bertos/mware/event.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
  31  *
  32  * -->
  33  *
  34  * \brief Events handling
  35  *
  36  * This module implements a common system for executing
  37  * a user defined action calling a hook function.
  38  *
  39  * \version $Id$
  40  *
  41  * \author Bernardo Innocenti <bernie@develer.com>
  42  */
  43
  44 #ifndef KERN_EVENT_H
  45 #define KERN_EVENT_H
  46
  47 #include <cfg/compiler.h>
  48 #include "cfg/cfg_kern.h"
  49
  50 #if CONFIG_KERNEL
  51         #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
  52                 #include <kern/signal.h>
  53         #endif
  54
  55         /* Forward decl */
  56         struct Process;
  57 #endif
  58
  59
  60 /// User defined callback type
  61 typedef void (*Hook)(void *);
  62
  63 typedef struct Event
  64 {
  65         void (*action)(struct Event *);
  66         union
  67         {
  68 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
  69                 struct
  70                 {
  71                         struct Process *sig_proc;  /* Process to be signalled */
  72                         sigbit_t        sig_bit;   /* Signal to send */
  73                 } Sig;
  74 #endif
  75                 struct
  76                 {
  77                         Hook  func;         /* Pointer to softint hook */
  78                         void *user_data;    /* Data to be passed back to user hook */
  79                 } Int;
  80         } Ev;
  81 } Event;
  82
  83 void event_hook_ignore(Event *event);
  84 void event_hook_signal(Event *event);
  85 void event_hook_softint(Event *event);
  86
  87 /** Initialize the event \a e as a no-op */
  88 #define event_initNone(e) \
  89         ((e)->action = event_hook_ignore)
  90
  91 /** Same as event_initNone(), but returns the initialized event */
  92 INLINE Event event_createNone(void);
  93 INLINE Event event_createNone(void)
  94 {
  95         Event e;
  96         e.action = event_hook_ignore;
  97         return e;
  98 }
  99
 100 /** Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */
 101 #define event_initSoftInt(e,f,u) \
 102         ((e)->action = event_hook_softint,(e)->Ev.Int.func = (f), (e)->Ev.Int.user_data = (u))
 103
 104 /** Same as event_initSoftInt(), but returns the initialized event */
 105 INLINE Event event_createSoftInt(Hook func, void *user_data)
 106 {
 107         Event e;
 108         e.action = event_hook_softint;
 109         e.Ev.Int.func = func;
 110         e.Ev.Int.user_data = user_data;
 111         return e;
 112 }
 113
 114
 115 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 116
 117 /** Initialize the event \a e with a signal (send signal \a s to process \a p) */
 118 #define event_initSignal(e,p,s) \
 119         ((e)->action = event_hook_signal,(e)->Ev.Sig.sig_proc = (p), (e)->Ev.Sig.sig_bit = (s))
 120
 121 /** Same as event_initSignal(), but returns the initialized event */
 122 INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
 123 {
 124         Event e;
 125         e.action = event_hook_signal;
 126         e.Ev.Sig.sig_proc = proc;
 127         e.Ev.Sig.sig_bit = bit;
 128         return e;
 129 }
 130
 131 #endif
 132
 133 /** Trigger an event */
 134 INLINE void event_do(struct Event *e)
 135 {
 136         e->action(e);
 137 }
 138
 139 #endif /* KERN_EVENT_H */