]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/usb/core/hub.c
projects / mirror_ubuntu-jammy-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: net1080: Fix && typos
[mirror_ubuntu-jammy-kernel.git] / drivers / usb / core / hub.c
CommitLineData
1da177e4
LT		 1/*
2 * USB hub driver.
3 *
4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
8 *
9 */
10
1da177e4
LT		 11#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/completion.h>
16#include <linux/sched.h>
17#include <linux/list.h>
18#include <linux/slab.h>
19#include <linux/smp_lock.h>
20#include <linux/ioctl.h>
21#include <linux/usb.h>
22#include <linux/usbdevice_fs.h>
9c8d6178 23#include <linux/kthread.h>
4186ecf8 24#include <linux/mutex.h>
1da177e4
LT		 25
26#include <asm/semaphore.h>
27#include <asm/uaccess.h>
28#include <asm/byteorder.h>
29
30#include "usb.h"
31#include "hcd.h"
32#include "hub.h"
33
34/* Protect struct usb_device->state and ->children members
9ad3d6cc 35 * Note: Both are also protected by ->dev.sem, except that ->state can
1da177e4
LT		 36 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
37static DEFINE_SPINLOCK(device_state_lock);
38
39/* khubd's worklist and its lock */
40static DEFINE_SPINLOCK(hub_event_lock);
41static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
42
43/* Wakes up khubd */
44static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
45
9c8d6178 46static struct task_struct *khubd_task;
1da177e4
LT		 47
48/* cycle leds on hubs that aren't blinking for attention */
49static int blinkenlights = 0;
50module_param (blinkenlights, bool, S_IRUGO);
51MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
52
53/*
54 * As of 2.6.10 we introduce a new USB device initialization scheme which
55 * closely resembles the way Windows works. Hopefully it will be compatible
56 * with a wider range of devices than the old scheme. However some previously
57 * working devices may start giving rise to "device not accepting address"
58 * errors; if that happens the user can try the old scheme by adjusting the
59 * following module parameters.
60 *
61 * For maximum flexibility there are two boolean parameters to control the
62 * hub driver's behavior. On the first initialization attempt, if the
63 * "old_scheme_first" parameter is set then the old scheme will be used,
64 * otherwise the new scheme is used. If that fails and "use_both_schemes"
65 * is set, then the driver will make another attempt, using the other scheme.
66 */
67static int old_scheme_first = 0;
68module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
69MODULE_PARM_DESC(old_scheme_first,
70 "start with the old device initialization scheme");
71
72static int use_both_schemes = 1;
73module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
74MODULE_PARM_DESC(use_both_schemes,
75 "try the other device initialization scheme if the "
76 "first one fails");
77
78
79#ifdef DEBUG
80static inline char *portspeed (int portstatus)
81{
82 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
83 return "480 Mb/s";
84 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
85 return "1.5 Mb/s";
86 else
87 return "12 Mb/s";
88}
89#endif
90
91/* Note that hdev or one of its children must be locked! */
92static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
93{
94 return usb_get_intfdata(hdev->actconfig->interface[0]);
95}
96
97/* USB 2.0 spec Section 11.24.4.5 */
98static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
99{
100 int i, ret;
101
102 for (i = 0; i < 3; i++) {
103 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
104 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
105 USB_DT_HUB << 8, 0, data, size,
106 USB_CTRL_GET_TIMEOUT);
107 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
108 return ret;
109 }
110 return -EINVAL;
111}
112
113/*
114 * USB 2.0 spec Section 11.24.2.1
115 */
116static int clear_hub_feature(struct usb_device *hdev, int feature)
117{
118 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
119 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
120}
121
122/*
123 * USB 2.0 spec Section 11.24.2.2
124 */
125static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
126{
127 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
128 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
129 NULL, 0, 1000);
130}
131
132/*
133 * USB 2.0 spec Section 11.24.2.13
134 */
135static int set_port_feature(struct usb_device *hdev, int port1, int feature)
136{
137 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
138 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
139 NULL, 0, 1000);
140}
141
142/*
143 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
144 * for info about using port indicators
145 */
146static void set_port_led(
147 struct usb_hub *hub,
148 int port1,
149 int selector
150)
151{
152 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
153 USB_PORT_FEAT_INDICATOR);
154 if (status < 0)
155 dev_dbg (hub->intfdev,
156 "port %d indicator %s status %d\n",
157 port1,
158 ({ char *s; switch (selector) {
159 case HUB_LED_AMBER: s = "amber"; break;
160 case HUB_LED_GREEN: s = "green"; break;
161 case HUB_LED_OFF: s = "off"; break;
162 case HUB_LED_AUTO: s = "auto"; break;
163 default: s = "??"; break;
164 }; s; }),
165 status);
166}
167
168#define LED_CYCLE_PERIOD ((2*HZ)/3)
169
170static void led_work (void *__hub)
171{
172 struct usb_hub *hub = __hub;
173 struct usb_device *hdev = hub->hdev;
174 unsigned i;
175 unsigned changed = 0;
176 int cursor = -1;
177
178 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
179 return;
180
181 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
182 unsigned selector, mode;
183
184 /* 30%-50% duty cycle */
185
186 switch (hub->indicator[i]) {
187 /* cycle marker */
188 case INDICATOR_CYCLE:
189 cursor = i;
190 selector = HUB_LED_AUTO;
191 mode = INDICATOR_AUTO;
192 break;
193 /* blinking green = sw attention */
194 case INDICATOR_GREEN_BLINK:
195 selector = HUB_LED_GREEN;
196 mode = INDICATOR_GREEN_BLINK_OFF;
197 break;
198 case INDICATOR_GREEN_BLINK_OFF:
199 selector = HUB_LED_OFF;
200 mode = INDICATOR_GREEN_BLINK;
201 break;
202 /* blinking amber = hw attention */
203 case INDICATOR_AMBER_BLINK:
204 selector = HUB_LED_AMBER;
205 mode = INDICATOR_AMBER_BLINK_OFF;
206 break;
207 case INDICATOR_AMBER_BLINK_OFF:
208 selector = HUB_LED_OFF;
209 mode = INDICATOR_AMBER_BLINK;
210 break;
211 /* blink green/amber = reserved */
212 case INDICATOR_ALT_BLINK:
213 selector = HUB_LED_GREEN;
214 mode = INDICATOR_ALT_BLINK_OFF;
215 break;
216 case INDICATOR_ALT_BLINK_OFF:
217 selector = HUB_LED_AMBER;
218 mode = INDICATOR_ALT_BLINK;
219 break;
220 default:
221 continue;
222 }
223 if (selector != HUB_LED_AUTO)
224 changed = 1;
225 set_port_led(hub, i + 1, selector);
226 hub->indicator[i] = mode;
227 }
228 if (!changed && blinkenlights) {
229 cursor++;
230 cursor %= hub->descriptor->bNbrPorts;
231 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
232 hub->indicator[cursor] = INDICATOR_CYCLE;
233 changed++;
234 }
235 if (changed)
236 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
237}
238
239/* use a short timeout for hub/port status fetches */
240#define USB_STS_TIMEOUT 1000
241#define USB_STS_RETRIES 5
242
243/*
244 * USB 2.0 spec Section 11.24.2.6
245 */
246static int get_hub_status(struct usb_device *hdev,
247 struct usb_hub_status *data)
248{
249 int i, status = -ETIMEDOUT;
250
251 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
252 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
253 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
254 data, sizeof(*data), USB_STS_TIMEOUT);
255 }
256 return status;
257}
258
259/*
260 * USB 2.0 spec Section 11.24.2.7
261 */
262static int get_port_status(struct usb_device *hdev, int port1,
263 struct usb_port_status *data)
264{
265 int i, status = -ETIMEDOUT;
266
267 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
268 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
269 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
270 data, sizeof(*data), USB_STS_TIMEOUT);
271 }
272 return status;
273}
274
275static void kick_khubd(struct usb_hub *hub)
276{
277 unsigned long flags;
278
279 spin_lock_irqsave(&hub_event_lock, flags);
280 if (list_empty(&hub->event_list)) {
281 list_add_tail(&hub->event_list, &hub_event_list);
282 wake_up(&khubd_wait);
283 }
284 spin_unlock_irqrestore(&hub_event_lock, flags);
285}
286
287void usb_kick_khubd(struct usb_device *hdev)
288{
289 kick_khubd(hdev_to_hub(hdev));
290}
291
292
293/* completion function, fires on port status changes and various faults */
7d12e780 294static void hub_irq(struct urb *urb)
1da177e4 295{
ec17cf1c 296 struct usb_hub *hub = urb->context;
1da177e4
LT		 297 int status;
298 int i;
299 unsigned long bits;
300
301 switch (urb->status) {
302 case -ENOENT: /* synchronous unlink */
303 case -ECONNRESET: /* async unlink */
304 case -ESHUTDOWN: /* hardware going away */
305 return;
306
307 default: /* presumably an error */
308 /* Cause a hub reset after 10 consecutive errors */
309 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
310 if ((++hub->nerrors < 10) || hub->error)
311 goto resubmit;
312 hub->error = urb->status;
313 /* FALL THROUGH */
ec17cf1c 314
1da177e4
LT		 315 /* let khubd handle things */
316 case 0: /* we got data: port status changed */
317 bits = 0;
318 for (i = 0; i < urb->actual_length; ++i)
319 bits |= ((unsigned long) ((*hub->buffer)[i]))
320 << (i*8);
321 hub->event_bits[0] = bits;
322 break;
323 }
324
325 hub->nerrors = 0;
326
327 /* Something happened, let khubd figure it out */
328 kick_khubd(hub);
329
330resubmit:
331 if (hub->quiescing)
332 return;
333
334 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
335 && status != -ENODEV && status != -EPERM)
336 dev_err (hub->intfdev, "resubmit --> %d\n", status);
337}
338
339/* USB 2.0 spec Section 11.24.2.3 */
340static inline int
341hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
342{
343 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
345 tt, NULL, 0, 1000);
346}
347
348/*
349 * enumeration blocks khubd for a long time. we use keventd instead, since
350 * long blocking there is the exception, not the rule. accordingly, HCDs
351 * talking to TTs must queue control transfers (not just bulk and iso), so
352 * both can talk to the same hub concurrently.
353 */
354static void hub_tt_kevent (void *arg)
355{
356 struct usb_hub *hub = arg;
357 unsigned long flags;
358
359 spin_lock_irqsave (&hub->tt.lock, flags);
360 while (!list_empty (&hub->tt.clear_list)) {
361 struct list_head *temp;
362 struct usb_tt_clear *clear;
363 struct usb_device *hdev = hub->hdev;
364 int status;
365
366 temp = hub->tt.clear_list.next;
367 clear = list_entry (temp, struct usb_tt_clear, clear_list);
368 list_del (&clear->clear_list);
369
370 /* drop lock so HCD can concurrently report other TT errors */
371 spin_unlock_irqrestore (&hub->tt.lock, flags);
372 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
373 spin_lock_irqsave (&hub->tt.lock, flags);
374
375 if (status)
376 dev_err (&hdev->dev,
377 "clear tt %d (%04x) error %d\n",
378 clear->tt, clear->devinfo, status);
1bc3c9e1 379 kfree(clear);
1da177e4
LT		 380 }
381 spin_unlock_irqrestore (&hub->tt.lock, flags);
382}
383
384/**
385 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
386 * @udev: the device whose split transaction failed
387 * @pipe: identifies the endpoint of the failed transaction
388 *
389 * High speed HCDs use this to tell the hub driver that some split control or
390 * bulk transaction failed in a way that requires clearing internal state of
391 * a transaction translator. This is normally detected (and reported) from
392 * interrupt context.
393 *
394 * It may not be possible for that hub to handle additional full (or low)
395 * speed transactions until that state is fully cleared out.
396 */
397void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
398{
399 struct usb_tt *tt = udev->tt;
400 unsigned long flags;
401 struct usb_tt_clear *clear;
402
403 /* we've got to cope with an arbitrary number of pending TT clears,
404 * since each TT has "at least two" buffers that can need it (and
405 * there can be many TTs per hub). even if they're uncommon.
406 */
407 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
408 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
409 /* FIXME recover somehow ... RESET_TT? */
410 return;
411 }
412
413 /* info that CLEAR_TT_BUFFER needs */
414 clear->tt = tt->multi ? udev->ttport : 1;
415 clear->devinfo = usb_pipeendpoint (pipe);
416 clear->devinfo |= udev->devnum << 4;
417 clear->devinfo |= usb_pipecontrol (pipe)
418 ? (USB_ENDPOINT_XFER_CONTROL << 11)
419 : (USB_ENDPOINT_XFER_BULK << 11);
420 if (usb_pipein (pipe))
421 clear->devinfo |= 1 << 15;
422
423 /* tell keventd to clear state for this TT */
424 spin_lock_irqsave (&tt->lock, flags);
425 list_add_tail (&clear->clear_list, &tt->clear_list);
426 schedule_work (&tt->kevent);
427 spin_unlock_irqrestore (&tt->lock, flags);
428}
429
430static void hub_power_on(struct usb_hub *hub)
431{
432 int port1;
b789696a 433 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
4489a571
AS		 434 u16 wHubCharacteristics =
435 le16_to_cpu(hub->descriptor->wHubCharacteristics);
436
437 /* Enable power on each port. Some hubs have reserved values
438 * of LPSM (> 2) in their descriptors, even though they are
439 * USB 2.0 hubs. Some hubs do not implement port-power switching
440 * but only emulate it. In all cases, the ports won't work
441 * unless we send these messages to the hub.
442 */
443 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
1da177e4 444 dev_dbg(hub->intfdev, "enabling power on all ports\n");
4489a571
AS		 445 else
446 dev_dbg(hub->intfdev, "trying to enable port power on "
447 "non-switchable hub\n");
448 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
449 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
1da177e4 450
b789696a
DB		 451 /* Wait at least 100 msec for power to become stable */
452 msleep(max(pgood_delay, (unsigned) 100));
1da177e4
LT		 453}
454
02c399ee 455static void hub_quiesce(struct usb_hub *hub)
1da177e4 456{
979d5199 457 /* (nonblocking) khubd and related activity won't re-trigger */
1da177e4 458 hub->quiescing = 1;
c9f89fa4 459 hub->activating = 0;
979d5199 460 hub->resume_root_hub = 0;
979d5199 461
979d5199 462 /* (blocking) stop khubd and related activity */
1da177e4
LT		 463 usb_kill_urb(hub->urb);
464 if (hub->has_indicators)
465 cancel_delayed_work(&hub->leds);
466 if (hub->has_indicators || hub->tt.hub)
467 flush_scheduled_work();
468}
469
470static void hub_activate(struct usb_hub *hub)
471{
472 int status;
473
474 hub->quiescing = 0;
475 hub->activating = 1;
979d5199 476 hub->resume_root_hub = 0;
1da177e4
LT		 477 status = usb_submit_urb(hub->urb, GFP_NOIO);
478 if (status < 0)
479 dev_err(hub->intfdev, "activate --> %d\n", status);
480 if (hub->has_indicators && blinkenlights)
481 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
482
483 /* scan all ports ASAP */
484 kick_khubd(hub);
485}
486
487static int hub_hub_status(struct usb_hub *hub,
488 u16 *status, u16 *change)
489{
490 int ret;
491
492 ret = get_hub_status(hub->hdev, &hub->status->hub);
493 if (ret < 0)
494 dev_err (hub->intfdev,
495 "%s failed (err = %d)\n", __FUNCTION__, ret);
496 else {
497 *status = le16_to_cpu(hub->status->hub.wHubStatus);
498 *change = le16_to_cpu(hub->status->hub.wHubChange);
499 ret = 0;
500 }
501 return ret;
502}
503
8b28c752
AS		 504static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
505{
506 struct usb_device *hdev = hub->hdev;
507 int ret;
508
509 if (hdev->children[port1-1] && set_state) {
510 usb_set_device_state(hdev->children[port1-1],
511 USB_STATE_NOTATTACHED);
512 }
513 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
514 if (ret)
515 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
516 port1, ret);
517
518 return ret;
519}
520
7d069b7d
AS		 521
522/* caller has locked the hub device */
7de18d8b 523static void hub_pre_reset(struct usb_interface *intf)
7d069b7d 524{
7de18d8b 525 struct usb_hub *hub = usb_get_intfdata(intf);
7d069b7d
AS		 526 struct usb_device *hdev = hub->hdev;
527 int port1;
528
529 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
530 if (hdev->children[port1 - 1]) {
531 usb_disconnect(&hdev->children[port1 - 1]);
7de18d8b 532 if (hub->error == 0)
7d069b7d
AS		 533 hub_port_disable(hub, port1, 0);
534 }
535 }
536 hub_quiesce(hub);
537}
538
539/* caller has locked the hub device */
7de18d8b 540static void hub_post_reset(struct usb_interface *intf)
7d069b7d 541{
7de18d8b
AS		 542 struct usb_hub *hub = usb_get_intfdata(intf);
543
7d069b7d
AS		 544 hub_activate(hub);
545 hub_power_on(hub);
546}
547
548
1da177e4
LT		 549static int hub_configure(struct usb_hub *hub,
550 struct usb_endpoint_descriptor *endpoint)
551{
552 struct usb_device *hdev = hub->hdev;
553 struct device *hub_dev = hub->intfdev;
554 u16 hubstatus, hubchange;
74ad9bd2 555 u16 wHubCharacteristics;
1da177e4
LT		 556 unsigned int pipe;
557 int maxp, ret;
558 char *message;
559
560 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
561 &hub->buffer_dma);
562 if (!hub->buffer) {
563 message = "can't allocate hub irq buffer";
564 ret = -ENOMEM;
565 goto fail;
566 }
567
568 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
569 if (!hub->status) {
570 message = "can't kmalloc hub status buffer";
571 ret = -ENOMEM;
572 goto fail;
573 }
574
575 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
576 if (!hub->descriptor) {
577 message = "can't kmalloc hub descriptor";
578 ret = -ENOMEM;
579 goto fail;
580 }
581
582 /* Request the entire hub descriptor.
583 * hub->descriptor can handle USB_MAXCHILDREN ports,
584 * but the hub can/will return fewer bytes here.
585 */
586 ret = get_hub_descriptor(hdev, hub->descriptor,
587 sizeof(*hub->descriptor));
588 if (ret < 0) {
589 message = "can't read hub descriptor";
590 goto fail;
591 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
592 message = "hub has too many ports!";
593 ret = -ENODEV;
594 goto fail;
595 }
596
597 hdev->maxchild = hub->descriptor->bNbrPorts;
598 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
599 (hdev->maxchild == 1) ? "" : "s");
600
74ad9bd2 601 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1da177e4 602
74ad9bd2 603 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
1da177e4
LT		 604 int i;
605 char portstr [USB_MAXCHILDREN + 1];
606
607 for (i = 0; i < hdev->maxchild; i++)
608 portstr[i] = hub->descriptor->DeviceRemovable
609 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
610 ? 'F' : 'R';
611 portstr[hdev->maxchild] = 0;
612 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
613 } else
614 dev_dbg(hub_dev, "standalone hub\n");
615
74ad9bd2 616 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1da177e4
LT		 617 case 0x00:
618 dev_dbg(hub_dev, "ganged power switching\n");
619 break;
620 case 0x01:
621 dev_dbg(hub_dev, "individual port power switching\n");
622 break;
623 case 0x02:
624 case 0x03:
625 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
626 break;
627 }
628
74ad9bd2 629 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1da177e4
LT		 630 case 0x00:
631 dev_dbg(hub_dev, "global over-current protection\n");
632 break;
633 case 0x08:
634 dev_dbg(hub_dev, "individual port over-current protection\n");
635 break;
636 case 0x10:
637 case 0x18:
638 dev_dbg(hub_dev, "no over-current protection\n");
639 break;
640 }
641
642 spin_lock_init (&hub->tt.lock);
643 INIT_LIST_HEAD (&hub->tt.clear_list);
644 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
645 switch (hdev->descriptor.bDeviceProtocol) {
646 case 0:
647 break;
648 case 1:
649 dev_dbg(hub_dev, "Single TT\n");
650 hub->tt.hub = hdev;
651 break;
652 case 2:
653 ret = usb_set_interface(hdev, 0, 1);
654 if (ret == 0) {
655 dev_dbg(hub_dev, "TT per port\n");
656 hub->tt.multi = 1;
657 } else
658 dev_err(hub_dev, "Using single TT (err %d)\n",
659 ret);
660 hub->tt.hub = hdev;
661 break;
662 default:
663 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
664 hdev->descriptor.bDeviceProtocol);
665 break;
666 }
667
e09711ae 668 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
74ad9bd2 669 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
e09711ae
DB		 670 case HUB_TTTT_8_BITS:
671 if (hdev->descriptor.bDeviceProtocol != 0) {
672 hub->tt.think_time = 666;
673 dev_dbg(hub_dev, "TT requires at most %d "
674 "FS bit times (%d ns)\n",
675 8, hub->tt.think_time);
676 }
1da177e4 677 break;
e09711ae
DB		 678 case HUB_TTTT_16_BITS:
679 hub->tt.think_time = 666 * 2;
680 dev_dbg(hub_dev, "TT requires at most %d "
681 "FS bit times (%d ns)\n",
682 16, hub->tt.think_time);
1da177e4 683 break;
e09711ae
DB		 684 case HUB_TTTT_24_BITS:
685 hub->tt.think_time = 666 * 3;
686 dev_dbg(hub_dev, "TT requires at most %d "
687 "FS bit times (%d ns)\n",
688 24, hub->tt.think_time);
1da177e4 689 break;
e09711ae
DB		 690 case HUB_TTTT_32_BITS:
691 hub->tt.think_time = 666 * 4;
692 dev_dbg(hub_dev, "TT requires at most %d "
693 "FS bit times (%d ns)\n",
694 32, hub->tt.think_time);
1da177e4
LT		 695 break;
696 }
697
698 /* probe() zeroes hub->indicator[] */
74ad9bd2 699 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1da177e4
LT		 700 hub->has_indicators = 1;
701 dev_dbg(hub_dev, "Port indicators are supported\n");
702 }
703
704 dev_dbg(hub_dev, "power on to power good time: %dms\n",
705 hub->descriptor->bPwrOn2PwrGood * 2);
706
707 /* power budgeting mostly matters with bus-powered hubs,
708 * and battery-powered root hubs (may provide just 8 mA).
709 */
710 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
55c52718 711 if (ret < 2) {
1da177e4
LT		 712 message = "can't get hub status";
713 goto fail;
714 }
7d35b929
AS		 715 le16_to_cpus(&hubstatus);
716 if (hdev == hdev->bus->root_hub) {
55c52718
AS		 717 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
718 hub->mA_per_port = 500;
719 else {
720 hub->mA_per_port = hdev->bus_mA;
721 hub->limited_power = 1;
722 }
7d35b929 723 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1da177e4
LT		 724 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
725 hub->descriptor->bHubContrCurrent);
55c52718
AS		 726 hub->limited_power = 1;
727 if (hdev->maxchild > 0) {
728 int remaining = hdev->bus_mA -
729 hub->descriptor->bHubContrCurrent;
730
731 if (remaining < hdev->maxchild * 100)
732 dev_warn(hub_dev,
733 "insufficient power available "
734 "to use all downstream ports\n");
735 hub->mA_per_port = 100; /* 7.2.1.1 */
736 }
737 } else { /* Self-powered external hub */
738 /* FIXME: What about battery-powered external hubs that
739 * provide less current per port? */
740 hub->mA_per_port = 500;
7d35b929 741 }
55c52718
AS		 742 if (hub->mA_per_port < 500)
743 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
744 hub->mA_per_port);
1da177e4
LT		 745
746 ret = hub_hub_status(hub, &hubstatus, &hubchange);
747 if (ret < 0) {
748 message = "can't get hub status";
749 goto fail;
750 }
751
752 /* local power status reports aren't always correct */
753 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
754 dev_dbg(hub_dev, "local power source is %s\n",
755 (hubstatus & HUB_STATUS_LOCAL_POWER)
756 ? "lost (inactive)" : "good");
757
74ad9bd2 758 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1da177e4
LT		 759 dev_dbg(hub_dev, "%sover-current condition exists\n",
760 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
761
88fafff9 762 /* set up the interrupt endpoint
763 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
764 * bytes as USB2.0[11.12.3] says because some hubs are known
765 * to send more data (and thus cause overflow). For root hubs,
766 * maxpktsize is defined in hcd.c's fake endpoint descriptors
767 * to be big enough for at least USB_MAXCHILDREN ports. */
1da177e4
LT		 768 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
769 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
770
771 if (maxp > sizeof(*hub->buffer))
772 maxp = sizeof(*hub->buffer);
773
774 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
775 if (!hub->urb) {
776 message = "couldn't allocate interrupt urb";
777 ret = -ENOMEM;
778 goto fail;
779 }
780
781 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
782 hub, endpoint->bInterval);
783 hub->urb->transfer_dma = hub->buffer_dma;
784 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
785
786 /* maybe cycle the hub leds */
787 if (hub->has_indicators && blinkenlights)
788 hub->indicator [0] = INDICATOR_CYCLE;
789
790 hub_power_on(hub);
791 hub_activate(hub);
792 return 0;
793
794fail:
795 dev_err (hub_dev, "config failed, %s (err %d)\n",
796 message, ret);
797 /* hub_disconnect() frees urb and descriptor */
798 return ret;
799}
800
801static unsigned highspeed_hubs;
802
803static void hub_disconnect(struct usb_interface *intf)
804{
805 struct usb_hub *hub = usb_get_intfdata (intf);
806 struct usb_device *hdev;
807
7de18d8b
AS		 808 /* Disconnect all children and quiesce the hub */
809 hub->error = 0;
810 hub_pre_reset(intf);
811
8b28c752 812 usb_set_intfdata (intf, NULL);
1da177e4
LT		 813 hdev = hub->hdev;
814
815 if (hdev->speed == USB_SPEED_HIGH)
816 highspeed_hubs--;
817
1da177e4
LT		 818 usb_free_urb(hub->urb);
819 hub->urb = NULL;
820
821 spin_lock_irq(&hub_event_lock);
822 list_del_init(&hub->event_list);
823 spin_unlock_irq(&hub_event_lock);
824
1bc3c9e1
JJ		 825 kfree(hub->descriptor);
826 hub->descriptor = NULL;
1da177e4 827
1bc3c9e1
JJ		 828 kfree(hub->status);
829 hub->status = NULL;
1da177e4
LT		 830
831 if (hub->buffer) {
832 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
833 hub->buffer_dma);
834 hub->buffer = NULL;
835 }
836
7d069b7d 837 kfree(hub);
1da177e4
LT		 838}
839
840static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
841{
842 struct usb_host_interface *desc;
843 struct usb_endpoint_descriptor *endpoint;
844 struct usb_device *hdev;
845 struct usb_hub *hub;
846
847 desc = intf->cur_altsetting;
848 hdev = interface_to_usbdev(intf);
849
89ccbdc9
DB		 850#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
851 if (hdev->parent) {
852 dev_warn(&intf->dev, "ignoring external hub\n");
853 return -ENODEV;
854 }
855#endif
856
1da177e4
LT		 857 /* Some hubs have a subclass of 1, which AFAICT according to the */
858 /* specs is not defined, but it works */
859 if ((desc->desc.bInterfaceSubClass != 0) &&
860 (desc->desc.bInterfaceSubClass != 1)) {
861descriptor_error:
862 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
863 return -EIO;
864 }
865
866 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
867 if (desc->desc.bNumEndpoints != 1)
868 goto descriptor_error;
869
870 endpoint = &desc->endpoint[0].desc;
871
fbf81c29
LFC		 872 /* If it's not an interrupt in endpoint, we'd better punt! */
873 if (!usb_endpoint_is_int_in(endpoint))
1da177e4
LT		 874 goto descriptor_error;
875
876 /* We found a hub */
877 dev_info (&intf->dev, "USB hub found\n");
878
0a1ef3b5 879 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1da177e4
LT		 880 if (!hub) {
881 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
882 return -ENOMEM;
883 }
884
1da177e4
LT		 885 INIT_LIST_HEAD(&hub->event_list);
886 hub->intfdev = &intf->dev;
887 hub->hdev = hdev;
888 INIT_WORK(&hub->leds, led_work, hub);
889
890 usb_set_intfdata (intf, hub);
891
892 if (hdev->speed == USB_SPEED_HIGH)
893 highspeed_hubs++;
894
895 if (hub_configure(hub, endpoint) >= 0)
896 return 0;
897
898 hub_disconnect (intf);
899 return -ENODEV;
900}
901
902static int
903hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
904{
905 struct usb_device *hdev = interface_to_usbdev (intf);
906
907 /* assert ifno == 0 (part of hub spec) */
908 switch (code) {
909 case USBDEVFS_HUB_PORTINFO: {
910 struct usbdevfs_hub_portinfo *info = user_data;
911 int i;
912
913 spin_lock_irq(&device_state_lock);
914 if (hdev->devnum <= 0)
915 info->nports = 0;
916 else {
917 info->nports = hdev->maxchild;
918 for (i = 0; i < info->nports; i++) {
919 if (hdev->children[i] == NULL)
920 info->port[i] = 0;
921 else
922 info->port[i] =
923 hdev->children[i]->devnum;
924 }
925 }
926 spin_unlock_irq(&device_state_lock);
927
928 return info->nports + 1;
929 }
930
931 default:
932 return -ENOSYS;
933 }
934}
935
1da177e4
LT		 936
937/* grab device/port lock, returning index of that port (zero based).
938 * protects the upstream link used by this device from concurrent
939 * tree operations like suspend, resume, reset, and disconnect, which
940 * apply to everything downstream of a given port.
941 */
942static int locktree(struct usb_device *udev)
943{
944 int t;
945 struct usb_device *hdev;
946
947 if (!udev)
948 return -ENODEV;
949
950 /* root hub is always the first lock in the series */
951 hdev = udev->parent;
952 if (!hdev) {
953 usb_lock_device(udev);
954 return 0;
955 }
956
957 /* on the path from root to us, lock everything from
958 * top down, dropping parent locks when not needed
959 */
960 t = locktree(hdev);
961 if (t < 0)
962 return t;
1da177e4 963
12c3da34
AS		 964 /* everything is fail-fast once disconnect
965 * processing starts
966 */
967 if (udev->state == USB_STATE_NOTATTACHED) {
968 usb_unlock_device(hdev);
969 return -ENODEV;
1da177e4 970 }
12c3da34
AS		 971
972 /* when everyone grabs locks top->bottom,
973 * non-overlapping work may be concurrent
974 */
975 usb_lock_device(udev);
1da177e4 976 usb_unlock_device(hdev);
12c3da34 977 return udev->portnum;
1da177e4
LT		 978}
979
980static void recursively_mark_NOTATTACHED(struct usb_device *udev)
981{
982 int i;
983
984 for (i = 0; i < udev->maxchild; ++i) {
985 if (udev->children[i])
986 recursively_mark_NOTATTACHED(udev->children[i]);
987 }
988 udev->state = USB_STATE_NOTATTACHED;
989}
990
991/**
992 * usb_set_device_state - change a device's current state (usbcore, hcds)
993 * @udev: pointer to device whose state should be changed
994 * @new_state: new state value to be stored
995 *
996 * udev->state is _not_ fully protected by the device lock. Although
997 * most transitions are made only while holding the lock, the state can
998 * can change to USB_STATE_NOTATTACHED at almost any time. This
999 * is so that devices can be marked as disconnected as soon as possible,
1000 * without having to wait for any semaphores to be released. As a result,
1001 * all changes to any device's state must be protected by the
1002 * device_state_lock spinlock.
1003 *
1004 * Once a device has been added to the device tree, all changes to its state
1005 * should be made using this routine. The state should _not_ be set directly.
1006 *
1007 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1008 * Otherwise udev->state is set to new_state, and if new_state is
1009 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1010 * to USB_STATE_NOTATTACHED.
1011 */
1012void usb_set_device_state(struct usb_device *udev,
1013 enum usb_device_state new_state)
1014{
1015 unsigned long flags;
1016
1017 spin_lock_irqsave(&device_state_lock, flags);
1018 if (udev->state == USB_STATE_NOTATTACHED)
1019 ; /* do nothing */
b94dc6b5 1020 else if (new_state != USB_STATE_NOTATTACHED) {
fb669cc0
DB		 1021
1022 /* root hub wakeup capabilities are managed out-of-band
1023 * and may involve silicon errata ... ignore them here.
1024 */
1025 if (udev->parent) {
645daaab
AS		 1026 if (udev->state == USB_STATE_SUSPENDED
1027 || new_state == USB_STATE_SUSPENDED)
1028 ; /* No change to wakeup settings */
1029 else if (new_state == USB_STATE_CONFIGURED)
fb669cc0
DB		 1030 device_init_wakeup(&udev->dev,
1031 (udev->actconfig->desc.bmAttributes
1032 & USB_CONFIG_ATT_WAKEUP));
645daaab 1033 else
fb669cc0
DB		 1034 device_init_wakeup(&udev->dev, 0);
1035 }
645daaab 1036 udev->state = new_state;
b94dc6b5 1037 } else
1da177e4
LT		 1038 recursively_mark_NOTATTACHED(udev);
1039 spin_unlock_irqrestore(&device_state_lock, flags);
1040}
1da177e4
LT		 1041
1042
d388dab7 1043#ifdef CONFIG_PM
1c50c317
AS		 1044
1045/**
1046 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1047 * @rhdev: struct usb_device for the root hub
1048 *
1049 * The USB host controller driver calls this function when its root hub
1050 * is resumed and Vbus power has been interrupted or the controller
1051 * has been reset. The routine marks all the children of the root hub
1052 * as NOTATTACHED and marks logical connect-change events on their ports.
1053 */
1054void usb_root_hub_lost_power(struct usb_device *rhdev)
1055{
1056 struct usb_hub *hub;
1057 int port1;
1058 unsigned long flags;
1059
1060 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
353a4098
AS		 1061
1062 /* Make sure no potential wakeup events get lost,
1063 * by forcing the root hub to be resumed.
1064 */
1065 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1066
1c50c317
AS		 1067 spin_lock_irqsave(&device_state_lock, flags);
1068 hub = hdev_to_hub(rhdev);
1069 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1070 if (rhdev->children[port1 - 1]) {
1071 recursively_mark_NOTATTACHED(
1072 rhdev->children[port1 - 1]);
1073 set_bit(port1, hub->change_bits);
1074 }
1075 }
1076 spin_unlock_irqrestore(&device_state_lock, flags);
1077}
1078EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1079
d388dab7 1080#endif /* CONFIG_PM */
1c50c317 1081
1da177e4
LT		 1082static void choose_address(struct usb_device *udev)
1083{
1084 int devnum;
1085 struct usb_bus *bus = udev->bus;
1086
1087 /* If khubd ever becomes multithreaded, this will need a lock */
1088
1089 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1090 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1091 bus->devnum_next);
1092 if (devnum >= 128)
1093 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1094
1095 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1096
1097 if (devnum < 128) {
1098 set_bit(devnum, bus->devmap.devicemap);
1099 udev->devnum = devnum;
1100 }
1101}
1102
1103static void release_address(struct usb_device *udev)
1104{
1105 if (udev->devnum > 0) {
1106 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1107 udev->devnum = -1;
1108 }
1109}
1110
1111/**
1112 * usb_disconnect - disconnect a device (usbcore-internal)
1113 * @pdev: pointer to device being disconnected
1114 * Context: !in_interrupt ()
1115 *
1116 * Something got disconnected. Get rid of it and all of its children.
1117 *
1118 * If *pdev is a normal device then the parent hub must already be locked.
1119 * If *pdev is a root hub then this routine will acquire the
1120 * usb_bus_list_lock on behalf of the caller.
1121 *
1122 * Only hub drivers (including virtual root hub drivers for host
1123 * controllers) should ever call this.
1124 *
1125 * This call is synchronous, and may not be used in an interrupt context.
1126 */
1127void usb_disconnect(struct usb_device **pdev)
1128{
1129 struct usb_device *udev = *pdev;
1130 int i;
1131
1132 if (!udev) {
1133 pr_debug ("%s nodev\n", __FUNCTION__);
1134 return;
1135 }
1136
1137 /* mark the device as inactive, so any further urb submissions for
1138 * this device (and any of its children) will fail immediately.
1139 * this quiesces everyting except pending urbs.
1140 */
1141 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1da177e4
LT		 1142 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1143
9ad3d6cc
AS		 1144 usb_lock_device(udev);
1145
1da177e4
LT		 1146 /* Free up all the children before we remove this device */
1147 for (i = 0; i < USB_MAXCHILDREN; i++) {
1148 if (udev->children[i])
1149 usb_disconnect(&udev->children[i]);
1150 }
1151
1152 /* deallocate hcd/hardware state ... nuking all pending urbs and
1153 * cleaning up all state associated with the current configuration
1154 * so that the hardware is now fully quiesced.
1155 */
782da727 1156 dev_dbg (&udev->dev, "unregistering device\n");
1da177e4
LT		 1157 usb_disable_device(udev, 0);
1158
782da727
AS		 1159 usb_unlock_device(udev);
1160
1161 /* Unregister the device. The device driver is responsible
1162 * for removing the device files from usbfs and sysfs and for
1163 * de-configuring the device.
1164 */
1165 device_del(&udev->dev);
3099e75a 1166
782da727 1167 /* Free the device number and delete the parent's children[]
1da177e4
LT		 1168 * (or root_hub) pointer.
1169 */
1da177e4 1170 release_address(udev);
1da177e4
LT		 1171
1172 /* Avoid races with recursively_mark_NOTATTACHED() */
1173 spin_lock_irq(&device_state_lock);
1174 *pdev = NULL;
1175 spin_unlock_irq(&device_state_lock);
1176
782da727 1177 put_device(&udev->dev);
1da177e4
LT		 1178}
1179
1180#ifdef DEBUG
1181static void show_string(struct usb_device *udev, char *id, char *string)
1182{
1183 if (!string)
1184 return;
1185 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1186}
1187
1188#else
1189static inline void show_string(struct usb_device *udev, char *id, char *string)
1190{}
1191#endif
1192
1da177e4
LT		 1193
1194#ifdef CONFIG_USB_OTG
1195#include "otg_whitelist.h"
11bd44ab 1196static int __usb_port_suspend(struct usb_device *, int port1);
1da177e4
LT		 1197#endif
1198
1199/**
1200 * usb_new_device - perform initial device setup (usbcore-internal)
1201 * @udev: newly addressed device (in ADDRESS state)
1202 *
1203 * This is called with devices which have been enumerated, but not yet
1204 * configured. The device descriptor is available, but not descriptors
9ad3d6cc
AS		 1205 * for any device configuration. The caller must have locked either
1206 * the parent hub (if udev is a normal device) or else the
1da177e4
LT		 1207 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1208 * udev has already been installed, but udev is not yet visible through
1209 * sysfs or other filesystem code.
1210 *
1211 * Returns 0 for success (device is configured and listed, with its
1212 * interfaces, in sysfs); else a negative errno value.
1213 *
1214 * This call is synchronous, and may not be used in an interrupt context.
1215 *
9ad3d6cc 1216 * Only the hub driver or root-hub registrar should ever call this.
1da177e4
LT		 1217 */
1218int usb_new_device(struct usb_device *udev)
1219{
1220 int err;
1da177e4
LT		 1221
1222 err = usb_get_configuration(udev);
1223 if (err < 0) {
1224 dev_err(&udev->dev, "can't read configurations, error %d\n",
1225 err);
1226 goto fail;
1227 }
1228
1229 /* read the standard strings and cache them if present */
4f62efe6
AS		 1230 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1231 udev->manufacturer = usb_cache_string(udev,
1232 udev->descriptor.iManufacturer);
1233 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1da177e4
LT		 1234
1235 /* Tell the world! */
1236 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1237 "SerialNumber=%d\n",
1238 udev->descriptor.iManufacturer,
1239 udev->descriptor.iProduct,
1240 udev->descriptor.iSerialNumber);
1241 show_string(udev, "Product", udev->product);
1242 show_string(udev, "Manufacturer", udev->manufacturer);
1243 show_string(udev, "SerialNumber", udev->serial);
1244
1245#ifdef CONFIG_USB_OTG
1246 /*
1247 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1248 * to wake us after we've powered off VBUS; and HNP, switching roles
1249 * "host" to "peripheral". The OTG descriptor helps figure this out.
1250 */
1251 if (!udev->bus->is_b_host
1252 && udev->config
1253 && udev->parent == udev->bus->root_hub) {
1254 struct usb_otg_descriptor *desc = 0;
1255 struct usb_bus *bus = udev->bus;
1256
1257 /* descriptor may appear anywhere in config */
1258 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1259 le16_to_cpu(udev->config[0].desc.wTotalLength),
1260 USB_DT_OTG, (void **) &desc) == 0) {
1261 if (desc->bmAttributes & USB_OTG_HNP) {
12c3da34 1262 unsigned port1 = udev->portnum;
fc849b85 1263
1da177e4
LT		 1264 dev_info(&udev->dev,
1265 "Dual-Role OTG device on %sHNP port\n",
1266 (port1 == bus->otg_port)
1267 ? "" : "non-");
1268
1269 /* enable HNP before suspend, it's simpler */
1270 if (port1 == bus->otg_port)
1271 bus->b_hnp_enable = 1;
1272 err = usb_control_msg(udev,
1273 usb_sndctrlpipe(udev, 0),
1274 USB_REQ_SET_FEATURE, 0,
1275 bus->b_hnp_enable
1276 ? USB_DEVICE_B_HNP_ENABLE
1277 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1278 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1279 if (err < 0) {
1280 /* OTG MESSAGE: report errors here,
1281 * customize to match your product.
1282 */
1283 dev_info(&udev->dev,
1284 "can't set HNP mode; %d\n",
1285 err);
1286 bus->b_hnp_enable = 0;
1287 }
1288 }
1289 }
1290 }
1291
1292 if (!is_targeted(udev)) {
1293
1294 /* Maybe it can talk to us, though we can't talk to it.
1295 * (Includes HNP test device.)
1296 */
1297 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
140d8f68 1298 err = __usb_port_suspend(udev, udev->bus->otg_port);
1da177e4
LT		 1299 if (err < 0)
1300 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1301 }
1302 err = -ENODEV;
1303 goto fail;
1304 }
1305#endif
1306
782da727
AS		 1307 /* Register the device. The device driver is responsible
1308 * for adding the device files to usbfs and sysfs and for
1309 * configuring the device.
1310 */
1da177e4
LT		 1311 err = device_add (&udev->dev);
1312 if (err) {
1313 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1314 goto fail;
1315 }
9ad3d6cc 1316
1da177e4
LT		 1317 return 0;
1318
1319fail:
1320 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1321 return err;
1322}
1323
1324
1325static int hub_port_status(struct usb_hub *hub, int port1,
1326 u16 *status, u16 *change)
1327{
1328 int ret;
1329
1330 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1331 if (ret < 0)
1332 dev_err (hub->intfdev,
1333 "%s failed (err = %d)\n", __FUNCTION__, ret);
1334 else {
1335 *status = le16_to_cpu(hub->status->port.wPortStatus);
1336 *change = le16_to_cpu(hub->status->port.wPortChange);
1337 ret = 0;
1338 }
1339 return ret;
1340}
1341
0165de09
IPG		 1342
1343/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1344static unsigned hub_is_wusb(struct usb_hub *hub)
1345{
1346 struct usb_hcd *hcd;
1347 if (hub->hdev->parent != NULL) /* not a root hub? */
1348 return 0;
1349 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1350 return hcd->wireless;
1351}
1352
1353
1da177e4
LT		 1354#define PORT_RESET_TRIES 5
1355#define SET_ADDRESS_TRIES 2
1356#define GET_DESCRIPTOR_TRIES 2
1357#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1358#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1359
1360#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1361#define HUB_SHORT_RESET_TIME 10
1362#define HUB_LONG_RESET_TIME 200
1363#define HUB_RESET_TIMEOUT 500
1364
1365static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1366 struct usb_device *udev, unsigned int delay)
1367{
1368 int delay_time, ret;
1369 u16 portstatus;
1370 u16 portchange;
1371
1372 for (delay_time = 0;
1373 delay_time < HUB_RESET_TIMEOUT;
1374 delay_time += delay) {
1375 /* wait to give the device a chance to reset */
1376 msleep(delay);
1377
1378 /* read and decode port status */
1379 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1380 if (ret < 0)
1381 return ret;
1382
1383 /* Device went away? */
1384 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1385 return -ENOTCONN;
1386
1387 /* bomb out completely if something weird happened */
1388 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1389 return -EINVAL;
1390
1391 /* if we`ve finished resetting, then break out of the loop */
1392 if (!(portstatus & USB_PORT_STAT_RESET) &&
1393 (portstatus & USB_PORT_STAT_ENABLE)) {
0165de09
IPG		 1394 if (hub_is_wusb(hub))
1395 udev->speed = USB_SPEED_VARIABLE;
1396 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1da177e4
LT		 1397 udev->speed = USB_SPEED_HIGH;
1398 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1399 udev->speed = USB_SPEED_LOW;
1400 else
1401 udev->speed = USB_SPEED_FULL;
1402 return 0;
1403 }
1404
1405 /* switch to the long delay after two short delay failures */
1406 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1407 delay = HUB_LONG_RESET_TIME;
1408
1409 dev_dbg (hub->intfdev,
1410 "port %d not reset yet, waiting %dms\n",
1411 port1, delay);
1412 }
1413
1414 return -EBUSY;
1415}
1416
1417static int hub_port_reset(struct usb_hub *hub, int port1,
1418 struct usb_device *udev, unsigned int delay)
1419{
1420 int i, status;
1421
1422 /* Reset the port */
1423 for (i = 0; i < PORT_RESET_TRIES; i++) {
1424 status = set_port_feature(hub->hdev,
1425 port1, USB_PORT_FEAT_RESET);
1426 if (status)
1427 dev_err(hub->intfdev,
1428 "cannot reset port %d (err = %d)\n",
1429 port1, status);
1430 else {
1431 status = hub_port_wait_reset(hub, port1, udev, delay);
dd16525b 1432 if (status && status != -ENOTCONN)
1da177e4
LT		 1433 dev_dbg(hub->intfdev,
1434 "port_wait_reset: err = %d\n",
1435 status);
1436 }
1437
1438 /* return on disconnect or reset */
1439 switch (status) {
1440 case 0:
b789696a
DB		 1441 /* TRSTRCY = 10 ms; plus some extra */
1442 msleep(10 + 40);
1da177e4
LT		 1443 /* FALL THROUGH */
1444 case -ENOTCONN:
1445 case -ENODEV:
1446 clear_port_feature(hub->hdev,
1447 port1, USB_PORT_FEAT_C_RESET);
1448 /* FIXME need disconnect() for NOTATTACHED device */
1449 usb_set_device_state(udev, status
1450 ? USB_STATE_NOTATTACHED
1451 : USB_STATE_DEFAULT);
1452 return status;
1453 }
1454
1455 dev_dbg (hub->intfdev,
1456 "port %d not enabled, trying reset again...\n",
1457 port1);
1458 delay = HUB_LONG_RESET_TIME;
1459 }
1460
1461 dev_err (hub->intfdev,
1462 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1463 port1);
1464
1465 return status;
1466}
1467
1da177e4
LT		 1468/*
1469 * Disable a port and mark a logical connnect-change event, so that some
1470 * time later khubd will disconnect() any existing usb_device on the port
1471 * and will re-enumerate if there actually is a device attached.
1472 */
1473static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1474{
1475 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1476 hub_port_disable(hub, port1, 1);
1477
1478 /* FIXME let caller ask to power down the port:
1479 * - some devices won't enumerate without a VBUS power cycle
1480 * - SRP saves power that way
390a8c34 1481 * - ... new call, TBD ...
1da177e4
LT		 1482 * That's easy if this hub can switch power per-port, and
1483 * khubd reactivates the port later (timer, SRP, etc).
1484 * Powerdown must be optional, because of reset/DFU.
1485 */
1486
1487 set_bit(port1, hub->change_bits);
1488 kick_khubd(hub);
1489}
1490
d388dab7 1491#ifdef CONFIG_PM
1da177e4
LT		 1492
1493#ifdef CONFIG_USB_SUSPEND
1494
1495/*
1496 * Selective port suspend reduces power; most suspended devices draw
1497 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1498 * All devices below the suspended port are also suspended.
1499 *
1500 * Devices leave suspend state when the host wakes them up. Some devices
1501 * also support "remote wakeup", where the device can activate the USB
1502 * tree above them to deliver data, such as a keypress or packet. In
1503 * some cases, this wakes the USB host.
1504 */
1505static int hub_port_suspend(struct usb_hub *hub, int port1,
1506 struct usb_device *udev)
1507{
1508 int status;
1509
1510 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1511
1512 /* enable remote wakeup when appropriate; this lets the device
1513 * wake up the upstream hub (including maybe the root hub).
1514 *
1515 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1516 * we don't explicitly enable it here.
1517 */
645daaab 1518 if (udev->do_remote_wakeup) {
1da177e4
LT		 1519 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1520 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1521 USB_DEVICE_REMOTE_WAKEUP, 0,
1522 NULL, 0,
1523 USB_CTRL_SET_TIMEOUT);
1524 if (status)
1525 dev_dbg(&udev->dev,
1526 "won't remote wakeup, status %d\n",
1527 status);
1528 }
1529
1530 /* see 7.1.7.6 */
1531 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1532 if (status) {
1533 dev_dbg(hub->intfdev,
1534 "can't suspend port %d, status %d\n",
1535 port1, status);
1536 /* paranoia: "should not happen" */
1537 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1538 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1539 USB_DEVICE_REMOTE_WAKEUP, 0,
1540 NULL, 0,
1541 USB_CTRL_SET_TIMEOUT);
1542 } else {
1543 /* device has up to 10 msec to fully suspend */
645daaab
AS		 1544 dev_dbg(&udev->dev, "usb %ssuspend\n",
1545 udev->auto_pm ? "auto-" : "");
1da177e4
LT		 1546 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1547 msleep(10);
1548 }
1549 return status;
1550}
1551
1552/*
1553 * Devices on USB hub ports have only one "suspend" state, corresponding
ba9d35fb 1554 * to ACPI D2, "may cause the device to lose some context".
1da177e4
LT		 1555 * State transitions include:
1556 *
1557 * - suspend, resume ... when the VBUS power link stays live
1558 * - suspend, disconnect ... VBUS lost
1559 *
1560 * Once VBUS drop breaks the circuit, the port it's using has to go through
1561 * normal re-enumeration procedures, starting with enabling VBUS power.
1562 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1563 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1564 * timer, no SRP, no requests through sysfs.
390a8c34
DB		 1565 *
1566 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1567 * the root hub for their bus goes into global suspend ... so we don't
1568 * (falsely) update the device power state to say it suspended.
1da177e4 1569 */
140d8f68 1570static int __usb_port_suspend (struct usb_device *udev, int port1)
1da177e4 1571{
f3f3253d 1572 int status = 0;
1da177e4
LT		 1573
1574 /* caller owns the udev device lock */
1575 if (port1 < 0)
1576 return port1;
1577
140d8f68
AS		 1578 /* we change the device's upstream USB link,
1579 * but root hubs have no upstream USB link.
1da177e4 1580 */
f3f3253d 1581 if (udev->parent)
1da177e4
LT		 1582 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1583 udev);
2bf4086d 1584 else {
645daaab
AS		 1585 dev_dbg(&udev->dev, "usb %ssuspend\n",
1586 udev->auto_pm ? "auto-" : "");
2bf4086d
AS		 1587 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1588 }
1da177e4
LT		 1589 return status;
1590}
1591
5edbfb7c 1592/*
140d8f68 1593 * usb_port_suspend - suspend a usb device's upstream port
1da177e4 1594 * @udev: device that's no longer in active use
5edbfb7c 1595 * Context: must be able to sleep; device not locked; pm locks held
1da177e4
LT		 1596 *
1597 * Suspends a USB device that isn't in active use, conserving power.
1598 * Devices may wake out of a suspend, if anything important happens,
1599 * using the remote wakeup mechanism. They may also be taken out of
140d8f68 1600 * suspend by the host, using usb_port_resume(). It's also routine
1da177e4
LT		 1601 * to disconnect devices while they are suspended.
1602 *
390a8c34
DB		 1603 * This only affects the USB hardware for a device; its interfaces
1604 * (and, for hubs, child devices) must already have been suspended.
1605 *
1da177e4
LT		 1606 * Suspending OTG devices may trigger HNP, if that's been enabled
1607 * between a pair of dual-role devices. That will change roles, such
1608 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1609 *
1610 * Returns 0 on success, else negative errno.
1611 */
140d8f68 1612int usb_port_suspend(struct usb_device *udev)
1da177e4 1613{
140d8f68 1614 return __usb_port_suspend(udev, udev->portnum);
1da177e4 1615}
f3f3253d 1616
1da177e4 1617/*
390a8c34
DB		 1618 * If the USB "suspend" state is in use (rather than "global suspend"),
1619 * many devices will be individually taken out of suspend state using
1620 * special" resume" signaling. These routines kick in shortly after
1da177e4
LT		 1621 * hardware resume signaling is finished, either because of selective
1622 * resume (by host) or remote wakeup (by device) ... now see what changed
1623 * in the tree that's rooted at this device.
1624 */
140d8f68 1625static int finish_port_resume(struct usb_device *udev)
1da177e4
LT		 1626{
1627 int status;
1628 u16 devstatus;
1629
1630 /* caller owns the udev device lock */
f3f3253d 1631 dev_dbg(&udev->dev, "finish resume\n");
1da177e4
LT		 1632
1633 /* usb ch9 identifies four variants of SUSPENDED, based on what
1634 * state the device resumes to. Linux currently won't see the
1635 * first two on the host side; they'd be inside hub_port_init()
1636 * during many timeouts, but khubd can't suspend until later.
1637 */
1638 usb_set_device_state(udev, udev->actconfig
1639 ? USB_STATE_CONFIGURED
1640 : USB_STATE_ADDRESS);
1da177e4
LT		 1641
1642 /* 10.5.4.5 says be sure devices in the tree are still there.
1643 * For now let's assume the device didn't go crazy on resume,
1644 * and device drivers will know about any resume quirks.
1645 */
1646 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
b40b7a90
AS		 1647 if (status >= 0)
1648 status = (status == 2 ? 0 : -ENODEV);
1649
1650 if (status)
1da177e4
LT		 1651 dev_dbg(&udev->dev,
1652 "gone after usb resume? status %d\n",
1653 status);
1654 else if (udev->actconfig) {
1da177e4 1655 le16_to_cpus(&devstatus);
55c52718 1656 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
f3f3253d 1657 && udev->parent) {
1da177e4
LT		 1658 status = usb_control_msg(udev,
1659 usb_sndctrlpipe(udev, 0),
1660 USB_REQ_CLEAR_FEATURE,
1661 USB_RECIP_DEVICE,
1662 USB_DEVICE_REMOTE_WAKEUP, 0,
1663 NULL, 0,
1664 USB_CTRL_SET_TIMEOUT);
a8e7c565 1665 if (status)
1da177e4
LT		 1666 dev_dbg(&udev->dev, "disable remote "
1667 "wakeup, status %d\n", status);
4bf0ba86 1668 }
1da177e4
LT		 1669 status = 0;
1670
1671 } else if (udev->devnum <= 0) {
1672 dev_dbg(&udev->dev, "bogus resume!\n");
1673 status = -EINVAL;
1674 }
1675 return status;
1676}
1677
1678static int
1679hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1680{
1681 int status;
1682
1683 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1684
d5cbad4b
AS		 1685 set_bit(port1, hub->busy_bits);
1686
1da177e4
LT		 1687 /* see 7.1.7.7; affects power usage, but not budgeting */
1688 status = clear_port_feature(hub->hdev,
1689 port1, USB_PORT_FEAT_SUSPEND);
1690 if (status) {
1691 dev_dbg(hub->intfdev,
1692 "can't resume port %d, status %d\n",
1693 port1, status);
1694 } else {
1695 u16 devstatus;
1696 u16 portchange;
1697
1698 /* drive resume for at least 20 msec */
1699 if (udev)
645daaab
AS		 1700 dev_dbg(&udev->dev, "usb %sresume\n",
1701 udev->auto_pm ? "auto-" : "");
1da177e4
LT		 1702 msleep(25);
1703
1704#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1705 | USB_PORT_STAT_ENABLE \
1706 | USB_PORT_STAT_CONNECTION)
1707
1708 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1709 * stop resume signaling. Then finish the resume
1710 * sequence.
1711 */
1712 devstatus = portchange = 0;
1713 status = hub_port_status(hub, port1,
1714 &devstatus, &portchange);
1715 if (status < 0
1716 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1717 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1718 ) {
1719 dev_dbg(hub->intfdev,
1720 "port %d status %04x.%04x after resume, %d\n",
1721 port1, portchange, devstatus, status);
20307949
AS		 1722 if (status >= 0)
1723 status = -ENODEV;
1da177e4 1724 } else {
20307949
AS		 1725 if (portchange & USB_PORT_STAT_C_SUSPEND)
1726 clear_port_feature(hub->hdev, port1,
1727 USB_PORT_FEAT_C_SUSPEND);
1da177e4
LT		 1728 /* TRSMRCY = 10 msec */
1729 msleep(10);
1730 if (udev)
140d8f68 1731 status = finish_port_resume(udev);
1da177e4
LT		 1732 }
1733 }
1734 if (status < 0)
1735 hub_port_logical_disconnect(hub, port1);
1736
d5cbad4b
AS		 1737 clear_bit(port1, hub->busy_bits);
1738 if (!hub->hdev->parent && !hub->busy_bits[0])
1739 usb_enable_root_hub_irq(hub->hdev->bus);
1740
1da177e4
LT		 1741 return status;
1742}
1743
5edbfb7c 1744/*
140d8f68 1745 * usb_port_resume - re-activate a suspended usb device's upstream port
1da177e4 1746 * @udev: device to re-activate
5edbfb7c 1747 * Context: must be able to sleep; device not locked; pm locks held
1da177e4
LT		 1748 *
1749 * This will re-activate the suspended device, increasing power usage
1750 * while letting drivers communicate again with its endpoints.
1751 * USB resume explicitly guarantees that the power session between
1752 * the host and the device is the same as it was when the device
1753 * suspended.
1754 *
1755 * Returns 0 on success, else negative errno.
1756 */
140d8f68 1757int usb_port_resume(struct usb_device *udev)
1da177e4 1758{
d388dab7 1759 int status;
1da177e4 1760
140d8f68
AS		 1761 /* we change the device's upstream USB link,
1762 * but root hubs have no upstream USB link.
1763 */
f3f3253d 1764 if (udev->parent) {
114b368c
AS		 1765 // NOTE this fails if parent is also suspended...
1766 status = hub_port_resume(hdev_to_hub(udev->parent),
1767 udev->portnum, udev);
645daaab
AS		 1768 } else {
1769 dev_dbg(&udev->dev, "usb %sresume\n",
1770 udev->auto_pm ? "auto-" : "");
140d8f68 1771 status = finish_port_resume(udev);
645daaab 1772 }
f3f3253d 1773 if (status < 0)
a8e7c565 1774 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1da177e4
LT		 1775 return status;
1776}
1777
1778static int remote_wakeup(struct usb_device *udev)
1779{
1780 int status = 0;
1781
645daaab
AS		 1782 /* All this just to avoid sending a port-resume message
1783 * to the parent hub! */
1784
9ad3d6cc 1785 usb_lock_device(udev);
e0318ebf 1786 usb_pm_lock(udev);
1da177e4 1787 if (udev->state == USB_STATE_SUSPENDED) {
645daaab 1788 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1da177e4
LT		 1789 /* TRSMRCY = 10 msec */
1790 msleep(10);
140d8f68 1791 status = finish_port_resume(udev);
645daaab
AS		 1792 if (status == 0)
1793 udev->dev.power.power_state.event = PM_EVENT_ON;
1da177e4 1794 }
e0318ebf 1795 usb_pm_unlock(udev);
a8e7c565
AS		 1796
1797 if (status == 0)
645daaab 1798 usb_autoresume_device(udev, 0);
9ad3d6cc 1799 usb_unlock_device(udev);
1da177e4
LT		 1800 return status;
1801}
1802
d388dab7
AS		 1803#else /* CONFIG_USB_SUSPEND */
1804
1805/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1806
1807int usb_port_suspend(struct usb_device *udev)
1808{
1809 return 0;
1810}
1811
1812static inline int
1813finish_port_resume(struct usb_device *udev)
1814{
1815 return 0;
1816}
1817
1818static inline int
1819hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1820{
1821 return 0;
1822}
1823
1824int usb_port_resume(struct usb_device *udev)
1825{
1826 return 0;
1827}
1828
1829static inline int remote_wakeup(struct usb_device *udev)
1830{
1831 return 0;
1832}
1833
1834#endif
1835
db690874 1836static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1da177e4
LT		 1837{
1838 struct usb_hub *hub = usb_get_intfdata (intf);
1839 struct usb_device *hdev = hub->hdev;
1840 unsigned port1;
1da177e4 1841
c9f89fa4 1842 /* fail if children aren't already suspended */
1da177e4
LT		 1843 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1844 struct usb_device *udev;
1845
1846 udev = hdev->children [port1-1];
114b368c 1847 if (udev && msg.event == PM_EVENT_SUSPEND &&
f3f3253d 1848#ifdef CONFIG_USB_SUSPEND
114b368c
AS		 1849 udev->state != USB_STATE_SUSPENDED
1850#else
1851 udev->dev.power.power_state.event
1852 == PM_EVENT_ON
f3f3253d 1853#endif
114b368c 1854 ) {
645daaab
AS		 1855 if (!hdev->auto_pm)
1856 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1857 port1);
c9f89fa4
DB		 1858 return -EBUSY;
1859 }
1da177e4
LT		 1860 }
1861
f3f3253d
DB		 1862 /* "global suspend" of the downstream HC-to-USB interface */
1863 if (!hdev->parent) {
1864 struct usb_bus *bus = hdev->bus;
0c0382e3
AS		 1865 if (bus) {
1866 int status = hcd_bus_suspend (bus);
f3f3253d
DB		 1867
1868 if (status != 0) {
1869 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1870 status);
1871 return status;
1872 }
1873 } else
1874 return -EOPNOTSUPP;
1875 }
1876
c9f89fa4
DB		 1877 /* stop khubd and related activity */
1878 hub_quiesce(hub);
1da177e4
LT		 1879 return 0;
1880}
1881
1882static int hub_resume(struct usb_interface *intf)
1883{
1884 struct usb_device *hdev = interface_to_usbdev(intf);
1885 struct usb_hub *hub = usb_get_intfdata (intf);
1da177e4
LT		 1886 int status;
1887
f3f3253d
DB		 1888 /* "global resume" of the downstream HC-to-USB interface */
1889 if (!hdev->parent) {
1890 struct usb_bus *bus = hdev->bus;
0c0382e3
AS		 1891 if (bus) {
1892 status = hcd_bus_resume (bus);
f3f3253d
DB		 1893 if (status) {
1894 dev_dbg(&intf->dev, "'global' resume %d\n",
1895 status);
1896 return status;
1897 }
1898 } else
1899 return -EOPNOTSUPP;
1900 if (status == 0) {
1901 /* TRSMRCY = 10 msec */
1902 msleep(10);
1903 }
1904 }
1905
a8e7c565 1906 /* tell khubd to look for changes on this hub */
f3f3253d 1907 hub_activate(hub);
1da177e4
LT		 1908 return 0;
1909}
1910
d388dab7
AS		 1911#else /* CONFIG_PM */
1912
1913static inline int remote_wakeup(struct usb_device *udev)
1914{
1915 return 0;
1916}
1917
511366da
AM		 1918#define hub_suspend NULL
1919#define hub_resume NULL
d388dab7
AS		 1920#endif
1921
1da177e4
LT		 1922void usb_resume_root_hub(struct usb_device *hdev)
1923{
1924 struct usb_hub *hub = hdev_to_hub(hdev);
1925
1926 hub->resume_root_hub = 1;
1927 kick_khubd(hub);
1928}
1929
1da177e4
LT		 1930
1931/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1932 *
1933 * Between connect detection and reset signaling there must be a delay
1934 * of 100ms at least for debounce and power-settling. The corresponding
1935 * timer shall restart whenever the downstream port detects a disconnect.
1936 *
1937 * Apparently there are some bluetooth and irda-dongles and a number of
1938 * low-speed devices for which this debounce period may last over a second.
1939 * Not covered by the spec - but easy to deal with.
1940 *
1941 * This implementation uses a 1500ms total debounce timeout; if the
1942 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1943 * every 25ms for transient disconnects. When the port status has been
1944 * unchanged for 100ms it returns the port status.
1945 */
1946
1947#define HUB_DEBOUNCE_TIMEOUT 1500
1948#define HUB_DEBOUNCE_STEP 25
1949#define HUB_DEBOUNCE_STABLE 100
1950
1951static int hub_port_debounce(struct usb_hub *hub, int port1)
1952{
1953 int ret;
1954 int total_time, stable_time = 0;
1955 u16 portchange, portstatus;
1956 unsigned connection = 0xffff;
1957
1958 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
1959 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1960 if (ret < 0)
1961 return ret;
1962
1963 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
1964 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
1965 stable_time += HUB_DEBOUNCE_STEP;
1966 if (stable_time >= HUB_DEBOUNCE_STABLE)
1967 break;
1968 } else {
1969 stable_time = 0;
1970 connection = portstatus & USB_PORT_STAT_CONNECTION;
1971 }
1972
1973 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1974 clear_port_feature(hub->hdev, port1,
1975 USB_PORT_FEAT_C_CONNECTION);
1976 }
1977
1978 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
1979 break;
1980 msleep(HUB_DEBOUNCE_STEP);
1981 }
1982
1983 dev_dbg (hub->intfdev,
1984 "debounce: port %d: total %dms stable %dms status 0x%x\n",
1985 port1, total_time, stable_time, portstatus);
1986
1987 if (stable_time < HUB_DEBOUNCE_STABLE)
1988 return -ETIMEDOUT;
1989 return portstatus;
1990}
1991
1992static void ep0_reinit(struct usb_device *udev)
1993{
1994 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
1995 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
1996 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
1997}
1998
1999#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2000#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2001
2002static int hub_set_address(struct usb_device *udev)
2003{
2004 int retval;
2005
2006 if (udev->devnum == 0)
2007 return -EINVAL;
2008 if (udev->state == USB_STATE_ADDRESS)
2009 return 0;
2010 if (udev->state != USB_STATE_DEFAULT)
2011 return -EINVAL;
2012 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2013 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2014 NULL, 0, USB_CTRL_SET_TIMEOUT);
2015 if (retval == 0) {
2016 usb_set_device_state(udev, USB_STATE_ADDRESS);
2017 ep0_reinit(udev);
2018 }
2019 return retval;
2020}
2021
2022/* Reset device, (re)assign address, get device descriptor.
2023 * Device connection must be stable, no more debouncing needed.
2024 * Returns device in USB_STATE_ADDRESS, except on error.
2025 *
2026 * If this is called for an already-existing device (as part of
2027 * usb_reset_device), the caller must own the device lock. For a
2028 * newly detected device that is not accessible through any global
2029 * pointers, it's not necessary to lock the device.
2030 */
2031static int
2032hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2033 int retry_counter)
2034{
4186ecf8 2035 static DEFINE_MUTEX(usb_address0_mutex);
1da177e4
LT		 2036
2037 struct usb_device *hdev = hub->hdev;
2038 int i, j, retval;
2039 unsigned delay = HUB_SHORT_RESET_TIME;
2040 enum usb_device_speed oldspeed = udev->speed;
83a07196 2041 char *speed, *type;
1da177e4
LT		 2042
2043 /* root hub ports have a slightly longer reset period
2044 * (from USB 2.0 spec, section 7.1.7.5)
2045 */
2046 if (!hdev->parent) {
2047 delay = HUB_ROOT_RESET_TIME;
2048 if (port1 == hdev->bus->otg_port)
2049 hdev->bus->b_hnp_enable = 0;
2050 }
2051
2052 /* Some low speed devices have problems with the quick delay, so */
2053 /* be a bit pessimistic with those devices. RHbug #23670 */
2054 if (oldspeed == USB_SPEED_LOW)
2055 delay = HUB_LONG_RESET_TIME;
2056
4186ecf8 2057 mutex_lock(&usb_address0_mutex);
1da177e4
LT		 2058
2059 /* Reset the device; full speed may morph to high speed */
2060 retval = hub_port_reset(hub, port1, udev, delay);
2061 if (retval < 0) /* error or disconnect */
2062 goto fail;
2063 /* success, speed is known */
2064 retval = -ENODEV;
2065
2066 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2067 dev_dbg(&udev->dev, "device reset changed speed!\n");
2068 goto fail;
2069 }
2070 oldspeed = udev->speed;
2071
2072 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2073 * it's fixed size except for full speed devices.
5bb6e0ae
IPG		 2074 * For Wireless USB devices, ep0 max packet is always 512 (tho
2075 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
1da177e4
LT		 2076 */
2077 switch (udev->speed) {
5bb6e0ae
IPG		 2078 case USB_SPEED_VARIABLE: /* fixed at 512 */
2079 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2080 break;
1da177e4
LT		 2081 case USB_SPEED_HIGH: /* fixed at 64 */
2082 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2083 break;
2084 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2085 /* to determine the ep0 maxpacket size, try to read
2086 * the device descriptor to get bMaxPacketSize0 and
2087 * then correct our initial guess.
2088 */
2089 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2090 break;
2091 case USB_SPEED_LOW: /* fixed at 8 */
2092 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2093 break;
2094 default:
2095 goto fail;
2096 }
2097
83a07196
IPG		 2098 type = "";
2099 switch (udev->speed) {
2100 case USB_SPEED_LOW: speed = "low"; break;
2101 case USB_SPEED_FULL: speed = "full"; break;
2102 case USB_SPEED_HIGH: speed = "high"; break;
2103 case USB_SPEED_VARIABLE:
2104 speed = "variable";
2105 type = "Wireless ";
2106 break;
2107 default: speed = "?"; break;
2108 }
1da177e4 2109 dev_info (&udev->dev,
83a07196
IPG		 2110 "%s %s speed %sUSB device using %s and address %d\n",
2111 (udev->config) ? "reset" : "new", speed, type,
2112 udev->bus->controller->driver->name, udev->devnum);
1da177e4
LT		 2113
2114 /* Set up TT records, if needed */
2115 if (hdev->tt) {
2116 udev->tt = hdev->tt;
2117 udev->ttport = hdev->ttport;
2118 } else if (udev->speed != USB_SPEED_HIGH
2119 && hdev->speed == USB_SPEED_HIGH) {
2120 udev->tt = &hub->tt;
2121 udev->ttport = port1;
2122 }
2123
2124 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2125 * Because device hardware and firmware is sometimes buggy in
2126 * this area, and this is how Linux has done it for ages.
2127 * Change it cautiously.
2128 *
2129 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2130 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2131 * so it may help with some non-standards-compliant devices.
2132 * Otherwise we start with SET_ADDRESS and then try to read the
2133 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2134 * value.
2135 */
2136 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2137 if (USE_NEW_SCHEME(retry_counter)) {
2138 struct usb_device_descriptor *buf;
2139 int r = 0;
2140
2141#define GET_DESCRIPTOR_BUFSIZE 64
2142 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2143 if (!buf) {
2144 retval = -ENOMEM;
2145 continue;
2146 }
2147
2148 /* Use a short timeout the first time through,
2149 * so that recalcitrant full-speed devices with
2150 * 8- or 16-byte ep0-maxpackets won't slow things
2151 * down tremendously by NAKing the unexpectedly
2152 * early status stage. Also, retry on all errors;
2153 * some devices are flakey.
5bb6e0ae
IPG		 2154 * 255 is for WUSB devices, we actually need to use 512.
2155 * WUSB1.0[4.8.1].
1da177e4
LT		 2156 */
2157 for (j = 0; j < 3; ++j) {
2158 buf->bMaxPacketSize0 = 0;
2159 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2160 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2161 USB_DT_DEVICE << 8, 0,
2162 buf, GET_DESCRIPTOR_BUFSIZE,
2163 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2164 switch (buf->bMaxPacketSize0) {
5bb6e0ae 2165 case 8: case 16: case 32: case 64: case 255:
1da177e4
LT		 2166 if (buf->bDescriptorType ==
2167 USB_DT_DEVICE) {
2168 r = 0;
2169 break;
2170 }
2171 /* FALL THROUGH */
2172 default:
2173 if (r == 0)
2174 r = -EPROTO;
2175 break;
2176 }
2177 if (r == 0)
2178 break;
2179 }
2180 udev->descriptor.bMaxPacketSize0 =
2181 buf->bMaxPacketSize0;
2182 kfree(buf);
2183
2184 retval = hub_port_reset(hub, port1, udev, delay);
2185 if (retval < 0) /* error or disconnect */
2186 goto fail;
2187 if (oldspeed != udev->speed) {
2188 dev_dbg(&udev->dev,
2189 "device reset changed speed!\n");
2190 retval = -ENODEV;
2191 goto fail;
2192 }
2193 if (r) {
2194 dev_err(&udev->dev, "device descriptor "
2195 "read/%s, error %d\n",
2196 "64", r);
2197 retval = -EMSGSIZE;
2198 continue;
2199 }
2200#undef GET_DESCRIPTOR_BUFSIZE
2201 }
2202
2203 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2204 retval = hub_set_address(udev);
2205 if (retval >= 0)
2206 break;
2207 msleep(200);
2208 }
2209 if (retval < 0) {
2210 dev_err(&udev->dev,
2211 "device not accepting address %d, error %d\n",
2212 udev->devnum, retval);
2213 goto fail;
2214 }
2215
2216 /* cope with hardware quirkiness:
2217 * - let SET_ADDRESS settle, some device hardware wants it
2218 * - read ep0 maxpacket even for high and low speed,
2219 */
2220 msleep(10);
2221 if (USE_NEW_SCHEME(retry_counter))
2222 break;
2223
2224 retval = usb_get_device_descriptor(udev, 8);
2225 if (retval < 8) {
2226 dev_err(&udev->dev, "device descriptor "
2227 "read/%s, error %d\n",
2228 "8", retval);
2229 if (retval >= 0)
2230 retval = -EMSGSIZE;
2231 } else {
2232 retval = 0;
2233 break;
2234 }
2235 }
2236 if (retval)
2237 goto fail;
2238
5bb6e0ae
IPG		 2239 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2240 512 : udev->descriptor.bMaxPacketSize0;
1da177e4
LT		 2241 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2242 if (udev->speed != USB_SPEED_FULL ||
2243 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2244 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2245 retval = -EMSGSIZE;
2246 goto fail;
2247 }
2248 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2249 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2250 ep0_reinit(udev);
2251 }
2252
2253 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2254 if (retval < (signed)sizeof(udev->descriptor)) {
2255 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2256 "all", retval);
2257 if (retval >= 0)
2258 retval = -ENOMSG;
2259 goto fail;
2260 }
2261
2262 retval = 0;
2263
2264fail:
2265 if (retval)
2266 hub_port_disable(hub, port1, 0);
4186ecf8 2267 mutex_unlock(&usb_address0_mutex);
1da177e4
LT		 2268 return retval;
2269}
2270
2271static void
2272check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2273{
2274 struct usb_qualifier_descriptor *qual;
2275 int status;
2276
2277 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2278 if (qual == NULL)
2279 return;
2280
2281 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2282 qual, sizeof *qual);
2283 if (status == sizeof *qual) {
2284 dev_info(&udev->dev, "not running at top speed; "
2285 "connect to a high speed hub\n");
2286 /* hub LEDs are probably harder to miss than syslog */
2287 if (hub->has_indicators) {
2288 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2289 schedule_work (&hub->leds);
2290 }
2291 }
1bc3c9e1 2292 kfree(qual);
1da177e4
LT		 2293}
2294
2295static unsigned
2296hub_power_remaining (struct usb_hub *hub)
2297{
2298 struct usb_device *hdev = hub->hdev;
2299 int remaining;
55c52718 2300 int port1;
1da177e4 2301
55c52718 2302 if (!hub->limited_power)
1da177e4
LT		 2303 return 0;
2304
55c52718
AS		 2305 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2306 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2307 struct usb_device *udev = hdev->children[port1 - 1];
2308 int delta;
1da177e4
LT		 2309
2310 if (!udev)
2311 continue;
2312
55c52718
AS		 2313 /* Unconfigured devices may not use more than 100mA,
2314 * or 8mA for OTG ports */
1da177e4 2315 if (udev->actconfig)
55c52718
AS		 2316 delta = udev->actconfig->desc.bMaxPower * 2;
2317 else if (port1 != udev->bus->otg_port || hdev->parent)
2318 delta = 100;
1da177e4 2319 else
55c52718
AS		 2320 delta = 8;
2321 if (delta > hub->mA_per_port)
2322 dev_warn(&udev->dev, "%dmA is over %umA budget "
2323 "for port %d!\n",
2324 delta, hub->mA_per_port, port1);
1da177e4
LT		 2325 remaining -= delta;
2326 }
2327 if (remaining < 0) {
55c52718
AS		 2328 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2329 - remaining);
1da177e4
LT		 2330 remaining = 0;
2331 }
2332 return remaining;
2333}
2334
2335/* Handle physical or logical connection change events.
2336 * This routine is called when:
2337 * a port connection-change occurs;
2338 * a port enable-change occurs (often caused by EMI);
2339 * usb_reset_device() encounters changed descriptors (as from
2340 * a firmware download)
2341 * caller already locked the hub
2342 */
2343static void hub_port_connect_change(struct usb_hub *hub, int port1,
2344 u16 portstatus, u16 portchange)
2345{
2346 struct usb_device *hdev = hub->hdev;
2347 struct device *hub_dev = hub->intfdev;
74ad9bd2 2348 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1da177e4
LT		 2349 int status, i;
2350
2351 dev_dbg (hub_dev,
2352 "port %d, status %04x, change %04x, %s\n",
2353 port1, portstatus, portchange, portspeed (portstatus));
2354
2355 if (hub->has_indicators) {
2356 set_port_led(hub, port1, HUB_LED_AUTO);
2357 hub->indicator[port1-1] = INDICATOR_AUTO;
2358 }
2359
2360 /* Disconnect any existing devices under this port */
2361 if (hdev->children[port1-1])
2362 usb_disconnect(&hdev->children[port1-1]);
2363 clear_bit(port1, hub->change_bits);
2364
2365#ifdef CONFIG_USB_OTG
2366 /* during HNP, don't repeat the debounce */
2367 if (hdev->bus->is_b_host)
2368 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2369#endif
2370
2371 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2372 status = hub_port_debounce(hub, port1);
2373 if (status < 0) {
2374 dev_err (hub_dev,
2375 "connect-debounce failed, port %d disabled\n",
2376 port1);
2377 goto done;
2378 }
2379 portstatus = status;
2380 }
2381
2382 /* Return now if nothing is connected */
2383 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2384
2385 /* maybe switch power back on (e.g. root hub was reset) */
74ad9bd2 2386 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
1da177e4
LT		 2387 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2388 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2389
2390 if (portstatus & USB_PORT_STAT_ENABLE)
2391 goto done;
2392 return;
2393 }
2394
2395#ifdef CONFIG_USB_SUSPEND
2396 /* If something is connected, but the port is suspended, wake it up. */
2397 if (portstatus & USB_PORT_STAT_SUSPEND) {
2398 status = hub_port_resume(hub, port1, NULL);
2399 if (status < 0) {
2400 dev_dbg(hub_dev,
2401 "can't clear suspend on port %d; %d\n",
2402 port1, status);
2403 goto done;
2404 }
2405 }
2406#endif
2407
2408 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2409 struct usb_device *udev;
2410
2411 /* reallocate for each attempt, since references
2412 * to the previous one can escape in various ways
2413 */
2414 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2415 if (!udev) {
2416 dev_err (hub_dev,
2417 "couldn't allocate port %d usb_device\n",
2418 port1);
2419 goto done;
2420 }
2421
2422 usb_set_device_state(udev, USB_STATE_POWERED);
2423 udev->speed = USB_SPEED_UNKNOWN;
55c52718 2424 udev->bus_mA = hub->mA_per_port;
b6956ffa 2425 udev->level = hdev->level + 1;
55c52718 2426
1da177e4
LT		 2427 /* set the address */
2428 choose_address(udev);
2429 if (udev->devnum <= 0) {
2430 status = -ENOTCONN; /* Don't retry */
2431 goto loop;
2432 }
2433
2434 /* reset and get descriptor */
2435 status = hub_port_init(hub, udev, port1, i);
2436 if (status < 0)
2437 goto loop;
2438
2439 /* consecutive bus-powered hubs aren't reliable; they can
2440 * violate the voltage drop budget. if the new child has
2441 * a "powered" LED, users should notice we didn't enable it
2442 * (without reading syslog), even without per-port LEDs
2443 * on the parent.
2444 */
2445 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
55c52718 2446 && udev->bus_mA <= 100) {
1da177e4
LT		 2447 u16 devstat;
2448
2449 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2450 &devstat);
55c52718 2451 if (status < 2) {
1da177e4
LT		 2452 dev_dbg(&udev->dev, "get status %d ?\n", status);
2453 goto loop_disable;
2454 }
55c52718 2455 le16_to_cpus(&devstat);
1da177e4
LT		 2456 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2457 dev_err(&udev->dev,
2458 "can't connect bus-powered hub "
2459 "to this port\n");
2460 if (hub->has_indicators) {
2461 hub->indicator[port1-1] =
2462 INDICATOR_AMBER_BLINK;
2463 schedule_work (&hub->leds);
2464 }
2465 status = -ENOTCONN; /* Don't retry */
2466 goto loop_disable;
2467 }
2468 }
2469
2470 /* check for devices running slower than they could */
2471 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2472 && udev->speed == USB_SPEED_FULL
2473 && highspeed_hubs != 0)
2474 check_highspeed (hub, udev, port1);
2475
2476 /* Store the parent's children[] pointer. At this point
2477 * udev becomes globally accessible, although presumably
2478 * no one will look at it until hdev is unlocked.
2479 */
1da177e4
LT		 2480 status = 0;
2481
2482 /* We mustn't add new devices if the parent hub has
2483 * been disconnected; we would race with the
2484 * recursively_mark_NOTATTACHED() routine.
2485 */
2486 spin_lock_irq(&device_state_lock);
2487 if (hdev->state == USB_STATE_NOTATTACHED)
2488 status = -ENOTCONN;
2489 else
2490 hdev->children[port1-1] = udev;
2491 spin_unlock_irq(&device_state_lock);
2492
2493 /* Run it through the hoops (find a driver, etc) */
2494 if (!status) {
2495 status = usb_new_device(udev);
2496 if (status) {
2497 spin_lock_irq(&device_state_lock);
2498 hdev->children[port1-1] = NULL;
2499 spin_unlock_irq(&device_state_lock);
2500 }
2501 }
2502
1da177e4
LT		 2503 if (status)
2504 goto loop_disable;
2505
2506 status = hub_power_remaining(hub);
2507 if (status)
55c52718 2508 dev_dbg(hub_dev, "%dmA power budget left\n", status);
1da177e4
LT		 2509
2510 return;
2511
2512loop_disable:
2513 hub_port_disable(hub, port1, 1);
2514loop:
2515 ep0_reinit(udev);
2516 release_address(udev);
2517 usb_put_dev(udev);
2518 if (status == -ENOTCONN)
2519 break;
2520 }
2521
2522done:
2523 hub_port_disable(hub, port1, 1);
2524}
2525
2526static void hub_events(void)
2527{
2528 struct list_head *tmp;
2529 struct usb_device *hdev;
2530 struct usb_interface *intf;
2531 struct usb_hub *hub;
2532 struct device *hub_dev;
2533 u16 hubstatus;
2534 u16 hubchange;
2535 u16 portstatus;
2536 u16 portchange;
2537 int i, ret;
2538 int connect_change;
2539
2540 /*
2541 * We restart the list every time to avoid a deadlock with
2542 * deleting hubs downstream from this one. This should be
2543 * safe since we delete the hub from the event list.
2544 * Not the most efficient, but avoids deadlocks.
2545 */
2546 while (1) {
2547
2548 /* Grab the first entry at the beginning of the list */
2549 spin_lock_irq(&hub_event_lock);
2550 if (list_empty(&hub_event_list)) {
2551 spin_unlock_irq(&hub_event_lock);
2552 break;
2553 }
2554
2555 tmp = hub_event_list.next;
2556 list_del_init(tmp);
2557
2558 hub = list_entry(tmp, struct usb_hub, event_list);
2559 hdev = hub->hdev;
2560 intf = to_usb_interface(hub->intfdev);
2561 hub_dev = &intf->dev;
2562
979d5199
DB		 2563 i = hub->resume_root_hub;
2564
2565 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
1da177e4
LT		 2566 hdev->state, hub->descriptor
2567 ? hub->descriptor->bNbrPorts
2568 : 0,
2569 /* NOTE: expects max 15 ports... */
2570 (u16) hub->change_bits[0],
979d5199
DB		 2571 (u16) hub->event_bits[0],
2572 i ? ", resume root" : "");
1da177e4
LT		 2573
2574 usb_get_intf(intf);
1da177e4
LT		 2575 spin_unlock_irq(&hub_event_lock);
2576
1da177e4
LT		 2577 /* Lock the device, then check to see if we were
2578 * disconnected while waiting for the lock to succeed. */
2579 if (locktree(hdev) < 0) {
2580 usb_put_intf(intf);
2581 continue;
2582 }
2583 if (hub != usb_get_intfdata(intf))
2584 goto loop;
2585
2586 /* If the hub has died, clean up after it */
2587 if (hdev->state == USB_STATE_NOTATTACHED) {
7de18d8b
AS		 2588 hub->error = -ENODEV;
2589 hub_pre_reset(intf);
1da177e4
LT		 2590 goto loop;
2591 }
2592
a8e7c565
AS		 2593 /* Is this is a root hub wanting to reactivate the downstream
2594 * ports? If so, be sure the interface resumes even if its
2595 * stub "device" node was never suspended.
2596 */
2597 if (i)
645daaab 2598 usb_autoresume_device(hdev, 0);
a8e7c565 2599
1da177e4
LT		 2600 /* If this is an inactive or suspended hub, do nothing */
2601 if (hub->quiescing)
2602 goto loop;
2603
2604 if (hub->error) {
2605 dev_dbg (hub_dev, "resetting for error %d\n",
2606 hub->error);
2607
7de18d8b 2608 ret = usb_reset_composite_device(hdev, intf);
1da177e4
LT		 2609 if (ret) {
2610 dev_dbg (hub_dev,
2611 "error resetting hub: %d\n", ret);
2612 goto loop;
2613 }
2614
2615 hub->nerrors = 0;
2616 hub->error = 0;
2617 }
2618
2619 /* deal with port status changes */
2620 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2621 if (test_bit(i, hub->busy_bits))
2622 continue;
2623 connect_change = test_bit(i, hub->change_bits);
2624 if (!test_and_clear_bit(i, hub->event_bits) &&
2625 !connect_change && !hub->activating)
2626 continue;
2627
2628 ret = hub_port_status(hub, i,
2629 &portstatus, &portchange);
2630 if (ret < 0)
2631 continue;
2632
2633 if (hub->activating && !hdev->children[i-1] &&
2634 (portstatus &
2635 USB_PORT_STAT_CONNECTION))
2636 connect_change = 1;
2637
2638 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2639 clear_port_feature(hdev, i,
2640 USB_PORT_FEAT_C_CONNECTION);
2641 connect_change = 1;
2642 }
2643
2644 if (portchange & USB_PORT_STAT_C_ENABLE) {
2645 if (!connect_change)
2646 dev_dbg (hub_dev,
2647 "port %d enable change, "
2648 "status %08x\n",
2649 i, portstatus);
2650 clear_port_feature(hdev, i,
2651 USB_PORT_FEAT_C_ENABLE);
2652
2653 /*
2654 * EM interference sometimes causes badly
2655 * shielded USB devices to be shutdown by
2656 * the hub, this hack enables them again.
2657 * Works at least with mouse driver.
2658 */
2659 if (!(portstatus & USB_PORT_STAT_ENABLE)
2660 && !connect_change
2661 && hdev->children[i-1]) {
2662 dev_err (hub_dev,
2663 "port %i "
2664 "disabled by hub (EMI?), "
2665 "re-enabling...\n",
2666 i);
2667 connect_change = 1;
2668 }
2669 }
2670
2671 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2672 clear_port_feature(hdev, i,
2673 USB_PORT_FEAT_C_SUSPEND);
2674 if (hdev->children[i-1]) {
2675 ret = remote_wakeup(hdev->
2676 children[i-1]);
2677 if (ret < 0)
2678 connect_change = 1;
2679 } else {
2680 ret = -ENODEV;
2681 hub_port_disable(hub, i, 1);
2682 }
2683 dev_dbg (hub_dev,
2684 "resume on port %d, status %d\n",
2685 i, ret);
2686 }
2687
2688 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2689 dev_err (hub_dev,
2690 "over-current change on port %d\n",
2691 i);
2692 clear_port_feature(hdev, i,
2693 USB_PORT_FEAT_C_OVER_CURRENT);
2694 hub_power_on(hub);
2695 }
2696
2697 if (portchange & USB_PORT_STAT_C_RESET) {
2698 dev_dbg (hub_dev,
2699 "reset change on port %d\n",
2700 i);
2701 clear_port_feature(hdev, i,
2702 USB_PORT_FEAT_C_RESET);
2703 }
2704
2705 if (connect_change)
2706 hub_port_connect_change(hub, i,
2707 portstatus, portchange);
2708 } /* end for i */
2709
2710 /* deal with hub status changes */
2711 if (test_and_clear_bit(0, hub->event_bits) == 0)
2712 ; /* do nothing */
2713 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2714 dev_err (hub_dev, "get_hub_status failed\n");
2715 else {
2716 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2717 dev_dbg (hub_dev, "power change\n");
2718 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
55c52718
AS		 2719 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2720 /* FIXME: Is this always true? */
2721 hub->limited_power = 0;
2722 else
2723 hub->limited_power = 1;
1da177e4
LT		 2724 }
2725 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2726 dev_dbg (hub_dev, "overcurrent change\n");
2727 msleep(500); /* Cool down */
2728 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2729 hub_power_on(hub);
2730 }
2731 }
2732
2733 hub->activating = 0;
2734
d5926ae7
AS		 2735 /* If this is a root hub, tell the HCD it's okay to
2736 * re-enable port-change interrupts now. */
d5cbad4b 2737 if (!hdev->parent && !hub->busy_bits[0])
d5926ae7
AS		 2738 usb_enable_root_hub_irq(hdev->bus);
2739
1da177e4
LT		 2740loop:
2741 usb_unlock_device(hdev);
2742 usb_put_intf(intf);
2743
2744 } /* end while (1) */
2745}
2746
2747static int hub_thread(void *__unused)
2748{
1da177e4
LT		 2749 do {
2750 hub_events();
9c8d6178 2751 wait_event_interruptible(khubd_wait,
2752 !list_empty(&hub_event_list) ||
2753 kthread_should_stop());
3e1d1d28 2754 try_to_freeze();
9c8d6178 2755 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
1da177e4 2756
9c8d6178 2757 pr_debug("%s: khubd exiting\n", usbcore_name);
2758 return 0;
1da177e4
LT		 2759}
2760
2761static struct usb_device_id hub_id_table [] = {
2762 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2763 .bDeviceClass = USB_CLASS_HUB},
2764 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2765 .bInterfaceClass = USB_CLASS_HUB},
2766 { } /* Terminating entry */
2767};
2768
2769MODULE_DEVICE_TABLE (usb, hub_id_table);
2770
2771static struct usb_driver hub_driver = {
1da177e4
LT		 2772 .name = "hub",
2773 .probe = hub_probe,
2774 .disconnect = hub_disconnect,
2775 .suspend = hub_suspend,
2776 .resume = hub_resume,
7de18d8b
AS		 2777 .pre_reset = hub_pre_reset,
2778 .post_reset = hub_post_reset,
1da177e4
LT		 2779 .ioctl = hub_ioctl,
2780 .id_table = hub_id_table,
2781};
2782
2783int usb_hub_init(void)
2784{
1da177e4
LT		 2785 if (usb_register(&hub_driver) < 0) {
2786 printk(KERN_ERR "%s: can't register hub driver\n",
2787 usbcore_name);
2788 return -1;
2789 }
2790
9c8d6178 2791 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2792 if (!IS_ERR(khubd_task))
1da177e4 2793 return 0;
1da177e4
LT		 2794
2795 /* Fall through if kernel_thread failed */
2796 usb_deregister(&hub_driver);
2797 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2798
2799 return -1;
2800}
2801
2802void usb_hub_cleanup(void)
2803{
9c8d6178 2804 kthread_stop(khubd_task);
1da177e4
LT		 2805
2806 /*
2807 * Hub resources are freed for us by usb_deregister. It calls
2808 * usb_driver_purge on every device which in turn calls that
2809 * devices disconnect function if it is using this driver.
2810 * The hub_disconnect function takes care of releasing the
2811 * individual hub resources. -greg
2812 */
2813 usb_deregister(&hub_driver);
2814} /* usb_hub_cleanup() */
2815
1da177e4
LT		 2816static int config_descriptors_changed(struct usb_device *udev)
2817{
2818 unsigned index;
2819 unsigned len = 0;
2820 struct usb_config_descriptor *buf;
2821
2822 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2823 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2824 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2825 }
2826 buf = kmalloc (len, SLAB_KERNEL);
2827 if (buf == NULL) {
2828 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2829 /* assume the worst */
2830 return 1;
2831 }
2832 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2833 int length;
2834 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2835
2836 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2837 old_length);
2838 if (length < old_length) {
2839 dev_dbg(&udev->dev, "config index %d, error %d\n",
2840 index, length);
2841 break;
2842 }
2843 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2844 != 0) {
2845 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2846 index, buf->bConfigurationValue);
2847 break;
2848 }
2849 }
2850 kfree(buf);
2851 return index != udev->descriptor.bNumConfigurations;
2852}
2853
2854/**
2855 * usb_reset_device - perform a USB port reset to reinitialize a device
2856 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2857 *
79efa097
AS		 2858 * WARNING - don't use this routine to reset a composite device
2859 * (one with multiple interfaces owned by separate drivers)!
2860 * Use usb_reset_composite_device() instead.
1da177e4
LT		 2861 *
2862 * Do a port reset, reassign the device's address, and establish its
2863 * former operating configuration. If the reset fails, or the device's
2864 * descriptors change from their values before the reset, or the original
2865 * configuration and altsettings cannot be restored, a flag will be set
2866 * telling khubd to pretend the device has been disconnected and then
2867 * re-connected. All drivers will be unbound, and the device will be
2868 * re-enumerated and probed all over again.
2869 *
2870 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2871 * flagged for logical disconnection, or some other negative error code
2872 * if the reset wasn't even attempted.
2873 *
2874 * The caller must own the device lock. For example, it's safe to use
2875 * this from a driver probe() routine after downloading new firmware.
2876 * For calls that might not occur during probe(), drivers should lock
2877 * the device using usb_lock_device_for_reset().
2878 */
2879int usb_reset_device(struct usb_device *udev)
2880{
2881 struct usb_device *parent_hdev = udev->parent;
2882 struct usb_hub *parent_hub;
2883 struct usb_device_descriptor descriptor = udev->descriptor;
12c3da34
AS		 2884 int i, ret = 0;
2885 int port1 = udev->portnum;
1da177e4
LT		 2886
2887 if (udev->state == USB_STATE_NOTATTACHED ||
2888 udev->state == USB_STATE_SUSPENDED) {
2889 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2890 udev->state);
2891 return -EINVAL;
2892 }
2893
2894 if (!parent_hdev) {
2895 /* this requires hcd-specific logic; see OHCI hc_restart() */
2896 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2897 return -EISDIR;
2898 }
1da177e4
LT		 2899 parent_hub = hdev_to_hub(parent_hdev);
2900
1da177e4
LT		 2901 set_bit(port1, parent_hub->busy_bits);
2902 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2903
2904 /* ep0 maxpacket size may change; let the HCD know about it.
2905 * Other endpoints will be handled by re-enumeration. */
2906 ep0_reinit(udev);
2907 ret = hub_port_init(parent_hub, udev, port1, i);
2908 if (ret >= 0)
2909 break;
2910 }
2911 clear_bit(port1, parent_hub->busy_bits);
d5cbad4b
AS		 2912 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2913 usb_enable_root_hub_irq(parent_hdev->bus);
2914
1da177e4
LT		 2915 if (ret < 0)
2916 goto re_enumerate;
2917
2918 /* Device might have changed firmware (DFU or similar) */
2919 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2920 || config_descriptors_changed (udev)) {
2921 dev_info(&udev->dev, "device firmware changed\n");
2922 udev->descriptor = descriptor; /* for disconnect() calls */
2923 goto re_enumerate;
2924 }
2925
2926 if (!udev->actconfig)
2927 goto done;
2928
2929 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2930 USB_REQ_SET_CONFIGURATION, 0,
2931 udev->actconfig->desc.bConfigurationValue, 0,
2932 NULL, 0, USB_CTRL_SET_TIMEOUT);
2933 if (ret < 0) {
2934 dev_err(&udev->dev,
2935 "can't restore configuration #%d (error=%d)\n",
2936 udev->actconfig->desc.bConfigurationValue, ret);
2937 goto re_enumerate;
2938 }
2939 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2940
2941 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2942 struct usb_interface *intf = udev->actconfig->interface[i];
2943 struct usb_interface_descriptor *desc;
2944
2945 /* set_interface resets host side toggle even
2946 * for altsetting zero. the interface may have no driver.
2947 */
2948 desc = &intf->cur_altsetting->desc;
2949 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2950 desc->bAlternateSetting);
2951 if (ret < 0) {
2952 dev_err(&udev->dev, "failed to restore interface %d "
2953 "altsetting %d (error=%d)\n",
2954 desc->bInterfaceNumber,
2955 desc->bAlternateSetting,
2956 ret);
2957 goto re_enumerate;
2958 }
2959 }
2960
2961done:
1da177e4
LT		 2962 return 0;
2963
2964re_enumerate:
2965 hub_port_logical_disconnect(parent_hub, port1);
2966 return -ENODEV;
2967}
140d8f68 2968EXPORT_SYMBOL(usb_reset_device);
79efa097
AS		 2969
2970/**
2971 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
2972 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2973 * @iface: interface bound to the driver making the request (optional)
2974 *
2975 * Warns all drivers bound to registered interfaces (using their pre_reset
2976 * method), performs the port reset, and then lets the drivers know that
2977 * the reset is over (using their post_reset method).
2978 *
2979 * Return value is the same as for usb_reset_device().
2980 *
2981 * The caller must own the device lock. For example, it's safe to use
2982 * this from a driver probe() routine after downloading new firmware.
2983 * For calls that might not occur during probe(), drivers should lock
2984 * the device using usb_lock_device_for_reset().
2985 *
2986 * The interface locks are acquired during the pre_reset stage and released
2987 * during the post_reset stage. However if iface is not NULL and is
2988 * currently being probed, we assume that the caller already owns its
2989 * lock.
2990 */
2991int usb_reset_composite_device(struct usb_device *udev,
2992 struct usb_interface *iface)
2993{
2994 int ret;
2995 struct usb_host_config *config = udev->actconfig;
2996
2997 if (udev->state == USB_STATE_NOTATTACHED ||
2998 udev->state == USB_STATE_SUSPENDED) {
2999 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3000 udev->state);
3001 return -EINVAL;
3002 }
3003
645daaab
AS		 3004 /* Prevent autosuspend during the reset */
3005 usb_autoresume_device(udev, 1);
3006
79efa097
AS		 3007 if (iface && iface->condition != USB_INTERFACE_BINDING)
3008 iface = NULL;
3009
3010 if (config) {
3011 int i;
3012 struct usb_interface *cintf;
3013 struct usb_driver *drv;
3014
3015 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3016 cintf = config->interface[i];
3017 if (cintf != iface)
3018 down(&cintf->dev.sem);
3019 if (device_is_registered(&cintf->dev) &&
3020 cintf->dev.driver) {
3021 drv = to_usb_driver(cintf->dev.driver);
3022 if (drv->pre_reset)
3023 (drv->pre_reset)(cintf);
3024 }
3025 }
3026 }
3027
3028 ret = usb_reset_device(udev);
3029
3030 if (config) {
3031 int i;
3032 struct usb_interface *cintf;
3033 struct usb_driver *drv;
3034
3035 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3036 cintf = config->interface[i];
3037 if (device_is_registered(&cintf->dev) &&
3038 cintf->dev.driver) {
3039 drv = to_usb_driver(cintf->dev.driver);
3040 if (drv->post_reset)
3041 (drv->post_reset)(cintf);
3042 }
3043 if (cintf != iface)
3044 up(&cintf->dev.sem);
3045 }
3046 }
3047
645daaab 3048 usb_autosuspend_device(udev, 1);
79efa097
AS		 3049 return ret;
3050}
140d8f68 3051EXPORT_SYMBOL(usb_reset_composite_device);
Ubuntu Jammy Linux kernel mirror