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