usb_quirk.c revision 184610
1/* $FreeBSD: head/sys/dev/usb2/quirk/usb2_quirk.c 184610 2008-11-04 02:31:03Z alfred $ */ 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_MGE, USB_PRODUCT_MGE_UPS1, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 99 {USB_QUIRK_ENTRY(USB_VENDOR_MGE, USB_PRODUCT_MGE_UPS2, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 100 {USB_QUIRK_ENTRY(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 101 {USB_QUIRK_ENTRY(USB_VENDOR_APPLE, USB_PRODUCT_APPLE_IPHONE_3G, 0x0000, 0xFFFF, UQ_HID_IGNORE, UQ_NONE)}, 102 /* Devices which should be ignored by both ukbd and uhid */ 103 {USB_QUIRK_ENTRY(USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_WISPY1A, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 104 {USB_QUIRK_ENTRY(USB_VENDOR_METAGEEK, USB_PRODUCT_METAGEEK_WISPY1B, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 105 {USB_QUIRK_ENTRY(USB_VENDOR_TENX, USB_PRODUCT_TENX_UAUDIO0, 0x0101, 0x0101, UQ_AUDIO_SWAP_LR, UQ_NONE)}, 106 /* MS keyboards do weird things */ 107 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK, 0x0000, 0xFFFF, UQ_MS_BAD_CLASS, UQ_MS_LEADING_BYTE, UQ_NONE)}, 108 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLNOTEBOOK2, 0x0000, 0xFFFF, UQ_MS_BAD_CLASS, UQ_MS_LEADING_BYTE, UQ_NONE)}, 109 {USB_QUIRK_ENTRY(USB_VENDOR_MICROSOFT, USB_PRODUCT_MICROSOFT_WLINTELLIMOUSE, 0x0000, 0xFFFF, UQ_MS_LEADING_BYTE, UQ_NONE)}, 110 {USB_QUIRK_ENTRY(USB_VENDOR_METAGEEK, USB_PRODUCT_METAGEEK_WISPY24X, 0x0000, 0xFFFF, UQ_KBD_IGNORE, UQ_HID_IGNORE, UQ_NONE)}, 111}; 112 113USB_MAKE_DEBUG_TABLE(USB_QUIRK); 114 115/*------------------------------------------------------------------------* 116 * usb2_quirkstr 117 * 118 * This function converts an USB quirk code into a string. 119 *------------------------------------------------------------------------*/ 120static const char * 121usb2_quirkstr(uint16_t quirk) 122{ 123 return ((quirk < USB_QUIRK_MAX) ? 124 USB_QUIRK[quirk] : "USB_QUIRK_UNKNOWN"); 125} 126 127/*------------------------------------------------------------------------* 128 * usb2_test_quirk_by_info 129 * 130 * Returns: 131 * 0: Quirk not found 132 * Else: Quirk found 133 *------------------------------------------------------------------------*/ 134static uint8_t 135usb2_test_quirk_by_info(const struct usb2_lookup_info *info, uint16_t quirk) 136{ 137 uint16_t x; 138 uint16_t y; 139 140 if (quirk == UQ_NONE) { 141 return (0); 142 } 143 mtx_lock(&usb2_quirk_mtx); 144 145 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 146 /* see if quirk information does not match */ 147 if ((usb2_quirks[x].vid != info->idVendor) || 148 (usb2_quirks[x].pid != info->idProduct) || 149 (usb2_quirks[x].lo_rev > info->bcdDevice) || 150 (usb2_quirks[x].hi_rev < info->bcdDevice)) { 151 continue; 152 } 153 /* lookup quirk */ 154 for (y = 0; y != USB_SUB_QUIRKS_MAX; y++) { 155 if (usb2_quirks[x].quirks[y] == quirk) { 156 mtx_unlock(&usb2_quirk_mtx); 157 DPRINTF("Found quirk '%s'.\n", usb2_quirkstr(quirk)); 158 return (1); 159 } 160 } 161 /* no quirk found */ 162 break; 163 } 164 mtx_unlock(&usb2_quirk_mtx); 165 return (0); 166} 167 168static struct usb2_quirk_entry * 169usb2_quirk_get_entry(uint16_t vid, uint16_t pid, 170 uint16_t lo_rev, uint16_t hi_rev, uint8_t do_alloc) 171{ 172 uint16_t x; 173 174 mtx_assert(&usb2_quirk_mtx, MA_OWNED); 175 176 if ((vid | pid | lo_rev | hi_rev) == 0) { 177 /* all zero - special case */ 178 return (usb2_quirks + USB_DEV_QUIRKS_MAX - 1); 179 } 180 /* search for an existing entry */ 181 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 182 /* see if quirk information does not match */ 183 if ((usb2_quirks[x].vid != vid) || 184 (usb2_quirks[x].pid != pid) || 185 (usb2_quirks[x].lo_rev != lo_rev) || 186 (usb2_quirks[x].hi_rev != hi_rev)) { 187 continue; 188 } 189 return (usb2_quirks + x); 190 } 191 192 if (do_alloc == 0) { 193 /* no match */ 194 return (NULL); 195 } 196 /* search for a free entry */ 197 for (x = 0; x != USB_DEV_QUIRKS_MAX; x++) { 198 /* see if quirk information does not match */ 199 if ((usb2_quirks[x].vid | 200 usb2_quirks[x].pid | 201 usb2_quirks[x].lo_rev | 202 usb2_quirks[x].hi_rev) != 0) { 203 continue; 204 } 205 usb2_quirks[x].vid = vid; 206 usb2_quirks[x].pid = pid; 207 usb2_quirks[x].lo_rev = lo_rev; 208 usb2_quirks[x].hi_rev = hi_rev; 209 210 return (usb2_quirks + x); 211 } 212 213 /* no entry found */ 214 return (NULL); 215} 216 217/*------------------------------------------------------------------------* 218 * usb2_quirk_ioctl - handle quirk IOCTLs 219 * 220 * Returns: 221 * 0: Success 222 * Else: Failure 223 *------------------------------------------------------------------------*/ 224static int 225usb2_quirk_ioctl(unsigned long cmd, caddr_t data, 226 int fflag, struct thread *td) 227{ 228 struct usb2_gen_quirk *pgq; 229 struct usb2_quirk_entry *pqe; 230 uint32_t x; 231 uint32_t y; 232 int err; 233 234 switch (cmd) { 235 case USB_DEV_QUIRK_GET: 236 pgq = (void *)data; 237 x = pgq->index % USB_SUB_QUIRKS_MAX; 238 y = pgq->index / USB_SUB_QUIRKS_MAX; 239 if (y >= USB_DEV_QUIRKS_MAX) { 240 return (EINVAL); 241 } 242 mtx_lock(&usb2_quirk_mtx); 243 /* copy out data */ 244 pgq->vid = usb2_quirks[y].vid; 245 pgq->pid = usb2_quirks[y].pid; 246 pgq->bcdDeviceLow = usb2_quirks[y].lo_rev; 247 pgq->bcdDeviceHigh = usb2_quirks[y].hi_rev; 248 strlcpy(pgq->quirkname, 249 usb2_quirkstr(usb2_quirks[y].quirks[x]), 250 sizeof(pgq->quirkname)); 251 mtx_unlock(&usb2_quirk_mtx); 252 return (0); /* success */ 253 254 case USB_QUIRK_NAME_GET: 255 pgq = (void *)data; 256 x = pgq->index; 257 if (x >= USB_QUIRK_MAX) { 258 return (EINVAL); 259 } 260 strlcpy(pgq->quirkname, 261 usb2_quirkstr(x), sizeof(pgq->quirkname)); 262 return (0); /* success */ 263 264 case USB_DEV_QUIRK_ADD: 265 pgq = (void *)data; 266 267 /* check privileges */ 268 err = priv_check(curthread, PRIV_DRIVER); 269 if (err) { 270 return (err); 271 } 272 /* convert quirk string into numerical */ 273 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) { 274 if (strcmp(pgq->quirkname, usb2_quirkstr(y)) == 0) { 275 break; 276 } 277 } 278 if (y == USB_DEV_QUIRKS_MAX) { 279 return (EINVAL); 280 } 281 if (y == UQ_NONE) { 282 return (EINVAL); 283 } 284 mtx_lock(&usb2_quirk_mtx); 285 pqe = usb2_quirk_get_entry(pgq->vid, pgq->pid, 286 pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 1); 287 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 288 if (pqe->quirks[x] == UQ_NONE) { 289 pqe->quirks[x] = y; 290 break; 291 } 292 } 293 mtx_unlock(&usb2_quirk_mtx); 294 if (x == USB_SUB_QUIRKS_MAX) { 295 return (ENOMEM); 296 } 297 return (0); /* success */ 298 299 case USB_DEV_QUIRK_REMOVE: 300 pgq = (void *)data; 301 /* check privileges */ 302 err = priv_check(curthread, PRIV_DRIVER); 303 if (err) { 304 return (err); 305 } 306 /* convert quirk string into numerical */ 307 for (y = 0; y != USB_DEV_QUIRKS_MAX; y++) { 308 if (strcmp(pgq->quirkname, usb2_quirkstr(y)) == 0) { 309 break; 310 } 311 } 312 if (y == USB_DEV_QUIRKS_MAX) { 313 return (EINVAL); 314 } 315 if (y == UQ_NONE) { 316 return (EINVAL); 317 } 318 mtx_lock(&usb2_quirk_mtx); 319 pqe = usb2_quirk_get_entry(pgq->vid, pgq->pid, 320 pgq->bcdDeviceLow, pgq->bcdDeviceHigh, 0); 321 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 322 if (pqe->quirks[x] == y) { 323 pqe->quirks[x] = UQ_NONE; 324 break; 325 } 326 } 327 if (x == USB_SUB_QUIRKS_MAX) { 328 mtx_unlock(&usb2_quirk_mtx); 329 return (ENOMEM); 330 } 331 for (x = 0; x != USB_SUB_QUIRKS_MAX; x++) { 332 if (pqe->quirks[x] != UQ_NONE) { 333 break; 334 } 335 } 336 if (x == USB_SUB_QUIRKS_MAX) { 337 /* all quirk entries are unused - release */ 338 memset(pqe, 0, sizeof(pqe)); 339 } 340 mtx_unlock(&usb2_quirk_mtx); 341 return (0); /* success */ 342 343 default: 344 break; 345 } 346 return (ENOIOCTL); 347} 348 349static void 350usb2_quirk_init(void *arg) 351{ 352 /* initialize mutex */ 353 mtx_init(&usb2_quirk_mtx, "USB quirk", NULL, MTX_DEF); 354 355 /* register our function */ 356 usb2_test_quirk_p = &usb2_test_quirk_by_info; 357 usb2_quirk_ioctl_p = &usb2_quirk_ioctl; 358 return; 359} 360 361static void 362usb2_quirk_uninit(void *arg) 363{ 364 usb2_quirk_unload(arg); 365 366 /* destroy mutex */ 367 mtx_destroy(&usb2_quirk_mtx); 368 return; 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