1 /* $NetBSD: usb_subr.c,v 1.248 2020/06/11 02:39:30 thorpej Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usb_subr.c,v 1.18 1999/11/17 22:33:47 n_hibma Exp $ */ 3 4 /* 5 * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (lennart@augustsson.net) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include <sys/cdefs.h> 35 __KERNEL_RCSID(0, "$NetBSD: usb_subr.c,v 1.248 2020/06/11 02:39:30 thorpej Exp $"); 36 37 #ifdef _KERNEL_OPT 38 #include "opt_compat_netbsd.h" 39 #include "opt_usb.h" 40 #include "opt_usbverbose.h" 41 #endif 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/kernel.h> 46 #include <sys/kmem.h> 47 #include <sys/device.h> 48 #include <sys/select.h> 49 #include <sys/proc.h> 50 51 #include <sys/bus.h> 52 #include <sys/module.h> 53 54 #include <dev/usb/usb.h> 55 56 #include <dev/usb/usbdi.h> 57 #include <dev/usb/usbdi_util.h> 58 #include <dev/usb/usbdivar.h> 59 #include <dev/usb/usbdevs.h> 60 #include <dev/usb/usb_quirks.h> 61 #include <dev/usb/usb_verbose.h> 62 #include <dev/usb/usbhist.h> 63 64 #include "locators.h" 65 66 #define DPRINTF(FMT,A,B,C,D) USBHIST_LOG(usbdebug,FMT,A,B,C,D) 67 #define DPRINTFN(N,FMT,A,B,C,D) USBHIST_LOGN(usbdebug,N,FMT,A,B,C,D) 68 69 Static void usbd_devinfo(struct usbd_device *, int, char *, size_t); 70 Static int usbd_getnewaddr(struct usbd_bus *); 71 Static int usbd_print(void *, const char *); 72 Static int usbd_ifprint(void *, const char *); 73 Static void usbd_free_iface_data(struct usbd_device *, int); 74 75 uint32_t usb_cookie_no = 0; 76 77 Static const char * const usbd_error_strs[] = { 78 "NORMAL_COMPLETION", 79 "IN_PROGRESS", 80 "PENDING_REQUESTS", 81 "NOT_STARTED", 82 "INVAL", 83 "NOMEM", 84 "CANCELLED", 85 "BAD_ADDRESS", 86 "IN_USE", 87 "NO_ADDR", 88 "SET_ADDR_FAILED", 89 "NO_POWER", 90 "TOO_DEEP", 91 "IOERROR", 92 "NOT_CONFIGURED", 93 "TIMEOUT", 94 "SHORT_XFER", 95 "STALLED", 96 "INTERRUPTED", 97 "XXX", 98 }; 99 100 DEV_VERBOSE_DEFINE(usb); 101 102 const char * 103 usbd_errstr(usbd_status err) 104 { 105 static char buffer[5]; 106 107 if (err < USBD_ERROR_MAX) { 108 return usbd_error_strs[err]; 109 } else { 110 snprintf(buffer, sizeof(buffer), "%d", err); 111 return buffer; 112 } 113 } 114 115 static void 116 usbd_trim_spaces(char *p) 117 { 118 char *q, *e; 119 120 q = e = p; 121 while (*q == ' ') /* skip leading spaces */ 122 q++; 123 while ((*p = *q++)) /* copy string */ 124 if (*p++ != ' ') /* remember last non-space */ 125 e = p; 126 *e = '\0'; /* kill trailing spaces */ 127 } 128 129 static void 130 usbd_get_device_string(struct usbd_device *ud, uByte index, char **buf) 131 { 132 char *b; 133 usbd_status err; 134 135 b = kmem_alloc(USB_MAX_ENCODED_STRING_LEN, KM_SLEEP); 136 err = usbd_get_string0(ud, index, b, true); 137 if (err != USBD_NORMAL_COMPLETION) { 138 kmem_free(b, USB_MAX_ENCODED_STRING_LEN); 139 b = NULL; 140 } else { 141 usbd_trim_spaces(b); 142 } 143 144 *buf = b; 145 } 146 147 void 148 usbd_get_device_strings(struct usbd_device *ud) 149 { 150 usb_device_descriptor_t *udd = &ud->ud_ddesc; 151 152 usbd_get_device_string(ud, udd->iManufacturer, &ud->ud_vendor); 153 usbd_get_device_string(ud, udd->iProduct, &ud->ud_product); 154 usbd_get_device_string(ud, udd->iSerialNumber, &ud->ud_serial); 155 } 156 157 158 void 159 usbd_devinfo_vp(struct usbd_device *dev, char *v, size_t vl, char *p, 160 size_t pl, int usedev, int useencoded) 161 { 162 usb_device_descriptor_t *udd = &dev->ud_ddesc; 163 if (dev == NULL) 164 return; 165 166 v[0] = p[0] = '\0'; 167 168 if (usedev) { 169 if (usbd_get_string0(dev, udd->iManufacturer, v, useencoded) == 170 USBD_NORMAL_COMPLETION) 171 usbd_trim_spaces(v); 172 if (usbd_get_string0(dev, udd->iProduct, p, useencoded) == 173 USBD_NORMAL_COMPLETION) 174 usbd_trim_spaces(p); 175 } else { 176 if (dev->ud_vendor) { 177 strlcpy(v, dev->ud_vendor, vl); 178 } 179 if (dev->ud_product) { 180 strlcpy(p, dev->ud_product, pl); 181 } 182 } 183 if (v[0] == '\0') 184 usb_findvendor(v, vl, UGETW(udd->idVendor)); 185 if (p[0] == '\0') 186 usb_findproduct(p, pl, UGETW(udd->idVendor), 187 UGETW(udd->idProduct)); 188 } 189 190 int 191 usbd_printBCD(char *cp, size_t l, int bcd) 192 { 193 return snprintf(cp, l, "%x.%02x", bcd >> 8, bcd & 0xff); 194 } 195 196 Static void 197 usbd_devinfo(struct usbd_device *dev, int showclass, char *cp, size_t l) 198 { 199 usb_device_descriptor_t *udd = &dev->ud_ddesc; 200 char *vendor, *product; 201 int bcdDevice, bcdUSB; 202 char *ep; 203 204 vendor = kmem_alloc(USB_MAX_ENCODED_STRING_LEN * 2, KM_SLEEP); 205 product = &vendor[USB_MAX_ENCODED_STRING_LEN]; 206 207 ep = cp + l; 208 209 usbd_devinfo_vp(dev, vendor, USB_MAX_ENCODED_STRING_LEN, 210 product, USB_MAX_ENCODED_STRING_LEN, 0, 1); 211 cp += snprintf(cp, ep - cp, "%s (0x%04x) %s (0x%04x)", vendor, 212 UGETW(udd->idVendor), product, UGETW(udd->idProduct)); 213 if (showclass) 214 cp += snprintf(cp, ep - cp, ", class %d/%d", 215 udd->bDeviceClass, udd->bDeviceSubClass); 216 bcdUSB = UGETW(udd->bcdUSB); 217 bcdDevice = UGETW(udd->bcdDevice); 218 cp += snprintf(cp, ep - cp, ", rev "); 219 cp += usbd_printBCD(cp, ep - cp, bcdUSB); 220 *cp++ = '/'; 221 cp += usbd_printBCD(cp, ep - cp, bcdDevice); 222 cp += snprintf(cp, ep - cp, ", addr %d", dev->ud_addr); 223 *cp = 0; 224 kmem_free(vendor, USB_MAX_ENCODED_STRING_LEN * 2); 225 } 226 227 char * 228 usbd_devinfo_alloc(struct usbd_device *dev, int showclass) 229 { 230 char *devinfop; 231 232 devinfop = kmem_alloc(DEVINFOSIZE, KM_SLEEP); 233 usbd_devinfo(dev, showclass, devinfop, DEVINFOSIZE); 234 return devinfop; 235 } 236 237 void 238 usbd_devinfo_free(char *devinfop) 239 { 240 kmem_free(devinfop, DEVINFOSIZE); 241 } 242 243 /* Delay for a certain number of ms */ 244 void 245 usb_delay_ms_locked(struct usbd_bus *bus, u_int ms, kmutex_t *lock) 246 { 247 /* Wait at least two clock ticks so we know the time has passed. */ 248 if (bus->ub_usepolling || cold) 249 delay((ms+1) * 1000); 250 else 251 kpause("usbdly", false, (ms*hz+999)/1000 + 1, lock); 252 } 253 254 void 255 usb_delay_ms(struct usbd_bus *bus, u_int ms) 256 { 257 usb_delay_ms_locked(bus, ms, NULL); 258 } 259 260 /* Delay given a device handle. */ 261 void 262 usbd_delay_ms_locked(struct usbd_device *dev, u_int ms, kmutex_t *lock) 263 { 264 usb_delay_ms_locked(dev->ud_bus, ms, lock); 265 } 266 267 /* Delay given a device handle. */ 268 void 269 usbd_delay_ms(struct usbd_device *dev, u_int ms) 270 { 271 usb_delay_ms_locked(dev->ud_bus, ms, NULL); 272 } 273 274 usbd_status 275 usbd_reset_port(struct usbd_device *dev, int port, usb_port_status_t *ps) 276 { 277 USBHIST_FUNC(); USBHIST_CALLARGS(usbdebug, "port %jd", port, 0, 0, 0); 278 usb_device_request_t req; 279 usbd_status err; 280 int n; 281 282 req.bmRequestType = UT_WRITE_CLASS_OTHER; 283 req.bRequest = UR_SET_FEATURE; 284 USETW(req.wValue, UHF_PORT_RESET); 285 USETW(req.wIndex, port); 286 USETW(req.wLength, 0); 287 err = usbd_do_request(dev, &req, 0); 288 DPRINTFN(1, "port %jd reset done, error=%jd", port, err, 0, 0); 289 if (err) 290 return err; 291 n = 10; 292 do { 293 /* Wait for device to recover from reset. */ 294 usbd_delay_ms(dev, USB_PORT_RESET_DELAY); 295 err = usbd_get_port_status(dev, port, ps); 296 if (err) { 297 DPRINTF("get status failed %jd", err, 0, 0, 0); 298 return err; 299 } 300 /* If the device disappeared, just give up. */ 301 if (!(UGETW(ps->wPortStatus) & UPS_CURRENT_CONNECT_STATUS)) 302 return USBD_NORMAL_COMPLETION; 303 } while ((UGETW(ps->wPortChange) & UPS_C_PORT_RESET) == 0 && --n > 0); 304 if (n == 0) 305 return USBD_TIMEOUT; 306 err = usbd_clear_port_feature(dev, port, UHF_C_PORT_RESET); 307 #ifdef USB_DEBUG 308 if (err) 309 DPRINTF("clear port feature failed %jd", err, 0, 0, 0); 310 #endif 311 312 /* Wait for the device to recover from reset. */ 313 usbd_delay_ms(dev, USB_PORT_RESET_RECOVERY); 314 return err; 315 } 316 317 usb_interface_descriptor_t * 318 usbd_find_idesc(usb_config_descriptor_t *cd, int ifaceidx, int altidx) 319 { 320 USBHIST_FUNC(); 321 USBHIST_CALLARGS(usbdebug, "iface/alt idx %jd/%jd", 322 ifaceidx, altidx, 0, 0); 323 char *p = (char *)cd; 324 char *end = p + UGETW(cd->wTotalLength); 325 usb_descriptor_t *desc; 326 usb_interface_descriptor_t *idesc; 327 int curidx, lastidx, curaidx = 0; 328 329 for (curidx = lastidx = -1; p < end; ) { 330 desc = (usb_descriptor_t *)p; 331 332 DPRINTFN(4, "idx=%jd(%jd) altidx=%jd(%jd)", ifaceidx, curidx, 333 altidx, curaidx); 334 DPRINTFN(4, "len=%jd type=%jd", desc->bLength, 335 desc->bDescriptorType, 0, 0); 336 337 if (desc->bLength < USB_DESCRIPTOR_SIZE) 338 break; 339 p += desc->bLength; 340 if (p > end) 341 break; 342 343 if (desc->bDescriptorType != UDESC_INTERFACE) 344 continue; 345 idesc = (usb_interface_descriptor_t *)desc; 346 if (idesc->bLength < USB_INTERFACE_DESCRIPTOR_SIZE) 347 break; 348 349 if (idesc->bInterfaceNumber != lastidx) { 350 lastidx = idesc->bInterfaceNumber; 351 curidx++; 352 curaidx = 0; 353 } else { 354 curaidx++; 355 } 356 if (ifaceidx == curidx && altidx == curaidx) 357 return idesc; 358 } 359 360 return NULL; 361 } 362 363 usb_endpoint_descriptor_t * 364 usbd_find_edesc(usb_config_descriptor_t *cd, int ifaceidx, int altidx, 365 int endptidx) 366 { 367 char *p = (char *)cd; 368 char *end = p + UGETW(cd->wTotalLength); 369 usb_interface_descriptor_t *idesc; 370 usb_endpoint_descriptor_t *edesc; 371 usb_descriptor_t *desc; 372 int curidx; 373 374 idesc = usbd_find_idesc(cd, ifaceidx, altidx); 375 if (idesc == NULL) 376 return NULL; 377 if (endptidx >= idesc->bNumEndpoints) /* quick exit */ 378 return NULL; 379 380 curidx = -1; 381 for (p = (char *)idesc + idesc->bLength; p < end; ) { 382 desc = (usb_descriptor_t *)p; 383 384 if (desc->bLength < USB_DESCRIPTOR_SIZE) 385 break; 386 p += desc->bLength; 387 if (p > end) 388 break; 389 390 if (desc->bDescriptorType == UDESC_INTERFACE) 391 break; 392 if (desc->bDescriptorType != UDESC_ENDPOINT) 393 continue; 394 395 edesc = (usb_endpoint_descriptor_t *)desc; 396 if (edesc->bLength < USB_ENDPOINT_DESCRIPTOR_SIZE) 397 break; 398 399 curidx++; 400 if (curidx == endptidx) 401 return edesc; 402 } 403 return NULL; 404 } 405 406 usbd_status 407 usbd_fill_iface_data(struct usbd_device *dev, int ifaceidx, int altidx) 408 { 409 USBHIST_FUNC(); 410 USBHIST_CALLARGS(usbdebug, "ifaceidx=%jd altidx=%jd", 411 ifaceidx, altidx, 0, 0); 412 struct usbd_interface *ifc = &dev->ud_ifaces[ifaceidx]; 413 usb_interface_descriptor_t *idesc; 414 char *p, *end; 415 int endpt, nendpt; 416 417 idesc = usbd_find_idesc(dev->ud_cdesc, ifaceidx, altidx); 418 if (idesc == NULL) 419 return USBD_INVAL; 420 ifc->ui_dev = dev; 421 ifc->ui_idesc = idesc; 422 ifc->ui_index = ifaceidx; 423 ifc->ui_altindex = altidx; 424 nendpt = ifc->ui_idesc->bNumEndpoints; 425 DPRINTFN(4, "found idesc nendpt=%jd", nendpt, 0, 0, 0); 426 if (nendpt != 0) { 427 ifc->ui_endpoints = kmem_alloc(nendpt * sizeof(struct usbd_endpoint), 428 KM_SLEEP); 429 } else 430 ifc->ui_endpoints = NULL; 431 ifc->ui_priv = NULL; 432 p = (char *)ifc->ui_idesc + ifc->ui_idesc->bLength; 433 end = (char *)dev->ud_cdesc + UGETW(dev->ud_cdesc->wTotalLength); 434 #define ed ((usb_endpoint_descriptor_t *)p) 435 for (endpt = 0; endpt < nendpt; endpt++) { 436 DPRINTFN(10, "endpt=%jd", endpt, 0, 0, 0); 437 for (; p < end; p += ed->bLength) { 438 DPRINTFN(10, "p=%#jx end=%#jx len=%jd type=%jd", 439 (uintptr_t)p, (uintptr_t)end, ed->bLength, 440 ed->bDescriptorType); 441 if (p + ed->bLength <= end && 442 ed->bLength >= USB_ENDPOINT_DESCRIPTOR_SIZE && 443 ed->bDescriptorType == UDESC_ENDPOINT) 444 goto found; 445 if (ed->bLength == 0 || 446 ed->bDescriptorType == UDESC_INTERFACE) 447 break; 448 } 449 /* passed end, or bad desc */ 450 if (p < end) { 451 if (ed->bLength == 0) { 452 printf("%s: bad descriptor: 0 length\n", 453 __func__); 454 } else { 455 printf("%s: bad descriptor: iface desc\n", 456 __func__); 457 } 458 } else { 459 printf("%s: no desc found\n", __func__); 460 } 461 goto bad; 462 found: 463 ifc->ui_endpoints[endpt].ue_edesc = ed; 464 if (dev->ud_speed == USB_SPEED_HIGH) { 465 u_int mps; 466 /* Control and bulk endpoints have max packet limits. */ 467 switch (UE_GET_XFERTYPE(ed->bmAttributes)) { 468 case UE_CONTROL: 469 mps = USB_2_MAX_CTRL_PACKET; 470 goto check; 471 case UE_BULK: 472 mps = USB_2_MAX_BULK_PACKET; 473 check: 474 if (UGETW(ed->wMaxPacketSize) != mps) { 475 USETW(ed->wMaxPacketSize, mps); 476 #ifdef DIAGNOSTIC 477 printf("usbd_fill_iface_data: bad max " 478 "packet size\n"); 479 #endif 480 } 481 break; 482 default: 483 break; 484 } 485 } 486 ifc->ui_endpoints[endpt].ue_refcnt = 0; 487 ifc->ui_endpoints[endpt].ue_toggle = 0; 488 p += ed->bLength; 489 } 490 #undef ed 491 LIST_INIT(&ifc->ui_pipes); 492 return USBD_NORMAL_COMPLETION; 493 494 bad: 495 if (ifc->ui_endpoints != NULL) { 496 kmem_free(ifc->ui_endpoints, nendpt * sizeof(struct usbd_endpoint)); 497 ifc->ui_endpoints = NULL; 498 } 499 return USBD_INVAL; 500 } 501 502 void 503 usbd_free_iface_data(struct usbd_device *dev, int ifcno) 504 { 505 struct usbd_interface *ifc = &dev->ud_ifaces[ifcno]; 506 if (ifc->ui_endpoints) { 507 int nendpt = ifc->ui_idesc->bNumEndpoints; 508 size_t sz = nendpt * sizeof(struct usbd_endpoint); 509 kmem_free(ifc->ui_endpoints, sz); 510 ifc->ui_endpoints = NULL; 511 } 512 } 513 514 usbd_status 515 usbd_set_config_no(struct usbd_device *dev, int no, int msg) 516 { 517 USBHIST_FUNC(); USBHIST_CALLARGS(usbdebug, "%jd", no, 0, 0, 0); 518 usb_config_descriptor_t cd; 519 usbd_status err; 520 int index; 521 522 if (no == USB_UNCONFIG_NO) 523 return usbd_set_config_index(dev, USB_UNCONFIG_INDEX, msg); 524 525 /* Figure out what config index to use. */ 526 for (index = 0; index < dev->ud_ddesc.bNumConfigurations; index++) { 527 err = usbd_get_config_desc(dev, index, &cd); 528 if (err) 529 return err; 530 if (cd.bConfigurationValue == no) 531 return usbd_set_config_index(dev, index, msg); 532 } 533 return USBD_INVAL; 534 } 535 536 usbd_status 537 usbd_set_config_index(struct usbd_device *dev, int index, int msg) 538 { 539 USBHIST_FUNC(); 540 USBHIST_CALLARGS(usbdebug, "dev=%#jx index=%jd", 541 (uintptr_t)dev, index, 0, 0); 542 usb_config_descriptor_t cd, *cdp; 543 usb_bos_descriptor_t *bdp = NULL; 544 usbd_status err; 545 int i, ifcidx, nifc, len, selfpowered, power; 546 547 548 if (index >= dev->ud_ddesc.bNumConfigurations && 549 index != USB_UNCONFIG_INDEX) { 550 /* panic? */ 551 printf("usbd_set_config_index: illegal index\n"); 552 return USBD_INVAL; 553 } 554 555 /* XXX check that all interfaces are idle */ 556 if (dev->ud_config != USB_UNCONFIG_NO) { 557 DPRINTF("free old config", 0, 0, 0, 0); 558 /* Free all configuration data structures. */ 559 nifc = dev->ud_cdesc->bNumInterface; 560 for (ifcidx = 0; ifcidx < nifc; ifcidx++) 561 usbd_free_iface_data(dev, ifcidx); 562 kmem_free(dev->ud_ifaces, nifc * sizeof(struct usbd_interface)); 563 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength)); 564 if (dev->ud_bdesc != NULL) 565 kmem_free(dev->ud_bdesc, 566 UGETW(dev->ud_bdesc->wTotalLength)); 567 dev->ud_ifaces = NULL; 568 dev->ud_cdesc = NULL; 569 dev->ud_bdesc = NULL; 570 dev->ud_config = USB_UNCONFIG_NO; 571 } 572 573 if (index == USB_UNCONFIG_INDEX) { 574 /* We are unconfiguring the device, so leave unallocated. */ 575 DPRINTF("set config 0", 0, 0, 0, 0); 576 err = usbd_set_config(dev, USB_UNCONFIG_NO); 577 if (err) { 578 DPRINTF("setting config=0 failed, err = %jd", err, 579 0, 0, 0); 580 } 581 return err; 582 } 583 584 /* Get the short descriptor. */ 585 err = usbd_get_config_desc(dev, index, &cd); 586 if (err) { 587 DPRINTF("get_config_desc=%jd", err, 0, 0, 0); 588 return err; 589 } 590 len = UGETW(cd.wTotalLength); 591 if (len < USB_CONFIG_DESCRIPTOR_SIZE) { 592 DPRINTF("empty short descriptor", 0, 0, 0, 0); 593 return USBD_INVAL; 594 } 595 cdp = kmem_alloc(len, KM_SLEEP); 596 597 /* Get the full descriptor. Try a few times for slow devices. */ 598 for (i = 0; i < 3; i++) { 599 err = usbd_get_desc(dev, UDESC_CONFIG, index, len, cdp); 600 if (!err) 601 break; 602 usbd_delay_ms(dev, 200); 603 } 604 if (err) { 605 DPRINTF("get_desc=%jd", err, 0, 0, 0); 606 goto bad; 607 } 608 if (cdp->bDescriptorType != UDESC_CONFIG) { 609 DPRINTF("bad desc %jd", cdp->bDescriptorType, 0, 0, 0); 610 err = USBD_INVAL; 611 goto bad; 612 } 613 if (UGETW(cdp->wTotalLength) != UGETW(cd.wTotalLength)) { 614 DPRINTF("bad len %jd", UGETW(cdp->wTotalLength), 0, 0, 0); 615 err = USBD_INVAL; 616 goto bad; 617 } 618 619 if (USB_IS_SS(dev->ud_speed)) { 620 usb_bos_descriptor_t bd; 621 622 /* get short bos desc */ 623 err = usbd_get_bos_desc(dev, index, &bd); 624 if (!err) { 625 int blen = UGETW(bd.wTotalLength); 626 if (blen < USB_BOS_DESCRIPTOR_SIZE) { 627 DPRINTF("empty bos descriptor", 0, 0, 0, 0); 628 err = USBD_INVAL; 629 goto bad; 630 } 631 bdp = kmem_alloc(blen, KM_SLEEP); 632 633 /* Get the full desc */ 634 for (i = 0; i < 3; i++) { 635 err = usbd_get_desc(dev, UDESC_BOS, index, blen, 636 bdp); 637 if (!err) 638 break; 639 usbd_delay_ms(dev, 200); 640 } 641 if (err || bdp->bDescriptorType != UDESC_BOS || 642 UGETW(bdp->wTotalLength) != UGETW(bd.wTotalLength)) { 643 DPRINTF("error %jd or bad desc %jd", err, 644 bdp->bDescriptorType, 0, 0); 645 kmem_free(bdp, blen); 646 bdp = NULL; 647 } 648 } 649 } 650 dev->ud_bdesc = bdp; 651 652 /* 653 * Figure out if the device is self or bus powered. 654 */ 655 #if 0 /* XXX various devices don't report the power state correctly */ 656 selfpowered = 0; 657 err = usbd_get_device_status(dev, &ds); 658 if (!err && (UGETW(ds.wStatus) & UDS_SELF_POWERED)) 659 selfpowered = 1; 660 #endif 661 /* 662 * Use the power state in the configuration we are going 663 * to set. This doesn't necessarily reflect the actual 664 * power state of the device; the driver can control this 665 * by choosing the appropriate configuration. 666 */ 667 selfpowered = !!(cdp->bmAttributes & UC_SELF_POWERED); 668 669 DPRINTF("addr %jd cno=%jd attr=0x%02jx, selfpowered=%jd", 670 dev->ud_addr, cdp->bConfigurationValue, cdp->bmAttributes, 671 selfpowered); 672 DPRINTF("max power=%jd", cdp->bMaxPower * 2, 0, 0, 0); 673 674 /* Check if we have enough power. */ 675 #if 0 /* this is a no-op, see above */ 676 if ((cdp->bmAttributes & UC_SELF_POWERED) && !selfpowered) { 677 if (msg) 678 printf("%s: device addr %d (config %d): " 679 "can't set self powered configuration\n", 680 device_xname(dev->ud_bus->bdev), dev->ud_addr, 681 cdp->bConfigurationValue); 682 err = USBD_NO_POWER; 683 goto bad; 684 } 685 #endif 686 #ifdef USB_DEBUG 687 if (dev->ud_powersrc == NULL) { 688 DPRINTF("No power source?", 0, 0, 0, 0); 689 err = USBD_IOERROR; 690 goto bad; 691 } 692 #endif 693 power = cdp->bMaxPower * 2; 694 if (power > dev->ud_powersrc->up_power) { 695 DPRINTF("power exceeded %jd %jd", power, 696 dev->ud_powersrc->up_power, 0, 0); 697 /* XXX print nicer message. */ 698 if (msg) 699 printf("%s: device addr %d (config %d) exceeds power " 700 "budget, %d mA > %d mA\n", 701 device_xname(dev->ud_bus->ub_usbctl), dev->ud_addr, 702 cdp->bConfigurationValue, 703 power, dev->ud_powersrc->up_power); 704 err = USBD_NO_POWER; 705 goto bad; 706 } 707 dev->ud_power = power; 708 dev->ud_selfpowered = selfpowered; 709 710 /* Set the actual configuration value. */ 711 DPRINTF("set config %jd", cdp->bConfigurationValue, 0, 0, 0); 712 err = usbd_set_config(dev, cdp->bConfigurationValue); 713 if (err) { 714 DPRINTF("setting config=%jd failed, error=%jd", 715 cdp->bConfigurationValue, err, 0, 0); 716 goto bad; 717 } 718 719 /* Allocate and fill interface data. */ 720 nifc = cdp->bNumInterface; 721 if (nifc == 0) { 722 DPRINTF("no interfaces", 0, 0, 0, 0); 723 err = USBD_INVAL; 724 goto bad; 725 } 726 dev->ud_ifaces = kmem_alloc(nifc * sizeof(struct usbd_interface), 727 KM_SLEEP); 728 DPRINTFN(5, "dev=%#jx cdesc=%#jx", (uintptr_t)dev, (uintptr_t)cdp, 729 0, 0); 730 dev->ud_cdesc = cdp; 731 dev->ud_config = cdp->bConfigurationValue; 732 for (ifcidx = 0; ifcidx < nifc; ifcidx++) { 733 err = usbd_fill_iface_data(dev, ifcidx, 0); 734 if (err) { 735 while (--ifcidx >= 0) 736 usbd_free_iface_data(dev, ifcidx); 737 kmem_free(dev->ud_ifaces, 738 nifc * sizeof(struct usbd_interface)); 739 dev->ud_ifaces = NULL; 740 goto bad; 741 } 742 } 743 744 return USBD_NORMAL_COMPLETION; 745 746 bad: 747 /* XXX Use usbd_set_config() to reset the config? */ 748 /* XXX Should we forbid USB_UNCONFIG_NO from bConfigurationValue? */ 749 dev->ud_config = USB_UNCONFIG_NO; 750 kmem_free(cdp, len); 751 dev->ud_cdesc = NULL; 752 if (bdp != NULL) { 753 kmem_free(bdp, UGETW(bdp->wTotalLength)); 754 dev->ud_bdesc = NULL; 755 } 756 return err; 757 } 758 759 /* XXX add function for alternate settings */ 760 761 usbd_status 762 usbd_setup_pipe(struct usbd_device *dev, struct usbd_interface *iface, 763 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe) 764 { 765 return usbd_setup_pipe_flags(dev, iface, ep, ival, pipe, 0); 766 } 767 768 usbd_status 769 usbd_setup_pipe_flags(struct usbd_device *dev, struct usbd_interface *iface, 770 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe, uint8_t flags) 771 { 772 USBHIST_FUNC(); 773 USBHIST_CALLARGS(usbdebug, "dev=%#jx addr=%jd iface=%#jx ep=%#jx", 774 (uintptr_t)dev, dev->ud_addr, (uintptr_t)iface, (uintptr_t)ep); 775 struct usbd_pipe *p; 776 usbd_status err; 777 778 p = kmem_alloc(dev->ud_bus->ub_pipesize, KM_SLEEP); 779 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0); 780 p->up_dev = dev; 781 p->up_iface = iface; 782 p->up_endpoint = ep; 783 ep->ue_refcnt++; 784 p->up_intrxfer = NULL; 785 p->up_running = 0; 786 p->up_aborting = 0; 787 p->up_serialise = true; 788 p->up_repeat = 0; 789 p->up_interval = ival; 790 p->up_flags = flags; 791 SIMPLEQ_INIT(&p->up_queue); 792 err = dev->ud_bus->ub_methods->ubm_open(p); 793 if (err) { 794 DPRINTF("endpoint=%#jx failed, error=%jd", 795 (uintptr_t)ep->ue_edesc->bEndpointAddress, err, 0, 0); 796 kmem_free(p, dev->ud_bus->ub_pipesize); 797 return err; 798 } 799 800 KASSERT(p->up_methods->upm_start || p->up_serialise == false); 801 802 usb_init_task(&p->up_async_task, usbd_clear_endpoint_stall_task, p, 803 USB_TASKQ_MPSAFE); 804 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0); 805 *pipe = p; 806 return USBD_NORMAL_COMPLETION; 807 } 808 809 /* Abort the device control pipe. */ 810 void 811 usbd_kill_pipe(struct usbd_pipe *pipe) 812 { 813 usbd_abort_pipe(pipe); 814 usbd_lock_pipe(pipe); 815 pipe->up_methods->upm_close(pipe); 816 usbd_unlock_pipe(pipe); 817 usb_rem_task_wait(pipe->up_dev, &pipe->up_async_task, USB_TASKQ_DRIVER, 818 NULL); 819 pipe->up_endpoint->ue_refcnt--; 820 kmem_free(pipe, pipe->up_dev->ud_bus->ub_pipesize); 821 } 822 823 int 824 usbd_getnewaddr(struct usbd_bus *bus) 825 { 826 int addr; 827 828 for (addr = 1; addr < USB_MAX_DEVICES; addr++) { 829 size_t dindex = usb_addr2dindex(addr); 830 if (bus->ub_devices[dindex] == NULL) 831 return addr; 832 } 833 return -1; 834 } 835 836 usbd_status 837 usbd_attach_roothub(device_t parent, struct usbd_device *dev) 838 { 839 struct usb_attach_arg uaa; 840 usb_device_descriptor_t *dd = &dev->ud_ddesc; 841 device_t dv; 842 843 uaa.uaa_device = dev; 844 uaa.uaa_usegeneric = 0; 845 uaa.uaa_port = 0; 846 uaa.uaa_vendor = UGETW(dd->idVendor); 847 uaa.uaa_product = UGETW(dd->idProduct); 848 uaa.uaa_release = UGETW(dd->bcdDevice); 849 uaa.uaa_class = dd->bDeviceClass; 850 uaa.uaa_subclass = dd->bDeviceSubClass; 851 uaa.uaa_proto = dd->bDeviceProtocol; 852 853 KERNEL_LOCK(1, curlwp); 854 dv = config_found_ia(parent, "usbroothubif", &uaa, 0); 855 KERNEL_UNLOCK_ONE(curlwp); 856 if (dv) { 857 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP); 858 dev->ud_subdevs[0] = dv; 859 dev->ud_subdevlen = 1; 860 } 861 return USBD_NORMAL_COMPLETION; 862 } 863 864 static void 865 usbd_serialnumber(device_t dv, struct usbd_device *dev) 866 { 867 if (dev->ud_serial) { 868 prop_dictionary_set_string(device_properties(dv), 869 "serialnumber", dev->ud_serial); 870 } 871 } 872 873 static usbd_status 874 usbd_attachwholedevice(device_t parent, struct usbd_device *dev, int port, 875 int usegeneric) 876 { 877 struct usb_attach_arg uaa; 878 usb_device_descriptor_t *dd = &dev->ud_ddesc; 879 device_t dv; 880 int dlocs[USBDEVIFCF_NLOCS]; 881 882 uaa.uaa_device = dev; 883 uaa.uaa_usegeneric = usegeneric; 884 uaa.uaa_port = port; 885 uaa.uaa_vendor = UGETW(dd->idVendor); 886 uaa.uaa_product = UGETW(dd->idProduct); 887 uaa.uaa_release = UGETW(dd->bcdDevice); 888 uaa.uaa_class = dd->bDeviceClass; 889 uaa.uaa_subclass = dd->bDeviceSubClass; 890 uaa.uaa_proto = dd->bDeviceProtocol; 891 892 dlocs[USBDEVIFCF_PORT] = uaa.uaa_port; 893 dlocs[USBDEVIFCF_VENDOR] = uaa.uaa_vendor; 894 dlocs[USBDEVIFCF_PRODUCT] = uaa.uaa_product; 895 dlocs[USBDEVIFCF_RELEASE] = uaa.uaa_release; 896 /* the rest is historical ballast */ 897 dlocs[USBDEVIFCF_CONFIGURATION] = -1; 898 dlocs[USBDEVIFCF_INTERFACE] = -1; 899 900 KERNEL_LOCK(1, curlwp); 901 config_pending_incr(parent); 902 dv = config_found_sm_loc(parent, "usbdevif", dlocs, &uaa, usbd_print, 903 config_stdsubmatch); 904 KERNEL_UNLOCK_ONE(curlwp); 905 if (dv) { 906 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP); 907 dev->ud_subdevs[0] = dv; 908 dev->ud_subdevlen = 1; 909 dev->ud_nifaces_claimed = 1; /* XXX */ 910 usbd_serialnumber(dv, dev); 911 } 912 config_pending_decr(parent); 913 return USBD_NORMAL_COMPLETION; 914 } 915 916 static usbd_status 917 usbd_attachinterfaces(device_t parent, struct usbd_device *dev, 918 int port, const int *locators) 919 { 920 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 921 struct usbif_attach_arg uiaa; 922 int ilocs[USBIFIFCF_NLOCS]; 923 usb_device_descriptor_t *dd = &dev->ud_ddesc; 924 int nifaces; 925 struct usbd_interface **ifaces; 926 int i, j, loc; 927 device_t dv; 928 929 nifaces = dev->ud_cdesc->bNumInterface; 930 ifaces = kmem_zalloc(nifaces * sizeof(*ifaces), KM_SLEEP); 931 for (i = 0; i < nifaces; i++) { 932 if (!dev->ud_subdevs[i]) { 933 ifaces[i] = &dev->ud_ifaces[i]; 934 } 935 DPRINTF("interface %jd %#jx", i, (uintptr_t)ifaces[i], 0, 0); 936 } 937 938 939 uiaa.uiaa_device = dev; 940 uiaa.uiaa_port = port; 941 uiaa.uiaa_vendor = UGETW(dd->idVendor); 942 uiaa.uiaa_product = UGETW(dd->idProduct); 943 uiaa.uiaa_release = UGETW(dd->bcdDevice); 944 uiaa.uiaa_configno = dev->ud_cdesc->bConfigurationValue; 945 uiaa.uiaa_ifaces = ifaces; 946 uiaa.uiaa_nifaces = nifaces; 947 ilocs[USBIFIFCF_PORT] = uiaa.uiaa_port; 948 ilocs[USBIFIFCF_VENDOR] = uiaa.uiaa_vendor; 949 ilocs[USBIFIFCF_PRODUCT] = uiaa.uiaa_product; 950 ilocs[USBIFIFCF_RELEASE] = uiaa.uiaa_release; 951 ilocs[USBIFIFCF_CONFIGURATION] = uiaa.uiaa_configno; 952 953 for (i = 0; i < nifaces; i++) { 954 if (!ifaces[i]) { 955 DPRINTF("interface %jd claimed", i, 0, 0, 0); 956 continue; /* interface already claimed */ 957 } 958 uiaa.uiaa_iface = ifaces[i]; 959 uiaa.uiaa_class = ifaces[i]->ui_idesc->bInterfaceClass; 960 uiaa.uiaa_subclass = ifaces[i]->ui_idesc->bInterfaceSubClass; 961 uiaa.uiaa_proto = ifaces[i]->ui_idesc->bInterfaceProtocol; 962 uiaa.uiaa_ifaceno = ifaces[i]->ui_idesc->bInterfaceNumber; 963 964 DPRINTF("searching for interface %jd...", i, 0, 0, 0); 965 DPRINTF("class %jx subclass %jx proto %jx ifaceno %jd", 966 uiaa.uiaa_class, uiaa.uiaa_subclass, uiaa.uiaa_proto, 967 uiaa.uiaa_ifaceno); 968 ilocs[USBIFIFCF_INTERFACE] = uiaa.uiaa_ifaceno; 969 if (locators != NULL) { 970 loc = locators[USBIFIFCF_CONFIGURATION]; 971 if (loc != USBIFIFCF_CONFIGURATION_DEFAULT && 972 loc != uiaa.uiaa_configno) 973 continue; 974 loc = locators[USBIFIFCF_INTERFACE]; 975 if (loc != USBIFIFCF_INTERFACE_DEFAULT && 976 loc != uiaa.uiaa_ifaceno) 977 continue; 978 } 979 KERNEL_LOCK(1, curlwp); 980 dv = config_found_sm_loc(parent, "usbifif", ilocs, &uiaa, 981 usbd_ifprint, config_stdsubmatch); 982 KERNEL_UNLOCK_ONE(curlwp); 983 if (!dv) 984 continue; 985 986 usbd_serialnumber(dv, dev); 987 988 /* claim */ 989 ifaces[i] = NULL; 990 /* account for ifaces claimed by the driver behind our back */ 991 for (j = 0; j < nifaces; j++) { 992 993 if (!ifaces[j] && !dev->ud_subdevs[j]) { 994 DPRINTF("interface %jd claimed behind our back", 995 j, 0, 0, 0); 996 dev->ud_subdevs[j] = dv; 997 dev->ud_nifaces_claimed++; 998 } 999 } 1000 } 1001 1002 kmem_free(ifaces, nifaces * sizeof(*ifaces)); 1003 return USBD_NORMAL_COMPLETION; 1004 } 1005 1006 usbd_status 1007 usbd_probe_and_attach(device_t parent, struct usbd_device *dev, 1008 int port, int addr) 1009 { 1010 USBHIST_FUNC(); 1011 USBHIST_CALLARGS(usbdebug, "trying device specific drivers", 0, 0, 0, 0); 1012 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1013 int confi, nifaces; 1014 usbd_status err; 1015 1016 /* First try with device specific drivers. */ 1017 err = usbd_attachwholedevice(parent, dev, port, 0); 1018 if (dev->ud_nifaces_claimed || err) 1019 return err; 1020 DPRINTF("no device specific driver found", 0, 0, 0, 0); 1021 1022 DPRINTF("looping over %jd configurations", dd->bNumConfigurations, 1023 0, 0, 0); 1024 for (confi = 0; confi < dd->bNumConfigurations; confi++) { 1025 DPRINTFN(1, "trying config idx=%jd", confi, 0, 0, 0); 1026 err = usbd_set_config_index(dev, confi, 1); 1027 if (err) { 1028 DPRINTF("port %jd, set config at addr %jd failed, " 1029 "error=%jd", port, addr, err, 0); 1030 printf("%s: port %d, set config at addr %d failed\n", 1031 device_xname(parent), port, addr); 1032 return err; 1033 } 1034 nifaces = dev->ud_cdesc->bNumInterface; 1035 dev->ud_subdevs = kmem_zalloc(nifaces * sizeof(device_t), 1036 KM_SLEEP); 1037 if (dev->ud_subdevs == NULL) 1038 return USBD_NOMEM; 1039 dev->ud_subdevlen = nifaces; 1040 1041 err = usbd_attachinterfaces(parent, dev, port, NULL); 1042 1043 if (!dev->ud_nifaces_claimed) { 1044 kmem_free(dev->ud_subdevs, 1045 dev->ud_subdevlen * sizeof(device_t)); 1046 dev->ud_subdevs = 0; 1047 dev->ud_subdevlen = 0; 1048 } 1049 if (dev->ud_nifaces_claimed || err) 1050 return err; 1051 } 1052 /* No interfaces were attached in any of the configurations. */ 1053 1054 if (dd->bNumConfigurations > 1) /* don't change if only 1 config */ 1055 usbd_set_config_index(dev, 0, 0); 1056 1057 DPRINTF("no interface drivers found", 0, 0, 0, 0); 1058 1059 /* Finally try the generic driver. */ 1060 err = usbd_attachwholedevice(parent, dev, port, 1); 1061 1062 /* 1063 * The generic attach failed, but leave the device as it is. 1064 * We just did not find any drivers, that's all. The device is 1065 * fully operational and not harming anyone. 1066 */ 1067 DPRINTF("generic attach failed", 0, 0, 0, 0); 1068 1069 return USBD_NORMAL_COMPLETION; 1070 } 1071 1072 /** 1073 * Called from uhub_rescan(). usbd_new_device() for the target dev must be 1074 * called before calling this. 1075 */ 1076 usbd_status 1077 usbd_reattach_device(device_t parent, struct usbd_device *dev, 1078 int port, const int *locators) 1079 { 1080 int i, loc; 1081 1082 if (locators != NULL) { 1083 loc = locators[USBIFIFCF_PORT]; 1084 if (loc != USBIFIFCF_PORT_DEFAULT && loc != port) 1085 return USBD_NORMAL_COMPLETION; 1086 loc = locators[USBIFIFCF_VENDOR]; 1087 if (loc != USBIFIFCF_VENDOR_DEFAULT && 1088 loc != UGETW(dev->ud_ddesc.idVendor)) 1089 return USBD_NORMAL_COMPLETION; 1090 loc = locators[USBIFIFCF_PRODUCT]; 1091 if (loc != USBIFIFCF_PRODUCT_DEFAULT && 1092 loc != UGETW(dev->ud_ddesc.idProduct)) 1093 return USBD_NORMAL_COMPLETION; 1094 loc = locators[USBIFIFCF_RELEASE]; 1095 if (loc != USBIFIFCF_RELEASE_DEFAULT && 1096 loc != UGETW(dev->ud_ddesc.bcdDevice)) 1097 return USBD_NORMAL_COMPLETION; 1098 } 1099 if (dev->ud_subdevlen == 0) { 1100 /* XXX: check USBIFIFCF_CONFIGURATION and 1101 * USBIFIFCF_INTERFACE too */ 1102 return usbd_probe_and_attach(parent, dev, port, dev->ud_addr); 1103 } else if (dev->ud_subdevlen != dev->ud_cdesc->bNumInterface) { 1104 /* device-specific or generic driver is already attached. */ 1105 return USBD_NORMAL_COMPLETION; 1106 } 1107 /* Does the device have unconfigured interfaces? */ 1108 for (i = 0; i < dev->ud_subdevlen; i++) { 1109 if (dev->ud_subdevs[i] == NULL) { 1110 break; 1111 } 1112 } 1113 if (i >= dev->ud_subdevlen) 1114 return USBD_NORMAL_COMPLETION; 1115 return usbd_attachinterfaces(parent, dev, port, locators); 1116 } 1117 1118 /* 1119 * Called when a new device has been put in the powered state, 1120 * but not yet in the addressed state. 1121 * Get initial descriptor, set the address, get full descriptor, 1122 * and attach a driver. 1123 */ 1124 usbd_status 1125 usbd_new_device(device_t parent, struct usbd_bus *bus, int depth, int speed, 1126 int port, struct usbd_port *up) 1127 { 1128 USBHIST_FUNC(); 1129 USBHIST_CALLARGS(usbdebug, "bus=%#jx port=%jd depth=%jd speed=%jd", 1130 (uintptr_t)bus, port, depth, speed); 1131 struct usbd_device *dev, *adev; 1132 struct usbd_device *hub; 1133 usb_device_descriptor_t *dd; 1134 usb_port_status_t ps; 1135 usbd_status err; 1136 int addr; 1137 int i; 1138 int p; 1139 1140 if (bus->ub_methods->ubm_newdev != NULL) 1141 return (bus->ub_methods->ubm_newdev)(parent, bus, depth, speed, 1142 port, up); 1143 1144 addr = usbd_getnewaddr(bus); 1145 if (addr < 0) { 1146 printf("%s: No free USB addresses, new device ignored.\n", 1147 device_xname(bus->ub_usbctl)); 1148 return USBD_NO_ADDR; 1149 } 1150 1151 dev = kmem_zalloc(sizeof(*dev), KM_SLEEP); 1152 dev->ud_bus = bus; 1153 1154 /* Set up default endpoint handle. */ 1155 dev->ud_ep0.ue_edesc = &dev->ud_ep0desc; 1156 1157 /* Set up default endpoint descriptor. */ 1158 dev->ud_ep0desc.bLength = USB_ENDPOINT_DESCRIPTOR_SIZE; 1159 dev->ud_ep0desc.bDescriptorType = UDESC_ENDPOINT; 1160 dev->ud_ep0desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 1161 dev->ud_ep0desc.bmAttributes = UE_CONTROL; 1162 /* 1163 * temporary, will be fixed after first descriptor fetch 1164 * (which uses 64 bytes so it shouldn't be less), 1165 * highspeed devices must support 64 byte packets anyway 1166 */ 1167 if (speed == USB_SPEED_HIGH || speed == USB_SPEED_FULL) 1168 USETW(dev->ud_ep0desc.wMaxPacketSize, 64); 1169 else 1170 USETW(dev->ud_ep0desc.wMaxPacketSize, USB_MAX_IPACKET); 1171 1172 dev->ud_ep0desc.bInterval = 0; 1173 1174 /* doesn't matter, just don't leave it uninitialized */ 1175 dev->ud_ep0.ue_toggle = 0; 1176 1177 dev->ud_quirks = &usbd_no_quirk; 1178 dev->ud_addr = USB_START_ADDR; 1179 dev->ud_ddesc.bMaxPacketSize = 0; 1180 dev->ud_depth = depth; 1181 dev->ud_powersrc = up; 1182 dev->ud_myhub = up->up_parent; 1183 1184 up->up_dev = dev; 1185 1186 /* Locate port on upstream high speed hub */ 1187 for (adev = dev, hub = up->up_parent; 1188 hub != NULL && hub->ud_speed != USB_SPEED_HIGH; 1189 adev = hub, hub = hub->ud_myhub) 1190 ; 1191 if (hub) { 1192 for (p = 1; p <= hub->ud_hub->uh_hubdesc.bNbrPorts; p++) { 1193 if (hub->ud_hub->uh_ports[p - 1].up_dev == adev) { 1194 dev->ud_myhsport = 1195 &hub->ud_hub->uh_ports[p - 1]; 1196 goto found; 1197 } 1198 } 1199 panic("usbd_new_device: cannot find HS port"); 1200 found: 1201 DPRINTFN(1, "high speed port %jd", p, 0, 0, 0); 1202 } else { 1203 dev->ud_myhsport = NULL; 1204 } 1205 dev->ud_speed = speed; 1206 dev->ud_langid = USBD_NOLANG; 1207 dev->ud_cookie.cookie = ++usb_cookie_no; 1208 1209 /* Establish the default pipe. */ 1210 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1211 &dev->ud_pipe0, USBD_MPSAFE); 1212 if (err) { 1213 usbd_remove_device(dev, up); 1214 return err; 1215 } 1216 1217 dd = &dev->ud_ddesc; 1218 /* Try a few times in case the device is slow (i.e. outside specs.) */ 1219 for (i = 0; i < 10; i++) { 1220 /* Get the first 8 bytes of the device descriptor. */ 1221 err = usbd_get_initial_ddesc(dev, dd); 1222 if (!err) 1223 break; 1224 /* 1225 * The root hub can never fail to give the initial descriptor, 1226 * but assert it just in case. 1227 */ 1228 KASSERT(up->up_parent); 1229 usbd_delay_ms(dev, 200); 1230 if ((i & 3) == 3) 1231 usbd_reset_port(up->up_parent, port, &ps); 1232 } 1233 if (err) { 1234 DPRINTF("addr=%jd, getting first desc failed: %jd", addr, err, 1235 0, 0); 1236 usbd_remove_device(dev, up); 1237 return err; 1238 } 1239 1240 /* Windows resets the port here, do likewise */ 1241 if (up->up_parent) 1242 usbd_reset_port(up->up_parent, port, &ps); 1243 1244 if (speed == USB_SPEED_HIGH) { 1245 /* Max packet size must be 64 (sec 5.5.3). */ 1246 if (dd->bMaxPacketSize != USB_2_MAX_CTRL_PACKET) { 1247 #ifdef DIAGNOSTIC 1248 printf("usbd_new_device: addr=%d bad max packet " 1249 "size=%d. adjusting to %d.\n", 1250 addr, dd->bMaxPacketSize, USB_2_MAX_CTRL_PACKET); 1251 #endif 1252 dd->bMaxPacketSize = USB_2_MAX_CTRL_PACKET; 1253 } 1254 } 1255 1256 DPRINTF("adding unit addr=%jd, rev=%02jx, class=%jd, subclass=%jd", 1257 addr, UGETW(dd->bcdUSB), dd->bDeviceClass, dd->bDeviceSubClass); 1258 DPRINTF("protocol=%jd, maxpacket=%jd, len=%jd, speed=%jd", 1259 dd->bDeviceProtocol, dd->bMaxPacketSize, dd->bLength, dev->ud_speed); 1260 1261 if (dd->bDescriptorType != UDESC_DEVICE) { 1262 /* Illegal device descriptor */ 1263 DPRINTF("illegal descriptor %jd", dd->bDescriptorType, 0, 0, 0); 1264 usbd_remove_device(dev, up); 1265 return USBD_INVAL; 1266 } 1267 1268 if (dd->bLength < USB_DEVICE_DESCRIPTOR_SIZE) { 1269 DPRINTF("bad length %jd", dd->bLength, 0, 0, 0); 1270 usbd_remove_device(dev, up); 1271 return USBD_INVAL; 1272 } 1273 1274 USETW(dev->ud_ep0desc.wMaxPacketSize, dd->bMaxPacketSize); 1275 1276 /* Re-establish the default pipe with the new MPS. */ 1277 usbd_kill_pipe(dev->ud_pipe0); 1278 dev->ud_pipe0 = NULL; 1279 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1280 &dev->ud_pipe0, USBD_MPSAFE); 1281 if (err) { 1282 DPRINTF("setup default pipe failed err %jd", err, 0, 0, 0); 1283 usbd_remove_device(dev, up); 1284 return err; 1285 } 1286 1287 /* Set the address */ 1288 DPRINTFN(5, "setting device address=%jd", addr, 0, 0, 0); 1289 err = usbd_set_address(dev, addr); 1290 if (err) { 1291 DPRINTF("set address %jd failed, err = %jd", addr, err, 0, 0); 1292 err = USBD_SET_ADDR_FAILED; 1293 usbd_remove_device(dev, up); 1294 return err; 1295 } 1296 1297 /* Allow device time to set new address */ 1298 usbd_delay_ms(dev, USB_SET_ADDRESS_SETTLE); 1299 dev->ud_addr = addr; /* new device address now */ 1300 bus->ub_devices[usb_addr2dindex(addr)] = dev; 1301 1302 /* Re-establish the default pipe with the new address. */ 1303 usbd_kill_pipe(dev->ud_pipe0); 1304 dev->ud_pipe0 = NULL; 1305 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1306 &dev->ud_pipe0, USBD_MPSAFE); 1307 if (err) { 1308 DPRINTF("setup default pipe failed, err = %jd", err, 0, 0, 0); 1309 usbd_remove_device(dev, up); 1310 return err; 1311 } 1312 1313 err = usbd_reload_device_desc(dev); 1314 if (err) { 1315 DPRINTF("addr=%jd, getting full desc failed, err = %jd", addr, 1316 err, 0, 0); 1317 usbd_remove_device(dev, up); 1318 return err; 1319 } 1320 1321 /* Assume 100mA bus powered for now. Changed when configured. */ 1322 dev->ud_power = USB_MIN_POWER; 1323 dev->ud_selfpowered = 0; 1324 1325 DPRINTF("new dev (addr %jd), dev=%#jx, parent=%#jx", 1326 addr, (uintptr_t)dev, (uintptr_t)parent, 0); 1327 1328 usbd_get_device_strings(dev); 1329 1330 usbd_add_dev_event(USB_EVENT_DEVICE_ATTACH, dev); 1331 1332 if (port == 0) { /* root hub */ 1333 KASSERT(addr == 1); 1334 usbd_attach_roothub(parent, dev); 1335 return USBD_NORMAL_COMPLETION; 1336 } 1337 1338 err = usbd_probe_and_attach(parent, dev, port, addr); 1339 if (err) { 1340 usbd_remove_device(dev, up); 1341 return err; 1342 } 1343 1344 return USBD_NORMAL_COMPLETION; 1345 } 1346 1347 usbd_status 1348 usbd_reload_device_desc(struct usbd_device *dev) 1349 { 1350 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 1351 usb_device_descriptor_t *udd = &dev->ud_ddesc; 1352 usbd_status err; 1353 1354 /* Get the full device descriptor. */ 1355 err = usbd_get_device_desc(dev, udd); 1356 if (err) 1357 return err; 1358 if (udd->bDescriptorType != UDESC_DEVICE) 1359 return USBD_INVAL; 1360 if (udd->bLength < USB_DEVICE_DESCRIPTOR_SIZE) 1361 return USBD_INVAL; 1362 1363 DPRINTFN(15, "bLength %5ju", udd->bLength, 0, 0, 0); 1364 DPRINTFN(15, "bDescriptorType %5ju", udd->bDescriptorType, 0, 0, 0); 1365 DPRINTFN(15, "bcdUSB %2jx.%02jx", udd->bcdUSB[1], 1366 udd->bcdUSB[0], 0, 0); 1367 DPRINTFN(15, "bDeviceClass %5ju", udd->bDeviceClass, 0, 0, 0); 1368 DPRINTFN(15, "bDeviceSubClass %5ju", udd->bDeviceSubClass, 0, 0, 0); 1369 DPRINTFN(15, "bDeviceProtocol %5ju", udd->bDeviceProtocol, 0, 0, 0); 1370 DPRINTFN(15, "bMaxPacketSize0 %5ju", udd->bMaxPacketSize, 0, 0, 0); 1371 DPRINTFN(15, "idVendor 0x%02jx 0x%02jx", 1372 udd->idVendor[0], 1373 udd->idVendor[1], 0, 0); 1374 DPRINTFN(15, "idProduct 0x%02jx 0x%02jx", 1375 udd->idProduct[0], 1376 udd->idProduct[1], 0, 0); 1377 DPRINTFN(15, "bcdDevice %2jx.%02jx", udd->bcdDevice[1], 1378 udd->bcdDevice[0], 0, 0); 1379 DPRINTFN(15, "iManufacturer %5ju", udd->iManufacturer, 0, 0, 0); 1380 DPRINTFN(15, "iProduct %5ju", udd->iProduct, 0, 0, 0); 1381 DPRINTFN(15, "iSerial %5ju", udd->iSerialNumber, 0, 0, 0); 1382 DPRINTFN(15, "bNumConfigurations %5ju", udd->bNumConfigurations, 0, 0, 1383 0); 1384 1385 /* Figure out what's wrong with this device. */ 1386 dev->ud_quirks = usbd_find_quirk(udd); 1387 1388 return USBD_NORMAL_COMPLETION; 1389 } 1390 1391 void 1392 usbd_remove_device(struct usbd_device *dev, struct usbd_port *up) 1393 { 1394 1395 USBHIST_FUNC(); 1396 USBHIST_CALLARGS(usbdebug, "dev %#jx up %#jx", 1397 (uintptr_t)dev, (uintptr_t)up, 0, 0); 1398 1399 if (dev->ud_pipe0 != NULL) 1400 usbd_kill_pipe(dev->ud_pipe0); 1401 up->up_dev = NULL; 1402 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL; 1403 1404 if (dev->ud_vendor != NULL) { 1405 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN); 1406 } 1407 if (dev->ud_product != NULL) { 1408 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN); 1409 } 1410 if (dev->ud_serial != NULL) { 1411 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN); 1412 } 1413 kmem_free(dev, sizeof(*dev)); 1414 } 1415 1416 int 1417 usbd_print(void *aux, const char *pnp) 1418 { 1419 struct usb_attach_arg *uaa = aux; 1420 1421 if (pnp) { 1422 #define USB_DEVINFO 1024 1423 char *devinfo; 1424 if (!uaa->uaa_usegeneric) 1425 return QUIET; 1426 devinfo = kmem_alloc(USB_DEVINFO, KM_SLEEP); 1427 usbd_devinfo(uaa->uaa_device, 1, devinfo, USB_DEVINFO); 1428 aprint_normal("%s, %s", devinfo, pnp); 1429 kmem_free(devinfo, USB_DEVINFO); 1430 } 1431 aprint_normal(" port %d", uaa->uaa_port); 1432 #if 0 1433 /* 1434 * It gets very crowded with these locators on the attach line. 1435 * They are not really needed since they are printed in the clear 1436 * by each driver. 1437 */ 1438 if (uaa->uaa_vendor != UHUB_UNK_VENDOR) 1439 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor); 1440 if (uaa->uaa_product != UHUB_UNK_PRODUCT) 1441 aprint_normal(" product 0x%04x", uaa->uaa_product); 1442 if (uaa->uaa_release != UHUB_UNK_RELEASE) 1443 aprint_normal(" release 0x%04x", uaa->uaa_release); 1444 #endif 1445 return UNCONF; 1446 } 1447 1448 int 1449 usbd_ifprint(void *aux, const char *pnp) 1450 { 1451 struct usbif_attach_arg *uiaa = aux; 1452 1453 if (pnp) 1454 return QUIET; 1455 aprint_normal(" port %d", uiaa->uiaa_port); 1456 aprint_normal(" configuration %d", uiaa->uiaa_configno); 1457 aprint_normal(" interface %d", uiaa->uiaa_ifaceno); 1458 #if 0 1459 /* 1460 * It gets very crowded with these locators on the attach line. 1461 * They are not really needed since they are printed in the clear 1462 * by each driver. 1463 */ 1464 if (uaa->uaa_vendor != UHUB_UNK_VENDOR) 1465 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor); 1466 if (uaa->uaa_product != UHUB_UNK_PRODUCT) 1467 aprint_normal(" product 0x%04x", uaa->uaa_product); 1468 if (uaa->uaa_release != UHUB_UNK_RELEASE) 1469 aprint_normal(" release 0x%04x", uaa->uaa_release); 1470 #endif 1471 return UNCONF; 1472 } 1473 1474 void 1475 usbd_fill_deviceinfo(struct usbd_device *dev, struct usb_device_info *di, 1476 int usedev) 1477 { 1478 struct usbd_port *p; 1479 int i, j, err; 1480 1481 di->udi_bus = device_unit(dev->ud_bus->ub_usbctl); 1482 di->udi_addr = dev->ud_addr; 1483 di->udi_cookie = dev->ud_cookie; 1484 usbd_devinfo_vp(dev, di->udi_vendor, sizeof(di->udi_vendor), 1485 di->udi_product, sizeof(di->udi_product), usedev, 1); 1486 usbd_printBCD(di->udi_release, sizeof(di->udi_release), 1487 UGETW(dev->ud_ddesc.bcdDevice)); 1488 if (usedev) { 1489 usbd_status uerr = usbd_get_string(dev, 1490 dev->ud_ddesc.iSerialNumber, di->udi_serial); 1491 if (uerr != USBD_NORMAL_COMPLETION) { 1492 di->udi_serial[0] = '\0'; 1493 } else { 1494 usbd_trim_spaces(di->udi_serial); 1495 } 1496 } else { 1497 di->udi_serial[0] = '\0'; 1498 if (dev->ud_serial) { 1499 strlcpy(di->udi_serial, dev->ud_serial, 1500 sizeof(di->udi_serial)); 1501 } 1502 } 1503 1504 di->udi_vendorNo = UGETW(dev->ud_ddesc.idVendor); 1505 di->udi_productNo = UGETW(dev->ud_ddesc.idProduct); 1506 di->udi_releaseNo = UGETW(dev->ud_ddesc.bcdDevice); 1507 di->udi_class = dev->ud_ddesc.bDeviceClass; 1508 di->udi_subclass = dev->ud_ddesc.bDeviceSubClass; 1509 di->udi_protocol = dev->ud_ddesc.bDeviceProtocol; 1510 di->udi_config = dev->ud_config; 1511 di->udi_power = dev->ud_selfpowered ? 0 : dev->ud_power; 1512 di->udi_speed = dev->ud_speed; 1513 1514 if (dev->ud_subdevlen > 0) { 1515 for (i = 0, j = 0; i < dev->ud_subdevlen && 1516 j < USB_MAX_DEVNAMES; i++) { 1517 if (!dev->ud_subdevs[i]) 1518 continue; 1519 strncpy(di->udi_devnames[j], 1520 device_xname(dev->ud_subdevs[i]), USB_MAX_DEVNAMELEN); 1521 di->udi_devnames[j][USB_MAX_DEVNAMELEN-1] = '\0'; 1522 j++; 1523 } 1524 } else { 1525 j = 0; 1526 } 1527 for (/* j is set */; j < USB_MAX_DEVNAMES; j++) 1528 di->udi_devnames[j][0] = 0; /* empty */ 1529 1530 if (!dev->ud_hub) { 1531 di->udi_nports = 0; 1532 return; 1533 } 1534 1535 const int nports = dev->ud_hub->uh_hubdesc.bNbrPorts; 1536 for (i = 1; i <= __arraycount(di->udi_ports) && i <= nports; i++) { 1537 p = &dev->ud_hub->uh_ports[i - 1]; 1538 if (p->up_dev) 1539 err = p->up_dev->ud_addr; 1540 else { 1541 const int s = UGETW(p->up_status.wPortStatus); 1542 const bool sshub_p = USB_IS_SS(dev->ud_speed); 1543 if (s & UPS_PORT_ENABLED) 1544 err = USB_PORT_ENABLED; 1545 else if (s & UPS_SUSPEND) 1546 err = USB_PORT_SUSPENDED; 1547 /* 1548 * Note: UPS_PORT_POWER_SS is available only 1549 * on 3.x, and UPS_PORT_POWER is available 1550 * only on 2.0 or 1.1. 1551 */ 1552 else if (sshub_p && (s & UPS_PORT_POWER_SS)) 1553 err = USB_PORT_POWERED; 1554 else if (!sshub_p && (s & UPS_PORT_POWER)) 1555 err = USB_PORT_POWERED; 1556 else 1557 err = USB_PORT_DISABLED; 1558 } 1559 di->udi_ports[i - 1] = err; 1560 } 1561 di->udi_nports = nports; 1562 } 1563 1564 void 1565 usb_free_device(struct usbd_device *dev) 1566 { 1567 int ifcidx, nifc; 1568 1569 if (dev->ud_pipe0 != NULL) 1570 usbd_kill_pipe(dev->ud_pipe0); 1571 if (dev->ud_ifaces != NULL) { 1572 nifc = dev->ud_cdesc->bNumInterface; 1573 for (ifcidx = 0; ifcidx < nifc; ifcidx++) 1574 usbd_free_iface_data(dev, ifcidx); 1575 kmem_free(dev->ud_ifaces, 1576 nifc * sizeof(struct usbd_interface)); 1577 } 1578 if (dev->ud_cdesc != NULL) 1579 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength)); 1580 if (dev->ud_bdesc != NULL) 1581 kmem_free(dev->ud_bdesc, UGETW(dev->ud_bdesc->wTotalLength)); 1582 if (dev->ud_subdevlen > 0) { 1583 kmem_free(dev->ud_subdevs, 1584 dev->ud_subdevlen * sizeof(device_t)); 1585 dev->ud_subdevlen = 0; 1586 } 1587 if (dev->ud_vendor) { 1588 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN); 1589 } 1590 if (dev->ud_product) { 1591 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN); 1592 } 1593 if (dev->ud_serial) { 1594 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN); 1595 } 1596 kmem_free(dev, sizeof(*dev)); 1597 } 1598 1599 /* 1600 * The general mechanism for detaching drivers works as follows: Each 1601 * driver is responsible for maintaining a reference count on the 1602 * number of outstanding references to its softc (e.g. from 1603 * processing hanging in a read or write). The detach method of the 1604 * driver decrements this counter and flags in the softc that the 1605 * driver is dying and then wakes any sleepers. It then sleeps on the 1606 * softc. Each place that can sleep must maintain the reference 1607 * count. When the reference count drops to -1 (0 is the normal value 1608 * of the reference count) then a wakeup on the softc is performed 1609 * signaling to the detach waiter that all references are gone. 1610 */ 1611 1612 /* 1613 * Called from process context when we discover that a port has 1614 * been disconnected. 1615 */ 1616 int 1617 usb_disconnect_port(struct usbd_port *up, device_t parent, int flags) 1618 { 1619 struct usbd_device *dev = up->up_dev; 1620 device_t subdev; 1621 char subdevname[16]; 1622 const char *hubname = device_xname(parent); 1623 int i, rc; 1624 1625 USBHIST_FUNC(); 1626 USBHIST_CALLARGS(usbdebug, "up=%#jx dev=%#jx port=%jd", 1627 (uintptr_t)up, (uintptr_t)dev, up->up_portno, 0); 1628 1629 if (dev == NULL) { 1630 return 0; 1631 } 1632 1633 if (dev->ud_subdevlen > 0) { 1634 DPRINTFN(3, "disconnect subdevs", 0, 0, 0, 0); 1635 for (i = 0; i < dev->ud_subdevlen; i++) { 1636 if ((subdev = dev->ud_subdevs[i]) == NULL) 1637 continue; 1638 strlcpy(subdevname, device_xname(subdev), 1639 sizeof(subdevname)); 1640 KERNEL_LOCK(1, curlwp); 1641 rc = config_detach(subdev, flags); 1642 KERNEL_UNLOCK_ONE(curlwp); 1643 if (rc != 0) 1644 return rc; 1645 printf("%s: at %s", subdevname, hubname); 1646 if (up->up_portno != 0) 1647 printf(" port %d", up->up_portno); 1648 printf(" (addr %d) disconnected\n", dev->ud_addr); 1649 } 1650 KASSERT(!dev->ud_nifaces_claimed); 1651 } 1652 1653 mutex_enter(dev->ud_bus->ub_lock); 1654 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL; 1655 up->up_dev = NULL; 1656 mutex_exit(dev->ud_bus->ub_lock); 1657 1658 usbd_add_dev_event(USB_EVENT_DEVICE_DETACH, dev); 1659 1660 usb_free_device(dev); 1661 1662 return 0; 1663 } 1664