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