Hardware Libraries  20.1
Arria 10 SoC Hardware Manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
FPGA Manager Interrupt Control

Description

The functions in ths group provide management of interrupts originating from the FPGA Manager.

The following interrupt request (IRQ) signal is sourced from the FPGA Manager:

The functions in this group provide management of interrupts originating from the FPGA Manager.

The following interrupt request (IRQ) signal is sourced from the FPGA Manager:

Functions

ALT_STATUS_CODE alt_fpga_int_enable (uint32_t mask)
 
ALT_STATUS_CODE alt_fpga_int_disable (uint32_t mask)
 
uint32_t alt_fpga_int_get (void)
 
ALT_STATUS_CODE alt_fpga_int_clear (uint32_t mask)
 
ALT_STATUS_CODE alt_fpga_man_irq_disable (ALT_FPGA_MON_STATUS_t mon_stat_mask)
 
ALT_STATUS_CODE alt_fpga_man_irq_enable (ALT_FPGA_MON_STATUS_t mon_stat_mask)
 
uint32_t alt_fpga_man_irq_type_get (ALT_FPGA_MON_STATUS_t mon_stat_mask)
 
ALT_STATUS_CODE alt_fpga_man_irq_type_set (ALT_FPGA_MON_STATUS_t mon_stat_mask, ALT_FPGA_MON_STATUS_t mon_stat_config)
 
uint32_t alt_fpga_man_irq_pol_get (ALT_FPGA_MON_STATUS_t mon_stat_mask)
 
ALT_STATUS_CODE alt_fpga_man_irq_pol_set (ALT_FPGA_MON_STATUS_t mon_stat_mask, ALT_FPGA_MON_STATUS_t mon_stat_config)
 

Function Documentation

ALT_STATUS_CODE alt_fpga_int_enable ( uint32_t  mask)

Enable the FPGA Manager to interrupt on status condition(s) identified in the mask. To clear the interrupting condition, call alt_fpga_int_clear().

Parameters
maskSpecifies the status conditions to enable as the interrupt source contributor(s). mask is a mask of logically OR'ed ALT_FPGA_STATUS_t values that designates the conditions to enable.
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGSpecified mask includes invalid status condition(s).
ALT_E_FPGA_PWR_OFFFPGA is not powered on.
ALT_STATUS_CODE alt_fpga_int_disable ( uint32_t  mask)

Disable the FPGA Manager to interrupt status condition(s) identified in the mask.

Parameters
maskSpecifies the status conditions to disable as the interrupt source contributor(s). mask is a mask of logically OR'ed ALT_FPGA_STATUS_t values that designates the conditions to disable.
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGSpecified mask includes invalid status condition(s).
ALT_E_FPGA_PWR_OFFFPGA is not powered on.
uint32_t alt_fpga_int_get ( void  )

Gets the current status conditions contributing to the interrupt generation. Only enabled status conditions will be returned. To query all active status condition(s), call alt_fpga_status_get(). To clear the current interrupt generation, call alt_fpga_int_clear().

Return values
Maskof logically OR'ed ALT_FPGA_STATUS_t values that are enabled and contributiong to the interrupt generation.
ALT_STATUS_CODE alt_fpga_int_clear ( uint32_t  mask)

Clears the interrupt status condition(s) identified in the mask.

Parameters
maskSpecifies the status conditions to clear as the interrupt source contributor(s). mask is a mask of logically OR'ed ALT_FPGA_STATUS_t values that designates the conditions to disable.
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGSpecified mask includes invalid status condition(s).
ALT_E_FPGA_PWR_OFFFPGA is not powered on.
ALT_STATUS_CODE alt_fpga_man_irq_disable ( ALT_FPGA_MON_STATUS_t  mon_stat_mask)

Disable the fpga_man_IRQ interrupt signal source monitor status condition(s).

This function disables one or more of the monitor status conditions as contributors to the fpga_man_IRQ interrupt signal state.

NOTE: A set bit for a monitor status condition in the mask value does not have the effect of enabling it as a contributor to the fpga_man_IRQ interrupt signal state. The function alt_fpga_man_irq_enable() is used to enable monitor status source condition(s).

Parameters
mon_stat_maskSpecifies the monitor status conditions to disable as interrupt source contributors. mon_stat_mask is a mask of logically OR'ed ALT_FPGA_MON_STATUS_t values that designate the monitor status conditions to disable.
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGThe mon_stat_mask argument contains an unknown monitor status value.
ALT_STATUS_CODE alt_fpga_man_irq_enable ( ALT_FPGA_MON_STATUS_t  mon_stat_mask)

Enable the fpga_man_IRQ interrupt signal source monitor status condition(s).

This function enables one or more of the monitor status conditions as contributors to the fpga_man_IRQ interrupt signal state.

NOTE: A cleared bit for any monitor status condition in the mask value does not have the effect of disabling it as a contributor to the fpga_man_IRQ interrupt signal state. The function alt_fpga_man_irq_disable() is used to disable monitor status source condition(s).

Parameters
mon_stat_maskSpecifies the monitor status conditions to enable as interrupt source contributors. mon_stat_mask is a mask of logically OR'ed ALT_FPGA_MON_STATUS_t values that designate the monitor conditions to enable.
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGThe mon_stat_mask argument contains an unknown monitor status value.
uint32_t alt_fpga_man_irq_type_get ( ALT_FPGA_MON_STATUS_t  mon_stat_mask)

Returns the interrupt configuration (level-triggered or edge-triggered) for the specified monitor status condition(s).

Parameters
mon_stat_maskSpecifies the monitor status conditions interrupt type to return.
Returns
The current interrupt source configuration for the given mask. Bits with 0 are level-triggered and 1 are edge-triggered.
ALT_STATUS_CODE alt_fpga_man_irq_type_set ( ALT_FPGA_MON_STATUS_t  mon_stat_mask,
ALT_FPGA_MON_STATUS_t  mon_stat_config 
)

Sets the trigger condition configuration for specified status mask.

Parameters
mon_stat_maskSpecifies the monitor status conditions interrupt type to update.
mon_stat_configThe interrupt configuration to update. Bits with 0 is level-triggered and 1 is edge-triggered.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
uint32_t alt_fpga_man_irq_pol_get ( ALT_FPGA_MON_STATUS_t  mon_stat_mask)

Returns the active-high or active-low polarity configuration for the FPGA monitor signals.

Parameters
mon_stat_maskSpecifies the monitor status condition polarity to return.
Returns
The current interrupt polarity condition. Bits with 0 are active low and 1 are active high.
ALT_STATUS_CODE alt_fpga_man_irq_pol_set ( ALT_FPGA_MON_STATUS_t  mon_stat_mask,
ALT_FPGA_MON_STATUS_t  mon_stat_config 
)

Sets the active level configuration for the specified status mask.

Parameters
mon_stat_maskSpecifies the monitor status conditions interrupt type to update.
mon_stat_configThe interrupt configuration to update. Bits with 0 is active low and 1 is active high.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.