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 /*#*
  54  *#* $Log$
  55  *#* Revision 1.7  2006/07/19 12:56:25  bernie
  56  *#* Convert to new Doxygen style.
  57  *#*
  58  *#* Revision 1.6  2005/11/04 16:20:02  bernie
  59  *#* Fix reference to README.devlib in header.
  60  *#*
  61  *#* Revision 1.5  2004/12/08 09:43:41  bernie
  62  *#* Add a todo item.
  63  *#*
  64  *#* Revision 1.4  2004/08/25 14:12:08  rasky
  65  *#* Aggiornato il comment block dei log RCS
  66  *#*
  67  *#* Revision 1.3  2004/07/14 14:04:29  rasky
  68  *#* Merge da SC: spostata bld_set inline perché si ottimizza parecchio tramite propagazione di costanti
  69  *#*
  70  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  71  *#* Add dual-license information.
  72  *#*
  73  *#* Revision 1.1  2004/05/23 18:36:05  bernie
  74  *#* Import buzzerled driver.
  75  *#*
  76  *#*/
  77
  78 #include "buzzerled.h"
  79 #include "timer.h"
  80
  81 static struct Timer timers[NUM_BLDS];
  82 static bool timer_go[NUM_BLDS];
  83
  84 INLINE enum BLD_DEVICE hook_parm_to_device(void* parm)
  85 {
  86         struct Timer* t = (struct Timer*)parm;
  87         int num_bld = t - &timers[0];
  88
  89         ASSERT(num_bld >= 0);
  90         ASSERT(num_bld < NUM_BLDS);
  91
  92         return (enum BLD_DEVICE)num_bld;
  93 }
  94
  95 static void hook_turn_off(void* parm)
  96 {
  97         enum BLD_DEVICE num_bld = hook_parm_to_device(parm);
  98         bld_set(num_bld, false);
  99 }
 100
 101 void bld_init(void)
 102 {
 103         bld_hw_init();
 104 }
 105
 106 void bld_beep(enum BLD_DEVICE device, uint16_t duration)
 107 {
 108         // \todo This is not reentrant for the same device. FIXME!
 109         struct Timer *t = &timers[device];
 110         timer_set_delay(t, duration);
 111         timer_set_event_softint(t, hook_turn_off, t);
 112         timer_add(t);
 113
 114         bld_set(device, true);
 115 }
 116
 117 void bld_beep_and_wait(enum BLD_DEVICE device, uint16_t duration)
 118 {
 119         bld_set(device, true);
 120         timer_delay(duration);
 121         bld_set(device, false);
 122 }
 123