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