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