xref: /btstack/port/raspi/main.c (revision c41e99220ec957db1b4a31a6bd5900185fcee9f8)
1 /*
2  * Copyright (C) 2014 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__ "main.c"
39 
40 // *****************************************************************************
41 //
42 //   Port for Rasperry Pi with built-in BCM chipset via H4 or H5
43 //
44 // *****************************************************************************
45 
46 #include <errno.h>
47 #include <fcntl.h>
48 #include <inttypes.h>
49 #include <signal.h>
50 #include <stdint.h>
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <string.h>
54 #include <sys/stat.h>
55 #include <termios.h>
56 #include <unistd.h>
57 
58 #include "btstack_config.h"
59 
60 #include "btstack_debug.h"
61 #include "btstack_event.h"
62 #include "btstack_link_key_db_fs.h"
63 #include "btstack_memory.h"
64 #include "btstack_run_loop.h"
65 #include "btstack_run_loop_posix.h"
66 #include "bluetooth_company_id.h"
67 #include "hci.h"
68 #include "hci_dump.h"
69 #include "btstack_stdin.h"
70 #include "btstack_tlv_posix.h"
71 
72 #include "btstack_chipset_bcm.h"
73 #include "btstack_chipset_bcm_download_firmware.h"
74 #include "btstack_control_raspi.h"
75 
76 int btstack_main(int argc, const char * argv[]);
77 
78 typedef enum  {
79     UART_INVALID,
80     UART_SOFTWARE_NO_FLOW,
81     UART_HARDWARE_NO_FLOW,
82     UART_HARDWARE_FLOW
83 } uart_type_t;
84 
85 // default config, updated depending on RasperryPi UART configuration
86 static hci_transport_config_uart_t transport_config = {
87     HCI_TRANSPORT_CONFIG_UART,
88     115200,
89     0,       // main baudrate
90     0,       // flow control
91     NULL,
92 };
93 
94 static btstack_uart_config_t uart_config;
95 
96 static int main_argc;
97 static const char ** main_argv;
98 
99 static btstack_packet_callback_registration_t hci_event_callback_registration;
100 
101 #define TLV_DB_PATH_PREFIX "/tmp/btstack_"
102 #define TLV_DB_PATH_POSTFIX ".tlv"
103 static char tlv_db_path[100];
104 static const btstack_tlv_t * tlv_impl;
105 static btstack_tlv_posix_t   tlv_context;
106 
107 
108 static int raspi_speed_to_baud(speed_t baud)
109 {
110     switch (baud) {
111         case B9600:
112             return 9600;
113         case B19200:
114             return 19200;
115         case B38400:
116             return 38400;
117         case B57600:
118             return 57600;
119         case B115200:
120             return 115200;
121         case B230400:
122             return 230400;
123         case B460800:
124             return 460800;
125         case B500000:
126             return 500000;
127         case B576000:
128             return 576000;
129         case B921600:
130             return 921600;
131         case B1000000:
132             return 1000000;
133         case B1152000:
134             return 1152000;
135         case B1500000:
136             return 1500000;
137         case B2000000:
138             return 2000000;
139         case B2500000:
140             return 2500000;
141         case B3000000:
142             return 3000000;
143         case B3500000:
144             return 3500000;
145         case B4000000:
146             return 4000000;
147         default:
148             return -1;
149     }
150 }
151 
152 static void raspi_get_terminal_params( hci_transport_config_uart_t *tc )
153 {
154     // open serial terminal and get parameters
155     int fd = open( tc->device_name, O_RDONLY );
156     if( fd < 0 )
157     {
158         perror( "can't open serial port" );
159         return;
160     }
161     struct termios tios;
162     tcgetattr( fd, &tios );
163     close( fd );
164 
165     speed_t ospeed = cfgetospeed( &tios );
166     int baud = raspi_speed_to_baud( ospeed );
167     printf( "current serial terminal parameter baudrate: %d, flow control: %s\n", baud, (tios.c_cflag&CRTSCTS)?"Hardware":"None" );
168 
169     // overwrites the initial baudrate only in case it was likely to be altered before
170     if( baud > 9600 )
171     {
172         tc->baudrate_init = baud;
173         tc->flowcontrol = (tios.c_cflag & CRTSCTS)?1:0;
174     }
175 }
176 
177 static void sigint_handler(int param){
178     UNUSED(param);
179 
180     printf("CTRL-C - SIGINT received, shutting down..\n");
181     log_info("sigint_handler: shutting down");
182 
183     // reset anyway
184     btstack_stdin_reset();
185 
186     // power down
187     hci_power_control(HCI_POWER_OFF);
188     hci_close();
189     log_info("Good bye, see you.\n");
190     exit(0);
191 }
192 
193 static int led_state = 0;
194 void hal_led_toggle(void){
195     led_state = 1 - led_state;
196     printf("LED State %u\n", led_state);
197 }
198 
199 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
200     bd_addr_t addr;
201     if (packet_type != HCI_EVENT_PACKET) return;
202     switch (hci_event_packet_get_type(packet)){
203         case BTSTACK_EVENT_STATE:
204             if (btstack_event_state_get_state(packet) != HCI_STATE_WORKING) break;
205             gap_local_bd_addr(addr);
206             printf("BTstack up and running at %s\n",  bd_addr_to_str(addr));
207             // setup TLV
208             strcpy(tlv_db_path, TLV_DB_PATH_PREFIX);
209             strcat(tlv_db_path, bd_addr_to_str(addr));
210             strcat(tlv_db_path, TLV_DB_PATH_POSTFIX);
211             tlv_impl = btstack_tlv_posix_init_instance(&tlv_context, tlv_db_path);
212             btstack_tlv_set_instance(tlv_impl, &tlv_context);
213             break;
214         case HCI_EVENT_COMMAND_COMPLETE:
215             if (HCI_EVENT_IS_COMMAND_COMPLETE(packet, hci_read_local_name)){
216                 if (hci_event_command_complete_get_return_parameters(packet)[0]) break;
217                 // terminate, name 248 chars
218                 packet[6+248] = 0;
219                 printf("Local name: %s\n", &packet[6]);
220 
221                 btstack_chipset_bcm_set_device_name((const char *)&packet[6]);
222             }
223             break;
224         default:
225             break;
226     }
227 }
228 
229 // see https://github.com/RPi-Distro/pi-bluetooth/blob/master/usr/bin/btuart
230 static int raspi_get_bd_addr(bd_addr_t addr){
231 
232     FILE *fd = fopen( "/proc/device-tree/serial-number", "r" );
233     if( fd == NULL ){
234         fprintf(stderr, "can't read serial number, %s\n", strerror( errno ) );
235         return -1;
236     }
237     fscanf( fd, "%*08x" "%*02x" "%02" SCNx8 "%02" SCNx8 "%02" SCNx8, &addr[3], &addr[4], &addr[5] );
238     fclose( fd );
239 
240     addr[0] =  0xb8; addr[1]  = 0x27; addr[2] =  0xeb;
241     addr[3] ^= 0xaa; addr[4] ^= 0xaa; addr[5] ^= 0xaa;
242 
243     return 0;
244 }
245 
246 // see https://github.com/RPi-Distro/pi-bluetooth/blob/master/usr/bin/btuart
247 // on UART_INVALID errno is set
248 static uart_type_t raspi_get_bluetooth_uart_type(void){
249 
250     uint8_t deviceUart0[21] = { 0 };
251     FILE *fd = fopen( "/proc/device-tree/aliases/uart0", "r" );
252     if( fd == NULL ) return UART_INVALID;
253     fscanf( fd, "%20s", deviceUart0 );
254     fclose( fd );
255 
256     uint8_t deviceSerial1[21] = { 0 };
257     fd = fopen( "/proc/device-tree/aliases/serial1", "r" );
258     if( fd == NULL ) return UART_INVALID;
259     fscanf( fd, "%20s", deviceSerial1 );
260     fclose( fd );
261 
262     // test if uart0 is an alias for serial1
263     if( strncmp( (const char *) deviceUart0, (const char *) deviceSerial1, 21 ) == 0 ){
264         // HW uart
265         size_t count = 0;
266         uint8_t buf[16];
267         fd = fopen( "/proc/device-tree/soc/gpio@7e200000/uart0_pins/brcm,pins", "r" );
268         if( fd == NULL ) return UART_INVALID;
269         count = fread( buf, 1, 16, fd );
270         fclose( fd );
271 
272         // contains assigned pins
273         int pins = count / 4;
274         if( pins == 4 ){
275             return UART_HARDWARE_FLOW;
276         } else {
277             return UART_HARDWARE_NO_FLOW;
278         }
279     } else {
280         return UART_SOFTWARE_NO_FLOW;
281     }
282 }
283 
284 static void phase2(int status);
285 int main(int argc, const char * argv[]){
286 
287     /// GET STARTED with BTstack ///
288     btstack_memory_init();
289 
290     // use logger: format HCI_DUMP_PACKETLOGGER, HCI_DUMP_BLUEZ or HCI_DUMP_STDOUT
291     const char * pklg_path = "/tmp/hci_dump.pklg";
292     hci_dump_open(pklg_path, HCI_DUMP_PACKETLOGGER);
293     printf("Packet Log: %s\n", pklg_path);
294 
295     // setup run loop
296     btstack_run_loop_init(btstack_run_loop_posix_get_instance());
297 
298     // pick serial port and configure uart block driver
299     transport_config.device_name = "/dev/serial1";
300 
301     // derive bd_addr from serial number
302     bd_addr_t addr = { 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 };
303     raspi_get_bd_addr(addr);
304 
305     // set UART config based on raspi Bluetooth UART type
306     int bt_reg_en_pin = -1;
307     switch (raspi_get_bluetooth_uart_type()){
308         case UART_INVALID:
309             fprintf(stderr, "can't verify HW uart, %s\n", strerror( errno ) );
310             return -1;
311         case UART_SOFTWARE_NO_FLOW:
312             // ??
313             bt_reg_en_pin = 128;
314             transport_config.baudrate_main = 460800;
315             transport_config.flowcontrol   = 0;
316             break;
317         case UART_HARDWARE_NO_FLOW:
318             // Raspberry Pi 3 A
319             // Raspberry Pi 3 B
320             bt_reg_en_pin = 128;
321             transport_config.baudrate_main = 921600;
322             transport_config.flowcontrol   = 0;
323             break;
324         case UART_HARDWARE_FLOW:
325             // Raspberry Pi Zero W
326             // Raspberry Pi 3A+ vgpio 129 but WLAN + BL
327             // Raspberry Pi 3B+ vgpio 129 but WLAN + BL
328             bt_reg_en_pin = 45;
329             transport_config.baudrate_main = 921600;
330             transport_config.flowcontrol   = 1;
331             break;
332     }
333     printf("%s, %u, BT_REG_EN at GPIO %u\n", transport_config.flowcontrol ? "H4":"H5", transport_config.baudrate_main, bt_reg_en_pin);
334 
335     // get BCM chipset driver
336     const btstack_chipset_t * chipset = btstack_chipset_bcm_instance();
337     chipset->init(&transport_config);
338 
339     // set path to firmware files
340     btstack_chipset_bcm_set_hcd_folder_path("/lib/firmware/brcm");
341 
342     // setup UART driver
343     const btstack_uart_block_t * uart_driver = btstack_uart_block_posix_instance();
344 
345     // extract UART config from transport config
346     uart_config.baudrate    = transport_config.baudrate_init;
347     uart_config.flowcontrol = transport_config.flowcontrol;
348     uart_config.device_name = transport_config.device_name;
349     uart_driver->init(&uart_config);
350 
351     // HW with FlowControl -> we can use regular h4 mode
352     const hci_transport_t * transport;
353     if (transport_config.flowcontrol){
354         transport = hci_transport_h4_instance(uart_driver);
355     } else {
356         transport = hci_transport_h5_instance(uart_driver);
357     }
358 
359     // setup HCI (to be able to use bcm chipset driver)
360     const btstack_link_key_db_t * link_key_db = btstack_link_key_db_fs_instance();
361     hci_init(transport, (void*) &transport_config);
362     hci_set_bd_addr( addr );
363     hci_set_chipset(btstack_chipset_bcm_instance());
364     hci_set_link_key_db(link_key_db);
365 
366     // inform about BTstack state
367     hci_event_callback_registration.callback = &packet_handler;
368     hci_add_event_handler(&hci_event_callback_registration);
369 
370     // handle CTRL-c
371     signal(SIGINT, sigint_handler);
372 
373     main_argc = argc;
374     main_argv = argv;
375 
376     if (transport_config.flowcontrol){
377 
378         // re-use current terminal speed
379         raspi_get_terminal_params( &transport_config );
380 
381         // with flowcontrol, we use h4 and are done
382         btstack_main(main_argc, main_argv);
383 
384     } else {
385 
386         // power cycle Bluetooth controller on older models without flowcontrol
387         printf("Power Cycle Controller\n");
388         btstack_control_raspi_set_bt_reg_en_pin(bt_reg_en_pin);
389         btstack_control_t *control = btstack_control_raspi_get_instance();
390         control->init(NULL);
391         control->off();
392         usleep( 100000 );
393         control->on();
394 
395         // assume BCM4343W used in Pi 3 A/B. Pi 3 A/B+ have a newer controller but support H4 with Flowcontrol
396         btstack_chipset_bcm_set_device_name("BCM43430A1");
397 
398         // phase #1 download firmware
399         printf("Phase 1: Download firmware\n");
400 
401         // phase #2 start main app
402         btstack_chipset_bcm_download_firmware(uart_driver, transport_config.baudrate_main, &phase2);
403     }
404 
405     // go
406     btstack_run_loop_execute();
407     return 0;
408 }
409 
410 static void phase2(int status){
411 
412     if (status){
413         printf("Download firmware failed\n");
414         return;
415     }
416 
417     printf("Phase 2: Main app\n");
418 
419     // setup app
420     btstack_main(main_argc, main_argv);
421 }
422 
423