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