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.35 2007/06/30 20:39:22 hasso Exp $
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 $
15 * Copyright (c) 1998 The NetBSD Foundation, Inc.
16 * All rights reserved.
18 * This code is derived from software contributed to The NetBSD Foundation
19 * by Lennart Augustsson (lennart@augustsson.net) at
20 * Carlstedt Research & Technology.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
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.
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.
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/
57 #include <sys/param.h>
58 #include <sys/systm.h>
59 #include <sys/kernel.h>
61 #include <sys/malloc.h>
62 #include <sys/unistd.h>
63 #include <sys/module.h>
65 #include <sys/fcntl.h>
66 #include <sys/filio.h>
68 #include <sys/kthread.h>
71 #include <sys/device.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>
79 #include <bus/usb/usb.h>
80 #include <bus/usb/usbdi.h>
81 #include <bus/usb/usbdi_util.h>
83 #define USBUNIT(d) (minor(d)) /* usb_discover device nodes, kthread */
84 #define USB_DEV_MINOR 255 /* event queue device */
86 MALLOC_DEFINE(M_USB, "USB", "USB");
87 MALLOC_DEFINE(M_USBDEV, "USBdev", "USB device");
88 MALLOC_DEFINE(M_USBHC, "USBHC", "USB host controller");
92 #include <bus/usb/usbdivar.h>
93 #include <bus/usb/usb_quirks.h>
95 /* Define this unconditionally in case a kernel module is loaded that
96 * has been compiled with debugging options.
98 SYSCTL_NODE(_hw, OID_AUTO, usb, CTLFLAG_RW, 0, "USB debugging");
101 #define DPRINTF(x) if (usbdebug) kprintf x
102 #define DPRINTFN(n,x) if (usbdebug>(n)) kprintf x
104 SYSCTL_INT(_hw_usb, OID_AUTO, debug, CTLFLAG_RW,
105 &usbdebug, 0, "usb debug level");
107 * 0 - do usual exploration
108 * 1 - do not use timeout exploration
109 * >1 - do no exploration
111 int usb_noexplore = 0;
114 #define DPRINTFN(n,x)
118 device_t sc_dev; /* base device */
120 usbd_bus_handle sc_bus; /* USB controller */
121 struct usbd_port sc_port; /* dummy port for root hub */
123 struct thread *sc_event_thread;
129 TAILQ_HEAD(, usb_task) tasks;
130 usb_proc_ptr task_thread_proc;
132 int taskcreated; /* task thread exists. */
134 static struct usb_taskq usb_taskq[USB_NUM_TASKQS];
142 struct dev_ops usb_ops = {
143 { "usb", USB_CDEV_MAJOR, 0 },
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 *);
157 static cdev_t usb_dev; /* The /dev/usb device. */
158 static int usb_ndevs; /* Number of /dev/usbN devices. */
160 #define USB_MAX_EVENTS 100
163 TAILQ_ENTRY(usb_event_q) next;
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 *);
173 static int usb_get_next_event(struct usb_event *);
175 static const char *usbrev_str[] = USBREV_STR;
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)
184 MODULE_VERSION(usb, 1);
188 DPRINTF(("usbd_match\n"));
189 return (UMATCH_GENERIC);
194 struct usb_softc *sc = device_get_softc(self);
195 void *aux = device_get_ivars(self);
197 usbd_device_handle dev;
205 DPRINTF(("usbd_attach\n"));
209 sc->sc_bus->usbctl = sc;
210 sc->sc_port.power = USB_MAX_POWER;
212 kprintf("%s", device_get_nameunit(sc->sc_dev));
213 usbrev = sc->sc_bus->usbrev;
214 kprintf(": USB revision %s", usbrev_str[usbrev]);
218 speed = USB_SPEED_FULL;
221 speed = USB_SPEED_HIGH;
224 kprintf(", not supported\n");
226 USB_ATTACH_ERROR_RETURN;
231 /* Make sure not to use tsleep() if we are cold booting. */
233 sc->sc_bus->use_polling++;
236 ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
237 usb_add_event(USB_EVENT_CTRLR_ATTACH, &ue);
239 #ifdef USB_USE_SOFTINTR
240 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
241 /* XXX we should have our own level */
242 sc->sc_bus->soft = softintr_establish(IPL_SOFTNET,
243 sc->sc_bus->methods->soft_intr, sc->sc_bus);
244 if (sc->sc_bus->soft == NULL) {
245 kprintf("%s: can't register softintr\n", device_get_nameunit(sc->sc_dev));
247 USB_ATTACH_ERROR_RETURN;
250 callout_init(&sc->sc_bus->softi);
254 err = usbd_new_device(sc->sc_dev, sc->sc_bus, 0, speed, 0,
257 dev = sc->sc_port.device;
258 if (dev->hub == NULL) {
260 kprintf("%s: root device is not a hub\n",
261 device_get_nameunit(sc->sc_dev));
262 USB_ATTACH_ERROR_RETURN;
264 sc->sc_bus->root_hub = dev;
267 * Turning this code off will delay attachment of USB devices
268 * until the USB event thread is running, which means that
269 * the keyboard will not work until after cold boot.
273 * XXX Exploring high speed device here will
276 if (speed != USB_SPEED_HIGH)
277 dev->hub->explore(sc->sc_bus->root_hub);
281 kprintf("%s: root hub problem, error=%d\n",
282 device_get_nameunit(sc->sc_dev), err);
287 sc->sc_bus->use_polling--;
290 config_pending_incr();
292 usb_create_event_thread(sc);
293 /* The per controller devices (used for usb_discover) */
294 /* XXX This is redundant now, but old usbd's will want it */
295 dev_ops_add(&usb_ops, -1, device_get_unit(self));
296 tmp_dev = make_dev(&usb_ops, device_get_unit(self),
297 UID_ROOT, GID_OPERATOR, 0660,
298 "usb%d", device_get_unit(self));
299 sc->sc_usbdev = reference_dev(tmp_dev);
300 if (usb_ndevs++ == 0) {
301 /* The device spitting out events */
302 dev_ops_add(&usb_ops, -1, USB_DEV_MINOR);
303 tmp_dev = make_dev(&usb_ops, USB_DEV_MINOR,
304 UID_ROOT, GID_OPERATOR, 0660, "usb");
305 usb_dev = reference_dev(tmp_dev);
308 USB_ATTACH_SUCCESS_RETURN;
311 static const char *taskq_names[] = USB_TASKQ_NAMES;
314 usb_create_event_thread(void *arg)
316 struct usb_softc *sc = arg;
319 if (kthread_create(usb_event_thread, sc, &sc->sc_event_thread,
320 "%s", device_get_nameunit(sc->sc_dev))) {
321 kprintf("%s: unable to create event thread for\n",
322 device_get_nameunit(sc->sc_dev));
323 panic("usb_create_event_thread");
326 for (i = 0; i < USB_NUM_TASKQS; i++) {
327 struct usb_taskq *taskq = &usb_taskq[i];
329 if (taskq->taskcreated == 0) {
330 taskq->taskcreated = 1;
331 taskq->name = taskq_names[i];
332 TAILQ_INIT(&taskq->tasks);
333 if (kthread_create(usb_task_thread, taskq,
334 &taskq->task_thread_proc, taskq->name)) {
335 kprintf("unable to create task thread\n");
336 panic("usb_create_event_thread task");
343 * Add a task to be performed by the task thread. This function can be
344 * called from any context and the task will be executed in a process
348 usb_add_task(usbd_device_handle dev, struct usb_task *task, int queue)
350 struct usb_taskq *taskq;
354 taskq = &usb_taskq[queue];
355 if (task->queue == -1) {
356 DPRINTFN(2,("usb_add_task: task=%p\n", task));
357 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
360 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
362 wakeup(&taskq->tasks);
368 usb_do_task(usbd_device_handle dev, struct usb_task *task, int queue,
371 struct usb_taskq *taskq;
375 taskq = &usb_taskq[queue];
376 if (task->queue == -1) {
377 DPRINTFN(2,("usb_add_task: task=%p\n", task));
378 TAILQ_INSERT_TAIL(&taskq->tasks, task, next);
381 DPRINTFN(3,("usb_add_task: task=%p on q\n", task));
383 wakeup(&taskq->tasks);
385 /* Wait until task is finished */
386 tsleep((&taskq->tasks + 1), 0, "usbdotsk", time_out);
392 usb_rem_task(usbd_device_handle dev, struct usb_task *task)
395 if (task->queue != -1) {
396 TAILQ_REMOVE(&usb_taskq[task->queue].tasks, task, next);
403 usb_event_thread(void *arg)
405 struct usb_softc *sc = arg;
407 DPRINTF(("usb_event_thread: start\n"));
410 * In case this controller is a companion controller to an
411 * EHCI controller we need to wait until the EHCI controller
412 * has grabbed the port.
413 * XXX It would be nicer to do this with a tsleep(), but I don't
414 * know how to synchronize the creation of the threads so it
417 usb_delay_ms(sc->sc_bus, 500);
421 /* Make sure first discover does something. */
422 sc->sc_bus->needs_explore = 1;
424 config_pending_decr();
426 while (!sc->sc_dying) {
428 if (usb_noexplore < 2)
432 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt",
433 usb_noexplore ? 0 : hz * 60);
435 tsleep(&sc->sc_bus->needs_explore, 0, "usbevt", hz * 60);
437 DPRINTFN(2,("usb_event_thread: woke up\n"));
439 sc->sc_event_thread = NULL;
443 /* In case parent is waiting for us to exit. */
446 DPRINTF(("usb_event_thread: exit\n"));
451 usb_task_thread(void *arg)
453 struct usb_task *task;
454 struct usb_taskq *taskq;
459 DPRINTF(("usb_task_thread: start taskq %s\n", taskq->name));
461 while (usb_ndevs > 0) {
462 task = TAILQ_FIRST(&taskq->tasks);
464 tsleep(&taskq->tasks, 0, "usbtsk", 0);
465 task = TAILQ_FIRST(&taskq->tasks);
467 DPRINTFN(2,("usb_task_thread: woke up task=%p\n", task));
469 TAILQ_REMOVE(&taskq->tasks, task, next);
472 task->fun(task->arg);
474 wakeup((&taskq->tasks + 1));
480 taskq->taskcreated = 0;
481 wakeup(&taskq->taskcreated);
483 DPRINTF(("usb_event_thread: exit\n"));
487 usbopen(struct dev_open_args *ap)
489 cdev_t dev = ap->a_head.a_dev;
490 int unit = USBUNIT(dev);
491 struct usb_softc *sc;
493 if (unit == USB_DEV_MINOR) {
497 usb_async_proc = NULL;
501 USB_GET_SC_OPEN(usb, unit, sc);
510 usbread(struct dev_read_args *ap)
512 cdev_t dev = ap->a_head.a_dev;
513 struct uio *uio = ap->a_uio;
515 int unit = USBUNIT(dev);
518 if (unit != USB_DEV_MINOR)
521 if (uio->uio_resid != sizeof(struct usb_event))
527 n = usb_get_next_event(&ue);
530 if (ap->a_ioflag & IO_NDELAY) {
534 error = tsleep(&usb_events, PCATCH, "usbrea", 0);
540 error = uiomove((void *)&ue, uio->uio_resid, uio);
546 usbclose(struct dev_close_args *ap)
548 cdev_t dev = ap->a_head.a_dev;
549 int unit = USBUNIT(dev);
551 if (unit == USB_DEV_MINOR) {
552 usb_async_proc = NULL;
560 usbioctl(struct dev_ioctl_args *ap)
562 cdev_t devt = ap->a_head.a_dev;
563 struct usb_softc *sc;
564 int unit = USBUNIT(devt);
566 if (unit == USB_DEV_MINOR) {
569 if (*(int *)ap->a_data)
570 usb_async_proc = curproc;
572 usb_async_proc = NULL;
580 USB_GET_SC(usb, unit, sc);
586 /* This part should be deleted */
591 struct usb_ctl_request *ur = (void *)ap->a_data;
592 int len = UGETW(ur->ucr_request.wLength);
596 int addr = ur->ucr_addr;
600 DPRINTF(("usbioctl: USB_REQUEST addr=%d len=%d\n", addr, len));
601 if (len < 0 || len > 32768)
603 if (addr < 0 || addr >= USB_MAX_DEVICES ||
604 sc->sc_bus->devices[addr] == 0)
607 iov.iov_base = (caddr_t)ur->ucr_data;
613 uio.uio_segflg = UIO_USERSPACE;
615 ur->ucr_request.bmRequestType & UT_READ ?
616 UIO_READ : UIO_WRITE;
617 uio.uio_td = curthread;
618 ptr = kmalloc(len, M_TEMP, M_WAITOK);
619 if (uio.uio_rw == UIO_WRITE) {
620 error = uiomove(ptr, len, &uio);
625 err = usbd_do_request_flags(sc->sc_bus->devices[addr],
626 &ur->ucr_request, ptr, ur->ucr_flags, &ur->ucr_actlen,
627 USBD_DEFAULT_TIMEOUT);
633 if (uio.uio_rw == UIO_READ) {
634 error = uiomove(ptr, len, &uio);
647 struct usb_device_info *di = (void *)ap->a_data;
648 int addr = di->udi_addr;
649 usbd_device_handle dev;
651 if (addr < 1 || addr >= USB_MAX_DEVICES)
653 dev = sc->sc_bus->devices[addr];
656 usbd_fill_deviceinfo(dev, di, 1);
660 case USB_DEVICESTATS:
661 *(struct usb_device_stats *)ap->a_data = sc->sc_bus->stats;
671 usbpoll(struct dev_poll_args *ap)
673 cdev_t dev = ap->a_head.a_dev;
675 int unit = USBUNIT(dev);
677 if (unit == USB_DEV_MINOR) {
679 mask = POLLIN | POLLRDNORM;
682 if (ap->a_events & mask && usb_nevents > 0)
683 revents |= ap->a_events & mask;
684 if (revents == 0 && ap->a_events & mask)
685 selrecord(curthread, &usb_selevent);
687 ap->a_events = revents;
691 return (0); /* select/poll never wakes up - back compat */
695 /* Explore device tree from the root. */
697 usb_discover(void *v)
699 struct usb_softc *sc = v;
701 DPRINTFN(2,("usb_discover\n"));
703 if (usb_noexplore > 1)
708 * We need mutual exclusion while traversing the device tree,
709 * but this is guaranteed since this function is only called
710 * from the event thread for the controller.
713 while (sc->sc_bus->needs_explore && !sc->sc_dying) {
714 sc->sc_bus->needs_explore = 0;
717 sc->sc_bus->root_hub->hub->explore(sc->sc_bus->root_hub);
725 usb_needs_explore(usbd_device_handle dev)
727 DPRINTFN(2,("usb_needs_explore\n"));
728 dev->bus->needs_explore = 1;
729 wakeup(&dev->bus->needs_explore);
732 /* Called from a critical section */
734 usb_get_next_event(struct usb_event *ue)
736 struct usb_event_q *ueq;
738 if (usb_nevents <= 0)
740 ueq = TAILQ_FIRST(&usb_events);
743 kprintf("usb: usb_nevents got out of sync! %d\n", usb_nevents);
749 TAILQ_REMOVE(&usb_events, ueq, next);
750 kfree(ueq, M_USBDEV);
756 usbd_add_dev_event(int type, usbd_device_handle udev)
760 usbd_fill_deviceinfo(udev, &ue.u.ue_device, USB_EVENT_IS_ATTACH(type));
761 usb_add_event(type, &ue);
765 usbd_add_drv_event(int type, usbd_device_handle udev, device_t dev)
769 ue.u.ue_driver.ue_cookie = udev->cookie;
770 strncpy(ue.u.ue_driver.ue_devname, device_get_nameunit(dev),
771 sizeof ue.u.ue_driver.ue_devname);
772 usb_add_event(type, &ue);
776 usb_add_event(int type, struct usb_event *uep)
778 struct usb_event_q *ueq;
780 struct timeval thetime;
782 ueq = kmalloc(sizeof *ueq, M_USBDEV, M_INTWAIT);
784 ueq->ue.ue_type = type;
786 TIMEVAL_TO_TIMESPEC(&thetime, &ueq->ue.ue_time);
789 if (USB_EVENT_IS_DETACH(type)) {
790 struct usb_event_q *ueqi, *ueqi_next;
792 for (ueqi = TAILQ_FIRST(&usb_events); ueqi; ueqi = ueqi_next) {
793 ueqi_next = TAILQ_NEXT(ueqi, next);
794 if (ueqi->ue.u.ue_driver.ue_cookie.cookie ==
795 uep->u.ue_device.udi_cookie.cookie) {
796 TAILQ_REMOVE(&usb_events, ueqi, next);
797 kfree(ueqi, M_USBDEV);
799 ueqi_next = TAILQ_FIRST(&usb_events);
803 if (usb_nevents >= USB_MAX_EVENTS) {
804 /* Too many queued events, drop an old one. */
805 DPRINTF(("usb: event dropped\n"));
806 usb_get_next_event(&ue);
808 TAILQ_INSERT_TAIL(&usb_events, ueq, next);
811 selwakeuppri(&usb_selevent, 0);
812 if (usb_async_proc != NULL) {
813 ksignal(usb_async_proc, SIGIO);
819 usb_schedsoftintr(usbd_bus_handle bus)
821 DPRINTFN(10,("usb_schedsoftintr: polling=%d\n", bus->use_polling));
822 #ifdef USB_USE_SOFTINTR
823 if (bus->use_polling) {
824 bus->methods->soft_intr(bus);
826 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
827 softintr_schedule(bus->soft);
829 if (!callout_pending(&bus->softi))
830 callout_reset(&bus->softi, 0, bus->methods->soft_intr,
832 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */
835 bus->methods->soft_intr(bus);
836 #endif /* USB_USE_SOFTINTR */
841 USB_DETACH_START(usb, sc);
844 DPRINTF(("usb_detach: start\n"));
848 /* Make all devices disconnect. */
849 if (sc->sc_port.device != NULL)
850 usb_disconnect_port(&sc->sc_port, self);
852 /* Kill off event thread. */
853 if (sc->sc_event_thread != NULL) {
854 wakeup(&sc->sc_bus->needs_explore);
855 if (tsleep(sc, 0, "usbdet", hz * 60))
856 kprintf("%s: event thread didn't die\n",
857 device_get_nameunit(sc->sc_dev));
858 DPRINTF(("usb_detach: event thread dead\n"));
861 destroy_dev(sc->sc_usbdev);
862 if (--usb_ndevs == 0) {
865 destroy_dev(usb_dev);
868 for (i = 0; i < USB_NUM_TASKQS; i++) {
869 struct usb_taskq *taskq = &usb_taskq[i];
870 wakeup(&taskq->tasks);
871 if (tsleep(&taskq->taskcreated, 0, "usbtdt",
873 kprintf("usb task thread %s didn't die\n",
881 #ifdef USB_USE_SOFTINTR
882 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
883 if (sc->sc_bus->soft != NULL) {
884 softintr_disestablish(sc->sc_bus->soft);
885 sc->sc_bus->soft = NULL;
888 callout_stop(&sc->sc_bus->softi);
892 ue.u.ue_ctrlr.ue_bus = device_get_unit(sc->sc_dev);
893 usb_add_event(USB_EVENT_CTRLR_DETACH, &ue);
899 usb_child_detached(device_t self, device_t child)
901 struct usb_softc *sc = device_get_softc(self);
903 /* XXX, should check it is the right device. */
904 sc->sc_port.device = NULL;
907 DRIVER_MODULE(usb, ohci, usb_driver, usb_devclass, 0, 0);
908 DRIVER_MODULE(usb, uhci, usb_driver, usb_devclass, 0, 0);
909 DRIVER_MODULE(usb, ehci, usb_driver, usb_devclass, 0, 0);