4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2004 Giovanni Bajo
34 * \brief Generic library to handle buzzers and leds
37 * \author Giovanni Bajo <rasky@develer.com>
40 #ifndef DRV_BUZZERLED_H
41 #define DRV_BUZZERLED_H
46 /** Include hw_buzzerled.h. We expect hw_buzzerled.h to define enum BLD_DEVICE, which must contain
47 * an enumarator for each device, plus a special symbol NUM_BLDS containing the
50 #include "hw/hw_buzzerled.h"
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).
57 #include CPU_HEADER(buzzerled)
60 /** Initialize the buzzerled library.
62 * \note This function must be called before any other function in the library.
67 /** Set or reset a device.
69 * \param device Device to be set
70 * \param enable Enable/disable status
72 #define bld_set(device, enable) bld_hw_set(device, enable)
75 /** Enable a device for a certain interval of time
77 * \param device Device to be enabled
78 * \param duration Number of milliseconds the device must be enabled
80 * \note This function is non-blocking, so it will return immediately.
82 void bld_beep(enum BLD_DEVICE device, uint16_t duration);
85 /** Enable a device for a certain interval of time and wait.
87 * \param device Device to be enabled
88 * \param duration Number of milliseconds the device must be enabled
90 * \note This function is blocking, so it will return after the specified period of time.
92 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration);
96 #endif /* DRV_BUZZERLED_H */