API Functions

Overview

Function definitions for Timer driver.

Functions
void	utimer_applyConfig (utimer_instance_t *inst)
	Apply the software configuration to the hardware.
void	utimer_clearValue (utimer_instance_t *inst)
	Clear Timer Value to zero.

UserTimer (Get Functions)
Read values from the Timer hardware registers.
u32	utimer_getConfig (utimer_instance_t *inst)
	Get stored Timer Configuration.
u32	utimer_getLimit (utimer_instance_t *inst)
	Get stored Timer Limit (Reload Value).
u32	utimer_getValue (utimer_instance_t *inst)
	Get current Timer Value.
u32	utimer_getPrescalerValue (utimer_instance_t *inst)
	Get stored Prescaler Value.

UserTimer (Set Functions)
Write values to the Timer registers. Note Call utimer_applyConfig() to make these changes effective.
u32	utimer_setConfig (utimer_instance_t *inst, u32 value)
	Set Timer Configuration.
u32	utimer_setPrescalerValue (utimer_instance_t *inst, u32 value)
	Set Prescaler Value.
u32	utimer_setLimit (utimer_instance_t *inst, u32 value)
	Get stored Timer Limit (Reload Value).

Function Documentation

utimer_applyConfig()

void utimer_applyConfig

(

utimer_instance_t *

inst

)

#include <timer.h>

Apply the software configuration to the hardware.

Writes all values stored in the utimer_instance to the corresponding Timer hardware registers.

Parameters

inst	Pointer to Timer instance.

Writes all values stored in the utimer_instance to the corresponding Timer hardware registers.

Definition at line 93 of file timer.c.

utimer_clearValue()

void utimer_clearValue

(

utimer_instance_t *

inst

)

#include <timer.h>

Clear Timer Value to zero.

Parameters

inst	Pointer to Timer instance.

Clear Timer Value to zero.

Definition at line 81 of file timer.c.

utimer_getConfig()

u32 utimer_getConfig

(

utimer_instance_t *

inst

)

#include <timer.h>

Get stored Timer Configuration.

/*

Parameters

inst	Pointer to Timer instance.

Returns

The current configuration bitmask (Enable, Auto-Reload, etc.).

Definition at line 25 of file timer.c.

utimer_getLimit()

u32 utimer_getLimit

(

utimer_instance_t *

inst

)

#include <timer.h>

Get stored Timer Limit (Reload Value).

Parameters

inst	Pointer to Timer instance.

Returns

The count limit value.

Definition at line 57 of file timer.c.

utimer_getPrescalerValue()

u32 utimer_getPrescalerValue

(

utimer_instance_t *

inst

)

#include <timer.h>

Get stored Prescaler Value.

Parameters

inst	Pointer to Timer instance.

Returns

The current clock prescaler divider.

Get stored Prescaler Value.

Definition at line 41 of file timer.c.

utimer_getValue()

u32 utimer_getValue

(

utimer_instance_t *

inst

)

#include <timer.h>

Get current Timer Value.

Parameters

inst	Pointer to Timer instance.

Returns

The current timer count value.

Get current Timer Value.

Definition at line 73 of file timer.c.

utimer_setConfig()

u32 utimer_setConfig	(	utimer_instance_t *	inst,
		u32	value )

#include <timer.h>

Set Timer Configuration.

/*

Parameters

inst	Pointer to Timer instance.
value	Configuration bitmask (e.g., Enable | Interrupt).

Definition at line 33 of file timer.c.

utimer_setLimit()

u32 utimer_setLimit	(	utimer_instance_t *	inst,
		u32	value )

#include <timer.h>

Get stored Timer Limit (Reload Value).

Parameters

inst	Pointer to Timer instance.

Returns

The count limit value.

Get stored Timer Limit (Reload Value).

Definition at line 65 of file timer.c.

utimer_setPrescalerValue()

u32 utimer_setPrescalerValue	(	utimer_instance_t *	inst,
		u32	value )

#include <timer.h>

Set Prescaler Value.

Parameters

inst	Pointer to Timer instance.
value	Clock divider value.

Set Prescaler Value.

Definition at line 49 of file timer.c.