diff options
Diffstat (limited to 'os/kernel/include/chevents.h')
| -rw-r--r-- | os/kernel/include/chevents.h | 240 |
1 files changed, 0 insertions, 240 deletions
diff --git a/os/kernel/include/chevents.h b/os/kernel/include/chevents.h deleted file mode 100644 index e15d0e6cb..000000000 --- a/os/kernel/include/chevents.h +++ /dev/null @@ -1,240 +0,0 @@ -/*
- ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
- 2011,2012,2013 Giovanni Di Sirio.
-
- This file is part of ChibiOS/RT.
-
- ChibiOS/RT is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
-
- ChibiOS/RT is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
-*/
-/*
- Concepts and parts of this file have been contributed by Scott (skute).
- */
-
-/**
- * @file chevents.h
- * @brief Events macros and structures.
- *
- * @addtogroup events
- * @{
- */
-
-#ifndef _CHEVENTS_H_
-#define _CHEVENTS_H_
-
-#if CH_CFG_USE_EVENTS || defined(__DOXYGEN__)
-
-/*===========================================================================*/
-/* Module constants. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Module pre-compile time settings. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Module data structures and types. */
-/*===========================================================================*/
-
-typedef struct event_listener event_listener_t;
-
-/**
- * @brief Event Listener structure.
- */
-struct event_listener {
- event_listener_t *el_next; /**< @brief Next Event Listener
- registered on the event
- source. */
- thread_t *el_listener; /**< @brief Thread interested in the
- event source. */
- eventmask_t el_mask; /**< @brief Event identifiers mask. */
- eventflags_t el_flags; /**< @brief Flags added to the listener
- by the event source.*/
-};
-
-/**
- * @brief Event Source structure.
- */
-typedef struct event_source {
- event_listener_t *es_next; /**< @brief First Event Listener
- registered on the Event
- Source. */
-} event_source_t;
-
-/**
- * @brief Event Handler callback function.
- */
-typedef void (*evhandler_t)(eventid_t);
-
-/*===========================================================================*/
-/* Module macros. */
-/*===========================================================================*/
-
-/**
- * @brief All events allowed mask.
- */
-#define ALL_EVENTS ((eventmask_t)-1)
-
-/**
- * @brief Returns an event mask from an event identifier.
- */
-#define EVENT_MASK(eid) ((eventmask_t)(1 << (eid)))
-
-/**
- * @brief Data part of a static event source initializer.
- * @details This macro should be used when statically initializing an event
- * source that is part of a bigger structure.
- * @param name the name of the event source variable
- */
-#define _EVENTSOURCE_DATA(name) {(void *)(&name)}
-
-/**
- * @brief Static event source initializer.
- * @details Statically initialized event sources require no explicit
- * initialization using @p chEvtInit().
- *
- * @param name the name of the event source variable
- */
-#define EVENTSOURCE_DECL(name) event_source_t name = _EVENTSOURCE_DATA(name)
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
- void chEvtRegisterMask(event_source_t *esp,
- event_listener_t *elp,
- eventmask_t mask);
- void chEvtUnregister(event_source_t *esp, event_listener_t *elp);
- eventmask_t chEvtGetAndClearEvents(eventmask_t mask);
- eventmask_t chEvtAddEvents(eventmask_t mask);
- eventflags_t chEvtGetAndClearFlags(event_listener_t *elp);
- eventflags_t chEvtGetAndClearFlagsI(event_listener_t *elp);
- void chEvtSignal(thread_t *tp, eventmask_t mask);
- void chEvtSignalI(thread_t *tp, eventmask_t mask);
- void chEvtBroadcastFlags(event_source_t *esp, eventflags_t flags);
- void chEvtBroadcastFlagsI(event_source_t *esp, eventflags_t flags);
- void chEvtDispatch(const evhandler_t *handlers, eventmask_t mask);
-#if CH_CFG_OPTIMIZE_SPEED || !CH_CFG_USE_EVENTS_TIMEOUT
- eventmask_t chEvtWaitOne(eventmask_t mask);
- eventmask_t chEvtWaitAny(eventmask_t mask);
- eventmask_t chEvtWaitAll(eventmask_t mask);
-#endif
-#if CH_CFG_USE_EVENTS_TIMEOUT
- eventmask_t chEvtWaitOneTimeout(eventmask_t mask, systime_t time);
- eventmask_t chEvtWaitAnyTimeout(eventmask_t mask, systime_t time);
- eventmask_t chEvtWaitAllTimeout(eventmask_t mask, systime_t time);
-#endif
-#ifdef __cplusplus
-}
-#endif
-
-#if !CH_CFG_OPTIMIZE_SPEED && CH_CFG_USE_EVENTS_TIMEOUT
-#define chEvtWaitOne(mask) chEvtWaitOneTimeout(mask, TIME_INFINITE)
-#define chEvtWaitAny(mask) chEvtWaitAnyTimeout(mask, TIME_INFINITE)
-#define chEvtWaitAll(mask) chEvtWaitAllTimeout(mask, TIME_INFINITE)
-#endif
-
-/*===========================================================================*/
-/* Module inline functions. */
-/*===========================================================================*/
-
-/**
- * @brief Initializes an Event Source.
- * @note This function can be invoked before the kernel is initialized
- * because it just prepares a @p event_source_t structure.
- *
- * @param[in] esp pointer to the @p event_source_t structure
- *
- * @init
- */
-static inline void chEvtObjectInit(event_source_t *esp) {
-
- esp->es_next = (event_listener_t *)(void *)esp;
-}
-
-/**
- * @brief Registers an Event Listener on an Event Source.
- * @note Multiple Event Listeners can use the same event identifier, the
- * listener will share the callback function.
- *
- * @param[in] esp pointer to the @p event_source_t structure
- * @param[out] elp pointer to the @p event_listener_t structure
- * @param[in] eid numeric identifier assigned to the Event Listener. The
- * identifier is used as index for the event callback
- * function.
- * The value must range between zero and the size, in bit,
- * of the @p eventid_t type minus one.
- *
- * @api
- */
-static inline void chEvtRegister(event_source_t *esp,
- event_listener_t *elp,
- eventid_t eid) {
-
- chEvtRegisterMask(esp, elp, EVENT_MASK(eid));
-}
-
-/**
- * @brief Verifies if there is at least one @p event_listener_t registered.
- *
- * @param[in] esp pointer to the @p event_source_t structure
- *
- * @iclass
- */
-static inline bool chEvtIsListeningI(event_source_t *esp) {
-
- return (bool)((void *)esp != (void *)esp->es_next);
-}
-
-/**
- * @brief Signals all the Event Listeners registered on the specified Event
- * Source.
- *
- * @param[in] esp pointer to the @p event_source_t structure
- *
- * @api
- */
-static inline void chEvtBroadcast(event_source_t *esp) {
-
- chEvtBroadcastFlags(esp, 0);
-}
-
-/**
- * @brief Signals all the Event Listeners registered on the specified Event
- * Source.
- * @post This function does not reschedule so a call to a rescheduling
- * function must be performed before unlocking the kernel. Note that
- * interrupt handlers always reschedule on exit so an explicit
- * reschedule must not be performed in ISRs.
- *
- * @param[in] esp pointer to the @p event_source_t structure
- *
- * @iclass
- */
-static inline void chEvtBroadcastI(event_source_t *esp) {
-
- chEvtBroadcastFlagsI(esp, 0);
-}
-
-#endif /* CH_CFG_USE_EVENTS */
-
-#endif /* _CHEVENTS_H_ */
-
-/** @} */
|