Commit | Line | Data |
---|---|---|
2eb5dc30 PW |
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> | |
ec37d321 | 19 | #include <linux/export.h> |
5a0e3ad6 | 20 | #include <linux/slab.h> |
2eb5dc30 | 21 | |
990436a7 | 22 | #include "../hid-ids.h" |
a32bcc45 | 23 | |
2eb5dc30 PW |
24 | /* |
25 | * Alphabetically sorted blacklist by quirk type. | |
26 | */ | |
27 | ||
28 | static const struct hid_blacklist { | |
29 | __u16 idVendor; | |
30 | __u16 idProduct; | |
31 | __u32 quirks; | |
32 | } hid_blacklist[] = { | |
2eb5dc30 PW |
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 }, | |
d34c4aa4 | 37 | { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET }, |
1f45e324 | 38 | { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT }, |
2eb5dc30 PW |
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 }, | |
c9bde7ad | 42 | { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD }, |
2eb5dc30 | 43 | { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD }, |
9db630b4 | 44 | { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT}, |
2eb5dc30 PW |
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 }, | |
2c3e3bfb | 47 | |
f345c37c PS |
48 | { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL }, |
49 | ||
cd07655e | 50 | { USB_VENDOR_ID_EMS, USB_DEVICE_ID_EMS_TRIO_LINKER_PLUS_II, HID_QUIRK_MULTI_INPUT }, |
8127f4e8 | 51 | { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT }, |
6d1db077 | 52 | { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT }, |
2eb5dc30 PW |
53 | { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS }, |
54 | { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT }, | |
c2c3489c | 55 | { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT }, |
2eb5dc30 | 56 | |
2eb5dc30 PW |
57 | { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET }, |
58 | { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET }, | |
59 | { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET }, | |
60 | { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET }, | |
61 | { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET }, | |
724ed328 | 62 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FIGHTERSTICK, HID_QUIRK_NOGET }, |
b820aabf | 63 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET }, |
c8e84646 | 64 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET }, |
b820aabf | 65 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET }, |
da60325d | 66 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET }, |
b820aabf | 67 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET }, |
73cdcf56 | 68 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET }, |
8038298f | 69 | { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET }, |
02008faa | 70 | { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET }, |
d500d116 | 71 | { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET }, |
b7ea95ff AT |
72 | { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS }, |
73 | { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS }, | |
74 | { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS }, | |
c2c3489c | 75 | { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET }, |
c565c54d | 76 | { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET }, |
2eb5dc30 | 77 | { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET }, |
4b5730fa JK |
78 | { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET }, |
79 | { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET }, | |
2eb5dc30 | 80 | { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET }, |
25e61613 | 81 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT }, |
eff7f270 | 82 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT }, |
426409b1 | 83 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT }, |
e23be0a2 | 84 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT }, |
f8a489cc NK |
85 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT }, |
86 | { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT }, | |
72a46344 | 87 | { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT }, |
8f1acc32 | 88 | { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT }, |
2eb5dc30 PW |
89 | { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT }, |
90 | ||
66ebf66e | 91 | { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT }, |
2eb5dc30 | 92 | |
70c7c9c4 DM |
93 | { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE }, |
94 | ||
7cacfa87 | 95 | { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT }, |
b9e4b1e0 | 96 | { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT }, |
f5e42825 | 97 | { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS }, |
ea9a4a8b JK |
98 | { 0, 0 } |
99 | }; | |
100 | ||
8cef9082 PW |
101 | /* Dynamic HID quirks list - specified at runtime */ |
102 | struct quirks_list_struct { | |
103 | struct hid_blacklist hid_bl_item; | |
104 | struct list_head node; | |
105 | }; | |
106 | ||
107 | static LIST_HEAD(dquirks_list); | |
108 | static DECLARE_RWSEM(dquirks_rwsem); | |
109 | ||
110 | /* Runtime ("dynamic") quirks manipulation functions */ | |
111 | ||
8222fbe6 | 112 | /** |
8cef9082 PW |
113 | * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device |
114 | * @idVendor: the 16-bit USB vendor ID, in native byteorder | |
115 | * @idProduct: the 16-bit USB product ID, in native byteorder | |
116 | * | |
117 | * Description: | |
118 | * Scans dquirks_list for a matching dynamic quirk and returns | |
119 | * the pointer to the relevant struct hid_blacklist if found. | |
120 | * Must be called with a read lock held on dquirks_rwsem. | |
121 | * | |
122 | * Returns: NULL if no quirk found, struct hid_blacklist * if found. | |
123 | */ | |
124 | static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor, | |
125 | const u16 idProduct) | |
126 | { | |
127 | struct quirks_list_struct *q; | |
128 | struct hid_blacklist *bl_entry = NULL; | |
129 | ||
8cef9082 PW |
130 | list_for_each_entry(q, &dquirks_list, node) { |
131 | if (q->hid_bl_item.idVendor == idVendor && | |
132 | q->hid_bl_item.idProduct == idProduct) { | |
133 | bl_entry = &q->hid_bl_item; | |
134 | break; | |
135 | } | |
136 | } | |
137 | ||
138 | if (bl_entry != NULL) | |
58037eb9 | 139 | dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n", |
8cef9082 PW |
140 | bl_entry->quirks, bl_entry->idVendor, |
141 | bl_entry->idProduct); | |
142 | ||
143 | return bl_entry; | |
144 | } | |
145 | ||
146 | ||
147 | /** | |
148 | * usbhid_modify_dquirk: add/replace a HID quirk | |
149 | * @idVendor: the 16-bit USB vendor ID, in native byteorder | |
150 | * @idProduct: the 16-bit USB product ID, in native byteorder | |
151 | * @quirks: the u32 quirks value to add/replace | |
152 | * | |
153 | * Description: | |
154 | * If an dynamic quirk exists in memory for this (idVendor, | |
155 | * idProduct) pair, replace its quirks value with what was | |
156 | * provided. Otherwise, add the quirk to the dynamic quirks list. | |
157 | * | |
158 | * Returns: 0 OK, -error on failure. | |
159 | */ | |
abdff0f7 AB |
160 | static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct, |
161 | const u32 quirks) | |
8cef9082 PW |
162 | { |
163 | struct quirks_list_struct *q_new, *q; | |
164 | int list_edited = 0; | |
165 | ||
166 | if (!idVendor) { | |
58037eb9 | 167 | dbg_hid("Cannot add a quirk with idVendor = 0\n"); |
8cef9082 PW |
168 | return -EINVAL; |
169 | } | |
170 | ||
171 | q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL); | |
172 | if (!q_new) { | |
58037eb9 | 173 | dbg_hid("Could not allocate quirks_list_struct\n"); |
8cef9082 PW |
174 | return -ENOMEM; |
175 | } | |
176 | ||
177 | q_new->hid_bl_item.idVendor = idVendor; | |
178 | q_new->hid_bl_item.idProduct = idProduct; | |
179 | q_new->hid_bl_item.quirks = quirks; | |
180 | ||
181 | down_write(&dquirks_rwsem); | |
182 | ||
183 | list_for_each_entry(q, &dquirks_list, node) { | |
184 | ||
185 | if (q->hid_bl_item.idVendor == idVendor && | |
186 | q->hid_bl_item.idProduct == idProduct) { | |
187 | ||
188 | list_replace(&q->node, &q_new->node); | |
189 | kfree(q); | |
190 | list_edited = 1; | |
191 | break; | |
192 | ||
193 | } | |
194 | ||
195 | } | |
196 | ||
197 | if (!list_edited) | |
198 | list_add_tail(&q_new->node, &dquirks_list); | |
199 | ||
200 | up_write(&dquirks_rwsem); | |
201 | ||
202 | return 0; | |
203 | } | |
204 | ||
8cef9082 PW |
205 | /** |
206 | * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory | |
207 | * | |
208 | * Description: | |
209 | * Free all memory associated with dynamic quirks - called before | |
210 | * module unload. | |
211 | * | |
212 | */ | |
213 | static void usbhid_remove_all_dquirks(void) | |
214 | { | |
215 | struct quirks_list_struct *q, *temp; | |
216 | ||
217 | down_write(&dquirks_rwsem); | |
218 | list_for_each_entry_safe(q, temp, &dquirks_list, node) { | |
219 | list_del(&q->node); | |
220 | kfree(q); | |
221 | } | |
222 | up_write(&dquirks_rwsem); | |
223 | ||
224 | } | |
225 | ||
876b9276 PW |
226 | /** |
227 | * usbhid_quirks_init: apply USB HID quirks specified at module load time | |
228 | */ | |
229 | int usbhid_quirks_init(char **quirks_param) | |
230 | { | |
231 | u16 idVendor, idProduct; | |
232 | u32 quirks; | |
233 | int n = 0, m; | |
234 | ||
44cb2db1 | 235 | for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) { |
876b9276 PW |
236 | |
237 | m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x", | |
238 | &idVendor, &idProduct, &quirks); | |
239 | ||
240 | if (m != 3 || | |
241 | usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) { | |
242 | printk(KERN_WARNING | |
243 | "Could not parse HID quirk module param %s\n", | |
244 | quirks_param[n]); | |
245 | } | |
246 | } | |
247 | ||
248 | return 0; | |
249 | } | |
250 | ||
251 | /** | |
252 | * usbhid_quirks_exit: release memory associated with dynamic_quirks | |
253 | * | |
254 | * Description: | |
255 | * Release all memory associated with dynamic quirks. Called upon | |
256 | * module unload. | |
257 | * | |
258 | * Returns: nothing | |
259 | */ | |
260 | void usbhid_quirks_exit(void) | |
261 | { | |
262 | usbhid_remove_all_dquirks(); | |
263 | } | |
8cef9082 PW |
264 | |
265 | /** | |
266 | * usbhid_exists_squirk: return any static quirks for a USB HID device | |
267 | * @idVendor: the 16-bit USB vendor ID, in native byteorder | |
268 | * @idProduct: the 16-bit USB product ID, in native byteorder | |
269 | * | |
270 | * Description: | |
271 | * Given a USB vendor ID and product ID, return a pointer to | |
272 | * the hid_blacklist entry associated with that device. | |
273 | * | |
274 | * Returns: pointer if quirk found, or NULL if no quirks found. | |
275 | */ | |
8222fbe6 | 276 | static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor, |
8cef9082 | 277 | const u16 idProduct) |
8222fbe6 | 278 | { |
8cef9082 PW |
279 | const struct hid_blacklist *bl_entry = NULL; |
280 | int n = 0; | |
8222fbe6 PW |
281 | |
282 | for (; hid_blacklist[n].idVendor; n++) | |
283 | if (hid_blacklist[n].idVendor == idVendor && | |
284 | hid_blacklist[n].idProduct == idProduct) | |
285 | bl_entry = &hid_blacklist[n]; | |
286 | ||
287 | if (bl_entry != NULL) | |
58037eb9 | 288 | dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n", |
8222fbe6 PW |
289 | bl_entry->quirks, bl_entry->idVendor, |
290 | bl_entry->idProduct); | |
291 | return bl_entry; | |
292 | } | |
2eb5dc30 PW |
293 | |
294 | /** | |
295 | * usbhid_lookup_quirk: return any quirks associated with a USB HID device | |
296 | * @idVendor: the 16-bit USB vendor ID, in native byteorder | |
297 | * @idProduct: the 16-bit USB product ID, in native byteorder | |
298 | * | |
299 | * Description: | |
300 | * Given a USB vendor ID and product ID, return any quirks associated | |
301 | * with that device. | |
302 | * | |
303 | * Returns: a u32 quirks value. | |
304 | */ | |
305 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct) | |
306 | { | |
307 | u32 quirks = 0; | |
8222fbe6 | 308 | const struct hid_blacklist *bl_entry = NULL; |
2eb5dc30 | 309 | |
b8e98f1c JK |
310 | /* NCR devices must not be queried for reports */ |
311 | if (idVendor == USB_VENDOR_ID_NCR && | |
312 | idProduct >= USB_DEVICE_ID_NCR_FIRST && | |
313 | idProduct <= USB_DEVICE_ID_NCR_LAST) | |
5b915d9e | 314 | return HID_QUIRK_NO_INIT_REPORTS; |
b8e98f1c | 315 | |
8cef9082 PW |
316 | down_read(&dquirks_rwsem); |
317 | bl_entry = usbhid_exists_dquirk(idVendor, idProduct); | |
318 | if (!bl_entry) | |
319 | bl_entry = usbhid_exists_squirk(idVendor, idProduct); | |
8222fbe6 PW |
320 | if (bl_entry) |
321 | quirks = bl_entry->quirks; | |
8cef9082 PW |
322 | up_read(&dquirks_rwsem); |
323 | ||
2eb5dc30 PW |
324 | return quirks; |
325 | } | |
8222fbe6 | 326 | |
9f6b3727 | 327 | EXPORT_SYMBOL_GPL(usbhid_lookup_quirk); |