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