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