HID: Kanvus Note A5 tablet needs HID_QUIRK_MULTI_INPUT
[linux-2.6.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/slab.h>
20
21 #include "../hid-ids.h"
22
23 /*
24  * Alphabetically sorted blacklist by quirk type.
25  */
26
27 static const struct hid_blacklist {
28         __u16 idVendor;
29         __u16 idProduct;
30         __u32 quirks;
31 } hid_blacklist[] = {
32         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
33         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
34         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
35         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
36         { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH, HID_QUIRK_MULTI_INPUT },
37         { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
38         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
39         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
40         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
41         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
42         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
43         { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
44         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
45         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
46
47         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
48
49         { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
50         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
51         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
52         { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
53
54         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
55         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
56         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
57         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
58         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
59         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
60         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
61         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
62         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
63         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
64         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
65         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
66         { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
67         { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
68         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
69         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
70         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
71         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
72         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
73         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
74         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
75
76         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
77         { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
78
79         { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
80
81         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
82
83         { 0, 0 }
84 };
85
86 /* Dynamic HID quirks list - specified at runtime */
87 struct quirks_list_struct {
88         struct hid_blacklist hid_bl_item;
89         struct list_head node;
90 };
91
92 static LIST_HEAD(dquirks_list);
93 static DECLARE_RWSEM(dquirks_rwsem);
94
95 /* Runtime ("dynamic") quirks manipulation functions */
96
97 /**
98  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
99  * @idVendor: the 16-bit USB vendor ID, in native byteorder
100  * @idProduct: the 16-bit USB product ID, in native byteorder
101  *
102  * Description:
103  *         Scans dquirks_list for a matching dynamic quirk and returns
104  *         the pointer to the relevant struct hid_blacklist if found.
105  *         Must be called with a read lock held on dquirks_rwsem.
106  *
107  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
108  */
109 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
110                 const u16 idProduct)
111 {
112         struct quirks_list_struct *q;
113         struct hid_blacklist *bl_entry = NULL;
114
115         list_for_each_entry(q, &dquirks_list, node) {
116                 if (q->hid_bl_item.idVendor == idVendor &&
117                                 q->hid_bl_item.idProduct == idProduct) {
118                         bl_entry = &q->hid_bl_item;
119                         break;
120                 }
121         }
122
123         if (bl_entry != NULL)
124                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
125                                 bl_entry->quirks, bl_entry->idVendor,
126                                 bl_entry->idProduct);
127
128         return bl_entry;
129 }
130
131
132 /**
133  * usbhid_modify_dquirk: add/replace a HID quirk
134  * @idVendor: the 16-bit USB vendor ID, in native byteorder
135  * @idProduct: the 16-bit USB product ID, in native byteorder
136  * @quirks: the u32 quirks value to add/replace
137  *
138  * Description:
139  *         If an dynamic quirk exists in memory for this (idVendor,
140  *         idProduct) pair, replace its quirks value with what was
141  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
142  *
143  * Returns: 0 OK, -error on failure.
144  */
145 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
146                                 const u32 quirks)
147 {
148         struct quirks_list_struct *q_new, *q;
149         int list_edited = 0;
150
151         if (!idVendor) {
152                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
153                 return -EINVAL;
154         }
155
156         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
157         if (!q_new) {
158                 dbg_hid("Could not allocate quirks_list_struct\n");
159                 return -ENOMEM;
160         }
161
162         q_new->hid_bl_item.idVendor = idVendor;
163         q_new->hid_bl_item.idProduct = idProduct;
164         q_new->hid_bl_item.quirks = quirks;
165
166         down_write(&dquirks_rwsem);
167
168         list_for_each_entry(q, &dquirks_list, node) {
169
170                 if (q->hid_bl_item.idVendor == idVendor &&
171                                 q->hid_bl_item.idProduct == idProduct) {
172
173                         list_replace(&q->node, &q_new->node);
174                         kfree(q);
175                         list_edited = 1;
176                         break;
177
178                 }
179
180         }
181
182         if (!list_edited)
183                 list_add_tail(&q_new->node, &dquirks_list);
184
185         up_write(&dquirks_rwsem);
186
187         return 0;
188 }
189
190 /**
191  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
192  *
193  * Description:
194  *         Free all memory associated with dynamic quirks - called before
195  *         module unload.
196  *
197  */
198 static void usbhid_remove_all_dquirks(void)
199 {
200         struct quirks_list_struct *q, *temp;
201
202         down_write(&dquirks_rwsem);
203         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
204                 list_del(&q->node);
205                 kfree(q);
206         }
207         up_write(&dquirks_rwsem);
208
209 }
210
211 /** 
212  * usbhid_quirks_init: apply USB HID quirks specified at module load time
213  */
214 int usbhid_quirks_init(char **quirks_param)
215 {
216         u16 idVendor, idProduct;
217         u32 quirks;
218         int n = 0, m;
219
220         for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
221
222                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
223                                 &idVendor, &idProduct, &quirks);
224
225                 if (m != 3 ||
226                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
227                         printk(KERN_WARNING
228                                         "Could not parse HID quirk module param %s\n",
229                                         quirks_param[n]);
230                 }
231         }
232
233         return 0;
234 }
235
236 /**
237  * usbhid_quirks_exit: release memory associated with dynamic_quirks
238  *
239  * Description:
240  *     Release all memory associated with dynamic quirks.  Called upon
241  *     module unload.
242  *
243  * Returns: nothing
244  */
245 void usbhid_quirks_exit(void)
246 {
247         usbhid_remove_all_dquirks();
248 }
249
250 /**
251  * usbhid_exists_squirk: return any static quirks for a USB HID device
252  * @idVendor: the 16-bit USB vendor ID, in native byteorder
253  * @idProduct: the 16-bit USB product ID, in native byteorder
254  *
255  * Description:
256  *     Given a USB vendor ID and product ID, return a pointer to
257  *     the hid_blacklist entry associated with that device.
258  *
259  * Returns: pointer if quirk found, or NULL if no quirks found.
260  */
261 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
262                 const u16 idProduct)
263 {
264         const struct hid_blacklist *bl_entry = NULL;
265         int n = 0;
266
267         for (; hid_blacklist[n].idVendor; n++)
268                 if (hid_blacklist[n].idVendor == idVendor &&
269                                 hid_blacklist[n].idProduct == idProduct)
270                         bl_entry = &hid_blacklist[n];
271
272         if (bl_entry != NULL)
273                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
274                                 bl_entry->quirks, bl_entry->idVendor, 
275                                 bl_entry->idProduct);
276         return bl_entry;
277 }
278
279 /**
280  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
281  * @idVendor: the 16-bit USB vendor ID, in native byteorder
282  * @idProduct: the 16-bit USB product ID, in native byteorder
283  *
284  * Description:
285  *     Given a USB vendor ID and product ID, return any quirks associated
286  *     with that device.
287  *
288  * Returns: a u32 quirks value.
289  */
290 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
291 {
292         u32 quirks = 0;
293         const struct hid_blacklist *bl_entry = NULL;
294
295         /* NCR devices must not be queried for reports */
296         if (idVendor == USB_VENDOR_ID_NCR &&
297                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
298                         idProduct <= USB_DEVICE_ID_NCR_LAST)
299                         return HID_QUIRK_NO_INIT_REPORTS;
300
301         down_read(&dquirks_rwsem);
302         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
303         if (!bl_entry)
304                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
305         if (bl_entry)
306                 quirks = bl_entry->quirks;
307         up_read(&dquirks_rwsem);
308
309         return quirks;
310 }
311
312 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);