xref: /netbsd-src/sys/dev/usb/uhub.c (revision aad9773e38ed2370a628a6416e098f9008fc10a7)
1 /*	$NetBSD: uhub.c,v 1.126 2014/08/13 06:26:32 skrll Exp $	*/
2 /*	$FreeBSD: src/sys/dev/usb/uhub.c,v 1.18 1999/11/17 22:33:43 n_hibma Exp $	*/
3 
4 /*
5  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net) at
10  * Carlstedt Research & Technology.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * USB spec: http://www.usb.org/developers/docs/usbspec.zip
36  */
37 
38 #include <sys/cdefs.h>
39 __KERNEL_RCSID(0, "$NetBSD: uhub.c,v 1.126 2014/08/13 06:26:32 skrll Exp $");
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
45 #include <sys/device.h>
46 #include <sys/proc.h>
47 
48 #include <sys/bus.h>
49 
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
52 #include <dev/usb/usbdi_util.h>
53 #include <dev/usb/usbdivar.h>
54 
55 #ifdef UHUB_DEBUG
56 #define DPRINTF(x)	if (uhubdebug) printf x
57 #define DPRINTFN(n,x)	if (uhubdebug>(n)) printf x
58 int	uhubdebug = 0;
59 #else
60 #define DPRINTF(x)
61 #define DPRINTFN(n,x)
62 #endif
63 
64 struct uhub_softc {
65 	device_t		sc_dev;		/* base device */
66 	usbd_device_handle	sc_hub;		/* USB device */
67 	int			sc_proto;	/* device protocol */
68 	usbd_pipe_handle	sc_ipipe;	/* interrupt pipe */
69 
70 	/* XXX second buffer needed because we can't suspend pipes yet */
71 	u_int8_t		*sc_statusbuf;
72 	u_int8_t		*sc_status;
73 	size_t			sc_statuslen;
74 	int			sc_explorepending;
75 	int		sc_isehciroothub; /* see comment in uhub_intr() */
76 
77 	u_char			sc_running;
78 };
79 
80 #define UHUB_IS_HIGH_SPEED(sc) ((sc)->sc_proto != UDPROTO_FSHUB)
81 #define UHUB_IS_SINGLE_TT(sc) ((sc)->sc_proto == UDPROTO_HSHUBSTT)
82 
83 #define PORTSTAT_ISSET(sc, port) \
84 	((sc)->sc_status[(port) / 8] & (1 << ((port) % 8)))
85 
86 Static usbd_status uhub_explore(usbd_device_handle hub);
87 Static void uhub_intr(usbd_xfer_handle, usbd_private_handle,usbd_status);
88 
89 
90 /*
91  * We need two attachment points:
92  * hub to usb and hub to hub
93  * Every other driver only connects to hubs
94  */
95 
96 int uhub_match(device_t, cfdata_t, void *);
97 void uhub_attach(device_t, device_t, void *);
98 int uhub_rescan(device_t, const char *, const int *);
99 void uhub_childdet(device_t, device_t);
100 int uhub_detach(device_t, int);
101 extern struct cfdriver uhub_cd;
102 CFATTACH_DECL3_NEW(uhub, sizeof(struct uhub_softc), uhub_match,
103     uhub_attach, uhub_detach, NULL, uhub_rescan, uhub_childdet,
104     DVF_DETACH_SHUTDOWN);
105 CFATTACH_DECL2_NEW(uroothub, sizeof(struct uhub_softc), uhub_match,
106     uhub_attach, uhub_detach, NULL, uhub_rescan, uhub_childdet);
107 
108 /*
109  * Setting this to 1 makes sure than an uhub attaches even at higher
110  * priority than ugen when ugen_override is set to 1.  This allows to
111  * probe the whole USB bus and attach functions with ugen.
112  */
113 int uhub_ubermatch = 0;
114 
115 int
116 uhub_match(device_t parent, cfdata_t match, void *aux)
117 {
118 	struct usb_attach_arg *uaa = aux;
119 	int matchvalue;
120 
121 	if (uhub_ubermatch)
122 		matchvalue = UMATCH_HIGHEST+1;
123 	else
124 		matchvalue = UMATCH_DEVCLASS_DEVSUBCLASS;
125 
126 	DPRINTFN(5,("uhub_match, uaa=%p\n", uaa));
127 	/*
128 	 * The subclass for hubs seems to be 0 for some and 1 for others,
129 	 * so we just ignore the subclass.
130 	 */
131 	if (uaa->class == UDCLASS_HUB)
132 		return (matchvalue);
133 	return (UMATCH_NONE);
134 }
135 
136 void
137 uhub_attach(device_t parent, device_t self, void *aux)
138 {
139 	struct uhub_softc *sc = device_private(self);
140 	struct usb_attach_arg *uaa = aux;
141 	usbd_device_handle dev = uaa->device;
142 	char *devinfop;
143 	usbd_status err;
144 	struct usbd_hub *hub = NULL;
145 	usb_device_request_t req;
146 	usb_hub_descriptor_t hubdesc;
147 	int p, port, nports, nremov, pwrdly;
148 	usbd_interface_handle iface;
149 	usb_endpoint_descriptor_t *ed;
150 #if 0 /* notyet */
151 	struct usbd_tt *tts = NULL;
152 #endif
153 
154 	DPRINTFN(1,("uhub_attach\n"));
155 	sc->sc_dev = self;
156 	sc->sc_hub = dev;
157 	sc->sc_proto = uaa->proto;
158 
159 	devinfop = usbd_devinfo_alloc(dev, 1);
160 	aprint_naive("\n");
161 	aprint_normal(": %s\n", devinfop);
162 	usbd_devinfo_free(devinfop);
163 
164 	if (dev->depth > 0 && UHUB_IS_HIGH_SPEED(sc)) {
165 		aprint_normal_dev(self, "%s transaction translator%s\n",
166 		       UHUB_IS_SINGLE_TT(sc) ? "single" : "multiple",
167 		       UHUB_IS_SINGLE_TT(sc) ? "" : "s");
168 	}
169 
170 	err = usbd_set_config_index(dev, 0, 1);
171 	if (err) {
172 		DPRINTF(("%s: configuration failed, error=%s\n",
173 		    device_xname(sc->sc_dev), usbd_errstr(err)));
174 		return;
175 	}
176 
177 	if (dev->depth > USB_HUB_MAX_DEPTH) {
178 		aprint_error_dev(self,
179 		    "hub depth (%d) exceeded, hub ignored\n",
180 		    USB_HUB_MAX_DEPTH);
181 		return;
182 	}
183 
184 	/* Get hub descriptor. */
185 	req.bmRequestType = UT_READ_CLASS_DEVICE;
186 	req.bRequest = UR_GET_DESCRIPTOR;
187 	USETW2(req.wValue, UDESC_HUB, 0);
188 	USETW(req.wIndex, 0);
189 	USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE);
190 	DPRINTFN(1,("%s: getting hub descriptor\n", __func__));
191 	err = usbd_do_request(dev, &req, &hubdesc);
192 	nports = hubdesc.bNbrPorts;
193 	if (!err && nports > 7) {
194 		USETW(req.wLength, USB_HUB_DESCRIPTOR_SIZE + (nports+1) / 8);
195 		err = usbd_do_request(dev, &req, &hubdesc);
196 	}
197 	if (err) {
198 		DPRINTF(("%s: getting hub descriptor failed, error=%s\n",
199 		    device_xname(sc->sc_dev), usbd_errstr(err)));
200 		return;
201 	}
202 
203 	for (nremov = 0, port = 1; port <= nports; port++)
204 		if (!UHD_NOT_REMOV(&hubdesc, port))
205 			nremov++;
206 	aprint_verbose_dev(self, "%d port%s with %d removable, %s powered\n",
207 	    nports, nports != 1 ? "s" : "", nremov,
208 	    dev->self_powered ? "self" : "bus");
209 
210 	if (nports == 0) {
211 		aprint_debug_dev(self, "no ports, hub ignored\n");
212 		goto bad;
213 	}
214 
215 	hub = malloc(sizeof(*hub) + (nports-1) * sizeof(struct usbd_port),
216 		     M_USBDEV, M_NOWAIT);
217 	if (hub == NULL)
218 		return;
219 	dev->hub = hub;
220 	dev->hub->hubsoftc = sc;
221 	hub->explore = uhub_explore;
222 	hub->hubdesc = hubdesc;
223 
224 	/* Set up interrupt pipe. */
225 	err = usbd_device2interface_handle(dev, 0, &iface);
226 	if (err) {
227 		aprint_error_dev(self, "no interface handle\n");
228 		goto bad;
229 	}
230 
231 	if (UHUB_IS_HIGH_SPEED(sc) && !UHUB_IS_SINGLE_TT(sc)) {
232 		err = usbd_set_interface(iface, 1);
233 		if (err)
234 			aprint_error_dev(self, "can't enable multiple TTs\n");
235 	}
236 
237 	ed = usbd_interface2endpoint_descriptor(iface, 0);
238 	if (ed == NULL) {
239 		aprint_error_dev(self, "no endpoint descriptor\n");
240 		goto bad;
241 	}
242 	if ((ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
243 		aprint_error_dev(self, "bad interrupt endpoint\n");
244 		goto bad;
245 	}
246 
247 	sc->sc_statuslen = (nports + 1 + 7) / 8;
248 	sc->sc_statusbuf = malloc(sc->sc_statuslen, M_USBDEV, M_NOWAIT);
249 	if (!sc->sc_statusbuf)
250 		goto bad;
251 	sc->sc_status = malloc(sc->sc_statuslen, M_USBDEV, M_NOWAIT);
252 	if (!sc->sc_status)
253 		goto bad;
254 	if (device_is_a(device_parent(device_parent(sc->sc_dev)), "ehci"))
255 		sc->sc_isehciroothub = 1;
256 
257 	/* force initial scan */
258 	memset(sc->sc_status, 0xff, sc->sc_statuslen);
259 	sc->sc_explorepending = 1;
260 
261 	err = usbd_open_pipe_intr(iface, ed->bEndpointAddress,
262 		  USBD_SHORT_XFER_OK|USBD_MPSAFE, &sc->sc_ipipe, sc,
263 		  sc->sc_statusbuf, sc->sc_statuslen,
264 		  uhub_intr, USBD_DEFAULT_INTERVAL);
265 	if (err) {
266 		aprint_error_dev(self, "cannot open interrupt pipe\n");
267 		goto bad;
268 	}
269 
270 	/* Wait with power off for a while. */
271 	usbd_delay_ms(dev, USB_POWER_DOWN_TIME);
272 
273 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, dev, sc->sc_dev);
274 
275 	/*
276 	 * To have the best chance of success we do things in the exact same
277 	 * order as Windows 98.  This should not be necessary, but some
278 	 * devices do not follow the USB specs to the letter.
279 	 *
280 	 * These are the events on the bus when a hub is attached:
281 	 *  Get device and config descriptors (see attach code)
282 	 *  Get hub descriptor (see above)
283 	 *  For all ports
284 	 *     turn on power
285 	 *     wait for power to become stable
286 	 * (all below happens in explore code)
287 	 *  For all ports
288 	 *     clear C_PORT_CONNECTION
289 	 *  For all ports
290 	 *     get port status
291 	 *     if device connected
292 	 *        wait 100 ms
293 	 *        turn on reset
294 	 *        wait
295 	 *        clear C_PORT_RESET
296 	 *        get port status
297 	 *        proceed with device attachment
298 	 */
299 
300 #if 0
301 	if (UHUB_IS_HIGH_SPEED(sc) && nports > 0) {
302 		tts = malloc((UHUB_IS_SINGLE_TT(sc) ? 1 : nports) *
303 			     sizeof (struct usbd_tt), M_USBDEV, M_NOWAIT);
304 		if (!tts)
305 			goto bad;
306 	}
307 #endif
308 	/* Set up data structures */
309 	for (p = 0; p < nports; p++) {
310 		struct usbd_port *up = &hub->ports[p];
311 		up->device = NULL;
312 		up->parent = dev;
313 		up->portno = p+1;
314 		if (dev->self_powered)
315 			/* Self powered hub, give ports maximum current. */
316 			up->power = USB_MAX_POWER;
317 		else
318 			up->power = USB_MIN_POWER;
319 		up->restartcnt = 0;
320 		up->reattach = 0;
321 #if 0
322 		if (UHUB_IS_HIGH_SPEED(sc)) {
323 			up->tt = &tts[UHUB_IS_SINGLE_TT(sc) ? 0 : p];
324 			up->tt->hub = hub;
325 		} else {
326 			up->tt = NULL;
327 		}
328 #endif
329 	}
330 
331 	/* XXX should check for none, individual, or ganged power? */
332 
333 	pwrdly = dev->hub->hubdesc.bPwrOn2PwrGood * UHD_PWRON_FACTOR
334 	    + USB_EXTRA_POWER_UP_TIME;
335 	for (port = 1; port <= nports; port++) {
336 		/* Turn the power on. */
337 		err = usbd_set_port_feature(dev, port, UHF_PORT_POWER);
338 		if (err)
339 			aprint_error_dev(self, "port %d power on failed, %s\n",
340 			    port, usbd_errstr(err));
341 		DPRINTF(("usb_init_port: turn on port %d power\n", port));
342 	}
343 
344 	/* Wait for stable power if we are not a root hub */
345 	if (dev->powersrc->parent != NULL)
346 		usbd_delay_ms(dev, pwrdly);
347 
348 	/* The usual exploration will finish the setup. */
349 
350 	sc->sc_running = 1;
351 
352 	if (!pmf_device_register(self, NULL, NULL))
353 		aprint_error_dev(self, "couldn't establish power handler\n");
354 
355 	return;
356 
357  bad:
358 	if (sc->sc_status)
359 		free(sc->sc_status, M_USBDEV);
360 	if (sc->sc_statusbuf)
361 		free(sc->sc_statusbuf, M_USBDEV);
362 	if (hub)
363 		free(hub, M_USBDEV);
364 	dev->hub = NULL;
365 	return;
366 }
367 
368 usbd_status
369 uhub_explore(usbd_device_handle dev)
370 {
371 	usb_hub_descriptor_t *hd = &dev->hub->hubdesc;
372 	struct uhub_softc *sc = dev->hub->hubsoftc;
373 	struct usbd_port *up;
374 	usbd_status err;
375 	int speed;
376 	int port;
377 	int change, status, reconnect;
378 
379 	DPRINTFN(10, ("uhub_explore dev=%p addr=%d\n", dev, dev->address));
380 
381 	if (!sc->sc_running)
382 		return (USBD_NOT_STARTED);
383 
384 	/* Ignore hubs that are too deep. */
385 	if (dev->depth > USB_HUB_MAX_DEPTH)
386 		return (USBD_TOO_DEEP);
387 
388 	if (PORTSTAT_ISSET(sc, 0)) { /* hub status change */
389 		usb_hub_status_t hs;
390 
391 		err = usbd_get_hub_status(dev, &hs);
392 		if (err) {
393 			DPRINTF(("%s: get hub status failed, err=%d\n",
394 				 device_xname(sc->sc_dev), err));
395 		} else {
396 			/* just acknowledge */
397 			status = UGETW(hs.wHubStatus);
398 			change = UGETW(hs.wHubChange);
399 			if (change & UHS_LOCAL_POWER)
400 				usbd_clear_hub_feature(dev,
401 						       UHF_C_HUB_LOCAL_POWER);
402 			if (change & UHS_OVER_CURRENT)
403 				usbd_clear_hub_feature(dev,
404 						       UHF_C_HUB_OVER_CURRENT);
405 		}
406 	}
407 
408 	for (port = 1; port <= hd->bNbrPorts; port++) {
409 		up = &dev->hub->ports[port-1];
410 
411 		/* reattach is needed after firmware upload */
412 		reconnect = up->reattach;
413 		up->reattach = 0;
414 
415 		status = change = 0;
416 
417 		/* don't check if no change summary notification */
418 		if (PORTSTAT_ISSET(sc, port) || reconnect) {
419 			err = usbd_get_port_status(dev, port, &up->status);
420 			if (err) {
421 				DPRINTF(("uhub_explore: get port stat failed, "
422 					 "error=%s\n", usbd_errstr(err)));
423 				continue;
424 			}
425 			status = UGETW(up->status.wPortStatus);
426 			change = UGETW(up->status.wPortChange);
427 #if 0
428 			printf("%s port %d: s/c=%x/%x\n",
429 			       device_xname(sc->sc_dev), port, status, change);
430 #endif
431 		}
432 		if (!change && !reconnect) {
433 			/* No status change, just do recursive explore. */
434 			if (up->device != NULL && up->device->hub != NULL)
435 				up->device->hub->explore(up->device);
436 			continue;
437 		}
438 
439 		if (change & UPS_C_PORT_ENABLED) {
440 			DPRINTF(("uhub_explore: C_PORT_ENABLED\n"));
441 			usbd_clear_port_feature(dev, port, UHF_C_PORT_ENABLE);
442 			if (change & UPS_C_CONNECT_STATUS) {
443 				/* Ignore the port error if the device
444 				   vanished. */
445 			} else if (status & UPS_PORT_ENABLED) {
446 				aprint_error_dev(sc->sc_dev,
447 				    "illegal enable change, port %d\n", port);
448 			} else {
449 				/* Port error condition. */
450 				if (up->restartcnt) /* no message first time */
451 					aprint_error_dev(sc->sc_dev,
452 					    "port error, restarting port %d\n",
453 					    port);
454 
455 				if (up->restartcnt++ < USBD_RESTART_MAX)
456 					goto disco;
457 				else
458 					aprint_error_dev(sc->sc_dev,
459 					    "port error, giving up port %d\n",
460 					    port);
461 			}
462 		}
463 
464 		/* XXX handle overcurrent and resume events! */
465 
466 		if (!reconnect && !(change & UPS_C_CONNECT_STATUS)) {
467 			/* No status change, just do recursive explore. */
468 			if (up->device != NULL && up->device->hub != NULL)
469 				up->device->hub->explore(up->device);
470 			continue;
471 		}
472 
473 		/* We have a connect status change, handle it. */
474 
475 		DPRINTF(("uhub_explore: status change hub=%d port=%d\n",
476 			 dev->address, port));
477 		usbd_clear_port_feature(dev, port, UHF_C_PORT_CONNECTION);
478 		/*
479 		 * If there is already a device on the port the change status
480 		 * must mean that is has disconnected.  Looking at the
481 		 * current connect status is not enough to figure this out
482 		 * since a new unit may have been connected before we handle
483 		 * the disconnect.
484 		 */
485 	disco:
486 		if (up->device != NULL) {
487 			/* Disconnected */
488 			DPRINTF(("uhub_explore: device addr=%d disappeared "
489 				 "on port %d\n", up->device->address, port));
490 			usb_disconnect_port(up, sc->sc_dev, DETACH_FORCE);
491 			usbd_clear_port_feature(dev, port,
492 						UHF_C_PORT_CONNECTION);
493 		}
494 		if (!(status & UPS_CURRENT_CONNECT_STATUS)) {
495 			/* Nothing connected, just ignore it. */
496 			DPRINTFN(3,("uhub_explore: port=%d !CURRENT_CONNECT"
497 				    "_STATUS\n", port));
498 			continue;
499 		}
500 
501 		/* Connected */
502 
503 		if (!(status & UPS_PORT_POWER))
504 			aprint_normal_dev(sc->sc_dev,
505 			    "strange, connected port %d has no power\n", port);
506 
507 		/* Wait for maximum device power up time. */
508 		usbd_delay_ms(dev, USB_PORT_POWERUP_DELAY);
509 
510 		/* Reset port, which implies enabling it. */
511 		if (usbd_reset_port(dev, port, &up->status)) {
512 			aprint_error_dev(sc->sc_dev,
513 			    "port %d reset failed\n", port);
514 			continue;
515 		}
516 		/* Get port status again, it might have changed during reset */
517 		err = usbd_get_port_status(dev, port, &up->status);
518 		if (err) {
519 			DPRINTF(("uhub_explore: get port status failed, "
520 				 "error=%s\n", usbd_errstr(err)));
521 			continue;
522 		}
523 		status = UGETW(up->status.wPortStatus);
524 		change = UGETW(up->status.wPortChange);
525 		if (!(status & UPS_CURRENT_CONNECT_STATUS)) {
526 			/* Nothing connected, just ignore it. */
527 #ifdef DIAGNOSTIC
528 			aprint_debug_dev(sc->sc_dev,
529 			    "port %d, device disappeared after reset\n", port);
530 #endif
531 			continue;
532 		}
533 		if (!(status & UPS_PORT_ENABLED)) {
534 			/* Not allowed send/receive packet. */
535 #ifdef DIAGNOSTIC
536 			printf("%s: port %d, device not enabled\n",
537 			       device_xname(sc->sc_dev), port);
538 #endif
539 			continue;
540 		}
541 
542 		/* Figure out device speed */
543 #if 0
544 		if (status & UPS_SUPER_SPEED)
545 			speed = USB_SPEED_SUPER;
546 		else
547 #endif
548 		if (status & UPS_HIGH_SPEED)
549 			speed = USB_SPEED_HIGH;
550 		else if (status & UPS_LOW_SPEED)
551 			speed = USB_SPEED_LOW;
552 		else
553 			speed = USB_SPEED_FULL;
554 		/* Get device info and set its address. */
555 		err = usbd_new_device(sc->sc_dev, dev->bus,
556 			  dev->depth + 1, speed, port, up);
557 		/* XXX retry a few times? */
558 		if (err) {
559 			DPRINTFN(-1,("uhub_explore: usbd_new_device failed, "
560 				     "error=%s\n", usbd_errstr(err)));
561 			/* Avoid addressing problems by disabling. */
562 			/* usbd_reset_port(dev, port, &up->status); */
563 
564 			/*
565 			 * The unit refused to accept a new address, or had
566 			 * some other serious problem.  Since we cannot leave
567 			 * at 0 we have to disable the port instead.
568 			 */
569 			aprint_error_dev(sc->sc_dev,
570 			    "device problem, disabling port %d\n", port);
571 			usbd_clear_port_feature(dev, port, UHF_PORT_ENABLE);
572 		} else {
573 			/* The port set up succeeded, reset error count. */
574 			up->restartcnt = 0;
575 
576 			if (up->device->hub)
577 				up->device->hub->explore(up->device);
578 		}
579 	}
580 	/* enable status change notifications again */
581 	if (!sc->sc_isehciroothub)
582 		memset(sc->sc_status, 0, sc->sc_statuslen);
583 	sc->sc_explorepending = 0;
584 	return (USBD_NORMAL_COMPLETION);
585 }
586 
587 /*
588  * Called from process context when the hub is gone.
589  * Detach all devices on active ports.
590  */
591 int
592 uhub_detach(device_t self, int flags)
593 {
594 	struct uhub_softc *sc = device_private(self);
595 	struct usbd_hub *hub = sc->sc_hub->hub;
596 	struct usbd_port *rup;
597 	int nports, port, rc;
598 
599 	DPRINTF(("uhub_detach: sc=%p flags=%d\n", sc, flags));
600 
601 	if (hub == NULL)		/* Must be partially working */
602 		return (0);
603 
604 	/* XXXSMP usb */
605 	KERNEL_LOCK(1, curlwp);
606 
607 	nports = hub->hubdesc.bNbrPorts;
608 	for(port = 0; port < nports; port++) {
609 		rup = &hub->ports[port];
610 		if (rup->device == NULL)
611 			continue;
612 		if ((rc = usb_disconnect_port(rup, self, flags)) != 0) {
613 			/* XXXSMP usb */
614 			KERNEL_UNLOCK_ONE(curlwp);
615 
616 			return rc;
617 		}
618 	}
619 
620 	pmf_device_deregister(self);
621 	usbd_abort_pipe(sc->sc_ipipe);
622 	usbd_close_pipe(sc->sc_ipipe);
623 
624 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_hub, sc->sc_dev);
625 
626 #if 0
627 	if (hub->ports[0].tt)
628 		free(hub->ports[0].tt, M_USBDEV);
629 #endif
630 	free(hub, M_USBDEV);
631 	sc->sc_hub->hub = NULL;
632 	if (sc->sc_status)
633 		free(sc->sc_status, M_USBDEV);
634 	if (sc->sc_statusbuf)
635 		free(sc->sc_statusbuf, M_USBDEV);
636 
637 	/* XXXSMP usb */
638 	KERNEL_UNLOCK_ONE(curlwp);
639 
640 	return (0);
641 }
642 
643 int
644 uhub_rescan(device_t self, const char *ifattr, const int *locators)
645 {
646 	struct uhub_softc *sc = device_private(self);
647 	struct usbd_hub *hub = sc->sc_hub->hub;
648 	usbd_device_handle dev;
649 	int port;
650 
651 	for (port = 0; port < hub->hubdesc.bNbrPorts; port++) {
652 		dev = hub->ports[port].device;
653 		if (dev == NULL)
654 			continue;
655 		usbd_reattach_device(sc->sc_dev, dev, port, locators);
656 	}
657 	return 0;
658 }
659 
660 /* Called when a device has been detached from it */
661 void
662 uhub_childdet(device_t self, device_t child)
663 {
664 	struct uhub_softc *sc = device_private(self);
665 	usbd_device_handle devhub = sc->sc_hub;
666 	usbd_device_handle dev;
667 	int nports;
668 	int port;
669 	int i;
670 
671 	if (!devhub->hub)
672 		/* should never happen; children are only created after init */
673 		panic("hub not fully initialised, but child deleted?");
674 
675 	nports = devhub->hub->hubdesc.bNbrPorts;
676 	for (port = 0; port < nports; port++) {
677 		dev = devhub->hub->ports[port].device;
678 		if (!dev || dev->subdevlen == 0)
679 			continue;
680 		for (i = 0; i < dev->subdevlen; i++) {
681 			if (dev->subdevs[i] == child) {
682 				dev->subdevs[i] = NULL;
683 				dev->nifaces_claimed--;
684 			}
685 		}
686 		if (dev->nifaces_claimed == 0) {
687 			free(dev->subdevs, M_USB);
688 			dev->subdevs = NULL;
689 			dev->subdevlen = 0;
690 		}
691 	}
692 }
693 
694 
695 /*
696  * Hub interrupt.
697  * This an indication that some port has changed status.
698  * Notify the bus event handler thread that we need
699  * to be explored again.
700  */
701 void
702 uhub_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
703 {
704 	struct uhub_softc *sc = addr;
705 
706 	DPRINTFN(5,("uhub_intr: sc=%p\n", sc));
707 
708 	if (status == USBD_STALLED)
709 		usbd_clear_endpoint_stall_async(sc->sc_ipipe);
710 	else if (status == USBD_NORMAL_COMPLETION &&
711 		 !sc->sc_explorepending) {
712 		/*
713 		 * Make sure the status is not overwritten in between.
714 		 * XXX we should suspend the pipe instead
715 		 */
716 		memcpy(sc->sc_status, sc->sc_statusbuf, sc->sc_statuslen);
717 		sc->sc_explorepending = 1;
718 		usb_needs_explore(sc->sc_hub);
719 	}
720 	/*
721 	 * XXX workaround for broken implementation of the interrupt
722 	 * pipe in EHCI root hub emulation which doesn't resend
723 	 * status change notifications until handled: force a rescan
724 	 * of the ports we touched in the last run
725 	 */
726 	if (status == USBD_NORMAL_COMPLETION && sc->sc_explorepending &&
727 	    sc->sc_isehciroothub)
728 		usb_needs_explore(sc->sc_hub);
729 }
730