This functional group contains the basic functions to control and manage the watchdog timers.
ALT_STATUS_CODE alt_wdog_init |
( |
void |
| ) |
|
Initialize the watchdog timer module before use
- Return values
-
ALT_E_SUCCESS | The operation was successful. |
ALT_E_ERROR | The operation failed. |
ALT_STATUS_CODE alt_wdog_uninit |
( |
void |
| ) |
|
Uninitialize the watchdog timer module & return to reset state
- Return values
-
ALT_E_SUCCESS | The operation was successful. |
ALT_E_ERROR | The operation failed. |
Stop the specified watchdog timer. ALT_WATCHDOG0, ALT_WATCHDOG1, ALT_WATCHDOG0_INITIAL and ALT_WATCHDOG1_INITIAL cannot be stopped once started.
- Parameters
-
tmr_id | The watchdog timer identifier. |
- Return values
-
ALT_E_SUCCESS | The operation was successful. |
ALT_E_ERROR | The operation failed. |
ALT_E_BAD_ARG | Tried to stop an invalid watchdog timer. |
Start the specified watchdog timer.
- Parameters
-
tmr_id | The watchdog timer identifier. |
- Return values
-
ALT_E_SUCCESS | The operation was successful. |
ALT_E_ERROR | The operation failed. |
ALT_E_BAD_ARG | Tried to enable an invalid watchdog timer. |
Returns whether the specified watchdog timer is currently running or not.
- Parameters
-
tmr_id | The watchdog timer identifier. |
- Return values
-
TRUE | The timer is currently running. |
FALSE | The timer is currently not running. |
Reloads the counter countdown value, clears the timer interrupt, and restarts the watchdog timer. User can reset the timer at any time before timeout. This is also known as kicking, petting, feeding, waking, or walking the watchdog.
If the timer is reset while stopped, it remains stopped, the timer reset value is reloaded and the countdown will start from there when it is started. The timer configuration is retained.
- Parameters
-
tmr_id | The watchdog timer identifier. |
- Return values
-
ALT_E_SUCCESS | The operation was successful. |
ALT_E_ERROR | The operation failed. |
ALT_E_BAD_ARG | Tried to reset an invalid watchdog timer. |