[mirror_ubuntu-artful-kernel.git] / drivers / usb / misc / emi26.c

/* 
 * Emagic EMI 2|6 usb audio interface firmware loader.
 * Copyright (C) 2002
 * 	Tapio Laxström (tapio.laxstrom@iptime.fi)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, as published by
 * the Free Software Foundation, version 2.
 * 
 * emi26.c,v 1.13 2002/03/08 13:10:26 tapio Exp
 */
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/usb.h>
#include <linux/delay.h>
#include <linux/firmware.h>
#include <linux/ihex.h>

#define EMI26_VENDOR_ID 		0x086a  /* Emagic Soft-und Hardware GmBH */
#define EMI26_PRODUCT_ID		0x0100	/* EMI 2|6 without firmware */
#define EMI26B_PRODUCT_ID		0x0102	/* EMI 2|6 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 emi26_writememory( struct usb_device *dev, int address,
			      const unsigned char *data, int length,
			      __u8 bRequest);
static int emi26_set_reset(struct usb_device *dev, unsigned char reset_bit);
static int emi26_load_firmware (struct usb_device *dev);
static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id);
static void emi26_disconnect(struct usb_interface *intf);

/* thanks to drivers/usb/serial/keyspan_pda.c code */
static int emi26_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 emi26_set_reset (struct usb_device *dev, unsigned char reset_bit)
{
	int response;
	dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
	/* printk(KERN_DEBUG "%s - %d", __func__, reset_bit); */
	response = emi26_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 emi26_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;

	buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
	if (!buf)
		goto wraperr;

	err = request_ihex_firmware(&loader_fw, "emi26/loader.fw", &dev->dev);
	if (err)
		goto nofw;

	err = request_ihex_firmware(&bitstream_fw, "emi26/bitstream.fw",
				    &dev->dev);
	if (err)
		goto nofw;

	err = request_ihex_firmware(&firmware_fw, "emi26/firmware.fw",
				    &dev->dev);
	if (err) {
	nofw:
		dev_err(&dev->dev, "%s - request_firmware() failed\n",
			__func__);
		goto wraperr;
	}

	/* Assert reset (stop the CPU in the EMI) */
	err = emi26_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 = emi26_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 = emi26_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 = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
		if (err < 0)
			goto wraperr;
	} while (rec);

	/* Assert reset (stop the CPU in the EMI) */
	err = emi26_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 = emi26_writememory(dev, be32_to_cpu(rec->addr),
					rec->data, be16_to_cpu(rec->len),
					ANCHOR_LOAD_INTERNAL);
		if (err < 0)
			goto wraperr;
	}
	msleep(250);	/* let device settle */

	/* De-assert reset (let the CPU run) */
	err = emi26_set_reset(dev,0);
	if (err < 0)
		goto wraperr;

	/* 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 = emi26_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 = emi26_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 = emi26_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 = emi26_set_reset(dev,0);
	if (err < 0)
		goto wraperr;
	msleep(250);	/* let device settle */

	/* return 1 to fail the driver inialization
	 * and give real driver change to load */
	err = 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);
	return err;
}

static const struct usb_device_id id_table[] = {
	{ USB_DEVICE(EMI26_VENDOR_ID, EMI26_PRODUCT_ID) },
	{ USB_DEVICE(EMI26_VENDOR_ID, EMI26B_PRODUCT_ID) },
	{ }                                             /* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, id_table);

static int emi26_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *dev = interface_to_usbdev(intf);

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

	emi26_load_firmware(dev);

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

static void emi26_disconnect(struct usb_interface *intf)
{
}

static struct usb_driver emi26_driver = {
	.name		= "emi26 - firmware loader",
	.probe		= emi26_probe,
	.disconnect	= emi26_disconnect,
	.id_table	= id_table,
};

module_usb_driver(emi26_driver);

MODULE_AUTHOR("Tapio Laxström");
MODULE_DESCRIPTION("Emagic EMI 2|6 firmware loader.");
MODULE_LICENSE("GPL");

MODULE_FIRMWARE("emi26/loader.fw");
MODULE_FIRMWARE("emi26/bitstream.fw");
MODULE_FIRMWARE("emi26/firmware.fw");
/* vi:ai:syntax=c:sw=8:ts=8:tw=80
 */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Emagic EMI 2\|6 usb audio interface firmware loader.
	3	* Copyright (C) 2002
96de0e25	4	* Tapio Laxström (tapio.laxstrom@iptime.fi)
1da177e4 LT	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>
16c23f7d	18	#include <linux/delay.h>
ae93a55b DW	19	#include <linux/firmware.h>
ae93a55b DW	20	#include <linux/ihex.h>
1da177e4 LT	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
ae93a55b DW	33	static int emi26_writememory( struct usb_device *dev, int address,
	34	const unsigned char *data, int length,
	35	__u8 bRequest);
1da177e4 LT	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);
1da177e4 LT	40
1da177e4 LT	41	/* thanks to drivers/usb/serial/keyspan_pda.c code */
ae93a55b DW	42	static int emi26_writememory (struct usb_device *dev, int address,
	43	const unsigned char *data, int length,
	44	__u8 request)
1da177e4 LT	45	{
1da177e4 LT	46	int result;
5d7efe5b	47	unsigned char *buffer = kmemdup(data, length, GFP_KERNEL);
1da177e4 LT	48
1da177e4 LT	49	if (!buffer) {
fd3f1917	50	dev_err(&dev->dev, "kmalloc(%d) failed.\n", length);
1da177e4 LT	51	return -ENOMEM;
1da177e4 LT	52	}
1da177e4 LT	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;
1b29a375	64	dev_info(&dev->dev, "%s - %d\n", __func__, reset_bit);
441b62c1	65	/* printk(KERN_DEBUG "%s - %d", __func__, reset_bit); */
1da177e4 LT	66	response = emi26_writememory (dev, CPUCS_REG, &reset_bit, 1, 0xa0);
1da177e4 LT	67	if (response < 0) {
fd3f1917	68	dev_err(&dev->dev, "set_reset (%d) failed\n", reset_bit);
1da177e4 LT	69	}
	70	return response;
	71	}
	72
	73	#define FW_LOAD_SIZE 1023
	74
	75	static int emi26_load_firmware (struct usb_device *dev)
	76	{
ae93a55b DW	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;
b412284b	81	int err = -ENOMEM;
1da177e4	82	int i;
1da177e4 LT	83	__u32 addr; /* Address to write */
	84	__u8 *buf;
	85
	86	buf = kmalloc(FW_LOAD_SIZE, GFP_KERNEL);
b412284b	87	if (!buf)
1da177e4	88	goto wraperr;
1da177e4	89
ae93a55b DW	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:
fd3f1917 GKH	103	dev_err(&dev->dev, "%s - request_firmware() failed\n",
fd3f1917 GKH	104	__func__);
ae93a55b DW	105	goto wraperr;
	106	}
	107
1da177e4 LT	108	/* Assert reset (stop the CPU in the EMI) */
1da177e4 LT	109	err = emi26_set_reset(dev,1);
b412284b	110	if (err < 0)
1da177e4	111	goto wraperr;
1da177e4	112
ae93a55b	113	rec = (const struct ihex_binrec *)loader_fw->data;
1da177e4	114	/* 1. We need to put the loader for the FPGA into the EZ-USB */
ae93a55b DW	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);
b412284b	119	if (err < 0)
1da177e4	120	goto wraperr;
ae93a55b	121	rec = ihex_next_binrec(rec);
1da177e4 LT	122	}
	123
	124	/* De-assert reset (let the CPU run) */
	125	err = emi26_set_reset(dev,0);
b412284b	126	if (err < 0)
cf4cf0bb	127	goto wraperr;
16c23f7d	128	msleep(250); /* let device settle */
1da177e4 LT	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! */
ae93a55b	133	rec = (const struct ihex_binrec *)bitstream_fw->data;
1da177e4 LT	134	do {
1da177e4 LT	135	i = 0;
ae93a55b	136	addr = be32_to_cpu(rec->addr);
1da177e4 LT	137
1da177e4 LT	138	/* intel hex records are terminated with type 0 element */
ae93a55b DW	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);
1da177e4 LT	143	}
1da177e4 LT	144	err = emi26_writememory(dev, addr, buf, i, ANCHOR_LOAD_FPGA);
b412284b	145	if (err < 0)
1da177e4	146	goto wraperr;
327d74f6	147	} while (rec);
1da177e4 LT	148
	149	/* Assert reset (stop the CPU in the EMI) */
	150	err = emi26_set_reset(dev,1);
b412284b	151	if (err < 0)
1da177e4	152	goto wraperr;
1da177e4 LT	153
1da177e4 LT	154	/* 3. We need to put the loader for the firmware into the EZ-USB (again...) */
ae93a55b DW	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);
b412284b	160	if (err < 0)
1da177e4	161	goto wraperr;
1da177e4	162	}
16c23f7d	163	msleep(250); /* let device settle */
1da177e4 LT	164
	165	/* De-assert reset (let the CPU run) */
	166	err = emi26_set_reset(dev,0);
b412284b	167	if (err < 0)
1da177e4	168	goto wraperr;
1da177e4 LT	169
1da177e4 LT	170	/* 4. We put the part of the firmware that lies in the external RAM into the EZ-USB */
ae93a55b DW	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);
b412284b	178	if (err < 0)
1da177e4	179	goto wraperr;
1da177e4 LT	180	}
1da177e4 LT	181	}
b412284b	182
1da177e4 LT	183	/* Assert reset (stop the CPU in the EMI) */
1da177e4 LT	184	err = emi26_set_reset(dev,1);
b412284b	185	if (err < 0)
1da177e4	186	goto wraperr;
1da177e4	187
ae93a55b DW	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);
b412284b	194	if (err < 0)
1da177e4	195	goto wraperr;
1da177e4 LT	196	}
	197	}
	198
	199	/* De-assert reset (let the CPU run) */
	200	err = emi26_set_reset(dev,0);
b412284b	201	if (err < 0)
1da177e4	202	goto wraperr;
16c23f7d	203	msleep(250); /* let device settle */
1da177e4 LT	204
	205	/* return 1 to fail the driver inialization
	206	* and give real driver change to load */
	207	err = 1;
	208
	209	wraperr:
b412284b GKH	210	if (err < 0)
	211	dev_err(&dev->dev,"%s - error loading firmware: error = %d\n",
	212	__func__, err);
	213
ae93a55b DW	214	release_firmware(loader_fw);
	215	release_firmware(bitstream_fw);
	216	release_firmware(firmware_fw);
	217
1da177e4 LT	218	kfree(buf);
	219	return err;
	220	}
	221
33b9e162	222	static const struct usb_device_id id_table[] = {
1da177e4 LT	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
1b29a375	234	dev_info(&intf->dev, "%s start\n", __func__);
1da177e4 LT	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 = {
1da177e4 LT	247	.name = "emi26 - firmware loader",
	248	.probe = emi26_probe,
	249	.disconnect = emi26_disconnect,
	250	.id_table = id_table,
	251	};
	252
65db4305	253	module_usb_driver(emi26_driver);
1da177e4	254
96de0e25	255	MODULE_AUTHOR("Tapio Laxström");
1da177e4 LT	256	MODULE_DESCRIPTION("Emagic EMI 2\|6 firmware loader.");
	257	MODULE_LICENSE("GPL");
	258
ae93a55b DW	259	MODULE_FIRMWARE("emi26/loader.fw");
	260	MODULE_FIRMWARE("emi26/bitstream.fw");
	261	MODULE_FIRMWARE("emi26/firmware.fw");
1da177e4 LT	262	/* vi:ai:syntax=c:sw=8:ts=8:tw=80
1da177e4 LT	263	*/