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