blob: 602ee05ba9ff928bd59338690959840cf12ef5d2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Emagic EMI 2|6 usb audio interface firmware loader.
3 * Copyright (C) 2002
Jan Engelhardt96de0e22007-10-19 23:21:04 +02004 * Tapio Laxström (tapio.laxstrom@iptime.fi)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, as published by
8 * the Free Software Foundation, version 2.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10#include <linux/kernel.h>
11#include <linux/errno.h>
12#include <linux/slab.h>
13#include <linux/init.h>
14#include <linux/module.h>
15#include <linux/usb.h>
Monty16c23f72006-05-09 12:37:22 -070016#include <linux/delay.h>
David Woodhouseb8e24bf2008-05-30 17:35:47 +030017#include <linux/firmware.h>
18#include <linux/ihex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/* include firmware (variables)*/
21
22/* FIXME: This is quick and dirty solution! */
23#define SPDIF /* if you want SPDIF comment next line */
24//#undef SPDIF /* if you want MIDI uncomment this line */
25
26#ifdef SPDIF
David Woodhouseb8e24bf2008-05-30 17:35:47 +030027#define FIRMWARE_FW "emi62/spdif.fw"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#else
David Woodhouseb8e24bf2008-05-30 17:35:47 +030029#define FIRMWARE_FW "emi62/midi.fw"
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#endif
31
32#define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
33#define EMI62_PRODUCT_ID 0x0110 /* EMI 6|2m without firmware */
34
35#define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
36#define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */
37#define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */
38#define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */
39#define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */
40#define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS)
41
David Woodhouseb8e24bf2008-05-30 17:35:47 +030042static int emi62_writememory(struct usb_device *dev, int address,
43 const unsigned char *data, int length,
44 __u8 bRequest);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
46static int emi62_load_firmware (struct usb_device *dev);
47static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
48static void emi62_disconnect(struct usb_interface *intf);
49static int __init emi62_init (void);
50static void __exit emi62_exit (void);
51
52
53/* thanks to drivers/usb/serial/keyspan_pda.c code */
David Woodhouseb8e24bf2008-05-30 17:35:47 +030054static int emi62_writememory(struct usb_device *dev, int address,
55 const unsigned char *data, int length,
56 __u8 request)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
58 int result;
Eric Sesterhenn5d7efe52006-10-26 21:06:24 +020059 unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61 if (!buffer) {
62 err("emi62: kmalloc(%d) failed.", length);
63 return -ENOMEM;
64 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 /* Note: usb_control_msg returns negative value on error or length of the
66 * data that was written! */
67 result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
68 kfree (buffer);
69 return result;
70}
71
72/* thanks to drivers/usb/serial/keyspan_pda.c code */
73static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
74{
75 int response;
Greg Kroah-Hartman1b29a372008-08-18 13:21:04 -070076 dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78 response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
79 if (response < 0) {
80 err("emi62: set_reset (%d) failed", reset_bit);
81 }
82 return response;
83}
84
85#define FW_LOAD_SIZE 1023
86
87static int emi62_load_firmware (struct usb_device *dev)
88{
David Woodhouseb8e24bf2008-05-30 17:35:47 +030089 const struct firmware *loader_fw = NULL;
90 const struct firmware *bitstream_fw = NULL;
91 const struct firmware *firmware_fw = NULL;
92 const struct ihex_binrec *rec;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 int err;
94 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 __u32 addr; /* Address to write */
96 __u8 *buf;
97
98 dev_dbg(&dev->dev, "load_firmware\n");
99 buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
100 if (!buf) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800101 err( "%s - error loading firmware: error = %d", __func__, -ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 err = -ENOMEM;
103 goto wraperr;
104 }
105
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300106 err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev);
107 if (err)
108 goto nofw;
109
110 err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw",
111 &dev->dev);
112 if (err)
113 goto nofw;
114
115 err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev);
116 if (err) {
117 nofw:
118 err( "%s - request_firmware() failed", __func__);
119 goto wraperr;
120 }
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 /* Assert reset (stop the CPU in the EMI) */
123 err = emi62_set_reset(dev,1);
124 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800125 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 goto wraperr;
127 }
128
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300129 rec = (const struct ihex_binrec *)loader_fw->data;
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 /* 1. We need to put the loader for the FPGA into the EZ-USB */
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300132 while (rec) {
133 err = emi62_writememory(dev, be32_to_cpu(rec->addr),
134 rec->data, be16_to_cpu(rec->len),
135 ANCHOR_LOAD_INTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800137 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 goto wraperr;
139 }
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300140 rec = ihex_next_binrec(rec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 }
142
143 /* De-assert reset (let the CPU run) */
144 err = emi62_set_reset(dev,0);
Oliver Neukum5919a43b2007-10-25 15:42:38 +0200145 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800146 err("%s - error loading firmware: error = %d", __func__, err);
Oliver Neukum5919a43b2007-10-25 15:42:38 +0200147 goto wraperr;
148 }
Monty16c23f72006-05-09 12:37:22 -0700149 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151 /* 2. We upload the FPGA firmware into the EMI
152 * Note: collect up to 1023 (yes!) bytes and send them with
153 * a single request. This is _much_ faster! */
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300154 rec = (const struct ihex_binrec *)bitstream_fw->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 do {
156 i = 0;
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300157 addr = be32_to_cpu(rec->addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159 /* intel hex records are terminated with type 0 element */
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300160 while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
161 memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
162 i += be16_to_cpu(rec->len);
163 rec = ihex_next_binrec(rec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 }
165 err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
166 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800167 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 goto wraperr;
169 }
170 } while (i > 0);
171
172 /* Assert reset (stop the CPU in the EMI) */
173 err = emi62_set_reset(dev,1);
174 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800175 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 goto wraperr;
177 }
178
179 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300180 for (rec = (const struct ihex_binrec *)loader_fw->data;
181 rec; rec = ihex_next_binrec(rec)) {
182 err = emi62_writememory(dev, be32_to_cpu(rec->addr),
183 rec->data, be16_to_cpu(rec->len),
184 ANCHOR_LOAD_INTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800186 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 goto wraperr;
188 }
189 }
190
191 /* De-assert reset (let the CPU run) */
192 err = emi62_set_reset(dev,0);
193 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800194 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 goto wraperr;
196 }
Monty16c23f72006-05-09 12:37:22 -0700197 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
200
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300201 for (rec = (const struct ihex_binrec *)firmware_fw->data;
202 rec; rec = ihex_next_binrec(rec)) {
203 if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
204 err = emi62_writememory(dev, be32_to_cpu(rec->addr),
205 rec->data, be16_to_cpu(rec->len),
206 ANCHOR_LOAD_EXTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800208 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 goto wraperr;
210 }
211 }
212 }
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 /* Assert reset (stop the CPU in the EMI) */
215 err = emi62_set_reset(dev,1);
216 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800217 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 goto wraperr;
219 }
220
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300221 for (rec = (const struct ihex_binrec *)firmware_fw->data;
222 rec; rec = ihex_next_binrec(rec)) {
223 if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
224 err = emi62_writememory(dev, be32_to_cpu(rec->addr),
225 rec->data, be16_to_cpu(rec->len),
226 ANCHOR_LOAD_EXTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800228 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 goto wraperr;
230 }
231 }
232 }
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 /* De-assert reset (let the CPU run) */
235 err = emi62_set_reset(dev,0);
236 if (err < 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800237 err("%s - error loading firmware: error = %d", __func__, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 goto wraperr;
239 }
Monty16c23f72006-05-09 12:37:22 -0700240 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300242 release_firmware(loader_fw);
243 release_firmware(bitstream_fw);
244 release_firmware(firmware_fw);
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 kfree(buf);
247
248 /* return 1 to fail the driver inialization
249 * and give real driver change to load */
250 return 1;
251
252wraperr:
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300253 release_firmware(loader_fw);
254 release_firmware(bitstream_fw);
255 release_firmware(firmware_fw);
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 kfree(buf);
258 dev_err(&dev->dev, "Error\n");
259 return err;
260}
261
262static __devinitdata struct usb_device_id id_table [] = {
263 { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
264 { } /* Terminating entry */
265};
266
267MODULE_DEVICE_TABLE (usb, id_table);
268
269static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id)
270{
271 struct usb_device *dev = interface_to_usbdev(intf);
272 dev_dbg(&intf->dev, "emi62_probe\n");
273
Greg Kroah-Hartman1b29a372008-08-18 13:21:04 -0700274 dev_info(&intf->dev, "%s start\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 emi62_load_firmware(dev);
277
278 /* do not return the driver context, let real audio driver do that */
279 return -EIO;
280}
281
282static void emi62_disconnect(struct usb_interface *intf)
283{
284}
285
286static struct usb_driver emi62_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 .name = "emi62 - firmware loader",
288 .probe = emi62_probe,
289 .disconnect = emi62_disconnect,
290 .id_table = id_table,
291};
292
293static int __init emi62_init (void)
294{
295 int retval;
296 retval = usb_register (&emi62_driver);
297 if (retval)
298 printk(KERN_ERR "adi-emi: registration failed\n");
299 return retval;
300}
301
302static void __exit emi62_exit (void)
303{
304 usb_deregister (&emi62_driver);
305}
306
307module_init(emi62_init);
308module_exit(emi62_exit);
309
Jan Engelhardt96de0e22007-10-19 23:21:04 +0200310MODULE_AUTHOR("Tapio Laxström");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
312MODULE_LICENSE("GPL");
313
David Woodhouseb8e24bf2008-05-30 17:35:47 +0300314MODULE_FIRMWARE("emi62/loader.fw");
315MODULE_FIRMWARE("emi62/bitstream.fw");
316MODULE_FIRMWARE(FIRMWARE_FW);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317/* vi:ai:syntax=c:sw=8:ts=8:tw=80
318 */