drv/buzzerled.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2004 Giovanni Bajo
   6  * All Rights Reserved.
   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.1  2004/05/23 18:36:05  bernie
  19  * Import buzzerled driver.
  20  *
  21  */
  22
  23 #ifndef DRV_BUZZERLED_H
  24 #define DRV_BUZZERLED_H
  25
  26 /*! Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain
  27  *  an enumarator for each device, plus a special symbol NUM_BLDS containing the
  28  *  number of devices.
  29  */
  30 #include <hw.h>
  31
  32 /*! Initialize the buzzerled library.
  33  *
  34  * \note This function must be called before any other function in the library.
  35  */
  36 void bld_init(void);
  37
  38 /*! Set or reset a device.
  39  *
  40  * \param device Device to be set
  41  * \param enable Enable/disable status
  42  */
  43 void bld_set(enum BLD_DEVICE device, bool enable);
  44
  45 /*! Enable a device for a certain interval of time
  46  *
  47  * \param device Device to be enabled
  48  * \param duration Number of milliseconds the device must be enabled
  49  *
  50  * \note This function is non-blocking, so it will return immediately.
  51  */
  52 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
  53
  54
  55 /*! Enable a device for a certain interval of time and wait.
  56  *
  57  * \param device Device to be enabled
  58  * \param duration Number of milliseconds the device must be enabled
  59  *
  60  * \note This function is blocking, so it will return after the specified period of time.
  61  */
  62 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
  63
  64 #endif /* DRV_BUZZERLED_H */