Version:  2.0.40 2.2.26 2.4.37 2.6.39 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15

Linux/drivers/hid/usbhid/hid-quirks.c

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

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us