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.3  2004/07/14 14:04:29  rasky
  19  * Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti
  20  *
  21  * Revision 1.2  2004/06/03 11:27:09  bernie
  22  * Add dual-license information.
  23  *
  24  * Revision 1.1  2004/05/23 18:36:05  bernie
  25  * Import buzzerled driver.
  26  *
  27  */
  28
  29 #ifndef DRV_BUZZERLED_H
  30 #define DRV_BUZZERLED_H
  31
  32 /*! Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain
  33  *  an enumarator for each device, plus a special symbol NUM_BLDS containing the
  34  *  number of devices.
  35  */
  36 #include <hw.h>
  37
  38
  39 /* Include hw-level implementation. This allows inlining of bld_set, which in turns
  40  * should allow fast constant propagation for the common case (where the parameter
  41  * device is a constant).
  42  */
  43 #if defined(__m56800__)
  44         #include "buzzerled_dsp56k.h"
  45 #else
  46         #error Unsupported architecture
  47 #endif
  48
  49
  50 /*! Initialize the buzzerled library.
  51  *
  52  * \note This function must be called before any other function in the library.
  53  */
  54 void bld_init(void);
  55
  56
  57 /*! Set or reset a device.
  58  *
  59  * \param device Device to be set
  60  * \param enable Enable/disable status
  61  */
  62 #define bld_set(device, enable)  bld_hw_set(device, enable)
  63
  64
  65 /*! Enable a device for a certain interval of time
  66  *
  67  * \param device Device to be enabled
  68  * \param duration Number of milliseconds the device must be enabled
  69  *
  70  * \note This function is non-blocking, so it will return immediately.
  71  */
  72 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
  73
  74
  75 /*! Enable a device for a certain interval of time and wait.
  76  *
  77  * \param device Device to be enabled
  78  * \param duration Number of milliseconds the device must be enabled
  79  *
  80  * \note This function is blocking, so it will return after the specified period of time.
  81  */
  82 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
  83
  84 #endif /* DRV_BUZZERLED_H */