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