drv/buzzerled.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2004 Giovanni Bajo
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \brief Generic library to handle buzzers and leds
  10  *
  11  * \version $Id$
  12  *
  13  * \author Giovanni Bajo <rasky@develer.com>
  14  */
  15
  16 /*#*
  17  *#* $Log$
  18  *#* Revision 1.6  2005/04/11 19:10:27  bernie
  19  *#* Include top-level headers from cfg/ subdir.
  20  *#*
  21  *#* Revision 1.5  2004/08/25 14:12:08  rasky
  22  *#* Aggiornato il comment block dei log RCS
  23  *#*
  24  *#* Revision 1.4  2004/07/30 14:15:53  rasky
  25  *#* Nuovo supporto unificato per detect della CPU
  26  *#*
  27  *#* Revision 1.3  2004/07/14 14:04:29  rasky
  28  *#* Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti
  29  *#*
  30  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  31  *#* Add dual-license information.
  32  *#*
  33  *#* Revision 1.1  2004/05/23 18:36:05  bernie
  34  *#* Import buzzerled driver.
  35  *#*
  36  *#*/
  37
  38 #ifndef DRV_BUZZERLED_H
  39 #define DRV_BUZZERLED_H
  40
  41 #include <cfg/cpu.h>
  42
  43 /*! Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain
  44  *  an enumarator for each device, plus a special symbol NUM_BLDS containing the
  45  *  number of devices.
  46  */
  47 #include <hw.h>
  48
  49
  50 /* Include hw-level implementation. This allows inlining of bld_set, which in turns
  51  * should allow fast constant propagation for the common case (where the parameter
  52  * device is a constant).
  53  */
  54 #include CPU_HEADER(buzzerled)
  55
  56
  57 /*! Initialize the buzzerled library.
  58  *
  59  * \note This function must be called before any other function in the library.
  60  */
  61 void bld_init(void);
  62
  63
  64 /*! Set or reset a device.
  65  *
  66  * \param device Device to be set
  67  * \param enable Enable/disable status
  68  */
  69 #define bld_set(device, enable)  bld_hw_set(device, enable)
  70
  71
  72 /*! Enable a device for a certain interval of time
  73  *
  74  * \param device Device to be enabled
  75  * \param duration Number of milliseconds the device must be enabled
  76  *
  77  * \note This function is non-blocking, so it will return immediately.
  78  */
  79 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
  80
  81
  82 /*! Enable a device for a certain interval of time and wait.
  83  *
  84  * \param device Device to be enabled
  85  * \param duration Number of milliseconds the device must be enabled
  86  *
  87  * \note This function is blocking, so it will return after the specified period of time.
  88  */
  89 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
  90
  91 #endif /* DRV_BUZZERLED_H */