LXR linux/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/export.h>
  20#include <linux/slab.h>
  21
  22#include "../hid-ids.h"
  23
  24/*
  25 * Alphabetically sorted blacklist by quirk type.
  26 */
  27
  28static const struct hid_blacklist {
  29        __u16 idVendor;
  30        __u16 idProduct;
  31        __u32 quirks;
  32} hid_blacklist[] = {
  33        { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_GAMEPAD, HID_QUIRK_BADPAD },
  34        { USB_VENDOR_ID_AASHIMA, USB_DEVICE_ID_AASHIMA_PREDATOR, HID_QUIRK_BADPAD },
  35        { USB_VENDOR_ID_ALPS, USB_DEVICE_ID_IBM_GAMEPAD, HID_QUIRK_BADPAD },
  36        { USB_VENDOR_ID_CHIC, USB_DEVICE_ID_CHIC_GAMEPAD, HID_QUIRK_BADPAD },
  37        { USB_VENDOR_ID_DWAV, USB_DEVICE_ID_EGALAX_TOUCHCONTROLLER, HID_QUIRK_MULTI_INPUT | HID_QUIRK_NOGET },
  38        { USB_VENDOR_ID_MOJO, USB_DEVICE_ID_RETRO_ADAPTER, 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_EMS, USB_DEVICE_ID_EMS_TRIO_LINKER_PLUS_II, HID_QUIRK_MULTI_INPUT },
  51        { USB_VENDOR_ID_ETURBOTOUCH, USB_DEVICE_ID_ETURBOTOUCH, HID_QUIRK_MULTI_INPUT },
  52        { USB_VENDOR_ID_GREENASIA, USB_DEVICE_ID_GREENASIA_DUAL_USB_JOYPAD, HID_QUIRK_MULTI_INPUT },
  53        { USB_VENDOR_ID_PANTHERLORD, USB_DEVICE_ID_PANTHERLORD_TWIN_USB_JOYSTICK, HID_QUIRK_MULTI_INPUT | HID_QUIRK_SKIP_OUTPUT_REPORTS },
  54        { USB_VENDOR_ID_PLAYDOTCOM, USB_DEVICE_ID_PLAYDOTCOM_EMS_USBII, HID_QUIRK_MULTI_INPUT },
  55        { USB_VENDOR_ID_TOUCHPACK, USB_DEVICE_ID_TOUCHPACK_RTS, HID_QUIRK_MULTI_INPUT },
  56
  57        { USB_VENDOR_ID_AIREN, USB_DEVICE_ID_AIREN_SLIMPLUS, HID_QUIRK_NOGET },
  58        { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_UC100KM, HID_QUIRK_NOGET },
  59        { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_CS124U, HID_QUIRK_NOGET },
  60        { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_2PORTKVM, HID_QUIRK_NOGET },
  61        { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVM, HID_QUIRK_NOGET },
  62        { USB_VENDOR_ID_ATEN, USB_DEVICE_ID_ATEN_4PORTKVMC, HID_QUIRK_NOGET },
  63        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FIGHTERSTICK, HID_QUIRK_NOGET },
  64        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_COMBATSTICK, HID_QUIRK_NOGET },
  65        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_ECLIPSE_YOKE, HID_QUIRK_NOGET },
  66        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_FLIGHT_SIM_YOKE, HID_QUIRK_NOGET },
  67        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_THROTTLE, HID_QUIRK_NOGET },
  68        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_PRO_PEDALS, HID_QUIRK_NOGET },
  69        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_3AXIS_5BUTTON_STICK, HID_QUIRK_NOGET },
  70        { USB_VENDOR_ID_CH, USB_DEVICE_ID_CH_AXIS_295, HID_QUIRK_NOGET },
  71        { USB_VENDOR_ID_DMI, USB_DEVICE_ID_DMI_ENC, HID_QUIRK_NOGET },
  72        { USB_VENDOR_ID_ELO, USB_DEVICE_ID_ELO_TS2700, HID_QUIRK_NOGET },
  73        { USB_VENDOR_ID_FORMOSA, USB_DEVICE_ID_FORMOSA_IR_RECEIVER, HID_QUIRK_NO_INIT_REPORTS },
  74        { USB_VENDOR_ID_FREESCALE, USB_DEVICE_ID_FREESCALE_MX28, HID_QUIRK_NOGET },
  75        { USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS, HID_QUIRK_NOGET },
  76        { USB_VENDOR_ID_MSI, USB_DEVICE_ID_MSI_GX680R_LED_PANEL, HID_QUIRK_NO_INIT_REPORTS },
  77        { USB_VENDOR_ID_NOVATEK, USB_DEVICE_ID_NOVATEK_MOUSE, HID_QUIRK_NO_INIT_REPORTS },
  78        { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN, HID_QUIRK_NO_INIT_REPORTS },
  79        { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN1, HID_QUIRK_NO_INIT_REPORTS },
  80        { USB_VENDOR_ID_PIXART, USB_DEVICE_ID_PIXART_OPTICAL_TOUCH_SCREEN2, HID_QUIRK_NO_INIT_REPORTS },
  81        { USB_VENDOR_ID_PRODIGE, USB_DEVICE_ID_PRODIGE_CORDLESS, HID_QUIRK_NOGET },
  82        { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3001, HID_QUIRK_NOGET },
  83        { USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH_3008, HID_QUIRK_NOGET },
  84        { USB_VENDOR_ID_REALTEK, USB_DEVICE_ID_REALTEK_READER, HID_QUIRK_NO_INIT_REPORTS },
  85        { USB_VENDOR_ID_SENNHEISER, USB_DEVICE_ID_SENNHEISER_BTD500USB, HID_QUIRK_NOGET },
  86        { USB_VENDOR_ID_SIGMATEL, USB_DEVICE_ID_SIGMATEL_STMP3780, HID_QUIRK_NOGET },
  87        { USB_VENDOR_ID_SUN, USB_DEVICE_ID_RARITAN_KVM_DONGLE, HID_QUIRK_NOGET },
  88        { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_1, HID_QUIRK_NOGET },
  89        { USB_VENDOR_ID_SYMBOL, USB_DEVICE_ID_SYMBOL_SCANNER_2, HID_QUIRK_NOGET },
  90        { USB_VENDOR_ID_TPV, USB_DEVICE_ID_TPV_OPTICAL_TOUCHSCREEN, HID_QUIRK_NOGET },
  91        { USB_VENDOR_ID_TURBOX, USB_DEVICE_ID_TURBOX_KEYBOARD, HID_QUIRK_NOGET },
  92        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_PF1209, HID_QUIRK_MULTI_INPUT },
  93        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U, HID_QUIRK_MULTI_INPUT },
  94        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_KNA5, HID_QUIRK_MULTI_INPUT },
  95        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_TWA60, HID_QUIRK_MULTI_INPUT },
  96        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U, HID_QUIRK_MULTI_INPUT },
  97        { USB_VENDOR_ID_UCLOGIC, USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U, HID_QUIRK_MULTI_INPUT },
  98        { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_10_6_INCH, HID_QUIRK_MULTI_INPUT },
  99        { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_MEDIA_TABLET_14_1_INCH, HID_QUIRK_MULTI_INPUT },
 100        { USB_VENDOR_ID_WALTOP, USB_DEVICE_ID_WALTOP_SIRIUS_BATTERY_FREE_TABLET, HID_QUIRK_MULTI_INPUT },
 101        { USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_QUAD_USB_JOYPAD, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
 102
 103        { USB_VENDOR_ID_WISEGROUP_LTD2, USB_DEVICE_ID_SMARTJOY_DUAL_PLUS, HID_QUIRK_NOGET | HID_QUIRK_MULTI_INPUT },
 104
 105        { USB_VENDOR_ID_PI_ENGINEERING, USB_DEVICE_ID_PI_ENGINEERING_VEC_USB_FOOTPEDAL, HID_QUIRK_HIDINPUT_FORCE },
 106
 107        { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_MULTI_TOUCH, HID_QUIRK_MULTI_INPUT },
 108        { USB_VENDOR_ID_CHICONY, USB_DEVICE_ID_CHICONY_WIRELESS, HID_QUIRK_MULTI_INPUT },
 109        { USB_VENDOR_ID_SIGMA_MICRO, USB_DEVICE_ID_SIGMA_MICRO_KEYBOARD, HID_QUIRK_NO_INIT_REPORTS },
 110        { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_MOUSEPEN_I608X, HID_QUIRK_MULTI_INPUT },
 111        { USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_EASYPEN_M610X, HID_QUIRK_MULTI_INPUT },
 112        { USB_VENDOR_ID_NTRIG, USB_DEVICE_ID_NTRIG_DUOSENSE, HID_QUIRK_NO_INIT_REPORTS },
 113        { USB_VENDOR_ID_SYNAPTICS, USB_DEVICE_ID_SYNAPTICS_LTS1, HID_QUIRK_NO_INIT_REPORTS },
 114        { USB_VENDOR_ID_SYNAPTICS, USB_DEVICE_ID_SYNAPTICS_LTS2, HID_QUIRK_NO_INIT_REPORTS },
 115        { USB_VENDOR_ID_SIS, USB_DEVICE_ID_SIS_TS, HID_QUIRK_NO_INIT_REPORTS },
 116
 117        { 0, 0 }
 118};
 119
 120/* Dynamic HID quirks list - specified at runtime */
 121struct quirks_list_struct {
 122        struct hid_blacklist hid_bl_item;
 123        struct list_head node;
 124};
 125
 126static LIST_HEAD(dquirks_list);
 127static DECLARE_RWSEM(dquirks_rwsem);
 128
 129/* Runtime ("dynamic") quirks manipulation functions */
 130
 131/**
 132 * usbhid_exists_dquirk: find any dynamic quirks for a USB HID device
 133 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 134 * @idProduct: the 16-bit USB product ID, in native byteorder
 135 *
 136 * Description:
 137 *         Scans dquirks_list for a matching dynamic quirk and returns
 138 *         the pointer to the relevant struct hid_blacklist if found.
 139 *         Must be called with a read lock held on dquirks_rwsem.
 140 *
 141 * Returns: NULL if no quirk found, struct hid_blacklist * if found.
 142 */
 143static struct hid_blacklist *usbhid_exists_dquirk(const u16 idVendor,
 144                const u16 idProduct)
 145{
 146        struct quirks_list_struct *q;
 147        struct hid_blacklist *bl_entry = NULL;
 148
 149        list_for_each_entry(q, &dquirks_list, node) {
 150                if (q->hid_bl_item.idVendor == idVendor &&
 151                                q->hid_bl_item.idProduct == idProduct) {
 152                        bl_entry = &q->hid_bl_item;
 153                        break;
 154                }
 155        }
 156
 157        if (bl_entry != NULL)
 158                dbg_hid("Found dynamic quirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 159                                bl_entry->quirks, bl_entry->idVendor,
 160                                bl_entry->idProduct);
 161
 162        return bl_entry;
 163}
 164
 165
 166/**
 167 * usbhid_modify_dquirk: add/replace a HID quirk
 168 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 169 * @idProduct: the 16-bit USB product ID, in native byteorder
 170 * @quirks: the u32 quirks value to add/replace
 171 *
 172 * Description:
 173 *         If an dynamic quirk exists in memory for this (idVendor,
 174 *         idProduct) pair, replace its quirks value with what was
 175 *         provided.  Otherwise, add the quirk to the dynamic quirks list.
 176 *
 177 * Returns: 0 OK, -error on failure.
 178 */
 179static int usbhid_modify_dquirk(const u16 idVendor, const u16 idProduct,
 180                                const u32 quirks)
 181{
 182        struct quirks_list_struct *q_new, *q;
 183        int list_edited = 0;
 184
 185        if (!idVendor) {
 186                dbg_hid("Cannot add a quirk with idVendor = 0\n");
 187                return -EINVAL;
 188        }
 189
 190        q_new = kmalloc(sizeof(struct quirks_list_struct), GFP_KERNEL);
 191        if (!q_new) {
 192                dbg_hid("Could not allocate quirks_list_struct\n");
 193                return -ENOMEM;
 194        }
 195
 196        q_new->hid_bl_item.idVendor = idVendor;
 197        q_new->hid_bl_item.idProduct = idProduct;
 198        q_new->hid_bl_item.quirks = quirks;
 199
 200        down_write(&dquirks_rwsem);
 201
 202        list_for_each_entry(q, &dquirks_list, node) {
 203
 204                if (q->hid_bl_item.idVendor == idVendor &&
 205                                q->hid_bl_item.idProduct == idProduct) {
 206
 207                        list_replace(&q->node, &q_new->node);
 208                        kfree(q);
 209                        list_edited = 1;
 210                        break;
 211
 212                }
 213
 214        }
 215
 216        if (!list_edited)
 217                list_add_tail(&q_new->node, &dquirks_list);
 218
 219        up_write(&dquirks_rwsem);
 220
 221        return 0;
 222}
 223
 224/**
 225 * usbhid_remove_all_dquirks: remove all runtime HID quirks from memory
 226 *
 227 * Description:
 228 *         Free all memory associated with dynamic quirks - called before
 229 *         module unload.
 230 *
 231 */
 232static void usbhid_remove_all_dquirks(void)
 233{
 234        struct quirks_list_struct *q, *temp;
 235
 236        down_write(&dquirks_rwsem);
 237        list_for_each_entry_safe(q, temp, &dquirks_list, node) {
 238                list_del(&q->node);
 239                kfree(q);
 240        }
 241        up_write(&dquirks_rwsem);
 242
 243}
 244
 245/** 
 246 * usbhid_quirks_init: apply USB HID quirks specified at module load time
 247 */
 248int usbhid_quirks_init(char **quirks_param)
 249{
 250        u16 idVendor, idProduct;
 251        u32 quirks;
 252        int n = 0, m;
 253
 254        for (; n < MAX_USBHID_BOOT_QUIRKS && quirks_param[n]; n++) {
 255
 256                m = sscanf(quirks_param[n], "0x%hx:0x%hx:0x%x",
 257                                &idVendor, &idProduct, &quirks);
 258
 259                if (m != 3 ||
 260                                usbhid_modify_dquirk(idVendor, idProduct, quirks) != 0) {
 261                        printk(KERN_WARNING
 262                                        "Could not parse HID quirk module param %s\n",
 263                                        quirks_param[n]);
 264                }
 265        }
 266
 267        return 0;
 268}
 269
 270/**
 271 * usbhid_quirks_exit: release memory associated with dynamic_quirks
 272 *
 273 * Description:
 274 *     Release all memory associated with dynamic quirks.  Called upon
 275 *     module unload.
 276 *
 277 * Returns: nothing
 278 */
 279void usbhid_quirks_exit(void)
 280{
 281        usbhid_remove_all_dquirks();
 282}
 283
 284/**
 285 * usbhid_exists_squirk: return any static quirks for a USB HID device
 286 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 287 * @idProduct: the 16-bit USB product ID, in native byteorder
 288 *
 289 * Description:
 290 *     Given a USB vendor ID and product ID, return a pointer to
 291 *     the hid_blacklist entry associated with that device.
 292 *
 293 * Returns: pointer if quirk found, or NULL if no quirks found.
 294 */
 295static const struct hid_blacklist *usbhid_exists_squirk(const u16 idVendor,
 296                const u16 idProduct)
 297{
 298        const struct hid_blacklist *bl_entry = NULL;
 299        int n = 0;
 300
 301        for (; hid_blacklist[n].idVendor; n++)
 302                if (hid_blacklist[n].idVendor == idVendor &&
 303                                hid_blacklist[n].idProduct == idProduct)
 304                        bl_entry = &hid_blacklist[n];
 305
 306        if (bl_entry != NULL)
 307                dbg_hid("Found squirk 0x%x for USB HID vendor 0x%hx prod 0x%hx\n",
 308                                bl_entry->quirks, bl_entry->idVendor, 
 309                                bl_entry->idProduct);
 310        return bl_entry;
 311}
 312
 313/**
 314 * usbhid_lookup_quirk: return any quirks associated with a USB HID device
 315 * @idVendor: the 16-bit USB vendor ID, in native byteorder
 316 * @idProduct: the 16-bit USB product ID, in native byteorder
 317 *
 318 * Description:
 319 *     Given a USB vendor ID and product ID, return any quirks associated
 320 *     with that device.
 321 *
 322 * Returns: a u32 quirks value.
 323 */
 324u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct)
 325{
 326        u32 quirks = 0;
 327        const struct hid_blacklist *bl_entry = NULL;
 328
 329        /* NCR devices must not be queried for reports */
 330        if (idVendor == USB_VENDOR_ID_NCR &&
 331                        idProduct >= USB_DEVICE_ID_NCR_FIRST &&
 332                        idProduct <= USB_DEVICE_ID_NCR_LAST)
 333                        return HID_QUIRK_NO_INIT_REPORTS;
 334
 335        down_read(&dquirks_rwsem);
 336        bl_entry = usbhid_exists_dquirk(idVendor, idProduct);
 337        if (!bl_entry)
 338                bl_entry = usbhid_exists_squirk(idVendor, idProduct);
 339        if (bl_entry)
 340                quirks = bl_entry->quirks;
 341        up_read(&dquirks_rwsem);
 342
 343        return quirks;
 344}
 345
 346EXPORT_SYMBOL_GPL(usbhid_lookup_quirk);
 347