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