csl_mcbspclose.c

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

/** \file csl_mcbspClose.c
 *
 *  \brief    File for functional layer of CSL API \a CSL_mcbspClose()
 *
 *  Description
 *    - The \a CSL_mcbspClose() function contains definition of the 
 *      functional layer API
 *
 *  Path: \\(CSLPATH)\\ipmodules\\mcbsp\\src
 *
 */

#include <csl_mcbsp.h>

/**
 * Unreserves the MCBSP identified by the handle passed.
 * 
 * <b> Usage Constraints: </b>
 * Both @a CSL_mcbspInit() and @a CSL_mcbspOpen() must be called successfully
 * in that order before @a CSL_mcbspClose() can be called.
 *
 * @b Example:
 * @verbatim


   CSL_mcbspHandle hMcbsp;
   ...
   CSL_mcbspClose(hMcbsp);
   @endverbatim
 * 
 * @return CSL_SOK if successful or an error status (see @a CSL_ESYS_<SYMBOL>)
 */
#pragma CODE_SECTION (CSL_mcbspClose, ".text:csl_section:mcbsp");
CSL_Status  CSL_mcbspClose(
    /** MCBSP handle that was returned by successful call to 
     * @a CSL_mcbspOpen() */
    CSL_McbspHandle    hMcbsp
)
{
    CSL_Status  status;
    
    if (hMcbsp != NULL) {
        hMcbsp->regs    = (CSL_McbspRegsOvly)NULL;
        hMcbsp->perNum  = (CSL_InstNum)-1;
        status = CSL_SOK;
    } else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}