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. | |
9 | * | |
10 | * emi26.c,v 1.13 2002/03/08 13:10:26 tapio Exp | |
11 | */ | |
12 | #include <linux/kernel.h> | |
13 | #include <linux/errno.h> | |
14 | #include <linux/slab.h> | |
15 | #include <linux/module.h> | |
16 | #include <linux/init.h> | |
17 | #include <linux/usb.h> | |
16c23f7d | 18 | #include <linux/delay.h> |
ae93a55b DW |
19 | #include <linux/firmware.h> |
20 | #include <linux/ihex.h> | |
1da177e4 LT |
21 | |
22 | #define EMI26_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */ | |
23 | #define EMI26_PRODUCT_ID 0x0100 /* EMI 2|6 without firmware */ | |
24 | #define EMI26B_PRODUCT_ID 0x0102 /* EMI 2|6 without firmware */ | |
25 | ||
26 | #define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */ | |
27 | #define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */ | |
28 | #define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */ | |
29 | #define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */ | |
30 | #define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */ | |
31 | #define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS) | |
32 | ||
ae93a55b DW |
33 | static int emi26_writememory( struct usb_device *dev, int address, |
34 | const unsigned char *data, int length, | |
35 | __u8 bRequest); | |
1da177e4 LT |
36 | static int emi26_set_reset(struct usb_device *dev, unsigned char reset_bit); |
37 | static int emi26_load_firmware (struct usb_device *dev); | |
38 | static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id); | |
39 | static void emi26_disconnect(struct usb_interface *intf); | |
40 | static int __init emi26_init (void); | |
41 | static void __exit emi26_exit (void); | |
42 | ||
43 | ||
44 | /* thanks to drivers/usb/serial/keyspan_pda.c code */ | |
ae93a55b DW |
45 | static int emi26_writememory (struct usb_device *dev, int address, |
46 | const unsigned char *data, int length, | |
47 | __u8 request) | |
1da177e4 LT |
48 | { |
49 | int result; | |
5d7efe5b | 50 | unsigned char *buffer = kmemdup(data, length, GFP_KERNEL); |
1da177e4 LT |
51 | |
52 | if (!buffer) { | |
53 | err("emi26: kmalloc(%d) failed.", length); | |
54 | return -ENOMEM; | |
55 | } | |
1da177e4 LT |
56 | /* Note: usb_control_msg returns negative value on error or length of the |
57 | * data that was written! */ | |
58 | result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300); | |
59 | kfree (buffer); | |
60 | return result; | |
61 | } | |
62 | ||
63 | /* thanks to drivers/usb/serial/keyspan_pda.c code */ | |
64 | static int emi26_set_reset (struct usb_device *dev, unsigned char reset_bit) | |
65 | { | |
66 | int response; | |
441b62c1 HH |
67 | info("%s - %d", __func__, reset_bit); |
68 | /* printk(KERN_DEBUG "%s - %d", __func__, reset_bit); */ | |
1da177e4 LT |
69 | response = emi26_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0); |
70 | if (response < 0) { | |
71 | err("emi26: set_reset (%d) failed", reset_bit); | |
72 | } | |
73 | return response; | |
74 | } | |
75 | ||
76 | #define FW_LOAD_SIZE 1023 | |
77 | ||
78 | static int emi26_load_firmware (struct usb_device *dev) | |
79 | { | |
ae93a55b DW |
80 | const struct firmware *loader_fw = NULL; |
81 | const struct firmware *bitstream_fw = NULL; | |
82 | const struct firmware *firmware_fw = NULL; | |
83 | const struct ihex_binrec *rec; | |
1da177e4 LT |
84 | int err; |
85 | int i; | |
1da177e4 LT |
86 | __u32 addr; /* Address to write */ |
87 | __u8 *buf; | |
88 | ||
89 | buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL); | |
90 | if (!buf) { | |
441b62c1 | 91 | err( "%s - error loading firmware: error = %d", __func__, -ENOMEM); |
1da177e4 LT |
92 | err = -ENOMEM; |
93 | goto wraperr; | |
94 | } | |
95 | ||
ae93a55b DW |
96 | err = request_ihex_firmware(&loader_fw, "emi26/loader.fw", &dev->dev); |
97 | if (err) | |
98 | goto nofw; | |
99 | ||
100 | err = request_ihex_firmware(&bitstream_fw, "emi26/bitstream.fw", | |
101 | &dev->dev); | |
102 | if (err) | |
103 | goto nofw; | |
104 | ||
105 | err = request_ihex_firmware(&firmware_fw, "emi26/firmware.fw", | |
106 | &dev->dev); | |
107 | if (err) { | |
108 | nofw: | |
109 | err( "%s - request_firmware() failed", __func__); | |
110 | goto wraperr; | |
111 | } | |
112 | ||
1da177e4 LT |
113 | /* Assert reset (stop the CPU in the EMI) */ |
114 | err = emi26_set_reset(dev,1); | |
115 | if (err < 0) { | |
441b62c1 | 116 | err( "%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
117 | goto wraperr; |
118 | } | |
119 | ||
ae93a55b | 120 | rec = (const struct ihex_binrec *)loader_fw->data; |
1da177e4 | 121 | /* 1. We need to put the loader for the FPGA into the EZ-USB */ |
ae93a55b DW |
122 | while (rec) { |
123 | err = emi26_writememory(dev, be32_to_cpu(rec->addr), | |
124 | rec->data, be16_to_cpu(rec->len), | |
125 | ANCHOR_LOAD_INTERNAL); | |
1da177e4 | 126 | if (err < 0) { |
441b62c1 | 127 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
128 | goto wraperr; |
129 | } | |
ae93a55b | 130 | rec = ihex_next_binrec(rec); |
1da177e4 LT |
131 | } |
132 | ||
133 | /* De-assert reset (let the CPU run) */ | |
134 | err = emi26_set_reset(dev,0); | |
cf4cf0bb | 135 | if (err < 0) { |
441b62c1 | 136 | err("%s - error loading firmware: error = %d", __func__, err); |
cf4cf0bb ON |
137 | goto wraperr; |
138 | } | |
16c23f7d | 139 | msleep(250); /* let device settle */ |
1da177e4 LT |
140 | |
141 | /* 2. We upload the FPGA firmware into the EMI | |
142 | * Note: collect up to 1023 (yes!) bytes and send them with | |
143 | * a single request. This is _much_ faster! */ | |
ae93a55b | 144 | rec = (const struct ihex_binrec *)bitstream_fw->data; |
1da177e4 LT |
145 | do { |
146 | i = 0; | |
ae93a55b | 147 | addr = be32_to_cpu(rec->addr); |
1da177e4 LT |
148 | |
149 | /* intel hex records are terminated with type 0 element */ | |
ae93a55b DW |
150 | while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) { |
151 | memcpy(buf + i, rec->data, be16_to_cpu(rec->len)); | |
152 | i += be16_to_cpu(rec->len); | |
153 | rec = ihex_next_binrec(rec); | |
1da177e4 LT |
154 | } |
155 | err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA); | |
156 | if (err < 0) { | |
441b62c1 | 157 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
158 | goto wraperr; |
159 | } | |
160 | } while (i > 0); | |
161 | ||
162 | /* Assert reset (stop the CPU in the EMI) */ | |
163 | err = emi26_set_reset(dev,1); | |
164 | if (err < 0) { | |
441b62c1 | 165 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
166 | goto wraperr; |
167 | } | |
168 | ||
169 | /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */ | |
ae93a55b DW |
170 | for (rec = (const struct ihex_binrec *)loader_fw->data; |
171 | rec; rec = ihex_next_binrec(rec)) { | |
172 | err = emi26_writememory(dev, be32_to_cpu(rec->addr), | |
173 | rec->data, be16_to_cpu(rec->len), | |
174 | ANCHOR_LOAD_INTERNAL); | |
1da177e4 | 175 | if (err < 0) { |
441b62c1 | 176 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
177 | goto wraperr; |
178 | } | |
179 | } | |
16c23f7d | 180 | msleep(250); /* let device settle */ |
1da177e4 LT |
181 | |
182 | /* De-assert reset (let the CPU run) */ | |
183 | err = emi26_set_reset(dev,0); | |
184 | if (err < 0) { | |
441b62c1 | 185 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
186 | goto wraperr; |
187 | } | |
188 | ||
189 | /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */ | |
ae93a55b DW |
190 | |
191 | for (rec = (const struct ihex_binrec *)firmware_fw->data; | |
192 | rec; rec = ihex_next_binrec(rec)) { | |
193 | if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) { | |
194 | err = emi26_writememory(dev, be32_to_cpu(rec->addr), | |
195 | rec->data, be16_to_cpu(rec->len), | |
196 | ANCHOR_LOAD_EXTERNAL); | |
1da177e4 | 197 | if (err < 0) { |
441b62c1 | 198 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
199 | goto wraperr; |
200 | } | |
201 | } | |
202 | } | |
203 | ||
204 | /* Assert reset (stop the CPU in the EMI) */ | |
205 | err = emi26_set_reset(dev,1); | |
206 | if (err < 0) { | |
441b62c1 | 207 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
208 | goto wraperr; |
209 | } | |
210 | ||
ae93a55b DW |
211 | for (rec = (const struct ihex_binrec *)firmware_fw->data; |
212 | rec; rec = ihex_next_binrec(rec)) { | |
213 | if (INTERNAL_RAM(be32_to_cpu(rec->addr))) { | |
214 | err = emi26_writememory(dev, be32_to_cpu(rec->addr), | |
215 | rec->data, be16_to_cpu(rec->len), | |
216 | ANCHOR_LOAD_INTERNAL); | |
1da177e4 | 217 | if (err < 0) { |
441b62c1 | 218 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
219 | goto wraperr; |
220 | } | |
221 | } | |
222 | } | |
223 | ||
224 | /* De-assert reset (let the CPU run) */ | |
225 | err = emi26_set_reset(dev,0); | |
226 | if (err < 0) { | |
441b62c1 | 227 | err("%s - error loading firmware: error = %d", __func__, err); |
1da177e4 LT |
228 | goto wraperr; |
229 | } | |
16c23f7d | 230 | msleep(250); /* let device settle */ |
1da177e4 LT |
231 | |
232 | /* return 1 to fail the driver inialization | |
233 | * and give real driver change to load */ | |
234 | err = 1; | |
235 | ||
236 | wraperr: | |
ae93a55b DW |
237 | release_firmware(loader_fw); |
238 | release_firmware(bitstream_fw); | |
239 | release_firmware(firmware_fw); | |
240 | ||
1da177e4 LT |
241 | kfree(buf); |
242 | return err; | |
243 | } | |
244 | ||
245 | static struct usb_device_id id_table [] = { | |
246 | { USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) }, | |
247 | { USB_DEVICE(EMI26_VENDOR_ID, EMI26B_PRODUCT_ID) }, | |
248 | { } /* Terminating entry */ | |
249 | }; | |
250 | ||
251 | MODULE_DEVICE_TABLE (usb, id_table); | |
252 | ||
253 | static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id) | |
254 | { | |
255 | struct usb_device *dev = interface_to_usbdev(intf); | |
256 | ||
441b62c1 | 257 | info("%s start", __func__); |
1da177e4 LT |
258 | |
259 | emi26_load_firmware(dev); | |
260 | ||
261 | /* do not return the driver context, let real audio driver do that */ | |
262 | return -EIO; | |
263 | } | |
264 | ||
265 | static void emi26_disconnect(struct usb_interface *intf) | |
266 | { | |
267 | } | |
268 | ||
269 | static struct usb_driver emi26_driver = { | |
1da177e4 LT |
270 | .name = "emi26 - firmware loader", |
271 | .probe = emi26_probe, | |
272 | .disconnect = emi26_disconnect, | |
273 | .id_table = id_table, | |
274 | }; | |
275 | ||
276 | static int __init emi26_init (void) | |
277 | { | |
278 | return usb_register(&emi26_driver); | |
279 | } | |
280 | ||
281 | static void __exit emi26_exit (void) | |
282 | { | |
283 | usb_deregister (&emi26_driver); | |
284 | } | |
285 | ||
286 | module_init(emi26_init); | |
287 | module_exit(emi26_exit); | |
288 | ||
96de0e25 | 289 | MODULE_AUTHOR("Tapio Laxström"); |
1da177e4 LT |
290 | MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader."); |
291 | MODULE_LICENSE("GPL"); | |
292 | ||
ae93a55b DW |
293 | MODULE_FIRMWARE("emi26/loader.fw"); |
294 | MODULE_FIRMWARE("emi26/bitstream.fw"); | |
295 | MODULE_FIRMWARE("emi26/firmware.fw"); | |
1da177e4 LT |
296 | /* vi:ai:syntax=c:sw=8:ts=8:tw=80 |
297 | */ |