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