Timer (TMR)

Modules
	TMR_Registers

Data Structures
struct	mxc_tmr_cfg_t

Enumerations
enum	mxc_tmr_pres_t
enum	mxc_tmr_mode_t
enum	mxc_tmr_bit_mode_t
enum	mxc_tmr_unit_t
enum	mxc_tmr_clock_t

Functions
int	MXC_TMR_Init (mxc_tmr_regs_t *tmr, mxc_tmr_cfg_t *cfg, bool init_pins)
void	MXC_TMR_Shutdown (mxc_tmr_regs_t *tmr)
void	MXC_TMR_Start (mxc_tmr_regs_t *tmr)
void	MXC_TMR_Stop (mxc_tmr_regs_t *tmr)
int	MXC_TMR_SetPWM (mxc_tmr_regs_t *tmr, uint32_t pwm)
uint32_t	MXC_TMR_GetCompare (mxc_tmr_regs_t *tmr)
uint32_t	MXC_TMR_GetCapture (mxc_tmr_regs_t *tmr)
uint32_t	MXC_TMR_GetCount (mxc_tmr_regs_t *tmr)
uint32_t	MXC_TMR_GetPeriod (mxc_tmr_regs_t *tmr, mxc_tmr_clock_t clock, uint32_t prescalar, uint32_t frequency)
void	MXC_TMR_ClearFlags (mxc_tmr_regs_t *tmr)
uint32_t	MXC_TMR_GetFlags (mxc_tmr_regs_t *tmr)
void	MXC_TMR_EnableInt (mxc_tmr_regs_t *tmr)
void	MXC_TMR_DisableInt (mxc_tmr_regs_t *tmr)
void	MXC_TMR_EnableWakeup (mxc_tmr_regs_t *tmr, mxc_tmr_cfg_t *cfg)
void	MXC_TMR_DisableWakeup (mxc_tmr_regs_t *tmr, mxc_tmr_cfg_t *cfg)
void	MXC_TMR_SetCompare (mxc_tmr_regs_t *tmr, uint32_t cmp_cnt)
void	MXC_TMR_SetCount (mxc_tmr_regs_t *tmr, uint32_t cnt)
void	MXC_TMR_Delay (mxc_tmr_regs_t *tmr, uint32_t us)
void	MXC_TMR_TO_Start (mxc_tmr_regs_t *tmr, uint32_t us)
int	MXC_TMR_TO_Check (mxc_tmr_regs_t *tmr)
void	MXC_TMR_TO_Stop (mxc_tmr_regs_t *tmr)
void	MXC_TMR_TO_Clear (mxc_tmr_regs_t *tmr)
unsigned int	MXC_TMR_TO_Elapsed (mxc_tmr_regs_t *tmr)
unsigned int	MXC_TMR_TO_Remaining (mxc_tmr_regs_t *tmr)
void	MXC_TMR_SW_Start (mxc_tmr_regs_t *tmr)
unsigned int	MXC_TMR_SW_Stop (mxc_tmr_regs_t *tmr)
int	MXC_TMR_GetTime (mxc_tmr_regs_t *tmr, uint32_t ticks, uint32_t *time, mxc_tmr_unit_t *units)

Detailed Description

---

Data Structure Documentation

mxc_tmr_cfg_t

struct mxc_tmr_cfg_t

Timer Configuration.

Data Fields
mxc_tmr_pres_t	pres
mxc_tmr_mode_t	mode
mxc_tmr_bit_mode_t	bitMode
mxc_tmr_clock_t	clock
uint32_t	cmp_cnt
unsigned	pol

Enumeration Type Documentation

mxc_tmr_bit_mode_t

enum mxc_tmr_bit_mode_t

Timer bit mode.

Enumerator
MXC_TMR_BIT_MODE_32	Timer Mode 32 bit.
MXC_TMR_BIT_MODE_16A	Timer Mode Lower 16 bit.
MXC_TMR_BIT_MODE_16B	Timer Mode Upper 16 bit.

mxc_tmr_clock_t

enum mxc_tmr_clock_t

Clock settings.

Note

8M and 32M clocks can be used for Timers 0,1,2 and 3 32K and 80K clocks can only be used for Timers 4 and 5

Enumerator
MXC_TMR_APB_CLK	PCLK CLock.
MXC_TMR_EXT_CLK	External Clock.
MXC_TMR_IBRO_CLK	7.3728MHz Clock
MXC_TMR_ERFO_CLK	32MHz Clock
MXC_TMR_ERTCO_CLK	32.768KHz Clock
MXC_TMR_INRO_CLK	80KHz Clock
MXC_TMR_8M_CLK	8MHz Clock
MXC_TMR_32M_CLK	32MHz Clock
MXC_TMR_32K_CLK	32KHz Clock
MXC_TMR_80K_CLK	80KHz Clock

mxc_tmr_mode_t

enum mxc_tmr_mode_t

Timer modes.

Enumerator
MXC_TMR_MODE_ONESHOT	Timer Mode ONESHOT.
MXC_TMR_MODE_CONTINUOUS	Timer Mode CONTINUOUS.
MXC_TMR_MODE_COUNTER	Timer Mode COUNTER.
MXC_TMR_MODE_PWM	Timer Mode PWM.
MXC_TMR_MODE_CAPTURE	Timer Mode CAPTURE.
MXC_TMR_MODE_COMPARE	Timer Mode COMPARE.
MXC_TMR_MODE_GATED	Timer Mode GATED.
MXC_TMR_MODE_CAPTURE_COMPARE	Timer Mode CAPTURECOMPARE.
MXC_TMR_MODE_DUAL_EDGE	Timer Mode DUALEDGE.

mxc_tmr_pres_t

enum mxc_tmr_pres_t

Timer prescaler values.

Enumerator
MXC_TMR_PRES_1	Divide input clock by 1.
MXC_TMR_PRES_2	Divide input clock by 2.
MXC_TMR_PRES_4	Divide input clock by 4.
MXC_TMR_PRES_8	Divide input clock by 8.
MXC_TMR_PRES_16	Divide input clock by 16.
MXC_TMR_PRES_32	Divide input clock by 32.
MXC_TMR_PRES_64	Divide input clock by 64.
MXC_TMR_PRES_128	Divide input clock by 128.
MXC_TMR_PRES_256	Divide input clock by 256.
MXC_TMR_PRES_512	Divide input clock by 512.
MXC_TMR_PRES_1024	Divide input clock by 1024.
MXC_TMR_PRES_2048	Divide input clock by 2048.
MXC_TMR_PRES_4096	Divide input clock by 4096.

mxc_tmr_unit_t

enum mxc_tmr_unit_t

Timer units of time enumeration.

Enumerator
MXC_TMR_UNIT_NANOSEC	Nanosecond Unit Indicator.
MXC_TMR_UNIT_MICROSEC	Microsecond Unit Indicator.
MXC_TMR_UNIT_MILLISEC	Millisecond Unit Indicator.
MXC_TMR_UNIT_SEC	Second Unit Indicator.

Function Documentation

MXC_TMR_ClearFlags()

void MXC_TMR_ClearFlags

(

mxc_tmr_regs_t *

tmr

)

Clear the timer interrupt.

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_Delay()

void MXC_TMR_Delay	(	mxc_tmr_regs_t *	tmr,
		uint32_t	us
	)

Dealay for a set periord of time measured in microseconds.

Parameters

tmr	The timer
us	microseconds to delay for

MXC_TMR_DisableInt()

void MXC_TMR_DisableInt

(

mxc_tmr_regs_t *

tmr

)

disable interupt

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_DisableWakeup()

void MXC_TMR_DisableWakeup	(	mxc_tmr_regs_t *	tmr,
		mxc_tmr_cfg_t *	cfg
	)

Disable wakeup from sleep.

Parameters

tmr	Pointer to timer module to initialize.
cfg	System configuration object

MXC_TMR_EnableInt()

void MXC_TMR_EnableInt

(

mxc_tmr_regs_t *

tmr

)

enable interupt

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_EnableWakeup()

void MXC_TMR_EnableWakeup	(	mxc_tmr_regs_t *	tmr,
		mxc_tmr_cfg_t *	cfg
	)

Enable wakeup from sleep.

Parameters

tmr	Pointer to timer module to initialize.
cfg	System configuration object

MXC_TMR_GetCapture()

uint32_t MXC_TMR_GetCapture

(

mxc_tmr_regs_t *

tmr

)

Get the timer capture count.

Parameters

tmr	Pointer to timer module to initialize.

Returns

Returns the most recent capture count.

MXC_TMR_GetCompare()

uint32_t MXC_TMR_GetCompare

(

mxc_tmr_regs_t *

tmr

)

Get the timer compare count.

Parameters

tmr	Pointer to timer module to initialize.

Returns

Returns the current compare count.

MXC_TMR_GetCount()

uint32_t MXC_TMR_GetCount

(

mxc_tmr_regs_t *

tmr

)

Get the timer count.

Parameters

tmr	Pointer to timer module to initialize.

Returns

Returns the current count.

MXC_TMR_GetFlags()

uint32_t MXC_TMR_GetFlags

(

mxc_tmr_regs_t *

tmr

)

Get the timer interrupt status.

Parameters

tmr	Pointer to timer module to initialize.

Returns

Returns the interrupt status. 1 if interrupt has occured.

MXC_TMR_GetPeriod()

uint32_t MXC_TMR_GetPeriod	(	mxc_tmr_regs_t *	tmr,
		mxc_tmr_clock_t	clock,
		uint32_t	prescalar,
		uint32_t	frequency
	)

Calculate count for required frequency.

Parameters

tmr	Timer
clock	Clock source.
prescalar	prescalar
frequency	required frequency.

Returns

Returns the period count.

MXC_TMR_GetTime()

int MXC_TMR_GetTime	(	mxc_tmr_regs_t *	tmr,
		uint32_t	ticks,
		uint32_t *	time,
		mxc_tmr_unit_t *	units
	)

Get time from timer.

Parameters

tmr	The timer
ticks	The ticks
time	The time
units	The units

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_TMR_Init()

int MXC_TMR_Init	(	mxc_tmr_regs_t *	tmr,
		mxc_tmr_cfg_t *	cfg,
		bool	init_pins
	)

Initialize timer module clock.

Note

On default this function enables TMR peripheral clock and related GPIOs. if you wish to manage clock and gpio related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove clock and gpio related codes from file.

Parameters

tmr	Pointer to timer module to initialize.
cfg	System configuration object
bool	True will initialize pins corresponding to the TMR and False will not if pins are pinned out otherwise it will not be used, has no effect incase of MSDK_NO_GPIO_CLK_INIT has been defined.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_TMR_SetCompare()

void MXC_TMR_SetCompare	(	mxc_tmr_regs_t *	tmr,
		uint32_t	cmp_cnt
	)

Set the timer compare count.

Parameters

tmr	Pointer to timer module to initialize.
cmp_cnt	New compare count.

Note

In PWM Mode use this to set the value of the second transition.

MXC_TMR_SetCount()

void MXC_TMR_SetCount	(	mxc_tmr_regs_t *	tmr,
		uint32_t	cnt
	)

Set the timer count.

Parameters

tmr	Pointer to timer module to initialize.
cnt	New count.

MXC_TMR_SetPWM()

int MXC_TMR_SetPWM	(	mxc_tmr_regs_t *	tmr,
		uint32_t	pwm
	)

Set the value of the first transition in PWM mode.

Parameters

tmr	Pointer to timer module to initialize.
pwm	New pwm count.

Note

Will block until safe to change the period count.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_TMR_Shutdown()

void MXC_TMR_Shutdown

(

mxc_tmr_regs_t *

tmr

)

Shutdown timer module clock.

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_Start()

void MXC_TMR_Start

(

mxc_tmr_regs_t *

tmr

)

Start the timer counting.

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_Stop()

void MXC_TMR_Stop

(

mxc_tmr_regs_t *

tmr

)

Stop the timer.

Parameters

tmr	Pointer to timer module to initialize.

MXC_TMR_SW_Start()

void MXC_TMR_SW_Start

(

mxc_tmr_regs_t *

tmr

)

Start stopwatch.

Parameters

tmr

The timer

MXC_TMR_SW_Stop()

unsigned int MXC_TMR_SW_Stop

(

mxc_tmr_regs_t *

tmr

)

Stopwatch stop.

Parameters

tmr

The timer

Returns

the time when the stopwatch is stopped.

MXC_TMR_TO_Check()

int MXC_TMR_TO_Check

(

mxc_tmr_regs_t *

tmr

)

Check on time out timer.

Parameters

tmr

The timer

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_TMR_TO_Clear()

void MXC_TMR_TO_Clear

(

mxc_tmr_regs_t *

tmr

)

Clear timeout timer back to zero.

Parameters

tmr

The timer

MXC_TMR_TO_Elapsed()

unsigned int MXC_TMR_TO_Elapsed

(

mxc_tmr_regs_t *

tmr

)

Get elapsed time of timeout timer.

Parameters

tmr

The timer

Returns

Time that has elapsed in timeout timer

MXC_TMR_TO_Remaining()

unsigned int MXC_TMR_TO_Remaining

(

mxc_tmr_regs_t *

tmr

)

Amount of time remaining until timeour.

Parameters

tmr

The timer

Returns

Time that is left until timeout

MXC_TMR_TO_Start()

void MXC_TMR_TO_Start	(	mxc_tmr_regs_t *	tmr,
		uint32_t	us
	)

Start a timer that will time out after a certain number of microseconds.

Note

This uses the 32-it Timer

Parameters

tmr	The timer
us	microseconds to time out after

MXC_TMR_TO_Stop()

void MXC_TMR_TO_Stop

(

mxc_tmr_regs_t *

tmr

)

Stop the Timeout timer.

Parameters

tmr

The timer