counter_driver_api Struct Reference

@driver_ops{Counter} More...

#include <counter.h>

Data Fields
counter_api_start	start
	@driver_ops_mandatory Start counter device in free running mode.
counter_api_stop	stop
	@driver_ops_mandatory Stop counter device.
counter_api_get_value	get_value
	@driver_ops_mandatory Get current counter value.
counter_api_reset	reset
	@driver_ops_optional Reset the counter to the initial value.
counter_api_set_value	set_value
	@driver_ops_optional Set current counter value.
counter_api_set_alarm	set_alarm
	@driver_ops_mandatory Set a single shot alarm on a channel.
counter_api_cancel_alarm	cancel_alarm
	@driver_ops_mandatory Cancel an alarm on a channel.
counter_api_set_top_value	set_top_value
	@driver_ops_mandatory Set counter top value.
counter_api_get_pending_int	get_pending_int
	@driver_ops_mandatory Function to get pending interrupts.
counter_api_get_top_value	get_top_value
	@driver_ops_mandatory Function to retrieve current top value.
counter_api_get_guard_period	get_guard_period
	@driver_ops_optional Return guard period.
counter_api_set_guard_period	set_guard_period
	@driver_ops_optional Set guard period in counter ticks.
counter_api_get_freq	get_freq
	@driver_ops_optional

Detailed Description

@driver_ops{Counter}

Field Documentation

cancel_alarm

counter_api_cancel_alarm counter_driver_api::cancel_alarm

@driver_ops_mandatory Cancel an alarm on a channel.

get_freq

counter_api_get_freq counter_driver_api::get_freq

@driver_ops_optional

get_guard_period

counter_api_get_guard_period counter_driver_api::get_guard_period

@driver_ops_optional Return guard period.

get_pending_int

counter_api_get_pending_int counter_driver_api::get_pending_int

@driver_ops_mandatory Function to get pending interrupts.

get_top_value

counter_api_get_top_value counter_driver_api::get_top_value

@driver_ops_mandatory Function to retrieve current top value.

get_value

counter_api_get_value counter_driver_api::get_value

@driver_ops_mandatory Get current counter value.

reset

counter_api_reset counter_driver_api::reset

@driver_ops_optional Reset the counter to the initial value.

set_alarm

counter_api_set_alarm counter_driver_api::set_alarm

@driver_ops_mandatory Set a single shot alarm on a channel.

set_guard_period

counter_api_set_guard_period counter_driver_api::set_guard_period

@driver_ops_optional Set guard period in counter ticks.

set_top_value

counter_api_set_top_value counter_driver_api::set_top_value

@driver_ops_mandatory Set counter top value.

set_value

counter_api_set_value counter_driver_api::set_value

@driver_ops_optional Set current counter value.

start

counter_api_start counter_driver_api::start

@driver_ops_mandatory Start counter device in free running mode.

stop

counter_api_stop counter_driver_api::stop

@driver_ops_mandatory Stop counter device.

---

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

• include/zephyr/drivers/counter.h