Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
sys_clock.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2014-2015 Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
16#ifndef ZEPHYR_INCLUDE_SYS_CLOCK_H_
17#define ZEPHYR_INCLUDE_SYS_CLOCK_H_
18
19#include <zephyr/sys/util.h>
20#include <zephyr/sys/dlist.h>
21
22#include <zephyr/toolchain.h>
23#include <zephyr/types.h>
24
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
45#ifdef CONFIG_TIMEOUT_64BIT
46typedef int64_t k_ticks_t;
47#else
49#endif
50
51#define K_TICKS_FOREVER ((k_ticks_t) -1)
52
65typedef struct {
68
80#define K_TIMEOUT_EQ(a, b) ((a).ticks == (b).ticks)
81
83#define NSEC_PER_USEC 1000U
84
86#define NSEC_PER_MSEC 1000000U
87
89#define USEC_PER_MSEC 1000U
90
92#define MSEC_PER_SEC 1000U
93
95#define SEC_PER_MIN 60U
96
98#define SEC_PER_HOUR 3600U
99
101#define SEC_PER_DAY 86400U
102
104#define MIN_PER_HOUR 60U
105
107#define HOUR_PER_DAY 24U
108
110#define USEC_PER_SEC ((USEC_PER_MSEC) * (MSEC_PER_SEC))
111
113#define NSEC_PER_SEC ((NSEC_PER_USEC) * (USEC_PER_MSEC) * (MSEC_PER_SEC))
114
118#define Z_TIMEOUT_NO_WAIT ((k_timeout_t) {0})
119#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
120#define Z_TIMEOUT_TICKS(t) ((k_timeout_t) { (t) })
121#else
122#define Z_TIMEOUT_TICKS(t) ((k_timeout_t) { .ticks = (t) })
123#endif
124#define Z_FOREVER Z_TIMEOUT_TICKS(K_TICKS_FOREVER)
125
126#ifdef CONFIG_TIMEOUT_64BIT
127# define Z_TIMEOUT_MS(t) Z_TIMEOUT_TICKS((k_ticks_t)k_ms_to_ticks_ceil64(MAX(t, 0)))
128# define Z_TIMEOUT_US(t) Z_TIMEOUT_TICKS((k_ticks_t)k_us_to_ticks_ceil64(MAX(t, 0)))
129# define Z_TIMEOUT_NS(t) Z_TIMEOUT_TICKS((k_ticks_t)k_ns_to_ticks_ceil64(MAX(t, 0)))
130# define Z_TIMEOUT_CYC(t) Z_TIMEOUT_TICKS((k_ticks_t)k_cyc_to_ticks_ceil64(MAX(t, 0)))
131# define Z_TIMEOUT_MS_TICKS(t) ((k_ticks_t)k_ms_to_ticks_ceil64(MAX(t, 0)))
132#else
133# define Z_TIMEOUT_MS(t) Z_TIMEOUT_TICKS((k_ticks_t)k_ms_to_ticks_ceil32(MAX(t, 0)))
134# define Z_TIMEOUT_US(t) Z_TIMEOUT_TICKS((k_ticks_t)k_us_to_ticks_ceil32(MAX(t, 0)))
135# define Z_TIMEOUT_NS(t) Z_TIMEOUT_TICKS((k_ticks_t)k_ns_to_ticks_ceil32(MAX(t, 0)))
136# define Z_TIMEOUT_CYC(t) Z_TIMEOUT_TICKS((k_ticks_t)k_cyc_to_ticks_ceil32(MAX(t, 0)))
137# define Z_TIMEOUT_MS_TICKS(t) ((k_ticks_t)k_ms_to_ticks_ceil32(MAX(t, 0)))
138#endif
139
140/* Converts between absolute timeout expiration values (packed into
141 * the negative space below K_TICKS_FOREVER) and (non-negative) delta
142 * timeout values. If the result of Z_TICK_ABS(t) is >= 0, then the
143 * value was an absolute timeout with the returned expiration time.
144 * Note that this macro is bidirectional: Z_TICK_ABS(Z_TICK_ABS(t)) ==
145 * t for all inputs, and that the representation of K_TICKS_FOREVER is
146 * the same value in both spaces! Clever, huh?
147 */
148#define Z_TICK_ABS(t) (K_TICKS_FOREVER - 1 - (t))
149
150/* added tick needed to account for tick in progress */
151#define _TICK_ALIGN 1
152
155#if defined(CONFIG_SYS_CLOCK_EXISTS) && \
156 (CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC == 0)
157#error "SYS_CLOCK_HW_CYCLES_PER_SEC must be non-zero!"
158#endif
159
160
161/* kernel clocks */
162
163/*
164 * We default to using 64-bit intermediates in timescale conversions,
165 * but if the HW timer cycles/sec, ticks/sec and ms/sec are all known
166 * to be nicely related, then we can cheat with 32 bits instead.
167 */
173#ifdef CONFIG_SYS_CLOCK_EXISTS
174
175#if defined(CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME) || \
176 (MSEC_PER_SEC % CONFIG_SYS_CLOCK_TICKS_PER_SEC) || \
177 (CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC % CONFIG_SYS_CLOCK_TICKS_PER_SEC)
178#define _NEED_PRECISE_TICK_MS_CONVERSION
179#endif
180
181#endif
182
187#define SYS_CLOCK_HW_CYCLES_TO_NS_AVG(X, NCYCLES) \
188 (uint32_t)(k_cyc_to_ns_floor64(X) / NCYCLES)
189
198
207
208#ifndef CONFIG_SYS_CLOCK_EXISTS
209#define sys_clock_tick_get() (0)
210#define sys_clock_tick_get_32() (0)
211#endif
212
213#ifdef CONFIG_SYS_CLOCK_EXISTS
214
225typedef struct { uint64_t tick; } k_timepoint_t;
226
244
259
271{
272 if (a.tick == b.tick) {
273 return 0;
274 }
275 return a.tick < b.tick ? -1 : 1;
276}
277
278#else
279
280/*
281 * When timers are configured out, timepoints can't relate to anything.
282 * The best we can do is to preserve whether or not they are derived from
283 * K_NO_WAIT. Anything else will translate back to K_FOREVER.
284 */
285typedef struct { bool wait; } k_timepoint_t;
286
287static inline k_timepoint_t sys_timepoint_calc(k_timeout_t timeout)
288{
289 k_timepoint_t timepoint;
290
291 timepoint.wait = !K_TIMEOUT_EQ(timeout, Z_TIMEOUT_NO_WAIT);
292 return timepoint;
293}
294
295static inline k_timeout_t sys_timepoint_timeout(k_timepoint_t timepoint)
296{
297 return timepoint.wait ? Z_FOREVER : Z_TIMEOUT_NO_WAIT;
298}
299
300static inline int sys_timepoint_cmp(k_timepoint_t a, k_timepoint_t b)
301{
302 if (a.wait == b.wait) {
303 return 0;
304 }
305 return b.wait ? -1 : 1;
306}
307
308#endif
309
318static inline bool sys_timepoint_expired(k_timepoint_t timepoint)
319{
320 return K_TIMEOUT_EQ(sys_timepoint_timeout(timepoint), Z_TIMEOUT_NO_WAIT);
321}
322
325#ifdef __cplusplus
326}
327#endif
328
329#endif /* ZEPHYR_INCLUDE_SYS_CLOCK_H_ */
uint32_t sys_clock_tick_get_32(void)
Return the lower part of the current system tick count.
k_timepoint_t sys_timepoint_calc(k_timeout_t timeout)
Calculate a timepoint value.
int64_t sys_clock_tick_get(void)
Return the current system tick count.
k_timeout_t sys_timepoint_timeout(k_timepoint_t timepoint)
Remaining time to given timepoint.
static bool sys_timepoint_expired(k_timepoint_t timepoint)
Indicates if timepoint is expired.
Definition sys_clock.h:318
uint32_t k_ticks_t
Tick precision used in timeout APIs.
Definition sys_clock.h:48
#define K_TIMEOUT_EQ(a, b)
Compare timeouts for equality.
Definition sys_clock.h:80
static int sys_timepoint_cmp(k_timepoint_t a, k_timepoint_t b)
Compare two timepoint values.
Definition sys_clock.h:270
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__INT64_TYPE__ int64_t
Definition stdint.h:75
Kernel timeout type.
Definition sys_clock.h:65
k_ticks_t ticks
Definition sys_clock.h:66
Kernel timepoint type.
Definition sys_clock.h:225
uint64_t tick
Definition sys_clock.h:225
Misc utilities.
Macros to abstract toolchain specific capabilities.