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