Altera HWLIB  16.0
The Altera HW Manager API Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
Watchdog Timer Interrupt Management

Description

This functional group implements management of the interrupts of the watchdog timers.

Functions

ALT_STATUS_CODE alt_wdog_int_disable (ALT_WDOG_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_wdog_int_enable (ALT_WDOG_TIMER_t tmr_id)
 
bool alt_wdog_int_is_pending (ALT_WDOG_TIMER_t tmr_id)
 
bool alt_wdog_int_is_enabled (ALT_WDOG_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_wdog_int_clear (ALT_WDOG_TIMER_t tmr_id)
 
bool alt_wdog_int_if_pending_clear (ALT_WDOG_TIMER_t tmr_id)
 

Function Documentation

ALT_STATUS_CODE alt_wdog_int_disable ( ALT_WDOG_TIMER_t  tmr_id)

Disables the interrupt of the specified watchdog timer module. If the watchdog timer is one of the watchdog timers that can be used in general-purpose mode, and if the timer is in general-purpose timer mode, disable the interrupt.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGSpecified an incorrect timer.
ALT_STATUS_CODE alt_wdog_int_enable ( ALT_WDOG_TIMER_t  tmr_id)

Sets/enables the interrupt of the specified watchdog timer module. If the watchdog timer is one of the watchdog timers that can be used in general-purpose mode, and if the timer is in general-purpose timer mode, enable the interrupt.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGSpecified an incorrect timer.
bool alt_wdog_int_is_pending ( ALT_WDOG_TIMER_t  tmr_id)

Returns the status of the interrupt of the specified watchdog timer module but does not clear it. Return TRUE if the interrupt of the specified general purpose timer module is pending and FALSE otherwise.

Parameters
tmr_idThe timer identifier.
Return values
TRUEThe timer interrupt is currently pending.
FALSEThe timer interrupt is not currently pending.
bool alt_wdog_int_is_enabled ( ALT_WDOG_TIMER_t  tmr_id)

Returns the state of the interrupt of the specified watchdog timer module. If the watchdog timer is one of the watchdog timers that can be used in general-purpose mode, and if the timer is in general-purpose timer mode, returns TRUE if the interrupt of the specified general purpose timer module is enabled and FALSE if disabled. If the timer is not in general-purpose timer mode, returns /b TRUE, as watchdog interrupts are always enabled.

Parameters
tmr_idThe timer identifier.
Return values
TRUEThe timer interrupt is currently pending.
FALSEThe timer interrupt is not currently pending.
ALT_STATUS_CODE alt_wdog_int_clear ( ALT_WDOG_TIMER_t  tmr_id)

Clears the pending status of the interrupt of the specified watchdog timer module.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
bool alt_wdog_int_if_pending_clear ( ALT_WDOG_TIMER_t  tmr_id)

Returns the status of the interrupt of the specified watchdog timer module and also clears it. Return TRUE if the interrupt of the specified general purpose timer module is pending and FALSE otherwise.

Parameters
tmr_idThe timer identifier.
Return values
TRUEThe timer interrupt was pending.
FALSEThe timer interrupt was not pending.