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