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