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 #include <linux/slab.h>
  20
  21 #include "../hid-ids.h"
  22
  23 /*
  24  * Alphabetically sorted blacklist by quirk type.
  25  */
  26
  27 static const struct hid_blacklist {
  28         __u16 idVendor;
  29         __u16 idProduct;
  30         __u32 quirks;
  31 } hid_blacklist[] = {
  32         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
  33         { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
  34         { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
  35         { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
  36         { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
  37         { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_DWAV_EGALAX_MULTITOUCH, HID_QUIRK_MULTI_INPUT },
  38         { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, HID_QUIRK_MULTI_INPUT },
  39         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_TOUCHSCREEN_MOSART, HID_QUIRK_MULTI_INPUT },
  40         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_DRIVING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  41         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FLYING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  42         { USB_VENDOR_ID_HAPP, USB_DEVICE_ID_UGCI_FIGHTING, HID_QUIRK_BADPAD | HID_QUIRK_MULTI_INPUT },
  43         { USB_VENDOR_ID_NATSU, USB_DEVICE_ID_NATSU_GAMEPAD, HID_QUIRK_BADPAD },
  44         { USB_VENDOR_ID_NEC, USB_DEVICE_ID_NEC_USB_GAME_PAD, HID_QUIRK_BADPAD },
  45         { USB_VENDOR_ID_NEXTWINDOW, USB_DEVICE_ID_NEXTWINDOW_TOUCHSCREEN, HID_QUIRK_MULTI_INPUT},
  46         { USB_VENDOR_ID_SAITEK, USB_DEVICE_ID_SAITEK_RUMBLEPAD, HID_QUIRK_BADPAD },
  47         { USB_VENDOR_ID_TOPMAX, USB_DEVICE_ID_TOPMAX_COBRAPAD, HID_QUIRK_BADPAD },
  48
  49         { USB_VENDOR_ID_AFATECH, USB_DEVICE_ID_AFATECH_AF9016, HID_QUIRK_FULLSPEED_INTERVAL },
  50
  51         { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
  52         { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  53         { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
  54         { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
  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_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
  62         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
  63         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
  64         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
  65         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
  66         { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
  67         { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  68         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  69         { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
  70         { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
  71         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  72         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  73         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
  74         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
  75         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
  76         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  77         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  78
  79         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  80         { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  81
  82         { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
  83
  84         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
  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 (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; 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_NO_INIT_REPORTS;
 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);