sapi_watchdog.h

Go to the documentation of this file.

 
#ifndef SAPI_WATCHDOG_H
#define SAPI_WATCHDOG_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * Types & Constants
 * ========================================================================== */

typedef struct sapi_watchdog_s *sapi_watchdog_t;

typedef enum {
    SAPI_WATCHDOG_SYSTEM,      
    SAPI_WATCHDOG_TASK,        
    SAPI_WATCHDOG_CHANNEL,     
    SAPI_WATCHDOG_CHECKPOINT   
} sapi_watchdog_type_t;

typedef enum {
    SAPI_WATCHDOG_ACTION_LOG,           
    SAPI_WATCHDOG_ACTION_SAFESTATE,     
    SAPI_WATCHDOG_ACTION_REBOOT,        
    SAPI_WATCHDOG_ACTION_FAILOVER,      
    SAPI_WATCHDOG_ACTION_CUSTOM         
} sapi_watchdog_action_t;

typedef struct {
    sapi_watchdog_type_t type;          
    const char *name;                   
    sapi_duration_ms_t timeout_ms;      
    sapi_watchdog_action_t action;      
    void (*custom_action)(void *ctx);   
    void *context;                      
} sapi_watchdog_config_t;

typedef struct {
    uint8_t active;                     
    uint32_t kicks;                     
    uint32_t fires;                     
    uint32_t recoveries;                
    sapi_duration_ms_t time_since_last_kick; 
    sapi_duration_ms_t time_until_fire;      
} sapi_watchdog_status_t;
 
/* ============================================================================
 * API: Core Watchdog Operations
 * ========================================================================== */

sapi_status_t sapi_watchdog_create(sapi_watchdog_t *handle_out,
                                    const sapi_watchdog_config_t *config);

sapi_status_t sapi_watchdog_start(sapi_watchdog_t watchdog);

sapi_status_t sapi_watchdog_stop(sapi_watchdog_t watchdog);

sapi_status_t sapi_watchdog_kick(sapi_watchdog_t watchdog);

sapi_status_t sapi_watchdog_get_status(sapi_watchdog_t watchdog,
                                        sapi_watchdog_status_t *status_out);

sapi_status_t sapi_watchdog_destroy(sapi_watchdog_t watchdog);
 
/* ============================================================================
 * API: Watchdog Manager (Global)
 * ========================================================================== */

sapi_status_t sapi_watchdog_manager_initialize(void);

sapi_status_t sapi_watchdog_manager_shutdown(void);
 
/* ============================================================================
 * Watchdog Timeout Callback (Invoked by Framework)
 * ========================================================================== */

void sapi_watchdog_timeout_handler(uint32_t watchdog_id);

void sapi_watchdog_timer_tick(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAPI_WATCHDOG_H */
 /* WATCHDOG */