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