rtos2-utils/include/sta/os2/watchdog.hpp
2022-04-14 15:17:45 +02:00

43 lines
1.2 KiB
C++

/**
* @brief Implementation of watchdog system task.
*
* Configuration:
* 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
#include <sta/config.hpp>
#ifdef STA_OS2_WATCHDOG_ENABLE
#include <cstdint>
// Watchdog task flags
//
#define STA_WATCHDOG_FLAG_HEARTBEAT 0x00001000U
namespace sta
{
/**
* @brief Start heartbeat timer for watchdog.
*/
void startWatchdogTimer();
/**
* @brief Send notification to watchdog task.
*/
void notifyWatchdog(uint32_t flags);
} // namespace sta
#endif // STA_OS2_WATCHDOG_ENABLE
#endif // STA_OS2_WATCHDOG_HPP