![]() |
![]() |
The file implements API's which are used to retreive setup information specific to an opened EDMA Channel. More...
#include <ti/csl/csl_edma3.h>
#include <ti/csl/csl_edma3Aux.h>
Functions | |
CSL_Status | CSL_edma3GetHwChannelSetupParam (CSL_Edma3ChannelHandle hEdma, Uint16 *paramNum) |
CSL_Status | CSL_edma3GetHwChannelSetupTriggerWord (CSL_Edma3ChannelHandle hEdma, Uint8 *triggerWord) |
CSL_Status | CSL_edma3GetHwChannelSetupQue (CSL_Edma3ChannelHandle hEdma, CSL_Edma3Que *evtQue) |
The file implements API's which are used to retreive setup information specific to an opened EDMA 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_edma3GetHwChannelSetupParam | ( | CSL_Edma3ChannelHandle | hEdma, |
Uint16 * | paramNum | ||
) |
============================================================================
CSL_edma3GetHwChannelSetupParam
Description
The function gets the DMA/QDMA Channel to PARAM Entry Mapping.
Arguments
hEdma Channel Handle paramNum Pointer to parameter entry to which the channel is mapped.
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameters passed is invalid)
Pre Condition
Functions CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before CSL_edma3GetHwChannelSetupParam() can be invoked.
Post Condition
None
Reads
TPCC_TPCC_DCHMAP_PAENTRY;
TPCC_TPCC_QCHMAP_PAENTRY
Example
CSL_Edma3Handle hModule; CSL_Edma3Obj edmaObj; CSL_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; CSL_Edma3ChannelAttr chAttr; CSL_Status status; Uint16 paramNum; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj, 0, 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); ... // Get the parameter entry number to which a channel is mapped to CSL_edma3GetHwChannelSetupParam(hChannel,¶mNum); ...
=============================================================================
CSL_Status CSL_edma3GetHwChannelSetupQue | ( | CSL_Edma3ChannelHandle | hEdma, |
CSL_Edma3Que * | evtQue | ||
) |
============================================================================
CSL_edma3GetHwChannelSetupQue
Description
The function gets the event queue to which the specific DMA/QDMA channel is mapped.
Arguments
hEdma Channel Handle evtQue Event Queue to which the DMA/QDMA channel is mapped.
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameters passed is invalid)
Pre Condition
Functions CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before CSL_edma3GetHwChannelSetupQue() can be called.
Post Condition
None
Reads
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_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; CSL_Edma3ChannelAttr chAttr; CSL_Status status; CSL_Edma3Que evtQue; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj, 0, 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); ... // Get the trigger word programmed for the channel CSL_edma3GetHwChannelSetupQue(hChannel, &evtQue); ...
=============================================================================
CSL_Status CSL_edma3GetHwChannelSetupTriggerWord | ( | CSL_Edma3ChannelHandle | hEdma, |
Uint8 * | triggerWord | ||
) |
============================================================================
CSL_edma3GetHwChannelSetupTriggerWord
Description
The function gets the Trigger word for a specific QDMA Channel.
Arguments
hEdma Channel Handle (Only QDMA Channels) triggerWord Pointer to Trigger word populated by this API.
Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameters passed is invalid)
Pre Condition
Functions CSL_edma3Init(), CSL_edma3Open() and CSL_edma3ChannelOpen() must be called successfully in that order before CSL_edma3GetHwChannelSetupTriggerWord() can be called.
Post Condition
None
Reads
TPCC_TPCC_QCHMAP0_TRWORD
Example
CSL_Edma3Handle hModule; CSL_Edma3Obj edmaObj; CSL_Edma3ChannelObj chObj; CSL_Edma3ChannelHandle hChannel; CSL_Edma3ChannelAttr chAttr; CSL_Status status; Uint8 triggerWord; // Module Initialization CSL_edma3Init(NULL); // Module Level Open hModule = CSL_edma3Open(&edmaObj, 0, 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); ... // Get the trigger word programmed for the channel CSL_edma3GetHwChannelSetupTriggerWord(hChannel,&triggerWord); ...
=============================================================================