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
  32         { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_WCP32PU, HID_QUIRK_2WHEEL_MOUSE_HACK_7 },
  33         { USB_VENDOR_ID_A4TECH, USB_DEVICE_ID_A4TECH_X5_005D, HID_QUIRK_2WHEEL_MOUSE_HACK_B8 },
  34         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_MOUSE, HID_QUIRK_2WHEEL_MOUSE_HACK_5 },
  35
  36         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
  37         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
  38         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
  39         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
  40         { USB_VENDOR_ID_GAMERON, USB_DEVICE_ID_GAMERON_DUAL_PSX_ADAPTOR, HID_QUIRK_MULTI_INPUT },
  41         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  42         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  43         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  44         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
  45         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
  46         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
  47         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
  48
  49         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
  50
  51         { USB_VENDOR_ID_BELKIN, USB_DEVICE_ID_FLIP_KVM, HID_QUIRK_HIDDEV },
  52         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },
  53         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_HIDDEV | HID_QUIRK_IGNORE_HIDINPUT },
  54         { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV, HID_QUIRK_HIDINPUT },
  55
  56         { USB_VENDOR_ID_EZKEY, USB_DEVICE_ID_BTC_8193, HID_QUIRK_HWHEEL_WHEEL_INVERT },
  57
  58
  59         { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K, HID_QUIRK_MICROSOFT_KEYS },
  60         { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K, HID_QUIRK_MICROSOFT_KEYS },
  61
  62         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE, HID_QUIRK_MIGHTYMOUSE | HID_QUIRK_INVERT_HWHEEL },
  63
  64         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  65         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
  66
  67         { USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER, HID_QUIRK_SONY_PS3_CONTROLLER | HID_QUIRK_HIDDEV },
  68
  69         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
  70         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
  71         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
  72         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
  73         { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
  74         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  75         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  76         { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0, HID_QUIRK_NOGET },
  77         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_NOGET },
  78         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  79         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  80         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  81         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  82
  83         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  84
  85         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  86         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  87         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  88         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE | HID_QUIRK_APPLE_ISO_KEYBOARD},
  89         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER_JIS, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  90         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  91         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE | HID_QUIRK_APPLE_ISO_KEYBOARD},
  92         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER3_JIS, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  93         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  94         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE | HID_QUIRK_APPLE_ISO_KEYBOARD},
  95         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
  96         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI, HID_QUIRK_APPLE_HAS_FN },
  97         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_APPLE_ISO_KEYBOARD },
  98         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS, HID_QUIRK_APPLE_HAS_FN },
  99         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 100         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 101         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_HF_JIS, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 102         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN },
 103         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_APPLE_ISO_KEYBOARD },
 104         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN },
 105         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ANSI, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 106         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_ISO, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_APPLE_ISO_KEYBOARD | HID_QUIRK_IGNORE_MOUSE},
 107         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING_JIS, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE},
 108         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE},
 109         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_ISO, HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_APPLE_ISO_KEYBOARD | HID_QUIRK_IGNORE_MOUSE },
 110         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_WELLSPRING2_JIS, HID_QUIRK_APPLE_HAS_FN  | HID_QUIRK_IGNORE_MOUSE },
 111         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 112         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY, HID_QUIRK_APPLE_NUMLOCK_EMULATION | HID_QUIRK_APPLE_HAS_FN | HID_QUIRK_IGNORE_MOUSE },
 113
 114         { USB_VENDOR_ID_DELL, USB_DEVICE_ID_DELL_W7658, HID_QUIRK_RESET_LEDS },
 115
 116         { 0, 0 }
 117 };
 118
 119 /* Quirks for devices which require report descriptor fixup go here */
 120 static const struct hid_rdesc_blacklist {
 121         __u16 idVendor;
 122         __u16 idProduct;
 123         __u32 quirks;
 124 } hid_rdesc_blacklist[] = {
 125
 126         { USB_VENDOR_ID_CHERRY, USB_DEVICE_ID_CHERRY_CYMOTION, HID_QUIRK_RDESC_CYMOTION },
 127
 128         { USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_DESKTOP_RECV_1028, HID_QUIRK_RDESC_MICROSOFT_RECV_1028 },
 129
 130         { USB_VENDOR_ID_MONTEREY, USB_DEVICE_ID_GENIUS_KB29E, HID_QUIRK_RDESC_BUTTON_CONSUMER },
 131
 132         { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_GEYSER4_JIS, HID_QUIRK_RDESC_MACBOOK_JIS },
 133
 134         { USB_VENDOR_ID_PETALYNX, USB_DEVICE_ID_PETALYNX_MAXTER_REMOTE, HID_QUIRK_RDESC_PETALYNX },
 135
 136         { USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE, HID_QUIRK_RDESC_SAMSUNG_REMOTE },
 137
 138         { USB_VENDOR_ID_SUNPLUS, USB_DEVICE_ID_SUNPLUS_WDESKTOP, HID_QUIRK_RDESC_SUNPLUS_WDESKTOP },
 139
 140         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_1, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
 141         { USB_VENDOR_ID_CYPRESS, USB_DEVICE_ID_CYPRESS_BARCODE_2, HID_QUIRK_RDESC_SWAPPED_MIN_MAX },
 142
 143         { 0, 0 }
 144 };
 145
 146 /* Dynamic HID quirks list - specified at runtime */
 147 struct quirks_list_struct {
 148         struct hid_blacklist hid_bl_item;
 149         struct list_head node;
 150 };
 151
 152 static LIST_HEAD(dquirks_list);
 153 static DECLARE_RWSEM(dquirks_rwsem);
 154
 155 /* Runtime ("dynamic") quirks manipulation functions */
 156
 157 /**
 158  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 159  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 160  * @idProduct: the 16-bit USB product ID, in native byteorder
 161  *
 162  * Description:
 163  *         Scans dquirks_list for a matching dynamic quirk and returns
 164  *         the pointer to the relevant struct hid_blacklist if found.
 165  *         Must be called with a read lock held on dquirks_rwsem.
 166  *
 167  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 168  */
 169 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
 170                 const u16 idProduct)
 171 {
 172         struct quirks_list_struct *q;
 173         struct hid_blacklist *bl_entry = NULL;
 174
 175         list_for_each_entry(q, &dquirks_list, node) {
 176                 if (q->hid_bl_item.idVendor == idVendor &&
 177                                 q->hid_bl_item.idProduct == idProduct) {
 178                         bl_entry = &q->hid_bl_item;
 179                         break;
 180                 }
 181         }
 182
 183         if (bl_entry != NULL)
 184                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 185                                 bl_entry->quirks, bl_entry->idVendor,
 186                                 bl_entry->idProduct);
 187
 188         return bl_entry;
 189 }
 190
 191
 192 /**
 193  * usbhid_modify_dquirk: add/replace a HID quirk
 194  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 195  * @idProduct: the 16-bit USB product ID, in native byteorder
 196  * @quirks: the u32 quirks value to add/replace
 197  *
 198  * Description:
 199  *         If an dynamic quirk exists in memory for this (idVendor,
 200  *         idProduct) pair, replace its quirks value with what was
 201  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 202  *
 203  * Returns: 0 OK, -error on failure.
 204  */
 205 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
 206                                 const u32 quirks)
 207 {
 208         struct quirks_list_struct *q_new, *q;
 209         int list_edited = 0;
 210
 211         if (!idVendor) {
 212                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
 213                 return -EINVAL;
 214         }
 215
 216         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
 217         if (!q_new) {
 218                 dbg_hid("Could not allocate quirks_list_struct\n");
 219                 return -ENOMEM;
 220         }
 221
 222         q_new->hid_bl_item.idVendor = idVendor;
 223         q_new->hid_bl_item.idProduct = idProduct;
 224         q_new->hid_bl_item.quirks = quirks;
 225
 226         down_write(&dquirks_rwsem);
 227
 228         list_for_each_entry(q, &dquirks_list, node) {
 229
 230                 if (q->hid_bl_item.idVendor == idVendor &&
 231                                 q->hid_bl_item.idProduct == idProduct) {
 232
 233                         list_replace(&q->node, &q_new->node);
 234                         kfree(q);
 235                         list_edited = 1;
 236                         break;
 237
 238                 }
 239
 240         }
 241
 242         if (!list_edited)
 243                 list_add_tail(&q_new->node, &dquirks_list);
 244
 245         up_write(&dquirks_rwsem);
 246
 247         return 0;
 248 }
 249
 250 /**
 251  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 252  *
 253  * Description:
 254  *         Free all memory associated with dynamic quirks - called before
 255  *         module unload.
 256  *
 257  */
 258 static void usbhid_remove_all_dquirks(void)
 259 {
 260         struct quirks_list_struct *q, *temp;
 261
 262         down_write(&dquirks_rwsem);
 263         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
 264                 list_del(&q->node);
 265                 kfree(q);
 266         }
 267         up_write(&dquirks_rwsem);
 268
 269 }
 270
 271 /**
 272  * usbhid_quirks_init: apply USB HID quirks specified at module load time
 273  */
 274 int usbhid_quirks_init(char **quirks_param)
 275 {
 276         u16 idVendor, idProduct;
 277         u32 quirks;
 278         int n = 0, m;
 279
 280         for (; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
 281
 282                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 283                                 &idVendor, &idProduct, &quirks);
 284
 285                 if (m != 3 ||
 286                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
 287                         printk(KERN_WARNING
 288                                         "Could not parse HID quirk module param %s\n",
 289                                         quirks_param[n]);
 290                 }
 291         }
 292
 293         return 0;
 294 }
 295
 296 /**
 297  * usbhid_quirks_exit: release memory associated with dynamic_quirks
 298  *
 299  * Description:
 300  *     Release all memory associated with dynamic quirks.  Called upon
 301  *     module unload.
 302  *
 303  * Returns: nothing
 304  */
 305 void usbhid_quirks_exit(void)
 306 {
 307         usbhid_remove_all_dquirks();
 308 }
 309
 310 /**
 311  * usbhid_exists_squirk: return any static quirks for a USB HID device
 312  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 313  * @idProduct: the 16-bit USB product ID, in native byteorder
 314  *
 315  * Description:
 316  *     Given a USB vendor ID and product ID, return a pointer to
 317  *     the hid_blacklist entry associated with that device.
 318  *
 319  * Returns: pointer if quirk found, or NULL if no quirks found.
 320  */
 321 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
 322                 const u16 idProduct)
 323 {
 324         const struct hid_blacklist *bl_entry = NULL;
 325         int n = 0;
 326
 327         for (; hid_blacklist[n].idVendor; n++)
 328                 if (hid_blacklist[n].idVendor == idVendor &&
 329                                 hid_blacklist[n].idProduct == idProduct)
 330                         bl_entry = &hid_blacklist[n];
 331
 332         if (bl_entry != NULL)
 333                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 334                                 bl_entry->quirks, bl_entry->idVendor,
 335                                 bl_entry->idProduct);
 336         return bl_entry;
 337 }
 338
 339 /**
 340  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 341  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 342  * @idProduct: the 16-bit USB product ID, in native byteorder
 343  *
 344  * Description:
 345  *     Given a USB vendor ID and product ID, return any quirks associated
 346  *     with that device.
 347  *
 348  * Returns: a u32 quirks value.
 349  */
 350 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
 351 {
 352         u32 quirks = 0;
 353         const struct hid_blacklist *bl_entry = NULL;
 354
 355         /* NCR devices must not be queried for reports */
 356         if (idVendor == USB_VENDOR_ID_NCR &&
 357                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
 358                         idProduct <= USB_DEVICE_ID_NCR_LAST)
 359                         return HID_QUIRK_NOGET;
 360
 361         down_read(&dquirks_rwsem);
 362         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
 363         if (!bl_entry)
 364                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
 365         if (bl_entry)
 366                 quirks = bl_entry->quirks;
 367         up_read(&dquirks_rwsem);
 368
 369         return quirks;
 370 }
 371
 372 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
 373
 374 /*
 375  * Cherry Cymotion keyboard have an invalid HID report descriptor,
 376  * that needs fixing before we can parse it.
 377  */
 378 static void usbhid_fixup_cymotion_descriptor(char *rdesc, int rsize)
 379 {
 380         if (rsize >= 17 && rdesc[11] == 0x3c && rdesc[12] == 0x02) {
 381                 printk(KERN_INFO "Fixing up Cherry Cymotion report descriptor\n");
 382                 rdesc[11] = rdesc[16] = 0xff;
 383                 rdesc[12] = rdesc[17] = 0x03;
 384         }
 385 }
 386
 387 static void usbhid_fixup_sunplus_wdesktop(unsigned char *rdesc, int rsize)
 388 {
 389         if (rsize >= 107 && rdesc[104] == 0x26
 390                          && rdesc[105] == 0x80
 391                          && rdesc[106] == 0x03) {
 392                 printk(KERN_INFO "Fixing up Sunplus Wireless Desktop report descriptor\n");
 393                 rdesc[105] = rdesc[110] = 0x03;
 394                 rdesc[106] = rdesc[111] = 0x21;
 395         }
 396 }
 397
 398 /*
 399  * Samsung IrDA remote controller (reports as Cypress USB Mouse).
 400  *
 401  * Vendor specific report #4 has a size of 48 bit,
 402  * and therefore is not accepted when inspecting the descriptors.
 403  * As a workaround we reinterpret the report as:
 404  *   Variable type, count 6, size 8 bit, log. maximum 255
 405  * The burden to reconstruct the data is moved into user space.
 406  */
 407 static void usbhid_fixup_samsung_irda_descriptor(unsigned char *rdesc,
 408                                                   int rsize)
 409 {
 410         if (rsize >= 182 && rdesc[175] == 0x25
 411                          && rdesc[176] == 0x40
 412                          && rdesc[177] == 0x75
 413                          && rdesc[178] == 0x30
 414                          && rdesc[179] == 0x95
 415                          && rdesc[180] == 0x01
 416                          && rdesc[182] == 0x40) {
 417                 printk(KERN_INFO "Fixing up Samsung IrDA report descriptor\n");
 418                 rdesc[176] = 0xff;
 419                 rdesc[178] = 0x08;
 420                 rdesc[180] = 0x06;
 421                 rdesc[182] = 0x42;
 422         }
 423 }
 424
 425 /* Petalynx Maxter Remote has maximum for consumer page set too low */
 426 static void usbhid_fixup_petalynx_descriptor(unsigned char *rdesc, int rsize)
 427 {
 428         if (rsize >= 60 && rdesc[39] == 0x2a
 429                         && rdesc[40] == 0xf5
 430                         && rdesc[41] == 0x00
 431                         && rdesc[59] == 0x26
 432                         && rdesc[60] == 0xf9
 433                         && rdesc[61] == 0x00) {
 434                 printk(KERN_INFO "Fixing up Petalynx Maxter Remote report descriptor\n");
 435                 rdesc[60] = 0xfa;
 436                 rdesc[40] = 0xfa;
 437         }
 438 }
 439
 440 /*
 441  * Some USB barcode readers from cypress have usage min and usage max in
 442  * the wrong order
 443  */
 444 static void usbhid_fixup_cypress_descriptor(unsigned char *rdesc, int rsize)
 445 {
 446         short fixed = 0;
 447         int i;
 448
 449         for (i = 0; i < rsize - 4; i++) {
 450                 if (rdesc[i] == 0x29 && rdesc [i+2] == 0x19) {
 451                         unsigned char tmp;
 452
 453                         rdesc[i] = 0x19; rdesc[i+2] = 0x29;
 454                         tmp = rdesc[i+3];
 455                         rdesc[i+3] = rdesc[i+1];
 456                         rdesc[i+1] = tmp;
 457                 }
 458         }
 459
 460         if (fixed)
 461                 printk(KERN_INFO "Fixing up Cypress report descriptor\n");
 462 }
 463
 464 /*
 465  * MacBook JIS keyboard has wrong logical maximum
 466  */
 467 static void usbhid_fixup_macbook_descriptor(unsigned char *rdesc, int rsize)
 468 {
 469         if (rsize >= 60 && rdesc[53] == 0x65
 470                         && rdesc[59] == 0x65) {
 471                 printk(KERN_INFO "Fixing up MacBook JIS keyboard report descriptor\n");
 472                 rdesc[53] = rdesc[59] = 0xe7;
 473         }
 474 }
 475
 476 static void usbhid_fixup_button_consumer_descriptor(unsigned char *rdesc, int rsize)
 477 {
 478         if (rsize >= 30 && rdesc[29] == 0x05
 479                         && rdesc[30] == 0x09) {
 480                 printk(KERN_INFO "Fixing up button/consumer in HID report descriptor\n");
 481                 rdesc[30] = 0x0c;
 482         }
 483 }
 484
 485 /*
 486  * Microsoft Wireless Desktop Receiver (Model 1028) has several
 487  * 'Usage Min/Max' where it ought to have 'Physical Min/Max'
 488  */
 489 static void usbhid_fixup_microsoft_descriptor(unsigned char *rdesc, int rsize)
 490 {
 491         if (rsize == 571 && rdesc[284] == 0x19
 492                          && rdesc[286] == 0x2a
 493                          && rdesc[304] == 0x19
 494                          && rdesc[306] == 0x29
 495                          && rdesc[352] == 0x1a
 496                          && rdesc[355] == 0x2a
 497                          && rdesc[557] == 0x19
 498                          && rdesc[559] == 0x29) {
 499                 printk(KERN_INFO "Fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n");
 500                 rdesc[284] = rdesc[304] = rdesc[557] = 0x35;
 501                 rdesc[352] = 0x36;
 502                 rdesc[286] = rdesc[355] = 0x46;
 503                 rdesc[306] = rdesc[559] = 0x45;
 504         }
 505 }
 506
 507 static void __usbhid_fixup_report_descriptor(__u32 quirks, char *rdesc, unsigned rsize)
 508 {
 509         if ((quirks & HID_QUIRK_RDESC_CYMOTION))
 510                 usbhid_fixup_cymotion_descriptor(rdesc, rsize);
 511
 512         if (quirks & HID_QUIRK_RDESC_SWAPPED_MIN_MAX)
 513                 usbhid_fixup_cypress_descriptor(rdesc, rsize);
 514
 515         if (quirks & HID_QUIRK_RDESC_PETALYNX)
 516                 usbhid_fixup_petalynx_descriptor(rdesc, rsize);
 517
 518         if (quirks & HID_QUIRK_RDESC_MACBOOK_JIS)
 519                 usbhid_fixup_macbook_descriptor(rdesc, rsize);
 520
 521         if (quirks & HID_QUIRK_RDESC_BUTTON_CONSUMER)
 522                 usbhid_fixup_button_consumer_descriptor(rdesc, rsize);
 523
 524         if (quirks & HID_QUIRK_RDESC_SAMSUNG_REMOTE)
 525                 usbhid_fixup_samsung_irda_descriptor(rdesc, rsize);
 526
 527         if (quirks & HID_QUIRK_RDESC_MICROSOFT_RECV_1028)
 528                 usbhid_fixup_microsoft_descriptor(rdesc, rsize);
 529
 530         if (quirks & HID_QUIRK_RDESC_SUNPLUS_WDESKTOP)
 531                 usbhid_fixup_sunplus_wdesktop(rdesc, rsize);
 532 }
 533
 534 /**
 535  * usbhid_fixup_report_descriptor: check if report descriptor needs fixup
 536  *
 537  * Description:
 538  *      Walks the hid_rdesc_blacklist[] array and checks whether the device
 539  *      is known to have broken report descriptor that needs to be fixed up
 540  *      prior to entering the HID parser
 541  *
 542  * Returns: nothing
 543  */
 544 void usbhid_fixup_report_descriptor(const u16 idVendor, const u16 idProduct,
 545                                     char *rdesc, unsigned rsize, char **quirks_param)
 546 {
 547         int n, m;
 548         u16 paramVendor, paramProduct;
 549         u32 quirks;
 550
 551         /* static rdesc quirk entries */
 552         for (n = 0; hid_rdesc_blacklist[n].idVendor; n++)
 553                 if (hid_rdesc_blacklist[n].idVendor == idVendor &&
 554                                 hid_rdesc_blacklist[n].idProduct == idProduct)
 555                         __usbhid_fixup_report_descriptor(hid_rdesc_blacklist[n].quirks,
 556                                         rdesc, rsize);
 557
 558         /* runtime rdesc quirk entries handling */
 559         for (n = 0; quirks_param[n] && n < MAX_USBHID_BOOT_QUIRKS; n++) {
 560                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 561                                 &paramVendor, &paramProduct, &quirks);
 562
 563                 if (m != 3)
 564                         printk(KERN_WARNING
 565                                 "Could not parse HID quirk module param %s\n",
 566                                 quirks_param[n]);
 567                 else if (paramVendor == idVendor && paramProduct == idProduct)
 568                         __usbhid_fixup_report_descriptor(quirks, rdesc, rsize);
 569         }
 570 }