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

/*
 * $Id: usbmouse.c,v 1.15 2001/12/27 10:37:41 vojtech Exp $
 *
 *  Copyright (c) 1999-2001 Vojtech Pavlik
 *
 *  USB HIDBP Mouse support
 */

/*
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Should you need to contact me, the author, you can do so either by
 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
 */

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

/*
 * Version Information
 */
#define DRIVER_VERSION "v1.6"
#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
#define DRIVER_DESC "USB HID Boot Protocol mouse driver"
#define DRIVER_LICENSE "GPL"

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

struct usb_mouse {
	char name[128];
	char phys[64];
	struct usb_device *usbdev;
	struct input_dev *dev;
	struct urb *irq;

	signed char *data;
	dma_addr_t data_dma;
};

static void usb_mouse_irq(struct urb *urb)
{
	struct usb_mouse *mouse = urb->context;
	signed char *data = mouse->data;
	struct input_dev *dev = mouse->dev;
	int status;

	switch (urb->status) {
	case 0:			/* success */
		break;
	case -ECONNRESET:	/* unlink */
	case -ENOENT:
	case -ESHUTDOWN:
		return;
	/* -EPIPE:  should clear the halt */
	default:		/* error */
		goto resubmit;
	}

	input_report_key(dev, BTN_LEFT,   data[0] & 0x01);
	input_report_key(dev, BTN_RIGHT,  data[0] & 0x02);
	input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
	input_report_key(dev, BTN_SIDE,   data[0] & 0x08);
	input_report_key(dev, BTN_EXTRA,  data[0] & 0x10);

	input_report_rel(dev, REL_X,     data[1]);
	input_report_rel(dev, REL_Y,     data[2]);
	input_report_rel(dev, REL_WHEEL, data[3]);

	input_sync(dev);
resubmit:
	status = usb_submit_urb (urb, SLAB_ATOMIC);
	if (status)
		err ("can't resubmit intr, %s-%s/input0, status %d",
				mouse->usbdev->bus->bus_name,
				mouse->usbdev->devpath, status);
}

static int usb_mouse_open(struct input_dev *dev)
{
	struct usb_mouse *mouse = dev->private;

	mouse->irq->dev = mouse->usbdev;
	if (usb_submit_urb(mouse->irq, GFP_KERNEL))
		return -EIO;

	return 0;
}

static void usb_mouse_close(struct input_dev *dev)
{
	struct usb_mouse *mouse = dev->private;

	usb_kill_urb(mouse->irq);
}

static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *dev = interface_to_usbdev(intf);
	struct usb_host_interface *interface;
	struct usb_endpoint_descriptor *endpoint;
	struct usb_mouse *mouse;
	struct input_dev *input_dev;
	int pipe, maxp;

	interface = intf->cur_altsetting;

	if (interface->desc.bNumEndpoints != 1)
		return -ENODEV;

	endpoint = &interface->endpoint[0].desc;
	if (!(endpoint->bEndpointAddress & USB_DIR_IN))
		return -ENODEV;
	if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
		return -ENODEV;

	pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
	maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));

	mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!mouse || !input_dev)
		goto fail1;

	mouse->data = usb_buffer_alloc(dev, 8, SLAB_ATOMIC, &mouse->data_dma);
	if (!mouse->data)
		goto fail1;

	mouse->irq = usb_alloc_urb(0, GFP_KERNEL);
	if (!mouse->irq)
		goto fail2;

	mouse->usbdev = dev;
	mouse->dev = input_dev;

	if (dev->manufacturer)
		strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));

	if (dev->product) {
		if (dev->manufacturer)
			strlcat(mouse->name, " ", sizeof(mouse->name));
		strlcat(mouse->name, dev->product, sizeof(mouse->name));
	}

	if (!strlen(mouse->name))
		snprintf(mouse->name, sizeof(mouse->name),
			 "USB HIDBP Mouse %04x:%04x",
			 le16_to_cpu(dev->descriptor.idVendor),
			 le16_to_cpu(dev->descriptor.idProduct));

	usb_make_path(dev, mouse->phys, sizeof(mouse->phys));
	strlcat(mouse->phys, "/input0", sizeof(mouse->phys));

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

	input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
	input_dev->keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE);
	input_dev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
	input_dev->keybit[LONG(BTN_MOUSE)] |= BIT(BTN_SIDE) | BIT(BTN_EXTRA);
	input_dev->relbit[0] |= BIT(REL_WHEEL);

	input_dev->private = mouse;
	input_dev->open = usb_mouse_open;
	input_dev->close = usb_mouse_close;

	usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
			 (maxp > 8 ? 8 : maxp),
			 usb_mouse_irq, mouse, endpoint->bInterval);
	mouse->irq->transfer_dma = mouse->data_dma;
	mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	input_register_device(mouse->dev);

	usb_set_intfdata(intf, mouse);
	return 0;

fail2:	usb_buffer_free(dev, 8, mouse->data, mouse->data_dma);
fail1:	input_free_device(input_dev);
	kfree(mouse);
	return -ENOMEM;
}

static void usb_mouse_disconnect(struct usb_interface *intf)
{
	struct usb_mouse *mouse = usb_get_intfdata (intf);

	usb_set_intfdata(intf, NULL);
	if (mouse) {
		usb_kill_urb(mouse->irq);
		input_unregister_device(mouse->dev);
		usb_free_urb(mouse->irq);
		usb_buffer_free(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
		kfree(mouse);
	}
}

static struct usb_device_id usb_mouse_id_table [] = {
	{ USB_INTERFACE_INFO(3, 1, 2) },
	{ }	/* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);

static struct usb_driver usb_mouse_driver = {
	.name		= "usbmouse",
	.probe		= usb_mouse_probe,
	.disconnect	= usb_mouse_disconnect,
	.id_table	= usb_mouse_id_table,
};

static int __init usb_mouse_init(void)
{
	int retval = usb_register(&usb_mouse_driver);
	if (retval == 0)
		info(DRIVER_VERSION ":" DRIVER_DESC);
	return retval;
}

static void __exit usb_mouse_exit(void)
{
	usb_deregister(&usb_mouse_driver);
}

module_init(usb_mouse_init);
module_exit(usb_mouse_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* $Id: usbmouse.c,v 1.15 2001/12/27 10:37:41 vojtech Exp $
	3	*
	4	* Copyright (c) 1999-2001 Vojtech Pavlik
	5	*
	6	* USB HIDBP Mouse support
	7	*/
	8
	9	/*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
05f091ab	12	* the Free Software Foundation; either version 2 of the License, or
1da177e4	13	* (at your option) any later version.
05f091ab	14	*
1da177e4 LT	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
05f091ab	19	*
1da177e4 LT	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
05f091ab	23	*
1da177e4 LT	24	* Should you need to contact me, the author, you can do so either by
	25	* e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
	26	* Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
	27	*/
	28
	29	#include <linux/kernel.h>
	30	#include <linux/slab.h>
1da177e4 LT	31	#include <linux/module.h>
1da177e4 LT	32	#include <linux/init.h>
ae0dadcf	33	#include <linux/usb/input.h>
1da177e4 LT	34
	35	/*
	36	* Version Information
	37	*/
	38	#define DRIVER_VERSION "v1.6"
	39	#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
	40	#define DRIVER_DESC "USB HID Boot Protocol mouse driver"
	41	#define DRIVER_LICENSE "GPL"
	42
	43	MODULE_AUTHOR(DRIVER_AUTHOR);
	44	MODULE_DESCRIPTION(DRIVER_DESC);
	45	MODULE_LICENSE(DRIVER_LICENSE);
	46
	47	struct usb_mouse {
	48	char name[128];
	49	char phys[64];
	50	struct usb_device *usbdev;
c5b7c7c3	51	struct input_dev *dev;
1da177e4	52	struct urb *irq;
1da177e4 LT	53
	54	signed char *data;
	55	dma_addr_t data_dma;
	56	};
	57
7d12e780	58	static void usb_mouse_irq(struct urb *urb)
1da177e4 LT	59	{
	60	struct usb_mouse *mouse = urb->context;
	61	signed char *data = mouse->data;
c5b7c7c3	62	struct input_dev *dev = mouse->dev;
1da177e4 LT	63	int status;
	64
	65	switch (urb->status) {
	66	case 0: /* success */
	67	break;
	68	case -ECONNRESET: /* unlink */
	69	case -ENOENT:
	70	case -ESHUTDOWN:
	71	return;
	72	/* -EPIPE: should clear the halt */
	73	default: /* error */
	74	goto resubmit;
	75	}
	76
1da177e4 LT	77	input_report_key(dev, BTN_LEFT, data[0] & 0x01);
	78	input_report_key(dev, BTN_RIGHT, data[0] & 0x02);
	79	input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
	80	input_report_key(dev, BTN_SIDE, data[0] & 0x08);
	81	input_report_key(dev, BTN_EXTRA, data[0] & 0x10);
	82
	83	input_report_rel(dev, REL_X, data[1]);
	84	input_report_rel(dev, REL_Y, data[2]);
	85	input_report_rel(dev, REL_WHEEL, data[3]);
	86
	87	input_sync(dev);
	88	resubmit:
	89	status = usb_submit_urb (urb, SLAB_ATOMIC);
	90	if (status)
	91	err ("can't resubmit intr, %s-%s/input0, status %d",
	92	mouse->usbdev->bus->bus_name,
	93	mouse->usbdev->devpath, status);
	94	}
	95
	96	static int usb_mouse_open(struct input_dev *dev)
	97	{
	98	struct usb_mouse *mouse = dev->private;
	99
1da177e4	100	mouse->irq->dev = mouse->usbdev;
65cde54b	101	if (usb_submit_urb(mouse->irq, GFP_KERNEL))
1da177e4	102	return -EIO;
1da177e4 LT	103
	104	return 0;
	105	}
	106
	107	static void usb_mouse_close(struct input_dev *dev)
	108	{
	109	struct usb_mouse *mouse = dev->private;
	110
65cde54b	111	usb_kill_urb(mouse->irq);
1da177e4 LT	112	}
1da177e4 LT	113
c5b7c7c3	114	static int usb_mouse_probe(struct usb_interface intf, const struct usb_device_id id)
1da177e4	115	{
c5b7c7c3	116	struct usb_device *dev = interface_to_usbdev(intf);
1da177e4 LT	117	struct usb_host_interface *interface;
	118	struct usb_endpoint_descriptor *endpoint;
	119	struct usb_mouse *mouse;
c5b7c7c3	120	struct input_dev *input_dev;
1da177e4	121	int pipe, maxp;
1da177e4 LT	122
	123	interface = intf->cur_altsetting;
	124
05f091ab	125	if (interface->desc.bNumEndpoints != 1)
1da177e4 LT	126	return -ENODEV;
	127
	128	endpoint = &interface->endpoint[0].desc;
c5b7c7c3	129	if (!(endpoint->bEndpointAddress & USB_DIR_IN))
1da177e4	130	return -ENODEV;
c5b7c7c3	131	if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1da177e4 LT	132	return -ENODEV;
	133
	134	pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
	135	maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
	136
c5b7c7c3 DT	137	mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);
	138	input_dev = input_allocate_device();
	139	if (!mouse \|\| !input_dev)
	140	goto fail1;
1da177e4 LT	141
1da177e4 LT	142	mouse->data = usb_buffer_alloc(dev, 8, SLAB_ATOMIC, &mouse->data_dma);
c5b7c7c3 DT	143	if (!mouse->data)
c5b7c7c3 DT	144	goto fail1;
1da177e4 LT	145
1da177e4 LT	146	mouse->irq = usb_alloc_urb(0, GFP_KERNEL);
c5b7c7c3 DT	147	if (!mouse->irq)
c5b7c7c3 DT	148	goto fail2;
1da177e4 LT	149
1da177e4 LT	150	mouse->usbdev = dev;
c5b7c7c3 DT	151	mouse->dev = input_dev;
	152
	153	if (dev->manufacturer)
	154	strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));
1da177e4	155
c5b7c7c3 DT	156	if (dev->product) {
	157	if (dev->manufacturer)
	158	strlcat(mouse->name, " ", sizeof(mouse->name));
	159	strlcat(mouse->name, dev->product, sizeof(mouse->name));
	160	}
1da177e4	161
c5b7c7c3 DT	162	if (!strlen(mouse->name))
	163	snprintf(mouse->name, sizeof(mouse->name),
	164	"USB HIDBP Mouse %04x:%04x",
	165	le16_to_cpu(dev->descriptor.idVendor),
	166	le16_to_cpu(dev->descriptor.idProduct));
1da177e4	167
c5b7c7c3 DT	168	usb_make_path(dev, mouse->phys, sizeof(mouse->phys));
c5b7c7c3 DT	169	strlcat(mouse->phys, "/input0", sizeof(mouse->phys));
1da177e4	170
c5b7c7c3 DT	171	input_dev->name = mouse->name;
	172	input_dev->phys = mouse->phys;
	173	usb_to_input_id(dev, &input_dev->id);
	174	input_dev->cdev.dev = &intf->dev;
1da177e4	175
c5b7c7c3 DT	176	input_dev->evbit[0] = BIT(EV_KEY) \| BIT(EV_REL);
	177	input_dev->keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) \| BIT(BTN_RIGHT) \| BIT(BTN_MIDDLE);
	178	input_dev->relbit[0] = BIT(REL_X) \| BIT(REL_Y);
	179	input_dev->keybit[LONG(BTN_MOUSE)] \|= BIT(BTN_SIDE) \| BIT(BTN_EXTRA);
	180	input_dev->relbit[0] \|= BIT(REL_WHEEL);
1da177e4	181
c5b7c7c3 DT	182	input_dev->private = mouse;
	183	input_dev->open = usb_mouse_open;
	184	input_dev->close = usb_mouse_close;
1da177e4 LT	185
	186	usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
	187	(maxp > 8 ? 8 : maxp),
	188	usb_mouse_irq, mouse, endpoint->bInterval);
	189	mouse->irq->transfer_dma = mouse->data_dma;
	190	mouse->irq->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
	191
c5b7c7c3	192	input_register_device(mouse->dev);
1da177e4 LT	193
	194	usb_set_intfdata(intf, mouse);
	195	return 0;
c5b7c7c3 DT	196
	197	fail2: usb_buffer_free(dev, 8, mouse->data, mouse->data_dma);
	198	fail1: input_free_device(input_dev);
	199	kfree(mouse);
	200	return -ENOMEM;
1da177e4 LT	201	}
	202
	203	static void usb_mouse_disconnect(struct usb_interface *intf)
	204	{
	205	struct usb_mouse *mouse = usb_get_intfdata (intf);
05f091ab	206
1da177e4 LT	207	usb_set_intfdata(intf, NULL);
	208	if (mouse) {
	209	usb_kill_urb(mouse->irq);
c5b7c7c3	210	input_unregister_device(mouse->dev);
1da177e4 LT	211	usb_free_urb(mouse->irq);
	212	usb_buffer_free(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
	213	kfree(mouse);
	214	}
	215	}
	216
	217	static struct usb_device_id usb_mouse_id_table [] = {
	218	{ USB_INTERFACE_INFO(3, 1, 2) },
14acdcd3	219	{ } /* Terminating entry */
1da177e4 LT	220	};
	221
	222	MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);
	223
	224	static struct usb_driver usb_mouse_driver = {
1da177e4 LT	225	.name = "usbmouse",
	226	.probe = usb_mouse_probe,
	227	.disconnect = usb_mouse_disconnect,
	228	.id_table = usb_mouse_id_table,
	229	};
	230
	231	static int __init usb_mouse_init(void)
	232	{
	233	int retval = usb_register(&usb_mouse_driver);
05f091ab	234	if (retval == 0)
1da177e4 LT	235	info(DRIVER_VERSION ":" DRIVER_DESC);
	236	return retval;
	237	}
	238
	239	static void __exit usb_mouse_exit(void)
	240	{
	241	usb_deregister(&usb_mouse_driver);
	242	}
	243
	244	module_init(usb_mouse_init);
	245	module_exit(usb_mouse_exit);