blob: 1b1846e6473bb222d6af65b6522e7b467696cf8a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
11#include <linux/config.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/kernel.h>
13#include <linux/errno.h>
14#include <linux/module.h>
15#include <linux/moduleparam.h>
16#include <linux/completion.h>
17#include <linux/sched.h>
18#include <linux/list.h>
19#include <linux/slab.h>
20#include <linux/smp_lock.h>
21#include <linux/ioctl.h>
22#include <linux/usb.h>
23#include <linux/usbdevice_fs.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070024#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010025#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include <asm/semaphore.h>
28#include <asm/uaccess.h>
29#include <asm/byteorder.h>
30
31#include "usb.h"
32#include "hcd.h"
33#include "hub.h"
34
35/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050036 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
38static DEFINE_SPINLOCK(device_state_lock);
39
40/* khubd's worklist and its lock */
41static DEFINE_SPINLOCK(hub_event_lock);
42static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
43
44/* Wakes up khubd */
45static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
46
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070047static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/* cycle leds on hubs that aren't blinking for attention */
50static int blinkenlights = 0;
51module_param (blinkenlights, bool, S_IRUGO);
52MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
53
54/*
55 * As of 2.6.10 we introduce a new USB device initialization scheme which
56 * closely resembles the way Windows works. Hopefully it will be compatible
57 * with a wider range of devices than the old scheme. However some previously
58 * working devices may start giving rise to "device not accepting address"
59 * errors; if that happens the user can try the old scheme by adjusting the
60 * following module parameters.
61 *
62 * For maximum flexibility there are two boolean parameters to control the
63 * hub driver's behavior. On the first initialization attempt, if the
64 * "old_scheme_first" parameter is set then the old scheme will be used,
65 * otherwise the new scheme is used. If that fails and "use_both_schemes"
66 * is set, then the driver will make another attempt, using the other scheme.
67 */
68static int old_scheme_first = 0;
69module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
70MODULE_PARM_DESC(old_scheme_first,
71 "start with the old device initialization scheme");
72
73static int use_both_schemes = 1;
74module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
75MODULE_PARM_DESC(use_both_schemes,
76 "try the other device initialization scheme if the "
77 "first one fails");
78
79
80#ifdef DEBUG
81static inline char *portspeed (int portstatus)
82{
83 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
84 return "480 Mb/s";
85 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
86 return "1.5 Mb/s";
87 else
88 return "12 Mb/s";
89}
90#endif
91
92/* Note that hdev or one of its children must be locked! */
93static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
94{
95 return usb_get_intfdata(hdev->actconfig->interface[0]);
96}
97
98/* USB 2.0 spec Section 11.24.4.5 */
99static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
100{
101 int i, ret;
102
103 for (i = 0; i < 3; i++) {
104 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
105 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
106 USB_DT_HUB << 8, 0, data, size,
107 USB_CTRL_GET_TIMEOUT);
108 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
109 return ret;
110 }
111 return -EINVAL;
112}
113
114/*
115 * USB 2.0 spec Section 11.24.2.1
116 */
117static int clear_hub_feature(struct usb_device *hdev, int feature)
118{
119 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
120 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
121}
122
123/*
124 * USB 2.0 spec Section 11.24.2.2
125 */
126static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
127{
128 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
129 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
130 NULL, 0, 1000);
131}
132
133/*
134 * USB 2.0 spec Section 11.24.2.13
135 */
136static int set_port_feature(struct usb_device *hdev, int port1, int feature)
137{
138 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
139 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
140 NULL, 0, 1000);
141}
142
143/*
144 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
145 * for info about using port indicators
146 */
147static void set_port_led(
148 struct usb_hub *hub,
149 int port1,
150 int selector
151)
152{
153 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
154 USB_PORT_FEAT_INDICATOR);
155 if (status < 0)
156 dev_dbg (hub->intfdev,
157 "port %d indicator %s status %d\n",
158 port1,
159 ({ char *s; switch (selector) {
160 case HUB_LED_AMBER: s = "amber"; break;
161 case HUB_LED_GREEN: s = "green"; break;
162 case HUB_LED_OFF: s = "off"; break;
163 case HUB_LED_AUTO: s = "auto"; break;
164 default: s = "??"; break;
165 }; s; }),
166 status);
167}
168
169#define LED_CYCLE_PERIOD ((2*HZ)/3)
170
171static void led_work (void *__hub)
172{
173 struct usb_hub *hub = __hub;
174 struct usb_device *hdev = hub->hdev;
175 unsigned i;
176 unsigned changed = 0;
177 int cursor = -1;
178
179 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
180 return;
181
182 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
183 unsigned selector, mode;
184
185 /* 30%-50% duty cycle */
186
187 switch (hub->indicator[i]) {
188 /* cycle marker */
189 case INDICATOR_CYCLE:
190 cursor = i;
191 selector = HUB_LED_AUTO;
192 mode = INDICATOR_AUTO;
193 break;
194 /* blinking green = sw attention */
195 case INDICATOR_GREEN_BLINK:
196 selector = HUB_LED_GREEN;
197 mode = INDICATOR_GREEN_BLINK_OFF;
198 break;
199 case INDICATOR_GREEN_BLINK_OFF:
200 selector = HUB_LED_OFF;
201 mode = INDICATOR_GREEN_BLINK;
202 break;
203 /* blinking amber = hw attention */
204 case INDICATOR_AMBER_BLINK:
205 selector = HUB_LED_AMBER;
206 mode = INDICATOR_AMBER_BLINK_OFF;
207 break;
208 case INDICATOR_AMBER_BLINK_OFF:
209 selector = HUB_LED_OFF;
210 mode = INDICATOR_AMBER_BLINK;
211 break;
212 /* blink green/amber = reserved */
213 case INDICATOR_ALT_BLINK:
214 selector = HUB_LED_GREEN;
215 mode = INDICATOR_ALT_BLINK_OFF;
216 break;
217 case INDICATOR_ALT_BLINK_OFF:
218 selector = HUB_LED_AMBER;
219 mode = INDICATOR_ALT_BLINK;
220 break;
221 default:
222 continue;
223 }
224 if (selector != HUB_LED_AUTO)
225 changed = 1;
226 set_port_led(hub, i + 1, selector);
227 hub->indicator[i] = mode;
228 }
229 if (!changed && blinkenlights) {
230 cursor++;
231 cursor %= hub->descriptor->bNbrPorts;
232 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
233 hub->indicator[cursor] = INDICATOR_CYCLE;
234 changed++;
235 }
236 if (changed)
237 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
238}
239
240/* use a short timeout for hub/port status fetches */
241#define USB_STS_TIMEOUT 1000
242#define USB_STS_RETRIES 5
243
244/*
245 * USB 2.0 spec Section 11.24.2.6
246 */
247static int get_hub_status(struct usb_device *hdev,
248 struct usb_hub_status *data)
249{
250 int i, status = -ETIMEDOUT;
251
252 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
253 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
254 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
255 data, sizeof(*data), USB_STS_TIMEOUT);
256 }
257 return status;
258}
259
260/*
261 * USB 2.0 spec Section 11.24.2.7
262 */
263static int get_port_status(struct usb_device *hdev, int port1,
264 struct usb_port_status *data)
265{
266 int i, status = -ETIMEDOUT;
267
268 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
269 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
270 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
271 data, sizeof(*data), USB_STS_TIMEOUT);
272 }
273 return status;
274}
275
276static void kick_khubd(struct usb_hub *hub)
277{
278 unsigned long flags;
279
280 spin_lock_irqsave(&hub_event_lock, flags);
281 if (list_empty(&hub->event_list)) {
282 list_add_tail(&hub->event_list, &hub_event_list);
283 wake_up(&khubd_wait);
284 }
285 spin_unlock_irqrestore(&hub_event_lock, flags);
286}
287
288void usb_kick_khubd(struct usb_device *hdev)
289{
290 kick_khubd(hdev_to_hub(hdev));
291}
292
293
294/* completion function, fires on port status changes and various faults */
295static void hub_irq(struct urb *urb, struct pt_regs *regs)
296{
297 struct usb_hub *hub = (struct usb_hub *)urb->context;
298 int status;
299 int i;
300 unsigned long bits;
301
302 switch (urb->status) {
303 case -ENOENT: /* synchronous unlink */
304 case -ECONNRESET: /* async unlink */
305 case -ESHUTDOWN: /* hardware going away */
306 return;
307
308 default: /* presumably an error */
309 /* Cause a hub reset after 10 consecutive errors */
310 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
311 if ((++hub->nerrors < 10) || hub->error)
312 goto resubmit;
313 hub->error = urb->status;
314 /* FALL THROUGH */
315
316 /* let khubd handle things */
317 case 0: /* we got data: port status changed */
318 bits = 0;
319 for (i = 0; i < urb->actual_length; ++i)
320 bits |= ((unsigned long) ((*hub->buffer)[i]))
321 << (i*8);
322 hub->event_bits[0] = bits;
323 break;
324 }
325
326 hub->nerrors = 0;
327
328 /* Something happened, let khubd figure it out */
329 kick_khubd(hub);
330
331resubmit:
332 if (hub->quiescing)
333 return;
334
335 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
336 && status != -ENODEV && status != -EPERM)
337 dev_err (hub->intfdev, "resubmit --> %d\n", status);
338}
339
340/* USB 2.0 spec Section 11.24.2.3 */
341static inline int
342hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
343{
344 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
345 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
346 tt, NULL, 0, 1000);
347}
348
349/*
350 * enumeration blocks khubd for a long time. we use keventd instead, since
351 * long blocking there is the exception, not the rule. accordingly, HCDs
352 * talking to TTs must queue control transfers (not just bulk and iso), so
353 * both can talk to the same hub concurrently.
354 */
355static void hub_tt_kevent (void *arg)
356{
357 struct usb_hub *hub = arg;
358 unsigned long flags;
359
360 spin_lock_irqsave (&hub->tt.lock, flags);
361 while (!list_empty (&hub->tt.clear_list)) {
362 struct list_head *temp;
363 struct usb_tt_clear *clear;
364 struct usb_device *hdev = hub->hdev;
365 int status;
366
367 temp = hub->tt.clear_list.next;
368 clear = list_entry (temp, struct usb_tt_clear, clear_list);
369 list_del (&clear->clear_list);
370
371 /* drop lock so HCD can concurrently report other TT errors */
372 spin_unlock_irqrestore (&hub->tt.lock, flags);
373 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
374 spin_lock_irqsave (&hub->tt.lock, flags);
375
376 if (status)
377 dev_err (&hdev->dev,
378 "clear tt %d (%04x) error %d\n",
379 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700380 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 }
382 spin_unlock_irqrestore (&hub->tt.lock, flags);
383}
384
385/**
386 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
387 * @udev: the device whose split transaction failed
388 * @pipe: identifies the endpoint of the failed transaction
389 *
390 * High speed HCDs use this to tell the hub driver that some split control or
391 * bulk transaction failed in a way that requires clearing internal state of
392 * a transaction translator. This is normally detected (and reported) from
393 * interrupt context.
394 *
395 * It may not be possible for that hub to handle additional full (or low)
396 * speed transactions until that state is fully cleared out.
397 */
398void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
399{
400 struct usb_tt *tt = udev->tt;
401 unsigned long flags;
402 struct usb_tt_clear *clear;
403
404 /* we've got to cope with an arbitrary number of pending TT clears,
405 * since each TT has "at least two" buffers that can need it (and
406 * there can be many TTs per hub). even if they're uncommon.
407 */
408 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
409 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
410 /* FIXME recover somehow ... RESET_TT? */
411 return;
412 }
413
414 /* info that CLEAR_TT_BUFFER needs */
415 clear->tt = tt->multi ? udev->ttport : 1;
416 clear->devinfo = usb_pipeendpoint (pipe);
417 clear->devinfo |= udev->devnum << 4;
418 clear->devinfo |= usb_pipecontrol (pipe)
419 ? (USB_ENDPOINT_XFER_CONTROL << 11)
420 : (USB_ENDPOINT_XFER_BULK << 11);
421 if (usb_pipein (pipe))
422 clear->devinfo |= 1 << 15;
423
424 /* tell keventd to clear state for this TT */
425 spin_lock_irqsave (&tt->lock, flags);
426 list_add_tail (&clear->clear_list, &tt->clear_list);
427 schedule_work (&tt->kevent);
428 spin_unlock_irqrestore (&tt->lock, flags);
429}
430
431static void hub_power_on(struct usb_hub *hub)
432{
433 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700434 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400435 u16 wHubCharacteristics =
436 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Alan Stern4489a572006-04-27 15:54:22 -0400438 /* Enable power on each port. Some hubs have reserved values
439 * of LPSM (> 2) in their descriptors, even though they are
440 * USB 2.0 hubs. Some hubs do not implement port-power switching
441 * but only emulate it. In all cases, the ports won't work
442 * unless we send these messages to the hub.
443 */
444 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400446 else
447 dev_dbg(hub->intfdev, "trying to enable port power on "
448 "non-switchable hub\n");
449 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
450 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
David Brownellb7896962005-08-31 10:41:44 -0700452 /* Wait at least 100 msec for power to become stable */
453 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
David Brownell979d5192005-09-22 22:32:24 -0700456static inline void __hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
David Brownell979d5192005-09-22 22:32:24 -0700458 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700460 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700461 hub->resume_root_hub = 0;
462}
463
464static void hub_quiesce(struct usb_hub *hub)
465{
466 /* (blocking) stop khubd and related activity */
467 __hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 usb_kill_urb(hub->urb);
469 if (hub->has_indicators)
470 cancel_delayed_work(&hub->leds);
471 if (hub->has_indicators || hub->tt.hub)
472 flush_scheduled_work();
473}
474
475static void hub_activate(struct usb_hub *hub)
476{
477 int status;
478
479 hub->quiescing = 0;
480 hub->activating = 1;
David Brownell979d5192005-09-22 22:32:24 -0700481 hub->resume_root_hub = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 status = usb_submit_urb(hub->urb, GFP_NOIO);
483 if (status < 0)
484 dev_err(hub->intfdev, "activate --> %d\n", status);
485 if (hub->has_indicators && blinkenlights)
486 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
487
488 /* scan all ports ASAP */
489 kick_khubd(hub);
490}
491
492static int hub_hub_status(struct usb_hub *hub,
493 u16 *status, u16 *change)
494{
495 int ret;
496
497 ret = get_hub_status(hub->hdev, &hub->status->hub);
498 if (ret < 0)
499 dev_err (hub->intfdev,
500 "%s failed (err = %d)\n", __FUNCTION__, ret);
501 else {
502 *status = le16_to_cpu(hub->status->hub.wHubStatus);
503 *change = le16_to_cpu(hub->status->hub.wHubChange);
504 ret = 0;
505 }
506 return ret;
507}
508
Alan Stern8b28c752005-08-10 17:04:13 -0400509static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
510{
511 struct usb_device *hdev = hub->hdev;
512 int ret;
513
514 if (hdev->children[port1-1] && set_state) {
515 usb_set_device_state(hdev->children[port1-1],
516 USB_STATE_NOTATTACHED);
517 }
518 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
519 if (ret)
520 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
521 port1, ret);
522
523 return ret;
524}
525
Alan Stern7d069b72005-11-18 12:06:34 -0500526
527/* caller has locked the hub device */
528static void hub_pre_reset(struct usb_hub *hub, int disable_ports)
529{
530 struct usb_device *hdev = hub->hdev;
531 int port1;
532
533 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
534 if (hdev->children[port1 - 1]) {
535 usb_disconnect(&hdev->children[port1 - 1]);
536 if (disable_ports)
537 hub_port_disable(hub, port1, 0);
538 }
539 }
540 hub_quiesce(hub);
541}
542
543/* caller has locked the hub device */
544static void hub_post_reset(struct usb_hub *hub)
545{
546 hub_activate(hub);
547 hub_power_on(hub);
548}
549
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551static int hub_configure(struct usb_hub *hub,
552 struct usb_endpoint_descriptor *endpoint)
553{
554 struct usb_device *hdev = hub->hdev;
555 struct device *hub_dev = hub->intfdev;
556 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700557 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 unsigned int pipe;
559 int maxp, ret;
560 char *message;
561
562 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
563 &hub->buffer_dma);
564 if (!hub->buffer) {
565 message = "can't allocate hub irq buffer";
566 ret = -ENOMEM;
567 goto fail;
568 }
569
570 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
571 if (!hub->status) {
572 message = "can't kmalloc hub status buffer";
573 ret = -ENOMEM;
574 goto fail;
575 }
576
577 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
578 if (!hub->descriptor) {
579 message = "can't kmalloc hub descriptor";
580 ret = -ENOMEM;
581 goto fail;
582 }
583
584 /* Request the entire hub descriptor.
585 * hub->descriptor can handle USB_MAXCHILDREN ports,
586 * but the hub can/will return fewer bytes here.
587 */
588 ret = get_hub_descriptor(hdev, hub->descriptor,
589 sizeof(*hub->descriptor));
590 if (ret < 0) {
591 message = "can't read hub descriptor";
592 goto fail;
593 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
594 message = "hub has too many ports!";
595 ret = -ENODEV;
596 goto fail;
597 }
598
599 hdev->maxchild = hub->descriptor->bNbrPorts;
600 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
601 (hdev->maxchild == 1) ? "" : "s");
602
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700603 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700605 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 int i;
607 char portstr [USB_MAXCHILDREN + 1];
608
609 for (i = 0; i < hdev->maxchild; i++)
610 portstr[i] = hub->descriptor->DeviceRemovable
611 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
612 ? 'F' : 'R';
613 portstr[hdev->maxchild] = 0;
614 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
615 } else
616 dev_dbg(hub_dev, "standalone hub\n");
617
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700618 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 case 0x00:
620 dev_dbg(hub_dev, "ganged power switching\n");
621 break;
622 case 0x01:
623 dev_dbg(hub_dev, "individual port power switching\n");
624 break;
625 case 0x02:
626 case 0x03:
627 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
628 break;
629 }
630
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700631 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 case 0x00:
633 dev_dbg(hub_dev, "global over-current protection\n");
634 break;
635 case 0x08:
636 dev_dbg(hub_dev, "individual port over-current protection\n");
637 break;
638 case 0x10:
639 case 0x18:
640 dev_dbg(hub_dev, "no over-current protection\n");
641 break;
642 }
643
644 spin_lock_init (&hub->tt.lock);
645 INIT_LIST_HEAD (&hub->tt.clear_list);
646 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
647 switch (hdev->descriptor.bDeviceProtocol) {
648 case 0:
649 break;
650 case 1:
651 dev_dbg(hub_dev, "Single TT\n");
652 hub->tt.hub = hdev;
653 break;
654 case 2:
655 ret = usb_set_interface(hdev, 0, 1);
656 if (ret == 0) {
657 dev_dbg(hub_dev, "TT per port\n");
658 hub->tt.multi = 1;
659 } else
660 dev_err(hub_dev, "Using single TT (err %d)\n",
661 ret);
662 hub->tt.hub = hdev;
663 break;
664 default:
665 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
666 hdev->descriptor.bDeviceProtocol);
667 break;
668 }
669
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700670 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700671 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700672 case HUB_TTTT_8_BITS:
673 if (hdev->descriptor.bDeviceProtocol != 0) {
674 hub->tt.think_time = 666;
675 dev_dbg(hub_dev, "TT requires at most %d "
676 "FS bit times (%d ns)\n",
677 8, hub->tt.think_time);
678 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700680 case HUB_TTTT_16_BITS:
681 hub->tt.think_time = 666 * 2;
682 dev_dbg(hub_dev, "TT requires at most %d "
683 "FS bit times (%d ns)\n",
684 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700686 case HUB_TTTT_24_BITS:
687 hub->tt.think_time = 666 * 3;
688 dev_dbg(hub_dev, "TT requires at most %d "
689 "FS bit times (%d ns)\n",
690 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700692 case HUB_TTTT_32_BITS:
693 hub->tt.think_time = 666 * 4;
694 dev_dbg(hub_dev, "TT requires at most %d "
695 "FS bit times (%d ns)\n",
696 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 break;
698 }
699
700 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700701 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 hub->has_indicators = 1;
703 dev_dbg(hub_dev, "Port indicators are supported\n");
704 }
705
706 dev_dbg(hub_dev, "power on to power good time: %dms\n",
707 hub->descriptor->bPwrOn2PwrGood * 2);
708
709 /* power budgeting mostly matters with bus-powered hubs,
710 * and battery-powered root hubs (may provide just 8 mA).
711 */
712 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500713 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 message = "can't get hub status";
715 goto fail;
716 }
Alan Stern7d35b922005-04-25 11:18:32 -0400717 le16_to_cpus(&hubstatus);
718 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500719 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
720 hub->mA_per_port = 500;
721 else {
722 hub->mA_per_port = hdev->bus_mA;
723 hub->limited_power = 1;
724 }
Alan Stern7d35b922005-04-25 11:18:32 -0400725 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
727 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500728 hub->limited_power = 1;
729 if (hdev->maxchild > 0) {
730 int remaining = hdev->bus_mA -
731 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
Alan Stern55c52712005-11-23 12:03:12 -0500733 if (remaining < hdev->maxchild * 100)
734 dev_warn(hub_dev,
735 "insufficient power available "
736 "to use all downstream ports\n");
737 hub->mA_per_port = 100; /* 7.2.1.1 */
738 }
739 } else { /* Self-powered external hub */
740 /* FIXME: What about battery-powered external hubs that
741 * provide less current per port? */
742 hub->mA_per_port = 500;
743 }
744 if (hub->mA_per_port < 500)
745 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
746 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748 ret = hub_hub_status(hub, &hubstatus, &hubchange);
749 if (ret < 0) {
750 message = "can't get hub status";
751 goto fail;
752 }
753
754 /* local power status reports aren't always correct */
755 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
756 dev_dbg(hub_dev, "local power source is %s\n",
757 (hubstatus & HUB_STATUS_LOCAL_POWER)
758 ? "lost (inactive)" : "good");
759
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700760 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 dev_dbg(hub_dev, "%sover-current condition exists\n",
762 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
763
764 /* set up the interrupt endpoint */
765 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
766 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
767
768 if (maxp > sizeof(*hub->buffer))
769 maxp = sizeof(*hub->buffer);
770
771 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
772 if (!hub->urb) {
773 message = "couldn't allocate interrupt urb";
774 ret = -ENOMEM;
775 goto fail;
776 }
777
778 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
779 hub, endpoint->bInterval);
780 hub->urb->transfer_dma = hub->buffer_dma;
781 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
782
783 /* maybe cycle the hub leds */
784 if (hub->has_indicators && blinkenlights)
785 hub->indicator [0] = INDICATOR_CYCLE;
786
787 hub_power_on(hub);
788 hub_activate(hub);
789 return 0;
790
791fail:
792 dev_err (hub_dev, "config failed, %s (err %d)\n",
793 message, ret);
794 /* hub_disconnect() frees urb and descriptor */
795 return ret;
796}
797
798static unsigned highspeed_hubs;
799
800static void hub_disconnect(struct usb_interface *intf)
801{
802 struct usb_hub *hub = usb_get_intfdata (intf);
803 struct usb_device *hdev;
804
Alan Stern8b28c752005-08-10 17:04:13 -0400805 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 hdev = hub->hdev;
807
808 if (hdev->speed == USB_SPEED_HIGH)
809 highspeed_hubs--;
810
Alan Stern7d069b72005-11-18 12:06:34 -0500811 /* Disconnect all children and quiesce the hub */
812 hub_pre_reset(hub, 1);
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 usb_free_urb(hub->urb);
815 hub->urb = NULL;
816
817 spin_lock_irq(&hub_event_lock);
818 list_del_init(&hub->event_list);
819 spin_unlock_irq(&hub_event_lock);
820
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700821 kfree(hub->descriptor);
822 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700824 kfree(hub->status);
825 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 if (hub->buffer) {
828 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
829 hub->buffer_dma);
830 hub->buffer = NULL;
831 }
832
Alan Stern7d069b72005-11-18 12:06:34 -0500833 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
837{
838 struct usb_host_interface *desc;
839 struct usb_endpoint_descriptor *endpoint;
840 struct usb_device *hdev;
841 struct usb_hub *hub;
842
843 desc = intf->cur_altsetting;
844 hdev = interface_to_usbdev(intf);
845
David Brownell89ccbdc2006-04-02 10:18:09 -0800846#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
847 if (hdev->parent) {
848 dev_warn(&intf->dev, "ignoring external hub\n");
849 return -ENODEV;
850 }
851#endif
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 /* Some hubs have a subclass of 1, which AFAICT according to the */
854 /* specs is not defined, but it works */
855 if ((desc->desc.bInterfaceSubClass != 0) &&
856 (desc->desc.bInterfaceSubClass != 1)) {
857descriptor_error:
858 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
859 return -EIO;
860 }
861
862 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
863 if (desc->desc.bNumEndpoints != 1)
864 goto descriptor_error;
865
866 endpoint = &desc->endpoint[0].desc;
867
868 /* Output endpoint? Curiouser and curiouser.. */
869 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
870 goto descriptor_error;
871
872 /* If it's not an interrupt endpoint, we'd better punt! */
873 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
874 != USB_ENDPOINT_XFER_INT)
875 goto descriptor_error;
876
877 /* We found a hub */
878 dev_info (&intf->dev, "USB hub found\n");
879
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400880 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 if (!hub) {
882 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
883 return -ENOMEM;
884 }
885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 INIT_LIST_HEAD(&hub->event_list);
887 hub->intfdev = &intf->dev;
888 hub->hdev = hdev;
889 INIT_WORK(&hub->leds, led_work, hub);
890
891 usb_set_intfdata (intf, hub);
892
893 if (hdev->speed == USB_SPEED_HIGH)
894 highspeed_hubs++;
895
896 if (hub_configure(hub, endpoint) >= 0)
897 return 0;
898
899 hub_disconnect (intf);
900 return -ENODEV;
901}
902
903static int
904hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
905{
906 struct usb_device *hdev = interface_to_usbdev (intf);
907
908 /* assert ifno == 0 (part of hub spec) */
909 switch (code) {
910 case USBDEVFS_HUB_PORTINFO: {
911 struct usbdevfs_hub_portinfo *info = user_data;
912 int i;
913
914 spin_lock_irq(&device_state_lock);
915 if (hdev->devnum <= 0)
916 info->nports = 0;
917 else {
918 info->nports = hdev->maxchild;
919 for (i = 0; i < info->nports; i++) {
920 if (hdev->children[i] == NULL)
921 info->port[i] = 0;
922 else
923 info->port[i] =
924 hdev->children[i]->devnum;
925 }
926 }
927 spin_unlock_irq(&device_state_lock);
928
929 return info->nports + 1;
930 }
931
932 default:
933 return -ENOSYS;
934 }
935}
936
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
938/* grab device/port lock, returning index of that port (zero based).
939 * protects the upstream link used by this device from concurrent
940 * tree operations like suspend, resume, reset, and disconnect, which
941 * apply to everything downstream of a given port.
942 */
943static int locktree(struct usb_device *udev)
944{
945 int t;
946 struct usb_device *hdev;
947
948 if (!udev)
949 return -ENODEV;
950
951 /* root hub is always the first lock in the series */
952 hdev = udev->parent;
953 if (!hdev) {
954 usb_lock_device(udev);
955 return 0;
956 }
957
958 /* on the path from root to us, lock everything from
959 * top down, dropping parent locks when not needed
960 */
961 t = locktree(hdev);
962 if (t < 0)
963 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Alan Stern12c3da32005-11-23 12:09:52 -0500965 /* everything is fail-fast once disconnect
966 * processing starts
967 */
968 if (udev->state == USB_STATE_NOTATTACHED) {
969 usb_unlock_device(hdev);
970 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 }
Alan Stern12c3da32005-11-23 12:09:52 -0500972
973 /* when everyone grabs locks top->bottom,
974 * non-overlapping work may be concurrent
975 */
976 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -0500978 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979}
980
981static void recursively_mark_NOTATTACHED(struct usb_device *udev)
982{
983 int i;
984
985 for (i = 0; i < udev->maxchild; ++i) {
986 if (udev->children[i])
987 recursively_mark_NOTATTACHED(udev->children[i]);
988 }
989 udev->state = USB_STATE_NOTATTACHED;
990}
991
992/**
993 * usb_set_device_state - change a device's current state (usbcore, hcds)
994 * @udev: pointer to device whose state should be changed
995 * @new_state: new state value to be stored
996 *
997 * udev->state is _not_ fully protected by the device lock. Although
998 * most transitions are made only while holding the lock, the state can
999 * can change to USB_STATE_NOTATTACHED at almost any time. This
1000 * is so that devices can be marked as disconnected as soon as possible,
1001 * without having to wait for any semaphores to be released. As a result,
1002 * all changes to any device's state must be protected by the
1003 * device_state_lock spinlock.
1004 *
1005 * Once a device has been added to the device tree, all changes to its state
1006 * should be made using this routine. The state should _not_ be set directly.
1007 *
1008 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1009 * Otherwise udev->state is set to new_state, and if new_state is
1010 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1011 * to USB_STATE_NOTATTACHED.
1012 */
1013void usb_set_device_state(struct usb_device *udev,
1014 enum usb_device_state new_state)
1015{
1016 unsigned long flags;
1017
1018 spin_lock_irqsave(&device_state_lock, flags);
1019 if (udev->state == USB_STATE_NOTATTACHED)
1020 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001021 else if (new_state != USB_STATE_NOTATTACHED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 udev->state = new_state;
David Brownellfb669cc2006-01-24 08:40:27 -08001023
1024 /* root hub wakeup capabilities are managed out-of-band
1025 * and may involve silicon errata ... ignore them here.
1026 */
1027 if (udev->parent) {
1028 if (new_state == USB_STATE_CONFIGURED)
1029 device_init_wakeup(&udev->dev,
1030 (udev->actconfig->desc.bmAttributes
1031 & USB_CONFIG_ATT_WAKEUP));
1032 else if (new_state != USB_STATE_SUSPENDED)
1033 device_init_wakeup(&udev->dev, 0);
1034 }
David Brownellb94dc6b2005-09-12 19:39:39 -07001035 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 recursively_mark_NOTATTACHED(udev);
1037 spin_unlock_irqrestore(&device_state_lock, flags);
1038}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
1040
Alan Stern1c50c312005-11-14 11:45:38 -05001041#ifdef CONFIG_PM
1042
1043/**
1044 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1045 * @rhdev: struct usb_device for the root hub
1046 *
1047 * The USB host controller driver calls this function when its root hub
1048 * is resumed and Vbus power has been interrupted or the controller
1049 * has been reset. The routine marks all the children of the root hub
1050 * as NOTATTACHED and marks logical connect-change events on their ports.
1051 */
1052void usb_root_hub_lost_power(struct usb_device *rhdev)
1053{
1054 struct usb_hub *hub;
1055 int port1;
1056 unsigned long flags;
1057
1058 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1059 spin_lock_irqsave(&device_state_lock, flags);
1060 hub = hdev_to_hub(rhdev);
1061 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1062 if (rhdev->children[port1 - 1]) {
1063 recursively_mark_NOTATTACHED(
1064 rhdev->children[port1 - 1]);
1065 set_bit(port1, hub->change_bits);
1066 }
1067 }
1068 spin_unlock_irqrestore(&device_state_lock, flags);
1069}
1070EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1071
1072#endif
1073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074static void choose_address(struct usb_device *udev)
1075{
1076 int devnum;
1077 struct usb_bus *bus = udev->bus;
1078
1079 /* If khubd ever becomes multithreaded, this will need a lock */
1080
1081 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1082 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1083 bus->devnum_next);
1084 if (devnum >= 128)
1085 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1086
1087 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1088
1089 if (devnum < 128) {
1090 set_bit(devnum, bus->devmap.devicemap);
1091 udev->devnum = devnum;
1092 }
1093}
1094
1095static void release_address(struct usb_device *udev)
1096{
1097 if (udev->devnum > 0) {
1098 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1099 udev->devnum = -1;
1100 }
1101}
1102
1103/**
1104 * usb_disconnect - disconnect a device (usbcore-internal)
1105 * @pdev: pointer to device being disconnected
1106 * Context: !in_interrupt ()
1107 *
1108 * Something got disconnected. Get rid of it and all of its children.
1109 *
1110 * If *pdev is a normal device then the parent hub must already be locked.
1111 * If *pdev is a root hub then this routine will acquire the
1112 * usb_bus_list_lock on behalf of the caller.
1113 *
1114 * Only hub drivers (including virtual root hub drivers for host
1115 * controllers) should ever call this.
1116 *
1117 * This call is synchronous, and may not be used in an interrupt context.
1118 */
1119void usb_disconnect(struct usb_device **pdev)
1120{
1121 struct usb_device *udev = *pdev;
1122 int i;
1123
1124 if (!udev) {
1125 pr_debug ("%s nodev\n", __FUNCTION__);
1126 return;
1127 }
1128
1129 /* mark the device as inactive, so any further urb submissions for
1130 * this device (and any of its children) will fail immediately.
1131 * this quiesces everyting except pending urbs.
1132 */
1133 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1135
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001136 usb_lock_device(udev);
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 /* Free up all the children before we remove this device */
1139 for (i = 0; i < USB_MAXCHILDREN; i++) {
1140 if (udev->children[i])
1141 usb_disconnect(&udev->children[i]);
1142 }
1143
1144 /* deallocate hcd/hardware state ... nuking all pending urbs and
1145 * cleaning up all state associated with the current configuration
1146 * so that the hardware is now fully quiesced.
1147 */
1148 usb_disable_device(udev, 0);
1149
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001150 usb_notify_remove_device(udev);
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 /* Free the device number, remove the /proc/bus/usb entry and
1153 * the sysfs attributes, and delete the parent's children[]
1154 * (or root_hub) pointer.
1155 */
1156 dev_dbg (&udev->dev, "unregistering device\n");
1157 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 usb_remove_sysfs_dev_files(udev);
1159
1160 /* Avoid races with recursively_mark_NOTATTACHED() */
1161 spin_lock_irq(&device_state_lock);
1162 *pdev = NULL;
1163 spin_unlock_irq(&device_state_lock);
1164
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001165 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167 device_unregister(&udev->dev);
1168}
1169
Alan Stern55c52712005-11-23 12:03:12 -05001170static inline const char *plural(int n)
1171{
1172 return (n == 1 ? "" : "s");
1173}
1174
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175static int choose_configuration(struct usb_device *udev)
1176{
Alan Stern55c52712005-11-23 12:03:12 -05001177 int i;
Alan Stern55c52712005-11-23 12:03:12 -05001178 int num_configs;
1179 struct usb_host_config *c, *best;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
Alan Stern55c52712005-11-23 12:03:12 -05001181 best = NULL;
1182 c = udev->config;
1183 num_configs = udev->descriptor.bNumConfigurations;
1184 for (i = 0; i < num_configs; (i++, c++)) {
Alan Stern6aa35672006-03-08 15:14:09 -05001185 struct usb_interface_descriptor *desc = NULL;
1186
1187 /* It's possible that a config has no interfaces! */
1188 if (c->desc.bNumInterfaces > 0)
1189 desc = &c->intf_cache[0]->altsetting->desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Alan Stern55c52712005-11-23 12:03:12 -05001191 /*
1192 * HP's USB bus-powered keyboard has only one configuration
1193 * and it claims to be self-powered; other devices may have
1194 * similar errors in their descriptors. If the next test
1195 * were allowed to execute, such configurations would always
1196 * be rejected and the devices would not work as expected.
Alan Stern436f5762006-05-02 15:22:41 -04001197 * In the meantime, we run the risk of selecting a config
1198 * that requires external power at a time when that power
1199 * isn't available. It seems to be the lesser of two evils.
1200 *
1201 * Bugzilla #6448 reports a device that appears to crash
1202 * when it receives a GET_DEVICE_STATUS request! We don't
1203 * have any other way to tell whether a device is self-powered,
1204 * but since we don't use that information anywhere but here,
1205 * the call has been removed.
1206 *
1207 * Maybe the GET_DEVICE_STATUS call and the test below can
1208 * be reinstated when device firmwares become more reliable.
1209 * Don't hold your breath.
Alan Stern55c52712005-11-23 12:03:12 -05001210 */
1211#if 0
1212 /* Rule out self-powered configs for a bus-powered device */
1213 if (bus_powered && (c->desc.bmAttributes &
1214 USB_CONFIG_ATT_SELFPOWER))
1215 continue;
1216#endif
1217
1218 /*
1219 * The next test may not be as effective as it should be.
1220 * Some hubs have errors in their descriptor, claiming
1221 * to be self-powered when they are really bus-powered.
1222 * We will overestimate the amount of current such hubs
1223 * make available for each port.
1224 *
1225 * This is a fairly benign sort of failure. It won't
1226 * cause us to reject configurations that we should have
1227 * accepted.
1228 */
1229
1230 /* Rule out configs that draw too much bus current */
1231 if (c->desc.bMaxPower * 2 > udev->bus_mA)
1232 continue;
1233
1234 /* If the first config's first interface is COMM/2/0xff
1235 * (MSFT RNDIS), rule it out unless Linux has host-side
1236 * RNDIS support. */
Alan Stern6aa35672006-03-08 15:14:09 -05001237 if (i == 0 && desc
1238 && desc->bInterfaceClass == USB_CLASS_COMM
Alan Stern55c52712005-11-23 12:03:12 -05001239 && desc->bInterfaceSubClass == 2
1240 && desc->bInterfaceProtocol == 0xff) {
1241#ifndef CONFIG_USB_NET_RNDIS
1242 continue;
1243#else
1244 best = c;
1245#endif
1246 }
1247
1248 /* From the remaining configs, choose the first one whose
1249 * first interface is for a non-vendor-specific class.
1250 * Reason: Linux is more likely to have a class driver
1251 * than a vendor-specific driver. */
1252 else if (udev->descriptor.bDeviceClass !=
1253 USB_CLASS_VENDOR_SPEC &&
Alan Stern6aa35672006-03-08 15:14:09 -05001254 (!desc || desc->bInterfaceClass !=
1255 USB_CLASS_VENDOR_SPEC)) {
Alan Stern55c52712005-11-23 12:03:12 -05001256 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 break;
1258 }
Alan Stern55c52712005-11-23 12:03:12 -05001259
1260 /* If all the remaining configs are vendor-specific,
1261 * choose the first one. */
1262 else if (!best)
1263 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
Alan Stern55c52712005-11-23 12:03:12 -05001265
1266 if (best) {
1267 i = best->desc.bConfigurationValue;
1268 dev_info(&udev->dev,
1269 "configuration #%d chosen from %d choice%s\n",
1270 i, num_configs, plural(num_configs));
1271 } else {
1272 i = -1;
1273 dev_warn(&udev->dev,
1274 "no configuration chosen from %d choice%s\n",
1275 num_configs, plural(num_configs));
1276 }
1277 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
1280#ifdef DEBUG
1281static void show_string(struct usb_device *udev, char *id, char *string)
1282{
1283 if (!string)
1284 return;
1285 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1286}
1287
1288#else
1289static inline void show_string(struct usb_device *udev, char *id, char *string)
1290{}
1291#endif
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
1294#ifdef CONFIG_USB_OTG
1295#include "otg_whitelist.h"
1296#endif
1297
1298/**
1299 * usb_new_device - perform initial device setup (usbcore-internal)
1300 * @udev: newly addressed device (in ADDRESS state)
1301 *
1302 * This is called with devices which have been enumerated, but not yet
1303 * configured. The device descriptor is available, but not descriptors
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001304 * for any device configuration. The caller must have locked either
1305 * the parent hub (if udev is a normal device) or else the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1307 * udev has already been installed, but udev is not yet visible through
1308 * sysfs or other filesystem code.
1309 *
1310 * Returns 0 for success (device is configured and listed, with its
1311 * interfaces, in sysfs); else a negative errno value.
1312 *
1313 * This call is synchronous, and may not be used in an interrupt context.
1314 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001315 * Only the hub driver or root-hub registrar should ever call this.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 */
1317int usb_new_device(struct usb_device *udev)
1318{
1319 int err;
1320 int c;
1321
1322 err = usb_get_configuration(udev);
1323 if (err < 0) {
1324 dev_err(&udev->dev, "can't read configurations, error %d\n",
1325 err);
1326 goto fail;
1327 }
1328
1329 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001330 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1331 udev->manufacturer = usb_cache_string(udev,
1332 udev->descriptor.iManufacturer);
1333 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
1335 /* Tell the world! */
1336 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1337 "SerialNumber=%d\n",
1338 udev->descriptor.iManufacturer,
1339 udev->descriptor.iProduct,
1340 udev->descriptor.iSerialNumber);
1341 show_string(udev, "Product", udev->product);
1342 show_string(udev, "Manufacturer", udev->manufacturer);
1343 show_string(udev, "SerialNumber", udev->serial);
1344
1345#ifdef CONFIG_USB_OTG
1346 /*
1347 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1348 * to wake us after we've powered off VBUS; and HNP, switching roles
1349 * "host" to "peripheral". The OTG descriptor helps figure this out.
1350 */
1351 if (!udev->bus->is_b_host
1352 && udev->config
1353 && udev->parent == udev->bus->root_hub) {
1354 struct usb_otg_descriptor *desc = 0;
1355 struct usb_bus *bus = udev->bus;
1356
1357 /* descriptor may appear anywhere in config */
1358 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1359 le16_to_cpu(udev->config[0].desc.wTotalLength),
1360 USB_DT_OTG, (void **) &desc) == 0) {
1361 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001362 unsigned port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 struct usb_device *root = udev->parent;
1364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 dev_info(&udev->dev,
1366 "Dual-Role OTG device on %sHNP port\n",
1367 (port1 == bus->otg_port)
1368 ? "" : "non-");
1369
1370 /* enable HNP before suspend, it's simpler */
1371 if (port1 == bus->otg_port)
1372 bus->b_hnp_enable = 1;
1373 err = usb_control_msg(udev,
1374 usb_sndctrlpipe(udev, 0),
1375 USB_REQ_SET_FEATURE, 0,
1376 bus->b_hnp_enable
1377 ? USB_DEVICE_B_HNP_ENABLE
1378 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1379 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1380 if (err < 0) {
1381 /* OTG MESSAGE: report errors here,
1382 * customize to match your product.
1383 */
1384 dev_info(&udev->dev,
1385 "can't set HNP mode; %d\n",
1386 err);
1387 bus->b_hnp_enable = 0;
1388 }
1389 }
1390 }
1391 }
1392
1393 if (!is_targeted(udev)) {
1394
1395 /* Maybe it can talk to us, though we can't talk to it.
1396 * (Includes HNP test device.)
1397 */
1398 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell390a8c32005-09-13 19:57:27 -07001399 static int __usb_suspend_device(struct usb_device *,
1400 int port1);
1401 err = __usb_suspend_device(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 if (err < 0)
1403 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1404 }
1405 err = -ENODEV;
1406 goto fail;
1407 }
1408#endif
1409
1410 /* put device-specific files into sysfs */
1411 err = device_add (&udev->dev);
1412 if (err) {
1413 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1414 goto fail;
1415 }
1416 usb_create_sysfs_dev_files (udev);
1417
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001418 usb_lock_device(udev);
1419
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 /* choose and set the configuration. that registers the interfaces
1421 * with the driver core, and lets usb device drivers bind to them.
1422 */
1423 c = choose_configuration(udev);
Alan Stern55c52712005-11-23 12:03:12 -05001424 if (c >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 err = usb_set_configuration(udev, c);
1426 if (err) {
1427 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1428 c, err);
Alan Stern55c52712005-11-23 12:03:12 -05001429 /* This need not be fatal. The user can try to
1430 * set other configurations. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 }
1432 }
1433
1434 /* USB device state == configured ... usable */
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001435 usb_notify_add_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001437 usb_unlock_device(udev);
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 return 0;
1440
1441fail:
1442 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1443 return err;
1444}
1445
1446
1447static int hub_port_status(struct usb_hub *hub, int port1,
1448 u16 *status, u16 *change)
1449{
1450 int ret;
1451
1452 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1453 if (ret < 0)
1454 dev_err (hub->intfdev,
1455 "%s failed (err = %d)\n", __FUNCTION__, ret);
1456 else {
1457 *status = le16_to_cpu(hub->status->port.wPortStatus);
1458 *change = le16_to_cpu(hub->status->port.wPortChange);
1459 ret = 0;
1460 }
1461 return ret;
1462}
1463
1464#define PORT_RESET_TRIES 5
1465#define SET_ADDRESS_TRIES 2
1466#define GET_DESCRIPTOR_TRIES 2
1467#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1468#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1469
1470#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1471#define HUB_SHORT_RESET_TIME 10
1472#define HUB_LONG_RESET_TIME 200
1473#define HUB_RESET_TIMEOUT 500
1474
1475static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1476 struct usb_device *udev, unsigned int delay)
1477{
1478 int delay_time, ret;
1479 u16 portstatus;
1480 u16 portchange;
1481
1482 for (delay_time = 0;
1483 delay_time < HUB_RESET_TIMEOUT;
1484 delay_time += delay) {
1485 /* wait to give the device a chance to reset */
1486 msleep(delay);
1487
1488 /* read and decode port status */
1489 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1490 if (ret < 0)
1491 return ret;
1492
1493 /* Device went away? */
1494 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1495 return -ENOTCONN;
1496
1497 /* bomb out completely if something weird happened */
1498 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1499 return -EINVAL;
1500
1501 /* if we`ve finished resetting, then break out of the loop */
1502 if (!(portstatus & USB_PORT_STAT_RESET) &&
1503 (portstatus & USB_PORT_STAT_ENABLE)) {
1504 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1505 udev->speed = USB_SPEED_HIGH;
1506 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1507 udev->speed = USB_SPEED_LOW;
1508 else
1509 udev->speed = USB_SPEED_FULL;
1510 return 0;
1511 }
1512
1513 /* switch to the long delay after two short delay failures */
1514 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1515 delay = HUB_LONG_RESET_TIME;
1516
1517 dev_dbg (hub->intfdev,
1518 "port %d not reset yet, waiting %dms\n",
1519 port1, delay);
1520 }
1521
1522 return -EBUSY;
1523}
1524
1525static int hub_port_reset(struct usb_hub *hub, int port1,
1526 struct usb_device *udev, unsigned int delay)
1527{
1528 int i, status;
1529
1530 /* Reset the port */
1531 for (i = 0; i < PORT_RESET_TRIES; i++) {
1532 status = set_port_feature(hub->hdev,
1533 port1, USB_PORT_FEAT_RESET);
1534 if (status)
1535 dev_err(hub->intfdev,
1536 "cannot reset port %d (err = %d)\n",
1537 port1, status);
1538 else {
1539 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001540 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 dev_dbg(hub->intfdev,
1542 "port_wait_reset: err = %d\n",
1543 status);
1544 }
1545
1546 /* return on disconnect or reset */
1547 switch (status) {
1548 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001549 /* TRSTRCY = 10 ms; plus some extra */
1550 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 /* FALL THROUGH */
1552 case -ENOTCONN:
1553 case -ENODEV:
1554 clear_port_feature(hub->hdev,
1555 port1, USB_PORT_FEAT_C_RESET);
1556 /* FIXME need disconnect() for NOTATTACHED device */
1557 usb_set_device_state(udev, status
1558 ? USB_STATE_NOTATTACHED
1559 : USB_STATE_DEFAULT);
1560 return status;
1561 }
1562
1563 dev_dbg (hub->intfdev,
1564 "port %d not enabled, trying reset again...\n",
1565 port1);
1566 delay = HUB_LONG_RESET_TIME;
1567 }
1568
1569 dev_err (hub->intfdev,
1570 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1571 port1);
1572
1573 return status;
1574}
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576/*
1577 * Disable a port and mark a logical connnect-change event, so that some
1578 * time later khubd will disconnect() any existing usb_device on the port
1579 * and will re-enumerate if there actually is a device attached.
1580 */
1581static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1582{
1583 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1584 hub_port_disable(hub, port1, 1);
1585
1586 /* FIXME let caller ask to power down the port:
1587 * - some devices won't enumerate without a VBUS power cycle
1588 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001589 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 * That's easy if this hub can switch power per-port, and
1591 * khubd reactivates the port later (timer, SRP, etc).
1592 * Powerdown must be optional, because of reset/DFU.
1593 */
1594
1595 set_bit(port1, hub->change_bits);
1596 kick_khubd(hub);
1597}
1598
1599
1600#ifdef CONFIG_USB_SUSPEND
1601
1602/*
1603 * Selective port suspend reduces power; most suspended devices draw
1604 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1605 * All devices below the suspended port are also suspended.
1606 *
1607 * Devices leave suspend state when the host wakes them up. Some devices
1608 * also support "remote wakeup", where the device can activate the USB
1609 * tree above them to deliver data, such as a keypress or packet. In
1610 * some cases, this wakes the USB host.
1611 */
1612static int hub_port_suspend(struct usb_hub *hub, int port1,
1613 struct usb_device *udev)
1614{
1615 int status;
1616
1617 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1618
1619 /* enable remote wakeup when appropriate; this lets the device
1620 * wake up the upstream hub (including maybe the root hub).
1621 *
1622 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1623 * we don't explicitly enable it here.
1624 */
David Brownellb94dc6b2005-09-12 19:39:39 -07001625 if (device_may_wakeup(&udev->dev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1627 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1628 USB_DEVICE_REMOTE_WAKEUP, 0,
1629 NULL, 0,
1630 USB_CTRL_SET_TIMEOUT);
1631 if (status)
1632 dev_dbg(&udev->dev,
1633 "won't remote wakeup, status %d\n",
1634 status);
1635 }
1636
1637 /* see 7.1.7.6 */
1638 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1639 if (status) {
1640 dev_dbg(hub->intfdev,
1641 "can't suspend port %d, status %d\n",
1642 port1, status);
1643 /* paranoia: "should not happen" */
1644 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1645 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1646 USB_DEVICE_REMOTE_WAKEUP, 0,
1647 NULL, 0,
1648 USB_CTRL_SET_TIMEOUT);
1649 } else {
1650 /* device has up to 10 msec to fully suspend */
1651 dev_dbg(&udev->dev, "usb suspend\n");
1652 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1653 msleep(10);
1654 }
1655 return status;
1656}
1657
1658/*
1659 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001660 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 * State transitions include:
1662 *
1663 * - suspend, resume ... when the VBUS power link stays live
1664 * - suspend, disconnect ... VBUS lost
1665 *
1666 * Once VBUS drop breaks the circuit, the port it's using has to go through
1667 * normal re-enumeration procedures, starting with enabling VBUS power.
1668 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1669 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1670 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001671 *
1672 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1673 * the root hub for their bus goes into global suspend ... so we don't
1674 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 */
David Brownell390a8c32005-09-13 19:57:27 -07001676static int __usb_suspend_device (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677{
David Brownellf3f32532005-09-22 22:37:29 -07001678 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 /* caller owns the udev device lock */
1681 if (port1 < 0)
1682 return port1;
1683
1684 if (udev->state == USB_STATE_SUSPENDED
1685 || udev->state == USB_STATE_NOTATTACHED) {
1686 return 0;
1687 }
1688
David Brownellc9f89fa2005-09-13 19:57:04 -07001689 /* all interfaces must already be suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 if (udev->actconfig) {
1691 int i;
1692
1693 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1694 struct usb_interface *intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
1696 intf = udev->actconfig->interface[i];
David Brownellc9f89fa2005-09-13 19:57:04 -07001697 if (is_active(intf)) {
1698 dev_dbg(&intf->dev, "nyet suspended\n");
1699 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 }
1701 }
1702 }
1703
David Brownellf3f32532005-09-22 22:37:29 -07001704 /* we only change a device's upstream USB link.
1705 * root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 */
David Brownellf3f32532005-09-22 22:37:29 -07001707 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1709 udev);
1710
1711 if (status == 0)
David Brownell390a8c32005-09-13 19:57:27 -07001712 udev->dev.power.power_state = PMSG_SUSPEND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 return status;
1714}
1715
David Brownellf3f32532005-09-22 22:37:29 -07001716#endif
1717
David Brownell5edbfb72005-09-22 22:45:26 -07001718/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 * usb_suspend_device - suspend a usb device
1720 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001721 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 *
1723 * Suspends a USB device that isn't in active use, conserving power.
1724 * Devices may wake out of a suspend, if anything important happens,
1725 * using the remote wakeup mechanism. They may also be taken out of
1726 * suspend by the host, using usb_resume_device(). It's also routine
1727 * to disconnect devices while they are suspended.
1728 *
David Brownell390a8c32005-09-13 19:57:27 -07001729 * This only affects the USB hardware for a device; its interfaces
1730 * (and, for hubs, child devices) must already have been suspended.
1731 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 * Suspending OTG devices may trigger HNP, if that's been enabled
1733 * between a pair of dual-role devices. That will change roles, such
1734 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1735 *
1736 * Returns 0 on success, else negative errno.
1737 */
David Brownell390a8c32005-09-13 19:57:27 -07001738int usb_suspend_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739{
David Brownellf3f32532005-09-22 22:37:29 -07001740#ifdef CONFIG_USB_SUSPEND
Alan Stern4bf0ba82005-11-21 11:58:07 -05001741 if (udev->state == USB_STATE_NOTATTACHED)
1742 return -ENODEV;
Alan Stern12c3da32005-11-23 12:09:52 -05001743 return __usb_suspend_device(udev, udev->portnum);
David Brownellf3f32532005-09-22 22:37:29 -07001744#else
1745 /* NOTE: udev->state unchanged, it's not lying ... */
1746 udev->dev.power.power_state = PMSG_SUSPEND;
1747 return 0;
1748#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749}
David Brownellf3f32532005-09-22 22:37:29 -07001750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751/*
David Brownell390a8c32005-09-13 19:57:27 -07001752 * If the USB "suspend" state is in use (rather than "global suspend"),
1753 * many devices will be individually taken out of suspend state using
1754 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 * hardware resume signaling is finished, either because of selective
1756 * resume (by host) or remote wakeup (by device) ... now see what changed
1757 * in the tree that's rooted at this device.
1758 */
David Brownellf3f32532005-09-22 22:37:29 -07001759static int finish_device_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760{
1761 int status;
1762 u16 devstatus;
1763
1764 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001765 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
1767 /* usb ch9 identifies four variants of SUSPENDED, based on what
1768 * state the device resumes to. Linux currently won't see the
1769 * first two on the host side; they'd be inside hub_port_init()
1770 * during many timeouts, but khubd can't suspend until later.
1771 */
1772 usb_set_device_state(udev, udev->actconfig
1773 ? USB_STATE_CONFIGURED
1774 : USB_STATE_ADDRESS);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001775 udev->dev.power.power_state = PMSG_ON;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
1777 /* 10.5.4.5 says be sure devices in the tree are still there.
1778 * For now let's assume the device didn't go crazy on resume,
1779 * and device drivers will know about any resume quirks.
1780 */
1781 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001782 if (status < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 dev_dbg(&udev->dev,
1784 "gone after usb resume? status %d\n",
1785 status);
1786 else if (udev->actconfig) {
1787 unsigned i;
David Brownelldbc38872005-09-13 19:57:36 -07001788 int (*resume)(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
1790 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001791 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001792 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 status = usb_control_msg(udev,
1794 usb_sndctrlpipe(udev, 0),
1795 USB_REQ_CLEAR_FEATURE,
1796 USB_RECIP_DEVICE,
1797 USB_DEVICE_REMOTE_WAKEUP, 0,
1798 NULL, 0,
1799 USB_CTRL_SET_TIMEOUT);
1800 if (status) {
1801 dev_dbg(&udev->dev, "disable remote "
1802 "wakeup, status %d\n", status);
1803 status = 0;
1804 }
1805 }
1806
1807 /* resume interface drivers; if this is a hub, it
David Brownelldbc38872005-09-13 19:57:36 -07001808 * may have a child resume event to deal with soon
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 */
David Brownelldbc38872005-09-13 19:57:36 -07001810 resume = udev->dev.bus->resume;
Alan Stern4bf0ba82005-11-21 11:58:07 -05001811 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1812 struct device *dev =
1813 &udev->actconfig->interface[i]->dev;
1814
1815 down(&dev->sem);
1816 (void) resume(dev);
1817 up(&dev->sem);
1818 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 status = 0;
1820
1821 } else if (udev->devnum <= 0) {
1822 dev_dbg(&udev->dev, "bogus resume!\n");
1823 status = -EINVAL;
1824 }
1825 return status;
1826}
1827
David Brownellf3f32532005-09-22 22:37:29 -07001828#ifdef CONFIG_USB_SUSPEND
1829
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830static int
1831hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1832{
1833 int status;
1834
1835 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1836
1837 /* see 7.1.7.7; affects power usage, but not budgeting */
1838 status = clear_port_feature(hub->hdev,
1839 port1, USB_PORT_FEAT_SUSPEND);
1840 if (status) {
1841 dev_dbg(hub->intfdev,
1842 "can't resume port %d, status %d\n",
1843 port1, status);
1844 } else {
1845 u16 devstatus;
1846 u16 portchange;
1847
1848 /* drive resume for at least 20 msec */
1849 if (udev)
1850 dev_dbg(&udev->dev, "RESUME\n");
1851 msleep(25);
1852
1853#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1854 | USB_PORT_STAT_ENABLE \
1855 | USB_PORT_STAT_CONNECTION)
1856
1857 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1858 * stop resume signaling. Then finish the resume
1859 * sequence.
1860 */
1861 devstatus = portchange = 0;
1862 status = hub_port_status(hub, port1,
1863 &devstatus, &portchange);
1864 if (status < 0
1865 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1866 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1867 ) {
1868 dev_dbg(hub->intfdev,
1869 "port %d status %04x.%04x after resume, %d\n",
1870 port1, portchange, devstatus, status);
1871 } else {
1872 /* TRSMRCY = 10 msec */
1873 msleep(10);
1874 if (udev)
David Brownellf3f32532005-09-22 22:37:29 -07001875 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 }
1877 }
1878 if (status < 0)
1879 hub_port_logical_disconnect(hub, port1);
1880
1881 return status;
1882}
1883
David Brownellf3f32532005-09-22 22:37:29 -07001884#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
David Brownell5edbfb72005-09-22 22:45:26 -07001886/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 * usb_resume_device - re-activate a suspended usb device
1888 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001889 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 *
1891 * This will re-activate the suspended device, increasing power usage
1892 * while letting drivers communicate again with its endpoints.
1893 * USB resume explicitly guarantees that the power session between
1894 * the host and the device is the same as it was when the device
1895 * suspended.
1896 *
1897 * Returns 0 on success, else negative errno.
1898 */
1899int usb_resume_device(struct usb_device *udev)
1900{
Alan Stern12c3da32005-11-23 12:09:52 -05001901 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902
Alan Stern4bf0ba82005-11-21 11:58:07 -05001903 if (udev->state == USB_STATE_NOTATTACHED)
1904 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
David Brownellf3f32532005-09-22 22:37:29 -07001906 /* selective resume of one downstream hub-to-device port */
1907 if (udev->parent) {
David Brownellfb669cc2006-01-24 08:40:27 -08001908#ifdef CONFIG_USB_SUSPEND
David Brownellf3f32532005-09-22 22:37:29 -07001909 if (udev->state == USB_STATE_SUSPENDED) {
1910 // NOTE swsusp may bork us, device state being wrong...
1911 // NOTE this fails if parent is also suspended...
1912 status = hub_port_resume(hdev_to_hub(udev->parent),
Alan Stern12c3da32005-11-23 12:09:52 -05001913 udev->portnum, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 } else
David Brownellf3f32532005-09-22 22:37:29 -07001915#endif
Alan Stern43c5d5a2006-02-01 10:47:11 -05001916 status = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001917 } else
David Brownellf3f32532005-09-22 22:37:29 -07001918 status = finish_device_resume(udev);
1919 if (status < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 dev_dbg(&udev->dev, "can't resume, status %d\n",
1921 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 /* rebind drivers that had no suspend() */
Alan Stern4bf0ba82005-11-21 11:58:07 -05001924 if (status == 0) {
1925 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 bus_rescan_devices(&usb_bus_type);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001927 usb_lock_device(udev);
1928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 return status;
1930}
1931
1932static int remote_wakeup(struct usb_device *udev)
1933{
1934 int status = 0;
1935
David Brownellf3f32532005-09-22 22:37:29 -07001936#ifdef CONFIG_USB_SUSPEND
1937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 /* don't repeat RESUME sequence if this device
1939 * was already woken up by some other task
1940 */
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001941 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 if (udev->state == USB_STATE_SUSPENDED) {
1943 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1944 /* TRSMRCY = 10 msec */
1945 msleep(10);
David Brownellf3f32532005-09-22 22:37:29 -07001946 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001948 usb_unlock_device(udev);
David Brownellf3f32532005-09-22 22:37:29 -07001949#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 return status;
1951}
1952
David Brownelldb690872005-09-13 19:56:33 -07001953static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954{
1955 struct usb_hub *hub = usb_get_intfdata (intf);
1956 struct usb_device *hdev = hub->hdev;
1957 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
David Brownellc9f89fa2005-09-13 19:57:04 -07001959 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1961 struct usb_device *udev;
1962
1963 udev = hdev->children [port1-1];
David Brownellf3f32532005-09-22 22:37:29 -07001964 if (udev && (udev->dev.power.power_state.event
1965 == PM_EVENT_ON
1966#ifdef CONFIG_USB_SUSPEND
1967 || udev->state != USB_STATE_SUSPENDED
1968#endif
1969 )) {
David Brownellc9f89fa2005-09-13 19:57:04 -07001970 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1971 return -EBUSY;
1972 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
1974
David Brownellf3f32532005-09-22 22:37:29 -07001975 /* "global suspend" of the downstream HC-to-USB interface */
1976 if (!hdev->parent) {
1977 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001978 if (bus) {
1979 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001980
1981 if (status != 0) {
1982 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1983 status);
1984 return status;
1985 }
1986 } else
1987 return -EOPNOTSUPP;
1988 }
1989
David Brownellc9f89fa2005-09-13 19:57:04 -07001990 /* stop khubd and related activity */
1991 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 return 0;
1993}
1994
1995static int hub_resume(struct usb_interface *intf)
1996{
1997 struct usb_device *hdev = interface_to_usbdev(intf);
1998 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 int status;
2000
David Brownellf3f32532005-09-22 22:37:29 -07002001 /* "global resume" of the downstream HC-to-USB interface */
2002 if (!hdev->parent) {
2003 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04002004 if (bus) {
2005 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07002006 if (status) {
2007 dev_dbg(&intf->dev, "'global' resume %d\n",
2008 status);
2009 return status;
2010 }
2011 } else
2012 return -EOPNOTSUPP;
2013 if (status == 0) {
2014 /* TRSMRCY = 10 msec */
2015 msleep(10);
2016 }
2017 }
2018
2019 hub_activate(hub);
2020
2021 /* REVISIT: this recursion probably shouldn't exist. Remove
2022 * this code sometime, after retesting with different root and
2023 * external hubs.
2024 */
2025#ifdef CONFIG_USB_SUSPEND
2026 {
2027 unsigned port1;
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2030 struct usb_device *udev;
2031 u16 portstat, portchange;
2032
2033 udev = hdev->children [port1-1];
2034 status = hub_port_status(hub, port1, &portstat, &portchange);
2035 if (status == 0) {
2036 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2037 clear_port_feature(hdev, port1,
2038 USB_PORT_FEAT_C_SUSPEND);
2039 portchange &= ~USB_PORT_STAT_C_SUSPEND;
2040 }
2041
2042 /* let khubd handle disconnects etc */
2043 if (portchange)
2044 continue;
2045 }
2046
2047 if (!udev || status < 0)
2048 continue;
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002049 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 if (portstat & USB_PORT_STAT_SUSPEND)
2051 status = hub_port_resume(hub, port1, udev);
2052 else {
David Brownellf3f32532005-09-22 22:37:29 -07002053 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 if (status < 0) {
2055 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2056 port1, status);
2057 hub_port_logical_disconnect(hub, port1);
2058 }
2059 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002060 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 }
David Brownellf3f32532005-09-22 22:37:29 -07002062 }
2063#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 return 0;
2065}
2066
David Brownell979d5192005-09-22 22:32:24 -07002067void usb_suspend_root_hub(struct usb_device *hdev)
2068{
2069 struct usb_hub *hub = hdev_to_hub(hdev);
2070
2071 /* This also makes any led blinker stop retriggering. We're called
2072 * from irq, so the blinker might still be scheduled. Caller promises
2073 * that the root hub status URB will be canceled.
2074 */
2075 __hub_quiesce(hub);
2076 mark_quiesced(to_usb_interface(hub->intfdev));
2077}
2078
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079void usb_resume_root_hub(struct usb_device *hdev)
2080{
2081 struct usb_hub *hub = hdev_to_hub(hdev);
2082
2083 hub->resume_root_hub = 1;
2084 kick_khubd(hub);
2085}
2086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
2088/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2089 *
2090 * Between connect detection and reset signaling there must be a delay
2091 * of 100ms at least for debounce and power-settling. The corresponding
2092 * timer shall restart whenever the downstream port detects a disconnect.
2093 *
2094 * Apparently there are some bluetooth and irda-dongles and a number of
2095 * low-speed devices for which this debounce period may last over a second.
2096 * Not covered by the spec - but easy to deal with.
2097 *
2098 * This implementation uses a 1500ms total debounce timeout; if the
2099 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2100 * every 25ms for transient disconnects. When the port status has been
2101 * unchanged for 100ms it returns the port status.
2102 */
2103
2104#define HUB_DEBOUNCE_TIMEOUT 1500
2105#define HUB_DEBOUNCE_STEP 25
2106#define HUB_DEBOUNCE_STABLE 100
2107
2108static int hub_port_debounce(struct usb_hub *hub, int port1)
2109{
2110 int ret;
2111 int total_time, stable_time = 0;
2112 u16 portchange, portstatus;
2113 unsigned connection = 0xffff;
2114
2115 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2116 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2117 if (ret < 0)
2118 return ret;
2119
2120 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2121 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2122 stable_time += HUB_DEBOUNCE_STEP;
2123 if (stable_time >= HUB_DEBOUNCE_STABLE)
2124 break;
2125 } else {
2126 stable_time = 0;
2127 connection = portstatus & USB_PORT_STAT_CONNECTION;
2128 }
2129
2130 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2131 clear_port_feature(hub->hdev, port1,
2132 USB_PORT_FEAT_C_CONNECTION);
2133 }
2134
2135 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2136 break;
2137 msleep(HUB_DEBOUNCE_STEP);
2138 }
2139
2140 dev_dbg (hub->intfdev,
2141 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2142 port1, total_time, stable_time, portstatus);
2143
2144 if (stable_time < HUB_DEBOUNCE_STABLE)
2145 return -ETIMEDOUT;
2146 return portstatus;
2147}
2148
2149static void ep0_reinit(struct usb_device *udev)
2150{
2151 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2152 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2153 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2154}
2155
2156#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2157#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2158
2159static int hub_set_address(struct usb_device *udev)
2160{
2161 int retval;
2162
2163 if (udev->devnum == 0)
2164 return -EINVAL;
2165 if (udev->state == USB_STATE_ADDRESS)
2166 return 0;
2167 if (udev->state != USB_STATE_DEFAULT)
2168 return -EINVAL;
2169 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2170 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2171 NULL, 0, USB_CTRL_SET_TIMEOUT);
2172 if (retval == 0) {
2173 usb_set_device_state(udev, USB_STATE_ADDRESS);
2174 ep0_reinit(udev);
2175 }
2176 return retval;
2177}
2178
2179/* Reset device, (re)assign address, get device descriptor.
2180 * Device connection must be stable, no more debouncing needed.
2181 * Returns device in USB_STATE_ADDRESS, except on error.
2182 *
2183 * If this is called for an already-existing device (as part of
2184 * usb_reset_device), the caller must own the device lock. For a
2185 * newly detected device that is not accessible through any global
2186 * pointers, it's not necessary to lock the device.
2187 */
2188static int
2189hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2190 int retry_counter)
2191{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002192 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
2194 struct usb_device *hdev = hub->hdev;
2195 int i, j, retval;
2196 unsigned delay = HUB_SHORT_RESET_TIME;
2197 enum usb_device_speed oldspeed = udev->speed;
2198
2199 /* root hub ports have a slightly longer reset period
2200 * (from USB 2.0 spec, section 7.1.7.5)
2201 */
2202 if (!hdev->parent) {
2203 delay = HUB_ROOT_RESET_TIME;
2204 if (port1 == hdev->bus->otg_port)
2205 hdev->bus->b_hnp_enable = 0;
2206 }
2207
2208 /* Some low speed devices have problems with the quick delay, so */
2209 /* be a bit pessimistic with those devices. RHbug #23670 */
2210 if (oldspeed == USB_SPEED_LOW)
2211 delay = HUB_LONG_RESET_TIME;
2212
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002213 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
2215 /* Reset the device; full speed may morph to high speed */
2216 retval = hub_port_reset(hub, port1, udev, delay);
2217 if (retval < 0) /* error or disconnect */
2218 goto fail;
2219 /* success, speed is known */
2220 retval = -ENODEV;
2221
2222 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2223 dev_dbg(&udev->dev, "device reset changed speed!\n");
2224 goto fail;
2225 }
2226 oldspeed = udev->speed;
2227
2228 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2229 * it's fixed size except for full speed devices.
2230 */
2231 switch (udev->speed) {
2232 case USB_SPEED_HIGH: /* fixed at 64 */
2233 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2234 break;
2235 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2236 /* to determine the ep0 maxpacket size, try to read
2237 * the device descriptor to get bMaxPacketSize0 and
2238 * then correct our initial guess.
2239 */
2240 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2241 break;
2242 case USB_SPEED_LOW: /* fixed at 8 */
2243 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2244 break;
2245 default:
2246 goto fail;
2247 }
2248
2249 dev_info (&udev->dev,
2250 "%s %s speed USB device using %s and address %d\n",
2251 (udev->config) ? "reset" : "new",
2252 ({ char *speed; switch (udev->speed) {
2253 case USB_SPEED_LOW: speed = "low"; break;
2254 case USB_SPEED_FULL: speed = "full"; break;
2255 case USB_SPEED_HIGH: speed = "high"; break;
2256 default: speed = "?"; break;
2257 }; speed;}),
2258 udev->bus->controller->driver->name,
2259 udev->devnum);
2260
2261 /* Set up TT records, if needed */
2262 if (hdev->tt) {
2263 udev->tt = hdev->tt;
2264 udev->ttport = hdev->ttport;
2265 } else if (udev->speed != USB_SPEED_HIGH
2266 && hdev->speed == USB_SPEED_HIGH) {
2267 udev->tt = &hub->tt;
2268 udev->ttport = port1;
2269 }
2270
2271 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2272 * Because device hardware and firmware is sometimes buggy in
2273 * this area, and this is how Linux has done it for ages.
2274 * Change it cautiously.
2275 *
2276 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2277 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2278 * so it may help with some non-standards-compliant devices.
2279 * Otherwise we start with SET_ADDRESS and then try to read the
2280 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2281 * value.
2282 */
2283 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2284 if (USE_NEW_SCHEME(retry_counter)) {
2285 struct usb_device_descriptor *buf;
2286 int r = 0;
2287
2288#define GET_DESCRIPTOR_BUFSIZE 64
2289 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2290 if (!buf) {
2291 retval = -ENOMEM;
2292 continue;
2293 }
2294
2295 /* Use a short timeout the first time through,
2296 * so that recalcitrant full-speed devices with
2297 * 8- or 16-byte ep0-maxpackets won't slow things
2298 * down tremendously by NAKing the unexpectedly
2299 * early status stage. Also, retry on all errors;
2300 * some devices are flakey.
2301 */
2302 for (j = 0; j < 3; ++j) {
2303 buf->bMaxPacketSize0 = 0;
2304 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2305 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2306 USB_DT_DEVICE << 8, 0,
2307 buf, GET_DESCRIPTOR_BUFSIZE,
2308 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2309 switch (buf->bMaxPacketSize0) {
2310 case 8: case 16: case 32: case 64:
2311 if (buf->bDescriptorType ==
2312 USB_DT_DEVICE) {
2313 r = 0;
2314 break;
2315 }
2316 /* FALL THROUGH */
2317 default:
2318 if (r == 0)
2319 r = -EPROTO;
2320 break;
2321 }
2322 if (r == 0)
2323 break;
2324 }
2325 udev->descriptor.bMaxPacketSize0 =
2326 buf->bMaxPacketSize0;
2327 kfree(buf);
2328
2329 retval = hub_port_reset(hub, port1, udev, delay);
2330 if (retval < 0) /* error or disconnect */
2331 goto fail;
2332 if (oldspeed != udev->speed) {
2333 dev_dbg(&udev->dev,
2334 "device reset changed speed!\n");
2335 retval = -ENODEV;
2336 goto fail;
2337 }
2338 if (r) {
2339 dev_err(&udev->dev, "device descriptor "
2340 "read/%s, error %d\n",
2341 "64", r);
2342 retval = -EMSGSIZE;
2343 continue;
2344 }
2345#undef GET_DESCRIPTOR_BUFSIZE
2346 }
2347
2348 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2349 retval = hub_set_address(udev);
2350 if (retval >= 0)
2351 break;
2352 msleep(200);
2353 }
2354 if (retval < 0) {
2355 dev_err(&udev->dev,
2356 "device not accepting address %d, error %d\n",
2357 udev->devnum, retval);
2358 goto fail;
2359 }
2360
2361 /* cope with hardware quirkiness:
2362 * - let SET_ADDRESS settle, some device hardware wants it
2363 * - read ep0 maxpacket even for high and low speed,
2364 */
2365 msleep(10);
2366 if (USE_NEW_SCHEME(retry_counter))
2367 break;
2368
2369 retval = usb_get_device_descriptor(udev, 8);
2370 if (retval < 8) {
2371 dev_err(&udev->dev, "device descriptor "
2372 "read/%s, error %d\n",
2373 "8", retval);
2374 if (retval >= 0)
2375 retval = -EMSGSIZE;
2376 } else {
2377 retval = 0;
2378 break;
2379 }
2380 }
2381 if (retval)
2382 goto fail;
2383
2384 i = udev->descriptor.bMaxPacketSize0;
2385 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2386 if (udev->speed != USB_SPEED_FULL ||
2387 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2388 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2389 retval = -EMSGSIZE;
2390 goto fail;
2391 }
2392 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2393 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2394 ep0_reinit(udev);
2395 }
2396
2397 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2398 if (retval < (signed)sizeof(udev->descriptor)) {
2399 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2400 "all", retval);
2401 if (retval >= 0)
2402 retval = -ENOMSG;
2403 goto fail;
2404 }
2405
2406 retval = 0;
2407
2408fail:
2409 if (retval)
2410 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002411 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412 return retval;
2413}
2414
2415static void
2416check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2417{
2418 struct usb_qualifier_descriptor *qual;
2419 int status;
2420
2421 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2422 if (qual == NULL)
2423 return;
2424
2425 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2426 qual, sizeof *qual);
2427 if (status == sizeof *qual) {
2428 dev_info(&udev->dev, "not running at top speed; "
2429 "connect to a high speed hub\n");
2430 /* hub LEDs are probably harder to miss than syslog */
2431 if (hub->has_indicators) {
2432 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2433 schedule_work (&hub->leds);
2434 }
2435 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002436 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437}
2438
2439static unsigned
2440hub_power_remaining (struct usb_hub *hub)
2441{
2442 struct usb_device *hdev = hub->hdev;
2443 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002444 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Alan Stern55c52712005-11-23 12:03:12 -05002446 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 return 0;
2448
Alan Stern55c52712005-11-23 12:03:12 -05002449 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2450 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2451 struct usb_device *udev = hdev->children[port1 - 1];
2452 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453
2454 if (!udev)
2455 continue;
2456
Alan Stern55c52712005-11-23 12:03:12 -05002457 /* Unconfigured devices may not use more than 100mA,
2458 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002460 delta = udev->actconfig->desc.bMaxPower * 2;
2461 else if (port1 != udev->bus->otg_port || hdev->parent)
2462 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 else
Alan Stern55c52712005-11-23 12:03:12 -05002464 delta = 8;
2465 if (delta > hub->mA_per_port)
2466 dev_warn(&udev->dev, "%dmA is over %umA budget "
2467 "for port %d!\n",
2468 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 remaining -= delta;
2470 }
2471 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002472 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2473 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 remaining = 0;
2475 }
2476 return remaining;
2477}
2478
2479/* Handle physical or logical connection change events.
2480 * This routine is called when:
2481 * a port connection-change occurs;
2482 * a port enable-change occurs (often caused by EMI);
2483 * usb_reset_device() encounters changed descriptors (as from
2484 * a firmware download)
2485 * caller already locked the hub
2486 */
2487static void hub_port_connect_change(struct usb_hub *hub, int port1,
2488 u16 portstatus, u16 portchange)
2489{
2490 struct usb_device *hdev = hub->hdev;
2491 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002492 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 int status, i;
2494
2495 dev_dbg (hub_dev,
2496 "port %d, status %04x, change %04x, %s\n",
2497 port1, portstatus, portchange, portspeed (portstatus));
2498
2499 if (hub->has_indicators) {
2500 set_port_led(hub, port1, HUB_LED_AUTO);
2501 hub->indicator[port1-1] = INDICATOR_AUTO;
2502 }
2503
2504 /* Disconnect any existing devices under this port */
2505 if (hdev->children[port1-1])
2506 usb_disconnect(&hdev->children[port1-1]);
2507 clear_bit(port1, hub->change_bits);
2508
2509#ifdef CONFIG_USB_OTG
2510 /* during HNP, don't repeat the debounce */
2511 if (hdev->bus->is_b_host)
2512 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2513#endif
2514
2515 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2516 status = hub_port_debounce(hub, port1);
2517 if (status < 0) {
2518 dev_err (hub_dev,
2519 "connect-debounce failed, port %d disabled\n",
2520 port1);
2521 goto done;
2522 }
2523 portstatus = status;
2524 }
2525
2526 /* Return now if nothing is connected */
2527 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2528
2529 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002530 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2532 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2533
2534 if (portstatus & USB_PORT_STAT_ENABLE)
2535 goto done;
2536 return;
2537 }
2538
2539#ifdef CONFIG_USB_SUSPEND
2540 /* If something is connected, but the port is suspended, wake it up. */
2541 if (portstatus & USB_PORT_STAT_SUSPEND) {
2542 status = hub_port_resume(hub, port1, NULL);
2543 if (status < 0) {
2544 dev_dbg(hub_dev,
2545 "can't clear suspend on port %d; %d\n",
2546 port1, status);
2547 goto done;
2548 }
2549 }
2550#endif
2551
2552 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2553 struct usb_device *udev;
2554
2555 /* reallocate for each attempt, since references
2556 * to the previous one can escape in various ways
2557 */
2558 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2559 if (!udev) {
2560 dev_err (hub_dev,
2561 "couldn't allocate port %d usb_device\n",
2562 port1);
2563 goto done;
2564 }
2565
2566 usb_set_device_state(udev, USB_STATE_POWERED);
2567 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002568 udev->bus_mA = hub->mA_per_port;
2569
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 /* set the address */
2571 choose_address(udev);
2572 if (udev->devnum <= 0) {
2573 status = -ENOTCONN; /* Don't retry */
2574 goto loop;
2575 }
2576
2577 /* reset and get descriptor */
2578 status = hub_port_init(hub, udev, port1, i);
2579 if (status < 0)
2580 goto loop;
2581
2582 /* consecutive bus-powered hubs aren't reliable; they can
2583 * violate the voltage drop budget. if the new child has
2584 * a "powered" LED, users should notice we didn't enable it
2585 * (without reading syslog), even without per-port LEDs
2586 * on the parent.
2587 */
2588 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002589 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 u16 devstat;
2591
2592 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2593 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002594 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 dev_dbg(&udev->dev, "get status %d ?\n", status);
2596 goto loop_disable;
2597 }
Alan Stern55c52712005-11-23 12:03:12 -05002598 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2600 dev_err(&udev->dev,
2601 "can't connect bus-powered hub "
2602 "to this port\n");
2603 if (hub->has_indicators) {
2604 hub->indicator[port1-1] =
2605 INDICATOR_AMBER_BLINK;
2606 schedule_work (&hub->leds);
2607 }
2608 status = -ENOTCONN; /* Don't retry */
2609 goto loop_disable;
2610 }
2611 }
2612
2613 /* check for devices running slower than they could */
2614 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2615 && udev->speed == USB_SPEED_FULL
2616 && highspeed_hubs != 0)
2617 check_highspeed (hub, udev, port1);
2618
2619 /* Store the parent's children[] pointer. At this point
2620 * udev becomes globally accessible, although presumably
2621 * no one will look at it until hdev is unlocked.
2622 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 status = 0;
2624
2625 /* We mustn't add new devices if the parent hub has
2626 * been disconnected; we would race with the
2627 * recursively_mark_NOTATTACHED() routine.
2628 */
2629 spin_lock_irq(&device_state_lock);
2630 if (hdev->state == USB_STATE_NOTATTACHED)
2631 status = -ENOTCONN;
2632 else
2633 hdev->children[port1-1] = udev;
2634 spin_unlock_irq(&device_state_lock);
2635
2636 /* Run it through the hoops (find a driver, etc) */
2637 if (!status) {
2638 status = usb_new_device(udev);
2639 if (status) {
2640 spin_lock_irq(&device_state_lock);
2641 hdev->children[port1-1] = NULL;
2642 spin_unlock_irq(&device_state_lock);
2643 }
2644 }
2645
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 if (status)
2647 goto loop_disable;
2648
2649 status = hub_power_remaining(hub);
2650 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002651 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652
2653 return;
2654
2655loop_disable:
2656 hub_port_disable(hub, port1, 1);
2657loop:
2658 ep0_reinit(udev);
2659 release_address(udev);
2660 usb_put_dev(udev);
2661 if (status == -ENOTCONN)
2662 break;
2663 }
2664
2665done:
2666 hub_port_disable(hub, port1, 1);
2667}
2668
2669static void hub_events(void)
2670{
2671 struct list_head *tmp;
2672 struct usb_device *hdev;
2673 struct usb_interface *intf;
2674 struct usb_hub *hub;
2675 struct device *hub_dev;
2676 u16 hubstatus;
2677 u16 hubchange;
2678 u16 portstatus;
2679 u16 portchange;
2680 int i, ret;
2681 int connect_change;
2682
2683 /*
2684 * We restart the list every time to avoid a deadlock with
2685 * deleting hubs downstream from this one. This should be
2686 * safe since we delete the hub from the event list.
2687 * Not the most efficient, but avoids deadlocks.
2688 */
2689 while (1) {
2690
2691 /* Grab the first entry at the beginning of the list */
2692 spin_lock_irq(&hub_event_lock);
2693 if (list_empty(&hub_event_list)) {
2694 spin_unlock_irq(&hub_event_lock);
2695 break;
2696 }
2697
2698 tmp = hub_event_list.next;
2699 list_del_init(tmp);
2700
2701 hub = list_entry(tmp, struct usb_hub, event_list);
2702 hdev = hub->hdev;
2703 intf = to_usb_interface(hub->intfdev);
2704 hub_dev = &intf->dev;
2705
David Brownell979d5192005-09-22 22:32:24 -07002706 i = hub->resume_root_hub;
2707
2708 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 hdev->state, hub->descriptor
2710 ? hub->descriptor->bNbrPorts
2711 : 0,
2712 /* NOTE: expects max 15 ports... */
2713 (u16) hub->change_bits[0],
David Brownell979d5192005-09-22 22:32:24 -07002714 (u16) hub->event_bits[0],
2715 i ? ", resume root" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716
2717 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718 spin_unlock_irq(&hub_event_lock);
2719
David Brownell979d5192005-09-22 22:32:24 -07002720 /* Is this is a root hub wanting to reactivate the downstream
2721 * ports? If so, be sure the interface resumes even if its
2722 * stub "device" node was never suspended.
2723 */
2724 if (i) {
David Brownell979d5192005-09-22 22:32:24 -07002725 dpm_runtime_resume(&hdev->dev);
2726 dpm_runtime_resume(&intf->dev);
Alan Stern2425e9f2005-11-29 12:13:31 -05002727 usb_put_intf(intf);
2728 continue;
David Brownell979d5192005-09-22 22:32:24 -07002729 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730
2731 /* Lock the device, then check to see if we were
2732 * disconnected while waiting for the lock to succeed. */
2733 if (locktree(hdev) < 0) {
2734 usb_put_intf(intf);
2735 continue;
2736 }
2737 if (hub != usb_get_intfdata(intf))
2738 goto loop;
2739
2740 /* If the hub has died, clean up after it */
2741 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7d069b72005-11-18 12:06:34 -05002742 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 goto loop;
2744 }
2745
2746 /* If this is an inactive or suspended hub, do nothing */
2747 if (hub->quiescing)
2748 goto loop;
2749
2750 if (hub->error) {
2751 dev_dbg (hub_dev, "resetting for error %d\n",
2752 hub->error);
2753
2754 ret = usb_reset_device(hdev);
2755 if (ret) {
2756 dev_dbg (hub_dev,
2757 "error resetting hub: %d\n", ret);
2758 goto loop;
2759 }
2760
2761 hub->nerrors = 0;
2762 hub->error = 0;
2763 }
2764
2765 /* deal with port status changes */
2766 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2767 if (test_bit(i, hub->busy_bits))
2768 continue;
2769 connect_change = test_bit(i, hub->change_bits);
2770 if (!test_and_clear_bit(i, hub->event_bits) &&
2771 !connect_change && !hub->activating)
2772 continue;
2773
2774 ret = hub_port_status(hub, i,
2775 &portstatus, &portchange);
2776 if (ret < 0)
2777 continue;
2778
2779 if (hub->activating && !hdev->children[i-1] &&
2780 (portstatus &
2781 USB_PORT_STAT_CONNECTION))
2782 connect_change = 1;
2783
2784 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2785 clear_port_feature(hdev, i,
2786 USB_PORT_FEAT_C_CONNECTION);
2787 connect_change = 1;
2788 }
2789
2790 if (portchange & USB_PORT_STAT_C_ENABLE) {
2791 if (!connect_change)
2792 dev_dbg (hub_dev,
2793 "port %d enable change, "
2794 "status %08x\n",
2795 i, portstatus);
2796 clear_port_feature(hdev, i,
2797 USB_PORT_FEAT_C_ENABLE);
2798
2799 /*
2800 * EM interference sometimes causes badly
2801 * shielded USB devices to be shutdown by
2802 * the hub, this hack enables them again.
2803 * Works at least with mouse driver.
2804 */
2805 if (!(portstatus & USB_PORT_STAT_ENABLE)
2806 && !connect_change
2807 && hdev->children[i-1]) {
2808 dev_err (hub_dev,
2809 "port %i "
2810 "disabled by hub (EMI?), "
2811 "re-enabling...\n",
2812 i);
2813 connect_change = 1;
2814 }
2815 }
2816
2817 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2818 clear_port_feature(hdev, i,
2819 USB_PORT_FEAT_C_SUSPEND);
2820 if (hdev->children[i-1]) {
2821 ret = remote_wakeup(hdev->
2822 children[i-1]);
2823 if (ret < 0)
2824 connect_change = 1;
2825 } else {
2826 ret = -ENODEV;
2827 hub_port_disable(hub, i, 1);
2828 }
2829 dev_dbg (hub_dev,
2830 "resume on port %d, status %d\n",
2831 i, ret);
2832 }
2833
2834 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2835 dev_err (hub_dev,
2836 "over-current change on port %d\n",
2837 i);
2838 clear_port_feature(hdev, i,
2839 USB_PORT_FEAT_C_OVER_CURRENT);
2840 hub_power_on(hub);
2841 }
2842
2843 if (portchange & USB_PORT_STAT_C_RESET) {
2844 dev_dbg (hub_dev,
2845 "reset change on port %d\n",
2846 i);
2847 clear_port_feature(hdev, i,
2848 USB_PORT_FEAT_C_RESET);
2849 }
2850
2851 if (connect_change)
2852 hub_port_connect_change(hub, i,
2853 portstatus, portchange);
2854 } /* end for i */
2855
2856 /* deal with hub status changes */
2857 if (test_and_clear_bit(0, hub->event_bits) == 0)
2858 ; /* do nothing */
2859 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2860 dev_err (hub_dev, "get_hub_status failed\n");
2861 else {
2862 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2863 dev_dbg (hub_dev, "power change\n");
2864 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002865 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2866 /* FIXME: Is this always true? */
2867 hub->limited_power = 0;
2868 else
2869 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870 }
2871 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2872 dev_dbg (hub_dev, "overcurrent change\n");
2873 msleep(500); /* Cool down */
2874 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2875 hub_power_on(hub);
2876 }
2877 }
2878
2879 hub->activating = 0;
2880
Alan Sternd5926ae72005-04-21 15:56:37 -04002881 /* If this is a root hub, tell the HCD it's okay to
2882 * re-enable port-change interrupts now. */
2883 if (!hdev->parent)
2884 usb_enable_root_hub_irq(hdev->bus);
2885
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886loop:
2887 usb_unlock_device(hdev);
2888 usb_put_intf(intf);
2889
2890 } /* end while (1) */
2891}
2892
2893static int hub_thread(void *__unused)
2894{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 do {
2896 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002897 wait_event_interruptible(khubd_wait,
2898 !list_empty(&hub_event_list) ||
2899 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002900 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002901 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002903 pr_debug("%s: khubd exiting\n", usbcore_name);
2904 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905}
2906
2907static struct usb_device_id hub_id_table [] = {
2908 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2909 .bDeviceClass = USB_CLASS_HUB},
2910 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2911 .bInterfaceClass = USB_CLASS_HUB},
2912 { } /* Terminating entry */
2913};
2914
2915MODULE_DEVICE_TABLE (usb, hub_id_table);
2916
2917static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 .name = "hub",
2919 .probe = hub_probe,
2920 .disconnect = hub_disconnect,
2921 .suspend = hub_suspend,
2922 .resume = hub_resume,
2923 .ioctl = hub_ioctl,
2924 .id_table = hub_id_table,
2925};
2926
2927int usb_hub_init(void)
2928{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 if (usb_register(&hub_driver) < 0) {
2930 printk(KERN_ERR "%s: can't register hub driver\n",
2931 usbcore_name);
2932 return -1;
2933 }
2934
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002935 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2936 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938
2939 /* Fall through if kernel_thread failed */
2940 usb_deregister(&hub_driver);
2941 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2942
2943 return -1;
2944}
2945
2946void usb_hub_cleanup(void)
2947{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002948 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949
2950 /*
2951 * Hub resources are freed for us by usb_deregister. It calls
2952 * usb_driver_purge on every device which in turn calls that
2953 * devices disconnect function if it is using this driver.
2954 * The hub_disconnect function takes care of releasing the
2955 * individual hub resources. -greg
2956 */
2957 usb_deregister(&hub_driver);
2958} /* usb_hub_cleanup() */
2959
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960static int config_descriptors_changed(struct usb_device *udev)
2961{
2962 unsigned index;
2963 unsigned len = 0;
2964 struct usb_config_descriptor *buf;
2965
2966 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2967 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2968 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2969 }
2970 buf = kmalloc (len, SLAB_KERNEL);
2971 if (buf == NULL) {
2972 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2973 /* assume the worst */
2974 return 1;
2975 }
2976 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2977 int length;
2978 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2979
2980 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2981 old_length);
2982 if (length < old_length) {
2983 dev_dbg(&udev->dev, "config index %d, error %d\n",
2984 index, length);
2985 break;
2986 }
2987 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2988 != 0) {
2989 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2990 index, buf->bConfigurationValue);
2991 break;
2992 }
2993 }
2994 kfree(buf);
2995 return index != udev->descriptor.bNumConfigurations;
2996}
2997
2998/**
2999 * usb_reset_device - perform a USB port reset to reinitialize a device
3000 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3001 *
3002 * WARNING - don't reset any device unless drivers for all of its
3003 * interfaces are expecting that reset! Maybe some driver->reset()
3004 * method should eventually help ensure sufficient cooperation.
3005 *
3006 * Do a port reset, reassign the device's address, and establish its
3007 * former operating configuration. If the reset fails, or the device's
3008 * descriptors change from their values before the reset, or the original
3009 * configuration and altsettings cannot be restored, a flag will be set
3010 * telling khubd to pretend the device has been disconnected and then
3011 * re-connected. All drivers will be unbound, and the device will be
3012 * re-enumerated and probed all over again.
3013 *
3014 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3015 * flagged for logical disconnection, or some other negative error code
3016 * if the reset wasn't even attempted.
3017 *
3018 * The caller must own the device lock. For example, it's safe to use
3019 * this from a driver probe() routine after downloading new firmware.
3020 * For calls that might not occur during probe(), drivers should lock
3021 * the device using usb_lock_device_for_reset().
3022 */
3023int usb_reset_device(struct usb_device *udev)
3024{
3025 struct usb_device *parent_hdev = udev->parent;
3026 struct usb_hub *parent_hub;
3027 struct usb_device_descriptor descriptor = udev->descriptor;
3028 struct usb_hub *hub = NULL;
Alan Stern12c3da32005-11-23 12:09:52 -05003029 int i, ret = 0;
3030 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031
3032 if (udev->state == USB_STATE_NOTATTACHED ||
3033 udev->state == USB_STATE_SUSPENDED) {
3034 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3035 udev->state);
3036 return -EINVAL;
3037 }
3038
3039 if (!parent_hdev) {
3040 /* this requires hcd-specific logic; see OHCI hc_restart() */
3041 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3042 return -EISDIR;
3043 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044 parent_hub = hdev_to_hub(parent_hdev);
3045
3046 /* If we're resetting an active hub, take some special actions */
Alan Stern6aa35672006-03-08 15:14:09 -05003047 if (udev->actconfig && udev->actconfig->desc.bNumInterfaces > 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048 udev->actconfig->interface[0]->dev.driver ==
3049 &hub_driver.driver &&
3050 (hub = hdev_to_hub(udev)) != NULL) {
Alan Stern7d069b72005-11-18 12:06:34 -05003051 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052 }
3053
3054 set_bit(port1, parent_hub->busy_bits);
3055 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3056
3057 /* ep0 maxpacket size may change; let the HCD know about it.
3058 * Other endpoints will be handled by re-enumeration. */
3059 ep0_reinit(udev);
3060 ret = hub_port_init(parent_hub, udev, port1, i);
3061 if (ret >= 0)
3062 break;
3063 }
3064 clear_bit(port1, parent_hub->busy_bits);
3065 if (ret < 0)
3066 goto re_enumerate;
3067
3068 /* Device might have changed firmware (DFU or similar) */
3069 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3070 || config_descriptors_changed (udev)) {
3071 dev_info(&udev->dev, "device firmware changed\n");
3072 udev->descriptor = descriptor; /* for disconnect() calls */
3073 goto re_enumerate;
3074 }
3075
3076 if (!udev->actconfig)
3077 goto done;
3078
3079 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3080 USB_REQ_SET_CONFIGURATION, 0,
3081 udev->actconfig->desc.bConfigurationValue, 0,
3082 NULL, 0, USB_CTRL_SET_TIMEOUT);
3083 if (ret < 0) {
3084 dev_err(&udev->dev,
3085 "can't restore configuration #%d (error=%d)\n",
3086 udev->actconfig->desc.bConfigurationValue, ret);
3087 goto re_enumerate;
3088 }
3089 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3090
3091 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3092 struct usb_interface *intf = udev->actconfig->interface[i];
3093 struct usb_interface_descriptor *desc;
3094
3095 /* set_interface resets host side toggle even
3096 * for altsetting zero. the interface may have no driver.
3097 */
3098 desc = &intf->cur_altsetting->desc;
3099 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3100 desc->bAlternateSetting);
3101 if (ret < 0) {
3102 dev_err(&udev->dev, "failed to restore interface %d "
3103 "altsetting %d (error=%d)\n",
3104 desc->bInterfaceNumber,
3105 desc->bAlternateSetting,
3106 ret);
3107 goto re_enumerate;
3108 }
3109 }
3110
3111done:
3112 if (hub)
3113 hub_post_reset(hub);
3114 return 0;
3115
3116re_enumerate:
3117 hub_port_logical_disconnect(parent_hub, port1);
3118 return -ENODEV;
3119}