watchdog.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef WATCHDOG_H
#define WATCHDOG_H

 
#include "type.h"
#include "soc.h"
#include "riscv.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                    */
/* ========================================================================== */

        typedef enum {
            WDG_TIMER_CLEAR     = 0xAD68E70D,   
            WDG_TIMER_UNLOCK    = 0x3C21B925,   
            WDG_TIMER_LOCK      = 0x3C21B924    
        } watchdog_heartbeat_t;

 // End of WDG_ENUM group
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */
    typedef volatile struct 
    {
        u32 WDG_HEARTBEAT;                      
        u32 WDG_ENABLE;                         
        u32 WDG_DISABLE;                        
        u32 reserved0 [(0x0040 - 0xC)/4U];      
        u32 WDG_PRESCALER;                      
        u32 reserved1 [(0x0080 - 0x44)/4U];     
        u32 WDG_COUNTER_LIMIT_0;                
        u32 WDG_COUNTER_LIMIT_1;                
        u32 reserved2 [(0x00C0 - 0x88)/4U];     
        u32 WDG_COUNTER_VALUE_0;                
        u32 WDG_COUNTER_VALUE_1;                
 
    } watchdog_hwreg_t;

    typedef struct {
        watchdog_hwreg_t    *hwreg;             
 
        u32                 enable[2];          
 
        u32                 prescaler;          
 
        u32                 counterLimit[2];    
 
        u32                 heartbeat;          
        
    }watchdog_instance_t;
 // End of WDG_Types group
 
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */

    void watchdog_applyConfig(watchdog_instance_t *inst);

        void watchdog_lock(watchdog_instance_t *inst);
        void watchdog_unlock(watchdog_instance_t *inst);
        void watchdog_clear(watchdog_instance_t *inst);
        void watchdog_enable(watchdog_instance_t *inst, u32 mask);
        void watchdog_disable(watchdog_instance_t *inst, u32 mask);

        u32 watchdog_getCounterValue(watchdog_instance_t *inst, u32 counterId);
        u32 watchdog_getEnable(watchdog_instance_t *inst);

        void watchdog_setPrescaler(watchdog_instance_t * inst, u32 value);
        void watchdog_setHeartBeat(watchdog_instance_t *inst, watchdog_heartbeat_t value);
        void watchdog_setCounterLimit(watchdog_instance_t *inst, u32 counterId, u32 value);
 // End of WDG_Funcs group
 
 
 
#ifdef __cplusplus
}
#endif // End of MAIN WDG Group
 
#endif // WATCHDOG_H