Functions
csl_edma3Open.c File Reference

The file implements the API to open the EDMA Module. More...

#include <ti/csl/csl_edma3.h>

Functions

CSL_Edma3Handle CSL_edma3Open (CSL_Edma3Obj *pEdmaObj, CSL_InstNum edmaNum, CSL_Edma3ModuleAttr *pAttr, CSL_Status *pStatus)

Detailed Description

The file implements the API to open 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_Edma3Handle CSL_edma3Open ( CSL_Edma3Obj *  pEdmaObj,
CSL_InstNum  edmaNum,
CSL_Edma3ModuleAttr *  pAttr,
CSL_Status *  pStatus 
)

============================================================================
CSL_edma3Open

Description
This function returns the handle to the EDMA instance. This handle is passed to all other CSL APIs.

Arguments

            pEdmaObj         EDMA Module Object pointer 
            edmaNum          Instance of EDMA                             
            pAttr            EDMA Attribute pointer 
            pStatus          Status of the function call
     

Return Value
Success - Valid Edma handle will be returned if status value is equal to CSL_SOK.
Failure - NULL

Pre Condition
The EDMA must be succesfully initialized via CSL_edma3Init() before calling this function.

Post Condition
1. The status is returned in the status variable. If status returned is

  • CSL_SOK Valid EDMA handle is returned
  • CSL_ESYS_FAIL The EDMA instance is invalid
  • CSL_ESYS_INVPARAMS The Parameter passed is invalid

2. Edma object structure is populated

Affects
None

Example

            CSL_Edma3Handle     hModule;
            CSL_Edma3Obj        edmaObj;
            CSL_Status          status;
            
            // Module Initialization
            CSL_edma3Init(NULL);
            
            // Module Level Open    
            hModule = CSL_edma3Open(&edmaObj,CSL_EDMA3,NULL,&status);
    

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


Copyright 2014, Texas Instruments Incorporated