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

Cleanup docs and unused files

Browse Source
This commit is contained in:
Henrik Stickann
2023-01-21 23:38:53 +01:00
parent 600b2d01c7
commit 2d516bd318
5 changed files with 24 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -17,17 +17,15 @@ The library provides implementations for the following interfaces using CMSIS-RT
# Modules
## System Event
## System Events
Provides an interface for common system events.
Configuration:
* `#define STA_RTOS_SYSTEM_EVENT_ENABLE`: Enable module
* `#define STA_RTOS_SYSTEM_EVENT_HANDLE <var_name>`: Override variable name of flag handle (default: systemEventHandle)
* `#define STA_RTOS_SYSTEM_EVENTS_ENABLE`: Enable module
Requirements:
* RTOS: event flag
When enabled a new global event flag will be created. Initialization will be handled by the Startup module
if enabled.
## Watchdog
@@ -38,30 +36,33 @@ and forwards the event flags to the `sta::watchdogEventHandler` function impleme
Configuration:
* `#define STA_RTOS_WATCHDOG_ENABLE`: Enable module
* `#define STA_RTOS_WATCHDOG_TIMER_PERIOD <period_ticks>`: Set period in ticks of heartbeat timer (default: 1000)
* `#define STA_RTOS_WATCHDOG_TIMER_HANDLE <var_name>`: Override variable name of heartbeat timer handle (default: heartbeatHandle)
* `#define STA_RTOS_WATCHDOG_TIMER_CALLBACK <func_name>`: Override name of heartbeat timer callback function (default: heartbeatCallback)
* `#define STA_RTOS_WATCHDOG_HANDLE <var_name>`: Override variable name of watchdog task handle (default: watchdogHandle)
* `#define STA_RTOS_WATCHDOG_ENTRY_FUNCTION <func_name>`: Override name of watchdog task entry function (default: watchdogTask)
Requirements:
* Uses the `System Event` module
* RTOS: timer + task
* `System Events` module
## Can Bus
TODO Add description
Configuration:
Requirements:
* `System Events` module
## Startup
The entry function for the startup task must be called manually from the default task.
The `startALPAKA` function must be called 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/rtos2/startup.hpp>` can be implemented.
It provides all setup required by the enabled system tasks. If additional initialization is required
the function `void sta::startupExtras(void *)` declared in `<sta/rtos/startup.hpp>` can be implemented by the application.
Configuration:
* `#define STA_RTOS_STARTUP_ENABLE`: Enable module
* `#define STA_RTOS_STARTUP_ENTRY_FUNCTION <func_name>`: Override name of startup task entry function (default: startupTask)
Requirements:
* Uses the `System Event` module
* RTOS: task
* `System Events` module
## Easy Config
@@ -70,5 +71,3 @@ Simplify configuration of modules. Intended for use in `<sta/config.hpp>`.
Configuration:
* `#define STA_RTOS_SYSTEM_TASKS_ENABLE`: Enable all modules required for system tasks
* `#define STA_RTOS_WATCHDOG_TIMER_NAME <name>`: Override handle and callback name for watchdog timer
* `#define STA_RTOS_WATCHDOG_NAME <name>`: Override handle and entry function name for watchdog task