1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Linux driver for TerraTec DMX 6Fire USB
7 * Author: Torsten Schenk <torsten.schenk@zoho.com>
8 * Created: Jan 01, 2011
9 * Copyright: (C) Torsten Schenk
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/bitrev.h>
15 #include <linux/kernel.h>
23 FPGA_BUFSIZE = 512, FPGA_EP = 2
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
31 * CAUTION: keep sizeof <= buffer[] in usb6fire_fw_init
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) */
39 static const u8 known_fw_versions[][2] = {
47 char error; /* true if an error occurred parsing this record */
49 u8 max_len; /* maximum record length in whole ihex */
53 unsigned int txt_length;
54 unsigned int txt_offset; /* current position in txt_data */
57 static u8 usb6fire_fw_ihex_hex(const u8 *data, u8 *crc)
62 hval = hex_to_bin(data[0]);
66 hval = hex_to_bin(data[1]);
75 * returns true if record is available, false otherwise.
76 * iff an error occurred, false will be returned and record->error will be true.
78 static bool usb6fire_fw_ihex_next_record(struct ihex_record *record)
84 record->error = false;
86 /* find begin of record (marked by a colon) */
87 while (record->txt_offset < record->txt_length
88 && record->txt_data[record->txt_offset] != ':')
90 if (record->txt_offset == record->txt_length)
93 /* number of characters needed for len, addr and type entries */
95 if (record->txt_offset + 8 > record->txt_length) {
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;
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;
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;
123 usb6fire_fw_ihex_hex(record->txt_data + record->txt_offset, &crc);
125 record->error = true;
129 if (type == 1 || !record->len) /* eof */
134 record->error = true;
139 static int usb6fire_fw_ihex_init(const struct firmware *fw,
140 struct ihex_record *record)
142 record->txt_data = fw->data;
143 record->txt_length = fw->size;
144 record->txt_offset = 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);
152 record->txt_offset = 0;
156 static int usb6fire_fw_ezusb_write(struct usb_device *device,
157 int type, int value, char *data, int len)
161 ret = usb_control_msg(device, usb_sndctrlpipe(device, 0), type,
162 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
163 value, 0, data, len, 1000);
171 static int usb6fire_fw_ezusb_read(struct usb_device *device,
172 int type, int value, char *data, int len)
174 int ret = usb_control_msg(device, usb_rcvctrlpipe(device, 0), type,
175 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, value,
184 static int usb6fire_fw_fpga_write(struct usb_device *device,
190 ret = usb_bulk_msg(device, usb_sndbulkpipe(device, FPGA_EP), data, len,
194 else if (actual_len != len)
199 static int usb6fire_fw_ezusb_upload(
200 struct usb_interface *intf, const char *fwname,
201 unsigned int postaddr, u8 *postdata, unsigned int postlen)
205 struct usb_device *device = interface_to_usbdev(intf);
206 const struct firmware *fw = NULL;
207 struct ihex_record *rec = kmalloc(sizeof(struct ihex_record),
213 ret = reject_firmware(&fw, fwname, &device->dev);
217 "error requesting ezusb firmware %s.\n", fwname);
220 ret = usb6fire_fw_ihex_init(fw, rec);
223 release_firmware(fw);
225 "error validating ezusb firmware %s.\n", fwname);
228 /* upload firmware image */
229 data = 0x01; /* stop ezusb cpu */
230 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1);
233 release_firmware(fw);
235 "unable to upload ezusb firmware %s: begin message.\n",
240 while (usb6fire_fw_ihex_next_record(rec)) { /* write firmware */
241 ret = usb6fire_fw_ezusb_write(device, 0xa0, rec->address,
242 rec->data, rec->len);
245 release_firmware(fw);
247 "unable to upload ezusb firmware %s: data urb.\n",
253 release_firmware(fw);
255 if (postdata) { /* write data after firmware has been uploaded */
256 ret = usb6fire_fw_ezusb_write(device, 0xa0, postaddr,
260 "unable to upload ezusb firmware %s: post urb.\n",
266 data = 0x00; /* resume ezusb cpu */
267 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1);
270 "unable to upload ezusb firmware %s: end message.\n",
277 static int usb6fire_fw_fpga_upload(
278 struct usb_interface *intf, const char *fwname)
282 struct usb_device *device = interface_to_usbdev(intf);
283 u8 *buffer = kmalloc(FPGA_BUFSIZE, GFP_KERNEL);
286 const struct firmware *fw;
291 ret = reject_firmware(&fw, fwname, &device->dev);
293 dev_err(&intf->dev, "unable to get fpga firmware %s.\n",
300 end = fw->data + fw->size;
302 ret = usb6fire_fw_ezusb_write(device, 8, 0, NULL, 0);
305 release_firmware(fw);
307 "unable to upload fpga firmware: begin urb.\n");
312 for (i = 0; c != end && i < FPGA_BUFSIZE; i++, c++)
313 buffer[i] = bitrev8((u8)*c);
315 ret = usb6fire_fw_fpga_write(device, buffer, i);
317 release_firmware(fw);
320 "unable to upload fpga firmware: fw urb.\n");
324 release_firmware(fw);
327 ret = usb6fire_fw_ezusb_write(device, 9, 0, NULL, 0);
330 "unable to upload fpga firmware: end urb.\n");
336 /* check, if the firmware version the devices has currently loaded
337 * is known by this driver. 'version' needs to have 4 bytes version
339 static int usb6fire_fw_check(struct usb_interface *intf, const u8 *version)
343 for (i = 0; i < ARRAY_SIZE(known_fw_versions); i++)
344 if (!memcmp(version, known_fw_versions + i, 2))
347 dev_err(&intf->dev, "invalid firmware version in device: %4ph. "
348 "please reconnect to power. if this failure "
349 "still happens, check your firmware installation.",
354 int usb6fire_fw_init(struct usb_interface *intf)
358 struct usb_device *device = interface_to_usbdev(intf);
359 /* buffer: 8 receiving bytes from device and
360 * sizeof(EP_W_MAX_PACKET_SIZE) bytes for non-const copy */
363 ret = usb6fire_fw_ezusb_read(device, 1, 0, buffer, 8);
366 "unable to receive device firmware state.\n");
369 if (buffer[0] != 0xeb || buffer[1] != 0xaa || buffer[2] != 0x55) {
371 "unknown device firmware state received from device:");
372 for (i = 0; i < 8; i++)
373 printk(KERN_CONT "%02x ", buffer[i]);
374 printk(KERN_CONT "\n");
377 /* do we need fpga loader ezusb firmware? */
378 if (buffer[3] == 0x01) {
379 ret = usb6fire_fw_ezusb_upload(intf,
380 "/*(DEBLOBBED)*/", 0, NULL, 0);
385 /* do we need fpga firmware and application ezusb firmware? */
386 else if (buffer[3] == 0x02) {
387 ret = usb6fire_fw_check(intf, buffer + 4);
390 ret = usb6fire_fw_fpga_upload(intf, "/*(DEBLOBBED)*/");
393 memcpy(buffer, ep_w_max_packet_size,
394 sizeof(ep_w_max_packet_size));
395 ret = usb6fire_fw_ezusb_upload(intf, "/*(DEBLOBBED)*/",
396 0x0003, buffer, sizeof(ep_w_max_packet_size));
402 else if (buffer[3] == 0x03)
403 return usb6fire_fw_check(intf, buffer + 4);
407 "unknown device firmware state received from device: ");
408 for (i = 0; i < 8; i++)
409 printk(KERN_CONT "%02x ", buffer[i]);
410 printk(KERN_CONT "\n");