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_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  67         { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  68         { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
  69         { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NOGET },
  70         { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  71         { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  72         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
  73         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
  74         { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
  75         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_DUAL_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  76         { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  77
  78         { USB_VENDOR_ID_WISEGROUP_LTD, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  79         { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
  80
  81         { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
  82
  83         { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
  84
  85         { 0, 0 }
  86 };
  87
  88 /* Dynamic HID quirks list - specified at runtime */
  89 struct quirks_list_struct {
  90         struct hid_blacklist hid_bl_item;
  91         struct list_head node;
  92 };
  93
  94 static LIST_HEAD(dquirks_list);
  95 static DECLARE_RWSEM(dquirks_rwsem);
  96
  97 /* Runtime ("dynamic") quirks manipulation functions */
  98
  99 /**
 100  * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 101  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 102  * @idProduct: the 16-bit USB product ID, in native byteorder
 103  *
 104  * Description:
 105  *         Scans dquirks_list for a matching dynamic quirk and returns
 106  *         the pointer to the relevant struct hid_blacklist if found.
 107  *         Must be called with a read lock held on dquirks_rwsem.
 108  *
 109  * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 110  */
 111 static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
 112                 const u16 idProduct)
 113 {
 114         struct quirks_list_struct *q;
 115         struct hid_blacklist *bl_entry = NULL;
 116
 117         list_for_each_entry(q, &dquirks_list, node) {
 118                 if (q->hid_bl_item.idVendor == idVendor &&
 119                                 q->hid_bl_item.idProduct == idProduct) {
 120                         bl_entry = &q->hid_bl_item;
 121                         break;
 122                 }
 123         }
 124
 125         if (bl_entry != NULL)
 126                 dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 127                                 bl_entry->quirks, bl_entry->idVendor,
 128                                 bl_entry->idProduct);
 129
 130         return bl_entry;
 131 }
 132
 133
 134 /**
 135  * usbhid_modify_dquirk: add/replace a HID quirk
 136  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 137  * @idProduct: the 16-bit USB product ID, in native byteorder
 138  * @quirks: the u32 quirks value to add/replace
 139  *
 140  * Description:
 141  *         If an dynamic quirk exists in memory for this (idVendor,
 142  *         idProduct) pair, replace its quirks value with what was
 143  *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 144  *
 145  * Returns: 0 OK, -error on failure.
 146  */
 147 static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
 148                                 const u32 quirks)
 149 {
 150         struct quirks_list_struct *q_new, *q;
 151         int list_edited = 0;
 152
 153         if (!idVendor) {
 154                 dbg_hid("Cannot add a quirk with idVendor = 0\n");
 155                 return -EINVAL;
 156         }
 157
 158         q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
 159         if (!q_new) {
 160                 dbg_hid("Could not allocate quirks_list_struct\n");
 161                 return -ENOMEM;
 162         }
 163
 164         q_new->hid_bl_item.idVendor = idVendor;
 165         q_new->hid_bl_item.idProduct = idProduct;
 166         q_new->hid_bl_item.quirks = quirks;
 167
 168         down_write(&dquirks_rwsem);
 169
 170         list_for_each_entry(q, &dquirks_list, node) {
 171
 172                 if (q->hid_bl_item.idVendor == idVendor &&
 173                                 q->hid_bl_item.idProduct == idProduct) {
 174
 175                         list_replace(&q->node, &q_new->node);
 176                         kfree(q);
 177                         list_edited = 1;
 178                         break;
 179
 180                 }
 181
 182         }
 183
 184         if (!list_edited)
 185                 list_add_tail(&q_new->node, &dquirks_list);
 186
 187         up_write(&dquirks_rwsem);
 188
 189         return 0;
 190 }
 191
 192 /**
 193  * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 194  *
 195  * Description:
 196  *         Free all memory associated with dynamic quirks - called before
 197  *         module unload.
 198  *
 199  */
 200 static void usbhid_remove_all_dquirks(void)
 201 {
 202         struct quirks_list_struct *q, *temp;
 203
 204         down_write(&dquirks_rwsem);
 205         list_for_each_entry_safe(q, temp, &dquirks_list, node) {
 206                 list_del(&q->node);
 207                 kfree(q);
 208         }
 209         up_write(&dquirks_rwsem);
 210
 211 }
 212
 213 /**
 214  * usbhid_quirks_init: apply USB HID quirks specified at module load time
 215  */
 216 int usbhid_quirks_init(char **quirks_param)
 217 {
 218         u16 idVendor, idProduct;
 219         u32 quirks;
 220         int n = 0, m;
 221
 222         for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
 223
 224                 m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 225                                 &idVendor, &idProduct, &quirks);
 226
 227                 if (m != 3 ||
 228                                 usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
 229                         printk(KERN_WARNING
 230                                         "Could not parse HID quirk module param %s\n",
 231                                         quirks_param[n]);
 232                 }
 233         }
 234
 235         return 0;
 236 }
 237
 238 /**
 239  * usbhid_quirks_exit: release memory associated with dynamic_quirks
 240  *
 241  * Description:
 242  *     Release all memory associated with dynamic quirks.  Called upon
 243  *     module unload.
 244  *
 245  * Returns: nothing
 246  */
 247 void usbhid_quirks_exit(void)
 248 {
 249         usbhid_remove_all_dquirks();
 250 }
 251
 252 /**
 253  * usbhid_exists_squirk: return any static quirks for a USB HID device
 254  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 255  * @idProduct: the 16-bit USB product ID, in native byteorder
 256  *
 257  * Description:
 258  *     Given a USB vendor ID and product ID, return a pointer to
 259  *     the hid_blacklist entry associated with that device.
 260  *
 261  * Returns: pointer if quirk found, or NULL if no quirks found.
 262  */
 263 static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
 264                 const u16 idProduct)
 265 {
 266         const struct hid_blacklist *bl_entry = NULL;
 267         int n = 0;
 268
 269         for (; hid_blacklist[n].idVendor; n++)
 270                 if (hid_blacklist[n].idVendor == idVendor &&
 271                                 hid_blacklist[n].idProduct == idProduct)
 272                         bl_entry = &hid_blacklist[n];
 273
 274         if (bl_entry != NULL)
 275                 dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 276                                 bl_entry->quirks, bl_entry->idVendor,
 277                                 bl_entry->idProduct);
 278         return bl_entry;
 279 }
 280
 281 /**
 282  * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 283  * @idVendor: the 16-bit USB vendor ID, in native byteorder
 284  * @idProduct: the 16-bit USB product ID, in native byteorder
 285  *
 286  * Description:
 287  *     Given a USB vendor ID and product ID, return any quirks associated
 288  *     with that device.
 289  *
 290  * Returns: a u32 quirks value.
 291  */
 292 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
 293 {
 294         u32 quirks = 0;
 295         const struct hid_blacklist *bl_entry = NULL;
 296
 297         /* NCR devices must not be queried for reports */
 298         if (idVendor == USB_VENDOR_ID_NCR &&
 299                         idProduct >= USB_DEVICE_ID_NCR_FIRST &&
 300                         idProduct <= USB_DEVICE_ID_NCR_LAST)
 301                         return HID_QUIRK_NO_INIT_REPORTS;
 302
 303         down_read(&dquirks_rwsem);
 304         bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
 305         if (!bl_entry)
 306                 bl_entry = usbhid_exists_squirk(idVendor, idProduct);
 307         if (bl_entry)
 308                 quirks = bl_entry->quirks;
 309         up_read(&dquirks_rwsem);
 310
 311         return quirks;
 312 }
 313
 314 EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);