PDK API Guide for J721E
Udma_FlowHandle Struct Reference

Detailed Description

UDMA flow object.

UDMA flow handle.

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

Data Fields

Udma_DrvHandle drvHandle
 
uint32_t flowStart
 
uint32_t flowCnt
 
uint32_t flowInitDone
 
uint32_t mappedFlowGrp
 
uint32_t mappedChNum
 

Field Documentation

◆ drvHandle

Udma_DrvHandle Udma_FlowHandle::drvHandle

Pointer to global driver handle.

◆ flowStart

uint32_t Udma_FlowHandle::flowStart

Flow ID start number.

Note: In case of mapped flow(in devices like AM64x), this indicates the mapped flow idx managed by this flow handle.

◆ flowCnt

uint32_t Udma_FlowHandle::flowCnt

Number of flow IDs allocated - Contiguos flows are allocated

Note: In case of mapped flow(in devices like AM64x), this will be 1 since only one mapped flow is managed by a flow handle.

◆ flowInitDone

uint32_t Udma_FlowHandle::flowInitDone

Flag to set the flow object is init.

◆ mappedFlowGrp

uint32_t Udma_FlowHandle::mappedFlowGrp

The allocated mapped flow group when channel type is UDMA_CH_TYPE_RX_MAPPED.

This is needed to free the mapped flow.

Refer Udma_MappedRxGrpSoc macro for details about mapped RX flow groups.

For unmapped case, this will be UDMA_MAPPED_GROUP_INVALID

◆ mappedChNum

uint32_t Udma_FlowHandle::mappedChNum

The assigned mapped channel number when channel type is UDMA_CH_TYPE_RX_MAPPED.

This is needed to free the mapped flow.

For unmapped case, this will be UDMA_DMA_CH_INVALID.