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