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