linux/drivers/hid/usbhid/usbkbd.c
<<
>>
Prefs
   1/*
   2 *  Copyright (c) 1999-2001 Vojtech Pavlik
   3 *
   4 *  USB HIDBP Keyboard 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#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  28
  29#include <linux/kernel.h>
  30#include <linux/slab.h>
  31#include <linux/module.h>
  32#include <linux/init.h>
  33#include <linux/usb/input.h>
  34#include <linux/hid.h>
  35
  36/*
  37 * Version Information
  38 */
  39#define DRIVER_VERSION ""
  40#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
  41#define DRIVER_DESC "USB HID Boot Protocol keyboard driver"
  42#define DRIVER_LICENSE "GPL"
  43
  44MODULE_AUTHOR(DRIVER_AUTHOR);
  45MODULE_DESCRIPTION(DRIVER_DESC);
  46MODULE_LICENSE(DRIVER_LICENSE);
  47
  48static const unsigned char usb_kbd_keycode[256] = {
  49          0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
  50         50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
  51          4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
  52         27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
  53         65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
  54        105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
  55         72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
  56        191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
  57        115,114,  0,  0,  0,121,  0, 89, 93,124, 92, 94, 95,  0,  0,  0,
  58        122,123, 90, 91, 85,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
  59          0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
  60          0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
  61          0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
  62          0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
  63         29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
  64        150,158,159,128,136,177,178,176,142,152,173,140
  65};
  66
  67struct usb_kbd {
  68        struct input_dev *dev;
  69        struct usb_device *usbdev;
  70        unsigned char old[8];
  71        struct urb *irq, *led;
  72        unsigned char newleds;
  73        char name[128];
  74        char phys[64];
  75
  76        unsigned char *new;
  77        struct usb_ctrlrequest *cr;
  78        unsigned char *leds;
  79        dma_addr_t new_dma;
  80        dma_addr_t leds_dma;
  81};
  82
  83static void usb_kbd_irq(struct urb *urb)
  84{
  85        struct usb_kbd *kbd = urb->context;
  86        int i;
  87
  88        switch (urb->status) {
  89        case 0:                 /* success */
  90                break;
  91        case -ECONNRESET:       /* unlink */
  92        case -ENOENT:
  93        case -ESHUTDOWN:
  94                return;
  95        /* -EPIPE:  should clear the halt */
  96        default:                /* error */
  97                goto resubmit;
  98        }
  99
 100        for (i = 0; i < 8; i++)
 101                input_report_key(kbd->dev, usb_kbd_keycode[i + 224], (kbd->new[0] >> i) & 1);
 102
 103        for (i = 2; i < 8; i++) {
 104
 105                if (kbd->old[i] > 3 && memscan(kbd->new + 2, kbd->old[i], 6) == kbd->new + 8) {
 106                        if (usb_kbd_keycode[kbd->old[i]])
 107                                input_report_key(kbd->dev, usb_kbd_keycode[kbd->old[i]], 0);
 108                        else
 109                                hid_info(urb->dev,
 110                                         "Unknown key (scancode %#x) released.\n",
 111                                         kbd->old[i]);
 112                }
 113
 114                if (kbd->new[i] > 3 && memscan(kbd->old + 2, kbd->new[i], 6) == kbd->old + 8) {
 115                        if (usb_kbd_keycode[kbd->new[i]])
 116                                input_report_key(kbd->dev, usb_kbd_keycode[kbd->new[i]], 1);
 117                        else
 118                                hid_info(urb->dev,
 119                                         "Unknown key (scancode %#x) released.\n",
 120                                         kbd->new[i]);
 121                }
 122        }
 123
 124        input_sync(kbd->dev);
 125
 126        memcpy(kbd->old, kbd->new, 8);
 127
 128resubmit:
 129        i = usb_submit_urb (urb, GFP_ATOMIC);
 130        if (i)
 131                hid_err(urb->dev, "can't resubmit intr, %s-%s/input0, status %d",
 132                        kbd->usbdev->bus->bus_name,
 133                        kbd->usbdev->devpath, i);
 134}
 135
 136static int usb_kbd_event(struct input_dev *dev, unsigned int type,
 137                         unsigned int code, int value)
 138{
 139        struct usb_kbd *kbd = input_get_drvdata(dev);
 140
 141        if (type != EV_LED)
 142                return -1;
 143
 144        kbd->newleds = (!!test_bit(LED_KANA,    dev->led) << 3) | (!!test_bit(LED_COMPOSE, dev->led) << 3) |
 145                       (!!test_bit(LED_SCROLLL, dev->led) << 2) | (!!test_bit(LED_CAPSL,   dev->led) << 1) |
 146                       (!!test_bit(LED_NUML,    dev->led));
 147
 148        if (kbd->led->status == -EINPROGRESS)
 149                return 0;
 150
 151        if (*(kbd->leds) == kbd->newleds)
 152                return 0;
 153
 154        *(kbd->leds) = kbd->newleds;
 155        kbd->led->dev = kbd->usbdev;
 156        if (usb_submit_urb(kbd->led, GFP_ATOMIC))
 157                pr_err("usb_submit_urb(leds) failed\n");
 158
 159        return 0;
 160}
 161
 162static void usb_kbd_led(struct urb *urb)
 163{
 164        struct usb_kbd *kbd = urb->context;
 165
 166        if (urb->status)
 167                hid_warn(urb->dev, "led urb status %d received\n",
 168                         urb->status);
 169
 170        if (*(kbd->leds) == kbd->newleds)
 171                return;
 172
 173        *(kbd->leds) = kbd->newleds;
 174        kbd->led->dev = kbd->usbdev;
 175        if (usb_submit_urb(kbd->led, GFP_ATOMIC))
 176                hid_err(urb->dev, "usb_submit_urb(leds) failed\n");
 177}
 178
 179static int usb_kbd_open(struct input_dev *dev)
 180{
 181        struct usb_kbd *kbd = input_get_drvdata(dev);
 182
 183        kbd->irq->dev = kbd->usbdev;
 184        if (usb_submit_urb(kbd->irq, GFP_KERNEL))
 185                return -EIO;
 186
 187        return 0;
 188}
 189
 190static void usb_kbd_close(struct input_dev *dev)
 191{
 192        struct usb_kbd *kbd = input_get_drvdata(dev);
 193
 194        usb_kill_urb(kbd->irq);
 195}
 196
 197static int usb_kbd_alloc_mem(struct usb_device *dev, struct usb_kbd *kbd)
 198{
 199        if (!(kbd->irq = usb_alloc_urb(0, GFP_KERNEL)))
 200                return -1;
 201        if (!(kbd->led = usb_alloc_urb(0, GFP_KERNEL)))
 202                return -1;
 203        if (!(kbd->new = usb_alloc_coherent(dev, 8, GFP_ATOMIC, &kbd->new_dma)))
 204                return -1;
 205        if (!(kbd->cr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL)))
 206                return -1;
 207        if (!(kbd->leds = usb_alloc_coherent(dev, 1, GFP_ATOMIC, &kbd->leds_dma)))
 208                return -1;
 209
 210        return 0;
 211}
 212
 213static void usb_kbd_free_mem(struct usb_device *dev, struct usb_kbd *kbd)
 214{
 215        usb_free_urb(kbd->irq);
 216        usb_free_urb(kbd->led);
 217        usb_free_coherent(dev, 8, kbd->new, kbd->new_dma);
 218        kfree(kbd->cr);
 219        usb_free_coherent(dev, 1, kbd->leds, kbd->leds_dma);
 220}
 221
 222static int usb_kbd_probe(struct usb_interface *iface,
 223                         const struct usb_device_id *id)
 224{
 225        struct usb_device *dev = interface_to_usbdev(iface);
 226        struct usb_host_interface *interface;
 227        struct usb_endpoint_descriptor *endpoint;
 228        struct usb_kbd *kbd;
 229        struct input_dev *input_dev;
 230        int i, pipe, maxp;
 231        int error = -ENOMEM;
 232
 233        interface = iface->cur_altsetting;
 234
 235        if (interface->desc.bNumEndpoints != 1)
 236                return -ENODEV;
 237
 238        endpoint = &interface->endpoint[0].desc;
 239        if (!usb_endpoint_is_int_in(endpoint))
 240                return -ENODEV;
 241
 242        pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
 243        maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
 244
 245        kbd = kzalloc(sizeof(struct usb_kbd), GFP_KERNEL);
 246        input_dev = input_allocate_device();
 247        if (!kbd || !input_dev)
 248                goto fail1;
 249
 250        if (usb_kbd_alloc_mem(dev, kbd))
 251                goto fail2;
 252
 253        kbd->usbdev = dev;
 254        kbd->dev = input_dev;
 255
 256        if (dev->manufacturer)
 257                strlcpy(kbd->name, dev->manufacturer, sizeof(kbd->name));
 258
 259        if (dev->product) {
 260                if (dev->manufacturer)
 261                        strlcat(kbd->name, " ", sizeof(kbd->name));
 262                strlcat(kbd->name, dev->product, sizeof(kbd->name));
 263        }
 264
 265        if (!strlen(kbd->name))
 266                snprintf(kbd->name, sizeof(kbd->name),
 267                         "USB HIDBP Keyboard %04x:%04x",
 268                         le16_to_cpu(dev->descriptor.idVendor),
 269                         le16_to_cpu(dev->descriptor.idProduct));
 270
 271        usb_make_path(dev, kbd->phys, sizeof(kbd->phys));
 272        strlcat(kbd->phys, "/input0", sizeof(kbd->phys));
 273
 274        input_dev->name = kbd->name;
 275        input_dev->phys = kbd->phys;
 276        usb_to_input_id(dev, &input_dev->id);
 277        input_dev->dev.parent = &iface->dev;
 278
 279        input_set_drvdata(input_dev, kbd);
 280
 281        input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
 282                BIT_MASK(EV_REP);
 283        input_dev->ledbit[0] = BIT_MASK(LED_NUML) | BIT_MASK(LED_CAPSL) |
 284                BIT_MASK(LED_SCROLLL) | BIT_MASK(LED_COMPOSE) |
 285                BIT_MASK(LED_KANA);
 286
 287        for (i = 0; i < 255; i++)
 288                set_bit(usb_kbd_keycode[i], input_dev->keybit);
 289        clear_bit(0, input_dev->keybit);
 290
 291        input_dev->event = usb_kbd_event;
 292        input_dev->open = usb_kbd_open;
 293        input_dev->close = usb_kbd_close;
 294
 295        usb_fill_int_urb(kbd->irq, dev, pipe,
 296                         kbd->new, (maxp > 8 ? 8 : maxp),
 297                         usb_kbd_irq, kbd, endpoint->bInterval);
 298        kbd->irq->transfer_dma = kbd->new_dma;
 299        kbd->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 300
 301        kbd->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
 302        kbd->cr->bRequest = 0x09;
 303        kbd->cr->wValue = cpu_to_le16(0x200);
 304        kbd->cr->wIndex = cpu_to_le16(interface->desc.bInterfaceNumber);
 305        kbd->cr->wLength = cpu_to_le16(1);
 306
 307        usb_fill_control_urb(kbd->led, dev, usb_sndctrlpipe(dev, 0),
 308                             (void *) kbd->cr, kbd->leds, 1,
 309                             usb_kbd_led, kbd);
 310        kbd->led->transfer_dma = kbd->leds_dma;
 311        kbd->led->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 312
 313        error = input_register_device(kbd->dev);
 314        if (error)
 315                goto fail2;
 316
 317        usb_set_intfdata(iface, kbd);
 318        device_set_wakeup_enable(&dev->dev, 1);
 319        return 0;
 320
 321fail2:  
 322        usb_kbd_free_mem(dev, kbd);
 323fail1:  
 324        input_free_device(input_dev);
 325        kfree(kbd);
 326        return error;
 327}
 328
 329static void usb_kbd_disconnect(struct usb_interface *intf)
 330{
 331        struct usb_kbd *kbd = usb_get_intfdata (intf);
 332
 333        usb_set_intfdata(intf, NULL);
 334        if (kbd) {
 335                usb_kill_urb(kbd->irq);
 336                input_unregister_device(kbd->dev);
 337                usb_kbd_free_mem(interface_to_usbdev(intf), kbd);
 338                kfree(kbd);
 339        }
 340}
 341
 342static struct usb_device_id usb_kbd_id_table [] = {
 343        { USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
 344                USB_INTERFACE_PROTOCOL_KEYBOARD) },
 345        { }                                             /* Terminating entry */
 346};
 347
 348MODULE_DEVICE_TABLE (usb, usb_kbd_id_table);
 349
 350static struct usb_driver usb_kbd_driver = {
 351        .name =         "usbkbd",
 352        .probe =        usb_kbd_probe,
 353        .disconnect =   usb_kbd_disconnect,
 354        .id_table =     usb_kbd_id_table,
 355};
 356
 357static int __init usb_kbd_init(void)
 358{
 359        int result = usb_register(&usb_kbd_driver);
 360        if (result == 0)
 361                printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 362                                DRIVER_DESC "\n");
 363        return result;
 364}
 365
 366static void __exit usb_kbd_exit(void)
 367{
 368        usb_deregister(&usb_kbd_driver);
 369}
 370
 371module_init(usb_kbd_init);
 372module_exit(usb_kbd_exit);
 373