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