HID: multitouch: add more eGalax devices
[linux-2.6-block.git] / drivers / hid / usbhid / hid-quirks.c
CommitLineData
2eb5dc30
PW
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>
ec37d321 19#include <linux/export.h>
5a0e3ad6 20#include <linux/slab.h>
2eb5dc30 21
990436a7 22#include "../hid-ids.h"
a32bcc45 23
2eb5dc30
PW
24/*
25 * Alphabetically sorted blacklist by quirk type.
26 */
27
28static const struct hid_blacklist {
29 __u16 idVendor;
30 __u16 idProduct;
31 __u32 quirks;
32} hid_blacklist[] = {
2eb5dc30
PW
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 },
d34c4aa4 37 { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
1f45e324 38 { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
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 },
c9bde7ad 42 { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
2eb5dc30 43 { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
9db630b4 44 { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
2eb5dc30
PW
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 },
2c3e3bfb 47
f345c37c
PS
48 { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
49
cd07655e 50 { USB_VENDOR_ID_EMS, USB_DEVICE_ID_EMS_TRIO_LINKER_PLUS_II, HID_QUIRK_MULTI_INPUT },
8127f4e8 51 { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
6d1db077 52 { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
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 },
c2c3489c 55 { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
2eb5dc30 56
2eb5dc30
PW
57 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
58 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
59 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
60 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
61 { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
b820aabf 62 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
c8e84646 63 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
b820aabf 64 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
da60325d 65 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET },
b820aabf 66 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
73cdcf56 67 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
8038298f 68 { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
02008faa 69 { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
d500d116 70 { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
b7ea95ff
AT
71 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS },
72 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS },
73 { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS },
c2c3489c 74 { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
c565c54d 75 { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
2eb5dc30 76 { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
4b5730fa
JK
77 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET },
78 { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET },
2eb5dc30 79 { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
25e61613 80 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
eff7f270 81 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
426409b1 82 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
e23be0a2 83 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT },
f8a489cc
NK
84 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
85 { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
72a46344 86 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT },
8f1acc32 87 { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT },
2eb5dc30
PW
88 { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
89
66ebf66e 90 { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
2eb5dc30 91
70c7c9c4
DM
92 { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
93
7cacfa87 94 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
b9e4b1e0 95 { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT },
f5e42825 96 { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS },
ea9a4a8b
JK
97 { 0, 0 }
98};
99
8cef9082
PW
100/* Dynamic HID quirks list - specified at runtime */
101struct quirks_list_struct {
102 struct hid_blacklist hid_bl_item;
103 struct list_head node;
104};
105
106static LIST_HEAD(dquirks_list);
107static DECLARE_RWSEM(dquirks_rwsem);
108
109/* Runtime ("dynamic") quirks manipulation functions */
110
8222fbe6 111/**
8cef9082
PW
112 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
113 * @idVendor: the 16-bit USB vendor ID, in native byteorder
114 * @idProduct: the 16-bit USB product ID, in native byteorder
115 *
116 * Description:
117 * Scans dquirks_list for a matching dynamic quirk and returns
118 * the pointer to the relevant struct hid_blacklist if found.
119 * Must be called with a read lock held on dquirks_rwsem.
120 *
121 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
122 */
123static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
124 const u16 idProduct)
125{
126 struct quirks_list_struct *q;
127 struct hid_blacklist *bl_entry = NULL;
128
8cef9082
PW
129 list_for_each_entry(q, &dquirks_list, node) {
130 if (q->hid_bl_item.idVendor == idVendor &&
131 q->hid_bl_item.idProduct == idProduct) {
132 bl_entry = &q->hid_bl_item;
133 break;
134 }
135 }
136
137 if (bl_entry != NULL)
58037eb9 138 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8cef9082
PW
139 bl_entry->quirks, bl_entry->idVendor,
140 bl_entry->idProduct);
141
142 return bl_entry;
143}
144
145
146/**
147 * usbhid_modify_dquirk: add/replace a HID quirk
148 * @idVendor: the 16-bit USB vendor ID, in native byteorder
149 * @idProduct: the 16-bit USB product ID, in native byteorder
150 * @quirks: the u32 quirks value to add/replace
151 *
152 * Description:
153 * If an dynamic quirk exists in memory for this (idVendor,
154 * idProduct) pair, replace its quirks value with what was
155 * provided. Otherwise, add the quirk to the dynamic quirks list.
156 *
157 * Returns: 0 OK, -error on failure.
158 */
abdff0f7
AB
159static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
160 const u32 quirks)
8cef9082
PW
161{
162 struct quirks_list_struct *q_new, *q;
163 int list_edited = 0;
164
165 if (!idVendor) {
58037eb9 166 dbg_hid("Cannot add a quirk with idVendor = 0\n");
8cef9082
PW
167 return -EINVAL;
168 }
169
170 q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
171 if (!q_new) {
58037eb9 172 dbg_hid("Could not allocate quirks_list_struct\n");
8cef9082
PW
173 return -ENOMEM;
174 }
175
176 q_new->hid_bl_item.idVendor = idVendor;
177 q_new->hid_bl_item.idProduct = idProduct;
178 q_new->hid_bl_item.quirks = quirks;
179
180 down_write(&dquirks_rwsem);
181
182 list_for_each_entry(q, &dquirks_list, node) {
183
184 if (q->hid_bl_item.idVendor == idVendor &&
185 q->hid_bl_item.idProduct == idProduct) {
186
187 list_replace(&q->node, &q_new->node);
188 kfree(q);
189 list_edited = 1;
190 break;
191
192 }
193
194 }
195
196 if (!list_edited)
197 list_add_tail(&q_new->node, &dquirks_list);
198
199 up_write(&dquirks_rwsem);
200
201 return 0;
202}
203
8cef9082
PW
204/**
205 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
206 *
207 * Description:
208 * Free all memory associated with dynamic quirks - called before
209 * module unload.
210 *
211 */
212static void usbhid_remove_all_dquirks(void)
213{
214 struct quirks_list_struct *q, *temp;
215
216 down_write(&dquirks_rwsem);
217 list_for_each_entry_safe(q, temp, &dquirks_list, node) {
218 list_del(&q->node);
219 kfree(q);
220 }
221 up_write(&dquirks_rwsem);
222
223}
224
876b9276
PW
225/**
226 * usbhid_quirks_init: apply USB HID quirks specified at module load time
227 */
228int usbhid_quirks_init(char **quirks_param)
229{
230 u16 idVendor, idProduct;
231 u32 quirks;
232 int n = 0, m;
233
44cb2db1 234 for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
876b9276
PW
235
236 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
237 &idVendor, &idProduct, &quirks);
238
239 if (m != 3 ||
240 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
241 printk(KERN_WARNING
242 "Could not parse HID quirk module param %s\n",
243 quirks_param[n]);
244 }
245 }
246
247 return 0;
248}
249
250/**
251 * usbhid_quirks_exit: release memory associated with dynamic_quirks
252 *
253 * Description:
254 * Release all memory associated with dynamic quirks. Called upon
255 * module unload.
256 *
257 * Returns: nothing
258 */
259void usbhid_quirks_exit(void)
260{
261 usbhid_remove_all_dquirks();
262}
8cef9082
PW
263
264/**
265 * usbhid_exists_squirk: return any static quirks for a USB HID device
266 * @idVendor: the 16-bit USB vendor ID, in native byteorder
267 * @idProduct: the 16-bit USB product ID, in native byteorder
268 *
269 * Description:
270 * Given a USB vendor ID and product ID, return a pointer to
271 * the hid_blacklist entry associated with that device.
272 *
273 * Returns: pointer if quirk found, or NULL if no quirks found.
274 */
8222fbe6 275static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
8cef9082 276 const u16 idProduct)
8222fbe6 277{
8cef9082
PW
278 const struct hid_blacklist *bl_entry = NULL;
279 int n = 0;
8222fbe6
PW
280
281 for (; hid_blacklist[n].idVendor; n++)
282 if (hid_blacklist[n].idVendor == idVendor &&
283 hid_blacklist[n].idProduct == idProduct)
284 bl_entry = &hid_blacklist[n];
285
286 if (bl_entry != NULL)
58037eb9 287 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
8222fbe6
PW
288 bl_entry->quirks, bl_entry->idVendor,
289 bl_entry->idProduct);
290 return bl_entry;
291}
2eb5dc30
PW
292
293/**
294 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
295 * @idVendor: the 16-bit USB vendor ID, in native byteorder
296 * @idProduct: the 16-bit USB product ID, in native byteorder
297 *
298 * Description:
299 * Given a USB vendor ID and product ID, return any quirks associated
300 * with that device.
301 *
302 * Returns: a u32 quirks value.
303 */
304u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
305{
306 u32 quirks = 0;
8222fbe6 307 const struct hid_blacklist *bl_entry = NULL;
2eb5dc30 308
b8e98f1c
JK
309 /* NCR devices must not be queried for reports */
310 if (idVendor == USB_VENDOR_ID_NCR &&
311 idProduct >= USB_DEVICE_ID_NCR_FIRST &&
312 idProduct <= USB_DEVICE_ID_NCR_LAST)
5b915d9e 313 return HID_QUIRK_NO_INIT_REPORTS;
b8e98f1c 314
8cef9082
PW
315 down_read(&dquirks_rwsem);
316 bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
317 if (!bl_entry)
318 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
8222fbe6
PW
319 if (bl_entry)
320 quirks = bl_entry->quirks;
8cef9082
PW
321 up_read(&dquirks_rwsem);
322
2eb5dc30
PW
323 return quirks;
324}
8222fbe6 325
9f6b3727 326EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);