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