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