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