csl_wdtclose.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_wdtClose.c
 *
 *   @brief  File for functional layer of CSL API @a CSL_wdtClose()
 *
 *  Path: \\(CSLPATH)\\ipmodules\\wdt\\src
 *
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  01-Sep-2004 Hmm File created.
 * =============================================================================
 */
#include <csl_wdt.h>

/** ============================================================================
 *   @n@b csl_wdtClose.c
 *
 *   @b Description
 *   @n This function marks that CSL for the watchdog timer instance is closed.
 *      CSL for the watchdog timer instance need to be reopened before using any
 *      watchdog timer CSL API.
 *
 *   @b Arguments
 *   @verbatim
            hwdt         Handle to the watchdog timer instance
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK            - Watchdog timer is closed
 *                                               successfully
 *
 *   @li                    CSL_ESYS_BADHANDLE - The handle passed is invalid
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  1. The watchdog timer CSL APIs can not be called until the watchdog timer
 *          CSL is reopened again using CSL_wdtOpen()
 *
 *   @b Modifies
 *   @n  None
 *
 *   @b Example
 *   @verbatim
            CSL_wdtClose (hWdt);
    @endverbatim
 * ===========================================================================
 */
#pragma CODE_SECTION (CSL_wdtClose, ".text:csl_section:wdt");
CSL_Status  CSL_wdtClose (
    CSL_WdtHandle    hWdt
)
{
    CSL_Status  status;

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

    return status;
}