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