mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git
synced 2025-08-06 19:17:34 +00:00
Full Doxygen documentation
This commit is contained in:
@@ -7,7 +7,13 @@
|
||||
#include <cmsis_os2.h>
|
||||
|
||||
/**
|
||||
* @defgroup STA_RTOS_THREAD Thread
|
||||
* @ingroup STA_RTOS_API
|
||||
* @brief RTOS Thread.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup STA_RTOS_THREAD
|
||||
* @{
|
||||
*/
|
||||
|
||||
@@ -43,11 +49,14 @@
|
||||
#define STA_RTOS_THREAD_FLAGS_ERROR_CODE_BITS UINT32_C( 0x0000000F )
|
||||
#define STA_RTOS_THREAD_FLAGS_ERROR_CODE_EXT_BITS UINT32_C( 0x7FFFFFF0 )
|
||||
|
||||
|
||||
/**
|
||||
* @brief Error code from flags.
|
||||
*/
|
||||
#define STA_RTOS_THREAD_FLAGS_GET_EXT_ERROR_CODE(flags) (~flags & STA_RTOS_THREAD_FLAGS_ERROR_CODE_EXT_BITS)
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @brief Wait for any of the given flags to be set.
|
||||
*/
|
||||
#define STA_RTOS_THREAD_FLAGS_WAIT_ANY(timeout) osThreadFlagsWait(STA_RTOS_THREAD_FLAGS_VALID_BITS, osFlagsWaitAny, timeout)
|
||||
|
||||
|
||||
@@ -59,7 +68,7 @@ namespace sta
|
||||
/**
|
||||
* @brief Wrapper for RTOS thread control.
|
||||
*
|
||||
* @ingroup STA_RTOS_API
|
||||
* @ingroup STA_RTOS_THREAD
|
||||
*/
|
||||
class RtosThread
|
||||
{
|
||||
|
Reference in New Issue
Block a user