csl_pwminit.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_pwmInit.c
 *  
 *  @brief    File for functional layer of CSL API @a CSL_pwmInit()
 *
 *  Path: \\(CSLPATH)\\ipmodules\\pwm\\src
 *
 *  Description
 *    - The @a CSL_pwmInit() function definition & it's associated functions
 *
 *  @date 27 April, 2004
 *  @author Pratheesh Gangadhar
 */
 
/* =============================================================================
 *  Revision History
 *  ===============
 *  03-Oct-2004 brn Updated for the new CSL architecture.
 *  11-Oct_2004 brn File updated with the review comments
 * =============================================================================
 */


#include <csl_pwm.h>

/** ===========================================================================
 *   @n@b   CSL_pwmInit
 *
 *   @b Description
 *   @n This function is idempotent in that calling it many times is same as
 *   calling it once. This function initializes the PWM CSL data structures.
 *
 *   @b Arguments
     @verbatim
            pContext   Context information for the instance. Should be NULL
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Always returns
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  None
 *
 *   @b Modifies
 *   @n  None
 *
 *   @b Example
 *  @verbatim
    ...
    CSL_sysInit( NULL );
    if (CSL_SOK != CSL_pwmInit( NULL )) {
        return;
    }
    @endverbatim
 *  <b> Usage Constraints: </b>
 *  CSL system initialization must be successfully completed by invoking
 *  @a CSL_sysInit() before calling this function. This function should be
 *  called before using any of the CSL APIs
 *  
 *  @b Example:
 *  @verbatim
    CSL_Status    status;
    ...
    status = CSL_pwmInit( NULL )
    if (CSL_SOK != status) {
        return;
    }
    @endverbatim
 *  
 *  @return returns the status of the operation
 *
 * ============================================================================
 */
#pragma CODE_SECTION (CSL_pwmInit, ".text:csl_section:pwm");
CSL_Status  CSL_pwmInit (
    CSL_PwmContext          * 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_pwmInit()
     */ 
    return CSL_SOK;
}