xref: /btstack/platform/freertos/btstack_run_loop_freertos.h (revision a8d51f092f1b660d0f6921369ad2bc3f9368296c)
1 /*
2  * Copyright (C) 2017 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  * btstack_run_loop_freertos.h
40  *
41  * Functions relevant for BTstack WICED port
42  */
43 
44 #ifndef BTSTACK_RUN_LOOP_FREERTOS_H
45 #define BTSTACK_RUN_LOOP_FREERTOS_H
46 
47 #include "btstack_config.h"
48 #include "btstack_run_loop.h"
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /**
55  * @brief Provide btstack_run_loop_freertos instance for use with btstack_run_loop_init
56  */
57 const btstack_run_loop_t * btstack_run_loop_freertos_get_instance(void);
58 
59 /*
60  * @brief Execute code on BTstack run loop. Can be used to control BTstack from a different thread
61  */
62 void btstack_run_loop_freertos_execute_code_on_main_thread(void (*fn)(void *arg), void * arg);
63 
64 /*
65  * @brief Execute code on BTstack run loop. Can be used to control BTstack from an ISR
66  */
67 void btstack_run_loop_freertos_execute_code_on_main_thread_from_isr(void (*fn)(void *arg), void * arg);
68 
69 /**
70  * @brief Triggers processing of data sources from thread context.
71  * Has to be called after enabling a poll data source to wake-pup run loop.
72  */
73 void btstack_run_loop_freertos_trigger(void);
74 
75 /**
76  * @brief Triggers processing of data sources from an ISR.
77  * Has to be called after enabling a poll data source to wake-pup run loop.
78  */
79 void btstack_run_loop_freertos_trigger_from_isr(void);
80 
81 /**
82  * @brief Triggers exit of run loop from BTstack main thread, causes call to btstack_run_loop_execute to return
83  */
84 void btstack_run_loop_freertos_trigger_exit(void);
85 
86 /* API_END */
87 
88 #if defined __cplusplus
89 }
90 #endif
91 
92 #endif // btstack_run_loop_WICED_H
93