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