projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB/xHCI: Enable USB 3.0 hub remote wakeup.
[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
d35e70d5
MG		 1841static void set_usb_port_removable(struct usb_device *udev)
1842{
1843 struct usb_device *hdev = udev->parent;
1844 struct usb_hub *hub;
1845 u8 port = udev->portnum;
1846 u16 wHubCharacteristics;
1847 bool removable = true;
1848
1849 if (!hdev)
1850 return;
1851
1852 hub = hdev_to_hub(udev->parent);
1853
1854 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1855
1856 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
1857 return;
1858
1859 if (hub_is_superspeed(hdev)) {
1860 if (hub->descriptor->u.ss.DeviceRemovable & (1 << port))
1861 removable = false;
1862 } else {
1863 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
1864 removable = false;
1865 }
1866
1867 if (removable)
1868 udev->removable = USB_DEVICE_REMOVABLE;
1869 else
1870 udev->removable = USB_DEVICE_FIXED;
1871}
d9d16e8a
IPG		 1872
1873/**
1874 * usb_new_device - perform initial device setup (usbcore-internal)
1875 * @udev: newly addressed device (in ADDRESS state)
1876 *
8d8558d1
AS		 1877 * This is called with devices which have been detected but not fully
1878 * enumerated. The device descriptor is available, but not descriptors
d9d16e8a
IPG		 1879 * for any device configuration. The caller must have locked either
1880 * the parent hub (if udev is a normal device) or else the
1881 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1882 * udev has already been installed, but udev is not yet visible through
1883 * sysfs or other filesystem code.
1884 *
1885 * It will return if the device is configured properly or not. Zero if
1886 * the interface was registered with the driver core; else a negative
1887 * errno value.
1888 *
1889 * This call is synchronous, and may not be used in an interrupt context.
1890 *
1891 * Only the hub driver or root-hub registrar should ever call this.
1892 */
1893int usb_new_device(struct usb_device *udev)
1894{
1895 int err;
1896
16985408 1897 if (udev->parent) {
16985408
DS		 1898 /* Initialize non-root-hub device wakeup to disabled;
1899 * device (un)configuration controls wakeup capable
1900 * sysfs power/wakeup controls wakeup enabled/disabled
1901 */
1902 device_init_wakeup(&udev->dev, 0);
16985408
DS		 1903 }
1904
9bbdf1e0
AS		 1905 /* Tell the runtime-PM framework the device is active */
1906 pm_runtime_set_active(&udev->dev);
c08512c7 1907 pm_runtime_get_noresume(&udev->dev);
fcc4a01e 1908 pm_runtime_use_autosuspend(&udev->dev);
9bbdf1e0
AS		 1909 pm_runtime_enable(&udev->dev);
1910
c08512c7
AS		 1911 /* By default, forbid autosuspend for all devices. It will be
1912 * allowed for hubs during binding.
1913 */
1914 usb_disable_autosuspend(udev);
1915
8d8558d1 1916 err = usb_enumerate_device(udev); /* Read descriptors */
d9d16e8a
IPG		 1917 if (err < 0)
1918 goto fail;
c6515272
SS		 1919 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1920 udev->devnum, udev->bus->busnum,
1921 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
9f8b17e6
KS		 1922 /* export the usbdev device-node for libusb */
1923 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1924 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1925
6cd13201
AS		 1926 /* Tell the world! */
1927 announce_device(udev);
195af2cc 1928
927bc916 1929 device_enable_async_suspend(&udev->dev);
d35e70d5
MG		 1930
1931 /*
1932 * check whether the hub marks this port as non-removable. Do it
1933 * now so that platform-specific data can override it in
1934 * device_add()
1935 */
1936 if (udev->parent)
1937 set_usb_port_removable(udev);
1938
782da727 1939 /* Register the device. The device driver is responsible
3b23dd6f
AS		 1940 * for configuring the device and invoking the add-device
1941 * notifier chain (used by usbfs and possibly others).
782da727 1942 */
9f8b17e6 1943 err = device_add(&udev->dev);
1da177e4
LT		 1944 if (err) {
1945 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1946 goto fail;
1947 }
9ad3d6cc 1948
3b23dd6f 1949 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
c08512c7
AS		 1950 usb_mark_last_busy(udev);
1951 pm_runtime_put_sync_autosuspend(&udev->dev);
c066475e 1952 return err;
1da177e4
LT		 1953
1954fail:
1955 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
9bbdf1e0
AS		 1956 pm_runtime_disable(&udev->dev);
1957 pm_runtime_set_suspended(&udev->dev);
d9d16e8a 1958 return err;
1da177e4
LT		 1959}
1960
93993a0a
IPG		 1961
1962/**
fd39c86b
RD		 1963 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1964 * @usb_dev: USB device
1965 *
1966 * Move the USB device to a very basic state where interfaces are disabled
1967 * and the device is in fact unconfigured and unusable.
93993a0a
IPG		 1968 *
1969 * We share a lock (that we have) with device_del(), so we need to
1970 * defer its call.
1971 */
1972int usb_deauthorize_device(struct usb_device *usb_dev)
1973{
93993a0a
IPG		 1974 usb_lock_device(usb_dev);
1975 if (usb_dev->authorized == 0)
1976 goto out_unauthorized;
da307123 1977
93993a0a
IPG		 1978 usb_dev->authorized = 0;
1979 usb_set_configuration(usb_dev, -1);
da307123
AS		 1980
1981 kfree(usb_dev->product);
93993a0a 1982 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
da307123 1983 kfree(usb_dev->manufacturer);
93993a0a 1984 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
da307123 1985 kfree(usb_dev->serial);
93993a0a 1986 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
da307123
AS		 1987
1988 usb_destroy_configuration(usb_dev);
93993a0a 1989 usb_dev->descriptor.bNumConfigurations = 0;
da307123 1990
93993a0a
IPG		 1991out_unauthorized:
1992 usb_unlock_device(usb_dev);
1993 return 0;
1994}
1995
1996
1997int usb_authorize_device(struct usb_device *usb_dev)
1998{
1999 int result = 0, c;
da307123 2000
93993a0a
IPG		 2001 usb_lock_device(usb_dev);
2002 if (usb_dev->authorized == 1)
2003 goto out_authorized;
da307123 2004
93993a0a
IPG		 2005 result = usb_autoresume_device(usb_dev);
2006 if (result < 0) {
2007 dev_err(&usb_dev->dev,
2008 "can't autoresume for authorization: %d\n", result);
2009 goto error_autoresume;
2010 }
2011 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2012 if (result < 0) {
2013 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2014 "authorization: %d\n", result);
2015 goto error_device_descriptor;
2016 }
da307123
AS		 2017
2018 kfree(usb_dev->product);
2019 usb_dev->product = NULL;
2020 kfree(usb_dev->manufacturer);
2021 usb_dev->manufacturer = NULL;
2022 kfree(usb_dev->serial);
2023 usb_dev->serial = NULL;
2024
93993a0a 2025 usb_dev->authorized = 1;
8d8558d1 2026 result = usb_enumerate_device(usb_dev);
93993a0a 2027 if (result < 0)
8d8558d1 2028 goto error_enumerate;
93993a0a
IPG		 2029 /* Choose and set the configuration. This registers the interfaces
2030 * with the driver core and lets interface drivers bind to them.
2031 */
b5ea060f 2032 c = usb_choose_configuration(usb_dev);
93993a0a
IPG		 2033 if (c >= 0) {
2034 result = usb_set_configuration(usb_dev, c);
2035 if (result) {
2036 dev_err(&usb_dev->dev,
2037 "can't set config #%d, error %d\n", c, result);
2038 /* This need not be fatal. The user can try to
2039 * set other configurations. */
2040 }
2041 }
2042 dev_info(&usb_dev->dev, "authorized to connect\n");
da307123 2043
8d8558d1 2044error_enumerate:
93993a0a 2045error_device_descriptor:
da307123 2046 usb_autosuspend_device(usb_dev);
93993a0a
IPG		 2047error_autoresume:
2048out_authorized:
2049 usb_unlock_device(usb_dev); // complements locktree
2050 return result;
2051}
2052
2053
0165de09
IPG		 2054/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2055static unsigned hub_is_wusb(struct usb_hub *hub)
2056{
2057 struct usb_hcd *hcd;
2058 if (hub->hdev->parent != NULL) /* not a root hub? */
2059 return 0;
2060 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2061 return hcd->wireless;
2062}
2063
2064
1da177e4
LT		 2065#define PORT_RESET_TRIES 5
2066#define SET_ADDRESS_TRIES 2
2067#define GET_DESCRIPTOR_TRIES 2
2068#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
90ab5ee9 2069#define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
1da177e4
LT		 2070
2071#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2072#define HUB_SHORT_RESET_TIME 10
75d7cf72 2073#define HUB_BH_RESET_TIME 50
1da177e4
LT		 2074#define HUB_LONG_RESET_TIME 200
2075#define HUB_RESET_TIMEOUT 500
2076
10d674a8
SS		 2077static int hub_port_reset(struct usb_hub *hub, int port1,
2078 struct usb_device *udev, unsigned int delay, bool warm);
2079
2080/* Is a USB 3.0 port in the Inactive state? */
2081static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2082{
2083 return hub_is_superspeed(hub->hdev) &&
2084 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2085 USB_SS_PORT_LS_SS_INACTIVE;
2086}
2087
1da177e4 2088static int hub_port_wait_reset(struct usb_hub *hub, int port1,
75d7cf72 2089 struct usb_device *udev, unsigned int delay, bool warm)
1da177e4
LT		 2090{
2091 int delay_time, ret;
2092 u16 portstatus;
2093 u16 portchange;
2094
2095 for (delay_time = 0;
2096 delay_time < HUB_RESET_TIMEOUT;
2097 delay_time += delay) {
2098 /* wait to give the device a chance to reset */
2099 msleep(delay);
2100
2101 /* read and decode port status */
2102 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2103 if (ret < 0)
2104 return ret;
2105
75d7cf72
AX		 2106 /*
2107 * Some buggy devices require a warm reset to be issued even
2108 * when the port appears not to be connected.
2109 */
2110 if (!warm) {
10d674a8
SS		 2111 /*
2112 * Some buggy devices can cause an NEC host controller
2113 * to transition to the "Error" state after a hot port
2114 * reset. This will show up as the port state in
2115 * "Inactive", and the port may also report a
2116 * disconnect. Forcing a warm port reset seems to make
2117 * the device work.
2118 *
2119 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2120 */
2121 if (hub_port_inactive(hub, portstatus)) {
2122 int ret;
2123
2124 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2125 clear_port_feature(hub->hdev, port1,
2126 USB_PORT_FEAT_C_CONNECTION);
2127 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2128 clear_port_feature(hub->hdev, port1,
2129 USB_PORT_FEAT_C_PORT_LINK_STATE);
2130 if (portchange & USB_PORT_STAT_C_RESET)
2131 clear_port_feature(hub->hdev, port1,
2132 USB_PORT_FEAT_C_RESET);
2133 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2134 port1);
2135 ret = hub_port_reset(hub, port1,
2136 udev, HUB_BH_RESET_TIME,
2137 true);
2138 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2139 clear_port_feature(hub->hdev, port1,
2140 USB_PORT_FEAT_C_CONNECTION);
2141 return ret;
2142 }
75d7cf72
AX		 2143 /* Device went away? */
2144 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2145 return -ENOTCONN;
2146
2147 /* bomb out completely if the connection bounced */
2148 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2149 return -ENOTCONN;
2150
2151 /* if we`ve finished resetting, then break out of
2152 * the loop
2153 */
2154 if (!(portstatus & USB_PORT_STAT_RESET) &&
2155 (portstatus & USB_PORT_STAT_ENABLE)) {
2156 if (hub_is_wusb(hub))
2157 udev->speed = USB_SPEED_WIRELESS;
2158 else if (hub_is_superspeed(hub->hdev))
2159 udev->speed = USB_SPEED_SUPER;
2160 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2161 udev->speed = USB_SPEED_HIGH;
2162 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2163 udev->speed = USB_SPEED_LOW;
2164 else
2165 udev->speed = USB_SPEED_FULL;
2166 return 0;
2167 }
2168 } else {
2169 if (portchange & USB_PORT_STAT_C_BH_RESET)
2170 return 0;
1da177e4
LT		 2171 }
2172
2173 /* switch to the long delay after two short delay failures */
2174 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2175 delay = HUB_LONG_RESET_TIME;
2176
2177 dev_dbg (hub->intfdev,
75d7cf72
AX		 2178 "port %d not %sreset yet, waiting %dms\n",
2179 port1, warm ? "warm " : "", delay);
1da177e4
LT		 2180 }
2181
2182 return -EBUSY;
2183}
2184
75d7cf72
AX		 2185static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2186 struct usb_device *udev, int *status, bool warm)
2187{
2188 switch (*status) {
2189 case 0:
2190 if (!warm) {
2191 struct usb_hcd *hcd;
2192 /* TRSTRCY = 10 ms; plus some extra */
2193 msleep(10 + 40);
2194 update_devnum(udev, 0);
2195 hcd = bus_to_hcd(udev->bus);
2196 if (hcd->driver->reset_device) {
2197 *status = hcd->driver->reset_device(hcd, udev);
2198 if (*status < 0) {
2199 dev_err(&udev->dev, "Cannot reset "
2200 "HCD device state\n");
2201 break;
2202 }
2203 }
2204 }
2205 /* FALL THROUGH */
2206 case -ENOTCONN:
2207 case -ENODEV:
2208 clear_port_feature(hub->hdev,
2209 port1, USB_PORT_FEAT_C_RESET);
2210 /* FIXME need disconnect() for NOTATTACHED device */
2211 if (warm) {
2212 clear_port_feature(hub->hdev, port1,
2213 USB_PORT_FEAT_C_BH_PORT_RESET);
2214 clear_port_feature(hub->hdev, port1,
2215 USB_PORT_FEAT_C_PORT_LINK_STATE);
2216 } else {
2217 usb_set_device_state(udev, *status
2218 ? USB_STATE_NOTATTACHED
2219 : USB_STATE_DEFAULT);
2220 }
2221 break;
2222 }
2223}
2224
2225/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
1da177e4 2226static int hub_port_reset(struct usb_hub *hub, int port1,
75d7cf72 2227 struct usb_device *udev, unsigned int delay, bool warm)
1da177e4
LT		 2228{
2229 int i, status;
2230
75d7cf72
AX		 2231 if (!warm) {
2232 /* Block EHCI CF initialization during the port reset.
2233 * Some companion controllers don't like it when they mix.
2234 */
2235 down_read(&ehci_cf_port_reset_rwsem);
2236 } else {
2237 if (!hub_is_superspeed(hub->hdev)) {
2238 dev_err(hub->intfdev, "only USB3 hub support "
2239 "warm reset\n");
2240 return -EINVAL;
2241 }
2242 }
32fe0198 2243
1da177e4
LT		 2244 /* Reset the port */
2245 for (i = 0; i < PORT_RESET_TRIES; i++) {
75d7cf72
AX		 2246 status = set_port_feature(hub->hdev, port1, (warm ?
2247 USB_PORT_FEAT_BH_PORT_RESET :
2248 USB_PORT_FEAT_RESET));
2249 if (status) {
1da177e4 2250 dev_err(hub->intfdev,
75d7cf72
AX		 2251 "cannot %sreset port %d (err = %d)\n",
2252 warm ? "warm " : "", port1, status);
2253 } else {
2254 status = hub_port_wait_reset(hub, port1, udev, delay,
2255 warm);
dd16525b 2256 if (status && status != -ENOTCONN)
1da177e4
LT		 2257 dev_dbg(hub->intfdev,
2258 "port_wait_reset: err = %d\n",
2259 status);
2260 }
2261
2262 /* return on disconnect or reset */
75d7cf72
AX		 2263 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2264 hub_port_finish_reset(hub, port1, udev, &status, warm);
32fe0198 2265 goto done;
1da177e4
LT		 2266 }
2267
2268 dev_dbg (hub->intfdev,
75d7cf72
AX		 2269 "port %d not enabled, trying %sreset again...\n",
2270 port1, warm ? "warm " : "");
1da177e4
LT		 2271 delay = HUB_LONG_RESET_TIME;
2272 }
2273
2274 dev_err (hub->intfdev,
2275 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2276 port1);
2277
75d7cf72
AX		 2278done:
2279 if (!warm)
2280 up_read(&ehci_cf_port_reset_rwsem);
5e467f6e 2281
75d7cf72 2282 return status;
5e467f6e
AX		 2283}
2284
0ed9a57e
AX		 2285/* Check if a port is power on */
2286static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2287{
2288 int ret = 0;
2289
2290 if (hub_is_superspeed(hub->hdev)) {
2291 if (portstatus & USB_SS_PORT_STAT_POWER)
2292 ret = 1;
2293 } else {
2294 if (portstatus & USB_PORT_STAT_POWER)
2295 ret = 1;
2296 }
2297
2298 return ret;
2299}
2300
d388dab7 2301#ifdef CONFIG_PM
1da177e4 2302
0ed9a57e
AX		 2303/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2304static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2305{
2306 int ret = 0;
2307
2308 if (hub_is_superspeed(hub->hdev)) {
2309 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2310 == USB_SS_PORT_LS_U3)
2311 ret = 1;
2312 } else {
2313 if (portstatus & USB_PORT_STAT_SUSPEND)
2314 ret = 1;
2315 }
2316
2317 return ret;
2318}
b01b03f3
AS		 2319
2320/* Determine whether the device on a port is ready for a normal resume,
2321 * is ready for a reset-resume, or should be disconnected.
2322 */
2323static int check_port_resume_type(struct usb_device *udev,
2324 struct usb_hub *hub, int port1,
2325 int status, unsigned portchange, unsigned portstatus)
2326{
2327 /* Is the device still present? */
0ed9a57e
AX		 2328 if (status || port_is_suspended(hub, portstatus) ||
2329 !port_is_power_on(hub, portstatus) ||
2330 !(portstatus & USB_PORT_STAT_CONNECTION)) {
b01b03f3
AS		 2331 if (status >= 0)
2332 status = -ENODEV;
2333 }
2334
86c57edf
AS		 2335 /* Can't do a normal resume if the port isn't enabled,
2336 * so try a reset-resume instead.
2337 */
2338 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2339 if (udev->persist_enabled)
2340 udev->reset_resume = 1;
2341 else
2342 status = -ENODEV;
2343 }
b01b03f3
AS		 2344
2345 if (status) {
2346 dev_dbg(hub->intfdev,
2347 "port %d status %04x.%04x after resume, %d\n",
2348 port1, portchange, portstatus, status);
2349 } else if (udev->reset_resume) {
2350
2351 /* Late port handoff can set status-change bits */
2352 if (portchange & USB_PORT_STAT_C_CONNECTION)
2353 clear_port_feature(hub->hdev, port1,
2354 USB_PORT_FEAT_C_CONNECTION);
2355 if (portchange & USB_PORT_STAT_C_ENABLE)
2356 clear_port_feature(hub->hdev, port1,
2357 USB_PORT_FEAT_C_ENABLE);
2358 }
2359
2360 return status;
2361}
2362
1da177e4
LT		 2363#ifdef CONFIG_USB_SUSPEND
2364
2365/*
624d6c07
AS		 2366 * usb_port_suspend - suspend a usb device's upstream port
2367 * @udev: device that's no longer in active use, not a root hub
2368 * Context: must be able to sleep; device not locked; pm locks held
2369 *
2370 * Suspends a USB device that isn't in active use, conserving power.
2371 * Devices may wake out of a suspend, if anything important happens,
2372 * using the remote wakeup mechanism. They may also be taken out of
2373 * suspend by the host, using usb_port_resume(). It's also routine
2374 * to disconnect devices while they are suspended.
2375 *
2376 * This only affects the USB hardware for a device; its interfaces
2377 * (and, for hubs, child devices) must already have been suspended.
2378 *
1da177e4
LT		 2379 * Selective port suspend reduces power; most suspended devices draw
2380 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2381 * All devices below the suspended port are also suspended.
2382 *
2383 * Devices leave suspend state when the host wakes them up. Some devices
2384 * also support "remote wakeup", where the device can activate the USB
2385 * tree above them to deliver data, such as a keypress or packet. In
2386 * some cases, this wakes the USB host.
624d6c07
AS		 2387 *
2388 * Suspending OTG devices may trigger HNP, if that's been enabled
2389 * between a pair of dual-role devices. That will change roles, such
2390 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2391 *
2392 * Devices on USB hub ports have only one "suspend" state, corresponding
2393 * to ACPI D2, "may cause the device to lose some context".
2394 * State transitions include:
2395 *
2396 * - suspend, resume ... when the VBUS power link stays live
2397 * - suspend, disconnect ... VBUS lost
2398 *
2399 * Once VBUS drop breaks the circuit, the port it's using has to go through
2400 * normal re-enumeration procedures, starting with enabling VBUS power.
2401 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2402 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2403 * timer, no SRP, no requests through sysfs.
2404 *
2405 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2406 * the root hub for their bus goes into global suspend ... so we don't
2407 * (falsely) update the device power state to say it suspended.
2408 *
2409 * Returns 0 on success, else negative errno.
1da177e4 2410 */
65bfd296 2411int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
1da177e4 2412{
624d6c07
AS		 2413 struct usb_hub *hub = hdev_to_hub(udev->parent);
2414 int port1 = udev->portnum;
2415 int status;
1da177e4 2416
1da177e4
LT		 2417 /* enable remote wakeup when appropriate; this lets the device
2418 * wake up the upstream hub (including maybe the root hub).
2419 *
2420 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2421 * we don't explicitly enable it here.
2422 */
645daaab 2423 if (udev->do_remote_wakeup) {
623bef9e
SS		 2424 if (!hub_is_superspeed(hub->hdev)) {
2425 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2426 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2427 USB_DEVICE_REMOTE_WAKEUP, 0,
2428 NULL, 0,
2429 USB_CTRL_SET_TIMEOUT);
2430 } else {
2431 /* Assume there's only one function on the USB 3.0
2432 * device and enable remote wake for the first
2433 * interface. FIXME if the interface association
2434 * descriptor shows there's more than one function.
2435 */
2436 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2437 USB_REQ_SET_FEATURE,
2438 USB_RECIP_INTERFACE,
2439 USB_INTRF_FUNC_SUSPEND,
3b9b6acd
SS		 2440 USB_INTRF_FUNC_SUSPEND_RW |
2441 USB_INTRF_FUNC_SUSPEND_LP,
623bef9e
SS		 2442 NULL, 0,
2443 USB_CTRL_SET_TIMEOUT);
2444 }
0c487206 2445 if (status) {
624d6c07
AS		 2446 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2447 status);
0c487206 2448 /* bail if autosuspend is requested */
5b1b0b81 2449 if (PMSG_IS_AUTO(msg))
0c487206
ON		 2450 return status;
2451 }
1da177e4
LT		 2452 }
2453
65580b43
AX		 2454 /* disable USB2 hardware LPM */
2455 if (udev->usb2_hw_lpm_enabled == 1)
2456 usb_set_usb2_hardware_lpm(udev, 0);
2457
1da177e4 2458 /* see 7.1.7.6 */
a7114230
AX		 2459 if (hub_is_superspeed(hub->hdev))
2460 status = set_port_feature(hub->hdev,
2461 port1 | (USB_SS_PORT_LS_U3 << 3),
2462 USB_PORT_FEAT_LINK_STATE);
a8f08d86
AX		 2463 else
2464 status = set_port_feature(hub->hdev, port1,
2465 USB_PORT_FEAT_SUSPEND);
1da177e4 2466 if (status) {
624d6c07
AS		 2467 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2468 port1, status);
1da177e4 2469 /* paranoia: "should not happen" */
0c487206
ON		 2470 if (udev->do_remote_wakeup)
2471 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1da177e4
LT		 2472 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2473 USB_DEVICE_REMOTE_WAKEUP, 0,
2474 NULL, 0,
2475 USB_CTRL_SET_TIMEOUT);
cbb33004
AS		 2476
2477 /* System sleep transitions should never fail */
5b1b0b81 2478 if (!PMSG_IS_AUTO(msg))
cbb33004 2479 status = 0;
1da177e4
LT		 2480 } else {
2481 /* device has up to 10 msec to fully suspend */
30b1a7a3
AS		 2482 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2483 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2484 udev->do_remote_wakeup);
1da177e4
LT		 2485 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2486 msleep(10);
2487 }
c08512c7 2488 usb_mark_last_busy(hub->hdev);
1da177e4
LT		 2489 return status;
2490}
2491
1da177e4 2492/*
390a8c34
DB		 2493 * If the USB "suspend" state is in use (rather than "global suspend"),
2494 * many devices will be individually taken out of suspend state using
54515fe5 2495 * special "resume" signaling. This routine kicks in shortly after
1da177e4
LT		 2496 * hardware resume signaling is finished, either because of selective
2497 * resume (by host) or remote wakeup (by device) ... now see what changed
2498 * in the tree that's rooted at this device.
54515fe5
AS		 2499 *
2500 * If @udev->reset_resume is set then the device is reset before the
2501 * status check is done.
1da177e4 2502 */
140d8f68 2503static int finish_port_resume(struct usb_device *udev)
1da177e4 2504{
54515fe5 2505 int status = 0;
1da177e4
LT		 2506 u16 devstatus;
2507
2508 /* caller owns the udev device lock */
b9cef6c3
WF		 2509 dev_dbg(&udev->dev, "%s\n",
2510 udev->reset_resume ? "finish reset-resume" : "finish resume");
1da177e4
LT		 2511
2512 /* usb ch9 identifies four variants of SUSPENDED, based on what
2513 * state the device resumes to. Linux currently won't see the
2514 * first two on the host side; they'd be inside hub_port_init()
2515 * during many timeouts, but khubd can't suspend until later.
2516 */
2517 usb_set_device_state(udev, udev->actconfig
2518 ? USB_STATE_CONFIGURED
2519 : USB_STATE_ADDRESS);
1da177e4 2520
54515fe5
AS		 2521 /* 10.5.4.5 says not to reset a suspended port if the attached
2522 * device is enabled for remote wakeup. Hence the reset
2523 * operation is carried out here, after the port has been
2524 * resumed.
2525 */
2526 if (udev->reset_resume)
86c57edf 2527 retry_reset_resume:
742120c6 2528 status = usb_reset_and_verify_device(udev);
54515fe5 2529
1da177e4
LT		 2530 /* 10.5.4.5 says be sure devices in the tree are still there.
2531 * For now let's assume the device didn't go crazy on resume,
2532 * and device drivers will know about any resume quirks.
2533 */
54515fe5 2534 if (status == 0) {
46dede46 2535 devstatus = 0;
54515fe5
AS		 2536 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2537 if (status >= 0)
46dede46 2538 status = (status > 0 ? 0 : -ENODEV);
86c57edf
AS		 2539
2540 /* If a normal resume failed, try doing a reset-resume */
2541 if (status && !udev->reset_resume && udev->persist_enabled) {
2542 dev_dbg(&udev->dev, "retry with reset-resume\n");
2543 udev->reset_resume = 1;
2544 goto retry_reset_resume;
2545 }
54515fe5 2546 }
b40b7a90 2547
624d6c07
AS		 2548 if (status) {
2549 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2550 status);
2551 } else if (udev->actconfig) {
1da177e4 2552 le16_to_cpus(&devstatus);
686314cf 2553 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1da177e4
LT		 2554 status = usb_control_msg(udev,
2555 usb_sndctrlpipe(udev, 0),
2556 USB_REQ_CLEAR_FEATURE,
2557 USB_RECIP_DEVICE,
2558 USB_DEVICE_REMOTE_WAKEUP, 0,
2559 NULL, 0,
2560 USB_CTRL_SET_TIMEOUT);
a8e7c565 2561 if (status)
b9cef6c3
WF		 2562 dev_dbg(&udev->dev,
2563 "disable remote wakeup, status %d\n",
2564 status);
4bf0ba86 2565 }
1da177e4 2566 status = 0;
1da177e4
LT		 2567 }
2568 return status;
2569}
2570
624d6c07
AS		 2571/*
2572 * usb_port_resume - re-activate a suspended usb device's upstream port
2573 * @udev: device to re-activate, not a root hub
2574 * Context: must be able to sleep; device not locked; pm locks held
2575 *
2576 * This will re-activate the suspended device, increasing power usage
2577 * while letting drivers communicate again with its endpoints.
2578 * USB resume explicitly guarantees that the power session between
2579 * the host and the device is the same as it was when the device
2580 * suspended.
2581 *
feccc30d
AS		 2582 * If @udev->reset_resume is set then this routine won't check that the
2583 * port is still enabled. Furthermore, finish_port_resume() above will
54515fe5
AS		 2584 * reset @udev. The end result is that a broken power session can be
2585 * recovered and @udev will appear to persist across a loss of VBUS power.
2586 *
2587 * For example, if a host controller doesn't maintain VBUS suspend current
2588 * during a system sleep or is reset when the system wakes up, all the USB
2589 * power sessions below it will be broken. This is especially troublesome
2590 * for mass-storage devices containing mounted filesystems, since the
2591 * device will appear to have disconnected and all the memory mappings
2592 * to it will be lost. Using the USB_PERSIST facility, the device can be
2593 * made to appear as if it had not disconnected.
2594 *
742120c6 2595 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
feccc30d 2596 * every effort to insure that the same device is present after the
54515fe5
AS		 2597 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2598 * quite possible for a device to remain unaltered but its media to be
2599 * changed. If the user replaces a flash memory card while the system is
2600 * asleep, he will have only himself to blame when the filesystem on the
2601 * new card is corrupted and the system crashes.
2602 *
624d6c07
AS		 2603 * Returns 0 on success, else negative errno.
2604 */
65bfd296 2605int usb_port_resume(struct usb_device *udev, pm_message_t msg)
1da177e4 2606{
624d6c07
AS		 2607 struct usb_hub *hub = hdev_to_hub(udev->parent);
2608 int port1 = udev->portnum;
2609 int status;
2610 u16 portchange, portstatus;
d25450c6
AS		 2611
2612 /* Skip the initial Clear-Suspend step for a remote wakeup */
2613 status = hub_port_status(hub, port1, &portstatus, &portchange);
0ed9a57e 2614 if (status == 0 && !port_is_suspended(hub, portstatus))
d25450c6 2615 goto SuspendCleared;
1da177e4
LT		 2616
2617 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2618
d5cbad4b
AS		 2619 set_bit(port1, hub->busy_bits);
2620
1da177e4 2621 /* see 7.1.7.7; affects power usage, but not budgeting */
a7114230
AX		 2622 if (hub_is_superspeed(hub->hdev))
2623 status = set_port_feature(hub->hdev,
2624 port1 | (USB_SS_PORT_LS_U0 << 3),
2625 USB_PORT_FEAT_LINK_STATE);
2626 else
2627 status = clear_port_feature(hub->hdev,
2628 port1, USB_PORT_FEAT_SUSPEND);
1da177e4 2629 if (status) {
624d6c07
AS		 2630 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2631 port1, status);
1da177e4 2632 } else {
1da177e4 2633 /* drive resume for at least 20 msec */
686314cf 2634 dev_dbg(&udev->dev, "usb %sresume\n",
5b1b0b81 2635 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
1da177e4
LT		 2636 msleep(25);
2637
1da177e4
LT		 2638 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2639 * stop resume signaling. Then finish the resume
2640 * sequence.
2641 */
d25450c6 2642 status = hub_port_status(hub, port1, &portstatus, &portchange);
54515fe5 2643
b01b03f3
AS		 2644 /* TRSMRCY = 10 msec */
2645 msleep(10);
2646 }
2647
54515fe5 2648 SuspendCleared:
b01b03f3 2649 if (status == 0) {
a7114230
AX		 2650 if (hub_is_superspeed(hub->hdev)) {
2651 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2652 clear_port_feature(hub->hdev, port1,
2653 USB_PORT_FEAT_C_PORT_LINK_STATE);
2654 } else {
2655 if (portchange & USB_PORT_STAT_C_SUSPEND)
2656 clear_port_feature(hub->hdev, port1,
2657 USB_PORT_FEAT_C_SUSPEND);
2658 }
1da177e4 2659 }
1da177e4 2660
d5cbad4b 2661 clear_bit(port1, hub->busy_bits);
d5cbad4b 2662
b01b03f3
AS		 2663 status = check_port_resume_type(udev,
2664 hub, port1, status, portchange, portstatus);
54515fe5
AS		 2665 if (status == 0)
2666 status = finish_port_resume(udev);
2667 if (status < 0) {
2668 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2669 hub_port_logical_disconnect(hub, port1);
65580b43
AX		 2670 } else {
2671 /* Try to enable USB2 hardware LPM */
2672 if (udev->usb2_hw_lpm_capable == 1)
2673 usb_set_usb2_hardware_lpm(udev, 1);
54515fe5 2674 }
65580b43 2675
1da177e4
LT		 2676 return status;
2677}
2678
8808f00c 2679/* caller has locked udev */
0534d468 2680int usb_remote_wakeup(struct usb_device *udev)
1da177e4
LT		 2681{
2682 int status = 0;
2683
1da177e4 2684 if (udev->state == USB_STATE_SUSPENDED) {
645daaab 2685 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
9bbdf1e0
AS		 2686 status = usb_autoresume_device(udev);
2687 if (status == 0) {
2688 /* Let the drivers do their thing, then... */
2689 usb_autosuspend_device(udev);
2690 }
1da177e4 2691 }
1da177e4
LT		 2692 return status;
2693}
2694
d388dab7
AS		 2695#else /* CONFIG_USB_SUSPEND */
2696
2697/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2698
65bfd296 2699int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
d388dab7
AS		 2700{
2701 return 0;
2702}
2703
b01b03f3
AS		 2704/* However we may need to do a reset-resume */
2705
65bfd296 2706int usb_port_resume(struct usb_device *udev, pm_message_t msg)
d388dab7 2707{
b01b03f3
AS		 2708 struct usb_hub *hub = hdev_to_hub(udev->parent);
2709 int port1 = udev->portnum;
2710 int status;
2711 u16 portchange, portstatus;
2712
2713 status = hub_port_status(hub, port1, &portstatus, &portchange);
2714 status = check_port_resume_type(udev,
2715 hub, port1, status, portchange, portstatus);
54515fe5 2716
b01b03f3
AS		 2717 if (status) {
2718 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2719 hub_port_logical_disconnect(hub, port1);
2720 } else if (udev->reset_resume) {
54515fe5 2721 dev_dbg(&udev->dev, "reset-resume\n");
742120c6 2722 status = usb_reset_and_verify_device(udev);
54515fe5
AS		 2723 }
2724 return status;
d388dab7
AS		 2725}
2726
d388dab7
AS		 2727#endif
2728
db690874 2729static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1da177e4
LT		 2730{
2731 struct usb_hub *hub = usb_get_intfdata (intf);
2732 struct usb_device *hdev = hub->hdev;
2733 unsigned port1;
4296c70a 2734 int status;
1da177e4 2735
cbb33004 2736 /* Warn if children aren't already suspended */
1da177e4
LT		 2737 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2738 struct usb_device *udev;
2739
2740 udev = hdev->children [port1-1];
6840d255 2741 if (udev && udev->can_submit) {
cbb33004 2742 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
5b1b0b81 2743 if (PMSG_IS_AUTO(msg))
cbb33004 2744 return -EBUSY;
c9f89fa4 2745 }
1da177e4 2746 }
4296c70a
SS		 2747 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
2748 /* Enable hub to send remote wakeup for all ports. */
2749 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2750 status = set_port_feature(hdev,
2751 port1 |
2752 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
2753 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
2754 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
2755 USB_PORT_FEAT_REMOTE_WAKE_MASK);
2756 }
2757 }
1da177e4 2758
441b62c1 2759 dev_dbg(&intf->dev, "%s\n", __func__);
40f122f3 2760
12f1ff83 2761 /* stop khubd and related activity */
4330354f 2762 hub_quiesce(hub, HUB_SUSPEND);
b6f6436d 2763 return 0;
1da177e4
LT		 2764}
2765
2766static int hub_resume(struct usb_interface *intf)
2767{
5e6effae 2768 struct usb_hub *hub = usb_get_intfdata(intf);
40f122f3 2769
5e6effae 2770 dev_dbg(&intf->dev, "%s\n", __func__);
f2835219 2771 hub_activate(hub, HUB_RESUME);
1da177e4
LT		 2772 return 0;
2773}
2774
b41a60ec 2775static int hub_reset_resume(struct usb_interface *intf)
f07600cf 2776{
b41a60ec 2777 struct usb_hub *hub = usb_get_intfdata(intf);
f07600cf 2778
5e6effae 2779 dev_dbg(&intf->dev, "%s\n", __func__);
f2835219 2780 hub_activate(hub, HUB_RESET_RESUME);
f07600cf
AS		 2781 return 0;
2782}
2783
54515fe5
AS		 2784/**
2785 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2786 * @rhdev: struct usb_device for the root hub
2787 *
2788 * The USB host controller driver calls this function when its root hub
2789 * is resumed and Vbus power has been interrupted or the controller
feccc30d
AS		 2790 * has been reset. The routine marks @rhdev as having lost power.
2791 * When the hub driver is resumed it will take notice and carry out
2792 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2793 * the others will be disconnected.
54515fe5
AS		 2794 */
2795void usb_root_hub_lost_power(struct usb_device *rhdev)
2796{
2797 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2798 rhdev->reset_resume = 1;
2799}
2800EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2801
d388dab7
AS		 2802#else /* CONFIG_PM */
2803
f07600cf
AS		 2804#define hub_suspend NULL
2805#define hub_resume NULL
2806#define hub_reset_resume NULL
d388dab7
AS		 2807#endif
2808
1da177e4
LT		 2809
2810/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2811 *
2812 * Between connect detection and reset signaling there must be a delay
2813 * of 100ms at least for debounce and power-settling. The corresponding
2814 * timer shall restart whenever the downstream port detects a disconnect.
2815 *
2816 * Apparently there are some bluetooth and irda-dongles and a number of
2817 * low-speed devices for which this debounce period may last over a second.
2818 * Not covered by the spec - but easy to deal with.
2819 *
2820 * This implementation uses a 1500ms total debounce timeout; if the
2821 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2822 * every 25ms for transient disconnects. When the port status has been
2823 * unchanged for 100ms it returns the port status.
2824 */
1da177e4
LT		 2825static int hub_port_debounce(struct usb_hub *hub, int port1)
2826{
2827 int ret;
2828 int total_time, stable_time = 0;
2829 u16 portchange, portstatus;
2830 unsigned connection = 0xffff;
2831
2832 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2833 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2834 if (ret < 0)
2835 return ret;
2836
2837 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2838 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2839 stable_time += HUB_DEBOUNCE_STEP;
2840 if (stable_time >= HUB_DEBOUNCE_STABLE)
2841 break;
2842 } else {
2843 stable_time = 0;
2844 connection = portstatus & USB_PORT_STAT_CONNECTION;
2845 }
2846
2847 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2848 clear_port_feature(hub->hdev, port1,
2849 USB_PORT_FEAT_C_CONNECTION);
2850 }
2851
2852 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2853 break;
2854 msleep(HUB_DEBOUNCE_STEP);
2855 }
2856
2857 dev_dbg (hub->intfdev,
2858 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2859 port1, total_time, stable_time, portstatus);
2860
2861 if (stable_time < HUB_DEBOUNCE_STABLE)
2862 return -ETIMEDOUT;
2863 return portstatus;
2864}
2865
fc721f51 2866void usb_ep0_reinit(struct usb_device *udev)
1da177e4 2867{
ddeac4e7
AS		 2868 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2869 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2caf7fcd 2870 usb_enable_endpoint(udev, &udev->ep0, true);
1da177e4 2871}
fc721f51 2872EXPORT_SYMBOL_GPL(usb_ep0_reinit);
1da177e4
LT		 2873
2874#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2875#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2876
4326ed0b 2877static int hub_set_address(struct usb_device *udev, int devnum)
1da177e4
LT		 2878{
2879 int retval;
c6515272 2880 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1da177e4 2881
c6515272
SS		 2882 /*
2883 * The host controller will choose the device address,
2884 * instead of the core having chosen it earlier
2885 */
2886 if (!hcd->driver->address_device && devnum <= 1)
1da177e4
LT		 2887 return -EINVAL;
2888 if (udev->state == USB_STATE_ADDRESS)
2889 return 0;
2890 if (udev->state != USB_STATE_DEFAULT)
2891 return -EINVAL;
c8d4af8e 2892 if (hcd->driver->address_device)
c6515272 2893 retval = hcd->driver->address_device(hcd, udev);
c8d4af8e 2894 else
c6515272
SS		 2895 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2896 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2897 NULL, 0, USB_CTRL_SET_TIMEOUT);
1da177e4 2898 if (retval == 0) {
3b29b68b 2899 update_devnum(udev, devnum);
4953d141 2900 /* Device now using proper address. */
1da177e4 2901 usb_set_device_state(udev, USB_STATE_ADDRESS);
fc721f51 2902 usb_ep0_reinit(udev);
1da177e4
LT		 2903 }
2904 return retval;
2905}
2906
2907/* Reset device, (re)assign address, get device descriptor.
2908 * Device connection must be stable, no more debouncing needed.
2909 * Returns device in USB_STATE_ADDRESS, except on error.
2910 *
2911 * If this is called for an already-existing device (as part of
742120c6 2912 * usb_reset_and_verify_device), the caller must own the device lock. For a
1da177e4
LT		 2913 * newly detected device that is not accessible through any global
2914 * pointers, it's not necessary to lock the device.
2915 */
2916static int
2917hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2918 int retry_counter)
2919{
4186ecf8 2920 static DEFINE_MUTEX(usb_address0_mutex);
1da177e4
LT		 2921
2922 struct usb_device *hdev = hub->hdev;
e7b77172 2923 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
1da177e4
LT		 2924 int i, j, retval;
2925 unsigned delay = HUB_SHORT_RESET_TIME;
2926 enum usb_device_speed oldspeed = udev->speed;
e538dfda 2927 const char *speed;
4326ed0b 2928 int devnum = udev->devnum;
1da177e4
LT		 2929
2930 /* root hub ports have a slightly longer reset period
2931 * (from USB 2.0 spec, section 7.1.7.5)
2932 */
2933 if (!hdev->parent) {
2934 delay = HUB_ROOT_RESET_TIME;
2935 if (port1 == hdev->bus->otg_port)
2936 hdev->bus->b_hnp_enable = 0;
2937 }
2938
2939 /* Some low speed devices have problems with the quick delay, so */
2940 /* be a bit pessimistic with those devices. RHbug #23670 */
2941 if (oldspeed == USB_SPEED_LOW)
2942 delay = HUB_LONG_RESET_TIME;
2943
4186ecf8 2944 mutex_lock(&usb_address0_mutex);
1da177e4 2945
07194ab7
LT		 2946 /* Reset the device; full speed may morph to high speed */
2947 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
75d7cf72 2948 retval = hub_port_reset(hub, port1, udev, delay, false);
07194ab7
LT		 2949 if (retval < 0) /* error or disconnect */
2950 goto fail;
2951 /* success, speed is known */
2952
1da177e4
LT		 2953 retval = -ENODEV;
2954
2955 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2956 dev_dbg(&udev->dev, "device reset changed speed!\n");
2957 goto fail;
2958 }
2959 oldspeed = udev->speed;
4326ed0b 2960
1da177e4
LT		 2961 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2962 * it's fixed size except for full speed devices.
5bb6e0ae
IPG		 2963 * For Wireless USB devices, ep0 max packet is always 512 (tho
2964 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
1da177e4
LT		 2965 */
2966 switch (udev->speed) {
6b403b02 2967 case USB_SPEED_SUPER:
551cdbbe 2968 case USB_SPEED_WIRELESS: /* fixed at 512 */
551509d2 2969 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
5bb6e0ae 2970 break;
1da177e4 2971 case USB_SPEED_HIGH: /* fixed at 64 */
551509d2 2972 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1da177e4
LT		 2973 break;
2974 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2975 /* to determine the ep0 maxpacket size, try to read
2976 * the device descriptor to get bMaxPacketSize0 and
2977 * then correct our initial guess.
2978 */
551509d2 2979 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
1da177e4
LT		 2980 break;
2981 case USB_SPEED_LOW: /* fixed at 8 */
551509d2 2982 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
1da177e4
LT		 2983 break;
2984 default:
2985 goto fail;
2986 }
e538dfda
MN		 2987
2988 if (udev->speed == USB_SPEED_WIRELESS)
2989 speed = "variable speed Wireless";
2990 else
2991 speed = usb_speed_string(udev->speed);
2992
c6515272
SS		 2993 if (udev->speed != USB_SPEED_SUPER)
2994 dev_info(&udev->dev,
e538dfda
MN		 2995 "%s %s USB device number %d using %s\n",
2996 (udev->config) ? "reset" : "new", speed,
3b29b68b 2997 devnum, udev->bus->controller->driver->name);
1da177e4
LT		 2998
2999 /* Set up TT records, if needed */
3000 if (hdev->tt) {
3001 udev->tt = hdev->tt;
3002 udev->ttport = hdev->ttport;
3003 } else if (udev->speed != USB_SPEED_HIGH
3004 && hdev->speed == USB_SPEED_HIGH) {
d199c96d
AS		 3005 if (!hub->tt.hub) {
3006 dev_err(&udev->dev, "parent hub has no TT\n");
3007 retval = -EINVAL;
3008 goto fail;
3009 }
1da177e4
LT		 3010 udev->tt = &hub->tt;
3011 udev->ttport = port1;
3012 }
3013
3014 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3015 * Because device hardware and firmware is sometimes buggy in
3016 * this area, and this is how Linux has done it for ages.
3017 * Change it cautiously.
3018 *
3019 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3020 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3021 * so it may help with some non-standards-compliant devices.
3022 * Otherwise we start with SET_ADDRESS and then try to read the
3023 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3024 * value.
3025 */
3026 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
c6515272 3027 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
1da177e4
LT		 3028 struct usb_device_descriptor *buf;
3029 int r = 0;
3030
3031#define GET_DESCRIPTOR_BUFSIZE 64
3032 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3033 if (!buf) {
3034 retval = -ENOMEM;
3035 continue;
3036 }
3037
b89ee19a
AS		 3038 /* Retry on all errors; some devices are flakey.
3039 * 255 is for WUSB devices, we actually need to use
3040 * 512 (WUSB1.0[4.8.1]).
1da177e4
LT		 3041 */
3042 for (j = 0; j < 3; ++j) {
3043 buf->bMaxPacketSize0 = 0;
3044 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3045 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3046 USB_DT_DEVICE << 8, 0,
3047 buf, GET_DESCRIPTOR_BUFSIZE,
fd7c519d 3048 initial_descriptor_timeout);
1da177e4 3049 switch (buf->bMaxPacketSize0) {
5bb6e0ae 3050 case 8: case 16: case 32: case 64: case 255:
1da177e4
LT		 3051 if (buf->bDescriptorType ==
3052 USB_DT_DEVICE) {
3053 r = 0;
3054 break;
3055 }
3056 /* FALL THROUGH */
3057 default:
3058 if (r == 0)
3059 r = -EPROTO;
3060 break;
3061 }
3062 if (r == 0)
3063 break;
3064 }
3065 udev->descriptor.bMaxPacketSize0 =
3066 buf->bMaxPacketSize0;
3067 kfree(buf);
3068
75d7cf72 3069 retval = hub_port_reset(hub, port1, udev, delay, false);
1da177e4
LT		 3070 if (retval < 0) /* error or disconnect */
3071 goto fail;
3072 if (oldspeed != udev->speed) {
3073 dev_dbg(&udev->dev,
3074 "device reset changed speed!\n");
3075 retval = -ENODEV;
3076 goto fail;
3077 }
3078 if (r) {
b9cef6c3
WF		 3079 dev_err(&udev->dev,
3080 "device descriptor read/64, error %d\n",
3081 r);
1da177e4
LT		 3082 retval = -EMSGSIZE;
3083 continue;
3084 }
3085#undef GET_DESCRIPTOR_BUFSIZE
3086 }
3087
6c529cdc
IPG		 3088 /*
3089 * If device is WUSB, we already assigned an
3090 * unauthorized address in the Connect Ack sequence;
3091 * authorization will assign the final address.
3092 */
c6515272 3093 if (udev->wusb == 0) {
6c529cdc
IPG		 3094 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3095 retval = hub_set_address(udev, devnum);
3096 if (retval >= 0)
3097 break;
3098 msleep(200);
3099 }
3100 if (retval < 0) {
3101 dev_err(&udev->dev,
3102 "device not accepting address %d, error %d\n",
3103 devnum, retval);
3104 goto fail;
3105 }
c6515272
SS		 3106 if (udev->speed == USB_SPEED_SUPER) {
3107 devnum = udev->devnum;
3108 dev_info(&udev->dev,
3b29b68b 3109 "%s SuperSpeed USB device number %d using %s\n",
c6515272 3110 (udev->config) ? "reset" : "new",
3b29b68b 3111 devnum, udev->bus->controller->driver->name);
c6515272 3112 }
6c529cdc
IPG		 3113
3114 /* cope with hardware quirkiness:
3115 * - let SET_ADDRESS settle, some device hardware wants it
3116 * - read ep0 maxpacket even for high and low speed,
3117 */
3118 msleep(10);
c6515272 3119 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
1da177e4 3120 break;
6c529cdc 3121 }
1da177e4
LT		 3122
3123 retval = usb_get_device_descriptor(udev, 8);
3124 if (retval < 8) {
b9cef6c3
WF		 3125 dev_err(&udev->dev,
3126 "device descriptor read/8, error %d\n",
3127 retval);
1da177e4
LT		 3128 if (retval >= 0)
3129 retval = -EMSGSIZE;
3130 } else {
3131 retval = 0;
3132 break;
3133 }
3134 }
3135 if (retval)
3136 goto fail;
3137
6b403b02
SS		 3138 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3139 udev->speed == USB_SPEED_SUPER)
3140 i = 512;
3141 else
3142 i = udev->descriptor.bMaxPacketSize0;
29cc8897 3143 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
56626a72 3144 if (udev->speed == USB_SPEED_LOW ||
1da177e4 3145 !(i == 8 || i == 16 || i == 32 || i == 64)) {
56626a72 3146 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
1da177e4
LT		 3147 retval = -EMSGSIZE;
3148 goto fail;
3149 }
56626a72
AS		 3150 if (udev->speed == USB_SPEED_FULL)
3151 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3152 else
3153 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
1da177e4 3154 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
fc721f51 3155 usb_ep0_reinit(udev);
1da177e4
LT		 3156 }
3157
3158 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3159 if (retval < (signed)sizeof(udev->descriptor)) {
b9cef6c3
WF		 3160 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3161 retval);
1da177e4
LT		 3162 if (retval >= 0)
3163 retval = -ENOMSG;
3164 goto fail;
3165 }
3166
1ff4df56
AX		 3167 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3168 retval = usb_get_bos_descriptor(udev);
3169 if (!retval) {
3170 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3171 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3172 udev->lpm_capable = 1;
3173 }
3174 }
3148bf04 3175
1da177e4 3176 retval = 0;
48f24970
AD		 3177 /* notify HCD that we have a device connected and addressed */
3178 if (hcd->driver->update_device)
3179 hcd->driver->update_device(hcd, udev);
1da177e4 3180fail:
4326ed0b 3181 if (retval) {
1da177e4 3182 hub_port_disable(hub, port1, 0);
3b29b68b 3183 update_devnum(udev, devnum); /* for disconnect processing */
4326ed0b 3184 }
4186ecf8 3185 mutex_unlock(&usb_address0_mutex);
1da177e4
LT		 3186 return retval;
3187}
3188
3189static void
3190check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3191{
3192 struct usb_qualifier_descriptor *qual;
3193 int status;
3194
e94b1766 3195 qual = kmalloc (sizeof *qual, GFP_KERNEL);
1da177e4
LT		 3196 if (qual == NULL)
3197 return;
3198
3199 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3200 qual, sizeof *qual);
3201 if (status == sizeof *qual) {
3202 dev_info(&udev->dev, "not running at top speed; "
3203 "connect to a high speed hub\n");
3204 /* hub LEDs are probably harder to miss than syslog */
3205 if (hub->has_indicators) {
3206 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
c4028958 3207 schedule_delayed_work (&hub->leds, 0);
1da177e4
LT		 3208 }
3209 }
1bc3c9e1 3210 kfree(qual);
1da177e4
LT		 3211}
3212
3213static unsigned
3214hub_power_remaining (struct usb_hub *hub)
3215{
3216 struct usb_device *hdev = hub->hdev;
3217 int remaining;
55c52718 3218 int port1;
1da177e4 3219
55c52718 3220 if (!hub->limited_power)
1da177e4
LT		 3221 return 0;
3222
55c52718
AS		 3223 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3224 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3225 struct usb_device *udev = hdev->children[port1 - 1];
3226 int delta;
1da177e4
LT		 3227
3228 if (!udev)
3229 continue;
3230
55c52718
AS		 3231 /* Unconfigured devices may not use more than 100mA,
3232 * or 8mA for OTG ports */
1da177e4 3233 if (udev->actconfig)
55c52718
AS		 3234 delta = udev->actconfig->desc.bMaxPower * 2;
3235 else if (port1 != udev->bus->otg_port || hdev->parent)
3236 delta = 100;
1da177e4 3237 else
55c52718
AS		 3238 delta = 8;
3239 if (delta > hub->mA_per_port)
b9cef6c3
WF		 3240 dev_warn(&udev->dev,
3241 "%dmA is over %umA budget for port %d!\n",
3242 delta, hub->mA_per_port, port1);
1da177e4
LT		 3243 remaining -= delta;
3244 }
3245 if (remaining < 0) {
55c52718
AS		 3246 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3247 - remaining);
1da177e4
LT		 3248 remaining = 0;
3249 }
3250 return remaining;
3251}
3252
3253/* Handle physical or logical connection change events.
3254 * This routine is called when:
3255 * a port connection-change occurs;
3256 * a port enable-change occurs (often caused by EMI);
742120c6 3257 * usb_reset_and_verify_device() encounters changed descriptors (as from
1da177e4
LT		 3258 * a firmware download)
3259 * caller already locked the hub
3260 */
3261static void hub_port_connect_change(struct usb_hub *hub, int port1,
3262 u16 portstatus, u16 portchange)
3263{
3264 struct usb_device *hdev = hub->hdev;
3265 struct device *hub_dev = hub->intfdev;
90da096e 3266 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
24618b0c
AS		 3267 unsigned wHubCharacteristics =
3268 le16_to_cpu(hub->descriptor->wHubCharacteristics);
8808f00c 3269 struct usb_device *udev;
1da177e4 3270 int status, i;
24618b0c 3271
1da177e4
LT		 3272 dev_dbg (hub_dev,
3273 "port %d, status %04x, change %04x, %s\n",
131dec34 3274 port1, portstatus, portchange, portspeed(hub, portstatus));
1da177e4
LT		 3275
3276 if (hub->has_indicators) {
3277 set_port_led(hub, port1, HUB_LED_AUTO);
3278 hub->indicator[port1-1] = INDICATOR_AUTO;
3279 }
1da177e4
LT		 3280
3281#ifdef CONFIG_USB_OTG
3282 /* during HNP, don't repeat the debounce */
3283 if (hdev->bus->is_b_host)
24618b0c
AS		 3284 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3285 USB_PORT_STAT_C_ENABLE);
1da177e4
LT		 3286#endif
3287
8808f00c
AS		 3288 /* Try to resuscitate an existing device */
3289 udev = hdev->children[port1-1];
3290 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3291 udev->state != USB_STATE_NOTATTACHED) {
8808f00c
AS		 3292 usb_lock_device(udev);
3293 if (portstatus & USB_PORT_STAT_ENABLE) {
3294 status = 0; /* Nothing to do */
8808f00c
AS		 3295
3296#ifdef CONFIG_USB_SUSPEND
5257d97a
AS		 3297 } else if (udev->state == USB_STATE_SUSPENDED &&
3298 udev->persist_enabled) {
8808f00c
AS		 3299 /* For a suspended device, treat this as a
3300 * remote wakeup event.
3301 */
0534d468 3302 status = usb_remote_wakeup(udev);
8808f00c
AS		 3303#endif
3304
3305 } else {
5257d97a 3306 status = -ENODEV; /* Don't resuscitate */
8808f00c
AS		 3307 }
3308 usb_unlock_device(udev);
3309
3310 if (status == 0) {
3311 clear_bit(port1, hub->change_bits);
3312 return;
3313 }
3314 }
3315
24618b0c 3316 /* Disconnect any existing devices under this port */
8808f00c 3317 if (udev)
24618b0c
AS		 3318 usb_disconnect(&hdev->children[port1-1]);
3319 clear_bit(port1, hub->change_bits);
3320
253e0572
AS		 3321 /* We can forget about a "removed" device when there's a physical
3322 * disconnect or the connect status changes.
3323 */
3324 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3325 (portchange & USB_PORT_STAT_C_CONNECTION))
3326 clear_bit(port1, hub->removed_bits);
3327
5257d97a
AS		 3328 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3329 USB_PORT_STAT_C_ENABLE)) {
3330 status = hub_port_debounce(hub, port1);
3331 if (status < 0) {
3332 if (printk_ratelimit())
3333 dev_err(hub_dev, "connect-debounce failed, "
3334 "port %d disabled\n", port1);
3335 portstatus &= ~USB_PORT_STAT_CONNECTION;
3336 } else {
3337 portstatus = status;
3338 }
3339 }
3340
253e0572
AS		 3341 /* Return now if debouncing failed or nothing is connected or
3342 * the device was "removed".
3343 */
3344 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3345 test_bit(port1, hub->removed_bits)) {
1da177e4
LT		 3346
3347 /* maybe switch power back on (e.g. root hub was reset) */
74ad9bd2 3348 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
0ed9a57e 3349 && !port_is_power_on(hub, portstatus))
1da177e4 3350 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5257d97a 3351
1da177e4
LT		 3352 if (portstatus & USB_PORT_STAT_ENABLE)
3353 goto done;
3354 return;
3355 }
3356
1da177e4 3357 for (i = 0; i < SET_CONFIG_TRIES; i++) {
1da177e4
LT		 3358
3359 /* reallocate for each attempt, since references
3360 * to the previous one can escape in various ways
3361 */
3362 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3363 if (!udev) {
3364 dev_err (hub_dev,
3365 "couldn't allocate port %d usb_device\n",
3366 port1);
3367 goto done;
3368 }
3369
3370 usb_set_device_state(udev, USB_STATE_POWERED);
55c52718 3371 udev->bus_mA = hub->mA_per_port;
b6956ffa 3372 udev->level = hdev->level + 1;
8af548dc 3373 udev->wusb = hub_is_wusb(hub);
55c52718 3374
131dec34
SS		 3375 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3376 if (hub_is_superspeed(hub->hdev))
e7b77172
SS		 3377 udev->speed = USB_SPEED_SUPER;
3378 else
3379 udev->speed = USB_SPEED_UNKNOWN;
3380
3b29b68b 3381 choose_devnum(udev);
c8d4af8e
AX		 3382 if (udev->devnum <= 0) {
3383 status = -ENOTCONN; /* Don't retry */
3384 goto loop;
c6515272
SS		 3385 }
3386
e7b77172 3387 /* reset (non-USB 3.0 devices) and get descriptor */
1da177e4
LT		 3388 status = hub_port_init(hub, udev, port1, i);
3389 if (status < 0)
3390 goto loop;
3391
93362a87
PD		 3392 usb_detect_quirks(udev);
3393 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3394 msleep(1000);
3395
1da177e4
LT		 3396 /* consecutive bus-powered hubs aren't reliable; they can
3397 * violate the voltage drop budget. if the new child has
3398 * a "powered" LED, users should notice we didn't enable it
3399 * (without reading syslog), even without per-port LEDs
3400 * on the parent.
3401 */
3402 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
55c52718 3403 && udev->bus_mA <= 100) {
1da177e4
LT		 3404 u16 devstat;
3405
3406 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3407 &devstat);
55c52718 3408 if (status < 2) {
1da177e4
LT		 3409 dev_dbg(&udev->dev, "get status %d ?\n", status);
3410 goto loop_disable;
3411 }
55c52718 3412 le16_to_cpus(&devstat);
1da177e4
LT		 3413 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3414 dev_err(&udev->dev,
3415 "can't connect bus-powered hub "
3416 "to this port\n");
3417 if (hub->has_indicators) {
3418 hub->indicator[port1-1] =
3419 INDICATOR_AMBER_BLINK;
c4028958 3420 schedule_delayed_work (&hub->leds, 0);
1da177e4
LT		 3421 }
3422 status = -ENOTCONN; /* Don't retry */
3423 goto loop_disable;
3424 }
3425 }
3426
3427 /* check for devices running slower than they could */
3428 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3429 && udev->speed == USB_SPEED_FULL
3430 && highspeed_hubs != 0)
3431 check_highspeed (hub, udev, port1);
3432
3433 /* Store the parent's children[] pointer. At this point
3434 * udev becomes globally accessible, although presumably
3435 * no one will look at it until hdev is unlocked.
3436 */
1da177e4
LT		 3437 status = 0;
3438
3439 /* We mustn't add new devices if the parent hub has
3440 * been disconnected; we would race with the
3441 * recursively_mark_NOTATTACHED() routine.
3442 */
3443 spin_lock_irq(&device_state_lock);
3444 if (hdev->state == USB_STATE_NOTATTACHED)
3445 status = -ENOTCONN;
3446 else
3447 hdev->children[port1-1] = udev;
3448 spin_unlock_irq(&device_state_lock);
3449
3450 /* Run it through the hoops (find a driver, etc) */
3451 if (!status) {
3452 status = usb_new_device(udev);
3453 if (status) {
3454 spin_lock_irq(&device_state_lock);
3455 hdev->children[port1-1] = NULL;
3456 spin_unlock_irq(&device_state_lock);
3457 }
3458 }
3459
1da177e4
LT		 3460 if (status)
3461 goto loop_disable;
3462
3463 status = hub_power_remaining(hub);
3464 if (status)
55c52718 3465 dev_dbg(hub_dev, "%dmA power budget left\n", status);
1da177e4
LT		 3466
3467 return;
3468
3469loop_disable:
3470 hub_port_disable(hub, port1, 1);
3471loop:
fc721f51 3472 usb_ep0_reinit(udev);
3b29b68b 3473 release_devnum(udev);
f7410ced 3474 hub_free_dev(udev);
1da177e4 3475 usb_put_dev(udev);
ffcdc18d 3476 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
1da177e4
LT		 3477 break;
3478 }
3a31155c
AS		 3479 if (hub->hdev->parent ||
3480 !hcd->driver->port_handed_over ||
3481 !(hcd->driver->port_handed_over)(hcd, port1))
3482 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3483 port1);
1da177e4
LT		 3484
3485done:
3486 hub_port_disable(hub, port1, 1);
90da096e
BR		 3487 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3488 hcd->driver->relinquish_port(hcd, port1);
1da177e4
LT		 3489}
3490
3491static void hub_events(void)
3492{
3493 struct list_head *tmp;
3494 struct usb_device *hdev;
3495 struct usb_interface *intf;
3496 struct usb_hub *hub;
3497 struct device *hub_dev;
3498 u16 hubstatus;
3499 u16 hubchange;
3500 u16 portstatus;
3501 u16 portchange;
3502 int i, ret;
3503 int connect_change;
3504
3505 /*
3506 * We restart the list every time to avoid a deadlock with
3507 * deleting hubs downstream from this one. This should be
3508 * safe since we delete the hub from the event list.
3509 * Not the most efficient, but avoids deadlocks.
3510 */
3511 while (1) {
3512
3513 /* Grab the first entry at the beginning of the list */
3514 spin_lock_irq(&hub_event_lock);
3515 if (list_empty(&hub_event_list)) {
3516 spin_unlock_irq(&hub_event_lock);
3517 break;
3518 }
3519
3520 tmp = hub_event_list.next;
3521 list_del_init(tmp);
3522
3523 hub = list_entry(tmp, struct usb_hub, event_list);
e8054854
AS		 3524 kref_get(&hub->kref);
3525 spin_unlock_irq(&hub_event_lock);
1da177e4 3526
e8054854
AS		 3527 hdev = hub->hdev;
3528 hub_dev = hub->intfdev;
3529 intf = to_usb_interface(hub_dev);
40f122f3 3530 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
1da177e4
LT		 3531 hdev->state, hub->descriptor
3532 ? hub->descriptor->bNbrPorts
3533 : 0,
3534 /* NOTE: expects max 15 ports... */
3535 (u16) hub->change_bits[0],
40f122f3 3536 (u16) hub->event_bits[0]);
1da177e4 3537
1da177e4
LT		 3538 /* Lock the device, then check to see if we were
3539 * disconnected while waiting for the lock to succeed. */
06b84e8a 3540 usb_lock_device(hdev);
e8054854 3541 if (unlikely(hub->disconnected))
9bbdf1e0 3542 goto loop_disconnected;
1da177e4
LT		 3543
3544 /* If the hub has died, clean up after it */
3545 if (hdev->state == USB_STATE_NOTATTACHED) {
7de18d8b 3546 hub->error = -ENODEV;
4330354f 3547 hub_quiesce(hub, HUB_DISCONNECT);
1da177e4
LT		 3548 goto loop;
3549 }
3550
40f122f3
AS		 3551 /* Autoresume */
3552 ret = usb_autopm_get_interface(intf);
3553 if (ret) {
3554 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3555 goto loop;
3556 }
a8e7c565 3557
40f122f3 3558 /* If this is an inactive hub, do nothing */
1da177e4 3559 if (hub->quiescing)
40f122f3 3560 goto loop_autopm;
1da177e4
LT		 3561
3562 if (hub->error) {
3563 dev_dbg (hub_dev, "resetting for error %d\n",
3564 hub->error);
3565
742120c6 3566 ret = usb_reset_device(hdev);
1da177e4
LT		 3567 if (ret) {
3568 dev_dbg (hub_dev,
3569 "error resetting hub: %d\n", ret);
40f122f3 3570 goto loop_autopm;
1da177e4
LT		 3571 }
3572
3573 hub->nerrors = 0;
3574 hub->error = 0;
3575 }
3576
3577 /* deal with port status changes */
3578 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3579 if (test_bit(i, hub->busy_bits))
3580 continue;
3581 connect_change = test_bit(i, hub->change_bits);
3582 if (!test_and_clear_bit(i, hub->event_bits) &&
6ee0b270 3583 !connect_change)
1da177e4
LT		 3584 continue;
3585
3586 ret = hub_port_status(hub, i,
3587 &portstatus, &portchange);
3588 if (ret < 0)
3589 continue;
3590
1da177e4
LT		 3591 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3592 clear_port_feature(hdev, i,
3593 USB_PORT_FEAT_C_CONNECTION);
3594 connect_change = 1;
3595 }
3596
3597 if (portchange & USB_PORT_STAT_C_ENABLE) {
3598 if (!connect_change)
3599 dev_dbg (hub_dev,
3600 "port %d enable change, "
3601 "status %08x\n",
3602 i, portstatus);
3603 clear_port_feature(hdev, i,
3604 USB_PORT_FEAT_C_ENABLE);
3605
3606 /*
3607 * EM interference sometimes causes badly
3608 * shielded USB devices to be shutdown by
3609 * the hub, this hack enables them again.
3610 * Works at least with mouse driver.
3611 */
3612 if (!(portstatus & USB_PORT_STAT_ENABLE)
3613 && !connect_change
3614 && hdev->children[i-1]) {
3615 dev_err (hub_dev,
3616 "port %i "
3617 "disabled by hub (EMI?), "
3618 "re-enabling...\n",
3619 i);
3620 connect_change = 1;
3621 }
3622 }
3623
3624 if (portchange & USB_PORT_STAT_C_SUSPEND) {
8808f00c
AS		 3625 struct usb_device *udev;
3626
1da177e4
LT		 3627 clear_port_feature(hdev, i,
3628 USB_PORT_FEAT_C_SUSPEND);
8808f00c
AS		 3629 udev = hdev->children[i-1];
3630 if (udev) {
49d0f078
AS		 3631 /* TRSMRCY = 10 msec */
3632 msleep(10);
3633
8808f00c 3634 usb_lock_device(udev);
0534d468 3635 ret = usb_remote_wakeup(hdev->
1da177e4 3636 children[i-1]);
8808f00c 3637 usb_unlock_device(udev);
1da177e4
LT		 3638 if (ret < 0)
3639 connect_change = 1;
3640 } else {
3641 ret = -ENODEV;
3642 hub_port_disable(hub, i, 1);
3643 }
3644 dev_dbg (hub_dev,
3645 "resume on port %d, status %d\n",
3646 i, ret);
3647 }
3648
3649 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
752d57a8
PB		 3650 u16 status = 0;
3651 u16 unused;
3652
3653 dev_dbg(hub_dev, "over-current change on port "
3654 "%d\n", i);
1da177e4
LT		 3655 clear_port_feature(hdev, i,
3656 USB_PORT_FEAT_C_OVER_CURRENT);
752d57a8 3657 msleep(100); /* Cool down */
8520f380 3658 hub_power_on(hub, true);
752d57a8
PB		 3659 hub_port_status(hub, i, &status, &unused);
3660 if (status & USB_PORT_STAT_OVERCURRENT)
3661 dev_err(hub_dev, "over-current "
3662 "condition on port %d\n", i);
1da177e4
LT		 3663 }
3664
3665 if (portchange & USB_PORT_STAT_C_RESET) {
3666 dev_dbg (hub_dev,
3667 "reset change on port %d\n",
3668 i);
3669 clear_port_feature(hdev, i,
3670 USB_PORT_FEAT_C_RESET);
3671 }
c7061574
SS		 3672 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3673 hub_is_superspeed(hub->hdev)) {
3674 dev_dbg(hub_dev,
3675 "warm reset change on port %d\n",
3676 i);
3677 clear_port_feature(hdev, i,
3678 USB_PORT_FEAT_C_BH_PORT_RESET);
3679 }
dbe79bbe
JY		 3680 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3681 clear_port_feature(hub->hdev, i,
3682 USB_PORT_FEAT_C_PORT_LINK_STATE);
3683 }
3684 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3685 dev_warn(hub_dev,
3686 "config error on port %d\n",
3687 i);
3688 clear_port_feature(hub->hdev, i,
3689 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3690 }
1da177e4 3691
5e467f6e
AX		 3692 /* Warm reset a USB3 protocol port if it's in
3693 * SS.Inactive state.
3694 */
3695 if (hub_is_superspeed(hub->hdev) &&
3696 (portstatus & USB_PORT_STAT_LINK_STATE)
3697 == USB_SS_PORT_LS_SS_INACTIVE) {
3698 dev_dbg(hub_dev, "warm reset port %d\n", i);
75d7cf72
AX		 3699 hub_port_reset(hub, i, NULL,
3700 HUB_BH_RESET_TIME, true);
5e467f6e
AX		 3701 }
3702
1da177e4
LT		 3703 if (connect_change)
3704 hub_port_connect_change(hub, i,
3705 portstatus, portchange);
3706 } /* end for i */
3707
3708 /* deal with hub status changes */
3709 if (test_and_clear_bit(0, hub->event_bits) == 0)
3710 ; /* do nothing */
3711 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3712 dev_err (hub_dev, "get_hub_status failed\n");
3713 else {
3714 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3715 dev_dbg (hub_dev, "power change\n");
3716 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
55c52718
AS		 3717 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3718 /* FIXME: Is this always true? */
55c52718 3719 hub->limited_power = 1;
403fae78 3720 else
3721 hub->limited_power = 0;
1da177e4
LT		 3722 }
3723 if (hubchange & HUB_CHANGE_OVERCURRENT) {
752d57a8
PB		 3724 u16 status = 0;
3725 u16 unused;
3726
3727 dev_dbg(hub_dev, "over-current change\n");
1da177e4 3728 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
752d57a8 3729 msleep(500); /* Cool down */
8520f380 3730 hub_power_on(hub, true);
752d57a8
PB		 3731 hub_hub_status(hub, &status, &unused);
3732 if (status & HUB_STATUS_OVERCURRENT)
3733 dev_err(hub_dev, "over-current "
3734 "condition\n");
1da177e4
LT		 3735 }
3736 }
3737
8e4ceb38
AS		 3738 loop_autopm:
3739 /* Balance the usb_autopm_get_interface() above */
3740 usb_autopm_put_interface_no_suspend(intf);
3741 loop:
3742 /* Balance the usb_autopm_get_interface_no_resume() in
3743 * kick_khubd() and allow autosuspend.
3744 */
3745 usb_autopm_put_interface(intf);
9bbdf1e0 3746 loop_disconnected:
1da177e4 3747 usb_unlock_device(hdev);
e8054854 3748 kref_put(&hub->kref, hub_release);
1da177e4
LT		 3749
3750 } /* end while (1) */
3751}
3752
3753static int hub_thread(void *__unused)
3754{
3bb1af52
AS		 3755 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3756 * port handover. Otherwise it might see that a full-speed device
3757 * was gone before the EHCI controller had handed its port over to
3758 * the companion full-speed controller.
3759 */
83144186 3760 set_freezable();
3bb1af52 3761
1da177e4
LT		 3762 do {
3763 hub_events();
e42837bc 3764 wait_event_freezable(khubd_wait,
9c8d6178
AM		 3765 !list_empty(&hub_event_list) ||
3766 kthread_should_stop());
9c8d6178 3767 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
1da177e4 3768
9c8d6178
AM		 3769 pr_debug("%s: khubd exiting\n", usbcore_name);
3770 return 0;
1da177e4
LT		 3771}
3772
1e927d96 3773static const struct usb_device_id hub_id_table[] = {
1da177e4
LT		 3774 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3775 .bDeviceClass = USB_CLASS_HUB},
3776 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3777 .bInterfaceClass = USB_CLASS_HUB},
3778 { } /* Terminating entry */
3779};
3780
3781MODULE_DEVICE_TABLE (usb, hub_id_table);
3782
3783static struct usb_driver hub_driver = {
1da177e4
LT		 3784 .name = "hub",
3785 .probe = hub_probe,
3786 .disconnect = hub_disconnect,
3787 .suspend = hub_suspend,
3788 .resume = hub_resume,
f07600cf 3789 .reset_resume = hub_reset_resume,
7de18d8b
AS		 3790 .pre_reset = hub_pre_reset,
3791 .post_reset = hub_post_reset,
c532b29a 3792 .unlocked_ioctl = hub_ioctl,
1da177e4 3793 .id_table = hub_id_table,
40f122f3 3794 .supports_autosuspend = 1,
1da177e4
LT		 3795};
3796
3797int usb_hub_init(void)
3798{
1da177e4
LT		 3799 if (usb_register(&hub_driver) < 0) {
3800 printk(KERN_ERR "%s: can't register hub driver\n",
3801 usbcore_name);
3802 return -1;
3803 }
3804
9c8d6178
AM		 3805 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3806 if (!IS_ERR(khubd_task))
1da177e4 3807 return 0;
1da177e4
LT		 3808
3809 /* Fall through if kernel_thread failed */
3810 usb_deregister(&hub_driver);
3811 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3812
3813 return -1;
3814}
3815
3816void usb_hub_cleanup(void)
3817{
9c8d6178 3818 kthread_stop(khubd_task);
1da177e4
LT		 3819
3820 /*
3821 * Hub resources are freed for us by usb_deregister. It calls
3822 * usb_driver_purge on every device which in turn calls that
3823 * devices disconnect function if it is using this driver.
3824 * The hub_disconnect function takes care of releasing the
3825 * individual hub resources. -greg
3826 */
3827 usb_deregister(&hub_driver);
3828} /* usb_hub_cleanup() */
3829
eb764c4b
AS		 3830static int descriptors_changed(struct usb_device *udev,
3831 struct usb_device_descriptor *old_device_descriptor)
3832{
3833 int changed = 0;
3834 unsigned index;
3835 unsigned serial_len = 0;
3836 unsigned len;
3837 unsigned old_length;
3838 int length;
3839 char *buf;
3840
3841 if (memcmp(&udev->descriptor, old_device_descriptor,
3842 sizeof(*old_device_descriptor)) != 0)
3843 return 1;
3844
3845 /* Since the idVendor, idProduct, and bcdDevice values in the
3846 * device descriptor haven't changed, we will assume the
3847 * Manufacturer and Product strings haven't changed either.
3848 * But the SerialNumber string could be different (e.g., a
3849 * different flash card of the same brand).
3850 */
3851 if (udev->serial)
3852 serial_len = strlen(udev->serial) + 1;
1da177e4 3853
eb764c4b 3854 len = serial_len;
1da177e4 3855 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
eb764c4b
AS		 3856 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3857 len = max(len, old_length);
1da177e4 3858 }
eb764c4b 3859
0cc1a51f 3860 buf = kmalloc(len, GFP_NOIO);
1da177e4
LT		 3861 if (buf == NULL) {
3862 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3863 /* assume the worst */
3864 return 1;
3865 }
3866 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
eb764c4b 3867 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
1da177e4
LT		 3868 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3869 old_length);
eb764c4b 3870 if (length != old_length) {
1da177e4
LT		 3871 dev_dbg(&udev->dev, "config index %d, error %d\n",
3872 index, length);
eb764c4b 3873 changed = 1;
1da177e4
LT		 3874 break;
3875 }
3876 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3877 != 0) {
3878 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
eb764c4b
AS		 3879 index,
3880 ((struct usb_config_descriptor *) buf)->
3881 bConfigurationValue);
3882 changed = 1;
1da177e4
LT		 3883 break;
3884 }
3885 }
eb764c4b
AS		 3886
3887 if (!changed && serial_len) {
3888 length = usb_string(udev, udev->descriptor.iSerialNumber,
3889 buf, serial_len);
3890 if (length + 1 != serial_len) {
3891 dev_dbg(&udev->dev, "serial string error %d\n",
3892 length);
3893 changed = 1;
3894 } else if (memcmp(buf, udev->serial, length) != 0) {
3895 dev_dbg(&udev->dev, "serial string changed\n");
3896 changed = 1;
3897 }
3898 }
3899
1da177e4 3900 kfree(buf);
eb764c4b 3901 return changed;
1da177e4
LT		 3902}
3903
3904/**
742120c6 3905 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
1da177e4
LT		 3906 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3907 *
79efa097
AS		 3908 * WARNING - don't use this routine to reset a composite device
3909 * (one with multiple interfaces owned by separate drivers)!
742120c6 3910 * Use usb_reset_device() instead.
1da177e4
LT		 3911 *
3912 * Do a port reset, reassign the device's address, and establish its
3913 * former operating configuration. If the reset fails, or the device's
3914 * descriptors change from their values before the reset, or the original
3915 * configuration and altsettings cannot be restored, a flag will be set
3916 * telling khubd to pretend the device has been disconnected and then
3917 * re-connected. All drivers will be unbound, and the device will be
3918 * re-enumerated and probed all over again.
3919 *
3920 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3921 * flagged for logical disconnection, or some other negative error code
3922 * if the reset wasn't even attempted.
3923 *
3924 * The caller must own the device lock. For example, it's safe to use
3925 * this from a driver probe() routine after downloading new firmware.
3926 * For calls that might not occur during probe(), drivers should lock
3927 * the device using usb_lock_device_for_reset().
6bc6cff5
AS		 3928 *
3929 * Locking exception: This routine may also be called from within an
3930 * autoresume handler. Such usage won't conflict with other tasks
3931 * holding the device lock because these tasks should always call
3932 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
1da177e4 3933 */
742120c6 3934static int usb_reset_and_verify_device(struct usb_device *udev)
1da177e4
LT		 3935{
3936 struct usb_device *parent_hdev = udev->parent;
3937 struct usb_hub *parent_hub;
3f0479e0 3938 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1da177e4 3939 struct usb_device_descriptor descriptor = udev->descriptor;
12c3da34
AS		 3940 int i, ret = 0;
3941 int port1 = udev->portnum;
1da177e4
LT		 3942
3943 if (udev->state == USB_STATE_NOTATTACHED ||
3944 udev->state == USB_STATE_SUSPENDED) {
3945 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3946 udev->state);
3947 return -EINVAL;
3948 }
3949
3950 if (!parent_hdev) {
4bec9917 3951 /* this requires hcd-specific logic; see ohci_restart() */
441b62c1 3952 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
1da177e4
LT		 3953 return -EISDIR;
3954 }
1da177e4
LT		 3955 parent_hub = hdev_to_hub(parent_hdev);
3956
1da177e4
LT		 3957 set_bit(port1, parent_hub->busy_bits);
3958 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3959
3960 /* ep0 maxpacket size may change; let the HCD know about it.
3961 * Other endpoints will be handled by re-enumeration. */
fc721f51 3962 usb_ep0_reinit(udev);
1da177e4 3963 ret = hub_port_init(parent_hub, udev, port1, i);
dd4dd19e 3964 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
1da177e4
LT		 3965 break;
3966 }
3967 clear_bit(port1, parent_hub->busy_bits);
d5cbad4b 3968
1da177e4
LT		 3969 if (ret < 0)
3970 goto re_enumerate;
3971
3972 /* Device might have changed firmware (DFU or similar) */
eb764c4b 3973 if (descriptors_changed(udev, &descriptor)) {
1da177e4
LT		 3974 dev_info(&udev->dev, "device firmware changed\n");
3975 udev->descriptor = descriptor; /* for disconnect() calls */
3976 goto re_enumerate;
3977 }
4fe0387a
AS		 3978
3979 /* Restore the device's previous configuration */
1da177e4
LT		 3980 if (!udev->actconfig)
3981 goto done;
3f0479e0 3982
d673bfcb 3983 mutex_lock(hcd->bandwidth_mutex);
3f0479e0
SS		 3984 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3985 if (ret < 0) {
3986 dev_warn(&udev->dev,
3987 "Busted HC? Not enough HCD resources for "
3988 "old configuration.\n");
d673bfcb 3989 mutex_unlock(hcd->bandwidth_mutex);
3f0479e0
SS		 3990 goto re_enumerate;
3991 }
1da177e4
LT		 3992 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3993 USB_REQ_SET_CONFIGURATION, 0,
3994 udev->actconfig->desc.bConfigurationValue, 0,
3995 NULL, 0, USB_CTRL_SET_TIMEOUT);
3996 if (ret < 0) {
3997 dev_err(&udev->dev,
3998 "can't restore configuration #%d (error=%d)\n",
3999 udev->actconfig->desc.bConfigurationValue, ret);
d673bfcb 4000 mutex_unlock(hcd->bandwidth_mutex);
1da177e4
LT		 4001 goto re_enumerate;
4002 }
d673bfcb 4003 mutex_unlock(hcd->bandwidth_mutex);
1da177e4
LT		 4004 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4005
4fe0387a
AS		 4006 /* Put interfaces back into the same altsettings as before.
4007 * Don't bother to send the Set-Interface request for interfaces
4008 * that were already in altsetting 0; besides being unnecessary,
4009 * many devices can't handle it. Instead just reset the host-side
4010 * endpoint state.
4011 */
1da177e4 4012 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3f0479e0
SS		 4013 struct usb_host_config *config = udev->actconfig;
4014 struct usb_interface *intf = config->interface[i];
1da177e4
LT		 4015 struct usb_interface_descriptor *desc;
4016
1da177e4 4017 desc = &intf->cur_altsetting->desc;
4fe0387a
AS		 4018 if (desc->bAlternateSetting == 0) {
4019 usb_disable_interface(udev, intf, true);
4020 usb_enable_interface(udev, intf, true);
4021 ret = 0;
4022 } else {
04a723ea
SS		 4023 /* Let the bandwidth allocation function know that this
4024 * device has been reset, and it will have to use
4025 * alternate setting 0 as the current alternate setting.
3f0479e0 4026 */
04a723ea 4027 intf->resetting_device = 1;
4fe0387a
AS		 4028 ret = usb_set_interface(udev, desc->bInterfaceNumber,
4029 desc->bAlternateSetting);
04a723ea 4030 intf->resetting_device = 0;
4fe0387a 4031 }
1da177e4
LT		 4032 if (ret < 0) {
4033 dev_err(&udev->dev, "failed to restore interface %d "
4034 "altsetting %d (error=%d)\n",
4035 desc->bInterfaceNumber,
4036 desc->bAlternateSetting,
4037 ret);
4038 goto re_enumerate;
4039 }
4040 }
4041
4042done:
1da177e4
LT		 4043 return 0;
4044
4045re_enumerate:
4046 hub_port_logical_disconnect(parent_hub, port1);
4047 return -ENODEV;
4048}
79efa097
AS		 4049
4050/**
742120c6 4051 * usb_reset_device - warn interface drivers and perform a USB port reset
79efa097 4052 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
79efa097
AS		 4053 *
4054 * Warns all drivers bound to registered interfaces (using their pre_reset
4055 * method), performs the port reset, and then lets the drivers know that
4056 * the reset is over (using their post_reset method).
4057 *
742120c6 4058 * Return value is the same as for usb_reset_and_verify_device().
79efa097
AS		 4059 *
4060 * The caller must own the device lock. For example, it's safe to use
4061 * this from a driver probe() routine after downloading new firmware.
4062 * For calls that might not occur during probe(), drivers should lock
4063 * the device using usb_lock_device_for_reset().
78d9a487
AS		 4064 *
4065 * If an interface is currently being probed or disconnected, we assume
4066 * its driver knows how to handle resets. For all other interfaces,
4067 * if the driver doesn't have pre_reset and post_reset methods then
4068 * we attempt to unbind it and rebind afterward.
79efa097 4069 */
742120c6 4070int usb_reset_device(struct usb_device *udev)
79efa097
AS		 4071{
4072 int ret;
852c4b43 4073 int i;
79efa097
AS		 4074 struct usb_host_config *config = udev->actconfig;
4075
4076 if (udev->state == USB_STATE_NOTATTACHED ||
4077 udev->state == USB_STATE_SUSPENDED) {
4078 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4079 udev->state);
4080 return -EINVAL;
4081 }
4082
645daaab 4083 /* Prevent autosuspend during the reset */
94fcda1f 4084 usb_autoresume_device(udev);
645daaab 4085
79efa097 4086 if (config) {
79efa097 4087 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
852c4b43
AS		 4088 struct usb_interface *cintf = config->interface[i];
4089 struct usb_driver *drv;
78d9a487 4090 int unbind = 0;
852c4b43
AS		 4091
4092 if (cintf->dev.driver) {
79efa097 4093 drv = to_usb_driver(cintf->dev.driver);
78d9a487
AS		 4094 if (drv->pre_reset && drv->post_reset)
4095 unbind = (drv->pre_reset)(cintf);
4096 else if (cintf->condition ==
4097 USB_INTERFACE_BOUND)
4098 unbind = 1;
4099 if (unbind)
4100 usb_forced_unbind_intf(cintf);
79efa097
AS		 4101 }
4102 }
4103 }
4104
742120c6 4105 ret = usb_reset_and_verify_device(udev);
79efa097
AS		 4106
4107 if (config) {
79efa097 4108 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
852c4b43
AS		 4109 struct usb_interface *cintf = config->interface[i];
4110 struct usb_driver *drv;
78d9a487 4111 int rebind = cintf->needs_binding;
852c4b43 4112
78d9a487 4113 if (!rebind && cintf->dev.driver) {
79efa097
AS		 4114 drv = to_usb_driver(cintf->dev.driver);
4115 if (drv->post_reset)
78d9a487
AS		 4116 rebind = (drv->post_reset)(cintf);
4117 else if (cintf->condition ==
4118 USB_INTERFACE_BOUND)
4119 rebind = 1;
79efa097 4120 }
6c640945 4121 if (ret == 0 && rebind)
78d9a487 4122 usb_rebind_intf(cintf);
79efa097
AS		 4123 }
4124 }
4125
94fcda1f 4126 usb_autosuspend_device(udev);
79efa097
AS		 4127 return ret;
4128}
742120c6 4129EXPORT_SYMBOL_GPL(usb_reset_device);
dc023dce
IPG		 4130
4131
4132/**
4133 * usb_queue_reset_device - Reset a USB device from an atomic context
4134 * @iface: USB interface belonging to the device to reset
4135 *
4136 * This function can be used to reset a USB device from an atomic
4137 * context, where usb_reset_device() won't work (as it blocks).
4138 *
4139 * Doing a reset via this method is functionally equivalent to calling
4140 * usb_reset_device(), except for the fact that it is delayed to a
4141 * workqueue. This means that any drivers bound to other interfaces
4142 * might be unbound, as well as users from usbfs in user space.
4143 *
4144 * Corner cases:
4145 *
4146 * - Scheduling two resets at the same time from two different drivers
4147 * attached to two different interfaces of the same device is
4148 * possible; depending on how the driver attached to each interface
4149 * handles ->pre_reset(), the second reset might happen or not.
4150 *
4151 * - If a driver is unbound and it had a pending reset, the reset will
4152 * be cancelled.
4153 *
4154 * - This function can be called during .probe() or .disconnect()
4155 * times. On return from .disconnect(), any pending resets will be
4156 * cancelled.
4157 *
4158 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4159 * does its own.
4160 *
4161 * NOTE: We don't do any reference count tracking because it is not
4162 * needed. The lifecycle of the work_struct is tied to the
4163 * usb_interface. Before destroying the interface we cancel the
4164 * work_struct, so the fact that work_struct is queued and or
4165 * running means the interface (and thus, the device) exist and
4166 * are referenced.
4167 */
4168void usb_queue_reset_device(struct usb_interface *iface)
4169{
4170 schedule_work(&iface->reset_ws);
4171}
4172EXPORT_SYMBOL_GPL(usb_queue_reset_device);
kernel source for telekom puls (alcatel/mediatek)