1 /*
2  * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef _HARDWARE_TIMER_H
8 #define _HARDWARE_TIMER_H
9 
10 #include "pico.h"
11 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
16 // PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER, Enable/disable assertions in the hardware_timer module, type=bool, default=0, group=hardware_timer
17 #ifndef PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER
18 #ifdef PARAM_ASSERTIONS_ENABLED_TIMER // backwards compatibility with SDK < 2.0.0
19 #define PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER PARAM_ASSERTIONS_ENABLED_TIMER
20 #else
21 #define PARAM_ASSERTIONS_ENABLED_HARDWARE_TIMER 0
22 #endif
23 #endif
24 
check_hardware_alarm_num_param(uint alarm_num)25 static inline void check_hardware_alarm_num_param(uint alarm_num) {
26     invalid_params_if(HARDWARE_TIMER, alarm_num >= NUM_ALARMS);
27 }
28 
29 uint32_t time_us_32();
30 uint64_t time_us_64();
31 void busy_wait_us_32(uint32_t delay_us);
32 void busy_wait_us(uint64_t delay_us);
33 void busy_wait_ms(uint32_t delay_m);
34 void busy_wait_until(absolute_time_t t);
35 bool time_reached(absolute_time_t t);
36 typedef void (*hardware_alarm_callback_t)(uint alarm_num, void *data);
37 void hardware_alarm_claim(uint alarm_num);
38 void hardware_alarm_unclaim(uint alarm_num);
39 int hardware_alarm_claim_unused(bool required);
40 void hardware_alarm_set_callback(uint alarm_num, hardware_alarm_callback_t callback);
41 bool hardware_alarm_set_target(uint alarm_num, absolute_time_t t);
42 void hardware_alarm_cancel(uint alarm_num);
43 void hardware_alarm_force_irq(uint alarm_num);
44 #ifdef __cplusplus
45 }
46 #endif
47 
48 #endif
49