software_timer.h

#pragma once
 
/************************************************************************************************
 * @file   software_timer.h
 *
 * @brief  Header file for the software timer library
 *
 * @date   2025-11-06
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "FreeRTOS.h"
#include "status.h"
#include "timers.h"
 
typedef TimerHandle_t SoftTimerId;
 
typedef void (*SoftTimerCallback)(SoftTimerId id);
 
typedef struct {
  StaticTimer_t buffer;
  SoftTimerId id;
} SoftTimer;
 
typedef struct {
  SoftTimer timer;                  
  uint32_t period_ms;               
  SoftTimerCallback fault_callback; 
} SoftwareWatchdog;
 
typedef void (*SoftTimerCallback)(SoftTimerId id);
 
StatusCode software_timer_init(uint32_t duration_ms, SoftTimerCallback callback, SoftTimer *timer);
 
StatusCode software_timer_start(SoftTimer *timer);
 
StatusCode software_timer_init_and_start(uint32_t duration_ms, SoftTimerCallback callback, SoftTimer *timer);
 
StatusCode software_timer_cancel(SoftTimer *timer);
 
StatusCode software_timer_reset(SoftTimer *timer);
 
bool software_timer_inuse(SoftTimer *timer);
 
uint32_t software_timer_remaining_time(SoftTimer *timer);
 
StatusCode software_watchdog_init(SoftwareWatchdog *watchdog, uint32_t period_ms, SoftTimerCallback fault_callback);
 
StatusCode software_watchdog_kick(SoftwareWatchdog *watchdog);
 
StatusCode software_watchdog_stop(SoftwareWatchdog *watchdog);