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 * run_loop.h 40 * 41 * Created by Matthias Ringwald on 6/6/09. 42 */ 43 44 #ifndef btstack_run_loop_H 45 #define btstack_run_loop_H 46 47 #include "btstack_config.h" 48 49 #include "btstack_bool.h" 50 #include "btstack_linked_list.h" 51 52 #include <stdint.h> 53 54 #if defined __cplusplus 55 extern "C" { 56 #endif 57 58 59 /** 60 * Callback types for run loop data sources 61 */ 62 typedef enum { 63 DATA_SOURCE_CALLBACK_POLL = 1 << 0, 64 DATA_SOURCE_CALLBACK_READ = 1 << 1, 65 DATA_SOURCE_CALLBACK_WRITE = 1 << 2, 66 } btstack_data_source_callback_type_t; 67 68 typedef struct btstack_data_source { 69 // linked item 70 btstack_linked_item_t item; 71 72 // item to watch in run loop 73 union { 74 // file descriptor for posix systems 75 int fd; 76 // handle on windows 77 void * handle; 78 } source; 79 80 // callback to call for enabled callback types 81 void (*process)(struct btstack_data_source *ds, btstack_data_source_callback_type_t callback_type); 82 83 // flags storing enabled callback types 84 uint16_t flags; 85 86 } btstack_data_source_t; 87 88 typedef struct btstack_timer_source { 89 btstack_linked_item_t item; 90 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 91 uint32_t timeout; 92 // will be called when timer fired 93 void (*process)(struct btstack_timer_source *ts); 94 void * context; 95 } btstack_timer_source_t; 96 97 typedef struct btstack_run_loop { 98 void (*init)(void); 99 void (*add_data_source)(btstack_data_source_t * data_source); 100 bool (*remove_data_source)(btstack_data_source_t * data_source); 101 void (*enable_data_source_callbacks)(btstack_data_source_t * data_source, uint16_t callbacks); 102 void (*disable_data_source_callbacks)(btstack_data_source_t * data_source, uint16_t callbacks); 103 void (*set_timer)(btstack_timer_source_t * timer, uint32_t timeout_in_ms); 104 void (*add_timer)(btstack_timer_source_t *timer); 105 bool (*remove_timer)(btstack_timer_source_t *timer); 106 void (*execute)(void); 107 void (*dump_timer)(void); 108 uint32_t (*get_time_ms)(void); 109 } btstack_run_loop_t; 110 111 void btstack_run_loop_timer_dump(void); 112 113 /* API_START */ 114 115 /** 116 * @brief Init main run loop. Must be called before any other run loop call. 117 * 118 * Use btstack_run_loop_$(btstack_run_loop_TYPE)_get_instance() from btstack_run_loop_$(btstack_run_loop_TYPE).h to get instance 119 */ 120 void btstack_run_loop_init(const btstack_run_loop_t * run_loop); 121 122 /** 123 * @brief Set timer based on current time in milliseconds. 124 */ 125 void btstack_run_loop_set_timer(btstack_timer_source_t * ts, uint32_t timeout_in_ms); 126 127 /** 128 * @brief Set callback that will be executed when timer expires. 129 */ 130 void btstack_run_loop_set_timer_handler(btstack_timer_source_t * ts, void (*process)(btstack_timer_source_t *_ts)); 131 132 /** 133 * @brief Set context for this timer 134 */ 135 void btstack_run_loop_set_timer_context(btstack_timer_source_t * ts, void * context); 136 137 /** 138 * @brief Get context for this timer 139 */ 140 void * btstack_run_loop_get_timer_context(btstack_timer_source_t * ts); 141 142 /** 143 * @brief Add timer source. 144 */ 145 void btstack_run_loop_add_timer(btstack_timer_source_t * timer); 146 147 /** 148 * @brief Remove timer source. 149 */ 150 int btstack_run_loop_remove_timer(btstack_timer_source_t * timer); 151 152 /** 153 * @brief Get current time in ms 154 * @note 32-bit ms counter will overflow after approx. 52 days 155 */ 156 uint32_t btstack_run_loop_get_time_ms(void); 157 158 /** 159 * @brief Set data source callback. 160 */ 161 void btstack_run_loop_set_data_source_handler(btstack_data_source_t * data_source, void (*process)(btstack_data_source_t *_ds, btstack_data_source_callback_type_t callback_type)); 162 163 /** 164 * @brief Set data source file descriptor. 165 * @param data_source 166 * @param fd file descriptor 167 * @note No effect if port doensn't have file descriptors 168 */ 169 void btstack_run_loop_set_data_source_fd(btstack_data_source_t * data_source, int fd); 170 171 /** 172 * @brief Get data source file descriptor. 173 * @param data_source 174 */ 175 int btstack_run_loop_get_data_source_fd(btstack_data_source_t * data_source); 176 177 178 /** 179 * @brief Set data source file descriptor. 180 * @param data_source 181 * @param handle 182 * @note No effect if port doensn't have file descriptors 183 */ 184 void btstack_run_loop_set_data_source_handle(btstack_data_source_t * data_source, void * handle); 185 186 /** 187 * @brief Get data source file descriptor. 188 * @param data_source 189 */ 190 void * btstack_run_loop_get_data_source_handle(btstack_data_source_t * data_source); 191 192 /** 193 * @brief Enable callbacks for a data source 194 * @param data_source to remove 195 * @param callback types to enable 196 */ 197 void btstack_run_loop_enable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callbacks); 198 199 /** 200 * @brief Enable callbacks for a data source 201 * @param data_source to remove 202 * @param callback types to disable 203 */ 204 void btstack_run_loop_disable_data_source_callbacks(btstack_data_source_t * data_source, uint16_t callbacks); 205 206 /** 207 * @brief Add data source to run loop 208 * @param data_source to add 209 */ 210 void btstack_run_loop_add_data_source(btstack_data_source_t * data_source); 211 212 /** 213 * @brief Remove data source from run loop 214 * @param data_source to remove 215 */ 216 int btstack_run_loop_remove_data_source(btstack_data_source_t * data_source); 217 218 /** 219 * @brief Execute configured run loop. This function does not return. 220 */ 221 void btstack_run_loop_execute(void); 222 223 /** 224 * @brief De-Init Run Loop 225 */ 226 void btstack_run_loop_deinit(void); 227 228 /* API_END */ 229 230 #if defined __cplusplus 231 } 232 #endif 233 234 #endif // btstack_run_loop_H 235