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