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