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>
19 #include <linux/export.h>
20 #include <linux/slab.h>
21
22 #include "../hid-ids.h"
23
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[] = {
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 },
47
48 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
49
50 { USB_VENDOR_ID_EMS, USB_DEVICE_ID_EMS_TRIO_LINKER_PLUS_II, HID_QUIRK_MULTI_INPUT },
51 { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
52 { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT },
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 },
55 { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
56
57 { USB_VENDOR_ID_AIREN, USB_DEVICE_ID_AIREN_SLIMPLUS, HID_QUIRK_NOGET },
58 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
59 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
60 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
61 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
62 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
63 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FIGHTERSTICK, HID_QUIRK_NOGET },
64 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
65 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
66 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
67 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET },
68 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
69 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
70 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, 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_FORMOSA, USB_DEVICE_ID_FORMOSA_IR_RECEIVER, HID_QUIRK_NO_INIT_REPORTS },
74 { USB_VENDOR_ID_FREESCALE, USB_DEVICE_ID_FREESCALE_MX28, HID_QUIRK_NOGET },
75 { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_NOGET },
76 { USB_VENDOR_ID_MSI, USB_DEVICE_ID_MSI_GX680R_LED_PANEL, HID_QUIRK_NO_INIT_REPORTS },
77 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS },
78 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS },
79 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS },
80 { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
81 { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
82 { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008, HID_QUIRK_NOGET },
83 { USB_VENDOR_ID_REALTEK, USB_DEVICE_ID_REALTEK_READER, HID_QUIRK_NO_INIT_REPORTS },
84 { USB_VENDOR_ID_SENNHEISER, USB_DEVICE_ID_SENNHEISER_BTD500USB, HID_QUIRK_NOGET },
85 { USB_VENDOR_ID_SIGMATEL, USB_DEVICE_ID_SIGMATEL_STMP3780, HID_QUIRK_NOGET },
86 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
87 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET },
88 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET },
89 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
90 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
91 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
92 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
93 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT },
94 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
95 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
96 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT },
97 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT },
98 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
99
100 { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
101
102 { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
103
104 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
105 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT },
106 { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS },
107 { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_MOUSEPEN_I608X, HID_QUIRK_MULTI_INPUT },
108 { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_EASYPEN_M610X, HID_QUIRK_MULTI_INPUT },
109 { USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_DUOSENSE, HID_QUIRK_NO_INIT_REPORTS },
110
111 { 0, 0 }
112 };
113
114 /* Dynamic HID quirks list - specified at runtime */
115 struct quirks_list_struct {
116 struct hid_blacklist hid_bl_item;
117 struct list_head node;
118 };
119
120 static LIST_HEAD(dquirks_list);
121 static DECLARE_RWSEM(dquirks_rwsem);
122
123 /* Runtime ("dynamic") quirks manipulation functions */
124
125 /**
126 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
127 * @idVendor: the 16-bit USB vendor ID, in native byteorder
128 * @idProduct: the 16-bit USB product ID, in native byteorder
129 *
130 * Description:
131 * Scans dquirks_list for a matching dynamic quirk and returns
132 * the pointer to the relevant struct hid_blacklist if found.
133 * Must be called with a read lock held on dquirks_rwsem.
134 *
135 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
136 */
usbhid_exists_dquirk(const u16 idVendor,const u16 idProduct)137 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
138 const u16 idProduct)
139 {
140 struct quirks_list_struct *q;
141 struct hid_blacklist *bl_entry = NULL;
142
143 list_for_each_entry(q, &dquirks_list, node) {
144 if (q->hid_bl_item.idVendor == idVendor &&
145 q->hid_bl_item.idProduct == idProduct) {
146 bl_entry = &q->hid_bl_item;
147 break;
148 }
149 }
150
151 if (bl_entry != NULL)
152 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
153 bl_entry->quirks, bl_entry->idVendor,
154 bl_entry->idProduct);
155
156 return bl_entry;
157 }
158
159
160 /**
161 * usbhid_modify_dquirk: add/replace a HID quirk
162 * @idVendor: the 16-bit USB vendor ID, in native byteorder
163 * @idProduct: the 16-bit USB product ID, in native byteorder
164 * @quirks: the u32 quirks value to add/replace
165 *
166 * Description:
167 * If an dynamic quirk exists in memory for this (idVendor,
168 * idProduct) pair, replace its quirks value with what was
169 * provided. Otherwise, add the quirk to the dynamic quirks list.
170 *
171 * Returns: 0 OK, -error on failure.
172 */
usbhid_modify_dquirk(const u16 idVendor,const u16 idProduct,const u32 quirks)173 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
174 const u32 quirks)
175 {
176 struct quirks_list_struct *q_new, *q;
177 int list_edited = 0;
178
179 if (!idVendor) {
180 dbg_hid("Cannot add a quirk with idVendor = 0\n");
181 return -EINVAL;
182 }
183
184 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
185 if (!q_new) {
186 dbg_hid("Could not allocate quirks_list_struct\n");
187 return -ENOMEM;
188 }
189
190 q_new->hid_bl_item.idVendor = idVendor;
191 q_new->hid_bl_item.idProduct = idProduct;
192 q_new->hid_bl_item.quirks = quirks;
193
194 down_write(&dquirks_rwsem);
195
196 list_for_each_entry(q, &dquirks_list, node) {
197
198 if (q->hid_bl_item.idVendor == idVendor &&
199 q->hid_bl_item.idProduct == idProduct) {
200
201 list_replace(&q->node, &q_new->node);
202 kfree(q);
203 list_edited = 1;
204 break;
205
206 }
207
208 }
209
210 if (!list_edited)
211 list_add_tail(&q_new->node, &dquirks_list);
212
213 up_write(&dquirks_rwsem);
214
215 return 0;
216 }
217
218 /**
219 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
220 *
221 * Description:
222 * Free all memory associated with dynamic quirks - called before
223 * module unload.
224 *
225 */
usbhid_remove_all_dquirks(void)226 static void usbhid_remove_all_dquirks(void)
227 {
228 struct quirks_list_struct *q, *temp;
229
230 down_write(&dquirks_rwsem);
231 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
232 list_del(&q->node);
233 kfree(q);
234 }
235 up_write(&dquirks_rwsem);
236
237 }
238
239 /**
240 * usbhid_quirks_init: apply USB HID quirks specified at module load time
241 */
usbhid_quirks_init(char ** quirks_param)242 int usbhid_quirks_init(char **quirks_param)
243 {
244 u16 idVendor, idProduct;
245 u32 quirks;
246 int n = 0, m;
247
248 for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
249
250 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
251 &idVendor, &idProduct, &quirks);
252
253 if (m != 3 ||
254 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
255 printk(KERN_WARNING
256 "Could not parse HID quirk module param %s\n",
257 quirks_param[n]);
258 }
259 }
260
261 return 0;
262 }
263
264 /**
265 * usbhid_quirks_exit: release memory associated with dynamic_quirks
266 *
267 * Description:
268 * Release all memory associated with dynamic quirks. Called upon
269 * module unload.
270 *
271 * Returns: nothing
272 */
usbhid_quirks_exit(void)273 void usbhid_quirks_exit(void)
274 {
275 usbhid_remove_all_dquirks();
276 }
277
278 /**
279 * usbhid_exists_squirk: return any static quirks for a USB HID device
280 * @idVendor: the 16-bit USB vendor ID, in native byteorder
281 * @idProduct: the 16-bit USB product ID, in native byteorder
282 *
283 * Description:
284 * Given a USB vendor ID and product ID, return a pointer to
285 * the hid_blacklist entry associated with that device.
286 *
287 * Returns: pointer if quirk found, or NULL if no quirks found.
288 */
usbhid_exists_squirk(const u16 idVendor,const u16 idProduct)289 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
290 const u16 idProduct)
291 {
292 const struct hid_blacklist *bl_entry = NULL;
293 int n = 0;
294
295 for (; hid_blacklist[n].idVendor; n++)
296 if (hid_blacklist[n].idVendor == idVendor &&
297 hid_blacklist[n].idProduct == idProduct)
298 bl_entry = &hid_blacklist[n];
299
300 if (bl_entry != NULL)
301 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
302 bl_entry->quirks, bl_entry->idVendor,
303 bl_entry->idProduct);
304 return bl_entry;
305 }
306
307 /**
308 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
309 * @idVendor: the 16-bit USB vendor ID, in native byteorder
310 * @idProduct: the 16-bit USB product ID, in native byteorder
311 *
312 * Description:
313 * Given a USB vendor ID and product ID, return any quirks associated
314 * with that device.
315 *
316 * Returns: a u32 quirks value.
317 */
usbhid_lookup_quirk(const u16 idVendor,const u16 idProduct)318 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
319 {
320 u32 quirks = 0;
321 const struct hid_blacklist *bl_entry = NULL;
322
323 /* NCR devices must not be queried for reports */
324 if (idVendor == USB_VENDOR_ID_NCR &&
325 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
326 idProduct <= USB_DEVICE_ID_NCR_LAST)
327 return HID_QUIRK_NO_INIT_REPORTS;
328
329 down_read(&dquirks_rwsem);
330 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
331 if (!bl_entry)
332 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
333 if (bl_entry)
334 quirks = bl_entry->quirks;
335 up_read(&dquirks_rwsem);
336
337 return quirks;
338 }
339
340 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
341