Timer Management Services

group timer

Defines the interfaces for Timer Management Services.

Typedefs

typedef void *wiced_timer_callback_arg_t

Timer callback argument type.

typedef wiced_timer_callback_arg_t WICED_TIMER_PARAM_TYPE
void() wiced_timer_callback_t (wiced_timer_callback_arg_t cb_params)

Function prototype for the timer call back.

Parameters
  • [in] cb_params: :Timer callback function

Enums

enum wiced_timer_type_e

wiced_timer_type_e: Defines the wiced timer types.

These timers are system tick driven and a systick is 1 millisecond.So the minimum timer resolution supported is 1 millisecond

Values:

enumerator WICED_MILLI_SECONDS_TIMER
enumerator WICED_SECONDS_TIMER
enumerator WICED_MILLI_SECONDS_PERIODIC_TIMER
enumerator WICED_SECONDS_PERIODIC_TIMER

Functions

wiced_result_t wiced_init_timer(wiced_timer_t *p_timer, wiced_timer_callback_t *p_timer_cb, wiced_timer_callback_arg_t cb_arg, wiced_timer_type_e timer_type)

Initializes the timer.

Return

wiced_result_t

Parameters
  • [in] p_timer: :Pointer to the timer structure

  • [in] p_timer_cb: :Timer callback function to be invoked on timer expiry

  • [in] cb_arg: :Parameter to be passed to the timer callback function which gets invoked on timer expiry,if any

  • [in] timer_type: :Shows if the timer is milliseconds or seconds, and if periodic or not

wiced_result_t wiced_start_timer(wiced_timer_t *p_timer, uint32_t timeout_ms)

Starts a timer.

Return

wiced_result_t

Parameters
  • [in] p_timer: :Pointer to the timer structure

  • [in] timeout_ms: :timeout in milliseconds

wiced_result_t wiced_stop_timer(wiced_timer_t *p_timer)

Stops a timer.

Return

wiced_result_t

Parameters
  • [in] p_timer: :Pointer to the timer structure

wiced_bool_t wiced_is_timer_in_use(wiced_timer_t *p_timer)

Checks if a timer is in use.

Return

TRUE if the timer is in use and FALSE if the timer is not in use

Parameters
  • [in] p_timer: :Pointer to the timer structure

wiced_result_t wiced_deinit_timer(wiced_timer_t *p_timer)

Deinitialize a timer instance and stops the timer if it is running.

Return

wiced_result_t

Parameters
  • [in] p_timer: :Pointer to the timer

struct wiced_timer_t
#include <wiced_timer.h>

Timer structure.

NOTE: this structure is used internally by the wiced stack. Applications MUST NOT modify any of the elements of this structure.

Timer control block memory MUST be peristant from when the timer is initialized, using wiced_init_timer(), till it is de-initialized, using wiced_deinit_timer().

Public Members

struct _wiced_timer_t *p_next
wiced_timer_callback_t *p_cback
wiced_timer_callback_arg_t cb_arg
uint32_t pi
uint64_t tt