Functions
csl_tmrHwSetupRaw.c File Reference

The file implements the Timer Hadware Setup RAW API which is used to configure all the timer registers. More...

#include <ti/csl/csl_tmr.h>
#include <ti/csl/csl_tmrAux.h>

Functions

CSL_Status CSL_tmrHwSetupRaw (CSL_TmrHandle hTmr, CSL_TmrConfig *config)

Detailed Description

The file implements the Timer Hadware Setup RAW API which is used to configure all the timer registers.

============================================================================
(C) Copyright 2002-2011, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Function Documentation

CSL_Status CSL_tmrHwSetupRaw ( CSL_TmrHandle  hTmr,
CSL_TmrConfig *  config 
)

============================================================================
CSL_tmrHwSetupRaw

Description
This function initializes the device registers with the register-values provided through the config data structure.

Arguments

            hTmr            Pointer to the object that holds reference to the
                            instance of TIMER requested after the call
            config          Pointer to the config structure containing the
                            device register values
     

Return Value
Success - CSL_SOK
Error - CSL_ESYS_BADHANDLE (The handle passed is invalid)
Error - CSL_ESYS_INVPARAMS (The parameter passed is invalid)

Pre Condition
Both CSL_tmrInit() and CSL_tmrOpen() must be called.

Post Condition
The registers of the specified General purpose timer instance will be setup according to the values passed through the config structure

Writes
TMR_CNTLO_CNT,TMR_CNTHI_CNT,TMR_PRDLO_PRDLO,TMR_PRDHI_PRDHI,TMR_TCR_TCR,TMR_TGCR_TGCR, TMR_WDTCR_WDTCR

Example

            CSL_status      status;
            CSL_TmrObj      tmrObj;
            CSL_TmrHandle   hTmr;
            CSL_TmrContext  context;
            CSL_TmrConfig   config = CSL_TMR_CONFIG_DEFAULTS;

            // Initialize the Timer Module.
            CSL_tmrInit(&context);
            ...
            // Open TIMER 0
            hTmr = CSL_tmrOpen(&tmrObj, 0, NULL, &status);
            ...
            // Configure the timer with the 'defaults'
            CSL_tmrHwSetupRaw (hTmr, &config);
            ...
     

===========================================================================


Copyright 2014, Texas Instruments Incorporated