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_HIGHSPEED))
170 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
176 int hub_port_reset(struct usb_device *dev, int port,
177 unsigned short *portstat)
180 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
181 unsigned short portstatus, portchange;
183 debug("hub_port_reset: resetting port %d...\n", port);
184 for (tries = 0; tries < MAX_TRIES; tries++) {
186 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
189 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
190 debug("get_port_status failed status %lX\n",
194 portstatus = le16_to_cpu(portsts->wPortStatus);
195 portchange = le16_to_cpu(portsts->wPortChange);
197 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
198 portspeed(portstatus));
200 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
201 " USB_PORT_STAT_ENABLE %d\n",
202 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
203 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
204 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
206 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
207 !(portstatus & USB_PORT_STAT_CONNECTION))
210 if (portstatus & USB_PORT_STAT_ENABLE)
216 if (tries == MAX_TRIES) {
217 debug("Cannot enable port %i after %i retries, " \
218 "disabling port.\n", port + 1, MAX_TRIES);
219 debug("Maybe the USB cable is bad?\n");
223 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
224 *portstat = portstatus;
229 void usb_hub_port_connect_change(struct usb_device *dev, int port)
231 struct usb_device *usb;
232 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
233 unsigned short portstatus;
236 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
237 debug("get_port_status failed\n");
241 portstatus = le16_to_cpu(portsts->wPortStatus);
242 debug("portstatus %x, change %x, %s\n",
244 le16_to_cpu(portsts->wPortChange),
245 portspeed(portstatus));
247 /* Clear the connection change status */
248 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
250 /* Disconnect any existing devices under this port */
251 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
252 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
253 debug("usb_disconnect(&hub->children[port]);\n");
254 /* Return now if nothing is connected */
255 if (!(portstatus & USB_PORT_STAT_CONNECTION))
261 if (hub_port_reset(dev, port, &portstatus) < 0) {
262 printf("cannot reset port %i!?\n", port + 1);
268 /* Allocate a new device struct for it */
269 usb = usb_alloc_new_device(dev->controller);
271 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
272 usb->speed = USB_SPEED_HIGH;
273 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
274 usb->speed = USB_SPEED_LOW;
276 usb->speed = USB_SPEED_FULL;
278 dev->children[port] = usb;
280 usb->portnr = port + 1;
281 /* Run it through the hoops (find a driver, etc) */
282 if (usb_new_device(usb)) {
283 /* Woops, disable the port */
285 dev->children[port] = NULL;
286 debug("hub: disabling port %d\n", port + 1);
287 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
292 static int usb_hub_configure(struct usb_device *dev)
295 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
296 unsigned char *bitmap;
297 short hubCharacteristics;
298 struct usb_hub_descriptor *descriptor;
299 struct usb_hub_device *hub;
300 __maybe_unused struct usb_hub_status *hubsts;
302 /* "allocate" Hub device */
303 hub = usb_hub_allocate();
307 /* Get the the hub descriptor */
308 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
309 debug("usb_hub_configure: failed to get hub " \
310 "descriptor, giving up %lX\n", dev->status);
313 descriptor = (struct usb_hub_descriptor *)buffer;
315 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
316 i = descriptor->bLength;
317 if (i > USB_BUFSIZ) {
318 debug("usb_hub_configure: failed to get hub " \
319 "descriptor - too long: %d\n", descriptor->bLength);
323 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
324 debug("usb_hub_configure: failed to get hub " \
325 "descriptor 2nd giving up %lX\n", dev->status);
328 memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
329 /* adjust 16bit values */
330 put_unaligned(le16_to_cpu(get_unaligned(
331 &descriptor->wHubCharacteristics)),
332 &hub->desc.wHubCharacteristics);
334 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
335 /* devices not removable by default */
336 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
337 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
338 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
340 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
341 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
343 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
344 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
346 dev->maxchild = descriptor->bNbrPorts;
347 debug("%d ports detected\n", dev->maxchild);
349 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
350 switch (hubCharacteristics & HUB_CHAR_LPSM) {
352 debug("ganged power switching\n");
355 debug("individual port power switching\n");
359 debug("unknown reserved power switching mode\n");
363 if (hubCharacteristics & HUB_CHAR_COMPOUND)
364 debug("part of a compound device\n");
366 debug("standalone hub\n");
368 switch (hubCharacteristics & HUB_CHAR_OCPM) {
370 debug("global over-current protection\n");
373 debug("individual port over-current protection\n");
377 debug("no over-current protection\n");
381 debug("power on to power good time: %dms\n",
382 descriptor->bPwrOn2PwrGood * 2);
383 debug("hub controller current requirement: %dmA\n",
384 descriptor->bHubContrCurrent);
386 for (i = 0; i < dev->maxchild; i++)
387 debug("port %d is%s removable\n", i + 1,
388 hub->desc.DeviceRemovable[(i + 1) / 8] & \
389 (1 << ((i + 1) % 8)) ? " not" : "");
391 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
392 debug("usb_hub_configure: failed to get Status - " \
393 "too long: %d\n", descriptor->bLength);
397 if (usb_get_hub_status(dev, buffer) < 0) {
398 debug("usb_hub_configure: failed to get Status %lX\n",
404 hubsts = (struct usb_hub_status *)buffer;
407 debug("get_hub_status returned status %X, change %X\n",
408 le16_to_cpu(hubsts->wHubStatus),
409 le16_to_cpu(hubsts->wHubChange));
410 debug("local power source is %s\n",
411 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
412 "lost (inactive)" : "good");
413 debug("%sover-current condition exists\n",
414 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
416 usb_hub_power_on(hub);
418 for (i = 0; i < dev->maxchild; i++) {
419 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
420 unsigned short portstatus, portchange;
422 ulong start = get_timer(0);
425 * Wait for (whichever finishes first)
426 * - A maximum of 10 seconds
427 * This is a purely observational value driven by connecting
428 * a few broken pen drives and taking the max * 1.5 approach
429 * - connection_change and connection state to report same
433 ret = usb_get_port_status(dev, i + 1, portsts);
435 debug("get_port_status failed\n");
439 portstatus = le16_to_cpu(portsts->wPortStatus);
440 portchange = le16_to_cpu(portsts->wPortChange);
442 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
443 (portstatus & USB_PORT_STAT_CONNECTION))
447 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
452 debug("Port %d Status %X Change %X\n",
453 i + 1, portstatus, portchange);
455 if (portchange & USB_PORT_STAT_C_CONNECTION) {
456 debug("port %d connection change\n", i + 1);
457 usb_hub_port_connect_change(dev, i);
459 if (portchange & USB_PORT_STAT_C_ENABLE) {
460 debug("port %d enable change, status %x\n",
462 usb_clear_port_feature(dev, i + 1,
463 USB_PORT_FEAT_C_ENABLE);
465 /* EM interference sometimes causes bad shielded USB
466 * devices to be shutdown by the hub, this hack enables
467 * them again. Works at least with mouse driver */
468 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
469 (portstatus & USB_PORT_STAT_CONNECTION) &&
470 ((dev->children[i]))) {
471 debug("already running port %i " \
472 "disabled by hub (EMI?), " \
473 "re-enabling...\n", i + 1);
474 usb_hub_port_connect_change(dev, i);
477 if (portstatus & USB_PORT_STAT_SUSPEND) {
478 debug("port %d suspend change\n", i + 1);
479 usb_clear_port_feature(dev, i + 1,
480 USB_PORT_FEAT_SUSPEND);
483 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
484 debug("port %d over-current change\n", i + 1);
485 usb_clear_port_feature(dev, i + 1,
486 USB_PORT_FEAT_C_OVER_CURRENT);
487 usb_hub_power_on(hub);
490 if (portchange & USB_PORT_STAT_C_RESET) {
491 debug("port %d reset change\n", i + 1);
492 usb_clear_port_feature(dev, i + 1,
493 USB_PORT_FEAT_C_RESET);
495 } /* end for i all ports */
500 int usb_hub_probe(struct usb_device *dev, int ifnum)
502 struct usb_interface *iface;
503 struct usb_endpoint_descriptor *ep;
506 iface = &dev->config.if_desc[ifnum];
508 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
510 /* Some hubs have a subclass of 1, which AFAICT according to the */
511 /* specs is not defined, but it works */
512 if ((iface->desc.bInterfaceSubClass != 0) &&
513 (iface->desc.bInterfaceSubClass != 1))
515 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
516 if (iface->desc.bNumEndpoints != 1)
518 ep = &iface->ep_desc[0];
519 /* Output endpoint? Curiousier and curiousier.. */
520 if (!(ep->bEndpointAddress & USB_DIR_IN))
522 /* If it's not an interrupt endpoint, we'd better punt! */
523 if ((ep->bmAttributes & 3) != 3)
526 debug("USB hub found\n");
527 ret = usb_hub_configure(dev);