![]() |
![]() |
The file implements the API's which are used to setup the properties of the channel. More...
#include <ti/csl/csl_edma3.h>
#include <ti/csl/csl_edma3Aux.h>
Functions | |
CSL_Status | CSL_edma3HwChannelSetupParam (CSL_Edma3ChannelHandle hEdma, Uint16 paramNum) |
CSL_Status | CSL_edma3HwChannelSetupTriggerWord (CSL_Edma3ChannelHandle hEdma, Uint8 triggerWord) |
CSL_Status | CSL_edma3HwChannelSetupQue (CSL_Edma3ChannelHandle hEdma, CSL_Edma3Que evtQue) |
The file implements the API's which are used to setup the properties of the channel.
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.
CSL_Status CSL_edma3HwChannelSetupParam | ( | CSL_Edma3ChannelHandle | hEdma, |
Uint16 | paramNum | ||
) |
============================================================================
CSL_edma3HwChannelSetupParam
Description
The function maps a DMA/QDMA channel to the specific PARAM Entry.
Arguments
hEdma Channel Handle paramNum Parameter Entry
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameter passed is invalid)
Pre Condition
CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before this API can be invoked
Post Condition
Channel is mapped to the PARAM Entry.
Writes
TPCC_TPCC_DCHMAP_PAENTRY;
TPCC_TPCC_QCHMAP_PAENTRY
Example
CSL_Edma3Handle hModule; CSL_Edma3Obj edmaObj; CSL_Status status; CSL_Edma3ChannelAttr chAttr; CSL_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj,CSL_EDMA3,NULL,&status); ... // Channel 0 Open in context of Shadow region 0 chAttr.regionNum = CSL_EDMA3_REGION_0; chAttr.chaNum = 0; hChannel = CSL_edma3ChannelOpen(&chObj, 0, &chAttr, &status); ... // Map the channel to PARAM Entry 1 CSL_edma3HwChannelSetupParam(hChannel, 1); ...
=============================================================================
CSL_Status CSL_edma3HwChannelSetupQue | ( | CSL_Edma3ChannelHandle | hEdma, |
CSL_Edma3Que | evtQue | ||
) |
============================================================================
CSL_edma3HwChannelSetupQue
Description
The function maps the DMA/QDMA channels to the specified event queue.
Arguments
hEdma Channel Handle evtQue Queue Setup
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Pre Condition
CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before this API can be invoked
Post Condition
Sets up the channel to Queue mapping
Writes
TPCC_TPCC_QDMAQNUM_E0;TPCC_TPCC_QDMAQNUM_E1;TPCC_TPCC_QDMAQNUM_E2; TPCC_TPCC_QDMAQNUM_E3;TPCC_TPCC_QDMAQNUM_E4;TPCC_TPCC_QDMAQNUM_E5; TPCC_TPCC_QDMAQNUM_E6;TPCC_TPCC_QDMAQNUM_E7;
TPCC_TPCC_DMAQNUM_E0;TPCC_TPCC_DMAQNUM_E1;TPCC_TPCC_DMAQNUM_E2; TPCC_TPCC_DMAQNUM_E3;TPCC_TPCC_DMAQNUM_E4;TPCC_TPCC_DMAQNUM_E5; TPCC_TPCC_DMAQNUM_E6;TPCC_TPCC_DMAQNUM_E7
Example
CSL_Edma3Handle hModule; CSL_Edma3Obj edmaObj; CSL_Status status; CSL_Edma3ChannelAttr chAttr; CSL_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj,CSL_EDMA3,NULL,&status); ... // Channel 1 Open in context of Shadow region 0 chAttr.regionNum = CSL_EDMA3_REGION_0; chAttr.chaNum = 16; hChannel = CSL_edma3ChannelOpen(&chObj, 0, &chAttr, &status); ... // Map the channel 1 to Event Queue 3. CSL_edma3HwChannelSetupQue(hChannel,CSL_EDMA3_QUE_3); ...
=============================================================================
CSL_Status CSL_edma3HwChannelSetupTriggerWord | ( | CSL_Edma3ChannelHandle | hEdma, |
Uint8 | triggerWord | ||
) |
============================================================================
CSL_edma3HwChannelSetupTriggerWord
Description
The function is used to setup the trigger word for QDMA Channels.
Arguments
hEdma Channel Handle triggerWord Trigger Word to be configured.
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameter passed is invalid)
Pre Condition
CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before this API can be invoked
Post Condition
Sets up the QDMA Channel to trigger Word
Writes
TPCC_TPCC_QCHMAP_TRWORD
Example
CSL_Edma3Handle hModule; CSL_Edma3Obj edmaObj; CSL_Status status; CSL_Edma3ChannelAttr chAttr; CSL_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj,CSL_EDMA3,NULL,&status); ... // Channel 16 Open in context of Shadow region 0 (This is a QDMA Channel) chAttr.regionNum = CSL_EDMA3_REGION_0; chAttr.chaNum = 16; hChannel = CSL_edma3ChannelOpen(&chObj, 0, &chAttr, &status); ... // Sets up the QDMA Channel 0 trigger Word to the 3rd trigger word. CSL_edma3HwChannelSetupTriggerWord(hChannel,3); ...
=============================================================================