Hardware Libraries  20.1
Arria 10 SoC Hardware Manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
SDRam Controller API

Description

         QOS API

This API allows the developer to set the QOS levels of the various ports

Data Structures

struct  ALT_SDR_QOS_INFO_s
 
struct  ALT_SDR_FIREWALL_ACCESS_s
 

Typedefs

typedef enum ALT_SDR_MODE_e ALT_SDR_MODE_t
 
typedef enum ALT_SDR_PORT_e ALT_SDR_PORT_t
 
typedef struct
ALT_SDR_FIREWALL_ACCESS_s 
ALT_SDR_FIREWALL_ACCESS_t
 
typedef enum ALT_SDR_MEM_TARGET_e ALT_SDR_MEM_TARGET_t
 

ENUMS

enum  ALT_SDR_MODE_e
 
enum  ALT_SDR_PORT_e
 
enum  ALT_SDR_MEM_TARGET_e
 

Functions

struct ALT_SDR_QOS_INFO_s __attribute__ ((aligned(4))) ALT_SDR_QOS_INFO_t
 
ALT_STATUS_CODE alt_sdr_port_qos_set (ALT_SDR_PORT_t port, ALT_SDR_QOS_INFO_t *qos)
 
ALT_STATUS_CODE alt_sdr_port_qos_get (ALT_SDR_PORT_t port, ALT_SDR_QOS_INFO_t *qos)
 
ALT_STATUS_CODE alt_sdr_firewall_set (ALT_SDR_MEM_TARGET_t target, ALT_SDR_FIREWALL_ACCESS_t *access)
 
ALT_STATUS_CODE alt_sdr_firewall_get (ALT_SDR_MEM_TARGET_t target, ALT_SDR_FIREWALL_ACCESS_t *access)
 

Data Structure Documentation

struct ALT_SDR_QOS_INFO_s

This type defines the structure for passing parameters to/from the alt_sdr_(set/get)_port_qos functions.

struct ALT_SDR_FIREWALL_ACCESS_s

This type defines the structure for passing parameters to/from the alt_sdr_(set/get)_target_firewall functions. Each of these values specifies whether or not a nonsecure memory operation would be allowed to access this memory

Typedef Documentation

This type enumerates the modes for a port

This type enumerates the various peripheral ports

This type defines the structure for passing parameters to/from the alt_sdr_(set/get)_target_firewall functions. Each of these values specifies whether or not a nonsecure memory operation would be allowed to access this memory

This type enumerates the varous memory port targets where the firewalls exist

Enumeration Type Documentation

This type enumerates the modes for a port

This type enumerates the various peripheral ports

This type enumerates the varous memory port targets where the firewalls exist

Function Documentation

struct ALT_SDR_QOS_INFO_s __attribute__ ( (aligned(4))  )

This type defines the structure for passing parameters to/from the alt_sdr_(set/get)_port_qos functions.

ALT_STATUS_CODE alt_sdr_port_qos_set ( ALT_SDR_PORT_t  port,
ALT_SDR_QOS_INFO_t *  qos 
)

alt_sdr_set_port_qos - Sets the QOS parameters for a given port NOTE: Setting the QOS for an FPGA* port before bringing up the FPGA bridge will cause a data abort

Parameters
portThe peripheral port whos parameters are being set
qosA pointer to a struct that contains the values to be programmed to the port
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGEither the pointer was NULL or port number was invalid
ALT_STATUS_CODE alt_sdr_port_qos_get ( ALT_SDR_PORT_t  port,
ALT_SDR_QOS_INFO_t *  qos 
)

alt_sdr_get_port_qos - Retreive the QOS parameters for a given port NOTE: Reading the QOS for an FPGA* port before bringing up the FPGA bridge will cause a data abort

Parameters
portThe peripheral port whos parameters are being set
qosA pointer to a struct that will be filled in with the values already programmed to the port
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGEither the pointer was NULL or port number was invalid
ALT_STATUS_CODE alt_sdr_firewall_set ( ALT_SDR_MEM_TARGET_t  target,
ALT_SDR_FIREWALL_ACCESS_t access 
)

alt_sdr_firewall_set - Sets the firewall permissions for a given memory target

Parameters
targetThe memory port target whos permissions are being set
accessA pointer to a struct that specifies which devices may send nonsecure memory accesses to the port
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGEither the pointer was NULL or port number was invalid
ALT_STATUS_CODE alt_sdr_firewall_get ( ALT_SDR_MEM_TARGET_t  target,
ALT_SDR_FIREWALL_ACCESS_t access 
)

alt_sdr_firewall_get - Retreives the firewall permissions for a given memory target

Parameters
targetThe memory port target whos permissions are being read
accessA pointer to a struct that will be filled in with the values already programmed to the memory port
Return values
ALT_E_SUCCESSSuccessful status.
ALT_E_BAD_ARGEither the pointer was NULL or port value was invalid