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/sys_clock.h>
38#include <stdbool.h>
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
49
53#define COUNTER_CONFIG_INFO_COUNT_UP BIT(0)
54
56
62
69#define COUNTER_TOP_CFG_DONT_RESET BIT(0)
70
77#define COUNTER_TOP_CFG_RESET_WHEN_LATE BIT(1)
78
80
87
94#define COUNTER_ALARM_CFG_ABSOLUTE BIT(0)
95
102#define COUNTER_ALARM_CFG_EXPIRE_WHEN_LATE BIT(1)
103
105
113
118#define COUNTER_GUARD_PERIOD_LATE_TO_SET BIT(0)
119
121
129
133#define COUNTER_CAPTURE_RISING_EDGE BIT(0)
134
138#define COUNTER_CAPTURE_FALLING_EDGE BIT(1)
139
143#define COUNTER_CAPTURE_BOTH_EDGES (COUNTER_CAPTURE_FALLING_EDGE | COUNTER_CAPTURE_RISING_EDGE)
144
148#define COUNTER_CAPTURE_CONTINUOUS 0
149
153#define COUNTER_CAPTURE_SINGLE_SHOT BIT(2)
154
163
165
167
176typedef void (*counter_capture_cb_t)(const struct device *dev, uint8_t chan_id,
178 void *user_data);
179
187typedef void (*counter_alarm_callback_t)(const struct device *dev, uint8_t chan_id, uint32_t ticks,
188 void *user_data);
189
223
229typedef void (*counter_top_callback_t)(const struct device *dev, void *user_data);
230
251
258#ifdef CONFIG_COUNTER_64BITS_FREQ
260#else
262#endif
266#ifdef CONFIG_COUNTER_64BITS_TICKS
267 union {
268 uint64_t max_top_value_64;
269 struct {
270#ifdef CONFIG_BIG_ENDIAN
271 uint32_t reserved;
273#else
275 uint32_t reserved;
276#endif /* CONFIG_BIG_ENDIAN */
277 };
278 };
279#else
281#endif /* CONFIG_COUNTER_64BITS_TICKS */
292};
293
301typedef void (*counter_alarm_callback_64_t)(const struct device *dev, uint8_t chan_id,
302 uint64_t ticks, void *user_data);
303
337
358
367typedef void (*counter_capture_cb_64_t)(const struct device *dev, uint8_t chan_id,
369 void *user_data);
370
375
377typedef int (*counter_api_start)(const struct device *dev);
379typedef int (*counter_api_stop)(const struct device *dev);
381typedef int (*counter_api_get_value)(const struct device *dev, uint32_t *ticks);
383typedef int (*counter_api_reset)(const struct device *dev);
385typedef int (*counter_api_set_value)(const struct device *dev, uint32_t ticks);
387typedef int (*counter_api_set_alarm)(const struct device *dev, uint8_t chan_id,
388 const struct counter_alarm_cfg *alarm_cfg);
390typedef int (*counter_api_cancel_alarm)(const struct device *dev, uint8_t chan_id);
392typedef int (*counter_api_set_top_value)(const struct device *dev,
393 const struct counter_top_cfg *cfg);
395typedef uint32_t (*counter_api_get_pending_int)(const struct device *dev);
397typedef uint32_t (*counter_api_get_top_value)(const struct device *dev);
401typedef int (*counter_api_set_guard_period)(const struct device *dev, uint32_t ticks,
404typedef uint32_t (*counter_api_get_freq)(const struct device *dev);
406typedef uint64_t (*counter_api_get_freq_64)(const struct device *dev);
407
409typedef int (*counter_api_get_value_64)(const struct device *dev, uint64_t *ticks);
411typedef int (*counter_api_set_value_64)(const struct device *dev, uint64_t ticks);
413typedef int (*counter_api_set_alarm_64)(const struct device *dev, uint8_t chan_id,
414 const struct counter_alarm_cfg_64 *alarm_cfg);
418typedef int (*counter_api_set_guard_period_64)(const struct device *dev, uint64_t ticks,
421typedef uint64_t (*counter_api_get_top_value_64)(const struct device *dev);
423typedef int (*counter_api_set_top_value_64)(const struct device *dev,
424 const struct counter_top_cfg_64 *cfg);
426typedef int (*counter_api_capture_configure)(const struct device *dev, uint8_t chan_id,
428 counter_capture_cb_t cb, void *user_data);
430typedef int (*counter_api_capture_configure_64)(const struct device *dev, uint8_t chan_id,
432 counter_capture_cb_64_t cb, void *user_data);
434typedef int (*counter_api_enable_capture)(const struct device *dev, uint8_t chan_id);
436typedef int (*counter_api_disable_capture)(const struct device *dev, uint8_t chan_id);
437
441__subsystem struct counter_driver_api {
494#ifdef CONFIG_COUNTER_64BITS_FREQ
498 counter_api_get_freq_64 get_freq_64;
499#endif /* CONFIG_COUNTER_64BITS_FREQ */
500#ifdef CONFIG_COUNTER_64BITS_TICKS
504 counter_api_get_value_64 get_value_64;
508 counter_api_set_value_64 set_value_64;
512 counter_api_set_alarm_64 set_alarm_64;
516 counter_api_get_guard_period_64 get_guard_period_64;
520 counter_api_set_guard_period_64 set_guard_period_64;
524 counter_api_get_top_value_64 get_top_value_64;
528 counter_api_set_top_value_64 set_top_value_64;
529#endif /* CONFIG_COUNTER_64BITS_TICKS */
530#ifdef CONFIG_COUNTER_CAPTURE
534 counter_api_capture_configure capture_configure;
535#ifdef CONFIG_COUNTER_64BITS_TICKS
539 counter_api_capture_configure_64 capture_configure_64;
540#endif /* CONFIG_COUNTER_64BITS_TICKS */
544 counter_api_enable_capture enable_capture;
548 counter_api_disable_capture disable_capture;
549#endif /* CONFIG_COUNTER_CAPTURE */
550};
551
554
563__syscall bool counter_is_counting_up(const struct device *dev);
564
565static inline bool z_impl_counter_is_counting_up(const struct device *dev)
566{
567 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
568
569 return config->flags & COUNTER_CONFIG_INFO_COUNT_UP;
570}
571
579__syscall uint8_t counter_get_num_of_channels(const struct device *dev);
580
581static inline uint8_t z_impl_counter_get_num_of_channels(const struct device *dev)
582{
583 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
584
585 return config->channels;
586}
587
588__syscall uint32_t counter_get_frequency(const struct device *dev);
589
590#ifdef CONFIG_COUNTER_64BITS_FREQ
601static inline uint32_t z_impl_counter_get_frequency(const struct device *dev)
602{
603 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
604 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
605
606 if (api->get_freq) {
607 return api->get_freq(dev);
608 } else {
609 return config->freq > UINT32_MAX ? UINT32_MAX : (uint32_t)config->freq;
610 }
611}
612
613#else
614
623static inline uint32_t z_impl_counter_get_frequency(const struct device *dev)
624{
625 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
626 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
627
628 return api->get_freq ? api->get_freq(dev) : config->freq;
629}
630#endif
631
640__syscall uint64_t counter_get_frequency_64(const struct device *dev);
641
642static inline uint64_t z_impl_counter_get_frequency_64(const struct device *dev)
643{
644#ifdef CONFIG_COUNTER_64BITS_FREQ
645 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
646 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
647
648 if (api->get_freq_64) {
649 return api->get_freq_64(dev);
650 } else if (api->get_freq) {
651 return (uint64_t)api->get_freq(dev);
652 } else {
653 return config->freq;
654 }
655#else
656 ARG_UNUSED(dev);
657 return -ENOTSUP;
658#endif
659}
660
661#ifdef CONFIG_COUNTER_64BITS_FREQ
662#define z_counter_get_frequency z_impl_counter_get_frequency_64
663#else
664#define z_counter_get_frequency z_impl_counter_get_frequency
665#endif
666
675__syscall uint32_t counter_us_to_ticks(const struct device *dev, uint64_t us);
676
677static inline uint32_t z_impl_counter_us_to_ticks(const struct device *dev, uint64_t us)
678{
679 uint64_t ticks = (us * z_counter_get_frequency(dev)) / USEC_PER_SEC;
680
681 return (ticks > (uint64_t)UINT32_MAX) ? UINT32_MAX : ticks;
682}
683
692__syscall uint64_t counter_us_to_ticks_64(const struct device *dev, uint64_t us);
693
694static inline uint64_t z_impl_counter_us_to_ticks_64(const struct device *dev, uint64_t us)
695{
696 uint64_t freq = z_counter_get_frequency(dev);
697
698 return (us / USEC_PER_SEC) * freq + ((us % USEC_PER_SEC) * freq) / USEC_PER_SEC;
699}
700
709__syscall uint64_t counter_ticks_to_us(const struct device *dev, uint32_t ticks);
710
711static inline uint64_t z_impl_counter_ticks_to_us(const struct device *dev, uint32_t ticks)
712{
713 return ((uint64_t)ticks * USEC_PER_SEC) / z_counter_get_frequency(dev);
714}
715
724__syscall uint64_t counter_ticks_to_us_64(const struct device *dev, uint64_t ticks);
725
726static inline uint64_t z_impl_counter_ticks_to_us_64(const struct device *dev, uint64_t ticks)
727{
728 uint64_t freq = z_counter_get_frequency(dev);
729
730 return (ticks / freq) * USEC_PER_SEC + ((ticks % freq) * USEC_PER_SEC) / freq;
731}
732
741__syscall uint32_t counter_ns_to_ticks(const struct device *dev, uint64_t ns);
742
743static inline uint32_t z_impl_counter_ns_to_ticks(const struct device *dev, uint64_t ns)
744{
745 uint64_t ticks = (ns * z_counter_get_frequency(dev)) / NSEC_PER_SEC;
746
747 return (ticks > (uint64_t)UINT32_MAX) ? UINT32_MAX : ticks;
748}
749
758__syscall uint64_t counter_ns_to_ticks_64(const struct device *dev, uint64_t ns);
759
760static inline uint64_t z_impl_counter_ns_to_ticks_64(const struct device *dev, uint64_t ns)
761{
762 uint64_t freq = z_counter_get_frequency(dev);
763
764 return (ns / NSEC_PER_SEC) * freq + ((ns % NSEC_PER_SEC) * freq) / NSEC_PER_SEC;
765}
766
775__syscall uint64_t counter_ticks_to_ns(const struct device *dev, uint32_t ticks);
776
777static inline uint64_t z_impl_counter_ticks_to_ns(const struct device *dev, uint32_t ticks)
778{
779 return ((uint64_t)ticks * NSEC_PER_SEC) / z_counter_get_frequency(dev);
780}
781
790__syscall uint64_t counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks);
791
792static inline uint64_t z_impl_counter_ticks_to_ns_64(const struct device *dev, uint64_t ticks)
793{
794 uint64_t freq = z_counter_get_frequency(dev);
795
796 return (ticks / freq) * NSEC_PER_SEC + ((ticks % freq) * NSEC_PER_SEC) / freq;
797}
798
810__syscall uint32_t counter_get_max_top_value(const struct device *dev);
811
812static inline uint32_t z_impl_counter_get_max_top_value(const struct device *dev)
813{
814 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
815
816 return config->max_top_value;
817}
818
827__syscall int counter_start(const struct device *dev);
828
829static inline int z_impl_counter_start(const struct device *dev)
830{
831 return DEVICE_API_GET(counter, dev)->start(dev);
832}
833
843__syscall int counter_stop(const struct device *dev);
844
845static inline int z_impl_counter_stop(const struct device *dev)
846{
847 return DEVICE_API_GET(counter, dev)->stop(dev);
848}
849
858__syscall int counter_get_value(const struct device *dev, uint32_t *ticks);
859
860static inline int z_impl_counter_get_value(const struct device *dev, uint32_t *ticks)
861{
862 return DEVICE_API_GET(counter, dev)->get_value(dev, ticks);
863}
864
872__syscall int counter_reset(const struct device *dev);
873
874static inline int z_impl_counter_reset(const struct device *dev)
875{
876 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
877
878 if (!api->reset) {
879 return -ENOSYS;
880 }
881
882 return api->reset(dev);
883}
884
893__syscall int counter_set_value(const struct device *dev, uint32_t ticks);
894
895static inline int z_impl_counter_set_value(const struct device *dev, uint32_t ticks)
896{
897 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
898
899 if (!api->set_value) {
900 return -ENOSYS;
901 }
902
903 return api->set_value(dev, ticks);
904}
905
926__syscall int counter_set_channel_alarm(const struct device *dev, uint8_t chan_id,
927 const struct counter_alarm_cfg *alarm_cfg);
928
929static inline int z_impl_counter_set_channel_alarm(const struct device *dev, uint8_t chan_id,
930 const struct counter_alarm_cfg *alarm_cfg)
931{
932 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
933
934 if (chan_id >= counter_get_num_of_channels(dev)) {
935 return -ENOTSUP;
936 }
937
938 return api->set_alarm(dev, chan_id, alarm_cfg);
939}
940
953__syscall int counter_cancel_channel_alarm(const struct device *dev, uint8_t chan_id);
954
955static inline int z_impl_counter_cancel_channel_alarm(const struct device *dev, uint8_t chan_id)
956{
957 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
958
959 if (chan_id >= counter_get_num_of_channels(dev)) {
960 return -ENOTSUP;
961 }
962
963 return api->cancel_alarm(dev, chan_id);
964}
965
994__syscall int counter_set_top_value(const struct device *dev, const struct counter_top_cfg *cfg);
995
996static inline int z_impl_counter_set_top_value(const struct device *dev,
997 const struct counter_top_cfg *cfg)
998{
999 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1000
1001 if (cfg->ticks > counter_get_max_top_value(dev)) {
1002 return -EINVAL;
1003 }
1004
1005 return api->set_top_value(dev, cfg);
1006}
1007
1021__syscall uint32_t counter_get_pending_int(const struct device *dev);
1022
1023static inline uint32_t z_impl_counter_get_pending_int(const struct device *dev)
1024{
1025 return DEVICE_API_GET(counter, dev)->get_pending_int(dev);
1026}
1027
1035__syscall uint32_t counter_get_top_value(const struct device *dev);
1036
1037static inline uint32_t z_impl_counter_get_top_value(const struct device *dev)
1038{
1039 return DEVICE_API_GET(counter, dev)->get_top_value(dev);
1040}
1041
1100__syscall int counter_set_guard_period(const struct device *dev, uint32_t ticks, uint32_t flags);
1101
1102static inline int z_impl_counter_set_guard_period(const struct device *dev, uint32_t ticks,
1104{
1105 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1106
1107 if (!api->set_guard_period) {
1108 return -ENOSYS;
1109 }
1110
1111 return api->set_guard_period(dev, ticks, flags);
1112}
1113
1126
1127static inline uint32_t z_impl_counter_get_guard_period(const struct device *dev, uint32_t flags)
1128{
1129 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1130
1131 return (api->get_guard_period) ? api->get_guard_period(dev, flags) : 0;
1132}
1133
1141__syscall uint64_t counter_get_max_top_value_64(const struct device *dev);
1142
1143static inline uint64_t z_impl_counter_get_max_top_value_64(const struct device *dev)
1144{
1145#ifdef CONFIG_COUNTER_64BITS_TICKS
1146 const struct counter_config_info *config = (const struct counter_config_info *)dev->config;
1147
1148 return config->max_top_value_64;
1149#else
1150 ARG_UNUSED(dev);
1151 return -ENOTSUP;
1152#endif
1153}
1154
1179__syscall int counter_set_top_value_64(const struct device *dev,
1180 const struct counter_top_cfg_64 *cfg);
1181
1182static inline int z_impl_counter_set_top_value_64(const struct device *dev,
1183 const struct counter_top_cfg_64 *cfg)
1184{
1185#ifdef CONFIG_COUNTER_64BITS_TICKS
1186 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1187
1188 if (cfg->ticks > counter_get_max_top_value_64(dev)) {
1189 return -EINVAL;
1190 }
1191
1192 return api->set_top_value_64(dev, cfg);
1193#else
1194 ARG_UNUSED(dev);
1195 ARG_UNUSED(cfg);
1196 return -ENOTSUP;
1197#endif
1198}
1199
1220__syscall int counter_set_channel_alarm_64(const struct device *dev, uint8_t chan_id,
1221 const struct counter_alarm_cfg_64 *alarm_cfg);
1222
1223static inline int z_impl_counter_set_channel_alarm_64(const struct device *dev, uint8_t chan_id,
1224 const struct counter_alarm_cfg_64 *alarm_cfg)
1225{
1226#ifdef CONFIG_COUNTER_64BITS_TICKS
1227 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1228
1229 if (chan_id >= counter_get_num_of_channels(dev)) {
1230 return -ENOTSUP;
1231 }
1232
1233 return api->set_alarm_64(dev, chan_id, alarm_cfg);
1234#else
1235 ARG_UNUSED(dev);
1236 ARG_UNUSED(chan_id);
1237 ARG_UNUSED(alarm_cfg);
1238 return -ENOTSUP;
1239#endif
1240}
1241
1249__syscall uint64_t counter_get_top_value_64(const struct device *dev);
1250
1251static inline uint64_t z_impl_counter_get_top_value_64(const struct device *dev)
1252{
1253#ifdef CONFIG_COUNTER_64BITS_TICKS
1254 return DEVICE_API_GET(counter, dev)->get_top_value_64(dev);
1255#else
1256 ARG_UNUSED(dev);
1257 return 0;
1258#endif
1259}
1260
1319__syscall int counter_set_guard_period_64(const struct device *dev, uint64_t ticks, uint32_t flags);
1320
1321static inline int z_impl_counter_set_guard_period_64(const struct device *dev, uint64_t ticks,
1323{
1324#ifdef CONFIG_COUNTER_64BITS_TICKS
1325 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1326
1327 if (!api->set_guard_period_64) {
1328 return -ENOSYS;
1329 }
1330
1331 return api->set_guard_period_64(dev, ticks, flags);
1332#else
1333 ARG_UNUSED(dev);
1334 ARG_UNUSED(ticks);
1335 ARG_UNUSED(flags);
1336 return -ENOTSUP;
1337#endif
1338}
1339
1352
1353static inline uint64_t z_impl_counter_get_guard_period_64(const struct device *dev, uint32_t flags)
1354{
1355#ifdef CONFIG_COUNTER_64BITS_TICKS
1356 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1357
1358 return (api->get_guard_period_64) ? api->get_guard_period_64(dev, flags) : 0;
1359#else
1360 ARG_UNUSED(dev);
1361 ARG_UNUSED(flags);
1362 return -ENOTSUP;
1363#endif
1364}
1365
1374__syscall int counter_get_value_64(const struct device *dev, uint64_t *ticks);
1375
1376static inline int z_impl_counter_get_value_64(const struct device *dev, uint64_t *ticks)
1377{
1378#ifdef CONFIG_COUNTER_64BITS_TICKS
1379 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1380
1381 if (!api->get_value_64) {
1382 return -ENOSYS;
1383 }
1384
1385 return api->get_value_64(dev, ticks);
1386#else
1387 ARG_UNUSED(dev);
1388 ARG_UNUSED(ticks);
1389 return -ENOTSUP;
1390#endif
1391}
1392
1401__syscall int counter_set_value_64(const struct device *dev, uint64_t ticks);
1402
1403static inline int z_impl_counter_set_value_64(const struct device *dev, uint64_t ticks)
1404{
1405#ifdef CONFIG_COUNTER_64BITS_TICKS
1406 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1407
1408 if (!api->set_value_64) {
1409 return -ENOSYS;
1410 }
1411
1412 return api->set_value_64(dev, ticks);
1413#else
1414 ARG_UNUSED(dev);
1415 ARG_UNUSED(ticks);
1416 return -ENOTSUP;
1417#endif
1418}
1419
1420#if defined(CONFIG_COUNTER_CAPTURE) || defined(__DOXYGEN__)
1430
1458static inline int counter_capture_configure(const struct device *dev, uint8_t chan_id,
1460 counter_capture_cb_t cb, void *user_data)
1461{
1462 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1463
1464 if (api->capture_configure == NULL) {
1465 return -ENOTSUP;
1466 }
1467
1468 if (chan_id >= counter_get_num_of_channels(dev)) {
1469 return -ENOTSUP;
1470 }
1471
1472 return api->capture_configure(dev, chan_id, flags, cb, user_data);
1473}
1474
1475#if defined(CONFIG_COUNTER_64BITS_TICKS) || defined(__DOXYGEN__)
1503static inline int counter_capture_configure_64(const struct device *dev, uint8_t chan_id,
1505 counter_capture_cb_64_t cb, void *user_data)
1506{
1507 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1508
1509 if (api->capture_configure_64 == NULL) {
1510 return -ENOTSUP;
1511 }
1512
1513 if (chan_id >= counter_get_num_of_channels(dev)) {
1514 return -ENOTSUP;
1515 }
1516
1517 return api->capture_configure_64(dev, chan_id, flags, cb, user_data);
1518}
1519#endif /* CONFIG_COUNTER_64BITS_TICKS */
1520
1530__syscall int counter_enable_capture(const struct device *dev, uint8_t chan_id);
1531
1532static inline int z_impl_counter_enable_capture(const struct device *dev, uint8_t chan_id)
1533{
1534 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1535
1536 if (api->enable_capture == NULL) {
1537 return -ENOTSUP;
1538 }
1539
1540 if (chan_id >= counter_get_num_of_channels(dev)) {
1541 return -ENOTSUP;
1542 }
1543
1544 return api->enable_capture(dev, chan_id);
1545}
1546
1556__syscall int counter_disable_capture(const struct device *dev, uint8_t chan_id);
1557
1558static inline int z_impl_counter_disable_capture(const struct device *dev, uint8_t chan_id)
1559{
1560 const struct counter_driver_api *api = DEVICE_API_GET(counter, dev);
1561
1562 if (api->disable_capture == NULL) {
1563 return -ENOTSUP;
1564 }
1565
1566 if (chan_id >= counter_get_num_of_channels(dev)) {
1567 return -ENOTSUP;
1568 }
1569
1570 return api->disable_capture(dev, chan_id);
1571}
1572
1574#endif /* CONFIG_COUNTER_CAPTURE */
1575
1576#ifdef __cplusplus
1577}
1578#endif
1579
1583
1584#include <zephyr/syscalls/counter.h>
1585
1586#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
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_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:1458
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:1503
int counter_enable_capture(const struct device *dev, uint8_t chan_id)
Enable capture on a channel.
uint32_t(* counter_api_get_top_value)(const struct device *dev)
Callback API to retrieve the current top value.
Definition counter.h:397
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
int(* counter_api_stop)(const struct device *dev)
Callback API to stop the counter.
Definition counter.h:379
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
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
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
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
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
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_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)
Callback API to start the counter.
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_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_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
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: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
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
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.
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
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:53
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.
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
__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
<span class="mlabel">Driver Operations</span> Counter driver operations
Definition counter.h:441
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:481
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:473
counter_api_set_alarm set_alarm
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:465
counter_api_get_value get_value
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:453
counter_api_reset reset
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition counter.h:457
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:477
counter_api_stop stop
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:449
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:489
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:461
counter_api_start start
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:445
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:485
counter_api_cancel_alarm cancel_alarm
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition counter.h:469
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:493
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