HTMR

Modules
	HTMR_Registers

Enumerations
enum	mxc_htmr_int_en_t
enum	mxc_htmr_int_fl_t

Functions
int	MXC_HTMR_EnableInt (mxc_htmr_regs_t *htmr, uint32_t mask)
int	MXC_HTMR_DisableInt (mxc_htmr_regs_t *htmr, uint32_t mask)
int	MXC_HTMR_SetLongAlarm (mxc_htmr_regs_t *htmr, uint32_t interval)
int	MXC_HTMR_SetShortAlarm (mxc_htmr_regs_t *htmr, uint32_t interval)
int	MXC_HTMR_Start (mxc_htmr_regs_t *htmr)
int	MXC_HTMR_Stop (mxc_htmr_regs_t *htmr)
int	MXC_HTMR_Init (mxc_htmr_regs_t *htmr, uint32_t longInterval, uint8_t shortInterval)
int	MXC_HTMR_CheckBusy (mxc_htmr_regs_t *htmr)
int	MXC_HTMR_GetFlags (mxc_htmr_regs_t *htmr)
int	MXC_HTMR_ClearFlags (mxc_htmr_regs_t *htmr, int flags)
int	MXC_HTMR_GetShortCount (mxc_htmr_regs_t *htmr)
int	MXC_HTMR_GetLongCount (mxc_htmr_regs_t *htmr)

Detailed Description

Enumeration Type Documentation

mxc_htmr_int_en_t

enum mxc_htmr_int_en_t

Bitmasks for each of the HTimer's interrupt enables.

Enumerator
MXC_HTMR_INT_EN_LONG	Long-interval alarm interrupt enable.
MXC_HTMR_INT_EN_SHORT	Short-interval alarm interrupt enable.
MXC_HTMR_INT_EN_READY	Timer ready interrupt enable.

mxc_htmr_int_fl_t

enum mxc_htmr_int_fl_t

Bitmasks for each of the HTimer's interrupt flags.

Enumerator
MXC_HTMR_INT_FL_LONG	Long-interval alarm interrupt flag.
MXC_HTMR_INT_FL_SHORT	Short-interval alarm interrupt flag.
MXC_HTMR_INT_FL_READY	Timer ready interrupt flag.

Function Documentation

MXC_HTMR_CheckBusy()

int MXC_HTMR_CheckBusy

(

mxc_htmr_regs_t *

htmr

)

Check if BUSY bit is 0.

Parameters

htmr	pointer to the htmr register structure

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_ClearFlags()

int MXC_HTMR_ClearFlags	(	mxc_htmr_regs_t *	htmr,
		int	flags
	)

Clear interrupt flags.

Parameters

htmr	pointer to the htmr register structure
flags	The bitwise OR of the interrupts flags to cleear. See mxc_htmr_int_fl_t for the list of possible flags.

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_DisableInt()

int MXC_HTMR_DisableInt	(	mxc_htmr_regs_t *	htmr,
		uint32_t	mask
	)

Disable Interurpts.

Parameters

htmr	pointer to the htmr register structure
mask	The mask of interrupts to disable. See mxc_htmr_int_en_t for available choices.

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_EnableInt()

int MXC_HTMR_EnableInt	(	mxc_htmr_regs_t *	htmr,
		uint32_t	mask
	)

Enable Interurpts.

Parameters

htmr	pointer to the htmr register structure
mask	The bitwise OR of interrupts to enable. See mxc_htmr_int_en_t for available choices.

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_GetFlags()

int MXC_HTMR_GetFlags

(

mxc_htmr_regs_t *

htmr

)

Get interrupt flags.

Parameters

htmr	pointer to the htmr register structure

Returns

The bitwise OR of any interrupts flags that are currently set. See mxc_htmr_int_fl_t for the list of possible flags.

MXC_HTMR_GetLongCount()

int MXC_HTMR_GetLongCount

(

mxc_htmr_regs_t *

htmr

)

Get value in long interval register.

Parameters

htmr	pointer to the htmr register structure

Returns

returns long count value

MXC_HTMR_GetShortCount()

int MXC_HTMR_GetShortCount

(

mxc_htmr_regs_t *

htmr

)

Get value in short interval register.

Parameters

htmr	pointer to the htmr register structure

Returns

Returns short count value

MXC_HTMR_Init()

int MXC_HTMR_Init	(	mxc_htmr_regs_t *	htmr,
		uint32_t	longInterval,
		uint8_t	shortInterval
	)

Initialize the longInterval and shortInterval registers and enable MXC_HTMR.

Parameters

htmr	pointer to the htmr register structure
longInterval	set the MXC_HTMR long counter (32-bit)
shortInterval	set the MXC_HTMR short counter (8-bit)

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_SetLongAlarm()

int MXC_HTMR_SetLongAlarm	(	mxc_htmr_regs_t *	htmr,
		uint32_t	interval
	)

Set Long Interval alarm value and enable Interrupt.

Parameters

htmr	pointer to the htmr register structure
interval	20-bit value 0-0xFFFFF

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_SetShortAlarm()

int MXC_HTMR_SetShortAlarm	(	mxc_htmr_regs_t *	htmr,
		uint32_t	interval
	)

Set Short Interval alarm value and enable interrupt,.

Parameters

htmr	pointer to the htmr register structure
interval	32-bit value 0-0xFFFFFFFF

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_Start()

int MXC_HTMR_Start

(

mxc_htmr_regs_t *

htmr

)

Enable/Start the High Speed Timer.

Parameters

htmr	pointer to the htmr register structure

Return values

returns

Success or Fail, see MXC_ERROR_CODES

MXC_HTMR_Stop()

int MXC_HTMR_Stop

(

mxc_htmr_regs_t *

htmr

)

Disable/Stop the High Speed Timer.

Parameters

htmr	pointer to the htmr register structure

Return values

returns

Success or Fail, see MXC_ERROR_CODES