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