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

// SPDX-License-Identifier: GPL-2.0
/*
 * EZ-USB specific functions used by some of the USB to Serial drivers.
 *
 * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
 */

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/usb.h>
#include <linux/firmware.h>
#include <linux/ihex.h>
#include <linux/usb/ezusb.h>

struct ezusb_fx_type {
	/* EZ-USB Control and Status Register.  Bit 0 controls 8051 reset */
	unsigned short cpucs_reg;
	unsigned short max_internal_adress;
};

static const struct ezusb_fx_type ezusb_fx1 = {
	.cpucs_reg = 0x7F92,
	.max_internal_adress = 0x1B3F,
};

/* Commands for writing to memory */
#define WRITE_INT_RAM 0xA0
#define WRITE_EXT_RAM 0xA3

static int ezusb_writememory(struct usb_device *dev, int address,
				unsigned char *data, int length, __u8 request)
{
	int result;
	unsigned char *transfer_buffer;

	if (!dev)
		return -ENODEV;

	transfer_buffer = kmemdup(data, length, GFP_KERNEL);
	if (!transfer_buffer) {
		dev_err(&dev->dev, "%s - kmalloc(%d) failed.\n",
							__func__, length);
		return -ENOMEM;
	}
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
				 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
				 address, 0, transfer_buffer, length, 3000);

	kfree(transfer_buffer);
	return result;
}

static int ezusb_set_reset(struct usb_device *dev, unsigned short cpucs_reg,
			   unsigned char reset_bit)
{
	int response = ezusb_writememory(dev, cpucs_reg, &reset_bit, 1, WRITE_INT_RAM);
	if (response < 0)
		dev_err(&dev->dev, "%s-%d failed: %d\n",
						__func__, reset_bit, response);
	return response;
}

int ezusb_fx1_set_reset(struct usb_device *dev, unsigned char reset_bit)
{
	return ezusb_set_reset(dev, ezusb_fx1.cpucs_reg, reset_bit);
}
EXPORT_SYMBOL_GPL(ezusb_fx1_set_reset);

static int ezusb_ihex_firmware_download(struct usb_device *dev,
					struct ezusb_fx_type fx,
					const char *firmware_path)
{
	int ret = -ENOENT;
	const struct firmware *firmware = NULL;
	const struct ihex_binrec *record;

	if (request_ihex_firmware(&firmware, firmware_path,
				  &dev->dev)) {
		dev_err(&dev->dev,
			"%s - request \"%s\" failed\n",
			__func__, firmware_path);
		goto out;
	}

	ret = ezusb_set_reset(dev, fx.cpucs_reg, 0);
	if (ret < 0)
		goto out;

	record = (const struct ihex_binrec *)firmware->data;
	for (; record; record = ihex_next_binrec(record)) {
		if (be32_to_cpu(record->addr) > fx.max_internal_adress) {
			ret = ezusb_writememory(dev, be32_to_cpu(record->addr),
						(unsigned char *)record->data,
						be16_to_cpu(record->len), WRITE_EXT_RAM);
			if (ret < 0) {
				dev_err(&dev->dev, "%s - ezusb_writememory "
					"failed writing internal memory "
					"(%d %04X %p %d)\n", __func__, ret,
					be32_to_cpu(record->addr), record->data,
					be16_to_cpu(record->len));
				goto out;
			}
		}
	}

	ret = ezusb_set_reset(dev, fx.cpucs_reg, 1);
	if (ret < 0)
		goto out;
	record = (const struct ihex_binrec *)firmware->data;
	for (; record; record = ihex_next_binrec(record)) {
		if (be32_to_cpu(record->addr) <= fx.max_internal_adress) {
			ret = ezusb_writememory(dev, be32_to_cpu(record->addr),
						(unsigned char *)record->data,
						be16_to_cpu(record->len), WRITE_INT_RAM);
			if (ret < 0) {
				dev_err(&dev->dev, "%s - ezusb_writememory "
					"failed writing external memory "
					"(%d %04X %p %d)\n", __func__, ret,
					be32_to_cpu(record->addr), record->data,
					be16_to_cpu(record->len));
				goto out;
			}
		}
	}
	ret = ezusb_set_reset(dev, fx.cpucs_reg, 0);
out:
	release_firmware(firmware);
	return ret;
}

int ezusb_fx1_ihex_firmware_download(struct usb_device *dev,
				     const char *firmware_path)
{
	return ezusb_ihex_firmware_download(dev, ezusb_fx1, firmware_path);
}
EXPORT_SYMBOL_GPL(ezusb_fx1_ihex_firmware_download);

#if 0
/*
 * Once someone one needs these fx2 functions, uncomment them
 * and add them to ezusb.h and all should be good.
 */
static struct ezusb_fx_type ezusb_fx2 = {
	.cpucs_reg = 0xE600,
	.max_internal_adress = 0x3FFF,
};

int ezusb_fx2_set_reset(struct usb_device *dev, unsigned char reset_bit)
{
	return ezusb_set_reset(dev, ezusb_fx2.cpucs_reg, reset_bit);
}
EXPORT_SYMBOL_GPL(ezusb_fx2_set_reset);

int ezusb_fx2_ihex_firmware_download(struct usb_device *dev,
				     const char *firmware_path)
{
	return ezusb_ihex_firmware_download(dev, ezusb_fx2, firmware_path);
}
EXPORT_SYMBOL_GPL(ezusb_fx2_ihex_firmware_download);
#endif

MODULE_LICENSE("GPL");
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0
1da177e4 LT	2	/*
	3	* EZ-USB specific functions used by some of the USB to Serial drivers.
	4	*
	5	* Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
1da177e4 LT	6	*/
1da177e4 LT	7
1da177e4	8	#include <linux/kernel.h>
1da177e4	9	#include <linux/slab.h>
1da177e4 LT	10	#include <linux/module.h>
1da177e4 LT	11	#include <linux/usb.h>
8d733e26 RB	12	#include <linux/firmware.h>
8d733e26 RB	13	#include <linux/ihex.h>
c30186e5	14	#include <linux/usb/ezusb.h>
1da177e4	15
cc183e2a RB	16	struct ezusb_fx_type {
	17	/* EZ-USB Control and Status Register. Bit 0 controls 8051 reset */
	18	unsigned short cpucs_reg;
	19	unsigned short max_internal_adress;
	20	};
1da177e4	21
36ae6776	22	static const struct ezusb_fx_type ezusb_fx1 = {
cc183e2a RB	23	.cpucs_reg = 0x7F92,
	24	.max_internal_adress = 0x1B3F,
	25	};
	26
cc183e2a	27	/* Commands for writing to memory */
99495c70	28	#define WRITE_INT_RAM 0xA0
cc183e2a	29	#define WRITE_EXT_RAM 0xA3
99495c70	30
c30186e5	31	static int ezusb_writememory(struct usb_device *dev, int address,
80359a9c	32	unsigned char *data, int length, __u8 request)
1da177e4 LT	33	{
	34	int result;
	35	unsigned char *transfer_buffer;
	36
c6ab0158	37	if (!dev)
1da177e4	38	return -ENODEV;
1da177e4	39
5d7efe5b	40	transfer_buffer = kmemdup(data, length, GFP_KERNEL);
1da177e4	41	if (!transfer_buffer) {
99495c70	42	dev_err(&dev->dev, "%s - kmalloc(%d) failed.\n",
80359a9c	43	__func__, length);
1da177e4 LT	44	return -ENOMEM;
1da177e4 LT	45	}
99495c70 RB	46	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
	47	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	48	address, 0, transfer_buffer, length, 3000);
	49
80359a9c	50	kfree(transfer_buffer);
1da177e4 LT	51	return result;
	52	}
	53
c30186e5 GKH	54	static int ezusb_set_reset(struct usb_device *dev, unsigned short cpucs_reg,
c30186e5 GKH	55	unsigned char reset_bit)
1da177e4	56	{
cc183e2a	57	int response = ezusb_writememory(dev, cpucs_reg, &reset_bit, 1, WRITE_INT_RAM);
1da177e4	58	if (response < 0)
99495c70 RB	59	dev_err(&dev->dev, "%s-%d failed: %d\n",
99495c70 RB	60	__func__, reset_bit, response);
1da177e4 LT	61	return response;
1da177e4 LT	62	}
1da177e4	63
cc183e2a RB	64	int ezusb_fx1_set_reset(struct usb_device *dev, unsigned char reset_bit)
	65	{
	66	return ezusb_set_reset(dev, ezusb_fx1.cpucs_reg, reset_bit);
	67	}
	68	EXPORT_SYMBOL_GPL(ezusb_fx1_set_reset);
	69
8d733e26 RB	70	static int ezusb_ihex_firmware_download(struct usb_device *dev,
	71	struct ezusb_fx_type fx,
	72	const char *firmware_path)
	73	{
	74	int ret = -ENOENT;
	75	const struct firmware *firmware = NULL;
	76	const struct ihex_binrec *record;
	77
	78	if (request_ihex_firmware(&firmware, firmware_path,
	79	&dev->dev)) {
	80	dev_err(&dev->dev,
	81	"%s - request \"%s\" failed\n",
	82	__func__, firmware_path);
	83	goto out;
	84	}
	85
	86	ret = ezusb_set_reset(dev, fx.cpucs_reg, 0);
	87	if (ret < 0)
	88	goto out;
	89
	90	record = (const struct ihex_binrec *)firmware->data;
	91	for (; record; record = ihex_next_binrec(record)) {
	92	if (be32_to_cpu(record->addr) > fx.max_internal_adress) {
	93	ret = ezusb_writememory(dev, be32_to_cpu(record->addr),
	94	(unsigned char *)record->data,
	95	be16_to_cpu(record->len), WRITE_EXT_RAM);
	96	if (ret < 0) {
	97	dev_err(&dev->dev, "%s - ezusb_writememory "
	98	"failed writing internal memory "
	99	"(%d %04X %p %d)\n", __func__, ret,
	100	be32_to_cpu(record->addr), record->data,
	101	be16_to_cpu(record->len));
	102	goto out;
	103	}
	104	}
	105	}
	106
	107	ret = ezusb_set_reset(dev, fx.cpucs_reg, 1);
	108	if (ret < 0)
	109	goto out;
	110	record = (const struct ihex_binrec *)firmware->data;
	111	for (; record; record = ihex_next_binrec(record)) {
	112	if (be32_to_cpu(record->addr) <= fx.max_internal_adress) {
	113	ret = ezusb_writememory(dev, be32_to_cpu(record->addr),
	114	(unsigned char *)record->data,
	115	be16_to_cpu(record->len), WRITE_INT_RAM);
	116	if (ret < 0) {
	117	dev_err(&dev->dev, "%s - ezusb_writememory "
	118	"failed writing external memory "
	119	"(%d %04X %p %d)\n", __func__, ret,
	120	be32_to_cpu(record->addr), record->data,
	121	be16_to_cpu(record->len));
	122	goto out;
	123	}
	124	}
	125	}
	126	ret = ezusb_set_reset(dev, fx.cpucs_reg, 0);
	127	out:
	128	release_firmware(firmware);
	129	return ret;
	130	}
	131
	132	int ezusb_fx1_ihex_firmware_download(struct usb_device *dev,
	133	const char *firmware_path)
134	{
135	return ezusb_ihex_firmware_download(dev, ezusb_fx1, firmware_path);
136	}
137	EXPORT_SYMBOL_GPL(ezusb_fx1_ihex_firmware_download);
138
c30186e5 GKH	139	#if 0
	140	/*
	141	* Once someone one needs these fx2 functions, uncomment them
	142	* and add them to ezusb.h and all should be good.
	143	*/
	144	static struct ezusb_fx_type ezusb_fx2 = {
	145	.cpucs_reg = 0xE600,
	146	.max_internal_adress = 0x3FFF,
	147	};
	148
	149	int ezusb_fx2_set_reset(struct usb_device *dev, unsigned char reset_bit)
	150	{
	151	return ezusb_set_reset(dev, ezusb_fx2.cpucs_reg, reset_bit);
	152	}
	153	EXPORT_SYMBOL_GPL(ezusb_fx2_set_reset);
	154
8d733e26 RB	155	int ezusb_fx2_ihex_firmware_download(struct usb_device *dev,
	156	const char *firmware_path)
	157	{
	158	return ezusb_ihex_firmware_download(dev, ezusb_fx2, firmware_path);
	159	}
	160	EXPORT_SYMBOL_GPL(ezusb_fx2_ihex_firmware_download);
c30186e5	161	#endif
8d733e26	162
197ef5ef	163	MODULE_LICENSE("GPL");