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