csl_nandclose.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_nandClose.c
 *
 *    @brief File for functional layer of CSL API @a CSL_nandClose()
 *
 *  Description
 *    - The @a CSL_nandClose() function definition & it's associated functions
 *
 *  Path: \\(CSLPATH)\\ipmodules\\nfc\\src
 *
 *  Modification 1
 *    - Created on: 28/6/2004
 *    - Reason: created the sources
 *
 *  @date 28th June, 2004
 *  @author Santosh Narayanan.
 */
 
/* =============================================================================
 *  Revision History
 *  ===============
 *  11-Oct-2004 Nsr renamed the local variable "st" as "status"
 *  03-sep-2004 Nsr Updated function and documentation for CSL_nandclose.
 *                 - Removed the include file, csl_resource.h.
 *
 * =============================================================================
 */
 
#include <csl_nand.h>

/** ============================================================================
 *   @n@b CSL_nandClose
 *
 *   @b Description
 *   @n This function closes the specified instance of NAND.
 *
 *   @b Arguments
 *   @verbatim
            hNand            Handle to the NAND instance
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK             - Close successful
 *   @li                    CSL_ESYS_BADHANDLE  - Invalid handle
 *
 *   @b Example
 *   @verbatim
            CSL_NandHandle       hNand;
            CSL_status          status;

            ...

            status = CSL_nandClose(hNand);
     @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_nandClose, ".text:csl_section:nand");
CSL_Status  CSL_nandClose(
    /** Pointer to the object that holds reference to the
     *  instance of NAND requested after the call 
     */
    CSL_NandHandle                         hNand
)
{
    CSL_Status  status;
    
    if (hNand != NULL) {
        hNand->regs    = (CSL_NandRegsOvly)NULL;
        hNand->perNum  = (CSL_InstNum)-1;
        status = CSL_SOK;
    } 
    else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}