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