1/* $NetBSD: usb_subr.c,v 1.279 2024/05/04 12:45:13 mlelstv 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.279 2024/05/04 12:45:13 mlelstv 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 69Static void usbd_devinfo(struct usbd_device *, int, char *, size_t); 70Static int usbd_getnewaddr(struct usbd_bus *); 71Static int usbd_print(void *, const char *); 72Static int usbd_ifprint(void *, const char *); 73Static void usbd_free_iface_data(struct usbd_device *, int); 74 75uint32_t usb_cookie_no = 0; 76 77Static 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 100DEV_VERBOSE_DEFINE(usb); 101 102const char * 103usbd_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 115static void 116usbd_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 129static void 130usbd_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 147void 148usbd_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 158void 159usbd_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 190int 191usbd_printBCD(char *cp, size_t l, int bcd) 192{ 193 return snprintf(cp, l, "%x.%02x", bcd >> 8, bcd & 0xff); 194} 195 196Static void 197usbd_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 227char * 228usbd_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 237void 238usbd_devinfo_free(char *devinfop) 239{ 240 kmem_free(devinfop, DEVINFOSIZE); 241} 242 243/* Delay for a certain number of ms */ 244void 245usb_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 254void 255usb_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. */ 261void 262usbd_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. */ 268void 269usbd_delay_ms(struct usbd_device *dev, u_int ms) 270{ 271 usb_delay_ms_locked(dev->ud_bus, ms, NULL); 272} 273 274usbd_status 275usbd_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 317usb_interface_descriptor_t * 318usbd_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; end - p >= sizeof(*desc);) { 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 if (desc->bLength > end - p) 340 break; 341 p += desc->bLength; 342 343 if (desc->bDescriptorType != UDESC_INTERFACE) 344 continue; 345 if (desc->bLength < USB_INTERFACE_DESCRIPTOR_SIZE) 346 break; 347 idesc = (usb_interface_descriptor_t *)desc; 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 363usb_endpoint_descriptor_t * 364usbd_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; end - p >= sizeof(*edesc);) { 382 desc = (usb_descriptor_t *)p; 383 384 if (desc->bLength < USB_DESCRIPTOR_SIZE) 385 break; 386 if (desc->bLength > end - p) 387 break; 388 p += desc->bLength; 389 390 if (desc->bDescriptorType == UDESC_INTERFACE) 391 break; 392 if (desc->bDescriptorType != UDESC_ENDPOINT) 393 continue; 394 395 if (desc->bLength < USB_ENDPOINT_DESCRIPTOR_SIZE) 396 break; 397 edesc = (usb_endpoint_descriptor_t *)desc; 398 399 curidx++; 400 if (curidx == endptidx) 401 return edesc; 402 } 403 return NULL; 404} 405 406static void 407usbd_iface_init(struct usbd_device *dev, int ifaceidx) 408{ 409 struct usbd_interface *ifc = &dev->ud_ifaces[ifaceidx]; 410 411 memset(ifc, 0, sizeof(*ifc)); 412 413 ifc->ui_dev = dev; 414 ifc->ui_idesc = NULL; 415 ifc->ui_index = 0; 416 ifc->ui_altindex = 0; 417 ifc->ui_endpoints = NULL; 418 ifc->ui_busy = 0; 419} 420 421static void 422usbd_iface_fini(struct usbd_device *dev, int ifaceidx) 423{ 424 struct usbd_interface *ifc __diagused = &dev->ud_ifaces[ifaceidx]; 425 426 KASSERT(ifc->ui_dev == dev); 427 KASSERT(ifc->ui_idesc == NULL); 428 KASSERT(ifc->ui_index == 0); 429 KASSERT(ifc->ui_altindex == 0); 430 KASSERT(ifc->ui_endpoints == NULL); 431 KASSERTMSG(ifc->ui_busy == 0, "%"PRId64, ifc->ui_busy); 432} 433 434/* 435 * usbd_iface_lock/locked/unlock, usbd_iface_piperef/pipeunref 436 * 437 * We lock the interface while we are setting it, and we acquire a 438 * reference to the interface for each pipe opened on it. 439 * 440 * Setting the interface while pipes are open is forbidden, and 441 * opening pipes while the interface is being set is forbidden. 442 */ 443 444bool 445usbd_iface_locked(struct usbd_interface *iface) 446{ 447 bool locked; 448 449 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 450 locked = (iface->ui_busy == -1); 451 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 452 453 return locked; 454} 455 456static void 457usbd_iface_exlock(struct usbd_interface *iface) 458{ 459 460 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 461 KASSERTMSG(iface->ui_busy == 0, "interface is not idle," 462 " busy=%"PRId64, iface->ui_busy); 463 iface->ui_busy = -1; 464 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 465} 466 467usbd_status 468usbd_iface_lock(struct usbd_interface *iface) 469{ 470 usbd_status err; 471 472 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 473 KASSERTMSG(iface->ui_busy != -1, "interface is locked"); 474 KASSERTMSG(iface->ui_busy >= 0, "%"PRId64, iface->ui_busy); 475 if (iface->ui_busy) { 476 err = USBD_IN_USE; 477 } else { 478 iface->ui_busy = -1; 479 err = 0; 480 } 481 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 482 483 return err; 484} 485 486void 487usbd_iface_unlock(struct usbd_interface *iface) 488{ 489 490 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 491 KASSERTMSG(iface->ui_busy == -1, "interface is not locked," 492 " busy=%"PRId64, iface->ui_busy); 493 iface->ui_busy = 0; 494 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 495} 496 497usbd_status 498usbd_iface_piperef(struct usbd_interface *iface) 499{ 500 usbd_status err; 501 502 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 503 KASSERTMSG(iface->ui_busy >= -1, "%"PRId64, iface->ui_busy); 504 if (iface->ui_busy == -1) { 505 err = USBD_IN_USE; 506 } else { 507 iface->ui_busy++; 508 err = 0; 509 } 510 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 511 512 return err; 513} 514 515void 516usbd_iface_pipeunref(struct usbd_interface *iface) 517{ 518 519 mutex_enter(iface->ui_dev->ud_bus->ub_lock); 520 KASSERTMSG(iface->ui_busy != -1, "interface is locked"); 521 KASSERTMSG(iface->ui_busy != 0, "interface not in use"); 522 KASSERTMSG(iface->ui_busy >= 1, "%"PRId64, iface->ui_busy); 523 iface->ui_busy--; 524 mutex_exit(iface->ui_dev->ud_bus->ub_lock); 525} 526 527usbd_status 528usbd_fill_iface_data(struct usbd_device *dev, int ifaceidx, int altidx) 529{ 530 USBHIST_FUNC(); 531 USBHIST_CALLARGS(usbdebug, "ifaceidx=%jd altidx=%jd", 532 ifaceidx, altidx, 0, 0); 533 struct usbd_interface *ifc = &dev->ud_ifaces[ifaceidx]; 534 usb_descriptor_t *desc; 535 usb_interface_descriptor_t *idesc; 536 usb_endpoint_descriptor_t *ed; 537 struct usbd_endpoint *endpoints; 538 char *p, *end; 539 int endpt, nendpt; 540 541 KASSERT(ifc->ui_dev == dev); 542 KASSERT(usbd_iface_locked(ifc)); 543 544 idesc = usbd_find_idesc(dev->ud_cdesc, ifaceidx, altidx); 545 if (idesc == NULL) 546 return USBD_INVAL; 547 548 nendpt = idesc->bNumEndpoints; 549 DPRINTFN(4, "found idesc nendpt=%jd", nendpt, 0, 0, 0); 550 if (nendpt != 0) { 551 endpoints = kmem_alloc(nendpt * sizeof(struct usbd_endpoint), 552 KM_SLEEP); 553 } else 554 endpoints = NULL; 555 556 p = (char *)idesc + idesc->bLength; 557 end = (char *)dev->ud_cdesc + UGETW(dev->ud_cdesc->wTotalLength); 558 KASSERTMSG((char *)dev->ud_cdesc <= (char *)idesc, "cdesc=%p idesc=%p", 559 dev->ud_cdesc, idesc); 560 KASSERTMSG((char *)idesc < end, "idesc=%p end=%p", idesc, end); 561 for (endpt = 0; endpt < nendpt; endpt++) { 562 DPRINTFN(10, "endpt=%jd", endpt, 0, 0, 0); 563 for (; end - p >= sizeof(*desc); p += desc->bLength) { 564 desc = (usb_descriptor_t *)p; 565 DPRINTFN(10, "p=%#jx end=%#jx len=%jd type=%jd", 566 (uintptr_t)p, (uintptr_t)end, desc->bLength, 567 desc->bDescriptorType); 568 if (desc->bLength < sizeof(*desc)) { 569 printf("%s: bad descriptor: too short\n", 570 __func__); 571 goto bad; 572 } else if (desc->bLength > end - p) { 573 printf("%s: bad descriptor: too long\n", 574 __func__); 575 goto bad; 576 } else if (desc->bDescriptorType == UDESC_INTERFACE) { 577 printf("%s: bad descriptor: iface desc\n", 578 __func__); 579 goto bad; 580 } 581 if (desc->bLength >= USB_ENDPOINT_DESCRIPTOR_SIZE && 582 desc->bDescriptorType == UDESC_ENDPOINT) { 583 ed = (usb_endpoint_descriptor_t *)p; 584 goto found; 585 } 586 } 587 printf("%s: no desc found\n", __func__); 588 goto bad; 589 found: 590 endpoints[endpt].ue_edesc = ed; 591 if (dev->ud_speed == USB_SPEED_HIGH) { 592 u_int mps; 593 /* Control and bulk endpoints have max packet limits. */ 594 switch (UE_GET_XFERTYPE(ed->bmAttributes)) { 595 case UE_CONTROL: 596 mps = USB_2_MAX_CTRL_PACKET; 597 goto check; 598 case UE_BULK: 599 mps = USB_2_MAX_BULK_PACKET; 600 check: 601 if (UGETW(ed->wMaxPacketSize) != mps) { 602 USETW(ed->wMaxPacketSize, mps); 603#ifdef DIAGNOSTIC 604 printf("usbd_fill_iface_data: bad max " 605 "packet size\n"); 606#endif 607 } 608 break; 609 default: 610 break; 611 } 612 } 613 endpoints[endpt].ue_refcnt = 0; 614 endpoints[endpt].ue_toggle = 0; 615 KASSERTMSG(end - p >= ed->bLength, "p=%p end=%p length=%u", 616 p, end, ed->bLength); 617 p += ed->bLength; 618 } 619#undef ed 620 621 /* Success! Free the old endpoints and commit the changes. */ 622 if (ifc->ui_endpoints) { 623 kmem_free(ifc->ui_endpoints, (sizeof(ifc->ui_endpoints[0]) * 624 ifc->ui_idesc->bNumEndpoints)); 625 } 626 627 ifc->ui_idesc = idesc; 628 ifc->ui_index = ifaceidx; 629 ifc->ui_altindex = altidx; 630 ifc->ui_endpoints = endpoints; 631 632 return USBD_NORMAL_COMPLETION; 633 634 bad: 635 if (endpoints) 636 kmem_free(endpoints, nendpt * sizeof(struct usbd_endpoint)); 637 return USBD_INVAL; 638} 639 640Static void 641usbd_free_iface_data(struct usbd_device *dev, int ifcno) 642{ 643 struct usbd_interface *ifc = &dev->ud_ifaces[ifcno]; 644 645 KASSERT(ifc->ui_dev == dev); 646 KASSERT(ifc->ui_idesc != NULL); 647 KASSERT(usbd_iface_locked(ifc)); 648 649 if (ifc->ui_endpoints) { 650 int nendpt = ifc->ui_idesc->bNumEndpoints; 651 size_t sz = nendpt * sizeof(struct usbd_endpoint); 652 kmem_free(ifc->ui_endpoints, sz); 653 ifc->ui_endpoints = NULL; 654 } 655 656 ifc->ui_altindex = 0; 657 ifc->ui_index = 0; 658 ifc->ui_idesc = NULL; 659} 660 661usbd_status 662usbd_set_config_no(struct usbd_device *dev, int no, int msg) 663{ 664 USBHIST_FUNC(); USBHIST_CALLARGS(usbdebug, "%jd", no, 0, 0, 0); 665 usb_config_descriptor_t cd; 666 usbd_status err; 667 int index; 668 669 if (no == USB_UNCONFIG_NO) 670 return usbd_set_config_index(dev, USB_UNCONFIG_INDEX, msg); 671 672 /* Figure out what config index to use. */ 673 for (index = 0; index < dev->ud_ddesc.bNumConfigurations; index++) { 674 err = usbd_get_config_desc(dev, index, &cd); 675 if (err) 676 return err; 677 if (cd.bConfigurationValue == no) 678 return usbd_set_config_index(dev, index, msg); 679 } 680 return USBD_INVAL; 681} 682 683usbd_status 684usbd_set_config_index(struct usbd_device *dev, int index, int msg) 685{ 686 USBHIST_FUNC(); 687 USBHIST_CALLARGS(usbdebug, "dev=%#jx index=%jd", 688 (uintptr_t)dev, index, 0, 0); 689 usb_config_descriptor_t cd, *cdp; 690 usb_bos_descriptor_t *bdp = NULL; 691 usbd_status err; 692 int i, ifcidx, nifc, len, selfpowered, power; 693 694 695 if (index >= dev->ud_ddesc.bNumConfigurations && 696 index != USB_UNCONFIG_INDEX) { 697 /* panic? */ 698 printf("usbd_set_config_index: illegal index\n"); 699 return USBD_INVAL; 700 } 701 702 /* XXX check that all interfaces are idle */ 703 if (dev->ud_config != USB_UNCONFIG_NO) { 704 DPRINTF("free old config", 0, 0, 0, 0); 705 /* Free all configuration data structures. */ 706 nifc = dev->ud_cdesc->bNumInterface; 707 for (ifcidx = 0; ifcidx < nifc; ifcidx++) { 708 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]); 709 usbd_free_iface_data(dev, ifcidx); 710 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]); 711 usbd_iface_fini(dev, ifcidx); 712 } 713 kmem_free(dev->ud_ifaces, nifc * sizeof(struct usbd_interface)); 714 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength)); 715 if (dev->ud_bdesc != NULL) 716 kmem_free(dev->ud_bdesc, 717 UGETW(dev->ud_bdesc->wTotalLength)); 718 dev->ud_ifaces = NULL; 719 dev->ud_cdesc = NULL; 720 dev->ud_bdesc = NULL; 721 dev->ud_config = USB_UNCONFIG_NO; 722 } 723 724 if (index == USB_UNCONFIG_INDEX) { 725 /* We are unconfiguring the device, so leave unallocated. */ 726 DPRINTF("set config 0", 0, 0, 0, 0); 727 err = usbd_set_config(dev, USB_UNCONFIG_NO); 728 if (err) { 729 DPRINTF("setting config=0 failed, err = %jd", err, 730 0, 0, 0); 731 } 732 return err; 733 } 734 735 /* Get the short descriptor. */ 736 err = usbd_get_config_desc(dev, index, &cd); 737 if (err) { 738 DPRINTF("get_config_desc=%jd", err, 0, 0, 0); 739 return err; 740 } 741 len = UGETW(cd.wTotalLength); 742 if (len < USB_CONFIG_DESCRIPTOR_SIZE) { 743 DPRINTF("empty short descriptor", 0, 0, 0, 0); 744 return USBD_INVAL; 745 } 746 cdp = kmem_alloc(len, KM_SLEEP); 747 748 /* Get the full descriptor. Try a few times for slow devices. */ 749 for (i = 0; i < 3; i++) { 750 err = usbd_get_desc(dev, UDESC_CONFIG, index, len, cdp); 751 if (!err) 752 break; 753 usbd_delay_ms(dev, 200); 754 } 755 if (err) { 756 DPRINTF("get_desc=%jd", err, 0, 0, 0); 757 goto bad; 758 } 759 if (cdp->bDescriptorType != UDESC_CONFIG) { 760 DPRINTF("bad desc %jd", cdp->bDescriptorType, 0, 0, 0); 761 err = USBD_INVAL; 762 goto bad; 763 } 764 if (UGETW(cdp->wTotalLength) != UGETW(cd.wTotalLength)) { 765 DPRINTF("bad len %jd", UGETW(cdp->wTotalLength), 0, 0, 0); 766 err = USBD_INVAL; 767 goto bad; 768 } 769 770 if (USB_IS_SS(dev->ud_speed)) { 771 usb_bos_descriptor_t bd; 772 773 /* get short bos desc */ 774 err = usbd_get_bos_desc(dev, index, &bd); 775 if (!err) { 776 int blen = UGETW(bd.wTotalLength); 777 if (blen < USB_BOS_DESCRIPTOR_SIZE) { 778 DPRINTF("empty bos descriptor", 0, 0, 0, 0); 779 err = USBD_INVAL; 780 goto bad; 781 } 782 bdp = kmem_alloc(blen, KM_SLEEP); 783 784 /* Get the full desc */ 785 for (i = 0; i < 3; i++) { 786 err = usbd_get_desc(dev, UDESC_BOS, index, blen, 787 bdp); 788 if (!err) 789 break; 790 usbd_delay_ms(dev, 200); 791 } 792 if (err || bdp->bDescriptorType != UDESC_BOS || 793 UGETW(bdp->wTotalLength) != UGETW(bd.wTotalLength)) { 794 DPRINTF("error %jd or bad desc %jd", err, 795 bdp->bDescriptorType, 0, 0); 796 kmem_free(bdp, blen); 797 bdp = NULL; 798 } 799 } 800 } 801 dev->ud_bdesc = bdp; 802 803 /* 804 * Figure out if the device is self or bus powered. 805 */ 806#if 0 /* XXX various devices don't report the power state correctly */ 807 selfpowered = 0; 808 err = usbd_get_device_status(dev, &ds); 809 if (!err && (UGETW(ds.wStatus) & UDS_SELF_POWERED)) 810 selfpowered = 1; 811#endif 812 /* 813 * Use the power state in the configuration we are going 814 * to set. This doesn't necessarily reflect the actual 815 * power state of the device; the driver can control this 816 * by choosing the appropriate configuration. 817 */ 818 selfpowered = !!(cdp->bmAttributes & UC_SELF_POWERED); 819 820 DPRINTF("addr %jd cno=%jd attr=0x%02jx, selfpowered=%jd", 821 dev->ud_addr, cdp->bConfigurationValue, cdp->bmAttributes, 822 selfpowered); 823 DPRINTF("max power=%jd", cdp->bMaxPower * 2, 0, 0, 0); 824 825 /* Check if we have enough power. */ 826#if 0 /* this is a no-op, see above */ 827 if ((cdp->bmAttributes & UC_SELF_POWERED) && !selfpowered) { 828 if (msg) 829 printf("%s: device addr %d (config %d): " 830 "can't set self powered configuration\n", 831 device_xname(dev->ud_bus->bdev), dev->ud_addr, 832 cdp->bConfigurationValue); 833 err = USBD_NO_POWER; 834 goto bad; 835 } 836#endif 837#ifdef USB_DEBUG 838 if (dev->ud_powersrc == NULL) { 839 DPRINTF("No power source?", 0, 0, 0, 0); 840 err = USBD_IOERROR; 841 goto bad; 842 } 843#endif 844 power = cdp->bMaxPower * 2; 845 if (power > dev->ud_powersrc->up_power) { 846 DPRINTF("power exceeded %jd %jd", power, 847 dev->ud_powersrc->up_power, 0, 0); 848 /* XXX print nicer message. */ 849 if (msg) 850 printf("%s: device addr %d (config %d) exceeds power " 851 "budget, %d mA > %d mA\n", 852 device_xname(dev->ud_bus->ub_usbctl), dev->ud_addr, 853 cdp->bConfigurationValue, 854 power, dev->ud_powersrc->up_power); 855 err = USBD_NO_POWER; 856 goto bad; 857 } 858 dev->ud_power = power; 859 dev->ud_selfpowered = selfpowered; 860 861 /* Set the actual configuration value. */ 862 DPRINTF("set config %jd", cdp->bConfigurationValue, 0, 0, 0); 863 err = usbd_set_config(dev, cdp->bConfigurationValue); 864 if (err) { 865 DPRINTF("setting config=%jd failed, error=%jd", 866 cdp->bConfigurationValue, err, 0, 0); 867 goto bad; 868 } 869 870 KASSERTMSG(dev->ud_ifaces == NULL, "ud_ifaces=%p", dev->ud_ifaces); 871 872 /* Allocate and fill interface data. */ 873 nifc = cdp->bNumInterface; 874 if (nifc == 0) { 875 DPRINTF("no interfaces", 0, 0, 0, 0); 876 err = USBD_INVAL; 877 goto bad; 878 } 879 dev->ud_ifaces = kmem_alloc(nifc * sizeof(struct usbd_interface), 880 KM_SLEEP); 881 DPRINTFN(5, "dev=%#jx cdesc=%#jx", (uintptr_t)dev, (uintptr_t)cdp, 882 0, 0); 883 dev->ud_cdesc = cdp; 884 dev->ud_config = cdp->bConfigurationValue; 885 for (ifcidx = 0; ifcidx < nifc; ifcidx++) { 886 usbd_iface_init(dev, ifcidx); 887 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]); 888 err = usbd_fill_iface_data(dev, ifcidx, 0); 889 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]); 890 if (err) { 891 while (--ifcidx >= 0) { 892 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]); 893 usbd_free_iface_data(dev, ifcidx); 894 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]); 895 usbd_iface_fini(dev, ifcidx); 896 } 897 kmem_free(dev->ud_ifaces, 898 nifc * sizeof(struct usbd_interface)); 899 dev->ud_ifaces = NULL; 900 goto bad; 901 } 902 } 903 904 return USBD_NORMAL_COMPLETION; 905 906bad: 907 /* XXX Use usbd_set_config() to reset the config? */ 908 /* XXX Should we forbid USB_UNCONFIG_NO from bConfigurationValue? */ 909 dev->ud_config = USB_UNCONFIG_NO; 910 KASSERT(dev->ud_ifaces == NULL); 911 kmem_free(cdp, len); 912 dev->ud_cdesc = NULL; 913 if (bdp != NULL) { 914 kmem_free(bdp, UGETW(bdp->wTotalLength)); 915 dev->ud_bdesc = NULL; 916 } 917 return err; 918} 919 920/* XXX add function for alternate settings */ 921 922usbd_status 923usbd_setup_pipe(struct usbd_device *dev, struct usbd_interface *iface, 924 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe) 925{ 926 return usbd_setup_pipe_flags(dev, iface, ep, ival, pipe, 0); 927} 928 929usbd_status 930usbd_setup_pipe_flags(struct usbd_device *dev, struct usbd_interface *iface, 931 struct usbd_endpoint *ep, int ival, struct usbd_pipe **pipe, uint8_t flags) 932{ 933 USBHIST_FUNC(); 934 USBHIST_CALLARGS(usbdebug, "dev=%#jx addr=%jd iface=%#jx ep=%#jx", 935 (uintptr_t)dev, dev->ud_addr, (uintptr_t)iface, (uintptr_t)ep); 936 struct usbd_pipe *p = NULL; 937 bool ep_acquired = false; 938 usbd_status err; 939 940 /* Block exclusive use of the endpoint by later pipes. */ 941 err = usbd_endpoint_acquire(dev, ep, flags & USBD_EXCLUSIVE_USE); 942 if (err) 943 goto out; 944 ep_acquired = true; 945 946 p = kmem_alloc(dev->ud_bus->ub_pipesize, KM_SLEEP); 947 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0); 948 p->up_dev = dev; 949 p->up_iface = iface; 950 p->up_endpoint = ep; 951 p->up_intrxfer = NULL; 952 p->up_running = 0; 953 p->up_aborting = 0; 954 p->up_serialise = true; 955 p->up_repeat = 0; 956 p->up_interval = ival; 957 p->up_flags = flags; 958 SIMPLEQ_INIT(&p->up_queue); 959 p->up_callingxfer = NULL; 960 cv_init(&p->up_callingcv, "usbpipecb"); 961 p->up_abortlwp = NULL; 962 963 err = dev->ud_bus->ub_methods->ubm_open(p); 964 if (err) { 965 DPRINTF("endpoint=%#jx failed, error=%jd", 966 (uintptr_t)ep->ue_edesc->bEndpointAddress, err, 0, 0); 967 goto out; 968 } 969 970 KASSERT(p->up_methods->upm_start || p->up_serialise == false); 971 972 usb_init_task(&p->up_async_task, usbd_clear_endpoint_stall_task, p, 973 USB_TASKQ_MPSAFE); 974 DPRINTFN(1, "pipe=%#jx", (uintptr_t)p, 0, 0, 0); 975 *pipe = p; 976 p = NULL; /* handed off to caller */ 977 ep_acquired = false; /* handed off to pipe */ 978 err = USBD_NORMAL_COMPLETION; 979 980out: if (p) { 981 KASSERT(p->up_abortlwp == NULL); 982 KASSERT(p->up_callingxfer == NULL); 983 cv_destroy(&p->up_callingcv); 984 kmem_free(p, dev->ud_bus->ub_pipesize); 985 } 986 if (ep_acquired) 987 usbd_endpoint_release(dev, ep); 988 return err; 989} 990 991usbd_status 992usbd_endpoint_acquire(struct usbd_device *dev, struct usbd_endpoint *ep, 993 int flags) 994{ 995 usbd_status err; 996 997 mutex_enter(dev->ud_bus->ub_lock); 998 if (ep->ue_refcnt == INT_MAX) { 999 err = USBD_IN_USE; /* XXX rule out or switch to 64-bit */ 1000 } else if ((flags & USBD_EXCLUSIVE_USE) && ep->ue_refcnt) { 1001 err = USBD_IN_USE; 1002 } else { 1003 ep->ue_refcnt++; 1004 err = 0; 1005 } 1006 mutex_exit(dev->ud_bus->ub_lock); 1007 1008 return err; 1009} 1010 1011void 1012usbd_endpoint_release(struct usbd_device *dev, struct usbd_endpoint *ep) 1013{ 1014 1015 mutex_enter(dev->ud_bus->ub_lock); 1016 KASSERT(ep->ue_refcnt); 1017 ep->ue_refcnt--; 1018 mutex_exit(dev->ud_bus->ub_lock); 1019} 1020 1021/* Abort and close the device control pipe. */ 1022void 1023usbd_kill_pipe(struct usbd_pipe *pipe) 1024{ 1025 1026 usbd_abort_pipe(pipe); 1027 usbd_close_pipe(pipe); 1028} 1029 1030int 1031usbd_getnewaddr(struct usbd_bus *bus) 1032{ 1033 int addr; 1034 1035 for (addr = 1; addr < USB_MAX_DEVICES; addr++) { 1036 size_t dindex = usb_addr2dindex(addr); 1037 if (bus->ub_devices[dindex] == NULL) 1038 return addr; 1039 } 1040 return -1; 1041} 1042 1043usbd_status 1044usbd_attach_roothub(device_t parent, struct usbd_device *dev) 1045{ 1046 struct usb_attach_arg uaa; 1047 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1048 device_t dv; 1049 1050 uaa.uaa_device = dev; 1051 uaa.uaa_usegeneric = 0; 1052 uaa.uaa_port = 0; 1053 uaa.uaa_vendor = UGETW(dd->idVendor); 1054 uaa.uaa_product = UGETW(dd->idProduct); 1055 uaa.uaa_release = UGETW(dd->bcdDevice); 1056 uaa.uaa_class = dd->bDeviceClass; 1057 uaa.uaa_subclass = dd->bDeviceSubClass; 1058 uaa.uaa_proto = dd->bDeviceProtocol; 1059 1060 KERNEL_LOCK(1, curlwp); 1061 dv = config_found(parent, &uaa, NULL, 1062 CFARGS(.iattr = "usbroothubif")); 1063 KERNEL_UNLOCK_ONE(curlwp); 1064 if (dv) { 1065 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP); 1066 dev->ud_subdevs[0] = dv; 1067 dev->ud_subdevlen = 1; 1068 } 1069 return USBD_NORMAL_COMPLETION; 1070} 1071 1072static void 1073usbd_properties(device_t dv, struct usbd_device *dev) 1074{ 1075 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1076 prop_dictionary_t dict = device_properties(dv); 1077 int class, subclass, release, proto, vendor, product; 1078 1079 class = dd->bDeviceClass; 1080 subclass = dd->bDeviceSubClass; 1081 release = UGETW(dd->bcdDevice); 1082 proto = dd->bDeviceProtocol; 1083 vendor = UGETW(dd->idVendor); 1084 product = UGETW(dd->idProduct); 1085 1086 prop_dictionary_set_uint8(dict, "address", dev->ud_addr); 1087 1088 if (dev->ud_myhub) { 1089 struct usbd_device *hdev = dev->ud_myhub; 1090 struct usbd_hub *hub = hdev->ud_hub; 1091 int p; 1092 1093 KASSERT(hub != NULL); 1094 1095 prop_dictionary_set_uint8(dict, "hub-address", hdev->ud_addr); 1096 for (p=1; p <= hub->uh_hubdesc.bNbrPorts; ++p) { 1097 if (hub->uh_ports[p-1].up_dev == dev) { 1098 prop_dictionary_set_uint8(dict, "hub-port", p); 1099 break; 1100 } 1101 } 1102 } 1103 1104 prop_dictionary_set_uint8(dict, "class", class); 1105 prop_dictionary_set_uint8(dict, "subclass", subclass); 1106 prop_dictionary_set_uint16(dict, "release", release); 1107 prop_dictionary_set_uint8(dict, "proto", proto); 1108 prop_dictionary_set_uint16(dict, "vendor-id", vendor); 1109 prop_dictionary_set_uint16(dict, "product-id", product); 1110 1111 if (dev->ud_vendor) { 1112 prop_dictionary_set_string(dict, 1113 "vendor-string", dev->ud_vendor); 1114 } 1115 if (dev->ud_product) { 1116 prop_dictionary_set_string(dict, 1117 "product-string", dev->ud_product); 1118 } 1119 if (dev->ud_serial) { 1120 prop_dictionary_set_string(dict, 1121 "serialnumber", dev->ud_serial); 1122 } 1123} 1124 1125static usbd_status 1126usbd_attachwholedevice(device_t parent, struct usbd_device *dev, int port, 1127 int usegeneric) 1128{ 1129 struct usb_attach_arg uaa; 1130 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1131 device_t dv; 1132 int dlocs[USBDEVIFCF_NLOCS]; 1133 1134 KASSERT(usb_in_event_thread(parent)); 1135 1136 uaa.uaa_device = dev; 1137 uaa.uaa_usegeneric = usegeneric; 1138 uaa.uaa_port = port; 1139 uaa.uaa_vendor = UGETW(dd->idVendor); 1140 uaa.uaa_product = UGETW(dd->idProduct); 1141 uaa.uaa_release = UGETW(dd->bcdDevice); 1142 uaa.uaa_class = dd->bDeviceClass; 1143 uaa.uaa_subclass = dd->bDeviceSubClass; 1144 uaa.uaa_proto = dd->bDeviceProtocol; 1145 1146 dlocs[USBDEVIFCF_PORT] = uaa.uaa_port; 1147 dlocs[USBDEVIFCF_VENDOR] = uaa.uaa_vendor; 1148 dlocs[USBDEVIFCF_PRODUCT] = uaa.uaa_product; 1149 dlocs[USBDEVIFCF_RELEASE] = uaa.uaa_release; 1150 /* the rest is historical ballast */ 1151 dlocs[USBDEVIFCF_CONFIGURATION] = -1; 1152 dlocs[USBDEVIFCF_INTERFACE] = -1; 1153 1154 config_pending_incr(parent); 1155 1156 KERNEL_LOCK(1, curlwp); 1157 dv = config_found(parent, &uaa, usbd_print, 1158 CFARGS(.submatch = config_stdsubmatch, 1159 .iattr = "usbdevif", 1160 .locators = dlocs)); 1161 KERNEL_UNLOCK_ONE(curlwp); 1162 if (dv) { 1163 dev->ud_subdevs = kmem_alloc(sizeof(dv), KM_SLEEP); 1164 dev->ud_subdevs[0] = dv; 1165 dev->ud_subdevlen = 1; 1166 dev->ud_nifaces_claimed = 1; /* XXX */ 1167 usbd_properties(dv, dev); 1168 } 1169 config_pending_decr(parent); 1170 return USBD_NORMAL_COMPLETION; 1171} 1172 1173static usbd_status 1174usbd_attachinterfaces(device_t parent, struct usbd_device *dev, 1175 int port, const int *locators) 1176{ 1177 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 1178 struct usbif_attach_arg uiaa; 1179 int ilocs[USBIFIFCF_NLOCS]; 1180 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1181 int nifaces; 1182 struct usbd_interface **ifaces; 1183 int i, j, loc; 1184 device_t dv; 1185 1186 KASSERT(usb_in_event_thread(parent)); 1187 1188 nifaces = dev->ud_cdesc->bNumInterface; 1189 ifaces = kmem_zalloc(nifaces * sizeof(*ifaces), KM_SLEEP); 1190 for (i = 0; i < nifaces; i++) { 1191 if (!dev->ud_subdevs[i]) { 1192 ifaces[i] = &dev->ud_ifaces[i]; 1193 } 1194 DPRINTF("interface %jd %#jx", i, (uintptr_t)ifaces[i], 0, 0); 1195 } 1196 1197 1198 uiaa.uiaa_device = dev; 1199 uiaa.uiaa_port = port; 1200 uiaa.uiaa_vendor = UGETW(dd->idVendor); 1201 uiaa.uiaa_product = UGETW(dd->idProduct); 1202 uiaa.uiaa_release = UGETW(dd->bcdDevice); 1203 uiaa.uiaa_configno = dev->ud_cdesc->bConfigurationValue; 1204 uiaa.uiaa_ifaces = ifaces; 1205 uiaa.uiaa_nifaces = nifaces; 1206 ilocs[USBIFIFCF_PORT] = uiaa.uiaa_port; 1207 ilocs[USBIFIFCF_VENDOR] = uiaa.uiaa_vendor; 1208 ilocs[USBIFIFCF_PRODUCT] = uiaa.uiaa_product; 1209 ilocs[USBIFIFCF_RELEASE] = uiaa.uiaa_release; 1210 ilocs[USBIFIFCF_CONFIGURATION] = uiaa.uiaa_configno; 1211 1212 for (i = 0; i < nifaces; i++) { 1213 if (!ifaces[i]) { 1214 DPRINTF("interface %jd claimed", i, 0, 0, 0); 1215 continue; /* interface already claimed */ 1216 } 1217 uiaa.uiaa_iface = ifaces[i]; 1218 uiaa.uiaa_class = ifaces[i]->ui_idesc->bInterfaceClass; 1219 uiaa.uiaa_subclass = ifaces[i]->ui_idesc->bInterfaceSubClass; 1220 uiaa.uiaa_proto = ifaces[i]->ui_idesc->bInterfaceProtocol; 1221 uiaa.uiaa_ifaceno = ifaces[i]->ui_idesc->bInterfaceNumber; 1222 1223 DPRINTF("searching for interface %jd...", i, 0, 0, 0); 1224 DPRINTF("class %jx subclass %jx proto %jx ifaceno %jd", 1225 uiaa.uiaa_class, uiaa.uiaa_subclass, uiaa.uiaa_proto, 1226 uiaa.uiaa_ifaceno); 1227 ilocs[USBIFIFCF_INTERFACE] = uiaa.uiaa_ifaceno; 1228 if (locators != NULL) { 1229 loc = locators[USBIFIFCF_CONFIGURATION]; 1230 if (loc != USBIFIFCF_CONFIGURATION_DEFAULT && 1231 loc != uiaa.uiaa_configno) 1232 continue; 1233 loc = locators[USBIFIFCF_INTERFACE]; 1234 if (loc != USBIFIFCF_INTERFACE_DEFAULT && 1235 loc != uiaa.uiaa_ifaceno) 1236 continue; 1237 } 1238 KERNEL_LOCK(1, curlwp); 1239 dv = config_found(parent, &uiaa, usbd_ifprint, 1240 CFARGS(.submatch = config_stdsubmatch, 1241 .iattr = "usbifif", 1242 .locators = ilocs)); 1243 KERNEL_UNLOCK_ONE(curlwp); 1244 if (!dv) 1245 continue; 1246 1247 usbd_properties(dv, dev); 1248 1249 /* claim */ 1250 ifaces[i] = NULL; 1251 /* account for ifaces claimed by the driver behind our back */ 1252 for (j = 0; j < nifaces; j++) { 1253 1254 if (!ifaces[j] && !dev->ud_subdevs[j]) { 1255 DPRINTF("interface %jd claimed behind our back", 1256 j, 0, 0, 0); 1257 dev->ud_subdevs[j] = dv; 1258 dev->ud_nifaces_claimed++; 1259 } 1260 } 1261 } 1262 1263 kmem_free(ifaces, nifaces * sizeof(*ifaces)); 1264 return USBD_NORMAL_COMPLETION; 1265} 1266 1267usbd_status 1268usbd_probe_and_attach(device_t parent, struct usbd_device *dev, 1269 int port, int addr) 1270{ 1271 USBHIST_FUNC(); 1272 USBHIST_CALLARGS(usbdebug, "trying device specific drivers", 0, 0, 0, 0); 1273 usb_device_descriptor_t *dd = &dev->ud_ddesc; 1274 int confi, nifaces; 1275 usbd_status err; 1276 1277 KASSERT(usb_in_event_thread(parent)); 1278 1279 /* First try with device specific drivers. */ 1280 err = usbd_attachwholedevice(parent, dev, port, 0); 1281 if (dev->ud_nifaces_claimed || err) 1282 return err; 1283 DPRINTF("no device specific driver found", 0, 0, 0, 0); 1284 1285 DPRINTF("looping over %jd configurations", dd->bNumConfigurations, 1286 0, 0, 0); 1287 for (confi = 0; confi < dd->bNumConfigurations; confi++) { 1288 DPRINTFN(1, "trying config idx=%jd", confi, 0, 0, 0); 1289 err = usbd_set_config_index(dev, confi, 1); 1290 if (err) { 1291 DPRINTF("port %jd, set config at addr %jd failed, " 1292 "error=%jd", port, addr, err, 0); 1293 printf("%s: port %d, set config at addr %d failed\n", 1294 device_xname(parent), port, addr); 1295 return err; 1296 } 1297 nifaces = dev->ud_cdesc->bNumInterface; 1298 dev->ud_subdevs = kmem_zalloc(nifaces * sizeof(device_t), 1299 KM_SLEEP); 1300 dev->ud_subdevlen = nifaces; 1301 1302 err = usbd_attachinterfaces(parent, dev, port, NULL); 1303 1304 if (dev->ud_subdevs && dev->ud_nifaces_claimed == 0) { 1305 kmem_free(dev->ud_subdevs, 1306 dev->ud_subdevlen * sizeof(device_t)); 1307 dev->ud_subdevs = 0; 1308 dev->ud_subdevlen = 0; 1309 } 1310 if (dev->ud_nifaces_claimed || err) 1311 return err; 1312 } 1313 /* No interfaces were attached in any of the configurations. */ 1314 1315 if (dd->bNumConfigurations > 1) /* don't change if only 1 config */ 1316 usbd_set_config_index(dev, 0, 0); 1317 1318 DPRINTF("no interface drivers found", 0, 0, 0, 0); 1319 1320 /* Finally try the generic driver. */ 1321 err = usbd_attachwholedevice(parent, dev, port, 1); 1322 1323 /* 1324 * The generic attach failed, but leave the device as it is. 1325 * We just did not find any drivers, that's all. The device is 1326 * fully operational and not harming anyone. 1327 */ 1328 DPRINTF("generic attach failed", 0, 0, 0, 0); 1329 1330 return USBD_NORMAL_COMPLETION; 1331} 1332 1333/** 1334 * Called from uhub_rescan(). usbd_new_device() for the target dev must be 1335 * called before calling this. 1336 */ 1337usbd_status 1338usbd_reattach_device(device_t parent, struct usbd_device *dev, 1339 int port, const int *locators) 1340{ 1341 int i, loc; 1342 1343 USBHIST_FUNC(); 1344 USBHIST_CALLARGS(usbdebug, "uhub%jd port=%jd", 1345 device_unit(parent), port, 0, 0); 1346 1347 KASSERT(usb_in_event_thread(parent)); 1348 1349 if (locators != NULL) { 1350 loc = locators[USBIFIFCF_PORT]; 1351 if (loc != USBIFIFCF_PORT_DEFAULT && loc != port) 1352 return USBD_NORMAL_COMPLETION; 1353 loc = locators[USBIFIFCF_VENDOR]; 1354 if (loc != USBIFIFCF_VENDOR_DEFAULT && 1355 loc != UGETW(dev->ud_ddesc.idVendor)) 1356 return USBD_NORMAL_COMPLETION; 1357 loc = locators[USBIFIFCF_PRODUCT]; 1358 if (loc != USBIFIFCF_PRODUCT_DEFAULT && 1359 loc != UGETW(dev->ud_ddesc.idProduct)) 1360 return USBD_NORMAL_COMPLETION; 1361 loc = locators[USBIFIFCF_RELEASE]; 1362 if (loc != USBIFIFCF_RELEASE_DEFAULT && 1363 loc != UGETW(dev->ud_ddesc.bcdDevice)) 1364 return USBD_NORMAL_COMPLETION; 1365 } 1366 if (dev->ud_subdevlen == 0) { 1367 /* XXX: check USBIFIFCF_CONFIGURATION and 1368 * USBIFIFCF_INTERFACE too */ 1369 return usbd_probe_and_attach(parent, dev, port, dev->ud_addr); 1370 } else if (dev->ud_subdevlen != dev->ud_cdesc->bNumInterface) { 1371 /* device-specific or generic driver is already attached. */ 1372 return USBD_NORMAL_COMPLETION; 1373 } 1374 /* Does the device have unconfigured interfaces? */ 1375 for (i = 0; i < dev->ud_subdevlen; i++) { 1376 if (dev->ud_subdevs[i] == NULL) { 1377 break; 1378 } 1379 } 1380 if (i >= dev->ud_subdevlen) 1381 return USBD_NORMAL_COMPLETION; 1382 return usbd_attachinterfaces(parent, dev, port, locators); 1383} 1384 1385/* 1386 * Called when a new device has been put in the powered state, 1387 * but not yet in the addressed state. 1388 * Get initial descriptor, set the address, get full descriptor, 1389 * and attach a driver. 1390 */ 1391usbd_status 1392usbd_new_device(device_t parent, struct usbd_bus *bus, int depth, int speed, 1393 int port, struct usbd_port *up) 1394{ 1395 USBHIST_FUNC(); 1396 USBHIST_CALLARGS(usbdebug, "bus=%#jx port=%jd depth=%jd speed=%jd", 1397 (uintptr_t)bus, port, depth, speed); 1398 struct usbd_device *dev, *adev; 1399 struct usbd_device *hub; 1400 usb_device_descriptor_t *dd; 1401 usb_port_status_t ps; 1402 usbd_status err; 1403 int addr; 1404 int i; 1405 int p; 1406 1407 KASSERT(usb_in_event_thread(parent)); 1408 1409 if (bus->ub_methods->ubm_newdev != NULL) 1410 return (bus->ub_methods->ubm_newdev)(parent, bus, depth, speed, 1411 port, up); 1412 1413 addr = usbd_getnewaddr(bus); 1414 if (addr < 0) { 1415 printf("%s: No free USB addresses, new device ignored.\n", 1416 device_xname(bus->ub_usbctl)); 1417 return USBD_NO_ADDR; 1418 } 1419 1420 dev = kmem_zalloc(sizeof(*dev), KM_SLEEP); 1421 dev->ud_bus = bus; 1422 1423 /* Set up default endpoint handle. */ 1424 dev->ud_ep0.ue_edesc = &dev->ud_ep0desc; 1425 1426 /* Set up default endpoint descriptor. */ 1427 dev->ud_ep0desc.bLength = USB_ENDPOINT_DESCRIPTOR_SIZE; 1428 dev->ud_ep0desc.bDescriptorType = UDESC_ENDPOINT; 1429 dev->ud_ep0desc.bEndpointAddress = USB_CONTROL_ENDPOINT; 1430 dev->ud_ep0desc.bmAttributes = UE_CONTROL; 1431 /* 1432 * temporary, will be fixed after first descriptor fetch 1433 * (which uses 64 bytes so it shouldn't be less), 1434 * highspeed devices must support 64 byte packets anyway 1435 */ 1436 if (speed == USB_SPEED_HIGH || speed == USB_SPEED_FULL) 1437 USETW(dev->ud_ep0desc.wMaxPacketSize, 64); 1438 else 1439 USETW(dev->ud_ep0desc.wMaxPacketSize, USB_MAX_IPACKET); 1440 1441 dev->ud_ep0desc.bInterval = 0; 1442 1443 /* doesn't matter, just don't leave it uninitialized */ 1444 dev->ud_ep0.ue_toggle = 0; 1445 1446 dev->ud_quirks = &usbd_no_quirk; 1447 dev->ud_addr = USB_START_ADDR; 1448 dev->ud_ddesc.bMaxPacketSize = 0; 1449 dev->ud_depth = depth; 1450 dev->ud_powersrc = up; 1451 dev->ud_myhub = up->up_parent; 1452 1453 up->up_dev = dev; 1454 1455 /* Locate port on upstream high speed hub */ 1456 for (adev = dev, hub = up->up_parent; 1457 hub != NULL && hub->ud_speed != USB_SPEED_HIGH; 1458 adev = hub, hub = hub->ud_myhub) 1459 ; 1460 if (hub) { 1461 for (p = 1; p <= hub->ud_hub->uh_hubdesc.bNbrPorts; p++) { 1462 if (hub->ud_hub->uh_ports[p - 1].up_dev == adev) { 1463 dev->ud_myhsport = 1464 &hub->ud_hub->uh_ports[p - 1]; 1465 goto found; 1466 } 1467 } 1468 panic("usbd_new_device: cannot find HS port"); 1469 found: 1470 DPRINTFN(1, "high speed port %jd", p, 0, 0, 0); 1471 } else { 1472 dev->ud_myhsport = NULL; 1473 } 1474 dev->ud_speed = speed; 1475 dev->ud_langid = USBD_NOLANG; 1476 dev->ud_cookie.cookie = ++usb_cookie_no; 1477 1478 /* Establish the default pipe. */ 1479 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1480 &dev->ud_pipe0, USBD_MPSAFE); 1481 if (err) { 1482 usbd_remove_device(dev, up); 1483 return err; 1484 } 1485 1486 dd = &dev->ud_ddesc; 1487 /* Try a few times in case the device is slow (i.e. outside specs.) */ 1488 for (i = 0; i < 10; i++) { 1489 /* Get the first 8 bytes of the device descriptor. */ 1490 err = usbd_get_initial_ddesc(dev, dd); 1491 if (!err) 1492 break; 1493 /* 1494 * The root hub can never fail to give the initial descriptor, 1495 * but assert it just in case. 1496 */ 1497 KASSERT(up->up_parent); 1498 usbd_delay_ms(dev, 200); 1499 if ((i & 3) == 3) 1500 usbd_reset_port(up->up_parent, port, &ps); 1501 } 1502 if (err) { 1503 DPRINTF("addr=%jd, getting first desc failed: %jd", addr, err, 1504 0, 0); 1505 usbd_remove_device(dev, up); 1506 return err; 1507 } 1508 1509 /* Windows resets the port here, do likewise */ 1510 if (up->up_parent) 1511 usbd_reset_port(up->up_parent, port, &ps); 1512 1513 if (speed == USB_SPEED_HIGH) { 1514 /* Max packet size must be 64 (sec 5.5.3). */ 1515 if (dd->bMaxPacketSize != USB_2_MAX_CTRL_PACKET) { 1516#ifdef DIAGNOSTIC 1517 printf("usbd_new_device: addr=%d bad max packet " 1518 "size=%d. adjusting to %d.\n", 1519 addr, dd->bMaxPacketSize, USB_2_MAX_CTRL_PACKET); 1520#endif 1521 dd->bMaxPacketSize = USB_2_MAX_CTRL_PACKET; 1522 } 1523 } 1524 1525 DPRINTF("adding unit addr=%jd, rev=%02jx, class=%jd, subclass=%jd", 1526 addr, UGETW(dd->bcdUSB), dd->bDeviceClass, dd->bDeviceSubClass); 1527 DPRINTF("protocol=%jd, maxpacket=%jd, len=%jd, speed=%jd", 1528 dd->bDeviceProtocol, dd->bMaxPacketSize, dd->bLength, dev->ud_speed); 1529 1530 if (dd->bDescriptorType != UDESC_DEVICE) { 1531 /* Illegal device descriptor */ 1532 DPRINTF("illegal descriptor %jd", dd->bDescriptorType, 0, 0, 0); 1533 usbd_remove_device(dev, up); 1534 return USBD_INVAL; 1535 } 1536 1537 if (dd->bLength < USB_DEVICE_DESCRIPTOR_SIZE) { 1538 DPRINTF("bad length %jd", dd->bLength, 0, 0, 0); 1539 usbd_remove_device(dev, up); 1540 return USBD_INVAL; 1541 } 1542 1543 USETW(dev->ud_ep0desc.wMaxPacketSize, dd->bMaxPacketSize); 1544 1545 /* Re-establish the default pipe with the new MPS. */ 1546 usbd_kill_pipe(dev->ud_pipe0); 1547 dev->ud_pipe0 = NULL; 1548 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1549 &dev->ud_pipe0, USBD_MPSAFE); 1550 if (err) { 1551 DPRINTF("setup default pipe failed err %jd", err, 0, 0, 0); 1552 usbd_remove_device(dev, up); 1553 return err; 1554 } 1555 1556 /* Set the address */ 1557 DPRINTFN(5, "setting device address=%jd", addr, 0, 0, 0); 1558 err = usbd_set_address(dev, addr); 1559 if (err) { 1560 DPRINTF("set address %jd failed, err = %jd", addr, err, 0, 0); 1561 err = USBD_SET_ADDR_FAILED; 1562 usbd_remove_device(dev, up); 1563 return err; 1564 } 1565 1566 /* Allow device time to set new address */ 1567 usbd_delay_ms(dev, USB_SET_ADDRESS_SETTLE); 1568 dev->ud_addr = addr; /* new device address now */ 1569 bus->ub_devices[usb_addr2dindex(addr)] = dev; 1570 1571 /* Re-establish the default pipe with the new address. */ 1572 usbd_kill_pipe(dev->ud_pipe0); 1573 dev->ud_pipe0 = NULL; 1574 err = usbd_setup_pipe_flags(dev, 0, &dev->ud_ep0, USBD_DEFAULT_INTERVAL, 1575 &dev->ud_pipe0, USBD_MPSAFE); 1576 if (err) { 1577 DPRINTF("setup default pipe failed, err = %jd", err, 0, 0, 0); 1578 usbd_remove_device(dev, up); 1579 return err; 1580 } 1581 1582 err = usbd_reload_device_desc(dev); 1583 if (err) { 1584 DPRINTF("addr=%jd, getting full desc failed, err = %jd", addr, 1585 err, 0, 0); 1586 usbd_remove_device(dev, up); 1587 return err; 1588 } 1589 1590 /* Assume 100mA bus powered for now. Changed when configured. */ 1591 dev->ud_power = USB_MIN_POWER; 1592 dev->ud_selfpowered = 0; 1593 1594 DPRINTF("new dev (addr %jd), dev=%#jx, parent=%#jx", 1595 addr, (uintptr_t)dev, (uintptr_t)parent, 0); 1596 1597 usbd_get_device_strings(dev); 1598 1599 usbd_add_dev_event(USB_EVENT_DEVICE_ATTACH, dev); 1600 1601 if (port == 0) { /* root hub */ 1602 KASSERT(addr == 1); 1603 usbd_attach_roothub(parent, dev); 1604 return USBD_NORMAL_COMPLETION; 1605 } 1606 1607 err = usbd_probe_and_attach(parent, dev, port, addr); 1608 if (err) { 1609 usbd_remove_device(dev, up); 1610 return err; 1611 } 1612 1613 return USBD_NORMAL_COMPLETION; 1614} 1615 1616usbd_status 1617usbd_reload_device_desc(struct usbd_device *dev) 1618{ 1619 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 1620 usb_device_descriptor_t *udd = &dev->ud_ddesc; 1621 usbd_status err; 1622 1623 /* Get the full device descriptor. */ 1624 err = usbd_get_device_desc(dev, udd); 1625 if (err) 1626 return err; 1627 if (udd->bDescriptorType != UDESC_DEVICE) 1628 return USBD_INVAL; 1629 if (udd->bLength < USB_DEVICE_DESCRIPTOR_SIZE) 1630 return USBD_INVAL; 1631 1632 DPRINTFN(15, "bLength %5ju", udd->bLength, 0, 0, 0); 1633 DPRINTFN(15, "bDescriptorType %5ju", udd->bDescriptorType, 0, 0, 0); 1634 DPRINTFN(15, "bcdUSB %2jx.%02jx", udd->bcdUSB[1], 1635 udd->bcdUSB[0], 0, 0); 1636 DPRINTFN(15, "bDeviceClass %5ju", udd->bDeviceClass, 0, 0, 0); 1637 DPRINTFN(15, "bDeviceSubClass %5ju", udd->bDeviceSubClass, 0, 0, 0); 1638 DPRINTFN(15, "bDeviceProtocol %5ju", udd->bDeviceProtocol, 0, 0, 0); 1639 DPRINTFN(15, "bMaxPacketSize0 %5ju", udd->bMaxPacketSize, 0, 0, 0); 1640 DPRINTFN(15, "idVendor 0x%02jx 0x%02jx", 1641 udd->idVendor[0], 1642 udd->idVendor[1], 0, 0); 1643 DPRINTFN(15, "idProduct 0x%02jx 0x%02jx", 1644 udd->idProduct[0], 1645 udd->idProduct[1], 0, 0); 1646 DPRINTFN(15, "bcdDevice %2jx.%02jx", udd->bcdDevice[1], 1647 udd->bcdDevice[0], 0, 0); 1648 DPRINTFN(15, "iManufacturer %5ju", udd->iManufacturer, 0, 0, 0); 1649 DPRINTFN(15, "iProduct %5ju", udd->iProduct, 0, 0, 0); 1650 DPRINTFN(15, "iSerial %5ju", udd->iSerialNumber, 0, 0, 0); 1651 DPRINTFN(15, "bNumConfigurations %5ju", udd->bNumConfigurations, 0, 0, 1652 0); 1653 1654 /* Figure out what's wrong with this device. */ 1655 dev->ud_quirks = usbd_find_quirk(udd); 1656 1657 return USBD_NORMAL_COMPLETION; 1658} 1659 1660void 1661usbd_remove_device(struct usbd_device *dev, struct usbd_port *up) 1662{ 1663 1664 USBHIST_FUNC(); 1665 USBHIST_CALLARGS(usbdebug, "dev %#jx up %#jx", 1666 (uintptr_t)dev, (uintptr_t)up, 0, 0); 1667 1668 if (dev->ud_pipe0 != NULL) 1669 usbd_kill_pipe(dev->ud_pipe0); 1670 up->up_dev = NULL; 1671 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL; 1672 1673 if (dev->ud_vendor != NULL) { 1674 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN); 1675 } 1676 if (dev->ud_product != NULL) { 1677 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN); 1678 } 1679 if (dev->ud_serial != NULL) { 1680 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN); 1681 } 1682 kmem_free(dev, sizeof(*dev)); 1683} 1684 1685int 1686usbd_print(void *aux, const char *pnp) 1687{ 1688 struct usb_attach_arg *uaa = aux; 1689 1690 if (pnp) { 1691#define USB_DEVINFO 1024 1692 char *devinfo; 1693 if (!uaa->uaa_usegeneric) 1694 return QUIET; 1695 devinfo = kmem_alloc(USB_DEVINFO, KM_SLEEP); 1696 usbd_devinfo(uaa->uaa_device, 1, devinfo, USB_DEVINFO); 1697 aprint_normal("%s, %s", devinfo, pnp); 1698 kmem_free(devinfo, USB_DEVINFO); 1699 } 1700 aprint_normal(" port %d", uaa->uaa_port); 1701#if 0 1702 /* 1703 * It gets very crowded with these locators on the attach line. 1704 * They are not really needed since they are printed in the clear 1705 * by each driver. 1706 */ 1707 if (uaa->uaa_vendor != UHUB_UNK_VENDOR) 1708 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor); 1709 if (uaa->uaa_product != UHUB_UNK_PRODUCT) 1710 aprint_normal(" product 0x%04x", uaa->uaa_product); 1711 if (uaa->uaa_release != UHUB_UNK_RELEASE) 1712 aprint_normal(" release 0x%04x", uaa->uaa_release); 1713#endif 1714 return UNCONF; 1715} 1716 1717int 1718usbd_ifprint(void *aux, const char *pnp) 1719{ 1720 struct usbif_attach_arg *uiaa = aux; 1721 1722 if (pnp) 1723 return QUIET; 1724 aprint_normal(" port %d", uiaa->uiaa_port); 1725 aprint_normal(" configuration %d", uiaa->uiaa_configno); 1726 aprint_normal(" interface %d", uiaa->uiaa_ifaceno); 1727#if 0 1728 /* 1729 * It gets very crowded with these locators on the attach line. 1730 * They are not really needed since they are printed in the clear 1731 * by each driver. 1732 */ 1733 if (uaa->uaa_vendor != UHUB_UNK_VENDOR) 1734 aprint_normal(" vendor 0x%04x", uaa->uaa_vendor); 1735 if (uaa->uaa_product != UHUB_UNK_PRODUCT) 1736 aprint_normal(" product 0x%04x", uaa->uaa_product); 1737 if (uaa->uaa_release != UHUB_UNK_RELEASE) 1738 aprint_normal(" release 0x%04x", uaa->uaa_release); 1739#endif 1740 return UNCONF; 1741} 1742 1743void 1744usbd_fill_deviceinfo(struct usbd_device *dev, struct usb_device_info *di, 1745 int usedev) 1746{ 1747 struct usbd_port *p; 1748 int i, j, err; 1749 1750 di->udi_bus = device_unit(dev->ud_bus->ub_usbctl); 1751 di->udi_addr = dev->ud_addr; 1752 di->udi_cookie = dev->ud_cookie; 1753 usbd_devinfo_vp(dev, di->udi_vendor, sizeof(di->udi_vendor), 1754 di->udi_product, sizeof(di->udi_product), usedev, 1); 1755 usbd_printBCD(di->udi_release, sizeof(di->udi_release), 1756 UGETW(dev->ud_ddesc.bcdDevice)); 1757 if (usedev) { 1758 usbd_status uerr = usbd_get_string(dev, 1759 dev->ud_ddesc.iSerialNumber, di->udi_serial); 1760 if (uerr != USBD_NORMAL_COMPLETION) { 1761 di->udi_serial[0] = '\0'; 1762 } else { 1763 usbd_trim_spaces(di->udi_serial); 1764 } 1765 } else { 1766 di->udi_serial[0] = '\0'; 1767 if (dev->ud_serial) { 1768 strlcpy(di->udi_serial, dev->ud_serial, 1769 sizeof(di->udi_serial)); 1770 } 1771 } 1772 1773 di->udi_vendorNo = UGETW(dev->ud_ddesc.idVendor); 1774 di->udi_productNo = UGETW(dev->ud_ddesc.idProduct); 1775 di->udi_releaseNo = UGETW(dev->ud_ddesc.bcdDevice); 1776 di->udi_class = dev->ud_ddesc.bDeviceClass; 1777 di->udi_subclass = dev->ud_ddesc.bDeviceSubClass; 1778 di->udi_protocol = dev->ud_ddesc.bDeviceProtocol; 1779 di->udi_config = dev->ud_config; 1780 di->udi_power = dev->ud_selfpowered ? 0 : dev->ud_power; 1781 di->udi_speed = dev->ud_speed; 1782 1783 if (dev->ud_subdevlen > 0) { 1784 for (i = 0, j = 0; i < dev->ud_subdevlen && 1785 j < USB_MAX_DEVNAMES; i++) { 1786 if (!dev->ud_subdevs[i]) 1787 continue; 1788 strncpy(di->udi_devnames[j], 1789 device_xname(dev->ud_subdevs[i]), USB_MAX_DEVNAMELEN); 1790 di->udi_devnames[j][USB_MAX_DEVNAMELEN-1] = '\0'; 1791 j++; 1792 } 1793 } else { 1794 j = 0; 1795 } 1796 for (/* j is set */; j < USB_MAX_DEVNAMES; j++) 1797 di->udi_devnames[j][0] = 0; /* empty */ 1798 1799 if (!dev->ud_hub) { 1800 di->udi_nports = 0; 1801 return; 1802 } 1803 1804 const int nports = dev->ud_hub->uh_hubdesc.bNbrPorts; 1805 for (i = 1; i <= __arraycount(di->udi_ports) && i <= nports; i++) { 1806 p = &dev->ud_hub->uh_ports[i - 1]; 1807 if (p->up_dev) 1808 err = p->up_dev->ud_addr; 1809 else { 1810 const int s = UGETW(p->up_status.wPortStatus); 1811 const bool sshub_p = USB_IS_SS(dev->ud_speed); 1812 if (s & UPS_PORT_ENABLED) 1813 err = USB_PORT_ENABLED; 1814 else if (s & UPS_SUSPEND) 1815 err = USB_PORT_SUSPENDED; 1816 /* 1817 * Note: UPS_PORT_POWER_SS is available only 1818 * on 3.x, and UPS_PORT_POWER is available 1819 * only on 2.0 or 1.1. 1820 */ 1821 else if (sshub_p && (s & UPS_PORT_POWER_SS)) 1822 err = USB_PORT_POWERED; 1823 else if (!sshub_p && (s & UPS_PORT_POWER)) 1824 err = USB_PORT_POWERED; 1825 else 1826 err = USB_PORT_DISABLED; 1827 } 1828 di->udi_ports[i - 1] = err; 1829 } 1830 di->udi_nports = nports; 1831} 1832 1833void 1834usb_free_device(struct usbd_device *dev) 1835{ 1836 int ifcidx, nifc; 1837 1838 if (dev->ud_pipe0 != NULL) 1839 usbd_kill_pipe(dev->ud_pipe0); 1840 if (dev->ud_ifaces != NULL) { 1841 nifc = dev->ud_cdesc->bNumInterface; 1842 for (ifcidx = 0; ifcidx < nifc; ifcidx++) { 1843 usbd_iface_exlock(&dev->ud_ifaces[ifcidx]); 1844 usbd_free_iface_data(dev, ifcidx); 1845 usbd_iface_unlock(&dev->ud_ifaces[ifcidx]); 1846 usbd_iface_fini(dev, ifcidx); 1847 } 1848 kmem_free(dev->ud_ifaces, 1849 nifc * sizeof(struct usbd_interface)); 1850 } 1851 if (dev->ud_cdesc != NULL) 1852 kmem_free(dev->ud_cdesc, UGETW(dev->ud_cdesc->wTotalLength)); 1853 if (dev->ud_bdesc != NULL) 1854 kmem_free(dev->ud_bdesc, UGETW(dev->ud_bdesc->wTotalLength)); 1855 if (dev->ud_subdevlen > 0) { 1856 kmem_free(dev->ud_subdevs, 1857 dev->ud_subdevlen * sizeof(device_t)); 1858 dev->ud_subdevlen = 0; 1859 } 1860 if (dev->ud_vendor) { 1861 kmem_free(dev->ud_vendor, USB_MAX_ENCODED_STRING_LEN); 1862 } 1863 if (dev->ud_product) { 1864 kmem_free(dev->ud_product, USB_MAX_ENCODED_STRING_LEN); 1865 } 1866 if (dev->ud_serial) { 1867 kmem_free(dev->ud_serial, USB_MAX_ENCODED_STRING_LEN); 1868 } 1869 kmem_free(dev, sizeof(*dev)); 1870} 1871 1872/* 1873 * The general mechanism for detaching drivers works as follows: Each 1874 * driver is responsible for maintaining a reference count on the 1875 * number of outstanding references to its softc (e.g. from 1876 * processing hanging in a read or write). The detach method of the 1877 * driver decrements this counter and flags in the softc that the 1878 * driver is dying and then wakes any sleepers. It then sleeps on the 1879 * softc. Each place that can sleep must maintain the reference 1880 * count. When the reference count drops to -1 (0 is the normal value 1881 * of the reference count) then a wakeup on the softc is performed 1882 * signaling to the detach waiter that all references are gone. 1883 */ 1884 1885/* 1886 * Called from process context when we discover that a port has 1887 * been disconnected. 1888 */ 1889int 1890usb_disconnect_port(struct usbd_port *up, device_t parent, int flags) 1891{ 1892 struct usbd_device *dev = up->up_dev; 1893 device_t subdev; 1894 char subdevname[16]; 1895 const char *hubname = device_xname(parent); 1896 int i, rc; 1897 1898 USBHIST_FUNC(); 1899 USBHIST_CALLARGS(usbdebug, "up=%#jx dev=%#jx port=%jd", 1900 (uintptr_t)up, (uintptr_t)dev, up->up_portno, 0); 1901 1902 if (dev == NULL) { 1903 return 0; 1904 } 1905 1906 usbd_suspend_pipe(dev->ud_pipe0); 1907 if (dev->ud_subdevlen > 0) { 1908 DPRINTFN(3, "disconnect subdevs", 0, 0, 0, 0); 1909 for (i = 0; i < dev->ud_subdevlen; i++) { 1910 if ((subdev = dev->ud_subdevs[i]) == NULL) 1911 continue; 1912 strlcpy(subdevname, device_xname(subdev), 1913 sizeof(subdevname)); 1914 KERNEL_LOCK(1, curlwp); 1915 rc = config_detach(subdev, flags); 1916 KERNEL_UNLOCK_ONE(curlwp); 1917 if (rc != 0) 1918 return rc; 1919 printf("%s: at %s", subdevname, hubname); 1920 if (up->up_portno != 0) 1921 printf(" port %d", up->up_portno); 1922 printf(" (addr %d) disconnected\n", dev->ud_addr); 1923 } 1924 KASSERT(!dev->ud_nifaces_claimed); 1925 } 1926 1927 mutex_enter(dev->ud_bus->ub_lock); 1928 dev->ud_bus->ub_devices[usb_addr2dindex(dev->ud_addr)] = NULL; 1929 up->up_dev = NULL; 1930 mutex_exit(dev->ud_bus->ub_lock); 1931 1932 usbd_add_dev_event(USB_EVENT_DEVICE_DETACH, dev); 1933 1934 usb_free_device(dev); 1935 1936 return 0; 1937} 1938