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