xref: /btstack/chipset/sx128x/hal_timer.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2020 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /*
39  *  hci_event.h
40  */
41 
42 #ifndef HAL_TIMER_H
43 #define HCI_TIMER_H
44 
45 #include "bluetooth.h"
46 
47 #include <stdint.h>
48 #include <stdarg.h>
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /*
55  * @brief Initialize 32.768 kHz timer, usually low power and used by RTC and in deep sleep
56  */
57 void hal_timer_init(void);
58 
59 /*
60  * @brief Set Timer Callback
61  * @param callback
62  */
63 void hal_timer_set_callback(void (*callback)(void));
64 
65 /**
66  * @brief Get current ticks
67  * @return num_ticks
68  */
69 uint16_t hal_timer_get_ticks(void);
70 
71 /**
72  * @brief Stop Timer
73  */
74 void hal_timer_stop(void);
75 
76 /**
77  * @brief Start Timer and fire at given timeout
78  * @param timeout_ticks timeout in ticks
79  */
80 void hal_timer_start(uint16_t timeout_ticks);
81 
82 #if defined __cplusplus
83 }
84 #endif
85 #endif // HAL_TIMER_H
86