blob: 8e65f7a237e4f68d09a87074bef6e2ed98679dfb [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;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700435 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437 /* if hub supports power switching, enable power on each port */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700438 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 dev_dbg(hub->intfdev, "enabling power on all ports\n");
440 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
441 set_port_feature(hub->hdev, port1,
442 USB_PORT_FEAT_POWER);
443 }
444
David Brownellb7896962005-08-31 10:41:44 -0700445 /* Wait at least 100 msec for power to become stable */
446 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
David Brownell979d5192005-09-22 22:32:24 -0700449static inline void __hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
David Brownell979d5192005-09-22 22:32:24 -0700451 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700453 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700454 hub->resume_root_hub = 0;
455}
456
457static void hub_quiesce(struct usb_hub *hub)
458{
459 /* (blocking) stop khubd and related activity */
460 __hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 usb_kill_urb(hub->urb);
462 if (hub->has_indicators)
463 cancel_delayed_work(&hub->leds);
464 if (hub->has_indicators || hub->tt.hub)
465 flush_scheduled_work();
466}
467
468static void hub_activate(struct usb_hub *hub)
469{
470 int status;
471
472 hub->quiescing = 0;
473 hub->activating = 1;
David Brownell979d5192005-09-22 22:32:24 -0700474 hub->resume_root_hub = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 status = usb_submit_urb(hub->urb, GFP_NOIO);
476 if (status < 0)
477 dev_err(hub->intfdev, "activate --> %d\n", status);
478 if (hub->has_indicators && blinkenlights)
479 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
480
481 /* scan all ports ASAP */
482 kick_khubd(hub);
483}
484
485static int hub_hub_status(struct usb_hub *hub,
486 u16 *status, u16 *change)
487{
488 int ret;
489
490 ret = get_hub_status(hub->hdev, &hub->status->hub);
491 if (ret < 0)
492 dev_err (hub->intfdev,
493 "%s failed (err = %d)\n", __FUNCTION__, ret);
494 else {
495 *status = le16_to_cpu(hub->status->hub.wHubStatus);
496 *change = le16_to_cpu(hub->status->hub.wHubChange);
497 ret = 0;
498 }
499 return ret;
500}
501
Alan Stern8b28c752005-08-10 17:04:13 -0400502static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
503{
504 struct usb_device *hdev = hub->hdev;
505 int ret;
506
507 if (hdev->children[port1-1] && set_state) {
508 usb_set_device_state(hdev->children[port1-1],
509 USB_STATE_NOTATTACHED);
510 }
511 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
512 if (ret)
513 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
514 port1, ret);
515
516 return ret;
517}
518
Alan Stern7d069b72005-11-18 12:06:34 -0500519
520/* caller has locked the hub device */
521static void hub_pre_reset(struct usb_hub *hub, int disable_ports)
522{
523 struct usb_device *hdev = hub->hdev;
524 int port1;
525
526 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
527 if (hdev->children[port1 - 1]) {
528 usb_disconnect(&hdev->children[port1 - 1]);
529 if (disable_ports)
530 hub_port_disable(hub, port1, 0);
531 }
532 }
533 hub_quiesce(hub);
534}
535
536/* caller has locked the hub device */
537static void hub_post_reset(struct usb_hub *hub)
538{
539 hub_activate(hub);
540 hub_power_on(hub);
541}
542
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544static int hub_configure(struct usb_hub *hub,
545 struct usb_endpoint_descriptor *endpoint)
546{
547 struct usb_device *hdev = hub->hdev;
548 struct device *hub_dev = hub->intfdev;
549 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700550 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 unsigned int pipe;
552 int maxp, ret;
553 char *message;
554
555 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
556 &hub->buffer_dma);
557 if (!hub->buffer) {
558 message = "can't allocate hub irq buffer";
559 ret = -ENOMEM;
560 goto fail;
561 }
562
563 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
564 if (!hub->status) {
565 message = "can't kmalloc hub status buffer";
566 ret = -ENOMEM;
567 goto fail;
568 }
569
570 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
571 if (!hub->descriptor) {
572 message = "can't kmalloc hub descriptor";
573 ret = -ENOMEM;
574 goto fail;
575 }
576
577 /* Request the entire hub descriptor.
578 * hub->descriptor can handle USB_MAXCHILDREN ports,
579 * but the hub can/will return fewer bytes here.
580 */
581 ret = get_hub_descriptor(hdev, hub->descriptor,
582 sizeof(*hub->descriptor));
583 if (ret < 0) {
584 message = "can't read hub descriptor";
585 goto fail;
586 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
587 message = "hub has too many ports!";
588 ret = -ENODEV;
589 goto fail;
590 }
591
592 hdev->maxchild = hub->descriptor->bNbrPorts;
593 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
594 (hdev->maxchild == 1) ? "" : "s");
595
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700596 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700598 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 int i;
600 char portstr [USB_MAXCHILDREN + 1];
601
602 for (i = 0; i < hdev->maxchild; i++)
603 portstr[i] = hub->descriptor->DeviceRemovable
604 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
605 ? 'F' : 'R';
606 portstr[hdev->maxchild] = 0;
607 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
608 } else
609 dev_dbg(hub_dev, "standalone hub\n");
610
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700611 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 case 0x00:
613 dev_dbg(hub_dev, "ganged power switching\n");
614 break;
615 case 0x01:
616 dev_dbg(hub_dev, "individual port power switching\n");
617 break;
618 case 0x02:
619 case 0x03:
620 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
621 break;
622 }
623
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700624 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 case 0x00:
626 dev_dbg(hub_dev, "global over-current protection\n");
627 break;
628 case 0x08:
629 dev_dbg(hub_dev, "individual port over-current protection\n");
630 break;
631 case 0x10:
632 case 0x18:
633 dev_dbg(hub_dev, "no over-current protection\n");
634 break;
635 }
636
637 spin_lock_init (&hub->tt.lock);
638 INIT_LIST_HEAD (&hub->tt.clear_list);
639 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
640 switch (hdev->descriptor.bDeviceProtocol) {
641 case 0:
642 break;
643 case 1:
644 dev_dbg(hub_dev, "Single TT\n");
645 hub->tt.hub = hdev;
646 break;
647 case 2:
648 ret = usb_set_interface(hdev, 0, 1);
649 if (ret == 0) {
650 dev_dbg(hub_dev, "TT per port\n");
651 hub->tt.multi = 1;
652 } else
653 dev_err(hub_dev, "Using single TT (err %d)\n",
654 ret);
655 hub->tt.hub = hdev;
656 break;
657 default:
658 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
659 hdev->descriptor.bDeviceProtocol);
660 break;
661 }
662
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700663 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700664 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700665 case HUB_TTTT_8_BITS:
666 if (hdev->descriptor.bDeviceProtocol != 0) {
667 hub->tt.think_time = 666;
668 dev_dbg(hub_dev, "TT requires at most %d "
669 "FS bit times (%d ns)\n",
670 8, hub->tt.think_time);
671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700673 case HUB_TTTT_16_BITS:
674 hub->tt.think_time = 666 * 2;
675 dev_dbg(hub_dev, "TT requires at most %d "
676 "FS bit times (%d ns)\n",
677 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700679 case HUB_TTTT_24_BITS:
680 hub->tt.think_time = 666 * 3;
681 dev_dbg(hub_dev, "TT requires at most %d "
682 "FS bit times (%d ns)\n",
683 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700685 case HUB_TTTT_32_BITS:
686 hub->tt.think_time = 666 * 4;
687 dev_dbg(hub_dev, "TT requires at most %d "
688 "FS bit times (%d ns)\n",
689 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 break;
691 }
692
693 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700694 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 hub->has_indicators = 1;
696 dev_dbg(hub_dev, "Port indicators are supported\n");
697 }
698
699 dev_dbg(hub_dev, "power on to power good time: %dms\n",
700 hub->descriptor->bPwrOn2PwrGood * 2);
701
702 /* power budgeting mostly matters with bus-powered hubs,
703 * and battery-powered root hubs (may provide just 8 mA).
704 */
705 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500706 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 message = "can't get hub status";
708 goto fail;
709 }
Alan Stern7d35b922005-04-25 11:18:32 -0400710 le16_to_cpus(&hubstatus);
711 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500712 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
713 hub->mA_per_port = 500;
714 else {
715 hub->mA_per_port = hdev->bus_mA;
716 hub->limited_power = 1;
717 }
Alan Stern7d35b922005-04-25 11:18:32 -0400718 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
720 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500721 hub->limited_power = 1;
722 if (hdev->maxchild > 0) {
723 int remaining = hdev->bus_mA -
724 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Alan Stern55c52712005-11-23 12:03:12 -0500726 if (remaining < hdev->maxchild * 100)
727 dev_warn(hub_dev,
728 "insufficient power available "
729 "to use all downstream ports\n");
730 hub->mA_per_port = 100; /* 7.2.1.1 */
731 }
732 } else { /* Self-powered external hub */
733 /* FIXME: What about battery-powered external hubs that
734 * provide less current per port? */
735 hub->mA_per_port = 500;
736 }
737 if (hub->mA_per_port < 500)
738 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
739 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741 ret = hub_hub_status(hub, &hubstatus, &hubchange);
742 if (ret < 0) {
743 message = "can't get hub status";
744 goto fail;
745 }
746
747 /* local power status reports aren't always correct */
748 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
749 dev_dbg(hub_dev, "local power source is %s\n",
750 (hubstatus & HUB_STATUS_LOCAL_POWER)
751 ? "lost (inactive)" : "good");
752
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700753 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 dev_dbg(hub_dev, "%sover-current condition exists\n",
755 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
756
757 /* set up the interrupt endpoint */
758 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
759 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
760
761 if (maxp > sizeof(*hub->buffer))
762 maxp = sizeof(*hub->buffer);
763
764 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
765 if (!hub->urb) {
766 message = "couldn't allocate interrupt urb";
767 ret = -ENOMEM;
768 goto fail;
769 }
770
771 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
772 hub, endpoint->bInterval);
773 hub->urb->transfer_dma = hub->buffer_dma;
774 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
775
776 /* maybe cycle the hub leds */
777 if (hub->has_indicators && blinkenlights)
778 hub->indicator [0] = INDICATOR_CYCLE;
779
780 hub_power_on(hub);
781 hub_activate(hub);
782 return 0;
783
784fail:
785 dev_err (hub_dev, "config failed, %s (err %d)\n",
786 message, ret);
787 /* hub_disconnect() frees urb and descriptor */
788 return ret;
789}
790
791static unsigned highspeed_hubs;
792
793static void hub_disconnect(struct usb_interface *intf)
794{
795 struct usb_hub *hub = usb_get_intfdata (intf);
796 struct usb_device *hdev;
797
Alan Stern8b28c752005-08-10 17:04:13 -0400798 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 hdev = hub->hdev;
800
801 if (hdev->speed == USB_SPEED_HIGH)
802 highspeed_hubs--;
803
Alan Stern7d069b72005-11-18 12:06:34 -0500804 /* Disconnect all children and quiesce the hub */
805 hub_pre_reset(hub, 1);
806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 usb_free_urb(hub->urb);
808 hub->urb = NULL;
809
810 spin_lock_irq(&hub_event_lock);
811 list_del_init(&hub->event_list);
812 spin_unlock_irq(&hub_event_lock);
813
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700814 kfree(hub->descriptor);
815 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700817 kfree(hub->status);
818 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820 if (hub->buffer) {
821 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
822 hub->buffer_dma);
823 hub->buffer = NULL;
824 }
825
Alan Stern7d069b72005-11-18 12:06:34 -0500826 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
828
829static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
830{
831 struct usb_host_interface *desc;
832 struct usb_endpoint_descriptor *endpoint;
833 struct usb_device *hdev;
834 struct usb_hub *hub;
835
836 desc = intf->cur_altsetting;
837 hdev = interface_to_usbdev(intf);
838
839 /* Some hubs have a subclass of 1, which AFAICT according to the */
840 /* specs is not defined, but it works */
841 if ((desc->desc.bInterfaceSubClass != 0) &&
842 (desc->desc.bInterfaceSubClass != 1)) {
843descriptor_error:
844 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
845 return -EIO;
846 }
847
848 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
849 if (desc->desc.bNumEndpoints != 1)
850 goto descriptor_error;
851
852 endpoint = &desc->endpoint[0].desc;
853
854 /* Output endpoint? Curiouser and curiouser.. */
855 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
856 goto descriptor_error;
857
858 /* If it's not an interrupt endpoint, we'd better punt! */
859 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
860 != USB_ENDPOINT_XFER_INT)
861 goto descriptor_error;
862
863 /* We found a hub */
864 dev_info (&intf->dev, "USB hub found\n");
865
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400866 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 if (!hub) {
868 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
869 return -ENOMEM;
870 }
871
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 INIT_LIST_HEAD(&hub->event_list);
873 hub->intfdev = &intf->dev;
874 hub->hdev = hdev;
875 INIT_WORK(&hub->leds, led_work, hub);
876
877 usb_set_intfdata (intf, hub);
878
879 if (hdev->speed == USB_SPEED_HIGH)
880 highspeed_hubs++;
881
882 if (hub_configure(hub, endpoint) >= 0)
883 return 0;
884
885 hub_disconnect (intf);
886 return -ENODEV;
887}
888
889static int
890hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
891{
892 struct usb_device *hdev = interface_to_usbdev (intf);
893
894 /* assert ifno == 0 (part of hub spec) */
895 switch (code) {
896 case USBDEVFS_HUB_PORTINFO: {
897 struct usbdevfs_hub_portinfo *info = user_data;
898 int i;
899
900 spin_lock_irq(&device_state_lock);
901 if (hdev->devnum <= 0)
902 info->nports = 0;
903 else {
904 info->nports = hdev->maxchild;
905 for (i = 0; i < info->nports; i++) {
906 if (hdev->children[i] == NULL)
907 info->port[i] = 0;
908 else
909 info->port[i] =
910 hdev->children[i]->devnum;
911 }
912 }
913 spin_unlock_irq(&device_state_lock);
914
915 return info->nports + 1;
916 }
917
918 default:
919 return -ENOSYS;
920 }
921}
922
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
924/* grab device/port lock, returning index of that port (zero based).
925 * protects the upstream link used by this device from concurrent
926 * tree operations like suspend, resume, reset, and disconnect, which
927 * apply to everything downstream of a given port.
928 */
929static int locktree(struct usb_device *udev)
930{
931 int t;
932 struct usb_device *hdev;
933
934 if (!udev)
935 return -ENODEV;
936
937 /* root hub is always the first lock in the series */
938 hdev = udev->parent;
939 if (!hdev) {
940 usb_lock_device(udev);
941 return 0;
942 }
943
944 /* on the path from root to us, lock everything from
945 * top down, dropping parent locks when not needed
946 */
947 t = locktree(hdev);
948 if (t < 0)
949 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Alan Stern12c3da32005-11-23 12:09:52 -0500951 /* everything is fail-fast once disconnect
952 * processing starts
953 */
954 if (udev->state == USB_STATE_NOTATTACHED) {
955 usb_unlock_device(hdev);
956 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 }
Alan Stern12c3da32005-11-23 12:09:52 -0500958
959 /* when everyone grabs locks top->bottom,
960 * non-overlapping work may be concurrent
961 */
962 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -0500964 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965}
966
967static void recursively_mark_NOTATTACHED(struct usb_device *udev)
968{
969 int i;
970
971 for (i = 0; i < udev->maxchild; ++i) {
972 if (udev->children[i])
973 recursively_mark_NOTATTACHED(udev->children[i]);
974 }
975 udev->state = USB_STATE_NOTATTACHED;
976}
977
978/**
979 * usb_set_device_state - change a device's current state (usbcore, hcds)
980 * @udev: pointer to device whose state should be changed
981 * @new_state: new state value to be stored
982 *
983 * udev->state is _not_ fully protected by the device lock. Although
984 * most transitions are made only while holding the lock, the state can
985 * can change to USB_STATE_NOTATTACHED at almost any time. This
986 * is so that devices can be marked as disconnected as soon as possible,
987 * without having to wait for any semaphores to be released. As a result,
988 * all changes to any device's state must be protected by the
989 * device_state_lock spinlock.
990 *
991 * Once a device has been added to the device tree, all changes to its state
992 * should be made using this routine. The state should _not_ be set directly.
993 *
994 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
995 * Otherwise udev->state is set to new_state, and if new_state is
996 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
997 * to USB_STATE_NOTATTACHED.
998 */
999void usb_set_device_state(struct usb_device *udev,
1000 enum usb_device_state new_state)
1001{
1002 unsigned long flags;
1003
1004 spin_lock_irqsave(&device_state_lock, flags);
1005 if (udev->state == USB_STATE_NOTATTACHED)
1006 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001007 else if (new_state != USB_STATE_NOTATTACHED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 udev->state = new_state;
David Brownellfb669cc2006-01-24 08:40:27 -08001009
1010 /* root hub wakeup capabilities are managed out-of-band
1011 * and may involve silicon errata ... ignore them here.
1012 */
1013 if (udev->parent) {
1014 if (new_state == USB_STATE_CONFIGURED)
1015 device_init_wakeup(&udev->dev,
1016 (udev->actconfig->desc.bmAttributes
1017 & USB_CONFIG_ATT_WAKEUP));
1018 else if (new_state != USB_STATE_SUSPENDED)
1019 device_init_wakeup(&udev->dev, 0);
1020 }
David Brownellb94dc6b2005-09-12 19:39:39 -07001021 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 recursively_mark_NOTATTACHED(udev);
1023 spin_unlock_irqrestore(&device_state_lock, flags);
1024}
1025EXPORT_SYMBOL(usb_set_device_state);
1026
1027
Alan Stern1c50c312005-11-14 11:45:38 -05001028#ifdef CONFIG_PM
1029
1030/**
1031 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1032 * @rhdev: struct usb_device for the root hub
1033 *
1034 * The USB host controller driver calls this function when its root hub
1035 * is resumed and Vbus power has been interrupted or the controller
1036 * has been reset. The routine marks all the children of the root hub
1037 * as NOTATTACHED and marks logical connect-change events on their ports.
1038 */
1039void usb_root_hub_lost_power(struct usb_device *rhdev)
1040{
1041 struct usb_hub *hub;
1042 int port1;
1043 unsigned long flags;
1044
1045 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1046 spin_lock_irqsave(&device_state_lock, flags);
1047 hub = hdev_to_hub(rhdev);
1048 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1049 if (rhdev->children[port1 - 1]) {
1050 recursively_mark_NOTATTACHED(
1051 rhdev->children[port1 - 1]);
1052 set_bit(port1, hub->change_bits);
1053 }
1054 }
1055 spin_unlock_irqrestore(&device_state_lock, flags);
1056}
1057EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1058
1059#endif
1060
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061static void choose_address(struct usb_device *udev)
1062{
1063 int devnum;
1064 struct usb_bus *bus = udev->bus;
1065
1066 /* If khubd ever becomes multithreaded, this will need a lock */
1067
1068 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1069 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1070 bus->devnum_next);
1071 if (devnum >= 128)
1072 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1073
1074 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1075
1076 if (devnum < 128) {
1077 set_bit(devnum, bus->devmap.devicemap);
1078 udev->devnum = devnum;
1079 }
1080}
1081
1082static void release_address(struct usb_device *udev)
1083{
1084 if (udev->devnum > 0) {
1085 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1086 udev->devnum = -1;
1087 }
1088}
1089
1090/**
1091 * usb_disconnect - disconnect a device (usbcore-internal)
1092 * @pdev: pointer to device being disconnected
1093 * Context: !in_interrupt ()
1094 *
1095 * Something got disconnected. Get rid of it and all of its children.
1096 *
1097 * If *pdev is a normal device then the parent hub must already be locked.
1098 * If *pdev is a root hub then this routine will acquire the
1099 * usb_bus_list_lock on behalf of the caller.
1100 *
1101 * Only hub drivers (including virtual root hub drivers for host
1102 * controllers) should ever call this.
1103 *
1104 * This call is synchronous, and may not be used in an interrupt context.
1105 */
1106void usb_disconnect(struct usb_device **pdev)
1107{
1108 struct usb_device *udev = *pdev;
1109 int i;
1110
1111 if (!udev) {
1112 pr_debug ("%s nodev\n", __FUNCTION__);
1113 return;
1114 }
1115
1116 /* mark the device as inactive, so any further urb submissions for
1117 * this device (and any of its children) will fail immediately.
1118 * this quiesces everyting except pending urbs.
1119 */
1120 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1122
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001123 usb_lock_device(udev);
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 /* Free up all the children before we remove this device */
1126 for (i = 0; i < USB_MAXCHILDREN; i++) {
1127 if (udev->children[i])
1128 usb_disconnect(&udev->children[i]);
1129 }
1130
1131 /* deallocate hcd/hardware state ... nuking all pending urbs and
1132 * cleaning up all state associated with the current configuration
1133 * so that the hardware is now fully quiesced.
1134 */
1135 usb_disable_device(udev, 0);
1136
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001137 usb_notify_remove_device(udev);
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 /* Free the device number, remove the /proc/bus/usb entry and
1140 * the sysfs attributes, and delete the parent's children[]
1141 * (or root_hub) pointer.
1142 */
1143 dev_dbg (&udev->dev, "unregistering device\n");
1144 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 usb_remove_sysfs_dev_files(udev);
1146
1147 /* Avoid races with recursively_mark_NOTATTACHED() */
1148 spin_lock_irq(&device_state_lock);
1149 *pdev = NULL;
1150 spin_unlock_irq(&device_state_lock);
1151
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001152 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
1154 device_unregister(&udev->dev);
1155}
1156
Alan Stern55c52712005-11-23 12:03:12 -05001157static inline const char *plural(int n)
1158{
1159 return (n == 1 ? "" : "s");
1160}
1161
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162static int choose_configuration(struct usb_device *udev)
1163{
Alan Stern55c52712005-11-23 12:03:12 -05001164 int i;
1165 u16 devstatus;
1166 int bus_powered;
1167 int num_configs;
1168 struct usb_host_config *c, *best;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
Alan Stern55c52712005-11-23 12:03:12 -05001170 /* If this fails, assume the device is bus-powered */
1171 devstatus = 0;
1172 usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1173 le16_to_cpus(&devstatus);
1174 bus_powered = ((devstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0);
1175 dev_dbg(&udev->dev, "device is %s-powered\n",
1176 bus_powered ? "bus" : "self");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177
Alan Stern55c52712005-11-23 12:03:12 -05001178 best = NULL;
1179 c = udev->config;
1180 num_configs = udev->descriptor.bNumConfigurations;
1181 for (i = 0; i < num_configs; (i++, c++)) {
Alan Stern6aa35672006-03-08 15:14:09 -05001182 struct usb_interface_descriptor *desc = NULL;
1183
1184 /* It's possible that a config has no interfaces! */
1185 if (c->desc.bNumInterfaces > 0)
1186 desc = &c->intf_cache[0]->altsetting->desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187
Alan Stern55c52712005-11-23 12:03:12 -05001188 /*
1189 * HP's USB bus-powered keyboard has only one configuration
1190 * and it claims to be self-powered; other devices may have
1191 * similar errors in their descriptors. If the next test
1192 * were allowed to execute, such configurations would always
1193 * be rejected and the devices would not work as expected.
1194 */
1195#if 0
1196 /* Rule out self-powered configs for a bus-powered device */
1197 if (bus_powered && (c->desc.bmAttributes &
1198 USB_CONFIG_ATT_SELFPOWER))
1199 continue;
1200#endif
1201
1202 /*
1203 * The next test may not be as effective as it should be.
1204 * Some hubs have errors in their descriptor, claiming
1205 * to be self-powered when they are really bus-powered.
1206 * We will overestimate the amount of current such hubs
1207 * make available for each port.
1208 *
1209 * This is a fairly benign sort of failure. It won't
1210 * cause us to reject configurations that we should have
1211 * accepted.
1212 */
1213
1214 /* Rule out configs that draw too much bus current */
1215 if (c->desc.bMaxPower * 2 > udev->bus_mA)
1216 continue;
1217
1218 /* If the first config's first interface is COMM/2/0xff
1219 * (MSFT RNDIS), rule it out unless Linux has host-side
1220 * RNDIS support. */
Alan Stern6aa35672006-03-08 15:14:09 -05001221 if (i == 0 && desc
1222 && desc->bInterfaceClass == USB_CLASS_COMM
Alan Stern55c52712005-11-23 12:03:12 -05001223 && desc->bInterfaceSubClass == 2
1224 && desc->bInterfaceProtocol == 0xff) {
1225#ifndef CONFIG_USB_NET_RNDIS
1226 continue;
1227#else
1228 best = c;
1229#endif
1230 }
1231
1232 /* From the remaining configs, choose the first one whose
1233 * first interface is for a non-vendor-specific class.
1234 * Reason: Linux is more likely to have a class driver
1235 * than a vendor-specific driver. */
1236 else if (udev->descriptor.bDeviceClass !=
1237 USB_CLASS_VENDOR_SPEC &&
Alan Stern6aa35672006-03-08 15:14:09 -05001238 (!desc || desc->bInterfaceClass !=
1239 USB_CLASS_VENDOR_SPEC)) {
Alan Stern55c52712005-11-23 12:03:12 -05001240 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 break;
1242 }
Alan Stern55c52712005-11-23 12:03:12 -05001243
1244 /* If all the remaining configs are vendor-specific,
1245 * choose the first one. */
1246 else if (!best)
1247 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 }
Alan Stern55c52712005-11-23 12:03:12 -05001249
1250 if (best) {
1251 i = best->desc.bConfigurationValue;
1252 dev_info(&udev->dev,
1253 "configuration #%d chosen from %d choice%s\n",
1254 i, num_configs, plural(num_configs));
1255 } else {
1256 i = -1;
1257 dev_warn(&udev->dev,
1258 "no configuration chosen from %d choice%s\n",
1259 num_configs, plural(num_configs));
1260 }
1261 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262}
1263
1264#ifdef DEBUG
1265static void show_string(struct usb_device *udev, char *id, char *string)
1266{
1267 if (!string)
1268 return;
1269 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1270}
1271
1272#else
1273static inline void show_string(struct usb_device *udev, char *id, char *string)
1274{}
1275#endif
1276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
1278#ifdef CONFIG_USB_OTG
1279#include "otg_whitelist.h"
1280#endif
1281
1282/**
1283 * usb_new_device - perform initial device setup (usbcore-internal)
1284 * @udev: newly addressed device (in ADDRESS state)
1285 *
1286 * This is called with devices which have been enumerated, but not yet
1287 * configured. The device descriptor is available, but not descriptors
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001288 * for any device configuration. The caller must have locked either
1289 * the parent hub (if udev is a normal device) or else the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1291 * udev has already been installed, but udev is not yet visible through
1292 * sysfs or other filesystem code.
1293 *
1294 * Returns 0 for success (device is configured and listed, with its
1295 * interfaces, in sysfs); else a negative errno value.
1296 *
1297 * This call is synchronous, and may not be used in an interrupt context.
1298 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001299 * Only the hub driver or root-hub registrar should ever call this.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 */
1301int usb_new_device(struct usb_device *udev)
1302{
1303 int err;
1304 int c;
1305
1306 err = usb_get_configuration(udev);
1307 if (err < 0) {
1308 dev_err(&udev->dev, "can't read configurations, error %d\n",
1309 err);
1310 goto fail;
1311 }
1312
1313 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001314 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1315 udev->manufacturer = usb_cache_string(udev,
1316 udev->descriptor.iManufacturer);
1317 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
1319 /* Tell the world! */
1320 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1321 "SerialNumber=%d\n",
1322 udev->descriptor.iManufacturer,
1323 udev->descriptor.iProduct,
1324 udev->descriptor.iSerialNumber);
1325 show_string(udev, "Product", udev->product);
1326 show_string(udev, "Manufacturer", udev->manufacturer);
1327 show_string(udev, "SerialNumber", udev->serial);
1328
1329#ifdef CONFIG_USB_OTG
1330 /*
1331 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1332 * to wake us after we've powered off VBUS; and HNP, switching roles
1333 * "host" to "peripheral". The OTG descriptor helps figure this out.
1334 */
1335 if (!udev->bus->is_b_host
1336 && udev->config
1337 && udev->parent == udev->bus->root_hub) {
1338 struct usb_otg_descriptor *desc = 0;
1339 struct usb_bus *bus = udev->bus;
1340
1341 /* descriptor may appear anywhere in config */
1342 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1343 le16_to_cpu(udev->config[0].desc.wTotalLength),
1344 USB_DT_OTG, (void **) &desc) == 0) {
1345 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001346 unsigned port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 struct usb_device *root = udev->parent;
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 dev_info(&udev->dev,
1350 "Dual-Role OTG device on %sHNP port\n",
1351 (port1 == bus->otg_port)
1352 ? "" : "non-");
1353
1354 /* enable HNP before suspend, it's simpler */
1355 if (port1 == bus->otg_port)
1356 bus->b_hnp_enable = 1;
1357 err = usb_control_msg(udev,
1358 usb_sndctrlpipe(udev, 0),
1359 USB_REQ_SET_FEATURE, 0,
1360 bus->b_hnp_enable
1361 ? USB_DEVICE_B_HNP_ENABLE
1362 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1363 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1364 if (err < 0) {
1365 /* OTG MESSAGE: report errors here,
1366 * customize to match your product.
1367 */
1368 dev_info(&udev->dev,
1369 "can't set HNP mode; %d\n",
1370 err);
1371 bus->b_hnp_enable = 0;
1372 }
1373 }
1374 }
1375 }
1376
1377 if (!is_targeted(udev)) {
1378
1379 /* Maybe it can talk to us, though we can't talk to it.
1380 * (Includes HNP test device.)
1381 */
1382 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell390a8c32005-09-13 19:57:27 -07001383 static int __usb_suspend_device(struct usb_device *,
1384 int port1);
1385 err = __usb_suspend_device(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 if (err < 0)
1387 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1388 }
1389 err = -ENODEV;
1390 goto fail;
1391 }
1392#endif
1393
1394 /* put device-specific files into sysfs */
1395 err = device_add (&udev->dev);
1396 if (err) {
1397 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1398 goto fail;
1399 }
1400 usb_create_sysfs_dev_files (udev);
1401
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001402 usb_lock_device(udev);
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 /* choose and set the configuration. that registers the interfaces
1405 * with the driver core, and lets usb device drivers bind to them.
1406 */
1407 c = choose_configuration(udev);
Alan Stern55c52712005-11-23 12:03:12 -05001408 if (c >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 err = usb_set_configuration(udev, c);
1410 if (err) {
1411 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1412 c, err);
Alan Stern55c52712005-11-23 12:03:12 -05001413 /* This need not be fatal. The user can try to
1414 * set other configurations. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 }
1416 }
1417
1418 /* USB device state == configured ... usable */
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001419 usb_notify_add_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001421 usb_unlock_device(udev);
1422
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 return 0;
1424
1425fail:
1426 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1427 return err;
1428}
1429
1430
1431static int hub_port_status(struct usb_hub *hub, int port1,
1432 u16 *status, u16 *change)
1433{
1434 int ret;
1435
1436 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1437 if (ret < 0)
1438 dev_err (hub->intfdev,
1439 "%s failed (err = %d)\n", __FUNCTION__, ret);
1440 else {
1441 *status = le16_to_cpu(hub->status->port.wPortStatus);
1442 *change = le16_to_cpu(hub->status->port.wPortChange);
1443 ret = 0;
1444 }
1445 return ret;
1446}
1447
1448#define PORT_RESET_TRIES 5
1449#define SET_ADDRESS_TRIES 2
1450#define GET_DESCRIPTOR_TRIES 2
1451#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1452#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1453
1454#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1455#define HUB_SHORT_RESET_TIME 10
1456#define HUB_LONG_RESET_TIME 200
1457#define HUB_RESET_TIMEOUT 500
1458
1459static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1460 struct usb_device *udev, unsigned int delay)
1461{
1462 int delay_time, ret;
1463 u16 portstatus;
1464 u16 portchange;
1465
1466 for (delay_time = 0;
1467 delay_time < HUB_RESET_TIMEOUT;
1468 delay_time += delay) {
1469 /* wait to give the device a chance to reset */
1470 msleep(delay);
1471
1472 /* read and decode port status */
1473 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1474 if (ret < 0)
1475 return ret;
1476
1477 /* Device went away? */
1478 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1479 return -ENOTCONN;
1480
1481 /* bomb out completely if something weird happened */
1482 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1483 return -EINVAL;
1484
1485 /* if we`ve finished resetting, then break out of the loop */
1486 if (!(portstatus & USB_PORT_STAT_RESET) &&
1487 (portstatus & USB_PORT_STAT_ENABLE)) {
1488 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1489 udev->speed = USB_SPEED_HIGH;
1490 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1491 udev->speed = USB_SPEED_LOW;
1492 else
1493 udev->speed = USB_SPEED_FULL;
1494 return 0;
1495 }
1496
1497 /* switch to the long delay after two short delay failures */
1498 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1499 delay = HUB_LONG_RESET_TIME;
1500
1501 dev_dbg (hub->intfdev,
1502 "port %d not reset yet, waiting %dms\n",
1503 port1, delay);
1504 }
1505
1506 return -EBUSY;
1507}
1508
1509static int hub_port_reset(struct usb_hub *hub, int port1,
1510 struct usb_device *udev, unsigned int delay)
1511{
1512 int i, status;
1513
1514 /* Reset the port */
1515 for (i = 0; i < PORT_RESET_TRIES; i++) {
1516 status = set_port_feature(hub->hdev,
1517 port1, USB_PORT_FEAT_RESET);
1518 if (status)
1519 dev_err(hub->intfdev,
1520 "cannot reset port %d (err = %d)\n",
1521 port1, status);
1522 else {
1523 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001524 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 dev_dbg(hub->intfdev,
1526 "port_wait_reset: err = %d\n",
1527 status);
1528 }
1529
1530 /* return on disconnect or reset */
1531 switch (status) {
1532 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001533 /* TRSTRCY = 10 ms; plus some extra */
1534 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 /* FALL THROUGH */
1536 case -ENOTCONN:
1537 case -ENODEV:
1538 clear_port_feature(hub->hdev,
1539 port1, USB_PORT_FEAT_C_RESET);
1540 /* FIXME need disconnect() for NOTATTACHED device */
1541 usb_set_device_state(udev, status
1542 ? USB_STATE_NOTATTACHED
1543 : USB_STATE_DEFAULT);
1544 return status;
1545 }
1546
1547 dev_dbg (hub->intfdev,
1548 "port %d not enabled, trying reset again...\n",
1549 port1);
1550 delay = HUB_LONG_RESET_TIME;
1551 }
1552
1553 dev_err (hub->intfdev,
1554 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1555 port1);
1556
1557 return status;
1558}
1559
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560/*
1561 * Disable a port and mark a logical connnect-change event, so that some
1562 * time later khubd will disconnect() any existing usb_device on the port
1563 * and will re-enumerate if there actually is a device attached.
1564 */
1565static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1566{
1567 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1568 hub_port_disable(hub, port1, 1);
1569
1570 /* FIXME let caller ask to power down the port:
1571 * - some devices won't enumerate without a VBUS power cycle
1572 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001573 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 * That's easy if this hub can switch power per-port, and
1575 * khubd reactivates the port later (timer, SRP, etc).
1576 * Powerdown must be optional, because of reset/DFU.
1577 */
1578
1579 set_bit(port1, hub->change_bits);
1580 kick_khubd(hub);
1581}
1582
1583
1584#ifdef CONFIG_USB_SUSPEND
1585
1586/*
1587 * Selective port suspend reduces power; most suspended devices draw
1588 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1589 * All devices below the suspended port are also suspended.
1590 *
1591 * Devices leave suspend state when the host wakes them up. Some devices
1592 * also support "remote wakeup", where the device can activate the USB
1593 * tree above them to deliver data, such as a keypress or packet. In
1594 * some cases, this wakes the USB host.
1595 */
1596static int hub_port_suspend(struct usb_hub *hub, int port1,
1597 struct usb_device *udev)
1598{
1599 int status;
1600
1601 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1602
1603 /* enable remote wakeup when appropriate; this lets the device
1604 * wake up the upstream hub (including maybe the root hub).
1605 *
1606 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1607 * we don't explicitly enable it here.
1608 */
David Brownellb94dc6b2005-09-12 19:39:39 -07001609 if (device_may_wakeup(&udev->dev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1611 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1612 USB_DEVICE_REMOTE_WAKEUP, 0,
1613 NULL, 0,
1614 USB_CTRL_SET_TIMEOUT);
1615 if (status)
1616 dev_dbg(&udev->dev,
1617 "won't remote wakeup, status %d\n",
1618 status);
1619 }
1620
1621 /* see 7.1.7.6 */
1622 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1623 if (status) {
1624 dev_dbg(hub->intfdev,
1625 "can't suspend port %d, status %d\n",
1626 port1, status);
1627 /* paranoia: "should not happen" */
1628 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1629 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1630 USB_DEVICE_REMOTE_WAKEUP, 0,
1631 NULL, 0,
1632 USB_CTRL_SET_TIMEOUT);
1633 } else {
1634 /* device has up to 10 msec to fully suspend */
1635 dev_dbg(&udev->dev, "usb suspend\n");
1636 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1637 msleep(10);
1638 }
1639 return status;
1640}
1641
1642/*
1643 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001644 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 * State transitions include:
1646 *
1647 * - suspend, resume ... when the VBUS power link stays live
1648 * - suspend, disconnect ... VBUS lost
1649 *
1650 * Once VBUS drop breaks the circuit, the port it's using has to go through
1651 * normal re-enumeration procedures, starting with enabling VBUS power.
1652 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1653 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1654 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001655 *
1656 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1657 * the root hub for their bus goes into global suspend ... so we don't
1658 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 */
David Brownell390a8c32005-09-13 19:57:27 -07001660static int __usb_suspend_device (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661{
David Brownellf3f32532005-09-22 22:37:29 -07001662 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
1664 /* caller owns the udev device lock */
1665 if (port1 < 0)
1666 return port1;
1667
1668 if (udev->state == USB_STATE_SUSPENDED
1669 || udev->state == USB_STATE_NOTATTACHED) {
1670 return 0;
1671 }
1672
David Brownellc9f89fa2005-09-13 19:57:04 -07001673 /* all interfaces must already be suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 if (udev->actconfig) {
1675 int i;
1676
1677 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1678 struct usb_interface *intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 intf = udev->actconfig->interface[i];
David Brownellc9f89fa2005-09-13 19:57:04 -07001681 if (is_active(intf)) {
1682 dev_dbg(&intf->dev, "nyet suspended\n");
1683 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 }
1685 }
1686 }
1687
David Brownellf3f32532005-09-22 22:37:29 -07001688 /* we only change a device's upstream USB link.
1689 * root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 */
David Brownellf3f32532005-09-22 22:37:29 -07001691 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1693 udev);
1694
1695 if (status == 0)
David Brownell390a8c32005-09-13 19:57:27 -07001696 udev->dev.power.power_state = PMSG_SUSPEND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 return status;
1698}
1699
David Brownellf3f32532005-09-22 22:37:29 -07001700#endif
1701
David Brownell5edbfb72005-09-22 22:45:26 -07001702/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 * usb_suspend_device - suspend a usb device
1704 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001705 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 *
1707 * Suspends a USB device that isn't in active use, conserving power.
1708 * Devices may wake out of a suspend, if anything important happens,
1709 * using the remote wakeup mechanism. They may also be taken out of
1710 * suspend by the host, using usb_resume_device(). It's also routine
1711 * to disconnect devices while they are suspended.
1712 *
David Brownell390a8c32005-09-13 19:57:27 -07001713 * This only affects the USB hardware for a device; its interfaces
1714 * (and, for hubs, child devices) must already have been suspended.
1715 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 * Suspending OTG devices may trigger HNP, if that's been enabled
1717 * between a pair of dual-role devices. That will change roles, such
1718 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1719 *
1720 * Returns 0 on success, else negative errno.
1721 */
David Brownell390a8c32005-09-13 19:57:27 -07001722int usb_suspend_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723{
David Brownellf3f32532005-09-22 22:37:29 -07001724#ifdef CONFIG_USB_SUSPEND
Alan Stern4bf0ba82005-11-21 11:58:07 -05001725 if (udev->state == USB_STATE_NOTATTACHED)
1726 return -ENODEV;
Alan Stern12c3da32005-11-23 12:09:52 -05001727 return __usb_suspend_device(udev, udev->portnum);
David Brownellf3f32532005-09-22 22:37:29 -07001728#else
1729 /* NOTE: udev->state unchanged, it's not lying ... */
1730 udev->dev.power.power_state = PMSG_SUSPEND;
1731 return 0;
1732#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733}
David Brownellf3f32532005-09-22 22:37:29 -07001734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735/*
David Brownell390a8c32005-09-13 19:57:27 -07001736 * If the USB "suspend" state is in use (rather than "global suspend"),
1737 * many devices will be individually taken out of suspend state using
1738 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 * hardware resume signaling is finished, either because of selective
1740 * resume (by host) or remote wakeup (by device) ... now see what changed
1741 * in the tree that's rooted at this device.
1742 */
David Brownellf3f32532005-09-22 22:37:29 -07001743static int finish_device_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744{
1745 int status;
1746 u16 devstatus;
1747
1748 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001749 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
1751 /* usb ch9 identifies four variants of SUSPENDED, based on what
1752 * state the device resumes to. Linux currently won't see the
1753 * first two on the host side; they'd be inside hub_port_init()
1754 * during many timeouts, but khubd can't suspend until later.
1755 */
1756 usb_set_device_state(udev, udev->actconfig
1757 ? USB_STATE_CONFIGURED
1758 : USB_STATE_ADDRESS);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001759 udev->dev.power.power_state = PMSG_ON;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
1761 /* 10.5.4.5 says be sure devices in the tree are still there.
1762 * For now let's assume the device didn't go crazy on resume,
1763 * and device drivers will know about any resume quirks.
1764 */
1765 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001766 if (status < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 dev_dbg(&udev->dev,
1768 "gone after usb resume? status %d\n",
1769 status);
1770 else if (udev->actconfig) {
1771 unsigned i;
David Brownelldbc38872005-09-13 19:57:36 -07001772 int (*resume)(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
1774 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001775 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001776 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 status = usb_control_msg(udev,
1778 usb_sndctrlpipe(udev, 0),
1779 USB_REQ_CLEAR_FEATURE,
1780 USB_RECIP_DEVICE,
1781 USB_DEVICE_REMOTE_WAKEUP, 0,
1782 NULL, 0,
1783 USB_CTRL_SET_TIMEOUT);
1784 if (status) {
1785 dev_dbg(&udev->dev, "disable remote "
1786 "wakeup, status %d\n", status);
1787 status = 0;
1788 }
1789 }
1790
1791 /* resume interface drivers; if this is a hub, it
David Brownelldbc38872005-09-13 19:57:36 -07001792 * may have a child resume event to deal with soon
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 */
David Brownelldbc38872005-09-13 19:57:36 -07001794 resume = udev->dev.bus->resume;
Alan Stern4bf0ba82005-11-21 11:58:07 -05001795 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1796 struct device *dev =
1797 &udev->actconfig->interface[i]->dev;
1798
1799 down(&dev->sem);
1800 (void) resume(dev);
1801 up(&dev->sem);
1802 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 status = 0;
1804
1805 } else if (udev->devnum <= 0) {
1806 dev_dbg(&udev->dev, "bogus resume!\n");
1807 status = -EINVAL;
1808 }
1809 return status;
1810}
1811
David Brownellf3f32532005-09-22 22:37:29 -07001812#ifdef CONFIG_USB_SUSPEND
1813
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814static int
1815hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1816{
1817 int status;
1818
1819 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1820
1821 /* see 7.1.7.7; affects power usage, but not budgeting */
1822 status = clear_port_feature(hub->hdev,
1823 port1, USB_PORT_FEAT_SUSPEND);
1824 if (status) {
1825 dev_dbg(hub->intfdev,
1826 "can't resume port %d, status %d\n",
1827 port1, status);
1828 } else {
1829 u16 devstatus;
1830 u16 portchange;
1831
1832 /* drive resume for at least 20 msec */
1833 if (udev)
1834 dev_dbg(&udev->dev, "RESUME\n");
1835 msleep(25);
1836
1837#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1838 | USB_PORT_STAT_ENABLE \
1839 | USB_PORT_STAT_CONNECTION)
1840
1841 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1842 * stop resume signaling. Then finish the resume
1843 * sequence.
1844 */
1845 devstatus = portchange = 0;
1846 status = hub_port_status(hub, port1,
1847 &devstatus, &portchange);
1848 if (status < 0
1849 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1850 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1851 ) {
1852 dev_dbg(hub->intfdev,
1853 "port %d status %04x.%04x after resume, %d\n",
1854 port1, portchange, devstatus, status);
1855 } else {
1856 /* TRSMRCY = 10 msec */
1857 msleep(10);
1858 if (udev)
David Brownellf3f32532005-09-22 22:37:29 -07001859 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 }
1861 }
1862 if (status < 0)
1863 hub_port_logical_disconnect(hub, port1);
1864
1865 return status;
1866}
1867
David Brownellf3f32532005-09-22 22:37:29 -07001868#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
David Brownell5edbfb72005-09-22 22:45:26 -07001870/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 * usb_resume_device - re-activate a suspended usb device
1872 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001873 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 *
1875 * This will re-activate the suspended device, increasing power usage
1876 * while letting drivers communicate again with its endpoints.
1877 * USB resume explicitly guarantees that the power session between
1878 * the host and the device is the same as it was when the device
1879 * suspended.
1880 *
1881 * Returns 0 on success, else negative errno.
1882 */
1883int usb_resume_device(struct usb_device *udev)
1884{
Alan Stern12c3da32005-11-23 12:09:52 -05001885 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
Alan Stern4bf0ba82005-11-21 11:58:07 -05001887 if (udev->state == USB_STATE_NOTATTACHED)
1888 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
David Brownellf3f32532005-09-22 22:37:29 -07001890 /* selective resume of one downstream hub-to-device port */
1891 if (udev->parent) {
David Brownellfb669cc2006-01-24 08:40:27 -08001892#ifdef CONFIG_USB_SUSPEND
David Brownellf3f32532005-09-22 22:37:29 -07001893 if (udev->state == USB_STATE_SUSPENDED) {
1894 // NOTE swsusp may bork us, device state being wrong...
1895 // NOTE this fails if parent is also suspended...
1896 status = hub_port_resume(hdev_to_hub(udev->parent),
Alan Stern12c3da32005-11-23 12:09:52 -05001897 udev->portnum, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 } else
David Brownellf3f32532005-09-22 22:37:29 -07001899#endif
Alan Stern43c5d5a2006-02-01 10:47:11 -05001900 status = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001901 } else
David Brownellf3f32532005-09-22 22:37:29 -07001902 status = finish_device_resume(udev);
1903 if (status < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 dev_dbg(&udev->dev, "can't resume, status %d\n",
1905 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 /* rebind drivers that had no suspend() */
Alan Stern4bf0ba82005-11-21 11:58:07 -05001908 if (status == 0) {
1909 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 bus_rescan_devices(&usb_bus_type);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001911 usb_lock_device(udev);
1912 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 return status;
1914}
1915
1916static int remote_wakeup(struct usb_device *udev)
1917{
1918 int status = 0;
1919
David Brownellf3f32532005-09-22 22:37:29 -07001920#ifdef CONFIG_USB_SUSPEND
1921
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 /* don't repeat RESUME sequence if this device
1923 * was already woken up by some other task
1924 */
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001925 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 if (udev->state == USB_STATE_SUSPENDED) {
1927 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1928 /* TRSMRCY = 10 msec */
1929 msleep(10);
David Brownellf3f32532005-09-22 22:37:29 -07001930 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001932 usb_unlock_device(udev);
David Brownellf3f32532005-09-22 22:37:29 -07001933#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 return status;
1935}
1936
David Brownelldb690872005-09-13 19:56:33 -07001937static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938{
1939 struct usb_hub *hub = usb_get_intfdata (intf);
1940 struct usb_device *hdev = hub->hdev;
1941 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
David Brownellc9f89fa2005-09-13 19:57:04 -07001943 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1945 struct usb_device *udev;
1946
1947 udev = hdev->children [port1-1];
David Brownellf3f32532005-09-22 22:37:29 -07001948 if (udev && (udev->dev.power.power_state.event
1949 == PM_EVENT_ON
1950#ifdef CONFIG_USB_SUSPEND
1951 || udev->state != USB_STATE_SUSPENDED
1952#endif
1953 )) {
David Brownellc9f89fa2005-09-13 19:57:04 -07001954 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1955 return -EBUSY;
1956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 }
1958
David Brownellf3f32532005-09-22 22:37:29 -07001959 /* "global suspend" of the downstream HC-to-USB interface */
1960 if (!hdev->parent) {
1961 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001962 if (bus) {
1963 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001964
1965 if (status != 0) {
1966 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1967 status);
1968 return status;
1969 }
1970 } else
1971 return -EOPNOTSUPP;
1972 }
1973
David Brownellc9f89fa2005-09-13 19:57:04 -07001974 /* stop khubd and related activity */
1975 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 return 0;
1977}
1978
1979static int hub_resume(struct usb_interface *intf)
1980{
1981 struct usb_device *hdev = interface_to_usbdev(intf);
1982 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 int status;
1984
David Brownellf3f32532005-09-22 22:37:29 -07001985 /* "global resume" of the downstream HC-to-USB interface */
1986 if (!hdev->parent) {
1987 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001988 if (bus) {
1989 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001990 if (status) {
1991 dev_dbg(&intf->dev, "'global' resume %d\n",
1992 status);
1993 return status;
1994 }
1995 } else
1996 return -EOPNOTSUPP;
1997 if (status == 0) {
1998 /* TRSMRCY = 10 msec */
1999 msleep(10);
2000 }
2001 }
2002
2003 hub_activate(hub);
2004
2005 /* REVISIT: this recursion probably shouldn't exist. Remove
2006 * this code sometime, after retesting with different root and
2007 * external hubs.
2008 */
2009#ifdef CONFIG_USB_SUSPEND
2010 {
2011 unsigned port1;
2012
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2014 struct usb_device *udev;
2015 u16 portstat, portchange;
2016
2017 udev = hdev->children [port1-1];
2018 status = hub_port_status(hub, port1, &portstat, &portchange);
2019 if (status == 0) {
2020 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2021 clear_port_feature(hdev, port1,
2022 USB_PORT_FEAT_C_SUSPEND);
2023 portchange &= ~USB_PORT_STAT_C_SUSPEND;
2024 }
2025
2026 /* let khubd handle disconnects etc */
2027 if (portchange)
2028 continue;
2029 }
2030
2031 if (!udev || status < 0)
2032 continue;
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002033 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 if (portstat & USB_PORT_STAT_SUSPEND)
2035 status = hub_port_resume(hub, port1, udev);
2036 else {
David Brownellf3f32532005-09-22 22:37:29 -07002037 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 if (status < 0) {
2039 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2040 port1, status);
2041 hub_port_logical_disconnect(hub, port1);
2042 }
2043 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002044 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 }
David Brownellf3f32532005-09-22 22:37:29 -07002046 }
2047#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 return 0;
2049}
2050
David Brownell979d5192005-09-22 22:32:24 -07002051void usb_suspend_root_hub(struct usb_device *hdev)
2052{
2053 struct usb_hub *hub = hdev_to_hub(hdev);
2054
2055 /* This also makes any led blinker stop retriggering. We're called
2056 * from irq, so the blinker might still be scheduled. Caller promises
2057 * that the root hub status URB will be canceled.
2058 */
2059 __hub_quiesce(hub);
2060 mark_quiesced(to_usb_interface(hub->intfdev));
2061}
2062
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063void usb_resume_root_hub(struct usb_device *hdev)
2064{
2065 struct usb_hub *hub = hdev_to_hub(hdev);
2066
2067 hub->resume_root_hub = 1;
2068 kick_khubd(hub);
2069}
2070
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
2072/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2073 *
2074 * Between connect detection and reset signaling there must be a delay
2075 * of 100ms at least for debounce and power-settling. The corresponding
2076 * timer shall restart whenever the downstream port detects a disconnect.
2077 *
2078 * Apparently there are some bluetooth and irda-dongles and a number of
2079 * low-speed devices for which this debounce period may last over a second.
2080 * Not covered by the spec - but easy to deal with.
2081 *
2082 * This implementation uses a 1500ms total debounce timeout; if the
2083 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2084 * every 25ms for transient disconnects. When the port status has been
2085 * unchanged for 100ms it returns the port status.
2086 */
2087
2088#define HUB_DEBOUNCE_TIMEOUT 1500
2089#define HUB_DEBOUNCE_STEP 25
2090#define HUB_DEBOUNCE_STABLE 100
2091
2092static int hub_port_debounce(struct usb_hub *hub, int port1)
2093{
2094 int ret;
2095 int total_time, stable_time = 0;
2096 u16 portchange, portstatus;
2097 unsigned connection = 0xffff;
2098
2099 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2100 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2101 if (ret < 0)
2102 return ret;
2103
2104 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2105 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2106 stable_time += HUB_DEBOUNCE_STEP;
2107 if (stable_time >= HUB_DEBOUNCE_STABLE)
2108 break;
2109 } else {
2110 stable_time = 0;
2111 connection = portstatus & USB_PORT_STAT_CONNECTION;
2112 }
2113
2114 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2115 clear_port_feature(hub->hdev, port1,
2116 USB_PORT_FEAT_C_CONNECTION);
2117 }
2118
2119 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2120 break;
2121 msleep(HUB_DEBOUNCE_STEP);
2122 }
2123
2124 dev_dbg (hub->intfdev,
2125 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2126 port1, total_time, stable_time, portstatus);
2127
2128 if (stable_time < HUB_DEBOUNCE_STABLE)
2129 return -ETIMEDOUT;
2130 return portstatus;
2131}
2132
2133static void ep0_reinit(struct usb_device *udev)
2134{
2135 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2136 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2137 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2138}
2139
2140#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2141#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2142
2143static int hub_set_address(struct usb_device *udev)
2144{
2145 int retval;
2146
2147 if (udev->devnum == 0)
2148 return -EINVAL;
2149 if (udev->state == USB_STATE_ADDRESS)
2150 return 0;
2151 if (udev->state != USB_STATE_DEFAULT)
2152 return -EINVAL;
2153 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2154 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2155 NULL, 0, USB_CTRL_SET_TIMEOUT);
2156 if (retval == 0) {
2157 usb_set_device_state(udev, USB_STATE_ADDRESS);
2158 ep0_reinit(udev);
2159 }
2160 return retval;
2161}
2162
2163/* Reset device, (re)assign address, get device descriptor.
2164 * Device connection must be stable, no more debouncing needed.
2165 * Returns device in USB_STATE_ADDRESS, except on error.
2166 *
2167 * If this is called for an already-existing device (as part of
2168 * usb_reset_device), the caller must own the device lock. For a
2169 * newly detected device that is not accessible through any global
2170 * pointers, it's not necessary to lock the device.
2171 */
2172static int
2173hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2174 int retry_counter)
2175{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002176 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177
2178 struct usb_device *hdev = hub->hdev;
2179 int i, j, retval;
2180 unsigned delay = HUB_SHORT_RESET_TIME;
2181 enum usb_device_speed oldspeed = udev->speed;
2182
2183 /* root hub ports have a slightly longer reset period
2184 * (from USB 2.0 spec, section 7.1.7.5)
2185 */
2186 if (!hdev->parent) {
2187 delay = HUB_ROOT_RESET_TIME;
2188 if (port1 == hdev->bus->otg_port)
2189 hdev->bus->b_hnp_enable = 0;
2190 }
2191
2192 /* Some low speed devices have problems with the quick delay, so */
2193 /* be a bit pessimistic with those devices. RHbug #23670 */
2194 if (oldspeed == USB_SPEED_LOW)
2195 delay = HUB_LONG_RESET_TIME;
2196
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002197 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198
2199 /* Reset the device; full speed may morph to high speed */
2200 retval = hub_port_reset(hub, port1, udev, delay);
2201 if (retval < 0) /* error or disconnect */
2202 goto fail;
2203 /* success, speed is known */
2204 retval = -ENODEV;
2205
2206 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2207 dev_dbg(&udev->dev, "device reset changed speed!\n");
2208 goto fail;
2209 }
2210 oldspeed = udev->speed;
2211
2212 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2213 * it's fixed size except for full speed devices.
2214 */
2215 switch (udev->speed) {
2216 case USB_SPEED_HIGH: /* fixed at 64 */
2217 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2218 break;
2219 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2220 /* to determine the ep0 maxpacket size, try to read
2221 * the device descriptor to get bMaxPacketSize0 and
2222 * then correct our initial guess.
2223 */
2224 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2225 break;
2226 case USB_SPEED_LOW: /* fixed at 8 */
2227 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2228 break;
2229 default:
2230 goto fail;
2231 }
2232
2233 dev_info (&udev->dev,
2234 "%s %s speed USB device using %s and address %d\n",
2235 (udev->config) ? "reset" : "new",
2236 ({ char *speed; switch (udev->speed) {
2237 case USB_SPEED_LOW: speed = "low"; break;
2238 case USB_SPEED_FULL: speed = "full"; break;
2239 case USB_SPEED_HIGH: speed = "high"; break;
2240 default: speed = "?"; break;
2241 }; speed;}),
2242 udev->bus->controller->driver->name,
2243 udev->devnum);
2244
2245 /* Set up TT records, if needed */
2246 if (hdev->tt) {
2247 udev->tt = hdev->tt;
2248 udev->ttport = hdev->ttport;
2249 } else if (udev->speed != USB_SPEED_HIGH
2250 && hdev->speed == USB_SPEED_HIGH) {
2251 udev->tt = &hub->tt;
2252 udev->ttport = port1;
2253 }
2254
2255 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2256 * Because device hardware and firmware is sometimes buggy in
2257 * this area, and this is how Linux has done it for ages.
2258 * Change it cautiously.
2259 *
2260 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2261 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2262 * so it may help with some non-standards-compliant devices.
2263 * Otherwise we start with SET_ADDRESS and then try to read the
2264 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2265 * value.
2266 */
2267 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2268 if (USE_NEW_SCHEME(retry_counter)) {
2269 struct usb_device_descriptor *buf;
2270 int r = 0;
2271
2272#define GET_DESCRIPTOR_BUFSIZE 64
2273 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2274 if (!buf) {
2275 retval = -ENOMEM;
2276 continue;
2277 }
2278
2279 /* Use a short timeout the first time through,
2280 * so that recalcitrant full-speed devices with
2281 * 8- or 16-byte ep0-maxpackets won't slow things
2282 * down tremendously by NAKing the unexpectedly
2283 * early status stage. Also, retry on all errors;
2284 * some devices are flakey.
2285 */
2286 for (j = 0; j < 3; ++j) {
2287 buf->bMaxPacketSize0 = 0;
2288 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2289 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2290 USB_DT_DEVICE << 8, 0,
2291 buf, GET_DESCRIPTOR_BUFSIZE,
2292 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2293 switch (buf->bMaxPacketSize0) {
2294 case 8: case 16: case 32: case 64:
2295 if (buf->bDescriptorType ==
2296 USB_DT_DEVICE) {
2297 r = 0;
2298 break;
2299 }
2300 /* FALL THROUGH */
2301 default:
2302 if (r == 0)
2303 r = -EPROTO;
2304 break;
2305 }
2306 if (r == 0)
2307 break;
2308 }
2309 udev->descriptor.bMaxPacketSize0 =
2310 buf->bMaxPacketSize0;
2311 kfree(buf);
2312
2313 retval = hub_port_reset(hub, port1, udev, delay);
2314 if (retval < 0) /* error or disconnect */
2315 goto fail;
2316 if (oldspeed != udev->speed) {
2317 dev_dbg(&udev->dev,
2318 "device reset changed speed!\n");
2319 retval = -ENODEV;
2320 goto fail;
2321 }
2322 if (r) {
2323 dev_err(&udev->dev, "device descriptor "
2324 "read/%s, error %d\n",
2325 "64", r);
2326 retval = -EMSGSIZE;
2327 continue;
2328 }
2329#undef GET_DESCRIPTOR_BUFSIZE
2330 }
2331
2332 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2333 retval = hub_set_address(udev);
2334 if (retval >= 0)
2335 break;
2336 msleep(200);
2337 }
2338 if (retval < 0) {
2339 dev_err(&udev->dev,
2340 "device not accepting address %d, error %d\n",
2341 udev->devnum, retval);
2342 goto fail;
2343 }
2344
2345 /* cope with hardware quirkiness:
2346 * - let SET_ADDRESS settle, some device hardware wants it
2347 * - read ep0 maxpacket even for high and low speed,
2348 */
2349 msleep(10);
2350 if (USE_NEW_SCHEME(retry_counter))
2351 break;
2352
2353 retval = usb_get_device_descriptor(udev, 8);
2354 if (retval < 8) {
2355 dev_err(&udev->dev, "device descriptor "
2356 "read/%s, error %d\n",
2357 "8", retval);
2358 if (retval >= 0)
2359 retval = -EMSGSIZE;
2360 } else {
2361 retval = 0;
2362 break;
2363 }
2364 }
2365 if (retval)
2366 goto fail;
2367
2368 i = udev->descriptor.bMaxPacketSize0;
2369 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2370 if (udev->speed != USB_SPEED_FULL ||
2371 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2372 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2373 retval = -EMSGSIZE;
2374 goto fail;
2375 }
2376 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2377 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2378 ep0_reinit(udev);
2379 }
2380
2381 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2382 if (retval < (signed)sizeof(udev->descriptor)) {
2383 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2384 "all", retval);
2385 if (retval >= 0)
2386 retval = -ENOMSG;
2387 goto fail;
2388 }
2389
2390 retval = 0;
2391
2392fail:
2393 if (retval)
2394 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002395 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 return retval;
2397}
2398
2399static void
2400check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2401{
2402 struct usb_qualifier_descriptor *qual;
2403 int status;
2404
2405 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2406 if (qual == NULL)
2407 return;
2408
2409 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2410 qual, sizeof *qual);
2411 if (status == sizeof *qual) {
2412 dev_info(&udev->dev, "not running at top speed; "
2413 "connect to a high speed hub\n");
2414 /* hub LEDs are probably harder to miss than syslog */
2415 if (hub->has_indicators) {
2416 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2417 schedule_work (&hub->leds);
2418 }
2419 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002420 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421}
2422
2423static unsigned
2424hub_power_remaining (struct usb_hub *hub)
2425{
2426 struct usb_device *hdev = hub->hdev;
2427 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002428 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429
Alan Stern55c52712005-11-23 12:03:12 -05002430 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 return 0;
2432
Alan Stern55c52712005-11-23 12:03:12 -05002433 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2434 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2435 struct usb_device *udev = hdev->children[port1 - 1];
2436 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437
2438 if (!udev)
2439 continue;
2440
Alan Stern55c52712005-11-23 12:03:12 -05002441 /* Unconfigured devices may not use more than 100mA,
2442 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002444 delta = udev->actconfig->desc.bMaxPower * 2;
2445 else if (port1 != udev->bus->otg_port || hdev->parent)
2446 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 else
Alan Stern55c52712005-11-23 12:03:12 -05002448 delta = 8;
2449 if (delta > hub->mA_per_port)
2450 dev_warn(&udev->dev, "%dmA is over %umA budget "
2451 "for port %d!\n",
2452 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 remaining -= delta;
2454 }
2455 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002456 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2457 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 remaining = 0;
2459 }
2460 return remaining;
2461}
2462
2463/* Handle physical or logical connection change events.
2464 * This routine is called when:
2465 * a port connection-change occurs;
2466 * a port enable-change occurs (often caused by EMI);
2467 * usb_reset_device() encounters changed descriptors (as from
2468 * a firmware download)
2469 * caller already locked the hub
2470 */
2471static void hub_port_connect_change(struct usb_hub *hub, int port1,
2472 u16 portstatus, u16 portchange)
2473{
2474 struct usb_device *hdev = hub->hdev;
2475 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002476 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 int status, i;
2478
2479 dev_dbg (hub_dev,
2480 "port %d, status %04x, change %04x, %s\n",
2481 port1, portstatus, portchange, portspeed (portstatus));
2482
2483 if (hub->has_indicators) {
2484 set_port_led(hub, port1, HUB_LED_AUTO);
2485 hub->indicator[port1-1] = INDICATOR_AUTO;
2486 }
2487
2488 /* Disconnect any existing devices under this port */
2489 if (hdev->children[port1-1])
2490 usb_disconnect(&hdev->children[port1-1]);
2491 clear_bit(port1, hub->change_bits);
2492
2493#ifdef CONFIG_USB_OTG
2494 /* during HNP, don't repeat the debounce */
2495 if (hdev->bus->is_b_host)
2496 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2497#endif
2498
2499 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2500 status = hub_port_debounce(hub, port1);
2501 if (status < 0) {
2502 dev_err (hub_dev,
2503 "connect-debounce failed, port %d disabled\n",
2504 port1);
2505 goto done;
2506 }
2507 portstatus = status;
2508 }
2509
2510 /* Return now if nothing is connected */
2511 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2512
2513 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002514 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2516 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2517
2518 if (portstatus & USB_PORT_STAT_ENABLE)
2519 goto done;
2520 return;
2521 }
2522
2523#ifdef CONFIG_USB_SUSPEND
2524 /* If something is connected, but the port is suspended, wake it up. */
2525 if (portstatus & USB_PORT_STAT_SUSPEND) {
2526 status = hub_port_resume(hub, port1, NULL);
2527 if (status < 0) {
2528 dev_dbg(hub_dev,
2529 "can't clear suspend on port %d; %d\n",
2530 port1, status);
2531 goto done;
2532 }
2533 }
2534#endif
2535
2536 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2537 struct usb_device *udev;
2538
2539 /* reallocate for each attempt, since references
2540 * to the previous one can escape in various ways
2541 */
2542 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2543 if (!udev) {
2544 dev_err (hub_dev,
2545 "couldn't allocate port %d usb_device\n",
2546 port1);
2547 goto done;
2548 }
2549
2550 usb_set_device_state(udev, USB_STATE_POWERED);
2551 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002552 udev->bus_mA = hub->mA_per_port;
2553
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554 /* set the address */
2555 choose_address(udev);
2556 if (udev->devnum <= 0) {
2557 status = -ENOTCONN; /* Don't retry */
2558 goto loop;
2559 }
2560
2561 /* reset and get descriptor */
2562 status = hub_port_init(hub, udev, port1, i);
2563 if (status < 0)
2564 goto loop;
2565
2566 /* consecutive bus-powered hubs aren't reliable; they can
2567 * violate the voltage drop budget. if the new child has
2568 * a "powered" LED, users should notice we didn't enable it
2569 * (without reading syslog), even without per-port LEDs
2570 * on the parent.
2571 */
2572 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002573 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 u16 devstat;
2575
2576 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2577 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002578 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 dev_dbg(&udev->dev, "get status %d ?\n", status);
2580 goto loop_disable;
2581 }
Alan Stern55c52712005-11-23 12:03:12 -05002582 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2584 dev_err(&udev->dev,
2585 "can't connect bus-powered hub "
2586 "to this port\n");
2587 if (hub->has_indicators) {
2588 hub->indicator[port1-1] =
2589 INDICATOR_AMBER_BLINK;
2590 schedule_work (&hub->leds);
2591 }
2592 status = -ENOTCONN; /* Don't retry */
2593 goto loop_disable;
2594 }
2595 }
2596
2597 /* check for devices running slower than they could */
2598 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2599 && udev->speed == USB_SPEED_FULL
2600 && highspeed_hubs != 0)
2601 check_highspeed (hub, udev, port1);
2602
2603 /* Store the parent's children[] pointer. At this point
2604 * udev becomes globally accessible, although presumably
2605 * no one will look at it until hdev is unlocked.
2606 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 status = 0;
2608
2609 /* We mustn't add new devices if the parent hub has
2610 * been disconnected; we would race with the
2611 * recursively_mark_NOTATTACHED() routine.
2612 */
2613 spin_lock_irq(&device_state_lock);
2614 if (hdev->state == USB_STATE_NOTATTACHED)
2615 status = -ENOTCONN;
2616 else
2617 hdev->children[port1-1] = udev;
2618 spin_unlock_irq(&device_state_lock);
2619
2620 /* Run it through the hoops (find a driver, etc) */
2621 if (!status) {
2622 status = usb_new_device(udev);
2623 if (status) {
2624 spin_lock_irq(&device_state_lock);
2625 hdev->children[port1-1] = NULL;
2626 spin_unlock_irq(&device_state_lock);
2627 }
2628 }
2629
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630 if (status)
2631 goto loop_disable;
2632
2633 status = hub_power_remaining(hub);
2634 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002635 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636
2637 return;
2638
2639loop_disable:
2640 hub_port_disable(hub, port1, 1);
2641loop:
2642 ep0_reinit(udev);
2643 release_address(udev);
2644 usb_put_dev(udev);
2645 if (status == -ENOTCONN)
2646 break;
2647 }
2648
2649done:
2650 hub_port_disable(hub, port1, 1);
2651}
2652
2653static void hub_events(void)
2654{
2655 struct list_head *tmp;
2656 struct usb_device *hdev;
2657 struct usb_interface *intf;
2658 struct usb_hub *hub;
2659 struct device *hub_dev;
2660 u16 hubstatus;
2661 u16 hubchange;
2662 u16 portstatus;
2663 u16 portchange;
2664 int i, ret;
2665 int connect_change;
2666
2667 /*
2668 * We restart the list every time to avoid a deadlock with
2669 * deleting hubs downstream from this one. This should be
2670 * safe since we delete the hub from the event list.
2671 * Not the most efficient, but avoids deadlocks.
2672 */
2673 while (1) {
2674
2675 /* Grab the first entry at the beginning of the list */
2676 spin_lock_irq(&hub_event_lock);
2677 if (list_empty(&hub_event_list)) {
2678 spin_unlock_irq(&hub_event_lock);
2679 break;
2680 }
2681
2682 tmp = hub_event_list.next;
2683 list_del_init(tmp);
2684
2685 hub = list_entry(tmp, struct usb_hub, event_list);
2686 hdev = hub->hdev;
2687 intf = to_usb_interface(hub->intfdev);
2688 hub_dev = &intf->dev;
2689
David Brownell979d5192005-09-22 22:32:24 -07002690 i = hub->resume_root_hub;
2691
2692 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 hdev->state, hub->descriptor
2694 ? hub->descriptor->bNbrPorts
2695 : 0,
2696 /* NOTE: expects max 15 ports... */
2697 (u16) hub->change_bits[0],
David Brownell979d5192005-09-22 22:32:24 -07002698 (u16) hub->event_bits[0],
2699 i ? ", resume root" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700
2701 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 spin_unlock_irq(&hub_event_lock);
2703
David Brownell979d5192005-09-22 22:32:24 -07002704 /* Is this is a root hub wanting to reactivate the downstream
2705 * ports? If so, be sure the interface resumes even if its
2706 * stub "device" node was never suspended.
2707 */
2708 if (i) {
David Brownell979d5192005-09-22 22:32:24 -07002709 dpm_runtime_resume(&hdev->dev);
2710 dpm_runtime_resume(&intf->dev);
Alan Stern2425e9f2005-11-29 12:13:31 -05002711 usb_put_intf(intf);
2712 continue;
David Brownell979d5192005-09-22 22:32:24 -07002713 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714
2715 /* Lock the device, then check to see if we were
2716 * disconnected while waiting for the lock to succeed. */
2717 if (locktree(hdev) < 0) {
2718 usb_put_intf(intf);
2719 continue;
2720 }
2721 if (hub != usb_get_intfdata(intf))
2722 goto loop;
2723
2724 /* If the hub has died, clean up after it */
2725 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7d069b72005-11-18 12:06:34 -05002726 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 goto loop;
2728 }
2729
2730 /* If this is an inactive or suspended hub, do nothing */
2731 if (hub->quiescing)
2732 goto loop;
2733
2734 if (hub->error) {
2735 dev_dbg (hub_dev, "resetting for error %d\n",
2736 hub->error);
2737
2738 ret = usb_reset_device(hdev);
2739 if (ret) {
2740 dev_dbg (hub_dev,
2741 "error resetting hub: %d\n", ret);
2742 goto loop;
2743 }
2744
2745 hub->nerrors = 0;
2746 hub->error = 0;
2747 }
2748
2749 /* deal with port status changes */
2750 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2751 if (test_bit(i, hub->busy_bits))
2752 continue;
2753 connect_change = test_bit(i, hub->change_bits);
2754 if (!test_and_clear_bit(i, hub->event_bits) &&
2755 !connect_change && !hub->activating)
2756 continue;
2757
2758 ret = hub_port_status(hub, i,
2759 &portstatus, &portchange);
2760 if (ret < 0)
2761 continue;
2762
2763 if (hub->activating && !hdev->children[i-1] &&
2764 (portstatus &
2765 USB_PORT_STAT_CONNECTION))
2766 connect_change = 1;
2767
2768 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2769 clear_port_feature(hdev, i,
2770 USB_PORT_FEAT_C_CONNECTION);
2771 connect_change = 1;
2772 }
2773
2774 if (portchange & USB_PORT_STAT_C_ENABLE) {
2775 if (!connect_change)
2776 dev_dbg (hub_dev,
2777 "port %d enable change, "
2778 "status %08x\n",
2779 i, portstatus);
2780 clear_port_feature(hdev, i,
2781 USB_PORT_FEAT_C_ENABLE);
2782
2783 /*
2784 * EM interference sometimes causes badly
2785 * shielded USB devices to be shutdown by
2786 * the hub, this hack enables them again.
2787 * Works at least with mouse driver.
2788 */
2789 if (!(portstatus & USB_PORT_STAT_ENABLE)
2790 && !connect_change
2791 && hdev->children[i-1]) {
2792 dev_err (hub_dev,
2793 "port %i "
2794 "disabled by hub (EMI?), "
2795 "re-enabling...\n",
2796 i);
2797 connect_change = 1;
2798 }
2799 }
2800
2801 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2802 clear_port_feature(hdev, i,
2803 USB_PORT_FEAT_C_SUSPEND);
2804 if (hdev->children[i-1]) {
2805 ret = remote_wakeup(hdev->
2806 children[i-1]);
2807 if (ret < 0)
2808 connect_change = 1;
2809 } else {
2810 ret = -ENODEV;
2811 hub_port_disable(hub, i, 1);
2812 }
2813 dev_dbg (hub_dev,
2814 "resume on port %d, status %d\n",
2815 i, ret);
2816 }
2817
2818 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2819 dev_err (hub_dev,
2820 "over-current change on port %d\n",
2821 i);
2822 clear_port_feature(hdev, i,
2823 USB_PORT_FEAT_C_OVER_CURRENT);
2824 hub_power_on(hub);
2825 }
2826
2827 if (portchange & USB_PORT_STAT_C_RESET) {
2828 dev_dbg (hub_dev,
2829 "reset change on port %d\n",
2830 i);
2831 clear_port_feature(hdev, i,
2832 USB_PORT_FEAT_C_RESET);
2833 }
2834
2835 if (connect_change)
2836 hub_port_connect_change(hub, i,
2837 portstatus, portchange);
2838 } /* end for i */
2839
2840 /* deal with hub status changes */
2841 if (test_and_clear_bit(0, hub->event_bits) == 0)
2842 ; /* do nothing */
2843 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2844 dev_err (hub_dev, "get_hub_status failed\n");
2845 else {
2846 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2847 dev_dbg (hub_dev, "power change\n");
2848 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002849 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2850 /* FIXME: Is this always true? */
2851 hub->limited_power = 0;
2852 else
2853 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002854 }
2855 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2856 dev_dbg (hub_dev, "overcurrent change\n");
2857 msleep(500); /* Cool down */
2858 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2859 hub_power_on(hub);
2860 }
2861 }
2862
2863 hub->activating = 0;
2864
Alan Sternd5926ae72005-04-21 15:56:37 -04002865 /* If this is a root hub, tell the HCD it's okay to
2866 * re-enable port-change interrupts now. */
2867 if (!hdev->parent)
2868 usb_enable_root_hub_irq(hdev->bus);
2869
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870loop:
2871 usb_unlock_device(hdev);
2872 usb_put_intf(intf);
2873
2874 } /* end while (1) */
2875}
2876
2877static int hub_thread(void *__unused)
2878{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 do {
2880 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002881 wait_event_interruptible(khubd_wait,
2882 !list_empty(&hub_event_list) ||
2883 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002884 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002885 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002887 pr_debug("%s: khubd exiting\n", usbcore_name);
2888 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889}
2890
2891static struct usb_device_id hub_id_table [] = {
2892 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2893 .bDeviceClass = USB_CLASS_HUB},
2894 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2895 .bInterfaceClass = USB_CLASS_HUB},
2896 { } /* Terminating entry */
2897};
2898
2899MODULE_DEVICE_TABLE (usb, hub_id_table);
2900
2901static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 .name = "hub",
2903 .probe = hub_probe,
2904 .disconnect = hub_disconnect,
2905 .suspend = hub_suspend,
2906 .resume = hub_resume,
2907 .ioctl = hub_ioctl,
2908 .id_table = hub_id_table,
2909};
2910
2911int usb_hub_init(void)
2912{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913 if (usb_register(&hub_driver) < 0) {
2914 printk(KERN_ERR "%s: can't register hub driver\n",
2915 usbcore_name);
2916 return -1;
2917 }
2918
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002919 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2920 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922
2923 /* Fall through if kernel_thread failed */
2924 usb_deregister(&hub_driver);
2925 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2926
2927 return -1;
2928}
2929
2930void usb_hub_cleanup(void)
2931{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002932 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933
2934 /*
2935 * Hub resources are freed for us by usb_deregister. It calls
2936 * usb_driver_purge on every device which in turn calls that
2937 * devices disconnect function if it is using this driver.
2938 * The hub_disconnect function takes care of releasing the
2939 * individual hub resources. -greg
2940 */
2941 usb_deregister(&hub_driver);
2942} /* usb_hub_cleanup() */
2943
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944static int config_descriptors_changed(struct usb_device *udev)
2945{
2946 unsigned index;
2947 unsigned len = 0;
2948 struct usb_config_descriptor *buf;
2949
2950 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2951 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2952 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2953 }
2954 buf = kmalloc (len, SLAB_KERNEL);
2955 if (buf == NULL) {
2956 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2957 /* assume the worst */
2958 return 1;
2959 }
2960 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2961 int length;
2962 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2963
2964 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2965 old_length);
2966 if (length < old_length) {
2967 dev_dbg(&udev->dev, "config index %d, error %d\n",
2968 index, length);
2969 break;
2970 }
2971 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2972 != 0) {
2973 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2974 index, buf->bConfigurationValue);
2975 break;
2976 }
2977 }
2978 kfree(buf);
2979 return index != udev->descriptor.bNumConfigurations;
2980}
2981
2982/**
2983 * usb_reset_device - perform a USB port reset to reinitialize a device
2984 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2985 *
2986 * WARNING - don't reset any device unless drivers for all of its
2987 * interfaces are expecting that reset! Maybe some driver->reset()
2988 * method should eventually help ensure sufficient cooperation.
2989 *
2990 * Do a port reset, reassign the device's address, and establish its
2991 * former operating configuration. If the reset fails, or the device's
2992 * descriptors change from their values before the reset, or the original
2993 * configuration and altsettings cannot be restored, a flag will be set
2994 * telling khubd to pretend the device has been disconnected and then
2995 * re-connected. All drivers will be unbound, and the device will be
2996 * re-enumerated and probed all over again.
2997 *
2998 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2999 * flagged for logical disconnection, or some other negative error code
3000 * if the reset wasn't even attempted.
3001 *
3002 * The caller must own the device lock. For example, it's safe to use
3003 * this from a driver probe() routine after downloading new firmware.
3004 * For calls that might not occur during probe(), drivers should lock
3005 * the device using usb_lock_device_for_reset().
3006 */
3007int usb_reset_device(struct usb_device *udev)
3008{
3009 struct usb_device *parent_hdev = udev->parent;
3010 struct usb_hub *parent_hub;
3011 struct usb_device_descriptor descriptor = udev->descriptor;
3012 struct usb_hub *hub = NULL;
Alan Stern12c3da32005-11-23 12:09:52 -05003013 int i, ret = 0;
3014 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015
3016 if (udev->state == USB_STATE_NOTATTACHED ||
3017 udev->state == USB_STATE_SUSPENDED) {
3018 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3019 udev->state);
3020 return -EINVAL;
3021 }
3022
3023 if (!parent_hdev) {
3024 /* this requires hcd-specific logic; see OHCI hc_restart() */
3025 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3026 return -EISDIR;
3027 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028 parent_hub = hdev_to_hub(parent_hdev);
3029
3030 /* If we're resetting an active hub, take some special actions */
Alan Stern6aa35672006-03-08 15:14:09 -05003031 if (udev->actconfig && udev->actconfig->desc.bNumInterfaces > 0 &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 udev->actconfig->interface[0]->dev.driver ==
3033 &hub_driver.driver &&
3034 (hub = hdev_to_hub(udev)) != NULL) {
Alan Stern7d069b72005-11-18 12:06:34 -05003035 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036 }
3037
3038 set_bit(port1, parent_hub->busy_bits);
3039 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3040
3041 /* ep0 maxpacket size may change; let the HCD know about it.
3042 * Other endpoints will be handled by re-enumeration. */
3043 ep0_reinit(udev);
3044 ret = hub_port_init(parent_hub, udev, port1, i);
3045 if (ret >= 0)
3046 break;
3047 }
3048 clear_bit(port1, parent_hub->busy_bits);
3049 if (ret < 0)
3050 goto re_enumerate;
3051
3052 /* Device might have changed firmware (DFU or similar) */
3053 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3054 || config_descriptors_changed (udev)) {
3055 dev_info(&udev->dev, "device firmware changed\n");
3056 udev->descriptor = descriptor; /* for disconnect() calls */
3057 goto re_enumerate;
3058 }
3059
3060 if (!udev->actconfig)
3061 goto done;
3062
3063 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3064 USB_REQ_SET_CONFIGURATION, 0,
3065 udev->actconfig->desc.bConfigurationValue, 0,
3066 NULL, 0, USB_CTRL_SET_TIMEOUT);
3067 if (ret < 0) {
3068 dev_err(&udev->dev,
3069 "can't restore configuration #%d (error=%d)\n",
3070 udev->actconfig->desc.bConfigurationValue, ret);
3071 goto re_enumerate;
3072 }
3073 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3074
3075 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3076 struct usb_interface *intf = udev->actconfig->interface[i];
3077 struct usb_interface_descriptor *desc;
3078
3079 /* set_interface resets host side toggle even
3080 * for altsetting zero. the interface may have no driver.
3081 */
3082 desc = &intf->cur_altsetting->desc;
3083 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3084 desc->bAlternateSetting);
3085 if (ret < 0) {
3086 dev_err(&udev->dev, "failed to restore interface %d "
3087 "altsetting %d (error=%d)\n",
3088 desc->bInterfaceNumber,
3089 desc->bAlternateSetting,
3090 ret);
3091 goto re_enumerate;
3092 }
3093 }
3094
3095done:
3096 if (hub)
3097 hub_post_reset(hub);
3098 return 0;
3099
3100re_enumerate:
3101 hub_port_logical_disconnect(parent_hub, port1);
3102 return -ENODEV;
3103}