mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git
synced 2025-06-12 02:36:00 +00:00
97 lines
1.8 KiB
C++
97 lines
1.8 KiB
C++
/**
|
|
* @file
|
|
* @brief Implementation of system events.
|
|
*/
|
|
#ifndef STA_OS2_SYSTEM_EVENT_HPP
|
|
#define STA_OS2_SYSTEM_EVENT_HPP
|
|
|
|
/**
|
|
* @defgroup rtos2SysEvent System Events
|
|
* @ingroup rtos2API
|
|
* @brief System events.
|
|
*
|
|
* Check @ref rtos2BuildConfig for configuration options.
|
|
*/
|
|
|
|
#ifdef DOXYGEN
|
|
/**
|
|
* @brief Enable module.
|
|
*
|
|
* @ingroup rtos2BuildConfig
|
|
*/
|
|
# define STA_RTOS2_SYSTEM_EVENT_ENABLE
|
|
#endif // DOXYGEN
|
|
|
|
/**
|
|
* @def STA_RTOS2_SYSTEM_EVENT_HANDLE
|
|
* @brief Set variable name of event flags handle.
|
|
*
|
|
* @ingroup rtos2BuildConfig
|
|
*/
|
|
#ifndef STA_RTOS2_SYSTEM_EVENT_HANDLE
|
|
# define STA_RTOS2_SYSTEM_EVENT_HANDLE systemEventHandle
|
|
#endif // !STA_RTOS2_SYSTEM_EVENT_HANDLE
|
|
|
|
|
|
#include <sta/config.hpp>
|
|
#ifdef STA_RTOS2_SYSTEM_EVENT_ENABLE
|
|
|
|
#include <cstdint>
|
|
|
|
|
|
// System event flags
|
|
//
|
|
|
|
/**
|
|
* @brief Startup system event flag.
|
|
*
|
|
* @ingroup rtos2SysEvent
|
|
*/
|
|
#define STA_SYSTEM_EVENT_STARTUP 0x100000U
|
|
|
|
|
|
namespace sta
|
|
{
|
|
/**
|
|
* @brief Signal system events.
|
|
*
|
|
* @param flags System event flags
|
|
*
|
|
* @ingroup rtos2SysEvent
|
|
*/
|
|
void signalSystemEvents(uint32_t flags);
|
|
|
|
/**
|
|
* @brief Wait for system events.
|
|
*
|
|
* @param flags System event flags
|
|
* @param options osFlagsWaitAll or osFlagsWaitAny (osFlagsNoClear always set)
|
|
* @param timeout Wait timeout (0 = instant, osWaitForever = infinite)
|
|
*
|
|
* @ingroup rtos2SysEvent
|
|
*/
|
|
void waitForSystemEvents(uint32_t flags, uint32_t options, uint32_t timeout);
|
|
|
|
|
|
/**
|
|
* @brief Signal startup system event.
|
|
*
|
|
* @ingroup rtos2SysEvent
|
|
*/
|
|
void signalStartupEvent();
|
|
|
|
/**
|
|
* @brief Wait for startup system event.
|
|
*
|
|
* Blocking while waiting
|
|
*
|
|
* @ingroup rtos2SysEvent
|
|
*/
|
|
void waitForStartupEvent();
|
|
} // namespace sta
|
|
|
|
|
|
#endif // STA_RTOS2_SYSTEM_EVENT_ENABLE
|
|
|
|
#endif // STA_RTOS2_SYSTEM_EVENT_HPP
|