Update doc

This commit is contained in:
Henrik Stickann 2022-05-10 02:08:50 +02:00
parent d736b44697
commit 802999f2f6
3 changed files with 26 additions and 7 deletions

View File

@ -13,7 +13,7 @@
/**
* @defgroup rtos2API API
* @ingroup rtos2
* @brief Public library interface.
* @brief Public interface.
*/
/**
@ -29,10 +29,22 @@
*/
// See limits defined in cmsis_os2.c
#define STA_RTOS2_MAX_BITS_TASK_NOTIFY 31U
#define STA_RTOS2_MAX_BITS_EVENT_GROUPS 24U
/**
* @brief Number of usable bits in task notification flags.
*/
#define STA_RTOS2_MAX_BITS_TASK_NOTIFY 31U
/**
* @brief Number of usable bits in event group flags.
*/
#define STA_RTOS2_MAX_BITS_EVENT_GROUPS 24U
/**
* @brief Mask for valid task notification flag bits.
*/
#define STA_RTOS2_THREAD_FLAGS_VALID_BITS ((1UL << STA_RTOS2_MAX_BITS_TASK_NOTIFY) - 1U)
/**
* @brief Mask for valid event group flag bits.
*/
#define STA_RTOS2_EVENT_FLAGS_VALID_BITS ((1UL << STA_RTOS2_MAX_BITS_EVENT_GROUPS) - 1U)

View File

@ -105,6 +105,17 @@ namespace sta
* @ingroup rtos2Watchdog
*/
void notifyWatchdog(uint32_t flags);
/**
* @brief Handler for watchdog events.
*
* Must be implemented by application.
*
* @param arg Watchdog task argument
* @param flags Event flags
*/
void watchdogEventHandler(void * arg, uint32_t flags);
} // namespace sta

View File

@ -20,10 +20,6 @@ namespace sta
{
osThreadFlagsSet(STA_RTOS2_WATCHDOG_HANDLE, flags);
}
// Handler for watchdog events
extern void watchdogEventHandler(void * arg, uint32_t flags);
} // namespace sta