sys/bus/usb/usb.c

   1 /*
   2  * $NetBSD: usb.c,v 1.68 2002/02/20 20:30:12 christos Exp $
   3  * $FreeBSD: src/sys/dev/usb/usb.c,v 1.106 2005/03/27 15:31:23 iedowse Exp $
   4  * $DragonFly: src/sys/bus/usb/usb.c,v 1.39 2007/07/03 19:28:16 hasso Exp $
   5  */
   6
   7 /* Also already merged from NetBSD:
   8  *      $NetBSD: usb.c,v 1.70 2002/05/09 21:54:32 augustss Exp $
   9  *      $NetBSD: usb.c,v 1.71 2002/06/01 23:51:04 lukem Exp $
  10  *      $NetBSD: usb.c,v 1.73 2002/09/23 05:51:19 simonb Exp $
  11  *      $NetBSD: usb.c,v 1.80 2003/11/07 17:03:25 wiz Exp $
  12  */
  13
  14 /*
  15  * Copyright (c) 1998 The NetBSD Foundation, Inc.
  16  * All rights reserved.
  17  *
  18  * This code is derived from software contributed to The NetBSD Foundation
  19  * by Lennart Augustsson (lennart@augustsson.net) at
  20  * Carlstedt Research & Technology.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the above copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *        This product includes software developed by the NetBSD
  33  *        Foundation, Inc. and its contributors.
  34  * 4. Neither the name of The NetBSD Foundation nor the names of its
  35  *    contributors may be used to endorse or promote products derived
  36  *    from this software without specific prior written permission.
  37  *
  38  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  39  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  40  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  42  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  43  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  44  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  45  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  46  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  47  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  48  * POSSIBILITY OF SUCH DAMAGE.
  49  */
  50
  51 /*
  52  * USB specifications and other documentation can be found at
  53  * http://www.usb.org/developers/docs/ and
  54  * http://www.usb.org/developers/devclass_docs/
  55  */
  56
  57 #include <sys/param.h>
  58 #include <sys/systm.h>
  59 #include <sys/kernel.h>
  60 #include <sys/lock.h>
  61 #include <sys/malloc.h>
  62 #include <sys/unistd.h>
  63 #include <sys/module.h>
  64 #include <sys/bus.h>
  65 #include <sys/fcntl.h>
  66 #include <sys/filio.h>
  67 #include <sys/uio.h>
  68 #include <sys/kthread.h>
  69 #include <sys/proc.h>
  70 #include <sys/conf.h>
  71 #include <sys/device.h>
  72 #include <sys/poll.h>
  73 #include <sys/select.h>
  74 #include <sys/vnode.h>
  75 #include <sys/signalvar.h>
  76 #include <sys/sysctl.h>
  77 #include <sys/thread2.h>
  78
  79 #include <bus/usb/usb.h>
  80 #include <bus/usb/usbdi.h>
  81 #include <bus/usb/usbdi_util.h>
  82
  83 #define USBUNIT(d)      (minor(d))      /* usb_discover device nodes, kthread */
  84 #define USB_DEV_MINOR   255             /* event queue device */
  85
  86 MALLOC_DEFINE(M_USB, "USB", "USB");
  87 MALLOC_DEFINE(M_USBDEV, "USBdev", "USB device");
  88 MALLOC_DEFINE(M_USBHC, "USBHC", "USB host controller");
  89
  90 #include "usb_if.h"
  91
  92 #include <bus/usb/usbdivar.h>
  93 #include <bus/usb/usb_quirks.h>
  94
  95 /* Define this unconditionally in case a kernel module is loaded that
  96  * has been compiled with debugging options.
  97  */
  98 SYSCTL_NODE(_hw, OID_AUTO, usb, CTLFLAG_RW, 0, "USB debugging");
  99
 100 #ifdef USB_DEBUG
 101 #define DPRINTF(x)      if (usbdebug) kprintf x
 102 #define DPRINTFN(n,x)   if (usbdebug>(n)) kprintf x
 103 int     usbdebug = 0;
 104 SYSCTL_INT(_hw_usb, OID_AUTO, debug, CTLFLAG_RW,
 105            &usbdebug, 0, "usb debug level");
 106 /*
 107  * 0  - do usual exploration
 108  * 1  - do not use timeout exploration
 109  * >1 - do no exploration
 110  */
 111 int     usb_noexplore = 0;
 112 #else
 113 #define DPRINTF(x)
 114 #define DPRINTFN(n,x)
 115 #endif
 116
 117 struct usb_softc {
 118         device_t        sc_dev;         /* base device */
 119         cdev_t          sc_usbdev;
 120         usbd_bus_handle sc_bus;         /* USB controller */
 121         struct usbd_port sc_port;       /* dummy port for root hub */
 122
 123         struct thread   *sc_event_thread;
 124
 125         char            sc_dying;
 126 };
 127
 128 struct usb_taskq {
 129         TAILQ_HEAD(, usb_task)  tasks;
 130         struct thread           *task_thread_proc;
 131         const char              *name;
 132         int                     taskcreated;    /* task thread exists. */
 133 };
 134 static struct usb_taskq usb_taskq[USB_NUM_TASKQS];
 135
 136 d_open_t  usbopen;
 137 d_close_t usbclose;
 138 d_read_t usbread;
 139 d_ioctl_t usbioctl;
 140 d_poll_t usbpoll;
 141
 142 struct dev_ops usb_ops = {
 143         { "usb", USB_CDEV_MAJOR, 0 },
 144         .d_open =       usbopen,
 145         .d_close =      usbclose,
 146         .d_read =       usbread,
 147         .d_ioctl =      usbioctl,
 148         .d_poll =       usbpoll,
 149 };
 150
 151 static void     usb_discover(void *);
 152 static bus_child_detached_t usb_child_detached;
 153 static void     usb_create_event_thread(void *);
 154 static void     usb_event_thread(void *);
 155 static void     usb_task_thread(void *);
 156
 157 static cdev_t usb_dev;          /* The /dev/usb device. */
 158 static int usb_ndevs;                   /* Number of /dev/usbN devices. */
 159
 160 #define USB_MAX_EVENTS 100
 161 struct usb_event_q {
 162         struct usb_event ue;
 163         TAILQ_ENTRY(usb_event_q) next;
 164 };
 165 static TAILQ_HEAD(, usb_event_q) usb_events =
 166         TAILQ_HEAD_INITIALIZER(usb_events);
 167 static int usb_nevents = 0;
 168 static struct selinfo usb_selevent;
 169 static struct proc *usb_async_proc;  /* process that wants USB SIGIO */
 170 static int usb_dev_open = 0;
 171 static void usb_add_event(int, struct usb_event *);
 172
 173 static int usb_get_next_event(struct usb_event *);
 174
 175 static const char *usbrev_str[] = USBREV_STR;
 176
 177 static device_probe_t usb_match;
 178 static device_attach_t usb_attach;
 179 static device_detach_t usb_detach;
 180
 181 static devclass_t usb_devclass;
 182
 183 static kobj_method_t usb_methods[] = {
 184         DEVMETHOD(device_probe, usb_match),
 185         DEVMETHOD(device_attach, usb_attach),
 186         DEVMETHOD(device_detach, usb_detach),
 187         DEVMETHOD(bus_child_detached, usb_child_detached),
 188         DEVMETHOD(device_suspend, bus_generic_suspend),
 189         DEVMETHOD(device_resume, bus_generic_resume),
 190         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 191         {0,0}
 192 };
 193
 194 static driver_t usb_driver = {
 195         "usb",
 196         usb_methods,
 197         sizeof(struct usb_softc)
 198 };
 199
 200 MODULE_DEPEND(usb, usb, 1, 1, 1);
 201 MODULE_VERSION(usb, 1);
 202
 203 static int
 204 usb_match(device_t self)
 205 {
 206         DPRINTF(("usbd_match\n"));
 207         return (UMATCH_GENERIC);
 208 }
 209
 210 static int
 211 usb_attach(device_t self)
 212 {
 213         struct usb_softc *sc = device_get_softc(self);
 214         void *aux = device_get_ivars(self);
 215         cdev_t tmp_dev;
 216         usbd_device_handle dev;
 217         usbd_status err;
 218         int usbrev;
 219         int speed;
 220         struct usb_event ue;
 221
 222         sc->sc_dev = self;
 223
 224         DPRINTF(("usbd_attach\n"));
 225
 226         usbd_init();
 227         sc->sc_bus = aux;
 228         sc->sc_bus->usbctl = sc;
 229         sc->sc_port.power = USB_MAX_POWER;
 230
 231         kprintf("%s", device_get_nameunit(sc->sc_dev));
 232         usbrev = sc->sc_bus->usbrev;
 233         kprintf(": USB revision %s", usbrev_str[usbrev]);
 234         switch (usbrev) {
 235         case USBREV_1_0:
 236         case USBREV_1_1:
 237                 speed = USB_SPEED_FULL;
 238                 break;
 239         case USBREV_2_0:
 240                 speed = USB_SPEED_HIGH;
 241                 break;
 242         default:
 243                 kprintf(", not supported\n");
 244                 sc->sc_dying = 1;
 245                 return ENXIO;
 246         }
 247         kprintf("\n");
 248
 249 #if 0
 250         /* Make sure not to use tsleep() if we are cold booting. */
 251         if (cold)
 252                 sc->sc_bus->use_polling++;
 253 #endif
 254
 255         ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
 256         usb_add_event(USB_EVENT_CTRLR_ATTACH, &ue);
 257
 258 #ifdef USB_USE_SOFTINTR
 259 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
 260         /* XXX we should have our own level */
 261         sc->sc_bus->soft = softintr_establish(IPL_SOFTNET,
 262             sc->sc_bus->methods->soft_intr, sc->sc_bus);
 263         if (sc->sc_bus->soft == NULL) {
 264                 kprintf("%s: can't register softintr\n", device_get_nameunit(sc->sc_dev));
 265                 sc->sc_dying = 1;
 266                 return ENXIO;
 267         }
 268 #else
 269         callout_init(&sc->sc_bus->softi);
 270 #endif
 271 #endif
 272
 273         err = usbd_new_device(sc->sc_dev, sc->sc_bus, 0, speed, 0,
 274                   &sc->sc_port);
 275         if (!err) {
 276                 dev = sc->sc_port.device;
 277                 if (dev->hub == NULL) {
 278                         sc->sc_dying = 1;
 279                         kprintf("%s: root device is not a hub\n",
 280                                device_get_nameunit(sc->sc_dev));
 281                         return ENXIO;
 282                 }
 283                 sc->sc_bus->root_hub = dev;
 284 #if 1
 285                 /*
 286                  * Turning this code off will delay attachment of USB devices
 287                  * until the USB event thread is running, which means that
 288                  * the keyboard will not work until after cold boot.
 289                  */
 290                 if (cold) {
 291                         /*
 292                          * XXX Exploring high speed device here will
 293                          * hang the system.
 294                          */
 295                         if (speed != USB_SPEED_HIGH)
 296                                 dev->hub->explore(sc->sc_bus->root_hub);
 297                 }
 298 #endif
 299         } else {
 300                 kprintf("%s: root hub problem, error=%d\n",
 301                        device_get_nameunit(sc->sc_dev), err);
 302                 sc->sc_dying = 1;
 303         }
 304 #if 0
 305         if (cold)
 306                 sc->sc_bus->use_polling--;
 307 #endif
 308
 309         usb_create_event_thread(sc);
 310         /* The per controller devices (used for usb_discover) */
 311         /* XXX This is redundant now, but old usbd's will want it */
 312         dev_ops_add(&usb_ops, -1, device_get_unit(self));
 313         tmp_dev = make_dev(&usb_ops, device_get_unit(self),
 314                            UID_ROOT, GID_OPERATOR, 0660,
 315                            "usb%d", device_get_unit(self));
 316         sc->sc_usbdev = reference_dev(tmp_dev);
 317         if (usb_ndevs++ == 0) {
 318                 /* The device spitting out events */
 319                 dev_ops_add(&usb_ops, -1, USB_DEV_MINOR);
 320                 tmp_dev = make_dev(&usb_ops, USB_DEV_MINOR,
 321                                    UID_ROOT, GID_OPERATOR, 0660, "usb");
 322                 usb_dev = reference_dev(tmp_dev);
 323         }
 324
 325         return 0;
 326 }
 327
 328 static const char *taskq_names[] = USB_TASKQ_NAMES;
 329
 330 void
 331 usb_create_event_thread(void *arg)
 332 {
 333         struct usb_softc *sc = arg;
 334         int i;
 335
 336         if (kthread_create(usb_event_thread, sc, &sc->sc_event_thread,
 337                            "%s", device_get_nameunit(sc->sc_dev))) {
 338                 kprintf("%s: unable to create event thread for\n",
 339                        device_get_nameunit(sc->sc_dev));
 340                 panic("usb_create_event_thread");
 341         }
 342
 343         for (i = 0; i < USB_NUM_TASKQS; i++) {
 344                 struct usb_taskq *taskq = &usb_taskq[i];
 345
 346                 if (taskq->taskcreated == 0) {
 347                         taskq->taskcreated = 1;
 348                         taskq->name = taskq_names[i];
 349                         TAILQ_INIT(&taskq->tasks);
 350                         if (kthread_create(usb_task_thread, taskq,
 351                             &taskq->task_thread_proc, taskq->name)) {
 352                                 kprintf("unable to create task thread\n");
 353                                 panic("usb_create_event_thread task");
 354                         }
 355                 }
 356         }
 357 }
 358
 359 /*
 360  * Add a task to be performed by the task thread.  This function can be
 361  * called from any context and the task will be executed in a process
 362  * context ASAP.
 363  */
 364 void
 365 usb_add_task(usbd_device_handle dev, struct usb_task *task, int queue)
 366 {
 367         struct usb_taskq *taskq;
 368
 369         crit_enter();
 370
 371         taskq = &usb_taskq[queue];
 372         if (task->queue == -1) {
 373                 DPRINTFN(2,("usb_add_task: task=%p\n", task));
 374                 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
 375                 task->queue = queue;
 376         } else {
 377                 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
 378         }
 379         wakeup(&taskq->tasks);
 380
 381         crit_exit();
 382 }
 383
 384 void
 385 usb_do_task(usbd_device_handle dev, struct usb_task *task, int queue,
 386             int time_out)
 387 {
 388         struct usb_taskq *taskq;
 389
 390         crit_enter();
 391
 392         taskq = &usb_taskq[queue];
 393         if (task->queue == -1) {
 394                 DPRINTFN(2,("usb_add_task: task=%p\n", task));
 395                 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
 396                 task->queue = queue;
 397         } else {
 398                 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
 399         }
 400         wakeup(&taskq->tasks);
 401
 402         /* Wait until task is finished */
 403         tsleep((&taskq->tasks + 1), 0, "usbdotsk", time_out);
 404
 405         crit_exit();
 406 }
 407
 408 void
 409 usb_rem_task(usbd_device_handle dev, struct usb_task *task)
 410 {
 411         crit_enter();
 412         if (task->queue != -1) {
 413                 TAILQ_REMOVE(&usb_taskq[task->queue].tasks, task, next);
 414                 task->queue = -1;
 415         }
 416         crit_exit();
 417 }
 418
 419 void
 420 usb_event_thread(void *arg)
 421 {
 422         struct usb_softc *sc = arg;
 423
 424         DPRINTF(("usb_event_thread: start\n"));
 425
 426         /*
 427          * In case this controller is a companion controller to an
 428          * EHCI controller we need to wait until the EHCI controller
 429          * has grabbed the port.
 430          * XXX It would be nicer to do this with a tsleep(), but I don't
 431          * know how to synchronize the creation of the threads so it
 432          * will work.
 433          */
 434         usb_delay_ms(sc->sc_bus, 500);
 435
 436         crit_enter();
 437
 438         /* Make sure first discover does something. */
 439         sc->sc_bus->needs_explore = 1;
 440         usb_discover(sc);
 441
 442         while (!sc->sc_dying) {
 443 #ifdef USB_DEBUG
 444                 if (usb_noexplore < 2)
 445 #endif
 446                 usb_discover(sc);
 447 #ifdef USB_DEBUG
 448                 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt",
 449                        usb_noexplore ? 0 : hz * 60);
 450 #else
 451                 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt", hz * 60);
 452 #endif
 453                 DPRINTFN(2,("usb_event_thread: woke up\n"));
 454         }
 455         sc->sc_event_thread = NULL;
 456
 457         crit_exit();
 458
 459         /* In case parent is waiting for us to exit. */
 460         wakeup(sc);
 461
 462         DPRINTF(("usb_event_thread: exit\n"));
 463         kthread_exit();
 464 }
 465
 466 void
 467 usb_task_thread(void *arg)
 468 {
 469         struct usb_task *task;
 470         struct usb_taskq *taskq;
 471
 472         crit_enter();
 473
 474         taskq = arg;
 475         DPRINTF(("usb_task_thread: start taskq %s\n", taskq->name));
 476
 477         while (usb_ndevs > 0) {
 478                 task = TAILQ_FIRST(&taskq->tasks);
 479                 if (task == NULL) {
 480                         tsleep(&taskq->tasks, 0, "usbtsk", 0);
 481                         task = TAILQ_FIRST(&taskq->tasks);
 482                 }
 483                 DPRINTFN(2,("usb_task_thread: woke up task=%p\n", task));
 484                 if (task != NULL) {
 485                         TAILQ_REMOVE(&taskq->tasks, task, next);
 486                         task->queue = -1;
 487                         crit_exit();
 488                         task->fun(task->arg);
 489                         crit_enter();
 490                         wakeup((&taskq->tasks + 1));
 491                 }
 492         }
 493
 494         crit_exit();
 495
 496         taskq->taskcreated = 0;
 497         wakeup(&taskq->taskcreated);
 498
 499         DPRINTF(("usb_event_thread: exit\n"));
 500 }
 501
 502 int
 503 usbopen(struct dev_open_args *ap)
 504 {
 505         cdev_t dev = ap->a_head.a_dev;
 506         int unit = USBUNIT(dev);
 507         struct usb_softc *sc;
 508
 509         if (unit == USB_DEV_MINOR) {
 510                 if (usb_dev_open)
 511                         return (EBUSY);
 512                 usb_dev_open = 1;
 513                 usb_async_proc = NULL;
 514                 return (0);
 515         }
 516
 517         sc = devclass_get_softc(usb_devclass, unit);
 518         if (sc == NULL)
 519                 return (ENXIO);
 520
 521         if (sc->sc_dying)
 522                 return (EIO);
 523
 524         return (0);
 525 }
 526
 527 int
 528 usbread(struct dev_read_args *ap)
 529 {
 530         cdev_t dev = ap->a_head.a_dev;
 531         struct uio *uio = ap->a_uio;
 532         struct usb_event ue;
 533         int unit = USBUNIT(dev);
 534         int error, n;
 535
 536         if (unit != USB_DEV_MINOR)
 537                 return (ENODEV);
 538
 539         if (uio->uio_resid != sizeof(struct usb_event))
 540                 return (EINVAL);
 541
 542         error = 0;
 543         crit_enter();
 544         for (;;) {
 545                 n = usb_get_next_event(&ue);
 546                 if (n != 0)
 547                         break;
 548                 if (ap->a_ioflag & IO_NDELAY) {
 549                         error = EWOULDBLOCK;
 550                         break;
 551                 }
 552                 error = tsleep(&usb_events, PCATCH, "usbrea", 0);
 553                 if (error)
 554                         break;
 555         }
 556         crit_exit();
 557         if (!error)
 558                 error = uiomove((void *)&ue, uio->uio_resid, uio);
 559
 560         return (error);
 561 }
 562
 563 int
 564 usbclose(struct dev_close_args *ap)
 565 {
 566         cdev_t dev = ap->a_head.a_dev;
 567         int unit = USBUNIT(dev);
 568
 569         if (unit == USB_DEV_MINOR) {
 570                 usb_async_proc = NULL;
 571                 usb_dev_open = 0;
 572         }
 573
 574         return (0);
 575 }
 576
 577 int
 578 usbioctl(struct dev_ioctl_args *ap)
 579 {
 580         cdev_t devt = ap->a_head.a_dev;
 581         struct usb_softc *sc;
 582         int unit = USBUNIT(devt);
 583
 584         if (unit == USB_DEV_MINOR) {
 585                 switch (ap->a_cmd) {
 586                 case FIOASYNC:
 587                         if (*(int *)ap->a_data)
 588                                 usb_async_proc = curproc;
 589                         else
 590                                 usb_async_proc = NULL;
 591                         return (0);
 592
 593                 default:
 594                         return (EINVAL);
 595                 }
 596         }
 597
 598         sc = devclass_get_softc(usb_devclass, unit);
 599
 600         if (sc->sc_dying)
 601                 return (EIO);
 602
 603         switch (ap->a_cmd) {
 604         /* This part should be deleted */
 605         case USB_DISCOVER:
 606                 break;
 607         case USB_REQUEST:
 608         {
 609                 struct usb_ctl_request *ur = (void *)ap->a_data;
 610                 int len = UGETW(ur->ucr_request.wLength);
 611                 struct iovec iov;
 612                 struct uio uio;
 613                 void *ptr = 0;
 614                 int addr = ur->ucr_addr;
 615                 usbd_status err;
 616                 int error = 0;
 617
 618                 DPRINTF(("usbioctl: USB_REQUEST addr=%d len=%d\n", addr, len));
 619                 if (len < 0 || len > 32768)
 620                         return (EINVAL);
 621                 if (addr < 0 || addr >= USB_MAX_DEVICES ||
 622                     sc->sc_bus->devices[addr] == 0)
 623                         return (EINVAL);
 624                 if (len != 0) {
 625                         iov.iov_base = (caddr_t)ur->ucr_data;
 626                         iov.iov_len = len;
 627                         uio.uio_iov = &iov;
 628                         uio.uio_iovcnt = 1;
 629                         uio.uio_resid = len;
 630                         uio.uio_offset = 0;
 631                         uio.uio_segflg = UIO_USERSPACE;
 632                         uio.uio_rw =
 633                                 ur->ucr_request.bmRequestType & UT_READ ?
 634                                 UIO_READ : UIO_WRITE;
 635                         uio.uio_td = curthread;
 636                         ptr = kmalloc(len, M_TEMP, M_WAITOK);
 637                         if (uio.uio_rw == UIO_WRITE) {
 638                                 error = uiomove(ptr, len, &uio);
 639                                 if (error)
 640                                         goto ret;
 641                         }
 642                 }
 643                 err = usbd_do_request_flags(sc->sc_bus->devices[addr],
 644                           &ur->ucr_request, ptr, ur->ucr_flags, &ur->ucr_actlen,
 645                           USBD_DEFAULT_TIMEOUT);
 646                 if (err) {
 647                         error = EIO;
 648                         goto ret;
 649                 }
 650                 if (len != 0) {
 651                         if (uio.uio_rw == UIO_READ) {
 652                                 error = uiomove(ptr, len, &uio);
 653                                 if (error)
 654                                         goto ret;
 655                         }
 656                 }
 657         ret:
 658                 if (ptr)
 659                         kfree(ptr, M_TEMP);
 660                 return (error);
 661         }
 662
 663         case USB_DEVICEINFO:
 664         {
 665                 struct usb_device_info *di = (void *)ap->a_data;
 666                 int addr = di->udi_addr;
 667                 usbd_device_handle dev;
 668
 669                 if (addr < 1 || addr >= USB_MAX_DEVICES)
 670                         return (EINVAL);
 671                 dev = sc->sc_bus->devices[addr];
 672                 if (dev == NULL)
 673                         return (ENXIO);
 674                 usbd_fill_deviceinfo(dev, di, 1);
 675                 break;
 676         }
 677
 678         case USB_DEVICESTATS:
 679                 *(struct usb_device_stats *)ap->a_data = sc->sc_bus->stats;
 680                 break;
 681
 682         default:
 683                 return (EINVAL);
 684         }
 685         return (0);
 686 }
 687
 688 int
 689 usbpoll(struct dev_poll_args *ap)
 690 {
 691         cdev_t dev = ap->a_head.a_dev;
 692         int revents, mask;
 693         int unit = USBUNIT(dev);
 694
 695         if (unit == USB_DEV_MINOR) {
 696                 revents = 0;
 697                 mask = POLLIN | POLLRDNORM;
 698
 699                 crit_enter();
 700                 if (ap->a_events & mask && usb_nevents > 0)
 701                         revents |= ap->a_events & mask;
 702                 if (revents == 0 && ap->a_events & mask)
 703                         selrecord(curthread, &usb_selevent);
 704                 crit_exit();
 705                 ap->a_events = revents;
 706                 return (0);
 707         } else {
 708                 ap->a_events = 0;
 709                 return (0);     /* select/poll never wakes up - back compat */
 710         }
 711 }
 712
 713 /* Explore device tree from the root. */
 714 static void
 715 usb_discover(void *v)
 716 {
 717         struct usb_softc *sc = v;
 718
 719         DPRINTFN(2,("usb_discover\n"));
 720 #ifdef USB_DEBUG
 721         if (usb_noexplore > 1)
 722                 return;
 723 #endif
 724
 725         /*
 726          * We need mutual exclusion while traversing the device tree,
 727          * but this is guaranteed since this function is only called
 728          * from the event thread for the controller.
 729          */
 730         crit_enter();
 731         while (sc->sc_bus->needs_explore && !sc->sc_dying) {
 732                 sc->sc_bus->needs_explore = 0;
 733
 734                 crit_exit();
 735                 sc->sc_bus->root_hub->hub->explore(sc->sc_bus->root_hub);
 736                 crit_enter();
 737
 738         }
 739         crit_exit();
 740 }
 741
 742 void
 743 usb_needs_explore(usbd_device_handle dev)
 744 {
 745         DPRINTFN(2,("usb_needs_explore\n"));
 746         dev->bus->needs_explore = 1;
 747         wakeup(&dev->bus->needs_explore);
 748 }
 749
 750 /* Called from a critical section */
 751 int
 752 usb_get_next_event(struct usb_event *ue)
 753 {
 754         struct usb_event_q *ueq;
 755
 756         if (usb_nevents <= 0)
 757                 return (0);
 758         ueq = TAILQ_FIRST(&usb_events);
 759 #ifdef DIAGNOSTIC
 760         if (ueq == NULL) {
 761                 kprintf("usb: usb_nevents got out of sync! %d\n", usb_nevents);
 762                 usb_nevents = 0;
 763                 return (0);
 764         }
 765 #endif
 766         *ue = ueq->ue;
 767         TAILQ_REMOVE(&usb_events, ueq, next);
 768         kfree(ueq, M_USBDEV);
 769         usb_nevents--;
 770         return (1);
 771 }
 772
 773 void
 774 usbd_add_dev_event(int type, usbd_device_handle udev)
 775 {
 776         struct usb_event ue;
 777
 778         usbd_fill_deviceinfo(udev, &ue.u.ue_device, USB_EVENT_IS_ATTACH(type));
 779         usb_add_event(type, &ue);
 780 }
 781
 782 void
 783 usbd_add_drv_event(int type, usbd_device_handle udev, device_t dev)
 784 {
 785         struct usb_event ue;
 786
 787         ue.u.ue_driver.ue_cookie = udev->cookie;
 788         strncpy(ue.u.ue_driver.ue_devname, device_get_nameunit(dev),
 789                 sizeof ue.u.ue_driver.ue_devname);
 790         usb_add_event(type, &ue);
 791 }
 792
 793 void
 794 usb_add_event(int type, struct usb_event *uep)
 795 {
 796         struct usb_event_q *ueq;
 797         struct usb_event ue;
 798         struct timeval thetime;
 799
 800         ueq = kmalloc(sizeof *ueq, M_USBDEV, M_INTWAIT);
 801         ueq->ue = *uep;
 802         ueq->ue.ue_type = type;
 803         microtime(&thetime);
 804         TIMEVAL_TO_TIMESPEC(&thetime, &ueq->ue.ue_time);
 805
 806         crit_enter();
 807         if (USB_EVENT_IS_DETACH(type)) {
 808                 struct usb_event_q *ueqi, *ueqi_next;
 809
 810                 for (ueqi = TAILQ_FIRST(&usb_events); ueqi; ueqi = ueqi_next) {
 811                         ueqi_next = TAILQ_NEXT(ueqi, next);
 812                         if (ueqi->ue.u.ue_driver.ue_cookie.cookie ==
 813                             uep->u.ue_device.udi_cookie.cookie) {
 814                                 TAILQ_REMOVE(&usb_events, ueqi, next);
 815                                 kfree(ueqi, M_USBDEV);
 816                                 usb_nevents--;
 817                                 ueqi_next = TAILQ_FIRST(&usb_events);
 818                         }
 819                 }
 820         }
 821         if (usb_nevents >= USB_MAX_EVENTS) {
 822                 /* Too many queued events, drop an old one. */
 823                 DPRINTF(("usb: event dropped\n"));
 824                 usb_get_next_event(&ue);
 825         }
 826         TAILQ_INSERT_TAIL(&usb_events, ueq, next);
 827         usb_nevents++;
 828         wakeup(&usb_events);
 829         selwakeup(&usb_selevent);
 830         if (usb_async_proc != NULL) {
 831                 ksignal(usb_async_proc, SIGIO);
 832         }
 833         crit_exit();
 834 }
 835
 836 void
 837 usb_schedsoftintr(usbd_bus_handle bus)
 838 {
 839         DPRINTFN(10,("usb_schedsoftintr: polling=%d\n", bus->use_polling));
 840 #ifdef USB_USE_SOFTINTR
 841         if (bus->use_polling) {
 842                 bus->methods->soft_intr(bus);
 843         } else {
 844 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
 845                 softintr_schedule(bus->soft);
 846 #else
 847                 if (!callout_pending(&bus->softi))
 848                         callout_reset(&bus->softi, 0, bus->methods->soft_intr,
 849                             bus);
 850 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */
 851         }
 852 #else
 853        bus->methods->soft_intr(bus);
 854 #endif /* USB_USE_SOFTINTR */
 855 }
 856
 857 static int
 858 usb_detach(device_t self)
 859 {
 860         struct usb_softc *sc = device_get_softc(self);
 861         struct usb_event ue;
 862
 863         DPRINTF(("usb_detach: start\n"));
 864
 865         sc->sc_dying = 1;
 866
 867         /* Make all devices disconnect. */
 868         if (sc->sc_port.device != NULL)
 869                 usb_disconnect_port(&sc->sc_port, self);
 870
 871         /* Kill off event thread. */
 872         if (sc->sc_event_thread != NULL) {
 873                 wakeup(&sc->sc_bus->needs_explore);
 874                 if (tsleep(sc, 0, "usbdet", hz * 60))
 875                         kprintf("%s: event thread didn't die\n",
 876                                device_get_nameunit(sc->sc_dev));
 877                 DPRINTF(("usb_detach: event thread dead\n"));
 878         }
 879
 880         destroy_dev(sc->sc_usbdev);
 881         if (--usb_ndevs == 0) {
 882                 int i;
 883
 884                 destroy_dev(usb_dev);
 885                 usb_dev = NULL;
 886
 887                 for (i = 0; i < USB_NUM_TASKQS; i++) {
 888                         struct usb_taskq *taskq = &usb_taskq[i];
 889                         wakeup(&taskq->tasks);
 890                         if (tsleep(&taskq->taskcreated, 0, "usbtdt",
 891                             hz * 60)) {
 892                                 kprintf("usb task thread %s didn't die\n",
 893                                     taskq->name);
 894                         }
 895                 }
 896         }
 897
 898         usbd_finish();
 899
 900 #ifdef USB_USE_SOFTINTR
 901 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
 902         if (sc->sc_bus->soft != NULL) {
 903                 softintr_disestablish(sc->sc_bus->soft);
 904                 sc->sc_bus->soft = NULL;
 905         }
 906 #else
 907         callout_stop(&sc->sc_bus->softi);
 908 #endif
 909 #endif
 910
 911         ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
 912         usb_add_event(USB_EVENT_CTRLR_DETACH, &ue);
 913
 914         return (0);
 915 }
 916
 917 static void
 918 usb_child_detached(device_t self, device_t child)
 919 {
 920         struct usb_softc *sc = device_get_softc(self);
 921
 922         /* XXX, should check it is the right device. */
 923         sc->sc_port.device = NULL;
 924 }
 925
 926 DRIVER_MODULE(usb, ohci, usb_driver, usb_devclass, 0, 0);
 927 DRIVER_MODULE(usb, uhci, usb_driver, usb_devclass, 0, 0);
 928 DRIVER_MODULE(usb, ehci, usb_driver, usb_devclass, 0, 0);
 929