Doc fixes.
[bertos.git] / mware / event.h
old mode 100755 (executable)
new mode 100644 (file)
index baa6493..4270e94
@@ -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, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Events handling
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.3  2006/01/16 03:27:49  bernie
- *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
- *#*
- *#* Revision 1.2  2005/11/27 03:02:55  bernie
- *#* Convert to appconfig.h.
- *#*
- *#* Revision 1.1  2005/11/27 01:39:48  bernie
- *#* Move event.[ch] from kern/ to mware/.
- *#*
- *#* Revision 1.11  2005/04/11 19:10:28  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.10  2005/01/24 04:22:02  bernie
- *#* Update copyright information.
- *#*
- *#* Revision 1.9  2005/01/24 04:19:55  bernie
- *#* Remove obsolete names.
- *#*
- *#* Revision 1.8  2005/01/24 04:19:05  bernie
- *#* Function pointer based event dispatching.
- *#*
- *#* Revision 1.7  2004/08/25 14:12:09  rasky
- *#* Aggiornato il comment block dei log RCS
- *#*
- *#* Revision 1.6  2004/08/14 19:37:57  rasky
- *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
- *#*
- *#* Revision 1.5  2004/07/30 14:30:27  rasky
- *#* Resa la sig_signal interrupt safe (con il nuovo scheduler IRQ-safe)
- *#* Rimossa event_doIntr (ora inutile) e semplificata la logica delle macro con funzioni inline
- *#*
- *#* Revision 1.4  2004/06/07 15:58:00  aleph
- *#* Add function prototypes
- *#*
- *#* Revision 1.3  2004/06/06 18:25:44  bernie
- *#* Rename event macros to look like regular functions.
- *#*
- *#* Revision 1.2  2004/06/03 11:27:09  bernie
- *#* Add dual-license information.
- *#*
- *#* Revision 1.1  2004/05/23 17:27:00  bernie
- *#* Import kern/ subdirectory.
- *#*
- *#*/
 #ifndef KERN_EVENT_H
 #define KERN_EVENT_H
 
+#include <cfg/compiler.h>
 #include <appconfig.h>
 
 #if CONFIG_KERNEL
-       #include <cfg/config_kern.h>
+       #include <config_kern.h>
        #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
-               #include "signal.h"
+               #include <kern/signal.h>
        #endif
+
+       /* Forward decl */
+       struct Process;
 #endif
 
 
-//! User defined callback type
+/// User defined callback type
 typedef void (*Hook)(void *);
 
 typedef struct Event
@@ -102,11 +85,11 @@ void event_hook_ignore(Event *event);
 void event_hook_signal(Event *event);
 void event_hook_softint(Event *event);
 
-/*! Initialize the event \a e as a no-op */
+/** Initialize the event \a e as a no-op */
 #define event_initNone(e) \
        ((e)->action = event_hook_ignore)
 
-/*! Same as event_initNone(), but returns the initialized event */
+/** Same as event_initNone(), but returns the initialized event */
 INLINE Event event_createNone(void);
 INLINE Event event_createNone(void)
 {
@@ -115,11 +98,11 @@ INLINE Event event_createNone(void)
        return e;
 }
 
-/*! Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */
+/** Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */
 #define event_initSoftInt(e,f,u) \
        ((e)->action = event_hook_softint,(e)->Ev.Int.func = (f), (e)->Ev.Int.user_data = (u))
 
-/*! Same as event_initSoftInt(), but returns the initialized event */
+/** Same as event_initSoftInt(), but returns the initialized event */
 INLINE Event event_createSoftInt(Hook func, void *user_data)
 {
        Event e;
@@ -132,11 +115,11 @@ INLINE Event event_createSoftInt(Hook func, void *user_data)
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 
-/*! Initialize the event \a e with a signal (send signal \a s to process \a p) */
+/** Initialize the event \a e with a signal (send signal \a s to process \a p) */
 #define event_initSignal(e,p,s) \
        ((e)->action = event_hook_signal,(e)->Ev.Sig.sig_proc = (p), (e)->Ev.Sig.sig_bit = (s))
 
-/*! Same as event_initSignal(), but returns the initialized event */
+/** Same as event_initSignal(), but returns the initialized event */
 INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
 {
        Event e;
@@ -148,7 +131,7 @@ INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
 
 #endif
 
-/*! Trigger an event */
+/** Trigger an event */
 INLINE void event_do(struct Event *e)
 {
        e->action(e);