xref: /btstack/platform/wiced/btstack_run_loop_wiced.c (revision 360243be41f47158adff357b9fead2686419a2df)
1 /*
2  * Copyright (C) 2015 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 #define __BTSTACK_FILE__ "btstack_run_loop_wiced.c"
39 
40 /*
41  *  btstack_run_loop_wiced.c
42  *
43  *  Run loop for Broadcom WICED SDK which currently supports FreeRTOS and ThreadX
44  *  WICED 3.3.1 does not support Event Flags on FreeRTOS so a queue is used instead
45  */
46 
47 #include "wiced.h"
48 
49 #include <stddef.h> // NULL
50 
51 #include "btstack_linked_list.h"
52 #include "btstack_debug.h"
53 #include "btstack_run_loop.h"
54 #include "btstack_run_loop_wiced.h"
55 
56 typedef struct function_call {
57     wiced_result_t (*fn)(void * arg);
58     void * arg;
59 } function_call_t;
60 
61 static const btstack_run_loop_t btstack_run_loop_wiced;
62 
63 static wiced_queue_t btstack_run_loop_queue;
64 
65 // the run loop
66 static btstack_linked_list_t timers;
67 
68 static uint32_t btstack_run_loop_wiced_get_time_ms(void){
69     wiced_time_t time;
70     wiced_time_get_time(&time);
71     return time;
72 }
73 
74 // set timer
75 static void btstack_run_loop_wiced_set_timer(btstack_timer_source_t *ts, uint32_t timeout_in_ms){
76     ts->timeout = btstack_run_loop_wiced_get_time_ms() + timeout_in_ms + 1;
77 }
78 
79 /**
80  * Add timer to run_loop (keep list sorted)
81  */
82 static void btstack_run_loop_wiced_add_timer(btstack_timer_source_t *ts){
83     btstack_linked_item_t *it;
84     for (it = (btstack_linked_item_t *) &timers; it->next ; it = it->next){
85         // don't add timer that's already in there
86         if ((btstack_timer_source_t *) it->next == ts){
87             log_error( "btstack_run_loop_timer_add error: timer to add already in list!");
88             return;
89         }
90         if (ts->timeout < ((btstack_timer_source_t *) it->next)->timeout) {
91             break;
92         }
93     }
94     ts->item.next = it->next;
95     it->next = (btstack_linked_item_t *) ts;
96 }
97 
98 /**
99  * Remove timer from run loop
100  */
101 static int btstack_run_loop_wiced_remove_timer(btstack_timer_source_t *ts){
102     return btstack_linked_list_remove(&timers, (btstack_linked_item_t *) ts);
103 }
104 
105 static void btstack_run_loop_wiced_dump_timer(void){
106 #ifdef ENABLE_LOG_INFO
107     btstack_linked_item_t *it;
108     int i = 0;
109     for (it = (btstack_linked_item_t *) timers; it ; it = it->next){
110         btstack_timer_source_t *ts = (btstack_timer_source_t*) it;
111         log_info("timer %u, timeout %u\n", i, (unsigned int) ts->timeout);
112     }
113 #endif
114 }
115 
116 // schedules execution similar to wiced_rtos_send_asynchronous_event for worker threads
117 void btstack_run_loop_wiced_execute_code_on_main_thread(wiced_result_t (*fn)(void *arg), void * arg){
118     function_call_t message;
119     message.fn  = fn;
120     message.arg = arg;
121     wiced_rtos_push_to_queue(&btstack_run_loop_queue, &message, WICED_NEVER_TIMEOUT);
122 }
123 
124 /**
125  * Execute run_loop
126  */
127 static void btstack_run_loop_wiced_execute(void) {
128     while (1) {
129         // get next timeout
130         uint32_t timeout_ms = WICED_NEVER_TIMEOUT;
131         if (timers) {
132             btstack_timer_source_t * ts = (btstack_timer_source_t *) timers;
133             uint32_t now = btstack_run_loop_wiced_get_time_ms();
134             if (ts->timeout < now){
135                 // remove timer before processing it to allow handler to re-register with run loop
136                 btstack_run_loop_wiced_remove_timer(ts);
137                 // printf("RL: timer %p\n", ts->process);
138                 ts->process(ts);
139                 continue;
140             }
141             timeout_ms = ts->timeout - now;
142         }
143 
144         // pop function call
145         function_call_t message = { NULL, NULL };
146         wiced_rtos_pop_from_queue( &btstack_run_loop_queue, &message, timeout_ms);
147         if (message.fn){
148             // execute code on run loop
149             // printf("RL: execute %p\n", message.fn);
150             message.fn(message.arg);
151         }
152     }
153 }
154 
155 static void btstack_run_loop_wiced_btstack_run_loop_init(void){
156     timers = NULL;
157 
158     // queue to receive events: up to 2 calls from transport, up to 3 for app
159     wiced_rtos_init_queue(&btstack_run_loop_queue, "BTstack Run Loop", sizeof(function_call_t), 5);
160 }
161 
162 /**
163  * @brief Provide btstack_run_loop_posix instance for use with btstack_run_loop_init
164  */
165 const btstack_run_loop_t * btstack_run_loop_wiced_get_instance(void){
166     return &btstack_run_loop_wiced;
167 }
168 
169 static const btstack_run_loop_t btstack_run_loop_wiced = {
170     &btstack_run_loop_wiced_btstack_run_loop_init,
171     NULL,
172     NULL,
173     NULL,
174     NULL,
175     &btstack_run_loop_wiced_set_timer,
176     &btstack_run_loop_wiced_add_timer,
177     &btstack_run_loop_wiced_remove_timer,
178     &btstack_run_loop_wiced_execute,
179     &btstack_run_loop_wiced_dump_timer,
180     &btstack_run_loop_wiced_get_time_ms,
181 };
182