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