Remove CVS logs.
[bertos.git] / bertos / drv / buzzerled.c
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  * This library is divided into three different layers:
37  *
38  *  - The topmost portable layer is buzzerled.[ch] which exposes a common API
39  *    enable/disable the devices. Basically, it handles the asynchronism to
40  *    implement bld_beep and bld_repeat.
41  *  - The middle layer is CPU-specific and exposes a single main function which
42  *    turns on/off each device.
43  *  - The lower layer is board-specific and communicates with the middle layer
44  *    with any required API. The idea is that devices can be tied to the CPU in
45  *    many different ways (many different pins), so this part should describe
46  *    which devices are present, and how they are connected.
47  *
48  * \version $Id$
49  *
50  * \author Giovanni Bajo <rasky@develer.com>
51  */
52
53 #include "buzzerled.h"
54 #include "timer.h"
55
56 static struct Timer timers[NUM_BLDS];
57 static bool timer_go[NUM_BLDS];
58
59 INLINE enum BLD_DEVICE hook_parm_to_device(void* parm)
60 {
61         struct Timer* t = (struct Timer*)parm;
62         int num_bld = t - &timers[0];
63
64         ASSERT(num_bld >= 0);
65         ASSERT(num_bld < NUM_BLDS);
66
67         return (enum BLD_DEVICE)num_bld;
68 }
69
70 static void hook_turn_off(void* parm)
71 {
72         enum BLD_DEVICE num_bld = hook_parm_to_device(parm);
73         bld_set(num_bld, false);
74 }
75
76 void bld_init(void)
77 {
78         bld_hw_init();
79 }
80
81 void bld_beep(enum BLD_DEVICE device, uint16_t duration)
82 {
83         // \todo This is not reentrant for the same device. FIXME!
84         struct Timer *t = &timers[device];
85         timer_set_delay(t, duration);
86         timer_set_event_softint(t, hook_turn_off, t);
87         timer_add(t);
88
89         bld_set(device, true);
90 }
91
92 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration)
93 {
94         bld_set(device, true);
95         timer_delay(duration);
96         bld_set(device, false);
97 }
98