blob: c8155209bf4b4dc07d1c4560c1ea3ac2643e6167 [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
4 * Tapio Laxström (tapio.laxstrom@iptime.fi)
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>
18
19#define MAX_INTEL_HEX_RECORD_LENGTH 16
20typedef struct _INTEL_HEX_RECORD
21{
22 __u32 length;
23 __u32 address;
24 __u32 type;
25 __u8 data[MAX_INTEL_HEX_RECORD_LENGTH];
26} INTEL_HEX_RECORD, *PINTEL_HEX_RECORD;
27
28/* include firmware (variables) */
29#include "emi26_fw.h"
30
31#define EMI26_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
32#define EMI26_PRODUCT_ID 0x0100 /* EMI 2|6 without firmware */
33#define EMI26B_PRODUCT_ID 0x0102 /* EMI 2|6 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
42static int emi26_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
43static int emi26_set_reset(struct usb_device *dev, unsigned char reset_bit);
44static int emi26_load_firmware (struct usb_device *dev);
45static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id);
46static void emi26_disconnect(struct usb_interface *intf);
47static int __init emi26_init (void);
48static void __exit emi26_exit (void);
49
50
51/* thanks to drivers/usb/serial/keyspan_pda.c code */
52static int emi26_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
53{
54 int result;
55 unsigned char *buffer = kmalloc (length, GFP_KERNEL);
56
57 if (!buffer) {
58 err("emi26: kmalloc(%d) failed.", length);
59 return -ENOMEM;
60 }
61 memcpy (buffer, data, length);
62 /* Note: usb_control_msg returns negative value on error or length of the
63 * data that was written! */
64 result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
65 kfree (buffer);
66 return result;
67}
68
69/* thanks to drivers/usb/serial/keyspan_pda.c code */
70static int emi26_set_reset (struct usb_device *dev, unsigned char reset_bit)
71{
72 int response;
73 info("%s - %d", __FUNCTION__, reset_bit);
74 /* printk(KERN_DEBUG "%s - %d", __FUNCTION__, reset_bit); */
75 response = emi26_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
76 if (response < 0) {
77 err("emi26: set_reset (%d) failed", reset_bit);
78 }
79 return response;
80}
81
82#define FW_LOAD_SIZE 1023
83
84static int emi26_load_firmware (struct usb_device *dev)
85{
86 int err;
87 int i;
88 int pos = 0; /* Position in hex record */
89 __u32 addr; /* Address to write */
90 __u8 *buf;
91
92 buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
93 if (!buf) {
94 err( "%s - error loading firmware: error = %d", __FUNCTION__, -ENOMEM);
95 err = -ENOMEM;
96 goto wraperr;
97 }
98
99 /* Assert reset (stop the CPU in the EMI) */
100 err = emi26_set_reset(dev,1);
101 if (err < 0) {
102 err( "%s - error loading firmware: error = %d", __FUNCTION__, err);
103 goto wraperr;
104 }
105
106 /* 1. We need to put the loader for the FPGA into the EZ-USB */
107 for (i=0; g_Loader[i].type == 0; i++) {
108 err = emi26_writememory(dev, g_Loader[i].address, g_Loader[i].data, g_Loader[i].length, ANCHOR_LOAD_INTERNAL);
109 if (err < 0) {
110 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
111 goto wraperr;
112 }
113 }
114
115 /* De-assert reset (let the CPU run) */
116 err = emi26_set_reset(dev,0);
117
118 /* 2. We upload the FPGA firmware into the EMI
119 * Note: collect up to 1023 (yes!) bytes and send them with
120 * a single request. This is _much_ faster! */
121 do {
122 i = 0;
123 addr = g_bitstream[pos].address;
124
125 /* intel hex records are terminated with type 0 element */
126 while ((g_bitstream[pos].type == 0) && (i + g_bitstream[pos].length < FW_LOAD_SIZE)) {
127 memcpy(buf + i, g_bitstream[pos].data, g_bitstream[pos].length);
128 i += g_bitstream[pos].length;
129 pos++;
130 }
131 err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
132 if (err < 0) {
133 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
134 goto wraperr;
135 }
136 } while (i > 0);
137
138 /* Assert reset (stop the CPU in the EMI) */
139 err = emi26_set_reset(dev,1);
140 if (err < 0) {
141 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
142 goto wraperr;
143 }
144
145 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
146 for (i=0; g_Loader[i].type == 0; i++) {
147 err = emi26_writememory(dev, g_Loader[i].address, g_Loader[i].data, g_Loader[i].length, ANCHOR_LOAD_INTERNAL);
148 if (err < 0) {
149 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
150 goto wraperr;
151 }
152 }
153
154 /* De-assert reset (let the CPU run) */
155 err = emi26_set_reset(dev,0);
156 if (err < 0) {
157 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
158 goto wraperr;
159 }
160
161 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
162 for (i=0; g_Firmware[i].type == 0; i++) {
163 if (!INTERNAL_RAM(g_Firmware[i].address)) {
164 err = emi26_writememory(dev, g_Firmware[i].address, g_Firmware[i].data, g_Firmware[i].length, ANCHOR_LOAD_EXTERNAL);
165 if (err < 0) {
166 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
167 goto wraperr;
168 }
169 }
170 }
171
172 /* Assert reset (stop the CPU in the EMI) */
173 err = emi26_set_reset(dev,1);
174 if (err < 0) {
175 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
176 goto wraperr;
177 }
178
179 for (i=0; g_Firmware[i].type == 0; i++) {
180 if (INTERNAL_RAM(g_Firmware[i].address)) {
181 err = emi26_writememory(dev, g_Firmware[i].address, g_Firmware[i].data, g_Firmware[i].length, ANCHOR_LOAD_INTERNAL);
182 if (err < 0) {
183 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
184 goto wraperr;
185 }
186 }
187 }
188
189 /* De-assert reset (let the CPU run) */
190 err = emi26_set_reset(dev,0);
191 if (err < 0) {
192 err("%s - error loading firmware: error = %d", __FUNCTION__, err);
193 goto wraperr;
194 }
195
196 /* return 1 to fail the driver inialization
197 * and give real driver change to load */
198 err = 1;
199
200wraperr:
201 kfree(buf);
202 return err;
203}
204
205static struct usb_device_id id_table [] = {
206 { USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) },
207 { USB_DEVICE(EMI26_VENDOR_ID, EMI26B_PRODUCT_ID) },
208 { } /* Terminating entry */
209};
210
211MODULE_DEVICE_TABLE (usb, id_table);
212
213static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id)
214{
215 struct usb_device *dev = interface_to_usbdev(intf);
216
217 info("%s start", __FUNCTION__);
218
219 emi26_load_firmware(dev);
220
221 /* do not return the driver context, let real audio driver do that */
222 return -EIO;
223}
224
225static void emi26_disconnect(struct usb_interface *intf)
226{
227}
228
229static struct usb_driver emi26_driver = {
230 .owner = THIS_MODULE,
231 .name = "emi26 - firmware loader",
232 .probe = emi26_probe,
233 .disconnect = emi26_disconnect,
234 .id_table = id_table,
235};
236
237static int __init emi26_init (void)
238{
239 return usb_register(&emi26_driver);
240}
241
242static void __exit emi26_exit (void)
243{
244 usb_deregister (&emi26_driver);
245}
246
247module_init(emi26_init);
248module_exit(emi26_exit);
249
250MODULE_AUTHOR("tapio laxström");
251MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
252MODULE_LICENSE("GPL");
253
254/* vi:ai:syntax=c:sw=8:ts=8:tw=80
255 */