The friendly Operating System for the Internet of Things
implementation.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Kaspar Schleiser <kaspar@schleiser.de>
3  * Copyright (C) 2016 Eistec AB
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
19 #ifndef XTIMER_IMPLEMENTATION_H
20 #define XTIMER_IMPLEMENTATION_H
21 
22 #ifndef XTIMER_H
23 #error "Do not include this file directly! Use xtimer.h instead"
24 #endif
25 
26 #include "periph/timer.h"
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #if XTIMER_MASK
33 extern volatile uint32_t _xtimer_high_cnt;
34 #endif
35 
39 #define MSG_XTIMER 12345
40 
44 static inline uint32_t _xtimer_lltimer_now(void)
45 {
46  return timer_read(XTIMER_DEV);
47 }
48 
52 static inline uint32_t _xtimer_lltimer_mask(uint32_t val)
53 {
54  return val & ~XTIMER_MASK;
55 }
56 
62 uint64_t _xtimer_now64(void);
63 int _xtimer_set_absolute(xtimer_t *timer, uint32_t target);
64 void _xtimer_set64(xtimer_t *timer, uint32_t offset, uint32_t long_offset);
65 void _xtimer_set(xtimer_t *timer, uint32_t offset);
66 void _xtimer_periodic_wakeup(uint32_t *last_wakeup, uint32_t period);
67 void _xtimer_set_msg(xtimer_t *timer, uint32_t offset, msg_t *msg, kernel_pid_t target_pid);
68 void _xtimer_set_msg64(xtimer_t *timer, uint64_t offset, msg_t *msg, kernel_pid_t target_pid);
69 void _xtimer_set_wakeup(xtimer_t *timer, uint32_t offset, kernel_pid_t pid);
70 void _xtimer_set_wakeup64(xtimer_t *timer, uint64_t offset, kernel_pid_t pid);
71 void _xtimer_set(xtimer_t *timer, uint32_t offset);
72 int _xtimer_msg_receive_timeout(msg_t *msg, uint32_t ticks);
73 int _xtimer_msg_receive_timeout64(msg_t *msg, uint64_t ticks);
74 
78 void _xtimer_tsleep(uint32_t offset, uint32_t long_offset);
81 #ifndef XTIMER_MIN_SPIN
82 
85 #define XTIMER_MIN_SPIN _xtimer_usec_from_ticks(1)
86 #endif
87 
88 #ifndef DOXYGEN
89 /* Doxygen warns that these are undocumented, but the documentation can be found in xtimer.h */
90 
91 static inline uint32_t _xtimer_now(void)
92 {
93 #if XTIMER_MASK
94  uint32_t latched_high_cnt, now;
95 
96  /* _high_cnt can change at any time, so check the value before
97  * and after reading the low-level timer. If it hasn't changed,
98  * then it can be safely applied to the timer count. */
99 
100  do {
101  latched_high_cnt = _xtimer_high_cnt;
102  now = _xtimer_lltimer_now();
103  } while (_xtimer_high_cnt != latched_high_cnt);
104 
105  return latched_high_cnt | now;
106 #else
107  return _xtimer_lltimer_now();
108 #endif
109 }
110 
111 static inline xtimer_ticks32_t xtimer_now(void)
112 {
113  xtimer_ticks32_t ret;
114  ret.ticks32 = _xtimer_now();
115  return ret;
116 }
117 
118 static inline xtimer_ticks64_t xtimer_now64(void)
119 {
120  xtimer_ticks64_t ret;
121  ret.ticks64 = _xtimer_now64();
122  return ret;
123 }
124 
125 static inline uint32_t xtimer_now_usec(void)
126 {
128 }
129 
130 static inline uint64_t xtimer_now_usec64(void)
131 {
133 }
134 
135 static inline void _xtimer_spin(uint32_t offset) {
136  uint32_t start = _xtimer_lltimer_now();
137 #if XTIMER_MASK
138  offset = _xtimer_lltimer_mask(offset);
139  while (_xtimer_lltimer_mask(_xtimer_lltimer_now() - start) < offset);
140 #else
141  while ((_xtimer_lltimer_now() - start) < offset);
142 #endif
143 }
144 
145 static inline void _xtimer_tsleep32(uint32_t ticks)
146 {
147  _xtimer_tsleep(ticks, 0);
148 }
149 
150 static inline void _xtimer_tsleep64(uint64_t ticks)
151 {
152  _xtimer_tsleep((uint32_t)ticks, (uint32_t)(ticks >> 32));
153 }
154 
155 static inline void xtimer_spin(xtimer_ticks32_t ticks) {
156  _xtimer_spin(ticks.ticks32);
157 }
158 
159 static inline void xtimer_usleep(uint32_t microseconds)
160 {
161  _xtimer_tsleep32(_xtimer_ticks_from_usec(microseconds));
162 }
163 
164 static inline void xtimer_usleep64(uint64_t microseconds)
165 {
166  _xtimer_tsleep64(_xtimer_ticks_from_usec64(microseconds));
167 }
168 
169 static inline void xtimer_sleep(uint32_t seconds)
170 {
171  _xtimer_tsleep64(_xtimer_ticks_from_usec64((uint64_t)seconds * US_PER_SEC));
172 }
173 
174 static inline void xtimer_nanosleep(uint32_t nanoseconds)
175 {
176  _xtimer_tsleep32(_xtimer_ticks_from_usec(nanoseconds / NS_PER_US));
177 }
178 
179 static inline void xtimer_tsleep32(xtimer_ticks32_t ticks)
180 {
181  _xtimer_tsleep32(ticks.ticks32);
182 }
183 
184 static inline void xtimer_tsleep64(xtimer_ticks64_t ticks)
185 {
186  _xtimer_tsleep64(ticks.ticks64);
187 }
188 
189 static inline void xtimer_periodic_wakeup(xtimer_ticks32_t *last_wakeup, uint32_t period)
190 {
191  _xtimer_periodic_wakeup(&last_wakeup->ticks32, _xtimer_ticks_from_usec(period));
192 }
193 
194 static inline void xtimer_set_msg(xtimer_t *timer, uint32_t offset, msg_t *msg, kernel_pid_t target_pid)
195 {
196  _xtimer_set_msg(timer, _xtimer_ticks_from_usec(offset), msg, target_pid);
197 }
198 
199 static inline void xtimer_set_msg64(xtimer_t *timer, uint64_t offset, msg_t *msg, kernel_pid_t target_pid)
200 {
201  _xtimer_set_msg64(timer, _xtimer_ticks_from_usec64(offset), msg, target_pid);
202 }
203 
204 static inline void xtimer_set_wakeup(xtimer_t *timer, uint32_t offset, kernel_pid_t pid)
205 {
206  _xtimer_set_wakeup(timer, _xtimer_ticks_from_usec(offset), pid);
207 }
208 
209 static inline void xtimer_set_wakeup64(xtimer_t *timer, uint64_t offset, kernel_pid_t pid)
210 {
211  _xtimer_set_wakeup64(timer, _xtimer_ticks_from_usec64(offset), pid);
212 }
213 
214 static inline void xtimer_set(xtimer_t *timer, uint32_t offset)
215 {
216  _xtimer_set(timer, _xtimer_ticks_from_usec(offset));
217 }
218 
219 static inline int xtimer_msg_receive_timeout(msg_t *msg, uint32_t timeout)
220 {
221  return _xtimer_msg_receive_timeout(msg, _xtimer_ticks_from_usec(timeout));
222 }
223 
224 static inline int xtimer_msg_receive_timeout64(msg_t *msg, uint64_t timeout)
225 {
226  return _xtimer_msg_receive_timeout64(msg, _xtimer_ticks_from_usec64(timeout));
227 }
228 
229 static inline xtimer_ticks32_t xtimer_ticks_from_usec(uint32_t usec)
230 {
231  xtimer_ticks32_t ticks;
232  ticks.ticks32 = _xtimer_ticks_from_usec(usec);
233  return ticks;
234 }
235 
236 static inline xtimer_ticks64_t xtimer_ticks_from_usec64(uint64_t usec)
237 {
238  xtimer_ticks64_t ticks;
239  ticks.ticks64 = _xtimer_ticks_from_usec64(usec);
240  return ticks;
241 }
242 
243 static inline uint32_t xtimer_usec_from_ticks(xtimer_ticks32_t ticks)
244 {
245  return _xtimer_usec_from_ticks(ticks.ticks32);
246 }
247 
248 static inline uint64_t xtimer_usec_from_ticks64(xtimer_ticks64_t ticks)
249 {
250  return _xtimer_usec_from_ticks64(ticks.ticks64);
251 }
252 
253 static inline xtimer_ticks32_t xtimer_ticks(uint32_t ticks)
254 {
255  xtimer_ticks32_t ret;
256  ret.ticks32 = ticks;
257  return ret;
258 }
259 
260 static inline xtimer_ticks64_t xtimer_ticks64(uint64_t ticks)
261 {
262  xtimer_ticks64_t ret;
263  ret.ticks64 = ticks;
264  return ret;
265 }
266 
268 {
269  xtimer_ticks32_t ret;
270  ret.ticks32 = a.ticks32 - b.ticks32;
271  return ret;
272 }
273 
275 {
276  xtimer_ticks64_t ret;
277  ret.ticks64 = a.ticks64 - b.ticks64;
278  return ret;
279 }
280 
282 {
283  uint64_t diff = a.ticks64 - b.ticks64;
284  xtimer_ticks32_t ret;
285  ret.ticks32 = diff;
286  return ret;
287 }
288 
289 static inline bool xtimer_less(xtimer_ticks32_t a, xtimer_ticks32_t b)
290 {
291  return (a.ticks32 < b.ticks32);
292 }
293 
294 static inline bool xtimer_less64(xtimer_ticks64_t a, xtimer_ticks64_t b)
295 {
296  return (a.ticks64 < b.ticks64);
297 }
298 
299 #endif /* !defined(DOXYGEN) */
300 
301 #ifdef __cplusplus
302 }
303 #endif
304 
305 #endif /* XTIMER_IMPLEMENTATION_H */
static xtimer_ticks64_t xtimer_ticks64(uint64_t ticks)
Create an xtimer time stamp, 64 bit version.
static uint64_t xtimer_usec_from_ticks64(xtimer_ticks64_t ticks)
Convert xtimer ticks to microseconds, 64 bit version.
uint64_t _xtimer_now64(void)
xtimer internal stuff
static void xtimer_set_msg64(xtimer_t *timer, uint64_t offset, msg_t *msg, kernel_pid_t target_pid)
Set a timer that sends a message, 64bit version.
static void xtimer_tsleep32(xtimer_ticks32_t ticks)
Stop execution of a thread for some time, 32bit version.
int16_t kernel_pid_t
Unique process identifier.
Definition: kernel_types.h:83
static uint64_t xtimer_now_usec64(void)
get the current system time in microseconds since start
static void xtimer_periodic_wakeup(xtimer_ticks32_t *last_wakeup, uint32_t period)
will cause the calling thread to be suspended until the absolute time (last_wakeup + period)...
static uint32_t xtimer_now_usec(void)
get the current system time in microseconds since start
static xtimer_ticks64_t xtimer_diff64(xtimer_ticks64_t a, xtimer_ticks64_t b)
Compute difference between two xtimer time stamps, 64 bit version.
static uint32_t _xtimer_lltimer_now(void)
returns the (masked) low-level timer counter value.
static xtimer_ticks64_t xtimer_now64(void)
get the current system time as 64bit time stamp
static void xtimer_set_wakeup64(xtimer_t *timer, uint64_t offset, kernel_pid_t pid)
Set a timer that wakes up a thread, 64bit version.
Low-level timer peripheral driver interface definitions.
#define XTIMER_DEV
Xtimer configuration.
#define XTIMER_MASK
xtimer timer mask
Definition: xtimer.h:571
unsigned int timer_read(tim_t dev)
Read the current value of the given timer device.
static void xtimer_usleep(uint32_t microseconds)
Pause the execution of a thread for some microseconds.
static void xtimer_nanosleep(uint32_t nanoseconds)
Stop execution of a thread for some time.
static xtimer_ticks32_t xtimer_ticks_from_usec(uint32_t usec)
Convert microseconds to xtimer ticks.
#define NS_PER_US
The number of nanoseconds per microsecond.
Definition: timex.h:59
uint64_t ticks64
Tick count.
Definition: xtimer.h:50
static xtimer_ticks32_t xtimer_diff32_64(xtimer_ticks64_t a, xtimer_ticks64_t b)
Compute 32 bit difference between two 64 bit xtimer time stamps.
uint32_t ticks32
Tick count.
Definition: xtimer.h:59
static void xtimer_spin(xtimer_ticks32_t ticks)
Stop execution of a thread for some time, blocking.
Describes a message object which can be sent between threads.
Definition: msg.h:184
static void xtimer_tsleep64(xtimer_ticks64_t ticks)
Stop execution of a thread for some time, 64bit version.
static xtimer_ticks64_t xtimer_ticks_from_usec64(uint64_t usec)
Convert microseconds to xtimer ticks, 64 bit version.
static xtimer_ticks32_t xtimer_diff(xtimer_ticks32_t a, xtimer_ticks32_t b)
Compute difference between two xtimer time stamps.
static void xtimer_set(xtimer_t *timer, uint32_t offset)
Set a timer to execute a callback at some time in the future.
static void xtimer_sleep(uint32_t seconds)
Pause the execution of a thread for some seconds.
void _xtimer_tsleep(uint32_t offset, uint32_t long_offset)
Sleep for the given number of ticks.
static xtimer_ticks32_t xtimer_ticks(uint32_t ticks)
Create an xtimer time stamp.
#define US_PER_SEC
The number of microseconds per second.
Definition: timex.h:34
static bool xtimer_less64(xtimer_ticks64_t a, xtimer_ticks64_t b)
Compare two xtimer time stamps, 64 bit version.
xtimer timer structure
Definition: xtimer.h:70
static void xtimer_set_msg(xtimer_t *timer, uint32_t offset, msg_t *msg, kernel_pid_t target_pid)
Set a timer that sends a message.
static int xtimer_msg_receive_timeout64(msg_t *msg, uint64_t timeout)
receive a message blocking but with timeout, 64bit version
static uint32_t _xtimer_lltimer_mask(uint32_t val)
drop bits of a value that don't fit into the low-level timer.
static bool xtimer_less(xtimer_ticks32_t a, xtimer_ticks32_t b)
Compare two xtimer time stamps.
xtimer timestamp (32 bit)
Definition: xtimer.h:58
xtimer timestamp (64 bit)
Definition: xtimer.h:49
static uint32_t xtimer_usec_from_ticks(xtimer_ticks32_t ticks)
Convert xtimer ticks to microseconds.
static void xtimer_set_wakeup(xtimer_t *timer, uint32_t offset, kernel_pid_t pid)
Set a timer that wakes up a thread.
static int xtimer_msg_receive_timeout(msg_t *msg, uint32_t timeout)
receive a message blocking but with timeout
static xtimer_ticks32_t xtimer_now(void)
get the current system time as 32bit time stamp value