csl_edmaclose.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_edmaClose.c
 *
 *  @brief    File for functional layer of CSL API @a CSL_edmaClose()
 *
 *  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_edmaClose
 *  
 *  @brief
 *     The EDMA module handlde is invalidated and in order to
 *     use the EDMA module it needs to be opened again.
 *
 *   @b Arguments
 *   @verbatim
            hEdma         Handle to the EDMA instance
     @endverbatim
 *
 *   <b> Return Value   CSL_Status
 *   @li                    CSL_SOK            - EDMA is closed
 *                                               successfully
 *
 *   @li                    CSL_ESYS_BADHANDLE - The handle passed is invalid
 *
 *   <b> Pre Condition
 *   @n  None
 *
 *   <b> Post Condition
 *   @n  1. The EDMA CSL APIs can not be called until the EDMA
 *          CSL is reopened again using CSL_uartOpen()
 *
 *   @b Modifies
 *   @n  None
 *
 *  <b> Usage Constraints: </b>
 *  Both @a CSL_edmaInit() and @a CSL_edmaOpen() must be called successfully
 *  in that order before @a CSL_edmaClose() can be called.
 *  
 *  @b Example:
 *  @verbatim
    
    
    CSL_EdmaHandle hEdma;
    ...
    CSL_edmaClose(hEdma);
    @endverbatim
 *
 * ============================================================================
 */
#pragma CODE_SECTION (CSL_edmaClose, ".text:csl_section:edma");
/** This is a module level close require to invalidate the module handle
 *  The module handle must not be used after this API call.
 *
 *  <b> Usage Constraints: </b>
 *  Module Init and open must have done prior to this call.
 *  
 *  @b Example:
    \code
    
    
    CSL_EdmaHandle     edmaHndl;          
    ...
    edmaHndl = CSL_edmaOpen(NULL,CSL_EDMA_0,NULL,&modStatus);
    ...
    CSL_edmaClose(edmaHndl);
    \endcode
 *  
 *  @return Status (CSL_SOK/CSL_ESYS_INVPARAMS)
 *  
 */

CSL_Status CSL_edmaClose(
    CSL_EdmaHandle           hEdma
)
{
    return CSL_SOK;
}