counter_alarm_cfg Struct Reference

Alarm callback structure. More...

#include <counter.h>

Data Fields
counter_alarm_callback_t	callback
uint32_t	ticks
void *	user_data
uint32_t	flags

Detailed Description

Alarm callback structure.

Parameters

callback	Callback called on alarm (cannot be NULL).
ticks	Number of ticks that triggers the alarm. It can be relative (to now) or absolute value (see COUNTER_ALARM_CFG_ABSOLUTE). Absolute alarm cannot be set further in future than top_value decremented by the guard period. Relative alarm ticks cannot exceed current top value (see counter_get_top_value). If counter is clock driven then ticks can be converted to microseconds (see counter_ticks_to_us). Alternatively, counter implementation may count asynchronous events.
user_data	User data returned in callback.
flags	Alarm flags. See Alarm configuration flags.

Field Documentation

callback

counter_alarm_callback_t counter_alarm_cfg::callback

flags

uint32_t counter_alarm_cfg::flags

ticks

uint32_t counter_alarm_cfg::ticks

user_data

void* counter_alarm_cfg::user_data

---

The documentation for this struct was generated from the following file:

• include/drivers/counter.h