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