Functions
csl_edma3GetHwStatus.c File Reference

The file implements the API which to get status of various entities in the EDMA module. More...

#include <ti/csl/csl_edma3.h>
#include <ti/csl/csl_edma3Aux.h>

Functions

CSL_Status CSL_edma3GetHwStatus (CSL_Edma3Handle hMod, CSL_Edma3HwStatusQuery myQuery, void *response)

Detailed Description

The file implements the API which to get status of various entities in the EDMA module.

============================================================================
(C) Copyright 2002, 2003, 2004, 2005, 2008, 2009, 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.


Function Documentation

CSL_Status CSL_edma3GetHwStatus ( CSL_Edma3Handle  hMod,
CSL_Edma3HwStatusQuery  myQuery,
void *  response 
)

============================================================================
CSL_edma3GetHwStatus

Description
The function gets the status of various entities in the EDMA module. The entity whose status needs to be retreived is specified in the query and the response is populated in the 'response'.

Arguments

            hMod            Edma module handle
            myQuery         Query to be performed
            response        Pointer to buffer to return the data requested by
                            the query passed
     
See also:
CSL_Edma3HwStatusQuery

Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameter passed is invalid)
Error - CSL_ESYS_INVQUERY (The query is invalid)

Pre Condition
Functions CSL_edma3Init(), CSL_edma3Open() must be called successfully in that order before this API can be invoked.argument type that can be void* casted & passed with a particular command refer to CSL_Edma3HwStatusQuery

Post Condition
None

Reads
TPCC_TPCC_CFG,TPCC_TPCC_PID;

Example

            CSL_Edma3Handle             hModule;
            CSL_Edma3Obj                edmaObj;
            CSL_Status                  status;
            CSL_Edma3QueryInfo          info;
        
            // Module Initialization
            CSL_edma3Init(NULL);
            
            // Module Level Open    
            hModule = CSL_edma3Open(&edmaObj,CSL_EDMA3,NULL,&status);
            ...
            // Query Module Info 
            CSL_edma3GetHwStatus(hModule,CSL_EDMA3_QUERY_INFO,&info);  
            ...
     

=============================================================================


Copyright 2014, Texas Instruments Incorporated