Udma_RingHandle Struct Reference

Detailed Description

UDMA ring object.

UDMA ring handle.

Note: This is an internal/private driver structure and should not be used or modified by caller.

Data Fields
Udma_DrvHandle	drvHandle
uint16_t	ringNum
uint32_t	ringInitDone
uint32_t	mappedRingGrp
uint32_t	mappedChNum

Field Documentation

drvHandle

Udma_DrvHandle Udma_RingHandle::drvHandle

Pointer to global driver handle.

ringNum

uint16_t Udma_RingHandle::ringNum

Ring number

ringInitDone

uint32_t Udma_RingHandle::ringInitDone

Flag to set the ring object is init.

mappedRingGrp

uint32_t Udma_RingHandle::mappedRingGrp

The allocated mapped ring group when channel type is UDMA_CH_TYPE_TX_MAPPED or UDMA_CH_TYPE_RX_MAPPED.

This is needed to free the mapped ring.

Refer Udma_MappedTxGrpSoc macro for details about mapped TX ring groups or Udma_MappedRxGrpSoc macro for details about mapped RX ring groups.

For unmapped case, this will be UDMA_MAPPED_GROUP_INVALID

mappedChNum

uint32_t Udma_RingHandle::mappedChNum

The assigned mapped channel number when channel type is UDMA_CH_TYPE_TX_MAPPED or UDMA_CH_TYPE_RX_MAPPED.

This is needed to free the mapped ring.

For unmapped case, this will be UDMA_DMA_CH_INVALID.