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