usb_quirk.c revision 187725
1/* $FreeBSD: head/sys/dev/usb2/quirk/usb2_quirk.c 187725 2009-01-26 17:42:02Z thompsa $ */ 2/*- 3 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 4 * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29#include <dev/usb2/include/usb2_standard.h> 30#include <dev/usb2/include/usb2_ioctl.h> 31#include <dev/usb2/include/usb2_mfunc.h> 32#include <dev/usb2/include/usb2_devid.h> 33 34#define USB_DEBUG_VAR usb2_debug 35 36#include <dev/usb2/core/usb2_core.h> 37#include <dev/usb2/core/usb2_lookup.h> 38#include <dev/usb2/core/usb2_debug.h> 39#include <dev/usb2/core/usb2_dynamic.h> 40 41#include <dev/usb2/quirk/usb2_quirk.h> 42 43MODULE_DEPEND(usb2_quirk, usb2_core, 1, 1, 1); 44MODULE_VERSION(usb2_quirk, 1); 45 46/* 47 * The following macro adds one or more quirks for a USB device: 48 */ 49#define USB_QUIRK_ENTRY(v,p,l,h,...) \ 50 .vid = (v), .pid = (p), .lo_rev = (l), .hi_rev = (h), .quirks = { __VA_ARGS__ } 51 52#define USB_DEV_QUIRKS_MAX 128 53#define USB_SUB_QUIRKS_MAX 8 54 55struct usb2_quirk_entry { 56 uint16_t vid; 57 uint16_t pid; 58 uint16_t lo_rev; 59 uint16_t hi_rev; 60 uint16_t quirks[USB_SUB_QUIRKS_MAX]; 61}; 62 63static struct mtx usb2_quirk_mtx; 64 65static struct usb2_quirk_entry usb2_quirks[USB_DEV_QUIRKS_MAX] = { 66 {USB_QUIRK_ENTRY(USB_VENDOR_ASUS, USB_PRODUCT_ASUS_LCM, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 67 {USB_QUIRK_ENTRY(USB_VENDOR_INSIDEOUT, USB_PRODUCT_INSIDEOUT_EDGEPORT4, 0x094, 0x094, UQ_SWAP_UNICODE, UQ_NONE)}, 68 {USB_QUIRK_ENTRY(USB_VENDOR_DALLAS, USB_PRODUCT_DALLAS_J6502, 0x0a2, 0x0a2, UQ_BAD_ADC, UQ_NONE)}, 69 {USB_QUIRK_ENTRY(USB_VENDOR_DALLAS, USB_PRODUCT_DALLAS_J6502, 0x0a2, 0x0a2, UQ_AU_NO_XU, UQ_NONE)}, 70 {USB_QUIRK_ENTRY(USB_VENDOR_ALTEC, USB_PRODUCT_ALTEC_ADA70, 0x103, 0x103, UQ_BAD_ADC, UQ_NONE)}, 71 {USB_QUIRK_ENTRY(USB_VENDOR_ALTEC, USB_PRODUCT_ALTEC_ASC495, 0x000, 0x000, UQ_BAD_AUDIO, UQ_NONE)}, 72 {USB_QUIRK_ENTRY(USB_VENDOR_QTRONIX, USB_PRODUCT_QTRONIX_980N, 0x110, 0x110, UQ_SPUR_BUT_UP, UQ_NONE)}, 73 {USB_QUIRK_ENTRY(USB_VENDOR_ALCOR2, USB_PRODUCT_ALCOR2_KBD_HUB, 0x001, 0x001, UQ_SPUR_BUT_UP, UQ_NONE)}, 74 {USB_QUIRK_ENTRY(USB_VENDOR_MCT, USB_PRODUCT_MCT_HUB0100, 0x102, 0x102, UQ_BUS_POWERED, UQ_NONE)}, 75 {USB_QUIRK_ENTRY(USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232, 0x102, 0x102, UQ_BUS_POWERED, UQ_NONE)}, 76 {USB_QUIRK_ENTRY(USB_VENDOR_TI, USB_PRODUCT_TI_UTUSB41, 0x110, 0x110, UQ_POWER_CLAIM, UQ_NONE)}, 77 {USB_QUIRK_ENTRY(USB_VENDOR_TELEX, USB_PRODUCT_TELEX_MIC1, 0x009, 0x009, UQ_AU_NO_FRAC, UQ_NONE)}, 78 {USB_QUIRK_ENTRY(USB_VENDOR_SILICONPORTALS, USB_PRODUCT_SILICONPORTALS_YAPPHONE, 0x100, 0x100, UQ_AU_INP_ASYNC, UQ_NONE)}, 79 {USB_QUIRK_ENTRY(USB_VENDOR_LOGITECH, USB_PRODUCT_LOGITECH_UN53B, 0x0000, 0xFFFF, UQ_NO_STRINGS, UQ_NONE)}, 80 81 /* 82 * XXX The following quirks should have a more specific revision 83 * number: 84 */ 85 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_895C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 86 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_880C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 87 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_815C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 88 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_810C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 89 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_830C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 90 {USB_QUIRK_ENTRY(USB_VENDOR_HP, USB_PRODUCT_HP_1220C, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 91 {USB_QUIRK_ENTRY(USB_VENDOR_XEROX, USB_PRODUCT_XEROX_WCM15, 0x0000, 0xFFFF, UQ_BROKEN_BIDIR, UQ_NONE)}, 92 /* Devices which should be ignored by uhid */ 93 {USB_QUIRK_ENTRY(USB_VENDOR_APC, USB_PRODUCT_APC_UPS, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 94 {USB_QUIRK_ENTRY(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F6C550AVR, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 95 {USB_QUIRK_ENTRY(USB_VENDOR_CYBERPOWER, USB_PRODUCT_CYBERPOWER_1500CAVRLCD, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 96 {USB_QUIRK_ENTRY(USB_VENDOR_DELORME, USB_PRODUCT_DELORME_EARTHMATE, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 97 {USB_QUIRK_ENTRY(USB_VENDOR_ITUNERNET, USB_PRODUCT_ITUNERNET_USBLCD2X20, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 98 {USB_QUIRK_ENTRY(USB_VENDOR_ITUNERNET, USB_PRODUCT_ITUNERNET_USBLCD4X20, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 99 {USB_QUIRK_ENTRY(USB_VENDOR_MGE, USB_PRODUCT_MGE_UPS1, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 100 {USB_QUIRK_ENTRY(USB_VENDOR_MGE, USB_PRODUCT_MGE_UPS2, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 101 {USB_QUIRK_ENTRY(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 102 {USB_QUIRK_ENTRY(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_3G, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 103 /* Devices which should be ignored by both ukbd and uhid */ 104 {USB_QUIRK_ENTRY(USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_WISPY1A, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 105 {USB_QUIRK_ENTRY(USB_VENDOR_METAGEEK, USB_PRODUCT_METAGEEK_WISPY1B, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 106 {USB_QUIRK_ENTRY(USB_VENDOR_TENX, USB_PRODUCT_TENX_UAUDIO0, 0x0101, 0x0101, UQ_AUDIO_SWAP_LR, UQ_NONE)}, 107 /* MS keyboards do weird things */ 108 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK, 0x0000, 0xFFFF, UQ_MS_BAD_CLASS, UQ_MS_LEADING_BYTE, UQ_NONE)}, 109 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK2, 0x0000, 0xFFFF, UQ_MS_BAD_CLASS, UQ_MS_LEADING_BYTE, UQ_NONE)}, 110 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLINTELLIMOUSE, 0x0000, 0xFFFF, UQ_MS_LEADING_BYTE, UQ_NONE)}, 111 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_COMFORT3000, 0x0000, 0xFFFF, UQ_MS_BAD_CLASS, UQ_MS_LEADING_BYTE, UQ_NONE)}, 112 {USB_QUIRK_ENTRY(USB_VENDOR_METAGEEK, USB_PRODUCT_METAGEEK_WISPY24X, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 113}; 114 115USB_MAKE_DEBUG_TABLE(USB_QUIRK); 116 117/*------------------------------------------------------------------------* 118 * usb2_quirkstr 119 * 120 * This function converts an USB quirk code into a string. 121 *------------------------------------------------------------------------*/ 122static const char * 123usb2_quirkstr(uint16_t quirk) 124{ 125 return ((quirk < USB_QUIRK_MAX) ? 126 USB_QUIRK[quirk] : "USB_QUIRK_UNKNOWN"); 127} 128 129/*------------------------------------------------------------------------* 130 * usb2_test_quirk_by_info 131 * 132 * Returns: 133 * 0: Quirk not found 134 * Else: Quirk found 135 *------------------------------------------------------------------------*/ 136static uint8_t 137usb2_test_quirk_by_info(const struct usb2_lookup_info *info, uint16_t quirk) 138{ 139 uint16_t x; 140 uint16_t y; 141 142 if (quirk == UQ_NONE) { 143 return (0); 144 } 145 mtx_lock(&usb2_quirk_mtx); 146 147 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 148 /* see if quirk information does not match */ 149 if ((usb2_quirks[x].vid != info->idVendor) || 150 (usb2_quirks[x].pid != info->idProduct) || 151 (usb2_quirks[x].lo_rev > info->bcdDevice) || 152 (usb2_quirks[x].hi_rev < info->bcdDevice)) { 153 continue; 154 } 155 /* lookup quirk */ 156 for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) { 157 if (usb2_quirks[x].quirks[y] == quirk) { 158 mtx_unlock(&usb2_quirk_mtx); 159 DPRINTF("Found quirk '%s'.\n", usb2_quirkstr(quirk)); 160 return (1); 161 } 162 } 163 /* no quirk found */ 164 break; 165 } 166 mtx_unlock(&usb2_quirk_mtx); 167 return (0); 168} 169 170static struct usb2_quirk_entry * 171usb2_quirk_get_entry(uint16_t vid, uint16_t pid, 172 uint16_t lo_rev, uint16_t hi_rev, uint8_t do_alloc) 173{ 174 uint16_t x; 175 176 mtx_assert(&usb2_quirk_mtx, MA_OWNED); 177 178 if ((vid | pid | lo_rev | hi_rev) == 0) { 179 /* all zero - special case */ 180 return (usb2_quirks + USB_DEV_QUIRKS_MAX - 1); 181 } 182 /* search for an existing entry */ 183 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 184 /* see if quirk information does not match */ 185 if ((usb2_quirks[x].vid != vid) || 186 (usb2_quirks[x].pid != pid) || 187 (usb2_quirks[x].lo_rev != lo_rev) || 188 (usb2_quirks[x].hi_rev != hi_rev)) { 189 continue; 190 } 191 return (usb2_quirks + x); 192 } 193 194 if (do_alloc == 0) { 195 /* no match */ 196 return (NULL); 197 } 198 /* search for a free entry */ 199 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 200 /* see if quirk information does not match */ 201 if ((usb2_quirks[x].vid | 202 usb2_quirks[x].pid | 203 usb2_quirks[x].lo_rev | 204 usb2_quirks[x].hi_rev) != 0) { 205 continue; 206 } 207 usb2_quirks[x].vid = vid; 208 usb2_quirks[x].pid = pid; 209 usb2_quirks[x].lo_rev = lo_rev; 210 usb2_quirks[x].hi_rev = hi_rev; 211 212 return (usb2_quirks + x); 213 } 214 215 /* no entry found */ 216 return (NULL); 217} 218 219/*------------------------------------------------------------------------* 220 * usb2_quirk_ioctl - handle quirk IOCTLs 221 * 222 * Returns: 223 * 0: Success 224 * Else: Failure 225 *------------------------------------------------------------------------*/ 226static int 227usb2_quirk_ioctl(unsigned long cmd, caddr_t data, 228 int fflag, struct thread *td) 229{ 230 struct usb2_gen_quirk *pgq; 231 struct usb2_quirk_entry *pqe; 232 uint32_t x; 233 uint32_t y; 234 int err; 235 236 switch (cmd) { 237 case USB_DEV_QUIRK_GET: 238 pgq = (void *)data; 239 x = pgq->index % USB_SUB_QUIRKS_MAX; 240 y = pgq->index / USB_SUB_QUIRKS_MAX; 241 if (y >= USB_DEV_QUIRKS_MAX) { 242 return (EINVAL); 243 } 244 mtx_lock(&usb2_quirk_mtx); 245 /* copy out data */ 246 pgq->vid = usb2_quirks[y].vid; 247 pgq->pid = usb2_quirks[y].pid; 248 pgq->bcdDeviceLow = usb2_quirks[y].lo_rev; 249 pgq->bcdDeviceHigh = usb2_quirks[y].hi_rev; 250 strlcpy(pgq->quirkname, 251 usb2_quirkstr(usb2_quirks[y].quirks[x]), 252 sizeof(pgq->quirkname)); 253 mtx_unlock(&usb2_quirk_mtx); 254 return (0); /* success */ 255 256 case USB_QUIRK_NAME_GET: 257 pgq = (void *)data; 258 x = pgq->index; 259 if (x >= USB_QUIRK_MAX) { 260 return (EINVAL); 261 } 262 strlcpy(pgq->quirkname, 263 usb2_quirkstr(x), sizeof(pgq->quirkname)); 264 return (0); /* success */ 265 266 case USB_DEV_QUIRK_ADD: 267 pgq = (void *)data; 268 269 /* check privileges */ 270 err = priv_check(curthread, PRIV_DRIVER); 271 if (err) { 272 return (err); 273 } 274 /* convert quirk string into numerical */ 275 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) { 276 if (strcmp(pgq->quirkname, usb2_quirkstr(y)) == 0) { 277 break; 278 } 279 } 280 if (y == USB_DEV_QUIRKS_MAX) { 281 return (EINVAL); 282 } 283 if (y == UQ_NONE) { 284 return (EINVAL); 285 } 286 mtx_lock(&usb2_quirk_mtx); 287 pqe = usb2_quirk_get_entry(pgq->vid, pgq->pid, 288 pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 1); 289 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 290 if (pqe->quirks[x] == UQ_NONE) { 291 pqe->quirks[x] = y; 292 break; 293 } 294 } 295 mtx_unlock(&usb2_quirk_mtx); 296 if (x == USB_SUB_QUIRKS_MAX) { 297 return (ENOMEM); 298 } 299 return (0); /* success */ 300 301 case USB_DEV_QUIRK_REMOVE: 302 pgq = (void *)data; 303 /* check privileges */ 304 err = priv_check(curthread, PRIV_DRIVER); 305 if (err) { 306 return (err); 307 } 308 /* convert quirk string into numerical */ 309 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) { 310 if (strcmp(pgq->quirkname, usb2_quirkstr(y)) == 0) { 311 break; 312 } 313 } 314 if (y == USB_DEV_QUIRKS_MAX) { 315 return (EINVAL); 316 } 317 if (y == UQ_NONE) { 318 return (EINVAL); 319 } 320 mtx_lock(&usb2_quirk_mtx); 321 pqe = usb2_quirk_get_entry(pgq->vid, pgq->pid, 322 pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 0); 323 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 324 if (pqe->quirks[x] == y) { 325 pqe->quirks[x] = UQ_NONE; 326 break; 327 } 328 } 329 if (x == USB_SUB_QUIRKS_MAX) { 330 mtx_unlock(&usb2_quirk_mtx); 331 return (ENOMEM); 332 } 333 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 334 if (pqe->quirks[x] != UQ_NONE) { 335 break; 336 } 337 } 338 if (x == USB_SUB_QUIRKS_MAX) { 339 /* all quirk entries are unused - release */ 340 memset(pqe, 0, sizeof(pqe)); 341 } 342 mtx_unlock(&usb2_quirk_mtx); 343 return (0); /* success */ 344 345 default: 346 break; 347 } 348 return (ENOIOCTL); 349} 350 351static void 352usb2_quirk_init(void *arg) 353{ 354 /* initialize mutex */ 355 mtx_init(&usb2_quirk_mtx, "USB quirk", NULL, MTX_DEF); 356 357 /* register our function */ 358 usb2_test_quirk_p = &usb2_test_quirk_by_info; 359 usb2_quirk_ioctl_p = &usb2_quirk_ioctl; 360} 361 362static void 363usb2_quirk_uninit(void *arg) 364{ 365 usb2_quirk_unload(arg); 366 367 /* destroy mutex */ 368 mtx_destroy(&usb2_quirk_mtx); 369} 370 371SYSINIT(usb2_quirk_init, SI_SUB_LOCK, SI_ORDER_FIRST, usb2_quirk_init, NULL); 372SYSUNINIT(usb2_quirk_uninit, SI_SUB_LOCK, SI_ORDER_ANY, usb2_quirk_uninit, NULL); 373