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