udma_flow.h File Reference

Introduction

UDMA flow related parameters and API.

Go to the source code of this file.

Data Structures
struct	Udma_FlowPrms
	UDMA RX channel flow parameters. More...
struct	Udma_FlowAllocMappedPrms
	UDMA RX channel mapped flow alloc parameters. More...
struct	Udma_FlowHandle
	UDMA flow object. More...

Macros
#define	UDMA_DEFAULT_FLOW_ID   (0x3FFFU)
	Default flow ID. More...
#define	UDMA_FLOW_INVALID   ((uint32_t) 0xFFFF0000U)
	Macro used to specify that flow ID is invalid. More...

Functions
int32_t	Udma_flowAlloc (Udma_DrvHandle drvHandle, Udma_FlowHandle flowHandle, uint32_t flowCnt)
	UDMA flow allocation API. More...
int32_t	Udma_flowAllocMapped (Udma_DrvHandle drvHandle, Udma_FlowHandle flowHandle, const Udma_FlowAllocMappedPrms *flowAllocMappedPrms)
	UDMA mapped flow allocation API. In devices like AM64x, flows are tied to channels. This API is used to allocate a single flow from the mapped free flows which are dedicated for a particular channel. More...
int32_t	Udma_flowFree (Udma_FlowHandle flowHandle)
	UDMA free flows. More...
int32_t	Udma_flowAttach (Udma_DrvHandle drvHandle, Udma_FlowHandle flowHandle, uint32_t flowStart, uint32_t flowCnt)
	UDMA flow attach API. This API is used to attach to an already allocated flow. This API differs from flow alloc API in this aspect - it doesn't allocate resource from RM. Once the flow is attached to, Udma_flowConfig API can be used to configure the flow through sciclient/DMSC API. More...
int32_t	Udma_flowAttachMapped (Udma_DrvHandle drvHandle, Udma_FlowHandle flowHandle, uint32_t mappepdFlowNum, const Udma_FlowAllocMappedPrms *flowAllocMappedPrms)
	UDMA mapped flow attach API. This API is used to attach to an already allocated mapped flow. This API differs from mapped flow alloc API in this aspect - it doesn't allocate resource from RM. Once the flow is attached to, Udma_flowConfig API can be used to configure the flow through sciclient/DMSC API. More...
int32_t	Udma_flowDetach (Udma_FlowHandle flowHandle)
	UDMA flow detach API. More...
int32_t	Udma_flowConfig (Udma_FlowHandle flowHandle, uint32_t flowIdx, const Udma_FlowPrms *flowPrms)
	This API configures the flow configurations. More...
uint32_t	Udma_flowGetNum (Udma_FlowHandle flowHandle)
	Returns the start flow number managed by this flow handle. More...
uint32_t	Udma_flowGetCount (Udma_FlowHandle flowHandle)
	Returns the number of flows managed by this flow handle. More...
void	UdmaFlowPrms_init (Udma_FlowPrms *flowPrms, uint32_t chType)
	Udma_FlowPrms structure init function. More...