Doc fixes.
[bertos.git] / drv / buzzer.c
old mode 100755 (executable)
new mode 100644 (file)
index e5bedfd..63cbc4a
-/*!
+/**
  * \file
  * <!--
- * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 1999,2003 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 1999, 2003 Bernardo Innocenti <bernie@develer.com>
+ *
  * -->
  *
  * \version $Id$
  *
- * \author Bernardo Innocenti <bernie@develer.com>
+ * \brief Buzzer driver (implementation)
  *
- * \brief Buzzer driver
+ * \version $Id$
+ * \author Bernardo Innocenti <bernie@develer.com>
+ * \author Francesco Sacchi <batt@develer.com>
  */
 
-/*
- * $Log$
- * Revision 1.3  2004/06/03 11:27:09  bernie
- * Add dual-license information.
- *
- * Revision 1.2  2004/05/23 18:21:53  bernie
- * Trim CVS logs and cleanup header info.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.19  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.18  2006/02/17 21:15:25  bernie
+ *#* Add MOD_CHECK() checks.
+ *#*
+ *#* Revision 1.17  2006/02/10 12:30:18  bernie
+ *#* Push interrupt protection inside hw module.
+ *#*
+ *#* Revision 1.16  2005/11/04 16:19:33  bernie
+ *#* buz_init(): Restore IRQ protection as in project_bko.
+ *#*
+ *#* Revision 1.15  2005/06/27 21:25:50  bernie
+ *#* Modularize hardware access; Port to new timer interface.
+ *#*
+ *#* Revision 1.14  2005/04/11 19:10:27  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.13  2005/02/18 11:20:15  bernie
+ *#* Use mware/event.h; Update copyright info.
+ *#*
+ *#* Revision 1.12  2004/12/13 12:07:06  bernie
+ *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
+ *#*
+ *#* Revision 1.11  2004/12/08 09:11:53  bernie
+ *#* Rename time_t to mtime_t.
+ *#*
+ *#* Revision 1.10  2004/10/03 18:38:51  bernie
+ *#* Add missing AVR header; Fix header.
+ *#*
+ *#* Revision 1.9  2004/09/14 21:01:25  bernie
+ *#* Use new AVR port pin names.
+ *#*/
 
-#include "hw.h"
-#include "kdebug.h"
-#include "timer.h"
 #include "buzzer.h"
-#include <kern/event.h>
-
-
-#if (ARCH & ARCH_EMUL)
-
-       int Emul_IsBuzzerOn(void);
-       void Emul_BuzzerOn(void);
-       void Emul_BuzzerOff(void);
-       void Emul_BuzzerInit(void);
-
-#      define IS_BUZZER_ON  (Emul_IsBuzzerOn())
-#      define BUZZER_ON     (Emul_BuzzerOn())
-#      define BUZZER_OFF    (Emul_BuzzerOff())
-#      define BUZZER_INIT   (Emul_BuzzerInit())
-
-#elif defined(__AVR__)
-
-#      define IS_BUZZER_ON  (PORTG & BV(PORTG0))
-
-       /**
-        * Buzzer manipulation macros
-        *
-        * \note Some PORTG functions are being used from
-        *       interrupt code, so we must be careful to
-        *       avoid race conditions.
-        */
-#      define BUZZER_ON \
-       do { \
-               cpuflags_t _flags; \
-               DISABLE_IRQSAVE(_flags); \
-               PORTG |= BV(PORTG0); \
-               ENABLE_IRQRESTORE(_flags); \
-       } while (0)
-
-#      define BUZZER_OFF \
-       do { \
-               cpuflags_t _flags; \
-               DISABLE_IRQSAVE(_flags); \
-               PORTG &= ~BV(PORTG0); \
-               ENABLE_IRQRESTORE(_flags); \
-       } while (0)
-
-#      define BUZZER_INIT \
-       do { \
-               cpuflags_t _flags; \
-               DISABLE_IRQSAVE(_flags); \
-               PORTG &= ~BV(PORTG0); \
-               DDRG |= BV(PORTG0); \
-               ENABLE_IRQRESTORE(_flags); \
-       } while (0)
-
-#elif defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__) /* 80C196 */
-
-#      define IS_BUZZER_ON  (cpld->Buzzer & 1)
-#      define BUZZER_ON     (cpld->Buzzer = 1)
-#      define BUZZER_OFF    (cpld->Buzzer = 0)
-#      define BUZZER_INIT   (cpld->Buzzer = 0)
-
-#endif /* ARCH, __AVR__, __IAR_SYSTEM_ICC */
+
+#include <hw_buzzer.h>
+#include <drv/timer.h>
+
+#include <mware/event.h>
+
+#include <cfg/debug.h>
+#include <cfg/module.h>
 
 
 /* Local vars */
-static Timer *buz_timer;
+static Timer buz_timer;
 static bool buz_timer_running;
-static time_t buz_repeat_interval;
-static time_t buz_repeat_duration;
+static mtime_t buz_repeat_interval;
+static mtime_t buz_repeat_duration;
 
 
-/*!
+/**
  * Turn off buzzer, called by software timer
  */
 static void buz_softint(void)
@@ -106,8 +105,8 @@ static void buz_softint(void)
                if (buz_repeat_interval)
                {
                        /* Wait for interval time */
-                       buz_timer->delay = buz_repeat_interval;
-                       timer_add(buz_timer);
+                       timer_setDelay(&buz_timer, ms_to_ticks(buz_repeat_interval));
+                       timer_add(&buz_timer);
                }
                else
                        buz_timer_running = false;
@@ -116,42 +115,42 @@ static void buz_softint(void)
        {
                /* Wait for beep time */
                BUZZER_ON;
-               buz_timer->delay = buz_repeat_duration;
-               timer_add(buz_timer);
+               timer_setDelay(&buz_timer, ms_to_ticks(buz_repeat_duration));
+               timer_add(&buz_timer);
        }
        else
                buz_timer_running = false;
 }
 
 
-/*!
+/**
  * Beep for the specified ms time
  */
-void buz_beep(time_t time)
+void buz_beep(mtime_t time)
 {
        cpuflags_t flags;
+       IRQ_SAVE_DISABLE(flags);
 
        /* Remove the software interrupt if it was already queued */
-       DISABLE_IRQSAVE(flags);
        if (buz_timer_running)
-               timer_abort(buz_timer);
+               timer_abort(&buz_timer);
 
        /* Turn on buzzer */
        BUZZER_ON;
 
        /* Add software interrupt to turn the buzzer off later */
        buz_timer_running = true;
-       buz_timer->delay = time;
-       timer_add(buz_timer);
+       timer_setDelay(&buz_timer, ms_to_ticks(time));
+       timer_add(&buz_timer);
 
-       ENABLE_IRQRESTORE(flags);
+       IRQ_RESTORE(flags);
 }
 
 
-/*!
+/**
  * Start buzzer repetition
  */
-void buz_repeat_start(time_t duration, time_t interval)
+void buz_repeat_start(mtime_t duration, mtime_t interval)
 {
        buz_repeat_interval = interval;
        buz_repeat_duration = duration;
@@ -159,37 +158,40 @@ void buz_repeat_start(time_t duration, time_t interval)
 }
 
 
-/*!
+/**
  * Stop buzzer repetition
  */
 void buz_repeat_stop(void)
 {
        cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
+       IRQ_SAVE_DISABLE(flags);
 
        /* Remove the software interrupt if it was already queued */
        if (buz_timer_running)
        {
-               timer_abort(buz_timer);
+               timer_abort(&buz_timer);
                buz_timer_running = false;
        }
 
        buz_repeat_interval = 0;
        BUZZER_OFF;
 
-       ENABLE_IRQRESTORE(flags);
+       IRQ_RESTORE(flags);
 }
 
+MOD_DEFINE(buzzer)
 
-/*!
- * Initialize buzzer
+/**
+ * Initialize buzzer.
  */
 void buz_init(void)
 {
-       BUZZER_INIT;
+       MOD_CHECK(timer);
+
+       BUZZER_HW_INIT;
+
+       /* Init software interrupt. */
+       timer_set_event_softint(&buz_timer, (Hook)buz_softint, 0);
 
-       /* Inizializza software interrupt */
-       buz_timer = timer_new();
-       ASSERT(buz_timer != NULL);
-       INITEVENT_INT(&buz_timer->expire, (Hook)buz_softint, 0);
+       MOD_INIT(buzzer);
 }