PDK API Guide for J721E
CSL_UdmapTxChanCfg Struct Reference

Detailed Description

Transmit channel configuration information.

This structure contains configuration information for a transmit channel.

Data Fields

uint32_t pauseOnError
 
uint32_t filterEinfo
 
uint32_t filterPsWords
 
CSL_UdmapAddrType addrType
 
CSL_UdmapChanType chanType
 
uint32_t fetchWordSize
 
uint32_t trEventNum
 
uint32_t errEventNum
 
uint32_t busPriority
 
uint32_t busQos
 
uint32_t busOrderId
 
CSL_UdmapChanSchedPri dmaPriority
 
uint32_t txCredit
 
uint32_t txTrCQ
 
uint32_t txThread
 
bool bNoTeardownCompletePkt
 
uint32_t tdType
 

Field Documentation

◆ pauseOnError

uint32_t CSL_UdmapTxChanCfg::pauseOnError

[IN] When set, pause channel on error

◆ filterEinfo

uint32_t CSL_UdmapTxChanCfg::filterEinfo

[IN] When set, filter out extended info

◆ filterPsWords

uint32_t CSL_UdmapTxChanCfg::filterPsWords

[IN] When set, filter out protocl specific words

◆ addrType

CSL_UdmapAddrType CSL_UdmapTxChanCfg::addrType

[IN] Address type for this channel

◆ chanType

CSL_UdmapChanType CSL_UdmapTxChanCfg::chanType

[IN] Channel type

◆ fetchWordSize

uint32_t CSL_UdmapTxChanCfg::fetchWordSize

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

◆ trEventNum

uint32_t CSL_UdmapTxChanCfg::trEventNum

[IN] Specifies a global event number to generate anytime the required event generation criteria specified in a TR are met (set to CSL_UDMAP_NO_EVENT for no event generation)

◆ errEventNum

uint32_t CSL_UdmapTxChanCfg::errEventNum

[IN] Specifies a global event number to generate anytime an error is encountered on the channel (set to CSL_UDMAP_NO_EVENT for no event generation)

◆ busPriority

uint32_t CSL_UdmapTxChanCfg::busPriority

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

◆ busQos

uint32_t CSL_UdmapTxChanCfg::busQos

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

◆ busOrderId

uint32_t CSL_UdmapTxChanCfg::busOrderId

[IN] 4-bit orderid value

◆ dmaPriority

CSL_UdmapChanSchedPri CSL_UdmapTxChanCfg::dmaPriority

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

◆ txCredit

uint32_t CSL_UdmapTxChanCfg::txCredit

[IN] TX credit for external channels

◆ txTrCQ

uint32_t CSL_UdmapTxChanCfg::txTrCQ

[IN] TX TR Completion Queue

◆ txThread

uint32_t CSL_UdmapTxChanCfg::txThread

[IN] TX mapped destination thread

◆ bNoTeardownCompletePkt

bool CSL_UdmapTxChanCfg::bNoTeardownCompletePkt

[IN] Specifies whether or not the channel should suppress sending the single data phase teardown packet when teardown is complete. 0 = TD packet is sent, 1 = Suppress sending TD packet

◆ tdType

uint32_t CSL_UdmapTxChanCfg::tdType

[IN] Specifies whether or not the channel should immediately return a teardown completion response to the default completion queue or wait until a status message is returned from the remote PSI-L paired peripheral. 0 = return immediately once all traffic is complete in UDMAP, 1 = wait until remote peer sends back a completion message. Valid in udmap version 2.0.0 and later.