emi62: use request_firmware()

Signed-off-by: David Woodhouse <dwmw2@infradead.org>

drivers/usb/misc/emi62.c

@@ -16,15 +16,8 @@
 #include <linux/module.h>
 #include <linux/usb.h>
 #include <linux/delay.h>
-
-#define MAX_INTEL_HEX_RECORD_LENGTH 16
-typedef struct _INTEL_HEX_RECORD
-{
-	__u32	length;
-	__u32	address;
-	__u32	type;
-	__u8	data[MAX_INTEL_HEX_RECORD_LENGTH];
-} INTEL_HEX_RECORD, *PINTEL_HEX_RECORD;
+#include <linux/firmware.h>
+#include <linux/ihex.h>
 
 /* include firmware (variables)*/
 
@@ -33,9 +26,9 @@ typedef struct _INTEL_HEX_RECORD
 //#undef SPDIF	/* if you want MIDI uncomment this line */ 
 
 #ifdef SPDIF
-#  include "emi62_fw_s.h" /* spdif fw */
+#define FIRMWARE_FW "emi62/spdif.fw"
 #else
-#  include "emi62_fw_m.h" /* midi fw */
+#define FIRMWARE_FW "emi62/midi.fw"
 #endif
 
 #define EMI62_VENDOR_ID 		0x086a  /* Emagic Soft-und Hardware GmBH */
@@ -48,7 +41,9 @@ typedef struct _INTEL_HEX_RECORD
 #define CPUCS_REG		0x7F92  /* EZ-USB Control and Status Register.  Bit 0 controls 8051 reset */ 
 #define INTERNAL_RAM(address)   (address <= MAX_INTERNAL_ADDRESS)
 
-static int emi62_writememory( struct usb_device *dev, int address, unsigned char *data, int length, __u8 bRequest);
+static int emi62_writememory(struct usb_device *dev, int address,
+			     const unsigned char *data, int length,
+			     __u8 bRequest);
 static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
 static int emi62_load_firmware (struct usb_device *dev);
 static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id);
@@ -58,7 +53,9 @@ static void __exit emi62_exit (void);
 
 
 /* thanks to drivers/usb/serial/keyspan_pda.c code */
-static int emi62_writememory (struct usb_device *dev, int address, unsigned char *data, int length, __u8 request)
+static int emi62_writememory(struct usb_device *dev, int address,
+			     const unsigned char *data, int length,
+			     __u8 request)
 {
 	int result;
 	unsigned char *buffer =  kmemdup(data, length, GFP_KERNEL);
@@ -91,9 +88,12 @@ static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
 
 static int emi62_load_firmware (struct usb_device *dev)
 {
+	const struct firmware *loader_fw = NULL;
+	const struct firmware *bitstream_fw = NULL;
+	const struct firmware *firmware_fw = NULL;
+	const struct ihex_binrec *rec;
 	int err;
 	int i;
-	int pos = 0;	/* Position in hex record */
 	__u32 addr;	/* Address to write */
 	__u8 *buf;
 
@@ -105,6 +105,22 @@ static int emi62_load_firmware (struct usb_device *dev)
 		goto wraperr;
 	}
 
+	err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev);
+	if (err)
+		goto nofw;
+
+	err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw",
+				    &dev->dev);
+	if (err)
+		goto nofw;
+
+	err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev);
+	if (err) {
+	nofw:
+		err( "%s - request_firmware() failed", __func__);
+		goto wraperr;
+	}
+
 	/* Assert reset (stop the CPU in the EMI) */
 	err = emi62_set_reset(dev,1);
 	if (err < 0) {
@@ -112,13 +128,18 @@ static int emi62_load_firmware (struct usb_device *dev)
 		goto wraperr;
 	}
 
+	rec = (const struct ihex_binrec *)loader_fw->data;
+
 	/* 1. We need to put the loader for the FPGA into the EZ-USB */
-	for (i=0; g_emi62_loader[i].type == 0; i++) {
-		err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
+	while (rec) {
+		err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+					rec->data, be16_to_cpu(rec->len),
+					ANCHOR_LOAD_INTERNAL);
 		if (err < 0) {
 			err("%s - error loading firmware: error = %d", __func__, err);
 			goto wraperr;
 		}
+		rec = ihex_next_binrec(rec);
 	}
 
 	/* De-assert reset (let the CPU run) */
@@ -132,15 +153,16 @@ static int emi62_load_firmware (struct usb_device *dev)
 	/* 2. We upload the FPGA firmware into the EMI
 	 * Note: collect up to 1023 (yes!) bytes and send them with
 	 * a single request. This is _much_ faster! */
+	rec = (const struct ihex_binrec *)bitstream_fw->data;
 	do {
 		i = 0;
-		addr = g_emi62bs[pos].address;
+		addr = be32_to_cpu(rec->addr);
 
 		/* intel hex records are terminated with type 0 element */
-		while ((g_emi62bs[pos].type == 0) && (i + g_emi62bs[pos].length < FW_LOAD_SIZE)) {
-			memcpy(buf + i, g_emi62bs[pos].data, g_emi62bs[pos].length);
-			i += g_emi62bs[pos].length;
-			pos++;
+		while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
+			memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
+			i += be16_to_cpu(rec->len);
+			rec = ihex_next_binrec(rec);
 		}
 		err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
 		if (err < 0) {
@@ -157,8 +179,11 @@ static int emi62_load_firmware (struct usb_device *dev)
 	}
 
 	/* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
-	for (i=0; g_emi62_loader[i].type == 0; i++) {
-		err = emi62_writememory(dev, g_emi62_loader[i].address, g_emi62_loader[i].data, g_emi62_loader[i].length, ANCHOR_LOAD_INTERNAL);
+	for (rec = (const struct ihex_binrec *)loader_fw->data;
+	     rec; rec = ihex_next_binrec(rec)) {
+		err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+					rec->data, be16_to_cpu(rec->len),
+					ANCHOR_LOAD_INTERNAL);
 		if (err < 0) {
 			err("%s - error loading firmware: error = %d", __func__, err);
 			goto wraperr;
@@ -175,29 +200,19 @@ static int emi62_load_firmware (struct usb_device *dev)
 
 	/* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
 
-/* FIXME: quick and dirty ifdefs */
-#ifdef SPDIF
-	for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
-		if (!INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
-			err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_EXTERNAL);
+	for (rec = (const struct ihex_binrec *)firmware_fw->data;
+	     rec; rec = ihex_next_binrec(rec)) {
+		if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
+			err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+						rec->data, be16_to_cpu(rec->len),
+						ANCHOR_LOAD_EXTERNAL);
 			if (err < 0) {
 				err("%s - error loading firmware: error = %d", __func__, err);
 				goto wraperr;
 			}
 		}
 	}
-#else /* MIDI */
-	for (i=0; g_HexMidiFw62[i].type == 0; i++) {
-		if (!INTERNAL_RAM(g_HexMidiFw62[i].address)) {
-			err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_EXTERNAL);
-			if (err < 0) {
-				err("%s - error loading firmware: error = %d\n", __func__, err);
-				goto wraperr;
-				return err;
-			}
-		}
-	}
-#endif	
+
 	/* Assert reset (stop the CPU in the EMI) */
 	err = emi62_set_reset(dev,1);
 	if (err < 0) {
@@ -205,28 +220,18 @@ static int emi62_load_firmware (struct usb_device *dev)
 		goto wraperr;
 	}
 
-/* FIXME: quick and dirty ifdefs */
-#ifdef SPDIF
-	for (i=0; g_HexSpdifFw62[i].type == 0; i++) {
-		if (INTERNAL_RAM(g_HexSpdifFw62[i].address)) {
-			err = emi62_writememory(dev, g_HexSpdifFw62[i].address, g_HexSpdifFw62[i].data, g_HexSpdifFw62[i].length, ANCHOR_LOAD_INTERNAL);
+	for (rec = (const struct ihex_binrec *)firmware_fw->data;
+	     rec; rec = ihex_next_binrec(rec)) {
+		if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
+			err = emi62_writememory(dev, be32_to_cpu(rec->addr),
+						rec->data, be16_to_cpu(rec->len),
+						ANCHOR_LOAD_EXTERNAL);
 			if (err < 0) {
 				err("%s - error loading firmware: error = %d", __func__, err);
 				goto wraperr;
 			}
 		}
 	}
-#else /* MIDI */
-	for (i=0; g_HexMidiFw62[i].type == 0; i++) {
-		if (INTERNAL_RAM(g_HexMidiFw62[i].address)) {
-			err = emi62_writememory(dev, g_HexMidiFw62[i].address, g_HexMidiFw62[i].data, g_HexMidiFw62[i].length, ANCHOR_LOAD_INTERNAL);
-			if (err < 0) {
-				err("%s - error loading firmware: error = %d\n", __func__, err);
-				goto wraperr;
-			}
-		}
-	}
-#endif
 
 	/* De-assert reset (let the CPU run) */
 	err = emi62_set_reset(dev,0);
@@ -236,6 +241,10 @@ static int emi62_load_firmware (struct usb_device *dev)
 	}
 	msleep(250);	/* let device settle */
 
+	release_firmware(loader_fw);
+	release_firmware(bitstream_fw);
+	release_firmware(firmware_fw);
+
 	kfree(buf);
 
 	/* return 1 to fail the driver inialization
@@ -243,6 +252,10 @@ static int emi62_load_firmware (struct usb_device *dev)
 	return 1;
 
 wraperr:
+	release_firmware(loader_fw);
+	release_firmware(bitstream_fw);
+	release_firmware(firmware_fw);
+
 	kfree(buf);
 	dev_err(&dev->dev, "Error\n");
 	return err;
@@ -300,5 +313,8 @@ MODULE_AUTHOR("Tapio Laxström");
 MODULE_DESCRIPTION("Emagic EMI 6|2m firmware loader.");
 MODULE_LICENSE("GPL");
 
+MODULE_FIRMWARE("emi62/loader.fw");
+MODULE_FIRMWARE("emi62/bitstream.fw");
+MODULE_FIRMWARE(FIRMWARE_FW);
 /* vi:ai:syntax=c:sw=8:ts=8:tw=80
  */

firmware/Makefile

@@ -29,6 +29,8 @@ fw-shipped-$(CONFIG_SND_YMFPCI) += yamaha/ds1_ctrl.fw yamaha/ds1_dsp.fw \
 				   yamaha/ds1e_ctrl.fw
 fw-shipped-$(CONFIG_USB_EMI26) += emi26/loader.fw emi26/firmware.fw \
 				  emi26/bitstream.fw
+fw-shipped-$(CONFIG_USB_EMI62) += emi62/loader.fw emi62/bitstream.fw \
+				  emi62/spdif.fw emi62/midi.fw
 fw-shipped-$(CONFIG_USB_KAWETH) += kaweth/new_code.bin kaweth/trigger_code.bin \
 				   kaweth/new_code_fix.bin \
 				   kaweth/trigger_code_fix.bin

firmware/WHENCE

@@ -167,3 +167,26 @@ Original licence information:
  */
 
 --------------------------------------------------------------------------
+
+Driver: emi62 -- EMI 6|2m USB Audio interface
+
+File: emi62/bitstream.fw
+Info: VERSION=1.0.0.191 DATE= 2002oct28
+
+File: emi62/loader.fw
+Source: EMILOAD.HEX
+Info: VERSION=1.0.2.002 DATE=10.01.2002
+
+File: emi62/midi.fw
+Source: EMI62MFW.HEX
+Info: VERSION=1.04.062 DATE=16.10.2002
+
+File: emi62/spdif.fw
+Source: EMI62SFW.HEX
+Info: VERSION=1.04.062 DATE=16.10.2002
+
+Converted from Intel HEX files, used in our binary representation of ihex.
+
+Original licence information: None
+
+--------------------------------------------------------------------------

firmware/emi62/loader.HEX

@@ -0,0 +1,107 @@
+:0300000002028772
+:03004300020400B4
+:10010000E4FFFEC220D2E843D820907FAB74FFF01A
+:10011000907FA9F0907FAAF05391EF907F9574C0E3
+:10012000F0907F9EF0907F98F0E4907F94F0907F25
+:100130009D74FFF0907F9774A0F0907F93E054FC43
+:10014000F0907F9C7403F0E4907F96F0907FAFE096
+:100150004401F0907FAEE0440DF0D2AF0FBF00013C
+:100160000EBE07F8BF08F520204275140075130075
+:100170007512007511007F487E927D007C00AB14E3
+:10018000AA13A912A811C31203ED50DB2020D87ABC
+:100190000079007800E5142401F514EA3513F5130D
+:1001A000E93512F512E83511F51180CA3020FD123B
+:1001B00001C75007907FB4E04401F0907FB4E04461
+:0601C00002F0C22080E6FF
+:0101C6002216
+:1001C700907FE9E0245B606024026003020285906F
+:1001D7007FEAE0750A00F50BA3E0FEE4EE420A9021
+:1001E7007FEEE0751500F516A3E0FEE4EE4215E597
+:1001F7001645157003020285E4907FC5F0907FB421
+:10020700E020E3F9907FC5E0F50C120313AF0C7EF5
+:1002170000EF250BF50BEE350AF50AC3E5169FF53A
+:1002270016E5159EF51580C7907FEAE0750A00F57B
+:100237000BA3E0FEE4EE420A907FEEE0751500F5B1
+:1002470016A3E0FEE4EE4215E51645156030E4908E
+:100257007FC5F0907FB4E020E3F9907FC5E0F50C0F
+:1002670012032BAF0C7E00EF250BF50BEE350AF5CD
+:0F0277000AC3E5169FF516E5159EF51580CAC357
+:010286002255
+:0C028700787FE4F6D8FD7581290202CED4
+:10029300020100E493A3F8E493A34003F68001F280
+:1002A30008DFF48029E493A3F85407240CC8C3336C
+:1002B300C4540F4420C8834004F456800146F6DF3B
+:1002C300E4800B010204081020408090046EE47E59
+:1002D300019360BCA3FF543F30E509541FFEE49330
+:1002E300A360010ECF54C025E060A840B8E493A3F7
+:1002F300FAE493A3F8E493A3C8C582C8CAC583CA22
+:10030300F0A3C8C582C8CAC583CADFE9DEE780BED9
+:10031300E50CFFE50BF582E50AF58375927E74C063
+:08032300F8E208F0A3DFFA2262
+:10032B00907F96858392A8827902900000E0B400BA
+:10033B000D7401F0907F97E0547FF04480F0E50C52
+:10034B00FF907EC0E0F528E4A24733F269F2E4A205
+:10035B004633F269F2E4A24533F269F2E4A2443384
+:10036B00F269F2E4A24333F269F2E4A24233F26996
+:10037B00F2E4A24133F269F2E4A24033F269F2A350
+:03038B00DFC222AC
+:10038E00C0E0C083C082907FC4E4F05391EF907FB1
+:0B039E00AB7404F0D082D083D0E032BA
+:1003A900C0E0C083C082D2205391EF907FAB74012B
+:0803B900F0D082D083D0E032C5
+:1003C100C0E0C083C0825391EF907FAB7402F0D044
+:0603D10082D083D0E0326F
+:1003D700C0E0C083C0825391EF907FAB7410F0D020
+:0603E70082D083D0E03259
+:1003ED00EB9FF5F0EA9E42F0E99D42F0E89C45F066
+:0103FD0022DD
+:0103FE0032CC
+:0103FF0032CB
+:100400000203A9000203C10002038E000204580087
+:100410000203D7000203FE000203FF00020484006F
+:10042000020485000204860002048700020488009A
+:100430000204890002048A0002048B0002048C007A
+:1004400002048D0002048E0002048F00020490005A
+:08045000020491000204920075
+:10045800C0E0C083C0825391EF907FAB7408F0D0A6
+:0604680082D083D0E032D7
+:10046E00020A000F010C11040D00000000410000F3
+:01047E00007D
+:04047F000217000060
+:010483000078
+:010484003245
+:010485003244
+:010486003243
+:010487003242
+:010488003241
+:010489003240
+:01048A00323F
+:01048B00323E
+:01048C00323D
+:01048D00323C
+:01048E00323B
+:01048F00323A
+:010490003239
+:010491003238
+:010492003237
+:1011000012011001000000406A0801010001010203
+:10111000000109022000010103A0000904000002EF
+:10112000FF0000040705820240000007050202409C
+:10113000000004030904260341006E0063006800F8
+:101140006F007200200043006800690070007300A7
+:101150002C00200049006E0063002E00280346008A
+:10116000690072006D007700610072006500200068
+:101170004600720061006D00650057006F0072004C
+:101180006B0073002A0343006F006E006600690065
+:101190006700750072006100740069006F006E00E6
+:1011A000200053007400720069006E006700220383
+:1011B00049006E0074006500720066006100630003
+:1011C0006500200053007400720069006E00670023
+:0211D00000001D
+:00000001FF
+/*
+Source: EMILOAD.HEX
+VERSION=1.0.2.002
+DATE=10.01.2002
+EMI26_62
+*/