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