xref: /openbmc/linux/drivers/usb/misc/emi26.c (revision d0b73b48)
1 /*
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 #include <linux/delay.h>
19 #include <linux/firmware.h>
20 #include <linux/ihex.h>
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 
33 static int emi26_writememory( struct usb_device *dev, int address,
34 			      const unsigned char *data, int length,
35 			      __u8 bRequest);
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 
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,
44 			      __u8 request)
45 {
46 	int result;
47 	unsigned char *buffer =  kmemdup(data, length, GFP_KERNEL);
48 
49 	if (!buffer) {
50 		dev_err(&dev->dev, "kmalloc(%d) failed.\n", length);
51 		return -ENOMEM;
52 	}
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);
56 	kfree (buffer);
57 	return result;
58 }
59 
60 /* thanks to drivers/usb/serial/keyspan_pda.c code */
61 static int emi26_set_reset (struct usb_device *dev, unsigned char reset_bit)
62 {
63 	int response;
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);
67 	if (response < 0) {
68 		dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit);
69 	}
70 	return response;
71 }
72 
73 #define FW_LOAD_SIZE		1023
74 
75 static int emi26_load_firmware (struct usb_device *dev)
76 {
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;
81 	int err = -ENOMEM;
82 	int i;
83 	__u32 addr;	/* Address to write */
84 	__u8 *buf;
85 
86 	buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
87 	if (!buf)
88 		goto wraperr;
89 
90 	err = request_ihex_firmware(&loader_fw, "emi26/loader.fw", &dev->dev);
91 	if (err)
92 		goto nofw;
93 
94 	err = request_ihex_firmware(&bitstream_fw, "emi26/bitstream.fw",
95 				    &dev->dev);
96 	if (err)
97 		goto nofw;
98 
99 	err = request_ihex_firmware(&firmware_fw, "emi26/firmware.fw",
100 				    &dev->dev);
101 	if (err) {
102 	nofw:
103 		dev_err(&dev->dev, "%s - request_firmware() failed\n",
104 			__func__);
105 		goto wraperr;
106 	}
107 
108 	/* Assert reset (stop the CPU in the EMI) */
109 	err = emi26_set_reset(dev,1);
110 	if (err < 0)
111 		goto wraperr;
112 
113 	rec = (const struct ihex_binrec *)loader_fw->data;
114 	/* 1. We need to put the loader for the FPGA into the EZ-USB */
115 	while (rec) {
116 		err = emi26_writememory(dev, be32_to_cpu(rec->addr),
117 					rec->data, be16_to_cpu(rec->len),
118 					ANCHOR_LOAD_INTERNAL);
119 		if (err < 0)
120 			goto wraperr;
121 		rec = ihex_next_binrec(rec);
122 	}
123 
124 	/* De-assert reset (let the CPU run) */
125 	err = emi26_set_reset(dev,0);
126 	if (err < 0)
127 		goto wraperr;
128 	msleep(250);	/* let device settle */
129 
130 	/* 2. We upload the FPGA firmware into the EMI
131 	 * Note: collect up to 1023 (yes!) bytes and send them with
132 	 * a single request. This is _much_ faster! */
133 	rec = (const struct ihex_binrec *)bitstream_fw->data;
134 	do {
135 		i = 0;
136 		addr = be32_to_cpu(rec->addr);
137 
138 		/* intel hex records are terminated with type 0 element */
139 		while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
140 			memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
141 			i += be16_to_cpu(rec->len);
142 			rec = ihex_next_binrec(rec);
143 		}
144 		err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
145 		if (err < 0)
146 			goto wraperr;
147 	} while (rec);
148 
149 	/* Assert reset (stop the CPU in the EMI) */
150 	err = emi26_set_reset(dev,1);
151 	if (err < 0)
152 		goto wraperr;
153 
154 	/* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
155 	for (rec = (const struct ihex_binrec *)loader_fw->data;
156 	     rec; rec = ihex_next_binrec(rec)) {
157 		err = emi26_writememory(dev, be32_to_cpu(rec->addr),
158 					rec->data, be16_to_cpu(rec->len),
159 					ANCHOR_LOAD_INTERNAL);
160 		if (err < 0)
161 			goto wraperr;
162 	}
163 	msleep(250);	/* let device settle */
164 
165 	/* De-assert reset (let the CPU run) */
166 	err = emi26_set_reset(dev,0);
167 	if (err < 0)
168 		goto wraperr;
169 
170 	/* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
171 
172 	for (rec = (const struct ihex_binrec *)firmware_fw->data;
173 	     rec; rec = ihex_next_binrec(rec)) {
174 		if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
175 			err = emi26_writememory(dev, be32_to_cpu(rec->addr),
176 						rec->data, be16_to_cpu(rec->len),
177 						ANCHOR_LOAD_EXTERNAL);
178 			if (err < 0)
179 				goto wraperr;
180 		}
181 	}
182 
183 	/* Assert reset (stop the CPU in the EMI) */
184 	err = emi26_set_reset(dev,1);
185 	if (err < 0)
186 		goto wraperr;
187 
188 	for (rec = (const struct ihex_binrec *)firmware_fw->data;
189 	     rec; rec = ihex_next_binrec(rec)) {
190 		if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
191 			err = emi26_writememory(dev, be32_to_cpu(rec->addr),
192 						rec->data, be16_to_cpu(rec->len),
193 						ANCHOR_LOAD_INTERNAL);
194 			if (err < 0)
195 				goto wraperr;
196 		}
197 	}
198 
199 	/* De-assert reset (let the CPU run) */
200 	err = emi26_set_reset(dev,0);
201 	if (err < 0)
202 		goto wraperr;
203 	msleep(250);	/* let device settle */
204 
205 	/* return 1 to fail the driver inialization
206 	 * and give real driver change to load */
207 	err = 1;
208 
209 wraperr:
210 	if (err < 0)
211 		dev_err(&dev->dev,"%s - error loading firmware: error = %d\n",
212 			__func__, err);
213 
214 	release_firmware(loader_fw);
215 	release_firmware(bitstream_fw);
216 	release_firmware(firmware_fw);
217 
218 	kfree(buf);
219 	return err;
220 }
221 
222 static const struct usb_device_id id_table[] = {
223 	{ USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) },
224 	{ USB_DEVICE(EMI26_VENDOR_ID, EMI26B_PRODUCT_ID) },
225 	{ }                                             /* Terminating entry */
226 };
227 
228 MODULE_DEVICE_TABLE (usb, id_table);
229 
230 static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id)
231 {
232 	struct usb_device *dev = interface_to_usbdev(intf);
233 
234 	dev_info(&intf->dev, "%s start\n", __func__);
235 
236 	emi26_load_firmware(dev);
237 
238 	/* do not return the driver context, let real audio driver do that */
239 	return -EIO;
240 }
241 
242 static void emi26_disconnect(struct usb_interface *intf)
243 {
244 }
245 
246 static struct usb_driver emi26_driver = {
247 	.name		= "emi26 - firmware loader",
248 	.probe		= emi26_probe,
249 	.disconnect	= emi26_disconnect,
250 	.id_table	= id_table,
251 };
252 
253 module_usb_driver(emi26_driver);
254 
255 MODULE_AUTHOR("Tapio Laxström");
256 MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
257 MODULE_LICENSE("GPL");
258 
259 MODULE_FIRMWARE("emi26/loader.fw");
260 MODULE_FIRMWARE("emi26/bitstream.fw");
261 MODULE_FIRMWARE("emi26/firmware.fw");
262 /* vi:ai:syntax=c:sw=8:ts=8:tw=80
263  */
264