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