Update for new emulator.
[bertos.git] / mware / event.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 1999, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
6  * This file is part of DevLib - See README.devlib for information.
7  * -->
8  *
9  * \brief Events handling
10  *
11  * This module implements a common system for executing
12  * a user defined action calling a hook function.
13  *
14  * \version $Id$
15  *
16  * \author Bernardo Innocenti <bernie@develer.com>
17  */
18
19 /*#*
20  *#* $Log$
21  *#* Revision 1.6  2006/02/24 01:17:44  bernie
22  *#* Update for new emulator.
23  *#*
24  *#* Revision 1.5  2006/02/24 00:26:21  bernie
25  *#* Fix header name.
26  *#*
27  *#* Revision 1.4  2006/02/10 12:24:42  bernie
28  *#* Fix standalone build.
29  *#*
30  *#* Revision 1.3  2006/01/16 03:27:49  bernie
31  *#* Rename sig_t to sigbit_t to avoid clash with POSIX.
32  *#*
33  *#* Revision 1.2  2005/11/27 03:02:55  bernie
34  *#* Convert to appconfig.h.
35  *#*
36  *#* Revision 1.1  2005/11/27 01:39:48  bernie
37  *#* Move event.[ch] from kern/ to mware/.
38  *#*
39  *#* Revision 1.11  2005/04/11 19:10:28  bernie
40  *#* Include top-level headers from cfg/ subdir.
41  *#*
42  *#* Revision 1.10  2005/01/24 04:22:02  bernie
43  *#* Update copyright information.
44  *#*
45  *#* Revision 1.9  2005/01/24 04:19:55  bernie
46  *#* Remove obsolete names.
47  *#*
48  *#* Revision 1.8  2005/01/24 04:19:05  bernie
49  *#* Function pointer based event dispatching.
50  *#*
51  *#* Revision 1.7  2004/08/25 14:12:09  rasky
52  *#* Aggiornato il comment block dei log RCS
53  *#*
54  *#* Revision 1.6  2004/08/14 19:37:57  rasky
55  *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
56  *#*
57  *#* Revision 1.5  2004/07/30 14:30:27  rasky
58  *#* Resa la sig_signal interrupt safe (con il nuovo scheduler IRQ-safe)
59  *#* Rimossa event_doIntr (ora inutile) e semplificata la logica delle macro con funzioni inline
60  *#*
61  *#* Revision 1.4  2004/06/07 15:58:00  aleph
62  *#* Add function prototypes
63  *#*
64  *#* Revision 1.3  2004/06/06 18:25:44  bernie
65  *#* Rename event macros to look like regular functions.
66  *#*
67  *#* Revision 1.2  2004/06/03 11:27:09  bernie
68  *#* Add dual-license information.
69  *#*
70  *#* Revision 1.1  2004/05/23 17:27:00  bernie
71  *#* Import kern/ subdirectory.
72  *#*
73  *#*/
74 #ifndef KERN_EVENT_H
75 #define KERN_EVENT_H
76
77 #include <cfg/compiler.h>
78 #include <appconfig.h>
79
80 #if CONFIG_KERNEL
81         #include <config_kern.h>
82         #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
83                 #include <kern/signal.h>
84         #endif
85 #endif
86
87
88 //! User defined callback type
89 typedef void (*Hook)(void *);
90
91 typedef struct Event
92 {
93         void (*action)(struct Event *);
94         union
95         {
96 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
97                 struct
98                 {
99                         struct Process *sig_proc;  /* Process to be signalled */
100                         sigbit_t        sig_bit;   /* Signal to send */
101                 } Sig;
102 #endif
103                 struct
104                 {
105                         Hook  func;         /* Pointer to softint hook */
106                         void *user_data;    /* Data to be passed back to user hook */
107                 } Int;
108         } Ev;
109 } Event;
110
111 void event_hook_ignore(Event *event);
112 void event_hook_signal(Event *event);
113 void event_hook_softint(Event *event);
114
115 /*! Initialize the event \a e as a no-op */
116 #define event_initNone(e) \
117         ((e)->action = event_hook_ignore)
118
119 /*! Same as event_initNone(), but returns the initialized event */
120 INLINE Event event_createNone(void);
121 INLINE Event event_createNone(void)
122 {
123         Event e;
124         e.action = event_hook_ignore;
125         return e;
126 }
127
128 /*! Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */
129 #define event_initSoftInt(e,f,u) \
130         ((e)->action = event_hook_softint,(e)->Ev.Int.func = (f), (e)->Ev.Int.user_data = (u))
131
132 /*! Same as event_initSoftInt(), but returns the initialized event */
133 INLINE Event event_createSoftInt(Hook func, void *user_data)
134 {
135         Event e;
136         e.action = event_hook_softint;
137         e.Ev.Int.func = func;
138         e.Ev.Int.user_data = user_data;
139         return e;
140 }
141
142
143 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
144
145 /*! Initialize the event \a e with a signal (send signal \a s to process \a p) */
146 #define event_initSignal(e,p,s) \
147         ((e)->action = event_hook_signal,(e)->Ev.Sig.sig_proc = (p), (e)->Ev.Sig.sig_bit = (s))
148
149 /*! Same as event_initSignal(), but returns the initialized event */
150 INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
151 {
152         Event e;
153         e.action = event_hook_signal;
154         e.Ev.Sig.sig_proc = proc;
155         e.Ev.Sig.sig_bit = bit;
156         return e;
157 }
158
159 #endif
160
161 /*! Trigger an event */
162 INLINE void event_do(struct Event *e)
163 {
164         e->action(e);
165 }
166
167 #endif /* KERN_EVENT_H */