csl_msclose.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_msClose.c
 *
 *  @brief File for functional layer of CSL API @a CSL_msClose()
 *
 *  Path: \\(CSLPATH)\\ipmodules\\memstick\\src
 *
 *  Description
 *    - The @a CSL_msClose() function definition & it's associated functions
 *
 *  Date 3 June, 2004
 *  Author Santosh Narayanan
 */

/* =============================================================================
 *  Revision History
 *  ================
 *  14-Dec-2004 kpn Updated function and documentation for CSL_msclose.
 * =============================================================================
 */

#include <csl_ms.h>

/** ============================================================================
 *   @n@b CSL_msClose
 *
 *   @b Description
 *   @n This function closes the specified instance of MS.
 *
 *   @b Arguments
 *   @verbatim
         hMs      Handle to the MS instance
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK            - Close successful
 *   @li                    CSL_ESYS_BADHANDLE - Invalid handle
 *
 *   @b Example
 *   @verbatim
          CSL_status         status;
          CSL_MsObj          msObj;
          CSL_MsHandle       hMs;
          ...

          hMs = CSL_msOpen (&msObj, CSL_MS_PER_CNT, NULL, &status);
          ...
          status = CSL_msClose (hMs);
     @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_msClose, ".text:csl_section:ms");
CSL_Status CSL_msClose (
    CSL_MsHandle         hMs
)
{
    CSL_Status  status;

    if (hMs != NULL) {
        hMs->regs    = (CSL_MsRegsOvly)NULL;
        hMs->msNum   = (CSL_InstNum)-1;
        status       = CSL_SOK;
    }
    else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}