Outline ![]()
Files ![]()
loading...
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
/*
* Copyright (C) 2014 BlueKitchen GmbH
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holders nor the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
* 4. Any redistribution, use, or modification is done solely for
* personal benefit and not for any commercial purpose or for
* monetary gain.
*
* THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
* GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* Please inquire about commercial licensing options at
* contact@bluekitchen-gmbh.com
*
*/
/**
* BTstack Run Loop Abstraction
*
* Provides generic functionality required by the Bluetooth stack and example applications:
* - asynchronous IO for various devices Serial, USB, network sockets, console
* - system time in milliseconds
* - single shot timers
* - integration for threaded environments
*/
#ifndef BTSTACK_RUN_LOOP_H
#define BTSTACK_RUN_LOOP_H
#include "btstack_config.h"
#include "btstack_bool.h"
#include "btstack_linked_list.h"
#include "btstack_defines.h"
#include <stdint.h>
#ifdef ENABLE_TESTING_SUPPORT
typedef uint64_t btstack_time_t;
#define PRIbtstack_time_t PRIu64
#else
typedef uint32_t btstack_time_t;
#define PRIbtstack_time_t PRIu32
#endif
#if defined __cplusplus
extern "C" {
#endif
/**
* Callback types for run loop data sources
*/
typedef enum {
DATA_SOURCE_CALLBACK_POLL = 1 << 0,
DATA_SOURCE_CALLBACK_READ = 1 << 1,
DATA_SOURCE_CALLBACK_WRITE = 1 << 2,
} btstack_data_source_callback_type_t;
typedef struct btstack_data_source {
// linked item
btstack_linked_item_t item;
// item to watch in run loop
union {
// file descriptor for posix systems
int fd;
// handle on windows
void * handle;
} source;
// callback to call for enabled callback types
void (*process)(struct btstack_data_source *ds, btstack_data_source_callback_type_t callback_type);
// flags storing enabled callback types
uint16_t flags;
} btstack_data_source_t;
typedef struct btstack_timer_source {
btstack_linked_item_t item;
// timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS)
btstack_time_t timeout;
// will be called when timer fired
void (*process)(struct btstack_timer_source *ts);
void * context;
} btstack_timer_source_t;
typedef struct btstack_run_loop {
void (*init)(void);
void (*add_data_source)(btstack_data_source_t * data_source);
bool (*remove_data_source)(btstack_data_source_t * data_source);
void (*enable_data_source_callbacks)(btstack_data_source_t * data_source, uint16_t callbacks);
void (*disable_data_source_callbacks)(btstack_data_source_t * data_source, uint16_t callbacks);
void (*set_timer)(btstack_timer_source_t * timer, uint32_t timeout_in_ms);
void (*add_timer)(btstack_timer_source_t *timer);
bool (*remove_timer)(btstack_timer_source_t *timer);
void (*execute)(void);
void (*dump_timer)(void);
uint32_t (*get_time_ms)(void);
void (*poll_data_sources_from_irq)(void);
void (*execute_on_main_thread)(btstack_context_callback_registration_t * callback_registration);
void (*trigger_exit)(void);
} btstack_run_loop_t;
/*
* BTstack Run Loop Base Implementation
* Portable implementation of timer and data source management as base for platform specific implementations
*/
// private data (access only by run loop implementations)
extern btstack_linked_list_t btstack_run_loop_base_timers;
extern btstack_linked_list_t btstack_run_loop_base_data_sources;
extern btstack_linked_list_t btstack_run_loop_base_callbacks;
/**
* @brief Init
*/
void btstack_run_loop_base_init(void);
/**
* @brief Add timer source.
* @param timer to add
*/
void btstack_run_loop_base_add_timer(btstack_timer_source_t * timer);
/**
* @brief Remove timer source.
* @param timer to remove
* @return true if timer was removed
*/
bool btstack_run_loop_base_remove_timer(btstack_timer_source_t * timer);
/**
* @brief Process timers: remove expired timers from list and call their process function
* @param now
*/
void btstack_run_loop_base_process_timers(uint32_t now);
/**
* @brief Dump list of timers via log_info
*/
void btstack_run_loop_base_dump_timer(void);
/**
* @brief Get time until first timer fires
* @return -1 if no timers, time until next timeout otherwise
*/
int32_t btstack_run_loop_base_get_time_until_timeout(uint32_t now);
/**
* @brief Add data source to run loop
* @param data_source to add
*/
void btstack_run_loop_base_add_data_source(btstack_data_source_t * data_source);
/**
* @brief Remove data source from run loop
* @param data_source to remove
* @return true if data source was removed
*/
bool btstack_run_loop_base_remove_data_source(btstack_data_source_t * data_source);
/**
* @brief Enable callbacks for a data source
* @param data_source to enable
* @param callback_types to enable
*/
void btstack_run_loop_base_enable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callback_types);
/**
* @brief Disable callbacks for a data source
* @param data_source to disable
* @param callback_types to disable
*/
void btstack_run_loop_base_disable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callback_types);
/**
* @brief Poll data sources. It calls the process function for all data sources where DATA_SOURCE_CALLBACK_POLL is set
*/
void btstack_run_loop_base_poll_data_sources(void);
/**
* @bried Add Callbacks to list of callbacks to execute with btstack_run_loop_base_execute_callbacks
*/
void btstack_run_loop_base_add_callback(btstack_context_callback_registration_t * callback_registration);
/**
* @bried Process Callbacks: remove all callback-registrations and call the registered function with its context
*/
void btstack_run_loop_base_execute_callbacks(void);
/* API_START */
/**
* @brief Init main run loop. Must be called before any other run loop call.
*
* Use btstack_run_loop_$(btstack_run_loop_TYPE)_get_instance() from btstack_run_loop_$(btstack_run_loop_TYPE).h to get instance
*/
void btstack_run_loop_init(const btstack_run_loop_t * run_loop);
/**
* @brief Set timer based on current time in milliseconds.
*/
void btstack_run_loop_set_timer(btstack_timer_source_t * timer, uint32_t timeout_in_ms);
/**
* @brief Set callback that will be executed when timer expires.
*/
void btstack_run_loop_set_timer_handler(btstack_timer_source_t * timer, void (*process)(btstack_timer_source_t * _timer));
/**
* @brief Set context for this timer
*/
void btstack_run_loop_set_timer_context(btstack_timer_source_t * timer, void * context);
/**
* @brief Get context for this timer
*/
void * btstack_run_loop_get_timer_context(btstack_timer_source_t * timer);
/**
* @brief Add timer source.
*/
void btstack_run_loop_add_timer(btstack_timer_source_t * timer);
/**
* @brief Remove timer source.
*/
int btstack_run_loop_remove_timer(btstack_timer_source_t * timer);
/**
* @brief Get current time in ms
* @note 32-bit ms counter will overflow after approx. 52 days
*/
uint32_t btstack_run_loop_get_time_ms(void);
/**
* @brief Dump timers using log_info
*/
void btstack_run_loop_timer_dump(void);
/**
* @brief Set data source callback.
*/
void btstack_run_loop_set_data_source_handler(btstack_data_source_t * data_source, void (*process)(btstack_data_source_t * _data_source, btstack_data_source_callback_type_t callback_type));
/**
* @brief Set data source file descriptor.
* @param data_source
* @param fd file descriptor
* @note No effect if port doesn't have file descriptors
*/
void btstack_run_loop_set_data_source_fd(btstack_data_source_t * data_source, int fd);
/**
* @brief Get data source file descriptor.
* @param data_source
*/
int btstack_run_loop_get_data_source_fd(btstack_data_source_t * data_source);
/**
* @brief Set data source file descriptor.
* @param data_source
* @param handle
* @note No effect if port doesn't have file descriptors
*/
void btstack_run_loop_set_data_source_handle(btstack_data_source_t * data_source, void * handle);
/**
* @brief Get data source file descriptor.
* @param data_source
*/
void * btstack_run_loop_get_data_source_handle(btstack_data_source_t * data_source);
/**
* @brief Enable callbacks for a data source
* @param data_source to remove
* @param callback types to enable
*/
void btstack_run_loop_enable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callbacks);
/**
* @brief Enable callbacks for a data source
* @param data_source to remove
* @param callback types to disable
*/
void btstack_run_loop_disable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callbacks);
/**
* @brief Add data source to run loop
* @param data_source to add
*/
void btstack_run_loop_add_data_source(btstack_data_source_t * data_source);
/**
* @brief Remove data source from run loop
* @param data_source to remove
*/
int btstack_run_loop_remove_data_source(btstack_data_source_t * data_source);
/**
* @brief Poll data sources - called only from IRQ context
* @note Can be used to trigger processing of received peripheral data on the main thread
* by registering a data source with DATA_SOURCE_CALLBACK_POLL and calling this
* function from the IRQ handler.
*/
void btstack_run_loop_poll_data_sources_from_irq(void);
/**
* @brief Execute configured run loop. This function does not return.
*/
void btstack_run_loop_execute(void);
/**
* @brief Registers callback with run loop and mark main thread as ready
* @note If callback is already registered, the call will be ignored.
* This function allows to implement, e.g., a queue-based message passing mechanism:
* The external thread puts an item into a queue and call this function to trigger
* processing by the BTstack main thread. If this happens multiple times, it is
* guaranteed that the callback will run at least once after the last item was added.
* @param callback_registration
*/
void btstack_run_loop_execute_on_main_thread(btstack_context_callback_registration_t * callback_registration);
/**
* @brief Trigger exit of active run loop (started via btstack_run_loop_execute) if possible
* @note This is only supported if there's a loop in the btstack_run_loop_execute function.
* It is not supported if timers and data sources are only mapped to RTOS equivalents, e.g.
* in the Qt or Core Foundation implementations.
*/
void btstack_run_loop_trigger_exit(void);
/**
* @brief De-Init Run Loop
*/
void btstack_run_loop_deinit(void);
/* API_END */
#if defined __cplusplus
}
#endif
#endif // BTSTACK_RUN_LOOP_H
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.