[mirror_ubuntu-artful-kernel.git] / drivers / hid / usbhid / usbmouse.c

/*
 *  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>
#include <linux/hid.h>

/* for apple IDs */
#ifdef CONFIG_USB_HID_MODULE
#include "../hid-ids.h"
#endif

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

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");

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, GFP_ATOMIC);
	if (status)
		dev_err(&mouse->usbdev->dev,
			"can't resubmit intr, %s-%s/input0, status %d\n",
			mouse->usbdev->bus->bus_name,
			mouse->usbdev->devpath, status);
}

static int usb_mouse_open(struct input_dev *dev)
{
	struct usb_mouse *mouse = input_get_drvdata(dev);

	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 = input_get_drvdata(dev);

	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;
	int error = -ENOMEM;

	interface = intf->cur_altsetting;

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

	endpoint = &interface->endpoint[0].desc;
	if (!usb_endpoint_is_int_in(endpoint))
		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_alloc_coherent(dev, 8, GFP_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->dev.parent = &intf->dev;

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

	input_set_drvdata(input_dev, 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;

	error = input_register_device(mouse->dev);
	if (error)
		goto fail3;

	usb_set_intfdata(intf, mouse);
	return 0;

fail3:	
	usb_free_urb(mouse->irq);
fail2:	
	usb_free_coherent(dev, 8, mouse->data, mouse->data_dma);
fail1:	
	input_free_device(input_dev);
	kfree(mouse);
	return error;
}

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_free_coherent(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
		kfree(mouse);
	}
}

static struct usb_device_id usb_mouse_id_table [] = {
	{ USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
		USB_INTERFACE_PROTOCOL_MOUSE) },
	{ }	/* 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,
};

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