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 {
31 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
32 { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
33 { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
34 { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
35 { USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
36 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
37 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
38 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
39 { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
40 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
41 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
42 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
44 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
46 { USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM, HID_QUIRK_HIDDEV },
47 { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },
49 { USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193, HID_QUIRK_HWHEEL_WHEEL_INVERT },
51 { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
52 { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
54 { USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },
56 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
57 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
58 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
59 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
60 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
61 { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
62 { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
63 { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
64 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
65 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
66 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
67 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
69 { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
71 { USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
76 /* Quirks for devices which require report descriptor fixup go here */
77 static const struct hid_rdesc_blacklist {
81 } hid_rdesc_blacklist[] = {
83 { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_RDESC_CYMOTION },
85 { USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
87 { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
89 { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
94 /* Dynamic HID quirks list - specified at runtime */
95 struct quirks_list_struct {
96 struct hid_blacklist hid_bl_item;
97 struct list_head node;
100 static LIST_HEAD(dquirks_list);
101 static DECLARE_RWSEM(dquirks_rwsem);
103 /* Runtime ("dynamic") quirks manipulation functions */
106 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
107 * @idVendor: the 16-bit USB vendor ID, in native byteorder
108 * @idProduct: the 16-bit USB product ID, in native byteorder
111 * Scans dquirks_list for a matching dynamic quirk and returns
112 * the pointer to the relevant struct hid_blacklist if found.
113 * Must be called with a read lock held on dquirks_rwsem.
115 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
117 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
120 struct quirks_list_struct *q;
121 struct hid_blacklist *bl_entry = NULL;
123 list_for_each_entry(q, &dquirks_list, node) {
124 if (q->hid_bl_item.idVendor == idVendor &&
125 q->hid_bl_item.idProduct == idProduct) {
126 bl_entry = &q->hid_bl_item;
131 if (bl_entry != NULL)
132 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
133 bl_entry->quirks, bl_entry->idVendor,
134 bl_entry->idProduct);
141 * usbhid_modify_dquirk: add/replace a HID quirk
142 * @idVendor: the 16-bit USB vendor ID, in native byteorder
143 * @idProduct: the 16-bit USB product ID, in native byteorder
144 * @quirks: the u32 quirks value to add/replace
147 * If an dynamic quirk exists in memory for this (idVendor,
148 * idProduct) pair, replace its quirks value with what was
149 * provided. Otherwise, add the quirk to the dynamic quirks list.
151 * Returns: 0 OK, -error on failure.
153 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
156 struct quirks_list_struct *q_new, *q;
160 dbg_hid("Cannot add a quirk with idVendor = 0\n");
164 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
166 dbg_hid("Could not allocate quirks_list_struct\n");
170 q_new->hid_bl_item.idVendor = idVendor;
171 q_new->hid_bl_item.idProduct = idProduct;
172 q_new->hid_bl_item.quirks = quirks;
174 down_write(&dquirks_rwsem);
176 list_for_each_entry(q, &dquirks_list, node) {
178 if (q->hid_bl_item.idVendor == idVendor &&
179 q->hid_bl_item.idProduct == idProduct) {
181 list_replace(&q->node, &q_new->node);
191 list_add_tail(&q_new->node, &dquirks_list);
193 up_write(&dquirks_rwsem);
199 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
202 * Free all memory associated with dynamic quirks - called before
206 static void usbhid_remove_all_dquirks(void)
208 struct quirks_list_struct *q, *temp;
210 down_write(&dquirks_rwsem);
211 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
215 up_write(&dquirks_rwsem);
220 * usbhid_quirks_init: apply USB HID quirks specified at module load time
222 int usbhid_quirks_init(char **quirks_param)
224 u16 idVendor, idProduct;
228 for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
230 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
231 &idVendor, &idProduct, &quirks);
234 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
236 "Could not parse HID quirk module param %s\n",
245 * usbhid_quirks_exit: release memory associated with dynamic_quirks
248 * Release all memory associated with dynamic quirks. Called upon
253 void usbhid_quirks_exit(void)
255 usbhid_remove_all_dquirks();
259 * usbhid_exists_squirk: return any static quirks for a USB HID device
260 * @idVendor: the 16-bit USB vendor ID, in native byteorder
261 * @idProduct: the 16-bit USB product ID, in native byteorder
264 * Given a USB vendor ID and product ID, return a pointer to
265 * the hid_blacklist entry associated with that device.
267 * Returns: pointer if quirk found, or NULL if no quirks found.
269 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
272 const struct hid_blacklist *bl_entry = NULL;
275 for (; hid_blacklist[n].idVendor; n++)
276 if (hid_blacklist[n].idVendor == idVendor &&
277 hid_blacklist[n].idProduct == idProduct)
278 bl_entry = &hid_blacklist[n];
280 if (bl_entry != NULL)
281 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
282 bl_entry->quirks, bl_entry->idVendor,
283 bl_entry->idProduct);
288 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
289 * @idVendor: the 16-bit USB vendor ID, in native byteorder
290 * @idProduct: the 16-bit USB product ID, in native byteorder
293 * Given a USB vendor ID and product ID, return any quirks associated
296 * Returns: a u32 quirks value.
298 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
301 const struct hid_blacklist *bl_entry = NULL;
303 /* NCR devices must not be queried for reports */
304 if (idVendor == USB_VENDOR_ID_NCR &&
305 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
306 idProduct <= USB_DEVICE_ID_NCR_LAST)
307 return HID_QUIRK_NOGET;
309 down_read(&dquirks_rwsem);
310 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
312 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
314 quirks = bl_entry->quirks;
315 up_read(&dquirks_rwsem);
320 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
323 * Cherry Cymotion keyboard have an invalid HID report descriptor,
324 * that needs fixing before we can parse it.
326 static void usbhid_fixup_cymotion_descriptor(char *rdesc, int rsize)
328 if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
329 printk(KERN_INFO "Fixing up Cherry Cymotion report descriptor\n");
330 rdesc[11] = rdesc[16] = 0xff;
331 rdesc[12] = rdesc[17] = 0x03;
336 * Samsung IrDA remote controller (reports as Cypress USB Mouse).
338 * Vendor specific report #4 has a size of 48 bit,
339 * and therefore is not accepted when inspecting the descriptors.
340 * As a workaround we reinterpret the report as:
341 * Variable type, count 6, size 8 bit, log. maximum 255
342 * The burden to reconstruct the data is moved into user space.
344 static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
347 if (rsize >= 182 && rdesc[175] == 0x25
348 && rdesc[176] == 0x40
349 && rdesc[177] == 0x75
350 && rdesc[178] == 0x30
351 && rdesc[179] == 0x95
352 && rdesc[180] == 0x01
353 && rdesc[182] == 0x40) {
354 printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
362 /* Petalynx Maxter Remote has maximum for consumer page set too low */
363 static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
365 if (rsize >= 60 && rdesc[39] == 0x2a
370 && rdesc[61] == 0x00) {
371 printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
377 static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
379 if (rsize >= 30 && rdesc[29] == 0x05
380 && rdesc[30] == 0x09) {
381 printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
386 static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
388 if ((quirks & HID_QUIRK_RDESC_CYMOTION))
389 usbhid_fixup_cymotion_descriptor(rdesc, rsize);
391 if (quirks & HID_QUIRK_RDESC_PETALYNX)
392 usbhid_fixup_petalynx_descriptor(rdesc, rsize);
394 if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
395 usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
397 if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
398 usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
402 * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
405 * Walks the hid_rdesc_blacklist[] array and checks whether the device
406 * is known to have broken report descriptor that needs to be fixed up
407 * prior to entering the HID parser
411 void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
412 char *rdesc, unsigned rsize, char **quirks_param)
415 u16 paramVendor, paramProduct;
418 /* static rdesc quirk entries */
419 for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
420 if (hid_rdesc_blacklist[n].idVendor == idVendor &&
421 hid_rdesc_blacklist[n].idProduct == idProduct)
422 __usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
425 /* runtime rdesc quirk entries handling */
426 for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
427 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
428 ¶mVendor, ¶mProduct, &quirks);
432 "Could not parse HID quirk module param %s\n",
434 else if (paramVendor == idVendor && paramProduct == idProduct)
435 __usbhid_fixup_report_descriptor(quirks, rdesc, rsize);