blob: 4758cc5ccebcd37acdc7330718079941f77b332c [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.
9 *
10 * $Id: emi62.c,v 1.15 2002/04/23 06:13:59 tapio Exp $
11 */
12#include <linux/kernel.h>
13#include <linux/errno.h>
14#include <linux/slab.h>
15#include <linux/init.h>
16#include <linux/module.h>
17#include <linux/usb.h>
Monty16c23f72006-05-09 12:37:22 -070018#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20#define MAX_INTEL_HEX_RECORD_LENGTH 16
21typedef struct _INTEL_HEX_RECORD
22{
23 __u32 length;
24 __u32 address;
25 __u32 type;
26 __u8 data[MAX_INTEL_HEX_RECORD_LENGTH];
27} INTEL_HEX_RECORD, *PINTEL_HEX_RECORD;
28
29/* include firmware (variables)*/
30
31/* FIXME: This is quick and dirty solution! */
32#define SPDIF /* if you want SPDIF comment next line */
33//#undef SPDIF /* if you want MIDI uncomment this line */
34
35#ifdef SPDIF
36# include "emi62_fw_s.h" /* spdif fw */
37#else
38# include "emi62_fw_m.h" /* midi fw */
39#endif
40
41#define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
42#define EMI62_PRODUCT_ID 0x0110 /* EMI 6|2m without firmware */
43
44#define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
45#define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */
46#define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */
47#define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */
48#define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */
49#define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS)
50
51static int emi62_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
52static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
53static int emi62_load_firmware (struct usb_device *dev);
54static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
55static void emi62_disconnect(struct usb_interface *intf);
56static int __init emi62_init (void);
57static void __exit emi62_exit (void);
58
59
60/* thanks to drivers/usb/serial/keyspan_pda.c code */
61static int emi62_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
62{
63 int result;
Eric Sesterhenn5d7efe52006-10-26 21:06:24 +020064 unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66 if (!buffer) {
67 err("emi62: kmalloc(%d) failed.", length);
68 return -ENOMEM;
69 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 /* Note: usb_control_msg returns negative value on error or length of the
71 * data that was written! */
72 result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
73 kfree (buffer);
74 return result;
75}
76
77/* thanks to drivers/usb/serial/keyspan_pda.c code */
78static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
79{
80 int response;
81 info("%s - %d", __FUNCTION__, reset_bit);
82
83 response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
84 if (response < 0) {
85 err("emi62: set_reset (%d) failed", reset_bit);
86 }
87 return response;
88}
89
90#define FW_LOAD_SIZE 1023
91
92static int emi62_load_firmware (struct usb_device *dev)
93{
94 int err;
95 int i;
96 int pos = 0; /* Position in hex record */
97 __u32 addr; /* Address to write */
98 __u8 *buf;
99
100 dev_dbg(&dev->dev, "load_firmware\n");
101 buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
102 if (!buf) {
103 err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM);
104 err = -ENOMEM;
105 goto wraperr;
106 }
107
108 /* Assert reset (stop the CPU in the EMI) */
109 err = emi62_set_reset(dev,1);
110 if (err < 0) {
111 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
112 goto wraperr;
113 }
114
115 /* 1. We need to put the loader for the FPGA into the EZ-USB */
116 for (i=0; g_emi62_loader[i].type == 0; i++) {
117 err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
118 if (err < 0) {
119 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
120 goto wraperr;
121 }
122 }
123
124 /* De-assert reset (let the CPU run) */
125 err = emi62_set_reset(dev,0);
Monty16c23f72006-05-09 12:37:22 -0700126 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 /* 2. We upload the FPGA firmware into the EMI
129 * Note: collect up to 1023 (yes!) bytes and send them with
130 * a single request. This is _much_ faster! */
131 do {
132 i = 0;
133 addr = g_emi62bs[pos].address;
134
135 /* intel hex records are terminated with type 0 element */
136 while ((g_emi62bs[pos].type == 0) && (i + g_emi62bs[pos].length < FW_LOAD_SIZE)) {
137 memcpy(buf + i, g_emi62bs[pos].data, g_emi62bs[pos].length);
138 i += g_emi62bs[pos].length;
139 pos++;
140 }
141 err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
142 if (err < 0) {
143 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
144 goto wraperr;
145 }
146 } while (i > 0);
147
148 /* Assert reset (stop the CPU in the EMI) */
149 err = emi62_set_reset(dev,1);
150 if (err < 0) {
151 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
152 goto wraperr;
153 }
154
155 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
156 for (i=0; g_emi62_loader[i].type == 0; i++) {
157 err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
158 if (err < 0) {
159 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
160 goto wraperr;
161 }
162 }
163
164 /* De-assert reset (let the CPU run) */
165 err = emi62_set_reset(dev,0);
166 if (err < 0) {
167 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
168 goto wraperr;
169 }
Monty16c23f72006-05-09 12:37:22 -0700170 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
173
174/* FIXME: quick and dirty ifdefs */
175#ifdef SPDIF
176 for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
177 if (!INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
178 err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_EXTERNAL);
179 if (err < 0) {
180 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
181 goto wraperr;
182 }
183 }
184 }
185#else /* MIDI */
186 for (i=0; g_HexMidiFw62[i].type == 0; i++) {
187 if (!INTERNAL_RAM(g_HexMidiFw62[i].address)) {
188 err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_EXTERNAL);
189 if (err < 0) {
190 err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
191 goto wraperr;
192 return err;
193 }
194 }
195 }
196#endif
197 /* Assert reset (stop the CPU in the EMI) */
198 err = emi62_set_reset(dev,1);
199 if (err < 0) {
200 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
201 goto wraperr;
202 }
203
204/* FIXME: quick and dirty ifdefs */
205#ifdef SPDIF
206 for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
207 if (INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
208 err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_INTERNAL);
209 if (err < 0) {
210 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
211 goto wraperr;
212 }
213 }
214 }
215#else /* MIDI */
216 for (i=0; g_HexMidiFw62[i].type == 0; i++) {
217 if (INTERNAL_RAM(g_HexMidiFw62[i].address)) {
218 err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_INTERNAL);
219 if (err < 0) {
220 err("%s - error loading firmware: error = %d\n", __FUNCTION__, err);
221 goto wraperr;
222 }
223 }
224 }
225#endif
226
227 /* De-assert reset (let the CPU run) */
228 err = emi62_set_reset(dev,0);
229 if (err < 0) {
230 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
231 goto wraperr;
232 }
Monty16c23f72006-05-09 12:37:22 -0700233 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 kfree(buf);
236
237 /* return 1 to fail the driver inialization
238 * and give real driver change to load */
239 return 1;
240
241wraperr:
242 kfree(buf);
243 dev_err(&dev->dev, "Error\n");
244 return err;
245}
246
247static __devinitdata struct usb_device_id id_table [] = {
248 { USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
249 { } /* Terminating entry */
250};
251
252MODULE_DEVICE_TABLE (usb, id_table);
253
254static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id)
255{
256 struct usb_device *dev = interface_to_usbdev(intf);
257 dev_dbg(&intf->dev, "emi62_probe\n");
258
259 info("%s start", __FUNCTION__);
260
261 emi62_load_firmware(dev);
262
263 /* do not return the driver context, let real audio driver do that */
264 return -EIO;
265}
266
267static void emi62_disconnect(struct usb_interface *intf)
268{
269}
270
271static struct usb_driver emi62_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 .name = "emi62 - firmware loader",
273 .probe = emi62_probe,
274 .disconnect = emi62_disconnect,
275 .id_table = id_table,
276};
277
278static int __init emi62_init (void)
279{
280 int retval;
281 retval = usb_register (&emi62_driver);
282 if (retval)
283 printk(KERN_ERR "adi-emi: registration failed\n");
284 return retval;
285}
286
287static void __exit emi62_exit (void)
288{
289 usb_deregister (&emi62_driver);
290}
291
292module_init(emi62_init);
293module_exit(emi62_exit);
294
Jan Engelhardt96de0e22007-10-19 23:21:04 +0200295MODULE_AUTHOR("Tapio Laxström");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
297MODULE_LICENSE("GPL");
298
299/* vi:ai:syntax=c:sw=8:ts=8:tw=80
300 */