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_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
36 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
37 { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
38 { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
39 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
40 { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
41 { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
43 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
45 { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
46 { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
48 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
49 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
50 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
51 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
52 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
53 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
54 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
55 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
56 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
57 { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
58 { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
59 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
60 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
61 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
62 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
63 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
65 { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
66 { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
71 /* Dynamic HID quirks list - specified at runtime */
72 struct quirks_list_struct {
73 struct hid_blacklist hid_bl_item;
74 struct list_head node;
77 static LIST_HEAD(dquirks_list);
78 static DECLARE_RWSEM(dquirks_rwsem);
80 /* Runtime ("dynamic") quirks manipulation functions */
83 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
84 * @idVendor: the 16-bit USB vendor ID, in native byteorder
85 * @idProduct: the 16-bit USB product ID, in native byteorder
88 * Scans dquirks_list for a matching dynamic quirk and returns
89 * the pointer to the relevant struct hid_blacklist if found.
90 * Must be called with a read lock held on dquirks_rwsem.
92 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
94 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
97 struct quirks_list_struct *q;
98 struct hid_blacklist *bl_entry = NULL;
100 list_for_each_entry(q, &dquirks_list, node) {
101 if (q->hid_bl_item.idVendor == idVendor &&
102 q->hid_bl_item.idProduct == idProduct) {
103 bl_entry = &q->hid_bl_item;
108 if (bl_entry != NULL)
109 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
110 bl_entry->quirks, bl_entry->idVendor,
111 bl_entry->idProduct);
118 * usbhid_modify_dquirk: add/replace a HID quirk
119 * @idVendor: the 16-bit USB vendor ID, in native byteorder
120 * @idProduct: the 16-bit USB product ID, in native byteorder
121 * @quirks: the u32 quirks value to add/replace
124 * If an dynamic quirk exists in memory for this (idVendor,
125 * idProduct) pair, replace its quirks value with what was
126 * provided. Otherwise, add the quirk to the dynamic quirks list.
128 * Returns: 0 OK, -error on failure.
130 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
133 struct quirks_list_struct *q_new, *q;
137 dbg_hid("Cannot add a quirk with idVendor = 0\n");
141 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
143 dbg_hid("Could not allocate quirks_list_struct\n");
147 q_new->hid_bl_item.idVendor = idVendor;
148 q_new->hid_bl_item.idProduct = idProduct;
149 q_new->hid_bl_item.quirks = quirks;
151 down_write(&dquirks_rwsem);
153 list_for_each_entry(q, &dquirks_list, node) {
155 if (q->hid_bl_item.idVendor == idVendor &&
156 q->hid_bl_item.idProduct == idProduct) {
158 list_replace(&q->node, &q_new->node);
168 list_add_tail(&q_new->node, &dquirks_list);
170 up_write(&dquirks_rwsem);
176 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
179 * Free all memory associated with dynamic quirks - called before
183 static void usbhid_remove_all_dquirks(void)
185 struct quirks_list_struct *q, *temp;
187 down_write(&dquirks_rwsem);
188 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
192 up_write(&dquirks_rwsem);
197 * usbhid_quirks_init: apply USB HID quirks specified at module load time
199 int usbhid_quirks_init(char **quirks_param)
201 u16 idVendor, idProduct;
205 for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
207 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
208 &idVendor, &idProduct, &quirks);
211 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
213 "Could not parse HID quirk module param %s\n",
222 * usbhid_quirks_exit: release memory associated with dynamic_quirks
225 * Release all memory associated with dynamic quirks. Called upon
230 void usbhid_quirks_exit(void)
232 usbhid_remove_all_dquirks();
236 * usbhid_exists_squirk: return any static quirks for a USB HID device
237 * @idVendor: the 16-bit USB vendor ID, in native byteorder
238 * @idProduct: the 16-bit USB product ID, in native byteorder
241 * Given a USB vendor ID and product ID, return a pointer to
242 * the hid_blacklist entry associated with that device.
244 * Returns: pointer if quirk found, or NULL if no quirks found.
246 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
249 const struct hid_blacklist *bl_entry = NULL;
252 for (; hid_blacklist[n].idVendor; n++)
253 if (hid_blacklist[n].idVendor == idVendor &&
254 hid_blacklist[n].idProduct == idProduct)
255 bl_entry = &hid_blacklist[n];
257 if (bl_entry != NULL)
258 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
259 bl_entry->quirks, bl_entry->idVendor,
260 bl_entry->idProduct);
265 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
266 * @idVendor: the 16-bit USB vendor ID, in native byteorder
267 * @idProduct: the 16-bit USB product ID, in native byteorder
270 * Given a USB vendor ID and product ID, return any quirks associated
273 * Returns: a u32 quirks value.
275 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
278 const struct hid_blacklist *bl_entry = NULL;
280 /* NCR devices must not be queried for reports */
281 if (idVendor == USB_VENDOR_ID_NCR &&
282 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
283 idProduct <= USB_DEVICE_ID_NCR_LAST)
284 return HID_QUIRK_NO_INIT_REPORTS;
286 down_read(&dquirks_rwsem);
287 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
289 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
291 quirks = bl_entry->quirks;
292 up_read(&dquirks_rwsem);
297 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);