USB: move bus_suspend and bus_resume method calls
[safe/jmp/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         spin_lock_irqsave(&device_state_lock, flags);
1113         hub = hdev_to_hub(rhdev);
1114         for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1115                 if (rhdev->children[port1 - 1]) {
1116                         recursively_mark_NOTATTACHED(
1117                                         rhdev->children[port1 - 1]);
1118                         set_bit(port1, hub->change_bits);
1119                 }
1120         }
1121         spin_unlock_irqrestore(&device_state_lock, flags);
1122 }
1123 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1124
1125 #endif  /* CONFIG_PM */
1126
1127 static void choose_address(struct usb_device *udev)
1128 {
1129         int             devnum;
1130         struct usb_bus  *bus = udev->bus;
1131
1132         /* If khubd ever becomes multithreaded, this will need a lock */
1133
1134         /* Try to allocate the next devnum beginning at bus->devnum_next. */
1135         devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1136                         bus->devnum_next);
1137         if (devnum >= 128)
1138                 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1139
1140         bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1141
1142         if (devnum < 128) {
1143                 set_bit(devnum, bus->devmap.devicemap);
1144                 udev->devnum = devnum;
1145         }
1146 }
1147
1148 static void release_address(struct usb_device *udev)
1149 {
1150         if (udev->devnum > 0) {
1151                 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1152                 udev->devnum = -1;
1153         }
1154 }
1155
1156 #ifdef  CONFIG_USB_SUSPEND
1157
1158 static void usb_stop_pm(struct usb_device *udev)
1159 {
1160         /* Synchronize with the ksuspend thread to prevent any more
1161          * autosuspend requests from being submitted, and decrement
1162          * the parent's count of unsuspended children.
1163          */
1164         usb_pm_lock(udev);
1165         if (udev->parent && !udev->discon_suspended)
1166                 usb_autosuspend_device(udev->parent);
1167         usb_pm_unlock(udev);
1168
1169         /* Stop any autosuspend requests already submitted */
1170         cancel_rearming_delayed_work(&udev->autosuspend);
1171 }
1172
1173 #else
1174
1175 static inline void usb_stop_pm(struct usb_device *udev)
1176 { }
1177
1178 #endif
1179
1180 /**
1181  * usb_disconnect - disconnect a device (usbcore-internal)
1182  * @pdev: pointer to device being disconnected
1183  * Context: !in_interrupt ()
1184  *
1185  * Something got disconnected. Get rid of it and all of its children.
1186  *
1187  * If *pdev is a normal device then the parent hub must already be locked.
1188  * If *pdev is a root hub then this routine will acquire the
1189  * usb_bus_list_lock on behalf of the caller.
1190  *
1191  * Only hub drivers (including virtual root hub drivers for host
1192  * controllers) should ever call this.
1193  *
1194  * This call is synchronous, and may not be used in an interrupt context.
1195  */
1196 void usb_disconnect(struct usb_device **pdev)
1197 {
1198         struct usb_device       *udev = *pdev;
1199         int                     i;
1200
1201         if (!udev) {
1202                 pr_debug ("%s nodev\n", __FUNCTION__);
1203                 return;
1204         }
1205
1206         /* mark the device as inactive, so any further urb submissions for
1207          * this device (and any of its children) will fail immediately.
1208          * this quiesces everyting except pending urbs.
1209          */
1210         usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1211         dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1212
1213         usb_lock_device(udev);
1214
1215         /* Free up all the children before we remove this device */
1216         for (i = 0; i < USB_MAXCHILDREN; i++) {
1217                 if (udev->children[i])
1218                         usb_disconnect(&udev->children[i]);
1219         }
1220
1221         /* deallocate hcd/hardware state ... nuking all pending urbs and
1222          * cleaning up all state associated with the current configuration
1223          * so that the hardware is now fully quiesced.
1224          */
1225         dev_dbg (&udev->dev, "unregistering device\n");
1226         usb_disable_device(udev, 0);
1227
1228         usb_unlock_device(udev);
1229
1230         /* Unregister the device.  The device driver is responsible
1231          * for removing the device files from usbfs and sysfs and for
1232          * de-configuring the device.
1233          */
1234         device_del(&udev->dev);
1235
1236         /* Free the device number and delete the parent's children[]
1237          * (or root_hub) pointer.
1238          */
1239         release_address(udev);
1240
1241         /* Avoid races with recursively_mark_NOTATTACHED() */
1242         spin_lock_irq(&device_state_lock);
1243         *pdev = NULL;
1244         spin_unlock_irq(&device_state_lock);
1245
1246         usb_stop_pm(udev);
1247
1248         put_device(&udev->dev);
1249 }
1250
1251 #ifdef DEBUG
1252 static void show_string(struct usb_device *udev, char *id, char *string)
1253 {
1254         if (!string)
1255                 return;
1256         dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1257 }
1258
1259 #else
1260 static inline void show_string(struct usb_device *udev, char *id, char *string)
1261 {}
1262 #endif
1263
1264
1265 #ifdef  CONFIG_USB_OTG
1266 #include "otg_whitelist.h"
1267 static int __usb_port_suspend(struct usb_device *, int port1);
1268 #endif
1269
1270 /**
1271  * usb_new_device - perform initial device setup (usbcore-internal)
1272  * @udev: newly addressed device (in ADDRESS state)
1273  *
1274  * This is called with devices which have been enumerated, but not yet
1275  * configured.  The device descriptor is available, but not descriptors
1276  * for any device configuration.  The caller must have locked either
1277  * the parent hub (if udev is a normal device) or else the
1278  * usb_bus_list_lock (if udev is a root hub).  The parent's pointer to
1279  * udev has already been installed, but udev is not yet visible through
1280  * sysfs or other filesystem code.
1281  *
1282  * It will return if the device is configured properly or not.  Zero if
1283  * the interface was registered with the driver core; else a negative
1284  * errno value.
1285  *
1286  * This call is synchronous, and may not be used in an interrupt context.
1287  *
1288  * Only the hub driver or root-hub registrar should ever call this.
1289  */
1290 int usb_new_device(struct usb_device *udev)
1291 {
1292         int err;
1293
1294         /* Determine quirks */
1295         usb_detect_quirks(udev);
1296
1297         err = usb_get_configuration(udev);
1298         if (err < 0) {
1299                 dev_err(&udev->dev, "can't read configurations, error %d\n",
1300                         err);
1301                 goto fail;
1302         }
1303
1304         /* read the standard strings and cache them if present */
1305         udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1306         udev->manufacturer = usb_cache_string(udev,
1307                         udev->descriptor.iManufacturer);
1308         udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1309
1310         /* Tell the world! */
1311         dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1312                         "SerialNumber=%d\n",
1313                         udev->descriptor.iManufacturer,
1314                         udev->descriptor.iProduct,
1315                         udev->descriptor.iSerialNumber);
1316         show_string(udev, "Product", udev->product);
1317         show_string(udev, "Manufacturer", udev->manufacturer);
1318         show_string(udev, "SerialNumber", udev->serial);
1319
1320 #ifdef  CONFIG_USB_OTG
1321         /*
1322          * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1323          * to wake us after we've powered off VBUS; and HNP, switching roles
1324          * "host" to "peripheral".  The OTG descriptor helps figure this out.
1325          */
1326         if (!udev->bus->is_b_host
1327                         && udev->config
1328                         && udev->parent == udev->bus->root_hub) {
1329                 struct usb_otg_descriptor       *desc = 0;
1330                 struct usb_bus                  *bus = udev->bus;
1331
1332                 /* descriptor may appear anywhere in config */
1333                 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1334                                         le16_to_cpu(udev->config[0].desc.wTotalLength),
1335                                         USB_DT_OTG, (void **) &desc) == 0) {
1336                         if (desc->bmAttributes & USB_OTG_HNP) {
1337                                 unsigned                port1 = udev->portnum;
1338
1339                                 dev_info(&udev->dev,
1340                                         "Dual-Role OTG device on %sHNP port\n",
1341                                         (port1 == bus->otg_port)
1342                                                 ? "" : "non-");
1343
1344                                 /* enable HNP before suspend, it's simpler */
1345                                 if (port1 == bus->otg_port)
1346                                         bus->b_hnp_enable = 1;
1347                                 err = usb_control_msg(udev,
1348                                         usb_sndctrlpipe(udev, 0),
1349                                         USB_REQ_SET_FEATURE, 0,
1350                                         bus->b_hnp_enable
1351                                                 ? USB_DEVICE_B_HNP_ENABLE
1352                                                 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1353                                         0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1354                                 if (err < 0) {
1355                                         /* OTG MESSAGE: report errors here,
1356                                          * customize to match your product.
1357                                          */
1358                                         dev_info(&udev->dev,
1359                                                 "can't set HNP mode; %d\n",
1360                                                 err);
1361                                         bus->b_hnp_enable = 0;
1362                                 }
1363                         }
1364                 }
1365         }
1366
1367         if (!is_targeted(udev)) {
1368
1369                 /* Maybe it can talk to us, though we can't talk to it.
1370                  * (Includes HNP test device.)
1371                  */
1372                 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1373                         err = __usb_port_suspend(udev, udev->bus->otg_port);
1374                         if (err < 0)
1375                                 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1376                 }
1377                 err = -ENODEV;
1378                 goto fail;
1379         }
1380 #endif
1381
1382         /* export the usbdev device-node for libusb */
1383         udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1384                         (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1385
1386         /* Register the device.  The device driver is responsible
1387          * for adding the device files to sysfs and for configuring
1388          * the device.
1389          */
1390         err = device_add(&udev->dev);
1391         if (err) {
1392                 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1393                 goto fail;
1394         }
1395
1396         /* Increment the parent's count of unsuspended children */
1397         if (udev->parent)
1398                 usb_autoresume_device(udev->parent);
1399
1400 exit:
1401         return err;
1402
1403 fail:
1404         usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1405         goto exit;
1406 }
1407
1408 static int hub_port_status(struct usb_hub *hub, int port1,
1409                                u16 *status, u16 *change)
1410 {
1411         int ret;
1412
1413         mutex_lock(&hub->status_mutex);
1414         ret = get_port_status(hub->hdev, port1, &hub->status->port);
1415         if (ret < 4) {
1416                 dev_err (hub->intfdev,
1417                         "%s failed (err = %d)\n", __FUNCTION__, ret);
1418                 if (ret >= 0)
1419                         ret = -EIO;
1420         } else {
1421                 *status = le16_to_cpu(hub->status->port.wPortStatus);
1422                 *change = le16_to_cpu(hub->status->port.wPortChange); 
1423                 ret = 0;
1424         }
1425         mutex_unlock(&hub->status_mutex);
1426         return ret;
1427 }
1428
1429
1430 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1431 static unsigned hub_is_wusb(struct usb_hub *hub)
1432 {
1433         struct usb_hcd *hcd;
1434         if (hub->hdev->parent != NULL)  /* not a root hub? */
1435                 return 0;
1436         hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1437         return hcd->wireless;
1438 }
1439
1440
1441 #define PORT_RESET_TRIES        5
1442 #define SET_ADDRESS_TRIES       2
1443 #define GET_DESCRIPTOR_TRIES    2
1444 #define SET_CONFIG_TRIES        (2 * (use_both_schemes + 1))
1445 #define USE_NEW_SCHEME(i)       ((i) / 2 == old_scheme_first)
1446
1447 #define HUB_ROOT_RESET_TIME     50      /* times are in msec */
1448 #define HUB_SHORT_RESET_TIME    10
1449 #define HUB_LONG_RESET_TIME     200
1450 #define HUB_RESET_TIMEOUT       500
1451
1452 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1453                                 struct usb_device *udev, unsigned int delay)
1454 {
1455         int delay_time, ret;
1456         u16 portstatus;
1457         u16 portchange;
1458
1459         for (delay_time = 0;
1460                         delay_time < HUB_RESET_TIMEOUT;
1461                         delay_time += delay) {
1462                 /* wait to give the device a chance to reset */
1463                 msleep(delay);
1464
1465                 /* read and decode port status */
1466                 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1467                 if (ret < 0)
1468                         return ret;
1469
1470                 /* Device went away? */
1471                 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1472                         return -ENOTCONN;
1473
1474                 /* bomb out completely if something weird happened */
1475                 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1476                         return -EINVAL;
1477
1478                 /* if we`ve finished resetting, then break out of the loop */
1479                 if (!(portstatus & USB_PORT_STAT_RESET) &&
1480                     (portstatus & USB_PORT_STAT_ENABLE)) {
1481                         if (hub_is_wusb(hub))
1482                                 udev->speed = USB_SPEED_VARIABLE;
1483                         else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1484                                 udev->speed = USB_SPEED_HIGH;
1485                         else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1486                                 udev->speed = USB_SPEED_LOW;
1487                         else
1488                                 udev->speed = USB_SPEED_FULL;
1489                         return 0;
1490                 }
1491
1492                 /* switch to the long delay after two short delay failures */
1493                 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1494                         delay = HUB_LONG_RESET_TIME;
1495
1496                 dev_dbg (hub->intfdev,
1497                         "port %d not reset yet, waiting %dms\n",
1498                         port1, delay);
1499         }
1500
1501         return -EBUSY;
1502 }
1503
1504 static int hub_port_reset(struct usb_hub *hub, int port1,
1505                                 struct usb_device *udev, unsigned int delay)
1506 {
1507         int i, status;
1508
1509         /* Reset the port */
1510         for (i = 0; i < PORT_RESET_TRIES; i++) {
1511                 status = set_port_feature(hub->hdev,
1512                                 port1, USB_PORT_FEAT_RESET);
1513                 if (status)
1514                         dev_err(hub->intfdev,
1515                                         "cannot reset port %d (err = %d)\n",
1516                                         port1, status);
1517                 else {
1518                         status = hub_port_wait_reset(hub, port1, udev, delay);
1519                         if (status && status != -ENOTCONN)
1520                                 dev_dbg(hub->intfdev,
1521                                                 "port_wait_reset: err = %d\n",
1522                                                 status);
1523                 }
1524
1525                 /* return on disconnect or reset */
1526                 switch (status) {
1527                 case 0:
1528                         /* TRSTRCY = 10 ms; plus some extra */
1529                         msleep(10 + 40);
1530                         /* FALL THROUGH */
1531                 case -ENOTCONN:
1532                 case -ENODEV:
1533                         clear_port_feature(hub->hdev,
1534                                 port1, USB_PORT_FEAT_C_RESET);
1535                         /* FIXME need disconnect() for NOTATTACHED device */
1536                         usb_set_device_state(udev, status
1537                                         ? USB_STATE_NOTATTACHED
1538                                         : USB_STATE_DEFAULT);
1539                         return status;
1540                 }
1541
1542                 dev_dbg (hub->intfdev,
1543                         "port %d not enabled, trying reset again...\n",
1544                         port1);
1545                 delay = HUB_LONG_RESET_TIME;
1546         }
1547
1548         dev_err (hub->intfdev,
1549                 "Cannot enable port %i.  Maybe the USB cable is bad?\n",
1550                 port1);
1551
1552         return status;
1553 }
1554
1555 /*
1556  * Disable a port and mark a logical connnect-change event, so that some
1557  * time later khubd will disconnect() any existing usb_device on the port
1558  * and will re-enumerate if there actually is a device attached.
1559  */
1560 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1561 {
1562         dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1563         hub_port_disable(hub, port1, 1);
1564
1565         /* FIXME let caller ask to power down the port:
1566          *  - some devices won't enumerate without a VBUS power cycle
1567          *  - SRP saves power that way
1568          *  - ... new call, TBD ...
1569          * That's easy if this hub can switch power per-port, and
1570          * khubd reactivates the port later (timer, SRP, etc).
1571          * Powerdown must be optional, because of reset/DFU.
1572          */
1573
1574         set_bit(port1, hub->change_bits);
1575         kick_khubd(hub);
1576 }
1577
1578 #ifdef  CONFIG_PM
1579
1580 #ifdef  CONFIG_USB_SUSPEND
1581
1582 /*
1583  * Selective port suspend reduces power; most suspended devices draw
1584  * less than 500 uA.  It's also used in OTG, along with remote wakeup.
1585  * All devices below the suspended port are also suspended.
1586  *
1587  * Devices leave suspend state when the host wakes them up.  Some devices
1588  * also support "remote wakeup", where the device can activate the USB
1589  * tree above them to deliver data, such as a keypress or packet.  In
1590  * some cases, this wakes the USB host.
1591  */
1592 static int hub_port_suspend(struct usb_hub *hub, int port1,
1593                 struct usb_device *udev)
1594 {
1595         int     status;
1596
1597         // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1598
1599         /* enable remote wakeup when appropriate; this lets the device
1600          * wake up the upstream hub (including maybe the root hub).
1601          *
1602          * NOTE:  OTG devices may issue remote wakeup (or SRP) even when
1603          * we don't explicitly enable it here.
1604          */
1605         if (udev->do_remote_wakeup) {
1606                 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1607                                 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1608                                 USB_DEVICE_REMOTE_WAKEUP, 0,
1609                                 NULL, 0,
1610                                 USB_CTRL_SET_TIMEOUT);
1611                 if (status)
1612                         dev_dbg(&udev->dev,
1613                                 "won't remote wakeup, status %d\n",
1614                                 status);
1615         }
1616
1617         /* see 7.1.7.6 */
1618         status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1619         if (status) {
1620                 dev_dbg(hub->intfdev,
1621                         "can't suspend port %d, status %d\n",
1622                         port1, status);
1623                 /* paranoia:  "should not happen" */
1624                 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1625                                 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1626                                 USB_DEVICE_REMOTE_WAKEUP, 0,
1627                                 NULL, 0,
1628                                 USB_CTRL_SET_TIMEOUT);
1629         } else {
1630                 /* device has up to 10 msec to fully suspend */
1631                 dev_dbg(&udev->dev, "usb %ssuspend\n",
1632                                 udev->auto_pm ? "auto-" : "");
1633                 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1634                 msleep(10);
1635         }
1636         return status;
1637 }
1638
1639 /*
1640  * Devices on USB hub ports have only one "suspend" state, corresponding
1641  * to ACPI D2, "may cause the device to lose some context".
1642  * State transitions include:
1643  *
1644  *   - suspend, resume ... when the VBUS power link stays live
1645  *   - suspend, disconnect ... VBUS lost
1646  *
1647  * Once VBUS drop breaks the circuit, the port it's using has to go through
1648  * normal re-enumeration procedures, starting with enabling VBUS power.
1649  * Other than re-initializing the hub (plug/unplug, except for root hubs),
1650  * Linux (2.6) currently has NO mechanisms to initiate that:  no khubd
1651  * timer, no SRP, no requests through sysfs.
1652  *
1653  * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1654  * the root hub for their bus goes into global suspend ... so we don't
1655  * (falsely) update the device power state to say it suspended.
1656  */
1657 static int __usb_port_suspend (struct usb_device *udev, int port1)
1658 {
1659         int     status = 0;
1660
1661         /* caller owns the udev device lock */
1662         if (port1 < 0)
1663                 return port1;
1664
1665         /* we change the device's upstream USB link,
1666          * but root hubs have no upstream USB link.
1667          */
1668         if (udev->parent)
1669                 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1670                                 udev);
1671         else {
1672                 dev_dbg(&udev->dev, "usb %ssuspend\n",
1673                                 udev->auto_pm ? "auto-" : "");
1674                 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1675         }
1676         return status;
1677 }
1678
1679 /*
1680  * usb_port_suspend - suspend a usb device's upstream port
1681  * @udev: device that's no longer in active use
1682  * Context: must be able to sleep; device not locked; pm locks held
1683  *
1684  * Suspends a USB device that isn't in active use, conserving power.
1685  * Devices may wake out of a suspend, if anything important happens,
1686  * using the remote wakeup mechanism.  They may also be taken out of
1687  * suspend by the host, using usb_port_resume().  It's also routine
1688  * to disconnect devices while they are suspended.
1689  *
1690  * This only affects the USB hardware for a device; its interfaces
1691  * (and, for hubs, child devices) must already have been suspended.
1692  *
1693  * Suspending OTG devices may trigger HNP, if that's been enabled
1694  * between a pair of dual-role devices.  That will change roles, such
1695  * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1696  *
1697  * Returns 0 on success, else negative errno.
1698  */
1699 int usb_port_suspend(struct usb_device *udev)
1700 {
1701         return __usb_port_suspend(udev, udev->portnum);
1702 }
1703
1704 /*
1705  * If the USB "suspend" state is in use (rather than "global suspend"),
1706  * many devices will be individually taken out of suspend state using
1707  * special" resume" signaling.  These routines kick in shortly after
1708  * hardware resume signaling is finished, either because of selective
1709  * resume (by host) or remote wakeup (by device) ... now see what changed
1710  * in the tree that's rooted at this device.
1711  */
1712 static int finish_port_resume(struct usb_device *udev)
1713 {
1714         int     status;
1715         u16     devstatus;
1716
1717         /* caller owns the udev device lock */
1718         dev_dbg(&udev->dev, "finish resume\n");
1719
1720         /* usb ch9 identifies four variants of SUSPENDED, based on what
1721          * state the device resumes to.  Linux currently won't see the
1722          * first two on the host side; they'd be inside hub_port_init()
1723          * during many timeouts, but khubd can't suspend until later.
1724          */
1725         usb_set_device_state(udev, udev->actconfig
1726                         ? USB_STATE_CONFIGURED
1727                         : USB_STATE_ADDRESS);
1728
1729         /* 10.5.4.5 says be sure devices in the tree are still there.
1730          * For now let's assume the device didn't go crazy on resume,
1731          * and device drivers will know about any resume quirks.
1732          */
1733         status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1734         if (status >= 0)
1735                 status = (status == 2 ? 0 : -ENODEV);
1736
1737         if (status)
1738                 dev_dbg(&udev->dev,
1739                         "gone after usb resume? status %d\n",
1740                         status);
1741         else if (udev->actconfig) {
1742                 le16_to_cpus(&devstatus);
1743                 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1744                                 && udev->parent) {
1745                         status = usb_control_msg(udev,
1746                                         usb_sndctrlpipe(udev, 0),
1747                                         USB_REQ_CLEAR_FEATURE,
1748                                                 USB_RECIP_DEVICE,
1749                                         USB_DEVICE_REMOTE_WAKEUP, 0,
1750                                         NULL, 0,
1751                                         USB_CTRL_SET_TIMEOUT);
1752                         if (status)
1753                                 dev_dbg(&udev->dev, "disable remote "
1754                                         "wakeup, status %d\n", status);
1755                 }
1756                 status = 0;
1757
1758         } else if (udev->devnum <= 0) {
1759                 dev_dbg(&udev->dev, "bogus resume!\n");
1760                 status = -EINVAL;
1761         }
1762         return status;
1763 }
1764
1765 static int
1766 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1767 {
1768         int     status;
1769         u16     portchange, portstatus;
1770
1771         /* Skip the initial Clear-Suspend step for a remote wakeup */
1772         status = hub_port_status(hub, port1, &portstatus, &portchange);
1773         if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1774                 goto SuspendCleared;
1775
1776         // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1777
1778         set_bit(port1, hub->busy_bits);
1779
1780         /* see 7.1.7.7; affects power usage, but not budgeting */
1781         status = clear_port_feature(hub->hdev,
1782                         port1, USB_PORT_FEAT_SUSPEND);
1783         if (status) {
1784                 dev_dbg(hub->intfdev,
1785                         "can't resume port %d, status %d\n",
1786                         port1, status);
1787         } else {
1788                 /* drive resume for at least 20 msec */
1789                 if (udev)
1790                         dev_dbg(&udev->dev, "usb %sresume\n",
1791                                         udev->auto_pm ? "auto-" : "");
1792                 msleep(25);
1793
1794 #define LIVE_FLAGS      ( USB_PORT_STAT_POWER \
1795                         | USB_PORT_STAT_ENABLE \
1796                         | USB_PORT_STAT_CONNECTION)
1797
1798                 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1799                  * stop resume signaling.  Then finish the resume
1800                  * sequence.
1801                  */
1802                 status = hub_port_status(hub, port1, &portstatus, &portchange);
1803 SuspendCleared:
1804                 if (status < 0
1805                                 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1806                                 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
1807                                 ) {
1808                         dev_dbg(hub->intfdev,
1809                                 "port %d status %04x.%04x after resume, %d\n",
1810                                 port1, portchange, portstatus, status);
1811                         if (status >= 0)
1812                                 status = -ENODEV;
1813                 } else {
1814                         if (portchange & USB_PORT_STAT_C_SUSPEND)
1815                                 clear_port_feature(hub->hdev, port1,
1816                                                 USB_PORT_FEAT_C_SUSPEND);
1817                         /* TRSMRCY = 10 msec */
1818                         msleep(10);
1819                         if (udev)
1820                                 status = finish_port_resume(udev);
1821                 }
1822         }
1823         if (status < 0)
1824                 hub_port_logical_disconnect(hub, port1);
1825
1826         clear_bit(port1, hub->busy_bits);
1827         if (!hub->hdev->parent && !hub->busy_bits[0])
1828                 usb_enable_root_hub_irq(hub->hdev->bus);
1829
1830         return status;
1831 }
1832
1833 /*
1834  * usb_port_resume - re-activate a suspended usb device's upstream port
1835  * @udev: device to re-activate
1836  * Context: must be able to sleep; device not locked; pm locks held
1837  *
1838  * This will re-activate the suspended device, increasing power usage
1839  * while letting drivers communicate again with its endpoints.
1840  * USB resume explicitly guarantees that the power session between
1841  * the host and the device is the same as it was when the device
1842  * suspended.
1843  *
1844  * Returns 0 on success, else negative errno.
1845  */
1846 int usb_port_resume(struct usb_device *udev)
1847 {
1848         int     status;
1849
1850         /* we change the device's upstream USB link,
1851          * but root hubs have no upstream USB link.
1852          */
1853         if (udev->parent) {
1854                 // NOTE this fails if parent is also suspended...
1855                 status = hub_port_resume(hdev_to_hub(udev->parent),
1856                                 udev->portnum, udev);
1857         } else {
1858                 dev_dbg(&udev->dev, "usb %sresume\n",
1859                                 udev->auto_pm ? "auto-" : "");
1860                 status = finish_port_resume(udev);
1861         }
1862         if (status < 0)
1863                 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1864         return status;
1865 }
1866
1867 static int remote_wakeup(struct usb_device *udev)
1868 {
1869         int     status = 0;
1870
1871         usb_lock_device(udev);
1872         if (udev->state == USB_STATE_SUSPENDED) {
1873                 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1874                 usb_mark_last_busy(udev);
1875                 status = usb_external_resume_device(udev);
1876         }
1877         usb_unlock_device(udev);
1878         return status;
1879 }
1880
1881 #else   /* CONFIG_USB_SUSPEND */
1882
1883 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1884
1885 int usb_port_suspend(struct usb_device *udev)
1886 {
1887         return 0;
1888 }
1889
1890 static inline int
1891 finish_port_resume(struct usb_device *udev)
1892 {
1893         return 0;
1894 }
1895
1896 static inline int
1897 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1898 {
1899         return 0;
1900 }
1901
1902 int usb_port_resume(struct usb_device *udev)
1903 {
1904         return 0;
1905 }
1906
1907 static inline int remote_wakeup(struct usb_device *udev)
1908 {
1909         return 0;
1910 }
1911
1912 #endif
1913
1914 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1915 {
1916         struct usb_hub          *hub = usb_get_intfdata (intf);
1917         struct usb_device       *hdev = hub->hdev;
1918         unsigned                port1;
1919
1920         /* fail if children aren't already suspended */
1921         for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1922                 struct usb_device       *udev;
1923
1924                 udev = hdev->children [port1-1];
1925                 if (udev && msg.event == PM_EVENT_SUSPEND &&
1926 #ifdef  CONFIG_USB_SUSPEND
1927                                 udev->state != USB_STATE_SUSPENDED
1928 #else
1929                                 udev->dev.power.power_state.event
1930                                         == PM_EVENT_ON
1931 #endif
1932                                 ) {
1933                         if (!hdev->auto_pm)
1934                                 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1935                                                 port1);
1936                         return -EBUSY;
1937                 }
1938         }
1939
1940         dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1941
1942         /* stop khubd and related activity */
1943         hub_quiesce(hub);
1944         return 0;
1945 }
1946
1947 static int hub_resume(struct usb_interface *intf)
1948 {
1949         struct usb_hub          *hub = usb_get_intfdata (intf);
1950
1951         dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1952
1953         /* tell khubd to look for changes on this hub */
1954         hub_activate(hub);
1955         return 0;
1956 }
1957
1958 #else   /* CONFIG_PM */
1959
1960 static inline int remote_wakeup(struct usb_device *udev)
1961 {
1962         return 0;
1963 }
1964
1965 #define hub_suspend NULL
1966 #define hub_resume NULL
1967 #endif
1968
1969
1970 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1971  *
1972  * Between connect detection and reset signaling there must be a delay
1973  * of 100ms at least for debounce and power-settling.  The corresponding
1974  * timer shall restart whenever the downstream port detects a disconnect.
1975  * 
1976  * Apparently there are some bluetooth and irda-dongles and a number of
1977  * low-speed devices for which this debounce period may last over a second.
1978  * Not covered by the spec - but easy to deal with.
1979  *
1980  * This implementation uses a 1500ms total debounce timeout; if the
1981  * connection isn't stable by then it returns -ETIMEDOUT.  It checks
1982  * every 25ms for transient disconnects.  When the port status has been
1983  * unchanged for 100ms it returns the port status.
1984  */
1985
1986 #define HUB_DEBOUNCE_TIMEOUT    1500
1987 #define HUB_DEBOUNCE_STEP         25
1988 #define HUB_DEBOUNCE_STABLE      100
1989
1990 static int hub_port_debounce(struct usb_hub *hub, int port1)
1991 {
1992         int ret;
1993         int total_time, stable_time = 0;
1994         u16 portchange, portstatus;
1995         unsigned connection = 0xffff;
1996
1997         for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
1998                 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1999                 if (ret < 0)
2000                         return ret;
2001
2002                 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2003                      (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2004                         stable_time += HUB_DEBOUNCE_STEP;
2005                         if (stable_time >= HUB_DEBOUNCE_STABLE)
2006                                 break;
2007                 } else {
2008                         stable_time = 0;
2009                         connection = portstatus & USB_PORT_STAT_CONNECTION;
2010                 }
2011
2012                 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2013                         clear_port_feature(hub->hdev, port1,
2014                                         USB_PORT_FEAT_C_CONNECTION);
2015                 }
2016
2017                 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2018                         break;
2019                 msleep(HUB_DEBOUNCE_STEP);
2020         }
2021
2022         dev_dbg (hub->intfdev,
2023                 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2024                 port1, total_time, stable_time, portstatus);
2025
2026         if (stable_time < HUB_DEBOUNCE_STABLE)
2027                 return -ETIMEDOUT;
2028         return portstatus;
2029 }
2030
2031 static void ep0_reinit(struct usb_device *udev)
2032 {
2033         usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2034         usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2035         udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2036 }
2037
2038 #define usb_sndaddr0pipe()      (PIPE_CONTROL << 30)
2039 #define usb_rcvaddr0pipe()      ((PIPE_CONTROL << 30) | USB_DIR_IN)
2040
2041 static int hub_set_address(struct usb_device *udev)
2042 {
2043         int retval;
2044
2045         if (udev->devnum == 0)
2046                 return -EINVAL;
2047         if (udev->state == USB_STATE_ADDRESS)
2048                 return 0;
2049         if (udev->state != USB_STATE_DEFAULT)
2050                 return -EINVAL;
2051         retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2052                 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2053                 NULL, 0, USB_CTRL_SET_TIMEOUT);
2054         if (retval == 0) {
2055                 usb_set_device_state(udev, USB_STATE_ADDRESS);
2056                 ep0_reinit(udev);
2057         }
2058         return retval;
2059 }
2060
2061 /* Reset device, (re)assign address, get device descriptor.
2062  * Device connection must be stable, no more debouncing needed.
2063  * Returns device in USB_STATE_ADDRESS, except on error.
2064  *
2065  * If this is called for an already-existing device (as part of
2066  * usb_reset_device), the caller must own the device lock.  For a
2067  * newly detected device that is not accessible through any global
2068  * pointers, it's not necessary to lock the device.
2069  */
2070 static int
2071 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2072                 int retry_counter)
2073 {
2074         static DEFINE_MUTEX(usb_address0_mutex);
2075
2076         struct usb_device       *hdev = hub->hdev;
2077         int                     i, j, retval;
2078         unsigned                delay = HUB_SHORT_RESET_TIME;
2079         enum usb_device_speed   oldspeed = udev->speed;
2080         char                    *speed, *type;
2081
2082         /* root hub ports have a slightly longer reset period
2083          * (from USB 2.0 spec, section 7.1.7.5)
2084          */
2085         if (!hdev->parent) {
2086                 delay = HUB_ROOT_RESET_TIME;
2087                 if (port1 == hdev->bus->otg_port)
2088                         hdev->bus->b_hnp_enable = 0;
2089         }
2090
2091         /* Some low speed devices have problems with the quick delay, so */
2092         /*  be a bit pessimistic with those devices. RHbug #23670 */
2093         if (oldspeed == USB_SPEED_LOW)
2094                 delay = HUB_LONG_RESET_TIME;
2095
2096         mutex_lock(&usb_address0_mutex);
2097
2098         /* Reset the device; full speed may morph to high speed */
2099         retval = hub_port_reset(hub, port1, udev, delay);
2100         if (retval < 0)         /* error or disconnect */
2101                 goto fail;
2102                                 /* success, speed is known */
2103         retval = -ENODEV;
2104
2105         if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2106                 dev_dbg(&udev->dev, "device reset changed speed!\n");
2107                 goto fail;
2108         }
2109         oldspeed = udev->speed;
2110   
2111         /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2112          * it's fixed size except for full speed devices.
2113          * For Wireless USB devices, ep0 max packet is always 512 (tho
2114          * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2115          */
2116         switch (udev->speed) {
2117         case USB_SPEED_VARIABLE:        /* fixed at 512 */
2118                 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2119                 break;
2120         case USB_SPEED_HIGH:            /* fixed at 64 */
2121                 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2122                 break;
2123         case USB_SPEED_FULL:            /* 8, 16, 32, or 64 */
2124                 /* to determine the ep0 maxpacket size, try to read
2125                  * the device descriptor to get bMaxPacketSize0 and
2126                  * then correct our initial guess.
2127                  */
2128                 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2129                 break;
2130         case USB_SPEED_LOW:             /* fixed at 8 */
2131                 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2132                 break;
2133         default:
2134                 goto fail;
2135         }
2136  
2137         type = "";
2138         switch (udev->speed) {
2139         case USB_SPEED_LOW:     speed = "low";  break;
2140         case USB_SPEED_FULL:    speed = "full"; break;
2141         case USB_SPEED_HIGH:    speed = "high"; break;
2142         case USB_SPEED_VARIABLE:
2143                                 speed = "variable";
2144                                 type = "Wireless ";
2145                                 break;
2146         default:                speed = "?";    break;
2147         }
2148         dev_info (&udev->dev,
2149                   "%s %s speed %sUSB device using %s and address %d\n",
2150                   (udev->config) ? "reset" : "new", speed, type,
2151                   udev->bus->controller->driver->name, udev->devnum);
2152
2153         /* Set up TT records, if needed  */
2154         if (hdev->tt) {
2155                 udev->tt = hdev->tt;
2156                 udev->ttport = hdev->ttport;
2157         } else if (udev->speed != USB_SPEED_HIGH
2158                         && hdev->speed == USB_SPEED_HIGH) {
2159                 udev->tt = &hub->tt;
2160                 udev->ttport = port1;
2161         }
2162  
2163         /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2164          * Because device hardware and firmware is sometimes buggy in
2165          * this area, and this is how Linux has done it for ages.
2166          * Change it cautiously.
2167          *
2168          * NOTE:  If USE_NEW_SCHEME() is true we will start by issuing
2169          * a 64-byte GET_DESCRIPTOR request.  This is what Windows does,
2170          * so it may help with some non-standards-compliant devices.
2171          * Otherwise we start with SET_ADDRESS and then try to read the
2172          * first 8 bytes of the device descriptor to get the ep0 maxpacket
2173          * value.
2174          */
2175         for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2176                 if (USE_NEW_SCHEME(retry_counter)) {
2177                         struct usb_device_descriptor *buf;
2178                         int r = 0;
2179
2180 #define GET_DESCRIPTOR_BUFSIZE  64
2181                         buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2182                         if (!buf) {
2183                                 retval = -ENOMEM;
2184                                 continue;
2185                         }
2186
2187                         /* Retry on all errors; some devices are flakey.
2188                          * 255 is for WUSB devices, we actually need to use
2189                          * 512 (WUSB1.0[4.8.1]).
2190                          */
2191                         for (j = 0; j < 3; ++j) {
2192                                 buf->bMaxPacketSize0 = 0;
2193                                 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2194                                         USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2195                                         USB_DT_DEVICE << 8, 0,
2196                                         buf, GET_DESCRIPTOR_BUFSIZE,
2197                                         USB_CTRL_GET_TIMEOUT);
2198                                 switch (buf->bMaxPacketSize0) {
2199                                 case 8: case 16: case 32: case 64: case 255:
2200                                         if (buf->bDescriptorType ==
2201                                                         USB_DT_DEVICE) {
2202                                                 r = 0;
2203                                                 break;
2204                                         }
2205                                         /* FALL THROUGH */
2206                                 default:
2207                                         if (r == 0)
2208                                                 r = -EPROTO;
2209                                         break;
2210                                 }
2211                                 if (r == 0)
2212                                         break;
2213                         }
2214                         udev->descriptor.bMaxPacketSize0 =
2215                                         buf->bMaxPacketSize0;
2216                         kfree(buf);
2217
2218                         retval = hub_port_reset(hub, port1, udev, delay);
2219                         if (retval < 0)         /* error or disconnect */
2220                                 goto fail;
2221                         if (oldspeed != udev->speed) {
2222                                 dev_dbg(&udev->dev,
2223                                         "device reset changed speed!\n");
2224                                 retval = -ENODEV;
2225                                 goto fail;
2226                         }
2227                         if (r) {
2228                                 dev_err(&udev->dev, "device descriptor "
2229                                                 "read/%s, error %d\n",
2230                                                 "64", r);
2231                                 retval = -EMSGSIZE;
2232                                 continue;
2233                         }
2234 #undef GET_DESCRIPTOR_BUFSIZE
2235                 }
2236
2237                 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2238                         retval = hub_set_address(udev);
2239                         if (retval >= 0)
2240                                 break;
2241                         msleep(200);
2242                 }
2243                 if (retval < 0) {
2244                         dev_err(&udev->dev,
2245                                 "device not accepting address %d, error %d\n",
2246                                 udev->devnum, retval);
2247                         goto fail;
2248                 }
2249  
2250                 /* cope with hardware quirkiness:
2251                  *  - let SET_ADDRESS settle, some device hardware wants it
2252                  *  - read ep0 maxpacket even for high and low speed,
2253                  */
2254                 msleep(10);
2255                 if (USE_NEW_SCHEME(retry_counter))
2256                         break;
2257
2258                 retval = usb_get_device_descriptor(udev, 8);
2259                 if (retval < 8) {
2260                         dev_err(&udev->dev, "device descriptor "
2261                                         "read/%s, error %d\n",
2262                                         "8", retval);
2263                         if (retval >= 0)
2264                                 retval = -EMSGSIZE;
2265                 } else {
2266                         retval = 0;
2267                         break;
2268                 }
2269         }
2270         if (retval)
2271                 goto fail;
2272
2273         i = udev->descriptor.bMaxPacketSize0 == 0xff?
2274             512 : udev->descriptor.bMaxPacketSize0;
2275         if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2276                 if (udev->speed != USB_SPEED_FULL ||
2277                                 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2278                         dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2279                         retval = -EMSGSIZE;
2280                         goto fail;
2281                 }
2282                 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2283                 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2284                 ep0_reinit(udev);
2285         }
2286   
2287         retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2288         if (retval < (signed)sizeof(udev->descriptor)) {
2289                 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2290                         "all", retval);
2291                 if (retval >= 0)
2292                         retval = -ENOMSG;
2293                 goto fail;
2294         }
2295
2296         retval = 0;
2297
2298 fail:
2299         if (retval)
2300                 hub_port_disable(hub, port1, 0);
2301         mutex_unlock(&usb_address0_mutex);
2302         return retval;
2303 }
2304
2305 static void
2306 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2307 {
2308         struct usb_qualifier_descriptor *qual;
2309         int                             status;
2310
2311         qual = kmalloc (sizeof *qual, GFP_KERNEL);
2312         if (qual == NULL)
2313                 return;
2314
2315         status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2316                         qual, sizeof *qual);
2317         if (status == sizeof *qual) {
2318                 dev_info(&udev->dev, "not running at top speed; "
2319                         "connect to a high speed hub\n");
2320                 /* hub LEDs are probably harder to miss than syslog */
2321                 if (hub->has_indicators) {
2322                         hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2323                         schedule_delayed_work (&hub->leds, 0);
2324                 }
2325         }
2326         kfree(qual);
2327 }
2328
2329 static unsigned
2330 hub_power_remaining (struct usb_hub *hub)
2331 {
2332         struct usb_device *hdev = hub->hdev;
2333         int remaining;
2334         int port1;
2335
2336         if (!hub->limited_power)
2337                 return 0;
2338
2339         remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2340         for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2341                 struct usb_device       *udev = hdev->children[port1 - 1];
2342                 int                     delta;
2343
2344                 if (!udev)
2345                         continue;
2346
2347                 /* Unconfigured devices may not use more than 100mA,
2348                  * or 8mA for OTG ports */
2349                 if (udev->actconfig)
2350                         delta = udev->actconfig->desc.bMaxPower * 2;
2351                 else if (port1 != udev->bus->otg_port || hdev->parent)
2352                         delta = 100;
2353                 else
2354                         delta = 8;
2355                 if (delta > hub->mA_per_port)
2356                         dev_warn(&udev->dev, "%dmA is over %umA budget "
2357                                         "for port %d!\n",
2358                                         delta, hub->mA_per_port, port1);
2359                 remaining -= delta;
2360         }
2361         if (remaining < 0) {
2362                 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2363                         - remaining);
2364                 remaining = 0;
2365         }
2366         return remaining;
2367 }
2368
2369 /* Handle physical or logical connection change events.
2370  * This routine is called when:
2371  *      a port connection-change occurs;
2372  *      a port enable-change occurs (often caused by EMI);
2373  *      usb_reset_device() encounters changed descriptors (as from
2374  *              a firmware download)
2375  * caller already locked the hub
2376  */
2377 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2378                                         u16 portstatus, u16 portchange)
2379 {
2380         struct usb_device *hdev = hub->hdev;
2381         struct device *hub_dev = hub->intfdev;
2382         u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2383         int status, i;
2384  
2385         dev_dbg (hub_dev,
2386                 "port %d, status %04x, change %04x, %s\n",
2387                 port1, portstatus, portchange, portspeed (portstatus));
2388
2389         if (hub->has_indicators) {
2390                 set_port_led(hub, port1, HUB_LED_AUTO);
2391                 hub->indicator[port1-1] = INDICATOR_AUTO;
2392         }
2393  
2394         /* Disconnect any existing devices under this port */
2395         if (hdev->children[port1-1])
2396                 usb_disconnect(&hdev->children[port1-1]);
2397         clear_bit(port1, hub->change_bits);
2398
2399 #ifdef  CONFIG_USB_OTG
2400         /* during HNP, don't repeat the debounce */
2401         if (hdev->bus->is_b_host)
2402                 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2403 #endif
2404
2405         if (portchange & USB_PORT_STAT_C_CONNECTION) {
2406                 status = hub_port_debounce(hub, port1);
2407                 if (status < 0) {
2408                         if (printk_ratelimit())
2409                                 dev_err (hub_dev, "connect-debounce failed, "
2410                                                 "port %d disabled\n", port1);
2411                         goto done;
2412                 }
2413                 portstatus = status;
2414         }
2415
2416         /* Return now if nothing is connected */
2417         if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2418
2419                 /* maybe switch power back on (e.g. root hub was reset) */
2420                 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2421                                 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2422                         set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2423  
2424                 if (portstatus & USB_PORT_STAT_ENABLE)
2425                         goto done;
2426                 return;
2427         }
2428
2429 #ifdef  CONFIG_USB_SUSPEND
2430         /* If something is connected, but the port is suspended, wake it up. */
2431         if (portstatus & USB_PORT_STAT_SUSPEND) {
2432                 status = hub_port_resume(hub, port1, NULL);
2433                 if (status < 0) {
2434                         dev_dbg(hub_dev,
2435                                 "can't clear suspend on port %d; %d\n",
2436                                 port1, status);
2437                         goto done;
2438                 }
2439         }
2440 #endif
2441
2442         for (i = 0; i < SET_CONFIG_TRIES; i++) {
2443                 struct usb_device *udev;
2444
2445                 /* reallocate for each attempt, since references
2446                  * to the previous one can escape in various ways
2447                  */
2448                 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2449                 if (!udev) {
2450                         dev_err (hub_dev,
2451                                 "couldn't allocate port %d usb_device\n",
2452                                 port1);
2453                         goto done;
2454                 }
2455
2456                 usb_set_device_state(udev, USB_STATE_POWERED);
2457                 udev->speed = USB_SPEED_UNKNOWN;
2458                 udev->bus_mA = hub->mA_per_port;
2459                 udev->level = hdev->level + 1;
2460
2461                 /* set the address */
2462                 choose_address(udev);
2463                 if (udev->devnum <= 0) {
2464                         status = -ENOTCONN;     /* Don't retry */
2465                         goto loop;
2466                 }
2467
2468                 /* reset and get descriptor */
2469                 status = hub_port_init(hub, udev, port1, i);
2470                 if (status < 0)
2471                         goto loop;
2472
2473                 /* consecutive bus-powered hubs aren't reliable; they can
2474                  * violate the voltage drop budget.  if the new child has
2475                  * a "powered" LED, users should notice we didn't enable it
2476                  * (without reading syslog), even without per-port LEDs
2477                  * on the parent.
2478                  */
2479                 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2480                                 && udev->bus_mA <= 100) {
2481                         u16     devstat;
2482
2483                         status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2484                                         &devstat);
2485                         if (status < 2) {
2486                                 dev_dbg(&udev->dev, "get status %d ?\n", status);
2487                                 goto loop_disable;
2488                         }
2489                         le16_to_cpus(&devstat);
2490                         if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2491                                 dev_err(&udev->dev,
2492                                         "can't connect bus-powered hub "
2493                                         "to this port\n");
2494                                 if (hub->has_indicators) {
2495                                         hub->indicator[port1-1] =
2496                                                 INDICATOR_AMBER_BLINK;
2497                                         schedule_delayed_work (&hub->leds, 0);
2498                                 }
2499                                 status = -ENOTCONN;     /* Don't retry */
2500                                 goto loop_disable;
2501                         }
2502                 }
2503  
2504                 /* check for devices running slower than they could */
2505                 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2506                                 && udev->speed == USB_SPEED_FULL
2507                                 && highspeed_hubs != 0)
2508                         check_highspeed (hub, udev, port1);
2509
2510                 /* Store the parent's children[] pointer.  At this point
2511                  * udev becomes globally accessible, although presumably
2512                  * no one will look at it until hdev is unlocked.
2513                  */
2514                 status = 0;
2515
2516                 /* We mustn't add new devices if the parent hub has
2517                  * been disconnected; we would race with the
2518                  * recursively_mark_NOTATTACHED() routine.
2519                  */
2520                 spin_lock_irq(&device_state_lock);
2521                 if (hdev->state == USB_STATE_NOTATTACHED)
2522                         status = -ENOTCONN;
2523                 else
2524                         hdev->children[port1-1] = udev;
2525                 spin_unlock_irq(&device_state_lock);
2526
2527                 /* Run it through the hoops (find a driver, etc) */
2528                 if (!status) {
2529                         status = usb_new_device(udev);
2530                         if (status) {
2531                                 spin_lock_irq(&device_state_lock);
2532                                 hdev->children[port1-1] = NULL;
2533                                 spin_unlock_irq(&device_state_lock);
2534                         }
2535                 }
2536
2537                 if (status)
2538                         goto loop_disable;
2539
2540                 status = hub_power_remaining(hub);
2541                 if (status)
2542                         dev_dbg(hub_dev, "%dmA power budget left\n", status);
2543
2544                 return;
2545
2546 loop_disable:
2547                 hub_port_disable(hub, port1, 1);
2548 loop:
2549                 ep0_reinit(udev);
2550                 release_address(udev);
2551                 usb_put_dev(udev);
2552                 if (status == -ENOTCONN)
2553                         break;
2554         }
2555  
2556 done:
2557         hub_port_disable(hub, port1, 1);
2558 }
2559
2560 static void hub_events(void)
2561 {
2562         struct list_head *tmp;
2563         struct usb_device *hdev;
2564         struct usb_interface *intf;
2565         struct usb_hub *hub;
2566         struct device *hub_dev;
2567         u16 hubstatus;
2568         u16 hubchange;
2569         u16 portstatus;
2570         u16 portchange;
2571         int i, ret;
2572         int connect_change;
2573
2574         /*
2575          *  We restart the list every time to avoid a deadlock with
2576          * deleting hubs downstream from this one. This should be
2577          * safe since we delete the hub from the event list.
2578          * Not the most efficient, but avoids deadlocks.
2579          */
2580         while (1) {
2581
2582                 /* Grab the first entry at the beginning of the list */
2583                 spin_lock_irq(&hub_event_lock);
2584                 if (list_empty(&hub_event_list)) {
2585                         spin_unlock_irq(&hub_event_lock);
2586                         break;
2587                 }
2588
2589                 tmp = hub_event_list.next;
2590                 list_del_init(tmp);
2591
2592                 hub = list_entry(tmp, struct usb_hub, event_list);
2593                 hdev = hub->hdev;
2594                 intf = to_usb_interface(hub->intfdev);
2595                 hub_dev = &intf->dev;
2596
2597                 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2598                                 hdev->state, hub->descriptor
2599                                         ? hub->descriptor->bNbrPorts
2600                                         : 0,
2601                                 /* NOTE: expects max 15 ports... */
2602                                 (u16) hub->change_bits[0],
2603                                 (u16) hub->event_bits[0]);
2604
2605                 usb_get_intf(intf);
2606                 spin_unlock_irq(&hub_event_lock);
2607
2608                 /* Lock the device, then check to see if we were
2609                  * disconnected while waiting for the lock to succeed. */
2610                 if (locktree(hdev) < 0) {
2611                         usb_put_intf(intf);
2612                         continue;
2613                 }
2614                 if (hub != usb_get_intfdata(intf))
2615                         goto loop;
2616
2617                 /* If the hub has died, clean up after it */
2618                 if (hdev->state == USB_STATE_NOTATTACHED) {
2619                         hub->error = -ENODEV;
2620                         hub_pre_reset(intf);
2621                         goto loop;
2622                 }
2623
2624                 /* Autoresume */
2625                 ret = usb_autopm_get_interface(intf);
2626                 if (ret) {
2627                         dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2628                         goto loop;
2629                 }
2630
2631                 /* If this is an inactive hub, do nothing */
2632                 if (hub->quiescing)
2633                         goto loop_autopm;
2634
2635                 if (hub->error) {
2636                         dev_dbg (hub_dev, "resetting for error %d\n",
2637                                 hub->error);
2638
2639                         ret = usb_reset_composite_device(hdev, intf);
2640                         if (ret) {
2641                                 dev_dbg (hub_dev,
2642                                         "error resetting hub: %d\n", ret);
2643                                 goto loop_autopm;
2644                         }
2645
2646                         hub->nerrors = 0;
2647                         hub->error = 0;
2648                 }
2649
2650                 /* deal with port status changes */
2651                 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2652                         if (test_bit(i, hub->busy_bits))
2653                                 continue;
2654                         connect_change = test_bit(i, hub->change_bits);
2655                         if (!test_and_clear_bit(i, hub->event_bits) &&
2656                                         !connect_change && !hub->activating)
2657                                 continue;
2658
2659                         ret = hub_port_status(hub, i,
2660                                         &portstatus, &portchange);
2661                         if (ret < 0)
2662                                 continue;
2663
2664                         if (hub->activating && !hdev->children[i-1] &&
2665                                         (portstatus &
2666                                                 USB_PORT_STAT_CONNECTION))
2667                                 connect_change = 1;
2668
2669                         if (portchange & USB_PORT_STAT_C_CONNECTION) {
2670                                 clear_port_feature(hdev, i,
2671                                         USB_PORT_FEAT_C_CONNECTION);
2672                                 connect_change = 1;
2673                         }
2674
2675                         if (portchange & USB_PORT_STAT_C_ENABLE) {
2676                                 if (!connect_change)
2677                                         dev_dbg (hub_dev,
2678                                                 "port %d enable change, "
2679                                                 "status %08x\n",
2680                                                 i, portstatus);
2681                                 clear_port_feature(hdev, i,
2682                                         USB_PORT_FEAT_C_ENABLE);
2683
2684                                 /*
2685                                  * EM interference sometimes causes badly
2686                                  * shielded USB devices to be shutdown by
2687                                  * the hub, this hack enables them again.
2688                                  * Works at least with mouse driver. 
2689                                  */
2690                                 if (!(portstatus & USB_PORT_STAT_ENABLE)
2691                                     && !connect_change
2692                                     && hdev->children[i-1]) {
2693                                         dev_err (hub_dev,
2694                                             "port %i "
2695                                             "disabled by hub (EMI?), "
2696                                             "re-enabling...\n",
2697                                                 i);
2698                                         connect_change = 1;
2699                                 }
2700                         }
2701
2702                         if (portchange & USB_PORT_STAT_C_SUSPEND) {
2703                                 clear_port_feature(hdev, i,
2704                                         USB_PORT_FEAT_C_SUSPEND);
2705                                 if (hdev->children[i-1]) {
2706                                         ret = remote_wakeup(hdev->
2707                                                         children[i-1]);
2708                                         if (ret < 0)
2709                                                 connect_change = 1;
2710                                 } else {
2711                                         ret = -ENODEV;
2712                                         hub_port_disable(hub, i, 1);
2713                                 }
2714                                 dev_dbg (hub_dev,
2715                                         "resume on port %d, status %d\n",
2716                                         i, ret);
2717                         }
2718                         
2719                         if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2720                                 dev_err (hub_dev,
2721                                         "over-current change on port %d\n",
2722                                         i);
2723                                 clear_port_feature(hdev, i,
2724                                         USB_PORT_FEAT_C_OVER_CURRENT);
2725                                 hub_power_on(hub);
2726                         }
2727
2728                         if (portchange & USB_PORT_STAT_C_RESET) {
2729                                 dev_dbg (hub_dev,
2730                                         "reset change on port %d\n",
2731                                         i);
2732                                 clear_port_feature(hdev, i,
2733                                         USB_PORT_FEAT_C_RESET);
2734                         }
2735
2736                         if (connect_change)
2737                                 hub_port_connect_change(hub, i,
2738                                                 portstatus, portchange);
2739                 } /* end for i */
2740
2741                 /* deal with hub status changes */
2742                 if (test_and_clear_bit(0, hub->event_bits) == 0)
2743                         ;       /* do nothing */
2744                 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2745                         dev_err (hub_dev, "get_hub_status failed\n");
2746                 else {
2747                         if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2748                                 dev_dbg (hub_dev, "power change\n");
2749                                 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2750                                 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2751                                         /* FIXME: Is this always true? */
2752                                         hub->limited_power = 0;
2753                                 else
2754                                         hub->limited_power = 1;
2755                         }
2756                         if (hubchange & HUB_CHANGE_OVERCURRENT) {
2757                                 dev_dbg (hub_dev, "overcurrent change\n");
2758                                 msleep(500);    /* Cool down */
2759                                 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2760                                 hub_power_on(hub);
2761                         }
2762                 }
2763
2764                 hub->activating = 0;
2765
2766                 /* If this is a root hub, tell the HCD it's okay to
2767                  * re-enable port-change interrupts now. */
2768                 if (!hdev->parent && !hub->busy_bits[0])
2769                         usb_enable_root_hub_irq(hdev->bus);
2770
2771 loop_autopm:
2772                 /* Allow autosuspend if we're not going to run again */
2773                 if (list_empty(&hub->event_list))
2774                         usb_autopm_enable(intf);
2775 loop:
2776                 usb_unlock_device(hdev);
2777                 usb_put_intf(intf);
2778
2779         } /* end while (1) */
2780 }
2781
2782 static int hub_thread(void *__unused)
2783 {
2784         do {
2785                 hub_events();
2786                 wait_event_interruptible(khubd_wait,
2787                                 !list_empty(&hub_event_list) ||
2788                                 kthread_should_stop());
2789                 try_to_freeze();
2790         } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2791
2792         pr_debug("%s: khubd exiting\n", usbcore_name);
2793         return 0;
2794 }
2795
2796 static struct usb_device_id hub_id_table [] = {
2797     { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2798       .bDeviceClass = USB_CLASS_HUB},
2799     { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2800       .bInterfaceClass = USB_CLASS_HUB},
2801     { }                                         /* Terminating entry */
2802 };
2803
2804 MODULE_DEVICE_TABLE (usb, hub_id_table);
2805
2806 static struct usb_driver hub_driver = {
2807         .name =         "hub",
2808         .probe =        hub_probe,
2809         .disconnect =   hub_disconnect,
2810         .suspend =      hub_suspend,
2811         .resume =       hub_resume,
2812         .pre_reset =    hub_pre_reset,
2813         .post_reset =   hub_post_reset,
2814         .ioctl =        hub_ioctl,
2815         .id_table =     hub_id_table,
2816         .supports_autosuspend = 1,
2817 };
2818
2819 int usb_hub_init(void)
2820 {
2821         if (usb_register(&hub_driver) < 0) {
2822                 printk(KERN_ERR "%s: can't register hub driver\n",
2823                         usbcore_name);
2824                 return -1;
2825         }
2826
2827         khubd_task = kthread_run(hub_thread, NULL, "khubd");
2828         if (!IS_ERR(khubd_task))
2829                 return 0;
2830
2831         /* Fall through if kernel_thread failed */
2832         usb_deregister(&hub_driver);
2833         printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2834
2835         return -1;
2836 }
2837
2838 void usb_hub_cleanup(void)
2839 {
2840         kthread_stop(khubd_task);
2841
2842         /*
2843          * Hub resources are freed for us by usb_deregister. It calls
2844          * usb_driver_purge on every device which in turn calls that
2845          * devices disconnect function if it is using this driver.
2846          * The hub_disconnect function takes care of releasing the
2847          * individual hub resources. -greg
2848          */
2849         usb_deregister(&hub_driver);
2850 } /* usb_hub_cleanup() */
2851
2852 static int config_descriptors_changed(struct usb_device *udev)
2853 {
2854         unsigned                        index;
2855         unsigned                        len = 0;
2856         struct usb_config_descriptor    *buf;
2857
2858         for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2859                 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2860                         len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2861         }
2862         buf = kmalloc (len, GFP_KERNEL);
2863         if (buf == NULL) {
2864                 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2865                 /* assume the worst */
2866                 return 1;
2867         }
2868         for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2869                 int length;
2870                 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2871
2872                 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2873                                 old_length);
2874                 if (length < old_length) {
2875                         dev_dbg(&udev->dev, "config index %d, error %d\n",
2876                                         index, length);
2877                         break;
2878                 }
2879                 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2880                                 != 0) {
2881                         dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2882                                 index, buf->bConfigurationValue);
2883                         break;
2884                 }
2885         }
2886         kfree(buf);
2887         return index != udev->descriptor.bNumConfigurations;
2888 }
2889
2890 /**
2891  * usb_reset_device - perform a USB port reset to reinitialize a device
2892  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2893  *
2894  * WARNING - don't use this routine to reset a composite device
2895  * (one with multiple interfaces owned by separate drivers)!
2896  * Use usb_reset_composite_device() instead.
2897  *
2898  * Do a port reset, reassign the device's address, and establish its
2899  * former operating configuration.  If the reset fails, or the device's
2900  * descriptors change from their values before the reset, or the original
2901  * configuration and altsettings cannot be restored, a flag will be set
2902  * telling khubd to pretend the device has been disconnected and then
2903  * re-connected.  All drivers will be unbound, and the device will be
2904  * re-enumerated and probed all over again.
2905  *
2906  * Returns 0 if the reset succeeded, -ENODEV if the device has been
2907  * flagged for logical disconnection, or some other negative error code
2908  * if the reset wasn't even attempted.
2909  *
2910  * The caller must own the device lock.  For example, it's safe to use
2911  * this from a driver probe() routine after downloading new firmware.
2912  * For calls that might not occur during probe(), drivers should lock
2913  * the device using usb_lock_device_for_reset().
2914  */
2915 int usb_reset_device(struct usb_device *udev)
2916 {
2917         struct usb_device               *parent_hdev = udev->parent;
2918         struct usb_hub                  *parent_hub;
2919         struct usb_device_descriptor    descriptor = udev->descriptor;
2920         int                             i, ret = 0;
2921         int                             port1 = udev->portnum;
2922
2923         if (udev->state == USB_STATE_NOTATTACHED ||
2924                         udev->state == USB_STATE_SUSPENDED) {
2925                 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2926                                 udev->state);
2927                 return -EINVAL;
2928         }
2929
2930         if (!parent_hdev) {
2931                 /* this requires hcd-specific logic; see OHCI hc_restart() */
2932                 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2933                 return -EISDIR;
2934         }
2935         parent_hub = hdev_to_hub(parent_hdev);
2936
2937         set_bit(port1, parent_hub->busy_bits);
2938         for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2939
2940                 /* ep0 maxpacket size may change; let the HCD know about it.
2941                  * Other endpoints will be handled by re-enumeration. */
2942                 ep0_reinit(udev);
2943                 ret = hub_port_init(parent_hub, udev, port1, i);
2944                 if (ret >= 0)
2945                         break;
2946         }
2947         clear_bit(port1, parent_hub->busy_bits);
2948         if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2949                 usb_enable_root_hub_irq(parent_hdev->bus);
2950
2951         if (ret < 0)
2952                 goto re_enumerate;
2953  
2954         /* Device might have changed firmware (DFU or similar) */
2955         if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2956                         || config_descriptors_changed (udev)) {
2957                 dev_info(&udev->dev, "device firmware changed\n");
2958                 udev->descriptor = descriptor;  /* for disconnect() calls */
2959                 goto re_enumerate;
2960         }
2961   
2962         if (!udev->actconfig)
2963                 goto done;
2964
2965         ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2966                         USB_REQ_SET_CONFIGURATION, 0,
2967                         udev->actconfig->desc.bConfigurationValue, 0,
2968                         NULL, 0, USB_CTRL_SET_TIMEOUT);
2969         if (ret < 0) {
2970                 dev_err(&udev->dev,
2971                         "can't restore configuration #%d (error=%d)\n",
2972                         udev->actconfig->desc.bConfigurationValue, ret);
2973                 goto re_enumerate;
2974         }
2975         usb_set_device_state(udev, USB_STATE_CONFIGURED);
2976
2977         for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2978                 struct usb_interface *intf = udev->actconfig->interface[i];
2979                 struct usb_interface_descriptor *desc;
2980
2981                 /* set_interface resets host side toggle even
2982                  * for altsetting zero.  the interface may have no driver.
2983                  */
2984                 desc = &intf->cur_altsetting->desc;
2985                 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2986                         desc->bAlternateSetting);
2987                 if (ret < 0) {
2988                         dev_err(&udev->dev, "failed to restore interface %d "
2989                                 "altsetting %d (error=%d)\n",
2990                                 desc->bInterfaceNumber,
2991                                 desc->bAlternateSetting,
2992                                 ret);
2993                         goto re_enumerate;
2994                 }
2995         }
2996
2997 done:
2998         return 0;
2999  
3000 re_enumerate:
3001         hub_port_logical_disconnect(parent_hub, port1);
3002         return -ENODEV;
3003 }
3004 EXPORT_SYMBOL(usb_reset_device);
3005
3006 /**
3007  * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3008  * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3009  * @iface: interface bound to the driver making the request (optional)
3010  *
3011  * Warns all drivers bound to registered interfaces (using their pre_reset
3012  * method), performs the port reset, and then lets the drivers know that
3013  * the reset is over (using their post_reset method).
3014  *
3015  * Return value is the same as for usb_reset_device().
3016  *
3017  * The caller must own the device lock.  For example, it's safe to use
3018  * this from a driver probe() routine after downloading new firmware.
3019  * For calls that might not occur during probe(), drivers should lock
3020  * the device using usb_lock_device_for_reset().
3021  *
3022  * The interface locks are acquired during the pre_reset stage and released
3023  * during the post_reset stage.  However if iface is not NULL and is
3024  * currently being probed, we assume that the caller already owns its
3025  * lock.
3026  */
3027 int usb_reset_composite_device(struct usb_device *udev,
3028                 struct usb_interface *iface)
3029 {
3030         int ret;
3031         struct usb_host_config *config = udev->actconfig;
3032
3033         if (udev->state == USB_STATE_NOTATTACHED ||
3034                         udev->state == USB_STATE_SUSPENDED) {
3035                 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3036                                 udev->state);
3037                 return -EINVAL;
3038         }
3039
3040         /* Prevent autosuspend during the reset */
3041         usb_autoresume_device(udev);
3042
3043         if (iface && iface->condition != USB_INTERFACE_BINDING)
3044                 iface = NULL;
3045
3046         if (config) {
3047                 int i;
3048                 struct usb_interface *cintf;
3049                 struct usb_driver *drv;
3050
3051                 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3052                         cintf = config->interface[i];
3053                         if (cintf != iface)
3054                                 down(&cintf->dev.sem);
3055                         if (device_is_registered(&cintf->dev) &&
3056                                         cintf->dev.driver) {
3057                                 drv = to_usb_driver(cintf->dev.driver);
3058                                 if (drv->pre_reset)
3059                                         (drv->pre_reset)(cintf);
3060                         }
3061                 }
3062         }
3063
3064         ret = usb_reset_device(udev);
3065
3066         if (config) {
3067                 int i;
3068                 struct usb_interface *cintf;
3069                 struct usb_driver *drv;
3070
3071                 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3072                         cintf = config->interface[i];
3073                         if (device_is_registered(&cintf->dev) &&
3074                                         cintf->dev.driver) {
3075                                 drv = to_usb_driver(cintf->dev.driver);
3076                                 if (drv->post_reset)
3077                                         (drv->post_reset)(cintf);
3078                         }
3079                         if (cintf != iface)
3080                                 up(&cintf->dev.sem);
3081                 }
3082         }
3083
3084         usb_autosuspend_device(udev);
3085         return ret;
3086 }
3087 EXPORT_SYMBOL(usb_reset_composite_device);