csl_edmainit.c

TI达芬奇dm644x各硬件模块测试代码

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *   ===========================================================================
 */

/** @file csl_edmaInit.c
 *
 *  @brief    File for functional layer of CSL API @a CSL_edmaInit()
 *
 *  Path: \\(CSLPATH)\\ipmodules\\edma\\src
 *
 *  @date 
 *  @author Ruchika Kharwar
 */
 
/* =============================================================================
 *  Revision History
 *  ===============
 *  10-Aug-2005  brn      Updated for doxygen documentation and butification
 * =============================================================================
 */
  
#include <csl_edma.h>

/** ===========================================================================
 *   @n@b   CSL_edmaInit
 *
 *  @b Description
 *  @n This is EDMA module's init function. This initializes the context Object
 *     variables.
 *
 *  <b> Usage Constraints: </b>
 *  CSL system initialization must be successfully completed by invoking
 *  @a CSL_sysInit() before calling this function. This function should be
 *  called before using any of the CSL APIs
 *
 *   @b Arguments
     @verbatim
            pContext        Context information for the instance. Should be NULL
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Always returns
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n  None
 *
 *   @b Example
 *  @verbatim
    ...
    CSL_sysInit( NULL );
    if (CSL_SOK != CSL_edmaInit( NULL )) {
        return;
    }
    @endverbatim
 *  
 *  @return returns the status of the operation
 *
 * ============================================================================
 */
#pragma CODE_SECTION (CSL_edmaInit, ".text:csl_section:edma");
/** This function is idempotent in that calling it many times is same as
 * calling it once. This function initializes the EDMA.
 *
 * <b> Usage Constraints: </b>
 * This function should be called before using any of the CSL
 * EDMA APIs.
 *
 * @b Example:
 * \code
 
   ...
   if (CSL_edmaInit(NULL) != CSL_SOK) {
       exit;
   }
   \endcode
 *
 * @return Status (CSL_SOK)
 *
 */
CSL_Status CSL_edmaInit (
    CSL_EdmaContext     *pContext
)
{
    CSL_Status status = CSL_SOK;
    *pContext = *pContext; /* To avoid compiler warning/remark.*/
    return status;
}