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