blob: 8950fa5e973d6f100cb49e1fc2b7000564e27a4c [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 * 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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/usb.h>
Monty16c23f72006-05-09 12:37:22 -070017#include <linux/delay.h>
David Woodhouseae93a552008-05-30 16:19:39 +030018#include <linux/firmware.h>
19#include <linux/ihex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#define EMI26_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
22#define EMI26_PRODUCT_ID 0x0100 /* EMI 2|6 without firmware */
23#define EMI26B_PRODUCT_ID 0x0102 /* EMI 2|6 without firmware */
24
25#define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
26#define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */
27#define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */
28#define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */
29#define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */
30#define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS)
31
David Woodhouseae93a552008-05-30 16:19:39 +030032static int emi26_writememory( struct usb_device *dev, int address,
33 const unsigned char *data, int length,
34 __u8 bRequest);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035static int emi26_set_reset(struct usb_device *dev, unsigned char reset_bit);
36static int emi26_load_firmware (struct usb_device *dev);
37static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id);
38static void emi26_disconnect(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/* thanks to drivers/usb/serial/keyspan_pda.c code */
David Woodhouseae93a552008-05-30 16:19:39 +030041static int emi26_writememory (struct usb_device *dev, int address,
42 const unsigned char *data, int length,
43 __u8 request)
Linus Torvalds1da177e2005-04-16 15:20:36 -070044{
45 int result;
Eric Sesterhenn5d7efe52006-10-26 21:06:24 +020046 unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48 if (!buffer) {
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -070049 dev_err(&dev->dev, "kmalloc(%d) failed.\n", length);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 return -ENOMEM;
51 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 /* Note: usb_control_msg returns negative value on error or length of the
53 * data that was written! */
54 result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
55 kfree (buffer);
56 return result;
57}
58
59/* thanks to drivers/usb/serial/keyspan_pda.c code */
60static int emi26_set_reset (struct usb_device *dev, unsigned char reset_bit)
61{
62 int response;
Greg Kroah-Hartman1b29a372008-08-18 13:21:04 -070063 dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
Harvey Harrison441b62c2008-03-03 16:08:34 -080064 /* printk(KERN_DEBUG "%s - %d", __func__, reset_bit); */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 response = emi26_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
66 if (response < 0) {
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -070067 dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 }
69 return response;
70}
71
72#define FW_LOAD_SIZE 1023
73
74static int emi26_load_firmware (struct usb_device *dev)
75{
David Woodhouseae93a552008-05-30 16:19:39 +030076 const struct firmware *loader_fw = NULL;
77 const struct firmware *bitstream_fw = NULL;
78 const struct firmware *firmware_fw = NULL;
79 const struct ihex_binrec *rec;
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -070080 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 __u32 addr; /* Address to write */
83 __u8 *buf;
84
85 buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -070086 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
David Woodhouseae93a552008-05-30 16:19:39 +030089 err = request_ihex_firmware(&loader_fw, "emi26/loader.fw", &dev->dev);
90 if (err)
91 goto nofw;
92
93 err = request_ihex_firmware(&bitstream_fw, "emi26/bitstream.fw",
94 &dev->dev);
95 if (err)
96 goto nofw;
97
98 err = request_ihex_firmware(&firmware_fw, "emi26/firmware.fw",
99 &dev->dev);
100 if (err) {
101 nofw:
Greg Kroah-Hartmanfd3f1912008-08-14 09:37:34 -0700102 dev_err(&dev->dev, "%s - request_firmware() failed\n",
103 __func__);
David Woodhouseae93a552008-05-30 16:19:39 +0300104 goto wraperr;
105 }
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 /* Assert reset (stop the CPU in the EMI) */
108 err = emi26_set_reset(dev,1);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700109 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
David Woodhouseae93a552008-05-30 16:19:39 +0300112 rec = (const struct ihex_binrec *)loader_fw->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 /* 1. We need to put the loader for the FPGA into the EZ-USB */
David Woodhouseae93a552008-05-30 16:19:39 +0300114 while (rec) {
115 err = emi26_writememory(dev, be32_to_cpu(rec->addr),
116 rec->data, be16_to_cpu(rec->len),
117 ANCHOR_LOAD_INTERNAL);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700118 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 goto wraperr;
David Woodhouseae93a552008-05-30 16:19:39 +0300120 rec = ihex_next_binrec(rec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 }
122
123 /* De-assert reset (let the CPU run) */
124 err = emi26_set_reset(dev,0);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700125 if (err < 0)
Oliver Neukumcf4cf0b2007-10-25 15:38:44 +0200126 goto wraperr;
Monty16c23f72006-05-09 12:37:22 -0700127 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 /* 2. We upload the FPGA firmware into the EMI
130 * Note: collect up to 1023 (yes!) bytes and send them with
131 * a single request. This is _much_ faster! */
David Woodhouseae93a552008-05-30 16:19:39 +0300132 rec = (const struct ihex_binrec *)bitstream_fw->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 do {
134 i = 0;
David Woodhouseae93a552008-05-30 16:19:39 +0300135 addr = be32_to_cpu(rec->addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137 /* intel hex records are terminated with type 0 element */
David Woodhouseae93a552008-05-30 16:19:39 +0300138 while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
139 memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
140 i += be16_to_cpu(rec->len);
141 rec = ihex_next_binrec(rec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 }
143 err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700144 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 goto wraperr;
Marcin Slusarz327d74f2009-01-04 13:25:13 +0100146 } while (rec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148 /* Assert reset (stop the CPU in the EMI) */
149 err = emi26_set_reset(dev,1);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700150 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153 /* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
David Woodhouseae93a552008-05-30 16:19:39 +0300154 for (rec = (const struct ihex_binrec *)loader_fw->data;
155 rec; rec = ihex_next_binrec(rec)) {
156 err = emi26_writememory(dev, be32_to_cpu(rec->addr),
157 rec->data, be16_to_cpu(rec->len),
158 ANCHOR_LOAD_INTERNAL);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700159 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
Monty16c23f72006-05-09 12:37:22 -0700162 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164 /* De-assert reset (let the CPU run) */
165 err = emi26_set_reset(dev,0);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700166 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 /* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
David Woodhouseae93a552008-05-30 16:19:39 +0300170
171 for (rec = (const struct ihex_binrec *)firmware_fw->data;
172 rec; rec = ihex_next_binrec(rec)) {
173 if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
174 err = emi26_writememory(dev, be32_to_cpu(rec->addr),
175 rec->data, be16_to_cpu(rec->len),
176 ANCHOR_LOAD_EXTERNAL);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700177 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 }
180 }
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 /* Assert reset (stop the CPU in the EMI) */
183 err = emi26_set_reset(dev,1);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700184 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
David Woodhouseae93a552008-05-30 16:19:39 +0300187 for (rec = (const struct ihex_binrec *)firmware_fw->data;
188 rec; rec = ihex_next_binrec(rec)) {
189 if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
190 err = emi26_writememory(dev, be32_to_cpu(rec->addr),
191 rec->data, be16_to_cpu(rec->len),
192 ANCHOR_LOAD_INTERNAL);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700193 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 goto wraperr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 }
196 }
197
198 /* De-assert reset (let the CPU run) */
199 err = emi26_set_reset(dev,0);
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700200 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 goto wraperr;
Monty16c23f72006-05-09 12:37:22 -0700202 msleep(250); /* let device settle */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204 /* return 1 to fail the driver inialization
205 * and give real driver change to load */
206 err = 1;
207
208wraperr:
Greg Kroah-Hartmanb4122842012-04-20 16:53:37 -0700209 if (err < 0)
210 dev_err(&dev->dev,"%s - error loading firmware: error = %d\n",
211 __func__, err);
212
David Woodhouseae93a552008-05-30 16:19:39 +0300213 release_firmware(loader_fw);
214 release_firmware(bitstream_fw);
215 release_firmware(firmware_fw);
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 kfree(buf);
218 return err;
219}
220
Németh Márton33b9e162010-01-10 15:34:45 +0100221static const struct usb_device_id id_table[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 { USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) },
223 { USB_DEVICE(EMI26_VENDOR_ID, EMI26B_PRODUCT_ID) },
224 { } /* Terminating entry */
225};
226
227MODULE_DEVICE_TABLE (usb, id_table);
228
229static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id)
230{
231 struct usb_device *dev = interface_to_usbdev(intf);
232
Greg Kroah-Hartman1b29a372008-08-18 13:21:04 -0700233 dev_info(&intf->dev, "%s start\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 emi26_load_firmware(dev);
236
237 /* do not return the driver context, let real audio driver do that */
238 return -EIO;
239}
240
241static void emi26_disconnect(struct usb_interface *intf)
242{
243}
244
245static struct usb_driver emi26_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 .name = "emi26 - firmware loader",
247 .probe = emi26_probe,
248 .disconnect = emi26_disconnect,
249 .id_table = id_table,
250};
251
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -0800252module_usb_driver(emi26_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Jan Engelhardt96de0e22007-10-19 23:21:04 +0200254MODULE_AUTHOR("Tapio Laxström");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
256MODULE_LICENSE("GPL");
257
David Woodhouseae93a552008-05-30 16:19:39 +0300258MODULE_FIRMWARE("emi26/loader.fw");
259MODULE_FIRMWARE("emi26/bitstream.fw");
260MODULE_FIRMWARE("emi26/firmware.fw");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261/* vi:ai:syntax=c:sw=8:ts=8:tw=80
262 */