1 /* $OpenBSD: uhub.c,v 1.16 2002/05/07 18:29:18 nate Exp $ */ 2 /* $NetBSD: uhub.c,v 1.52 2001/10/26 17:53:59 augustss Exp $ */ 3 /* $FreeBSD: src/sys/dev/usb/uhub.c,v 1.18 1999/11/17 22:33:43 n_hibma Exp $ */ 4 5 /* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. All advertising materials mentioning features or use of this software 22 * must display the following acknowledgement: 23 * This product includes software developed by the NetBSD 24 * Foundation, Inc. and its contributors. 25 * 4. Neither the name of The NetBSD Foundation nor the names of its 26 * contributors may be used to endorse or promote products derived 27 * from this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 39 * POSSIBILITY OF SUCH DAMAGE. 40 */ 41 42 /* 43 * USB spec: http://www.usb.org/developers/data/usbspec.zip 44 */ 45 46 #include <sys/param.h> 47 #include <sys/systm.h> 48 #include <sys/kernel.h> 49 #include <sys/malloc.h> 50 #if defined(__NetBSD__) || defined(__OpenBSD__) 51 #include <sys/device.h> 52 #include <sys/proc.h> 53 #elif defined(__FreeBSD__) 54 #include <sys/module.h> 55 #include <sys/bus.h> 56 #include "bus_if.h" 57 #endif 58 59 #include <machine/bus.h> 60 61 #include <dev/usb/usb.h> 62 #include <dev/usb/usbdi.h> 63 #include <dev/usb/usbdi_util.h> 64 #include <dev/usb/usbdivar.h> 65 66 #define UHUB_INTR_INTERVAL 255 /* ms */ 67 68 #ifdef UHUB_DEBUG 69 #define DPRINTF(x) if (uhubdebug) logprintf x 70 #define DPRINTFN(n,x) if (uhubdebug>(n)) logprintf x 71 int uhubdebug; 72 #else 73 #define DPRINTF(x) 74 #define DPRINTFN(n,x) 75 #endif 76 77 struct uhub_softc { 78 USBBASEDEVICE sc_dev; /* base device */ 79 usbd_device_handle sc_hub; /* USB device */ 80 usbd_pipe_handle sc_ipipe; /* interrupt pipe */ 81 u_int8_t sc_status[1]; /* XXX more ports */ 82 u_char sc_running; 83 }; 84 85 Static usbd_status uhub_explore(usbd_device_handle hub); 86 Static void uhub_intr(usbd_xfer_handle, usbd_private_handle,usbd_status); 87 88 #if defined(__FreeBSD__) 89 Static bus_child_detached_t uhub_child_detached; 90 #endif 91 92 93 /* 94 * We need two attachment points: 95 * hub to usb and hub to hub 96 * Every other driver only connects to hubs 97 */ 98 99 #if defined(__NetBSD__) || defined(__OpenBSD__) 100 USB_DECLARE_DRIVER(uhub); 101 102 /* Create the driver instance for the hub connected to hub case */ 103 struct cfattach uhub_uhub_ca = { 104 sizeof(struct uhub_softc), uhub_match, uhub_attach, 105 uhub_detach, uhub_activate 106 }; 107 #elif defined(__FreeBSD__) 108 USB_DECLARE_DRIVER_INIT(uhub, 109 DEVMETHOD(bus_child_detached, uhub_child_detached)); 110 111 /* Create the driver instance for the hub connected to usb case. */ 112 devclass_t uhubroot_devclass; 113 114 Static device_method_t uhubroot_methods[] = { 115 DEVMETHOD(device_probe, uhub_match), 116 DEVMETHOD(device_attach, uhub_attach), 117 118 /* detach is not allowed for a root hub */ 119 {0,0} 120 }; 121 122 Static driver_t uhubroot_driver = { 123 "uhub", 124 uhubroot_methods, 125 sizeof(struct uhub_softc) 126 }; 127 #endif 128 129 USB_MATCH(uhub) 130 { 131 USB_MATCH_START(uhub, uaa); 132 usb_device_descriptor_t *dd = usbd_get_device_descriptor(uaa->device); 133 134 DPRINTFN(5,("uhub_match, dd=%p\n", dd)); 135 /* 136 * The subclass for hubs seems to be 0 for some and 1 for others, 137 * so we just ignore the subclass. 138 */ 139 if (uaa->iface == NULL && dd->bDeviceClass == UDCLASS_HUB) 140 return (UMATCH_DEVCLASS_DEVSUBCLASS); 141 return (UMATCH_NONE); 142 } 143 144 USB_ATTACH(uhub) 145 { 146 USB_ATTACH_START(uhub, sc, uaa); 147 usbd_device_handle dev = uaa->device; 148 char devinfo[1024]; 149 usbd_status err; 150 struct usbd_hub *hub; 151 usb_device_request_t req; 152 usb_hub_descriptor_t hubdesc; 153 int p, port, nports, nremov, pwrdly; 154 usbd_interface_handle iface; 155 usb_endpoint_descriptor_t *ed; 156 157 DPRINTFN(1,("uhub_attach\n")); 158 sc->sc_hub = dev; 159 usbd_devinfo(dev, 1, devinfo); 160 USB_ATTACH_SETUP; 161 printf("%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo); 162 163 err = usbd_set_config_index(dev, 0, 1); 164 if (err) { 165 DPRINTF(("%s: configuration failed, error=%s\n", 166 USBDEVNAME(sc->sc_dev), usbd_errstr(err))); 167 USB_ATTACH_ERROR_RETURN; 168 } 169 170 if (dev->depth > USB_HUB_MAX_DEPTH) { 171 printf("%s: hub depth (%d) exceeded, hub ignored\n", 172 USBDEVNAME(sc->sc_dev), USB_HUB_MAX_DEPTH); 173 USB_ATTACH_ERROR_RETURN; 174 } 175 176 /* Get hub descriptor. */ 177 req.bmRequestType = UT_READ_CLASS_DEVICE; 178 req.bRequest = UR_GET_DESCRIPTOR; 179 USETW(req.wValue, 0); 180 USETW(req.wIndex, 0); 181 USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE); 182 DPRINTFN(1,("usb_init_hub: getting hub descriptor\n")); 183 err = usbd_do_request(dev, &req, &hubdesc); 184 nports = hubdesc.bNbrPorts; 185 if (!err && nports > 7) { 186 USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE + (nports+1) / 8); 187 err = usbd_do_request(dev, &req, &hubdesc); 188 } 189 if (err) { 190 DPRINTF(("%s: getting hub descriptor failed, error=%s\n", 191 USBDEVNAME(sc->sc_dev), usbd_errstr(err))); 192 USB_ATTACH_ERROR_RETURN; 193 } 194 195 for (nremov = 0, port = 1; port <= nports; port++) 196 if (!UHD_NOT_REMOV(&hubdesc, port)) 197 nremov++; 198 printf("%s: %d port%s with %d removable, %s powered\n", 199 USBDEVNAME(sc->sc_dev), nports, nports != 1 ? "s" : "", 200 nremov, dev->self_powered ? "self" : "bus"); 201 202 hub = malloc(sizeof(*hub) + (nports-1) * sizeof(struct usbd_port), 203 M_USBDEV, M_NOWAIT); 204 if (hub == NULL) 205 USB_ATTACH_ERROR_RETURN; 206 dev->hub = hub; 207 dev->hub->hubsoftc = sc; 208 hub->explore = uhub_explore; 209 hub->hubdesc = hubdesc; 210 211 DPRINTFN(1,("usbhub_init_hub: selfpowered=%d, parent=%p, " 212 "parent->selfpowered=%d\n", 213 dev->self_powered, dev->powersrc->parent, 214 dev->powersrc->parent ? 215 dev->powersrc->parent->self_powered : 0)); 216 217 if (!dev->self_powered && dev->powersrc->parent != NULL && 218 !dev->powersrc->parent->self_powered) { 219 printf("%s: bus powered hub connected to bus powered hub, " 220 "ignored\n", USBDEVNAME(sc->sc_dev)); 221 goto bad; 222 } 223 224 /* Set up interrupt pipe. */ 225 err = usbd_device2interface_handle(dev, 0, &iface); 226 if (err) { 227 printf("%s: no interface handle\n", USBDEVNAME(sc->sc_dev)); 228 goto bad; 229 } 230 ed = usbd_interface2endpoint_descriptor(iface, 0); 231 if (ed == NULL) { 232 printf("%s: no endpoint descriptor\n", USBDEVNAME(sc->sc_dev)); 233 goto bad; 234 } 235 if ((ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) { 236 printf("%s: bad interrupt endpoint\n", USBDEVNAME(sc->sc_dev)); 237 goto bad; 238 } 239 240 err = usbd_open_pipe_intr(iface, ed->bEndpointAddress, 241 USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_status, 242 sizeof(sc->sc_status), uhub_intr, UHUB_INTR_INTERVAL); 243 if (err) { 244 printf("%s: cannot open interrupt pipe\n", 245 USBDEVNAME(sc->sc_dev)); 246 goto bad; 247 } 248 249 /* Wait with power off for a while. */ 250 usbd_delay_ms(dev, USB_POWER_DOWN_TIME); 251 252 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, dev, USBDEV(sc->sc_dev)); 253 254 /* 255 * To have the best chance of success we do things in the exact same 256 * order as Windoze98. This should not be necessary, but some 257 * devices do not follow the USB specs to the letter. 258 * 259 * These are the events on the bus when a hub is attached: 260 * Get device and config descriptors (see attach code) 261 * Get hub descriptor (see above) 262 * For all ports 263 * turn on power 264 * wait for power to become stable 265 * (all below happens in explore code) 266 * For all ports 267 * clear C_PORT_CONNECTION 268 * For all ports 269 * get port status 270 * if device connected 271 * turn on reset 272 * wait 273 * clear C_PORT_RESET 274 * get port status 275 * proceed with device attachment 276 */ 277 278 /* Set up data structures */ 279 for (p = 0; p < nports; p++) { 280 struct usbd_port *up = &hub->ports[p]; 281 up->device = 0; 282 up->parent = dev; 283 up->portno = p+1; 284 if (dev->self_powered) 285 /* Self powered hub, give ports maximum current. */ 286 up->power = USB_MAX_POWER; 287 else 288 up->power = USB_MIN_POWER; 289 } 290 291 /* XXX should check for none, individual, or ganged power? */ 292 293 pwrdly = dev->hub->hubdesc.bPwrOn2PwrGood * UHD_PWRON_FACTOR 294 + USB_EXTRA_POWER_UP_TIME; 295 for (port = 1; port <= nports; port++) { 296 /* Turn the power on. */ 297 err = usbd_set_port_feature(dev, port, UHF_PORT_POWER); 298 if (err) 299 printf("%s: port %d power on failed, %s\n", 300 USBDEVNAME(sc->sc_dev), port, 301 usbd_errstr(err)); 302 DPRINTF(("usb_init_port: turn on port %d power\n", port)); 303 /* Wait for stable power. */ 304 usbd_delay_ms(dev, pwrdly); 305 } 306 307 /* The usual exploration will finish the setup. */ 308 309 sc->sc_running = 1; 310 311 USB_ATTACH_SUCCESS_RETURN; 312 313 bad: 314 free(hub, M_USBDEV); 315 dev->hub = 0; 316 USB_ATTACH_ERROR_RETURN; 317 } 318 319 usbd_status 320 uhub_explore(usbd_device_handle dev) 321 { 322 usb_hub_descriptor_t *hd = &dev->hub->hubdesc; 323 struct uhub_softc *sc = dev->hub->hubsoftc; 324 struct usbd_port *up; 325 usbd_status err; 326 int port; 327 int change, status; 328 329 DPRINTFN(10, ("uhub_explore dev=%p addr=%d\n", dev, dev->address)); 330 331 if (!sc->sc_running) 332 return (USBD_NOT_STARTED); 333 334 /* Ignore hubs that are too deep. */ 335 if (dev->depth > USB_HUB_MAX_DEPTH) 336 return (USBD_TOO_DEEP); 337 338 for(port = 1; port <= hd->bNbrPorts; port++) { 339 up = &dev->hub->ports[port-1]; 340 err = usbd_get_port_status(dev, port, &up->status); 341 if (err) { 342 DPRINTF(("uhub_explore: get port status failed, " 343 "error=%s\n", usbd_errstr(err))); 344 continue; 345 } 346 status = UGETW(up->status.wPortStatus); 347 change = UGETW(up->status.wPortChange); 348 DPRINTFN(3,("uhub_explore: %s port %d status 0x%04x 0x%04x\n", 349 USBDEVNAME(sc->sc_dev), port, status, change)); 350 if (change & UPS_C_PORT_ENABLED) { 351 DPRINTF(("uhub_explore: C_PORT_ENABLED\n")); 352 usbd_clear_port_feature(dev, port, UHF_C_PORT_ENABLE); 353 if (status & UPS_PORT_ENABLED) { 354 printf("%s: illegal enable change, port %d\n", 355 USBDEVNAME(sc->sc_dev), port); 356 } else { 357 /* Port error condition. */ 358 if (up->restartcnt) /* no message first time */ 359 printf("%s: port error, restarting " 360 "port %d\n", 361 USBDEVNAME(sc->sc_dev), port); 362 363 if (up->restartcnt++ < USBD_RESTART_MAX) 364 goto disco; 365 else 366 printf("%s: port error, giving up " 367 "port %d\n", 368 USBDEVNAME(sc->sc_dev), port); 369 } 370 } 371 if (!(change & UPS_C_CONNECT_STATUS)) { 372 DPRINTFN(3,("uhub_explore: port=%d !C_CONNECT_" 373 "STATUS\n", port)); 374 /* No status change, just do recursive explore. */ 375 if (up->device != NULL && up->device->hub != NULL) 376 up->device->hub->explore(up->device); 377 #if 0 && defined(DIAGNOSTIC) 378 if (up->device == NULL && 379 (status & UPS_CURRENT_CONNECT_STATUS)) 380 printf("%s: connected, no device\n", 381 USBDEVNAME(sc->sc_dev)); 382 #endif 383 continue; 384 } 385 386 /* We have a connect status change, handle it. */ 387 388 DPRINTF(("uhub_explore: status change hub=%d port=%d\n", 389 dev->address, port)); 390 usbd_clear_port_feature(dev, port, UHF_C_PORT_CONNECTION); 391 /*usbd_clear_port_feature(dev, port, UHF_C_PORT_ENABLE);*/ 392 /* 393 * If there is already a device on the port the change status 394 * must mean that is has disconnected. Looking at the 395 * current connect status is not enough to figure this out 396 * since a new unit may have been connected before we handle 397 * the disconnect. 398 */ 399 disco: 400 if (up->device != NULL) { 401 /* Disconnected */ 402 DPRINTF(("uhub_explore: device addr=%d disappeared " 403 "on port %d\n", up->device->address, port)); 404 usb_disconnect_port(up, USBDEV(sc->sc_dev)); 405 usbd_clear_port_feature(dev, port, 406 UHF_C_PORT_CONNECTION); 407 } 408 if (!(status & UPS_CURRENT_CONNECT_STATUS)) { 409 /* Nothing connected, just ignore it. */ 410 DPRINTFN(3,("uhub_explore: port=%d !CURRENT_CONNECT" 411 "_STATUS\n", port)); 412 continue; 413 } 414 415 /* Connected */ 416 417 if (!(status & UPS_PORT_POWER)) 418 printf("%s: strange, connected port %d has no power\n", 419 USBDEVNAME(sc->sc_dev), port); 420 421 /* Wait for maximum device power up time. */ 422 usbd_delay_ms(dev, USB_PORT_POWERUP_DELAY); 423 424 /* Reset port, which implies enabling it. */ 425 if (usbd_reset_port(dev, port, &up->status)) { 426 printf("uhub_explore: port=%d reset failed\n", 427 port); 428 continue; 429 } 430 431 /* Get device info and set its address. */ 432 err = usbd_new_device(USBDEV(sc->sc_dev), dev->bus, 433 dev->depth + 1, status & UPS_LOW_SPEED, 434 port, up); 435 /* XXX retry a few times? */ 436 if (err) { 437 DPRINTFN(-1,("uhub_explore: usb_new_device failed, " 438 "error=%s\n", usbd_errstr(err))); 439 /* Avoid addressing problems by disabling. */ 440 /* usbd_reset_port(dev, port, &up->status); */ 441 442 /* 443 * The unit refused to accept a new address, or had 444 * some other serious problem. Since we cannot leave 445 * at 0 we have to disable the port instead. 446 */ 447 printf("%s: device problem, disabling port %d\n", 448 USBDEVNAME(sc->sc_dev), port); 449 usbd_clear_port_feature(dev, port, UHF_PORT_ENABLE); 450 } else { 451 /* The port set up succeeded, reset error count. */ 452 up->restartcnt = 0; 453 454 if (up->device->hub) 455 up->device->hub->explore(up->device); 456 } 457 } 458 return (USBD_NORMAL_COMPLETION); 459 } 460 461 #if defined(__NetBSD__) || defined(__OpenBSD__) 462 int 463 uhub_activate(device_ptr_t self, enum devact act) 464 { 465 struct uhub_softc *sc = (struct uhub_softc *)self; 466 struct usbd_hub *hub = sc->sc_hub->hub; 467 usbd_device_handle dev; 468 int nports, port, i; 469 470 switch (act) { 471 case DVACT_ACTIVATE: 472 return (EOPNOTSUPP); 473 break; 474 475 case DVACT_DEACTIVATE: 476 if (hub == NULL) /* malfunctioning hub */ 477 break; 478 nports = hub->hubdesc.bNbrPorts; 479 for(port = 0; port < nports; port++) { 480 dev = hub->ports[port].device; 481 if (dev != NULL && dev->subdevs != NULL) { 482 for (i = 0; dev->subdevs[i] != NULL; i++) 483 config_deactivate(dev->subdevs[i]); 484 } 485 } 486 break; 487 } 488 return (0); 489 } 490 #endif 491 492 /* 493 * Called from process context when the hub is gone. 494 * Detach all devices on active ports. 495 */ 496 USB_DETACH(uhub) 497 { 498 USB_DETACH_START(uhub, sc); 499 struct usbd_hub *hub = sc->sc_hub->hub; 500 struct usbd_port *rup; 501 int port, nports; 502 503 #if defined(__NetBSD__) || defined(__OpenBSD__) 504 DPRINTF(("uhub_detach: sc=%p flags=%d\n", sc, flags)); 505 #elif defined(__FreeBSD__) 506 DPRINTF(("uhub_detach: sc=%port\n", sc)); 507 #endif 508 509 if (hub == NULL) /* Must be partially working */ 510 return (0); 511 512 usbd_abort_pipe(sc->sc_ipipe); 513 usbd_close_pipe(sc->sc_ipipe); 514 515 nports = hub->hubdesc.bNbrPorts; 516 for(port = 0; port < nports; port++) { 517 rup = &hub->ports[port]; 518 if (rup->device) 519 usb_disconnect_port(rup, self); 520 } 521 522 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_hub, 523 USBDEV(sc->sc_dev)); 524 525 free(hub, M_USBDEV); 526 sc->sc_hub->hub = NULL; 527 528 return (0); 529 } 530 531 #if defined(__FreeBSD__) 532 /* Called when a device has been detached from it */ 533 Static void 534 uhub_child_detached(device_t self, device_t child) 535 { 536 struct uhub_softc *sc = device_get_softc(self); 537 usbd_device_handle devhub = sc->sc_hub; 538 usbd_device_handle dev; 539 int nports; 540 int port; 541 int i; 542 543 if (!devhub->hub) 544 /* should never happen; children are only created after init */ 545 panic("hub not fully initialised, but child deleted?"); 546 547 nports = devhub->hub->hubdesc.bNbrPorts; 548 for (port = 0; port < nports; port++) { 549 dev = devhub->hub->ports[port].device; 550 if (dev && dev->subdevs) { 551 for (i = 0; dev->subdevs[i]; i++) { 552 if (dev->subdevs[i] == child) { 553 dev->subdevs[i] = NULL; 554 return; 555 } 556 } 557 } 558 } 559 } 560 #endif 561 562 563 /* 564 * Hub interrupt. 565 * This an indication that some port has changed status. 566 * Notify the bus event handler thread that we need 567 * to be explored again. 568 */ 569 void 570 uhub_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status) 571 { 572 struct uhub_softc *sc = addr; 573 574 DPRINTFN(5,("uhub_intr: sc=%p\n", sc)); 575 if (status == USBD_STALLED) 576 usbd_clear_endpoint_stall_async(sc->sc_ipipe); 577 else if (status == USBD_NORMAL_COMPLETION) 578 usb_needs_explore(sc->sc_hub); 579 } 580 581 #if defined(__FreeBSD__) 582 DRIVER_MODULE(uhub, usb, uhubroot_driver, uhubroot_devclass, 0, 0); 583 DRIVER_MODULE(uhub, uhub, uhub_driver, uhub_devclass, usbd_driver_load, 0); 584 #endif 585