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

/* =============================================================================
 *  Revision History
 *  ===============
 *  11-Oct-2004 Hs  updated the code review comments
 *  01-Sep-2004 Hmm File created.
 * =============================================================================
 */
#include <csl_wdt.h>

/** ============================================================================
 *   @n@b CSL_wdtInit
 *
 *   @b Description
 *   @n This is the initialization function for the watchdog timer CSL. The
 *      function must be called before calling any other API from this CSL.
 *      This function is idem-potent. Currently, the function just return status
 *      CSL_SOK, without doing anything.
 *
 *   @b Arguments
 *   @verbatim
        pContext    Pointer to module-context. As watchdog timer doesn't have
                    any context based information user is expected to pass NULL.
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                        CSL_SOK - Always returns
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  The CSL for watchdog timer is initialized
 *
 *   @b Modifies
 *   @n  None
 *
 *   @b Example
 *   @verbatim
            CSL_wdtInit();
     @endverbatim
 * =============================================================================
 */

#pragma CODE_SECTION (CSL_wdtInit, ".text:csl_section:wdt");
CSL_Status  CSL_wdtInit(
     CSL_WdtContext *   pContext
)
{
    /* If the module is already initialized, then error is
     * returned as init done(CSL_EINITDONE). If the user
     * needs to force init more than once, then set the
     * global Context pointer to NULL and invoke CSL_wdtInit()
     */

    CSL_Status status = CSL_SOK;
    pContext = pContext;

    return status;
}