Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
counter.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation
3 * Copyright (c) 2018 Nordic Semiconductor ASA
4 * Copyright (c) 2026 Meta Platforms
5 *
6 * SPDX-License-Identifier: Apache-2.0
7 */
8
14
15#ifndef ZEPHYR_INCLUDE_DRIVERS_COUNTER_H_
16#define ZEPHYR_INCLUDE_DRIVERS_COUNTER_H_
17
31
32#include <errno.h>
33
34#include <zephyr/types.h>
35#include <stddef.h>
36#include <zephyr/device.h>
37#include <zephyr/devicetree.h>
39#include <zephyr/sys_clock.h>
40#include <stdbool.h>
41
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
53
57#define COUNTER_CONFIG_INFO_COUNT_UP BIT(0)
58
60
66
73#define COUNTER_TOP_CFG_DONT_RESET BIT(0)
74
81#define COUNTER_TOP_CFG_RESET_WHEN_LATE BIT(1)
82
84
91
98#define COUNTER_ALARM_CFG_ABSOLUTE BIT(0)
99
106#define COUNTER_ALARM_CFG_EXPIRE_WHEN_LATE BIT(1)
107
109
117
122#define COUNTER_GUARD_PERIOD_LATE_TO_SET BIT(0)
123
125
133
134/* Bit 0 and 1 are used for COUNTER_CAPTURE_RISING_EDGE/COUNTER_CAPTURE_FALLING_EDGE */
135
139#define COUNTER_CAPTURE_CONTINUOUS 0
140
144#define COUNTER_CAPTURE_SINGLE_SHOT BIT(2)
145
154
156
179
225#define COUNTER_CAPTURE_DT_SPEC_GET_BY_NAME(node_id, prop, name) \
226 { \
227 .dev = DEVICE_DT_GET(DT_COUNTER_CAPTURES_CTLR_BY_NAME(node_id, prop, name)), \
228 .chan_id = (uint8_t)DT_COUNTER_CAPTURES_CHANNEL_BY_NAME(node_id, prop, name), \
229 .flags = DT_COUNTER_CAPTURES_FLAGS_BY_NAME(node_id, prop, name), \
230 }
231
246#define COUNTER_CAPTURE_DT_SPEC_INST_GET_BY_NAME(inst, prop, name) \
247 COUNTER_CAPTURE_DT_SPEC_GET_BY_NAME(DT_DRV_INST(inst), prop, name)
248
270#define COUNTER_CAPTURE_DT_SPEC_GET_BY_NAME_OR(node_id, prop, name, default_value) \
271 COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop), \
272 (COUNTER_CAPTURE_DT_SPEC_GET_BY_NAME(node_id, prop, name)), \
273 (default_value))
274
290#define COUNTER_CAPTURE_DT_SPEC_INST_GET_BY_NAME_OR(inst, prop, name, default_value) \
291 COUNTER_CAPTURE_DT_SPEC_GET_BY_NAME_OR(DT_DRV_INST(inst), prop, name, default_value)
292
336#define COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX(node_id, prop, idx) \
337 { \
338 .dev = DEVICE_DT_GET(DT_COUNTER_CAPTURES_CTLR_BY_IDX(node_id, prop, idx)), \
339 .chan_id = (uint8_t)DT_COUNTER_CAPTURES_CHANNEL_BY_IDX(node_id, prop, idx), \
340 .flags = DT_COUNTER_CAPTURES_FLAGS_BY_IDX(node_id, prop, idx), \
341 }
342
356#define COUNTER_CAPTURE_DT_SPEC_INST_GET_BY_IDX(inst, prop, idx) \
357 COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), prop, idx)
358
379#define COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX_OR(node_id, prop, idx, default_value) \
380 COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop), \
381 (COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX(node_id, prop, idx)), \
382 (default_value))
383
398#define COUNTER_CAPTURE_DT_SPEC_INST_GET_BY_IDX_OR(inst, prop, idx, default_value) \
399 COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX_OR(DT_DRV_INST(inst), prop, idx, default_value)
400
413#define COUNTER_CAPTURE_DT_SPEC_GET(node_id, prop) \
414 COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX(node_id, prop, 0)
415
428#define COUNTER_CAPTURE_DT_SPEC_INST_GET(inst, prop) \
429 COUNTER_CAPTURE_DT_SPEC_GET(DT_DRV_INST(inst), prop)
430
445#define COUNTER_CAPTURE_DT_SPEC_GET_OR(node_id, prop, default_value) \
446 COUNTER_CAPTURE_DT_SPEC_GET_BY_IDX_OR(node_id, prop, 0, default_value)
447
462#define COUNTER_CAPTURE_DT_SPEC_INST_GET_OR(inst, prop, default_value) \
463 COUNTER_CAPTURE_DT_SPEC_GET_OR(DT_DRV_INST(inst), prop, default_value)
464
466
475typedef void (*counter_capture_cb_t)(const struct device *dev, uint8_t chan_id,
477 void *user_data);
478
486typedef void (*counter_alarm_callback_t)(const struct device *dev, uint8_t chan_id, uint32_t ticks,
487 void *user_data);
488
522
528typedef void (*counter_top_callback_t)(const struct device *dev, void *user_data);
529
550
557#ifdef CONFIG_COUNTER_64BITS_FREQ
559#else
561#endif
565#ifdef CONFIG_COUNTER_64BITS_TICKS
566 union {
567 uint64_t max_top_value_64;
568 struct {
569#ifdef CONFIG_BIG_ENDIAN
570 uint32_t reserved;
572#else
574 uint32_t reserved;
575#endif /* CONFIG_BIG_ENDIAN */
576 };
577 };
578#else
580#endif /* CONFIG_COUNTER_64BITS_TICKS */
591};
592
600typedef void (*counter_alarm_callback_64_t)(const struct device *dev, uint8_t chan_id,
601 uint64_t ticks, void *user_data);
602
636
657
666typedef void (*counter_capture_cb_64_t)(const struct device *dev, uint8_t chan_id,
668 void *user_data);
669
674
676typedef int (*counter_api_start)(const struct device *dev);
678typedef int (*counter_api_stop)(const struct device *dev);
680typedef int (*counter_api_get_value)(const struct device *dev, uint32_t *ticks);
682typedef int (*counter_api_reset)(const struct device *dev);
684typedef int (*counter_api_set_value)(const struct device *dev, uint32_t ticks);
686typedef int (*counter_api_set_alarm)(const struct device *dev, uint8_t chan_id,
687 const struct counter_alarm_cfg *alarm_cfg);
689typedef int (*counter_api_cancel_alarm)(const struct device *dev, uint8_t chan_id);
691typedef int (*counter_api_set_top_value)(const struct device *dev,
692 const struct counter_top_cfg *cfg);
694typedef uint32_t (*counter_api_get_pending_int)(const struct device *dev);
696typedef uint32_t (*counter_api_get_top_value)(const struct device *dev);
700typedef int (*counter_api_set_guard_period)(const struct device *dev, uint32_t ticks,
703typedef uint32_t (*counter_api_get_freq)(const struct device *dev);
705typedef uint64_t (*counter_api_get_freq_64)(const struct device *dev);
706
708typedef int (*counter_api_get_value_64)(const struct device *dev, uint64_t *ticks);
710typedef int (*counter_api_set_value_64)(const struct device *dev, uint64_t ticks);
712typedef int (*counter_api_set_alarm_64)(const struct device *dev, uint8_t chan_id,
713 const struct counter_alarm_cfg_64 *alarm_cfg);
717typedef int (*counter_api_set_guard_period_64)(const struct device *dev, uint64_t ticks,
720typedef uint64_t (*counter_api_get_top_value_64)(const struct device *dev);
722typedef int (*counter_api_set_top_value_64)(const struct device *dev,
723 const struct counter_top_cfg_64 *cfg);
725typedef int (*counter_api_capture_configure)(const struct device *dev, uint8_t chan_id,
727 counter_capture_cb_t cb, void *user_data);
729typedef int (*counter_api_capture_configure_64)(const struct device *dev, uint8_t chan_id,
731 counter_capture_cb_64_t cb, void *user_data);
733typedef int (*counter_api_enable_capture)(const struct device *dev, uint8_t chan_id);
735typedef int (*counter_api_disable_capture)(const struct device *dev, uint8_t chan_id);
736
738typedef int (*counter_api_set_calibration)(const struct device *dev, int32_t calibration);
740typedef int (*counter_api_get_calibration)(const struct device *dev, int32_t *calibration);
741
745__subsystem struct counter_driver_api {
798#ifdef CONFIG_COUNTER_64BITS_FREQ
802 counter_api_get_freq_64 get_freq_64;
803#endif /* CONFIG_COUNTER_64BITS_FREQ */
804#ifdef CONFIG_COUNTER_64BITS_TICKS
808 counter_api_get_value_64 get_value_64;
812 counter_api_set_value_64 set_value_64;
816 counter_api_set_alarm_64 set_alarm_64;
820 counter_api_get_guard_period_64 get_guard_period_64;
824 counter_api_set_guard_period_64 set_guard_period_64;
828 counter_api_get_top_value_64 get_top_value_64;
832 counter_api_set_top_value_64 set_top_value_64;
833#endif /* CONFIG_COUNTER_64BITS_TICKS */
834#ifdef CONFIG_COUNTER_CAPTURE
838 counter_api_capture_configure capture_configure;
839#ifdef CONFIG_COUNTER_64BITS_TICKS
843 counter_api_capture_configure_64 capture_configure_64;
844#endif /* CONFIG_COUNTER_64BITS_TICKS */
848 counter_api_enable_capture enable_capture;
852 counter_api_disable_capture disable_capture;
853#endif /* CONFIG_COUNTER_CAPTURE */
854#if defined(CONFIG_COUNTER_CALIBRATION) || defined(__DOXYGEN__)
863#endif /* CONFIG_COUNTER_CALIBRATION */
864};
865
868
877__syscall bool counter_is_counting_up(const struct device *dev);
878
879static inline bool z_impl_counter_is_counting_up(const struct device *dev)
880{
881 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
882
883 return config->flags & COUNTER_CONFIG_INFO_COUNT_UP;
884}
885
893__syscall uint8_t counter_get_num_of_channels(const struct device *dev);
894
895static inline uint8_t z_impl_counter_get_num_of_channels(const struct device *dev)
896{
897 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
898
899 return config->channels;
900}
901
902__syscall uint32_t counter_get_frequency(const struct device *dev);
903
904#ifdef CONFIG_COUNTER_64BITS_FREQ
915static inline uint32_t z_impl_counter_get_frequency(const struct device *dev)
916{
917 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
918 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
919
920 if (api->get_freq) {
921 return api->get_freq(dev);
922 } else {
923 return config->freq > UINT32_MAX ? UINT32_MAX : (uint32_t)config->freq;
924 }
925}
926
927#else
928
937static inline uint32_t z_impl_counter_get_frequency(const struct device *dev)
938{
939 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
940 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
941
942 return api->get_freq ? api->get_freq(dev) : config->freq;
943}
944#endif
945
954__syscall uint64_t counter_get_frequency_64(const struct device *dev);
955
956static inline uint64_t z_impl_counter_get_frequency_64(const struct device *dev)
957{
958#ifdef CONFIG_COUNTER_64BITS_FREQ
959 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
960 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
961
962 if (api->get_freq_64) {
963 return api->get_freq_64(dev);
964 } else if (api->get_freq) {
965 return (uint64_t)api->get_freq(dev);
966 } else {
967 return config->freq;
968 }
969#else
970 ARG_UNUSED(dev);
971 return -ENOTSUP;
972#endif
973}
974
975#ifdef CONFIG_COUNTER_64BITS_FREQ
976#define z_counter_get_frequency z_impl_counter_get_frequency_64
977#else
978#define z_counter_get_frequency z_impl_counter_get_frequency
979#endif
980
989__syscall uint32_t counter_us_to_ticks(const struct device *dev, uint64_t us);
990
991static inline uint32_t z_impl_counter_us_to_ticks(const struct device *dev, uint64_t us)
992{
993 uint64_t ticks = (us * z_counter_get_frequency(dev)) / USEC_PER_SEC;
994
995 return (ticks > (uint64_t)UINT32_MAX) ? UINT32_MAX : ticks;
996}
997
1006__syscall uint64_t counter_us_to_ticks_64(const struct device *dev, uint64_t us);
1007
1008static inline uint64_t z_impl_counter_us_to_ticks_64(const struct device *dev, uint64_t us)
1009{
1010 uint64_t freq = z_counter_get_frequency(dev);
1011
1012 return (us / USEC_PER_SEC) * freq + ((us % USEC_PER_SEC) * freq) / USEC_PER_SEC;
1013}
1014
1023__syscall uint64_t counter_ticks_to_us(const struct device *dev, uint32_t ticks);
1024
1025static inline uint64_t z_impl_counter_ticks_to_us(const struct device *dev, uint32_t ticks)
1026{
1027 return ((uint64_t)ticks * USEC_PER_SEC) / z_counter_get_frequency(dev);
1028}
1029
1038__syscall uint64_t counter_ticks_to_us_64(const struct device *dev, uint64_t ticks);
1039
1040static inline uint64_t z_impl_counter_ticks_to_us_64(const struct device *dev, uint64_t ticks)
1041{
1042 uint64_t freq = z_counter_get_frequency(dev);
1043
1044 return (ticks / freq) * USEC_PER_SEC + ((ticks % freq) * USEC_PER_SEC) / freq;
1045}
1046
1055__syscall uint32_t counter_ns_to_ticks(const struct device *dev, uint64_t ns);
1056
1057static inline uint32_t z_impl_counter_ns_to_ticks(const struct device *dev, uint64_t ns)
1058{
1059 uint64_t ticks = (ns * z_counter_get_frequency(dev)) / NSEC_PER_SEC;
1060
1061 return (ticks > (uint64_t)UINT32_MAX) ? UINT32_MAX : ticks;
1062}
1063
1072__syscall uint64_t counter_ns_to_ticks_64(const struct device *dev, uint64_t ns);
1073
1074static inline uint64_t z_impl_counter_ns_to_ticks_64(const struct device *dev, uint64_t ns)
1075{
1076 uint64_t freq = z_counter_get_frequency(dev);
1077
1078 return (ns / NSEC_PER_SEC) * freq + ((ns % NSEC_PER_SEC) * freq) / NSEC_PER_SEC;
1079}
1080
1089__syscall uint64_t counter_ticks_to_ns(const struct device *dev, uint32_t ticks);
1090
1091static inline uint64_t z_impl_counter_ticks_to_ns(const struct device *dev, uint32_t ticks)
1092{
1093 return ((uint64_t)ticks * NSEC_PER_SEC) / z_counter_get_frequency(dev);
1094}
1095
1104__syscall uint64_t counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks);
1105
1106static inline uint64_t z_impl_counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks)
1107{
1108 uint64_t freq = z_counter_get_frequency(dev);
1109
1110 return (ticks / freq) * NSEC_PER_SEC + ((ticks % freq) * NSEC_PER_SEC) / freq;
1111}
1112
1124__syscall uint32_t counter_get_max_top_value(const struct device *dev);
1125
1126static inline uint32_t z_impl_counter_get_max_top_value(const struct device *dev)
1127{
1128 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
1129
1130 return config->max_top_value;
1131}
1132
1140__syscall int counter_start(const struct device *dev);
1141
1142static inline int z_impl_counter_start(const struct device *dev)
1143{
1144 return DEVICE_API_GET(counter, dev)->start(dev);
1145}
1146
1156__syscall int counter_stop(const struct device *dev);
1157
1158static inline int z_impl_counter_stop(const struct device *dev)
1159{
1160 return DEVICE_API_GET(counter, dev)->stop(dev);
1161}
1162
1170__syscall int counter_get_value(const struct device *dev, uint32_t *ticks);
1171
1172static inline int z_impl_counter_get_value(const struct device *dev, uint32_t *ticks)
1173{
1174 return DEVICE_API_GET(counter, dev)->get_value(dev, ticks);
1175}
1176
1183__syscall int counter_reset(const struct device *dev);
1184
1185static inline int z_impl_counter_reset(const struct device *dev)
1186{
1187 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1188
1189 if (!api->reset) {
1190 return -ENOSYS;
1191 }
1192
1193 return api->reset(dev);
1194}
1195
1203__syscall int counter_set_value(const struct device *dev, uint32_t ticks);
1204
1205static inline int z_impl_counter_set_value(const struct device *dev, uint32_t ticks)
1206{
1207 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1208
1209 if (!api->set_value) {
1210 return -ENOSYS;
1211 }
1212
1213 return api->set_value(dev, ticks);
1214}
1215
1236__syscall int counter_set_channel_alarm(const struct device *dev, uint8_t chan_id,
1237 const struct counter_alarm_cfg *alarm_cfg);
1238
1239static inline int z_impl_counter_set_channel_alarm(const struct device *dev, uint8_t chan_id,
1240 const struct counter_alarm_cfg *alarm_cfg)
1241{
1242 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1243
1244 if (chan_id >= counter_get_num_of_channels(dev)) {
1245 return -ENOTSUP;
1246 }
1247
1248 return api->set_alarm(dev, chan_id, alarm_cfg);
1249}
1250
1263__syscall int counter_cancel_channel_alarm(const struct device *dev, uint8_t chan_id);
1264
1265static inline int z_impl_counter_cancel_channel_alarm(const struct device *dev, uint8_t chan_id)
1266{
1267 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1268
1269 if (chan_id >= counter_get_num_of_channels(dev)) {
1270 return -ENOTSUP;
1271 }
1272
1273 return api->cancel_alarm(dev, chan_id);
1274}
1275
1304__syscall int counter_set_top_value(const struct device *dev, const struct counter_top_cfg *cfg);
1305
1306static inline int z_impl_counter_set_top_value(const struct device *dev,
1307 const struct counter_top_cfg *cfg)
1308{
1309 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1310
1311 if (cfg->ticks > counter_get_max_top_value(dev)) {
1312 return -EINVAL;
1313 }
1314
1315 return api->set_top_value(dev, cfg);
1316}
1317
1331__syscall uint32_t counter_get_pending_int(const struct device *dev);
1332
1333static inline uint32_t z_impl_counter_get_pending_int(const struct device *dev)
1334{
1335 return DEVICE_API_GET(counter, dev)->get_pending_int(dev);
1336}
1337
1345__syscall uint32_t counter_get_top_value(const struct device *dev);
1346
1347static inline uint32_t z_impl_counter_get_top_value(const struct device *dev)
1348{
1349 return DEVICE_API_GET(counter, dev)->get_top_value(dev);
1350}
1351
1410__syscall int counter_set_guard_period(const struct device *dev, uint32_t ticks, uint32_t flags);
1411
1412static inline int z_impl_counter_set_guard_period(const struct device *dev, uint32_t ticks,
1414{
1415 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1416
1417 if (!api->set_guard_period) {
1418 return -ENOSYS;
1419 }
1420
1421 return api->set_guard_period(dev, ticks, flags);
1422}
1423
1436
1437static inline uint32_t z_impl_counter_get_guard_period(const struct device *dev, uint32_t flags)
1438{
1439 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1440
1441 return (api->get_guard_period) ? api->get_guard_period(dev, flags) : 0;
1442}
1443
1451__syscall uint64_t counter_get_max_top_value_64(const struct device *dev);
1452
1453static inline uint64_t z_impl_counter_get_max_top_value_64(const struct device *dev)
1454{
1455#ifdef CONFIG_COUNTER_64BITS_TICKS
1456 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
1457
1458 return config->max_top_value_64;
1459#else
1460 ARG_UNUSED(dev);
1461 return -ENOTSUP;
1462#endif
1463}
1464
1489__syscall int counter_set_top_value_64(const struct device *dev,
1490 const struct counter_top_cfg_64 *cfg);
1491
1492static inline int z_impl_counter_set_top_value_64(const struct device *dev,
1493 const struct counter_top_cfg_64 *cfg)
1494{
1495#ifdef CONFIG_COUNTER_64BITS_TICKS
1496 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1497
1498 if (cfg->ticks > counter_get_max_top_value_64(dev)) {
1499 return -EINVAL;
1500 }
1501
1502 return api->set_top_value_64(dev, cfg);
1503#else
1504 ARG_UNUSED(dev);
1505 ARG_UNUSED(cfg);
1506 return -ENOTSUP;
1507#endif
1508}
1509
1530__syscall int counter_set_channel_alarm_64(const struct device *dev, uint8_t chan_id,
1531 const struct counter_alarm_cfg_64 *alarm_cfg);
1532
1533static inline int z_impl_counter_set_channel_alarm_64(const struct device *dev, uint8_t chan_id,
1534 const struct counter_alarm_cfg_64 *alarm_cfg)
1535{
1536#ifdef CONFIG_COUNTER_64BITS_TICKS
1537 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1538
1539 if (chan_id >= counter_get_num_of_channels(dev)) {
1540 return -ENOTSUP;
1541 }
1542
1543 return api->set_alarm_64(dev, chan_id, alarm_cfg);
1544#else
1545 ARG_UNUSED(dev);
1546 ARG_UNUSED(chan_id);
1547 ARG_UNUSED(alarm_cfg);
1548 return -ENOTSUP;
1549#endif
1550}
1551
1559__syscall uint64_t counter_get_top_value_64(const struct device *dev);
1560
1561static inline uint64_t z_impl_counter_get_top_value_64(const struct device *dev)
1562{
1563#ifdef CONFIG_COUNTER_64BITS_TICKS
1564 return DEVICE_API_GET(counter, dev)->get_top_value_64(dev);
1565#else
1566 ARG_UNUSED(dev);
1567 return 0;
1568#endif
1569}
1570
1629__syscall int counter_set_guard_period_64(const struct device *dev, uint64_t ticks, uint32_t flags);
1630
1631static inline int z_impl_counter_set_guard_period_64(const struct device *dev, uint64_t ticks,
1633{
1634#ifdef CONFIG_COUNTER_64BITS_TICKS
1635 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1636
1637 if (!api->set_guard_period_64) {
1638 return -ENOSYS;
1639 }
1640
1641 return api->set_guard_period_64(dev, ticks, flags);
1642#else
1643 ARG_UNUSED(dev);
1644 ARG_UNUSED(ticks);
1645 ARG_UNUSED(flags);
1646 return -ENOTSUP;
1647#endif
1648}
1649
1662
1663static inline uint64_t z_impl_counter_get_guard_period_64(const struct device *dev, uint32_t flags)
1664{
1665#ifdef CONFIG_COUNTER_64BITS_TICKS
1666 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1667
1668 return (api->get_guard_period_64) ? api->get_guard_period_64(dev, flags) : 0;
1669#else
1670 ARG_UNUSED(dev);
1671 ARG_UNUSED(flags);
1672 return -ENOTSUP;
1673#endif
1674}
1675
1683__syscall int counter_get_value_64(const struct device *dev, uint64_t *ticks);
1684
1685static inline int z_impl_counter_get_value_64(const struct device *dev, uint64_t *ticks)
1686{
1687#ifdef CONFIG_COUNTER_64BITS_TICKS
1688 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1689
1690 if (!api->get_value_64) {
1691 return -ENOSYS;
1692 }
1693
1694 return api->get_value_64(dev, ticks);
1695#else
1696 ARG_UNUSED(dev);
1697 ARG_UNUSED(ticks);
1698 return -ENOTSUP;
1699#endif
1700}
1701
1709__syscall int counter_set_value_64(const struct device *dev, uint64_t ticks);
1710
1711static inline int z_impl_counter_set_value_64(const struct device *dev, uint64_t ticks)
1712{
1713#ifdef CONFIG_COUNTER_64BITS_TICKS
1714 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1715
1716 if (!api->set_value_64) {
1717 return -ENOSYS;
1718 }
1719
1720 return api->set_value_64(dev, ticks);
1721#else
1722 ARG_UNUSED(dev);
1723 ARG_UNUSED(ticks);
1724 return -ENOTSUP;
1725#endif
1726}
1727
1728#if defined(CONFIG_COUNTER_CAPTURE) || defined(__DOXYGEN__)
1738
1766static inline int counter_capture_configure(const struct device *dev, uint8_t chan_id,
1768 counter_capture_cb_t cb, void *user_data)
1769{
1770 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1771
1772 if (api->capture_configure == NULL) {
1773 return -ENOTSUP;
1774 }
1775
1776 if (chan_id >= counter_get_num_of_channels(dev)) {
1777 return -ENOTSUP;
1778 }
1779
1780 return api->capture_configure(dev, chan_id, flags, cb, user_data);
1781}
1782
1793static inline int counter_capture_configure_dt(const struct counter_capture_dt_spec *spec,
1794 counter_capture_cb_t cb, void *user_data)
1795{
1796 return counter_capture_configure(spec->dev, spec->chan_id, spec->flags, cb, user_data);
1797}
1798
1799#if defined(CONFIG_COUNTER_64BITS_TICKS) || defined(__DOXYGEN__)
1827static inline int counter_capture_configure_64(const struct device *dev, uint8_t chan_id,
1829 counter_capture_cb_64_t cb, void *user_data)
1830{
1831 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1832
1833 if (api->capture_configure_64 == NULL) {
1834 return -ENOTSUP;
1835 }
1836
1837 if (chan_id >= counter_get_num_of_channels(dev)) {
1838 return -ENOTSUP;
1839 }
1840
1841 return api->capture_configure_64(dev, chan_id, flags, cb, user_data);
1842}
1843
1855 counter_capture_cb_64_t cb, void *user_data)
1856{
1857 return counter_capture_configure_64(spec->dev, spec->chan_id, spec->flags, cb,
1858 user_data);
1859}
1860#endif /* CONFIG_COUNTER_64BITS_TICKS */
1861
1871__syscall int counter_enable_capture(const struct device *dev, uint8_t chan_id);
1872
1873static inline int z_impl_counter_enable_capture(const struct device *dev, uint8_t chan_id)
1874{
1875 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1876
1877 if (api->enable_capture == NULL) {
1878 return -ENOTSUP;
1879 }
1880
1881 if (chan_id >= counter_get_num_of_channels(dev)) {
1882 return -ENOTSUP;
1883 }
1884
1885 return api->enable_capture(dev, chan_id);
1886}
1887
1896static inline int counter_enable_capture_dt(const struct counter_capture_dt_spec *spec)
1897{
1898 return counter_enable_capture(spec->dev, spec->chan_id);
1899}
1900
1910__syscall int counter_disable_capture(const struct device *dev, uint8_t chan_id);
1911
1912static inline int z_impl_counter_disable_capture(const struct device *dev, uint8_t chan_id)
1913{
1914 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1915
1916 if (api->disable_capture == NULL) {
1917 return -ENOTSUP;
1918 }
1919
1920 if (chan_id >= counter_get_num_of_channels(dev)) {
1921 return -ENOTSUP;
1922 }
1923
1924 return api->disable_capture(dev, chan_id);
1925}
1926
1935static inline int counter_disable_capture_dt(const struct counter_capture_dt_spec *spec)
1936{
1937 return counter_disable_capture(spec->dev, spec->chan_id);
1938}
1939
1941#endif /* CONFIG_COUNTER_CAPTURE */
1942
1943#if defined(CONFIG_COUNTER_CALIBRATION) || defined(__DOXYGEN__)
1957__syscall int counter_set_calibration(const struct device *dev, int32_t calibration);
1958
1959static inline int z_impl_counter_set_calibration(const struct device *dev, int32_t calibration)
1960{
1961 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1962
1963 if (!api->set_calibration) {
1964 return -ENOSYS;
1965 }
1966
1967 return api->set_calibration(dev, calibration);
1968}
1969
1979__syscall int counter_get_calibration(const struct device *dev, int32_t *calibration);
1980
1981static inline int z_impl_counter_get_calibration(const struct device *dev, int32_t *calibration)
1982{
1983 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1984
1985 if (!api->get_calibration) {
1986 return -ENOSYS;
1987 }
1988
1989 return api->get_calibration(dev, calibration);
1990}
1991#endif /* CONFIG_COUNTER_CALIBRATION */
1992
1993#ifdef __cplusplus
1994}
1995#endif
1996
2000
2001#include <zephyr/syscalls/counter.h>
2002
2003#endif /* ZEPHYR_INCLUDE_DRIVERS_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
Counter capture Devicetree macro public API header file.
Devicetree main header.
Counter capture flags for use in devicetree.
System error numbers.
#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_enable_capture_dt(const struct counter_capture_dt_spec *spec)
Enable capture on a channel using a DT spec.
Definition counter.h:1896
static int counter_disable_capture_dt(const struct counter_capture_dt_spec *spec)
Disable capture on a channel using a DT spec.
Definition counter.h:1935
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:1766
int counter_disable_capture(const struct device *dev, uint8_t chan_id)
Disable capture on a channel.
static int counter_capture_configure_64_dt(const struct counter_capture_dt_spec *spec, counter_capture_cb_64_t cb, void *user_data)
Configure a capture channel and register its 64-bit callback using a DT spec.
Definition counter.h:1854
static int counter_capture_configure_dt(const struct counter_capture_dt_spec *spec, counter_capture_cb_t cb, void *user_data)
Configure a capture channel and register its callback using a DT spec.
Definition counter.h:1793
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:1827
int counter_enable_capture(const struct device *dev, uint8_t chan_id)
Enable capture 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:740
uint32_t(* counter_api_get_top_value)(const struct device *dev)
Callback API to retrieve the current top value.
Definition counter.h:696
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:722
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:720
int(* counter_api_set_value)(const struct device *dev, uint32_t ticks)
Callback API to set the current counter value.
Definition counter.h:684
int(* counter_api_stop)(const struct device *dev)
Callback API to stop the counter.
Definition counter.h:678
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:712
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:729
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:717
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:715
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:700
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:705
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:710
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:698
uint32_t(* counter_api_get_pending_int)(const struct device *dev)
Callback API to get pending counter interrupts.
Definition counter.h:694
uint32_t(* counter_api_get_freq)(const struct device *dev)
Callback API to get the counter frequency in Hz.
Definition counter.h:703
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:691
int(* counter_api_reset)(const struct device *dev)
Callback API to reset the counter to the initial value.
Definition counter.h:682
int(* counter_api_start)(const struct device *dev)
Callback API to start the counter.
Definition counter.h:676
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:725
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:689
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:733
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:708
int(* counter_api_get_value)(const struct device *dev, uint32_t *ticks)
Callback API to get the current counter value.
Definition counter.h:680
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:735
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:686
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:738
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.
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.
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.
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:528
void(* counter_alarm_callback_t)(const struct device *dev, uint8_t chan_id, uint32_t ticks, void *user_data)
Alarm callback.
Definition counter.h:486
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:666
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:475
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:600
uint64_t counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks)
Function to convert ticks with 64 bits to nanoseconds.
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:155
uint32_t counter_get_frequency(const struct device *dev)
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:57
int counter_set_calibration(const struct device *dev, int32_t calibration)
Set counter calibration value.
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_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_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.
uint32_t counter_ns_to_ticks(const struct device *dev, uint64_t ns)
Function to convert nanoseconds to ticks.
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
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:605
void * user_data
User data returned in callback.
Definition counter.h:630
uint32_t flags
Alarm flags (see COUNTER_ALARM_FLAGS).
Definition counter.h:634
counter_alarm_callback_64_t callback
Callback called on alarm (cannot be NULL).
Definition counter.h:626
uint64_t ticks
Number of ticks that triggers the alarm.
Definition counter.h:622
Alarm callback structure.
Definition counter.h:491
uint32_t ticks
Number of ticks that triggers the alarm.
Definition counter.h:512
uint32_t flags
Alarm flags (see COUNTER_ALARM_FLAGS).
Definition counter.h:520
void * user_data
User data returned in callback.
Definition counter.h:516
counter_alarm_callback_t callback
Callback called on alarm (cannot be NULL).
Definition counter.h:495
Container for counter capture information specified in devicetree.
Definition counter.h:171
counter_capture_flags_t flags
Capture flags.
Definition counter.h:175
const struct device * dev
Counter device instance.
Definition counter.h:173
uint8_t chan_id
Channel ID.
Definition counter.h:177
Structure with generic counter features.
Definition counter.h:553
uint32_t max_top_value
Maximal (default) top value on which counter is reset (cleared or reloaded).
Definition counter.h:579
uint32_t freq
Frequency of the source clock if synchronous events are counted.
Definition counter.h:560
uint8_t flags
Flags (see COUNTER_FLAGS).
Definition counter.h:584
uint8_t channels
Number of channels that can be used for setting alarm.
Definition counter.h:590
<span class="mlabel">Driver Operations</span> Counter driver operations
Definition counter.h:745
counter_api_get_calibration get_calibration
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:862
counter_api_get_top_value get_top_value
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:785
counter_api_set_top_value set_top_value
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:777
counter_api_set_alarm set_alarm
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:769
counter_api_get_value get_value
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:757
counter_api_reset reset
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:761
counter_api_get_pending_int get_pending_int
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:781
counter_api_stop stop
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:753
counter_api_set_guard_period set_guard_period
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:793
counter_api_set_value set_value
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:765
counter_api_start start
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:749
counter_api_set_calibration set_calibration
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:858
counter_api_get_guard_period get_guard_period
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:789
counter_api_cancel_alarm cancel_alarm
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:773
counter_api_get_freq get_freq
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:797
Top value configuration structure.
Definition counter.h:639
void * user_data
User data passed to callback function (not valid if callback is NULL).
Definition counter.h:651
counter_top_callback_t callback
Callback function (can be NULL).
Definition counter.h:647
uint32_t flags
Flags (see COUNTER_TOP_FLAGS).
Definition counter.h:655
uint64_t ticks
Top value.
Definition counter.h:643
Top value configuration structure.
Definition counter.h:532
uint32_t ticks
Top value.
Definition counter.h:536
uint32_t flags
Flags (see COUNTER_TOP_FLAGS).
Definition counter.h:548
counter_top_callback_t callback
Callback function (can be NULL).
Definition counter.h:540
void * user_data
User data passed to callback function (not valid if callback is NULL).
Definition counter.h:544
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