blob: 7dd28f8e1cea3b7ffa1a2fb9547b19f2b28fa675 [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++)) {
1182 struct usb_interface_descriptor *desc =
1183 &c->intf_cache[0]->altsetting->desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Alan Stern55c52712005-11-23 12:03:12 -05001185 /*
1186 * HP's USB bus-powered keyboard has only one configuration
1187 * and it claims to be self-powered; other devices may have
1188 * similar errors in their descriptors. If the next test
1189 * were allowed to execute, such configurations would always
1190 * be rejected and the devices would not work as expected.
1191 */
1192#if 0
1193 /* Rule out self-powered configs for a bus-powered device */
1194 if (bus_powered && (c->desc.bmAttributes &
1195 USB_CONFIG_ATT_SELFPOWER))
1196 continue;
1197#endif
1198
1199 /*
1200 * The next test may not be as effective as it should be.
1201 * Some hubs have errors in their descriptor, claiming
1202 * to be self-powered when they are really bus-powered.
1203 * We will overestimate the amount of current such hubs
1204 * make available for each port.
1205 *
1206 * This is a fairly benign sort of failure. It won't
1207 * cause us to reject configurations that we should have
1208 * accepted.
1209 */
1210
1211 /* Rule out configs that draw too much bus current */
1212 if (c->desc.bMaxPower * 2 > udev->bus_mA)
1213 continue;
1214
1215 /* If the first config's first interface is COMM/2/0xff
1216 * (MSFT RNDIS), rule it out unless Linux has host-side
1217 * RNDIS support. */
1218 if (i == 0 && desc->bInterfaceClass == USB_CLASS_COMM
1219 && desc->bInterfaceSubClass == 2
1220 && desc->bInterfaceProtocol == 0xff) {
1221#ifndef CONFIG_USB_NET_RNDIS
1222 continue;
1223#else
1224 best = c;
1225#endif
1226 }
1227
1228 /* From the remaining configs, choose the first one whose
1229 * first interface is for a non-vendor-specific class.
1230 * Reason: Linux is more likely to have a class driver
1231 * than a vendor-specific driver. */
1232 else if (udev->descriptor.bDeviceClass !=
1233 USB_CLASS_VENDOR_SPEC &&
1234 desc->bInterfaceClass !=
1235 USB_CLASS_VENDOR_SPEC) {
1236 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 break;
1238 }
Alan Stern55c52712005-11-23 12:03:12 -05001239
1240 /* If all the remaining configs are vendor-specific,
1241 * choose the first one. */
1242 else if (!best)
1243 best = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 }
Alan Stern55c52712005-11-23 12:03:12 -05001245
1246 if (best) {
1247 i = best->desc.bConfigurationValue;
1248 dev_info(&udev->dev,
1249 "configuration #%d chosen from %d choice%s\n",
1250 i, num_configs, plural(num_configs));
1251 } else {
1252 i = -1;
1253 dev_warn(&udev->dev,
1254 "no configuration chosen from %d choice%s\n",
1255 num_configs, plural(num_configs));
1256 }
1257 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258}
1259
1260#ifdef DEBUG
1261static void show_string(struct usb_device *udev, char *id, char *string)
1262{
1263 if (!string)
1264 return;
1265 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1266}
1267
1268#else
1269static inline void show_string(struct usb_device *udev, char *id, char *string)
1270{}
1271#endif
1272
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
1274#ifdef CONFIG_USB_OTG
1275#include "otg_whitelist.h"
1276#endif
1277
1278/**
1279 * usb_new_device - perform initial device setup (usbcore-internal)
1280 * @udev: newly addressed device (in ADDRESS state)
1281 *
1282 * This is called with devices which have been enumerated, but not yet
1283 * configured. The device descriptor is available, but not descriptors
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001284 * for any device configuration. The caller must have locked either
1285 * the parent hub (if udev is a normal device) or else the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1287 * udev has already been installed, but udev is not yet visible through
1288 * sysfs or other filesystem code.
1289 *
1290 * Returns 0 for success (device is configured and listed, with its
1291 * interfaces, in sysfs); else a negative errno value.
1292 *
1293 * This call is synchronous, and may not be used in an interrupt context.
1294 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001295 * Only the hub driver or root-hub registrar should ever call this.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 */
1297int usb_new_device(struct usb_device *udev)
1298{
1299 int err;
1300 int c;
1301
1302 err = usb_get_configuration(udev);
1303 if (err < 0) {
1304 dev_err(&udev->dev, "can't read configurations, error %d\n",
1305 err);
1306 goto fail;
1307 }
1308
1309 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001310 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1311 udev->manufacturer = usb_cache_string(udev,
1312 udev->descriptor.iManufacturer);
1313 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314
1315 /* Tell the world! */
1316 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1317 "SerialNumber=%d\n",
1318 udev->descriptor.iManufacturer,
1319 udev->descriptor.iProduct,
1320 udev->descriptor.iSerialNumber);
1321 show_string(udev, "Product", udev->product);
1322 show_string(udev, "Manufacturer", udev->manufacturer);
1323 show_string(udev, "SerialNumber", udev->serial);
1324
1325#ifdef CONFIG_USB_OTG
1326 /*
1327 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1328 * to wake us after we've powered off VBUS; and HNP, switching roles
1329 * "host" to "peripheral". The OTG descriptor helps figure this out.
1330 */
1331 if (!udev->bus->is_b_host
1332 && udev->config
1333 && udev->parent == udev->bus->root_hub) {
1334 struct usb_otg_descriptor *desc = 0;
1335 struct usb_bus *bus = udev->bus;
1336
1337 /* descriptor may appear anywhere in config */
1338 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1339 le16_to_cpu(udev->config[0].desc.wTotalLength),
1340 USB_DT_OTG, (void **) &desc) == 0) {
1341 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001342 unsigned port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 struct usb_device *root = udev->parent;
1344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 dev_info(&udev->dev,
1346 "Dual-Role OTG device on %sHNP port\n",
1347 (port1 == bus->otg_port)
1348 ? "" : "non-");
1349
1350 /* enable HNP before suspend, it's simpler */
1351 if (port1 == bus->otg_port)
1352 bus->b_hnp_enable = 1;
1353 err = usb_control_msg(udev,
1354 usb_sndctrlpipe(udev, 0),
1355 USB_REQ_SET_FEATURE, 0,
1356 bus->b_hnp_enable
1357 ? USB_DEVICE_B_HNP_ENABLE
1358 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1359 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1360 if (err < 0) {
1361 /* OTG MESSAGE: report errors here,
1362 * customize to match your product.
1363 */
1364 dev_info(&udev->dev,
1365 "can't set HNP mode; %d\n",
1366 err);
1367 bus->b_hnp_enable = 0;
1368 }
1369 }
1370 }
1371 }
1372
1373 if (!is_targeted(udev)) {
1374
1375 /* Maybe it can talk to us, though we can't talk to it.
1376 * (Includes HNP test device.)
1377 */
1378 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell390a8c32005-09-13 19:57:27 -07001379 static int __usb_suspend_device(struct usb_device *,
1380 int port1);
1381 err = __usb_suspend_device(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 if (err < 0)
1383 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1384 }
1385 err = -ENODEV;
1386 goto fail;
1387 }
1388#endif
1389
1390 /* put device-specific files into sysfs */
1391 err = device_add (&udev->dev);
1392 if (err) {
1393 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1394 goto fail;
1395 }
1396 usb_create_sysfs_dev_files (udev);
1397
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001398 usb_lock_device(udev);
1399
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 /* choose and set the configuration. that registers the interfaces
1401 * with the driver core, and lets usb device drivers bind to them.
1402 */
1403 c = choose_configuration(udev);
Alan Stern55c52712005-11-23 12:03:12 -05001404 if (c >= 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 err = usb_set_configuration(udev, c);
1406 if (err) {
1407 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1408 c, err);
Alan Stern55c52712005-11-23 12:03:12 -05001409 /* This need not be fatal. The user can try to
1410 * set other configurations. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 }
1412 }
1413
1414 /* USB device state == configured ... usable */
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001415 usb_notify_add_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001417 usb_unlock_device(udev);
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 return 0;
1420
1421fail:
1422 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1423 return err;
1424}
1425
1426
1427static int hub_port_status(struct usb_hub *hub, int port1,
1428 u16 *status, u16 *change)
1429{
1430 int ret;
1431
1432 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1433 if (ret < 0)
1434 dev_err (hub->intfdev,
1435 "%s failed (err = %d)\n", __FUNCTION__, ret);
1436 else {
1437 *status = le16_to_cpu(hub->status->port.wPortStatus);
1438 *change = le16_to_cpu(hub->status->port.wPortChange);
1439 ret = 0;
1440 }
1441 return ret;
1442}
1443
1444#define PORT_RESET_TRIES 5
1445#define SET_ADDRESS_TRIES 2
1446#define GET_DESCRIPTOR_TRIES 2
1447#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1448#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1449
1450#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1451#define HUB_SHORT_RESET_TIME 10
1452#define HUB_LONG_RESET_TIME 200
1453#define HUB_RESET_TIMEOUT 500
1454
1455static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1456 struct usb_device *udev, unsigned int delay)
1457{
1458 int delay_time, ret;
1459 u16 portstatus;
1460 u16 portchange;
1461
1462 for (delay_time = 0;
1463 delay_time < HUB_RESET_TIMEOUT;
1464 delay_time += delay) {
1465 /* wait to give the device a chance to reset */
1466 msleep(delay);
1467
1468 /* read and decode port status */
1469 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1470 if (ret < 0)
1471 return ret;
1472
1473 /* Device went away? */
1474 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1475 return -ENOTCONN;
1476
1477 /* bomb out completely if something weird happened */
1478 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1479 return -EINVAL;
1480
1481 /* if we`ve finished resetting, then break out of the loop */
1482 if (!(portstatus & USB_PORT_STAT_RESET) &&
1483 (portstatus & USB_PORT_STAT_ENABLE)) {
1484 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1485 udev->speed = USB_SPEED_HIGH;
1486 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1487 udev->speed = USB_SPEED_LOW;
1488 else
1489 udev->speed = USB_SPEED_FULL;
1490 return 0;
1491 }
1492
1493 /* switch to the long delay after two short delay failures */
1494 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1495 delay = HUB_LONG_RESET_TIME;
1496
1497 dev_dbg (hub->intfdev,
1498 "port %d not reset yet, waiting %dms\n",
1499 port1, delay);
1500 }
1501
1502 return -EBUSY;
1503}
1504
1505static int hub_port_reset(struct usb_hub *hub, int port1,
1506 struct usb_device *udev, unsigned int delay)
1507{
1508 int i, status;
1509
1510 /* Reset the port */
1511 for (i = 0; i < PORT_RESET_TRIES; i++) {
1512 status = set_port_feature(hub->hdev,
1513 port1, USB_PORT_FEAT_RESET);
1514 if (status)
1515 dev_err(hub->intfdev,
1516 "cannot reset port %d (err = %d)\n",
1517 port1, status);
1518 else {
1519 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001520 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 dev_dbg(hub->intfdev,
1522 "port_wait_reset: err = %d\n",
1523 status);
1524 }
1525
1526 /* return on disconnect or reset */
1527 switch (status) {
1528 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001529 /* TRSTRCY = 10 ms; plus some extra */
1530 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 /* FALL THROUGH */
1532 case -ENOTCONN:
1533 case -ENODEV:
1534 clear_port_feature(hub->hdev,
1535 port1, USB_PORT_FEAT_C_RESET);
1536 /* FIXME need disconnect() for NOTATTACHED device */
1537 usb_set_device_state(udev, status
1538 ? USB_STATE_NOTATTACHED
1539 : USB_STATE_DEFAULT);
1540 return status;
1541 }
1542
1543 dev_dbg (hub->intfdev,
1544 "port %d not enabled, trying reset again...\n",
1545 port1);
1546 delay = HUB_LONG_RESET_TIME;
1547 }
1548
1549 dev_err (hub->intfdev,
1550 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1551 port1);
1552
1553 return status;
1554}
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556/*
1557 * Disable a port and mark a logical connnect-change event, so that some
1558 * time later khubd will disconnect() any existing usb_device on the port
1559 * and will re-enumerate if there actually is a device attached.
1560 */
1561static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1562{
1563 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1564 hub_port_disable(hub, port1, 1);
1565
1566 /* FIXME let caller ask to power down the port:
1567 * - some devices won't enumerate without a VBUS power cycle
1568 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001569 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 * That's easy if this hub can switch power per-port, and
1571 * khubd reactivates the port later (timer, SRP, etc).
1572 * Powerdown must be optional, because of reset/DFU.
1573 */
1574
1575 set_bit(port1, hub->change_bits);
1576 kick_khubd(hub);
1577}
1578
1579
1580#ifdef CONFIG_USB_SUSPEND
1581
1582/*
1583 * Selective port suspend reduces power; most suspended devices draw
1584 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1585 * All devices below the suspended port are also suspended.
1586 *
1587 * Devices leave suspend state when the host wakes them up. Some devices
1588 * also support "remote wakeup", where the device can activate the USB
1589 * tree above them to deliver data, such as a keypress or packet. In
1590 * some cases, this wakes the USB host.
1591 */
1592static int hub_port_suspend(struct usb_hub *hub, int port1,
1593 struct usb_device *udev)
1594{
1595 int status;
1596
1597 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1598
1599 /* enable remote wakeup when appropriate; this lets the device
1600 * wake up the upstream hub (including maybe the root hub).
1601 *
1602 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1603 * we don't explicitly enable it here.
1604 */
David Brownellb94dc6b2005-09-12 19:39:39 -07001605 if (device_may_wakeup(&udev->dev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1607 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1608 USB_DEVICE_REMOTE_WAKEUP, 0,
1609 NULL, 0,
1610 USB_CTRL_SET_TIMEOUT);
1611 if (status)
1612 dev_dbg(&udev->dev,
1613 "won't remote wakeup, status %d\n",
1614 status);
1615 }
1616
1617 /* see 7.1.7.6 */
1618 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1619 if (status) {
1620 dev_dbg(hub->intfdev,
1621 "can't suspend port %d, status %d\n",
1622 port1, status);
1623 /* paranoia: "should not happen" */
1624 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1625 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1626 USB_DEVICE_REMOTE_WAKEUP, 0,
1627 NULL, 0,
1628 USB_CTRL_SET_TIMEOUT);
1629 } else {
1630 /* device has up to 10 msec to fully suspend */
1631 dev_dbg(&udev->dev, "usb suspend\n");
1632 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1633 msleep(10);
1634 }
1635 return status;
1636}
1637
1638/*
1639 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001640 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 * State transitions include:
1642 *
1643 * - suspend, resume ... when the VBUS power link stays live
1644 * - suspend, disconnect ... VBUS lost
1645 *
1646 * Once VBUS drop breaks the circuit, the port it's using has to go through
1647 * normal re-enumeration procedures, starting with enabling VBUS power.
1648 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1649 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1650 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001651 *
1652 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1653 * the root hub for their bus goes into global suspend ... so we don't
1654 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 */
David Brownell390a8c32005-09-13 19:57:27 -07001656static int __usb_suspend_device (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657{
David Brownellf3f32532005-09-22 22:37:29 -07001658 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 /* caller owns the udev device lock */
1661 if (port1 < 0)
1662 return port1;
1663
1664 if (udev->state == USB_STATE_SUSPENDED
1665 || udev->state == USB_STATE_NOTATTACHED) {
1666 return 0;
1667 }
1668
David Brownellc9f89fa2005-09-13 19:57:04 -07001669 /* all interfaces must already be suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 if (udev->actconfig) {
1671 int i;
1672
1673 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1674 struct usb_interface *intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
1676 intf = udev->actconfig->interface[i];
David Brownellc9f89fa2005-09-13 19:57:04 -07001677 if (is_active(intf)) {
1678 dev_dbg(&intf->dev, "nyet suspended\n");
1679 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
1681 }
1682 }
1683
David Brownellf3f32532005-09-22 22:37:29 -07001684 /* we only change a device's upstream USB link.
1685 * root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 */
David Brownellf3f32532005-09-22 22:37:29 -07001687 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1689 udev);
1690
1691 if (status == 0)
David Brownell390a8c32005-09-13 19:57:27 -07001692 udev->dev.power.power_state = PMSG_SUSPEND;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 return status;
1694}
1695
David Brownellf3f32532005-09-22 22:37:29 -07001696#endif
1697
David Brownell5edbfb72005-09-22 22:45:26 -07001698/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 * usb_suspend_device - suspend a usb device
1700 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001701 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 *
1703 * Suspends a USB device that isn't in active use, conserving power.
1704 * Devices may wake out of a suspend, if anything important happens,
1705 * using the remote wakeup mechanism. They may also be taken out of
1706 * suspend by the host, using usb_resume_device(). It's also routine
1707 * to disconnect devices while they are suspended.
1708 *
David Brownell390a8c32005-09-13 19:57:27 -07001709 * This only affects the USB hardware for a device; its interfaces
1710 * (and, for hubs, child devices) must already have been suspended.
1711 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 * Suspending OTG devices may trigger HNP, if that's been enabled
1713 * between a pair of dual-role devices. That will change roles, such
1714 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1715 *
1716 * Returns 0 on success, else negative errno.
1717 */
David Brownell390a8c32005-09-13 19:57:27 -07001718int usb_suspend_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719{
David Brownellf3f32532005-09-22 22:37:29 -07001720#ifdef CONFIG_USB_SUSPEND
Alan Stern4bf0ba82005-11-21 11:58:07 -05001721 if (udev->state == USB_STATE_NOTATTACHED)
1722 return -ENODEV;
Alan Stern12c3da32005-11-23 12:09:52 -05001723 return __usb_suspend_device(udev, udev->portnum);
David Brownellf3f32532005-09-22 22:37:29 -07001724#else
1725 /* NOTE: udev->state unchanged, it's not lying ... */
1726 udev->dev.power.power_state = PMSG_SUSPEND;
1727 return 0;
1728#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729}
David Brownellf3f32532005-09-22 22:37:29 -07001730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731/*
David Brownell390a8c32005-09-13 19:57:27 -07001732 * If the USB "suspend" state is in use (rather than "global suspend"),
1733 * many devices will be individually taken out of suspend state using
1734 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 * hardware resume signaling is finished, either because of selective
1736 * resume (by host) or remote wakeup (by device) ... now see what changed
1737 * in the tree that's rooted at this device.
1738 */
David Brownellf3f32532005-09-22 22:37:29 -07001739static int finish_device_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740{
1741 int status;
1742 u16 devstatus;
1743
1744 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001745 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
1747 /* usb ch9 identifies four variants of SUSPENDED, based on what
1748 * state the device resumes to. Linux currently won't see the
1749 * first two on the host side; they'd be inside hub_port_init()
1750 * during many timeouts, but khubd can't suspend until later.
1751 */
1752 usb_set_device_state(udev, udev->actconfig
1753 ? USB_STATE_CONFIGURED
1754 : USB_STATE_ADDRESS);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001755 udev->dev.power.power_state = PMSG_ON;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757 /* 10.5.4.5 says be sure devices in the tree are still there.
1758 * For now let's assume the device didn't go crazy on resume,
1759 * and device drivers will know about any resume quirks.
1760 */
1761 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001762 if (status < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 dev_dbg(&udev->dev,
1764 "gone after usb resume? status %d\n",
1765 status);
1766 else if (udev->actconfig) {
1767 unsigned i;
David Brownelldbc38872005-09-13 19:57:36 -07001768 int (*resume)(struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
1770 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001771 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001772 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 status = usb_control_msg(udev,
1774 usb_sndctrlpipe(udev, 0),
1775 USB_REQ_CLEAR_FEATURE,
1776 USB_RECIP_DEVICE,
1777 USB_DEVICE_REMOTE_WAKEUP, 0,
1778 NULL, 0,
1779 USB_CTRL_SET_TIMEOUT);
1780 if (status) {
1781 dev_dbg(&udev->dev, "disable remote "
1782 "wakeup, status %d\n", status);
1783 status = 0;
1784 }
1785 }
1786
1787 /* resume interface drivers; if this is a hub, it
David Brownelldbc38872005-09-13 19:57:36 -07001788 * may have a child resume event to deal with soon
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 */
David Brownelldbc38872005-09-13 19:57:36 -07001790 resume = udev->dev.bus->resume;
Alan Stern4bf0ba82005-11-21 11:58:07 -05001791 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1792 struct device *dev =
1793 &udev->actconfig->interface[i]->dev;
1794
1795 down(&dev->sem);
1796 (void) resume(dev);
1797 up(&dev->sem);
1798 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 status = 0;
1800
1801 } else if (udev->devnum <= 0) {
1802 dev_dbg(&udev->dev, "bogus resume!\n");
1803 status = -EINVAL;
1804 }
1805 return status;
1806}
1807
David Brownellf3f32532005-09-22 22:37:29 -07001808#ifdef CONFIG_USB_SUSPEND
1809
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810static int
1811hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1812{
1813 int status;
1814
1815 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1816
1817 /* see 7.1.7.7; affects power usage, but not budgeting */
1818 status = clear_port_feature(hub->hdev,
1819 port1, USB_PORT_FEAT_SUSPEND);
1820 if (status) {
1821 dev_dbg(hub->intfdev,
1822 "can't resume port %d, status %d\n",
1823 port1, status);
1824 } else {
1825 u16 devstatus;
1826 u16 portchange;
1827
1828 /* drive resume for at least 20 msec */
1829 if (udev)
1830 dev_dbg(&udev->dev, "RESUME\n");
1831 msleep(25);
1832
1833#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1834 | USB_PORT_STAT_ENABLE \
1835 | USB_PORT_STAT_CONNECTION)
1836
1837 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1838 * stop resume signaling. Then finish the resume
1839 * sequence.
1840 */
1841 devstatus = portchange = 0;
1842 status = hub_port_status(hub, port1,
1843 &devstatus, &portchange);
1844 if (status < 0
1845 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1846 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1847 ) {
1848 dev_dbg(hub->intfdev,
1849 "port %d status %04x.%04x after resume, %d\n",
1850 port1, portchange, devstatus, status);
1851 } else {
1852 /* TRSMRCY = 10 msec */
1853 msleep(10);
1854 if (udev)
David Brownellf3f32532005-09-22 22:37:29 -07001855 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 }
1857 }
1858 if (status < 0)
1859 hub_port_logical_disconnect(hub, port1);
1860
1861 return status;
1862}
1863
David Brownellf3f32532005-09-22 22:37:29 -07001864#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
David Brownell5edbfb72005-09-22 22:45:26 -07001866/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 * usb_resume_device - re-activate a suspended usb device
1868 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001869 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 *
1871 * This will re-activate the suspended device, increasing power usage
1872 * while letting drivers communicate again with its endpoints.
1873 * USB resume explicitly guarantees that the power session between
1874 * the host and the device is the same as it was when the device
1875 * suspended.
1876 *
1877 * Returns 0 on success, else negative errno.
1878 */
1879int usb_resume_device(struct usb_device *udev)
1880{
Alan Stern12c3da32005-11-23 12:09:52 -05001881 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882
Alan Stern4bf0ba82005-11-21 11:58:07 -05001883 if (udev->state == USB_STATE_NOTATTACHED)
1884 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
David Brownellf3f32532005-09-22 22:37:29 -07001886 /* selective resume of one downstream hub-to-device port */
1887 if (udev->parent) {
David Brownellfb669cc2006-01-24 08:40:27 -08001888#ifdef CONFIG_USB_SUSPEND
David Brownellf3f32532005-09-22 22:37:29 -07001889 if (udev->state == USB_STATE_SUSPENDED) {
1890 // NOTE swsusp may bork us, device state being wrong...
1891 // NOTE this fails if parent is also suspended...
1892 status = hub_port_resume(hdev_to_hub(udev->parent),
Alan Stern12c3da32005-11-23 12:09:52 -05001893 udev->portnum, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 } else
David Brownellf3f32532005-09-22 22:37:29 -07001895#endif
Alan Stern43c5d5a2006-02-01 10:47:11 -05001896 status = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001897 } else
David Brownellf3f32532005-09-22 22:37:29 -07001898 status = finish_device_resume(udev);
1899 if (status < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 dev_dbg(&udev->dev, "can't resume, status %d\n",
1901 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 /* rebind drivers that had no suspend() */
Alan Stern4bf0ba82005-11-21 11:58:07 -05001904 if (status == 0) {
1905 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 bus_rescan_devices(&usb_bus_type);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001907 usb_lock_device(udev);
1908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 return status;
1910}
1911
1912static int remote_wakeup(struct usb_device *udev)
1913{
1914 int status = 0;
1915
David Brownellf3f32532005-09-22 22:37:29 -07001916#ifdef CONFIG_USB_SUSPEND
1917
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 /* don't repeat RESUME sequence if this device
1919 * was already woken up by some other task
1920 */
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001921 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 if (udev->state == USB_STATE_SUSPENDED) {
1923 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1924 /* TRSMRCY = 10 msec */
1925 msleep(10);
David Brownellf3f32532005-09-22 22:37:29 -07001926 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001928 usb_unlock_device(udev);
David Brownellf3f32532005-09-22 22:37:29 -07001929#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 return status;
1931}
1932
David Brownelldb690872005-09-13 19:56:33 -07001933static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934{
1935 struct usb_hub *hub = usb_get_intfdata (intf);
1936 struct usb_device *hdev = hub->hdev;
1937 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
David Brownellc9f89fa2005-09-13 19:57:04 -07001939 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1941 struct usb_device *udev;
1942
1943 udev = hdev->children [port1-1];
David Brownellf3f32532005-09-22 22:37:29 -07001944 if (udev && (udev->dev.power.power_state.event
1945 == PM_EVENT_ON
1946#ifdef CONFIG_USB_SUSPEND
1947 || udev->state != USB_STATE_SUSPENDED
1948#endif
1949 )) {
David Brownellc9f89fa2005-09-13 19:57:04 -07001950 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1951 return -EBUSY;
1952 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 }
1954
David Brownellf3f32532005-09-22 22:37:29 -07001955 /* "global suspend" of the downstream HC-to-USB interface */
1956 if (!hdev->parent) {
1957 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001958 if (bus) {
1959 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001960
1961 if (status != 0) {
1962 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1963 status);
1964 return status;
1965 }
1966 } else
1967 return -EOPNOTSUPP;
1968 }
1969
David Brownellc9f89fa2005-09-13 19:57:04 -07001970 /* stop khubd and related activity */
1971 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 return 0;
1973}
1974
1975static int hub_resume(struct usb_interface *intf)
1976{
1977 struct usb_device *hdev = interface_to_usbdev(intf);
1978 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 int status;
1980
David Brownellf3f32532005-09-22 22:37:29 -07001981 /* "global resume" of the downstream HC-to-USB interface */
1982 if (!hdev->parent) {
1983 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001984 if (bus) {
1985 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001986 if (status) {
1987 dev_dbg(&intf->dev, "'global' resume %d\n",
1988 status);
1989 return status;
1990 }
1991 } else
1992 return -EOPNOTSUPP;
1993 if (status == 0) {
1994 /* TRSMRCY = 10 msec */
1995 msleep(10);
1996 }
1997 }
1998
1999 hub_activate(hub);
2000
2001 /* REVISIT: this recursion probably shouldn't exist. Remove
2002 * this code sometime, after retesting with different root and
2003 * external hubs.
2004 */
2005#ifdef CONFIG_USB_SUSPEND
2006 {
2007 unsigned port1;
2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2010 struct usb_device *udev;
2011 u16 portstat, portchange;
2012
2013 udev = hdev->children [port1-1];
2014 status = hub_port_status(hub, port1, &portstat, &portchange);
2015 if (status == 0) {
2016 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2017 clear_port_feature(hdev, port1,
2018 USB_PORT_FEAT_C_SUSPEND);
2019 portchange &= ~USB_PORT_STAT_C_SUSPEND;
2020 }
2021
2022 /* let khubd handle disconnects etc */
2023 if (portchange)
2024 continue;
2025 }
2026
2027 if (!udev || status < 0)
2028 continue;
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002029 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 if (portstat & USB_PORT_STAT_SUSPEND)
2031 status = hub_port_resume(hub, port1, udev);
2032 else {
David Brownellf3f32532005-09-22 22:37:29 -07002033 status = finish_device_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 if (status < 0) {
2035 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2036 port1, status);
2037 hub_port_logical_disconnect(hub, port1);
2038 }
2039 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002040 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 }
David Brownellf3f32532005-09-22 22:37:29 -07002042 }
2043#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 return 0;
2045}
2046
David Brownell979d5192005-09-22 22:32:24 -07002047void usb_suspend_root_hub(struct usb_device *hdev)
2048{
2049 struct usb_hub *hub = hdev_to_hub(hdev);
2050
2051 /* This also makes any led blinker stop retriggering. We're called
2052 * from irq, so the blinker might still be scheduled. Caller promises
2053 * that the root hub status URB will be canceled.
2054 */
2055 __hub_quiesce(hub);
2056 mark_quiesced(to_usb_interface(hub->intfdev));
2057}
2058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059void usb_resume_root_hub(struct usb_device *hdev)
2060{
2061 struct usb_hub *hub = hdev_to_hub(hdev);
2062
2063 hub->resume_root_hub = 1;
2064 kick_khubd(hub);
2065}
2066
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
2068/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2069 *
2070 * Between connect detection and reset signaling there must be a delay
2071 * of 100ms at least for debounce and power-settling. The corresponding
2072 * timer shall restart whenever the downstream port detects a disconnect.
2073 *
2074 * Apparently there are some bluetooth and irda-dongles and a number of
2075 * low-speed devices for which this debounce period may last over a second.
2076 * Not covered by the spec - but easy to deal with.
2077 *
2078 * This implementation uses a 1500ms total debounce timeout; if the
2079 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2080 * every 25ms for transient disconnects. When the port status has been
2081 * unchanged for 100ms it returns the port status.
2082 */
2083
2084#define HUB_DEBOUNCE_TIMEOUT 1500
2085#define HUB_DEBOUNCE_STEP 25
2086#define HUB_DEBOUNCE_STABLE 100
2087
2088static int hub_port_debounce(struct usb_hub *hub, int port1)
2089{
2090 int ret;
2091 int total_time, stable_time = 0;
2092 u16 portchange, portstatus;
2093 unsigned connection = 0xffff;
2094
2095 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2096 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2097 if (ret < 0)
2098 return ret;
2099
2100 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2101 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2102 stable_time += HUB_DEBOUNCE_STEP;
2103 if (stable_time >= HUB_DEBOUNCE_STABLE)
2104 break;
2105 } else {
2106 stable_time = 0;
2107 connection = portstatus & USB_PORT_STAT_CONNECTION;
2108 }
2109
2110 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2111 clear_port_feature(hub->hdev, port1,
2112 USB_PORT_FEAT_C_CONNECTION);
2113 }
2114
2115 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2116 break;
2117 msleep(HUB_DEBOUNCE_STEP);
2118 }
2119
2120 dev_dbg (hub->intfdev,
2121 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2122 port1, total_time, stable_time, portstatus);
2123
2124 if (stable_time < HUB_DEBOUNCE_STABLE)
2125 return -ETIMEDOUT;
2126 return portstatus;
2127}
2128
2129static void ep0_reinit(struct usb_device *udev)
2130{
2131 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2132 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2133 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2134}
2135
2136#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2137#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2138
2139static int hub_set_address(struct usb_device *udev)
2140{
2141 int retval;
2142
2143 if (udev->devnum == 0)
2144 return -EINVAL;
2145 if (udev->state == USB_STATE_ADDRESS)
2146 return 0;
2147 if (udev->state != USB_STATE_DEFAULT)
2148 return -EINVAL;
2149 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2150 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2151 NULL, 0, USB_CTRL_SET_TIMEOUT);
2152 if (retval == 0) {
2153 usb_set_device_state(udev, USB_STATE_ADDRESS);
2154 ep0_reinit(udev);
2155 }
2156 return retval;
2157}
2158
2159/* Reset device, (re)assign address, get device descriptor.
2160 * Device connection must be stable, no more debouncing needed.
2161 * Returns device in USB_STATE_ADDRESS, except on error.
2162 *
2163 * If this is called for an already-existing device (as part of
2164 * usb_reset_device), the caller must own the device lock. For a
2165 * newly detected device that is not accessible through any global
2166 * pointers, it's not necessary to lock the device.
2167 */
2168static int
2169hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2170 int retry_counter)
2171{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002172 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173
2174 struct usb_device *hdev = hub->hdev;
2175 int i, j, retval;
2176 unsigned delay = HUB_SHORT_RESET_TIME;
2177 enum usb_device_speed oldspeed = udev->speed;
2178
2179 /* root hub ports have a slightly longer reset period
2180 * (from USB 2.0 spec, section 7.1.7.5)
2181 */
2182 if (!hdev->parent) {
2183 delay = HUB_ROOT_RESET_TIME;
2184 if (port1 == hdev->bus->otg_port)
2185 hdev->bus->b_hnp_enable = 0;
2186 }
2187
2188 /* Some low speed devices have problems with the quick delay, so */
2189 /* be a bit pessimistic with those devices. RHbug #23670 */
2190 if (oldspeed == USB_SPEED_LOW)
2191 delay = HUB_LONG_RESET_TIME;
2192
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002193 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
2195 /* Reset the device; full speed may morph to high speed */
2196 retval = hub_port_reset(hub, port1, udev, delay);
2197 if (retval < 0) /* error or disconnect */
2198 goto fail;
2199 /* success, speed is known */
2200 retval = -ENODEV;
2201
2202 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2203 dev_dbg(&udev->dev, "device reset changed speed!\n");
2204 goto fail;
2205 }
2206 oldspeed = udev->speed;
2207
2208 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2209 * it's fixed size except for full speed devices.
2210 */
2211 switch (udev->speed) {
2212 case USB_SPEED_HIGH: /* fixed at 64 */
2213 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2214 break;
2215 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2216 /* to determine the ep0 maxpacket size, try to read
2217 * the device descriptor to get bMaxPacketSize0 and
2218 * then correct our initial guess.
2219 */
2220 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2221 break;
2222 case USB_SPEED_LOW: /* fixed at 8 */
2223 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2224 break;
2225 default:
2226 goto fail;
2227 }
2228
2229 dev_info (&udev->dev,
2230 "%s %s speed USB device using %s and address %d\n",
2231 (udev->config) ? "reset" : "new",
2232 ({ char *speed; switch (udev->speed) {
2233 case USB_SPEED_LOW: speed = "low"; break;
2234 case USB_SPEED_FULL: speed = "full"; break;
2235 case USB_SPEED_HIGH: speed = "high"; break;
2236 default: speed = "?"; break;
2237 }; speed;}),
2238 udev->bus->controller->driver->name,
2239 udev->devnum);
2240
2241 /* Set up TT records, if needed */
2242 if (hdev->tt) {
2243 udev->tt = hdev->tt;
2244 udev->ttport = hdev->ttport;
2245 } else if (udev->speed != USB_SPEED_HIGH
2246 && hdev->speed == USB_SPEED_HIGH) {
2247 udev->tt = &hub->tt;
2248 udev->ttport = port1;
2249 }
2250
2251 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2252 * Because device hardware and firmware is sometimes buggy in
2253 * this area, and this is how Linux has done it for ages.
2254 * Change it cautiously.
2255 *
2256 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2257 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2258 * so it may help with some non-standards-compliant devices.
2259 * Otherwise we start with SET_ADDRESS and then try to read the
2260 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2261 * value.
2262 */
2263 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2264 if (USE_NEW_SCHEME(retry_counter)) {
2265 struct usb_device_descriptor *buf;
2266 int r = 0;
2267
2268#define GET_DESCRIPTOR_BUFSIZE 64
2269 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2270 if (!buf) {
2271 retval = -ENOMEM;
2272 continue;
2273 }
2274
2275 /* Use a short timeout the first time through,
2276 * so that recalcitrant full-speed devices with
2277 * 8- or 16-byte ep0-maxpackets won't slow things
2278 * down tremendously by NAKing the unexpectedly
2279 * early status stage. Also, retry on all errors;
2280 * some devices are flakey.
2281 */
2282 for (j = 0; j < 3; ++j) {
2283 buf->bMaxPacketSize0 = 0;
2284 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2285 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2286 USB_DT_DEVICE << 8, 0,
2287 buf, GET_DESCRIPTOR_BUFSIZE,
2288 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2289 switch (buf->bMaxPacketSize0) {
2290 case 8: case 16: case 32: case 64:
2291 if (buf->bDescriptorType ==
2292 USB_DT_DEVICE) {
2293 r = 0;
2294 break;
2295 }
2296 /* FALL THROUGH */
2297 default:
2298 if (r == 0)
2299 r = -EPROTO;
2300 break;
2301 }
2302 if (r == 0)
2303 break;
2304 }
2305 udev->descriptor.bMaxPacketSize0 =
2306 buf->bMaxPacketSize0;
2307 kfree(buf);
2308
2309 retval = hub_port_reset(hub, port1, udev, delay);
2310 if (retval < 0) /* error or disconnect */
2311 goto fail;
2312 if (oldspeed != udev->speed) {
2313 dev_dbg(&udev->dev,
2314 "device reset changed speed!\n");
2315 retval = -ENODEV;
2316 goto fail;
2317 }
2318 if (r) {
2319 dev_err(&udev->dev, "device descriptor "
2320 "read/%s, error %d\n",
2321 "64", r);
2322 retval = -EMSGSIZE;
2323 continue;
2324 }
2325#undef GET_DESCRIPTOR_BUFSIZE
2326 }
2327
2328 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2329 retval = hub_set_address(udev);
2330 if (retval >= 0)
2331 break;
2332 msleep(200);
2333 }
2334 if (retval < 0) {
2335 dev_err(&udev->dev,
2336 "device not accepting address %d, error %d\n",
2337 udev->devnum, retval);
2338 goto fail;
2339 }
2340
2341 /* cope with hardware quirkiness:
2342 * - let SET_ADDRESS settle, some device hardware wants it
2343 * - read ep0 maxpacket even for high and low speed,
2344 */
2345 msleep(10);
2346 if (USE_NEW_SCHEME(retry_counter))
2347 break;
2348
2349 retval = usb_get_device_descriptor(udev, 8);
2350 if (retval < 8) {
2351 dev_err(&udev->dev, "device descriptor "
2352 "read/%s, error %d\n",
2353 "8", retval);
2354 if (retval >= 0)
2355 retval = -EMSGSIZE;
2356 } else {
2357 retval = 0;
2358 break;
2359 }
2360 }
2361 if (retval)
2362 goto fail;
2363
2364 i = udev->descriptor.bMaxPacketSize0;
2365 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2366 if (udev->speed != USB_SPEED_FULL ||
2367 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2368 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2369 retval = -EMSGSIZE;
2370 goto fail;
2371 }
2372 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2373 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2374 ep0_reinit(udev);
2375 }
2376
2377 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2378 if (retval < (signed)sizeof(udev->descriptor)) {
2379 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2380 "all", retval);
2381 if (retval >= 0)
2382 retval = -ENOMSG;
2383 goto fail;
2384 }
2385
2386 retval = 0;
2387
2388fail:
2389 if (retval)
2390 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002391 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 return retval;
2393}
2394
2395static void
2396check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2397{
2398 struct usb_qualifier_descriptor *qual;
2399 int status;
2400
2401 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2402 if (qual == NULL)
2403 return;
2404
2405 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2406 qual, sizeof *qual);
2407 if (status == sizeof *qual) {
2408 dev_info(&udev->dev, "not running at top speed; "
2409 "connect to a high speed hub\n");
2410 /* hub LEDs are probably harder to miss than syslog */
2411 if (hub->has_indicators) {
2412 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2413 schedule_work (&hub->leds);
2414 }
2415 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002416 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417}
2418
2419static unsigned
2420hub_power_remaining (struct usb_hub *hub)
2421{
2422 struct usb_device *hdev = hub->hdev;
2423 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002424 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425
Alan Stern55c52712005-11-23 12:03:12 -05002426 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 return 0;
2428
Alan Stern55c52712005-11-23 12:03:12 -05002429 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2430 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2431 struct usb_device *udev = hdev->children[port1 - 1];
2432 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433
2434 if (!udev)
2435 continue;
2436
Alan Stern55c52712005-11-23 12:03:12 -05002437 /* Unconfigured devices may not use more than 100mA,
2438 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002440 delta = udev->actconfig->desc.bMaxPower * 2;
2441 else if (port1 != udev->bus->otg_port || hdev->parent)
2442 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 else
Alan Stern55c52712005-11-23 12:03:12 -05002444 delta = 8;
2445 if (delta > hub->mA_per_port)
2446 dev_warn(&udev->dev, "%dmA is over %umA budget "
2447 "for port %d!\n",
2448 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 remaining -= delta;
2450 }
2451 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002452 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2453 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 remaining = 0;
2455 }
2456 return remaining;
2457}
2458
2459/* Handle physical or logical connection change events.
2460 * This routine is called when:
2461 * a port connection-change occurs;
2462 * a port enable-change occurs (often caused by EMI);
2463 * usb_reset_device() encounters changed descriptors (as from
2464 * a firmware download)
2465 * caller already locked the hub
2466 */
2467static void hub_port_connect_change(struct usb_hub *hub, int port1,
2468 u16 portstatus, u16 portchange)
2469{
2470 struct usb_device *hdev = hub->hdev;
2471 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002472 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 int status, i;
2474
2475 dev_dbg (hub_dev,
2476 "port %d, status %04x, change %04x, %s\n",
2477 port1, portstatus, portchange, portspeed (portstatus));
2478
2479 if (hub->has_indicators) {
2480 set_port_led(hub, port1, HUB_LED_AUTO);
2481 hub->indicator[port1-1] = INDICATOR_AUTO;
2482 }
2483
2484 /* Disconnect any existing devices under this port */
2485 if (hdev->children[port1-1])
2486 usb_disconnect(&hdev->children[port1-1]);
2487 clear_bit(port1, hub->change_bits);
2488
2489#ifdef CONFIG_USB_OTG
2490 /* during HNP, don't repeat the debounce */
2491 if (hdev->bus->is_b_host)
2492 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2493#endif
2494
2495 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2496 status = hub_port_debounce(hub, port1);
2497 if (status < 0) {
2498 dev_err (hub_dev,
2499 "connect-debounce failed, port %d disabled\n",
2500 port1);
2501 goto done;
2502 }
2503 portstatus = status;
2504 }
2505
2506 /* Return now if nothing is connected */
2507 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2508
2509 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002510 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2512 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2513
2514 if (portstatus & USB_PORT_STAT_ENABLE)
2515 goto done;
2516 return;
2517 }
2518
2519#ifdef CONFIG_USB_SUSPEND
2520 /* If something is connected, but the port is suspended, wake it up. */
2521 if (portstatus & USB_PORT_STAT_SUSPEND) {
2522 status = hub_port_resume(hub, port1, NULL);
2523 if (status < 0) {
2524 dev_dbg(hub_dev,
2525 "can't clear suspend on port %d; %d\n",
2526 port1, status);
2527 goto done;
2528 }
2529 }
2530#endif
2531
2532 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2533 struct usb_device *udev;
2534
2535 /* reallocate for each attempt, since references
2536 * to the previous one can escape in various ways
2537 */
2538 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2539 if (!udev) {
2540 dev_err (hub_dev,
2541 "couldn't allocate port %d usb_device\n",
2542 port1);
2543 goto done;
2544 }
2545
2546 usb_set_device_state(udev, USB_STATE_POWERED);
2547 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002548 udev->bus_mA = hub->mA_per_port;
2549
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550 /* set the address */
2551 choose_address(udev);
2552 if (udev->devnum <= 0) {
2553 status = -ENOTCONN; /* Don't retry */
2554 goto loop;
2555 }
2556
2557 /* reset and get descriptor */
2558 status = hub_port_init(hub, udev, port1, i);
2559 if (status < 0)
2560 goto loop;
2561
2562 /* consecutive bus-powered hubs aren't reliable; they can
2563 * violate the voltage drop budget. if the new child has
2564 * a "powered" LED, users should notice we didn't enable it
2565 * (without reading syslog), even without per-port LEDs
2566 * on the parent.
2567 */
2568 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002569 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 u16 devstat;
2571
2572 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2573 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002574 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 dev_dbg(&udev->dev, "get status %d ?\n", status);
2576 goto loop_disable;
2577 }
Alan Stern55c52712005-11-23 12:03:12 -05002578 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2580 dev_err(&udev->dev,
2581 "can't connect bus-powered hub "
2582 "to this port\n");
2583 if (hub->has_indicators) {
2584 hub->indicator[port1-1] =
2585 INDICATOR_AMBER_BLINK;
2586 schedule_work (&hub->leds);
2587 }
2588 status = -ENOTCONN; /* Don't retry */
2589 goto loop_disable;
2590 }
2591 }
2592
2593 /* check for devices running slower than they could */
2594 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2595 && udev->speed == USB_SPEED_FULL
2596 && highspeed_hubs != 0)
2597 check_highspeed (hub, udev, port1);
2598
2599 /* Store the parent's children[] pointer. At this point
2600 * udev becomes globally accessible, although presumably
2601 * no one will look at it until hdev is unlocked.
2602 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 status = 0;
2604
2605 /* We mustn't add new devices if the parent hub has
2606 * been disconnected; we would race with the
2607 * recursively_mark_NOTATTACHED() routine.
2608 */
2609 spin_lock_irq(&device_state_lock);
2610 if (hdev->state == USB_STATE_NOTATTACHED)
2611 status = -ENOTCONN;
2612 else
2613 hdev->children[port1-1] = udev;
2614 spin_unlock_irq(&device_state_lock);
2615
2616 /* Run it through the hoops (find a driver, etc) */
2617 if (!status) {
2618 status = usb_new_device(udev);
2619 if (status) {
2620 spin_lock_irq(&device_state_lock);
2621 hdev->children[port1-1] = NULL;
2622 spin_unlock_irq(&device_state_lock);
2623 }
2624 }
2625
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 if (status)
2627 goto loop_disable;
2628
2629 status = hub_power_remaining(hub);
2630 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002631 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632
2633 return;
2634
2635loop_disable:
2636 hub_port_disable(hub, port1, 1);
2637loop:
2638 ep0_reinit(udev);
2639 release_address(udev);
2640 usb_put_dev(udev);
2641 if (status == -ENOTCONN)
2642 break;
2643 }
2644
2645done:
2646 hub_port_disable(hub, port1, 1);
2647}
2648
2649static void hub_events(void)
2650{
2651 struct list_head *tmp;
2652 struct usb_device *hdev;
2653 struct usb_interface *intf;
2654 struct usb_hub *hub;
2655 struct device *hub_dev;
2656 u16 hubstatus;
2657 u16 hubchange;
2658 u16 portstatus;
2659 u16 portchange;
2660 int i, ret;
2661 int connect_change;
2662
2663 /*
2664 * We restart the list every time to avoid a deadlock with
2665 * deleting hubs downstream from this one. This should be
2666 * safe since we delete the hub from the event list.
2667 * Not the most efficient, but avoids deadlocks.
2668 */
2669 while (1) {
2670
2671 /* Grab the first entry at the beginning of the list */
2672 spin_lock_irq(&hub_event_lock);
2673 if (list_empty(&hub_event_list)) {
2674 spin_unlock_irq(&hub_event_lock);
2675 break;
2676 }
2677
2678 tmp = hub_event_list.next;
2679 list_del_init(tmp);
2680
2681 hub = list_entry(tmp, struct usb_hub, event_list);
2682 hdev = hub->hdev;
2683 intf = to_usb_interface(hub->intfdev);
2684 hub_dev = &intf->dev;
2685
David Brownell979d5192005-09-22 22:32:24 -07002686 i = hub->resume_root_hub;
2687
2688 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 hdev->state, hub->descriptor
2690 ? hub->descriptor->bNbrPorts
2691 : 0,
2692 /* NOTE: expects max 15 ports... */
2693 (u16) hub->change_bits[0],
David Brownell979d5192005-09-22 22:32:24 -07002694 (u16) hub->event_bits[0],
2695 i ? ", resume root" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696
2697 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698 spin_unlock_irq(&hub_event_lock);
2699
David Brownell979d5192005-09-22 22:32:24 -07002700 /* Is this is a root hub wanting to reactivate the downstream
2701 * ports? If so, be sure the interface resumes even if its
2702 * stub "device" node was never suspended.
2703 */
2704 if (i) {
David Brownell979d5192005-09-22 22:32:24 -07002705 dpm_runtime_resume(&hdev->dev);
2706 dpm_runtime_resume(&intf->dev);
Alan Stern2425e9f2005-11-29 12:13:31 -05002707 usb_put_intf(intf);
2708 continue;
David Brownell979d5192005-09-22 22:32:24 -07002709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710
2711 /* Lock the device, then check to see if we were
2712 * disconnected while waiting for the lock to succeed. */
2713 if (locktree(hdev) < 0) {
2714 usb_put_intf(intf);
2715 continue;
2716 }
2717 if (hub != usb_get_intfdata(intf))
2718 goto loop;
2719
2720 /* If the hub has died, clean up after it */
2721 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7d069b72005-11-18 12:06:34 -05002722 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 goto loop;
2724 }
2725
2726 /* If this is an inactive or suspended hub, do nothing */
2727 if (hub->quiescing)
2728 goto loop;
2729
2730 if (hub->error) {
2731 dev_dbg (hub_dev, "resetting for error %d\n",
2732 hub->error);
2733
2734 ret = usb_reset_device(hdev);
2735 if (ret) {
2736 dev_dbg (hub_dev,
2737 "error resetting hub: %d\n", ret);
2738 goto loop;
2739 }
2740
2741 hub->nerrors = 0;
2742 hub->error = 0;
2743 }
2744
2745 /* deal with port status changes */
2746 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2747 if (test_bit(i, hub->busy_bits))
2748 continue;
2749 connect_change = test_bit(i, hub->change_bits);
2750 if (!test_and_clear_bit(i, hub->event_bits) &&
2751 !connect_change && !hub->activating)
2752 continue;
2753
2754 ret = hub_port_status(hub, i,
2755 &portstatus, &portchange);
2756 if (ret < 0)
2757 continue;
2758
2759 if (hub->activating && !hdev->children[i-1] &&
2760 (portstatus &
2761 USB_PORT_STAT_CONNECTION))
2762 connect_change = 1;
2763
2764 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2765 clear_port_feature(hdev, i,
2766 USB_PORT_FEAT_C_CONNECTION);
2767 connect_change = 1;
2768 }
2769
2770 if (portchange & USB_PORT_STAT_C_ENABLE) {
2771 if (!connect_change)
2772 dev_dbg (hub_dev,
2773 "port %d enable change, "
2774 "status %08x\n",
2775 i, portstatus);
2776 clear_port_feature(hdev, i,
2777 USB_PORT_FEAT_C_ENABLE);
2778
2779 /*
2780 * EM interference sometimes causes badly
2781 * shielded USB devices to be shutdown by
2782 * the hub, this hack enables them again.
2783 * Works at least with mouse driver.
2784 */
2785 if (!(portstatus & USB_PORT_STAT_ENABLE)
2786 && !connect_change
2787 && hdev->children[i-1]) {
2788 dev_err (hub_dev,
2789 "port %i "
2790 "disabled by hub (EMI?), "
2791 "re-enabling...\n",
2792 i);
2793 connect_change = 1;
2794 }
2795 }
2796
2797 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2798 clear_port_feature(hdev, i,
2799 USB_PORT_FEAT_C_SUSPEND);
2800 if (hdev->children[i-1]) {
2801 ret = remote_wakeup(hdev->
2802 children[i-1]);
2803 if (ret < 0)
2804 connect_change = 1;
2805 } else {
2806 ret = -ENODEV;
2807 hub_port_disable(hub, i, 1);
2808 }
2809 dev_dbg (hub_dev,
2810 "resume on port %d, status %d\n",
2811 i, ret);
2812 }
2813
2814 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2815 dev_err (hub_dev,
2816 "over-current change on port %d\n",
2817 i);
2818 clear_port_feature(hdev, i,
2819 USB_PORT_FEAT_C_OVER_CURRENT);
2820 hub_power_on(hub);
2821 }
2822
2823 if (portchange & USB_PORT_STAT_C_RESET) {
2824 dev_dbg (hub_dev,
2825 "reset change on port %d\n",
2826 i);
2827 clear_port_feature(hdev, i,
2828 USB_PORT_FEAT_C_RESET);
2829 }
2830
2831 if (connect_change)
2832 hub_port_connect_change(hub, i,
2833 portstatus, portchange);
2834 } /* end for i */
2835
2836 /* deal with hub status changes */
2837 if (test_and_clear_bit(0, hub->event_bits) == 0)
2838 ; /* do nothing */
2839 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2840 dev_err (hub_dev, "get_hub_status failed\n");
2841 else {
2842 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2843 dev_dbg (hub_dev, "power change\n");
2844 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002845 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2846 /* FIXME: Is this always true? */
2847 hub->limited_power = 0;
2848 else
2849 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850 }
2851 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2852 dev_dbg (hub_dev, "overcurrent change\n");
2853 msleep(500); /* Cool down */
2854 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2855 hub_power_on(hub);
2856 }
2857 }
2858
2859 hub->activating = 0;
2860
Alan Sternd5926ae72005-04-21 15:56:37 -04002861 /* If this is a root hub, tell the HCD it's okay to
2862 * re-enable port-change interrupts now. */
2863 if (!hdev->parent)
2864 usb_enable_root_hub_irq(hdev->bus);
2865
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866loop:
2867 usb_unlock_device(hdev);
2868 usb_put_intf(intf);
2869
2870 } /* end while (1) */
2871}
2872
2873static int hub_thread(void *__unused)
2874{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875 do {
2876 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002877 wait_event_interruptible(khubd_wait,
2878 !list_empty(&hub_event_list) ||
2879 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002880 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002881 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002883 pr_debug("%s: khubd exiting\n", usbcore_name);
2884 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885}
2886
2887static struct usb_device_id hub_id_table [] = {
2888 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2889 .bDeviceClass = USB_CLASS_HUB},
2890 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2891 .bInterfaceClass = USB_CLASS_HUB},
2892 { } /* Terminating entry */
2893};
2894
2895MODULE_DEVICE_TABLE (usb, hub_id_table);
2896
2897static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 .name = "hub",
2899 .probe = hub_probe,
2900 .disconnect = hub_disconnect,
2901 .suspend = hub_suspend,
2902 .resume = hub_resume,
2903 .ioctl = hub_ioctl,
2904 .id_table = hub_id_table,
2905};
2906
2907int usb_hub_init(void)
2908{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909 if (usb_register(&hub_driver) < 0) {
2910 printk(KERN_ERR "%s: can't register hub driver\n",
2911 usbcore_name);
2912 return -1;
2913 }
2914
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002915 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2916 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918
2919 /* Fall through if kernel_thread failed */
2920 usb_deregister(&hub_driver);
2921 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2922
2923 return -1;
2924}
2925
2926void usb_hub_cleanup(void)
2927{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002928 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929
2930 /*
2931 * Hub resources are freed for us by usb_deregister. It calls
2932 * usb_driver_purge on every device which in turn calls that
2933 * devices disconnect function if it is using this driver.
2934 * The hub_disconnect function takes care of releasing the
2935 * individual hub resources. -greg
2936 */
2937 usb_deregister(&hub_driver);
2938} /* usb_hub_cleanup() */
2939
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940static int config_descriptors_changed(struct usb_device *udev)
2941{
2942 unsigned index;
2943 unsigned len = 0;
2944 struct usb_config_descriptor *buf;
2945
2946 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2947 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2948 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2949 }
2950 buf = kmalloc (len, SLAB_KERNEL);
2951 if (buf == NULL) {
2952 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2953 /* assume the worst */
2954 return 1;
2955 }
2956 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2957 int length;
2958 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2959
2960 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2961 old_length);
2962 if (length < old_length) {
2963 dev_dbg(&udev->dev, "config index %d, error %d\n",
2964 index, length);
2965 break;
2966 }
2967 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2968 != 0) {
2969 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2970 index, buf->bConfigurationValue);
2971 break;
2972 }
2973 }
2974 kfree(buf);
2975 return index != udev->descriptor.bNumConfigurations;
2976}
2977
2978/**
2979 * usb_reset_device - perform a USB port reset to reinitialize a device
2980 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2981 *
2982 * WARNING - don't reset any device unless drivers for all of its
2983 * interfaces are expecting that reset! Maybe some driver->reset()
2984 * method should eventually help ensure sufficient cooperation.
2985 *
2986 * Do a port reset, reassign the device's address, and establish its
2987 * former operating configuration. If the reset fails, or the device's
2988 * descriptors change from their values before the reset, or the original
2989 * configuration and altsettings cannot be restored, a flag will be set
2990 * telling khubd to pretend the device has been disconnected and then
2991 * re-connected. All drivers will be unbound, and the device will be
2992 * re-enumerated and probed all over again.
2993 *
2994 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2995 * flagged for logical disconnection, or some other negative error code
2996 * if the reset wasn't even attempted.
2997 *
2998 * The caller must own the device lock. For example, it's safe to use
2999 * this from a driver probe() routine after downloading new firmware.
3000 * For calls that might not occur during probe(), drivers should lock
3001 * the device using usb_lock_device_for_reset().
3002 */
3003int usb_reset_device(struct usb_device *udev)
3004{
3005 struct usb_device *parent_hdev = udev->parent;
3006 struct usb_hub *parent_hub;
3007 struct usb_device_descriptor descriptor = udev->descriptor;
3008 struct usb_hub *hub = NULL;
Alan Stern12c3da32005-11-23 12:09:52 -05003009 int i, ret = 0;
3010 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
3012 if (udev->state == USB_STATE_NOTATTACHED ||
3013 udev->state == USB_STATE_SUSPENDED) {
3014 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3015 udev->state);
3016 return -EINVAL;
3017 }
3018
3019 if (!parent_hdev) {
3020 /* this requires hcd-specific logic; see OHCI hc_restart() */
3021 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3022 return -EISDIR;
3023 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024 parent_hub = hdev_to_hub(parent_hdev);
3025
3026 /* If we're resetting an active hub, take some special actions */
3027 if (udev->actconfig &&
3028 udev->actconfig->interface[0]->dev.driver ==
3029 &hub_driver.driver &&
3030 (hub = hdev_to_hub(udev)) != NULL) {
Alan Stern7d069b72005-11-18 12:06:34 -05003031 hub_pre_reset(hub, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 }
3033
3034 set_bit(port1, parent_hub->busy_bits);
3035 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3036
3037 /* ep0 maxpacket size may change; let the HCD know about it.
3038 * Other endpoints will be handled by re-enumeration. */
3039 ep0_reinit(udev);
3040 ret = hub_port_init(parent_hub, udev, port1, i);
3041 if (ret >= 0)
3042 break;
3043 }
3044 clear_bit(port1, parent_hub->busy_bits);
3045 if (ret < 0)
3046 goto re_enumerate;
3047
3048 /* Device might have changed firmware (DFU or similar) */
3049 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3050 || config_descriptors_changed (udev)) {
3051 dev_info(&udev->dev, "device firmware changed\n");
3052 udev->descriptor = descriptor; /* for disconnect() calls */
3053 goto re_enumerate;
3054 }
3055
3056 if (!udev->actconfig)
3057 goto done;
3058
3059 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3060 USB_REQ_SET_CONFIGURATION, 0,
3061 udev->actconfig->desc.bConfigurationValue, 0,
3062 NULL, 0, USB_CTRL_SET_TIMEOUT);
3063 if (ret < 0) {
3064 dev_err(&udev->dev,
3065 "can't restore configuration #%d (error=%d)\n",
3066 udev->actconfig->desc.bConfigurationValue, ret);
3067 goto re_enumerate;
3068 }
3069 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3070
3071 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3072 struct usb_interface *intf = udev->actconfig->interface[i];
3073 struct usb_interface_descriptor *desc;
3074
3075 /* set_interface resets host side toggle even
3076 * for altsetting zero. the interface may have no driver.
3077 */
3078 desc = &intf->cur_altsetting->desc;
3079 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3080 desc->bAlternateSetting);
3081 if (ret < 0) {
3082 dev_err(&udev->dev, "failed to restore interface %d "
3083 "altsetting %d (error=%d)\n",
3084 desc->bInterfaceNumber,
3085 desc->bAlternateSetting,
3086 ret);
3087 goto re_enumerate;
3088 }
3089 }
3090
3091done:
3092 if (hub)
3093 hub_post_reset(hub);
3094 return 0;
3095
3096re_enumerate:
3097 hub_port_logical_disconnect(parent_hub, port1);
3098 return -ENODEV;
3099}