2 * Linux driver for TerraTec DMX 6Fire USB
6 * Author: Torsten Schenk <torsten.schenk@zoho.com>
7 * Created: Jan 01, 2011
8 * Copyright: (C) Torsten Schenk
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
16 #include <linux/firmware.h>
17 #include <linux/module.h>
18 #include <linux/bitrev.h>
19 #include <linux/kernel.h>
27 FPGA_BUFSIZE = 512, FPGA_EP = 2
31 * wMaxPacketSize of pcm endpoints.
32 * keep synced with rates_in_packet_size and rates_out_packet_size in pcm.c
33 * fpp: frames per isopacket
35 * CAUTION: keep sizeof <= buffer[] in usb6fire_fw_init
37 static const u8 ep_w_max_packet_size[] = {
38 0xe4, 0x00, 0xe4, 0x00, /* alt 1: 228 EP2 and EP6 (7 fpp) */
39 0xa4, 0x01, 0xa4, 0x01, /* alt 2: 420 EP2 and EP6 (13 fpp)*/
40 0x94, 0x01, 0x5c, 0x02 /* alt 3: 404 EP2 and 604 EP6 (25 fpp) */
43 static const u8 known_fw_versions[][2] = {
51 char error; /* true if an error occurred parsing this record */
53 u8 max_len; /* maximum record length in whole ihex */
57 unsigned int txt_length;
58 unsigned int txt_offset; /* current position in txt_data */
61 static u8 usb6fire_fw_ihex_hex(const u8 *data, u8 *crc)
66 hval = hex_to_bin(data[0]);
70 hval = hex_to_bin(data[1]);
79 * returns true if record is available, false otherwise.
80 * iff an error occurred, false will be returned and record->error will be true.
82 static bool usb6fire_fw_ihex_next_record(struct ihex_record *record)
88 record->error = false;
90 /* find begin of record (marked by a colon) */
91 while (record->txt_offset < record->txt_length
92 && record->txt_data[record->txt_offset] != ':')
94 if (record->txt_offset == record->txt_length)
97 /* number of characters needed for len, addr and type entries */
99 if (record->txt_offset + 8 > record->txt_length) {
100 record->error = true;
104 record->len = usb6fire_fw_ihex_hex(record->txt_data +
105 record->txt_offset, &crc);
106 record->txt_offset += 2;
107 record->address = usb6fire_fw_ihex_hex(record->txt_data +
108 record->txt_offset, &crc) << 8;
109 record->txt_offset += 2;
110 record->address |= usb6fire_fw_ihex_hex(record->txt_data +
111 record->txt_offset, &crc);
112 record->txt_offset += 2;
113 type = usb6fire_fw_ihex_hex(record->txt_data +
114 record->txt_offset, &crc);
115 record->txt_offset += 2;
117 /* number of characters needed for data and crc entries */
118 if (record->txt_offset + 2 * (record->len + 1) > record->txt_length) {
119 record->error = true;
122 for (i = 0; i < record->len; i++) {
123 record->data[i] = usb6fire_fw_ihex_hex(record->txt_data
124 + record->txt_offset, &crc);
125 record->txt_offset += 2;
127 usb6fire_fw_ihex_hex(record->txt_data + record->txt_offset, &crc);
129 record->error = true;
133 if (type == 1 || !record->len) /* eof */
138 record->error = true;
143 static int usb6fire_fw_ihex_init(const struct firmware *fw,
144 struct ihex_record *record)
146 record->txt_data = fw->data;
147 record->txt_length = fw->size;
148 record->txt_offset = 0;
150 /* read all records, if loop ends, record->error indicates,
151 * whether ihex is valid. */
152 while (usb6fire_fw_ihex_next_record(record))
153 record->max_len = max(record->len, record->max_len);
156 record->txt_offset = 0;
160 static int usb6fire_fw_ezusb_write(struct usb_device *device,
161 int type, int value, char *data, int len)
165 ret = usb_control_msg(device, usb_sndctrlpipe(device, 0), type,
166 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
167 value, 0, data, len, 1000);
175 static int usb6fire_fw_ezusb_read(struct usb_device *device,
176 int type, int value, char *data, int len)
178 int ret = usb_control_msg(device, usb_rcvctrlpipe(device, 0), type,
179 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE, value,
188 static int usb6fire_fw_fpga_write(struct usb_device *device,
194 ret = usb_bulk_msg(device, usb_sndbulkpipe(device, FPGA_EP), data, len,
198 else if (actual_len != len)
203 static int usb6fire_fw_ezusb_upload(
204 struct usb_interface *intf, const char *fwname,
205 unsigned int postaddr, u8 *postdata, unsigned int postlen)
209 struct usb_device *device = interface_to_usbdev(intf);
210 const struct firmware *fw = NULL;
211 struct ihex_record *rec = kmalloc(sizeof(struct ihex_record),
217 ret = reject_firmware(&fw, fwname, &device->dev);
221 "error requesting ezusb firmware %s.\n", fwname);
224 ret = usb6fire_fw_ihex_init(fw, rec);
227 release_firmware(fw);
229 "error validating ezusb firmware %s.\n", fwname);
232 /* upload firmware image */
233 data = 0x01; /* stop ezusb cpu */
234 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1);
237 release_firmware(fw);
239 "unable to upload ezusb firmware %s: begin message.\n",
244 while (usb6fire_fw_ihex_next_record(rec)) { /* write firmware */
245 ret = usb6fire_fw_ezusb_write(device, 0xa0, rec->address,
246 rec->data, rec->len);
249 release_firmware(fw);
251 "unable to upload ezusb firmware %s: data urb.\n",
257 release_firmware(fw);
259 if (postdata) { /* write data after firmware has been uploaded */
260 ret = usb6fire_fw_ezusb_write(device, 0xa0, postaddr,
264 "unable to upload ezusb firmware %s: post urb.\n",
270 data = 0x00; /* resume ezusb cpu */
271 ret = usb6fire_fw_ezusb_write(device, 0xa0, 0xe600, &data, 1);
274 "unable to upload ezusb firmware %s: end message.\n",
281 static int usb6fire_fw_fpga_upload(
282 struct usb_interface *intf, const char *fwname)
286 struct usb_device *device = interface_to_usbdev(intf);
287 u8 *buffer = kmalloc(FPGA_BUFSIZE, GFP_KERNEL);
290 const struct firmware *fw;
295 ret = reject_firmware(&fw, fwname, &device->dev);
297 dev_err(&intf->dev, "unable to get fpga firmware %s.\n",
304 end = fw->data + fw->size;
306 ret = usb6fire_fw_ezusb_write(device, 8, 0, NULL, 0);
309 release_firmware(fw);
311 "unable to upload fpga firmware: begin urb.\n");
316 for (i = 0; c != end && i < FPGA_BUFSIZE; i++, c++)
317 buffer[i] = bitrev8((u8)*c);
319 ret = usb6fire_fw_fpga_write(device, buffer, i);
321 release_firmware(fw);
324 "unable to upload fpga firmware: fw urb.\n");
328 release_firmware(fw);
331 ret = usb6fire_fw_ezusb_write(device, 9, 0, NULL, 0);
334 "unable to upload fpga firmware: end urb.\n");
340 /* check, if the firmware version the devices has currently loaded
341 * is known by this driver. 'version' needs to have 4 bytes version
343 static int usb6fire_fw_check(struct usb_interface *intf, const u8 *version)
347 for (i = 0; i < ARRAY_SIZE(known_fw_versions); i++)
348 if (!memcmp(version, known_fw_versions + i, 2))
351 dev_err(&intf->dev, "invalid firmware version in device: %4ph. "
352 "please reconnect to power. if this failure "
353 "still happens, check your firmware installation.",
358 int usb6fire_fw_init(struct usb_interface *intf)
362 struct usb_device *device = interface_to_usbdev(intf);
363 /* buffer: 8 receiving bytes from device and
364 * sizeof(EP_W_MAX_PACKET_SIZE) bytes for non-const copy */
367 ret = usb6fire_fw_ezusb_read(device, 1, 0, buffer, 8);
370 "unable to receive device firmware state.\n");
373 if (buffer[0] != 0xeb || buffer[1] != 0xaa || buffer[2] != 0x55) {
375 "unknown device firmware state received from device:");
376 for (i = 0; i < 8; i++)
377 printk(KERN_CONT "%02x ", buffer[i]);
378 printk(KERN_CONT "\n");
381 /* do we need fpga loader ezusb firmware? */
382 if (buffer[3] == 0x01) {
383 ret = usb6fire_fw_ezusb_upload(intf,
384 "/*(DEBLOBBED)*/", 0, NULL, 0);
389 /* do we need fpga firmware and application ezusb firmware? */
390 else if (buffer[3] == 0x02) {
391 ret = usb6fire_fw_check(intf, buffer + 4);
394 ret = usb6fire_fw_fpga_upload(intf, "/*(DEBLOBBED)*/");
397 memcpy(buffer, ep_w_max_packet_size,
398 sizeof(ep_w_max_packet_size));
399 ret = usb6fire_fw_ezusb_upload(intf, "/*(DEBLOBBED)*/",
400 0x0003, buffer, sizeof(ep_w_max_packet_size));
406 else if (buffer[3] == 0x03)
407 return usb6fire_fw_check(intf, buffer + 4);
411 "unknown device firmware state received from device: ");
412 for (i = 0; i < 8; i++)
413 printk(KERN_CONT "%02x ", buffer[i]);
414 printk(KERN_CONT "\n");