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 BLUEKITCHEN 24 * GMBH 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_chipset_bcm_download_firmware.c" 39 40 // download firmware implementation 41 // requires hci_dump 42 // supports higher baudrate for patch upload 43 44 #include <string.h> 45 #include <printf.h> 46 #include <unistd.h> 47 48 #include "hci_dump.h" 49 #include "btstack_chipset_bcm.h" 50 #include "btstack_chipset_bcm_download_firmware.h" 51 #include "bluetooth.h" 52 #include "btstack_debug.h" 53 #include "btstack_chipset.h" 54 55 static void bcm_send_hci_baudrate(void); 56 static void bcm_send_next_init_script_command(void); 57 static void bcm_set_local_baudrate(void); 58 static void bcm_w4_command_complete(void); 59 60 static const btstack_uart_block_t * uart_driver; 61 static const btstack_chipset_t * chipset; 62 63 static uint8_t response_buffer[260]; 64 static uint16_t response_buffer_len; 65 static uint8_t command_buffer[260]; 66 67 static const int hci_command_complete_len = 7; 68 static const int hci_command_complete_read_local_version = 15; 69 static const uint8_t hci_read_local_version_cmd[] = { 0x01, 0x10, 0x00}; 70 static const uint8_t hci_reset_cmd[] = { 0x03, 0x0c, 0x00 }; 71 static const uint8_t hci_command_complete_reset[] = { 0x04, 0x0e, 0x04, 0x01, 0x03, 0x0c, 0x00}; 72 73 static void (*download_complete)(int result); 74 static uint32_t baudrate; 75 76 static inline void bcm_hci_dump_event(void){ 77 uint16_t event_len = 2 + response_buffer[2]; 78 hci_dump_packet(HCI_EVENT_PACKET, 0, &response_buffer[1], event_len); 79 } 80 81 static void bcm_send_prepared_command(void){ 82 command_buffer[0] = 1; 83 uint16_t command_len = 3 + command_buffer[3]; 84 hci_dump_packet(HCI_COMMAND_DATA_PACKET, 0, &command_buffer[1], command_len); 85 uart_driver->send_block(command_buffer, command_len + 1); 86 } 87 88 // Send / Receive HCI Read Local Version Information 89 90 static void bcm_receive_command_command_complete_read_local_version(void){ 91 92 // TODO: check version / detect controller 93 94 const uint8_t * packet = &response_buffer[1]; 95 printf("ROM version information:\n"); 96 uint16_t hci_version = packet[6]; 97 uint16_t hci_revision = little_endian_read_16(packet, 7); 98 uint16_t lmp_version = packet[9]; 99 uint16_t manufacturer = little_endian_read_16(packet, 10); 100 uint16_t lmp_subversion = little_endian_read_16(packet, 12); 101 printf("- HCI Version 0x%04x\n", hci_version); 102 printf("- HCI Revision 0x%04x\n", hci_revision); 103 printf("- LMP Version 0x%04x\n", lmp_version); 104 printf("- LMP Subversion 0x%04x\n", lmp_subversion); 105 printf("- Manufacturer 0x%04x\n", manufacturer); 106 bcm_w4_command_complete(); 107 } 108 109 static void bcm_send_read_local_version(void){ 110 log_info("bcm: send HCI Read Local Version Information"); 111 uart_driver->set_block_received(&bcm_receive_command_command_complete_read_local_version); 112 uart_driver->receive_block(response_buffer, hci_command_complete_read_local_version); 113 memcpy(&command_buffer[1], hci_read_local_version_cmd, sizeof(hci_read_local_version_cmd)); 114 bcm_send_prepared_command(); 115 } 116 117 // Send / Receive HCI Reset 118 119 // Although the Controller just has been reset by the user, there might still be HCI data in the UART driver 120 // which we'll ignore in the receive function 121 122 static void bcm_receive_command_complete_reset(void){ 123 response_buffer_len++; 124 if (response_buffer_len == hci_command_complete_len){ 125 // try to match command complete for HCI Reset 126 if (memcmp(response_buffer, hci_command_complete_reset, hci_command_complete_len) == 0){ 127 bcm_hci_dump_event(); 128 bcm_send_read_local_version(); 129 return; 130 } 131 memmove(&response_buffer[0], &response_buffer[1], response_buffer_len - 1); 132 response_buffer_len--; 133 } 134 uart_driver->receive_block(&response_buffer[response_buffer_len], 1); 135 } 136 137 static void bcm_send_hci_reset(void){ 138 log_info("bcm: send HCI Reset"); 139 response_buffer_len = 0; 140 uart_driver->set_block_received(&bcm_receive_command_complete_reset); 141 uart_driver->receive_block(&response_buffer[response_buffer_len], 1); 142 memcpy(&command_buffer[1], hci_reset_cmd, sizeof(hci_reset_cmd)); 143 bcm_send_prepared_command(); 144 } 145 146 // Other 147 148 static void bcm_send_hci_baudrate(void){ 149 bcm_hci_dump_event(); 150 chipset->set_baudrate_command(baudrate, &command_buffer[1]); 151 uart_driver->set_block_received(&bcm_set_local_baudrate); 152 uart_driver->receive_block(&response_buffer[0], hci_command_complete_len); 153 log_info("bcm: send baud rate command - %u", baudrate); 154 bcm_send_prepared_command(); 155 } 156 157 static void bcm_set_local_baudrate(void){ 158 bcm_hci_dump_event(); 159 uart_driver->set_baudrate(baudrate); 160 uart_driver->set_block_received(&bcm_w4_command_complete); 161 bcm_send_next_init_script_command(); 162 } 163 164 static void bcm_w4_command_complete(void){ 165 bcm_hci_dump_event(); 166 uart_driver->set_block_received(&bcm_w4_command_complete); 167 bcm_send_next_init_script_command(); 168 } 169 170 static void bcm_send_next_init_script_command(void){ 171 int res = chipset->next_command(&command_buffer[1]); 172 switch (res){ 173 case BTSTACK_CHIPSET_VALID_COMMAND: 174 uart_driver->receive_block(&response_buffer[0], hci_command_complete_len); 175 bcm_send_prepared_command(); 176 break; 177 case BTSTACK_CHIPSET_DONE: 178 log_info("bcm: init script done"); 179 // disable init script for main startup 180 btstack_chipset_bcm_enable_init_script(0); 181 // reset baudrate to default 182 uart_driver->set_baudrate(115200); 183 // notify main 184 download_complete(0); 185 break; 186 default: 187 break; 188 } 189 } 190 191 /** 192 * @brief Download firmware via uart_driver 193 * @param uart_driver -- already initialized 194 * @param done callback. 0 = Success 195 */ 196 197 void btstack_chipset_bcm_download_firmware_with_uart(const btstack_uart_t * the_uart_driver, int baudrate_upload, void (*done)(int result)){ 198 // 199 uart_driver = the_uart_driver; 200 chipset = btstack_chipset_bcm_instance(); 201 baudrate = baudrate_upload; 202 download_complete = done; 203 btstack_chipset_bcm_enable_init_script(1); 204 205 int res = uart_driver->open(); 206 if (res) { 207 log_error("uart_block init failed %u", res); 208 download_complete(res); 209 return; 210 } 211 212 // Reset with CTS asserted (low) 213 printf("Please reset Bluetooth Controller, e.g. via RESET button. Firmware download starts in:\n"); 214 uint8_t i; 215 for (i = 3; i > 0; i--){ 216 printf("%u\n", i); 217 sleep(1); 218 } 219 printf("Firmware download started\n"); 220 221 bcm_send_hci_reset(); 222 } 223 224 void btstack_chipset_bcm_download_firmware(const btstack_uart_block_t * the_uart_driver, int baudrate_upload, void (*done)(int result)) { 225 btstack_chipset_bcm_download_firmware_with_uart((const btstack_uart_t *) the_uart_driver, baudrate_upload, done); 226 } 227