xref: /btstack/platform/wiced/btstack_run_loop_wiced.c (revision 6bdecec7ba8f55d805af8d13b9f45c3a7f6d5810)
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 "btstack_run_loop_wiced.h"
50 
51 #include "btstack_run_loop_base.h"
52 #include "btstack_linked_list.h"
53 #include "btstack_debug.h"
54 #include "btstack_util.h"
55 #include "btstack_run_loop.h"
56 
57 #include <stddef.h> // NULL
58 
59 typedef struct function_call {
60     wiced_result_t (*fn)(void * arg);
61     void * arg;
62 } function_call_t;
63 
64 static const btstack_run_loop_t btstack_run_loop_wiced;
65 
66 static wiced_queue_t btstack_run_loop_queue;
67 
68 // the run loop
69 static btstack_linked_list_t timers;
70 
71 static uint32_t btstack_run_loop_wiced_get_time_ms(void){
72     wiced_time_t time;
73     wiced_time_get_time(&time);
74     return time;
75 }
76 
77 // set timer
78 static void btstack_run_loop_wiced_set_timer(btstack_timer_source_t *ts, uint32_t timeout_in_ms){
79     ts->timeout = btstack_run_loop_wiced_get_time_ms() + timeout_in_ms + 1;
80 }
81 
82 // schedules execution similar to wiced_rtos_send_asynchronous_event for worker threads
83 void btstack_run_loop_wiced_execute_code_on_main_thread(wiced_result_t (*fn)(void *arg), void * arg){
84     function_call_t message;
85     message.fn  = fn;
86     message.arg = arg;
87     wiced_rtos_push_to_queue(&btstack_run_loop_queue, &message, WICED_NEVER_TIMEOUT);
88 }
89 
90 /**
91  * Execute run_loop
92  */
93 static void btstack_run_loop_wiced_execute(void) {
94     while (true) {
95 
96         // process timers
97         uint32_t now = btstack_run_loop_wiced_get_time_ms();
98         btstack_run_loop_base_process_timers(now);
99 
100         // get time until next timeout
101         int32_t timeout_next_timer_ms = btstack_run_loop_base_get_time_until_timeout(now);
102         uint32_t timeout_ms = WICED_NEVER_TIMEOUT;
103         if (timeout_next_timer_ms >= 0){
104             timeout_ms = (uint32_t) timeout_next_timer_ms;
105         }
106 
107         // pop function call
108         function_call_t message = { NULL, NULL };
109         wiced_rtos_pop_from_queue( &btstack_run_loop_queue, &message, timeout_ms);
110         if (message.fn){
111             // execute code on run loop
112             message.fn(message.arg);
113         }
114     }
115 }
116 
117 static void btstack_run_loop_wiced_btstack_run_loop_init(void){
118     btstack_run_loop_base_init();
119 
120     // queue to receive events: up to 2 calls from transport, up to 3 for app
121     wiced_rtos_init_queue(&btstack_run_loop_queue, "BTstack Run Loop", sizeof(function_call_t), 5);
122 }
123 
124 /**
125  * @brief Provide btstack_run_loop_posix instance for use with btstack_run_loop_init
126  */
127 const btstack_run_loop_t * btstack_run_loop_wiced_get_instance(void){
128     return &btstack_run_loop_wiced;
129 }
130 
131 static const btstack_run_loop_t btstack_run_loop_wiced = {
132     &btstack_run_loop_wiced_btstack_run_loop_init,
133     NULL,
134     NULL,
135     NULL,
136     NULL,
137     &btstack_run_loop_wiced_set_timer,
138     &btstack_run_loop_base_add_timer,
139     &btstack_run_loop_base_remove_timer,
140     &btstack_run_loop_wiced_execute,
141     &btstack_run_loop_base_dump_timer,
142     &btstack_run_loop_wiced_get_time_ms,
143 };
144