Change sreg type to cpuflags_t.

[bertos.git] / mware / event.h

diff --git a/mware/event.h b/mware/event.h
old mode 100755 (executable)
new mode 100644 (file)
index a289db8..65ad31c
--- a/mware/event.h
+++ b/mware/event.h
@@ -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
@@ -18,6 +43,27 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.8  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.7  2006/03/20 17:52:22  bernie
+ *#* Add missing forward declaration.
+ *#*
+ *#* Revision 1.6  2006/02/24 01:17:44  bernie
+ *#* Update for new emulator.
+ *#*
+ *#* Revision 1.5  2006/02/24 00:26:21  bernie
+ *#* Fix header name.
+ *#*
+ *#* Revision 1.4  2006/02/10 12:24:42  bernie
+ *#* Fix standalone build.
+ *#*
+ *#* 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/.
  *#*
@@ -59,17 +105,21 @@
 #ifndef KERN_EVENT_H
 #define KERN_EVENT_H
 
-#include <cfg/config.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
@@ -81,7 +131,7 @@ typedef struct Event
                struct
                {
                        struct Process *sig_proc;  /* Process to be signalled */
-                       sig_t           sig_bit;   /* Signal to send */
+                       sigbit_t        sig_bit;   /* Signal to send */
                } Sig;
 #endif
                struct
@@ -96,11 +146,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)
 {
@@ -109,12 +159,12 @@ 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 */
-INLINE Event event_createSoftInt(Hook func, void* user_data)
+/** Same as event_initSoftInt(), but returns the initialized event */
+INLINE Event event_createSoftInt(Hook func, void *user_data)
 {
        Event e;
        e.action = event_hook_softint;
@@ -126,12 +176,12 @@ 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 */
-INLINE Event event_createSignal(struct Process* proc, sig_t bit)
+/** Same as event_initSignal(), but returns the initialized event */
+INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
 {
        Event e;
        e.action = event_hook_signal;
@@ -142,8 +192,8 @@ INLINE Event event_createSignal(struct Process* proc, sig_t bit)
 
 #endif
 
-/*! Trigger an event */
-INLINE void event_do(struct Event* e)
+/** Trigger an event */
+INLINE void event_do(struct Event *e)
 {
        e->action(e);
 }