Introduction

EDMA Configuration Utility API definitions.

: NOTE: (C) Copyright 2018 - 2021 Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Go to the source code of this file.

Data Structures
struct	DPEDMA_ChanCfg
	EDMA channel configuration. More...

struct	DPEDMA_3LinkChanCfg
	EDMA channel configuration with 3 shadow channels. More...

struct	DPEDMA_2LinkChanCfg
	EDMA channel configuration with 2 shadow channels. More...

struct	DPEDMA_ChainingCfg
	EDMA chaining configuration. More...

struct	DPEDMA_syncACfg
	EDMA configuration for Sync A copy. More...

struct	DPEDMA_syncABCfg
	EDMA configuration for Sync AB copy. More...

Macros
#define	DPEDMA_NO_ERROR ((int32_t)0)

#define	DPEDMA_EINVAL (DP_ERRNO_DPEDMA_BASE-1)
	Error Code: Invalid argument. More...

#define	DPEDMA_EINVAL_EDMAADDR (DP_ERRNO_DPEDMA_BASE-2)
	Error Code: Invalid EDMA baseaddress. More...

#define	DPEDMA_EDMA_TRIGGER_FAIL (DP_ERRNO_DPEDMA_BASE-3)
	Error Code: EDMA transfer trigger failure. More...

Functions
int32_t	DPEDMA_configDummyChannel (EDMA_Handle handle, uint32_t chType, uint32_t dmaCh, uint32_t tcc, uint32_t *param)

int32_t	DPEDMA_setSourceAddress (EDMA_Handle handle, uint32_t chanId, uint32_t addressVal)

int32_t	DPEDMA_setDestinationAddress (EDMA_Handle handle, uint32_t chanId, uint32_t addressVal)

int32_t	DPEDMA_setBcntAcnt (EDMA_Handle handle, uint32_t chanId, uint32_t BcntAcnt)

int32_t	DPEDMA_startTransfer (EDMA_Handle handle, uint32_t chanId)

uint32_t	DPEDMA_local2Global (uint32_t addr)

int32_t	DPEDMA_configSyncTransfer (EDMA_Handle handle, DPEDMA_ChanCfg chanCfg, DPEDMA_ChainingCfg chainingCfg, DPEDMA_syncABCfg syncABCfg, bool isEventTriggered, bool isIntermediateTransferCompletionEnabled, bool isTransferCompletionEnabled, Edma_EventCallback transferCompletionCallbackFxn, void transferCompletionCallbackFxnArg, Edma_IntrObject *intrObj, uint8_t transferType)

int32_t	DPEDMA_linkParamSets (EDMA_Handle handle, uint16_t fromParamId, uint16_t toParamId)

int32_t	DPEDMA_configSyncAB (EDMA_Handle handle, DPEDMA_ChanCfg chanCfg, DPEDMA_ChainingCfg chainingCfg, DPEDMA_syncABCfg syncABCfg, bool isEventTriggered, bool isIntermediateTransferCompletionEnabled, bool isTransferCompletionEnabled, Edma_EventCallback transferCompletionCallbackFxn, void transferCompletionCallbackFxnArg, Edma_IntrObject *intrObj)

int32_t	DPEDMA_configSyncA_singleFrame (EDMA_Handle handle, DPEDMA_ChanCfg chanCfg, DPEDMA_ChainingCfg chainingCfg, DPEDMA_syncACfg syncACfg, bool isEventTriggered, bool isIntermediateTransferInterruptEnabled, bool isTransferCompletionEnabled, Edma_EventCallback transferCompletionCallbackFxn, void transferCompletionCallbackFxnArg, Edma_IntrObject *intrObj)

int32_t	DPEDMA_configSyncA (EDMA_Handle handle, DPEDMA_ChanCfg chanCfg, DPEDMA_ChainingCfg chainingCfg, DPEDMA_syncACfg syncACfg, bool isEventTriggered, bool isIntermediateTransferInterruptEnabled, bool isTransferCompletionEnabled, Edma_EventCallback transferCompletionCallbackFxn, void transferCompletionCallbackFxnArg, Edma_IntrObject *intrObj)

int32_t	DPEDMA_updateAddressAndTrigger (EDMA_Handle handle, uint32_t srcAddress, uint32_t destAddress, uint8_t channel, uint8_t triggerEnabled)

void	DPEDMA_allocateEDMAChannel (EDMA_Handle handle, uint32_t dmaCh, uint32_t tcc, uint32_t *param)

void	DPEDMA_freeEDMAChannel (EDMA_Handle handle, uint32_t dmaCh, uint32_t tcc, uint32_t param, uint32_t shadowParam)

int32_t	DPEDMA_edmaStartTransferManualTrigger (EDMA_Handle handle, uint32_t channel)

Macro Definition Documentation

◆ DPEDMA_NO_ERROR

#define DPEDMA_NO_ERROR ((int32_t)0)

Function Documentation

◆ DPEDMA_configDummyChannel()

int32_t DPEDMA_configDummyChannel	(	EDMA_Handle	handle,
		uint32_t	chType,
		uint32_t *	dmaCh,
		uint32_t *	tcc,
		uint32_t *	param
	)

◆ DPEDMA_setSourceAddress()

int32_t DPEDMA_setSourceAddress	(	EDMA_Handle	handle,
		uint32_t	chanId,
		uint32_t	addressVal
	)

◆ DPEDMA_setDestinationAddress()

int32_t DPEDMA_setDestinationAddress	(	EDMA_Handle	handle,
		uint32_t	chanId,
		uint32_t	addressVal
	)

◆ DPEDMA_setBcntAcnt()

int32_t DPEDMA_setBcntAcnt	(	EDMA_Handle	handle,
		uint32_t	chanId,
		uint32_t	BcntAcnt
	)

◆ DPEDMA_startTransfer()

int32_t DPEDMA_startTransfer	(	EDMA_Handle	handle,
		uint32_t	chanId
	)

◆ DPEDMA_local2Global()

uint32_t DPEDMA_local2Global ( uint32_t addr )

◆ DPEDMA_configSyncTransfer()

int32_t DPEDMA_configSyncTransfer	(	EDMA_Handle	handle,
		DPEDMA_ChanCfg *	chanCfg,
		DPEDMA_ChainingCfg *	chainingCfg,
		DPEDMA_syncABCfg *	syncABCfg,
		bool	isEventTriggered,
		bool	isIntermediateTransferCompletionEnabled,
		bool	isTransferCompletionEnabled,
		Edma_EventCallback	transferCompletionCallbackFxn,
		void *	transferCompletionCallbackFxnArg,
		Edma_IntrObject *	intrObj,
		uint8_t	transferType
	)

◆ DPEDMA_linkParamSets()

int32_t DPEDMA_linkParamSets	(	EDMA_Handle	handle,
		uint16_t	fromParamId,
		uint16_t	toParamId
	)

◆ DPEDMA_configSyncAB()

int32_t DPEDMA_configSyncAB	(	EDMA_Handle	handle,
		DPEDMA_ChanCfg *	chanCfg,
		DPEDMA_ChainingCfg *	chainingCfg,
		DPEDMA_syncABCfg *	syncABCfg,
		bool	isEventTriggered,
		bool	isIntermediateTransferCompletionEnabled,
		bool	isTransferCompletionEnabled,
		Edma_EventCallback	transferCompletionCallbackFxn,
		void *	transferCompletionCallbackFxnArg,
		Edma_IntrObject *	intrObj
	)

◆ DPEDMA_configSyncA_singleFrame()

int32_t DPEDMA_configSyncA_singleFrame	(	EDMA_Handle	handle,
		DPEDMA_ChanCfg *	chanCfg,
		DPEDMA_ChainingCfg *	chainingCfg,
		DPEDMA_syncACfg *	syncACfg,
		bool	isEventTriggered,
		bool	isIntermediateTransferInterruptEnabled,
		bool	isTransferCompletionEnabled,
		Edma_EventCallback	transferCompletionCallbackFxn,
		void *	transferCompletionCallbackFxnArg,
		Edma_IntrObject *	intrObj
	)

◆ DPEDMA_configSyncA()

int32_t DPEDMA_configSyncA	(	EDMA_Handle	handle,
		DPEDMA_ChanCfg *	chanCfg,
		DPEDMA_ChainingCfg *	chainingCfg,
		DPEDMA_syncACfg *	syncACfg,
		bool	isEventTriggered,
		bool	isIntermediateTransferInterruptEnabled,
		bool	isTransferCompletionEnabled,
		Edma_EventCallback	transferCompletionCallbackFxn,
		void *	transferCompletionCallbackFxnArg,
		Edma_IntrObject *	intrObj
	)

◆ DPEDMA_updateAddressAndTrigger()

int32_t DPEDMA_updateAddressAndTrigger	(	EDMA_Handle	handle,
		uint32_t	srcAddress,
		uint32_t	destAddress,
		uint8_t	channel,
		uint8_t	triggerEnabled
	)

◆ DPEDMA_allocateEDMAChannel()

void DPEDMA_allocateEDMAChannel	(	EDMA_Handle	handle,
		uint32_t *	dmaCh,
		uint32_t *	tcc,
		uint32_t *	param
	)

◆ DPEDMA_freeEDMAChannel()

void DPEDMA_freeEDMAChannel	(	EDMA_Handle	handle,
		uint32_t *	dmaCh,
		uint32_t *	tcc,
		uint32_t *	param,
		uint32_t *	shadowParam
	)

◆ DPEDMA_edmaStartTransferManualTrigger()

int32_t DPEDMA_edmaStartTransferManualTrigger	(	EDMA_Handle	handle,
		uint32_t	channel
	)