ALPAKA/rtos2-utils
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git synced 2025-12-16 18:08:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rework. Improve doxygen documentation

Browse Source
This commit is contained in:
Henrik Stickann
2022-05-08 03:15:08 +02:00
parent 0fe1be1863
commit b09de25c62
14 changed files with 340 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,4 +1,7 @@
# CMSIS OS2
# RTOS2 Utilities
![pre-release v0.1.0](https://img.shields.io/static/v1?label=pre-release&message=v0.1.0&color=orange&logo=git)
![Standard: C++11](https://img.shields.io/static/v1?label=standard&message=C%2B%2B11&color=blue&logo=cplusplus)
Library using CMSIS-RTOS2 functionality for RTOS projects.
@@ -19,8 +22,8 @@ The library provides implementations for the following interfaces using CMSIS-RT
Provides an interface for common system events.
Configuration:
* `#define STA_OS2_SYSTEM_EVENT_ENABLE`: Enable module
* `#define STA_OS2_SYSTEM_EVENT_HANDLE <var_name>`: Override variable name of flag handle (default: systemEventHandle)
* `#define STA_RTOS2_SYSTEM_EVENT_ENABLE`: Enable module
* `#define STA_RTOS2_SYSTEM_EVENT_HANDLE <var_name>`: Override variable name of flag handle (default: systemEventHandle)
Requirements:
@@ -33,12 +36,12 @@ The watchdog task waits for signals sent either from the heartbeat timer or manu
and forwards the event flags to the `sta::watchdogEventHandler` function implemented by the application.
Configuration:
* `#define STA_OS2_WATCHDOG_ENABLE`: Enable module
* `#define STA_OS2_WATCHDOG_TIMER_PERIOD <period_ticks>`: Set period in ticks of heartbeat timer (default: 1000)
* `#define STA_OS2_WATCHDOG_TIMER_HANDLE <var_name>`: Override variable name of heartbeat timer handle (default: heartbeatHandle)
* `#define STA_OS2_WATCHDOG_TIMER_CALLBACK <func_name>`: Override name of heartbeat timer callback function (default: heartbeatCallback)
* `#define STA_OS2_WATCHDOG_HANDLE <var_name>`: Override variable name of watchdog task handle (default: watchdogHandle)
* `#define STA_OS2_WATCHDOG_ENTRY_FUNCTION <func_name>`: Override name of watchdog task entry function (default: watchdogTask)
* `#define STA_RTOS2_WATCHDOG_ENABLE`: Enable module
* `#define STA_RTOS2_WATCHDOG_TIMER_PERIOD <period_ticks>`: Set period in ticks of heartbeat timer (default: 1000)
* `#define STA_RTOS2_WATCHDOG_TIMER_HANDLE <var_name>`: Override variable name of heartbeat timer handle (default: heartbeatHandle)
* `#define STA_RTOS2_WATCHDOG_TIMER_CALLBACK <func_name>`: Override name of heartbeat timer callback function (default: heartbeatCallback)
* `#define STA_RTOS2_WATCHDOG_HANDLE <var_name>`: Override variable name of watchdog task handle (default: watchdogHandle)
* `#define STA_RTOS2_WATCHDOG_ENTRY_FUNCTION <func_name>`: Override name of watchdog task entry function (default: watchdogTask)
Requirements:
* Uses the `System Event` module
@@ -50,11 +53,11 @@ Requirements:
The entry function for the startup task must be called manually from the default task.
It provides all setup required by the enabled system tasks. If additional initialization is required by the
application the function `void sta::startupExtras(void *)` declared in `<sta/os2/startup.hpp>` can be implemented.
application the function `void sta::startupExtras(void *)` declared in `<sta/rtos2/startup.hpp>` can be implemented.
Configuration:
* `#define STA_OS2_STARTUP_ENABLE`: Enable module
* `#define STA_OS2_STARTUP_ENTRY_FUNCTION <func_name>`: Override name of startup task entry function (default: startupTask)
* `#define STA_RTOS2_STARTUP_ENABLE`: Enable module
* `#define STA_RTOS2_STARTUP_ENTRY_FUNCTION <func_name>`: Override name of startup task entry function (default: startupTask)
Requirements:
* Uses the `System Event` module
@@ -66,6 +69,6 @@ Requirements:
Simplify configuration of modules. Intended for use in `<sta/config.hpp>`.
Configuration:
* `#define STA_OS2_SYSTEM_TASKS_ENABLE`: Enable all modules required for system tasks
* `#define STA_OS2_WATCHDOG_TIMER_NAME <name>`: Override handle and callback name for watchdog timer
* `#define STA_OS2_WATCHDOG_NAME <name>`: Override handle and entry function name for watchdog task
* `#define STA_RTOS2_SYSTEM_TASKS_ENABLE`: Enable all modules required for system tasks
* `#define STA_RTOS2_WATCHDOG_TIMER_NAME <name>`: Override handle and callback name for watchdog timer
* `#define STA_RTOS2_WATCHDOG_NAME <name>`: Override handle and entry function name for watchdog task