xref: /freebsd/sys/dev/usb/controller/usb_controller.c (revision aa64588d28258aef88cc33b8043112e8856948d0) 
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 #include "opt_ddb.h"
28 
29 #include <sys/stdint.h>
30 #include <sys/stddef.h>
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/types.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/bus.h>
37 #include <sys/linker_set.h>
38 #include <sys/module.h>
39 #include <sys/lock.h>
40 #include <sys/mutex.h>
41 #include <sys/condvar.h>
42 #include <sys/sysctl.h>
43 #include <sys/sx.h>
44 #include <sys/unistd.h>
45 #include <sys/callout.h>
46 #include <sys/malloc.h>
47 #include <sys/priv.h>
48 
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 
52 #define	USB_DEBUG_VAR usb_ctrl_debug
53 
54 #include <dev/usb/usb_core.h>
55 #include <dev/usb/usb_debug.h>
56 #include <dev/usb/usb_process.h>
57 #include <dev/usb/usb_busdma.h>
58 #include <dev/usb/usb_dynamic.h>
59 #include <dev/usb/usb_device.h>
60 #include <dev/usb/usb_hub.h>
61 
62 #include <dev/usb/usb_controller.h>
63 #include <dev/usb/usb_bus.h>
64 
65 /* function prototypes  */
66 
67 static device_probe_t usb_probe;
68 static device_attach_t usb_attach;
69 static device_detach_t usb_detach;
70 
71 static void	usb_attach_sub(device_t, struct usb_bus *);
72 
73 /* static variables */
74 
75 #ifdef USB_DEBUG
76 static int usb_ctrl_debug = 0;
77 
78 SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW, 0, "USB controller");
79 SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RW, &usb_ctrl_debug, 0,
80     "Debug level");
81 #endif
82 
83 static int usb_no_boot_wait = 0;
84 TUNABLE_INT("hw.usb.no_boot_wait", &usb_no_boot_wait);
85 SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RDTUN, &usb_no_boot_wait, 0,
86     "No device enumerate waiting at boot.");
87 
88 static devclass_t usb_devclass;
89 
90 static device_method_t usb_methods[] = {
91 	DEVMETHOD(device_probe, usb_probe),
92 	DEVMETHOD(device_attach, usb_attach),
93 	DEVMETHOD(device_detach, usb_detach),
94 	DEVMETHOD(device_suspend, bus_generic_suspend),
95 	DEVMETHOD(device_resume, bus_generic_resume),
96 	DEVMETHOD(device_shutdown, bus_generic_shutdown),
97 	{0, 0}
98 };
99 
100 static driver_t usb_driver = {
101 	.name = "usbus",
102 	.methods = usb_methods,
103 	.size = 0,
104 };
105 
106 DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0);
107 DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0);
108 DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0);
109 DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0);
110 DRIVER_MODULE(usbus, uss820, usb_driver, usb_devclass, 0, 0);
111 
112 /*------------------------------------------------------------------------*
113  *	usb_probe
114  *
115  * This function is called from "{ehci,ohci,uhci}_pci_attach()".
116  *------------------------------------------------------------------------*/
117 static int
118 usb_probe(device_t dev)
119 {
120 	DPRINTF("\n");
121 	return (0);
122 }
123 
124 /*------------------------------------------------------------------------*
125  *	usb_attach
126  *------------------------------------------------------------------------*/
127 static int
128 usb_attach(device_t dev)
129 {
130 	struct usb_bus *bus = device_get_ivars(dev);
131 
132 	DPRINTF("\n");
133 
134 	if (bus == NULL) {
135 		device_printf(dev, "USB device has no ivars\n");
136 		return (ENXIO);
137 	}
138 
139 	if (usb_no_boot_wait == 0) {
140 		/* delay vfs_mountroot until the bus is explored */
141 		bus->bus_roothold = root_mount_hold(device_get_nameunit(dev));
142 	}
143 
144 	usb_attach_sub(dev, bus);
145 
146 	return (0);			/* return success */
147 }
148 
149 /*------------------------------------------------------------------------*
150  *	usb_detach
151  *------------------------------------------------------------------------*/
152 static int
153 usb_detach(device_t dev)
154 {
155 	struct usb_bus *bus = device_get_softc(dev);
156 
157 	DPRINTF("\n");
158 
159 	if (bus == NULL) {
160 		/* was never setup properly */
161 		return (0);
162 	}
163 	/* Stop power watchdog */
164 	usb_callout_drain(&bus->power_wdog);
165 
166 	/* Let the USB explore process detach all devices. */
167 	if (bus->bus_roothold != NULL) {
168 		root_mount_rel(bus->bus_roothold);
169 		bus->bus_roothold = NULL;
170 	}
171 
172 	USB_BUS_LOCK(bus);
173 	if (usb_proc_msignal(&bus->explore_proc,
174 	    &bus->detach_msg[0], &bus->detach_msg[1])) {
175 		/* ignore */
176 	}
177 	/* Wait for detach to complete */
178 
179 	usb_proc_mwait(&bus->explore_proc,
180 	    &bus->detach_msg[0], &bus->detach_msg[1]);
181 
182 	USB_BUS_UNLOCK(bus);
183 
184 	/* Get rid of USB callback processes */
185 
186 	usb_proc_free(&bus->giant_callback_proc);
187 	usb_proc_free(&bus->non_giant_callback_proc);
188 
189 	/* Get rid of USB explore process */
190 
191 	usb_proc_free(&bus->explore_proc);
192 
193 	/* Get rid of control transfer process */
194 
195 	usb_proc_free(&bus->control_xfer_proc);
196 
197 	return (0);
198 }
199 
200 /*------------------------------------------------------------------------*
201  *	usb_bus_explore
202  *
203  * This function is used to explore the device tree from the root.
204  *------------------------------------------------------------------------*/
205 static void
206 usb_bus_explore(struct usb_proc_msg *pm)
207 {
208 	struct usb_bus *bus;
209 	struct usb_device *udev;
210 
211 	bus = ((struct usb_bus_msg *)pm)->bus;
212 	udev = bus->devices[USB_ROOT_HUB_ADDR];
213 
214 	if (udev && udev->hub) {
215 
216 		if (bus->do_probe) {
217 			bus->do_probe = 0;
218 			bus->driver_added_refcount++;
219 		}
220 		if (bus->driver_added_refcount == 0) {
221 			/* avoid zero, hence that is memory default */
222 			bus->driver_added_refcount = 1;
223 		}
224 
225 #ifdef DDB
226 		/*
227 		 * The following three lines of code are only here to
228 		 * recover from DDB:
229 		 */
230 		usb_proc_rewakeup(&bus->control_xfer_proc);
231 		usb_proc_rewakeup(&bus->giant_callback_proc);
232 		usb_proc_rewakeup(&bus->non_giant_callback_proc);
233 #endif
234 
235 		USB_BUS_UNLOCK(bus);
236 
237 #if USB_HAVE_POWERD
238 		/*
239 		 * First update the USB power state!
240 		 */
241 		usb_bus_powerd(bus);
242 #endif
243 		 /* Explore the Root USB HUB. */
244 		(udev->hub->explore) (udev);
245 		USB_BUS_LOCK(bus);
246 	}
247 	if (bus->bus_roothold != NULL) {
248 		root_mount_rel(bus->bus_roothold);
249 		bus->bus_roothold = NULL;
250 	}
251 }
252 
253 /*------------------------------------------------------------------------*
254  *	usb_bus_detach
255  *
256  * This function is used to detach the device tree from the root.
257  *------------------------------------------------------------------------*/
258 static void
259 usb_bus_detach(struct usb_proc_msg *pm)
260 {
261 	struct usb_bus *bus;
262 	struct usb_device *udev;
263 	device_t dev;
264 
265 	bus = ((struct usb_bus_msg *)pm)->bus;
266 	udev = bus->devices[USB_ROOT_HUB_ADDR];
267 	dev = bus->bdev;
268 	/* clear the softc */
269 	device_set_softc(dev, NULL);
270 	USB_BUS_UNLOCK(bus);
271 
272 	/* detach children first */
273 	mtx_lock(&Giant);
274 	bus_generic_detach(dev);
275 	mtx_unlock(&Giant);
276 
277 	/*
278 	 * Free USB device and all subdevices, if any.
279 	 */
280 	usb_free_device(udev, 0);
281 
282 	USB_BUS_LOCK(bus);
283 	/* clear bdev variable last */
284 	bus->bdev = NULL;
285 }
286 
287 static void
288 usb_power_wdog(void *arg)
289 {
290 	struct usb_bus *bus = arg;
291 
292 	USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
293 
294 	usb_callout_reset(&bus->power_wdog,
295 	    4 * hz, usb_power_wdog, arg);
296 
297 #ifdef DDB
298 	/*
299 	 * The following line of code is only here to recover from
300 	 * DDB:
301 	 */
302 	usb_proc_rewakeup(&bus->explore_proc);	/* recover from DDB */
303 #endif
304 
305 #if USB_HAVE_POWERD
306 	USB_BUS_UNLOCK(bus);
307 
308 	usb_bus_power_update(bus);
309 
310 	USB_BUS_LOCK(bus);
311 #endif
312 }
313 
314 /*------------------------------------------------------------------------*
315  *	usb_bus_attach
316  *
317  * This function attaches USB in context of the explore thread.
318  *------------------------------------------------------------------------*/
319 static void
320 usb_bus_attach(struct usb_proc_msg *pm)
321 {
322 	struct usb_bus *bus;
323 	struct usb_device *child;
324 	device_t dev;
325 	usb_error_t err;
326 	enum usb_dev_speed speed;
327 
328 	bus = ((struct usb_bus_msg *)pm)->bus;
329 	dev = bus->bdev;
330 
331 	DPRINTF("\n");
332 
333 	switch (bus->usbrev) {
334 	case USB_REV_1_0:
335 		speed = USB_SPEED_FULL;
336 		device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n");
337 		break;
338 
339 	case USB_REV_1_1:
340 		speed = USB_SPEED_FULL;
341 		device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n");
342 		break;
343 
344 	case USB_REV_2_0:
345 		speed = USB_SPEED_HIGH;
346 		device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n");
347 		break;
348 
349 	case USB_REV_2_5:
350 		speed = USB_SPEED_VARIABLE;
351 		device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n");
352 		break;
353 
354 	default:
355 		device_printf(bus->bdev, "Unsupported USB revision\n");
356 		return;
357 	}
358 
359 	USB_BUS_UNLOCK(bus);
360 
361 	/* default power_mask value */
362 	bus->hw_power_state =
363 	  USB_HW_POWER_CONTROL |
364 	  USB_HW_POWER_BULK |
365 	  USB_HW_POWER_INTERRUPT |
366 	  USB_HW_POWER_ISOC |
367 	  USB_HW_POWER_NON_ROOT_HUB;
368 
369 	/* make sure power is set at least once */
370 
371 	if (bus->methods->set_hw_power != NULL) {
372 		(bus->methods->set_hw_power) (bus);
373 	}
374 
375 	/* Allocate the Root USB device */
376 
377 	child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1,
378 	    speed, USB_MODE_HOST);
379 	if (child) {
380 		err = usb_probe_and_attach(child,
381 		    USB_IFACE_INDEX_ANY);
382 		if (!err) {
383 			if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) ||
384 			    (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) {
385 				err = USB_ERR_NO_ROOT_HUB;
386 			}
387 		}
388 	} else {
389 		err = USB_ERR_NOMEM;
390 	}
391 
392 	USB_BUS_LOCK(bus);
393 
394 	if (err) {
395 		device_printf(bus->bdev, "Root HUB problem, error=%s\n",
396 		    usbd_errstr(err));
397 	}
398 
399 	/* set softc - we are ready */
400 	device_set_softc(dev, bus);
401 
402 	/* start watchdog */
403 	usb_power_wdog(bus);
404 }
405 
406 /*------------------------------------------------------------------------*
407  *	usb_attach_sub
408  *
409  * This function creates a thread which runs the USB attach code.
410  *------------------------------------------------------------------------*/
411 static void
412 usb_attach_sub(device_t dev, struct usb_bus *bus)
413 {
414 	const char *pname = device_get_nameunit(dev);
415 
416 	mtx_lock(&Giant);
417 	if (usb_devclass_ptr == NULL)
418 		usb_devclass_ptr = devclass_find("usbus");
419 	mtx_unlock(&Giant);
420 
421 	/* Initialise USB process messages */
422 	bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore;
423 	bus->explore_msg[0].bus = bus;
424 	bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore;
425 	bus->explore_msg[1].bus = bus;
426 
427 	bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach;
428 	bus->detach_msg[0].bus = bus;
429 	bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach;
430 	bus->detach_msg[1].bus = bus;
431 
432 	bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach;
433 	bus->attach_msg[0].bus = bus;
434 	bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach;
435 	bus->attach_msg[1].bus = bus;
436 
437 	/* Create USB explore and callback processes */
438 
439 	if (usb_proc_create(&bus->giant_callback_proc,
440 	    &bus->bus_mtx, pname, USB_PRI_MED)) {
441 		printf("WARNING: Creation of USB Giant "
442 		    "callback process failed.\n");
443 	} else if (usb_proc_create(&bus->non_giant_callback_proc,
444 	    &bus->bus_mtx, pname, USB_PRI_HIGH)) {
445 		printf("WARNING: Creation of USB non-Giant "
446 		    "callback process failed.\n");
447 	} else if (usb_proc_create(&bus->explore_proc,
448 	    &bus->bus_mtx, pname, USB_PRI_MED)) {
449 		printf("WARNING: Creation of USB explore "
450 		    "process failed.\n");
451 	} else if (usb_proc_create(&bus->control_xfer_proc,
452 	    &bus->bus_mtx, pname, USB_PRI_MED)) {
453 		printf("WARNING: Creation of USB control transfer "
454 		    "process failed.\n");
455 	} else {
456 		/* Get final attach going */
457 		USB_BUS_LOCK(bus);
458 		if (usb_proc_msignal(&bus->explore_proc,
459 		    &bus->attach_msg[0], &bus->attach_msg[1])) {
460 			/* ignore */
461 		}
462 		USB_BUS_UNLOCK(bus);
463 
464 		/* Do initial explore */
465 		usb_needs_explore(bus, 1);
466 	}
467 }
468 
469 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL);
470 
471 /*------------------------------------------------------------------------*
472  *	usb_bus_mem_flush_all_cb
473  *------------------------------------------------------------------------*/
474 #if USB_HAVE_BUSDMA
475 static void
476 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
477     struct usb_page *pg, usb_size_t size, usb_size_t align)
478 {
479 	usb_pc_cpu_flush(pc);
480 }
481 #endif
482 
483 /*------------------------------------------------------------------------*
484  *	usb_bus_mem_flush_all - factored out code
485  *------------------------------------------------------------------------*/
486 #if USB_HAVE_BUSDMA
487 void
488 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
489 {
490 	if (cb) {
491 		cb(bus, &usb_bus_mem_flush_all_cb);
492 	}
493 }
494 #endif
495 
496 /*------------------------------------------------------------------------*
497  *	usb_bus_mem_alloc_all_cb
498  *------------------------------------------------------------------------*/
499 #if USB_HAVE_BUSDMA
500 static void
501 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
502     struct usb_page *pg, usb_size_t size, usb_size_t align)
503 {
504 	/* need to initialize the page cache */
505 	pc->tag_parent = bus->dma_parent_tag;
506 
507 	if (usb_pc_alloc_mem(pc, pg, size, align)) {
508 		bus->alloc_failed = 1;
509 	}
510 }
511 #endif
512 
513 /*------------------------------------------------------------------------*
514  *	usb_bus_mem_alloc_all - factored out code
515  *
516  * Returns:
517  *    0: Success
518  * Else: Failure
519  *------------------------------------------------------------------------*/
520 uint8_t
521 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat,
522     usb_bus_mem_cb_t *cb)
523 {
524 	bus->alloc_failed = 0;
525 
526 	mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent),
527 	    NULL, MTX_DEF | MTX_RECURSE);
528 
529 	usb_callout_init_mtx(&bus->power_wdog,
530 	    &bus->bus_mtx, 0);
531 
532 	TAILQ_INIT(&bus->intr_q.head);
533 
534 #if USB_HAVE_BUSDMA
535 	usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags,
536 	    dmat, &bus->bus_mtx, NULL, 32, USB_BUS_DMA_TAG_MAX);
537 #endif
538 	if ((bus->devices_max > USB_MAX_DEVICES) ||
539 	    (bus->devices_max < USB_MIN_DEVICES) ||
540 	    (bus->devices == NULL)) {
541 		DPRINTFN(0, "Devices field has not been "
542 		    "initialised properly\n");
543 		bus->alloc_failed = 1;		/* failure */
544 	}
545 #if USB_HAVE_BUSDMA
546 	if (cb) {
547 		cb(bus, &usb_bus_mem_alloc_all_cb);
548 	}
549 #endif
550 	if (bus->alloc_failed) {
551 		usb_bus_mem_free_all(bus, cb);
552 	}
553 	return (bus->alloc_failed);
554 }
555 
556 /*------------------------------------------------------------------------*
557  *	usb_bus_mem_free_all_cb
558  *------------------------------------------------------------------------*/
559 #if USB_HAVE_BUSDMA
560 static void
561 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
562     struct usb_page *pg, usb_size_t size, usb_size_t align)
563 {
564 	usb_pc_free_mem(pc);
565 }
566 #endif
567 
568 /*------------------------------------------------------------------------*
569  *	usb_bus_mem_free_all - factored out code
570  *------------------------------------------------------------------------*/
571 void
572 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
573 {
574 #if USB_HAVE_BUSDMA
575 	if (cb) {
576 		cb(bus, &usb_bus_mem_free_all_cb);
577 	}
578 	usb_dma_tag_unsetup(bus->dma_parent_tag);
579 #endif
580 
581 	mtx_destroy(&bus->bus_mtx);
582 }
583