2 * USB HID quirks support for Linux
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
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)
18 #include <linux/hid.h>
20 #include "../hid-ids.h"
23 * Alphabetically sorted blacklist by quirk type.
26 static const struct hid_blacklist {
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 },
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 },
49 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
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 { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV, HID_QUIRK_HIDINPUT },
55 { USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193, HID_QUIRK_HWHEEL_WHEEL_INVERT },
58 { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K, HID_QUIRK_MICROSOFT_KEYS },
59 { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K, HID_QUIRK_MICROSOFT_KEYS },
61 { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
62 { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
64 { USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },
66 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
67 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
68 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
69 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
70 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
71 { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
72 { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
73 { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0, HID_QUIRK_NOGET },
74 { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
75 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
76 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
77 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
78 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
80 { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
82 { USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
87 /* Quirks for devices which require report descriptor fixup go here */
88 static const struct hid_rdesc_blacklist {
92 } hid_rdesc_blacklist[] = {
94 { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_RDESC_CYMOTION },
96 { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_DESKTOP_RECV_1028, HID_QUIRK_RDESC_MICROSOFT_RECV_1028 },
98 { USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
100 { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
102 { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
104 { USB_VENDOR_ID_SUNPLUS, USB_DEVICE_ID_SUNPLUS_WDESKTOP, HID_QUIRK_RDESC_SUNPLUS_WDESKTOP },
106 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
107 { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
112 /* Dynamic HID quirks list - specified at runtime */
113 struct quirks_list_struct {
114 struct hid_blacklist hid_bl_item;
115 struct list_head node;
118 static LIST_HEAD(dquirks_list);
119 static DECLARE_RWSEM(dquirks_rwsem);
121 /* Runtime ("dynamic") quirks manipulation functions */
124 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
125 * @idVendor: the 16-bit USB vendor ID, in native byteorder
126 * @idProduct: the 16-bit USB product ID, in native byteorder
129 * Scans dquirks_list for a matching dynamic quirk and returns
130 * the pointer to the relevant struct hid_blacklist if found.
131 * Must be called with a read lock held on dquirks_rwsem.
133 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
135 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
138 struct quirks_list_struct *q;
139 struct hid_blacklist *bl_entry = NULL;
141 list_for_each_entry(q, &dquirks_list, node) {
142 if (q->hid_bl_item.idVendor == idVendor &&
143 q->hid_bl_item.idProduct == idProduct) {
144 bl_entry = &q->hid_bl_item;
149 if (bl_entry != NULL)
150 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
151 bl_entry->quirks, bl_entry->idVendor,
152 bl_entry->idProduct);
159 * usbhid_modify_dquirk: add/replace a HID quirk
160 * @idVendor: the 16-bit USB vendor ID, in native byteorder
161 * @idProduct: the 16-bit USB product ID, in native byteorder
162 * @quirks: the u32 quirks value to add/replace
165 * If an dynamic quirk exists in memory for this (idVendor,
166 * idProduct) pair, replace its quirks value with what was
167 * provided. Otherwise, add the quirk to the dynamic quirks list.
169 * Returns: 0 OK, -error on failure.
171 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
174 struct quirks_list_struct *q_new, *q;
178 dbg_hid("Cannot add a quirk with idVendor = 0\n");
182 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
184 dbg_hid("Could not allocate quirks_list_struct\n");
188 q_new->hid_bl_item.idVendor = idVendor;
189 q_new->hid_bl_item.idProduct = idProduct;
190 q_new->hid_bl_item.quirks = quirks;
192 down_write(&dquirks_rwsem);
194 list_for_each_entry(q, &dquirks_list, node) {
196 if (q->hid_bl_item.idVendor == idVendor &&
197 q->hid_bl_item.idProduct == idProduct) {
199 list_replace(&q->node, &q_new->node);
209 list_add_tail(&q_new->node, &dquirks_list);
211 up_write(&dquirks_rwsem);
217 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
220 * Free all memory associated with dynamic quirks - called before
224 static void usbhid_remove_all_dquirks(void)
226 struct quirks_list_struct *q, *temp;
228 down_write(&dquirks_rwsem);
229 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
233 up_write(&dquirks_rwsem);
238 * usbhid_quirks_init: apply USB HID quirks specified at module load time
240 int usbhid_quirks_init(char **quirks_param)
242 u16 idVendor, idProduct;
246 for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
248 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
249 &idVendor, &idProduct, &quirks);
252 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
254 "Could not parse HID quirk module param %s\n",
263 * usbhid_quirks_exit: release memory associated with dynamic_quirks
266 * Release all memory associated with dynamic quirks. Called upon
271 void usbhid_quirks_exit(void)
273 usbhid_remove_all_dquirks();
277 * usbhid_exists_squirk: return any static quirks for a USB HID device
278 * @idVendor: the 16-bit USB vendor ID, in native byteorder
279 * @idProduct: the 16-bit USB product ID, in native byteorder
282 * Given a USB vendor ID and product ID, return a pointer to
283 * the hid_blacklist entry associated with that device.
285 * Returns: pointer if quirk found, or NULL if no quirks found.
287 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
290 const struct hid_blacklist *bl_entry = NULL;
293 for (; hid_blacklist[n].idVendor; n++)
294 if (hid_blacklist[n].idVendor == idVendor &&
295 hid_blacklist[n].idProduct == idProduct)
296 bl_entry = &hid_blacklist[n];
298 if (bl_entry != NULL)
299 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
300 bl_entry->quirks, bl_entry->idVendor,
301 bl_entry->idProduct);
306 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
307 * @idVendor: the 16-bit USB vendor ID, in native byteorder
308 * @idProduct: the 16-bit USB product ID, in native byteorder
311 * Given a USB vendor ID and product ID, return any quirks associated
314 * Returns: a u32 quirks value.
316 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
319 const struct hid_blacklist *bl_entry = NULL;
321 /* NCR devices must not be queried for reports */
322 if (idVendor == USB_VENDOR_ID_NCR &&
323 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
324 idProduct <= USB_DEVICE_ID_NCR_LAST)
325 return HID_QUIRK_NOGET;
327 down_read(&dquirks_rwsem);
328 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
330 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
332 quirks = bl_entry->quirks;
333 up_read(&dquirks_rwsem);
338 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
341 * Cherry Cymotion keyboard have an invalid HID report descriptor,
342 * that needs fixing before we can parse it.
344 static void usbhid_fixup_cymotion_descriptor(char *rdesc, int rsize)
346 if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
347 printk(KERN_INFO "Fixing up Cherry Cymotion report descriptor\n");
348 rdesc[11] = rdesc[16] = 0xff;
349 rdesc[12] = rdesc[17] = 0x03;
353 static void usbhid_fixup_sunplus_wdesktop(unsigned char *rdesc, int rsize)
355 if (rsize >= 107 && rdesc[104] == 0x26
356 && rdesc[105] == 0x80
357 && rdesc[106] == 0x03) {
358 printk(KERN_INFO "Fixing up Sunplus Wireless Desktop report descriptor\n");
359 rdesc[105] = rdesc[110] = 0x03;
360 rdesc[106] = rdesc[111] = 0x21;
365 * Samsung IrDA remote controller (reports as Cypress USB Mouse).
367 * Vendor specific report #4 has a size of 48 bit,
368 * and therefore is not accepted when inspecting the descriptors.
369 * As a workaround we reinterpret the report as:
370 * Variable type, count 6, size 8 bit, log. maximum 255
371 * The burden to reconstruct the data is moved into user space.
373 static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
376 if (rsize >= 182 && rdesc[175] == 0x25
377 && rdesc[176] == 0x40
378 && rdesc[177] == 0x75
379 && rdesc[178] == 0x30
380 && rdesc[179] == 0x95
381 && rdesc[180] == 0x01
382 && rdesc[182] == 0x40) {
383 printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
391 /* Petalynx Maxter Remote has maximum for consumer page set too low */
392 static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
394 if (rsize >= 60 && rdesc[39] == 0x2a
399 && rdesc[61] == 0x00) {
400 printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
407 * Some USB barcode readers from cypress have usage min and usage max in
410 static void usbhid_fixup_cypress_descriptor(unsigned char *rdesc, int rsize)
415 for (i = 0; i < rsize - 4; i++) {
416 if (rdesc[i] == 0x29 && rdesc [i+2] == 0x19) {
419 rdesc[i] = 0x19; rdesc[i+2] = 0x29;
421 rdesc[i+3] = rdesc[i+1];
427 printk(KERN_INFO "Fixing up Cypress report descriptor\n");
430 static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
432 if (rsize >= 30 && rdesc[29] == 0x05
433 && rdesc[30] == 0x09) {
434 printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
440 * Microsoft Wireless Desktop Receiver (Model 1028) has several
441 * 'Usage Min/Max' where it ought to have 'Physical Min/Max'
443 static void usbhid_fixup_microsoft_descriptor(unsigned char *rdesc, int rsize)
445 if (rsize == 571 && rdesc[284] == 0x19
446 && rdesc[286] == 0x2a
447 && rdesc[304] == 0x19
448 && rdesc[306] == 0x29
449 && rdesc[352] == 0x1a
450 && rdesc[355] == 0x2a
451 && rdesc[557] == 0x19
452 && rdesc[559] == 0x29) {
453 printk(KERN_INFO "Fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n");
454 rdesc[284] = rdesc[304] = rdesc[557] = 0x35;
456 rdesc[286] = rdesc[355] = 0x46;
457 rdesc[306] = rdesc[559] = 0x45;
461 static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
463 if ((quirks & HID_QUIRK_RDESC_CYMOTION))
464 usbhid_fixup_cymotion_descriptor(rdesc, rsize);
466 if (quirks & HID_QUIRK_RDESC_SWAPPED_MIN_MAX)
467 usbhid_fixup_cypress_descriptor(rdesc, rsize);
469 if (quirks & HID_QUIRK_RDESC_PETALYNX)
470 usbhid_fixup_petalynx_descriptor(rdesc, rsize);
472 if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
473 usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
475 if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
476 usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
478 if (quirks & HID_QUIRK_RDESC_MICROSOFT_RECV_1028)
479 usbhid_fixup_microsoft_descriptor(rdesc, rsize);
481 if (quirks & HID_QUIRK_RDESC_SUNPLUS_WDESKTOP)
482 usbhid_fixup_sunplus_wdesktop(rdesc, rsize);
486 * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
489 * Walks the hid_rdesc_blacklist[] array and checks whether the device
490 * is known to have broken report descriptor that needs to be fixed up
491 * prior to entering the HID parser
495 void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
496 char *rdesc, unsigned rsize, char **quirks_param)
499 u16 paramVendor, paramProduct;
502 /* static rdesc quirk entries */
503 for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
504 if (hid_rdesc_blacklist[n].idVendor == idVendor &&
505 hid_rdesc_blacklist[n].idProduct == idProduct)
506 __usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
509 /* runtime rdesc quirk entries handling */
510 for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
511 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
512 ¶mVendor, ¶mProduct, &quirks);
516 "Could not parse HID quirk module param %s\n",
518 else if (paramVendor == idVendor && paramProduct == idProduct)
519 __usbhid_fixup_report_descriptor(quirks, rdesc, rsize);