2 * Emagic EMI 2|6 usb audio interface firmware loader.
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.
10 * emi26.c,v 1.13 2002/03/08 13:10:26 tapio Exp
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>
18 #include <linux/delay.h>
19 #include <linux/firmware.h>
20 #include <linux/ihex.h>
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 */
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)
33 static int emi26_writememory( struct usb_device
*dev
, int address
,
34 const unsigned char *data
, int length
,
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
);
41 /* thanks to drivers/usb/serial/keyspan_pda.c code */
42 static int emi26_writememory (struct usb_device
*dev
, int address
,
43 const unsigned char *data
, int length
,
47 unsigned char *buffer
= kmemdup(data
, length
, GFP_KERNEL
);
50 dev_err(&dev
->dev
, "kmalloc(%d) failed.\n", length
);
53 /* Note: usb_control_msg returns negative value on error or length of the
54 * data that was written! */
55 result
= usb_control_msg (dev
, usb_sndctrlpipe(dev
, 0), request
, 0x40, address
, 0, buffer
, length
, 300);
60 /* thanks to drivers/usb/serial/keyspan_pda.c code */
61 static int emi26_set_reset (struct usb_device
*dev
, unsigned char reset_bit
)
64 dev_info(&dev
->dev
, "%s - %d\n", __func__
, reset_bit
);
65 /* printk(KERN_DEBUG "%s - %d", __func__, reset_bit); */
66 response
= emi26_writememory (dev
, CPUCS_REG
, &reset_bit
, 1, 0xa0);
68 dev_err(&dev
->dev
, "set_reset (%d) failed\n", reset_bit
);
73 #define FW_LOAD_SIZE 1023
75 static int emi26_load_firmware (struct usb_device
*dev
)
77 const struct firmware
*loader_fw
= NULL
;
78 const struct firmware
*bitstream_fw
= NULL
;
79 const struct firmware
*firmware_fw
= NULL
;
80 const struct ihex_binrec
*rec
;
83 __u32 addr
; /* Address to write */
86 buf
= kmalloc(FW_LOAD_SIZE
, GFP_KERNEL
);
88 dev_err(&dev
->dev
, "%s - error loading firmware: error = %d\n",
94 err
= request_ihex_firmware(&loader_fw
, "emi26/loader.fw", &dev
->dev
);
98 err
= request_ihex_firmware(&bitstream_fw
, "emi26/bitstream.fw",
103 err
= request_ihex_firmware(&firmware_fw
, "emi26/firmware.fw",
107 dev_err(&dev
->dev
, "%s - request_firmware() failed\n",
112 /* Assert reset (stop the CPU in the EMI) */
113 err
= emi26_set_reset(dev
,1);
115 dev_err(&dev
->dev
,"%s - error loading firmware: error = %d\n",
120 rec
= (const struct ihex_binrec
*)loader_fw
->data
;
121 /* 1. We need to put the loader for the FPGA into the EZ-USB */
123 err
= emi26_writememory(dev
, be32_to_cpu(rec
->addr
),
124 rec
->data
, be16_to_cpu(rec
->len
),
125 ANCHOR_LOAD_INTERNAL
);
127 err("%s - error loading firmware: error = %d", __func__
, err
);
130 rec
= ihex_next_binrec(rec
);
133 /* De-assert reset (let the CPU run) */
134 err
= emi26_set_reset(dev
,0);
136 err("%s - error loading firmware: error = %d", __func__
, err
);
139 msleep(250); /* let device settle */
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! */
144 rec
= (const struct ihex_binrec
*)bitstream_fw
->data
;
147 addr
= be32_to_cpu(rec
->addr
);
149 /* intel hex records are terminated with type 0 element */
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
);
155 err
= emi26_writememory(dev
, addr
, buf
, i
, ANCHOR_LOAD_FPGA
);
157 err("%s - error loading firmware: error = %d", __func__
, err
);
162 /* Assert reset (stop the CPU in the EMI) */
163 err
= emi26_set_reset(dev
,1);
165 err("%s - error loading firmware: error = %d", __func__
, err
);
169 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
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
);
176 err("%s - error loading firmware: error = %d", __func__
, err
);
180 msleep(250); /* let device settle */
182 /* De-assert reset (let the CPU run) */
183 err
= emi26_set_reset(dev
,0);
185 err("%s - error loading firmware: error = %d", __func__
, err
);
189 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
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
);
198 err("%s - error loading firmware: error = %d", __func__
, err
);
204 /* Assert reset (stop the CPU in the EMI) */
205 err
= emi26_set_reset(dev
,1);
207 err("%s - error loading firmware: error = %d", __func__
, err
);
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
);
218 err("%s - error loading firmware: error = %d", __func__
, err
);
224 /* De-assert reset (let the CPU run) */
225 err
= emi26_set_reset(dev
,0);
227 err("%s - error loading firmware: error = %d", __func__
, err
);
230 msleep(250); /* let device settle */
232 /* return 1 to fail the driver inialization
233 * and give real driver change to load */
237 release_firmware(loader_fw
);
238 release_firmware(bitstream_fw
);
239 release_firmware(firmware_fw
);
245 static const 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 */
251 MODULE_DEVICE_TABLE (usb
, id_table
);
253 static int emi26_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
255 struct usb_device
*dev
= interface_to_usbdev(intf
);
257 dev_info(&intf
->dev
, "%s start\n", __func__
);
259 emi26_load_firmware(dev
);
261 /* do not return the driver context, let real audio driver do that */
265 static void emi26_disconnect(struct usb_interface
*intf
)
269 static struct usb_driver emi26_driver
= {
270 .name
= "emi26 - firmware loader",
271 .probe
= emi26_probe
,
272 .disconnect
= emi26_disconnect
,
273 .id_table
= id_table
,
276 module_usb_driver(emi26_driver
);
278 MODULE_AUTHOR("Tapio Laxström");
279 MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
280 MODULE_LICENSE("GPL");
282 MODULE_FIRMWARE("emi26/loader.fw");
283 MODULE_FIRMWARE("emi26/bitstream.fw");
284 MODULE_FIRMWARE("emi26/firmware.fw");
285 /* vi:ai:syntax=c:sw=8:ts=8:tw=80