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