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