[linux-2.6-block.git] / drivers / usb / misc / emi62.c

// SPDX-License-Identifier: GPL-2.0
/* 
 * Emagic EMI 2|6 usb audio interface firmware loader.
 * Copyright (C) 2002
 * 	Tapio Laxström (tapio.laxstrom@iptime.fi)
 */
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/usb.h>
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/ihex.h>

/* include firmware (variables)*/

/* FIXME: This is quick and dirty solution! */
#define SPDIF	/* if you want SPDIF comment next line */
//#undef SPDIF	/* if you want MIDI uncomment this line */ 

#ifdef SPDIF
#define FIRMWARE_FW "emi62/spdif.fw"
#else
#define FIRMWARE_FW "emi62/midi.fw"
#endif

#define EMI62_VENDOR_ID 		0x086a  /* Emagic Soft-und Hardware GmBH */
#define EMI62_PRODUCT_ID		0x0110	/* EMI 6|2m without firmware */

#define ANCHOR_LOAD_INTERNAL	0xA0	/* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
#define ANCHOR_LOAD_EXTERNAL	0xA3	/* This command is not implemented in the core. Requires firmware */
#define ANCHOR_LOAD_FPGA	0xA5	/* This command is not implemented in the core. Requires firmware. Emagic extension */
#define MAX_INTERNAL_ADDRESS	0x1B3F	/* This is the highest internal RAM address for the AN2131Q */
#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,
			     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);
static void emi62_disconnect(struct usb_interface *intf);

/* thanks to drivers/usb/serial/keyspan_pda.c code */
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);

	if (!buffer) {
		dev_err(&dev->dev, "kmalloc(%d) failed.\n", length);
		return -ENOMEM;
	}
	/* Note: usb_control_msg returns negative value on error or length of the
	 * 		 data that was written! */
	result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
	kfree (buffer);
	return result;
}

/* thanks to drivers/usb/serial/keyspan_pda.c code */
static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
{
	int response;
	dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
	
	response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
	if (response < 0)
		dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit);
	return response;
}

#define FW_LOAD_SIZE		1023

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 = -ENOMEM;
	int i;
	__u32 addr;	/* Address to write */
	__u8 *buf;

	dev_dbg(&dev->dev, "load_firmware\n");
	buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
	if (!buf)
		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:
		goto wraperr;
	}

	/* Assert reset (stop the CPU in the EMI) */
	err = emi62_set_reset(dev,1);
	if (err < 0)
		goto wraperr;

	rec = (const struct ihex_binrec *)loader_fw->data;

	/* 1. We need to put the loader for the FPGA into the EZ-USB */
	while (rec) {
		err = emi62_writememory(dev, be32_to_cpu(rec->addr),
					rec->data, be16_to_cpu(rec->len),
					ANCHOR_LOAD_INTERNAL);
		if (err < 0)
			goto wraperr;
		rec = ihex_next_binrec(rec);
	}

	/* De-assert reset (let the CPU run) */
	err = emi62_set_reset(dev,0);
	if (err < 0)
		goto wraperr;
	msleep(250);	/* let device settle */

	/* 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 = be32_to_cpu(rec->addr);

		/* intel hex records are terminated with type 0 element */
		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)
			goto wraperr;
	} while (rec);

	/* Assert reset (stop the CPU in the EMI) */
	err = emi62_set_reset(dev,1);
	if (err < 0)
		goto wraperr;

	/* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
	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)
			goto wraperr;
	}

	/* De-assert reset (let the CPU run) */
	err = emi62_set_reset(dev,0);
	if (err < 0)
		goto wraperr;
	msleep(250);	/* let device settle */

	/* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */

	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)
				goto wraperr;
		}
	}

	/* Assert reset (stop the CPU in the EMI) */
	err = emi62_set_reset(dev,1);
	if (err < 0)
		goto wraperr;

	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)
				goto wraperr;
		}
	}

	/* De-assert reset (let the CPU run) */
	err = emi62_set_reset(dev,0);
	if (err < 0)
		goto wraperr;
	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
	 * and give real driver change to load */
	return 1;

wraperr:
	if (err < 0)
		dev_err(&dev->dev,"%s - error loading firmware: error = %d\n",
			__func__, err);
	release_firmware(loader_fw);
	release_firmware(bitstream_fw);
	release_firmware(firmware_fw);

	kfree(buf);
	dev_err(&dev->dev, "Error\n");
	return err;
}

static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
	{ }                                             /* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, id_table);

static int emi62_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *dev = interface_to_usbdev(intf);
	dev_dbg(&intf->dev, "emi62_probe\n");

	dev_info(&intf->dev, "%s start\n", __func__);

	emi62_load_firmware(dev);

	/* do not return the driver context, let real audio driver do that */
	return -EIO;
}

static void emi62_disconnect(struct usb_interface *intf)
{
}

static struct usb_driver emi62_driver = {
	.name		= "emi62 - firmware loader",
	.probe		= emi62_probe,
	.disconnect	= emi62_disconnect,
	.id_table	= id_table,
};

module_usb_driver(emi62_driver);

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
 */
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0
1da177e4 LT	2	/*
	3	* Emagic EMI 2\|6 usb audio interface firmware loader.
	4	* Copyright (C) 2002
96de0e25	5	* Tapio Laxström (tapio.laxstrom@iptime.fi)
1da177e4 LT	6	*/
	7	#include <linux/kernel.h>
	8	#include <linux/errno.h>
	9	#include <linux/slab.h>
1da177e4 LT	10	#include <linux/module.h>
1da177e4 LT	11	#include <linux/usb.h>
16c23f7d	12	#include <linux/delay.h>
b8e24bfa DW	13	#include <linux/firmware.h>
b8e24bfa DW	14	#include <linux/ihex.h>
1da177e4 LT	15
	16	/* include firmware (variables)*/
	17
	18	/* FIXME: This is quick and dirty solution! */
	19	#define SPDIF /* if you want SPDIF comment next line */
	20	//#undef SPDIF /* if you want MIDI uncomment this line */
	21
	22	#ifdef SPDIF
b8e24bfa	23	#define FIRMWARE_FW "emi62/spdif.fw"
1da177e4	24	#else
b8e24bfa	25	#define FIRMWARE_FW "emi62/midi.fw"
1da177e4 LT	26	#endif
	27
	28	#define EMI62_VENDOR_ID 0x086a /* Emagic Soft-und Hardware GmBH */
	29	#define EMI62_PRODUCT_ID 0x0110 /* EMI 6\|2m without firmware */
	30
	31	#define ANCHOR_LOAD_INTERNAL 0xA0 /* Vendor specific request code for Anchor Upload/Download (This one is implemented in the core) */
	32	#define ANCHOR_LOAD_EXTERNAL 0xA3 /* This command is not implemented in the core. Requires firmware */
	33	#define ANCHOR_LOAD_FPGA 0xA5 /* This command is not implemented in the core. Requires firmware. Emagic extension */
	34	#define MAX_INTERNAL_ADDRESS 0x1B3F /* This is the highest internal RAM address for the AN2131Q */
	35	#define CPUCS_REG 0x7F92 /* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */
	36	#define INTERNAL_RAM(address) (address <= MAX_INTERNAL_ADDRESS)
	37
b8e24bfa DW	38	static int emi62_writememory(struct usb_device *dev, int address,
	39	const unsigned char *data, int length,
	40	__u8 bRequest);
1da177e4 LT	41	static int emi62_set_reset(struct usb_device *dev, unsigned char reset_bit);
	42	static int emi62_load_firmware (struct usb_device *dev);
	43	static int emi62_probe(struct usb_interface intf, const struct usb_device_id id);
	44	static void emi62_disconnect(struct usb_interface *intf);
1da177e4 LT	45
1da177e4 LT	46	/* thanks to drivers/usb/serial/keyspan_pda.c code */
b8e24bfa DW	47	static int emi62_writememory(struct usb_device *dev, int address,
	48	const unsigned char *data, int length,
	49	__u8 request)
1da177e4 LT	50	{
1da177e4 LT	51	int result;
5d7efe5b	52	unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
1da177e4 LT	53
1da177e4 LT	54	if (!buffer) {
e9a527da	55	dev_err(&dev->dev, "kmalloc(%d) failed.\n", length);
1da177e4 LT	56	return -ENOMEM;
1da177e4 LT	57	}
1da177e4 LT	58	/* Note: usb_control_msg returns negative value on error or length of the
	59	* data that was written! */
	60	result = usb_control_msg (dev, usb_sndctrlpipe(dev, 0), request, 0x40, address, 0, buffer, length, 300);
	61	kfree (buffer);
	62	return result;
	63	}
	64
	65	/* thanks to drivers/usb/serial/keyspan_pda.c code */
	66	static int emi62_set_reset (struct usb_device *dev, unsigned char reset_bit)
	67	{
	68	int response;
1b29a375	69	dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
1da177e4 LT	70
1da177e4 LT	71	response = emi62_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
e9a527da GKH	72	if (response < 0)
e9a527da GKH	73	dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit);
1da177e4 LT	74	return response;
	75	}
	76
	77	#define FW_LOAD_SIZE 1023
	78
	79	static int emi62_load_firmware (struct usb_device *dev)
	80	{
b8e24bfa DW	81	const struct firmware *loader_fw = NULL;
	82	const struct firmware *bitstream_fw = NULL;
	83	const struct firmware *firmware_fw = NULL;
	84	const struct ihex_binrec *rec;
e9a527da	85	int err = -ENOMEM;
1da177e4	86	int i;
1da177e4 LT	87	__u32 addr; /* Address to write */
	88	__u8 *buf;
	89
	90	dev_dbg(&dev->dev, "load_firmware\n");
	91	buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
e9a527da	92	if (!buf)
1da177e4	93	goto wraperr;
1da177e4	94
b8e24bfa DW	95	err = request_ihex_firmware(&loader_fw, "emi62/loader.fw", &dev->dev);
	96	if (err)
	97	goto nofw;
	98
	99	err = request_ihex_firmware(&bitstream_fw, "emi62/bitstream.fw",
	100	&dev->dev);
	101	if (err)
	102	goto nofw;
	103
	104	err = request_ihex_firmware(&firmware_fw, FIRMWARE_FW, &dev->dev);
	105	if (err) {
	106	nofw:
b8e24bfa DW	107	goto wraperr;
	108	}
	109
1da177e4 LT	110	/* Assert reset (stop the CPU in the EMI) */
1da177e4 LT	111	err = emi62_set_reset(dev,1);
e9a527da	112	if (err < 0)
1da177e4	113	goto wraperr;
1da177e4	114
b8e24bfa DW	115	rec = (const struct ihex_binrec *)loader_fw->data;
b8e24bfa DW	116
1da177e4	117	/* 1. We need to put the loader for the FPGA into the EZ-USB */
b8e24bfa DW	118	while (rec) {
	119	err = emi62_writememory(dev, be32_to_cpu(rec->addr),
	120	rec->data, be16_to_cpu(rec->len),
	121	ANCHOR_LOAD_INTERNAL);
e9a527da	122	if (err < 0)
1da177e4	123	goto wraperr;
b8e24bfa	124	rec = ihex_next_binrec(rec);
1da177e4 LT	125	}
	126
	127	/* De-assert reset (let the CPU run) */
	128	err = emi62_set_reset(dev,0);
e9a527da	129	if (err < 0)
5919a43b	130	goto wraperr;
16c23f7d	131	msleep(250); /* let device settle */
1da177e4 LT	132
	133	/* 2. We upload the FPGA firmware into the EMI
	134	* Note: collect up to 1023 (yes!) bytes and send them with
	135	* a single request. This is _much_ faster! */
b8e24bfa	136	rec = (const struct ihex_binrec *)bitstream_fw->data;
1da177e4 LT	137	do {
1da177e4 LT	138	i = 0;
b8e24bfa	139	addr = be32_to_cpu(rec->addr);
1da177e4 LT	140
1da177e4 LT	141	/* intel hex records are terminated with type 0 element */
b8e24bfa DW	142	while (rec && (i + be16_to_cpu(rec->len) < FW_LOAD_SIZE)) {
	143	memcpy(buf + i, rec->data, be16_to_cpu(rec->len));
	144	i += be16_to_cpu(rec->len);
	145	rec = ihex_next_binrec(rec);
1da177e4 LT	146	}
1da177e4 LT	147	err = emi62_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
e9a527da	148	if (err < 0)
1da177e4	149	goto wraperr;
ac06c067	150	} while (rec);
1da177e4 LT	151
	152	/* Assert reset (stop the CPU in the EMI) */
	153	err = emi62_set_reset(dev,1);
e9a527da	154	if (err < 0)
1da177e4	155	goto wraperr;
1da177e4 LT	156
1da177e4 LT	157	/* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
b8e24bfa DW	158	for (rec = (const struct ihex_binrec *)loader_fw->data;
	159	rec; rec = ihex_next_binrec(rec)) {
	160	err = emi62_writememory(dev, be32_to_cpu(rec->addr),
	161	rec->data, be16_to_cpu(rec->len),
	162	ANCHOR_LOAD_INTERNAL);
e9a527da	163	if (err < 0)
1da177e4	164	goto wraperr;
1da177e4 LT	165	}
	166
	167	/* De-assert reset (let the CPU run) */
	168	err = emi62_set_reset(dev,0);
e9a527da	169	if (err < 0)
1da177e4	170	goto wraperr;
16c23f7d	171	msleep(250); /* let device settle */
1da177e4 LT	172
	173	/* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
	174
b8e24bfa DW	175	for (rec = (const struct ihex_binrec *)firmware_fw->data;
	176	rec; rec = ihex_next_binrec(rec)) {
	177	if (!INTERNAL_RAM(be32_to_cpu(rec->addr))) {
	178	err = emi62_writememory(dev, be32_to_cpu(rec->addr),
	179	rec->data, be16_to_cpu(rec->len),
	180	ANCHOR_LOAD_EXTERNAL);
e9a527da	181	if (err < 0)
1da177e4	182	goto wraperr;
1da177e4 LT	183	}
1da177e4 LT	184	}
b8e24bfa	185
1da177e4 LT	186	/* Assert reset (stop the CPU in the EMI) */
1da177e4 LT	187	err = emi62_set_reset(dev,1);
e9a527da	188	if (err < 0)
1da177e4	189	goto wraperr;
1da177e4	190
b8e24bfa DW	191	for (rec = (const struct ihex_binrec *)firmware_fw->data;
	192	rec; rec = ihex_next_binrec(rec)) {
	193	if (INTERNAL_RAM(be32_to_cpu(rec->addr))) {
	194	err = emi62_writememory(dev, be32_to_cpu(rec->addr),
	195	rec->data, be16_to_cpu(rec->len),
	196	ANCHOR_LOAD_EXTERNAL);
e9a527da	197	if (err < 0)
1da177e4	198	goto wraperr;
1da177e4 LT	199	}
1da177e4 LT	200	}
b8e24bfa	201
1da177e4 LT	202	/* De-assert reset (let the CPU run) */
1da177e4 LT	203	err = emi62_set_reset(dev,0);
e9a527da	204	if (err < 0)
1da177e4	205	goto wraperr;
16c23f7d	206	msleep(250); /* let device settle */
1da177e4	207
b8e24bfa DW	208	release_firmware(loader_fw);
	209	release_firmware(bitstream_fw);
	210	release_firmware(firmware_fw);
	211
1da177e4 LT	212	kfree(buf);
	213
	214	/* return 1 to fail the driver inialization
	215	* and give real driver change to load */
	216	return 1;
	217
	218	wraperr:
e9a527da GKH	219	if (err < 0)
	220	dev_err(&dev->dev,"%s - error loading firmware: error = %d\n",
	221	__func__, err);
b8e24bfa DW	222	release_firmware(loader_fw);
	223	release_firmware(bitstream_fw);
	224	release_firmware(firmware_fw);
	225
1da177e4 LT	226	kfree(buf);
	227	dev_err(&dev->dev, "Error\n");
	228	return err;
	229	}
	230
83957df2	231	static const struct usb_device_id id_table[] = {
1da177e4 LT	232	{ USB_DEVICE(EMI62_VENDOR_ID, EMI62_PRODUCT_ID) },
	233	{ } /* Terminating entry */
	234	};
	235
	236	MODULE_DEVICE_TABLE (usb, id_table);
	237
	238	static int emi62_probe(struct usb_interface intf, const struct usb_device_id id)
	239	{
	240	struct usb_device *dev = interface_to_usbdev(intf);
	241	dev_dbg(&intf->dev, "emi62_probe\n");
	242
1b29a375	243	dev_info(&intf->dev, "%s start\n", __func__);
1da177e4 LT	244
	245	emi62_load_firmware(dev);
	246
	247	/* do not return the driver context, let real audio driver do that */
	248	return -EIO;
	249	}
	250
	251	static void emi62_disconnect(struct usb_interface *intf)
	252	{
	253	}
	254
	255	static struct usb_driver emi62_driver = {
1da177e4 LT	256	.name = "emi62 - firmware loader",
	257	.probe = emi62_probe,
	258	.disconnect = emi62_disconnect,
	259	.id_table = id_table,
	260	};
	261
65db4305	262	module_usb_driver(emi62_driver);
1da177e4	263
96de0e25	264	MODULE_AUTHOR("Tapio Laxström");
1da177e4 LT	265	MODULE_DESCRIPTION("Emagic EMI 6\|2m firmware loader.");
	266	MODULE_LICENSE("GPL");
	267
b8e24bfa DW	268	MODULE_FIRMWARE("emi62/loader.fw");
	269	MODULE_FIRMWARE("emi62/bitstream.fw");
	270	MODULE_FIRMWARE(FIRMWARE_FW);
1da177e4 LT	271	/* vi:ai:syntax=c:sw=8:ts=8:tw=80
1da177e4 LT	272	*/