csl_bwmngmtclose.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_bwmngmtClose.c
 *
 *    @brief File for functional layer of CSL API @a CSL_bwmngmtClose()
 *
 *  Description
 *    - The @a CSL_bwmngmtClose() function definition & it's associated functions
 *
 *  PATH  \\(CSLPATH)\\ipmodules\\bwmngmt\\src
 *
 *  @date 3rd June, 2004
 *  @author Chad Courtney
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  11-Apr-2005 Brn updated the file for doxygen compatibiliy
 *
 * =============================================================================
 */

#include <csl_bwmngmt.h>

/** ============================================================================
 *   @n@b CSL_bwmngmtClose
 *
 *   @b Description
 *   @n This function closes the specified instance of BWMNGMT.
 *
 *  <b> Usage Constraints: </b>
 *  Both @a CSL_bwmngmtInit() and @a CSL_bwmngmtOpen() must be called successfully
 *  in that order before @a CSL_bwmngmtClose() can be called.
 *
 *   @b Arguments
 *   @verbatim
         hBwmngmt           Handle to the BWMNGMT instance
 *    @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Close successful
 *                          CSL_ESYS_BADHANDLE - Invalid handle
 *
 *   @b Example
 *   @verbatim
 *     CSL_bwmngmtClose (hBwmngmt);
 *
 *  @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_bwmngmtClose, ".text:csl_section:bwmngmt");
CSL_Status  CSL_bwmngmtClose(
   /** Pointer to the object that holds reference to the
     * instance of bwmngmt requested after the call */
    CSL_BwmngmtHandle           hBwmngmt
)
{
    /* indicate in the CSL global data structure that the peripheral
     * has been unreserved
     */

    return CSL_SOK;
}