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