drivers/usb/input/usbmouse.c

   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
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  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.
  19  *
  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
  23  *
  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>
  31 #include <linux/input.h>
  32 #include <linux/module.h>
  33 #include <linux/init.h>
  34 #include <linux/usb.h>
  35 #include <linux/usb_input.h>
  36
  37 /*
  38  * Version Information
  39  */
  40 #define DRIVER_VERSION "v1.6"
  41 #define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
  42 #define DRIVER_DESC "USB HID Boot Protocol mouse driver"
  43 #define DRIVER_LICENSE "GPL"
  44
  45 MODULE_AUTHOR(DRIVER_AUTHOR);
  46 MODULE_DESCRIPTION(DRIVER_DESC);
  47 MODULE_LICENSE(DRIVER_LICENSE);
  48
  49 struct usb_mouse {
  50         char name[128];
  51         char phys[64];
  52         struct usb_device *usbdev;
  53         struct input_dev *dev;
  54         struct urb *irq;
  55
  56         signed char *data;
  57         dma_addr_t data_dma;
  58 };
  59
  60 static void usb_mouse_irq(struct urb *urb, struct pt_regs *regs)
  61 {
  62         struct usb_mouse *mouse = urb->context;
  63         signed char *data = mouse->data;
  64         struct input_dev *dev = mouse->dev;
  65         int status;
  66
  67         switch (urb->status) {
  68         case 0:                 /* success */
  69                 break;
  70         case -ECONNRESET:       /* unlink */
  71         case -ENOENT:
  72         case -ESHUTDOWN:
  73                 return;
  74         /* -EPIPE:  should clear the halt */
  75         default:                /* error */
  76                 goto resubmit;
  77         }
  78
  79         input_regs(dev, regs);
  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);
  92 resubmit:
  93         status = usb_submit_urb (urb, SLAB_ATOMIC);
  94         if (status)
  95                 err ("can't resubmit intr, %s-%s/input0, status %d",
  96                                 mouse->usbdev->bus->bus_name,
  97                                 mouse->usbdev->devpath, status);
  98 }
  99
 100 static int usb_mouse_open(struct input_dev *dev)
 101 {
 102         struct usb_mouse *mouse = dev->private;
 103
 104         mouse->irq->dev = mouse->usbdev;
 105         if (usb_submit_urb(mouse->irq, GFP_KERNEL))
 106                 return -EIO;
 107
 108         return 0;
 109 }
 110
 111 static void usb_mouse_close(struct input_dev *dev)
 112 {
 113         struct usb_mouse *mouse = dev->private;
 114
 115         usb_kill_urb(mouse->irq);
 116 }
 117
 118 static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)
 119 {
 120         struct usb_device *dev = interface_to_usbdev(intf);
 121         struct usb_host_interface *interface;
 122         struct usb_endpoint_descriptor *endpoint;
 123         struct usb_mouse *mouse;
 124         struct input_dev *input_dev;
 125         int pipe, maxp;
 126
 127         interface = intf->cur_altsetting;
 128
 129         if (interface->desc.bNumEndpoints != 1)
 130                 return -ENODEV;
 131
 132         endpoint = &interface->endpoint[0].desc;
 133         if (!(endpoint->bEndpointAddress & USB_DIR_IN))
 134                 return -ENODEV;
 135         if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
 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_buffer_alloc(dev, 8, SLAB_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->cdev.dev = &intf->dev;
 179
 180         input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
 181         input_dev->keybit[LONG(BTN_MOUSE)] = BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE);
 182         input_dev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
 183         input_dev->keybit[LONG(BTN_MOUSE)] |= BIT(BTN_SIDE) | BIT(BTN_EXTRA);
 184         input_dev->relbit[0] |= BIT(REL_WHEEL);
 185
 186         input_dev->private = mouse;
 187         input_dev->open = usb_mouse_open;
 188         input_dev->close = usb_mouse_close;
 189
 190         usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data,
 191                          (maxp > 8 ? 8 : maxp),
 192                          usb_mouse_irq, mouse, endpoint->bInterval);
 193         mouse->irq->transfer_dma = mouse->data_dma;
 194         mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 195
 196         input_register_device(mouse->dev);
 197
 198         usb_set_intfdata(intf, mouse);
 199         return 0;
 200
 201 fail2:  usb_buffer_free(dev, 8, mouse->data, mouse->data_dma);
 202 fail1:  input_free_device(input_dev);
 203         kfree(mouse);
 204         return -ENOMEM;
 205 }
 206
 207 static void usb_mouse_disconnect(struct usb_interface *intf)
 208 {
 209         struct usb_mouse *mouse = usb_get_intfdata (intf);
 210
 211         usb_set_intfdata(intf, NULL);
 212         if (mouse) {
 213                 usb_kill_urb(mouse->irq);
 214                 input_unregister_device(mouse->dev);
 215                 usb_free_urb(mouse->irq);
 216                 usb_buffer_free(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
 217                 kfree(mouse);
 218         }
 219 }
 220
 221 static struct usb_device_id usb_mouse_id_table [] = {
 222         { USB_INTERFACE_INFO(3, 1, 2) },
 223     { }                                         /* Terminating entry */
 224 };
 225
 226 MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);
 227
 228 static struct usb_driver usb_mouse_driver = {
 229         .name           = "usbmouse",
 230         .probe          = usb_mouse_probe,
 231         .disconnect     = usb_mouse_disconnect,
 232         .id_table       = usb_mouse_id_table,
 233 };
 234
 235 static int __init usb_mouse_init(void)
 236 {
 237         int retval = usb_register(&usb_mouse_driver);
 238         if (retval == 0)
 239                 info(DRIVER_VERSION ":" DRIVER_DESC);
 240         return retval;
 241 }
 242
 243 static void __exit usb_mouse_exit(void)
 244 {
 245         usb_deregister(&usb_mouse_driver);
 246 }
 247
 248 module_init(usb_mouse_init);
 249 module_exit(usb_mouse_exit);