HID: move cherry quirks
[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
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_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
36         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
37         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
38         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
39         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
40         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
41         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
42         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
43
44         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
45
46         { USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM, HID_QUIRK_HIDDEV },
47         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },
48
49         { USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193, HID_QUIRK_HWHEEL_WHEEL_INVERT },
50
51         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
52         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
53
54         { USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },
55
56         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
57         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
58         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
59         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
60         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
61         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
62         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
63         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
64         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
65         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
66         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
67         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
68
69         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
70
71         { USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
72
73         { 0, 0 }
74 };
75
76 /* Quirks for devices which require report descriptor fixup go here */
77 static const struct hid_rdesc_blacklist {
78         __u16 idVendor;
79         __u16 idProduct;
80         __u32 quirks;
81 } hid_rdesc_blacklist[] = {
82         { USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
83
84         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
85
86         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
87
88         { 0, 0 }
89 };
90
91 /* Dynamic HID quirks list - specified at runtime */
92 struct quirks_list_struct {
93         struct hid_blacklist hid_bl_item;
94         struct list_head node;
95 };
96
97 static LIST_HEAD(dquirks_list);
98 static DECLARE_RWSEM(dquirks_rwsem);
99
100 /* Runtime ("dynamic") quirks manipulation functions */
101
102 /**
103  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
104  * @idVendor: the 16-bit USB vendor ID, in native byteorder
105  * @idProduct: the 16-bit USB product ID, in native byteorder
106  *
107  * Description:
108  *         Scans dquirks_list for a matching dynamic quirk and returns
109  *         the pointer to the relevant struct hid_blacklist if found.
110  *         Must be called with a read lock held on dquirks_rwsem.
111  *
112  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
113  */
114 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
115                 const u16 idProduct)
116 {
117         struct quirks_list_struct *q;
118         struct hid_blacklist *bl_entry = NULL;
119
120         list_for_each_entry(q, &dquirks_list, node) {
121                 if (q->hid_bl_item.idVendor == idVendor &&
122                                 q->hid_bl_item.idProduct == idProduct) {
123                         bl_entry = &q->hid_bl_item;
124                         break;
125                 }
126         }
127
128         if (bl_entry != NULL)
129                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
130                                 bl_entry->quirks, bl_entry->idVendor,
131                                 bl_entry->idProduct);
132
133         return bl_entry;
134 }
135
136
137 /**
138  * usbhid_modify_dquirk: add/replace a HID quirk
139  * @idVendor: the 16-bit USB vendor ID, in native byteorder
140  * @idProduct: the 16-bit USB product ID, in native byteorder
141  * @quirks: the u32 quirks value to add/replace
142  *
143  * Description:
144  *         If an dynamic quirk exists in memory for this (idVendor,
145  *         idProduct) pair, replace its quirks value with what was
146  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
147  *
148  * Returns: 0 OK, -error on failure.
149  */
150 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
151                                 const u32 quirks)
152 {
153         struct quirks_list_struct *q_new, *q;
154         int list_edited = 0;
155
156         if (!idVendor) {
157                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
158                 return -EINVAL;
159         }
160
161         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
162         if (!q_new) {
163                 dbg_hid("Could not allocate quirks_list_struct\n");
164                 return -ENOMEM;
165         }
166
167         q_new->hid_bl_item.idVendor = idVendor;
168         q_new->hid_bl_item.idProduct = idProduct;
169         q_new->hid_bl_item.quirks = quirks;
170
171         down_write(&dquirks_rwsem);
172
173         list_for_each_entry(q, &dquirks_list, node) {
174
175                 if (q->hid_bl_item.idVendor == idVendor &&
176                                 q->hid_bl_item.idProduct == idProduct) {
177
178                         list_replace(&q->node, &q_new->node);
179                         kfree(q);
180                         list_edited = 1;
181                         break;
182
183                 }
184
185         }
186
187         if (!list_edited)
188                 list_add_tail(&q_new->node, &dquirks_list);
189
190         up_write(&dquirks_rwsem);
191
192         return 0;
193 }
194
195 /**
196  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
197  *
198  * Description:
199  *         Free all memory associated with dynamic quirks - called before
200  *         module unload.
201  *
202  */
203 static void usbhid_remove_all_dquirks(void)
204 {
205         struct quirks_list_struct *q, *temp;
206
207         down_write(&dquirks_rwsem);
208         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
209                 list_del(&q->node);
210                 kfree(q);
211         }
212         up_write(&dquirks_rwsem);
213
214 }
215
216 /** 
217  * usbhid_quirks_init: apply USB HID quirks specified at module load time
218  */
219 int usbhid_quirks_init(char **quirks_param)
220 {
221         u16 idVendor, idProduct;
222         u32 quirks;
223         int n = 0, m;
224
225         for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
226
227                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
228                                 &idVendor, &idProduct, &quirks);
229
230                 if (m != 3 ||
231                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
232                         printk(KERN_WARNING
233                                         "Could not parse HID quirk module param %s\n",
234                                         quirks_param[n]);
235                 }
236         }
237
238         return 0;
239 }
240
241 /**
242  * usbhid_quirks_exit: release memory associated with dynamic_quirks
243  *
244  * Description:
245  *     Release all memory associated with dynamic quirks.  Called upon
246  *     module unload.
247  *
248  * Returns: nothing
249  */
250 void usbhid_quirks_exit(void)
251 {
252         usbhid_remove_all_dquirks();
253 }
254
255 /**
256  * usbhid_exists_squirk: return any static quirks for a USB HID device
257  * @idVendor: the 16-bit USB vendor ID, in native byteorder
258  * @idProduct: the 16-bit USB product ID, in native byteorder
259  *
260  * Description:
261  *     Given a USB vendor ID and product ID, return a pointer to
262  *     the hid_blacklist entry associated with that device.
263  *
264  * Returns: pointer if quirk found, or NULL if no quirks found.
265  */
266 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
267                 const u16 idProduct)
268 {
269         const struct hid_blacklist *bl_entry = NULL;
270         int n = 0;
271
272         for (; hid_blacklist[n].idVendor; n++)
273                 if (hid_blacklist[n].idVendor == idVendor &&
274                                 hid_blacklist[n].idProduct == idProduct)
275                         bl_entry = &hid_blacklist[n];
276
277         if (bl_entry != NULL)
278                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
279                                 bl_entry->quirks, bl_entry->idVendor, 
280                                 bl_entry->idProduct);
281         return bl_entry;
282 }
283
284 /**
285  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
286  * @idVendor: the 16-bit USB vendor ID, in native byteorder
287  * @idProduct: the 16-bit USB product ID, in native byteorder
288  *
289  * Description:
290  *     Given a USB vendor ID and product ID, return any quirks associated
291  *     with that device.
292  *
293  * Returns: a u32 quirks value.
294  */
295 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
296 {
297         u32 quirks = 0;
298         const struct hid_blacklist *bl_entry = NULL;
299
300         /* NCR devices must not be queried for reports */
301         if (idVendor == USB_VENDOR_ID_NCR &&
302                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
303                         idProduct <= USB_DEVICE_ID_NCR_LAST)
304                         return HID_QUIRK_NOGET;
305
306         down_read(&dquirks_rwsem);
307         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
308         if (!bl_entry)
309                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
310         if (bl_entry)
311                 quirks = bl_entry->quirks;
312         up_read(&dquirks_rwsem);
313
314         return quirks;
315 }
316
317 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
318
319 /*
320  * Samsung IrDA remote controller (reports as Cypress USB Mouse).
321  *
322  * Vendor specific report #4 has a size of 48 bit,
323  * and therefore is not accepted when inspecting the descriptors.
324  * As a workaround we reinterpret the report as:
325  *   Variable type, count 6, size 8 bit, log. maximum 255
326  * The burden to reconstruct the data is moved into user space.
327  */
328 static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
329                                                   int rsize)
330 {
331         if (rsize >= 182 && rdesc[175] == 0x25
332                          && rdesc[176] == 0x40
333                          && rdesc[177] == 0x75
334                          && rdesc[178] == 0x30
335                          && rdesc[179] == 0x95
336                          && rdesc[180] == 0x01
337                          && rdesc[182] == 0x40) {
338                 printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
339                 rdesc[176] = 0xff;
340                 rdesc[178] = 0x08;
341                 rdesc[180] = 0x06;
342                 rdesc[182] = 0x42;
343         }
344 }
345
346 /* Petalynx Maxter Remote has maximum for consumer page set too low */
347 static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
348 {
349         if (rsize >= 60 && rdesc[39] == 0x2a
350                         && rdesc[40] == 0xf5
351                         && rdesc[41] == 0x00
352                         && rdesc[59] == 0x26
353                         && rdesc[60] == 0xf9
354                         && rdesc[61] == 0x00) {
355                 printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
356                 rdesc[60] = 0xfa;
357                 rdesc[40] = 0xfa;
358         }
359 }
360
361 static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
362 {
363         if (rsize >= 30 && rdesc[29] == 0x05
364                         && rdesc[30] == 0x09) {
365                 printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
366                 rdesc[30] = 0x0c;
367         }
368 }
369
370 static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
371 {
372         if (quirks & HID_QUIRK_RDESC_PETALYNX)
373                 usbhid_fixup_petalynx_descriptor(rdesc, rsize);
374
375         if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
376                 usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
377
378         if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
379                 usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
380 }
381
382 /**
383  * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
384  *
385  * Description:
386  *      Walks the hid_rdesc_blacklist[] array and checks whether the device
387  *      is known to have broken report descriptor that needs to be fixed up
388  *      prior to entering the HID parser
389  *
390  * Returns: nothing
391  */
392 void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
393                                     char *rdesc, unsigned rsize, char **quirks_param)
394 {
395         int n, m;
396         u16 paramVendor, paramProduct;
397         u32 quirks;
398
399         /* static rdesc quirk entries */
400         for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
401                 if (hid_rdesc_blacklist[n].idVendor == idVendor &&
402                                 hid_rdesc_blacklist[n].idProduct == idProduct)
403                         __usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
404                                         rdesc, rsize);
405
406         /* runtime rdesc quirk entries handling */
407         for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
408                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
409                                 &paramVendor, &paramProduct, &quirks);
410
411                 if (m != 3)
412                         printk(KERN_WARNING
413                                 "Could not parse HID quirk module param %s\n",
414                                 quirks_param[n]);
415                 else if (paramVendor == idVendor && paramProduct == idProduct)
416                         __usbhid_fixup_report_descriptor(quirks, rdesc, rsize);
417         }
418 }