[linux-2.6-block.git] / drivers / usb / input / itmtouch.c

/******************************************************************************
 * itmtouch.c  --  Driver for ITM touchscreen panel
 *
 * 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; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Based upon original work by Chris Collins <xfire-itmtouch@xware.cx>.
 *
 * Kudos to ITM for providing me with the datasheet for the panel,
 * even though it was a day later than I had finished writing this
 * driver.
 *
 * It has meant that I've been able to correct my interpretation of the
 * protocol packets however.
 *
 * CC -- 2003/9/29
 *
 * History
 * 1.0 & 1.1  2003 (CC) vojtech@suse.cz
 *   Original version for 2.4.x kernels
 *
 * 1.2  02/03/2005 (HCE) hc@mivu.no
 *   Complete rewrite to support Linux 2.6.10, thanks to mtouchusb.c for hints.
 *   Unfortunately no calibration support at this time.
 *
 * 1.2.1  09/03/2005 (HCE) hc@mivu.no
 *   Code cleanup and adjusting syntax to start matching kernel standards
 * 
 * 1.2.2  10/05/2006 (MJA) massad@gmail.com
 *   Flag for detecting if the screen was being touch was incorrectly 
 *   inverted, so no touch events were being detected. 	
 *   
 *****************************************************************************/

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

/* only an 8 byte buffer necessary for a single packet */
#define ITM_BUFSIZE			8
#define PATH_SIZE			64

#define USB_VENDOR_ID_ITMINC		0x0403
#define USB_PRODUCT_ID_TOUCHPANEL	0xf9e9

#define DRIVER_AUTHOR "Hans-Christian Egtvedt <hc@mivu.no>"
#define DRIVER_VERSION "v1.2.2"
#define DRIVER_DESC "USB ITM Inc Touch Panel Driver"
#define DRIVER_LICENSE "GPL"

MODULE_AUTHOR( DRIVER_AUTHOR );
MODULE_DESCRIPTION( DRIVER_DESC );
MODULE_LICENSE( DRIVER_LICENSE );

struct itmtouch_dev {
	struct usb_device	*usbdev; /* usb device */
	struct input_dev	*inputdev; /* input device */
	struct urb		*readurb; /* urb */
	char			rbuf[ITM_BUFSIZE]; /* data */
	int			users;
	char name[128];
	char phys[64];
};

static struct usb_device_id itmtouch_ids [] = {
	{ USB_DEVICE(USB_VENDOR_ID_ITMINC, USB_PRODUCT_ID_TOUCHPANEL) },
	{ }
};

static void itmtouch_irq(struct urb *urb)
{
	struct itmtouch_dev *itmtouch = urb->context;
	unsigned char *data = urb->transfer_buffer;
	struct input_dev *dev = itmtouch->inputdev;
	int retval;

	switch (urb->status) {
	case 0:
		/* success */
		break;
	case -ETIME:
		/* this urb is timing out */
		dbg("%s - urb timed out - was the device unplugged?",
		    __FUNCTION__);
		return;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
		dbg("%s - urb shutting down with status: %d",
		    __FUNCTION__, urb->status);
		return;
	default:
		dbg("%s - nonzero urb status received: %d",
		    __FUNCTION__, urb->status);
		goto exit;
	}

	/* if pressure has been released, then don't report X/Y */
	if (!(data[7] & 0x20)) {
		input_report_abs(dev, ABS_X, (data[0] & 0x1F) << 7 | (data[3] & 0x7F));
		input_report_abs(dev, ABS_Y, (data[1] & 0x1F) << 7 | (data[4] & 0x7F));
	}

	input_report_abs(dev, ABS_PRESSURE, (data[2] & 1) << 7 | (data[5] & 0x7F));
	input_report_key(dev, BTN_TOUCH, ~data[7] & 0x20);
	input_sync(dev);

exit:
	retval = usb_submit_urb (urb, GFP_ATOMIC);
	if (retval)
		printk(KERN_ERR "%s - usb_submit_urb failed with result: %d",
				__FUNCTION__, retval);
}

static int itmtouch_open(struct input_dev *input)
{
	struct itmtouch_dev *itmtouch = input->private;

	itmtouch->readurb->dev = itmtouch->usbdev;

	if (usb_submit_urb(itmtouch->readurb, GFP_KERNEL))
		return -EIO;

	return 0;
}

static void itmtouch_close(struct input_dev *input)
{
	struct itmtouch_dev *itmtouch = input->private;

	usb_kill_urb(itmtouch->readurb);
}

static int itmtouch_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct itmtouch_dev *itmtouch;
	struct input_dev *input_dev;
	struct usb_host_interface *interface;
	struct usb_endpoint_descriptor *endpoint;
	struct usb_device *udev = interface_to_usbdev(intf);
	unsigned int pipe;
	unsigned int maxp;

	interface = intf->cur_altsetting;
	endpoint = &interface->endpoint[0].desc;

	itmtouch = kzalloc(sizeof(struct itmtouch_dev), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!itmtouch || !input_dev) {
		err("%s - Out of memory.", __FUNCTION__);
		goto fail;
	}

	itmtouch->usbdev = udev;
	itmtouch->inputdev = input_dev;

	if (udev->manufacturer)
		strlcpy(itmtouch->name, udev->manufacturer, sizeof(itmtouch->name));

	if (udev->product) {
		if (udev->manufacturer)
			strlcat(itmtouch->name, " ", sizeof(itmtouch->name));
		strlcat(itmtouch->name, udev->product, sizeof(itmtouch->name));
	}

	if (!strlen(itmtouch->name))
		sprintf(itmtouch->name, "USB ITM touchscreen");

	usb_make_path(udev, itmtouch->phys, sizeof(itmtouch->phys));
	strlcpy(itmtouch->phys, "/input0", sizeof(itmtouch->phys));

	input_dev->name = itmtouch->name;
	input_dev->phys = itmtouch->phys;
	usb_to_input_id(udev, &input_dev->id);
	input_dev->cdev.dev = &intf->dev;
	input_dev->private = itmtouch;

	input_dev->open = itmtouch_open;
	input_dev->close = itmtouch_close;

	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
	input_dev->absbit[0] = BIT(ABS_X) | BIT(ABS_Y) | BIT(ABS_PRESSURE);
	input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);

	/* device limits */
	/* as specified by the ITM datasheet, X and Y are 12bit,
	 * Z (pressure) is 8 bit. However, the fields are defined up
	 * to 14 bits for future possible expansion.
	 */
	input_set_abs_params(input_dev, ABS_X, 0, 0x0FFF, 2, 0);
	input_set_abs_params(input_dev, ABS_Y, 0, 0x0FFF, 2, 0);
	input_set_abs_params(input_dev, ABS_PRESSURE, 0, 0xFF, 2, 0);

	/* initialise the URB so we can read from the transport stream */
	pipe = usb_rcvintpipe(itmtouch->usbdev, endpoint->bEndpointAddress);
	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));

	if (maxp > ITM_BUFSIZE)
		maxp = ITM_BUFSIZE;

	itmtouch->readurb = usb_alloc_urb(0, GFP_KERNEL);
	if (!itmtouch->readurb) {
		dbg("%s - usb_alloc_urb failed: itmtouch->readurb", __FUNCTION__);
		goto fail;
	}

	usb_fill_int_urb(itmtouch->readurb, itmtouch->usbdev, pipe, itmtouch->rbuf,
			 maxp, itmtouch_irq, itmtouch, endpoint->bInterval);

	input_register_device(itmtouch->inputdev);

	usb_set_intfdata(intf, itmtouch);

	return 0;

 fail:	input_free_device(input_dev);
	kfree(itmtouch);
	return -ENOMEM;
}

static void itmtouch_disconnect(struct usb_interface *intf)
{
	struct itmtouch_dev *itmtouch = usb_get_intfdata(intf);

	usb_set_intfdata(intf, NULL);

	if (itmtouch) {
		input_unregister_device(itmtouch->inputdev);
		usb_kill_urb(itmtouch->readurb);
		usb_free_urb(itmtouch->readurb);
		kfree(itmtouch);
	}
}

MODULE_DEVICE_TABLE(usb, itmtouch_ids);

static struct usb_driver itmtouch_driver = {
	.name =         "itmtouch",
	.probe =        itmtouch_probe,
	.disconnect =   itmtouch_disconnect,
	.id_table =     itmtouch_ids,
};

static int __init itmtouch_init(void)
{
	info(DRIVER_DESC " " DRIVER_VERSION);
	info(DRIVER_AUTHOR);
	return usb_register(&itmtouch_driver);
}

static void __exit itmtouch_exit(void)
{
	usb_deregister(&itmtouch_driver);
}

module_init(itmtouch_init);
module_exit(itmtouch_exit);
Commit	Line	Data
86084712 HCE	1	/******************************************************************************
	2	* itmtouch.c -- Driver for ITM touchscreen panel
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License as
	6	* published by the Free Software Foundation; either version 2 of the
	7	* License, or (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful, but
	10	* WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	* General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	17	*
	18	* Based upon original work by Chris Collins <xfire-itmtouch@xware.cx>.
	19	*
	20	* Kudos to ITM for providing me with the datasheet for the panel,
05f091ab	21	* even though it was a day later than I had finished writing this
86084712	22	* driver.
05f091ab	23	*
86084712 HCE	24	* It has meant that I've been able to correct my interpretation of the
86084712 HCE	25	* protocol packets however.
05f091ab	26	*
86084712	27	* CC -- 2003/9/29
05f091ab	28	*
86084712 HCE	29	* History
	30	* 1.0 & 1.1 2003 (CC) vojtech@suse.cz
	31	* Original version for 2.4.x kernels
	32	*
	33	* 1.2 02/03/2005 (HCE) hc@mivu.no
	34	* Complete rewrite to support Linux 2.6.10, thanks to mtouchusb.c for hints.
	35	* Unfortunately no calibration support at this time.
05f091ab	36	*
86084712 HCE	37	* 1.2.1 09/03/2005 (HCE) hc@mivu.no
86084712 HCE	38	* Code cleanup and adjusting syntax to start matching kernel standards
77dc2db6 MA	39	*
	40	* 1.2.2 10/05/2006 (MJA) massad@gmail.com
	41	* Flag for detecting if the screen was being touch was incorrectly
	42	* inverted, so no touch events were being detected.
	43	*
86084712 HCE	44	*****************************************************************************/
86084712 HCE	45
86084712 HCE	46	#include <linux/kernel.h>
86084712 HCE	47	#include <linux/slab.h>
86084712 HCE	48	#include <linux/module.h>
86084712 HCE	49	#include <linux/init.h>
ae0dadcf	50	#include <linux/usb/input.h>
86084712 HCE	51
	52	/* only an 8 byte buffer necessary for a single packet */
	53	#define ITM_BUFSIZE 8
	54	#define PATH_SIZE 64
	55
	56	#define USB_VENDOR_ID_ITMINC 0x0403
	57	#define USB_PRODUCT_ID_TOUCHPANEL 0xf9e9
	58
	59	#define DRIVER_AUTHOR "Hans-Christian Egtvedt <hc@mivu.no>"
77dc2db6	60	#define DRIVER_VERSION "v1.2.2"
86084712 HCE	61	#define DRIVER_DESC "USB ITM Inc Touch Panel Driver"
	62	#define DRIVER_LICENSE "GPL"
	63
	64	MODULE_AUTHOR( DRIVER_AUTHOR );
	65	MODULE_DESCRIPTION( DRIVER_DESC );
	66	MODULE_LICENSE( DRIVER_LICENSE );
	67
	68	struct itmtouch_dev {
05f091ab	69	struct usb_device usbdev; / usb device */
c5b7c7c3	70	struct input_dev inputdev; / input device */
86084712 HCE	71	struct urb readurb; / urb */
	72	char rbuf[ITM_BUFSIZE]; /* data */
	73	int users;
	74	char name[128];
	75	char phys[64];
	76	};
	77
	78	static struct usb_device_id itmtouch_ids [] = {
	79	{ USB_DEVICE(USB_VENDOR_ID_ITMINC, USB_PRODUCT_ID_TOUCHPANEL) },
	80	{ }
	81	};
	82
7d12e780	83	static void itmtouch_irq(struct urb *urb)
86084712	84	{
c5b7c7c3	85	struct itmtouch_dev *itmtouch = urb->context;
86084712	86	unsigned char *data = urb->transfer_buffer;
c5b7c7c3	87	struct input_dev *dev = itmtouch->inputdev;
86084712 HCE	88	int retval;
	89
	90	switch (urb->status) {
	91	case 0:
	92	/* success */
	93	break;
38e2bfc9	94	case -ETIME:
86084712 HCE	95	/* this urb is timing out */
	96	dbg("%s - urb timed out - was the device unplugged?",
	97	__FUNCTION__);
	98	return;
	99	case -ECONNRESET:
	100	case -ENOENT:
	101	case -ESHUTDOWN:
	102	/* this urb is terminated, clean up */
	103	dbg("%s - urb shutting down with status: %d",
	104	__FUNCTION__, urb->status);
	105	return;
	106	default:
	107	dbg("%s - nonzero urb status received: %d",
	108	__FUNCTION__, urb->status);
	109	goto exit;
	110	}
	111
86084712	112	/* if pressure has been released, then don't report X/Y */
77dc2db6	113	if (!(data[7] & 0x20)) {
86084712 HCE	114	input_report_abs(dev, ABS_X, (data[0] & 0x1F) << 7 \| (data[3] & 0x7F));
	115	input_report_abs(dev, ABS_Y, (data[1] & 0x1F) << 7 \| (data[4] & 0x7F));
	116	}
05f091ab	117
86084712 HCE	118	input_report_abs(dev, ABS_PRESSURE, (data[2] & 1) << 7 \| (data[5] & 0x7F));
	119	input_report_key(dev, BTN_TOUCH, ~data[7] & 0x20);
	120	input_sync(dev);
	121
	122	exit:
	123	retval = usb_submit_urb (urb, GFP_ATOMIC);
	124	if (retval)
	125	printk(KERN_ERR "%s - usb_submit_urb failed with result: %d",
	126	__FUNCTION__, retval);
	127	}
	128
	129	static int itmtouch_open(struct input_dev *input)
	130	{
	131	struct itmtouch_dev *itmtouch = input->private;
	132
86084712 HCE	133	itmtouch->readurb->dev = itmtouch->usbdev;
86084712 HCE	134
65cde54b	135	if (usb_submit_urb(itmtouch->readurb, GFP_KERNEL))
86084712	136	return -EIO;
86084712 HCE	137
	138	return 0;
	139	}
	140
	141	static void itmtouch_close(struct input_dev *input)
	142	{
	143	struct itmtouch_dev *itmtouch = input->private;
	144
65cde54b	145	usb_kill_urb(itmtouch->readurb);
86084712 HCE	146	}
	147
	148	static int itmtouch_probe(struct usb_interface intf, const struct usb_device_id id)
	149	{
	150	struct itmtouch_dev *itmtouch;
c5b7c7c3	151	struct input_dev *input_dev;
86084712 HCE	152	struct usb_host_interface *interface;
	153	struct usb_endpoint_descriptor *endpoint;
	154	struct usb_device *udev = interface_to_usbdev(intf);
	155	unsigned int pipe;
	156	unsigned int maxp;
86084712 HCE	157
	158	interface = intf->cur_altsetting;
	159	endpoint = &interface->endpoint[0].desc;
	160
c5b7c7c3 DT	161	itmtouch = kzalloc(sizeof(struct itmtouch_dev), GFP_KERNEL);
	162	input_dev = input_allocate_device();
	163	if (!itmtouch \|\| !input_dev) {
86084712	164	err("%s - Out of memory.", __FUNCTION__);
c5b7c7c3	165	goto fail;
86084712 HCE	166	}
	167
	168	itmtouch->usbdev = udev;
c5b7c7c3	169	itmtouch->inputdev = input_dev;
05f091ab	170
c5b7c7c3 DT	171	if (udev->manufacturer)
c5b7c7c3 DT	172	strlcpy(itmtouch->name, udev->manufacturer, sizeof(itmtouch->name));
86084712	173
c5b7c7c3 DT	174	if (udev->product) {
	175	if (udev->manufacturer)
	176	strlcat(itmtouch->name, " ", sizeof(itmtouch->name));
	177	strlcat(itmtouch->name, udev->product, sizeof(itmtouch->name));
	178	}
86084712 HCE	179
	180	if (!strlen(itmtouch->name))
	181	sprintf(itmtouch->name, "USB ITM touchscreen");
05f091ab	182
c5b7c7c3 DT	183	usb_make_path(udev, itmtouch->phys, sizeof(itmtouch->phys));
	184	strlcpy(itmtouch->phys, "/input0", sizeof(itmtouch->phys));
	185
	186	input_dev->name = itmtouch->name;
	187	input_dev->phys = itmtouch->phys;
	188	usb_to_input_id(udev, &input_dev->id);
	189	input_dev->cdev.dev = &intf->dev;
	190	input_dev->private = itmtouch;
	191
	192	input_dev->open = itmtouch_open;
	193	input_dev->close = itmtouch_close;
	194
	195	input_dev->evbit[0] = BIT(EV_KEY) \| BIT(EV_ABS);
	196	input_dev->absbit[0] = BIT(ABS_X) \| BIT(ABS_Y) \| BIT(ABS_PRESSURE);
	197	input_dev->keybit[LONG(BTN_TOUCH)] = BIT(BTN_TOUCH);
	198
86084712 HCE	199	/* device limits */
	200	/* as specified by the ITM datasheet, X and Y are 12bit,
	201	* Z (pressure) is 8 bit. However, the fields are defined up
	202	* to 14 bits for future possible expansion.
	203	*/
c5b7c7c3 DT	204	input_set_abs_params(input_dev, ABS_X, 0, 0x0FFF, 2, 0);
	205	input_set_abs_params(input_dev, ABS_Y, 0, 0x0FFF, 2, 0);
	206	input_set_abs_params(input_dev, ABS_PRESSURE, 0, 0xFF, 2, 0);
86084712 HCE	207
	208	/* initialise the URB so we can read from the transport stream */
	209	pipe = usb_rcvintpipe(itmtouch->usbdev, endpoint->bEndpointAddress);
	210	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
05f091ab	211
86084712 HCE	212	if (maxp > ITM_BUFSIZE)
	213	maxp = ITM_BUFSIZE;
	214
	215	itmtouch->readurb = usb_alloc_urb(0, GFP_KERNEL);
86084712 HCE	216	if (!itmtouch->readurb) {
86084712 HCE	217	dbg("%s - usb_alloc_urb failed: itmtouch->readurb", __FUNCTION__);
c5b7c7c3	218	goto fail;
86084712	219	}
05f091ab DT	220
	221	usb_fill_int_urb(itmtouch->readurb, itmtouch->usbdev, pipe, itmtouch->rbuf,
	222	maxp, itmtouch_irq, itmtouch, endpoint->bInterval);
86084712	223
c5b7c7c3	224	input_register_device(itmtouch->inputdev);
86084712	225
86084712 HCE	226	usb_set_intfdata(intf, itmtouch);
	227
	228	return 0;
c5b7c7c3 DT	229
	230	fail: input_free_device(input_dev);
	231	kfree(itmtouch);
	232	return -ENOMEM;
86084712 HCE	233	}
	234
	235	static void itmtouch_disconnect(struct usb_interface *intf)
05f091ab	236	{
86084712 HCE	237	struct itmtouch_dev *itmtouch = usb_get_intfdata(intf);
	238
	239	usb_set_intfdata(intf, NULL);
	240
	241	if (itmtouch) {
c5b7c7c3	242	input_unregister_device(itmtouch->inputdev);
86084712 HCE	243	usb_kill_urb(itmtouch->readurb);
	244	usb_free_urb(itmtouch->readurb);
	245	kfree(itmtouch);
	246	}
	247	}
	248
	249	MODULE_DEVICE_TABLE(usb, itmtouch_ids);
	250
	251	static struct usb_driver itmtouch_driver = {
05f091ab DT	252	.name = "itmtouch",
	253	.probe = itmtouch_probe,
	254	.disconnect = itmtouch_disconnect,
	255	.id_table = itmtouch_ids,
86084712 HCE	256	};
	257
	258	static int __init itmtouch_init(void)
	259	{
	260	info(DRIVER_DESC " " DRIVER_VERSION);
	261	info(DRIVER_AUTHOR);
	262	return usb_register(&itmtouch_driver);
	263	}
	264
	265	static void __exit itmtouch_exit(void)
	266	{
	267	usb_deregister(&itmtouch_driver);
	268	}
	269
	270	module_init(itmtouch_init);
	271	module_exit(itmtouch_exit);