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