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