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 struct ihex_record *rec __free(kfree) = kmalloc_obj(struct ihex_record); 198 199 if (!rec) 200 return -ENOMEM; 201 202 const struct firmware *fw __free(firmware) = NULL; 203 ret = request_firmware(&fw, fwname, &device->dev); 204 if (ret < 0) { 205 dev_err(&intf->dev, 206 "error requesting ezusb firmware %s.\n", fwname); 207 return ret; 208 } 209 ret = usb6fire_fw_ihex_init(fw, rec); 210 if (ret < 0) { 211 dev_err(&intf->dev, 212 "error validating ezusb firmware %s.\n", fwname); 213 return ret; 214 } 215 /* upload firmware image */ 216 data = 0x01; /* stop ezusb cpu */ 217 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1); 218 if (ret) { 219 dev_err(&intf->dev, 220 "unable to upload ezusb firmware %s: begin message.\n", 221 fwname); 222 return ret; 223 } 224 225 while (usb6fire_fw_ihex_next_record(rec)) { /* write firmware */ 226 ret = usb6fire_fw_ezusb_write(device, 0xa0, rec->address, 227 rec->data, rec->len); 228 if (ret) { 229 dev_err(&intf->dev, 230 "unable to upload ezusb firmware %s: data urb.\n", 231 fwname); 232 return ret; 233 } 234 } 235 236 if (postdata) { /* write data after firmware has been uploaded */ 237 ret = usb6fire_fw_ezusb_write(device, 0xa0, postaddr, 238 postdata, postlen); 239 if (ret) { 240 dev_err(&intf->dev, 241 "unable to upload ezusb firmware %s: post urb.\n", 242 fwname); 243 return ret; 244 } 245 } 246 247 data = 0x00; /* resume ezusb cpu */ 248 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1); 249 if (ret) { 250 dev_err(&intf->dev, 251 "unable to upload ezusb firmware %s: end message.\n", 252 fwname); 253 return ret; 254 } 255 return 0; 256 } 257 258 static int usb6fire_fw_fpga_upload( 259 struct usb_interface *intf, const char *fwname) 260 { 261 int ret; 262 int i; 263 struct usb_device *device = interface_to_usbdev(intf); 264 u8 *buffer __free(kfree) = kmalloc(FPGA_BUFSIZE, GFP_KERNEL); 265 const char *c; 266 const char *end; 267 268 if (!buffer) 269 return -ENOMEM; 270 271 const struct firmware *fw __free(firmware) = NULL; 272 ret = request_firmware(&fw, fwname, &device->dev); 273 if (ret < 0) { 274 dev_err(&intf->dev, "unable to get fpga firmware %s.\n", 275 fwname); 276 return -EIO; 277 } 278 279 c = fw->data; 280 end = fw->data + fw->size; 281 282 ret = usb6fire_fw_ezusb_write(device, 8, 0, NULL, 0); 283 if (ret) { 284 dev_err(&intf->dev, 285 "unable to upload fpga firmware: begin urb.\n"); 286 return ret; 287 } 288 289 while (c != end) { 290 for (i = 0; c != end && i < FPGA_BUFSIZE; i++, c++) 291 buffer[i] = bitrev8((u8)*c); 292 293 ret = usb6fire_fw_fpga_write(device, buffer, i); 294 if (ret < 0) { 295 dev_err(&intf->dev, 296 "unable to upload fpga firmware: fw urb.\n"); 297 return ret; 298 } 299 } 300 301 ret = usb6fire_fw_ezusb_write(device, 9, 0, NULL, 0); 302 if (ret) { 303 dev_err(&intf->dev, 304 "unable to upload fpga firmware: end urb.\n"); 305 return ret; 306 } 307 return 0; 308 } 309 310 /* check, if the firmware version the devices has currently loaded 311 * is known by this driver. 'version' needs to have 4 bytes version 312 * info data. */ 313 static int usb6fire_fw_check(struct usb_interface *intf, const u8 *version) 314 { 315 int i; 316 317 for (i = 0; i < ARRAY_SIZE(known_fw_versions); i++) 318 if (!memcmp(version, known_fw_versions + i, 2)) 319 return 0; 320 321 dev_err(&intf->dev, "invalid firmware version in device: %4ph. " 322 "please reconnect to power. if this failure " 323 "still happens, check your firmware installation.", 324 version); 325 return -EINVAL; 326 } 327 328 int usb6fire_fw_init(struct usb_interface *intf) 329 { 330 int i; 331 int ret; 332 struct usb_device *device = interface_to_usbdev(intf); 333 /* buffer: 8 receiving bytes from device and 334 * sizeof(EP_W_MAX_PACKET_SIZE) bytes for non-const copy */ 335 u8 buffer[12]; 336 337 ret = usb6fire_fw_ezusb_read(device, 1, 0, buffer, 8); 338 if (ret) { 339 dev_err(&intf->dev, 340 "unable to receive device firmware state.\n"); 341 return ret; 342 } 343 if (buffer[0] != 0xeb || buffer[1] != 0xaa || buffer[2] != 0x55) { 344 dev_err(&intf->dev, 345 "unknown device firmware state received from device:"); 346 for (i = 0; i < 8; i++) 347 printk(KERN_CONT "%02x ", buffer[i]); 348 printk(KERN_CONT "\n"); 349 return -EIO; 350 } 351 /* do we need fpga loader ezusb firmware? */ 352 if (buffer[3] == 0x01) { 353 ret = usb6fire_fw_ezusb_upload(intf, 354 "6fire/dmx6firel2.ihx", 0, NULL, 0); 355 if (ret < 0) 356 return ret; 357 return FW_NOT_READY; 358 } 359 /* do we need fpga firmware and application ezusb firmware? */ 360 else if (buffer[3] == 0x02) { 361 ret = usb6fire_fw_check(intf, buffer + 4); 362 if (ret < 0) 363 return ret; 364 ret = usb6fire_fw_fpga_upload(intf, "6fire/dmx6firecf.bin"); 365 if (ret < 0) 366 return ret; 367 memcpy(buffer, ep_w_max_packet_size, 368 sizeof(ep_w_max_packet_size)); 369 ret = usb6fire_fw_ezusb_upload(intf, "6fire/dmx6fireap.ihx", 370 0x0003, buffer, sizeof(ep_w_max_packet_size)); 371 if (ret < 0) 372 return ret; 373 return FW_NOT_READY; 374 } 375 /* all fw loaded? */ 376 else if (buffer[3] == 0x03) 377 return usb6fire_fw_check(intf, buffer + 4); 378 /* unknown data? */ 379 else { 380 dev_err(&intf->dev, 381 "unknown device firmware state received from device: "); 382 for (i = 0; i < 8; i++) 383 printk(KERN_CONT "%02x ", buffer[i]); 384 printk(KERN_CONT "\n"); 385 return -EIO; 386 } 387 return 0; 388 } 389 390