X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fbuzzerled.h;h=012def4ea9069a07c16d351fca6535feb41b6b94;hb=f52e46baa21748f30f30a9e725edbf90b420ed24;hp=e6431852a18528829806022995df42c36495c48e;hpb=a5fba8f9bf20dab160ac77bcdc8f34487fbc55db;p=bertos.git diff --git a/drv/buzzerled.h b/drv/buzzerled.h index e6431852..012def4e 100755 --- a/drv/buzzerled.h +++ b/drv/buzzerled.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \brief Generic library to handle buzzers and leds @@ -13,36 +13,69 @@ * \author Giovanni Bajo */ -/* - * $Log$ - * Revision 1.1 2004/05/23 18:36:05 bernie - * Import buzzerled driver. - * - */ +/*#* + *#* $Log$ + *#* Revision 1.8 2006/07/19 12:56:25 bernie + *#* Convert to new Doxygen style. + *#* + *#* Revision 1.7 2005/11/04 16:20:02 bernie + *#* Fix reference to README.devlib in header. + *#* + *#* Revision 1.6 2005/04/11 19:10:27 bernie + *#* Include top-level headers from cfg/ subdir. + *#* + *#* Revision 1.5 2004/08/25 14:12:08 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.4 2004/07/30 14:15:53 rasky + *#* Nuovo supporto unificato per detect della CPU + *#* + *#* Revision 1.3 2004/07/14 14:04:29 rasky + *#* Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti + *#* + *#* Revision 1.2 2004/06/03 11:27:09 bernie + *#* Add dual-license information. + *#* + *#* Revision 1.1 2004/05/23 18:36:05 bernie + *#* Import buzzerled driver. + *#* + *#*/ #ifndef DRV_BUZZERLED_H #define DRV_BUZZERLED_H -/*! Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain +#include + +/** Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain * an enumarator for each device, plus a special symbol NUM_BLDS containing the * number of devices. */ #include -/*! Initialize the buzzerled library. + +/* Include hw-level implementation. This allows inlining of bld_set, which in turns + * should allow fast constant propagation for the common case (where the parameter + * device is a constant). + */ +#include CPU_HEADER(buzzerled) + + +/** Initialize the buzzerled library. * * \note This function must be called before any other function in the library. */ void bld_init(void); -/*! Set or reset a device. + +/** Set or reset a device. * * \param device Device to be set * \param enable Enable/disable status */ -void bld_set(enum BLD_DEVICE device, bool enable); +#define bld_set(device, enable) bld_hw_set(device, enable) + -/*! Enable a device for a certain interval of time +/** Enable a device for a certain interval of time * * \param device Device to be enabled * \param duration Number of milliseconds the device must be enabled @@ -52,7 +85,7 @@ void bld_set(enum BLD_DEVICE device, bool enable); void bld_beep(enum BLD_DEVICE device, uint16_t duration); -/*! Enable a device for a certain interval of time and wait. +/** Enable a device for a certain interval of time and wait. * * \param device Device to be enabled * \param duration Number of milliseconds the device must be enabled