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