15#ifndef ZEPHYR_INCLUDE_DRIVERS_COUNTER_H_
16#define ZEPHYR_INCLUDE_DRIVERS_COUNTER_H_
53#define COUNTER_CONFIG_INFO_COUNT_UP BIT(0)
69#define COUNTER_TOP_CFG_DONT_RESET BIT(0)
77#define COUNTER_TOP_CFG_RESET_WHEN_LATE BIT(1)
94#define COUNTER_ALARM_CFG_ABSOLUTE BIT(0)
102#define COUNTER_ALARM_CFG_EXPIRE_WHEN_LATE BIT(1)
118#define COUNTER_GUARD_PERIOD_LATE_TO_SET BIT(0)
133#define COUNTER_CAPTURE_RISING_EDGE BIT(0)
138#define COUNTER_CAPTURE_FALLING_EDGE BIT(1)
143#define COUNTER_CAPTURE_BOTH_EDGES (COUNTER_CAPTURE_FALLING_EDGE | COUNTER_CAPTURE_RISING_EDGE)
148#define COUNTER_CAPTURE_CONTINUOUS 0
153#define COUNTER_CAPTURE_SINGLE_SHOT BIT(2)
258#ifdef CONFIG_COUNTER_64BITS_FREQ
266#ifdef CONFIG_COUNTER_64BITS_TICKS
270#ifdef CONFIG_BIG_ENDIAN
499#ifdef CONFIG_COUNTER_64BITS_FREQ
505#ifdef CONFIG_COUNTER_64BITS_TICKS
535#ifdef CONFIG_COUNTER_CAPTURE
540#ifdef CONFIG_COUNTER_64BITS_TICKS
555#if defined(CONFIG_COUNTER_CALIBRATION) || defined(__DOXYGEN__)
580static inline bool z_impl_counter_is_counting_up(
const struct device *dev)
596static inline uint8_t z_impl_counter_get_num_of_channels(
const struct device *dev)
600 return config->channels;
605#ifdef CONFIG_COUNTER_64BITS_FREQ
616static inline uint32_t z_impl_counter_get_frequency(
const struct device *dev)
638static inline uint32_t z_impl_counter_get_frequency(
const struct device *dev)
657static inline uint64_t z_impl_counter_get_frequency_64(
const struct device *dev)
659#ifdef CONFIG_COUNTER_64BITS_FREQ
663 if (api->get_freq_64) {
664 return api->get_freq_64(dev);
676#ifdef CONFIG_COUNTER_64BITS_FREQ
677#define z_counter_get_frequency z_impl_counter_get_frequency_64
679#define z_counter_get_frequency z_impl_counter_get_frequency
711 uint64_t freq = z_counter_get_frequency(dev);
743 uint64_t freq = z_counter_get_frequency(dev);
777 uint64_t freq = z_counter_get_frequency(dev);
809 uint64_t freq = z_counter_get_frequency(dev);
827static inline uint32_t z_impl_counter_get_max_top_value(
const struct device *dev)
831 return config->max_top_value;
844static inline int z_impl_counter_start(
const struct device *dev)
860static inline int z_impl_counter_stop(
const struct device *dev)
875static inline int z_impl_counter_get_value(
const struct device *dev,
uint32_t *ticks)
889static inline int z_impl_counter_reset(
const struct device *dev)
897 return api->
reset(dev);
910static inline int z_impl_counter_set_value(
const struct device *dev,
uint32_t ticks)
944static inline int z_impl_counter_set_channel_alarm(
const struct device *dev,
uint8_t chan_id,
953 return api->
set_alarm(dev, chan_id, alarm_cfg);
970static inline int z_impl_counter_cancel_channel_alarm(
const struct device *dev,
uint8_t chan_id)
1011static inline int z_impl_counter_set_top_value(
const struct device *dev,
1038static inline uint32_t z_impl_counter_get_pending_int(
const struct device *dev)
1052static inline uint32_t z_impl_counter_get_top_value(
const struct device *dev)
1117static inline int z_impl_counter_set_guard_period(
const struct device *dev,
uint32_t ticks,
1158static inline uint64_t z_impl_counter_get_max_top_value_64(
const struct device *dev)
1160#ifdef CONFIG_COUNTER_64BITS_TICKS
1163 return config->max_top_value_64;
1197static inline int z_impl_counter_set_top_value_64(
const struct device *dev,
1200#ifdef CONFIG_COUNTER_64BITS_TICKS
1207 return api->set_top_value_64(dev, cfg);
1238static inline int z_impl_counter_set_channel_alarm_64(
const struct device *dev,
uint8_t chan_id,
1241#ifdef CONFIG_COUNTER_64BITS_TICKS
1248 return api->set_alarm_64(dev, chan_id, alarm_cfg);
1251 ARG_UNUSED(chan_id);
1252 ARG_UNUSED(alarm_cfg);
1266static inline uint64_t z_impl_counter_get_top_value_64(
const struct device *dev)
1268#ifdef CONFIG_COUNTER_64BITS_TICKS
1336static inline int z_impl_counter_set_guard_period_64(
const struct device *dev,
uint64_t ticks,
1339#ifdef CONFIG_COUNTER_64BITS_TICKS
1342 if (!api->set_guard_period_64) {
1346 return api->set_guard_period_64(dev, ticks,
flags);
1370#ifdef CONFIG_COUNTER_64BITS_TICKS
1373 return (api->get_guard_period_64) ? api->get_guard_period_64(dev,
flags) : 0;
1391static inline int z_impl_counter_get_value_64(
const struct device *dev,
uint64_t *ticks)
1393#ifdef CONFIG_COUNTER_64BITS_TICKS
1396 if (!api->get_value_64) {
1400 return api->get_value_64(dev, ticks);
1418static inline int z_impl_counter_set_value_64(
const struct device *dev,
uint64_t ticks)
1420#ifdef CONFIG_COUNTER_64BITS_TICKS
1423 if (!api->set_value_64) {
1427 return api->set_value_64(dev, ticks);
1435#if defined(CONFIG_COUNTER_CAPTURE) || defined(__DOXYGEN__)
1479 if (api->capture_configure ==
NULL) {
1487 return api->capture_configure(dev, chan_id,
flags, cb, user_data);
1490#if defined(CONFIG_COUNTER_64BITS_TICKS) || defined(__DOXYGEN__)
1524 if (api->capture_configure_64 ==
NULL) {
1532 return api->capture_configure_64(dev, chan_id,
flags, cb, user_data);
1547static inline int z_impl_counter_enable_capture(
const struct device *dev,
uint8_t chan_id)
1551 if (api->enable_capture ==
NULL) {
1559 return api->enable_capture(dev, chan_id);
1573static inline int z_impl_counter_disable_capture(
const struct device *dev,
uint8_t chan_id)
1577 if (api->disable_capture ==
NULL) {
1585 return api->disable_capture(dev, chan_id);
1591#if defined(CONFIG_COUNTER_CALIBRATION) || defined(__DOXYGEN__)
1607static inline int z_impl_counter_set_calibration(
const struct device *dev,
int32_t calibration)
1629static inline int z_impl_counter_get_calibration(
const struct device *dev,
int32_t *calibration)
1649#include <zephyr/syscalls/counter.h>
#define DEVICE_API_GET(_class, _dev)
Expands to the pointer of a device's API for a given class.
Definition device.h:1425
#define NSEC_PER_SEC
number of nanoseconds per second
Definition clock.h:113
#define USEC_PER_SEC
number of microseconds per second
Definition clock.h:110
static int counter_capture_configure(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, counter_capture_cb_t cb, void *user_data)
Configure a capture channel and register its callback.
Definition counter.h:1473
int counter_disable_capture(const struct device *dev, uint8_t chan_id)
Disable capture on a channel.
static int counter_capture_configure_64(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, counter_capture_cb_64_t cb, void *user_data)
Configure a capture channel and register its callback for 64 bits ticks.
Definition counter.h:1518
int counter_enable_capture(const struct device *dev, uint8_t chan_id)
Enable capture on a channel.
int counter_set_channel_alarm(const struct device *dev, uint8_t chan_id, const struct counter_alarm_cfg *alarm_cfg)
Set a single shot alarm on a channel.
int(* counter_api_get_calibration)(const struct device *dev, int32_t *calibration)
Callback API to get counter calibration in parts per billion.
Definition counter.h:441
uint32_t(* counter_api_get_top_value)(const struct device *dev)
Callback API to retrieve the current top value.
Definition counter.h:397
uint8_t counter_get_num_of_channels(const struct device *dev)
Function to get number of alarm channels.
int counter_start(const struct device *dev)
Start counter device in free running mode.
uint32_t counter_get_top_value(const struct device *dev)
Function to retrieve current top value.
int counter_set_channel_alarm_64(const struct device *dev, uint8_t chan_id, const struct counter_alarm_cfg_64 *alarm_cfg)
Set a single shot alarm on a channel for 64 bits.
uint32_t counter_get_pending_int(const struct device *dev)
Function to get pending interrupts.
int(* counter_api_set_top_value_64)(const struct device *dev, const struct counter_top_cfg_64 *cfg)
Callback API to set the counter top value (64 bits).
Definition counter.h:423
uint64_t(* counter_api_get_top_value_64)(const struct device *dev)
Callback API to retrieve the current top value (64 bits).
Definition counter.h:421
int(* counter_api_set_value)(const struct device *dev, uint32_t ticks)
Callback API to set the current counter value.
Definition counter.h:385
uint64_t counter_ticks_to_us_64(const struct device *dev, uint64_t ticks)
Function to convert ticks with 64 bits to microseconds.
int counter_reset(const struct device *dev)
Reset the counter to the initial value.
int(* counter_api_stop)(const struct device *dev)
Callback API to stop the counter.
Definition counter.h:379
uint64_t counter_ns_to_ticks_64(const struct device *dev, uint64_t ns)
Function to convert nanoseconds to ticks with 64 bits.
int counter_set_top_value(const struct device *dev, const struct counter_top_cfg *cfg)
Set counter top value.
int counter_get_value_64(const struct device *dev, uint64_t *ticks)
Get current counter 64-bit value.
int counter_set_top_value_64(const struct device *dev, const struct counter_top_cfg_64 *cfg)
Set counter top value for 64 bits.
uint64_t counter_us_to_ticks_64(const struct device *dev, uint64_t us)
Function to convert microseconds to ticks with 64 bits.
void(* counter_top_callback_t)(const struct device *dev, void *user_data)
Callback called when counter turns around.
Definition counter.h:229
void(* counter_alarm_callback_t)(const struct device *dev, uint8_t chan_id, uint32_t ticks, void *user_data)
Alarm callback.
Definition counter.h:187
int(* counter_api_set_alarm_64)(const struct device *dev, uint8_t chan_id, const struct counter_alarm_cfg_64 *alarm_cfg)
Callback API to set a single shot alarm on a channel (64 bits).
Definition counter.h:413
uint64_t counter_get_max_top_value_64(const struct device *dev)
Function to retrieve maximum top value that can be set for 64 bits.
uint64_t counter_get_guard_period_64(const struct device *dev, uint32_t flags)
Return guard period for 64 bits.
uint64_t counter_get_frequency_64(const struct device *dev)
Function to get counter frequency in 64bits.
void(* counter_capture_cb_64_t)(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, uint64_t ticks, void *user_data)
Counter capture callback for 64 bits ticks.
Definition counter.h:367
int(* counter_api_capture_configure_64)(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, counter_capture_cb_64_t cb, void *user_data)
Callback API to configure counter capture on a channel with 64-bit ticks.
Definition counter.h:430
void(* counter_capture_cb_t)(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, uint32_t ticks, void *user_data)
Counter capture callback.
Definition counter.h:176
void(* counter_alarm_callback_64_t)(const struct device *dev, uint8_t chan_id, uint64_t ticks, void *user_data)
Alarm callback.
Definition counter.h:301
uint64_t counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks)
Function to convert ticks with 64 bits to nanoseconds.
int(* counter_api_set_guard_period_64)(const struct device *dev, uint64_t ticks, uint32_t flags)
Callback API to set the guard period in ticks (64 bits).
Definition counter.h:418
uint32_t counter_get_guard_period(const struct device *dev, uint32_t flags)
Return guard period.
int counter_set_value(const struct device *dev, uint32_t ticks)
Set current counter value.
uint32_t counter_capture_flags_t
Provides a type to hold Counter Capture configuration flags.
Definition counter.h:164
uint64_t(* counter_api_get_guard_period_64)(const struct device *dev, uint32_t flags)
Callback API to retrieve the guard period in ticks (64 bits).
Definition counter.h:416
int(* counter_api_set_guard_period)(const struct device *dev, uint32_t ticks, uint32_t flags)
Callback API to set the guard period in ticks.
Definition counter.h:401
uint64_t(* counter_api_get_freq_64)(const struct device *dev)
Callback API to get the counter frequency in Hz (64 bits).
Definition counter.h:406
uint32_t counter_get_frequency(const struct device *dev)
int(* counter_api_set_value_64)(const struct device *dev, uint64_t ticks)
Callback API to set the current counter value (64 bits).
Definition counter.h:411
int counter_get_value(const struct device *dev, uint32_t *ticks)
Get current counter value.
#define COUNTER_CONFIG_INFO_COUNT_UP
Counter count up flag.
Definition counter.h:53
int counter_set_calibration(const struct device *dev, int32_t calibration)
Set counter calibration value.
uint32_t(* counter_api_get_guard_period)(const struct device *dev, uint32_t flags)
Callback API to retrieve the guard period in ticks.
Definition counter.h:399
uint32_t(* counter_api_get_pending_int)(const struct device *dev)
Callback API to get pending counter interrupts.
Definition counter.h:395
uint32_t(* counter_api_get_freq)(const struct device *dev)
Callback API to get the counter frequency in Hz.
Definition counter.h:404
int counter_set_value_64(const struct device *dev, uint64_t ticks)
Set current counter 64-bit value.
uint64_t counter_get_top_value_64(const struct device *dev)
Function to retrieve current top value for 64 bits.
uint64_t counter_ticks_to_us(const struct device *dev, uint32_t ticks)
Function to convert ticks to microseconds.
int(* counter_api_set_top_value)(const struct device *dev, const struct counter_top_cfg *cfg)
Callback API to set the counter top value.
Definition counter.h:392
int(* counter_api_reset)(const struct device *dev)
Callback API to reset the counter to the initial value.
Definition counter.h:383
int(* counter_api_start)(const struct device *dev)
@def_driverbackendgroup{Counter,counter_interface}
Definition counter.h:377
int(* counter_api_capture_configure)(const struct device *dev, uint8_t chan_id, counter_capture_flags_t flags, counter_capture_cb_t cb, void *user_data)
Callback API to configure counter capture on a channel.
Definition counter.h:426
int counter_set_guard_period(const struct device *dev, uint32_t ticks, uint32_t flags)
Set guard period in counter ticks.
uint32_t counter_us_to_ticks(const struct device *dev, uint64_t us)
Function to convert microseconds to ticks.
bool counter_is_counting_up(const struct device *dev)
Function to check if counter is counting up.
int counter_set_guard_period_64(const struct device *dev, uint64_t ticks, uint32_t flags)
Set guard period in counter ticks for 64 bits.
int(* counter_api_cancel_alarm)(const struct device *dev, uint8_t chan_id)
Callback API to cancel an alarm on a channel.
Definition counter.h:390
int(* counter_api_enable_capture)(const struct device *dev, uint8_t chan_id)
Callback API to enable counter capture on a channel.
Definition counter.h:434
int(* counter_api_get_value_64)(const struct device *dev, uint64_t *ticks)
Callback API to get the current counter value (64 bits).
Definition counter.h:409
int(* counter_api_get_value)(const struct device *dev, uint32_t *ticks)
Callback API to get the current counter value.
Definition counter.h:381
int(* counter_api_disable_capture)(const struct device *dev, uint8_t chan_id)
Callback API to disable counter capture on a channel.
Definition counter.h:436
int counter_get_calibration(const struct device *dev, int32_t *calibration)
Get counter calibration value.
uint64_t counter_ticks_to_ns(const struct device *dev, uint32_t ticks)
Function to convert ticks to nanoseconds.
int counter_cancel_channel_alarm(const struct device *dev, uint8_t chan_id)
Cancel an alarm on a channel.
int(* counter_api_set_alarm)(const struct device *dev, uint8_t chan_id, const struct counter_alarm_cfg *alarm_cfg)
Callback API to set a single shot alarm on a channel.
Definition counter.h:387
uint32_t counter_ns_to_ticks(const struct device *dev, uint64_t ns)
Function to convert nanoseconds to ticks.
int(* counter_api_set_calibration)(const struct device *dev, int32_t calibration)
Callback API to set counter calibration in parts per billion.
Definition counter.h:439
int counter_stop(const struct device *dev)
Stop counter device.
uint32_t counter_get_max_top_value(const struct device *dev)
Function to retrieve maximum top value that can be set.
#define EINVAL
Invalid argument.
Definition errno.h:60
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define ENOTSUP
Unsupported value.
Definition errno.h:114
#define NULL
Definition iar_missing_defs.h:20
flags
Definition parser.h:97
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
#define UINT32_MAX
Definition stdint.h:29
Alarm callback structure.
Definition counter.h:306
void * user_data
User data returned in callback.
Definition counter.h:331
uint32_t flags
Alarm flags (see COUNTER_ALARM_FLAGS).
Definition counter.h:335
counter_alarm_callback_64_t callback
Callback called on alarm (cannot be NULL).
Definition counter.h:327
uint64_t ticks
Number of ticks that triggers the alarm.
Definition counter.h:323
Alarm callback structure.
Definition counter.h:192
uint32_t ticks
Number of ticks that triggers the alarm.
Definition counter.h:213
uint32_t flags
Alarm flags (see COUNTER_ALARM_FLAGS).
Definition counter.h:221
void * user_data
User data returned in callback.
Definition counter.h:217
counter_alarm_callback_t callback
Callback called on alarm (cannot be NULL).
Definition counter.h:196
Structure with generic counter features.
Definition counter.h:254
uint32_t max_top_value
Maximal (default) top value on which counter is reset (cleared or reloaded).
Definition counter.h:280
uint32_t freq
Frequency of the source clock if synchronous events are counted.
Definition counter.h:261
uint8_t flags
Flags (see COUNTER_FLAGS).
Definition counter.h:285
uint8_t channels
Number of channels that can be used for setting alarm.
Definition counter.h:291
@driver_ops{Counter}
Definition counter.h:446
counter_api_get_calibration get_calibration
@driver_ops_optional Get counter calibration value.
Definition counter.h:563
counter_api_get_top_value get_top_value
@driver_ops_mandatory Function to retrieve current top value.
Definition counter.h:486
counter_api_set_top_value set_top_value
@driver_ops_mandatory Set counter top value.
Definition counter.h:478
counter_api_set_alarm set_alarm
@driver_ops_mandatory Set a single shot alarm on a channel.
Definition counter.h:470
counter_api_get_value get_value
@driver_ops_mandatory Get current counter value.
Definition counter.h:458
counter_api_reset reset
@driver_ops_optional Reset the counter to the initial value.
Definition counter.h:462
counter_api_get_pending_int get_pending_int
@driver_ops_mandatory Function to get pending interrupts.
Definition counter.h:482
counter_api_stop stop
@driver_ops_mandatory Stop counter device.
Definition counter.h:454
counter_api_set_guard_period set_guard_period
@driver_ops_optional Set guard period in counter ticks.
Definition counter.h:494
counter_api_set_value set_value
@driver_ops_optional Set current counter value.
Definition counter.h:466
counter_api_start start
@driver_ops_mandatory Start counter device in free running mode.
Definition counter.h:450
counter_api_set_calibration set_calibration
@driver_ops_optional Set counter calibration value.
Definition counter.h:559
counter_api_get_guard_period get_guard_period
@driver_ops_optional Return guard period.
Definition counter.h:490
counter_api_cancel_alarm cancel_alarm
@driver_ops_mandatory Cancel an alarm on a channel.
Definition counter.h:474
counter_api_get_freq get_freq
@driver_ops_optional
Definition counter.h:498
Top value configuration structure.
Definition counter.h:340
void * user_data
User data passed to callback function (not valid if callback is NULL).
Definition counter.h:352
counter_top_callback_t callback
Callback function (can be NULL).
Definition counter.h:348
uint32_t flags
Flags (see COUNTER_TOP_FLAGS).
Definition counter.h:356
uint64_t ticks
Top value.
Definition counter.h:344
Top value configuration structure.
Definition counter.h:233
uint32_t ticks
Top value.
Definition counter.h:237
uint32_t flags
Flags (see COUNTER_TOP_FLAGS).
Definition counter.h:249
counter_top_callback_t callback
Callback function (can be NULL).
Definition counter.h:241
void * user_data
User data passed to callback function (not valid if callback is NULL).
Definition counter.h:245
Runtime device structure (in ROM) per driver instance.
Definition device.h:513
const void * config
Address of device instance config information.
Definition device.h:517