Staging: strip: delete the driver
[linux/fpc-iii.git] / drivers / usb / misc / emi62.c
blobfc15ad4c3139ca17432ced814bdc3204c559f56a
1 /*
2 * Emagic EMI 2|6 usb audio interface firmware loader.
3 * Copyright (C) 2002
4 * Tapio Laxström (tapio.laxstrom@iptime.fi)
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.
9 */
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>
16 #include <linux/delay.h>
17 #include <linux/firmware.h>
18 #include <linux/ihex.h>
20 /* include firmware (variables)*/
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 */
26 #ifdef SPDIF
27 #define FIRMWARE_FW "emi62/spdif.fw"
28 #else
29 #define FIRMWARE_FW "emi62/midi.fw"
30 #endif
32 #define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
33 #define EMI62_PRODUCT_ID 0x0110 /* EMI 6|2m without firmware */
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)
42 static int emi62_writememory(struct usb_device *dev, int address,
43 const unsigned char *data, int length,
44 __u8 bRequest);
45 static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
46 static int emi62_load_firmware (struct usb_device *dev);
47 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
48 static void emi62_disconnect(struct usb_interface *intf);
49 static int __init emi62_init (void);
50 static void __exit emi62_exit (void);
53 /* thanks to drivers/usb/serial/keyspan_pda.c code */
54 static int emi62_writememory(struct usb_device *dev, int address,
55 const unsigned char *data, int length,
56 __u8 request)
58 int result;
59 unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
61 if (!buffer) {
62 err("emi62: kmalloc(%d) failed.", length);
63 return -ENOMEM;
65 /* 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;
72 /* thanks to drivers/usb/serial/keyspan_pda.c code */
73 static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
75 int response;
76 dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
78 response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
79 if (response < 0) {
80 err("emi62: set_reset (%d) failed", reset_bit);
82 return response;
85 #define FW_LOAD_SIZE 1023
87 static int emi62_load_firmware (struct usb_device *dev)
89 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;
93 int err;
94 int i;
95 __u32 addr; /* Address to write */
96 __u8 *buf;
98 dev_dbg(&dev->dev, "load_firmware\n");
99 buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
100 if (!buf) {
101 err( "%s - error loading firmware: error = %d", __func__, -ENOMEM);
102 err = -ENOMEM;
103 goto wraperr;
106 err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev);
107 if (err)
108 goto nofw;
110 err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw",
111 &dev->dev);
112 if (err)
113 goto nofw;
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;
122 /* Assert reset (stop the CPU in the EMI) */
123 err = emi62_set_reset(dev,1);
124 if (err < 0) {
125 err("%s - error loading firmware: error = %d", __func__, err);
126 goto wraperr;
129 rec = (const struct ihex_binrec *)loader_fw->data;
131 /* 1. We need to put the loader for the FPGA into the EZ-USB */
132 while (rec) {
133 err = emi62_writememory(dev, be32_to_cpu(rec->addr),
134 rec->data, be16_to_cpu(rec->len),
135 ANCHOR_LOAD_INTERNAL);
136 if (err < 0) {
137 err("%s - error loading firmware: error = %d", __func__, err);
138 goto wraperr;
140 rec = ihex_next_binrec(rec);
143 /* De-assert reset (let the CPU run) */
144 err = emi62_set_reset(dev,0);
145 if (err < 0) {
146 err("%s - error loading firmware: error = %d", __func__, err);
147 goto wraperr;
149 msleep(250); /* let device settle */
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! */
154 rec = (const struct ihex_binrec *)bitstream_fw->data;
155 do {
156 i = 0;
157 addr = be32_to_cpu(rec->addr);
159 /* intel hex records are terminated with type 0 element */
160 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);
165 err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
166 if (err < 0) {
167 err("%s - error loading firmware: error = %d", __func__, err);
168 goto wraperr;
170 } while (rec);
172 /* Assert reset (stop the CPU in the EMI) */
173 err = emi62_set_reset(dev,1);
174 if (err < 0) {
175 err("%s - error loading firmware: error = %d", __func__, err);
176 goto wraperr;
179 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
180 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);
185 if (err < 0) {
186 err("%s - error loading firmware: error = %d", __func__, err);
187 goto wraperr;
191 /* De-assert reset (let the CPU run) */
192 err = emi62_set_reset(dev,0);
193 if (err < 0) {
194 err("%s - error loading firmware: error = %d", __func__, err);
195 goto wraperr;
197 msleep(250); /* let device settle */
199 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
201 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);
207 if (err < 0) {
208 err("%s - error loading firmware: error = %d", __func__, err);
209 goto wraperr;
214 /* Assert reset (stop the CPU in the EMI) */
215 err = emi62_set_reset(dev,1);
216 if (err < 0) {
217 err("%s - error loading firmware: error = %d", __func__, err);
218 goto wraperr;
221 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);
227 if (err < 0) {
228 err("%s - error loading firmware: error = %d", __func__, err);
229 goto wraperr;
234 /* De-assert reset (let the CPU run) */
235 err = emi62_set_reset(dev,0);
236 if (err < 0) {
237 err("%s - error loading firmware: error = %d", __func__, err);
238 goto wraperr;
240 msleep(250); /* let device settle */
242 release_firmware(loader_fw);
243 release_firmware(bitstream_fw);
244 release_firmware(firmware_fw);
246 kfree(buf);
248 /* return 1 to fail the driver inialization
249 * and give real driver change to load */
250 return 1;
252 wraperr:
253 release_firmware(loader_fw);
254 release_firmware(bitstream_fw);
255 release_firmware(firmware_fw);
257 kfree(buf);
258 dev_err(&dev->dev, "Error\n");
259 return err;
262 static const struct usb_device_id id_table[] __devinitconst = {
263 { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
264 { } /* Terminating entry */
267 MODULE_DEVICE_TABLE (usb, id_table);
269 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id)
271 struct usb_device *dev = interface_to_usbdev(intf);
272 dev_dbg(&intf->dev, "emi62_probe\n");
274 dev_info(&intf->dev, "%s start\n", __func__);
276 emi62_load_firmware(dev);
278 /* do not return the driver context, let real audio driver do that */
279 return -EIO;
282 static void emi62_disconnect(struct usb_interface *intf)
286 static struct usb_driver emi62_driver = {
287 .name = "emi62 - firmware loader",
288 .probe = emi62_probe,
289 .disconnect = emi62_disconnect,
290 .id_table = id_table,
293 static int __init emi62_init (void)
295 int retval;
296 retval = usb_register (&emi62_driver);
297 if (retval)
298 printk(KERN_ERR "adi-emi: registration failed\n");
299 return retval;
302 static void __exit emi62_exit (void)
304 usb_deregister (&emi62_driver);
307 module_init(emi62_init);
308 module_exit(emi62_exit);
310 MODULE_AUTHOR("Tapio Laxström");
311 MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
312 MODULE_LICENSE("GPL");
314 MODULE_FIRMWARE("emi62/loader.fw");
315 MODULE_FIRMWARE("emi62/bitstream.fw");
316 MODULE_FIRMWARE(FIRMWARE_FW);
317 /* vi:ai:syntax=c:sw=8:ts=8:tw=80