xref: /btstack/platform/freertos/btstack_uart_block_freertos.c (revision d40c3de009bce6994e726da5a427e08951b353d9)
1 /*
2  * Copyright (C) 2016 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_uart_block_freertos.c"
39 
40 /*
41  *  btstack_uart_block_freertos.c
42  *
43  *  Adapter to IRQ-driven hal_uart_dma.h with FreeRTOS BTstack Run Loop and
44  *  Callbacks are executed on main thread via data source and btstack_run_loop_freertos_trigger_from_isr
45  *
46  */
47 
48 #include "btstack_debug.h"
49 #include "btstack_uart_block.h"
50 #include "btstack_run_loop_freertos.h"
51 #include "hal_uart_dma.h"
52 
53 // hack to avoid error for ESP32
54 #ifndef ESP_PLATFORM
55 
56 #if (INCLUDE_xEventGroupSetBitFromISR != 1) && !defined(HAVE_FREERTOS_TASK_NOTIFICATIONS)
57 #error "The BTstack HAL UART Run Loop integration (btstack_uart_block_freertos) needs to trigger Run Loop iterations from ISR context," \
58 "but 'INCLUDE_xEventGroupSetBitFromISR' is not enabled in your FreeRTOS configuration. Please enable INCLUDE_xEventGroupSetBitFromISR."
59 #endif
60 
61 // uart config
62 static const btstack_uart_config_t * uart_config;
63 
64 // data source for integration with BTstack Runloop
65 static btstack_data_source_t transport_data_source;
66 
67 // callbacks
68 static void (*block_sent)(void);
69 static void (*block_received)(void);
70 
71 static int send_complete;
72 static int receive_complete;
73 
74 static void btstack_uart_block_freertos_received_isr(void){
75     receive_complete = 1;
76     btstack_run_loop_freertos_trigger_from_isr();
77 }
78 
79 static void btstack_uart_block_freertos_sent_isr(void){
80     send_complete = 1;
81     btstack_run_loop_freertos_trigger_from_isr();
82 }
83 
84 static void btstack_uart_block_freertos_process(btstack_data_source_t *ds, btstack_data_source_callback_type_t callback_type) {
85     switch (callback_type){
86         case DATA_SOURCE_CALLBACK_POLL:
87             if (send_complete){
88                 send_complete = 0;
89                 if (block_sent){
90                     block_sent();
91                 }
92             }
93             if (receive_complete){
94                 receive_complete = 0;
95                 if (block_received){
96                     block_received();
97                 }
98             }
99             break;
100         default:
101             break;
102     }
103 }
104 
105 //
106 static int btstack_uart_block_freertos_init(const btstack_uart_config_t * config){
107     uart_config = config;
108     hal_uart_dma_set_block_received(&btstack_uart_block_freertos_received_isr);
109     hal_uart_dma_set_block_sent(&btstack_uart_block_freertos_sent_isr);
110 
111     // set up polling data_source
112     btstack_run_loop_set_data_source_handler(&transport_data_source, &btstack_uart_block_freertos_process);
113     btstack_run_loop_enable_data_source_callbacks(&transport_data_source, DATA_SOURCE_CALLBACK_POLL);
114     btstack_run_loop_add_data_source(&transport_data_source);
115     return 0;
116 }
117 
118 static int btstack_uart_block_freertos_open(void){
119     hal_uart_dma_init();
120     hal_uart_dma_set_baud(uart_config->baudrate);
121     return 0;
122 }
123 
124 static int btstack_uart_block_freertos_close(void){
125 
126     // close device
127     // ...
128     return 0;
129 }
130 
131 static void btstack_uart_block_freertos_set_block_received( void (*block_handler)(void)){
132     block_received = block_handler;
133 }
134 
135 static void btstack_uart_block_freertos_set_block_sent( void (*block_handler)(void)){
136     block_sent = block_handler;
137 }
138 
139 static int btstack_uart_block_freertos_set_parity(int parity){
140     return 0;
141 }
142 
143 // static void btstack_uart_block_set_sleep(uint8_t sleep){
144 // }
145 
146 // static void btstack_uart_block_freertos_set_csr_irq_handler( void (*csr_irq_handler)(void)){
147 // }
148 
149 static const btstack_uart_block_t btstack_uart_block_freertos = {
150     /* int  (*init)(hci_transport_config_uart_t * config); */         &btstack_uart_block_freertos_init,
151     /* int  (*open)(void); */                                         &btstack_uart_block_freertos_open,
152     /* int  (*close)(void); */                                        &btstack_uart_block_freertos_close,
153     /* void (*set_block_received)(void (*handler)(void)); */          &btstack_uart_block_freertos_set_block_received,
154     /* void (*set_block_sent)(void (*handler)(void)); */              &btstack_uart_block_freertos_set_block_sent,
155     /* int  (*set_baudrate)(uint32_t baudrate); */                    &hal_uart_dma_set_baud,
156     /* int  (*set_parity)(int parity); */                             &btstack_uart_block_freertos_set_parity,
157     /* void (*receive_block)(uint8_t *buffer, uint16_t len); */       &hal_uart_dma_receive_block,
158     /* void (*send_block)(const uint8_t *buffer, uint16_t length); */ &hal_uart_dma_send_block,
159     /* int (*get_supported_sleep_modes); */                           NULL,
160     /* void (*set_sleep)(btstack_uart_sleep_mode_t sleep_mode); */    NULL,
161     /* void (*set_wakeup_handler)(void (*wakeup_handler)(void)); */   NULL,
162 };
163 
164 const btstack_uart_block_t * btstack_uart_block_freertos_instance(void){
165 	return &btstack_uart_block_freertos;
166 }
167 
168 // end of hack to avoid error for ESP32
169 #endif // ESP_PLATFORM
170