Introduction

This is UDMA driver init, deinit and common API.

Files
file	udma.h
	UDMA Driver API/interface file.

Data Structures
struct	Udma_InitPrms
	UDMA initialization parameters. More...

struct	Udma_DrvHandle
	UDMA driver object. More...

Functions
int32_t	Udma_init (Udma_DrvHandle drvHandle, const Udma_InitPrms *initPrms)
	UDMA init function. More...

int32_t	Udma_deinit (Udma_DrvHandle drvHandle)
	UDMA deinit function. More...

int32_t	UdmaInitPrms_init (uint32_t instId, Udma_InitPrms *initPrms)
	Udma_InitPrms structure init function. More...

static uint64_t	Udma_defaultVirtToPhyFxn (const void virtAddr, uint32_t chNum, void appData)
	Default virtual to physical translation function. More...

static void *	Udma_defaultPhyToVirtFxn (uint64_t phyAddr, uint32_t chNum, void *appData)
	Default physical to virtual translation function. More...

Typedefs
typedef uint64_t(*	Udma_VirtToPhyFxn) (const void virtAddr, uint32_t chNum, void appData)
	UDMA Virtual to Physical address translation callback function. More...

typedef void (	Udma_PhyToVirtFxn) (uint64_t phyAddr, uint32_t chNum, void *appData)
	UDMA Physical to Virtual address translation callback function. More...

typedef void(*	Udma_PrintFxn) (const char *str)
	UDMA info/debug print function prototype. More...

UDMA Ring Local API's function prototypes
Function prototypes for various local UDMA Ring API's. For Normal RA / LCDMA RA, function pointers will be used to call the appropriate function.
typedef void(*	Udma_ringHandleClearRegsFxn) (Udma_RingHandle ringHandle)
	UDMA Ring handle clear register function prototype. More...

typedef void(*	Udma_ringSetDoorBellFxn) (Udma_RingHandle ringHandle, int32_t count)
	UDMA Ring set doorbell function prototype. More...

typedef void(*	Udma_ringPrimeFxn) (Udma_RingHandle ringHandle, uint64_t phyDescMem)
	UDMA Ring prime function prototype. More...

typedef void(*	Udma_ringPrimeReadFxn) (Udma_RingHandle ringHandle, uint64_t *phyDescMem)
	UDMA Ring prime read function prototype. More...

typedef void (	Udma_ringGetMemPtrFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get mem pointer function prototype. More...

typedef uint32_t(*	Udma_ringGetModeFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get ring mode function prototype. More...

typedef uint32_t(*	Udma_ringGetElementCntFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get element count function prototype. More...

typedef uint32_t(*	Udma_ringGetForwardRingOccFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get forward ring occupancy function prototype. More...

typedef uint32_t(*	Udma_ringGetReverseRingOccFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get reverse ring occupancy function prototype. More...

typedef uint32_t(*	Udma_ringGetWrIdxFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get write index value function prototype. More...

typedef uint32_t(*	Udma_ringGetRdIdxFxn) (Udma_RingHandle ringHandle)
	UDMA Ring get read index value function prototype. More...

typedef int32_t(*	Udma_ringDequeueRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t *phyDescMem)
	UDMA Ring dequeue raw function prototype. More...

typedef int32_t(*	Udma_ringQueueRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t phyDescMem)
	UDMA Ring queue raw function prototype. More...

typedef int32_t(*	Udma_ringFlushRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t *phyDescMem)
	UDMA Ring flush raw function prototype. More...

typedef void(*	Udma_ringSetCfgFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, const Udma_RingPrms *ringPrms)
	UDMA Ring set Cfg function prototype. More...

Typedef Documentation

◆ Udma_VirtToPhyFxn

typedef uint64_t(* Udma_VirtToPhyFxn) (const void *virtAddr, uint32_t chNum, void *appData)

UDMA Virtual to Physical address translation callback function.

This function is used by the driver to convert virtual address to physical address.

Parameters

virtAddr	[IN] Virtual address
chNum	[IN] Channel number passed during channel open
appData	[IN] Callback pointer passed during channel open

Returns: Corresponding physical address

◆ Udma_PhyToVirtFxn

typedef void*(* Udma_PhyToVirtFxn) (uint64_t phyAddr, uint32_t chNum, void *appData)

UDMA Physical to Virtual address translation callback function.

This function is used by the driver to convert physical address to virtual address.

Parameters

phyAddr	[IN] Physical address
chNum	[IN] Channel number passed during channel open
appData	[IN] Callback pointer passed during channel open

Returns: Corresponding virtual address

◆ Udma_PrintFxn

typedef void(* Udma_PrintFxn) (const char *str)

UDMA info/debug print function prototype.

This function is used by the driver to print info/debug messages.

Parameters

str	[OUT] Info string to print.

◆ Udma_ringHandleClearRegsFxn

typedef void(* Udma_ringHandleClearRegsFxn) (Udma_RingHandle ringHandle)

UDMA Ring handle clear register function prototype.

◆ Udma_ringSetDoorBellFxn

typedef void(* Udma_ringSetDoorBellFxn) (Udma_RingHandle ringHandle, int32_t count)

UDMA Ring set doorbell function prototype.

◆ Udma_ringPrimeFxn

typedef void(* Udma_ringPrimeFxn) (Udma_RingHandle ringHandle, uint64_t phyDescMem)

UDMA Ring prime function prototype.

◆ Udma_ringPrimeReadFxn

typedef void(* Udma_ringPrimeReadFxn) (Udma_RingHandle ringHandle, uint64_t *phyDescMem)

UDMA Ring prime read function prototype.

◆ Udma_ringGetMemPtrFxn

typedef void*(* Udma_ringGetMemPtrFxn) (Udma_RingHandle ringHandle)

UDMA Ring get mem pointer function prototype.

◆ Udma_ringGetModeFxn

typedef uint32_t(* Udma_ringGetModeFxn) (Udma_RingHandle ringHandle)

UDMA Ring get ring mode function prototype.

◆ Udma_ringGetElementCntFxn

typedef uint32_t(* Udma_ringGetElementCntFxn) (Udma_RingHandle ringHandle)

UDMA Ring get element count function prototype.

◆ Udma_ringGetForwardRingOccFxn

typedef uint32_t(* Udma_ringGetForwardRingOccFxn) (Udma_RingHandle ringHandle)

UDMA Ring get forward ring occupancy function prototype.

◆ Udma_ringGetReverseRingOccFxn

typedef uint32_t(* Udma_ringGetReverseRingOccFxn) (Udma_RingHandle ringHandle)

UDMA Ring get reverse ring occupancy function prototype.

◆ Udma_ringGetWrIdxFxn

typedef uint32_t(* Udma_ringGetWrIdxFxn) (Udma_RingHandle ringHandle)

UDMA Ring get write index value function prototype.

◆ Udma_ringGetRdIdxFxn

typedef uint32_t(* Udma_ringGetRdIdxFxn) (Udma_RingHandle ringHandle)

UDMA Ring get read index value function prototype.

◆ Udma_ringDequeueRawFxn

typedef int32_t(* Udma_ringDequeueRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t *phyDescMem)

UDMA Ring dequeue raw function prototype.

◆ Udma_ringQueueRawFxn

typedef int32_t(* Udma_ringQueueRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t phyDescMem)

UDMA Ring queue raw function prototype.

◆ Udma_ringFlushRawFxn

typedef int32_t(* Udma_ringFlushRawFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, uint64_t *phyDescMem)

UDMA Ring flush raw function prototype.

◆ Udma_ringSetCfgFxn

typedef void(* Udma_ringSetCfgFxn) (Udma_DrvHandle drvHandle, Udma_RingHandle ringHandle, const Udma_RingPrms *ringPrms)

UDMA Ring set Cfg function prototype.

Function Documentation

◆ Udma_init()

int32_t Udma_init	(	Udma_DrvHandle	drvHandle,
		const Udma_InitPrms *	initPrms
	)

UDMA init function.

Initializes the UDMA drivers. This function should be called before calling any of driver API's and should be called only once.

Requirement: DOX_REQ_TAG(PDK-2576)

Parameters

drvHandle	[IN] UDMA driver handle - static memory needs to allocated by caller. This is used by the driver to maintain the driver states. This cannot be NULL.
initPrms	[IN] UDMA Initialization parameters. If NULL is passed, the default parameters will be assumed - address translation disabled.

Returns: Udma_ErrorCodes

◆ Udma_deinit()

int32_t Udma_deinit ( Udma_DrvHandle drvHandle )

UDMA deinit function.

Uninitializes the drivers and the hardware and should be called during system shutdown. Should not be called if Udma_init() is not called.

Requirement: DOX_REQ_TAG(PDK-2577)

Parameters

drvHandle [IN] UDMA driver handle pointer passed during Udma_init

Returns: Udma_ErrorCodes

◆ UdmaInitPrms_init()

int32_t UdmaInitPrms_init	(	uint32_t	instId,
		Udma_InitPrms *	initPrms
	)

Udma_InitPrms structure init function.

Note: API returns error when there is a failure in intilaizing Udma_RmInitPrms. This can be due to the following reasons:

Wrong entry for resources in Default Board Cfg (Sciclient_defaultBoardCfg_rm.c)
Number of resources reserved in Default Board Cfg is less than the 'minumum requirement' specified as per UDMA RM Shared resource parameters Udma_RmSharedResPrms. In this case, user should reserve more resources in Default Board Cfg OR override the default UDMA RM Shared resource parameters. (Use Udma_rmGetSharedResPrms API to get default UDMA RM Shared resource parameters)
Total number of resources requested for each instance as per UDMA RM Shared resource parameters is greater than the number of resorurces reserved in Default Board Cfg. In this case, user should reduce the requested share for each instance in UDMA RM Shared resource parameters.

Parameters

instId	[IN] Udma_InstanceIdSoc
initPrms	[IN] Pointer to Udma_InitPrms structure.

Returns: Udma_ErrorCodes

◆ Udma_defaultVirtToPhyFxn()

static uint64_t Udma_defaultVirtToPhyFxn	(	const void *	virtAddr,
		uint32_t	chNum,
		void *	appData
	)

inlinestatic

Default virtual to physical translation function.

Parameters

virtAddr	[IN] Virtual address
chNum	[IN] Channel number passed during channel open. Note: When called for functions which is not channel dependent (like ring alloc), this parameter will be set to UDMA_DMA_CH_INVALID.
appData	[IN] Callback pointer passed during channel open. Note: When called for functions which is not channel dependent (like ring alloc), this parameter will be set to NULL.

Returns: Corresponding physical address

◆ Udma_defaultPhyToVirtFxn()

static void * Udma_defaultPhyToVirtFxn	(	uint64_t	phyAddr,
		uint32_t	chNum,
		void *	appData
	)

inlinestatic

Default physical to virtual translation function.

Parameters

phyAddr	[IN] Physical address
chNum	[IN] Channel number passed during channel open. Note: When called for functions which is not channel dependent (like ring alloc), this parameter will be set to UDMA_DMA_CH_INVALID.
appData	[IN] Callback pointer passed during channel open. Note: When called for functions which is not channel dependent (like ring alloc), this parameter will be set to NULL.

Returns: Corresponding virtual address

Introduction

Files

Data Structures

Functions

Typedefs

UDMA Ring Local API's function prototypes

Typedef Documentation

◆ Udma_VirtToPhyFxn

◆ Udma_PhyToVirtFxn

◆ Udma_PrintFxn

◆ Udma_ringHandleClearRegsFxn

◆ Udma_ringSetDoorBellFxn

◆ Udma_ringPrimeFxn

◆ Udma_ringPrimeReadFxn

◆ Udma_ringGetMemPtrFxn

◆ Udma_ringGetModeFxn

◆ Udma_ringGetElementCntFxn

◆ Udma_ringGetForwardRingOccFxn

◆ Udma_ringGetReverseRingOccFxn

◆ Udma_ringGetWrIdxFxn

◆ Udma_ringGetRdIdxFxn

◆ Udma_ringDequeueRawFxn

◆ Udma_ringQueueRawFxn

◆ Udma_ringFlushRawFxn

◆ Udma_ringSetCfgFxn

Function Documentation

◆ Udma_init()

◆ Udma_deinit()

◆ UdmaInitPrms_init()

◆ Udma_defaultVirtToPhyFxn()

◆ Udma_defaultPhyToVirtFxn()