Sapphire SoC DS Sapphire SoC UG Sapphire HP SoC DS Sapphire HP SoC UG RISC-V Embedded IDE UG Board Support Package
Loading...
Searching...
No Matches
watchdog.h File Reference
#include "type.h"
#include "soc.h"
#include "riscv.h"

Go to the source code of this file.

Overview

Watchdog driver API definitions.

Author
Efinix Inc

Definition in file watchdog.h.

Data Structures

struct  watchdog_hwreg_t
 Watchdog hardware register map. More...
struct  watchdog_instance_t
 Watchdog instance. Holds the software registers and hardware pointer. More...

Enumerations

Configuration Enums

Enums used for driver initialization.

enum  watchdog_heartbeat_t { WDG_TIMER_CLEAR = 0xAD68E70D , WDG_TIMER_UNLOCK = 0x3C21B925 , WDG_TIMER_LOCK = 0x3C21B924 }
 Value for the timer to generate a detection pulse. More...

Functions

void watchdog_applyConfig (watchdog_instance_t *inst)
 Apply the software configuration to the hardware.
Watchdog (Control Functions)

Control functions for the Watchdog.

void watchdog_lock (watchdog_instance_t *inst)
 Send Lock Heartbeat to Watchdog.
void watchdog_unlock (watchdog_instance_t *inst)
 Send Unlock Heartbeat to Watchdog.
void watchdog_clear (watchdog_instance_t *inst)
 Send Clear Heartbeat to Watchdog.
void watchdog_enable (watchdog_instance_t *inst, u32 mask)
 Enable Watchdog Counters.
void watchdog_disable (watchdog_instance_t *inst, u32 mask)
 Disable Watchdog Counters.
Watchdog (Get Functions)

Read values from the Watchdog hardware registers.

u32 watchdog_getCounterValue (watchdog_instance_t *inst, u32 counterId)
 Get current Counter Value.
u32 watchdog_getEnable (watchdog_instance_t *inst)
 Get Watchdog Enable Register.
Watchdog (Set Functions)

Write values to the Watchdog registers.

Note
Call watchdog_applyConfig() to make these changes effective.
void watchdog_setPrescaler (watchdog_instance_t *inst, u32 value)
 Set Watchdog Prescaler Value.
void watchdog_setHeartBeat (watchdog_instance_t *inst, watchdog_heartbeat_t value)
 Set Watchdog Heartbeat Action.
void watchdog_setCounterLimit (watchdog_instance_t *inst, u32 counterId, u32 value)
 Set Watchdog Counter Limit.