MotorWare f2806x Driver API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Enumerations | Functions
timer.h File Reference

Contains public interface to various functions related to the timer (TIMER) object. More...

`#include "sw/modules/types/src/types.h"`

Go to the source code of this file.

## Data Structures
struct | _TIMER_Obj_
| Defines the timer (TIMER) object. More...

## Macros
#define | TIMER0_BASE_ADDR (0x00000C00)
| Defines the base address of the timer (TIMER) 0 registers. More...
#define | TIMER1_BASE_ADDR (0x00000C08)
| Defines the base address of the timer (TIMER) 1 registers. More...
#define | TIMER2_BASE_ADDR (0x00000C10)
| Defines the base address of the timer (TIMER) 2 registers. More...
#define | TIMER_TCR_TSS_BITS (1 << 4)
| Defines the location of the TSS bits in the TCR register. More...
#define | TIMER_TCR_TRB_BITS (1 << 5)
| Defines the location of the TRB bits in the TCR register. More...
#define | TIMER_TCR_FREESOFT_BITS (3 << 10)
| Defines the location of the FREESOFT bits in the TCR register. More...
#define | TIMER_TCR_TIE_BITS (1 << 14)
| Defines the location of the TIE bits in the TCR register. More...
#define | TIMER_TCR_TIF_BITS (1 << 15)
| Defines the location of the TIF bits in the TCR register. More...

## Typedefs
typedef struct _TIMER_Obj_ | TIMER_Obj
| Defines the timer (TIMER) object. More...
typedef struct _TIMER_Obj_ * | TIMER_Handle
| Defines the timer (TIMER) handle. More...

## Enumerations
enum | TIMER_EmulationMode_e { TIMER_EmulationMode_StopAfterNextDecrement =(0 << 10), TIMER_EmulationMode_StopAtZero =(1 << 10), TIMER_EmulationMode_RunFree =(2 << 10) }
| Enumeration to define the timer (TIMER) emulation mode. More...
enum | TIMER_Status_e { TIMER_Status_CntIsNotZero =(0 << 15), TIMER_Status_CntIsZero =(1 << 15) }
| Enumeration to define the timer (TIMER) status. More...

## Functions
void | TIMER_clearFlag (TIMER_Handle timerHandle)
| Clears the timer (TIMER) flag. More...
void | TIMER_disableInt (TIMER_Handle timerHandle)
| Disables the timer (TIMER) interrupt. More...
void | TIMER_enableInt (TIMER_Handle timerHandle)
| Enables the timer (TIMER) interrupt. More...
static uint32_t | TIMER_getCount (TIMER_Handle timerHandle)
| Gets the timer (TIMER) count. More...
TIMER_Status_e | TIMER_getStatus (TIMER_Handle timerHandle)
| Gets the timer (TIMER) status. More...
TIMER_Handle | TIMER_init (void *pMemory, const size_t numBytes)
| Initializes the timer (TIMER) object handle. More...
static void | TIMER_reload (TIMER_Handle timerHandle)
| Reloads the timer (TIMER) value. More...
void | TIMER_setDecimationFactor (TIMER_Handle timerHandle, const uint16_t decFactor)
| Sets the timer (TIMER) decimation factor. More...
void | TIMER_setEmulationMode (TIMER_Handle timerHandle, const TIMER_EmulationMode_e mode)
| Sets the timer (TIMER) emulation mode. More...
static uint32_t | TIMER_getPeriod (TIMER_Handle timerHandle)
| Gets the timer (TIMER) period. More...
static void | TIMER_setPeriod (TIMER_Handle timerHandle, const uint32_t period)
| Sets the timer (TIMER) period. More...
void | TIMER_setPreScaler (TIMER_Handle timerHandle, const uint16_t preScaler)
| Sets the timer (TIMER) prescaler. More...
static void | TIMER_start (TIMER_Handle timerHandle)
| Starts the timer (TIMER) More...
static void | TIMER_stop (TIMER_Handle timerHandle)
| Stops the timer (TIMER) More...

## Detailed Description

Contains public interface to various functions related to the timer (TIMER) object.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file timer.h.