bertos/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 #ifndef DRV_BUZZERLED_H
  42 #define DRV_BUZZERLED_H
  43
  44 #include <cpu/attr.h>
  45
  46 /** Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain
  47  *  an enumarator for each device, plus a special symbol NUM_BLDS containing the
  48  *  number of devices.
  49  */
  50 #include <hw.h>
  51
  52
  53 /* Include hw-level implementation. This allows inlining of bld_set, which in turns
  54  * should allow fast constant propagation for the common case (where the parameter
  55  * device is a constant).
  56  */
  57 #include CPU_HEADER(buzzerled)
  58
  59
  60 /** Initialize the buzzerled library.
  61  *
  62  * \note This function must be called before any other function in the library.
  63  */
  64 void bld_init(void);
  65
  66
  67 /** Set or reset a device.
  68  *
  69  * \param device Device to be set
  70  * \param enable Enable/disable status
  71  */
  72 #define bld_set(device, enable)  bld_hw_set(device, enable)
  73
  74
  75 /** Enable a device for a certain interval of time
  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 non-blocking, so it will return immediately.
  81  */
  82 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
  83
  84
  85 /** Enable a device for a certain interval of time and wait.
  86  *
  87  * \param device Device to be enabled
  88  * \param duration Number of milliseconds the device must be enabled
  89  *
  90  * \note This function is blocking, so it will return after the specified period of time.
  91  */
  92 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
  93
  94 #endif /* DRV_BUZZERLED_H */