1/*
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
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
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.
17 *
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
21 *
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>
29#include <linux/module.h>
30#include <linux/init.h>
31#include <linux/usb/input.h>
32#include <linux/hid.h>
33
34/* for apple IDs */
35#ifdef CONFIG_USB_HID_MODULE
36#include "../hid-ids.h"
37#endif
38
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"
45#define DRIVER_LICENSE "GPL"
46
47MODULE_AUTHOR(DRIVER_AUTHOR);
48MODULE_DESCRIPTION(DRIVER_DESC);
49MODULE_LICENSE(DRIVER_LICENSE);
50
51struct usb_mouse {
52	char name[128];
53	char phys[64];
54	struct usb_device *usbdev;
55	struct input_dev *dev;
56	struct urb *irq;
57
58	signed char *data;
59	dma_addr_t data_dma;
60};
61
62static void usb_mouse_irq(struct urb *urb)
63{
64	struct usb_mouse *mouse = urb->context;
65	signed char *data = mouse->data;
66	struct input_dev *dev = mouse->dev;
67	int status;
68
69	switch (urb->status) {
70	case 0:			/* success */
71		break;
72	case -ECONNRESET:	/* unlink */
73	case -ENOENT:
74	case -ESHUTDOWN:
75		return;
76	/* -EPIPE:  should clear the halt */
77	default:		/* error */
78		goto resubmit;
79	}
80
81	input_report_key(dev, BTN_LEFT,   data[0] & 0x01);
82	input_report_key(dev, BTN_RIGHT,  data[0] & 0x02);
83	input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
84	input_report_key(dev, BTN_SIDE,   data[0] & 0x08);
85	input_report_key(dev, BTN_EXTRA,  data[0] & 0x10);
86
87	input_report_rel(dev, REL_X,     data[1]);
88	input_report_rel(dev, REL_Y,     data[2]);
89	input_report_rel(dev, REL_WHEEL, data[3]);
90
91	input_sync(dev);
92resubmit:
93	status = usb_submit_urb (urb, GFP_ATOMIC);
94	if (status)
95		dev_err(&mouse->usbdev->dev,
96			"can't resubmit intr, %s-%s/input0, status %d\n",
97			mouse->usbdev->bus->bus_name,
98			mouse->usbdev->devpath, status);
99}
100
101static int usb_mouse_open(struct input_dev *dev)
102{
103	struct usb_mouse *mouse = input_get_drvdata(dev);
104
105	mouse->irq->dev = mouse->usbdev;
106	if (usb_submit_urb(mouse->irq, GFP_KERNEL))
107		return -EIO;
108
109	return 0;
110}
111
112static void usb_mouse_close(struct input_dev *dev)
113{
114	struct usb_mouse *mouse = input_get_drvdata(dev);
115
116	usb_kill_urb(mouse->irq);
117}
118
119static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)
120{
121	struct usb_device *dev = interface_to_usbdev(intf);
122	struct usb_host_interface *interface;
123	struct usb_endpoint_descriptor *endpoint;
124	struct usb_mouse *mouse;
125	struct input_dev *input_dev;
126	int pipe, maxp;
127	int error = -ENOMEM;
128
129	interface = intf->cur_altsetting;
130
131	if (interface->desc.bNumEndpoints != 1)
132		return -ENODEV;
133
134	endpoint = &interface->endpoint[0].desc;
135	if (!usb_endpoint_is_int_in(endpoint))
136		return -ENODEV;
137
138	pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
139	maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
140
141	mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);
142	input_dev = input_allocate_device();
143	if (!mouse || !input_dev)
144		goto fail1;
145
146	mouse->data = usb_alloc_coherent(dev, 8, GFP_ATOMIC, &mouse->data_dma);
147	if (!mouse->data)
148		goto fail1;
149
150	mouse->irq = usb_alloc_urb(0, GFP_KERNEL);
151	if (!mouse->irq)
152		goto fail2;
153
154	mouse->usbdev = dev;
155	mouse->dev = input_dev;
156
157	if (dev->manufacturer)
158		strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));
159
160	if (dev->product) {
161		if (dev->manufacturer)
162			strlcat(mouse->name, " ", sizeof(mouse->name));
163		strlcat(mouse->name, dev->product, sizeof(mouse->name));
164	}
165
166	if (!strlen(mouse->name))
167		snprintf(mouse->name, sizeof(mouse->name),
168			 "USB HIDBP Mouse %04x:%04x",
169			 le16_to_cpu(dev->descriptor.idVendor),
170			 le16_to_cpu(dev->descriptor.idProduct));
171
172	usb_make_path(dev, mouse->phys, sizeof(mouse->phys));
173	strlcat(mouse->phys, "/input0", sizeof(mouse->phys));
174
175	input_dev->name = mouse->name;
176	input_dev->phys = mouse->phys;
177	usb_to_input_id(dev, &input_dev->id);
178	input_dev->dev.parent = &intf->dev;
179
180	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
181	input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
182		BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
183	input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
184	input_dev->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |
185		BIT_MASK(BTN_EXTRA);
186	input_dev->relbit[0] |= BIT_MASK(REL_WHEEL);
187
188	input_set_drvdata(input_dev, mouse);
189
190	input_dev->open = usb_mouse_open;
191	input_dev->close = usb_mouse_close;
192
193	usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
194			 (maxp > 8 ? 8 : maxp),
195			 usb_mouse_irq, mouse, endpoint->bInterval);
196	mouse->irq->transfer_dma = mouse->data_dma;
197	mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
198
199	error = input_register_device(mouse->dev);
200	if (error)
201		goto fail3;
202
203	usb_set_intfdata(intf, mouse);
204	return 0;
205
206fail3:
207	usb_free_urb(mouse->irq);
208fail2:
209	usb_free_coherent(dev, 8, mouse->data, mouse->data_dma);
210fail1:
211	input_free_device(input_dev);
212	kfree(mouse);
213	return error;
214}
215
216static void usb_mouse_disconnect(struct usb_interface *intf)
217{
218	struct usb_mouse *mouse = usb_get_intfdata (intf);
219
220	usb_set_intfdata(intf, NULL);
221	if (mouse) {
222		usb_kill_urb(mouse->irq);
223		input_unregister_device(mouse->dev);
224		usb_free_urb(mouse->irq);
225		usb_free_coherent(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
226		kfree(mouse);
227	}
228}
229
230static struct usb_device_id usb_mouse_id_table [] = {
231	{ USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
232		USB_INTERFACE_PROTOCOL_MOUSE) },
233	{ }	/* Terminating entry */
234};
235
236MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);
237
238static struct usb_driver usb_mouse_driver = {
239	.name		= "usbmouse",
240	.probe		= usb_mouse_probe,
241	.disconnect	= usb_mouse_disconnect,
242	.id_table	= usb_mouse_id_table,
243};
244
245module_usb_driver(usb_mouse_driver);
246