HID: move microsoft quirks
[linux-2.6.git] / drivers / hid / usbhid / hid-quirks.c
1 /*
2  *  USB HID quirks support for Linux
3  *
4  *  Copyright (c) 1999 Andreas Gal
5  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7  *  Copyright (c) 2006-2007 Jiri Kosina
8  *  Copyright (c) 2007 Paul Walmsley
9  */
10
11 /*
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 2 of the License, or (at your option)
15  * any later version.
16  */
17
18 #include <linux/hid.h>
19
20 #include "../hid-ids.h"
21
22 /*
23  * Alphabetically sorted blacklist by quirk type.
24  */
25
26 static const struct hid_blacklist {
27         __u16 idVendor;
28         __u16 idProduct;
29         __u32 quirks;
30 } hid_blacklist[] = {
31
32         { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
33         { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_X5_005D, HID_QUIRK_2WHEEL_MOUSE_HACK_B8 },
34         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
35
36         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
37         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
38         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
39         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
40         { USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
41         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
42         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
43         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
44         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
45         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
46         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
47         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
48
49         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
50
51         { USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM, HID_QUIRK_HIDDEV },
52         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },
53
54         { USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193, HID_QUIRK_HWHEEL_WHEEL_INVERT },
55
56         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
57         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
58
59         { USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },
60
61         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
62         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
63         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
64         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
65         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
66         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
67         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
68         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
69         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
70         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
71         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
72         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
73
74         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
75
76         { USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
77
78         { 0, 0 }
79 };
80
81 /* Quirks for devices which require report descriptor fixup go here */
82 static const struct hid_rdesc_blacklist {
83         __u16 idVendor;
84         __u16 idProduct;
85         __u32 quirks;
86 } hid_rdesc_blacklist[] = {
87
88         { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_RDESC_CYMOTION },
89
90         { USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
91
92         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
93
94         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
95
96         { USB_VENDOR_ID_SUNPLUS, USB_DEVICE_ID_SUNPLUS_WDESKTOP, HID_QUIRK_RDESC_SUNPLUS_WDESKTOP },
97
98         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
99         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
100
101         { 0, 0 }
102 };
103
104 /* Dynamic HID quirks list - specified at runtime */
105 struct quirks_list_struct {
106         struct hid_blacklist hid_bl_item;
107         struct list_head node;
108 };
109
110 static LIST_HEAD(dquirks_list);
111 static DECLARE_RWSEM(dquirks_rwsem);
112
113 /* Runtime ("dynamic") quirks manipulation functions */
114
115 /**
116  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
117  * @idVendor: the 16-bit USB vendor ID, in native byteorder
118  * @idProduct: the 16-bit USB product ID, in native byteorder
119  *
120  * Description:
121  *         Scans dquirks_list for a matching dynamic quirk and returns
122  *         the pointer to the relevant struct hid_blacklist if found.
123  *         Must be called with a read lock held on dquirks_rwsem.
124  *
125  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
126  */
127 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
128                 const u16 idProduct)
129 {
130         struct quirks_list_struct *q;
131         struct hid_blacklist *bl_entry = NULL;
132
133         list_for_each_entry(q, &dquirks_list, node) {
134                 if (q->hid_bl_item.idVendor == idVendor &&
135                                 q->hid_bl_item.idProduct == idProduct) {
136                         bl_entry = &q->hid_bl_item;
137                         break;
138                 }
139         }
140
141         if (bl_entry != NULL)
142                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
143                                 bl_entry->quirks, bl_entry->idVendor,
144                                 bl_entry->idProduct);
145
146         return bl_entry;
147 }
148
149
150 /**
151  * usbhid_modify_dquirk: add/replace a HID quirk
152  * @idVendor: the 16-bit USB vendor ID, in native byteorder
153  * @idProduct: the 16-bit USB product ID, in native byteorder
154  * @quirks: the u32 quirks value to add/replace
155  *
156  * Description:
157  *         If an dynamic quirk exists in memory for this (idVendor,
158  *         idProduct) pair, replace its quirks value with what was
159  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
160  *
161  * Returns: 0 OK, -error on failure.
162  */
163 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
164                                 const u32 quirks)
165 {
166         struct quirks_list_struct *q_new, *q;
167         int list_edited = 0;
168
169         if (!idVendor) {
170                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
171                 return -EINVAL;
172         }
173
174         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
175         if (!q_new) {
176                 dbg_hid("Could not allocate quirks_list_struct\n");
177                 return -ENOMEM;
178         }
179
180         q_new->hid_bl_item.idVendor = idVendor;
181         q_new->hid_bl_item.idProduct = idProduct;
182         q_new->hid_bl_item.quirks = quirks;
183
184         down_write(&dquirks_rwsem);
185
186         list_for_each_entry(q, &dquirks_list, node) {
187
188                 if (q->hid_bl_item.idVendor == idVendor &&
189                                 q->hid_bl_item.idProduct == idProduct) {
190
191                         list_replace(&q->node, &q_new->node);
192                         kfree(q);
193                         list_edited = 1;
194                         break;
195
196                 }
197
198         }
199
200         if (!list_edited)
201                 list_add_tail(&q_new->node, &dquirks_list);
202
203         up_write(&dquirks_rwsem);
204
205         return 0;
206 }
207
208 /**
209  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
210  *
211  * Description:
212  *         Free all memory associated with dynamic quirks - called before
213  *         module unload.
214  *
215  */
216 static void usbhid_remove_all_dquirks(void)
217 {
218         struct quirks_list_struct *q, *temp;
219
220         down_write(&dquirks_rwsem);
221         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
222                 list_del(&q->node);
223                 kfree(q);
224         }
225         up_write(&dquirks_rwsem);
226
227 }
228
229 /** 
230  * usbhid_quirks_init: apply USB HID quirks specified at module load time
231  */
232 int usbhid_quirks_init(char **quirks_param)
233 {
234         u16 idVendor, idProduct;
235         u32 quirks;
236         int n = 0, m;
237
238         for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
239
240                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
241                                 &idVendor, &idProduct, &quirks);
242
243                 if (m != 3 ||
244                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
245                         printk(KERN_WARNING
246                                         "Could not parse HID quirk module param %s\n",
247                                         quirks_param[n]);
248                 }
249         }
250
251         return 0;
252 }
253
254 /**
255  * usbhid_quirks_exit: release memory associated with dynamic_quirks
256  *
257  * Description:
258  *     Release all memory associated with dynamic quirks.  Called upon
259  *     module unload.
260  *
261  * Returns: nothing
262  */
263 void usbhid_quirks_exit(void)
264 {
265         usbhid_remove_all_dquirks();
266 }
267
268 /**
269  * usbhid_exists_squirk: return any static quirks for a USB HID device
270  * @idVendor: the 16-bit USB vendor ID, in native byteorder
271  * @idProduct: the 16-bit USB product ID, in native byteorder
272  *
273  * Description:
274  *     Given a USB vendor ID and product ID, return a pointer to
275  *     the hid_blacklist entry associated with that device.
276  *
277  * Returns: pointer if quirk found, or NULL if no quirks found.
278  */
279 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
280                 const u16 idProduct)
281 {
282         const struct hid_blacklist *bl_entry = NULL;
283         int n = 0;
284
285         for (; hid_blacklist[n].idVendor; n++)
286                 if (hid_blacklist[n].idVendor == idVendor &&
287                                 hid_blacklist[n].idProduct == idProduct)
288                         bl_entry = &hid_blacklist[n];
289
290         if (bl_entry != NULL)
291                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
292                                 bl_entry->quirks, bl_entry->idVendor, 
293                                 bl_entry->idProduct);
294         return bl_entry;
295 }
296
297 /**
298  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
299  * @idVendor: the 16-bit USB vendor ID, in native byteorder
300  * @idProduct: the 16-bit USB product ID, in native byteorder
301  *
302  * Description:
303  *     Given a USB vendor ID and product ID, return any quirks associated
304  *     with that device.
305  *
306  * Returns: a u32 quirks value.
307  */
308 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
309 {
310         u32 quirks = 0;
311         const struct hid_blacklist *bl_entry = NULL;
312
313         /* NCR devices must not be queried for reports */
314         if (idVendor == USB_VENDOR_ID_NCR &&
315                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
316                         idProduct <= USB_DEVICE_ID_NCR_LAST)
317                         return HID_QUIRK_NOGET;
318
319         down_read(&dquirks_rwsem);
320         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
321         if (!bl_entry)
322                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
323         if (bl_entry)
324                 quirks = bl_entry->quirks;
325         up_read(&dquirks_rwsem);
326
327         return quirks;
328 }
329
330 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
331
332 /*
333  * Cherry Cymotion keyboard have an invalid HID report descriptor,
334  * that needs fixing before we can parse it.
335  */
336 static void usbhid_fixup_cymotion_descriptor(char *rdesc, int rsize)
337 {
338         if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
339                 printk(KERN_INFO "Fixing up Cherry Cymotion report descriptor\n");
340                 rdesc[11] = rdesc[16] = 0xff;
341                 rdesc[12] = rdesc[17] = 0x03;
342         }
343 }
344
345 static void usbhid_fixup_sunplus_wdesktop(unsigned char *rdesc, int rsize)
346 {
347         if (rsize >= 107 && rdesc[104] == 0x26
348                          && rdesc[105] == 0x80
349                          && rdesc[106] == 0x03) {
350                 printk(KERN_INFO "Fixing up Sunplus Wireless Desktop report descriptor\n");
351                 rdesc[105] = rdesc[110] = 0x03;
352                 rdesc[106] = rdesc[111] = 0x21;
353         }
354 }
355
356 /*
357  * Samsung IrDA remote controller (reports as Cypress USB Mouse).
358  *
359  * Vendor specific report #4 has a size of 48 bit,
360  * and therefore is not accepted when inspecting the descriptors.
361  * As a workaround we reinterpret the report as:
362  *   Variable type, count 6, size 8 bit, log. maximum 255
363  * The burden to reconstruct the data is moved into user space.
364  */
365 static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
366                                                   int rsize)
367 {
368         if (rsize >= 182 && rdesc[175] == 0x25
369                          && rdesc[176] == 0x40
370                          && rdesc[177] == 0x75
371                          && rdesc[178] == 0x30
372                          && rdesc[179] == 0x95
373                          && rdesc[180] == 0x01
374                          && rdesc[182] == 0x40) {
375                 printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
376                 rdesc[176] = 0xff;
377                 rdesc[178] = 0x08;
378                 rdesc[180] = 0x06;
379                 rdesc[182] = 0x42;
380         }
381 }
382
383 /* Petalynx Maxter Remote has maximum for consumer page set too low */
384 static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
385 {
386         if (rsize >= 60 && rdesc[39] == 0x2a
387                         && rdesc[40] == 0xf5
388                         && rdesc[41] == 0x00
389                         && rdesc[59] == 0x26
390                         && rdesc[60] == 0xf9
391                         && rdesc[61] == 0x00) {
392                 printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
393                 rdesc[60] = 0xfa;
394                 rdesc[40] = 0xfa;
395         }
396 }
397
398 /*
399  * Some USB barcode readers from cypress have usage min and usage max in
400  * the wrong order
401  */
402 static void usbhid_fixup_cypress_descriptor(unsigned char *rdesc, int rsize)
403 {
404         short fixed = 0;
405         int i;
406
407         for (i = 0; i < rsize - 4; i++) {
408                 if (rdesc[i] == 0x29 && rdesc [i+2] == 0x19) {
409                         unsigned char tmp;
410
411                         rdesc[i] = 0x19; rdesc[i+2] = 0x29;
412                         tmp = rdesc[i+3];
413                         rdesc[i+3] = rdesc[i+1];
414                         rdesc[i+1] = tmp;
415                 }
416         }
417
418         if (fixed)
419                 printk(KERN_INFO "Fixing up Cypress report descriptor\n");
420 }
421
422 static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
423 {
424         if (rsize >= 30 && rdesc[29] == 0x05
425                         && rdesc[30] == 0x09) {
426                 printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
427                 rdesc[30] = 0x0c;
428         }
429 }
430
431 static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
432 {
433         if ((quirks & HID_QUIRK_RDESC_CYMOTION))
434                 usbhid_fixup_cymotion_descriptor(rdesc, rsize);
435
436         if (quirks & HID_QUIRK_RDESC_SWAPPED_MIN_MAX)
437                 usbhid_fixup_cypress_descriptor(rdesc, rsize);
438
439         if (quirks & HID_QUIRK_RDESC_PETALYNX)
440                 usbhid_fixup_petalynx_descriptor(rdesc, rsize);
441
442         if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
443                 usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
444
445         if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
446                 usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
447
448         if (quirks & HID_QUIRK_RDESC_SUNPLUS_WDESKTOP)
449                 usbhid_fixup_sunplus_wdesktop(rdesc, rsize);
450 }
451
452 /**
453  * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
454  *
455  * Description:
456  *      Walks the hid_rdesc_blacklist[] array and checks whether the device
457  *      is known to have broken report descriptor that needs to be fixed up
458  *      prior to entering the HID parser
459  *
460  * Returns: nothing
461  */
462 void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
463                                     char *rdesc, unsigned rsize, char **quirks_param)
464 {
465         int n, m;
466         u16 paramVendor, paramProduct;
467         u32 quirks;
468
469         /* static rdesc quirk entries */
470         for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
471                 if (hid_rdesc_blacklist[n].idVendor == idVendor &&
472                                 hid_rdesc_blacklist[n].idProduct == idProduct)
473                         __usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
474                                         rdesc, rsize);
475
476         /* runtime rdesc quirk entries handling */
477         for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
478                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
479                                 &paramVendor, &paramProduct, &quirks);
480
481                 if (m != 3)
482                         printk(KERN_WARNING
483                                 "Could not parse HID quirk module param %s\n",
484                                 quirks_param[n]);
485                 else if (paramVendor == idVendor && paramProduct == idProduct)
486                         __usbhid_fixup_report_descriptor(quirks, rdesc, rsize);
487         }
488 }