HID: fix compilation of hidbp drivers without usbhid
[linux-2.6.git] / drivers / hid / usbhid / 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 #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
44 MODULE_AUTHOR(DRIVER_AUTHOR);
45 MODULE_DESCRIPTION(DRIVER_DESC);
46 MODULE_LICENSE(DRIVER_LICENSE);
47
48 static 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
67 struct 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 cr_dma;
80         dma_addr_t new_dma;
81         dma_addr_t leds_dma;
82 };
83
84 static void usb_kbd_irq(struct urb *urb)
85 {
86         struct usb_kbd *kbd = urb->context;
87         int i;
88
89         switch (urb->status) {
90         case 0:                 /* success */
91                 break;
92         case -ECONNRESET:       /* unlink */
93         case -ENOENT:
94         case -ESHUTDOWN:
95                 return;
96         /* -EPIPE:  should clear the halt */
97         default:                /* error */
98                 goto resubmit;
99         }
100
101         for (i = 0; i < 8; i++)
102                 input_report_key(kbd->dev, usb_kbd_keycode[i + 224], (kbd->new[0] >> i) & 1);
103
104         for (i = 2; i < 8; i++) {
105
106                 if (kbd->old[i] > 3 && memscan(kbd->new + 2, kbd->old[i], 6) == kbd->new + 8) {
107                         if (usb_kbd_keycode[kbd->old[i]])
108                                 input_report_key(kbd->dev, usb_kbd_keycode[kbd->old[i]], 0);
109                         else
110                                 info("Unknown key (scancode %#x) released.", kbd->old[i]);
111                 }
112
113                 if (kbd->new[i] > 3 && memscan(kbd->old + 2, kbd->new[i], 6) == kbd->old + 8) {
114                         if (usb_kbd_keycode[kbd->new[i]])
115                                 input_report_key(kbd->dev, usb_kbd_keycode[kbd->new[i]], 1);
116                         else
117                                 info("Unknown key (scancode %#x) pressed.", kbd->new[i]);
118                 }
119         }
120
121         input_sync(kbd->dev);
122
123         memcpy(kbd->old, kbd->new, 8);
124
125 resubmit:
126         i = usb_submit_urb (urb, GFP_ATOMIC);
127         if (i)
128                 err_hid ("can't resubmit intr, %s-%s/input0, status %d",
129                                 kbd->usbdev->bus->bus_name,
130                                 kbd->usbdev->devpath, i);
131 }
132
133 static int usb_kbd_event(struct input_dev *dev, unsigned int type,
134                          unsigned int code, int value)
135 {
136         struct usb_kbd *kbd = input_get_drvdata(dev);
137
138         if (type != EV_LED)
139                 return -1;
140
141         kbd->newleds = (!!test_bit(LED_KANA,    dev->led) << 3) | (!!test_bit(LED_COMPOSE, dev->led) << 3) |
142                        (!!test_bit(LED_SCROLLL, dev->led) << 2) | (!!test_bit(LED_CAPSL,   dev->led) << 1) |
143                        (!!test_bit(LED_NUML,    dev->led));
144
145         if (kbd->led->status == -EINPROGRESS)
146                 return 0;
147
148         if (*(kbd->leds) == kbd->newleds)
149                 return 0;
150
151         *(kbd->leds) = kbd->newleds;
152         kbd->led->dev = kbd->usbdev;
153         if (usb_submit_urb(kbd->led, GFP_ATOMIC))
154                 err_hid("usb_submit_urb(leds) failed");
155
156         return 0;
157 }
158
159 static void usb_kbd_led(struct urb *urb)
160 {
161         struct usb_kbd *kbd = urb->context;
162
163         if (urb->status)
164                 warn("led urb status %d received", urb->status);
165
166         if (*(kbd->leds) == kbd->newleds)
167                 return;
168
169         *(kbd->leds) = kbd->newleds;
170         kbd->led->dev = kbd->usbdev;
171         if (usb_submit_urb(kbd->led, GFP_ATOMIC))
172                 err_hid("usb_submit_urb(leds) failed");
173 }
174
175 static int usb_kbd_open(struct input_dev *dev)
176 {
177         struct usb_kbd *kbd = input_get_drvdata(dev);
178
179         kbd->irq->dev = kbd->usbdev;
180         if (usb_submit_urb(kbd->irq, GFP_KERNEL))
181                 return -EIO;
182
183         return 0;
184 }
185
186 static void usb_kbd_close(struct input_dev *dev)
187 {
188         struct usb_kbd *kbd = input_get_drvdata(dev);
189
190         usb_kill_urb(kbd->irq);
191 }
192
193 static int usb_kbd_alloc_mem(struct usb_device *dev, struct usb_kbd *kbd)
194 {
195         if (!(kbd->irq = usb_alloc_urb(0, GFP_KERNEL)))
196                 return -1;
197         if (!(kbd->led = usb_alloc_urb(0, GFP_KERNEL)))
198                 return -1;
199         if (!(kbd->new = usb_buffer_alloc(dev, 8, GFP_ATOMIC, &kbd->new_dma)))
200                 return -1;
201         if (!(kbd->cr = usb_buffer_alloc(dev, sizeof(struct usb_ctrlrequest), GFP_ATOMIC, &kbd->cr_dma)))
202                 return -1;
203         if (!(kbd->leds = usb_buffer_alloc(dev, 1, GFP_ATOMIC, &kbd->leds_dma)))
204                 return -1;
205
206         return 0;
207 }
208
209 static void usb_kbd_free_mem(struct usb_device *dev, struct usb_kbd *kbd)
210 {
211         usb_free_urb(kbd->irq);
212         usb_free_urb(kbd->led);
213         usb_buffer_free(dev, 8, kbd->new, kbd->new_dma);
214         usb_buffer_free(dev, sizeof(struct usb_ctrlrequest), kbd->cr, kbd->cr_dma);
215         usb_buffer_free(dev, 1, kbd->leds, kbd->leds_dma);
216 }
217
218 static int usb_kbd_probe(struct usb_interface *iface,
219                          const struct usb_device_id *id)
220 {
221         struct usb_device *dev = interface_to_usbdev(iface);
222         struct usb_host_interface *interface;
223         struct usb_endpoint_descriptor *endpoint;
224         struct usb_kbd *kbd;
225         struct input_dev *input_dev;
226         int i, pipe, maxp;
227         int error = -ENOMEM;
228
229         interface = iface->cur_altsetting;
230
231         if (interface->desc.bNumEndpoints != 1)
232                 return -ENODEV;
233
234         endpoint = &interface->endpoint[0].desc;
235         if (!usb_endpoint_is_int_in(endpoint))
236                 return -ENODEV;
237
238 #ifdef CONFIG_USB_HID
239         if (usbhid_lookup_quirk(le16_to_cpu(dev->descriptor.idVendor),
240                                 le16_to_cpu(dev->descriptor.idProduct))
241                         & HID_QUIRK_IGNORE) {
242                 return -ENODEV;
243         }
244 #endif
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->dev.parent = &iface->dev;
282
283         input_set_drvdata(input_dev, kbd);
284
285         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
286                 BIT_MASK(EV_REP);
287         input_dev->ledbit[0] = BIT_MASK(LED_NUML) | BIT_MASK(LED_CAPSL) |
288                 BIT_MASK(LED_SCROLLL) | BIT_MASK(LED_COMPOSE) |
289                 BIT_MASK(LED_KANA);
290
291         for (i = 0; i < 255; i++)
292                 set_bit(usb_kbd_keycode[i], input_dev->keybit);
293         clear_bit(0, input_dev->keybit);
294
295         input_dev->event = usb_kbd_event;
296         input_dev->open = usb_kbd_open;
297         input_dev->close = usb_kbd_close;
298
299         usb_fill_int_urb(kbd->irq, dev, pipe,
300                          kbd->new, (maxp > 8 ? 8 : maxp),
301                          usb_kbd_irq, kbd, endpoint->bInterval);
302         kbd->irq->transfer_dma = kbd->new_dma;
303         kbd->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
304
305         kbd->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
306         kbd->cr->bRequest = 0x09;
307         kbd->cr->wValue = cpu_to_le16(0x200);
308         kbd->cr->wIndex = cpu_to_le16(interface->desc.bInterfaceNumber);
309         kbd->cr->wLength = cpu_to_le16(1);
310
311         usb_fill_control_urb(kbd->led, dev, usb_sndctrlpipe(dev, 0),
312                              (void *) kbd->cr, kbd->leds, 1,
313                              usb_kbd_led, kbd);
314         kbd->led->setup_dma = kbd->cr_dma;
315         kbd->led->transfer_dma = kbd->leds_dma;
316         kbd->led->transfer_flags |= (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP);
317
318         error = input_register_device(kbd->dev);
319         if (error)
320                 goto fail2;
321
322         usb_set_intfdata(iface, kbd);
323         return 0;
324
325 fail2:  
326         usb_kbd_free_mem(dev, kbd);
327 fail1:  
328         input_free_device(input_dev);
329         kfree(kbd);
330         return error;
331 }
332
333 static void usb_kbd_disconnect(struct usb_interface *intf)
334 {
335         struct usb_kbd *kbd = usb_get_intfdata (intf);
336
337         usb_set_intfdata(intf, NULL);
338         if (kbd) {
339                 usb_kill_urb(kbd->irq);
340                 input_unregister_device(kbd->dev);
341                 usb_kbd_free_mem(interface_to_usbdev(intf), kbd);
342                 kfree(kbd);
343         }
344 }
345
346 static struct usb_device_id usb_kbd_id_table [] = {
347         { USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
348                 USB_INTERFACE_PROTOCOL_KEYBOARD) },
349         { }                                             /* Terminating entry */
350 };
351
352 MODULE_DEVICE_TABLE (usb, usb_kbd_id_table);
353
354 static struct usb_driver usb_kbd_driver = {
355         .name =         "usbkbd",
356         .probe =        usb_kbd_probe,
357         .disconnect =   usb_kbd_disconnect,
358         .id_table =     usb_kbd_id_table,
359 };
360
361 static int __init usb_kbd_init(void)
362 {
363         int result = usb_register(&usb_kbd_driver);
364         if (result == 0)
365                 info(DRIVER_VERSION ":" DRIVER_DESC);
366         return result;
367 }
368
369 static void __exit usb_kbd_exit(void)
370 {
371         usb_deregister(&usb_kbd_driver);
372 }
373
374 module_init(usb_kbd_init);
375 module_exit(usb_kbd_exit);