csl_vlynqclose.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_vlynqClose.c> ---- */

/** @file csl_vlynqClose.c
 *
 *    @brief File for functional layer of CSL API @a CSL_vlynqClose()
 *
 *  Description
 *    - The @a CSL_vlynqClose() function definition & it's associated functions
 */

/* ============================================================================
 *  Revision History
 *  ===============
 *  20-Dec-2004 Nsr Updated function and documentation for CSL_vlynqclose.
 *                 - Removed the include file, csl_resource.h.
 *
 * ============================================================================
 */

#include <csl_vlynq.h>

/*
 * ============================================================================
 *   @func CSL_vlynqClose
 *
 *   @b Description
 *   @n This function closes the specified instance of VLYNQ.
 *
 *   @arg  hVlynq
           Handle to the VLYNQ instance
 *
 *   @ret CSL_Status
 *         CSL_SOK            - Close successful
 *         CSL_ESYS_BADHANDLE - Invalid handle
 *
 *   @eg
 *     CSL_vlynqClose (hVlynq);
 * ============================================================================
 */
#pragma CODE_SECTION (CSL_vlynqClose, ".text:csl_section:vlynq");
CSL_Status  CSL_vlynqClose(
    /** Pointer to the object that holds reference to the
     *  instance of VLYNQ requested after the call
     */
    CSL_VlynqHandle                         hVlynq
)
{
    /* Indicate in the CSL global data structure that the peripheral
     * has been unreserved   */
    CSL_Status  status;

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

    return status;
}