Outline ![]()
Files ![]()
loading...
SourceVu![]()
Raspberry Pi Pico SDK and Examples![]()
PicoSDK![]()
src/rp2_common/hardware_timer/include/hardware/timer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
/*
* Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _HARDWARE_TIMER_H
#define _HARDWARE_TIMER_H
#include "pico.h"
#include "hardware/structs/timer.h"
#include "hardware/regs/intctrl.h"
#ifdef __cplusplus
extern "C" {
#endif
/** \file hardware/timer.h
* \defgroup hardware_timer hardware_timer
*
* \brief Low-level hardware timer API
*
* This API provides medium level access to the timer HW.
* See also \ref pico_time which provides higher levels functionality using the hardware timer.
*
* The timer peripheral on RP-series microcontrollers supports the following features:
* - RP2040 single 64-bit counter, incrementing once per microsecond
* - RP2350 two 64-bit counters, ticks generated from the tick block
* - Latching two-stage read of counter, for race-free read over 32 bit bus
* - Four alarms: match on the lower 32 bits of counter, IRQ on match.
*
* \if rp2040_specific
* On RP2040, by default the timer uses a one microsecond reference that is generated in the Watchdog (see RP2040 Datasheet Section 4.8.2) which is derived
* from the clk_ref.
* \endif
*
* \if rp2350_specific
* On RP2350, by default the timer uses a one microsecond reference that is generated by the tick block (see RP2350 Datasheet Section 8.5)
* \endif
*
* The timer has 4 alarms, and can output a separate interrupt for each alarm. The alarms match on the lower 32 bits of the 64
* bit counter which means they can be fired a maximum of 2^32 microseconds into the future. This is equivalent to:
* - 2^32 ÷ 10^6: ~4295 seconds
* - 4295 ÷ 60: ~72 minutes
*
* The timer is expected to be used for short sleeps, if you want a longer alarm see the \ref hardware_rtc functions.
*
* \subsection timer_example Example
* \addtogroup hardware_timer
*
* \include hello_timer.c
*
* \see pico_time
*/
// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER, Enable/disable assertions in the hardware_timer module, type=bool, default=0, group=hardware_timer
#ifndef PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER
#ifdef PARAM_ASSERTIONS_ENABLED_TIMER // backwards compatibility with SDK < 2.0.0
#define PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER PARAM_ASSERTIONS_ENABLED_TIMER
#else
#define PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER 0
#endif
#endif
/**
* \def TIMER_NUM(timer)
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the timer number for a timer instance
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef TIMER_NUM
#if NUM_GENERIC_TIMERS == 1
#define TIMER_NUM(timer) ({ (void) (timer); 0; })
#elif NUM_GENERIC_TIMERS == 2
#define TIMER_NUM(timer) ((timer) == timer1_hw)
#endif
#endif
/**
* \def TIMER_INSTANCE(timer_num)
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the timer instance with the given timer number
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef TIMER_INSTANCE
#if NUM_GENERIC_TIMERS == 1
#define TIMER_INSTANCE(num) timer_hw
#elif NUM_GENERIC_TIMERS == 2
#define TIMER_INSTANCE(num) ((num) ? timer1_hw : timer0_hw)
#endif
#endif
/**
* \def TIMER_ALARM_IRQ_NUM(timer,alarm_num)
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the \ref irq_num_t for the alarm interrupt from the given alarm on the given timer instance
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef TIMER_ALARM_IRQ_NUM
#if NUM_GENERIC_TIMERS == 1
static_assert(TIMER_IRQ_3 == TIMER_IRQ_0 + 3, "");
#define TIMER_ALARM_IRQ_NUM(timer, alarm_num) (TIMER_IRQ_0 + (alarm_num))
#else
static_assert(TIMER1_IRQ_3 == TIMER0_IRQ_0 + 7, "");
#define TIMER_ALARM_IRQ_NUM(timer, alarm_num) (TIMER0_IRQ_0 + TIMER_NUM(timer) * NUM_ALARMS + (alarm_num))
#endif
#endif
/**
* \def TIMER_ALARM_NUM_FROM_IRQ(irq_num)
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the alarm number from an \irq_num_t. See \ref TIMER_INSTANCE_NUM_FROM_IRQ to get the timer instance number
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef TIMER_ALARM_NUM_FROM_IRQ
#if NUM_GENERIC_TIMERS == 1
static_assert(TIMER_IRQ_3 == TIMER_IRQ_0 + 3, "");
#define TIMER_ALARM_NUM_FROM_IRQ(irq_num) (((irq_num) - TIMER_IRQ_0) & 3u)
#else
static_assert(TIMER1_IRQ_3 == TIMER0_IRQ_0 + 7, "");
#define TIMER_ALARM_NUM_FROM_IRQ(irq_num) (((irq_num) - TIMER0_IRQ_0) & 3u)
#endif
#endif
/**
* \def TIMER_NUM_FROM_IRQ(irq_num)
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the alarm number from an \irq_num_t. See \ref TIMER_INSTANCE_NUM_FROM_IRQ to get the alarm number
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef TIMER_NUM_FROM_IRQ
#if NUM_GENERIC_TIMERS == 1
static_assert(TIMER_IRQ_3 == TIMER_IRQ_0 + 3, "");
#define TIMER_NUM_FROM_IRQ(irq_num) (((irq_num) - TIMER_IRQ_0) >> 2)
#else
static_assert(TIMER1_IRQ_3 == TIMER0_IRQ_0 + 7, "");
#define TIMER_NUM_FROM_IRQ(irq_num) (((irq_num) - TIMER0_IRQ_0) >> 2)
#endif
#endif
// PICO_CONFIG: PICO_DEFAULT_TIMER, Timer instance number to use for RP2040-period hardware_timer APIs that assumed a single timer instance, min=0, max=1, default=0, group=hardware_timer
/**
* \ingroup hardware_timer
* \brief The default timer instance number of the timer instance used for APIs that don't take an explicit timer instance
* \if rp2040_specific
* On RP2040 this must be 0 as there is only one timer instance
* \endif
* \if rp2350_specific
* On RP2040 this may be set to 0 or 1
* \endif
*/
#ifndef PICO_DEFAULT_TIMER
#define PICO_DEFAULT_TIMER 0
#endif
/**
* \def PICO_DEFAULT_TIMER_INSTANCE()
* \ingroup hardware_timer
* \hideinitializer
* \brief Returns the default timer instance on the platform based on the setting of PICO_DEFAULT_TIMER
*
* Note this macro is intended to resolve at compile time, and does no parameter checking
*/
#ifndef PICO_DEFAULT_TIMER_INSTANCE
#if NUM_GENERIC_TIMERS == 1
#if PICO_DEFAULT_TIMER
#error Setting PICO_DEFAULT_TIMER to non zero is meaningless as there is only one TIMER instance on this platform
#endif
#define PICO_DEFAULT_TIMER_INSTANCE() timer_hw
#else
#define PICO_DEFAULT_TIMER_INSTANCE() (__CONCAT(__CONCAT(timer,PICO_DEFAULT_TIMER), _hw))
// also define timer_hw for backwards compatibility (just accesses the default instance)
#define timer_hw PICO_DEFAULT_TIMER_INSTANCE()
#endif
#endif
static inline void check_hardware_alarm_num_param(__unused uint alarm_num) {
invalid_params_if(HARDWARE_TIMER, alarm_num >= NUM_ALARMS);
}
/*! \brief Return a 32 bit timestamp value in microseconds for a given timer instance
* \ingroup hardware_timer
*
* Returns the low 32 bits of the hardware timer.
* \note This value wraps roughly every 1 hour 11 minutes and 35 seconds.
*
* \param timer the timer instance
* \return the 32 bit timestamp
* \sa time_us_32
*/
static inline uint32_t timer_time_us_32(timer_hw_t *timer) {
return timer->timerawl;
}
/*! \brief Return a 32 bit timestamp value in microseconds for the default timer instance
* \ingroup hardware_timer
*
* Returns the low 32 bits of the hardware timer.
* \note This value wraps roughly every 1 hour 11 minutes and 35 seconds.
*
* \return the 32 bit timestamp
* \sa timer_time_us_32
*/
static inline uint32_t time_us_32(void) {
return timer_time_us_32(PICO_DEFAULT_TIMER_INSTANCE());
}
/*! \brief Return the current 64 bit timestamp value in microseconds for a given timer instance
* \ingroup hardware_timer
*
* Returns the full 64 bits of the hardware timer. The \ref pico_time and other functions rely on the fact that this
* value monotonically increases from power up. As such it is expected that this value counts upwards and never wraps
* (we apologize for introducing a potential year 5851444 bug).
*
* \param timer the timer instance
* \return the 64 bit timestamp
* \sa time_us_64
*/
uint64_t timer_time_us_64(timer_hw_t *timer);
/*! \brief Return the current 64 bit timestamp value in microseconds for the default timer instance
* \ingroup hardware_timer
*
* Returns the full 64 bits of the hardware timer. The \ref pico_time and other functions rely on the fact that this
* value monotonically increases from power up. As such it is expected that this value counts upwards and never wraps
* (we apologize for introducing a potential year 5851444 bug).
*
* \return the 64 bit timestamp
* \sa timer_time_us_64
* */
uint64_t time_us_64(void);
/*! \brief Busy wait wasting cycles for the given (32 bit) number of microseconds using the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param delay_us delay amount in microseconds
* \sa busy_wait_us_32
*/
void timer_busy_wait_us_32(timer_hw_t *timer, uint32_t delay_us);
/*! \brief Busy wait wasting cycles for the given (32 bit) number of microseconds using the default timer instance
* \ingroup hardware_timer
*
* \param delay_us delay amount in microseconds
* \sa timer_busy_wait_us_32
*/
void busy_wait_us_32(uint32_t delay_us);
/*! \brief Busy wait wasting cycles for the given (64 bit) number of microseconds using the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param delay_us delay amount in microseconds
* \sa busy_wait_us
*/
void timer_busy_wait_us(timer_hw_t *timer, uint64_t delay_us);
/*! \brief Busy wait wasting cycles for the given (64 bit) number of microseconds using the default timer instance
* \ingroup hardware_timer
*
* \param delay_us delay amount in microseconds
* \sa timer_busy_wait_us
*/
void busy_wait_us(uint64_t delay_us);
/*! \brief Busy wait wasting cycles for the given number of milliseconds using the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param delay_ms delay amount in milliseconds
* \sa busy_wait_ms
*/
void timer_busy_wait_ms(timer_hw_t *timer, uint32_t delay_ms);
/*! \brief Busy wait wasting cycles for the given number of milliseconds using the default timer instance
* \ingroup hardware_timer
*
* \param delay_ms delay amount in milliseconds
* \sa timer_busy_wait_ms
*/
void busy_wait_ms(uint32_t delay_ms);
/*! \brief Busy wait wasting cycles until after the specified timestamp using the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param t Absolute time to wait until
* \sa busy_wait_until
*/
void timer_busy_wait_until(timer_hw_t *timer, absolute_time_t t);
/*! \brief Busy wait wasting cycles until after the specified timestamp using the default timer instance
* \ingroup hardware_timer
*
* \param t Absolute time to wait until
* \sa timer_busy_wait_until
*/
void busy_wait_until(absolute_time_t t);
/*! \brief Check if the specified timestamp has been reached on the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param t Absolute time to compare against current time
* \return true if it is now after the specified timestamp
* \sa time_reached
*/
static inline bool timer_time_reached(timer_hw_t *timer, absolute_time_t t) {
uint64_t target = to_us_since_boot(t);
uint32_t hi_target = (uint32_t)(target >> 32u);
uint32_t hi = timer->timerawh;
return (hi >= hi_target && (timer->timerawl >= (uint32_t) target || hi != hi_target));
}
/*! \brief Check if the specified timestamp has been reached on the default timer instance
* \ingroup hardware_timer
*
* \param t Absolute time to compare against current time
* \return true if it is now after the specified timestamp
* \sa timer_time_reached
*/
static inline bool time_reached(absolute_time_t t) {
return timer_time_reached(PICO_DEFAULT_TIMER_INSTANCE(), t);
}
/*! Callback function type for hardware alarms
* \ingroup hardware_timer
*
* \param alarm_num the hardware alarm number
* \sa hardware_alarm_set_callback()
*/
typedef void (*hardware_alarm_callback_t)(uint alarm_num);
/*! \brief cooperatively claim the use of this hardware alarm_num on the given timer instance
* \ingroup hardware_timer
*
* This method hard asserts if the hardware alarm is currently claimed.
*
* \param timer the timer instance
* \param alarm_num the hardware alarm to claim
* \sa hardware_alarm_claim
* \sa hardware_claiming
*/
void timer_hardware_alarm_claim(timer_hw_t *timer, uint alarm_num);
/*! \brief cooperatively claim the use of this hardware alarm_num on the default timer instance
* \ingroup hardware_timer
*
* This method hard asserts if the hardware alarm is currently claimed.
*
* \param alarm_num the hardware alarm to claim
* \sa timer_hardware_alarm_claim
* \sa hardware_claiming
*/
void hardware_alarm_claim(uint alarm_num);
/*! \brief cooperatively claim the use of a hardware alarm_num on the given timer instance
* \ingroup hardware_timer
*
* This method attempts to claim an unused hardware alarm
*
* \param timer the timer instance
* \param required if true the function will panic if none are available
* \return alarm_num the hardware alarm claimed or -1 if required was false, and none are available
* \sa hardware_alarm_claim_unused
* \sa hardware_claiming
*/
int timer_hardware_alarm_claim_unused(timer_hw_t *timer, bool required);
/*! \brief cooperatively claim the use of a hardware alarm_num on the default timer instance
* \ingroup hardware_timer
*
* This method attempts to claim an unused hardware alarm
*
* \param required if true the function will panic if none are available
* \return alarm_num the hardware alarm claimed or -1 if required was false, and none are available
* \sa timer_hardware_alarm_claim_unused
* \sa hardware_claiming
*/
int hardware_alarm_claim_unused(bool required);
/*! \brief cooperatively release the claim on use of this hardware alarm_num on the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param alarm_num the hardware alarm to unclaim
* \sa hardware_alarm_unclaim
* \sa hardware_claiming
*/
void timer_hardware_alarm_unclaim(timer_hw_t *timer, uint alarm_num);
/*! \brief cooperatively release the claim on use of this hardware alarm_num on the default timer instance
* \ingroup hardware_timer
*
* \param alarm_num the hardware alarm to unclaim
* \sa timer_hardware_alarm_unclaim
* \sa hardware_claiming
*/
void hardware_alarm_unclaim(uint alarm_num);
/*! \brief Determine if a hardware alarm has been claimed on the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param alarm_num the hardware alarm number
* \return true if claimed, false otherwise
* \sa hardware_alarm_is_claimed
* \sa hardware_alarm_claim
*/
bool timer_hardware_alarm_is_claimed(timer_hw_t *timer, uint alarm_num);
/*! \brief Determine if a hardware alarm has been claimed on the default timer instance
* \ingroup hardware_timer
*
* \param alarm_num the hardware alarm number
* \return true if claimed, false otherwise
* \sa timer_hardware_alarm_is_claimed
* \sa hardware_alarm_claim
*/
bool hardware_alarm_is_claimed(uint alarm_num);
/*! \brief Enable/Disable a callback for a hardware alarm for a given timer instance on this core
* \ingroup hardware_timer
*
* This method enables/disables the alarm IRQ for the specified hardware alarm on the
* calling core, and set the specified callback to be associated with that alarm.
*
* This callback will be used for the timeout set via hardware_alarm_set_target
*
* \note This will install the handler on the current core if the IRQ handler isn't already set.
* Therefore the user has the opportunity to call this up from the core of their choice
*
* \param timer the timer instance
* \param alarm_num the hardware alarm number
* \param callback the callback to install, or NULL to unset
*
* \sa hardware_alarm_set_callback
* \sa timer_hardware_alarm_set_target()
*/
void timer_hardware_alarm_set_callback(timer_hw_t *timer, uint alarm_num, hardware_alarm_callback_t callback);
/*! \brief Enable/Disable a callback for a hardware alarm on the default timer instance on this core
* \ingroup hardware_timer
*
* This method enables/disables the alarm IRQ for the specified hardware alarm on the
* calling core, and set the specified callback to be associated with that alarm.
*
* This callback will be used for the timeout set via hardware_alarm_set_target
*
* \note This will install the handler on the current core if the IRQ handler isn't already set.
* Therefore the user has the opportunity to call this up from the core of their choice
*
* \param alarm_num the hardware alarm number
* \param callback the callback to install, or NULL to unset
*
* \sa timer_hardware_alarm_set_callback
* \sa hardware_alarm_set_target()
*/
void hardware_alarm_set_callback(uint alarm_num, hardware_alarm_callback_t callback);
/**
* \brief Set the current target for a specific hardware alarm on the given timer instance
* \ingroup hardware_timer
*
* This will replace any existing target
*
* \param timer the timer instance
* \param alarm_num the hardware alarm number
* \param t the target timestamp
* \return true if the target was "missed"; i.e. it was in the past, or occurred before a future hardware timeout could be set
* \sa hardware_alarm_set_target
*/
bool timer_hardware_alarm_set_target(timer_hw_t *timer, uint alarm_num, absolute_time_t t);
/**
* \brief Set the current target for the specified hardware alarm on the default timer instance
* \ingroup hardware_timer
*
* This will replace any existing target
*
* \param alarm_num the hardware alarm number
* \param t the target timestamp
* \return true if the target was "missed"; i.e. it was in the past, or occurred before a future hardware timeout could be set
* \sa timer_hardware_alarm_set_target
*/
bool hardware_alarm_set_target(uint alarm_num, absolute_time_t t);
/**
* \brief Cancel an existing target (if any) for a specific hardware_alarm on the given timer instance
* \ingroup hardware_timer
*
* \param timer the timer instance
* \param alarm_num the hardware alarm number
* \sa hardware_alarm_cancel
*/
void timer_hardware_alarm_cancel(timer_hw_t *timer, uint alarm_num);
/**
* \brief Cancel an existing target (if any) for the specified hardware_alarm on the default timer instance
* \ingroup hardware_timer
*
* \param alarm_num the hardware alarm number
* \sa timer_hardware_alarm_cancel
*/
void hardware_alarm_cancel(uint alarm_num);
/**
* \brief Force and IRQ for a specific hardware alarm on the given timer instance
* \ingroup hardware_timer
*
* This method will forcibly make sure the current alarm callback (if present) for the hardware
* alarm is called from an IRQ context after this call. If an actual callback is due at the same
* time then the callback may only be called once.
*
* Calling this method does not otherwise interfere with regular callback operations.
*
* \param timer the timer instance
* \param alarm_num the hardware alarm number
* \sa hardware_alarm_force_irq
*/
void timer_hardware_alarm_force_irq(timer_hw_t *timer, uint alarm_num);
/**
* \brief Force and IRQ for a specific hardware alarm on the default timer instance
* \ingroup hardware_timer
*
* This method will forcibly make sure the current alarm callback (if present) for the hardware
* alarm is called from an IRQ context after this call. If an actual callback is due at the same
* time then the callback may only be called once.
*
* Calling this method does not otherwise interfere with regular callback operations.
*
* \param alarm_num the hardware alarm number
* \sa timer_hardware_alarm_force_irq
*/
void hardware_alarm_force_irq(uint alarm_num);
/**
* \ingroup hardware_timer
* \brief Returns the \ref irq_num_t for the alarm interrupt from the given alarm on the given timer instance
* \param timer the timer instance
* \param alarm_num the alarm number
* \sa TIMER_ALARM_IRQ_NUM
*/
static inline uint timer_hardware_alarm_get_irq_num(__unused timer_hw_t *timer, uint alarm_num) {
check_hardware_alarm_num_param(alarm_num);
return TIMER_ALARM_IRQ_NUM(timer, alarm_num);
}
/**
* \ingroup hardware_timer
* \brief Returns the \ref irq_num_t for the alarm interrupt from the given alarm on the default timer instance
* \param timer the timer instance
* \param alarm_num the alarm number
*/
static inline uint hardware_alarm_get_irq_num(timer_hw_t *timer, uint alarm_num) {
return timer_hardware_alarm_get_irq_num(PICO_DEFAULT_TIMER_INSTANCE(), alarm_num);
}
/**
* \ingroup hardware_timer
* \brief Returns the timer number for a timer instance
*
* \param timer the timer instance
* \return the timer number
* \sa TIMER_NUM
*/
static inline uint timer_get_index(timer_hw_t *timer) {
return TIMER_NUM(timer);
}
/**
* \ingroup hardware_timer
* \brief Returns the timer instance with the given timer number
*
* \param timer_num the timer number
* \return the timer instance
*/
static inline timer_hw_t *timer_get_instance(uint timer_num) {
invalid_params_if(HARDWARE_TIMER, timer_num >= NUM_GENERIC_TIMERS);
return TIMER_INSTANCE(timer_num);
}
#ifdef __cplusplus
}
#endif
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.