[deliverable/linux.git] / drivers / usb / misc / cypress_cy7c63.c

/*
* cypress_cy7c63.c
*
* Copyright (c) 2006-2007 Oliver Bock (bock@tfh-berlin.de)
*
*	This driver is based on the Cypress USB Driver by Marcus Maul
*	(cyport) and the 2.0 version of Greg Kroah-Hartman's
*	USB Skeleton driver.
*
*	This is a generic driver for the Cypress CY7C63xxx family.
*	For the time being it enables you to read from and write to
*	the single I/O ports of the device.
*
*	Supported vendors:	AK Modul-Bus Computer GmbH
*				(Firmware "Port-Chip")
*
*	Supported devices:	CY7C63001A-PC
*				CY7C63001C-PXC
*				CY7C63001C-SXC
*
*	Supported functions:	Read/Write Ports
*
*
*	For up-to-date information please visit:
*	http://www.obock.de/kernel/cypress
*
*	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.
*/

#include <linux/init.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/usb.h>

#define DRIVER_AUTHOR		"Oliver Bock (bock@tfh-berlin.de)"
#define DRIVER_DESC		"Cypress CY7C63xxx USB driver"

#define CYPRESS_VENDOR_ID	0xa2c
#define CYPRESS_PRODUCT_ID	0x8

#define CYPRESS_READ_PORT	0x4
#define CYPRESS_WRITE_PORT	0x5

#define CYPRESS_READ_RAM	0x2
#define CYPRESS_WRITE_RAM	0x3
#define CYPRESS_READ_ROM	0x1

#define CYPRESS_READ_PORT_ID0	0
#define CYPRESS_WRITE_PORT_ID0	0
#define CYPRESS_READ_PORT_ID1	0x2
#define CYPRESS_WRITE_PORT_ID1	1

#define CYPRESS_MAX_REQSIZE	8


/* table of devices that work with this driver */
static const struct usb_device_id cypress_table[] = {
	{ USB_DEVICE(CYPRESS_VENDOR_ID, CYPRESS_PRODUCT_ID) },
	{ }
};
MODULE_DEVICE_TABLE(usb, cypress_table);

/* structure to hold all of our device specific stuff */
struct cypress {
	struct usb_device *	udev;
	unsigned char		port[2];
};

/* used to send usb control messages to device */
static int vendor_command(struct cypress *dev, unsigned char request,
			  unsigned char address, unsigned char data)
{
	int retval = 0;
	unsigned int pipe;
	unsigned char *iobuf;

	/* allocate some memory for the i/o buffer*/
	iobuf = kzalloc(CYPRESS_MAX_REQSIZE, GFP_KERNEL);
	if (!iobuf) {
		dev_err(&dev->udev->dev, "Out of memory!\n");
		retval = -ENOMEM;
		goto error;
	}

	dev_dbg(&dev->udev->dev, "Sending usb_control_msg (data: %d)\n", data);

	/* prepare usb control message and send it upstream */
	pipe = usb_rcvctrlpipe(dev->udev, 0);
	retval = usb_control_msg(dev->udev, pipe, request,
				 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
				 address, data, iobuf, CYPRESS_MAX_REQSIZE,
				 USB_CTRL_GET_TIMEOUT);

	/* store returned data (more READs to be added) */
	switch (request) {
		case CYPRESS_READ_PORT:
			if (address == CYPRESS_READ_PORT_ID0) {
				dev->port[0] = iobuf[1];
				dev_dbg(&dev->udev->dev,
					"READ_PORT0 returned: %d\n",
					dev->port[0]);
			}
			else if (address == CYPRESS_READ_PORT_ID1) {
				dev->port[1] = iobuf[1];
				dev_dbg(&dev->udev->dev,
					"READ_PORT1 returned: %d\n",
					dev->port[1]);
			}
			break;
	}

	kfree(iobuf);
error:
	return retval;
}

/* write port value */
static ssize_t write_port(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t count,
			  int port_num, int write_id)
{
	int value = -1;
	int result = 0;

	struct usb_interface *intf = to_usb_interface(dev);
	struct cypress *cyp = usb_get_intfdata(intf);

	dev_dbg(&cyp->udev->dev, "WRITE_PORT%d called\n", port_num);

	/* validate input data */
	if (sscanf(buf, "%d", &value) < 1) {
		result = -EINVAL;
		goto error;
	}
	if (value < 0 || value > 255) {
		result = -EINVAL;
		goto error;
	}

	result = vendor_command(cyp, CYPRESS_WRITE_PORT, write_id,
				(unsigned char)value);

	dev_dbg(&cyp->udev->dev, "Result of vendor_command: %d\n\n", result);
error:
	return result < 0 ? result : count;
}

/* attribute callback handler (write) */
static ssize_t set_port0_handler(struct device *dev,
				 struct device_attribute *attr,
				 const char *buf, size_t count)
{
	return write_port(dev, attr, buf, count, 0, CYPRESS_WRITE_PORT_ID0);
}

/* attribute callback handler (write) */
static ssize_t set_port1_handler(struct device *dev,
				 struct device_attribute *attr,
				 const char *buf, size_t count)
{
	return write_port(dev, attr, buf, count, 1, CYPRESS_WRITE_PORT_ID1);
}

/* read port value */
static ssize_t read_port(struct device *dev, struct device_attribute *attr,
			 char *buf, int port_num, int read_id)
{
	int result = 0;

	struct usb_interface *intf = to_usb_interface(dev);
	struct cypress *cyp = usb_get_intfdata(intf);

	dev_dbg(&cyp->udev->dev, "READ_PORT%d called\n", port_num);

	result = vendor_command(cyp, CYPRESS_READ_PORT, read_id, 0);

	dev_dbg(&cyp->udev->dev, "Result of vendor_command: %d\n\n", result);

	return sprintf(buf, "%d", cyp->port[port_num]);
}

/* attribute callback handler (read) */
static ssize_t get_port0_handler(struct device *dev,
				 struct device_attribute *attr, char *buf)
{
	return read_port(dev, attr, buf, 0, CYPRESS_READ_PORT_ID0);
}

/* attribute callback handler (read) */
static ssize_t get_port1_handler(struct device *dev,
				 struct device_attribute *attr, char *buf)
{
	return read_port(dev, attr, buf, 1, CYPRESS_READ_PORT_ID1);
}

static DEVICE_ATTR(port0, S_IRUGO | S_IWUSR, get_port0_handler, set_port0_handler);

static DEVICE_ATTR(port1, S_IRUGO | S_IWUSR, get_port1_handler, set_port1_handler);


static int cypress_probe(struct usb_interface *interface,
			 const struct usb_device_id *id)
{
	struct cypress *dev = NULL;
	int retval = -ENOMEM;

	/* allocate memory for our device state and initialize it */
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
	if (dev == NULL) {
		dev_err(&interface->dev, "Out of memory!\n");
		goto error_mem;
	}

	dev->udev = usb_get_dev(interface_to_usbdev(interface));

	/* save our data pointer in this interface device */
	usb_set_intfdata(interface, dev);

	/* create device attribute files */
	retval = device_create_file(&interface->dev, &dev_attr_port0);
	if (retval)
		goto error;
	retval = device_create_file(&interface->dev, &dev_attr_port1);
	if (retval)
		goto error;

	/* let the user know that the device is now attached */
	dev_info(&interface->dev,
		 "Cypress CY7C63xxx device now attached\n");
	return 0;

error:
	device_remove_file(&interface->dev, &dev_attr_port0);
	device_remove_file(&interface->dev, &dev_attr_port1);
	usb_set_intfdata(interface, NULL);
	usb_put_dev(dev->udev);
	kfree(dev);

error_mem:
	return retval;
}

static void cypress_disconnect(struct usb_interface *interface)
{
	struct cypress *dev;

	dev = usb_get_intfdata(interface);

	/* remove device attribute files */
	device_remove_file(&interface->dev, &dev_attr_port0);
	device_remove_file(&interface->dev, &dev_attr_port1);
	/* the intfdata can be set to NULL only after the
	 * device files have been removed */
	usb_set_intfdata(interface, NULL);

	usb_put_dev(dev->udev);

	dev_info(&interface->dev,
		 "Cypress CY7C63xxx device now disconnected\n");

	kfree(dev);
}

static struct usb_driver cypress_driver = {
	.name = "cypress_cy7c63",
	.probe = cypress_probe,
	.disconnect = cypress_disconnect,
	.id_table = cypress_table,
};

module_usb_driver(cypress_driver);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);

MODULE_LICENSE("GPL");
Commit	Line	Data
9189bfc2 OB	1	/*
	2	* cypress_cy7c63.c
	3	*
d09d6a35	4	* Copyright (c) 2006-2007 Oliver Bock (bock@tfh-berlin.de)
9189bfc2 OB	5	*
	6	* This driver is based on the Cypress USB Driver by Marcus Maul
	7	* (cyport) and the 2.0 version of Greg Kroah-Hartman's
	8	* USB Skeleton driver.
	9	*
	10	* This is a generic driver for the Cypress CY7C63xxx family.
	11	* For the time being it enables you to read from and write to
	12	* the single I/O ports of the device.
	13	*
	14	* Supported vendors: AK Modul-Bus Computer GmbH
6ad576bb OB	15	* (Firmware "Port-Chip")
	16	*
	17	* Supported devices: CY7C63001A-PC
	18	* CY7C63001C-PXC
	19	* CY7C63001C-SXC
	20	*
	21	* Supported functions: Read/Write Ports
9189bfc2 OB	22	*
9189bfc2 OB	23	*
d09d6a35 OB	24	* For up-to-date information please visit:
	25	* http://www.obock.de/kernel/cypress
	26	*
9189bfc2 OB	27	* This program is free software; you can redistribute it and/or
	28	* modify it under the terms of the GNU General Public License as
	29	* published by the Free Software Foundation, version 2.
	30	*/
	31
	32	#include <linux/init.h>
	33	#include <linux/module.h>
	34	#include <linux/kernel.h>
5a0e3ad6	35	#include <linux/slab.h>
9189bfc2 OB	36	#include <linux/usb.h>
9189bfc2 OB	37
d09d6a35	38	#define DRIVER_AUTHOR "Oliver Bock (bock@tfh-berlin.de)"
9189bfc2 OB	39	#define DRIVER_DESC "Cypress CY7C63xxx USB driver"
	40
	41	#define CYPRESS_VENDOR_ID 0xa2c
	42	#define CYPRESS_PRODUCT_ID 0x8
	43
	44	#define CYPRESS_READ_PORT 0x4
	45	#define CYPRESS_WRITE_PORT 0x5
	46
	47	#define CYPRESS_READ_RAM 0x2
	48	#define CYPRESS_WRITE_RAM 0x3
	49	#define CYPRESS_READ_ROM 0x1
	50
	51	#define CYPRESS_READ_PORT_ID0 0
	52	#define CYPRESS_WRITE_PORT_ID0 0
	53	#define CYPRESS_READ_PORT_ID1 0x2
	54	#define CYPRESS_WRITE_PORT_ID1 1
	55
	56	#define CYPRESS_MAX_REQSIZE 8
	57
	58
	59	/* table of devices that work with this driver */
33b9e162	60	static const struct usb_device_id cypress_table[] = {
9189bfc2 OB	61	{ USB_DEVICE(CYPRESS_VENDOR_ID, CYPRESS_PRODUCT_ID) },
	62	{ }
	63	};
	64	MODULE_DEVICE_TABLE(usb, cypress_table);
	65
	66	/* structure to hold all of our device specific stuff */
	67	struct cypress {
	68	struct usb_device * udev;
	69	unsigned char port[2];
	70	};
	71
	72	/* used to send usb control messages to device */
	73	static int vendor_command(struct cypress *dev, unsigned char request,
	74	unsigned char address, unsigned char data)
	75	{
	76	int retval = 0;
	77	unsigned int pipe;
	78	unsigned char *iobuf;
	79
	80	/* allocate some memory for the i/o buffer*/
	81	iobuf = kzalloc(CYPRESS_MAX_REQSIZE, GFP_KERNEL);
	82	if (!iobuf) {
	83	dev_err(&dev->udev->dev, "Out of memory!\n");
	84	retval = -ENOMEM;
	85	goto error;
	86	}
	87
	88	dev_dbg(&dev->udev->dev, "Sending usb_control_msg (data: %d)\n", data);
	89
	90	/* prepare usb control message and send it upstream */
	91	pipe = usb_rcvctrlpipe(dev->udev, 0);
	92	retval = usb_control_msg(dev->udev, pipe, request,
	93	USB_DIR_IN \| USB_TYPE_VENDOR \| USB_RECIP_OTHER,
	94	address, data, iobuf, CYPRESS_MAX_REQSIZE,
	95	USB_CTRL_GET_TIMEOUT);
	96
	97	/* store returned data (more READs to be added) */
	98	switch (request) {
	99	case CYPRESS_READ_PORT:
	100	if (address == CYPRESS_READ_PORT_ID0) {
	101	dev->port[0] = iobuf[1];
	102	dev_dbg(&dev->udev->dev,
	103	"READ_PORT0 returned: %d\n",
	104	dev->port[0]);
	105	}
	106	else if (address == CYPRESS_READ_PORT_ID1) {
	107	dev->port[1] = iobuf[1];
	108	dev_dbg(&dev->udev->dev,
	109	"READ_PORT1 returned: %d\n",
	110	dev->port[1]);
	111	}
	112	break;
	113	}
	114
	115	kfree(iobuf);
	116	error:
	117	return retval;
	118	}
	119
	120	/* write port value */
	121	static ssize_t write_port(struct device dev, struct device_attribute attr,
	122	const char *buf, size_t count,
	123	int port_num, int write_id)
	124	{
125	int value = -1;
126	int result = 0;
127
128	struct usb_interface *intf = to_usb_interface(dev);
129	struct cypress *cyp = usb_get_intfdata(intf);
130
131	dev_dbg(&cyp->udev->dev, "WRITE_PORT%d called\n", port_num);
132
133	/* validate input data */
134	if (sscanf(buf, "%d", &value) < 1) {
135	result = -EINVAL;
136	goto error;
137	}
138	if (value < 0 \|\| value > 255) {
139	result = -EINVAL;
140	goto error;
141	}
142
143	result = vendor_command(cyp, CYPRESS_WRITE_PORT, write_id,
144	(unsigned char)value);
145
146	dev_dbg(&cyp->udev->dev, "Result of vendor_command: %d\n\n", result);
147	error:
148	return result < 0 ? result : count;
149	}
150
151	/* attribute callback handler (write) */
152	static ssize_t set_port0_handler(struct device *dev,
153	struct device_attribute *attr,
154	const char *buf, size_t count)
155	{
156	return write_port(dev, attr, buf, count, 0, CYPRESS_WRITE_PORT_ID0);
157	}
158
159	/* attribute callback handler (write) */
160	static ssize_t set_port1_handler(struct device *dev,
161	struct device_attribute *attr,
162	const char *buf, size_t count)
163	{
164	return write_port(dev, attr, buf, count, 1, CYPRESS_WRITE_PORT_ID1);
165	}
166
167	/* read port value */
168	static ssize_t read_port(struct device dev, struct device_attribute attr,
169	char *buf, int port_num, int read_id)
170	{
171	int result = 0;
172
173	struct usb_interface *intf = to_usb_interface(dev);
174	struct cypress *cyp = usb_get_intfdata(intf);
175
176	dev_dbg(&cyp->udev->dev, "READ_PORT%d called\n", port_num);
177
178	result = vendor_command(cyp, CYPRESS_READ_PORT, read_id, 0);
179
180	dev_dbg(&cyp->udev->dev, "Result of vendor_command: %d\n\n", result);
181
182	return sprintf(buf, "%d", cyp->port[port_num]);
183	}
184
185	/* attribute callback handler (read) */
186	static ssize_t get_port0_handler(struct device *dev,
187	struct device_attribute attr, char buf)
188	{
189	return read_port(dev, attr, buf, 0, CYPRESS_READ_PORT_ID0);
190	}
191
192	/* attribute callback handler (read) */
193	static ssize_t get_port1_handler(struct device *dev,
194	struct device_attribute attr, char buf)
195	{
196	return read_port(dev, attr, buf, 1, CYPRESS_READ_PORT_ID1);
197	}
198
c990600d	199	static DEVICE_ATTR(port0, S_IRUGO \| S_IWUSR, get_port0_handler, set_port0_handler);
9189bfc2	200
c990600d	201	static DEVICE_ATTR(port1, S_IRUGO \| S_IWUSR, get_port1_handler, set_port1_handler);
9189bfc2 OB	202
	203
	204	static int cypress_probe(struct usb_interface *interface,
	205	const struct usb_device_id *id)
	206	{
	207	struct cypress *dev = NULL;
	208	int retval = -ENOMEM;
	209
	210	/* allocate memory for our device state and initialize it */
	211	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
	212	if (dev == NULL) {
b93b58ee	213	dev_err(&interface->dev, "Out of memory!\n");
4d42e1bb	214	goto error_mem;
9189bfc2 OB	215	}
	216
	217	dev->udev = usb_get_dev(interface_to_usbdev(interface));
	218
	219	/* save our data pointer in this interface device */
	220	usb_set_intfdata(interface, dev);
	221
	222	/* create device attribute files */
4d42e1bb GKH	223	retval = device_create_file(&interface->dev, &dev_attr_port0);
	224	if (retval)
	225	goto error;
	226	retval = device_create_file(&interface->dev, &dev_attr_port1);
	227	if (retval)
	228	goto error;
9189bfc2 OB	229
	230	/* let the user know that the device is now attached */
	231	dev_info(&interface->dev,
	232	"Cypress CY7C63xxx device now attached\n");
4d42e1bb	233	return 0;
9189bfc2	234
9189bfc2	235	error:
4d42e1bb GKH	236	device_remove_file(&interface->dev, &dev_attr_port0);
	237	device_remove_file(&interface->dev, &dev_attr_port1);
	238	usb_set_intfdata(interface, NULL);
	239	usb_put_dev(dev->udev);
	240	kfree(dev);
	241
	242	error_mem:
9189bfc2 OB	243	return retval;
	244	}
	245
	246	static void cypress_disconnect(struct usb_interface *interface)
	247	{
	248	struct cypress *dev;
	249
	250	dev = usb_get_intfdata(interface);
9189bfc2 OB	251
	252	/* remove device attribute files */
	253	device_remove_file(&interface->dev, &dev_attr_port0);
	254	device_remove_file(&interface->dev, &dev_attr_port1);
949ce471 ON	255	/* the intfdata can be set to NULL only after the
	256	* device files have been removed */
	257	usb_set_intfdata(interface, NULL);
9189bfc2 OB	258
	259	usb_put_dev(dev->udev);
	260
	261	dev_info(&interface->dev,
	262	"Cypress CY7C63xxx device now disconnected\n");
	263
	264	kfree(dev);
	265	}
	266
	267	static struct usb_driver cypress_driver = {
	268	.name = "cypress_cy7c63",
	269	.probe = cypress_probe,
	270	.disconnect = cypress_disconnect,
	271	.id_table = cypress_table,
	272	};
	273
65db4305	274	module_usb_driver(cypress_driver);
9189bfc2 OB	275
	276	MODULE_AUTHOR(DRIVER_AUTHOR);
	277	MODULE_DESCRIPTION(DRIVER_DESC);
	278
	279	MODULE_LICENSE("GPL");