Udma_ChRxPrms Struct Reference

Detailed Description

UDMA RX channel parameters.

Data Fields
uint8_t	pauseOnError
uint8_t	addrType
uint8_t	chanType
uint16_t	fetchWordSize
uint8_t	busPriority
uint8_t	busQos
uint8_t	busOrderId
uint8_t	dmaPriority
uint16_t	flowIdFwRangeStart
uint16_t	flowIdFwRangeCnt
uint8_t	flowEInfoPresent
uint8_t	flowPsInfoPresent
uint8_t	flowErrorHandling
uint8_t	flowSopOffset
uint8_t	ignoreLongPkts
uint32_t	configDefaultFlow
uint8_t	burstSize

Field Documentation

pauseOnError

uint8_t Udma_ChRxPrms::pauseOnError

[IN] Bool: When set (TRUE), pause channel on error

addrType

uint8_t Udma_ChRxPrms::addrType

[IN] Address type for this channel.

chanType

uint8_t Udma_ChRxPrms::chanType

[IN] Channel type.

fetchWordSize

uint16_t Udma_ChRxPrms::fetchWordSize

[IN] Descriptor/TR Size in 32-bit words

busPriority

uint8_t Udma_ChRxPrms::busPriority

[IN] 3-bit priority value (0=highest, 7=lowest)

busQos

uint8_t Udma_ChRxPrms::busQos

[IN] 3-bit qos value (0=highest, 7=lowest)

busOrderId

uint8_t Udma_ChRxPrms::busOrderId

[IN] 4-bit orderid value

dmaPriority

uint8_t Udma_ChRxPrms::dmaPriority

[IN] This field selects which scheduling bin the channel will be placed in for bandwidth allocation of the Tx DMA units.

flowIdFwRangeStart

uint16_t Udma_ChRxPrms::flowIdFwRangeStart

[IN] Starting flow ID value for firewall check

flowIdFwRangeCnt

uint16_t Udma_ChRxPrms::flowIdFwRangeCnt

[IN] Number of valid flow ID's starting from flowIdFwRangeStart for firewall check

flowEInfoPresent

uint8_t Udma_ChRxPrms::flowEInfoPresent

[IN] default flow config parameter for EPIB

flowPsInfoPresent

uint8_t Udma_ChRxPrms::flowPsInfoPresent

[IN] default flow config parameter for psInfo

flowErrorHandling

uint8_t Udma_ChRxPrms::flowErrorHandling

[IN] default flow config parameter for Error Handling

flowSopOffset

uint8_t Udma_ChRxPrms::flowSopOffset

[IN] default flow config parameter for SOP offset

ignoreLongPkts

uint8_t Udma_ChRxPrms::ignoreLongPkts

[IN] Bool: This field controls whether or not long packets will be treated as exceptions (FALSE) or ignored (TRUE) for the channel. This field is only used when the channel is in split UTC mode.

configDefaultFlow

uint32_t Udma_ChRxPrms::configDefaultFlow

[IN] Bool: This field controls whether or not to program the default flow. TRUE - Configures the default flow equal to the RX channel number FALSE - Doesn't configure the default flow of channel. The caller can allocate and use other generic flows or get the default flow handle and configure the flow using Udma_flowConfig API at a later point of time

burstSize

uint8_t Udma_ChRxPrms::burstSize

[IN] Specifies the nominal burst size and alignment for data transfers on this channel. Note1: In case of packet mode TX channels, the Tx fifoDepth must be at least 2 PSI-L data phases (32 bytes) larger than the burst size given in this field in order to hold the packet info and extended packet info header which is placed at the front of the data packet in addition to the payload i.e. fifoDepth >= (burstSize + 32 bytes)

Below are the supported burst sizes for various channel types Normal Capacity Channel - 64 bytes High Capacity Channel - 64, 128 or 256 bytes Ultra High Capacity Channel - 64, 128 or 256 bytes