Add rtos namespace

This commit is contained in:
Henrik Stickann 2022-05-24 14:37:00 +02:00
parent 9c4f2d1927
commit cf30f8f793
7 changed files with 121 additions and 100 deletions

View File

@ -54,14 +54,17 @@
namespace sta namespace sta
{ {
/** namespace rtos
* @brief Extra initialization run at start of startup task. {
* /**
* May be overridden by application if required. * @brief Extra initialization run at start of startup task.
* *
* @ingroup STA_RTOS_Startup * May be overridden by application if required.
*/ *
void startupExtras(void * argument); * @ingroup STA_RTOS_Startup
*/
void startupExtras(void * argument);
} // namespace rtos
} // namespace sta } // namespace sta

View File

@ -56,42 +56,45 @@
namespace sta namespace sta
{ {
/** namespace rtos
* @brief Signal system events. {
* /**
* @param flags System event flags * @brief Signal system events.
* *
* @ingroup STA_RTOS_SysEvent * @param flags System event flags
*/ *
void signalSystemEvents(uint32_t flags); * @ingroup STA_RTOS_SysEvent
*/
void signalSystemEvents(uint32_t flags);
/** /**
* @brief Wait for system events. * @brief Wait for system events.
* *
* @param flags System event flags * @param flags System event flags
* @param options osFlagsWaitAll or osFlagsWaitAny (osFlagsNoClear always set) * @param options osFlagsWaitAll or osFlagsWaitAny (osFlagsNoClear always set)
* @param timeout Wait timeout (0 = instant, osWaitForever = infinite) * @param timeout Wait timeout (0 = instant, osWaitForever = infinite)
* *
* @ingroup STA_RTOS_SysEvent * @ingroup STA_RTOS_SysEvent
*/ */
void waitForSystemEvents(uint32_t flags, uint32_t options, uint32_t timeout); void waitForSystemEvents(uint32_t flags, uint32_t options, uint32_t timeout);
/**
* @brief Signal startup system event.
*
* @ingroup STA_RTOS_SysEvent
*/
void signalStartupEvent();
/**
/** * @brief Wait for startup system event.
* @brief Signal startup system event. *
* * Blocking while waiting
* @ingroup STA_RTOS_SysEvent *
*/ * @ingroup STA_RTOS_SysEvent
void signalStartupEvent(); */
void waitForStartupEvent();
/** } // namespace rtos
* @brief Wait for startup system event.
*
* Blocking while waiting
*
* @ingroup STA_RTOS_SysEvent
*/
void waitForStartupEvent();
} // namespace sta } // namespace sta

View File

@ -108,31 +108,34 @@
namespace sta namespace sta
{ {
/** namespace rtos
* @brief Start heartbeat timer for watchdog. {
* /**
* @ingroup STA_RTOS_Watchdog * @brief Start heartbeat timer for watchdog.
*/ *
void startWatchdogTimer(); * @ingroup STA_RTOS_Watchdog
/** */
* @brief Send notification to watchdog task. void startWatchdogTimer();
* /**
* @ingroup STA_RTOS_Watchdog * @brief Send notification to watchdog task.
*/ *
void notifyWatchdog(uint32_t flags); * @ingroup STA_RTOS_Watchdog
*/
void notifyWatchdog(uint32_t flags);
/** /**
* @brief Handler for watchdog events. * @brief Handler for watchdog events.
* *
* Must be implemented by application. * Must be implemented by application.
* *
* @param arg Watchdog task argument * @param arg Watchdog task argument
* @param flags Event flags * @param flags Event flags
* *
* @ingroup STA_RTOS_Watchdog * @ingroup STA_RTOS_Watchdog
*/ */
void watchdogEventHandler(void * arg, uint32_t flags); void watchdogEventHandler(void * arg, uint32_t flags);
} // namespace rtos
} // namespace sta } // namespace sta

View File

@ -11,10 +11,13 @@
namespace sta namespace sta
{ {
// Provide weak implementation to allow overriding namespace rtos
STA_WEAK {
void startupExtras(void *) // Provide weak implementation to allow overriding
{} STA_WEAK
void startupExtras(void *)
{}
} // namespace rtos
} // namespace sta } // namespace sta
@ -24,20 +27,20 @@ extern "C"
void STA_RTOS_STARTUP_ENTRY_FUNCTION(void * arg) void STA_RTOS_STARTUP_ENTRY_FUNCTION(void * arg)
{ {
// Call further initialization code // Call further initialization code
sta::startupExtras(arg); sta::rtos::startupExtras(arg);
// Initialize HAL // Initialize HAL
sta::initHAL(); sta::initHAL();
#ifdef STA_RTOS_WATCHDOG_ENABLE #ifdef STA_RTOS_WATCHDOG_ENABLE
// Start timers // Start timers
sta::startWatchdogTimer(); sta::rtos::startWatchdogTimer();
#endif // STA_RTOS_WATCHDOG_ENABLE #endif // STA_RTOS_WATCHDOG_ENABLE
// Wake tasks // Wake threads
sta::signalStartupEvent(); sta::rtos::signalStartupEvent();
// Terminate task // Terminate thread
osThreadExit(); osThreadExit();
} }
} }

View File

@ -14,26 +14,29 @@ extern osEventFlagsId_t STA_RTOS_SYSTEM_EVENT_HANDLE;
namespace sta namespace sta
{ {
void signalSystemEvents(uint32_t flags) namespace rtos
{ {
osEventFlagsSet(STA_RTOS_SYSTEM_EVENT_HANDLE, flags); void signalSystemEvents(uint32_t flags)
} {
osEventFlagsSet(STA_RTOS_SYSTEM_EVENT_HANDLE, flags);
void waitForSystemEvents(uint32_t flags, uint32_t options, uint32_t timeout) }
{
osEventFlagsWait(STA_RTOS_SYSTEM_EVENT_HANDLE, flags, options | osFlagsNoClear, timeout);
}
void signalStartupEvent()
{
signalSystemEvents(STA_SYSTEM_EVENT_STARTUP);
}
void waitForStartupEvent() void waitForSystemEvents(uint32_t flags, uint32_t options, uint32_t timeout)
{ {
waitForSystemEvents(STA_SYSTEM_EVENT_STARTUP, osFlagsWaitAll, osWaitForever); osEventFlagsWait(STA_RTOS_SYSTEM_EVENT_HANDLE, flags, options | osFlagsNoClear, timeout);
} }
void signalStartupEvent()
{
signalSystemEvents(STA_SYSTEM_EVENT_STARTUP);
}
void waitForStartupEvent()
{
waitForSystemEvents(STA_SYSTEM_EVENT_STARTUP, osFlagsWaitAll, osWaitForever);
}
} // namespace rtos
} // namespace sta } // namespace sta

View File

@ -7,10 +7,13 @@
namespace sta namespace sta
{ {
void startWatchdogTimer() namespace rtos
{ {
osTimerStart(WATCHDOG_TIMER_HANDLE, STA_RTOS_WATCHDOG_TIMER_PERIOD); void startWatchdogTimer()
} {
osTimerStart(WATCHDOG_TIMER_HANDLE, STA_RTOS_WATCHDOG_TIMER_PERIOD);
}
} // namespace rtos
} // namespace sta } // namespace sta

View File

@ -11,10 +11,13 @@
namespace sta namespace sta
{ {
void notifyWatchdog(uint32_t flags) namespace rtos
{ {
osThreadFlagsSet(WATCHDOG_TASK_HANDLE, flags); void notifyWatchdog(uint32_t flags)
} {
osThreadFlagsSet(WATCHDOG_TASK_HANDLE, flags);
}
} // namespace rtos
} // namespace sta } // namespace sta
@ -23,7 +26,7 @@ extern "C"
{ {
void STA_RTOS_WATCHDOG_ENTRY_FUNCTION(void * arg) void STA_RTOS_WATCHDOG_ENTRY_FUNCTION(void * arg)
{ {
sta::waitForStartupEvent(); sta::rtos::waitForStartupEvent();
while (true) while (true)
{ {
@ -31,7 +34,7 @@ extern "C"
uint32_t flags = osThreadFlagsWait(STA_RTOS_THREAD_FLAGS_VALID_BITS, osFlagsWaitAny, osWaitForever); uint32_t flags = osThreadFlagsWait(STA_RTOS_THREAD_FLAGS_VALID_BITS, osFlagsWaitAny, osWaitForever);
// Call event handler // Call event handler
sta::watchdogEventHandler(arg, flags); sta::rtos::watchdogEventHandler(arg, flags);
} }
} }
} }