Nuke USB_MATCH*, USB_ATTACH* and USB_DETACH* macros.
[dragonfly.git] / 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.36 2007/07/01 21:24:02 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         usb_proc_ptr            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 USB_DECLARE_DRIVER_INIT(usb,
178                         DEVMETHOD(bus_child_detached, usb_child_detached),
179                         DEVMETHOD(device_suspend, bus_generic_suspend),
180                         DEVMETHOD(device_resume, bus_generic_resume),
181                         DEVMETHOD(device_shutdown, bus_generic_shutdown)
182                         );
183
184 MODULE_VERSION(usb, 1);
185
186 static int
187 usb_match(device_t self)
188 {
189         DPRINTF(("usbd_match\n"));
190         return (UMATCH_GENERIC);
191 }
192
193 static int
194 usb_attach(device_t self)
195 {
196         struct usb_softc *sc = device_get_softc(self);
197         void *aux = device_get_ivars(self);
198         cdev_t tmp_dev;
199         usbd_device_handle dev;
200         usbd_status err;
201         int usbrev;
202         int speed;
203         struct usb_event ue;
204
205         sc->sc_dev = self;
206
207         DPRINTF(("usbd_attach\n"));
208
209         usbd_init();
210         sc->sc_bus = aux;
211         sc->sc_bus->usbctl = sc;
212         sc->sc_port.power = USB_MAX_POWER;
213
214         kprintf("%s", device_get_nameunit(sc->sc_dev));
215         usbrev = sc->sc_bus->usbrev;
216         kprintf(": USB revision %s", usbrev_str[usbrev]);
217         switch (usbrev) {
218         case USBREV_1_0:
219         case USBREV_1_1:
220                 speed = USB_SPEED_FULL;
221                 break;
222         case USBREV_2_0:
223                 speed = USB_SPEED_HIGH;
224                 break;
225         default:
226                 kprintf(", not supported\n");
227                 sc->sc_dying = 1;
228                 return ENXIO;
229         }
230         kprintf("\n");
231
232 #if 0
233         /* Make sure not to use tsleep() if we are cold booting. */
234         if (cold)
235                 sc->sc_bus->use_polling++;
236 #endif
237
238         ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
239         usb_add_event(USB_EVENT_CTRLR_ATTACH, &ue);
240
241 #ifdef USB_USE_SOFTINTR
242 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
243         /* XXX we should have our own level */
244         sc->sc_bus->soft = softintr_establish(IPL_SOFTNET,
245             sc->sc_bus->methods->soft_intr, sc->sc_bus);
246         if (sc->sc_bus->soft == NULL) {
247                 kprintf("%s: can't register softintr\n", device_get_nameunit(sc->sc_dev));
248                 sc->sc_dying = 1;
249                 return ENXIO;
250         }
251 #else
252         callout_init(&sc->sc_bus->softi);
253 #endif
254 #endif
255
256         err = usbd_new_device(sc->sc_dev, sc->sc_bus, 0, speed, 0,
257                   &sc->sc_port);
258         if (!err) {
259                 dev = sc->sc_port.device;
260                 if (dev->hub == NULL) {
261                         sc->sc_dying = 1;
262                         kprintf("%s: root device is not a hub\n",
263                                device_get_nameunit(sc->sc_dev));
264                         return ENXIO;
265                 }
266                 sc->sc_bus->root_hub = dev;
267 #if 1
268                 /*
269                  * Turning this code off will delay attachment of USB devices
270                  * until the USB event thread is running, which means that
271                  * the keyboard will not work until after cold boot.
272                  */
273                 if (cold) {
274                         /*
275                          * XXX Exploring high speed device here will
276                          * hang the system.
277                          */
278                         if (speed != USB_SPEED_HIGH)
279                                 dev->hub->explore(sc->sc_bus->root_hub);
280                 }
281 #endif
282         } else {
283                 kprintf("%s: root hub problem, error=%d\n",
284                        device_get_nameunit(sc->sc_dev), err);
285                 sc->sc_dying = 1;
286         }
287 #if 0
288         if (cold)
289                 sc->sc_bus->use_polling--;
290 #endif
291
292         config_pending_incr();
293
294         usb_create_event_thread(sc);
295         /* The per controller devices (used for usb_discover) */
296         /* XXX This is redundant now, but old usbd's will want it */
297         dev_ops_add(&usb_ops, -1, device_get_unit(self));
298         tmp_dev = make_dev(&usb_ops, device_get_unit(self),
299                            UID_ROOT, GID_OPERATOR, 0660,
300                            "usb%d", device_get_unit(self));
301         sc->sc_usbdev = reference_dev(tmp_dev);
302         if (usb_ndevs++ == 0) {
303                 /* The device spitting out events */
304                 dev_ops_add(&usb_ops, -1, USB_DEV_MINOR);
305                 tmp_dev = make_dev(&usb_ops, USB_DEV_MINOR,
306                                    UID_ROOT, GID_OPERATOR, 0660, "usb");
307                 usb_dev = reference_dev(tmp_dev);
308         }
309
310         return 0;
311 }
312
313 static const char *taskq_names[] = USB_TASKQ_NAMES;
314
315 void
316 usb_create_event_thread(void *arg)
317 {
318         struct usb_softc *sc = arg;
319         int i;
320
321         if (kthread_create(usb_event_thread, sc, &sc->sc_event_thread,
322                            "%s", device_get_nameunit(sc->sc_dev))) {
323                 kprintf("%s: unable to create event thread for\n",
324                        device_get_nameunit(sc->sc_dev));
325                 panic("usb_create_event_thread");
326         }
327
328         for (i = 0; i < USB_NUM_TASKQS; i++) {
329                 struct usb_taskq *taskq = &usb_taskq[i];
330
331                 if (taskq->taskcreated == 0) {
332                         taskq->taskcreated = 1;
333                         taskq->name = taskq_names[i];
334                         TAILQ_INIT(&taskq->tasks);
335                         if (kthread_create(usb_task_thread, taskq,
336                             &taskq->task_thread_proc, taskq->name)) {
337                                 kprintf("unable to create task thread\n");
338                                 panic("usb_create_event_thread task");
339                         }
340                 }
341         }
342 }
343
344 /*
345  * Add a task to be performed by the task thread.  This function can be
346  * called from any context and the task will be executed in a process
347  * context ASAP.
348  */
349 void
350 usb_add_task(usbd_device_handle dev, struct usb_task *task, int queue)
351 {
352         struct usb_taskq *taskq;
353
354         crit_enter();
355
356         taskq = &usb_taskq[queue];
357         if (task->queue == -1) {
358                 DPRINTFN(2,("usb_add_task: task=%p\n", task));
359                 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
360                 task->queue = queue;
361         } else {
362                 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
363         }
364         wakeup(&taskq->tasks);
365
366         crit_exit();
367 }
368
369 void
370 usb_do_task(usbd_device_handle dev, struct usb_task *task, int queue,
371             int time_out)
372 {
373         struct usb_taskq *taskq;
374
375         crit_enter();
376
377         taskq = &usb_taskq[queue];
378         if (task->queue == -1) {
379                 DPRINTFN(2,("usb_add_task: task=%p\n", task));
380                 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
381                 task->queue = queue;
382         } else {
383                 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
384         }
385         wakeup(&taskq->tasks);
386
387         /* Wait until task is finished */
388         tsleep((&taskq->tasks + 1), 0, "usbdotsk", time_out);
389
390         crit_exit();
391 }
392
393 void
394 usb_rem_task(usbd_device_handle dev, struct usb_task *task)
395 {
396         crit_enter();
397         if (task->queue != -1) {
398                 TAILQ_REMOVE(&usb_taskq[task->queue].tasks, task, next);
399                 task->queue = -1;
400         }
401         crit_exit();
402 }
403
404 void
405 usb_event_thread(void *arg)
406 {
407         struct usb_softc *sc = arg;
408
409         DPRINTF(("usb_event_thread: start\n"));
410
411         /*
412          * In case this controller is a companion controller to an
413          * EHCI controller we need to wait until the EHCI controller
414          * has grabbed the port.
415          * XXX It would be nicer to do this with a tsleep(), but I don't
416          * know how to synchronize the creation of the threads so it
417          * will work.
418          */
419         usb_delay_ms(sc->sc_bus, 500);
420
421         crit_enter();
422
423         /* Make sure first discover does something. */
424         sc->sc_bus->needs_explore = 1;
425         usb_discover(sc);
426         config_pending_decr();
427
428         while (!sc->sc_dying) {
429 #ifdef USB_DEBUG
430                 if (usb_noexplore < 2)
431 #endif
432                 usb_discover(sc);
433 #ifdef USB_DEBUG
434                 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt",
435                        usb_noexplore ? 0 : hz * 60);
436 #else
437                 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt", hz * 60);
438 #endif
439                 DPRINTFN(2,("usb_event_thread: woke up\n"));
440         }
441         sc->sc_event_thread = NULL;
442
443         crit_exit();
444
445         /* In case parent is waiting for us to exit. */
446         wakeup(sc);
447
448         DPRINTF(("usb_event_thread: exit\n"));
449         kthread_exit();
450 }
451
452 void
453 usb_task_thread(void *arg)
454 {
455         struct usb_task *task;
456         struct usb_taskq *taskq;
457
458         crit_enter();
459
460         taskq = arg;
461         DPRINTF(("usb_task_thread: start taskq %s\n", taskq->name));
462
463         while (usb_ndevs > 0) {
464                 task = TAILQ_FIRST(&taskq->tasks);
465                 if (task == NULL) {
466                         tsleep(&taskq->tasks, 0, "usbtsk", 0);
467                         task = TAILQ_FIRST(&taskq->tasks);
468                 }
469                 DPRINTFN(2,("usb_task_thread: woke up task=%p\n", task));
470                 if (task != NULL) {
471                         TAILQ_REMOVE(&taskq->tasks, task, next);
472                         task->queue = -1;
473                         crit_exit();
474                         task->fun(task->arg);
475                         crit_enter();
476                         wakeup((&taskq->tasks + 1));
477                 }
478         }
479
480         crit_exit();
481
482         taskq->taskcreated = 0;
483         wakeup(&taskq->taskcreated);
484
485         DPRINTF(("usb_event_thread: exit\n"));
486 }
487
488 int
489 usbopen(struct dev_open_args *ap)
490 {
491         cdev_t dev = ap->a_head.a_dev;
492         int unit = USBUNIT(dev);
493         struct usb_softc *sc;
494
495         if (unit == USB_DEV_MINOR) {
496                 if (usb_dev_open)
497                         return (EBUSY);
498                 usb_dev_open = 1;
499                 usb_async_proc = NULL;
500                 return (0);
501         }
502
503         USB_GET_SC_OPEN(usb, unit, sc);
504
505         if (sc->sc_dying)
506                 return (EIO);
507
508         return (0);
509 }
510
511 int
512 usbread(struct dev_read_args *ap)
513 {
514         cdev_t dev = ap->a_head.a_dev;
515         struct uio *uio = ap->a_uio;
516         struct usb_event ue;
517         int unit = USBUNIT(dev);
518         int error, n;
519
520         if (unit != USB_DEV_MINOR)
521                 return (ENODEV);
522
523         if (uio->uio_resid != sizeof(struct usb_event))
524                 return (EINVAL);
525
526         error = 0;
527         crit_enter();
528         for (;;) {
529                 n = usb_get_next_event(&ue);
530                 if (n != 0)
531                         break;
532                 if (ap->a_ioflag & IO_NDELAY) {
533                         error = EWOULDBLOCK;
534                         break;
535                 }
536                 error = tsleep(&usb_events, PCATCH, "usbrea", 0);
537                 if (error)
538                         break;
539         }
540         crit_exit();
541         if (!error)
542                 error = uiomove((void *)&ue, uio->uio_resid, uio);
543
544         return (error);
545 }
546
547 int
548 usbclose(struct dev_close_args *ap)
549 {
550         cdev_t dev = ap->a_head.a_dev;
551         int unit = USBUNIT(dev);
552
553         if (unit == USB_DEV_MINOR) {
554                 usb_async_proc = NULL;
555                 usb_dev_open = 0;
556         }
557
558         return (0);
559 }
560
561 int
562 usbioctl(struct dev_ioctl_args *ap)
563 {
564         cdev_t devt = ap->a_head.a_dev;
565         struct usb_softc *sc;
566         int unit = USBUNIT(devt);
567
568         if (unit == USB_DEV_MINOR) {
569                 switch (ap->a_cmd) {
570                 case FIOASYNC:
571                         if (*(int *)ap->a_data)
572                                 usb_async_proc = curproc;
573                         else
574                                 usb_async_proc = NULL;
575                         return (0);
576
577                 default:
578                         return (EINVAL);
579                 }
580         }
581
582         USB_GET_SC(usb, unit, sc);
583
584         if (sc->sc_dying)
585                 return (EIO);
586
587         switch (ap->a_cmd) {
588         /* This part should be deleted */
589         case USB_DISCOVER:
590                 break;
591         case USB_REQUEST:
592         {
593                 struct usb_ctl_request *ur = (void *)ap->a_data;
594                 int len = UGETW(ur->ucr_request.wLength);
595                 struct iovec iov;
596                 struct uio uio;
597                 void *ptr = 0;
598                 int addr = ur->ucr_addr;
599                 usbd_status err;
600                 int error = 0;
601
602                 DPRINTF(("usbioctl: USB_REQUEST addr=%d len=%d\n", addr, len));
603                 if (len < 0 || len > 32768)
604                         return (EINVAL);
605                 if (addr < 0 || addr >= USB_MAX_DEVICES ||
606                     sc->sc_bus->devices[addr] == 0)
607                         return (EINVAL);
608                 if (len != 0) {
609                         iov.iov_base = (caddr_t)ur->ucr_data;
610                         iov.iov_len = len;
611                         uio.uio_iov = &iov;
612                         uio.uio_iovcnt = 1;
613                         uio.uio_resid = len;
614                         uio.uio_offset = 0;
615                         uio.uio_segflg = UIO_USERSPACE;
616                         uio.uio_rw =
617                                 ur->ucr_request.bmRequestType & UT_READ ?
618                                 UIO_READ : UIO_WRITE;
619                         uio.uio_td = curthread;
620                         ptr = kmalloc(len, M_TEMP, M_WAITOK);
621                         if (uio.uio_rw == UIO_WRITE) {
622                                 error = uiomove(ptr, len, &uio);
623                                 if (error)
624                                         goto ret;
625                         }
626                 }
627                 err = usbd_do_request_flags(sc->sc_bus->devices[addr],
628                           &ur->ucr_request, ptr, ur->ucr_flags, &ur->ucr_actlen,
629                           USBD_DEFAULT_TIMEOUT);
630                 if (err) {
631                         error = EIO;
632                         goto ret;
633                 }
634                 if (len != 0) {
635                         if (uio.uio_rw == UIO_READ) {
636                                 error = uiomove(ptr, len, &uio);
637                                 if (error)
638                                         goto ret;
639                         }
640                 }
641         ret:
642                 if (ptr)
643                         kfree(ptr, M_TEMP);
644                 return (error);
645         }
646
647         case USB_DEVICEINFO:
648         {
649                 struct usb_device_info *di = (void *)ap->a_data;
650                 int addr = di->udi_addr;
651                 usbd_device_handle dev;
652
653                 if (addr < 1 || addr >= USB_MAX_DEVICES)
654                         return (EINVAL);
655                 dev = sc->sc_bus->devices[addr];
656                 if (dev == NULL)
657                         return (ENXIO);
658                 usbd_fill_deviceinfo(dev, di, 1);
659                 break;
660         }
661
662         case USB_DEVICESTATS:
663                 *(struct usb_device_stats *)ap->a_data = sc->sc_bus->stats;
664                 break;
665
666         default:
667                 return (EINVAL);
668         }
669         return (0);
670 }
671
672 int
673 usbpoll(struct dev_poll_args *ap)
674 {
675         cdev_t dev = ap->a_head.a_dev;
676         int revents, mask;
677         int unit = USBUNIT(dev);
678
679         if (unit == USB_DEV_MINOR) {
680                 revents = 0;
681                 mask = POLLIN | POLLRDNORM;
682
683                 crit_enter();
684                 if (ap->a_events & mask && usb_nevents > 0)
685                         revents |= ap->a_events & mask;
686                 if (revents == 0 && ap->a_events & mask)
687                         selrecord(curthread, &usb_selevent);
688                 crit_exit();
689                 ap->a_events = revents;
690                 return (0);
691         } else {
692                 ap->a_events = 0;
693                 return (0);     /* select/poll never wakes up - back compat */
694         }
695 }
696
697 /* Explore device tree from the root. */
698 static void
699 usb_discover(void *v)
700 {
701         struct usb_softc *sc = v;
702
703         DPRINTFN(2,("usb_discover\n"));
704 #ifdef USB_DEBUG
705         if (usb_noexplore > 1)
706                 return;
707 #endif
708
709         /*
710          * We need mutual exclusion while traversing the device tree,
711          * but this is guaranteed since this function is only called
712          * from the event thread for the controller.
713          */
714         crit_enter();
715         while (sc->sc_bus->needs_explore && !sc->sc_dying) {
716                 sc->sc_bus->needs_explore = 0;
717
718                 crit_exit();
719                 sc->sc_bus->root_hub->hub->explore(sc->sc_bus->root_hub);
720                 crit_enter();
721
722         }
723         crit_exit();
724 }
725
726 void
727 usb_needs_explore(usbd_device_handle dev)
728 {
729         DPRINTFN(2,("usb_needs_explore\n"));
730         dev->bus->needs_explore = 1;
731         wakeup(&dev->bus->needs_explore);
732 }
733
734 /* Called from a critical section */
735 int
736 usb_get_next_event(struct usb_event *ue)
737 {
738         struct usb_event_q *ueq;
739
740         if (usb_nevents <= 0)
741                 return (0);
742         ueq = TAILQ_FIRST(&usb_events);
743 #ifdef DIAGNOSTIC
744         if (ueq == NULL) {
745                 kprintf("usb: usb_nevents got out of sync! %d\n", usb_nevents);
746                 usb_nevents = 0;
747                 return (0);
748         }
749 #endif
750         *ue = ueq->ue;
751         TAILQ_REMOVE(&usb_events, ueq, next);
752         kfree(ueq, M_USBDEV);
753         usb_nevents--;
754         return (1);
755 }
756
757 void
758 usbd_add_dev_event(int type, usbd_device_handle udev)
759 {
760         struct usb_event ue;
761
762         usbd_fill_deviceinfo(udev, &ue.u.ue_device, USB_EVENT_IS_ATTACH(type));
763         usb_add_event(type, &ue);
764 }
765
766 void
767 usbd_add_drv_event(int type, usbd_device_handle udev, device_t dev)
768 {
769         struct usb_event ue;
770
771         ue.u.ue_driver.ue_cookie = udev->cookie;
772         strncpy(ue.u.ue_driver.ue_devname, device_get_nameunit(dev),
773                 sizeof ue.u.ue_driver.ue_devname);
774         usb_add_event(type, &ue);
775 }
776
777 void
778 usb_add_event(int type, struct usb_event *uep)
779 {
780         struct usb_event_q *ueq;
781         struct usb_event ue;
782         struct timeval thetime;
783
784         ueq = kmalloc(sizeof *ueq, M_USBDEV, M_INTWAIT);
785         ueq->ue = *uep;
786         ueq->ue.ue_type = type;
787         microtime(&thetime);
788         TIMEVAL_TO_TIMESPEC(&thetime, &ueq->ue.ue_time);
789
790         crit_enter();
791         if (USB_EVENT_IS_DETACH(type)) {
792                 struct usb_event_q *ueqi, *ueqi_next;
793
794                 for (ueqi = TAILQ_FIRST(&usb_events); ueqi; ueqi = ueqi_next) {
795                         ueqi_next = TAILQ_NEXT(ueqi, next);
796                         if (ueqi->ue.u.ue_driver.ue_cookie.cookie ==
797                             uep->u.ue_device.udi_cookie.cookie) {
798                                 TAILQ_REMOVE(&usb_events, ueqi, next);
799                                 kfree(ueqi, M_USBDEV);
800                                 usb_nevents--;
801                                 ueqi_next = TAILQ_FIRST(&usb_events);
802                         }
803                 }
804         }
805         if (usb_nevents >= USB_MAX_EVENTS) {
806                 /* Too many queued events, drop an old one. */
807                 DPRINTF(("usb: event dropped\n"));
808                 usb_get_next_event(&ue);
809         }
810         TAILQ_INSERT_TAIL(&usb_events, ueq, next);
811         usb_nevents++;
812         wakeup(&usb_events);
813         selwakeuppri(&usb_selevent, 0);
814         if (usb_async_proc != NULL) {
815                 ksignal(usb_async_proc, SIGIO);
816         }
817         crit_exit();
818 }
819
820 void
821 usb_schedsoftintr(usbd_bus_handle bus)
822 {
823         DPRINTFN(10,("usb_schedsoftintr: polling=%d\n", bus->use_polling));
824 #ifdef USB_USE_SOFTINTR
825         if (bus->use_polling) {
826                 bus->methods->soft_intr(bus);
827         } else {
828 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
829                 softintr_schedule(bus->soft);
830 #else
831                 if (!callout_pending(&bus->softi))
832                         callout_reset(&bus->softi, 0, bus->methods->soft_intr,
833                             bus);
834 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */
835         }
836 #else
837        bus->methods->soft_intr(bus);
838 #endif /* USB_USE_SOFTINTR */
839 }
840
841 static int
842 usb_detach(device_t self)
843 {
844         struct usb_softc *sc = device_get_softc(self);
845         struct usb_event ue;
846
847         DPRINTF(("usb_detach: start\n"));
848
849         sc->sc_dying = 1;
850
851         /* Make all devices disconnect. */
852         if (sc->sc_port.device != NULL)
853                 usb_disconnect_port(&sc->sc_port, self);
854
855         /* Kill off event thread. */
856         if (sc->sc_event_thread != NULL) {
857                 wakeup(&sc->sc_bus->needs_explore);
858                 if (tsleep(sc, 0, "usbdet", hz * 60))
859                         kprintf("%s: event thread didn't die\n",
860                                device_get_nameunit(sc->sc_dev));
861                 DPRINTF(("usb_detach: event thread dead\n"));
862         }
863
864         destroy_dev(sc->sc_usbdev);
865         if (--usb_ndevs == 0) {
866                 int i;
867
868                 destroy_dev(usb_dev);
869                 usb_dev = NULL;
870
871                 for (i = 0; i < USB_NUM_TASKQS; i++) {
872                         struct usb_taskq *taskq = &usb_taskq[i];
873                         wakeup(&taskq->tasks);
874                         if (tsleep(&taskq->taskcreated, 0, "usbtdt",
875                             hz * 60)) {
876                                 kprintf("usb task thread %s didn't die\n",
877                                     taskq->name);
878                         }
879                 }
880         }
881
882         usbd_finish();
883
884 #ifdef USB_USE_SOFTINTR
885 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
886         if (sc->sc_bus->soft != NULL) {
887                 softintr_disestablish(sc->sc_bus->soft);
888                 sc->sc_bus->soft = NULL;
889         }
890 #else
891         callout_stop(&sc->sc_bus->softi);
892 #endif
893 #endif
894
895         ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
896         usb_add_event(USB_EVENT_CTRLR_DETACH, &ue);
897
898         return (0);
899 }
900
901 static void
902 usb_child_detached(device_t self, device_t child)
903 {
904         struct usb_softc *sc = device_get_softc(self);
905
906         /* XXX, should check it is the right device. */
907         sc->sc_port.device = NULL;
908 }
909
910 DRIVER_MODULE(usb, ohci, usb_driver, usb_devclass, 0, 0);
911 DRIVER_MODULE(usb, uhci, usb_driver, usb_devclass, 0, 0);
912 DRIVER_MODULE(usb, ehci, usb_driver, usb_devclass, 0, 0);
913