]> Git Repo - J-u-boot.git/blame - common/usb_hub.c
usb: hub: make minimum power-on delay configurable
[J-u-boot.git] / common / usb_hub.c
CommitLineData
23faf2bc
MV
1/*
2 *
3 * Most of this source has been derived from the Linux USB
4 * project:
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)
14 *
15 * Adapted for U-Boot:
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
17 *
18 * See file CREDITS for list of people who contributed to this
19 * project.
20 *
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.
25 *
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.
30 *
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,
34 * MA 02111-1307 USA
35 *
36 */
37
38/****************************************************************************
39 * HUB "Driver"
40 * Probes device for being a hub and configurate it
41 */
42
43#include <common.h>
44#include <command.h>
45#include <asm/processor.h>
93ad908c 46#include <asm/unaligned.h>
23faf2bc
MV
47#include <linux/ctype.h>
48#include <asm/byteorder.h>
49#include <asm/unaligned.h>
50
51#include <usb.h>
52#ifdef CONFIG_4xx
53#include <asm/4xx_pci.h>
54#endif
55
aa155058
KJS
56#ifndef CONFIG_USB_HUB_MIN_POWER_ON_DELAY
57#define CONFIG_USB_HUB_MIN_POWER_ON_DELAY 100
58#endif
59
23faf2bc
MV
60#define USB_BUFSIZ 512
61
62static struct usb_hub_device hub_dev[USB_MAX_HUB];
63static int usb_hub_index;
64
65
66static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
67{
68 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
69 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
70 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
71}
72
73static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
74{
75 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
76 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
77 port, NULL, 0, USB_CNTL_TIMEOUT);
78}
79
80static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
81{
82 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
83 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
84 port, NULL, 0, USB_CNTL_TIMEOUT);
85}
86
87static int usb_get_hub_status(struct usb_device *dev, void *data)
88{
89 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
90 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
91 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
92}
93
94static int usb_get_port_status(struct usb_device *dev, int port, void *data)
95{
96 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
97 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
98 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
99}
100
101
102static void usb_hub_power_on(struct usb_hub_device *hub)
103{
104 int i;
105 struct usb_device *dev;
a1a28c6e 106 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
020bbcb7
VG
107 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
108 unsigned short portstatus;
109 int ret;
23faf2bc
MV
110
111 dev = hub->pusb_dev;
0bf796f7
VG
112
113 /*
114 * Enable power to the ports:
115 * Here we Power-cycle the ports: aka,
116 * turning them off and turning on again.
117 */
ceb4972a 118 debug("enabling power on all ports\n");
23faf2bc 119 for (i = 0; i < dev->maxchild; i++) {
020bbcb7
VG
120 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
121 debug("port %d returns %lX\n", i + 1, dev->status);
0bf796f7 122 }
020bbcb7 123
0bf796f7
VG
124 /* Wait at least 2*bPwrOn2PwrGood for PP to change */
125 mdelay(pgood_delay);
020bbcb7 126
0bf796f7 127 for (i = 0; i < dev->maxchild; i++) {
020bbcb7
VG
128 ret = usb_get_port_status(dev, i + 1, portsts);
129 if (ret < 0) {
130 debug("port %d: get_port_status failed\n", i + 1);
131 return;
132 }
133
134 /*
135 * Check to confirm the state of Port Power:
136 * xHCI says "After modifying PP, s/w shall read
137 * PP and confirm that it has reached the desired state
138 * before modifying it again, undefined behavior may occur
139 * if this procedure is not followed".
140 * EHCI doesn't say anything like this, but no harm in keeping
141 * this.
142 */
143 portstatus = le16_to_cpu(portsts->wPortStatus);
144 if (portstatus & (USB_PORT_STAT_POWER << 1)) {
145 debug("port %d: Port power change failed\n", i + 1);
146 return;
147 }
0bf796f7 148 }
020bbcb7 149
0bf796f7 150 for (i = 0; i < dev->maxchild; i++) {
23faf2bc 151 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
ceb4972a 152 debug("port %d returns %lX\n", i + 1, dev->status);
23faf2bc 153 }
a1a28c6e 154
aa155058
KJS
155 /* Wait for power to become stable */
156 mdelay(max(pgood_delay, CONFIG_USB_HUB_MIN_POWER_ON_DELAY));
23faf2bc
MV
157}
158
159void usb_hub_reset(void)
160{
161 usb_hub_index = 0;
162}
163
164static struct usb_hub_device *usb_hub_allocate(void)
165{
166 if (usb_hub_index < USB_MAX_HUB)
167 return &hub_dev[usb_hub_index++];
168
169 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
170 return NULL;
171}
172
173#define MAX_TRIES 5
174
175static inline char *portspeed(int portstatus)
176{
55f4b575
VG
177 char *speed_str;
178
179 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
180 case USB_PORT_STAT_SUPER_SPEED:
181 speed_str = "5 Gb/s";
182 break;
183 case USB_PORT_STAT_HIGH_SPEED:
184 speed_str = "480 Mb/s";
185 break;
186 case USB_PORT_STAT_LOW_SPEED:
187 speed_str = "1.5 Mb/s";
188 break;
189 default:
190 speed_str = "12 Mb/s";
191 break;
192 }
193
194 return speed_str;
23faf2bc
MV
195}
196
197int hub_port_reset(struct usb_device *dev, int port,
198 unsigned short *portstat)
199{
200 int tries;
f5766139 201 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc
MV
202 unsigned short portstatus, portchange;
203
ceb4972a 204 debug("hub_port_reset: resetting port %d...\n", port);
23faf2bc
MV
205 for (tries = 0; tries < MAX_TRIES; tries++) {
206
207 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
5b84dd67 208 mdelay(200);
23faf2bc 209
f5766139 210 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
ceb4972a
VG
211 debug("get_port_status failed status %lX\n",
212 dev->status);
23faf2bc
MV
213 return -1;
214 }
f5766139
PS
215 portstatus = le16_to_cpu(portsts->wPortStatus);
216 portchange = le16_to_cpu(portsts->wPortChange);
23faf2bc 217
ceb4972a
VG
218 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
219 portspeed(portstatus));
23faf2bc 220
ceb4972a
VG
221 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
222 " USB_PORT_STAT_ENABLE %d\n",
223 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
224 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
225 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
23faf2bc
MV
226
227 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
228 !(portstatus & USB_PORT_STAT_CONNECTION))
229 return -1;
230
231 if (portstatus & USB_PORT_STAT_ENABLE)
232 break;
233
5b84dd67 234 mdelay(200);
23faf2bc
MV
235 }
236
237 if (tries == MAX_TRIES) {
ceb4972a
VG
238 debug("Cannot enable port %i after %i retries, " \
239 "disabling port.\n", port + 1, MAX_TRIES);
240 debug("Maybe the USB cable is bad?\n");
23faf2bc
MV
241 return -1;
242 }
243
244 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
245 *portstat = portstatus;
246 return 0;
247}
248
249
250void usb_hub_port_connect_change(struct usb_device *dev, int port)
251{
252 struct usb_device *usb;
f5766139 253 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc
MV
254 unsigned short portstatus;
255
256 /* Check status */
f5766139 257 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
ceb4972a 258 debug("get_port_status failed\n");
23faf2bc
MV
259 return;
260 }
261
f5766139 262 portstatus = le16_to_cpu(portsts->wPortStatus);
ceb4972a
VG
263 debug("portstatus %x, change %x, %s\n",
264 portstatus,
265 le16_to_cpu(portsts->wPortChange),
266 portspeed(portstatus));
23faf2bc
MV
267
268 /* Clear the connection change status */
269 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
270
271 /* Disconnect any existing devices under this port */
272 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
273 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
ceb4972a 274 debug("usb_disconnect(&hub->children[port]);\n");
23faf2bc
MV
275 /* Return now if nothing is connected */
276 if (!(portstatus & USB_PORT_STAT_CONNECTION))
277 return;
278 }
5b84dd67 279 mdelay(200);
23faf2bc
MV
280
281 /* Reset the port */
282 if (hub_port_reset(dev, port, &portstatus) < 0) {
283 printf("cannot reset port %i!?\n", port + 1);
284 return;
285 }
286
5b84dd67 287 mdelay(200);
23faf2bc
MV
288
289 /* Allocate a new device struct for it */
c7e3b2b5 290 usb = usb_alloc_new_device(dev->controller);
23faf2bc 291
55f4b575
VG
292 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
293 case USB_PORT_STAT_SUPER_SPEED:
6497c667 294 usb->speed = USB_SPEED_SUPER;
55f4b575
VG
295 break;
296 case USB_PORT_STAT_HIGH_SPEED:
23faf2bc 297 usb->speed = USB_SPEED_HIGH;
55f4b575
VG
298 break;
299 case USB_PORT_STAT_LOW_SPEED:
23faf2bc 300 usb->speed = USB_SPEED_LOW;
55f4b575
VG
301 break;
302 default:
23faf2bc 303 usb->speed = USB_SPEED_FULL;
55f4b575
VG
304 break;
305 }
23faf2bc
MV
306
307 dev->children[port] = usb;
308 usb->parent = dev;
309 usb->portnr = port + 1;
310 /* Run it through the hoops (find a driver, etc) */
311 if (usb_new_device(usb)) {
312 /* Woops, disable the port */
359439d2
MC
313 usb_free_device();
314 dev->children[port] = NULL;
ceb4972a 315 debug("hub: disabling port %d\n", port + 1);
23faf2bc
MV
316 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
317 }
318}
319
320
321static int usb_hub_configure(struct usb_device *dev)
322{
323 int i;
f5766139
PS
324 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
325 unsigned char *bitmap;
93ad908c 326 short hubCharacteristics;
23faf2bc
MV
327 struct usb_hub_descriptor *descriptor;
328 struct usb_hub_device *hub;
ceb4972a 329 __maybe_unused struct usb_hub_status *hubsts;
23faf2bc
MV
330
331 /* "allocate" Hub device */
332 hub = usb_hub_allocate();
333 if (hub == NULL)
334 return -1;
335 hub->pusb_dev = dev;
336 /* Get the the hub descriptor */
337 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
ceb4972a
VG
338 debug("usb_hub_configure: failed to get hub " \
339 "descriptor, giving up %lX\n", dev->status);
23faf2bc
MV
340 return -1;
341 }
342 descriptor = (struct usb_hub_descriptor *)buffer;
343
344 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
345 i = descriptor->bLength;
346 if (i > USB_BUFSIZ) {
ceb4972a
VG
347 debug("usb_hub_configure: failed to get hub " \
348 "descriptor - too long: %d\n", descriptor->bLength);
23faf2bc
MV
349 return -1;
350 }
351
352 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
ceb4972a
VG
353 debug("usb_hub_configure: failed to get hub " \
354 "descriptor 2nd giving up %lX\n", dev->status);
23faf2bc
MV
355 return -1;
356 }
357 memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
358 /* adjust 16bit values */
93ad908c
LS
359 put_unaligned(le16_to_cpu(get_unaligned(
360 &descriptor->wHubCharacteristics)),
361 &hub->desc.wHubCharacteristics);
23faf2bc
MV
362 /* set the bitmap */
363 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
364 /* devices not removable by default */
365 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
366 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
367 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
368
369 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
370 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
371
372 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
373 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
374
375 dev->maxchild = descriptor->bNbrPorts;
ceb4972a 376 debug("%d ports detected\n", dev->maxchild);
23faf2bc 377
93ad908c
LS
378 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
379 switch (hubCharacteristics & HUB_CHAR_LPSM) {
23faf2bc 380 case 0x00:
ceb4972a 381 debug("ganged power switching\n");
23faf2bc
MV
382 break;
383 case 0x01:
ceb4972a 384 debug("individual port power switching\n");
23faf2bc
MV
385 break;
386 case 0x02:
387 case 0x03:
ceb4972a 388 debug("unknown reserved power switching mode\n");
23faf2bc
MV
389 break;
390 }
391
93ad908c 392 if (hubCharacteristics & HUB_CHAR_COMPOUND)
ceb4972a 393 debug("part of a compound device\n");
23faf2bc 394 else
ceb4972a 395 debug("standalone hub\n");
23faf2bc 396
93ad908c 397 switch (hubCharacteristics & HUB_CHAR_OCPM) {
23faf2bc 398 case 0x00:
ceb4972a 399 debug("global over-current protection\n");
23faf2bc
MV
400 break;
401 case 0x08:
ceb4972a 402 debug("individual port over-current protection\n");
23faf2bc
MV
403 break;
404 case 0x10:
405 case 0x18:
ceb4972a 406 debug("no over-current protection\n");
23faf2bc
MV
407 break;
408 }
409
ceb4972a
VG
410 debug("power on to power good time: %dms\n",
411 descriptor->bPwrOn2PwrGood * 2);
412 debug("hub controller current requirement: %dmA\n",
413 descriptor->bHubContrCurrent);
23faf2bc
MV
414
415 for (i = 0; i < dev->maxchild; i++)
ceb4972a
VG
416 debug("port %d is%s removable\n", i + 1,
417 hub->desc.DeviceRemovable[(i + 1) / 8] & \
418 (1 << ((i + 1) % 8)) ? " not" : "");
23faf2bc
MV
419
420 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
ceb4972a
VG
421 debug("usb_hub_configure: failed to get Status - " \
422 "too long: %d\n", descriptor->bLength);
23faf2bc
MV
423 return -1;
424 }
425
426 if (usb_get_hub_status(dev, buffer) < 0) {
ceb4972a
VG
427 debug("usb_hub_configure: failed to get Status %lX\n",
428 dev->status);
23faf2bc
MV
429 return -1;
430 }
431
ceb4972a 432#ifdef DEBUG
23faf2bc
MV
433 hubsts = (struct usb_hub_status *)buffer;
434#endif
ceb4972a
VG
435
436 debug("get_hub_status returned status %X, change %X\n",
437 le16_to_cpu(hubsts->wHubStatus),
438 le16_to_cpu(hubsts->wHubChange));
439 debug("local power source is %s\n",
440 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
441 "lost (inactive)" : "good");
442 debug("%sover-current condition exists\n",
443 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
444 "" : "no ");
23faf2bc
MV
445 usb_hub_power_on(hub);
446
447 for (i = 0; i < dev->maxchild; i++) {
f5766139 448 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc 449 unsigned short portstatus, portchange;
b6d7852c
VK
450 int ret;
451 ulong start = get_timer(0);
452
453 /*
454 * Wait for (whichever finishes first)
455 * - A maximum of 10 seconds
456 * This is a purely observational value driven by connecting
457 * a few broken pen drives and taking the max * 1.5 approach
458 * - connection_change and connection state to report same
459 * state
460 */
461 do {
462 ret = usb_get_port_status(dev, i + 1, portsts);
463 if (ret < 0) {
ceb4972a 464 debug("get_port_status failed\n");
b6d7852c
VK
465 break;
466 }
467
468 portstatus = le16_to_cpu(portsts->wPortStatus);
469 portchange = le16_to_cpu(portsts->wPortChange);
470
471 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
472 (portstatus & USB_PORT_STAT_CONNECTION))
473 break;
474
b6d7852c
VK
475 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
476
477 if (ret < 0)
23faf2bc 478 continue;
23faf2bc 479
ceb4972a
VG
480 debug("Port %d Status %X Change %X\n",
481 i + 1, portstatus, portchange);
23faf2bc
MV
482
483 if (portchange & USB_PORT_STAT_C_CONNECTION) {
ceb4972a 484 debug("port %d connection change\n", i + 1);
23faf2bc
MV
485 usb_hub_port_connect_change(dev, i);
486 }
487 if (portchange & USB_PORT_STAT_C_ENABLE) {
ceb4972a
VG
488 debug("port %d enable change, status %x\n",
489 i + 1, portstatus);
23faf2bc
MV
490 usb_clear_port_feature(dev, i + 1,
491 USB_PORT_FEAT_C_ENABLE);
492
493 /* EM interference sometimes causes bad shielded USB
494 * devices to be shutdown by the hub, this hack enables
495 * them again. Works at least with mouse driver */
496 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
497 (portstatus & USB_PORT_STAT_CONNECTION) &&
498 ((dev->children[i]))) {
ceb4972a
VG
499 debug("already running port %i " \
500 "disabled by hub (EMI?), " \
501 "re-enabling...\n", i + 1);
502 usb_hub_port_connect_change(dev, i);
23faf2bc
MV
503 }
504 }
505 if (portstatus & USB_PORT_STAT_SUSPEND) {
ceb4972a 506 debug("port %d suspend change\n", i + 1);
23faf2bc
MV
507 usb_clear_port_feature(dev, i + 1,
508 USB_PORT_FEAT_SUSPEND);
509 }
510
511 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
ceb4972a 512 debug("port %d over-current change\n", i + 1);
23faf2bc
MV
513 usb_clear_port_feature(dev, i + 1,
514 USB_PORT_FEAT_C_OVER_CURRENT);
515 usb_hub_power_on(hub);
516 }
517
518 if (portchange & USB_PORT_STAT_C_RESET) {
ceb4972a 519 debug("port %d reset change\n", i + 1);
23faf2bc
MV
520 usb_clear_port_feature(dev, i + 1,
521 USB_PORT_FEAT_C_RESET);
522 }
523 } /* end for i all ports */
524
525 return 0;
526}
527
528int usb_hub_probe(struct usb_device *dev, int ifnum)
529{
530 struct usb_interface *iface;
531 struct usb_endpoint_descriptor *ep;
532 int ret;
533
534 iface = &dev->config.if_desc[ifnum];
535 /* Is it a hub? */
536 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
537 return 0;
538 /* Some hubs have a subclass of 1, which AFAICT according to the */
539 /* specs is not defined, but it works */
540 if ((iface->desc.bInterfaceSubClass != 0) &&
541 (iface->desc.bInterfaceSubClass != 1))
542 return 0;
543 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
544 if (iface->desc.bNumEndpoints != 1)
545 return 0;
546 ep = &iface->ep_desc[0];
547 /* Output endpoint? Curiousier and curiousier.. */
548 if (!(ep->bEndpointAddress & USB_DIR_IN))
549 return 0;
550 /* If it's not an interrupt endpoint, we'd better punt! */
551 if ((ep->bmAttributes & 3) != 3)
552 return 0;
553 /* We found a hub */
ceb4972a 554 debug("USB hub found\n");
23faf2bc
MV
555 ret = usb_hub_configure(dev);
556 return ret;
557}
This page took 0.212258 seconds and 4 git commands to generate.