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>
19 #include <linux/export.h>
20 #include <linux/slab.h>
22 #include "../hid-ids.h"
25 * Alphabetically sorted blacklist by quirk type.
28 static const struct hid_blacklist
{
33 { USB_VENDOR_ID_AASHIMA
, USB_DEVICE_ID_AASHIMA_GAMEPAD
, HID_QUIRK_BADPAD
},
34 { USB_VENDOR_ID_AASHIMA
, USB_DEVICE_ID_AASHIMA_PREDATOR
, HID_QUIRK_BADPAD
},
35 { USB_VENDOR_ID_ALPS
, USB_DEVICE_ID_IBM_GAMEPAD
, HID_QUIRK_BADPAD
},
36 { USB_VENDOR_ID_CHIC
, USB_DEVICE_ID_CHIC_GAMEPAD
, HID_QUIRK_BADPAD
},
37 { USB_VENDOR_ID_DWAV
, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER
, HID_QUIRK_MULTI_INPUT
| HID_QUIRK_NOGET
},
38 { USB_VENDOR_ID_MOJO
, USB_DEVICE_ID_RETRO_ADAPTER
, HID_QUIRK_MULTI_INPUT
},
39 { USB_VENDOR_ID_HAPP
, USB_DEVICE_ID_UGCI_DRIVING
, HID_QUIRK_BADPAD
| HID_QUIRK_MULTI_INPUT
},
40 { USB_VENDOR_ID_HAPP
, USB_DEVICE_ID_UGCI_FLYING
, HID_QUIRK_BADPAD
| HID_QUIRK_MULTI_INPUT
},
41 { USB_VENDOR_ID_HAPP
, USB_DEVICE_ID_UGCI_FIGHTING
, HID_QUIRK_BADPAD
| HID_QUIRK_MULTI_INPUT
},
42 { USB_VENDOR_ID_NATSU
, USB_DEVICE_ID_NATSU_GAMEPAD
, HID_QUIRK_BADPAD
},
43 { USB_VENDOR_ID_NEC
, USB_DEVICE_ID_NEC_USB_GAME_PAD
, HID_QUIRK_BADPAD
},
44 { USB_VENDOR_ID_NEXTWINDOW
, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN
, HID_QUIRK_MULTI_INPUT
},
45 { USB_VENDOR_ID_SAITEK
, USB_DEVICE_ID_SAITEK_RUMBLEPAD
, HID_QUIRK_BADPAD
},
46 { USB_VENDOR_ID_TOPMAX
, USB_DEVICE_ID_TOPMAX_COBRAPAD
, HID_QUIRK_BADPAD
},
48 { USB_VENDOR_ID_AFATECH
, USB_DEVICE_ID_AFATECH_AF9016
, HID_QUIRK_FULLSPEED_INTERVAL
},
50 { USB_VENDOR_ID_ETURBOTOUCH
, USB_DEVICE_ID_ETURBOTOUCH
, HID_QUIRK_MULTI_INPUT
},
51 { USB_VENDOR_ID_GREENASIA
, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD
, HID_QUIRK_MULTI_INPUT
},
52 { USB_VENDOR_ID_PANTHERLORD
, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK
, HID_QUIRK_MULTI_INPUT
| HID_QUIRK_SKIP_OUTPUT_REPORTS
},
53 { USB_VENDOR_ID_PLAYDOTCOM
, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII
, HID_QUIRK_MULTI_INPUT
},
54 { USB_VENDOR_ID_TOUCHPACK
, USB_DEVICE_ID_TOUCHPACK_RTS
, HID_QUIRK_MULTI_INPUT
},
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_CH
, USB_DEVICE_ID_CH_COMBATSTICK
, HID_QUIRK_NOGET
},
62 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE
, HID_QUIRK_NOGET
},
63 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE
, HID_QUIRK_NOGET
},
64 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_PRO_THROTTLE
, HID_QUIRK_NOGET
},
65 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_PRO_PEDALS
, HID_QUIRK_NOGET
},
66 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK
, HID_QUIRK_NOGET
},
67 { USB_VENDOR_ID_CH
, USB_DEVICE_ID_CH_AXIS_295
, HID_QUIRK_NOGET
},
68 { USB_VENDOR_ID_DMI
, USB_DEVICE_ID_DMI_ENC
, HID_QUIRK_NOGET
},
69 { USB_VENDOR_ID_ELO
, USB_DEVICE_ID_ELO_TS2700
, HID_QUIRK_NOGET
},
70 { USB_VENDOR_ID_PRODIGE
, USB_DEVICE_ID_PRODIGE_CORDLESS
, HID_QUIRK_NOGET
},
71 { USB_VENDOR_ID_QUANTA
, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN
, HID_QUIRK_NOGET
},
72 { USB_VENDOR_ID_SUN
, USB_DEVICE_ID_RARITAN_KVM_DONGLE
, HID_QUIRK_NOGET
},
73 { USB_VENDOR_ID_SYMBOL
, USB_DEVICE_ID_SYMBOL_SCANNER_1
, HID_QUIRK_NOGET
},
74 { USB_VENDOR_ID_SYMBOL
, USB_DEVICE_ID_SYMBOL_SCANNER_2
, HID_QUIRK_NOGET
},
75 { USB_VENDOR_ID_TURBOX
, USB_DEVICE_ID_TURBOX_KEYBOARD
, HID_QUIRK_NOGET
},
76 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209
, HID_QUIRK_MULTI_INPUT
},
77 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U
, HID_QUIRK_MULTI_INPUT
},
78 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5
, HID_QUIRK_MULTI_INPUT
},
79 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60
, HID_QUIRK_MULTI_INPUT
},
80 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U
, HID_QUIRK_MULTI_INPUT
},
81 { USB_VENDOR_ID_UCLOGIC
, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U
, HID_QUIRK_MULTI_INPUT
},
82 { USB_VENDOR_ID_WALTOP
, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH
, HID_QUIRK_MULTI_INPUT
},
83 { USB_VENDOR_ID_WALTOP
, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH
, HID_QUIRK_MULTI_INPUT
},
84 { USB_VENDOR_ID_WISEGROUP
, USB_DEVICE_ID_QUAD_USB_JOYPAD
, HID_QUIRK_NOGET
| HID_QUIRK_MULTI_INPUT
},
86 { USB_VENDOR_ID_WISEGROUP_LTD2
, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS
, HID_QUIRK_NOGET
| HID_QUIRK_MULTI_INPUT
},
88 { USB_VENDOR_ID_PI_ENGINEERING
, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL
, HID_QUIRK_HIDINPUT_FORCE
},
90 { USB_VENDOR_ID_CHICONY
, USB_DEVICE_ID_CHICONY_MULTI_TOUCH
, HID_QUIRK_MULTI_INPUT
},
91 { USB_VENDOR_ID_CHICONY
, USB_DEVICE_ID_CHICONY_WIRELESS
, HID_QUIRK_MULTI_INPUT
},
92 { USB_VENDOR_ID_SIGMA_MICRO
, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD
, HID_QUIRK_NO_INIT_REPORTS
},
96 /* Dynamic HID quirks list - specified at runtime */
97 struct quirks_list_struct
{
98 struct hid_blacklist hid_bl_item
;
99 struct list_head node
;
102 static LIST_HEAD(dquirks_list
);
103 static DECLARE_RWSEM(dquirks_rwsem
);
105 /* Runtime ("dynamic") quirks manipulation functions */
108 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
109 * @idVendor: the 16-bit USB vendor ID, in native byteorder
110 * @idProduct: the 16-bit USB product ID, in native byteorder
113 * Scans dquirks_list for a matching dynamic quirk and returns
114 * the pointer to the relevant struct hid_blacklist if found.
115 * Must be called with a read lock held on dquirks_rwsem.
117 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
119 static struct hid_blacklist
*usbhid_exists_dquirk(const u16 idVendor
,
122 struct quirks_list_struct
*q
;
123 struct hid_blacklist
*bl_entry
= NULL
;
125 list_for_each_entry(q
, &dquirks_list
, node
) {
126 if (q
->hid_bl_item
.idVendor
== idVendor
&&
127 q
->hid_bl_item
.idProduct
== idProduct
) {
128 bl_entry
= &q
->hid_bl_item
;
133 if (bl_entry
!= NULL
)
134 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
135 bl_entry
->quirks
, bl_entry
->idVendor
,
136 bl_entry
->idProduct
);
143 * usbhid_modify_dquirk: add/replace a HID quirk
144 * @idVendor: the 16-bit USB vendor ID, in native byteorder
145 * @idProduct: the 16-bit USB product ID, in native byteorder
146 * @quirks: the u32 quirks value to add/replace
149 * If an dynamic quirk exists in memory for this (idVendor,
150 * idProduct) pair, replace its quirks value with what was
151 * provided. Otherwise, add the quirk to the dynamic quirks list.
153 * Returns: 0 OK, -error on failure.
155 static int usbhid_modify_dquirk(const u16 idVendor
, const u16 idProduct
,
158 struct quirks_list_struct
*q_new
, *q
;
162 dbg_hid("Cannot add a quirk with idVendor = 0\n");
166 q_new
= kmalloc(sizeof(struct quirks_list_struct
), GFP_KERNEL
);
168 dbg_hid("Could not allocate quirks_list_struct\n");
172 q_new
->hid_bl_item
.idVendor
= idVendor
;
173 q_new
->hid_bl_item
.idProduct
= idProduct
;
174 q_new
->hid_bl_item
.quirks
= quirks
;
176 down_write(&dquirks_rwsem
);
178 list_for_each_entry(q
, &dquirks_list
, node
) {
180 if (q
->hid_bl_item
.idVendor
== idVendor
&&
181 q
->hid_bl_item
.idProduct
== idProduct
) {
183 list_replace(&q
->node
, &q_new
->node
);
193 list_add_tail(&q_new
->node
, &dquirks_list
);
195 up_write(&dquirks_rwsem
);
201 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
204 * Free all memory associated with dynamic quirks - called before
208 static void usbhid_remove_all_dquirks(void)
210 struct quirks_list_struct
*q
, *temp
;
212 down_write(&dquirks_rwsem
);
213 list_for_each_entry_safe(q
, temp
, &dquirks_list
, node
) {
217 up_write(&dquirks_rwsem
);
222 * usbhid_quirks_init: apply USB HID quirks specified at module load time
224 int usbhid_quirks_init(char **quirks_param
)
226 u16 idVendor
, idProduct
;
230 for (; n
< MAX_USBHID_BOOT_QUIRKS
&& quirks_param
[n
]; n
++) {
232 m
= sscanf(quirks_param
[n
], "0x%hx:0x%hx:0x%x",
233 &idVendor
, &idProduct
, &quirks
);
236 usbhid_modify_dquirk(idVendor
, idProduct
, quirks
) != 0) {
238 "Could not parse HID quirk module param %s\n",
247 * usbhid_quirks_exit: release memory associated with dynamic_quirks
250 * Release all memory associated with dynamic quirks. Called upon
255 void usbhid_quirks_exit(void)
257 usbhid_remove_all_dquirks();
261 * usbhid_exists_squirk: return any static quirks for a USB HID device
262 * @idVendor: the 16-bit USB vendor ID, in native byteorder
263 * @idProduct: the 16-bit USB product ID, in native byteorder
266 * Given a USB vendor ID and product ID, return a pointer to
267 * the hid_blacklist entry associated with that device.
269 * Returns: pointer if quirk found, or NULL if no quirks found.
271 static const struct hid_blacklist
*usbhid_exists_squirk(const u16 idVendor
,
274 const struct hid_blacklist
*bl_entry
= NULL
;
277 for (; hid_blacklist
[n
].idVendor
; n
++)
278 if (hid_blacklist
[n
].idVendor
== idVendor
&&
279 hid_blacklist
[n
].idProduct
== idProduct
)
280 bl_entry
= &hid_blacklist
[n
];
282 if (bl_entry
!= NULL
)
283 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
284 bl_entry
->quirks
, bl_entry
->idVendor
,
285 bl_entry
->idProduct
);
290 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
291 * @idVendor: the 16-bit USB vendor ID, in native byteorder
292 * @idProduct: the 16-bit USB product ID, in native byteorder
295 * Given a USB vendor ID and product ID, return any quirks associated
298 * Returns: a u32 quirks value.
300 u32
usbhid_lookup_quirk(const u16 idVendor
, const u16 idProduct
)
303 const struct hid_blacklist
*bl_entry
= NULL
;
305 /* NCR devices must not be queried for reports */
306 if (idVendor
== USB_VENDOR_ID_NCR
&&
307 idProduct
>= USB_DEVICE_ID_NCR_FIRST
&&
308 idProduct
<= USB_DEVICE_ID_NCR_LAST
)
309 return HID_QUIRK_NO_INIT_REPORTS
;
311 down_read(&dquirks_rwsem
);
312 bl_entry
= usbhid_exists_dquirk(idVendor
, idProduct
);
314 bl_entry
= usbhid_exists_squirk(idVendor
, idProduct
);
316 quirks
= bl_entry
->quirks
;
317 up_read(&dquirks_rwsem
);
322 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk
);