1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Linux driver for TerraTec DMX 6Fire USB 4 * 5 * Firmware loader 6 * 7 * Author: Torsten Schenk <torsten.schenk@zoho.com> 8 * Created: Jan 01, 2011 9 * Copyright: (C) Torsten Schenk 10 */ 11 12 #include <linux/firmware.h> 13 #include <linux/module.h> 14 #include <linux/bitrev.h> 15 #include <linux/hex.h> 16 #include <linux/kernel.h> 17 18 #include "firmware.h" 19 #include "chip.h" 20 21 MODULE_FIRMWARE("6fire/dmx6firel2.ihx"); 22 MODULE_FIRMWARE("6fire/dmx6fireap.ihx"); 23 MODULE_FIRMWARE("6fire/dmx6firecf.bin"); 24 25 enum { 26 FPGA_BUFSIZE = 512, FPGA_EP = 2 27 }; 28 29 /* 30 * wMaxPacketSize of pcm endpoints. 31 * keep synced with rates_in_packet_size and rates_out_packet_size in pcm.c 32 * fpp: frames per isopacket 33 * 34 * CAUTION: keep sizeof <= buffer[] in usb6fire_fw_init 35 */ 36 static const u8 ep_w_max_packet_size[] = { 37 0xe4, 0x00, 0xe4, 0x00, /* alt 1: 228 EP2 and EP6 (7 fpp) */ 38 0xa4, 0x01, 0xa4, 0x01, /* alt 2: 420 EP2 and EP6 (13 fpp)*/ 39 0x94, 0x01, 0x5c, 0x02 /* alt 3: 404 EP2 and 604 EP6 (25 fpp) */ 40 }; 41 42 static const u8 known_fw_versions[][2] = { 43 { 0x03, 0x01 } 44 }; 45 46 struct ihex_record { 47 u16 address; 48 u8 len; 49 u8 data[256]; 50 char error; /* true if an error occurred parsing this record */ 51 52 u8 max_len; /* maximum record length in whole ihex */ 53 54 /* private */ 55 const char *txt_data; 56 unsigned int txt_length; 57 unsigned int txt_offset; /* current position in txt_data */ 58 }; 59 60 static u8 usb6fire_fw_ihex_hex(const u8 *data, u8 *crc) 61 { 62 u8 val = 0; 63 int hval; 64 65 hval = hex_to_bin(data[0]); 66 if (hval >= 0) 67 val |= (hval << 4); 68 69 hval = hex_to_bin(data[1]); 70 if (hval >= 0) 71 val |= hval; 72 73 *crc += val; 74 return val; 75 } 76 77 /* 78 * returns true if record is available, false otherwise. 79 * iff an error occurred, false will be returned and record->error will be true. 80 */ 81 static bool usb6fire_fw_ihex_next_record(struct ihex_record *record) 82 { 83 u8 crc = 0; 84 u8 type; 85 int i; 86 87 record->error = false; 88 89 /* find begin of record (marked by a colon) */ 90 while (record->txt_offset < record->txt_length 91 && record->txt_data[record->txt_offset] != ':') 92 record->txt_offset++; 93 if (record->txt_offset == record->txt_length) 94 return false; 95 96 /* number of characters needed for len, addr and type entries */ 97 record->txt_offset++; 98 if (record->txt_offset + 8 > record->txt_length) { 99 record->error = true; 100 return false; 101 } 102 103 record->len = usb6fire_fw_ihex_hex(record->txt_data + 104 record->txt_offset, &crc); 105 record->txt_offset += 2; 106 record->address = usb6fire_fw_ihex_hex(record->txt_data + 107 record->txt_offset, &crc) << 8; 108 record->txt_offset += 2; 109 record->address |= usb6fire_fw_ihex_hex(record->txt_data + 110 record->txt_offset, &crc); 111 record->txt_offset += 2; 112 type = usb6fire_fw_ihex_hex(record->txt_data + 113 record->txt_offset, &crc); 114 record->txt_offset += 2; 115 116 /* number of characters needed for data and crc entries */ 117 if (record->txt_offset + 2 * (record->len + 1) > record->txt_length) { 118 record->error = true; 119 return false; 120 } 121 for (i = 0; i < record->len; i++) { 122 record->data[i] = usb6fire_fw_ihex_hex(record->txt_data 123 + record->txt_offset, &crc); 124 record->txt_offset += 2; 125 } 126 usb6fire_fw_ihex_hex(record->txt_data + record->txt_offset, &crc); 127 if (crc) { 128 record->error = true; 129 return false; 130 } 131 132 if (type == 1 || !record->len) /* eof */ 133 return false; 134 else if (type == 0) 135 return true; 136 else { 137 record->error = true; 138 return false; 139 } 140 } 141 142 static int usb6fire_fw_ihex_init(const struct firmware *fw, 143 struct ihex_record *record) 144 { 145 record->txt_data = fw->data; 146 record->txt_length = fw->size; 147 record->txt_offset = 0; 148 record->max_len = 0; 149 /* read all records, if loop ends, record->error indicates, 150 * whether ihex is valid. */ 151 while (usb6fire_fw_ihex_next_record(record)) 152 record->max_len = max(record->len, record->max_len); 153 if (record->error) 154 return -EINVAL; 155 record->txt_offset = 0; 156 return 0; 157 } 158 159 static int usb6fire_fw_ezusb_write(struct usb_device *device, 160 int type, int value, char *data, int len) 161 { 162 return usb_control_msg_send(device, 0, type, 163 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 164 value, 0, data, len, 1000, GFP_KERNEL); 165 } 166 167 static int usb6fire_fw_ezusb_read(struct usb_device *device, 168 int type, int value, char *data, int len) 169 { 170 return usb_control_msg_recv(device, 0, type, 171 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, 172 value, 0, data, len, 1000, GFP_KERNEL); 173 } 174 175 static int usb6fire_fw_fpga_write(struct usb_device *device, 176 char *data, int len) 177 { 178 int actual_len; 179 int ret; 180 181 ret = usb_bulk_msg(device, usb_sndbulkpipe(device, FPGA_EP), data, len, 182 &actual_len, 1000); 183 if (ret < 0) 184 return ret; 185 else if (actual_len != len) 186 return -EIO; 187 return 0; 188 } 189 190 static int usb6fire_fw_ezusb_upload( 191 struct usb_interface *intf, const char *fwname, 192 unsigned int postaddr, u8 *postdata, unsigned int postlen) 193 { 194 int ret; 195 u8 data; 196 struct usb_device *device = interface_to_usbdev(intf); 197 const struct firmware *fw = NULL; 198 struct ihex_record *rec = kmalloc(sizeof(struct ihex_record), 199 GFP_KERNEL); 200 201 if (!rec) 202 return -ENOMEM; 203 204 ret = request_firmware(&fw, fwname, &device->dev); 205 if (ret < 0) { 206 kfree(rec); 207 dev_err(&intf->dev, 208 "error requesting ezusb firmware %s.\n", fwname); 209 return ret; 210 } 211 ret = usb6fire_fw_ihex_init(fw, rec); 212 if (ret < 0) { 213 kfree(rec); 214 release_firmware(fw); 215 dev_err(&intf->dev, 216 "error validating ezusb firmware %s.\n", fwname); 217 return ret; 218 } 219 /* upload firmware image */ 220 data = 0x01; /* stop ezusb cpu */ 221 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1); 222 if (ret) { 223 kfree(rec); 224 release_firmware(fw); 225 dev_err(&intf->dev, 226 "unable to upload ezusb firmware %s: begin message.\n", 227 fwname); 228 return ret; 229 } 230 231 while (usb6fire_fw_ihex_next_record(rec)) { /* write firmware */ 232 ret = usb6fire_fw_ezusb_write(device, 0xa0, rec->address, 233 rec->data, rec->len); 234 if (ret) { 235 kfree(rec); 236 release_firmware(fw); 237 dev_err(&intf->dev, 238 "unable to upload ezusb firmware %s: data urb.\n", 239 fwname); 240 return ret; 241 } 242 } 243 244 release_firmware(fw); 245 kfree(rec); 246 if (postdata) { /* write data after firmware has been uploaded */ 247 ret = usb6fire_fw_ezusb_write(device, 0xa0, postaddr, 248 postdata, postlen); 249 if (ret) { 250 dev_err(&intf->dev, 251 "unable to upload ezusb firmware %s: post urb.\n", 252 fwname); 253 return ret; 254 } 255 } 256 257 data = 0x00; /* resume ezusb cpu */ 258 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1); 259 if (ret) { 260 dev_err(&intf->dev, 261 "unable to upload ezusb firmware %s: end message.\n", 262 fwname); 263 return ret; 264 } 265 return 0; 266 } 267 268 static int usb6fire_fw_fpga_upload( 269 struct usb_interface *intf, const char *fwname) 270 { 271 int ret; 272 int i; 273 struct usb_device *device = interface_to_usbdev(intf); 274 u8 *buffer = kmalloc(FPGA_BUFSIZE, GFP_KERNEL); 275 const char *c; 276 const char *end; 277 const struct firmware *fw; 278 279 if (!buffer) 280 return -ENOMEM; 281 282 ret = request_firmware(&fw, fwname, &device->dev); 283 if (ret < 0) { 284 dev_err(&intf->dev, "unable to get fpga firmware %s.\n", 285 fwname); 286 kfree(buffer); 287 return -EIO; 288 } 289 290 c = fw->data; 291 end = fw->data + fw->size; 292 293 ret = usb6fire_fw_ezusb_write(device, 8, 0, NULL, 0); 294 if (ret) { 295 kfree(buffer); 296 release_firmware(fw); 297 dev_err(&intf->dev, 298 "unable to upload fpga firmware: begin urb.\n"); 299 return ret; 300 } 301 302 while (c != end) { 303 for (i = 0; c != end && i < FPGA_BUFSIZE; i++, c++) 304 buffer[i] = bitrev8((u8)*c); 305 306 ret = usb6fire_fw_fpga_write(device, buffer, i); 307 if (ret < 0) { 308 release_firmware(fw); 309 kfree(buffer); 310 dev_err(&intf->dev, 311 "unable to upload fpga firmware: fw urb.\n"); 312 return ret; 313 } 314 } 315 release_firmware(fw); 316 kfree(buffer); 317 318 ret = usb6fire_fw_ezusb_write(device, 9, 0, NULL, 0); 319 if (ret) { 320 dev_err(&intf->dev, 321 "unable to upload fpga firmware: end urb.\n"); 322 return ret; 323 } 324 return 0; 325 } 326 327 /* check, if the firmware version the devices has currently loaded 328 * is known by this driver. 'version' needs to have 4 bytes version 329 * info data. */ 330 static int usb6fire_fw_check(struct usb_interface *intf, const u8 *version) 331 { 332 int i; 333 334 for (i = 0; i < ARRAY_SIZE(known_fw_versions); i++) 335 if (!memcmp(version, known_fw_versions + i, 2)) 336 return 0; 337 338 dev_err(&intf->dev, "invalid firmware version in device: %4ph. " 339 "please reconnect to power. if this failure " 340 "still happens, check your firmware installation.", 341 version); 342 return -EINVAL; 343 } 344 345 int usb6fire_fw_init(struct usb_interface *intf) 346 { 347 int i; 348 int ret; 349 struct usb_device *device = interface_to_usbdev(intf); 350 /* buffer: 8 receiving bytes from device and 351 * sizeof(EP_W_MAX_PACKET_SIZE) bytes for non-const copy */ 352 u8 buffer[12]; 353 354 ret = usb6fire_fw_ezusb_read(device, 1, 0, buffer, 8); 355 if (ret) { 356 dev_err(&intf->dev, 357 "unable to receive device firmware state.\n"); 358 return ret; 359 } 360 if (buffer[0] != 0xeb || buffer[1] != 0xaa || buffer[2] != 0x55) { 361 dev_err(&intf->dev, 362 "unknown device firmware state received from device:"); 363 for (i = 0; i < 8; i++) 364 printk(KERN_CONT "%02x ", buffer[i]); 365 printk(KERN_CONT "\n"); 366 return -EIO; 367 } 368 /* do we need fpga loader ezusb firmware? */ 369 if (buffer[3] == 0x01) { 370 ret = usb6fire_fw_ezusb_upload(intf, 371 "6fire/dmx6firel2.ihx", 0, NULL, 0); 372 if (ret < 0) 373 return ret; 374 return FW_NOT_READY; 375 } 376 /* do we need fpga firmware and application ezusb firmware? */ 377 else if (buffer[3] == 0x02) { 378 ret = usb6fire_fw_check(intf, buffer + 4); 379 if (ret < 0) 380 return ret; 381 ret = usb6fire_fw_fpga_upload(intf, "6fire/dmx6firecf.bin"); 382 if (ret < 0) 383 return ret; 384 memcpy(buffer, ep_w_max_packet_size, 385 sizeof(ep_w_max_packet_size)); 386 ret = usb6fire_fw_ezusb_upload(intf, "6fire/dmx6fireap.ihx", 387 0x0003, buffer, sizeof(ep_w_max_packet_size)); 388 if (ret < 0) 389 return ret; 390 return FW_NOT_READY; 391 } 392 /* all fw loaded? */ 393 else if (buffer[3] == 0x03) 394 return usb6fire_fw_check(intf, buffer + 4); 395 /* unknown data? */ 396 else { 397 dev_err(&intf->dev, 398 "unknown device firmware state received from device: "); 399 for (i = 0; i < 8; i++) 400 printk(KERN_CONT "%02x ", buffer[i]); 401 printk(KERN_CONT "\n"); 402 return -EIO; 403 } 404 return 0; 405 } 406 407