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