Functions
csl_tmrHwControl.c File Reference

The file implements the API which is used to control the TIMER Module. More...

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

Functions

CSL_Status CSL_tmrHwControl (CSL_TmrHandle hTmr, CSL_TmrHwControlCmd cmd, void *arg)

Detailed Description

The file implements the API which is used to control the TIMER Module.

============================================================================
(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_tmrHwControl ( CSL_TmrHandle  hTmr,
CSL_TmrHwControlCmd  cmd,
void *  arg 
)

============================================================================
CSL_tmrHwControl

Description
This function performs various control operations on the timer instance, based on the command passed.

Arguments

            hTmr         Handle to the timer instance
            cmd          Operation to be performed on the timer
            cmdArg       Argument specific to the command
     

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

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

Post Condition
Registers of the timer instance are configured according to the command and the command arguments. The command determines which registers are modified.

Writes
TMR_PRDLO_PRDLO; TMR_PRDHI_PRDHI; TMR_TGCR_PSCHI; TMR_TGCR_TIMLORS=1,TMR_TCR_ENAMODE_LO; TMR_TGCR_TIMHIRS=1,TMR_TCR_ENAMODE_HI; TMR_TCR_ENAMODE_LO=0; TMR_TCR_ENAMODE_HI=0; TMR_TGCR_TIMLORS=0; TMR_TGCR_TIMHIRS=0; TMR_TGCR_TIMLORS=1,TMR_TGCR_TIMHIRS=1, TMR_TCR_ENAMODE_LO,TMR_TCR_ENAMODE_HI; TMR_TCR_ENAMODE_LO=0,TMR_TCR_ENAMODE_HI=0; TMR_TGCR_TIMLORS=0,TMR_TGCR_TIMHIRS=0; TMR_TGCR_TIMLORS=1,TMR_TGCR_TIMHIRS=1,TMR_WDTCR_WDEN=1,TMR_TCR_ENAMODE_LO,TMR_TCR_ENAMODE_HI; TMR_WDTCR_WDKEY

Example

            CSL_status      status;
            CSL_TmrObj      tmrObj;
            CSL_TmrHandle   hTmr;
            CSL_TmrContext  context;

            // Initialize the Timer Module.
            CSL_tmrInit(&context);
            ...
            // Open TIMER 0
            hTmr = CSL_tmrOpen(&tmrObj, 0, NULL, &status);
            ...
            // Start the LO Timer.
            CSL_tmrHwControl(hTmr, CSL_TMR_CMD_START_TIMLO, NULL);
            ...
     

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


Copyright 2014, Texas Instruments Incorporated