Document AVR dependency.
[bertos.git] / drv / buzzerled.c
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  * This library is divided into three different layers:
12  *
13  *  - The topmost portable layer is buzzerled.[ch] which exposes a common API
14  *    enable/disable the devices. Basically, it handles the asynchronism to
15  *    implement bld_beep and bld_repeat.
16  *  - The middle layer is CPU-specific and exposes a single main function which
17  *    turns on/off each device.
18  *  - The lower layer is board-specific and communicates with the middle layer
19  *    with any required API. The idea is that devices can be tied to the CPU in
20  *    many different ways (many different pins), so this part should describe
21  *    which devices are present, and how they are connected.
22  *
23  * \version $Id$
24  *
25  * \author Giovanni Bajo <rasky@develer.com>
26  */
27
28 /*
29  * $Log$
30  * Revision 1.3  2004/07/14 14:04:29  rasky
31  * Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti
32  *
33  * Revision 1.2  2004/06/03 11:27:09  bernie
34  * Add dual-license information.
35  *
36  * Revision 1.1  2004/05/23 18:36:05  bernie
37  * Import buzzerled driver.
38  *
39  */
40
41 #include "buzzerled.h"
42 #include "timer.h"
43
44 static struct Timer timers[NUM_BLDS];
45 static bool timer_go[NUM_BLDS];
46
47 INLINE enum BLD_DEVICE hook_parm_to_device(void* parm)
48 {
49         struct Timer* t = (struct Timer*)parm;
50         int num_bld = t - &timers[0];
51
52         ASSERT(num_bld >= 0);
53         ASSERT(num_bld < NUM_BLDS);
54
55         return (enum BLD_DEVICE)num_bld;
56 }
57
58 static void hook_turn_off(void* parm)
59 {
60         enum BLD_DEVICE num_bld = hook_parm_to_device(parm);
61         bld_set(num_bld, false);
62 }
63
64 void bld_init(void)
65 {
66         bld_hw_init();
67 }
68
69 void bld_beep(enum BLD_DEVICE device, uint16_t duration)
70 {
71         struct Timer* t = &timers[device];
72         timer_set_delay(t, duration);
73         timer_set_event_softint(t, hook_turn_off, t);
74         timer_add(t);
75
76         bld_set(device, true);
77 }
78
79 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration)
80 {
81         bld_set(device, true);
82         timer_delay(duration);
83         bld_set(device, false);
84 }
85