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