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