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