Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Emagic EMI 2|6 usb audio interface firmware loader. | |
3 | * Copyright (C) 2002 | |
96de0e25 | 4 | * Tapio Laxström (tapio.laxstrom@iptime.fi) |
1da177e4 LT |
5 | * |
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. | |
1da177e4 LT |
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> | |
16c23f7d | 16 | #include <linux/delay.h> |
b8e24bfa DW |
17 | #include <linux/firmware.h> |
18 | #include <linux/ihex.h> | |
1da177e4 LT |
19 | |
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 | |
b8e24bfa | 27 | #define FIRMWARE_FW "emi62/spdif.fw" |
1da177e4 | 28 | #else |
b8e24bfa | 29 | #define FIRMWARE_FW "emi62/midi.fw" |
1da177e4 LT |
30 | #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 | ||
b8e24bfa DW |
42 | static int emi62_writememory(struct usb_device *dev, int address, |
43 | const unsigned char *data, int length, | |
44 | __u8 bRequest); | |
1da177e4 LT |
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); | |
51 | ||
52 | ||
53 | /* thanks to drivers/usb/serial/keyspan_pda.c code */ | |
b8e24bfa DW |
54 | static int emi62_writememory(struct usb_device *dev, int address, |
55 | const unsigned char *data, int length, | |
56 | __u8 request) | |
1da177e4 LT |
57 | { |
58 | int result; | |
5d7efe5b | 59 | unsigned char *buffer = kmemdup(data, length, GFP_KERNEL); |
1da177e4 LT |
60 | |
61 | if (!buffer) { | |
62 | err("emi62: kmalloc(%d) failed.", length); | |
63 | return -ENOMEM; | |
64 | } | |
1da177e4 LT |
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; | |
70 | } | |
71 | ||
72 | /* thanks to drivers/usb/serial/keyspan_pda.c code */ | |
73 | static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit) | |
74 | { | |
75 | int response; | |
1b29a375 | 76 | dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit); |
1da177e4 LT |
77 | |
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 | ||
87 | static int emi62_load_firmware (struct usb_device *dev) | |
88 | { | |
b8e24bfa DW |
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; | |
1da177e4 LT |
93 | int err; |
94 | int i; | |
1da177e4 LT |
95 | __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) { | |
441b62c1 | 101 | err( "%s - error loading firmware: error = %d", __func__, -ENOMEM); |
1da177e4 LT |
102 | err = -ENOMEM; |
103 | goto wraperr; | |
104 | } | |
105 | ||
b8e24bfa DW |
106 | 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 | ||
1da177e4 LT |
122 | /* Assert reset (stop the CPU in the EMI) */ |
123 | err = emi62_set_reset(dev,1); | |
124 | if (err < 0) { | |
441b62c1 | 125 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
126 | goto wraperr; |
127 | } | |
128 | ||
b8e24bfa DW |
129 | rec = (const struct ihex_binrec *)loader_fw->data; |
130 | ||
1da177e4 | 131 | /* 1. We need to put the loader for the FPGA into the EZ-USB */ |
b8e24bfa DW |
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); | |
1da177e4 | 136 | if (err < 0) { |
441b62c1 | 137 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
138 | goto wraperr; |
139 | } | |
b8e24bfa | 140 | rec = ihex_next_binrec(rec); |
1da177e4 LT |
141 | } |
142 | ||
143 | /* De-assert reset (let the CPU run) */ | |
144 | err = emi62_set_reset(dev,0); | |
5919a43b | 145 | if (err < 0) { |
441b62c1 | 146 | err("%s - error loading firmware: error = %d", __func__, err); |
5919a43b ON |
147 | goto wraperr; |
148 | } | |
16c23f7d | 149 | msleep(250); /* let device settle */ |
1da177e4 LT |
150 | |
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! */ | |
b8e24bfa | 154 | rec = (const struct ihex_binrec *)bitstream_fw->data; |
1da177e4 LT |
155 | do { |
156 | i = 0; | |
b8e24bfa | 157 | addr = be32_to_cpu(rec->addr); |
1da177e4 LT |
158 | |
159 | /* intel hex records are terminated with type 0 element */ | |
b8e24bfa DW |
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); | |
1da177e4 LT |
164 | } |
165 | err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA); | |
166 | if (err < 0) { | |
441b62c1 | 167 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
168 | goto wraperr; |
169 | } | |
ac06c067 | 170 | } while (rec); |
1da177e4 LT |
171 | |
172 | /* Assert reset (stop the CPU in the EMI) */ | |
173 | err = emi62_set_reset(dev,1); | |
174 | if (err < 0) { | |
441b62c1 | 175 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
176 | goto wraperr; |
177 | } | |
178 | ||
179 | /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */ | |
b8e24bfa DW |
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); | |
1da177e4 | 185 | if (err < 0) { |
441b62c1 | 186 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
187 | goto wraperr; |
188 | } | |
189 | } | |
190 | ||
191 | /* De-assert reset (let the CPU run) */ | |
192 | err = emi62_set_reset(dev,0); | |
193 | if (err < 0) { | |
441b62c1 | 194 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
195 | goto wraperr; |
196 | } | |
16c23f7d | 197 | msleep(250); /* let device settle */ |
1da177e4 LT |
198 | |
199 | /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */ | |
200 | ||
b8e24bfa DW |
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); | |
1da177e4 | 207 | if (err < 0) { |
441b62c1 | 208 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
209 | goto wraperr; |
210 | } | |
211 | } | |
212 | } | |
b8e24bfa | 213 | |
1da177e4 LT |
214 | /* Assert reset (stop the CPU in the EMI) */ |
215 | err = emi62_set_reset(dev,1); | |
216 | if (err < 0) { | |
441b62c1 | 217 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
218 | goto wraperr; |
219 | } | |
220 | ||
b8e24bfa DW |
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); | |
1da177e4 | 227 | if (err < 0) { |
441b62c1 | 228 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
229 | goto wraperr; |
230 | } | |
231 | } | |
232 | } | |
b8e24bfa | 233 | |
1da177e4 LT |
234 | /* De-assert reset (let the CPU run) */ |
235 | err = emi62_set_reset(dev,0); | |
236 | if (err < 0) { | |
441b62c1 | 237 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
238 | goto wraperr; |
239 | } | |
16c23f7d | 240 | msleep(250); /* let device settle */ |
1da177e4 | 241 | |
b8e24bfa DW |
242 | release_firmware(loader_fw); |
243 | release_firmware(bitstream_fw); | |
244 | release_firmware(firmware_fw); | |
245 | ||
1da177e4 LT |
246 | kfree(buf); |
247 | ||
248 | /* return 1 to fail the driver inialization | |
249 | * and give real driver change to load */ | |
250 | return 1; | |
251 | ||
252 | wraperr: | |
b8e24bfa DW |
253 | release_firmware(loader_fw); |
254 | release_firmware(bitstream_fw); | |
255 | release_firmware(firmware_fw); | |
256 | ||
1da177e4 LT |
257 | kfree(buf); |
258 | dev_err(&dev->dev, "Error\n"); | |
259 | return err; | |
260 | } | |
261 | ||
33b9e162 | 262 | static const struct usb_device_id id_table[] __devinitconst = { |
1da177e4 LT |
263 | { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) }, |
264 | { } /* Terminating entry */ | |
265 | }; | |
266 | ||
267 | MODULE_DEVICE_TABLE (usb, id_table); | |
268 | ||
269 | static 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 | ||
1b29a375 | 274 | dev_info(&intf->dev, "%s start\n", __func__); |
1da177e4 LT |
275 | |
276 | emi62_load_firmware(dev); | |
277 | ||
278 | /* do not return the driver context, let real audio driver do that */ | |
279 | return -EIO; | |
280 | } | |
281 | ||
282 | static void emi62_disconnect(struct usb_interface *intf) | |
283 | { | |
284 | } | |
285 | ||
286 | static struct usb_driver emi62_driver = { | |
1da177e4 LT |
287 | .name = "emi62 - firmware loader", |
288 | .probe = emi62_probe, | |
289 | .disconnect = emi62_disconnect, | |
290 | .id_table = id_table, | |
291 | }; | |
292 | ||
293 | static 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 | ||
302 | static void __exit emi62_exit (void) | |
303 | { | |
304 | usb_deregister (&emi62_driver); | |
305 | } | |
306 | ||
307 | module_init(emi62_init); | |
308 | module_exit(emi62_exit); | |
309 | ||
96de0e25 | 310 | MODULE_AUTHOR("Tapio Laxström"); |
1da177e4 LT |
311 | MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader."); |
312 | MODULE_LICENSE("GPL"); | |
313 | ||
b8e24bfa DW |
314 | MODULE_FIRMWARE("emi62/loader.fw"); |
315 | MODULE_FIRMWARE("emi62/bitstream.fw"); | |
316 | MODULE_FIRMWARE(FIRMWARE_FW); | |
1da177e4 LT |
317 | /* vi:ai:syntax=c:sw=8:ts=8:tw=80 |
318 | */ |