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