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