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