Doc fixes.

[bertos.git] / drv / buzzer.c

diff --git a/drv/buzzer.c b/drv/buzzer.c
old mode 100755 (executable)
new mode 100644 (file)
index 4383ed7..63cbc4a
--- a/drv/buzzer.c
+++ b/drv/buzzer.c
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * 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>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \version $Id$
@@ -17,6 +42,12 @@
 
 /*#*
  *#* $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.
  *#*
@@ -53,6 +84,7 @@
 #include <mware/event.h>
 
 #include <cfg/debug.h>
+#include <cfg/module.h>
 
 
 /* Local vars */
@@ -62,7 +94,7 @@ static mtime_t buz_repeat_interval;
 static mtime_t buz_repeat_duration;
 
 
-/*!
+/**
  * Turn off buzzer, called by software timer
  */
 static void buz_softint(void)
@@ -91,7 +123,7 @@ static void buz_softint(void)
 }
 
 
-/*!
+/**
  * Beep for the specified ms time
  */
 void buz_beep(mtime_t time)
@@ -115,7 +147,7 @@ void buz_beep(mtime_t time)
 }
 
 
-/*!
+/**
  * Start buzzer repetition
  */
 void buz_repeat_start(mtime_t duration, mtime_t interval)
@@ -126,7 +158,7 @@ void buz_repeat_start(mtime_t duration, mtime_t interval)
 }
 
 
-/*!
+/**
  * Stop buzzer repetition
  */
 void buz_repeat_stop(void)
@@ -147,14 +179,19 @@ void buz_repeat_stop(void)
        IRQ_RESTORE(flags);
 }
 
+MOD_DEFINE(buzzer)
 
-/*!
+/**
  * Initialize buzzer.
  */
 void buz_init(void)
 {
+       MOD_CHECK(timer);
+
        BUZZER_HW_INIT;
 
        /* Init software interrupt. */
        timer_set_event_softint(&buz_timer, (Hook)buz_softint, 0);
+
+       MOD_INIT(buzzer);
 }