Altera HWLIB  16.0
The Altera HW Manager API Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
Interrupts

Description

This functional group handles managing, setting, clearing, and disabling the interrupts of the general purpose timers and the global timer.

Functions

ALT_STATUS_CODE alt_gpt_int_disable (ALT_GPT_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_gpt_int_enable (ALT_GPT_TIMER_t tmr_id)
 
bool alt_gpt_int_is_enabled (ALT_GPT_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_gpt_int_clear_pending (ALT_GPT_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_gpt_int_is_pending (ALT_GPT_TIMER_t tmr_id)
 
ALT_STATUS_CODE alt_gpt_int_if_pending_clear (ALT_GPT_TIMER_t tmr_id)
 

Function Documentation

ALT_STATUS_CODE alt_gpt_int_disable ( ALT_GPT_TIMER_t  tmr_id)

Disables the interrupt from the specified general purpose timer or global timer module.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGInvalid input argument.
ALT_STATUS_CODE alt_gpt_int_enable ( ALT_GPT_TIMER_t  tmr_id)

Enables the interrupt of the specified general purpose timer or global timer module.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGInvalid input argument.
bool alt_gpt_int_is_enabled ( ALT_GPT_TIMER_t  tmr_id)

Return TRUE if the interrupt of the specified timer module is enabled and FALSE if the interrupt is disabled or masked.

Parameters
tmr_idThe timer identifier.
Return values
TRUEThe timer interrupt is currently enabled.
FALSEThe timer interrupt is currently disabled.
ALT_STATUS_CODE alt_gpt_int_clear_pending ( ALT_GPT_TIMER_t  tmr_id)

Clear the pending interrupt status of the specified timer module.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGInvalid input argument.
ALT_STATUS_CODE alt_gpt_int_is_pending ( ALT_GPT_TIMER_t  tmr_id)

Read the state (pending or not) of the interrupt of the specified timer module without changing the interrupt state.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_TRUEThe timer interrupt is currently pending.
ALT_E_FALSEThe timer interrupt is not currently pending.
ALT_E_BAD_ARGInvalid input argument.
ALT_STATUS_CODE alt_gpt_int_if_pending_clear ( ALT_GPT_TIMER_t  tmr_id)

Read the state of the interrupt of the specified general purpose timer module and if the interrupt is set, clear it.

Parameters
tmr_idThe timer identifier.
Return values
ALT_E_TRUEThe timer interrupt is currently pending.
ALT_E_FALSEThe timer interrupt is not currently pending.
ALT_E_BAD_ARGInvalid input argument.