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;
105 /* Enable power to the ports */
106 debug("enabling power on all ports\n");
107 for (i = 0; i < dev->maxchild; i++) {
108 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
109 debug("port %d returns %lX\n", i + 1, dev->status);
112 /* Wait at least 100 msec for power to become stable */
113 mdelay(max(pgood_delay, (unsigned)100));
116 void usb_hub_reset(void)
121 static struct usb_hub_device *usb_hub_allocate(void)
123 if (usb_hub_index < USB_MAX_HUB)
124 return &hub_dev[usb_hub_index++];
126 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
132 static inline char *portspeed(int portstatus)
134 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
136 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
142 int hub_port_reset(struct usb_device *dev, int port,
143 unsigned short *portstat)
146 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
147 unsigned short portstatus, portchange;
149 debug("hub_port_reset: resetting port %d...\n", port);
150 for (tries = 0; tries < MAX_TRIES; tries++) {
152 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
155 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
156 debug("get_port_status failed status %lX\n",
160 portstatus = le16_to_cpu(portsts->wPortStatus);
161 portchange = le16_to_cpu(portsts->wPortChange);
163 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
164 portspeed(portstatus));
166 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
167 " USB_PORT_STAT_ENABLE %d\n",
168 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
169 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
170 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
172 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
173 !(portstatus & USB_PORT_STAT_CONNECTION))
176 if (portstatus & USB_PORT_STAT_ENABLE)
182 if (tries == MAX_TRIES) {
183 debug("Cannot enable port %i after %i retries, " \
184 "disabling port.\n", port + 1, MAX_TRIES);
185 debug("Maybe the USB cable is bad?\n");
189 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
190 *portstat = portstatus;
195 void usb_hub_port_connect_change(struct usb_device *dev, int port)
197 struct usb_device *usb;
198 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
199 unsigned short portstatus;
202 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
203 debug("get_port_status failed\n");
207 portstatus = le16_to_cpu(portsts->wPortStatus);
208 debug("portstatus %x, change %x, %s\n",
210 le16_to_cpu(portsts->wPortChange),
211 portspeed(portstatus));
213 /* Clear the connection change status */
214 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
216 /* Disconnect any existing devices under this port */
217 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
218 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
219 debug("usb_disconnect(&hub->children[port]);\n");
220 /* Return now if nothing is connected */
221 if (!(portstatus & USB_PORT_STAT_CONNECTION))
227 if (hub_port_reset(dev, port, &portstatus) < 0) {
228 printf("cannot reset port %i!?\n", port + 1);
234 /* Allocate a new device struct for it */
235 usb = usb_alloc_new_device(dev->controller);
237 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
238 usb->speed = USB_SPEED_HIGH;
239 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
240 usb->speed = USB_SPEED_LOW;
242 usb->speed = USB_SPEED_FULL;
244 dev->children[port] = usb;
246 usb->portnr = port + 1;
247 /* Run it through the hoops (find a driver, etc) */
248 if (usb_new_device(usb)) {
249 /* Woops, disable the port */
251 dev->children[port] = NULL;
252 debug("hub: disabling port %d\n", port + 1);
253 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
258 static int usb_hub_configure(struct usb_device *dev)
261 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
262 unsigned char *bitmap;
263 short hubCharacteristics;
264 struct usb_hub_descriptor *descriptor;
265 struct usb_hub_device *hub;
266 __maybe_unused struct usb_hub_status *hubsts;
268 /* "allocate" Hub device */
269 hub = usb_hub_allocate();
273 /* Get the the hub descriptor */
274 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
275 debug("usb_hub_configure: failed to get hub " \
276 "descriptor, giving up %lX\n", dev->status);
279 descriptor = (struct usb_hub_descriptor *)buffer;
281 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
282 i = descriptor->bLength;
283 if (i > USB_BUFSIZ) {
284 debug("usb_hub_configure: failed to get hub " \
285 "descriptor - too long: %d\n", descriptor->bLength);
289 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
290 debug("usb_hub_configure: failed to get hub " \
291 "descriptor 2nd giving up %lX\n", dev->status);
294 memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
295 /* adjust 16bit values */
296 put_unaligned(le16_to_cpu(get_unaligned(
297 &descriptor->wHubCharacteristics)),
298 &hub->desc.wHubCharacteristics);
300 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
301 /* devices not removable by default */
302 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
303 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
304 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
306 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
307 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
309 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
310 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
312 dev->maxchild = descriptor->bNbrPorts;
313 debug("%d ports detected\n", dev->maxchild);
315 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
316 switch (hubCharacteristics & HUB_CHAR_LPSM) {
318 debug("ganged power switching\n");
321 debug("individual port power switching\n");
325 debug("unknown reserved power switching mode\n");
329 if (hubCharacteristics & HUB_CHAR_COMPOUND)
330 debug("part of a compound device\n");
332 debug("standalone hub\n");
334 switch (hubCharacteristics & HUB_CHAR_OCPM) {
336 debug("global over-current protection\n");
339 debug("individual port over-current protection\n");
343 debug("no over-current protection\n");
347 debug("power on to power good time: %dms\n",
348 descriptor->bPwrOn2PwrGood * 2);
349 debug("hub controller current requirement: %dmA\n",
350 descriptor->bHubContrCurrent);
352 for (i = 0; i < dev->maxchild; i++)
353 debug("port %d is%s removable\n", i + 1,
354 hub->desc.DeviceRemovable[(i + 1) / 8] & \
355 (1 << ((i + 1) % 8)) ? " not" : "");
357 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
358 debug("usb_hub_configure: failed to get Status - " \
359 "too long: %d\n", descriptor->bLength);
363 if (usb_get_hub_status(dev, buffer) < 0) {
364 debug("usb_hub_configure: failed to get Status %lX\n",
370 hubsts = (struct usb_hub_status *)buffer;
373 debug("get_hub_status returned status %X, change %X\n",
374 le16_to_cpu(hubsts->wHubStatus),
375 le16_to_cpu(hubsts->wHubChange));
376 debug("local power source is %s\n",
377 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
378 "lost (inactive)" : "good");
379 debug("%sover-current condition exists\n",
380 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
382 usb_hub_power_on(hub);
384 for (i = 0; i < dev->maxchild; i++) {
385 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
386 unsigned short portstatus, portchange;
388 ulong start = get_timer(0);
391 * Wait for (whichever finishes first)
392 * - A maximum of 10 seconds
393 * This is a purely observational value driven by connecting
394 * a few broken pen drives and taking the max * 1.5 approach
395 * - connection_change and connection state to report same
399 ret = usb_get_port_status(dev, i + 1, portsts);
401 debug("get_port_status failed\n");
405 portstatus = le16_to_cpu(portsts->wPortStatus);
406 portchange = le16_to_cpu(portsts->wPortChange);
408 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
409 (portstatus & USB_PORT_STAT_CONNECTION))
413 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
418 debug("Port %d Status %X Change %X\n",
419 i + 1, portstatus, portchange);
421 if (portchange & USB_PORT_STAT_C_CONNECTION) {
422 debug("port %d connection change\n", i + 1);
423 usb_hub_port_connect_change(dev, i);
425 if (portchange & USB_PORT_STAT_C_ENABLE) {
426 debug("port %d enable change, status %x\n",
428 usb_clear_port_feature(dev, i + 1,
429 USB_PORT_FEAT_C_ENABLE);
431 /* EM interference sometimes causes bad shielded USB
432 * devices to be shutdown by the hub, this hack enables
433 * them again. Works at least with mouse driver */
434 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
435 (portstatus & USB_PORT_STAT_CONNECTION) &&
436 ((dev->children[i]))) {
437 debug("already running port %i " \
438 "disabled by hub (EMI?), " \
439 "re-enabling...\n", i + 1);
440 usb_hub_port_connect_change(dev, i);
443 if (portstatus & USB_PORT_STAT_SUSPEND) {
444 debug("port %d suspend change\n", i + 1);
445 usb_clear_port_feature(dev, i + 1,
446 USB_PORT_FEAT_SUSPEND);
449 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
450 debug("port %d over-current change\n", i + 1);
451 usb_clear_port_feature(dev, i + 1,
452 USB_PORT_FEAT_C_OVER_CURRENT);
453 usb_hub_power_on(hub);
456 if (portchange & USB_PORT_STAT_C_RESET) {
457 debug("port %d reset change\n", i + 1);
458 usb_clear_port_feature(dev, i + 1,
459 USB_PORT_FEAT_C_RESET);
461 } /* end for i all ports */
466 int usb_hub_probe(struct usb_device *dev, int ifnum)
468 struct usb_interface *iface;
469 struct usb_endpoint_descriptor *ep;
472 iface = &dev->config.if_desc[ifnum];
474 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
476 /* Some hubs have a subclass of 1, which AFAICT according to the */
477 /* specs is not defined, but it works */
478 if ((iface->desc.bInterfaceSubClass != 0) &&
479 (iface->desc.bInterfaceSubClass != 1))
481 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
482 if (iface->desc.bNumEndpoints != 1)
484 ep = &iface->ep_desc[0];
485 /* Output endpoint? Curiousier and curiousier.. */
486 if (!(ep->bEndpointAddress & USB_DIR_IN))
488 /* If it's not an interrupt endpoint, we'd better punt! */
489 if ((ep->bmAttributes & 3) != 3)
492 debug("USB hub found\n");
493 ret = usb_hub_configure(dev);