sound/usb/6fire/firmware.c

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