csl_tmrclose.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_tmrClose.c
 *
 *  @brief File for functional layer of CSL API @a CSL_tmrClose()
 *
 *  Description
 *    - The @a CSL_tmrClose() function definition & it's associated functions
 *
 *  Path: \\(CSLPATH)\\ipmodules\\timer\\src
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  1-Sept-2004 HMM File Created.
 * =============================================================================
 */

#include <csl_tmr.h>

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

            ...

            status = CSL_tmrClose(hTmr);
     @endverbatim
 *  ============================================================================
 */
#pragma CODE_SECTION (CSL_tmrClose, ".text:csl_section:tmr");
CSL_Status CSL_tmrClose (
    CSL_TmrHandle         hTmr
)
{
    CSL_Status  status;

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

    return status;
}