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