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