3 * Most of this source has been derived from the Linux USB
5 * (C) Copyright Linus Torvalds 1999
6 * (C) Copyright Johannes Erdfelt 1999-2001
7 * (C) Copyright Andreas Gal 1999
8 * (C) Copyright Gregory P. Smith 1999
9 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
10 * (C) Copyright Randy Dunlap 2000
11 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
12 * (C) Copyright Yggdrasil Computing, Inc. 2000
13 * (usb_device_id matching changes by Adam J. Richter)
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
18 * See file CREDITS for list of people who contributed to this
21 * This program is free software; you can redistribute it and/or
22 * modify it under the terms of the GNU General Public License as
23 * published by the Free Software Foundation; either version 2 of
24 * the License, or (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program; if not, write to the Free Software
33 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
38 /****************************************************************************
40 * Probes device for being a hub and configurate it
45 #include <asm/processor.h>
46 #include <asm/unaligned.h>
47 #include <linux/ctype.h>
48 #include <asm/byteorder.h>
49 #include <asm/unaligned.h>
53 #include <asm/4xx_pci.h>
56 #define USB_BUFSIZ 512
58 static struct usb_hub_device hub_dev[USB_MAX_HUB];
59 static int usb_hub_index;
62 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
64 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
65 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
66 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
69 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
71 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
72 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
73 port, NULL, 0, USB_CNTL_TIMEOUT);
76 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
78 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
79 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
80 port, NULL, 0, USB_CNTL_TIMEOUT);
83 static int usb_get_hub_status(struct usb_device *dev, void *data)
85 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
86 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
87 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
90 static int usb_get_port_status(struct usb_device *dev, int port, void *data)
92 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
93 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
94 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
98 static void usb_hub_power_on(struct usb_hub_device *hub)
101 struct usb_device *dev;
102 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
103 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
104 unsigned short portstatus;
108 /* Enable power to the ports */
109 debug("enabling power on all ports\n");
110 for (i = 0; i < dev->maxchild; i++) {
112 * Power-cycle the ports here: aka,
113 * turning them off and turning on again.
115 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
116 debug("port %d returns %lX\n", i + 1, dev->status);
118 /* Wait at least 2*bPwrOn2PwrGood for PP to change */
121 ret = usb_get_port_status(dev, i + 1, portsts);
123 debug("port %d: get_port_status failed\n", i + 1);
128 * Check to confirm the state of Port Power:
129 * xHCI says "After modifying PP, s/w shall read
130 * PP and confirm that it has reached the desired state
131 * before modifying it again, undefined behavior may occur
132 * if this procedure is not followed".
133 * EHCI doesn't say anything like this, but no harm in keeping
136 portstatus = le16_to_cpu(portsts->wPortStatus);
137 if (portstatus & (USB_PORT_STAT_POWER << 1)) {
138 debug("port %d: Port power change failed\n", i + 1);
142 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
143 debug("port %d returns %lX\n", i + 1, dev->status);
146 /* Wait at least 100 msec for power to become stable */
147 mdelay(max(pgood_delay, (unsigned)100));
150 void usb_hub_reset(void)
155 static struct usb_hub_device *usb_hub_allocate(void)
157 if (usb_hub_index < USB_MAX_HUB)
158 return &hub_dev[usb_hub_index++];
160 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
166 static inline char *portspeed(int portstatus)
168 if (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED))
170 else if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
172 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
178 int hub_port_reset(struct usb_device *dev, int port,
179 unsigned short *portstat)
182 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
183 unsigned short portstatus, portchange;
185 debug("hub_port_reset: resetting port %d...\n", port);
186 for (tries = 0; tries < MAX_TRIES; tries++) {
188 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
191 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
192 debug("get_port_status failed status %lX\n",
196 portstatus = le16_to_cpu(portsts->wPortStatus);
197 portchange = le16_to_cpu(portsts->wPortChange);
199 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
200 portspeed(portstatus));
202 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
203 " USB_PORT_STAT_ENABLE %d\n",
204 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
205 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
206 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
208 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
209 !(portstatus & USB_PORT_STAT_CONNECTION))
212 if (portstatus & USB_PORT_STAT_ENABLE)
218 if (tries == MAX_TRIES) {
219 debug("Cannot enable port %i after %i retries, " \
220 "disabling port.\n", port + 1, MAX_TRIES);
221 debug("Maybe the USB cable is bad?\n");
225 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
226 *portstat = portstatus;
231 void usb_hub_port_connect_change(struct usb_device *dev, int port)
233 struct usb_device *usb;
234 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
235 unsigned short portstatus;
238 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
239 debug("get_port_status failed\n");
243 portstatus = le16_to_cpu(portsts->wPortStatus);
244 debug("portstatus %x, change %x, %s\n",
246 le16_to_cpu(portsts->wPortChange),
247 portspeed(portstatus));
249 /* Clear the connection change status */
250 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
252 /* Disconnect any existing devices under this port */
253 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
254 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
255 debug("usb_disconnect(&hub->children[port]);\n");
256 /* Return now if nothing is connected */
257 if (!(portstatus & USB_PORT_STAT_CONNECTION))
263 if (hub_port_reset(dev, port, &portstatus) < 0) {
264 printf("cannot reset port %i!?\n", port + 1);
270 /* Allocate a new device struct for it */
271 usb = usb_alloc_new_device(dev->controller);
273 if (portstatus & USB_PORT_STAT_SUPER_SPEED)
274 usb->speed = USB_SPEED_SUPER;
275 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
276 usb->speed = USB_SPEED_HIGH;
277 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
278 usb->speed = USB_SPEED_LOW;
280 usb->speed = USB_SPEED_FULL;
282 dev->children[port] = usb;
284 usb->portnr = port + 1;
285 /* Run it through the hoops (find a driver, etc) */
286 if (usb_new_device(usb)) {
287 /* Woops, disable the port */
289 dev->children[port] = NULL;
290 debug("hub: disabling port %d\n", port + 1);
291 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
296 static int usb_hub_configure(struct usb_device *dev)
299 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
300 unsigned char *bitmap;
301 short hubCharacteristics;
302 struct usb_hub_descriptor *descriptor;
303 struct usb_hub_device *hub;
304 __maybe_unused struct usb_hub_status *hubsts;
306 /* "allocate" Hub device */
307 hub = usb_hub_allocate();
311 /* Get the the hub descriptor */
312 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
313 debug("usb_hub_configure: failed to get hub " \
314 "descriptor, giving up %lX\n", dev->status);
317 descriptor = (struct usb_hub_descriptor *)buffer;
319 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
320 i = descriptor->bLength;
321 if (i > USB_BUFSIZ) {
322 debug("usb_hub_configure: failed to get hub " \
323 "descriptor - too long: %d\n", descriptor->bLength);
327 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
328 debug("usb_hub_configure: failed to get hub " \
329 "descriptor 2nd giving up %lX\n", dev->status);
332 memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
333 /* adjust 16bit values */
334 put_unaligned(le16_to_cpu(get_unaligned(
335 &descriptor->wHubCharacteristics)),
336 &hub->desc.wHubCharacteristics);
338 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
339 /* devices not removable by default */
340 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
341 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
342 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
344 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
345 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
347 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
348 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
350 dev->maxchild = descriptor->bNbrPorts;
351 debug("%d ports detected\n", dev->maxchild);
353 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
354 switch (hubCharacteristics & HUB_CHAR_LPSM) {
356 debug("ganged power switching\n");
359 debug("individual port power switching\n");
363 debug("unknown reserved power switching mode\n");
367 if (hubCharacteristics & HUB_CHAR_COMPOUND)
368 debug("part of a compound device\n");
370 debug("standalone hub\n");
372 switch (hubCharacteristics & HUB_CHAR_OCPM) {
374 debug("global over-current protection\n");
377 debug("individual port over-current protection\n");
381 debug("no over-current protection\n");
385 debug("power on to power good time: %dms\n",
386 descriptor->bPwrOn2PwrGood * 2);
387 debug("hub controller current requirement: %dmA\n",
388 descriptor->bHubContrCurrent);
390 for (i = 0; i < dev->maxchild; i++)
391 debug("port %d is%s removable\n", i + 1,
392 hub->desc.DeviceRemovable[(i + 1) / 8] & \
393 (1 << ((i + 1) % 8)) ? " not" : "");
395 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
396 debug("usb_hub_configure: failed to get Status - " \
397 "too long: %d\n", descriptor->bLength);
401 if (usb_get_hub_status(dev, buffer) < 0) {
402 debug("usb_hub_configure: failed to get Status %lX\n",
408 hubsts = (struct usb_hub_status *)buffer;
411 debug("get_hub_status returned status %X, change %X\n",
412 le16_to_cpu(hubsts->wHubStatus),
413 le16_to_cpu(hubsts->wHubChange));
414 debug("local power source is %s\n",
415 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
416 "lost (inactive)" : "good");
417 debug("%sover-current condition exists\n",
418 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
420 usb_hub_power_on(hub);
422 for (i = 0; i < dev->maxchild; i++) {
423 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
424 unsigned short portstatus, portchange;
426 ulong start = get_timer(0);
429 * Wait for (whichever finishes first)
430 * - A maximum of 10 seconds
431 * This is a purely observational value driven by connecting
432 * a few broken pen drives and taking the max * 1.5 approach
433 * - connection_change and connection state to report same
437 ret = usb_get_port_status(dev, i + 1, portsts);
439 debug("get_port_status failed\n");
443 portstatus = le16_to_cpu(portsts->wPortStatus);
444 portchange = le16_to_cpu(portsts->wPortChange);
446 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
447 (portstatus & USB_PORT_STAT_CONNECTION))
450 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
455 debug("Port %d Status %X Change %X\n",
456 i + 1, portstatus, portchange);
458 if (portchange & USB_PORT_STAT_C_CONNECTION) {
459 debug("port %d connection change\n", i + 1);
460 usb_hub_port_connect_change(dev, i);
462 if (portchange & USB_PORT_STAT_C_ENABLE) {
463 debug("port %d enable change, status %x\n",
465 usb_clear_port_feature(dev, i + 1,
466 USB_PORT_FEAT_C_ENABLE);
468 /* EM interference sometimes causes bad shielded USB
469 * devices to be shutdown by the hub, this hack enables
470 * them again. Works at least with mouse driver */
471 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
472 (portstatus & USB_PORT_STAT_CONNECTION) &&
473 ((dev->children[i]))) {
474 debug("already running port %i " \
475 "disabled by hub (EMI?), " \
476 "re-enabling...\n", i + 1);
477 usb_hub_port_connect_change(dev, i);
480 if (portstatus & USB_PORT_STAT_SUSPEND) {
481 debug("port %d suspend change\n", i + 1);
482 usb_clear_port_feature(dev, i + 1,
483 USB_PORT_FEAT_SUSPEND);
486 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
487 debug("port %d over-current change\n", i + 1);
488 usb_clear_port_feature(dev, i + 1,
489 USB_PORT_FEAT_C_OVER_CURRENT);
490 usb_hub_power_on(hub);
493 if (portchange & USB_PORT_STAT_C_RESET) {
494 debug("port %d reset change\n", i + 1);
495 usb_clear_port_feature(dev, i + 1,
496 USB_PORT_FEAT_C_RESET);
498 } /* end for i all ports */
503 int usb_hub_probe(struct usb_device *dev, int ifnum)
505 struct usb_interface *iface;
506 struct usb_endpoint_descriptor *ep;
509 iface = &dev->config.if_desc[ifnum];
511 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
513 /* Some hubs have a subclass of 1, which AFAICT according to the */
514 /* specs is not defined, but it works */
515 if ((iface->desc.bInterfaceSubClass != 0) &&
516 (iface->desc.bInterfaceSubClass != 1))
518 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
519 if (iface->desc.bNumEndpoints != 1)
521 ep = &iface->ep_desc[0];
522 /* Output endpoint? Curiousier and curiousier.. */
523 if (!(ep->bEndpointAddress & USB_DIR_IN))
525 /* If it's not an interrupt endpoint, we'd better punt! */
526 if ((ep->bmAttributes & 3) != 3)
529 debug("USB hub found\n");
530 ret = usb_hub_configure(dev);