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