Hardware Libraries  20.1
Stratix 10 SoC Hardware Manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
FPGA Interface Group

Description

These functions provide enable/disable control and operational status of the signal interfaces between the FPGA and HPS. Selective enabling/disabling of interfaces may be required under the following scenarios:

Typedefs

typedef enum ALT_FPGA_INTERFACE_e ALT_FPGA_INTERFACE_t
 

ENUMS

enum  ALT_FPGA_INTERFACE_e {
  ALT_FPGA_INTERFACE_CTMTRIGGER, ALT_FPGA_INTERFACE_STMEVENT, ALT_FPGA_INTERFACE_DBGAPB, ALT_FPGA_INTERFACE_TRACEOUT,
  ALT_FPGA_INTERFACE_TRACEIN, ALT_FPGA_INTERFACE_SPIM_1, ALT_FPGA_INTERFACE_SPIM_0, ALT_FPGA_INTERFACE_SDMMC,
  ALT_FPGA_INTERFACE_NAND, ALT_FPGA_INTERFACE_EMAC_2_SWITCH, ALT_FPGA_INTERFACE_EMAC_2, ALT_FPGA_INTERFACE_EMAC_1_SWITCH,
  ALT_FPGA_INTERFACE_EMAC_1, ALT_FPGA_INTERFACE_EMAC_0_SWITCH, ALT_FPGA_INTERFACE_EMAC_0
}
 

Functions

ALT_STATUS_CODE alt_fpga_interface_disable (ALT_FPGA_INTERFACE_t intfc)
 
ALT_STATUS_CODE alt_fpga_interface_enable (ALT_FPGA_INTERFACE_t intfc)
 
ALT_STATUS_CODE alt_fpga_interface_is_enabled (ALT_FPGA_INTERFACE_t intfc)
 

Typedef Documentation

This type definition enumerates the FPGA to HPS signal interfaces controlled by the functions in this API group.

Enumeration Type Documentation

This type definition enumerates the FPGA to HPS signal interfaces controlled by the functions in this API group.

Enumerator:
ALT_FPGA_INTERFACE_CTMTRIGGER 

Used to disable the FPGA Fabric from sending triggers to HPS debug logic. Note that this doesn't prevent the HPS debug logic from sending triggers to the FPGA Fabric.

ALT_FPGA_INTERFACE_STMEVENT 

Used to disable the STM event interface. This interface allows logic in the FPGA fabric to trigger events to the STM debug module in the HPS.

ALT_FPGA_INTERFACE_DBGAPB 

Used to disable the debug APB interface. This interface allows the HPS debug logic to communicate with debug APB slaves in the FPGA fabric.

ALT_FPGA_INTERFACE_TRACEOUT 

Gates the isolator of CoreSight.

ALT_FPGA_INTERFACE_TRACEIN 

Gates the isolator of TPIU.

ALT_FPGA_INTERFACE_SPIM_1 

Used to disable signals from the FPGA fabric to the SPI master modules that could potentially interfere with their normal operation. The array index corresponds to the SPI master module instance.

ALT_FPGA_INTERFACE_SPIM_0 

Used to disable signals from the FPGA fabric to the SPI master modules that could potentially interfere with their normal operation. The array index corresponds to the SPI master module instance.

ALT_FPGA_INTERFACE_SDMMC 

Used to disable signals from the FPGA fabric to the SD/MMC controller module that could potentially interfere with its normal operation.

ALT_FPGA_INTERFACE_NAND 

Used to disable signals from the FPGA fabric to the NAND flash controller module that could potentially interfere with its normal operation.

ALT_FPGA_INTERFACE_EMAC_2_SWITCH 

EMAC FPGA interface switch Enable

ALT_FPGA_INTERFACE_EMAC_2 

Used to disable signals from the FPGA fabric to the EMAC modules that could potentially interfere with their normal operation. The array index corresponds to the EMAC module instance.

ALT_FPGA_INTERFACE_EMAC_1_SWITCH 

EMAC FPGA interface switch Enable

ALT_FPGA_INTERFACE_EMAC_1 

Used to disable signals from the FPGA fabric to the EMAC modules that could potentially interfere with their normal operation. The array index corresponds to the EMAC module instance.

ALT_FPGA_INTERFACE_EMAC_0_SWITCH 

EMAC FPGA interface switch Enable

ALT_FPGA_INTERFACE_EMAC_0 

Used to disable signals from the FPGA fabric to the EMAC modules that could potentially interfere with their normal operation. The array index corresponds to the EMAC module instance.

Function Documentation

ALT_STATUS_CODE alt_fpga_interface_disable ( ALT_FPGA_INTERFACE_t  intfc)

Disables the specified FPGA to HPS signal interface.

Isolates and disables the designated FPGA/HPS signal interface. User is responsible for determining that the interface is inactive before disabling it.

Parameters
intfcThe interface to disable.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGThe intfc argument designates an invalid FPGA/HPS signal interface.
ALT_STATUS_CODE alt_fpga_interface_enable ( ALT_FPGA_INTERFACE_t  intfc)

Enables the specified FPGA to HPS signal interface.

Parameters
intfcThe interface to enable.
Return values
ALT_E_SUCCESSThe operation was successful.
ALT_E_ERRORThe operation failed.
ALT_E_BAD_ARGThe intfc argument designates an invalid FPGA/HPS signal interface.
ALT_STATUS_CODE alt_fpga_interface_is_enabled ( ALT_FPGA_INTERFACE_t  intfc)

Return whether the specified FPGA/HPS signal interface is enabled or not.

Parameters
intfcThe interface to enable.
Return values
ALT_E_TRUEThe interface is enabled.
ALT_E_FALSEThe interface is not enabled.
ALT_E_BAD_ARGThe intfc argument designates an invalid FPGA/HPS signal interface.