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