l4/pkg/l4re_c/include/event.h

   1 /**
   2  * \file
   3  * \brief Event C interface.
   4  */
   5 /*
   6  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   7  *               Alexander Warg <warg@os.inf.tu-dresden.de>
   8  *     economic rights: Technische Universität Dresden (Germany)
   9  *
  10  * This file is part of TUD:OS and distributed under the terms of the
  11  * GNU General Public License 2.
  12  * Please see the COPYING-GPL-2 file for details.
  13  *
  14  * As a special exception, you may use this file as part of a free software
  15  * library without restriction.  Specifically, if other files instantiate
  16  * templates or use macros or inline functions from this file, or you compile
  17  * this file and link it with other files to produce an executable, this
  18  * file does not by itself cause the resulting executable to be covered by
  19  * the GNU General Public License.  This exception does not however
  20  * invalidate any other reasons why the executable file might be covered by
  21  * the GNU General Public License.
  22  */
  23 #pragma once
  24
  25 /**
  26  * \defgroup api_l4re_c_event Event interface
  27  * \ingroup api_l4re_c
  28  * \brief Event C interface.
  29  */
  30
  31 #include <l4/sys/types.h>
  32 #include <l4/re/c/dataspace.h>
  33
  34 EXTERN_C_BEGIN
  35
  36 /**
  37  * \brief Event structure used in buffer.
  38  */
  39 typedef struct
  40 {
  41   long long time;         /**< Time stamp of the event */
  42   unsigned short type;    /**< Type of the event */
  43   unsigned short code;    /**< Code of the event */
  44   int value;              /**< Value of the event */
  45   l4_umword_t stream_id;  /**< Stream ID */
  46 } l4re_event_t;
  47
  48 /**
  49  * \brief Get an event object.
  50  * \ingroup api_l4re_c_event
  51  *
  52  * \param server   Server to talk to.
  53  * \param ds       Buffer to event data.
  54  * \param irq      Event signal.
  55  *
  56  * \return 0 for success, <0 on error
  57  *
  58  * \see L4Re::Event::get
  59  */
  60 L4_CV long
  61 l4re_event_get(const l4_cap_idx_t server,
  62                const l4re_ds_t ds) L4_NOTHROW;
  63
  64 EXTERN_C_END