csl_mmcsdclose.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_mmcsdClose.c
 *    Path: \\(CSLPATH)\\ipmodules\\mmcsd\\src
 *  @brief File for functional layer of CSL API @a CSL_mmcsdClose()
 *
 *  Description
 *    - The @a CSL_mmcsdClose() function definition & it's associated functions
 *
 *  @date 6 May, 2004
 *  @author Pratheesh Gangadhar
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  12-Oct-2004 Hs Updated according to review comments
 *  31-aug-2004 Hs Updated function and documentation for CSL_mmcsdclose.
 *                 - Removed the include file, csl_resource.h.
 * =============================================================================
 */

#include <csl_mmcsd.h>

/** ============================================================================
 *   @n@b CSL_mmcsdClose
 *                                                                             
 *   @b Description                                                            
 *   @n This function closes the specified instance of MMCSD.
 *                                                                             
 *   @b Arguments                                                              
 *   @verbatim                                                                 
            hMmcsd            Handle to the MMCSD instance
     @endverbatim                                                              
 *                                                                             
 *   <b> Return Value </b>  CSL_Status                                         
 *   @li                    CSL_SOK             - Close successful
 *   @li                    CSL_ESYS_BADHANDLE  - Invalid handle
 *                                                                             
 *   @b Example                                                                
 *   @verbatim                                                                 
            CSL_MmcsdHandle   hMmcsd;                                              
            CSL_status          status;
                                                                               
            ...                                                                
                                                                               
            status = CSL_mmcsdClose(hMmcsd);
     @endverbatim                                                              
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_mmcsdClose, ".text:csl_section:mmcsd");
CSL_Status  CSL_mmcsdClose (
    /** Pointer to the object that holds reference to the
     *  instance of MMCSD requested after the call
     */
    CSL_MmcsdHandle             hMmcsd
)
{
    CSL_Status  status;

    if (hMmcsd != NULL) {
        hMmcsd->regs    = (CSL_MmcsdRegsOvly)NULL;
        hMmcsd->perNum  = (CSL_InstNum)-1;
        status = CSL_SOK;
    }
    else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}