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