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