drv/buzzerled.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2004 Giovanni Bajo
  31  *
  32  * -->
  33  *
  34  * \brief Generic library to handle buzzers and leds
  35  *
  36  * \version $Id$
  37  *
  38  * \author Giovanni Bajo <rasky@develer.com>
  39  */
  40
  41 /*#*
  42  *#* $Log$
  43  *#* Revision 1.8  2006/07/19 12:56:25  bernie
  44  *#* Convert to new Doxygen style.
  45  *#*
  46  *#* Revision 1.7  2005/11/04 16:20:02  bernie
  47  *#* Fix reference to README.devlib in header.
  48  *#*
  49  *#* Revision 1.6  2005/04/11 19:10:27  bernie
  50  *#* Include top-level headers from cfg/ subdir.
  51  *#*
  52  *#* Revision 1.5  2004/08/25 14:12:08  rasky
  53  *#* Aggiornato il comment block dei log RCS
  54  *#*
  55  *#* Revision 1.4  2004/07/30 14:15:53  rasky
  56  *#* Nuovo supporto unificato per detect della CPU
  57  *#*
  58  *#* Revision 1.3  2004/07/14 14:04:29  rasky
  59  *#* Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti
  60  *#*
  61  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  62  *#* Add dual-license information.
  63  *#*
  64  *#* Revision 1.1  2004/05/23 18:36:05  bernie
  65  *#* Import buzzerled driver.
  66  *#*
  67  *#*/
  68
  69 #ifndef DRV_BUZZERLED_H
  70 #define DRV_BUZZERLED_H
  71
  72 #include <cfg/cpu.h>
  73
  74 /** Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain
  75  *  an enumarator for each device, plus a special symbol NUM_BLDS containing the
  76  *  number of devices.
  77  */
  78 #include <hw.h>
  79
  80
  81 /* Include hw-level implementation. This allows inlining of bld_set, which in turns
  82  * should allow fast constant propagation for the common case (where the parameter
  83  * device is a constant).
  84  */
  85 #include CPU_HEADER(buzzerled)
  86
  87
  88 /** Initialize the buzzerled library.
  89  *
  90  * \note This function must be called before any other function in the library.
  91  */
  92 void bld_init(void);
  93
  94
  95 /** Set or reset a device.
  96  *
  97  * \param device Device to be set
  98  * \param enable Enable/disable status
  99  */
 100 #define bld_set(device, enable)  bld_hw_set(device, enable)
 101
 102
 103 /** Enable a device for a certain interval of time
 104  *
 105  * \param device Device to be enabled
 106  * \param duration Number of milliseconds the device must be enabled
 107  *
 108  * \note This function is non-blocking, so it will return immediately.
 109  */
 110 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
 111
 112
 113 /** Enable a device for a certain interval of time and wait.
 114  *
 115  * \param device Device to be enabled
 116  * \param duration Number of milliseconds the device must be enabled
 117  *
 118  * \note This function is blocking, so it will return after the specified period of time.
 119  */
 120 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
 121
 122 #endif /* DRV_BUZZERLED_H */