xref: /btstack/platform/embedded/btstack_run_loop_embedded.h (revision 4fd33db7036b1487a4b368055df28fd1c2023015)
1 /*
2  * Copyright (C) 2014 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 MATTHIAS
24  * RINGWALD 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  *  btstack_run_loop_embedded.h
40  *  Functionality special to the embedded run loop
41  */
42 
43 #ifndef BTSTACK_RUN_LOOP_EMBEDDED_H
44 #define BTSTACK_RUN_LOOP_EMBEDDED_H
45 
46 #include "btstack_config.h"
47 #include "btstack_linked_list.h"
48 #include "btstack_run_loop.h"
49 
50 #ifdef HAVE_POSIX_TIME
51 #include <sys/time.h>
52 #endif
53 #include <stdint.h>
54 
55 #if defined __cplusplus
56 extern "C" {
57 #endif
58 
59 /**
60  * Provide btstack_run_loop_embedded instance
61  */
62 const btstack_run_loop_t * btstack_run_loop_embedded_get_instance(void);
63 
64 // hack to fix HCI timer handling
65 #ifdef HAVE_EMBEDDED_TICK
66 /**
67  * @brief Sets how many milliseconds has one tick.
68  */
69 uint32_t btstack_run_loop_embedded_ticks_for_ms(uint32_t time_in_ms);
70 /**
71  * @brief Queries the current time in ticks.
72  */
73 uint32_t btstack_run_loop_embedded_get_ticks(void);
74 #endif
75 
76 /**
77  * @brief Sets an internal flag that is checked in the critical section just before entering sleep mode. Has to be called by the interrupt handler of a data source to signal the run loop that a new data is available.
78  * @deprecated Please use btstack_run_loop_poll_data_sources_from_irq() instead
79  */
80 void btstack_run_loop_embedded_trigger(void);
81 
82 /**
83  * @brief Execute run_loop once. It can be used to integrate BTstack's timer and data source processing into a foreign run loop
84  *
85  * @note Not recommended. Instead, you can implement the btstack_run_loop_t interface with your own run loop and request
86  * - processing of timers by calling btstack_run_loop_base_process_timers and
87  * - poll data sources with by calling btstack_run_loop_base_poll_data_sources
88  */
89 void btstack_run_loop_embedded_execute_once(void);
90 
91 /* API_END */
92 
93 #if defined __cplusplus
94 }
95 #endif
96 
97 #endif // BTSTACK_RUN_LOOP_EMBEDDED_H
98