Wakeup Timer (WUT)

Modules
	WUT_Registers

Data Structures
struct	mxc_wut_cfg_t

Typedefs
typedef void(*	mxc_wut_complete_cb_t) (int result)

Enumerations
enum	mxc_wut_pres_t
enum	mxc_wut_mode_t
enum	mxc_wut_unit_t

Functions
void	MXC_WUT_Init (mxc_wut_regs_t *wut, mxc_wut_pres_t pres)
void	MXC_WUT_Shutdown (mxc_wut_regs_t *wut)
void	MXC_WUT_Enable (mxc_wut_regs_t *wut)
void	MXC_WUT_Disable (mxc_wut_regs_t *wut)
void	MXC_WUT_Config (mxc_wut_regs_t *wut, const mxc_wut_cfg_t *cfg)
uint32_t	MXC_WUT_GetCompare (mxc_wut_regs_t *wut)
uint32_t	MXC_WUT_GetCount (mxc_wut_regs_t *wut)
void	MXC_WUT_IntClear (mxc_wut_regs_t *wut)
uint32_t	MXC_WUT_IntStatus (mxc_wut_regs_t *wut)
void	MXC_WUT_SetCompare (mxc_wut_regs_t *wut, uint32_t cmp_cnt)
void	MXC_WUT_SetCount (mxc_wut_regs_t *wut, uint32_t cnt)
int	MXC_WUT_GetTicks (mxc_wut_regs_t *wut, uint32_t time, mxc_wut_unit_t units, uint32_t *ticks)
int	MXC_WUT_GetTime (mxc_wut_regs_t *wut, uint32_t ticks, uint32_t *time, mxc_wut_unit_t *units)
void	MXC_WUT_Edge (mxc_wut_regs_t *wut)
void	MXC_WUT_Store (mxc_wut_regs_t *wut)
void	MXC_WUT_RestoreBBClock (mxc_wut_regs_t *wut, uint32_t dbbFreq)
uint32_t	MXC_WUT_GetSleepTicks (mxc_wut_regs_t *wut)
void	MXC_WUT_Delay_MS (mxc_wut_regs_t *wut, uint32_t waitMs)
int	MXC_WUT_TrimCrystal (mxc_wut_regs_t *wut)
int	MXC_WUT_TrimCrystalAsync (mxc_wut_regs_t *wut, mxc_wut_complete_cb_t cb)
int	MXC_WUT_TrimPending (mxc_wut_regs_t *wut)
int	MXC_WUT_Handler (mxc_wut_regs_t *wut)

Detailed Description

---

Data Structure Documentation

mxc_wut_cfg_t

struct mxc_wut_cfg_t

Wakeup Timer Configuration.

Data Fields
uint32_t	cmp_cnt

Typedef Documentation

mxc_wut_complete_cb_t

typedef void(* mxc_wut_complete_cb_t) (int result)

The callback routine used by the MXC_WUT_TrimCrystalAsync() function to indicate the transaction has completed.

Parameters

result

Error code.

Enumeration Type Documentation

mxc_wut_mode_t

enum mxc_wut_mode_t

Wakeup Timer modes.

Enumerator
MXC_WUT_MODE_CONTINUOUS	Wakeup Timer Mode ONESHOT.
MXC_WUT_MODE_COUNTER	Wakeup Timer Mode CONTINUOUS.
MXC_WUT_MODE_CAPTURE	Wakeup Timer Mode COUNTER.
MXC_WUT_MODE_COMPARE	Wakeup Timer Mode CAPTURE.
MXC_WUT_MODE_GATED	Wakeup Timer Mode COMPARE.
MXC_WUT_MODE_CAPTURE_COMPARE	Wakeup Timer Mode GATED.

mxc_wut_pres_t

enum mxc_wut_pres_t

Wakeup Timer prescaler values.

Enumerator
MXC_WUT_PRES_2	Divide input clock by 1.
MXC_WUT_PRES_4	Divide input clock by 2.
MXC_WUT_PRES_8	Divide input clock by 4.
MXC_WUT_PRES_16	Divide input clock by 8.
MXC_WUT_PRES_32	Divide input clock by 16.
MXC_WUT_PRES_64	Divide input clock by 32.
MXC_WUT_PRES_128	Divide input clock by 64.
MXC_WUT_PRES_256	Divide input clock by 128.
MXC_WUT_PRES_512	Divide input clock by 256.
MXC_WUT_PRES_1024	Divide input clock by 512.
MXC_WUT_PRES_2048	Divide input clock by 1024.
MXC_WUT_PRES_4096	Divide input clock by 2048.

mxc_wut_unit_t

enum mxc_wut_unit_t

Wakeup Timer units of time enumeration.

Enumerator
MXC_WUT_UNIT_NANOSEC	Nanosecond Unit Indicator.
MXC_WUT_UNIT_MICROSEC	Microsecond Unit Indicator.
MXC_WUT_UNIT_MILLISEC	Millisecond Unit Indicator.
MXC_WUT_UNIT_SEC	Second Unit Indicator.

Function Documentation

MXC_WUT_Config()

void MXC_WUT_Config	(	mxc_wut_regs_t *	wut,
		const mxc_wut_cfg_t *	cfg
	)

Configure the timer.

Parameters

wut	Pointer to Wakeup Timer instance to configure.
cfg	Pointer to timer configuration struct.

MXC_WUT_Delay_MS()

void MXC_WUT_Delay_MS	(	mxc_wut_regs_t *	wut,
		uint32_t	waitMs
	)

Delays for the given number of milliseconds.

Parameters

wut	Pointer to Wakeup Timer instance to use as the delay timer.
waitMs	Number of milliseconds to wait.

MXC_WUT_Disable()

void MXC_WUT_Disable

(

mxc_wut_regs_t *

wut

)

Disable the timer.

Parameters

wut	Pointer to Wakeup Timer instance to disable.

MXC_WUT_Edge()

void MXC_WUT_Edge

(

mxc_wut_regs_t *

wut

)

Wait for an edge of the WUT count register.

Parameters

wut	Pointer to Wakeup Timer instance to wait on.

MXC_WUT_Enable()

void MXC_WUT_Enable

(

mxc_wut_regs_t *

wut

)

Enable the timer.

Parameters

wut	Pointer to Wakeup Timer instance to enable.

MXC_WUT_GetCompare()

uint32_t MXC_WUT_GetCompare

(

mxc_wut_regs_t *

wut

)

Get the timer compare count.

Parameters

wut	Pointer to Wakeup Timer instance to get compare value from.

Returns

Returns the current compare count.

MXC_WUT_GetCount()

uint32_t MXC_WUT_GetCount

(

mxc_wut_regs_t *

wut

)

Get the timer count.

Parameters

wut	Pointer to Wakeup Timer instance to get count value from.

Returns

Returns the current count.

MXC_WUT_GetSleepTicks()

uint32_t MXC_WUT_GetSleepTicks

(

mxc_wut_regs_t *

wut

)

Get the difference between the stored counter value and the current counter value.

Parameters

wut	Pointer to Wakeup Timer instance to get current sleep ticks from.

Returns

Returns the current counter value - stored counter value.

MXC_WUT_GetTicks()

int MXC_WUT_GetTicks	(	mxc_wut_regs_t *	wut,
		uint32_t	time,
		mxc_wut_unit_t	units,
		uint32_t *	ticks
	)

Convert real time to timer ticks.

Parameters

wut	Pointer to Wakeup Timer instance to get tick count from.
time	Number of units of time.
units	Which units of time you want to convert.
ticks	Pointer to store the number of ticks calculated.

Returns

E_NO_ERROR If everything is successful.

Error Codes If function is unsuccessful.

MXC_WUT_GetTime()

int MXC_WUT_GetTime	(	mxc_wut_regs_t *	wut,
		uint32_t	ticks,
		uint32_t *	time,
		mxc_wut_unit_t *	units
	)

Convert timer ticks to real time.

Parameters

wut	Pointer to Wakeup Timer instance to get time from.
ticks	Number of ticks.
time	Pointer to store number of units of time.
units	Pointer to store the units that time represents.

Returns

E_NO_ERROR If everything is successful.

Error Codes If function is unsuccessful.

MXC_WUT_Handler()

int MXC_WUT_Handler

(

mxc_wut_regs_t *

wut

)

Interrupt handler for trim procedure.

Parameters

wut	Pointer to Wakeup Timer instance to handle interrupts for.

Returns

E_NO_ERROR If trim is complete, E_BUSY if trim procedure is ongoing.

MXC_WUT_Init()

void MXC_WUT_Init	(	mxc_wut_regs_t *	wut,
		mxc_wut_pres_t	pres
	)

Initialize timer module clock.

Parameters

wut	Pointer to Wakeup Timer instance to initialize.
pres	Prescaler value.

MXC_WUT_IntClear()

void MXC_WUT_IntClear

(

mxc_wut_regs_t *

wut

)

Clear the timer interrupt.

Parameters

wut	Pointer to Wakeup Timer instance to clear interrupts for.

MXC_WUT_IntStatus()

uint32_t MXC_WUT_IntStatus

(

mxc_wut_regs_t *

wut

)

Get the timer interrupt status.

Parameters

wut	Pointer to Wakeup Timer instance to get interrupt status from.

Returns

Returns the interrupt status. 1 if interrupt has occurred.

MXC_WUT_RestoreBBClock()

void MXC_WUT_RestoreBBClock	(	mxc_wut_regs_t *	wut,
		uint32_t	dbbFreq
	)

Restore the DBB clock with the stored count and snapshot values.

Parameters

wut	Pointer to Wakeup Timer instance to restore count and snapshot values for.
dbbFreq	Frequency of DBB clock.

MXC_WUT_SetCompare()

void MXC_WUT_SetCompare	(	mxc_wut_regs_t *	wut,
		uint32_t	cmp_cnt
	)

Set the timer compare count.

Parameters

wut	Pointer to Wakeup Timer instance to set compare value for.
cmp_cnt	New compare count.

Note

This function does not protect against output glitches in PWM mode. Use MXC_WUT_PWMSetPeriod when in PWM mode.

MXC_WUT_SetCount()

void MXC_WUT_SetCount	(	mxc_wut_regs_t *	wut,
		uint32_t	cnt
	)

Set the timer count.

Parameters

wut	Pointer to Wakeup Timer instance to set count valeu for.
cnt	New count.

MXC_WUT_Shutdown()

void MXC_WUT_Shutdown

(

mxc_wut_regs_t *

wut

)

Shutdown timer module clock.

Parameters

wut	Pointer to Wakeup Timer instance to shutdown.

MXC_WUT_Store()

void MXC_WUT_Store

(

mxc_wut_regs_t *

wut

)

Store the count and snapshot values.

Parameters

wut	Pointer to Wakeup Timer instance to store count and snapshot values for.

MXC_WUT_TrimCrystal()

int MXC_WUT_TrimCrystal

(

mxc_wut_regs_t *

wut

)

Trim the 32 kHz crystal load settings, blocks until complete.

This procedure uses the WUT and the BLE DBB, driven by the 32 MHz crystal, to trim the load settings of the 32 kHz crystal. This procedure will only work if the BLE DBB is initialized and running.

Parameters

wut	Pointer to Wakeup Timer instance to trim.

Returns

E_NO_ERROR If everything is successful.

MXC_WUT_TrimCrystalAsync()

int MXC_WUT_TrimCrystalAsync	(	mxc_wut_regs_t *	wut,
		mxc_wut_complete_cb_t	cb
	)

Trim the 32 kHz crystal load settings, non-blocking interrupt based.

This procedure uses the WUT and the BLE DBB, driven by the 32 MHz crystal, to trim the load settings of the 32 kHz crystal. This procedure will only work if the BLE DBB is initialized and running.

Parameters

wut	Pointer to Wakeup Timer instance to trim.
cb	Callback for when the trim is complete.

Returns

E_NO_ERROR If everything is successful.

MXC_WUT_TrimPending()

int MXC_WUT_TrimPending

(

mxc_wut_regs_t *

wut

)

Check to see if the trim procedure is ongoing.

Must leave the 32 MHz clock and BLE DBB running while the trim procedure is pending.

Parameters

wut	Pointer to Wakeup Timer instance to check trim status for.

Returns

E_NO_ERROR If trim is complete, E_BUSY if trim procedure is ongoing.