2 * USB Synaptics device driver
4 * Copyright (c) 2002 Rob Miller (rob@inpharmatica . co . uk)
5 * Copyright (c) 2003 Ron Lee (ron@debian.org)
6 * cPad driver for kernel 2.4
8 * Copyright (c) 2004 Jan Steinhoff (cpad@jan-steinhoff . de)
9 * Copyright (c) 2004 Ron Lee (ron@debian.org)
10 * rewritten for kernel 2.6
12 * cPad display character device part is not included. It can be found at
13 * http://jan-steinhoff.de/linux/synaptics-usb.html
15 * Bases on: usb_skeleton.c v2.2 by Greg Kroah-Hartman
16 * drivers/hid/usbhid/usbmouse.c by Vojtech Pavlik
17 * drivers/input/mouse/synaptics.c by Peter Osterlund
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License as published by the Free
21 * Software Foundation; either version 2 of the License, or (at your option)
24 * Trademarks are the property of their respective owners.
28 * There are three different types of Synaptics USB devices: Touchpads,
29 * touchsticks (or trackpoints), and touchscreens. Touchpads are well supported
30 * by this driver, touchstick support has not been tested much yet, and
31 * touchscreens have not been tested at all.
33 * Up to three alternate settings are possible:
34 * setting 0: one int endpoint for relative movement (used by usbhid.ko)
35 * setting 1: one int endpoint for absolute finger position
36 * setting 2 (cPad only): one int endpoint for absolute finger position and
37 * two bulk endpoints for the display (in/out)
38 * This driver uses setting 1.
41 #include <linux/kernel.h>
42 #include <linux/slab.h>
43 #include <linux/module.h>
44 #include <linux/moduleparam.h>
45 #include <linux/usb.h>
46 #include <linux/input.h>
47 #include <linux/usb/input.h>
49 #define USB_VENDOR_ID_SYNAPTICS 0x06cb
50 #define USB_DEVICE_ID_SYNAPTICS_TP 0x0001 /* Synaptics USB TouchPad */
51 #define USB_DEVICE_ID_SYNAPTICS_INT_TP 0x0002 /* Integrated USB TouchPad */
52 #define USB_DEVICE_ID_SYNAPTICS_CPAD 0x0003 /* Synaptics cPad */
53 #define USB_DEVICE_ID_SYNAPTICS_TS 0x0006 /* Synaptics TouchScreen */
54 #define USB_DEVICE_ID_SYNAPTICS_STICK 0x0007 /* Synaptics USB Styk */
55 #define USB_DEVICE_ID_SYNAPTICS_WP 0x0008 /* Synaptics USB WheelPad */
56 #define USB_DEVICE_ID_SYNAPTICS_COMP_TP 0x0009 /* Composite USB TouchPad */
57 #define USB_DEVICE_ID_SYNAPTICS_WTP 0x0010 /* Wireless TouchPad */
58 #define USB_DEVICE_ID_SYNAPTICS_DPAD 0x0013 /* DisplayPad */
60 #define SYNUSB_TOUCHPAD (1 << 0)
61 #define SYNUSB_STICK (1 << 1)
62 #define SYNUSB_TOUCHSCREEN (1 << 2)
63 #define SYNUSB_AUXDISPLAY (1 << 3) /* For cPad */
64 #define SYNUSB_COMBO (1 << 4) /* Composite device (TP + stick) */
65 #define SYNUSB_IO_ALWAYS (1 << 5)
67 #define USB_DEVICE_SYNAPTICS(prod, kind) \
68 USB_DEVICE(USB_VENDOR_ID_SYNAPTICS, \
69 USB_DEVICE_ID_SYNAPTICS_##prod), \
70 .driver_info = (kind),
72 #define SYNUSB_RECV_SIZE 8
74 #define XMIN_NOMINAL 1472
75 #define XMAX_NOMINAL 5472
76 #define YMIN_NOMINAL 1408
77 #define YMAX_NOMINAL 4448
80 struct usb_device *udev;
81 struct usb_interface *intf;
85 /* input device related data structures */
86 struct input_dev *input;
90 /* characteristics of the device */
94 static void synusb_report_buttons(struct synusb *synusb)
96 struct input_dev *input_dev = synusb->input;
98 input_report_key(input_dev, BTN_LEFT, synusb->data[1] & 0x04);
99 input_report_key(input_dev, BTN_RIGHT, synusb->data[1] & 0x01);
100 input_report_key(input_dev, BTN_MIDDLE, synusb->data[1] & 0x02);
103 static void synusb_report_stick(struct synusb *synusb)
105 struct input_dev *input_dev = synusb->input;
107 unsigned int pressure;
109 pressure = synusb->data[6];
110 x = (s16)(be16_to_cpup((__be16 *)&synusb->data[2]) << 3) >> 7;
111 y = (s16)(be16_to_cpup((__be16 *)&synusb->data[4]) << 3) >> 7;
114 input_report_rel(input_dev, REL_X, x);
115 input_report_rel(input_dev, REL_Y, -y);
118 input_report_abs(input_dev, ABS_PRESSURE, pressure);
120 synusb_report_buttons(synusb);
122 input_sync(input_dev);
125 static void synusb_report_touchpad(struct synusb *synusb)
127 struct input_dev *input_dev = synusb->input;
128 unsigned int num_fingers, tool_width;
130 unsigned int pressure, w;
132 pressure = synusb->data[6];
133 x = be16_to_cpup((__be16 *)&synusb->data[2]);
134 y = be16_to_cpup((__be16 *)&synusb->data[4]);
135 w = synusb->data[0] & 0x0f;
145 case 2: /* pen, pretend its a finger */
159 * BTN_TOUCH has to be first as mousedev relies on it when doing
160 * absolute -> relative conversion
164 input_report_key(input_dev, BTN_TOUCH, 1);
166 input_report_key(input_dev, BTN_TOUCH, 0);
168 if (num_fingers > 0) {
169 input_report_abs(input_dev, ABS_X, x);
170 input_report_abs(input_dev, ABS_Y,
171 YMAX_NOMINAL + YMIN_NOMINAL - y);
174 input_report_abs(input_dev, ABS_PRESSURE, pressure);
175 input_report_abs(input_dev, ABS_TOOL_WIDTH, tool_width);
177 input_report_key(input_dev, BTN_TOOL_FINGER, num_fingers == 1);
178 input_report_key(input_dev, BTN_TOOL_DOUBLETAP, num_fingers == 2);
179 input_report_key(input_dev, BTN_TOOL_TRIPLETAP, num_fingers == 3);
181 synusb_report_buttons(synusb);
182 if (synusb->flags & SYNUSB_AUXDISPLAY)
183 input_report_key(input_dev, BTN_MIDDLE, synusb->data[1] & 0x08);
185 input_sync(input_dev);
188 static void synusb_irq(struct urb *urb)
190 struct synusb *synusb = urb->context;
193 /* Check our status in case we need to bail out early. */
194 switch (urb->status) {
196 usb_mark_last_busy(synusb->udev);
199 /* Device went away so don't keep trying to read from it. */
210 if (synusb->flags & SYNUSB_STICK)
211 synusb_report_stick(synusb);
213 synusb_report_touchpad(synusb);
216 error = usb_submit_urb(urb, GFP_ATOMIC);
217 if (error && error != -EPERM)
218 dev_err(&synusb->intf->dev,
219 "%s - usb_submit_urb failed with result: %d",
223 static struct usb_endpoint_descriptor *
224 synusb_get_in_endpoint(struct usb_host_interface *iface)
227 struct usb_endpoint_descriptor *endpoint;
230 for (i = 0; i < iface->desc.bNumEndpoints; ++i) {
231 endpoint = &iface->endpoint[i].desc;
233 if (usb_endpoint_is_int_in(endpoint)) {
234 /* we found our interrupt in endpoint */
242 static int synusb_open(struct input_dev *dev)
244 struct synusb *synusb = input_get_drvdata(dev);
247 retval = usb_autopm_get_interface(synusb->intf);
249 dev_err(&synusb->intf->dev,
250 "%s - usb_autopm_get_interface failed, error: %d\n",
255 retval = usb_submit_urb(synusb->urb, GFP_KERNEL);
257 dev_err(&synusb->intf->dev,
258 "%s - usb_submit_urb failed, error: %d\n",
264 synusb->intf->needs_remote_wakeup = 1;
267 usb_autopm_put_interface(synusb->intf);
271 static void synusb_close(struct input_dev *dev)
273 struct synusb *synusb = input_get_drvdata(dev);
276 autopm_error = usb_autopm_get_interface(synusb->intf);
278 usb_kill_urb(synusb->urb);
279 synusb->intf->needs_remote_wakeup = 0;
282 usb_autopm_put_interface(synusb->intf);
285 static int synusb_probe(struct usb_interface *intf,
286 const struct usb_device_id *id)
288 struct usb_device *udev = interface_to_usbdev(intf);
289 struct usb_endpoint_descriptor *ep;
290 struct synusb *synusb;
291 struct input_dev *input_dev;
292 unsigned int intf_num = intf->cur_altsetting->desc.bInterfaceNumber;
293 unsigned int altsetting = min(intf->num_altsetting, 1U);
296 error = usb_set_interface(udev, intf_num, altsetting);
299 "Can not set alternate setting to %i, error: %i",
304 ep = synusb_get_in_endpoint(intf->cur_altsetting);
308 synusb = kzalloc(sizeof(*synusb), GFP_KERNEL);
309 input_dev = input_allocate_device();
310 if (!synusb || !input_dev) {
317 synusb->input = input_dev;
319 synusb->flags = id->driver_info;
320 if (synusb->flags & SYNUSB_COMBO) {
322 * This is a combo device, we need to set proper
323 * capability, depending on the interface.
325 synusb->flags |= intf_num == 1 ?
326 SYNUSB_STICK : SYNUSB_TOUCHPAD;
329 synusb->urb = usb_alloc_urb(0, GFP_KERNEL);
335 synusb->data = usb_alloc_coherent(udev, SYNUSB_RECV_SIZE, GFP_KERNEL,
336 &synusb->urb->transfer_dma);
342 usb_fill_int_urb(synusb->urb, udev,
343 usb_rcvintpipe(udev, ep->bEndpointAddress),
344 synusb->data, SYNUSB_RECV_SIZE,
347 synusb->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
349 if (udev->manufacturer)
350 strlcpy(synusb->name, udev->manufacturer,
351 sizeof(synusb->name));
354 if (udev->manufacturer)
355 strlcat(synusb->name, " ", sizeof(synusb->name));
356 strlcat(synusb->name, udev->product, sizeof(synusb->name));
359 if (!strlen(synusb->name))
360 snprintf(synusb->name, sizeof(synusb->name),
361 "USB Synaptics Device %04x:%04x",
362 le16_to_cpu(udev->descriptor.idVendor),
363 le16_to_cpu(udev->descriptor.idProduct));
365 if (synusb->flags & SYNUSB_STICK)
366 strlcat(synusb->name, " (Stick)", sizeof(synusb->name));
368 usb_make_path(udev, synusb->phys, sizeof(synusb->phys));
369 strlcat(synusb->phys, "/input0", sizeof(synusb->phys));
371 input_dev->name = synusb->name;
372 input_dev->phys = synusb->phys;
373 usb_to_input_id(udev, &input_dev->id);
374 input_dev->dev.parent = &synusb->intf->dev;
376 if (!(synusb->flags & SYNUSB_IO_ALWAYS)) {
377 input_dev->open = synusb_open;
378 input_dev->close = synusb_close;
381 input_set_drvdata(input_dev, synusb);
383 __set_bit(EV_ABS, input_dev->evbit);
384 __set_bit(EV_KEY, input_dev->evbit);
386 if (synusb->flags & SYNUSB_STICK) {
387 __set_bit(EV_REL, input_dev->evbit);
388 __set_bit(REL_X, input_dev->relbit);
389 __set_bit(REL_Y, input_dev->relbit);
390 __set_bit(INPUT_PROP_POINTING_STICK, input_dev->propbit);
391 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 127, 0, 0);
393 input_set_abs_params(input_dev, ABS_X,
394 XMIN_NOMINAL, XMAX_NOMINAL, 0, 0);
395 input_set_abs_params(input_dev, ABS_Y,
396 YMIN_NOMINAL, YMAX_NOMINAL, 0, 0);
397 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
398 input_set_abs_params(input_dev, ABS_TOOL_WIDTH, 0, 15, 0, 0);
399 __set_bit(BTN_TOUCH, input_dev->keybit);
400 __set_bit(BTN_TOOL_FINGER, input_dev->keybit);
401 __set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
402 __set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
405 __set_bit(BTN_LEFT, input_dev->keybit);
406 __set_bit(BTN_RIGHT, input_dev->keybit);
407 __set_bit(BTN_MIDDLE, input_dev->keybit);
409 usb_set_intfdata(intf, synusb);
411 if (synusb->flags & SYNUSB_IO_ALWAYS) {
412 error = synusb_open(input_dev);
417 error = input_register_device(input_dev);
420 "Failed to register input device, error %d\n",
428 if (synusb->flags & SYNUSB_IO_ALWAYS)
429 synusb_close(synusb->input);
431 usb_free_coherent(udev, SYNUSB_RECV_SIZE, synusb->data,
432 synusb->urb->transfer_dma);
434 usb_free_urb(synusb->urb);
436 input_free_device(input_dev);
438 usb_set_intfdata(intf, NULL);
443 static void synusb_disconnect(struct usb_interface *intf)
445 struct synusb *synusb = usb_get_intfdata(intf);
446 struct usb_device *udev = interface_to_usbdev(intf);
448 if (synusb->flags & SYNUSB_IO_ALWAYS)
449 synusb_close(synusb->input);
451 input_unregister_device(synusb->input);
453 usb_free_coherent(udev, SYNUSB_RECV_SIZE, synusb->data,
454 synusb->urb->transfer_dma);
455 usb_free_urb(synusb->urb);
458 usb_set_intfdata(intf, NULL);
461 static int synusb_suspend(struct usb_interface *intf, pm_message_t message)
463 struct synusb *synusb = usb_get_intfdata(intf);
464 struct input_dev *input_dev = synusb->input;
466 mutex_lock(&input_dev->mutex);
467 usb_kill_urb(synusb->urb);
468 mutex_unlock(&input_dev->mutex);
473 static int synusb_resume(struct usb_interface *intf)
475 struct synusb *synusb = usb_get_intfdata(intf);
476 struct input_dev *input_dev = synusb->input;
479 mutex_lock(&input_dev->mutex);
481 if ((input_dev->users || (synusb->flags & SYNUSB_IO_ALWAYS)) &&
482 usb_submit_urb(synusb->urb, GFP_NOIO) < 0) {
486 mutex_unlock(&input_dev->mutex);
491 static int synusb_pre_reset(struct usb_interface *intf)
493 struct synusb *synusb = usb_get_intfdata(intf);
494 struct input_dev *input_dev = synusb->input;
496 mutex_lock(&input_dev->mutex);
497 usb_kill_urb(synusb->urb);
502 static int synusb_post_reset(struct usb_interface *intf)
504 struct synusb *synusb = usb_get_intfdata(intf);
505 struct input_dev *input_dev = synusb->input;
508 if ((input_dev->users || (synusb->flags & SYNUSB_IO_ALWAYS)) &&
509 usb_submit_urb(synusb->urb, GFP_NOIO) < 0) {
513 mutex_unlock(&input_dev->mutex);
518 static int synusb_reset_resume(struct usb_interface *intf)
520 return synusb_resume(intf);
523 static struct usb_device_id synusb_idtable[] = {
524 { USB_DEVICE_SYNAPTICS(TP, SYNUSB_TOUCHPAD) },
525 { USB_DEVICE_SYNAPTICS(INT_TP, SYNUSB_TOUCHPAD) },
526 { USB_DEVICE_SYNAPTICS(CPAD,
527 SYNUSB_TOUCHPAD | SYNUSB_AUXDISPLAY | SYNUSB_IO_ALWAYS) },
528 { USB_DEVICE_SYNAPTICS(TS, SYNUSB_TOUCHSCREEN) },
529 { USB_DEVICE_SYNAPTICS(STICK, SYNUSB_STICK) },
530 { USB_DEVICE_SYNAPTICS(WP, SYNUSB_TOUCHPAD) },
531 { USB_DEVICE_SYNAPTICS(COMP_TP, SYNUSB_COMBO) },
532 { USB_DEVICE_SYNAPTICS(WTP, SYNUSB_TOUCHPAD) },
533 { USB_DEVICE_SYNAPTICS(DPAD, SYNUSB_TOUCHPAD) },
536 MODULE_DEVICE_TABLE(usb, synusb_idtable);
538 static struct usb_driver synusb_driver = {
539 .name = "synaptics_usb",
540 .probe = synusb_probe,
541 .disconnect = synusb_disconnect,
542 .id_table = synusb_idtable,
543 .suspend = synusb_suspend,
544 .resume = synusb_resume,
545 .pre_reset = synusb_pre_reset,
546 .post_reset = synusb_post_reset,
547 .reset_resume = synusb_reset_resume,
548 .supports_autosuspend = 1,
551 module_usb_driver(synusb_driver);
553 MODULE_AUTHOR("Rob Miller <rob@inpharmatica.co.uk>, "
554 "Ron Lee <ron@debian.org>, "
555 "Jan Steinhoff <cpad@jan-steinhoff.de>");
556 MODULE_DESCRIPTION("Synaptics USB device driver");
557 MODULE_LICENSE("GPL");