sys/bus/usb/uhub.c

   1 /*      $NetBSD: uhub.c,v 1.68 2004/06/29 06:30:05 mycroft Exp $        */
   2 /*      $FreeBSD: src/sys/dev/usb/uhub.c,v 1.69.2.1 2005/12/18 15:51:31 iedowse Exp $   */
   3 /*      $DragonFly: src/sys/bus/usb/uhub.c,v 1.19 2007/11/06 07:37:00 hasso 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/docs/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 #include <sys/module.h>
  51 #include <sys/bus.h>
  52 #include <sys/lock.h>
  53 #include <sys/thread2.h>
  54 #include <sys/sysctl.h>
  55
  56 #include <bus/usb/usb.h>
  57 #include <bus/usb/usbdi.h>
  58 #include <bus/usb/usbdi_util.h>
  59 #include <bus/usb/usbdivar.h>
  60
  61 #define UHUB_INTR_INTERVAL 255  /* ms */
  62
  63 #ifdef USB_DEBUG
  64 #define DPRINTF(x)      if (uhubdebug) kprintf x
  65 #define DPRINTFN(n,x)   if (uhubdebug>(n)) kprintf x
  66 int     uhubdebug = 0;
  67 SYSCTL_NODE(_hw_usb, OID_AUTO, uhub, CTLFLAG_RW, 0, "USB uhub");
  68 SYSCTL_INT(_hw_usb_uhub, OID_AUTO, debug, CTLFLAG_RW,
  69            &uhubdebug, 0, "uhub debug level");
  70 #else
  71 #define DPRINTF(x)
  72 #define DPRINTFN(n,x)
  73 #endif
  74
  75 struct uhub_softc {
  76         device_t                sc_dev;         /* base device */
  77         usbd_device_handle      sc_hub;         /* USB device */
  78         usbd_pipe_handle        sc_ipipe;       /* interrupt pipe */
  79         u_int8_t                sc_status[1];   /* XXX more ports */
  80         u_char                  sc_running;
  81 };
  82 #define UHUB_PROTO(sc) ((sc)->sc_hub->ddesc.bDeviceProtocol)
  83 #define UHUB_IS_HIGH_SPEED(sc) (UHUB_PROTO(sc) != UDPROTO_FSHUB)
  84 #define UHUB_IS_SINGLE_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBSTT)
  85
  86 static usbd_status uhub_explore(usbd_device_handle hub);
  87 static void uhub_intr(usbd_xfer_handle, usbd_private_handle,usbd_status);
  88
  89 static bus_child_detached_t uhub_child_detached;
  90 static bus_child_location_str_t uhub_child_location_str;
  91 static bus_child_pnpinfo_str_t uhub_child_pnpinfo_str;
  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 static device_probe_t uhub_match;
 100 static device_attach_t uhub_attach;
 101 static device_detach_t uhub_detach;
 102
 103 static devclass_t uhub_devclass;
 104
 105 static kobj_method_t uhub_methods[] = {
 106         DEVMETHOD(device_probe, uhub_match),
 107         DEVMETHOD(device_attach, uhub_attach),
 108         DEVMETHOD(device_detach, uhub_detach),
 109         DEVMETHOD(bus_child_detached, uhub_child_detached),
 110         DEVMETHOD(bus_child_pnpinfo_str, uhub_child_pnpinfo_str),
 111         DEVMETHOD(bus_child_location_str, uhub_child_location_str),
 112         DEVMETHOD(bus_driver_added, bus_generic_driver_added),
 113         DEVMETHOD(device_suspend, bus_generic_suspend),
 114         DEVMETHOD(device_resume, bus_generic_resume),
 115         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 116         {0,0}
 117 };
 118
 119 static driver_t uhub_driver = {
 120         "uhub",
 121         uhub_methods,
 122         sizeof(struct uhub_softc)
 123 };
 124
 125 MODULE_DEPEND(uhub, usb, 1, 1, 1);
 126
 127 /* Create the driver instance for the hub connected to usb case. */
 128 devclass_t uhubroot_devclass;
 129
 130 static device_method_t uhubroot_methods[] = {
 131         DEVMETHOD(bus_child_detached, uhub_child_detached),
 132         DEVMETHOD(bus_child_location_str, uhub_child_location_str),
 133         DEVMETHOD(bus_child_pnpinfo_str, uhub_child_pnpinfo_str),
 134         DEVMETHOD(bus_driver_added, bus_generic_driver_added),
 135
 136         DEVMETHOD(device_probe, uhub_match),
 137         DEVMETHOD(device_attach, uhub_attach),
 138         DEVMETHOD(device_detach, uhub_detach),
 139         DEVMETHOD(device_suspend, bus_generic_suspend),
 140         DEVMETHOD(device_resume, bus_generic_resume),
 141         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 142         {0,0}
 143 };
 144
 145 static  driver_t uhubroot_driver = {
 146         "uhub",
 147         uhubroot_methods,
 148         sizeof(struct uhub_softc)
 149 };
 150
 151 static int
 152 uhub_match(device_t self)
 153 {
 154         struct usb_attach_arg *uaa = device_get_ivars(self);
 155         usb_device_descriptor_t *dd = usbd_get_device_descriptor(uaa->device);
 156
 157         DPRINTFN(5,("uhub_match, dd=%p\n", dd));
 158         /*
 159          * The subclass for hubs seems to be 0 for some and 1 for others,
 160          * so we just ignore the subclass.
 161          */
 162         if (uaa->iface == NULL && dd->bDeviceClass == UDCLASS_HUB)
 163                 return (UMATCH_DEVCLASS_DEVSUBCLASS);
 164         return (UMATCH_NONE);
 165 }
 166
 167 static int
 168 uhub_attach(device_t self)
 169 {
 170         struct uhub_softc *sc = device_get_softc(self);
 171         struct usb_attach_arg *uaa = device_get_ivars(self);
 172         usbd_device_handle dev = uaa->device;
 173         usbd_status err;
 174         struct usbd_hub *hub = NULL;
 175         usb_device_request_t req;
 176         usb_hub_descriptor_t hubdesc;
 177         int p, port, nports, nremov, pwrdly;
 178         usbd_interface_handle iface;
 179         usb_endpoint_descriptor_t *ed;
 180         struct usbd_tt *tts = NULL;
 181
 182         DPRINTFN(1,("uhub_attach\n"));
 183         sc->sc_hub = dev;
 184         sc->sc_dev = self;
 185
 186         if (dev->depth > 0 && UHUB_IS_HIGH_SPEED(sc)) {
 187                 kprintf("%s: %s transaction translator%s\n",
 188                     device_get_nameunit(sc->sc_dev),
 189                     UHUB_IS_SINGLE_TT(sc) ? "single" : "multiple",
 190                     UHUB_IS_SINGLE_TT(sc) ? "" : "s");
 191         }
 192         err = usbd_set_config_index(dev, 0, 1);
 193         if (err) {
 194                 DPRINTF(("%s: configuration failed, error=%s\n",
 195                          device_get_nameunit(sc->sc_dev), usbd_errstr(err)));
 196                 return ENXIO;
 197         }
 198
 199         if (dev->depth > USB_HUB_MAX_DEPTH) {
 200                 kprintf("%s: hub depth (%d) exceeded, hub ignored\n",
 201                        device_get_nameunit(sc->sc_dev), USB_HUB_MAX_DEPTH);
 202                 return ENXIO;
 203         }
 204
 205         /* Get hub descriptor. */
 206         req.bmRequestType = UT_READ_CLASS_DEVICE;
 207         req.bRequest = UR_GET_DESCRIPTOR;
 208         USETW2(req.wValue, (dev->address > 1 ? UDESC_HUB : 0), 0);
 209         USETW(req.wIndex, 0);
 210         USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE);
 211         DPRINTFN(1,("usb_init_hub: getting hub descriptor\n"));
 212         err = usbd_do_request(dev, &req, &hubdesc);
 213         nports = hubdesc.bNbrPorts;
 214         if (!err && nports > 7) {
 215                 USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE + (nports+1) / 8);
 216                 err = usbd_do_request(dev, &req, &hubdesc);
 217         }
 218         if (err) {
 219                 DPRINTF(("%s: getting hub descriptor failed, error=%s\n",
 220                          device_get_nameunit(sc->sc_dev), usbd_errstr(err)));
 221                 return ENXIO;
 222         }
 223
 224         for (nremov = 0, port = 1; port <= nports; port++)
 225                 if (!UHD_NOT_REMOV(&hubdesc, port))
 226                         nremov++;
 227         kprintf("%s: %d port%s with %d removable, %s powered\n",
 228                device_get_nameunit(sc->sc_dev), nports, nports != 1 ? "s" : "",
 229                nremov, dev->self_powered ? "self" : "bus");
 230
 231         if (nports == 0) {
 232                 kprintf("%s: no ports, hub ignored\n", device_get_nameunit(sc->sc_dev));
 233                 goto bad;
 234         }
 235
 236         hub = kmalloc(sizeof(*hub) + (nports-1) * sizeof(struct usbd_port),
 237                      M_USBDEV, M_WAITOK);
 238         dev->hub = hub;
 239         dev->hub->hubsoftc = sc;
 240         hub->explore = uhub_explore;
 241         hub->hubdesc = hubdesc;
 242
 243         DPRINTFN(1,("usbhub_init_hub: selfpowered=%d, parent=%p, "
 244                     "parent->selfpowered=%d\n",
 245                  dev->self_powered, dev->powersrc->parent,
 246                  dev->powersrc->parent ?
 247                  dev->powersrc->parent->self_powered : 0));
 248
 249         if (!dev->self_powered && dev->powersrc->parent != NULL &&
 250             !dev->powersrc->parent->self_powered) {
 251                 kprintf("%s: bus powered hub connected to bus powered hub, "
 252                        "ignored\n", device_get_nameunit(sc->sc_dev));
 253                 goto bad;
 254         }
 255
 256         /* Set up interrupt pipe. */
 257         err = usbd_device2interface_handle(dev, 0, &iface);
 258         if (err) {
 259                 kprintf("%s: no interface handle\n", device_get_nameunit(sc->sc_dev));
 260                 goto bad;
 261         }
 262         ed = usbd_interface2endpoint_descriptor(iface, 0);
 263         if (ed == NULL) {
 264                 kprintf("%s: no endpoint descriptor\n", device_get_nameunit(sc->sc_dev));
 265                 goto bad;
 266         }
 267         if ((ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
 268                 kprintf("%s: bad interrupt endpoint\n", device_get_nameunit(sc->sc_dev));
 269                 goto bad;
 270         }
 271
 272         err = usbd_open_pipe_intr(iface, ed->bEndpointAddress,
 273                   USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_status,
 274                   sizeof(sc->sc_status), uhub_intr, UHUB_INTR_INTERVAL);
 275         if (err) {
 276                 kprintf("%s: cannot open interrupt pipe\n",
 277                        device_get_nameunit(sc->sc_dev));
 278                 goto bad;
 279         }
 280
 281         /* Wait with power off for a while. */
 282         usbd_delay_ms(dev, USB_POWER_DOWN_TIME);
 283
 284         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, dev, sc->sc_dev);
 285
 286         /*
 287          * To have the best chance of success we do things in the exact same
 288          * order as Windoze98.  This should not be necessary, but some
 289          * devices do not follow the USB specs to the letter.
 290          *
 291          * These are the events on the bus when a hub is attached:
 292          *  Get device and config descriptors (see attach code)
 293          *  Get hub descriptor (see above)
 294          *  For all ports
 295          *     turn on power
 296          *     wait for power to become stable
 297          * (all below happens in explore code)
 298          *  For all ports
 299          *     clear C_PORT_CONNECTION
 300          *  For all ports
 301          *     get port status
 302          *     if device connected
 303          *        wait 100 ms
 304          *        turn on reset
 305          *        wait
 306          *        clear C_PORT_RESET
 307          *        get port status
 308          *        proceed with device attachment
 309          */
 310
 311         if (UHUB_IS_HIGH_SPEED(sc)) {
 312                 tts = kmalloc((UHUB_IS_SINGLE_TT(sc) ? 1 : nports) *
 313                               sizeof(struct usbd_tt), M_USBDEV, M_WAITOK);
 314         }
 315
 316         /* Set up data structures */
 317         for (p = 0; p < nports; p++) {
 318                 struct usbd_port *up = &hub->ports[p];
 319                 up->device = NULL;
 320                 up->parent = dev;
 321                 up->portno = p+1;
 322                 if (dev->self_powered)
 323                         /* Self powered hub, give ports maximum current. */
 324                         up->power = USB_MAX_POWER;
 325                 else
 326                         up->power = USB_MIN_POWER;
 327                 up->restartcnt = 0;
 328                 if (UHUB_IS_HIGH_SPEED(sc)) {
 329                         up->tt = &tts[UHUB_IS_SINGLE_TT(sc) ? 0 : p];
 330                         up->tt->hub = hub;
 331                 } else {
 332                         up->tt = NULL;
 333                 }
 334         }
 335
 336         /* XXX should check for none, individual, or ganged power? */
 337
 338         pwrdly = dev->hub->hubdesc.bPwrOn2PwrGood * UHD_PWRON_FACTOR
 339             + USB_EXTRA_POWER_UP_TIME;
 340         for (port = 1; port <= nports; port++) {
 341                 /* Turn the power on. */
 342                 err = usbd_set_port_feature(dev, port, UHF_PORT_POWER);
 343                 if (err)
 344                         kprintf("%s: port %d power on failed, %s\n",
 345                                device_get_nameunit(sc->sc_dev), port,
 346                                usbd_errstr(err));
 347                 DPRINTF(("usb_init_port: turn on port %d power\n", port));
 348                 /* Wait for stable power. */
 349                 usbd_delay_ms(dev, pwrdly);
 350         }
 351
 352         /* The usual exploration will finish the setup. */
 353
 354         sc->sc_running = 1;
 355
 356         return 0;
 357
 358  bad:
 359         if (hub)
 360                 kfree(hub, M_USBDEV);
 361         dev->hub = NULL;
 362         return ENXIO;
 363 }
 364
 365 usbd_status
 366 uhub_explore(usbd_device_handle dev)
 367 {
 368         usb_hub_descriptor_t *hd = &dev->hub->hubdesc;
 369         struct uhub_softc *sc = dev->hub->hubsoftc;
 370         struct usbd_port *up;
 371         usbd_status err;
 372         int speed;
 373         int port;
 374         int change, status;
 375
 376         DPRINTFN(10, ("uhub_explore dev=%p addr=%d\n", dev, dev->address));
 377
 378         if (!sc->sc_running)
 379                 return (USBD_NOT_STARTED);
 380
 381         /* Ignore hubs that are too deep. */
 382         if (dev->depth > USB_HUB_MAX_DEPTH)
 383                 return (USBD_TOO_DEEP);
 384
 385         for(port = 1; port <= hd->bNbrPorts; port++) {
 386                 up = &dev->hub->ports[port-1];
 387                 err = usbd_get_port_status(dev, port, &up->status);
 388                 if (err) {
 389                         DPRINTF(("uhub_explore: get port status failed, "
 390                                  "error=%s\n", usbd_errstr(err)));
 391                         continue;
 392                 }
 393                 status = UGETW(up->status.wPortStatus);
 394                 change = UGETW(up->status.wPortChange);
 395                 DPRINTFN(3,("uhub_explore: %s port %d status 0x%04x 0x%04x\n",
 396                             device_get_nameunit(sc->sc_dev), port, status, change));
 397                 if (change & UPS_C_PORT_ENABLED) {
 398                         DPRINTF(("uhub_explore: C_PORT_ENABLED 0x%x\n", change));
 399                         usbd_clear_port_feature(dev, port, UHF_C_PORT_ENABLE);
 400                         if (change & UPS_C_CONNECT_STATUS) {
 401                                 /* Ignore the port error if the device
 402                                    vanished. */
 403                         } else if (status & UPS_PORT_ENABLED) {
 404                                 kprintf("%s: illegal enable change, port %d\n",
 405                                        device_get_nameunit(sc->sc_dev), port);
 406                         } else {
 407                                 /* Port error condition. */
 408                                 if (up->restartcnt) /* no message first time */
 409                                         kprintf("%s: port error, restarting "
 410                                                "port %d\n",
 411                                                device_get_nameunit(sc->sc_dev), port);
 412
 413                                 if (up->restartcnt++ < USBD_RESTART_MAX)
 414                                         goto disco;
 415                                 else
 416                                         kprintf("%s: port error, giving up "
 417                                                "port %d\n",
 418                                           device_get_nameunit(sc->sc_dev), port);
 419                         }
 420                 }
 421                 if (!(change & UPS_C_CONNECT_STATUS)) {
 422                         DPRINTFN(3,("uhub_explore: port=%d !C_CONNECT_"
 423                                     "STATUS\n", port));
 424                         /* No status change, just do recursive explore. */
 425                         if (up->device != NULL && up->device->hub != NULL)
 426                                 up->device->hub->explore(up->device);
 427 #if 0 && defined(DIAGNOSTIC)
 428                         if (up->device == NULL &&
 429                             (status & UPS_CURRENT_CONNECT_STATUS))
 430                                 kprintf("%s: connected, no device\n",
 431                                        device_get_nameunit(sc->sc_dev));
 432 #endif
 433                         continue;
 434                 }
 435
 436                 /* We have a connect status change, handle it. */
 437
 438                 DPRINTF(("uhub_explore: status change hub=%d port=%d\n",
 439                          dev->address, port));
 440                 usbd_clear_port_feature(dev, port, UHF_C_PORT_CONNECTION);
 441                 /*usbd_clear_port_feature(dev, port, UHF_C_PORT_ENABLE);*/
 442                 /*
 443                  * If there is already a device on the port the change status
 444                  * must mean that is has disconnected.  Looking at the
 445                  * current connect status is not enough to figure this out
 446                  * since a new unit may have been connected before we handle
 447                  * the disconnect.
 448                  */
 449         disco:
 450                 if (up->device != NULL) {
 451                         /* Disconnected */
 452                         DPRINTF(("uhub_explore: device addr=%d disappeared "
 453                                  "on port %d\n", up->device->address, port));
 454                         usb_disconnect_port(up, sc->sc_dev);
 455                         usbd_clear_port_feature(dev, port,
 456                                                 UHF_C_PORT_CONNECTION);
 457                 }
 458                 if (!(status & UPS_CURRENT_CONNECT_STATUS)) {
 459                         /* Nothing connected, just ignore it. */
 460                         DPRINTFN(3,("uhub_explore: port=%d !CURRENT_CONNECT"
 461                                     "_STATUS\n", port));
 462                         continue;
 463                 }
 464
 465                 /* Connected */
 466
 467                 if (!(status & UPS_PORT_POWER))
 468                         kprintf("%s: strange, connected port %d has no power\n",
 469                                device_get_nameunit(sc->sc_dev), port);
 470
 471                 /* Wait for maximum device power up time. */
 472                 usbd_delay_ms(dev, USB_PORT_POWERUP_DELAY);
 473
 474                 /* Reset port, which implies enabling it. */
 475                 if (usbd_reset_port(dev, port, &up->status)) {
 476                         kprintf("%s: port %d reset failed\n",
 477                                device_get_nameunit(sc->sc_dev), port);
 478                         continue;
 479                 }
 480                 /* Get port status again, it might have changed during reset */
 481                 err = usbd_get_port_status(dev, port, &up->status);
 482                 if (err) {
 483                         DPRINTF(("uhub_explore: get port status failed, "
 484                                  "error=%s\n", usbd_errstr(err)));
 485                         continue;
 486                 }
 487                 status = UGETW(up->status.wPortStatus);
 488                 change = UGETW(up->status.wPortChange);
 489                 if (!(status & UPS_CURRENT_CONNECT_STATUS)) {
 490                         /* Nothing connected, just ignore it. */
 491 #ifdef DIAGNOSTIC
 492                         kprintf("%s: port %d, device disappeared after reset\n",
 493                                device_get_nameunit(sc->sc_dev), port);
 494 #endif
 495                         continue;
 496                 }
 497
 498 #if 0
 499                 if (UHUB_IS_HIGH_SPEED(sc) && !(status & UPS_HIGH_SPEED)) {
 500                         kprintf("%s: port %d, transaction translation not "
 501                             "implemented, low/full speed device ignored\n",
 502                             device_get_nameunit(sc->sc_dev), port);
 503                         continue;
 504                 }
 505 #endif
 506
 507                 /* Figure out device speed */
 508                 if (status & UPS_HIGH_SPEED)
 509                         speed = USB_SPEED_HIGH;
 510                 else if (status & UPS_LOW_SPEED)
 511                         speed = USB_SPEED_LOW;
 512                 else
 513                         speed = USB_SPEED_FULL;
 514                 /* Get device info and set its address. */
 515                 err = usbd_new_device(sc->sc_dev, dev->bus,
 516                     dev->depth + 1, speed, port, up);
 517                 /* XXX retry a few times? */
 518                 if (err) {
 519                         DPRINTFN(-1,("uhub_explore: usb_new_device failed, "
 520                                      "error=%s\n", usbd_errstr(err)));
 521                         /* Avoid addressing problems by disabling. */
 522                         /* usbd_reset_port(dev, port, &up->status); */
 523
 524                         /*
 525                          * The unit refused to accept a new address, or had
 526                          * some other serious problem.  Since we cannot leave
 527                          * at 0 we have to disable the port instead.
 528                          */
 529                         kprintf("%s: device problem (%s), disabling port %d\n",
 530                                device_get_nameunit(sc->sc_dev), usbd_errstr(err), port);
 531                         usbd_clear_port_feature(dev, port, UHF_PORT_ENABLE);
 532                 } else {
 533                         /* The port set up succeeded, reset error count. */
 534                         up->restartcnt = 0;
 535
 536                         if (up->device->hub)
 537                                 up->device->hub->explore(up->device);
 538                 }
 539         }
 540         return (USBD_NORMAL_COMPLETION);
 541 }
 542
 543 /*
 544  * Called from process context when the hub is gone.
 545  * Detach all devices on active ports.
 546  */
 547 static int
 548 uhub_detach(device_t self)
 549 {
 550         struct uhub_softc *sc = device_get_softc(self);
 551         struct usbd_hub *hub = sc->sc_hub->hub;
 552         struct usbd_port *rup;
 553         int port, nports;
 554
 555         DPRINTF(("uhub_detach: sc=%port\n", sc));
 556
 557         crit_enter();
 558
 559         if (hub == NULL) {              /* Must be partially working */
 560                 crit_exit();
 561                 return (0);
 562         }
 563
 564         usbd_abort_pipe(sc->sc_ipipe);
 565         usbd_close_pipe(sc->sc_ipipe);
 566
 567         nports = hub->hubdesc.bNbrPorts;
 568         for(port = 0; port < nports; port++) {
 569                 rup = &hub->ports[port];
 570                 if (rup->device)
 571                         usb_disconnect_port(rup, self);
 572         }
 573
 574         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_hub,
 575                            sc->sc_dev);
 576
 577         if (hub->ports[0].tt)
 578                 kfree(hub->ports[0].tt, M_USBDEV);
 579         kfree(hub, M_USBDEV);
 580         sc->sc_hub->hub = NULL;
 581
 582         crit_exit();
 583
 584         return (0);
 585 }
 586
 587 int
 588 uhub_child_location_str(device_t cbdev, device_t child, char *buf,
 589     size_t buflen)
 590 {
 591         struct uhub_softc *sc = device_get_softc(cbdev);
 592         usbd_device_handle devhub = sc->sc_hub;
 593         usbd_device_handle dev;
 594         int nports;
 595         int port;
 596         int i;
 597
 598         crit_enter();
 599         nports = devhub->hub->hubdesc.bNbrPorts;
 600         for (port = 0; port < nports; port++) {
 601                 dev = devhub->hub->ports[port].device;
 602                 if (dev && dev->subdevs) {
 603                         for (i = 0; dev->subdevs[i]; i++) {
 604                                 if (dev->subdevs[i] == child) {
 605                                         if (dev->ifacenums == NULL) {
 606                                                 ksnprintf(buf, buflen,
 607                                                     "port=%i", port);
 608                                         } else {
 609                                                 ksnprintf(buf, buflen,
 610                                                     "port=%i interface=%i",
 611                                                     port, dev->ifacenums[i]);
 612                                         }
 613                                         goto found_dev;
 614                                 }
 615                         }
 616                 }
 617         }
 618         DPRINTFN(0,("uhub_child_location_str: device not on hub\n"));
 619         buf[0] = '\0';
 620 found_dev:
 621         crit_exit();
 622         return (0);
 623 }
 624
 625 int
 626 uhub_child_pnpinfo_str(device_t cbdev, device_t child, char *buf,
 627     size_t buflen)
 628 {
 629         struct uhub_softc *sc = device_get_softc(cbdev);
 630         usbd_device_handle devhub = sc->sc_hub;
 631         usbd_device_handle dev;
 632         struct usbd_interface *iface;
 633         char serial[128];
 634         int nports;
 635         int port;
 636         int i;
 637
 638         crit_enter();
 639         nports = devhub->hub->hubdesc.bNbrPorts;
 640         for (port = 0; port < nports; port++) {
 641                 dev = devhub->hub->ports[port].device;
 642                 if (dev && dev->subdevs) {
 643                         for (i = 0; dev->subdevs[i]; i++) {
 644                                 if (dev->subdevs[i] == child) {
 645                                         goto found_dev;
 646                                 }
 647                         }
 648                 }
 649         }
 650         DPRINTFN(0,("uhub_child_pnpinfo_str: device not on hub\n"));
 651         buf[0] = '\0';
 652         crit_exit();
 653         return (0);
 654
 655 found_dev:
 656         /* XXX can sleep */
 657         (void)usbd_get_string(dev, dev->ddesc.iSerialNumber, &serial[0]);
 658         if (dev->ifacenums == NULL) {
 659                 ksnprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
 660                     "devclass=0x%02x devsubclass=0x%02x "
 661                     "release=0x%04x sernum=\"%s\"",
 662                     UGETW(dev->ddesc.idVendor), UGETW(dev->ddesc.idProduct),
 663                     dev->ddesc.bDeviceClass, dev->ddesc.bDeviceSubClass,
 664                     UGETW(dev->ddesc.bcdDevice), serial);
 665         } else {
 666                 iface = &dev->ifaces[dev->ifacenums[i]];
 667                 ksnprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
 668                     "devclass=0x%02x devsubclass=0x%02x "
 669                     "release=0x%04x sernum=\"%s\" "
 670                     "intclass=0x%02x intsubclass=0x%02x",
 671                     UGETW(dev->ddesc.idVendor), UGETW(dev->ddesc.idProduct),
 672                     dev->ddesc.bDeviceClass, dev->ddesc.bDeviceSubClass,
 673                     UGETW(dev->ddesc.bcdDevice), serial,
 674                     iface->idesc->bInterfaceClass,
 675                     iface->idesc->bInterfaceSubClass);
 676         }
 677         crit_exit();
 678         return (0);
 679 }
 680
 681 static void
 682 uhub_child_detached(device_t self, device_t child)
 683 {
 684         struct uhub_softc *sc = device_get_softc(self);
 685         usbd_device_handle devhub = sc->sc_hub;
 686         usbd_device_handle dev = NULL;
 687         int nports, port, i = 0;
 688
 689         crit_enter();
 690         nports = devhub->hub->hubdesc.bNbrPorts;
 691         for (port = 0; port < nports; port++) {
 692                 dev = devhub->hub->ports[port].device;
 693                 if (dev && dev->subdevs) {
 694                         for (i = 0; dev->subdevs[i]; ++i) {
 695                                 if (dev->subdevs[i] == child)
 696                                         goto found_dev;
 697                         }
 698                 }
 699         }
 700         crit_exit();
 701         return;
 702
 703 found_dev:
 704 #if 0
 705         kprintf("%s: at %s", device_get_nameunit(dev->subdevs[i]),
 706                device_get_nameunit(self));
 707         if (port != 0)
 708                 kprintf(" port %d", port);
 709         kprintf(" (addr %d) disconnected\n", dev->address);
 710 #endif
 711         kfree(device_get_ivars(dev->subdevs[i]), M_USB);
 712         dev->subdevs[i] = NULL;
 713         crit_exit();
 714 }
 715
 716 /*
 717  * Hub interrupt.
 718  * This an indication that some port has changed status.
 719  * Notify the bus event handler thread that we need
 720  * to be explored again.
 721  */
 722 void
 723 uhub_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
 724 {
 725         struct uhub_softc *sc = addr;
 726
 727         DPRINTFN(5,("uhub_intr: sc=%p\n", sc));
 728         if (status == USBD_STALLED)
 729                 usbd_clear_endpoint_stall_async(sc->sc_ipipe);
 730         else if (status == USBD_NORMAL_COMPLETION)
 731                 usb_needs_explore(sc->sc_hub);
 732 }
 733
 734 DRIVER_MODULE(uhub, usb, uhubroot_driver, uhubroot_devclass, 0, 0);
 735 DRIVER_MODULE(uhub, uhub, uhub_driver, uhub_devclass, usbd_driver_load, 0);