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