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