Update doxygen comments. Add TIM init for delayUs

This commit is contained in:
Henrik Stickann
2022-04-14 15:17:45 +02:00
parent 805b959161
commit ced5f9981f
7 changed files with 30 additions and 24 deletions

View File

@@ -1,15 +1,13 @@
/**
* @brief Implementation of watchdog system task.
*
* Define STA_OS2_WATCHDOG_ENABLE in <sta/config.hpp> to enable.
*
* Configuration:
* STA_OS2_WATCHDOG_TIMER_PERIOD: Period of heartbeat timer (default: 1000)
* STA_OS2_WATCHDOG_TIMER_HANDLE: Name of global timer handle variable (default: heartbeatHandle)
* STA_OS2_WATCHDOG_TIMER_CALLBACK: Name of timer callback function (default: heartbeatCallback)
*
* STA_OS2_WATCHDOG_HANDLE: Name of global task handle variable (default: watchdogHandle)
* STA_OS2_WATCHDOG_ENTRY_FUNCTION: Name of task entry function (default: watchdogTask)
* STA_OS2_WATCHDOG_ENABLE: Enable module
* STA_OS2_WATCHDOG_TIMER_PERIOD: Set period in ticks of heartbeat timer (default: 1000)
* STA_OS2_WATCHDOG_TIMER_HANDLE: Override variable name of heartbeat timer handle (default: heartbeatHandle)
* STA_OS2_WATCHDOG_TIMER_CALLBACK: Override name of heartbeat timer callback function (default: heartbeatCallback)
* STA_OS2_WATCHDOG_HANDLE: Override variable name of watchdog task handle (default: watchdogHandle)
* STA_OS2_WATCHDOG_ENTRY_FUNCTION: Override name of watchdog task entry function (default: watchdogTask)
*/
#ifndef STA_OS2_WATCHDOG_HPP
#define STA_OS2_WATCHDOG_HPP
@@ -17,7 +15,7 @@
#include <sta/config.hpp>
#ifdef STA_OS2_WATCHDOG_ENABLE
#include <stdint.h>
#include <cstdint>
// Watchdog task flags