csl_ataclose.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_ataClose.c
 *
 *  @brief File for functional layer of CSL API @a CSL_ataClose()
 *
 *  Description
 *    - The @a CSL_ataClose() function definition & it's associated functions
 *
 *  Path: \\(CSLPATH)\\ipmodules\\ata\\src
 *
 *  Modification 1
 *    - modified on: 2004/03/08
 *    - reason: created the sources
 *
 *  Date 2004/03/08
 *  Author RG Kiran
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  08-Oct-2004 kpn  Updated according to review comments
 *  24-Sep-2004 kpn  Updated according to CSL Upgradation guidelines
 *  ============================================================================
 */

#include <csl_ata.h>

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

            ...

            status = CSL_ataClose(hAta);
     @endverbatim
 *  ============================================================================
 */
#pragma CODE_SECTION (CSL_ataClose, ".text:csl_section:ata");
CSL_Status  CSL_ataClose (
    CSL_AtaHandle          hAta
)
{
    CSL_Status status;

    if (hAta != NULL) {
        hAta->regs    = (CSL_AtaRegsOvly)NULL;
        hAta->ataNum  = (CSL_InstNum)-1;
        status        = CSL_SOK;
    }
    else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}