xref: /freebsd/sys/dev/usb/controller/usb_controller.c (revision fe9b3289e67c4558d52b5035a0de1eae3bd96d10)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifdef USB_GLOBAL_INCLUDE_FILE
28 #include USB_GLOBAL_INCLUDE_FILE
29 #else
30 #include "opt_ddb.h"
31 
32 #include <sys/stdint.h>
33 #include <sys/stddef.h>
34 #include <sys/param.h>
35 #include <sys/queue.h>
36 #include <sys/types.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/bus.h>
40 #include <sys/module.h>
41 #include <sys/lock.h>
42 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/sysctl.h>
45 #include <sys/sx.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
49 #include <sys/priv.h>
50 
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbdi.h>
53 
54 #define	USB_DEBUG_VAR usb_ctrl_debug
55 
56 #include <dev/usb/usb_core.h>
57 #include <dev/usb/usb_debug.h>
58 #include <dev/usb/usb_process.h>
59 #include <dev/usb/usb_busdma.h>
60 #include <dev/usb/usb_dynamic.h>
61 #include <dev/usb/usb_device.h>
62 #include <dev/usb/usb_hub.h>
63 
64 #include <dev/usb/usb_controller.h>
65 #include <dev/usb/usb_bus.h>
66 #include <dev/usb/usb_pf.h>
67 #include "usb_if.h"
68 #endif			/* USB_GLOBAL_INCLUDE_FILE */
69 
70 /* function prototypes  */
71 
72 static device_probe_t usb_probe;
73 static device_attach_t usb_attach;
74 static device_detach_t usb_detach;
75 static device_suspend_t usb_suspend;
76 static device_resume_t usb_resume;
77 static device_shutdown_t usb_shutdown;
78 
79 static void	usb_attach_sub(device_t, struct usb_bus *);
80 
81 /* static variables */
82 
83 #ifdef USB_DEBUG
84 static int usb_ctrl_debug = 0;
85 
86 static SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW, 0, "USB controller");
87 SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RW, &usb_ctrl_debug, 0,
88     "Debug level");
89 #endif
90 
91 #if USB_HAVE_ROOT_MOUNT_HOLD
92 static int usb_no_boot_wait = 0;
93 TUNABLE_INT("hw.usb.no_boot_wait", &usb_no_boot_wait);
94 SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RD|CTLFLAG_TUN, &usb_no_boot_wait, 0,
95     "No USB device enumerate waiting at boot.");
96 #endif
97 
98 static int usb_no_suspend_wait = 0;
99 TUNABLE_INT("hw.usb.no_suspend_wait", &usb_no_suspend_wait);
100 SYSCTL_INT(_hw_usb, OID_AUTO, no_suspend_wait, CTLFLAG_RW|CTLFLAG_TUN,
101     &usb_no_suspend_wait, 0, "No USB device waiting at system suspend.");
102 
103 static int usb_no_shutdown_wait = 0;
104 TUNABLE_INT("hw.usb.no_shutdown_wait", &usb_no_shutdown_wait);
105 SYSCTL_INT(_hw_usb, OID_AUTO, no_shutdown_wait, CTLFLAG_RW|CTLFLAG_TUN,
106     &usb_no_shutdown_wait, 0, "No USB device waiting at system shutdown.");
107 
108 static devclass_t usb_devclass;
109 
110 static device_method_t usb_methods[] = {
111 	DEVMETHOD(device_probe, usb_probe),
112 	DEVMETHOD(device_attach, usb_attach),
113 	DEVMETHOD(device_detach, usb_detach),
114 	DEVMETHOD(device_suspend, usb_suspend),
115 	DEVMETHOD(device_resume, usb_resume),
116 	DEVMETHOD(device_shutdown, usb_shutdown),
117 
118 	DEVMETHOD_END
119 };
120 
121 static driver_t usb_driver = {
122 	.name = "usbus",
123 	.methods = usb_methods,
124 	.size = 0,
125 };
126 
127 /* Host Only Drivers */
128 DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0);
129 DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0);
130 DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0);
131 DRIVER_MODULE(usbus, xhci, usb_driver, usb_devclass, 0, 0);
132 
133 /* Device Only Drivers */
134 DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0);
135 DRIVER_MODULE(usbus, musbotg, usb_driver, usb_devclass, 0, 0);
136 DRIVER_MODULE(usbus, uss820, usb_driver, usb_devclass, 0, 0);
137 DRIVER_MODULE(usbus, octusb, usb_driver, usb_devclass, 0, 0);
138 
139 /* Dual Mode Drivers */
140 DRIVER_MODULE(usbus, dwcotg, usb_driver, usb_devclass, 0, 0);
141 
142 /*------------------------------------------------------------------------*
143  *	usb_probe
144  *
145  * This function is called from "{ehci,ohci,uhci}_pci_attach()".
146  *------------------------------------------------------------------------*/
147 static int
148 usb_probe(device_t dev)
149 {
150 	DPRINTF("\n");
151 	return (0);
152 }
153 
154 #if USB_HAVE_ROOT_MOUNT_HOLD
155 static void
156 usb_root_mount_rel(struct usb_bus *bus)
157 {
158 	if (bus->bus_roothold != NULL) {
159 		DPRINTF("Releasing root mount hold %p\n", bus->bus_roothold);
160 		root_mount_rel(bus->bus_roothold);
161 		bus->bus_roothold = NULL;
162 	}
163 }
164 #endif
165 
166 /*------------------------------------------------------------------------*
167  *	usb_attach
168  *------------------------------------------------------------------------*/
169 static int
170 usb_attach(device_t dev)
171 {
172 	struct usb_bus *bus = device_get_ivars(dev);
173 
174 	DPRINTF("\n");
175 
176 	if (bus == NULL) {
177 		device_printf(dev, "USB device has no ivars\n");
178 		return (ENXIO);
179 	}
180 
181 #if USB_HAVE_ROOT_MOUNT_HOLD
182 	if (usb_no_boot_wait == 0) {
183 		/* delay vfs_mountroot until the bus is explored */
184 		bus->bus_roothold = root_mount_hold(device_get_nameunit(dev));
185 	}
186 #endif
187 	usb_attach_sub(dev, bus);
188 
189 	return (0);			/* return success */
190 }
191 
192 /*------------------------------------------------------------------------*
193  *	usb_detach
194  *------------------------------------------------------------------------*/
195 static int
196 usb_detach(device_t dev)
197 {
198 	struct usb_bus *bus = device_get_softc(dev);
199 
200 	DPRINTF("\n");
201 
202 	if (bus == NULL) {
203 		/* was never setup properly */
204 		return (0);
205 	}
206 	/* Stop power watchdog */
207 	usb_callout_drain(&bus->power_wdog);
208 
209 #if USB_HAVE_ROOT_MOUNT_HOLD
210 	/* Let the USB explore process detach all devices. */
211 	usb_root_mount_rel(bus);
212 #endif
213 
214 	USB_BUS_LOCK(bus);
215 
216 	/* Queue detach job */
217 	usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
218 	    &bus->detach_msg[0], &bus->detach_msg[1]);
219 
220 	/* Wait for detach to complete */
221 	usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus),
222 	    &bus->detach_msg[0], &bus->detach_msg[1]);
223 
224 	USB_BUS_UNLOCK(bus);
225 
226 #if USB_HAVE_PER_BUS_PROCESS
227 	/* Get rid of USB callback processes */
228 
229 	usb_proc_free(USB_BUS_GIANT_PROC(bus));
230 	usb_proc_free(USB_BUS_NON_GIANT_PROC(bus));
231 
232 	/* Get rid of USB explore process */
233 
234 	usb_proc_free(USB_BUS_EXPLORE_PROC(bus));
235 
236 	/* Get rid of control transfer process */
237 
238 	usb_proc_free(USB_BUS_CONTROL_XFER_PROC(bus));
239 #endif
240 
241 #if USB_HAVE_PF
242 	usbpf_detach(bus);
243 #endif
244 	return (0);
245 }
246 
247 /*------------------------------------------------------------------------*
248  *	usb_suspend
249  *------------------------------------------------------------------------*/
250 static int
251 usb_suspend(device_t dev)
252 {
253 	struct usb_bus *bus = device_get_softc(dev);
254 
255 	DPRINTF("\n");
256 
257 	if (bus == NULL) {
258 		/* was never setup properly */
259 		return (0);
260 	}
261 
262 	USB_BUS_LOCK(bus);
263 	usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
264 	    &bus->suspend_msg[0], &bus->suspend_msg[1]);
265 	if (usb_no_suspend_wait == 0) {
266 		/* wait for suspend callback to be executed */
267 		usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus),
268 		    &bus->suspend_msg[0], &bus->suspend_msg[1]);
269 	}
270 	USB_BUS_UNLOCK(bus);
271 
272 	return (0);
273 }
274 
275 /*------------------------------------------------------------------------*
276  *	usb_resume
277  *------------------------------------------------------------------------*/
278 static int
279 usb_resume(device_t dev)
280 {
281 	struct usb_bus *bus = device_get_softc(dev);
282 
283 	DPRINTF("\n");
284 
285 	if (bus == NULL) {
286 		/* was never setup properly */
287 		return (0);
288 	}
289 
290 	USB_BUS_LOCK(bus);
291 	usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
292 	    &bus->resume_msg[0], &bus->resume_msg[1]);
293 	USB_BUS_UNLOCK(bus);
294 
295 	return (0);
296 }
297 
298 /*------------------------------------------------------------------------*
299  *	usb_shutdown
300  *------------------------------------------------------------------------*/
301 static int
302 usb_shutdown(device_t dev)
303 {
304 	struct usb_bus *bus = device_get_softc(dev);
305 
306 	DPRINTF("\n");
307 
308 	if (bus == NULL) {
309 		/* was never setup properly */
310 		return (0);
311 	}
312 
313 	device_printf(bus->bdev, "Controller shutdown\n");
314 
315 	USB_BUS_LOCK(bus);
316 	usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
317 	    &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
318 	if (usb_no_shutdown_wait == 0) {
319 		/* wait for shutdown callback to be executed */
320 		usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus),
321 		    &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
322 	}
323 	USB_BUS_UNLOCK(bus);
324 
325 	device_printf(bus->bdev, "Controller shutdown complete\n");
326 
327 	return (0);
328 }
329 
330 /*------------------------------------------------------------------------*
331  *	usb_bus_explore
332  *
333  * This function is used to explore the device tree from the root.
334  *------------------------------------------------------------------------*/
335 static void
336 usb_bus_explore(struct usb_proc_msg *pm)
337 {
338 	struct usb_bus *bus;
339 	struct usb_device *udev;
340 
341 	bus = ((struct usb_bus_msg *)pm)->bus;
342 	udev = bus->devices[USB_ROOT_HUB_ADDR];
343 
344 	if (bus->no_explore != 0)
345 		return;
346 
347 	if (udev && udev->hub) {
348 
349 		if (bus->do_probe) {
350 			bus->do_probe = 0;
351 			bus->driver_added_refcount++;
352 		}
353 		if (bus->driver_added_refcount == 0) {
354 			/* avoid zero, hence that is memory default */
355 			bus->driver_added_refcount = 1;
356 		}
357 
358 #ifdef DDB
359 		/*
360 		 * The following three lines of code are only here to
361 		 * recover from DDB:
362 		 */
363 		usb_proc_rewakeup(USB_BUS_CONTROL_XFER_PROC(bus));
364 		usb_proc_rewakeup(USB_BUS_GIANT_PROC(bus));
365 		usb_proc_rewakeup(USB_BUS_NON_GIANT_PROC(bus));
366 #endif
367 
368 		USB_BUS_UNLOCK(bus);
369 
370 #if USB_HAVE_POWERD
371 		/*
372 		 * First update the USB power state!
373 		 */
374 		usb_bus_powerd(bus);
375 #endif
376 		 /* Explore the Root USB HUB. */
377 		(udev->hub->explore) (udev);
378 		USB_BUS_LOCK(bus);
379 	}
380 #if USB_HAVE_ROOT_MOUNT_HOLD
381 	usb_root_mount_rel(bus);
382 #endif
383 }
384 
385 /*------------------------------------------------------------------------*
386  *	usb_bus_detach
387  *
388  * This function is used to detach the device tree from the root.
389  *------------------------------------------------------------------------*/
390 static void
391 usb_bus_detach(struct usb_proc_msg *pm)
392 {
393 	struct usb_bus *bus;
394 	struct usb_device *udev;
395 	device_t dev;
396 
397 	bus = ((struct usb_bus_msg *)pm)->bus;
398 	udev = bus->devices[USB_ROOT_HUB_ADDR];
399 	dev = bus->bdev;
400 	/* clear the softc */
401 	device_set_softc(dev, NULL);
402 	USB_BUS_UNLOCK(bus);
403 
404 	/* detach children first */
405 	mtx_lock(&Giant);
406 	bus_generic_detach(dev);
407 	mtx_unlock(&Giant);
408 
409 	/*
410 	 * Free USB device and all subdevices, if any.
411 	 */
412 	usb_free_device(udev, 0);
413 
414 	USB_BUS_LOCK(bus);
415 	/* clear bdev variable last */
416 	bus->bdev = NULL;
417 }
418 
419 /*------------------------------------------------------------------------*
420  *	usb_bus_suspend
421  *
422  * This function is used to suspend the USB contoller.
423  *------------------------------------------------------------------------*/
424 static void
425 usb_bus_suspend(struct usb_proc_msg *pm)
426 {
427 	struct usb_bus *bus;
428 	struct usb_device *udev;
429 	usb_error_t err;
430 
431 	bus = ((struct usb_bus_msg *)pm)->bus;
432 	udev = bus->devices[USB_ROOT_HUB_ADDR];
433 
434 	if (udev == NULL || bus->bdev == NULL)
435 		return;
436 
437 	USB_BUS_UNLOCK(bus);
438 
439 	/*
440 	 * We use the shutdown event here because the suspend and
441 	 * resume events are reserved for the USB port suspend and
442 	 * resume. The USB system suspend is implemented like full
443 	 * shutdown and all connected USB devices will be disconnected
444 	 * subsequently. At resume all USB devices will be
445 	 * re-connected again.
446 	 */
447 
448 	bus_generic_shutdown(bus->bdev);
449 
450 	usbd_enum_lock(udev);
451 
452 	err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
453 	if (err)
454 		device_printf(bus->bdev, "Could not unconfigure root HUB\n");
455 
456 	USB_BUS_LOCK(bus);
457 	bus->hw_power_state = 0;
458 	bus->no_explore = 1;
459 	USB_BUS_UNLOCK(bus);
460 
461 	if (bus->methods->set_hw_power != NULL)
462 		(bus->methods->set_hw_power) (bus);
463 
464 	if (bus->methods->set_hw_power_sleep != NULL)
465 		(bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SUSPEND);
466 
467 	usbd_enum_unlock(udev);
468 
469 	USB_BUS_LOCK(bus);
470 }
471 
472 /*------------------------------------------------------------------------*
473  *	usb_bus_resume
474  *
475  * This function is used to resume the USB contoller.
476  *------------------------------------------------------------------------*/
477 static void
478 usb_bus_resume(struct usb_proc_msg *pm)
479 {
480 	struct usb_bus *bus;
481 	struct usb_device *udev;
482 	usb_error_t err;
483 
484 	bus = ((struct usb_bus_msg *)pm)->bus;
485 	udev = bus->devices[USB_ROOT_HUB_ADDR];
486 
487 	if (udev == NULL || bus->bdev == NULL)
488 		return;
489 
490 	USB_BUS_UNLOCK(bus);
491 
492 	usbd_enum_lock(udev);
493 #if 0
494 	DEVMETHOD(usb_take_controller, NULL);	/* dummy */
495 #endif
496 	USB_TAKE_CONTROLLER(device_get_parent(bus->bdev));
497 
498 	USB_BUS_LOCK(bus);
499  	bus->hw_power_state =
500 	  USB_HW_POWER_CONTROL |
501 	  USB_HW_POWER_BULK |
502 	  USB_HW_POWER_INTERRUPT |
503 	  USB_HW_POWER_ISOC |
504 	  USB_HW_POWER_NON_ROOT_HUB;
505 	bus->no_explore = 0;
506 	USB_BUS_UNLOCK(bus);
507 
508 	if (bus->methods->set_hw_power_sleep != NULL)
509 		(bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_RESUME);
510 
511 	if (bus->methods->set_hw_power != NULL)
512 		(bus->methods->set_hw_power) (bus);
513 
514 	/* restore USB configuration to index 0 */
515 	err = usbd_set_config_index(udev, 0);
516 	if (err)
517 		device_printf(bus->bdev, "Could not configure root HUB\n");
518 
519 	/* probe and attach */
520 	err = usb_probe_and_attach(udev, USB_IFACE_INDEX_ANY);
521 	if (err) {
522 		device_printf(bus->bdev, "Could not probe and "
523 		    "attach root HUB\n");
524 	}
525 
526 	usbd_enum_unlock(udev);
527 
528 	USB_BUS_LOCK(bus);
529 }
530 
531 /*------------------------------------------------------------------------*
532  *	usb_bus_shutdown
533  *
534  * This function is used to shutdown the USB contoller.
535  *------------------------------------------------------------------------*/
536 static void
537 usb_bus_shutdown(struct usb_proc_msg *pm)
538 {
539 	struct usb_bus *bus;
540 	struct usb_device *udev;
541 	usb_error_t err;
542 
543 	bus = ((struct usb_bus_msg *)pm)->bus;
544 	udev = bus->devices[USB_ROOT_HUB_ADDR];
545 
546 	if (udev == NULL || bus->bdev == NULL)
547 		return;
548 
549 	USB_BUS_UNLOCK(bus);
550 
551 	bus_generic_shutdown(bus->bdev);
552 
553 	usbd_enum_lock(udev);
554 
555 	err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
556 	if (err)
557 		device_printf(bus->bdev, "Could not unconfigure root HUB\n");
558 
559 	USB_BUS_LOCK(bus);
560 	bus->hw_power_state = 0;
561 	bus->no_explore = 1;
562 	USB_BUS_UNLOCK(bus);
563 
564 	if (bus->methods->set_hw_power != NULL)
565 		(bus->methods->set_hw_power) (bus);
566 
567 	if (bus->methods->set_hw_power_sleep != NULL)
568 		(bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SHUTDOWN);
569 
570 	usbd_enum_unlock(udev);
571 
572 	USB_BUS_LOCK(bus);
573 }
574 
575 static void
576 usb_power_wdog(void *arg)
577 {
578 	struct usb_bus *bus = arg;
579 
580 	USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
581 
582 	usb_callout_reset(&bus->power_wdog,
583 	    4 * hz, usb_power_wdog, arg);
584 
585 #ifdef DDB
586 	/*
587 	 * The following line of code is only here to recover from
588 	 * DDB:
589 	 */
590 	usb_proc_rewakeup(USB_BUS_EXPLORE_PROC(bus));	/* recover from DDB */
591 #endif
592 
593 #if USB_HAVE_POWERD
594 	USB_BUS_UNLOCK(bus);
595 
596 	usb_bus_power_update(bus);
597 
598 	USB_BUS_LOCK(bus);
599 #endif
600 }
601 
602 /*------------------------------------------------------------------------*
603  *	usb_bus_attach
604  *
605  * This function attaches USB in context of the explore thread.
606  *------------------------------------------------------------------------*/
607 static void
608 usb_bus_attach(struct usb_proc_msg *pm)
609 {
610 	struct usb_bus *bus;
611 	struct usb_device *child;
612 	device_t dev;
613 	usb_error_t err;
614 	enum usb_dev_speed speed;
615 
616 	bus = ((struct usb_bus_msg *)pm)->bus;
617 	dev = bus->bdev;
618 
619 	DPRINTF("\n");
620 
621 	switch (bus->usbrev) {
622 	case USB_REV_1_0:
623 		speed = USB_SPEED_FULL;
624 		device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n");
625 		break;
626 
627 	case USB_REV_1_1:
628 		speed = USB_SPEED_FULL;
629 		device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n");
630 		break;
631 
632 	case USB_REV_2_0:
633 		speed = USB_SPEED_HIGH;
634 		device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n");
635 		break;
636 
637 	case USB_REV_2_5:
638 		speed = USB_SPEED_VARIABLE;
639 		device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n");
640 		break;
641 
642 	case USB_REV_3_0:
643 		speed = USB_SPEED_SUPER;
644 		device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n");
645 		break;
646 
647 	default:
648 		device_printf(bus->bdev, "Unsupported USB revision\n");
649 #if USB_HAVE_ROOT_MOUNT_HOLD
650 		usb_root_mount_rel(bus);
651 #endif
652 		return;
653 	}
654 
655 	/* default power_mask value */
656 	bus->hw_power_state =
657 	  USB_HW_POWER_CONTROL |
658 	  USB_HW_POWER_BULK |
659 	  USB_HW_POWER_INTERRUPT |
660 	  USB_HW_POWER_ISOC |
661 	  USB_HW_POWER_NON_ROOT_HUB;
662 
663 	USB_BUS_UNLOCK(bus);
664 
665 	/* make sure power is set at least once */
666 
667 	if (bus->methods->set_hw_power != NULL) {
668 		(bus->methods->set_hw_power) (bus);
669 	}
670 
671 	/* allocate the Root USB device */
672 
673 	child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1,
674 	    speed, USB_MODE_HOST);
675 	if (child) {
676 		err = usb_probe_and_attach(child,
677 		    USB_IFACE_INDEX_ANY);
678 		if (!err) {
679 			if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) ||
680 			    (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) {
681 				err = USB_ERR_NO_ROOT_HUB;
682 			}
683 		}
684 	} else {
685 		err = USB_ERR_NOMEM;
686 	}
687 
688 	USB_BUS_LOCK(bus);
689 
690 	if (err) {
691 		device_printf(bus->bdev, "Root HUB problem, error=%s\n",
692 		    usbd_errstr(err));
693 #if USB_HAVE_ROOT_MOUNT_HOLD
694 		usb_root_mount_rel(bus);
695 #endif
696 	}
697 
698 	/* set softc - we are ready */
699 	device_set_softc(dev, bus);
700 
701 	/* start watchdog */
702 	usb_power_wdog(bus);
703 }
704 
705 /*------------------------------------------------------------------------*
706  *	usb_attach_sub
707  *
708  * This function creates a thread which runs the USB attach code.
709  *------------------------------------------------------------------------*/
710 static void
711 usb_attach_sub(device_t dev, struct usb_bus *bus)
712 {
713 	mtx_lock(&Giant);
714 	if (usb_devclass_ptr == NULL)
715 		usb_devclass_ptr = devclass_find("usbus");
716 	mtx_unlock(&Giant);
717 
718 #if USB_HAVE_PF
719 	usbpf_attach(bus);
720 #endif
721 	/* Initialise USB process messages */
722 	bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore;
723 	bus->explore_msg[0].bus = bus;
724 	bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore;
725 	bus->explore_msg[1].bus = bus;
726 
727 	bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach;
728 	bus->detach_msg[0].bus = bus;
729 	bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach;
730 	bus->detach_msg[1].bus = bus;
731 
732 	bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach;
733 	bus->attach_msg[0].bus = bus;
734 	bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach;
735 	bus->attach_msg[1].bus = bus;
736 
737 	bus->suspend_msg[0].hdr.pm_callback = &usb_bus_suspend;
738 	bus->suspend_msg[0].bus = bus;
739 	bus->suspend_msg[1].hdr.pm_callback = &usb_bus_suspend;
740 	bus->suspend_msg[1].bus = bus;
741 
742 	bus->resume_msg[0].hdr.pm_callback = &usb_bus_resume;
743 	bus->resume_msg[0].bus = bus;
744 	bus->resume_msg[1].hdr.pm_callback = &usb_bus_resume;
745 	bus->resume_msg[1].bus = bus;
746 
747 	bus->shutdown_msg[0].hdr.pm_callback = &usb_bus_shutdown;
748 	bus->shutdown_msg[0].bus = bus;
749 	bus->shutdown_msg[1].hdr.pm_callback = &usb_bus_shutdown;
750 	bus->shutdown_msg[1].bus = bus;
751 
752 #if USB_HAVE_PER_BUS_PROCESS
753 	/* Create USB explore and callback processes */
754 
755 	if (usb_proc_create(USB_BUS_GIANT_PROC(bus),
756 	    &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) {
757 		device_printf(dev, "WARNING: Creation of USB Giant "
758 		    "callback process failed.\n");
759 	} else if (usb_proc_create(USB_BUS_NON_GIANT_PROC(bus),
760 	    &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_HIGH)) {
761 		device_printf(dev, "WARNING: Creation of USB non-Giant "
762 		    "callback process failed.\n");
763 	} else if (usb_proc_create(USB_BUS_EXPLORE_PROC(bus),
764 	    &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) {
765 		device_printf(dev, "WARNING: Creation of USB explore "
766 		    "process failed.\n");
767 	} else if (usb_proc_create(USB_BUS_CONTROL_XFER_PROC(bus),
768 	    &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) {
769 		device_printf(dev, "WARNING: Creation of USB control transfer "
770 		    "process failed.\n");
771 	} else
772 #endif
773 	{
774 		/* Get final attach going */
775 		USB_BUS_LOCK(bus);
776 		usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus),
777 		    &bus->attach_msg[0], &bus->attach_msg[1]);
778 		USB_BUS_UNLOCK(bus);
779 
780 		/* Do initial explore */
781 		usb_needs_explore(bus, 1);
782 	}
783 }
784 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL);
785 
786 /*------------------------------------------------------------------------*
787  *	usb_bus_mem_flush_all_cb
788  *------------------------------------------------------------------------*/
789 #if USB_HAVE_BUSDMA
790 static void
791 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
792     struct usb_page *pg, usb_size_t size, usb_size_t align)
793 {
794 	usb_pc_cpu_flush(pc);
795 }
796 #endif
797 
798 /*------------------------------------------------------------------------*
799  *	usb_bus_mem_flush_all - factored out code
800  *------------------------------------------------------------------------*/
801 #if USB_HAVE_BUSDMA
802 void
803 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
804 {
805 	if (cb) {
806 		cb(bus, &usb_bus_mem_flush_all_cb);
807 	}
808 }
809 #endif
810 
811 /*------------------------------------------------------------------------*
812  *	usb_bus_mem_alloc_all_cb
813  *------------------------------------------------------------------------*/
814 #if USB_HAVE_BUSDMA
815 static void
816 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
817     struct usb_page *pg, usb_size_t size, usb_size_t align)
818 {
819 	/* need to initialize the page cache */
820 	pc->tag_parent = bus->dma_parent_tag;
821 
822 	if (usb_pc_alloc_mem(pc, pg, size, align)) {
823 		bus->alloc_failed = 1;
824 	}
825 }
826 #endif
827 
828 /*------------------------------------------------------------------------*
829  *	usb_bus_mem_alloc_all - factored out code
830  *
831  * Returns:
832  *    0: Success
833  * Else: Failure
834  *------------------------------------------------------------------------*/
835 uint8_t
836 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat,
837     usb_bus_mem_cb_t *cb)
838 {
839 	bus->alloc_failed = 0;
840 
841 	mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent),
842 	    NULL, MTX_DEF | MTX_RECURSE);
843 
844 	usb_callout_init_mtx(&bus->power_wdog,
845 	    &bus->bus_mtx, 0);
846 
847 	TAILQ_INIT(&bus->intr_q.head);
848 
849 #if USB_HAVE_BUSDMA
850 	usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags,
851 	    dmat, &bus->bus_mtx, NULL, 32, USB_BUS_DMA_TAG_MAX);
852 #endif
853 	if ((bus->devices_max > USB_MAX_DEVICES) ||
854 	    (bus->devices_max < USB_MIN_DEVICES) ||
855 	    (bus->devices == NULL)) {
856 		DPRINTFN(0, "Devices field has not been "
857 		    "initialised properly\n");
858 		bus->alloc_failed = 1;		/* failure */
859 	}
860 #if USB_HAVE_BUSDMA
861 	if (cb) {
862 		cb(bus, &usb_bus_mem_alloc_all_cb);
863 	}
864 #endif
865 	if (bus->alloc_failed) {
866 		usb_bus_mem_free_all(bus, cb);
867 	}
868 	return (bus->alloc_failed);
869 }
870 
871 /*------------------------------------------------------------------------*
872  *	usb_bus_mem_free_all_cb
873  *------------------------------------------------------------------------*/
874 #if USB_HAVE_BUSDMA
875 static void
876 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
877     struct usb_page *pg, usb_size_t size, usb_size_t align)
878 {
879 	usb_pc_free_mem(pc);
880 }
881 #endif
882 
883 /*------------------------------------------------------------------------*
884  *	usb_bus_mem_free_all - factored out code
885  *------------------------------------------------------------------------*/
886 void
887 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
888 {
889 #if USB_HAVE_BUSDMA
890 	if (cb) {
891 		cb(bus, &usb_bus_mem_free_all_cb);
892 	}
893 	usb_dma_tag_unsetup(bus->dma_parent_tag);
894 #endif
895 
896 	mtx_destroy(&bus->bus_mtx);
897 }
898