blob: dee812bc6c43cd521fe4585dc9ed4998e5deaf23 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/completion.h>
16#include <linux/sched.h>
17#include <linux/list.h>
18#include <linux/slab.h>
19#include <linux/smp_lock.h>
20#include <linux/ioctl.h>
21#include <linux/usb.h>
22#include <linux/usbdevice_fs.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070023#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010024#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <asm/semaphore.h>
27#include <asm/uaccess.h>
28#include <asm/byteorder.h>
29
30#include "usb.h"
31#include "hcd.h"
32#include "hub.h"
33
34/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050035 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
37static DEFINE_SPINLOCK(device_state_lock);
38
39/* khubd's worklist and its lock */
40static DEFINE_SPINLOCK(hub_event_lock);
41static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
42
43/* Wakes up khubd */
44static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
45
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070046static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48/* cycle leds on hubs that aren't blinking for attention */
49static int blinkenlights = 0;
50module_param (blinkenlights, bool, S_IRUGO);
51MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
52
53/*
54 * As of 2.6.10 we introduce a new USB device initialization scheme which
55 * closely resembles the way Windows works. Hopefully it will be compatible
56 * with a wider range of devices than the old scheme. However some previously
57 * working devices may start giving rise to "device not accepting address"
58 * errors; if that happens the user can try the old scheme by adjusting the
59 * following module parameters.
60 *
61 * For maximum flexibility there are two boolean parameters to control the
62 * hub driver's behavior. On the first initialization attempt, if the
63 * "old_scheme_first" parameter is set then the old scheme will be used,
64 * otherwise the new scheme is used. If that fails and "use_both_schemes"
65 * is set, then the driver will make another attempt, using the other scheme.
66 */
67static int old_scheme_first = 0;
68module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
69MODULE_PARM_DESC(old_scheme_first,
70 "start with the old device initialization scheme");
71
72static int use_both_schemes = 1;
73module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
74MODULE_PARM_DESC(use_both_schemes,
75 "try the other device initialization scheme if the "
76 "first one fails");
77
78
79#ifdef DEBUG
80static inline char *portspeed (int portstatus)
81{
82 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
83 return "480 Mb/s";
84 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
85 return "1.5 Mb/s";
86 else
87 return "12 Mb/s";
88}
89#endif
90
91/* Note that hdev or one of its children must be locked! */
92static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
93{
94 return usb_get_intfdata(hdev->actconfig->interface[0]);
95}
96
97/* USB 2.0 spec Section 11.24.4.5 */
98static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
99{
100 int i, ret;
101
102 for (i = 0; i < 3; i++) {
103 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
104 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
105 USB_DT_HUB << 8, 0, data, size,
106 USB_CTRL_GET_TIMEOUT);
107 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
108 return ret;
109 }
110 return -EINVAL;
111}
112
113/*
114 * USB 2.0 spec Section 11.24.2.1
115 */
116static int clear_hub_feature(struct usb_device *hdev, int feature)
117{
118 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
119 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
120}
121
122/*
123 * USB 2.0 spec Section 11.24.2.2
124 */
125static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
126{
127 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
128 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
129 NULL, 0, 1000);
130}
131
132/*
133 * USB 2.0 spec Section 11.24.2.13
134 */
135static int set_port_feature(struct usb_device *hdev, int port1, int feature)
136{
137 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
138 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
139 NULL, 0, 1000);
140}
141
142/*
143 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
144 * for info about using port indicators
145 */
146static void set_port_led(
147 struct usb_hub *hub,
148 int port1,
149 int selector
150)
151{
152 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
153 USB_PORT_FEAT_INDICATOR);
154 if (status < 0)
155 dev_dbg (hub->intfdev,
156 "port %d indicator %s status %d\n",
157 port1,
158 ({ char *s; switch (selector) {
159 case HUB_LED_AMBER: s = "amber"; break;
160 case HUB_LED_GREEN: s = "green"; break;
161 case HUB_LED_OFF: s = "off"; break;
162 case HUB_LED_AUTO: s = "auto"; break;
163 default: s = "??"; break;
164 }; s; }),
165 status);
166}
167
168#define LED_CYCLE_PERIOD ((2*HZ)/3)
169
170static void led_work (void *__hub)
171{
172 struct usb_hub *hub = __hub;
173 struct usb_device *hdev = hub->hdev;
174 unsigned i;
175 unsigned changed = 0;
176 int cursor = -1;
177
178 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
179 return;
180
181 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
182 unsigned selector, mode;
183
184 /* 30%-50% duty cycle */
185
186 switch (hub->indicator[i]) {
187 /* cycle marker */
188 case INDICATOR_CYCLE:
189 cursor = i;
190 selector = HUB_LED_AUTO;
191 mode = INDICATOR_AUTO;
192 break;
193 /* blinking green = sw attention */
194 case INDICATOR_GREEN_BLINK:
195 selector = HUB_LED_GREEN;
196 mode = INDICATOR_GREEN_BLINK_OFF;
197 break;
198 case INDICATOR_GREEN_BLINK_OFF:
199 selector = HUB_LED_OFF;
200 mode = INDICATOR_GREEN_BLINK;
201 break;
202 /* blinking amber = hw attention */
203 case INDICATOR_AMBER_BLINK:
204 selector = HUB_LED_AMBER;
205 mode = INDICATOR_AMBER_BLINK_OFF;
206 break;
207 case INDICATOR_AMBER_BLINK_OFF:
208 selector = HUB_LED_OFF;
209 mode = INDICATOR_AMBER_BLINK;
210 break;
211 /* blink green/amber = reserved */
212 case INDICATOR_ALT_BLINK:
213 selector = HUB_LED_GREEN;
214 mode = INDICATOR_ALT_BLINK_OFF;
215 break;
216 case INDICATOR_ALT_BLINK_OFF:
217 selector = HUB_LED_AMBER;
218 mode = INDICATOR_ALT_BLINK;
219 break;
220 default:
221 continue;
222 }
223 if (selector != HUB_LED_AUTO)
224 changed = 1;
225 set_port_led(hub, i + 1, selector);
226 hub->indicator[i] = mode;
227 }
228 if (!changed && blinkenlights) {
229 cursor++;
230 cursor %= hub->descriptor->bNbrPorts;
231 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
232 hub->indicator[cursor] = INDICATOR_CYCLE;
233 changed++;
234 }
235 if (changed)
236 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
237}
238
239/* use a short timeout for hub/port status fetches */
240#define USB_STS_TIMEOUT 1000
241#define USB_STS_RETRIES 5
242
243/*
244 * USB 2.0 spec Section 11.24.2.6
245 */
246static int get_hub_status(struct usb_device *hdev,
247 struct usb_hub_status *data)
248{
249 int i, status = -ETIMEDOUT;
250
251 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
252 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
253 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
254 data, sizeof(*data), USB_STS_TIMEOUT);
255 }
256 return status;
257}
258
259/*
260 * USB 2.0 spec Section 11.24.2.7
261 */
262static int get_port_status(struct usb_device *hdev, int port1,
263 struct usb_port_status *data)
264{
265 int i, status = -ETIMEDOUT;
266
267 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
268 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
269 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
270 data, sizeof(*data), USB_STS_TIMEOUT);
271 }
272 return status;
273}
274
275static void kick_khubd(struct usb_hub *hub)
276{
277 unsigned long flags;
278
279 spin_lock_irqsave(&hub_event_lock, flags);
280 if (list_empty(&hub->event_list)) {
281 list_add_tail(&hub->event_list, &hub_event_list);
282 wake_up(&khubd_wait);
283 }
284 spin_unlock_irqrestore(&hub_event_lock, flags);
285}
286
287void usb_kick_khubd(struct usb_device *hdev)
288{
289 kick_khubd(hdev_to_hub(hdev));
290}
291
292
293/* completion function, fires on port status changes and various faults */
294static void hub_irq(struct urb *urb, struct pt_regs *regs)
295{
296 struct usb_hub *hub = (struct usb_hub *)urb->context;
297 int status;
298 int i;
299 unsigned long bits;
300
301 switch (urb->status) {
302 case -ENOENT: /* synchronous unlink */
303 case -ECONNRESET: /* async unlink */
304 case -ESHUTDOWN: /* hardware going away */
305 return;
306
307 default: /* presumably an error */
308 /* Cause a hub reset after 10 consecutive errors */
309 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
310 if ((++hub->nerrors < 10) || hub->error)
311 goto resubmit;
312 hub->error = urb->status;
313 /* FALL THROUGH */
314
315 /* let khubd handle things */
316 case 0: /* we got data: port status changed */
317 bits = 0;
318 for (i = 0; i < urb->actual_length; ++i)
319 bits |= ((unsigned long) ((*hub->buffer)[i]))
320 << (i*8);
321 hub->event_bits[0] = bits;
322 break;
323 }
324
325 hub->nerrors = 0;
326
327 /* Something happened, let khubd figure it out */
328 kick_khubd(hub);
329
330resubmit:
331 if (hub->quiescing)
332 return;
333
334 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
335 && status != -ENODEV && status != -EPERM)
336 dev_err (hub->intfdev, "resubmit --> %d\n", status);
337}
338
339/* USB 2.0 spec Section 11.24.2.3 */
340static inline int
341hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
342{
343 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
345 tt, NULL, 0, 1000);
346}
347
348/*
349 * enumeration blocks khubd for a long time. we use keventd instead, since
350 * long blocking there is the exception, not the rule. accordingly, HCDs
351 * talking to TTs must queue control transfers (not just bulk and iso), so
352 * both can talk to the same hub concurrently.
353 */
354static void hub_tt_kevent (void *arg)
355{
356 struct usb_hub *hub = arg;
357 unsigned long flags;
358
359 spin_lock_irqsave (&hub->tt.lock, flags);
360 while (!list_empty (&hub->tt.clear_list)) {
361 struct list_head *temp;
362 struct usb_tt_clear *clear;
363 struct usb_device *hdev = hub->hdev;
364 int status;
365
366 temp = hub->tt.clear_list.next;
367 clear = list_entry (temp, struct usb_tt_clear, clear_list);
368 list_del (&clear->clear_list);
369
370 /* drop lock so HCD can concurrently report other TT errors */
371 spin_unlock_irqrestore (&hub->tt.lock, flags);
372 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
373 spin_lock_irqsave (&hub->tt.lock, flags);
374
375 if (status)
376 dev_err (&hdev->dev,
377 "clear tt %d (%04x) error %d\n",
378 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700379 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 }
381 spin_unlock_irqrestore (&hub->tt.lock, flags);
382}
383
384/**
385 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
386 * @udev: the device whose split transaction failed
387 * @pipe: identifies the endpoint of the failed transaction
388 *
389 * High speed HCDs use this to tell the hub driver that some split control or
390 * bulk transaction failed in a way that requires clearing internal state of
391 * a transaction translator. This is normally detected (and reported) from
392 * interrupt context.
393 *
394 * It may not be possible for that hub to handle additional full (or low)
395 * speed transactions until that state is fully cleared out.
396 */
397void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
398{
399 struct usb_tt *tt = udev->tt;
400 unsigned long flags;
401 struct usb_tt_clear *clear;
402
403 /* we've got to cope with an arbitrary number of pending TT clears,
404 * since each TT has "at least two" buffers that can need it (and
405 * there can be many TTs per hub). even if they're uncommon.
406 */
407 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
408 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
409 /* FIXME recover somehow ... RESET_TT? */
410 return;
411 }
412
413 /* info that CLEAR_TT_BUFFER needs */
414 clear->tt = tt->multi ? udev->ttport : 1;
415 clear->devinfo = usb_pipeendpoint (pipe);
416 clear->devinfo |= udev->devnum << 4;
417 clear->devinfo |= usb_pipecontrol (pipe)
418 ? (USB_ENDPOINT_XFER_CONTROL << 11)
419 : (USB_ENDPOINT_XFER_BULK << 11);
420 if (usb_pipein (pipe))
421 clear->devinfo |= 1 << 15;
422
423 /* tell keventd to clear state for this TT */
424 spin_lock_irqsave (&tt->lock, flags);
425 list_add_tail (&clear->clear_list, &tt->clear_list);
426 schedule_work (&tt->kevent);
427 spin_unlock_irqrestore (&tt->lock, flags);
428}
429
430static void hub_power_on(struct usb_hub *hub)
431{
432 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700433 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400434 u16 wHubCharacteristics =
435 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Alan Stern4489a572006-04-27 15:54:22 -0400437 /* Enable power on each port. Some hubs have reserved values
438 * of LPSM (> 2) in their descriptors, even though they are
439 * USB 2.0 hubs. Some hubs do not implement port-power switching
440 * but only emulate it. In all cases, the ports won't work
441 * unless we send these messages to the hub.
442 */
443 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400445 else
446 dev_dbg(hub->intfdev, "trying to enable port power on "
447 "non-switchable hub\n");
448 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
449 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
David Brownellb7896962005-08-31 10:41:44 -0700451 /* Wait at least 100 msec for power to become stable */
452 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453}
454
David Brownell979d5192005-09-22 22:32:24 -0700455static inline void __hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
David Brownell979d5192005-09-22 22:32:24 -0700457 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700459 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700460 hub->resume_root_hub = 0;
461}
462
463static void hub_quiesce(struct usb_hub *hub)
464{
465 /* (blocking) stop khubd and related activity */
466 __hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 usb_kill_urb(hub->urb);
468 if (hub->has_indicators)
469 cancel_delayed_work(&hub->leds);
470 if (hub->has_indicators || hub->tt.hub)
471 flush_scheduled_work();
472}
473
474static void hub_activate(struct usb_hub *hub)
475{
476 int status;
477
478 hub->quiescing = 0;
479 hub->activating = 1;
David Brownell979d5192005-09-22 22:32:24 -0700480 hub->resume_root_hub = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 status = usb_submit_urb(hub->urb, GFP_NOIO);
482 if (status < 0)
483 dev_err(hub->intfdev, "activate --> %d\n", status);
484 if (hub->has_indicators && blinkenlights)
485 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
486
487 /* scan all ports ASAP */
488 kick_khubd(hub);
489}
490
491static int hub_hub_status(struct usb_hub *hub,
492 u16 *status, u16 *change)
493{
494 int ret;
495
496 ret = get_hub_status(hub->hdev, &hub->status->hub);
497 if (ret < 0)
498 dev_err (hub->intfdev,
499 "%s failed (err = %d)\n", __FUNCTION__, ret);
500 else {
501 *status = le16_to_cpu(hub->status->hub.wHubStatus);
502 *change = le16_to_cpu(hub->status->hub.wHubChange);
503 ret = 0;
504 }
505 return ret;
506}
507
Alan Stern8b28c752005-08-10 17:04:13 -0400508static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
509{
510 struct usb_device *hdev = hub->hdev;
511 int ret;
512
513 if (hdev->children[port1-1] && set_state) {
514 usb_set_device_state(hdev->children[port1-1],
515 USB_STATE_NOTATTACHED);
516 }
517 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
518 if (ret)
519 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
520 port1, ret);
521
522 return ret;
523}
524
Alan Stern7d069b72005-11-18 12:06:34 -0500525
526/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400527static void hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500528{
Alan Stern7de18d82006-06-01 13:37:24 -0400529 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Stern7d069b72005-11-18 12:06:34 -0500530 struct usb_device *hdev = hub->hdev;
531 int port1;
532
533 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
534 if (hdev->children[port1 - 1]) {
535 usb_disconnect(&hdev->children[port1 - 1]);
Alan Stern7de18d82006-06-01 13:37:24 -0400536 if (hub->error == 0)
Alan Stern7d069b72005-11-18 12:06:34 -0500537 hub_port_disable(hub, port1, 0);
538 }
539 }
540 hub_quiesce(hub);
541}
542
543/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400544static void hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500545{
Alan Stern7de18d82006-06-01 13:37:24 -0400546 struct usb_hub *hub = usb_get_intfdata(intf);
547
Alan Stern7d069b72005-11-18 12:06:34 -0500548 hub_activate(hub);
549 hub_power_on(hub);
550}
551
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553static int hub_configure(struct usb_hub *hub,
554 struct usb_endpoint_descriptor *endpoint)
555{
556 struct usb_device *hdev = hub->hdev;
557 struct device *hub_dev = hub->intfdev;
558 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700559 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 unsigned int pipe;
561 int maxp, ret;
562 char *message;
563
564 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
565 &hub->buffer_dma);
566 if (!hub->buffer) {
567 message = "can't allocate hub irq buffer";
568 ret = -ENOMEM;
569 goto fail;
570 }
571
572 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
573 if (!hub->status) {
574 message = "can't kmalloc hub status buffer";
575 ret = -ENOMEM;
576 goto fail;
577 }
578
579 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
580 if (!hub->descriptor) {
581 message = "can't kmalloc hub descriptor";
582 ret = -ENOMEM;
583 goto fail;
584 }
585
586 /* Request the entire hub descriptor.
587 * hub->descriptor can handle USB_MAXCHILDREN ports,
588 * but the hub can/will return fewer bytes here.
589 */
590 ret = get_hub_descriptor(hdev, hub->descriptor,
591 sizeof(*hub->descriptor));
592 if (ret < 0) {
593 message = "can't read hub descriptor";
594 goto fail;
595 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
596 message = "hub has too many ports!";
597 ret = -ENODEV;
598 goto fail;
599 }
600
601 hdev->maxchild = hub->descriptor->bNbrPorts;
602 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
603 (hdev->maxchild == 1) ? "" : "s");
604
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700605 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700607 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 int i;
609 char portstr [USB_MAXCHILDREN + 1];
610
611 for (i = 0; i < hdev->maxchild; i++)
612 portstr[i] = hub->descriptor->DeviceRemovable
613 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
614 ? 'F' : 'R';
615 portstr[hdev->maxchild] = 0;
616 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
617 } else
618 dev_dbg(hub_dev, "standalone hub\n");
619
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700620 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 case 0x00:
622 dev_dbg(hub_dev, "ganged power switching\n");
623 break;
624 case 0x01:
625 dev_dbg(hub_dev, "individual port power switching\n");
626 break;
627 case 0x02:
628 case 0x03:
629 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
630 break;
631 }
632
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700633 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 case 0x00:
635 dev_dbg(hub_dev, "global over-current protection\n");
636 break;
637 case 0x08:
638 dev_dbg(hub_dev, "individual port over-current protection\n");
639 break;
640 case 0x10:
641 case 0x18:
642 dev_dbg(hub_dev, "no over-current protection\n");
643 break;
644 }
645
646 spin_lock_init (&hub->tt.lock);
647 INIT_LIST_HEAD (&hub->tt.clear_list);
648 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
649 switch (hdev->descriptor.bDeviceProtocol) {
650 case 0:
651 break;
652 case 1:
653 dev_dbg(hub_dev, "Single TT\n");
654 hub->tt.hub = hdev;
655 break;
656 case 2:
657 ret = usb_set_interface(hdev, 0, 1);
658 if (ret == 0) {
659 dev_dbg(hub_dev, "TT per port\n");
660 hub->tt.multi = 1;
661 } else
662 dev_err(hub_dev, "Using single TT (err %d)\n",
663 ret);
664 hub->tt.hub = hdev;
665 break;
666 default:
667 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
668 hdev->descriptor.bDeviceProtocol);
669 break;
670 }
671
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700672 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700673 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700674 case HUB_TTTT_8_BITS:
675 if (hdev->descriptor.bDeviceProtocol != 0) {
676 hub->tt.think_time = 666;
677 dev_dbg(hub_dev, "TT requires at most %d "
678 "FS bit times (%d ns)\n",
679 8, hub->tt.think_time);
680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700682 case HUB_TTTT_16_BITS:
683 hub->tt.think_time = 666 * 2;
684 dev_dbg(hub_dev, "TT requires at most %d "
685 "FS bit times (%d ns)\n",
686 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700688 case HUB_TTTT_24_BITS:
689 hub->tt.think_time = 666 * 3;
690 dev_dbg(hub_dev, "TT requires at most %d "
691 "FS bit times (%d ns)\n",
692 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700694 case HUB_TTTT_32_BITS:
695 hub->tt.think_time = 666 * 4;
696 dev_dbg(hub_dev, "TT requires at most %d "
697 "FS bit times (%d ns)\n",
698 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 break;
700 }
701
702 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700703 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 hub->has_indicators = 1;
705 dev_dbg(hub_dev, "Port indicators are supported\n");
706 }
707
708 dev_dbg(hub_dev, "power on to power good time: %dms\n",
709 hub->descriptor->bPwrOn2PwrGood * 2);
710
711 /* power budgeting mostly matters with bus-powered hubs,
712 * and battery-powered root hubs (may provide just 8 mA).
713 */
714 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500715 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 message = "can't get hub status";
717 goto fail;
718 }
Alan Stern7d35b922005-04-25 11:18:32 -0400719 le16_to_cpus(&hubstatus);
720 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500721 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
722 hub->mA_per_port = 500;
723 else {
724 hub->mA_per_port = hdev->bus_mA;
725 hub->limited_power = 1;
726 }
Alan Stern7d35b922005-04-25 11:18:32 -0400727 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
729 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500730 hub->limited_power = 1;
731 if (hdev->maxchild > 0) {
732 int remaining = hdev->bus_mA -
733 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Alan Stern55c52712005-11-23 12:03:12 -0500735 if (remaining < hdev->maxchild * 100)
736 dev_warn(hub_dev,
737 "insufficient power available "
738 "to use all downstream ports\n");
739 hub->mA_per_port = 100; /* 7.2.1.1 */
740 }
741 } else { /* Self-powered external hub */
742 /* FIXME: What about battery-powered external hubs that
743 * provide less current per port? */
744 hub->mA_per_port = 500;
745 }
746 if (hub->mA_per_port < 500)
747 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
748 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750 ret = hub_hub_status(hub, &hubstatus, &hubchange);
751 if (ret < 0) {
752 message = "can't get hub status";
753 goto fail;
754 }
755
756 /* local power status reports aren't always correct */
757 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
758 dev_dbg(hub_dev, "local power source is %s\n",
759 (hubstatus & HUB_STATUS_LOCAL_POWER)
760 ? "lost (inactive)" : "good");
761
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700762 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 dev_dbg(hub_dev, "%sover-current condition exists\n",
764 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
765
766 /* set up the interrupt endpoint */
767 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
768 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
769
770 if (maxp > sizeof(*hub->buffer))
771 maxp = sizeof(*hub->buffer);
772
773 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
774 if (!hub->urb) {
775 message = "couldn't allocate interrupt urb";
776 ret = -ENOMEM;
777 goto fail;
778 }
779
780 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
781 hub, endpoint->bInterval);
782 hub->urb->transfer_dma = hub->buffer_dma;
783 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
784
785 /* maybe cycle the hub leds */
786 if (hub->has_indicators && blinkenlights)
787 hub->indicator [0] = INDICATOR_CYCLE;
788
789 hub_power_on(hub);
790 hub_activate(hub);
791 return 0;
792
793fail:
794 dev_err (hub_dev, "config failed, %s (err %d)\n",
795 message, ret);
796 /* hub_disconnect() frees urb and descriptor */
797 return ret;
798}
799
800static unsigned highspeed_hubs;
801
802static void hub_disconnect(struct usb_interface *intf)
803{
804 struct usb_hub *hub = usb_get_intfdata (intf);
805 struct usb_device *hdev;
806
Alan Stern7de18d82006-06-01 13:37:24 -0400807 /* Disconnect all children and quiesce the hub */
808 hub->error = 0;
809 hub_pre_reset(intf);
810
Alan Stern8b28c752005-08-10 17:04:13 -0400811 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 hdev = hub->hdev;
813
814 if (hdev->speed == USB_SPEED_HIGH)
815 highspeed_hubs--;
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 usb_free_urb(hub->urb);
818 hub->urb = NULL;
819
820 spin_lock_irq(&hub_event_lock);
821 list_del_init(&hub->event_list);
822 spin_unlock_irq(&hub_event_lock);
823
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700824 kfree(hub->descriptor);
825 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700827 kfree(hub->status);
828 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830 if (hub->buffer) {
831 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
832 hub->buffer_dma);
833 hub->buffer = NULL;
834 }
835
Alan Stern7d069b72005-11-18 12:06:34 -0500836 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837}
838
839static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
840{
841 struct usb_host_interface *desc;
842 struct usb_endpoint_descriptor *endpoint;
843 struct usb_device *hdev;
844 struct usb_hub *hub;
845
846 desc = intf->cur_altsetting;
847 hdev = interface_to_usbdev(intf);
848
David Brownell89ccbdc2006-04-02 10:18:09 -0800849#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
850 if (hdev->parent) {
851 dev_warn(&intf->dev, "ignoring external hub\n");
852 return -ENODEV;
853 }
854#endif
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 /* Some hubs have a subclass of 1, which AFAICT according to the */
857 /* specs is not defined, but it works */
858 if ((desc->desc.bInterfaceSubClass != 0) &&
859 (desc->desc.bInterfaceSubClass != 1)) {
860descriptor_error:
861 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
862 return -EIO;
863 }
864
865 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
866 if (desc->desc.bNumEndpoints != 1)
867 goto descriptor_error;
868
869 endpoint = &desc->endpoint[0].desc;
870
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700871 /* If it's not an interrupt in endpoint, we'd better punt! */
872 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 goto descriptor_error;
874
875 /* We found a hub */
876 dev_info (&intf->dev, "USB hub found\n");
877
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400878 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 if (!hub) {
880 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
881 return -ENOMEM;
882 }
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 INIT_LIST_HEAD(&hub->event_list);
885 hub->intfdev = &intf->dev;
886 hub->hdev = hdev;
887 INIT_WORK(&hub->leds, led_work, hub);
888
889 usb_set_intfdata (intf, hub);
890
891 if (hdev->speed == USB_SPEED_HIGH)
892 highspeed_hubs++;
893
894 if (hub_configure(hub, endpoint) >= 0)
895 return 0;
896
897 hub_disconnect (intf);
898 return -ENODEV;
899}
900
901static int
902hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
903{
904 struct usb_device *hdev = interface_to_usbdev (intf);
905
906 /* assert ifno == 0 (part of hub spec) */
907 switch (code) {
908 case USBDEVFS_HUB_PORTINFO: {
909 struct usbdevfs_hub_portinfo *info = user_data;
910 int i;
911
912 spin_lock_irq(&device_state_lock);
913 if (hdev->devnum <= 0)
914 info->nports = 0;
915 else {
916 info->nports = hdev->maxchild;
917 for (i = 0; i < info->nports; i++) {
918 if (hdev->children[i] == NULL)
919 info->port[i] = 0;
920 else
921 info->port[i] =
922 hdev->children[i]->devnum;
923 }
924 }
925 spin_unlock_irq(&device_state_lock);
926
927 return info->nports + 1;
928 }
929
930 default:
931 return -ENOSYS;
932 }
933}
934
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936/* grab device/port lock, returning index of that port (zero based).
937 * protects the upstream link used by this device from concurrent
938 * tree operations like suspend, resume, reset, and disconnect, which
939 * apply to everything downstream of a given port.
940 */
941static int locktree(struct usb_device *udev)
942{
943 int t;
944 struct usb_device *hdev;
945
946 if (!udev)
947 return -ENODEV;
948
949 /* root hub is always the first lock in the series */
950 hdev = udev->parent;
951 if (!hdev) {
952 usb_lock_device(udev);
953 return 0;
954 }
955
956 /* on the path from root to us, lock everything from
957 * top down, dropping parent locks when not needed
958 */
959 t = locktree(hdev);
960 if (t < 0)
961 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Alan Stern12c3da32005-11-23 12:09:52 -0500963 /* everything is fail-fast once disconnect
964 * processing starts
965 */
966 if (udev->state == USB_STATE_NOTATTACHED) {
967 usb_unlock_device(hdev);
968 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 }
Alan Stern12c3da32005-11-23 12:09:52 -0500970
971 /* when everyone grabs locks top->bottom,
972 * non-overlapping work may be concurrent
973 */
974 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -0500976 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977}
978
979static void recursively_mark_NOTATTACHED(struct usb_device *udev)
980{
981 int i;
982
983 for (i = 0; i < udev->maxchild; ++i) {
984 if (udev->children[i])
985 recursively_mark_NOTATTACHED(udev->children[i]);
986 }
987 udev->state = USB_STATE_NOTATTACHED;
988}
989
990/**
991 * usb_set_device_state - change a device's current state (usbcore, hcds)
992 * @udev: pointer to device whose state should be changed
993 * @new_state: new state value to be stored
994 *
995 * udev->state is _not_ fully protected by the device lock. Although
996 * most transitions are made only while holding the lock, the state can
997 * can change to USB_STATE_NOTATTACHED at almost any time. This
998 * is so that devices can be marked as disconnected as soon as possible,
999 * without having to wait for any semaphores to be released. As a result,
1000 * all changes to any device's state must be protected by the
1001 * device_state_lock spinlock.
1002 *
1003 * Once a device has been added to the device tree, all changes to its state
1004 * should be made using this routine. The state should _not_ be set directly.
1005 *
1006 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1007 * Otherwise udev->state is set to new_state, and if new_state is
1008 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1009 * to USB_STATE_NOTATTACHED.
1010 */
1011void usb_set_device_state(struct usb_device *udev,
1012 enum usb_device_state new_state)
1013{
1014 unsigned long flags;
1015
1016 spin_lock_irqsave(&device_state_lock, flags);
1017 if (udev->state == USB_STATE_NOTATTACHED)
1018 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001019 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001020
1021 /* root hub wakeup capabilities are managed out-of-band
1022 * and may involve silicon errata ... ignore them here.
1023 */
1024 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001025 if (udev->state == USB_STATE_SUSPENDED
1026 || new_state == USB_STATE_SUSPENDED)
1027 ; /* No change to wakeup settings */
1028 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001029 device_init_wakeup(&udev->dev,
1030 (udev->actconfig->desc.bmAttributes
1031 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001032 else
David Brownellfb669cc2006-01-24 08:40:27 -08001033 device_init_wakeup(&udev->dev, 0);
1034 }
Alan Stern645daaa2006-08-30 15:47:02 -04001035 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001036 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 recursively_mark_NOTATTACHED(udev);
1038 spin_unlock_irqrestore(&device_state_lock, flags);
1039}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
1041
Alan Sternd388dab2006-07-01 22:14:24 -04001042#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001043
1044/**
1045 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1046 * @rhdev: struct usb_device for the root hub
1047 *
1048 * The USB host controller driver calls this function when its root hub
1049 * is resumed and Vbus power has been interrupted or the controller
1050 * has been reset. The routine marks all the children of the root hub
1051 * as NOTATTACHED and marks logical connect-change events on their ports.
1052 */
1053void usb_root_hub_lost_power(struct usb_device *rhdev)
1054{
1055 struct usb_hub *hub;
1056 int port1;
1057 unsigned long flags;
1058
1059 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1060 spin_lock_irqsave(&device_state_lock, flags);
1061 hub = hdev_to_hub(rhdev);
1062 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1063 if (rhdev->children[port1 - 1]) {
1064 recursively_mark_NOTATTACHED(
1065 rhdev->children[port1 - 1]);
1066 set_bit(port1, hub->change_bits);
1067 }
1068 }
1069 spin_unlock_irqrestore(&device_state_lock, flags);
1070}
1071EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1072
Alan Sternd388dab2006-07-01 22:14:24 -04001073#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001074
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075static void choose_address(struct usb_device *udev)
1076{
1077 int devnum;
1078 struct usb_bus *bus = udev->bus;
1079
1080 /* If khubd ever becomes multithreaded, this will need a lock */
1081
1082 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1083 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1084 bus->devnum_next);
1085 if (devnum >= 128)
1086 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1087
1088 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1089
1090 if (devnum < 128) {
1091 set_bit(devnum, bus->devmap.devicemap);
1092 udev->devnum = devnum;
1093 }
1094}
1095
1096static void release_address(struct usb_device *udev)
1097{
1098 if (udev->devnum > 0) {
1099 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1100 udev->devnum = -1;
1101 }
1102}
1103
1104/**
1105 * usb_disconnect - disconnect a device (usbcore-internal)
1106 * @pdev: pointer to device being disconnected
1107 * Context: !in_interrupt ()
1108 *
1109 * Something got disconnected. Get rid of it and all of its children.
1110 *
1111 * If *pdev is a normal device then the parent hub must already be locked.
1112 * If *pdev is a root hub then this routine will acquire the
1113 * usb_bus_list_lock on behalf of the caller.
1114 *
1115 * Only hub drivers (including virtual root hub drivers for host
1116 * controllers) should ever call this.
1117 *
1118 * This call is synchronous, and may not be used in an interrupt context.
1119 */
1120void usb_disconnect(struct usb_device **pdev)
1121{
1122 struct usb_device *udev = *pdev;
1123 int i;
1124
1125 if (!udev) {
1126 pr_debug ("%s nodev\n", __FUNCTION__);
1127 return;
1128 }
1129
1130 /* mark the device as inactive, so any further urb submissions for
1131 * this device (and any of its children) will fail immediately.
1132 * this quiesces everyting except pending urbs.
1133 */
1134 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1136
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001137 usb_lock_device(udev);
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 /* Free up all the children before we remove this device */
1140 for (i = 0; i < USB_MAXCHILDREN; i++) {
1141 if (udev->children[i])
1142 usb_disconnect(&udev->children[i]);
1143 }
1144
1145 /* deallocate hcd/hardware state ... nuking all pending urbs and
1146 * cleaning up all state associated with the current configuration
1147 * so that the hardware is now fully quiesced.
1148 */
Alan Stern782da722006-07-01 22:09:35 -04001149 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 usb_disable_device(udev, 0);
1151
Alan Stern782da722006-07-01 22:09:35 -04001152 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001153
Alan Stern782da722006-07-01 22:09:35 -04001154 /* Unregister the device. The device driver is responsible
1155 * for removing the device files from usbfs and sysfs and for
1156 * de-configuring the device.
1157 */
1158 device_del(&udev->dev);
1159
1160 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 * (or root_hub) pointer.
1162 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
1165 /* Avoid races with recursively_mark_NOTATTACHED() */
1166 spin_lock_irq(&device_state_lock);
1167 *pdev = NULL;
1168 spin_unlock_irq(&device_state_lock);
1169
Alan Stern782da722006-07-01 22:09:35 -04001170 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171}
1172
1173#ifdef DEBUG
1174static void show_string(struct usb_device *udev, char *id, char *string)
1175{
1176 if (!string)
1177 return;
1178 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1179}
1180
1181#else
1182static inline void show_string(struct usb_device *udev, char *id, char *string)
1183{}
1184#endif
1185
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186
1187#ifdef CONFIG_USB_OTG
1188#include "otg_whitelist.h"
1189#endif
1190
1191/**
1192 * usb_new_device - perform initial device setup (usbcore-internal)
1193 * @udev: newly addressed device (in ADDRESS state)
1194 *
1195 * This is called with devices which have been enumerated, but not yet
1196 * configured. The device descriptor is available, but not descriptors
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001197 * for any device configuration. The caller must have locked either
1198 * the parent hub (if udev is a normal device) or else the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1200 * udev has already been installed, but udev is not yet visible through
1201 * sysfs or other filesystem code.
1202 *
1203 * Returns 0 for success (device is configured and listed, with its
1204 * interfaces, in sysfs); else a negative errno value.
1205 *
1206 * This call is synchronous, and may not be used in an interrupt context.
1207 *
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001208 * Only the hub driver or root-hub registrar should ever call this.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 */
1210int usb_new_device(struct usb_device *udev)
1211{
1212 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
1214 err = usb_get_configuration(udev);
1215 if (err < 0) {
1216 dev_err(&udev->dev, "can't read configurations, error %d\n",
1217 err);
1218 goto fail;
1219 }
1220
1221 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001222 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1223 udev->manufacturer = usb_cache_string(udev,
1224 udev->descriptor.iManufacturer);
1225 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 /* Tell the world! */
1228 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1229 "SerialNumber=%d\n",
1230 udev->descriptor.iManufacturer,
1231 udev->descriptor.iProduct,
1232 udev->descriptor.iSerialNumber);
1233 show_string(udev, "Product", udev->product);
1234 show_string(udev, "Manufacturer", udev->manufacturer);
1235 show_string(udev, "SerialNumber", udev->serial);
1236
1237#ifdef CONFIG_USB_OTG
1238 /*
1239 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1240 * to wake us after we've powered off VBUS; and HNP, switching roles
1241 * "host" to "peripheral". The OTG descriptor helps figure this out.
1242 */
1243 if (!udev->bus->is_b_host
1244 && udev->config
1245 && udev->parent == udev->bus->root_hub) {
1246 struct usb_otg_descriptor *desc = 0;
1247 struct usb_bus *bus = udev->bus;
1248
1249 /* descriptor may appear anywhere in config */
1250 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1251 le16_to_cpu(udev->config[0].desc.wTotalLength),
1252 USB_DT_OTG, (void **) &desc) == 0) {
1253 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001254 unsigned port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 struct usb_device *root = udev->parent;
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 dev_info(&udev->dev,
1258 "Dual-Role OTG device on %sHNP port\n",
1259 (port1 == bus->otg_port)
1260 ? "" : "non-");
1261
1262 /* enable HNP before suspend, it's simpler */
1263 if (port1 == bus->otg_port)
1264 bus->b_hnp_enable = 1;
1265 err = usb_control_msg(udev,
1266 usb_sndctrlpipe(udev, 0),
1267 USB_REQ_SET_FEATURE, 0,
1268 bus->b_hnp_enable
1269 ? USB_DEVICE_B_HNP_ENABLE
1270 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1271 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1272 if (err < 0) {
1273 /* OTG MESSAGE: report errors here,
1274 * customize to match your product.
1275 */
1276 dev_info(&udev->dev,
1277 "can't set HNP mode; %d\n",
1278 err);
1279 bus->b_hnp_enable = 0;
1280 }
1281 }
1282 }
1283 }
1284
1285 if (!is_targeted(udev)) {
1286
1287 /* Maybe it can talk to us, though we can't talk to it.
1288 * (Includes HNP test device.)
1289 */
1290 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern140d8f62006-07-01 22:07:21 -04001291 static int __usb_port_suspend(struct usb_device *,
David Brownell390a8c32005-09-13 19:57:27 -07001292 int port1);
Alan Stern140d8f62006-07-01 22:07:21 -04001293 err = __usb_port_suspend(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if (err < 0)
1295 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1296 }
1297 err = -ENODEV;
1298 goto fail;
1299 }
1300#endif
1301
Alan Stern782da722006-07-01 22:09:35 -04001302 /* Register the device. The device driver is responsible
1303 * for adding the device files to usbfs and sysfs and for
1304 * configuring the device.
1305 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 err = device_add (&udev->dev);
1307 if (err) {
1308 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1309 goto fail;
1310 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 return 0;
1313
1314fail:
1315 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1316 return err;
1317}
1318
1319
1320static int hub_port_status(struct usb_hub *hub, int port1,
1321 u16 *status, u16 *change)
1322{
1323 int ret;
1324
1325 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1326 if (ret < 0)
1327 dev_err (hub->intfdev,
1328 "%s failed (err = %d)\n", __FUNCTION__, ret);
1329 else {
1330 *status = le16_to_cpu(hub->status->port.wPortStatus);
1331 *change = le16_to_cpu(hub->status->port.wPortChange);
1332 ret = 0;
1333 }
1334 return ret;
1335}
1336
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001337
1338/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1339static unsigned hub_is_wusb(struct usb_hub *hub)
1340{
1341 struct usb_hcd *hcd;
1342 if (hub->hdev->parent != NULL) /* not a root hub? */
1343 return 0;
1344 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1345 return hcd->wireless;
1346}
1347
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349#define PORT_RESET_TRIES 5
1350#define SET_ADDRESS_TRIES 2
1351#define GET_DESCRIPTOR_TRIES 2
1352#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1353#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1354
1355#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1356#define HUB_SHORT_RESET_TIME 10
1357#define HUB_LONG_RESET_TIME 200
1358#define HUB_RESET_TIMEOUT 500
1359
1360static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1361 struct usb_device *udev, unsigned int delay)
1362{
1363 int delay_time, ret;
1364 u16 portstatus;
1365 u16 portchange;
1366
1367 for (delay_time = 0;
1368 delay_time < HUB_RESET_TIMEOUT;
1369 delay_time += delay) {
1370 /* wait to give the device a chance to reset */
1371 msleep(delay);
1372
1373 /* read and decode port status */
1374 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1375 if (ret < 0)
1376 return ret;
1377
1378 /* Device went away? */
1379 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1380 return -ENOTCONN;
1381
1382 /* bomb out completely if something weird happened */
1383 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1384 return -EINVAL;
1385
1386 /* if we`ve finished resetting, then break out of the loop */
1387 if (!(portstatus & USB_PORT_STAT_RESET) &&
1388 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001389 if (hub_is_wusb(hub))
1390 udev->speed = USB_SPEED_VARIABLE;
1391 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 udev->speed = USB_SPEED_HIGH;
1393 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1394 udev->speed = USB_SPEED_LOW;
1395 else
1396 udev->speed = USB_SPEED_FULL;
1397 return 0;
1398 }
1399
1400 /* switch to the long delay after two short delay failures */
1401 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1402 delay = HUB_LONG_RESET_TIME;
1403
1404 dev_dbg (hub->intfdev,
1405 "port %d not reset yet, waiting %dms\n",
1406 port1, delay);
1407 }
1408
1409 return -EBUSY;
1410}
1411
1412static int hub_port_reset(struct usb_hub *hub, int port1,
1413 struct usb_device *udev, unsigned int delay)
1414{
1415 int i, status;
1416
1417 /* Reset the port */
1418 for (i = 0; i < PORT_RESET_TRIES; i++) {
1419 status = set_port_feature(hub->hdev,
1420 port1, USB_PORT_FEAT_RESET);
1421 if (status)
1422 dev_err(hub->intfdev,
1423 "cannot reset port %d (err = %d)\n",
1424 port1, status);
1425 else {
1426 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001427 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 dev_dbg(hub->intfdev,
1429 "port_wait_reset: err = %d\n",
1430 status);
1431 }
1432
1433 /* return on disconnect or reset */
1434 switch (status) {
1435 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001436 /* TRSTRCY = 10 ms; plus some extra */
1437 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 /* FALL THROUGH */
1439 case -ENOTCONN:
1440 case -ENODEV:
1441 clear_port_feature(hub->hdev,
1442 port1, USB_PORT_FEAT_C_RESET);
1443 /* FIXME need disconnect() for NOTATTACHED device */
1444 usb_set_device_state(udev, status
1445 ? USB_STATE_NOTATTACHED
1446 : USB_STATE_DEFAULT);
1447 return status;
1448 }
1449
1450 dev_dbg (hub->intfdev,
1451 "port %d not enabled, trying reset again...\n",
1452 port1);
1453 delay = HUB_LONG_RESET_TIME;
1454 }
1455
1456 dev_err (hub->intfdev,
1457 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1458 port1);
1459
1460 return status;
1461}
1462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463/*
1464 * Disable a port and mark a logical connnect-change event, so that some
1465 * time later khubd will disconnect() any existing usb_device on the port
1466 * and will re-enumerate if there actually is a device attached.
1467 */
1468static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1469{
1470 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1471 hub_port_disable(hub, port1, 1);
1472
1473 /* FIXME let caller ask to power down the port:
1474 * - some devices won't enumerate without a VBUS power cycle
1475 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001476 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 * That's easy if this hub can switch power per-port, and
1478 * khubd reactivates the port later (timer, SRP, etc).
1479 * Powerdown must be optional, because of reset/DFU.
1480 */
1481
1482 set_bit(port1, hub->change_bits);
1483 kick_khubd(hub);
1484}
1485
Alan Sternd388dab2006-07-01 22:14:24 -04001486#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
1488#ifdef CONFIG_USB_SUSPEND
1489
1490/*
1491 * Selective port suspend reduces power; most suspended devices draw
1492 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1493 * All devices below the suspended port are also suspended.
1494 *
1495 * Devices leave suspend state when the host wakes them up. Some devices
1496 * also support "remote wakeup", where the device can activate the USB
1497 * tree above them to deliver data, such as a keypress or packet. In
1498 * some cases, this wakes the USB host.
1499 */
1500static int hub_port_suspend(struct usb_hub *hub, int port1,
1501 struct usb_device *udev)
1502{
1503 int status;
1504
1505 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1506
1507 /* enable remote wakeup when appropriate; this lets the device
1508 * wake up the upstream hub (including maybe the root hub).
1509 *
1510 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1511 * we don't explicitly enable it here.
1512 */
Alan Stern645daaa2006-08-30 15:47:02 -04001513 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1515 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1516 USB_DEVICE_REMOTE_WAKEUP, 0,
1517 NULL, 0,
1518 USB_CTRL_SET_TIMEOUT);
1519 if (status)
1520 dev_dbg(&udev->dev,
1521 "won't remote wakeup, status %d\n",
1522 status);
1523 }
1524
1525 /* see 7.1.7.6 */
1526 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1527 if (status) {
1528 dev_dbg(hub->intfdev,
1529 "can't suspend port %d, status %d\n",
1530 port1, status);
1531 /* paranoia: "should not happen" */
1532 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1533 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1534 USB_DEVICE_REMOTE_WAKEUP, 0,
1535 NULL, 0,
1536 USB_CTRL_SET_TIMEOUT);
1537 } else {
1538 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001539 dev_dbg(&udev->dev, "usb %ssuspend\n",
1540 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1542 msleep(10);
1543 }
1544 return status;
1545}
1546
1547/*
1548 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001549 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 * State transitions include:
1551 *
1552 * - suspend, resume ... when the VBUS power link stays live
1553 * - suspend, disconnect ... VBUS lost
1554 *
1555 * Once VBUS drop breaks the circuit, the port it's using has to go through
1556 * normal re-enumeration procedures, starting with enabling VBUS power.
1557 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1558 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1559 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001560 *
1561 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1562 * the root hub for their bus goes into global suspend ... so we don't
1563 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 */
Alan Stern140d8f62006-07-01 22:07:21 -04001565static int __usb_port_suspend (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566{
David Brownellf3f32532005-09-22 22:37:29 -07001567 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
1569 /* caller owns the udev device lock */
1570 if (port1 < 0)
1571 return port1;
1572
Alan Stern140d8f62006-07-01 22:07:21 -04001573 /* we change the device's upstream USB link,
1574 * but root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 */
David Brownellf3f32532005-09-22 22:37:29 -07001576 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1578 udev);
Alan Stern2bf40862006-07-01 22:12:19 -04001579 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001580 dev_dbg(&udev->dev, "usb %ssuspend\n",
1581 udev->auto_pm ? "auto-" : "");
Alan Stern2bf40862006-07-01 22:12:19 -04001582 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 return status;
1585}
1586
David Brownell5edbfb72005-09-22 22:45:26 -07001587/*
Alan Stern140d8f62006-07-01 22:07:21 -04001588 * usb_port_suspend - suspend a usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001590 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 *
1592 * Suspends a USB device that isn't in active use, conserving power.
1593 * Devices may wake out of a suspend, if anything important happens,
1594 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001595 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 * to disconnect devices while they are suspended.
1597 *
David Brownell390a8c32005-09-13 19:57:27 -07001598 * This only affects the USB hardware for a device; its interfaces
1599 * (and, for hubs, child devices) must already have been suspended.
1600 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 * Suspending OTG devices may trigger HNP, if that's been enabled
1602 * between a pair of dual-role devices. That will change roles, such
1603 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1604 *
1605 * Returns 0 on success, else negative errno.
1606 */
Alan Stern140d8f62006-07-01 22:07:21 -04001607int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608{
Alan Stern140d8f62006-07-01 22:07:21 -04001609 return __usb_port_suspend(udev, udev->portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610}
David Brownellf3f32532005-09-22 22:37:29 -07001611
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612/*
David Brownell390a8c32005-09-13 19:57:27 -07001613 * If the USB "suspend" state is in use (rather than "global suspend"),
1614 * many devices will be individually taken out of suspend state using
1615 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 * hardware resume signaling is finished, either because of selective
1617 * resume (by host) or remote wakeup (by device) ... now see what changed
1618 * in the tree that's rooted at this device.
1619 */
Alan Stern140d8f62006-07-01 22:07:21 -04001620static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621{
1622 int status;
1623 u16 devstatus;
1624
1625 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001626 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
1628 /* usb ch9 identifies four variants of SUSPENDED, based on what
1629 * state the device resumes to. Linux currently won't see the
1630 * first two on the host side; they'd be inside hub_port_init()
1631 * during many timeouts, but khubd can't suspend until later.
1632 */
1633 usb_set_device_state(udev, udev->actconfig
1634 ? USB_STATE_CONFIGURED
1635 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 /* 10.5.4.5 says be sure devices in the tree are still there.
1638 * For now let's assume the device didn't go crazy on resume,
1639 * and device drivers will know about any resume quirks.
1640 */
1641 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001642 if (status >= 0)
1643 status = (status == 2 ? 0 : -ENODEV);
1644
1645 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 dev_dbg(&udev->dev,
1647 "gone after usb resume? status %d\n",
1648 status);
1649 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001651 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001652 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 status = usb_control_msg(udev,
1654 usb_sndctrlpipe(udev, 0),
1655 USB_REQ_CLEAR_FEATURE,
1656 USB_RECIP_DEVICE,
1657 USB_DEVICE_REMOTE_WAKEUP, 0,
1658 NULL, 0,
1659 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001660 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 dev_dbg(&udev->dev, "disable remote "
1662 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001663 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 status = 0;
1665
1666 } else if (udev->devnum <= 0) {
1667 dev_dbg(&udev->dev, "bogus resume!\n");
1668 status = -EINVAL;
1669 }
1670 return status;
1671}
1672
1673static int
1674hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1675{
1676 int status;
1677
1678 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1679
Alan Sternd5cbad42006-08-11 16:52:39 -04001680 set_bit(port1, hub->busy_bits);
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 /* see 7.1.7.7; affects power usage, but not budgeting */
1683 status = clear_port_feature(hub->hdev,
1684 port1, USB_PORT_FEAT_SUSPEND);
1685 if (status) {
1686 dev_dbg(hub->intfdev,
1687 "can't resume port %d, status %d\n",
1688 port1, status);
1689 } else {
1690 u16 devstatus;
1691 u16 portchange;
1692
1693 /* drive resume for at least 20 msec */
1694 if (udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001695 dev_dbg(&udev->dev, "usb %sresume\n",
1696 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 msleep(25);
1698
1699#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1700 | USB_PORT_STAT_ENABLE \
1701 | USB_PORT_STAT_CONNECTION)
1702
1703 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1704 * stop resume signaling. Then finish the resume
1705 * sequence.
1706 */
1707 devstatus = portchange = 0;
1708 status = hub_port_status(hub, port1,
1709 &devstatus, &portchange);
1710 if (status < 0
1711 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1712 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1713 ) {
1714 dev_dbg(hub->intfdev,
1715 "port %d status %04x.%04x after resume, %d\n",
1716 port1, portchange, devstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001717 if (status >= 0)
1718 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 } else {
Alan Stern20307942006-06-28 11:20:41 -04001720 if (portchange & USB_PORT_STAT_C_SUSPEND)
1721 clear_port_feature(hub->hdev, port1,
1722 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 /* TRSMRCY = 10 msec */
1724 msleep(10);
1725 if (udev)
Alan Stern140d8f62006-07-01 22:07:21 -04001726 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 }
1728 }
1729 if (status < 0)
1730 hub_port_logical_disconnect(hub, port1);
1731
Alan Sternd5cbad42006-08-11 16:52:39 -04001732 clear_bit(port1, hub->busy_bits);
1733 if (!hub->hdev->parent && !hub->busy_bits[0])
1734 usb_enable_root_hub_irq(hub->hdev->bus);
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 return status;
1737}
1738
David Brownell5edbfb72005-09-22 22:45:26 -07001739/*
Alan Stern140d8f62006-07-01 22:07:21 -04001740 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001742 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 *
1744 * This will re-activate the suspended device, increasing power usage
1745 * while letting drivers communicate again with its endpoints.
1746 * USB resume explicitly guarantees that the power session between
1747 * the host and the device is the same as it was when the device
1748 * suspended.
1749 *
1750 * Returns 0 on success, else negative errno.
1751 */
Alan Stern140d8f62006-07-01 22:07:21 -04001752int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753{
Alan Sternd388dab2006-07-01 22:14:24 -04001754 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755
Alan Stern140d8f62006-07-01 22:07:21 -04001756 /* we change the device's upstream USB link,
1757 * but root hubs have no upstream USB link.
1758 */
David Brownellf3f32532005-09-22 22:37:29 -07001759 if (udev->parent) {
Alan Stern114b3682006-07-01 22:13:04 -04001760 // NOTE this fails if parent is also suspended...
1761 status = hub_port_resume(hdev_to_hub(udev->parent),
1762 udev->portnum, udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001763 } else {
1764 dev_dbg(&udev->dev, "usb %sresume\n",
1765 udev->auto_pm ? "auto-" : "");
Alan Stern140d8f62006-07-01 22:07:21 -04001766 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001767 }
David Brownellf3f32532005-09-22 22:37:29 -07001768 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001769 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 return status;
1771}
1772
1773static int remote_wakeup(struct usb_device *udev)
1774{
1775 int status = 0;
1776
Alan Stern645daaa2006-08-30 15:47:02 -04001777 /* All this just to avoid sending a port-resume message
1778 * to the parent hub! */
1779
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001780 usb_lock_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001781 mutex_lock_nested(&udev->pm_mutex, udev->level);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001783 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 /* TRSMRCY = 10 msec */
1785 msleep(10);
Alan Stern140d8f62006-07-01 22:07:21 -04001786 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001787 if (status == 0)
1788 udev->dev.power.power_state.event = PM_EVENT_ON;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 }
Alan Stern645daaa2006-08-30 15:47:02 -04001790 mutex_unlock(&udev->pm_mutex);
Alan Sterna8e7c562006-07-01 22:11:02 -04001791
1792 if (status == 0)
Alan Stern645daaa2006-08-30 15:47:02 -04001793 usb_autoresume_device(udev, 0);
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001794 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 return status;
1796}
1797
Alan Sternd388dab2006-07-01 22:14:24 -04001798#else /* CONFIG_USB_SUSPEND */
1799
1800/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1801
1802int usb_port_suspend(struct usb_device *udev)
1803{
1804 return 0;
1805}
1806
1807static inline int
1808finish_port_resume(struct usb_device *udev)
1809{
1810 return 0;
1811}
1812
1813static inline int
1814hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1815{
1816 return 0;
1817}
1818
1819int usb_port_resume(struct usb_device *udev)
1820{
1821 return 0;
1822}
1823
1824static inline int remote_wakeup(struct usb_device *udev)
1825{
1826 return 0;
1827}
1828
1829#endif
1830
David Brownelldb690872005-09-13 19:56:33 -07001831static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832{
1833 struct usb_hub *hub = usb_get_intfdata (intf);
1834 struct usb_device *hdev = hub->hdev;
1835 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
David Brownellc9f89fa2005-09-13 19:57:04 -07001837 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1839 struct usb_device *udev;
1840
1841 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001842 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001843#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001844 udev->state != USB_STATE_SUSPENDED
1845#else
1846 udev->dev.power.power_state.event
1847 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001848#endif
Alan Stern114b3682006-07-01 22:13:04 -04001849 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001850 if (!hdev->auto_pm)
1851 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1852 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001853 return -EBUSY;
1854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
1856
David Brownellf3f32532005-09-22 22:37:29 -07001857 /* "global suspend" of the downstream HC-to-USB interface */
1858 if (!hdev->parent) {
1859 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001860 if (bus) {
1861 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001862
1863 if (status != 0) {
1864 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1865 status);
1866 return status;
1867 }
1868 } else
1869 return -EOPNOTSUPP;
1870 }
1871
David Brownellc9f89fa2005-09-13 19:57:04 -07001872 /* stop khubd and related activity */
1873 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 return 0;
1875}
1876
1877static int hub_resume(struct usb_interface *intf)
1878{
1879 struct usb_device *hdev = interface_to_usbdev(intf);
1880 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 int status;
1882
David Brownellf3f32532005-09-22 22:37:29 -07001883 /* "global resume" of the downstream HC-to-USB interface */
1884 if (!hdev->parent) {
1885 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001886 if (bus) {
1887 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001888 if (status) {
1889 dev_dbg(&intf->dev, "'global' resume %d\n",
1890 status);
1891 return status;
1892 }
1893 } else
1894 return -EOPNOTSUPP;
1895 if (status == 0) {
1896 /* TRSMRCY = 10 msec */
1897 msleep(10);
1898 }
1899 }
1900
Alan Sterna8e7c562006-07-01 22:11:02 -04001901 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001902 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 return 0;
1904}
1905
Alan Sternd388dab2006-07-01 22:14:24 -04001906#else /* CONFIG_PM */
1907
1908static inline int remote_wakeup(struct usb_device *udev)
1909{
1910 return 0;
1911}
1912
Andrew Morton511366d2006-08-14 23:11:02 -07001913#define hub_suspend NULL
1914#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04001915#endif
1916
David Brownell979d5192005-09-22 22:32:24 -07001917void usb_suspend_root_hub(struct usb_device *hdev)
1918{
1919 struct usb_hub *hub = hdev_to_hub(hdev);
1920
1921 /* This also makes any led blinker stop retriggering. We're called
1922 * from irq, so the blinker might still be scheduled. Caller promises
1923 * that the root hub status URB will be canceled.
1924 */
1925 __hub_quiesce(hub);
1926 mark_quiesced(to_usb_interface(hub->intfdev));
1927}
1928
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929void usb_resume_root_hub(struct usb_device *hdev)
1930{
1931 struct usb_hub *hub = hdev_to_hub(hdev);
1932
1933 hub->resume_root_hub = 1;
1934 kick_khubd(hub);
1935}
1936
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
1938/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1939 *
1940 * Between connect detection and reset signaling there must be a delay
1941 * of 100ms at least for debounce and power-settling. The corresponding
1942 * timer shall restart whenever the downstream port detects a disconnect.
1943 *
1944 * Apparently there are some bluetooth and irda-dongles and a number of
1945 * low-speed devices for which this debounce period may last over a second.
1946 * Not covered by the spec - but easy to deal with.
1947 *
1948 * This implementation uses a 1500ms total debounce timeout; if the
1949 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1950 * every 25ms for transient disconnects. When the port status has been
1951 * unchanged for 100ms it returns the port status.
1952 */
1953
1954#define HUB_DEBOUNCE_TIMEOUT 1500
1955#define HUB_DEBOUNCE_STEP 25
1956#define HUB_DEBOUNCE_STABLE 100
1957
1958static int hub_port_debounce(struct usb_hub *hub, int port1)
1959{
1960 int ret;
1961 int total_time, stable_time = 0;
1962 u16 portchange, portstatus;
1963 unsigned connection = 0xffff;
1964
1965 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
1966 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1967 if (ret < 0)
1968 return ret;
1969
1970 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
1971 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
1972 stable_time += HUB_DEBOUNCE_STEP;
1973 if (stable_time >= HUB_DEBOUNCE_STABLE)
1974 break;
1975 } else {
1976 stable_time = 0;
1977 connection = portstatus & USB_PORT_STAT_CONNECTION;
1978 }
1979
1980 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1981 clear_port_feature(hub->hdev, port1,
1982 USB_PORT_FEAT_C_CONNECTION);
1983 }
1984
1985 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
1986 break;
1987 msleep(HUB_DEBOUNCE_STEP);
1988 }
1989
1990 dev_dbg (hub->intfdev,
1991 "debounce: port %d: total %dms stable %dms status 0x%x\n",
1992 port1, total_time, stable_time, portstatus);
1993
1994 if (stable_time < HUB_DEBOUNCE_STABLE)
1995 return -ETIMEDOUT;
1996 return portstatus;
1997}
1998
1999static void ep0_reinit(struct usb_device *udev)
2000{
2001 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2002 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2003 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2004}
2005
2006#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2007#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2008
2009static int hub_set_address(struct usb_device *udev)
2010{
2011 int retval;
2012
2013 if (udev->devnum == 0)
2014 return -EINVAL;
2015 if (udev->state == USB_STATE_ADDRESS)
2016 return 0;
2017 if (udev->state != USB_STATE_DEFAULT)
2018 return -EINVAL;
2019 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2020 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2021 NULL, 0, USB_CTRL_SET_TIMEOUT);
2022 if (retval == 0) {
2023 usb_set_device_state(udev, USB_STATE_ADDRESS);
2024 ep0_reinit(udev);
2025 }
2026 return retval;
2027}
2028
2029/* Reset device, (re)assign address, get device descriptor.
2030 * Device connection must be stable, no more debouncing needed.
2031 * Returns device in USB_STATE_ADDRESS, except on error.
2032 *
2033 * If this is called for an already-existing device (as part of
2034 * usb_reset_device), the caller must own the device lock. For a
2035 * newly detected device that is not accessible through any global
2036 * pointers, it's not necessary to lock the device.
2037 */
2038static int
2039hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2040 int retry_counter)
2041{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002042 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
2044 struct usb_device *hdev = hub->hdev;
2045 int i, j, retval;
2046 unsigned delay = HUB_SHORT_RESET_TIME;
2047 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002048 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
2050 /* root hub ports have a slightly longer reset period
2051 * (from USB 2.0 spec, section 7.1.7.5)
2052 */
2053 if (!hdev->parent) {
2054 delay = HUB_ROOT_RESET_TIME;
2055 if (port1 == hdev->bus->otg_port)
2056 hdev->bus->b_hnp_enable = 0;
2057 }
2058
2059 /* Some low speed devices have problems with the quick delay, so */
2060 /* be a bit pessimistic with those devices. RHbug #23670 */
2061 if (oldspeed == USB_SPEED_LOW)
2062 delay = HUB_LONG_RESET_TIME;
2063
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002064 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066 /* Reset the device; full speed may morph to high speed */
2067 retval = hub_port_reset(hub, port1, udev, delay);
2068 if (retval < 0) /* error or disconnect */
2069 goto fail;
2070 /* success, speed is known */
2071 retval = -ENODEV;
2072
2073 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2074 dev_dbg(&udev->dev, "device reset changed speed!\n");
2075 goto fail;
2076 }
2077 oldspeed = udev->speed;
2078
2079 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2080 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002081 * For Wireless USB devices, ep0 max packet is always 512 (tho
2082 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 */
2084 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002085 case USB_SPEED_VARIABLE: /* fixed at 512 */
2086 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2087 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 case USB_SPEED_HIGH: /* fixed at 64 */
2089 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2090 break;
2091 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2092 /* to determine the ep0 maxpacket size, try to read
2093 * the device descriptor to get bMaxPacketSize0 and
2094 * then correct our initial guess.
2095 */
2096 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2097 break;
2098 case USB_SPEED_LOW: /* fixed at 8 */
2099 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2100 break;
2101 default:
2102 goto fail;
2103 }
2104
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002105 type = "";
2106 switch (udev->speed) {
2107 case USB_SPEED_LOW: speed = "low"; break;
2108 case USB_SPEED_FULL: speed = "full"; break;
2109 case USB_SPEED_HIGH: speed = "high"; break;
2110 case USB_SPEED_VARIABLE:
2111 speed = "variable";
2112 type = "Wireless ";
2113 break;
2114 default: speed = "?"; break;
2115 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002117 "%s %s speed %sUSB device using %s and address %d\n",
2118 (udev->config) ? "reset" : "new", speed, type,
2119 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
2121 /* Set up TT records, if needed */
2122 if (hdev->tt) {
2123 udev->tt = hdev->tt;
2124 udev->ttport = hdev->ttport;
2125 } else if (udev->speed != USB_SPEED_HIGH
2126 && hdev->speed == USB_SPEED_HIGH) {
2127 udev->tt = &hub->tt;
2128 udev->ttport = port1;
2129 }
2130
2131 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2132 * Because device hardware and firmware is sometimes buggy in
2133 * this area, and this is how Linux has done it for ages.
2134 * Change it cautiously.
2135 *
2136 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2137 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2138 * so it may help with some non-standards-compliant devices.
2139 * Otherwise we start with SET_ADDRESS and then try to read the
2140 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2141 * value.
2142 */
2143 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2144 if (USE_NEW_SCHEME(retry_counter)) {
2145 struct usb_device_descriptor *buf;
2146 int r = 0;
2147
2148#define GET_DESCRIPTOR_BUFSIZE 64
2149 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2150 if (!buf) {
2151 retval = -ENOMEM;
2152 continue;
2153 }
2154
2155 /* Use a short timeout the first time through,
2156 * so that recalcitrant full-speed devices with
2157 * 8- or 16-byte ep0-maxpackets won't slow things
2158 * down tremendously by NAKing the unexpectedly
2159 * early status stage. Also, retry on all errors;
2160 * some devices are flakey.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002161 * 255 is for WUSB devices, we actually need to use 512.
2162 * WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 */
2164 for (j = 0; j < 3; ++j) {
2165 buf->bMaxPacketSize0 = 0;
2166 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2167 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2168 USB_DT_DEVICE << 8, 0,
2169 buf, GET_DESCRIPTOR_BUFSIZE,
2170 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2171 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002172 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 if (buf->bDescriptorType ==
2174 USB_DT_DEVICE) {
2175 r = 0;
2176 break;
2177 }
2178 /* FALL THROUGH */
2179 default:
2180 if (r == 0)
2181 r = -EPROTO;
2182 break;
2183 }
2184 if (r == 0)
2185 break;
2186 }
2187 udev->descriptor.bMaxPacketSize0 =
2188 buf->bMaxPacketSize0;
2189 kfree(buf);
2190
2191 retval = hub_port_reset(hub, port1, udev, delay);
2192 if (retval < 0) /* error or disconnect */
2193 goto fail;
2194 if (oldspeed != udev->speed) {
2195 dev_dbg(&udev->dev,
2196 "device reset changed speed!\n");
2197 retval = -ENODEV;
2198 goto fail;
2199 }
2200 if (r) {
2201 dev_err(&udev->dev, "device descriptor "
2202 "read/%s, error %d\n",
2203 "64", r);
2204 retval = -EMSGSIZE;
2205 continue;
2206 }
2207#undef GET_DESCRIPTOR_BUFSIZE
2208 }
2209
2210 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2211 retval = hub_set_address(udev);
2212 if (retval >= 0)
2213 break;
2214 msleep(200);
2215 }
2216 if (retval < 0) {
2217 dev_err(&udev->dev,
2218 "device not accepting address %d, error %d\n",
2219 udev->devnum, retval);
2220 goto fail;
2221 }
2222
2223 /* cope with hardware quirkiness:
2224 * - let SET_ADDRESS settle, some device hardware wants it
2225 * - read ep0 maxpacket even for high and low speed,
2226 */
2227 msleep(10);
2228 if (USE_NEW_SCHEME(retry_counter))
2229 break;
2230
2231 retval = usb_get_device_descriptor(udev, 8);
2232 if (retval < 8) {
2233 dev_err(&udev->dev, "device descriptor "
2234 "read/%s, error %d\n",
2235 "8", retval);
2236 if (retval >= 0)
2237 retval = -EMSGSIZE;
2238 } else {
2239 retval = 0;
2240 break;
2241 }
2242 }
2243 if (retval)
2244 goto fail;
2245
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002246 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2247 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2249 if (udev->speed != USB_SPEED_FULL ||
2250 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2251 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2252 retval = -EMSGSIZE;
2253 goto fail;
2254 }
2255 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2256 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2257 ep0_reinit(udev);
2258 }
2259
2260 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2261 if (retval < (signed)sizeof(udev->descriptor)) {
2262 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2263 "all", retval);
2264 if (retval >= 0)
2265 retval = -ENOMSG;
2266 goto fail;
2267 }
2268
2269 retval = 0;
2270
2271fail:
2272 if (retval)
2273 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002274 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 return retval;
2276}
2277
2278static void
2279check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2280{
2281 struct usb_qualifier_descriptor *qual;
2282 int status;
2283
2284 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2285 if (qual == NULL)
2286 return;
2287
2288 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2289 qual, sizeof *qual);
2290 if (status == sizeof *qual) {
2291 dev_info(&udev->dev, "not running at top speed; "
2292 "connect to a high speed hub\n");
2293 /* hub LEDs are probably harder to miss than syslog */
2294 if (hub->has_indicators) {
2295 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2296 schedule_work (&hub->leds);
2297 }
2298 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002299 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300}
2301
2302static unsigned
2303hub_power_remaining (struct usb_hub *hub)
2304{
2305 struct usb_device *hdev = hub->hdev;
2306 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002307 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308
Alan Stern55c52712005-11-23 12:03:12 -05002309 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 return 0;
2311
Alan Stern55c52712005-11-23 12:03:12 -05002312 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2313 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2314 struct usb_device *udev = hdev->children[port1 - 1];
2315 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316
2317 if (!udev)
2318 continue;
2319
Alan Stern55c52712005-11-23 12:03:12 -05002320 /* Unconfigured devices may not use more than 100mA,
2321 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002323 delta = udev->actconfig->desc.bMaxPower * 2;
2324 else if (port1 != udev->bus->otg_port || hdev->parent)
2325 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 else
Alan Stern55c52712005-11-23 12:03:12 -05002327 delta = 8;
2328 if (delta > hub->mA_per_port)
2329 dev_warn(&udev->dev, "%dmA is over %umA budget "
2330 "for port %d!\n",
2331 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 remaining -= delta;
2333 }
2334 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002335 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2336 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 remaining = 0;
2338 }
2339 return remaining;
2340}
2341
2342/* Handle physical or logical connection change events.
2343 * This routine is called when:
2344 * a port connection-change occurs;
2345 * a port enable-change occurs (often caused by EMI);
2346 * usb_reset_device() encounters changed descriptors (as from
2347 * a firmware download)
2348 * caller already locked the hub
2349 */
2350static void hub_port_connect_change(struct usb_hub *hub, int port1,
2351 u16 portstatus, u16 portchange)
2352{
2353 struct usb_device *hdev = hub->hdev;
2354 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002355 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 int status, i;
2357
2358 dev_dbg (hub_dev,
2359 "port %d, status %04x, change %04x, %s\n",
2360 port1, portstatus, portchange, portspeed (portstatus));
2361
2362 if (hub->has_indicators) {
2363 set_port_led(hub, port1, HUB_LED_AUTO);
2364 hub->indicator[port1-1] = INDICATOR_AUTO;
2365 }
2366
2367 /* Disconnect any existing devices under this port */
2368 if (hdev->children[port1-1])
2369 usb_disconnect(&hdev->children[port1-1]);
2370 clear_bit(port1, hub->change_bits);
2371
2372#ifdef CONFIG_USB_OTG
2373 /* during HNP, don't repeat the debounce */
2374 if (hdev->bus->is_b_host)
2375 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2376#endif
2377
2378 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2379 status = hub_port_debounce(hub, port1);
2380 if (status < 0) {
2381 dev_err (hub_dev,
2382 "connect-debounce failed, port %d disabled\n",
2383 port1);
2384 goto done;
2385 }
2386 portstatus = status;
2387 }
2388
2389 /* Return now if nothing is connected */
2390 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2391
2392 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002393 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2395 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2396
2397 if (portstatus & USB_PORT_STAT_ENABLE)
2398 goto done;
2399 return;
2400 }
2401
2402#ifdef CONFIG_USB_SUSPEND
2403 /* If something is connected, but the port is suspended, wake it up. */
2404 if (portstatus & USB_PORT_STAT_SUSPEND) {
2405 status = hub_port_resume(hub, port1, NULL);
2406 if (status < 0) {
2407 dev_dbg(hub_dev,
2408 "can't clear suspend on port %d; %d\n",
2409 port1, status);
2410 goto done;
2411 }
2412 }
2413#endif
2414
2415 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2416 struct usb_device *udev;
2417
2418 /* reallocate for each attempt, since references
2419 * to the previous one can escape in various ways
2420 */
2421 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2422 if (!udev) {
2423 dev_err (hub_dev,
2424 "couldn't allocate port %d usb_device\n",
2425 port1);
2426 goto done;
2427 }
2428
2429 usb_set_device_state(udev, USB_STATE_POWERED);
2430 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002431 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002432 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002433
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 /* set the address */
2435 choose_address(udev);
2436 if (udev->devnum <= 0) {
2437 status = -ENOTCONN; /* Don't retry */
2438 goto loop;
2439 }
2440
2441 /* reset and get descriptor */
2442 status = hub_port_init(hub, udev, port1, i);
2443 if (status < 0)
2444 goto loop;
2445
2446 /* consecutive bus-powered hubs aren't reliable; they can
2447 * violate the voltage drop budget. if the new child has
2448 * a "powered" LED, users should notice we didn't enable it
2449 * (without reading syslog), even without per-port LEDs
2450 * on the parent.
2451 */
2452 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002453 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 u16 devstat;
2455
2456 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2457 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002458 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 dev_dbg(&udev->dev, "get status %d ?\n", status);
2460 goto loop_disable;
2461 }
Alan Stern55c52712005-11-23 12:03:12 -05002462 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2464 dev_err(&udev->dev,
2465 "can't connect bus-powered hub "
2466 "to this port\n");
2467 if (hub->has_indicators) {
2468 hub->indicator[port1-1] =
2469 INDICATOR_AMBER_BLINK;
2470 schedule_work (&hub->leds);
2471 }
2472 status = -ENOTCONN; /* Don't retry */
2473 goto loop_disable;
2474 }
2475 }
2476
2477 /* check for devices running slower than they could */
2478 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2479 && udev->speed == USB_SPEED_FULL
2480 && highspeed_hubs != 0)
2481 check_highspeed (hub, udev, port1);
2482
2483 /* Store the parent's children[] pointer. At this point
2484 * udev becomes globally accessible, although presumably
2485 * no one will look at it until hdev is unlocked.
2486 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 status = 0;
2488
2489 /* We mustn't add new devices if the parent hub has
2490 * been disconnected; we would race with the
2491 * recursively_mark_NOTATTACHED() routine.
2492 */
2493 spin_lock_irq(&device_state_lock);
2494 if (hdev->state == USB_STATE_NOTATTACHED)
2495 status = -ENOTCONN;
2496 else
2497 hdev->children[port1-1] = udev;
2498 spin_unlock_irq(&device_state_lock);
2499
2500 /* Run it through the hoops (find a driver, etc) */
2501 if (!status) {
2502 status = usb_new_device(udev);
2503 if (status) {
2504 spin_lock_irq(&device_state_lock);
2505 hdev->children[port1-1] = NULL;
2506 spin_unlock_irq(&device_state_lock);
2507 }
2508 }
2509
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 if (status)
2511 goto loop_disable;
2512
2513 status = hub_power_remaining(hub);
2514 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002515 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516
2517 return;
2518
2519loop_disable:
2520 hub_port_disable(hub, port1, 1);
2521loop:
2522 ep0_reinit(udev);
2523 release_address(udev);
2524 usb_put_dev(udev);
2525 if (status == -ENOTCONN)
2526 break;
2527 }
2528
2529done:
2530 hub_port_disable(hub, port1, 1);
2531}
2532
2533static void hub_events(void)
2534{
2535 struct list_head *tmp;
2536 struct usb_device *hdev;
2537 struct usb_interface *intf;
2538 struct usb_hub *hub;
2539 struct device *hub_dev;
2540 u16 hubstatus;
2541 u16 hubchange;
2542 u16 portstatus;
2543 u16 portchange;
2544 int i, ret;
2545 int connect_change;
2546
2547 /*
2548 * We restart the list every time to avoid a deadlock with
2549 * deleting hubs downstream from this one. This should be
2550 * safe since we delete the hub from the event list.
2551 * Not the most efficient, but avoids deadlocks.
2552 */
2553 while (1) {
2554
2555 /* Grab the first entry at the beginning of the list */
2556 spin_lock_irq(&hub_event_lock);
2557 if (list_empty(&hub_event_list)) {
2558 spin_unlock_irq(&hub_event_lock);
2559 break;
2560 }
2561
2562 tmp = hub_event_list.next;
2563 list_del_init(tmp);
2564
2565 hub = list_entry(tmp, struct usb_hub, event_list);
2566 hdev = hub->hdev;
2567 intf = to_usb_interface(hub->intfdev);
2568 hub_dev = &intf->dev;
2569
David Brownell979d5192005-09-22 22:32:24 -07002570 i = hub->resume_root_hub;
2571
2572 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 hdev->state, hub->descriptor
2574 ? hub->descriptor->bNbrPorts
2575 : 0,
2576 /* NOTE: expects max 15 ports... */
2577 (u16) hub->change_bits[0],
David Brownell979d5192005-09-22 22:32:24 -07002578 (u16) hub->event_bits[0],
2579 i ? ", resume root" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580
2581 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 spin_unlock_irq(&hub_event_lock);
2583
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 /* Lock the device, then check to see if we were
2585 * disconnected while waiting for the lock to succeed. */
2586 if (locktree(hdev) < 0) {
2587 usb_put_intf(intf);
2588 continue;
2589 }
2590 if (hub != usb_get_intfdata(intf))
2591 goto loop;
2592
2593 /* If the hub has died, clean up after it */
2594 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002595 hub->error = -ENODEV;
2596 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597 goto loop;
2598 }
2599
Alan Sterna8e7c562006-07-01 22:11:02 -04002600 /* Is this is a root hub wanting to reactivate the downstream
2601 * ports? If so, be sure the interface resumes even if its
2602 * stub "device" node was never suspended.
2603 */
2604 if (i)
Alan Stern645daaa2006-08-30 15:47:02 -04002605 usb_autoresume_device(hdev, 0);
Alan Sterna8e7c562006-07-01 22:11:02 -04002606
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 /* If this is an inactive or suspended hub, do nothing */
2608 if (hub->quiescing)
2609 goto loop;
2610
2611 if (hub->error) {
2612 dev_dbg (hub_dev, "resetting for error %d\n",
2613 hub->error);
2614
Alan Stern7de18d82006-06-01 13:37:24 -04002615 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 if (ret) {
2617 dev_dbg (hub_dev,
2618 "error resetting hub: %d\n", ret);
2619 goto loop;
2620 }
2621
2622 hub->nerrors = 0;
2623 hub->error = 0;
2624 }
2625
2626 /* deal with port status changes */
2627 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2628 if (test_bit(i, hub->busy_bits))
2629 continue;
2630 connect_change = test_bit(i, hub->change_bits);
2631 if (!test_and_clear_bit(i, hub->event_bits) &&
2632 !connect_change && !hub->activating)
2633 continue;
2634
2635 ret = hub_port_status(hub, i,
2636 &portstatus, &portchange);
2637 if (ret < 0)
2638 continue;
2639
2640 if (hub->activating && !hdev->children[i-1] &&
2641 (portstatus &
2642 USB_PORT_STAT_CONNECTION))
2643 connect_change = 1;
2644
2645 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2646 clear_port_feature(hdev, i,
2647 USB_PORT_FEAT_C_CONNECTION);
2648 connect_change = 1;
2649 }
2650
2651 if (portchange & USB_PORT_STAT_C_ENABLE) {
2652 if (!connect_change)
2653 dev_dbg (hub_dev,
2654 "port %d enable change, "
2655 "status %08x\n",
2656 i, portstatus);
2657 clear_port_feature(hdev, i,
2658 USB_PORT_FEAT_C_ENABLE);
2659
2660 /*
2661 * EM interference sometimes causes badly
2662 * shielded USB devices to be shutdown by
2663 * the hub, this hack enables them again.
2664 * Works at least with mouse driver.
2665 */
2666 if (!(portstatus & USB_PORT_STAT_ENABLE)
2667 && !connect_change
2668 && hdev->children[i-1]) {
2669 dev_err (hub_dev,
2670 "port %i "
2671 "disabled by hub (EMI?), "
2672 "re-enabling...\n",
2673 i);
2674 connect_change = 1;
2675 }
2676 }
2677
2678 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2679 clear_port_feature(hdev, i,
2680 USB_PORT_FEAT_C_SUSPEND);
2681 if (hdev->children[i-1]) {
2682 ret = remote_wakeup(hdev->
2683 children[i-1]);
2684 if (ret < 0)
2685 connect_change = 1;
2686 } else {
2687 ret = -ENODEV;
2688 hub_port_disable(hub, i, 1);
2689 }
2690 dev_dbg (hub_dev,
2691 "resume on port %d, status %d\n",
2692 i, ret);
2693 }
2694
2695 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2696 dev_err (hub_dev,
2697 "over-current change on port %d\n",
2698 i);
2699 clear_port_feature(hdev, i,
2700 USB_PORT_FEAT_C_OVER_CURRENT);
2701 hub_power_on(hub);
2702 }
2703
2704 if (portchange & USB_PORT_STAT_C_RESET) {
2705 dev_dbg (hub_dev,
2706 "reset change on port %d\n",
2707 i);
2708 clear_port_feature(hdev, i,
2709 USB_PORT_FEAT_C_RESET);
2710 }
2711
2712 if (connect_change)
2713 hub_port_connect_change(hub, i,
2714 portstatus, portchange);
2715 } /* end for i */
2716
2717 /* deal with hub status changes */
2718 if (test_and_clear_bit(0, hub->event_bits) == 0)
2719 ; /* do nothing */
2720 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2721 dev_err (hub_dev, "get_hub_status failed\n");
2722 else {
2723 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2724 dev_dbg (hub_dev, "power change\n");
2725 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002726 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2727 /* FIXME: Is this always true? */
2728 hub->limited_power = 0;
2729 else
2730 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 }
2732 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2733 dev_dbg (hub_dev, "overcurrent change\n");
2734 msleep(500); /* Cool down */
2735 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2736 hub_power_on(hub);
2737 }
2738 }
2739
2740 hub->activating = 0;
2741
Alan Sternd5926ae72005-04-21 15:56:37 -04002742 /* If this is a root hub, tell the HCD it's okay to
2743 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002744 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002745 usb_enable_root_hub_irq(hdev->bus);
2746
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747loop:
2748 usb_unlock_device(hdev);
2749 usb_put_intf(intf);
2750
2751 } /* end while (1) */
2752}
2753
2754static int hub_thread(void *__unused)
2755{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 do {
2757 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002758 wait_event_interruptible(khubd_wait,
2759 !list_empty(&hub_event_list) ||
2760 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002761 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002762 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002764 pr_debug("%s: khubd exiting\n", usbcore_name);
2765 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
2767
2768static struct usb_device_id hub_id_table [] = {
2769 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2770 .bDeviceClass = USB_CLASS_HUB},
2771 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2772 .bInterfaceClass = USB_CLASS_HUB},
2773 { } /* Terminating entry */
2774};
2775
2776MODULE_DEVICE_TABLE (usb, hub_id_table);
2777
2778static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 .name = "hub",
2780 .probe = hub_probe,
2781 .disconnect = hub_disconnect,
2782 .suspend = hub_suspend,
2783 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002784 .pre_reset = hub_pre_reset,
2785 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786 .ioctl = hub_ioctl,
2787 .id_table = hub_id_table,
2788};
2789
2790int usb_hub_init(void)
2791{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 if (usb_register(&hub_driver) < 0) {
2793 printk(KERN_ERR "%s: can't register hub driver\n",
2794 usbcore_name);
2795 return -1;
2796 }
2797
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002798 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2799 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801
2802 /* Fall through if kernel_thread failed */
2803 usb_deregister(&hub_driver);
2804 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2805
2806 return -1;
2807}
2808
2809void usb_hub_cleanup(void)
2810{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002811 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812
2813 /*
2814 * Hub resources are freed for us by usb_deregister. It calls
2815 * usb_driver_purge on every device which in turn calls that
2816 * devices disconnect function if it is using this driver.
2817 * The hub_disconnect function takes care of releasing the
2818 * individual hub resources. -greg
2819 */
2820 usb_deregister(&hub_driver);
2821} /* usb_hub_cleanup() */
2822
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823static int config_descriptors_changed(struct usb_device *udev)
2824{
2825 unsigned index;
2826 unsigned len = 0;
2827 struct usb_config_descriptor *buf;
2828
2829 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2830 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2831 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2832 }
2833 buf = kmalloc (len, SLAB_KERNEL);
2834 if (buf == NULL) {
2835 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2836 /* assume the worst */
2837 return 1;
2838 }
2839 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2840 int length;
2841 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2842
2843 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2844 old_length);
2845 if (length < old_length) {
2846 dev_dbg(&udev->dev, "config index %d, error %d\n",
2847 index, length);
2848 break;
2849 }
2850 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2851 != 0) {
2852 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2853 index, buf->bConfigurationValue);
2854 break;
2855 }
2856 }
2857 kfree(buf);
2858 return index != udev->descriptor.bNumConfigurations;
2859}
2860
2861/**
2862 * usb_reset_device - perform a USB port reset to reinitialize a device
2863 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2864 *
Alan Stern79efa092006-06-01 13:33:42 -04002865 * WARNING - don't use this routine to reset a composite device
2866 * (one with multiple interfaces owned by separate drivers)!
2867 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868 *
2869 * Do a port reset, reassign the device's address, and establish its
2870 * former operating configuration. If the reset fails, or the device's
2871 * descriptors change from their values before the reset, or the original
2872 * configuration and altsettings cannot be restored, a flag will be set
2873 * telling khubd to pretend the device has been disconnected and then
2874 * re-connected. All drivers will be unbound, and the device will be
2875 * re-enumerated and probed all over again.
2876 *
2877 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2878 * flagged for logical disconnection, or some other negative error code
2879 * if the reset wasn't even attempted.
2880 *
2881 * The caller must own the device lock. For example, it's safe to use
2882 * this from a driver probe() routine after downloading new firmware.
2883 * For calls that might not occur during probe(), drivers should lock
2884 * the device using usb_lock_device_for_reset().
2885 */
2886int usb_reset_device(struct usb_device *udev)
2887{
2888 struct usb_device *parent_hdev = udev->parent;
2889 struct usb_hub *parent_hub;
2890 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002891 int i, ret = 0;
2892 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893
2894 if (udev->state == USB_STATE_NOTATTACHED ||
2895 udev->state == USB_STATE_SUSPENDED) {
2896 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2897 udev->state);
2898 return -EINVAL;
2899 }
2900
2901 if (!parent_hdev) {
2902 /* this requires hcd-specific logic; see OHCI hc_restart() */
2903 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2904 return -EISDIR;
2905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 parent_hub = hdev_to_hub(parent_hdev);
2907
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908 set_bit(port1, parent_hub->busy_bits);
2909 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2910
2911 /* ep0 maxpacket size may change; let the HCD know about it.
2912 * Other endpoints will be handled by re-enumeration. */
2913 ep0_reinit(udev);
2914 ret = hub_port_init(parent_hub, udev, port1, i);
2915 if (ret >= 0)
2916 break;
2917 }
2918 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002919 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2920 usb_enable_root_hub_irq(parent_hdev->bus);
2921
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922 if (ret < 0)
2923 goto re_enumerate;
2924
2925 /* Device might have changed firmware (DFU or similar) */
2926 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2927 || config_descriptors_changed (udev)) {
2928 dev_info(&udev->dev, "device firmware changed\n");
2929 udev->descriptor = descriptor; /* for disconnect() calls */
2930 goto re_enumerate;
2931 }
2932
2933 if (!udev->actconfig)
2934 goto done;
2935
2936 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2937 USB_REQ_SET_CONFIGURATION, 0,
2938 udev->actconfig->desc.bConfigurationValue, 0,
2939 NULL, 0, USB_CTRL_SET_TIMEOUT);
2940 if (ret < 0) {
2941 dev_err(&udev->dev,
2942 "can't restore configuration #%d (error=%d)\n",
2943 udev->actconfig->desc.bConfigurationValue, ret);
2944 goto re_enumerate;
2945 }
2946 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2947
2948 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2949 struct usb_interface *intf = udev->actconfig->interface[i];
2950 struct usb_interface_descriptor *desc;
2951
2952 /* set_interface resets host side toggle even
2953 * for altsetting zero. the interface may have no driver.
2954 */
2955 desc = &intf->cur_altsetting->desc;
2956 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2957 desc->bAlternateSetting);
2958 if (ret < 0) {
2959 dev_err(&udev->dev, "failed to restore interface %d "
2960 "altsetting %d (error=%d)\n",
2961 desc->bInterfaceNumber,
2962 desc->bAlternateSetting,
2963 ret);
2964 goto re_enumerate;
2965 }
2966 }
2967
2968done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969 return 0;
2970
2971re_enumerate:
2972 hub_port_logical_disconnect(parent_hub, port1);
2973 return -ENODEV;
2974}
Alan Stern140d8f62006-07-01 22:07:21 -04002975EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04002976
2977/**
2978 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
2979 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2980 * @iface: interface bound to the driver making the request (optional)
2981 *
2982 * Warns all drivers bound to registered interfaces (using their pre_reset
2983 * method), performs the port reset, and then lets the drivers know that
2984 * the reset is over (using their post_reset method).
2985 *
2986 * Return value is the same as for usb_reset_device().
2987 *
2988 * The caller must own the device lock. For example, it's safe to use
2989 * this from a driver probe() routine after downloading new firmware.
2990 * For calls that might not occur during probe(), drivers should lock
2991 * the device using usb_lock_device_for_reset().
2992 *
2993 * The interface locks are acquired during the pre_reset stage and released
2994 * during the post_reset stage. However if iface is not NULL and is
2995 * currently being probed, we assume that the caller already owns its
2996 * lock.
2997 */
2998int usb_reset_composite_device(struct usb_device *udev,
2999 struct usb_interface *iface)
3000{
3001 int ret;
3002 struct usb_host_config *config = udev->actconfig;
3003
3004 if (udev->state == USB_STATE_NOTATTACHED ||
3005 udev->state == USB_STATE_SUSPENDED) {
3006 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3007 udev->state);
3008 return -EINVAL;
3009 }
3010
Alan Stern645daaa2006-08-30 15:47:02 -04003011 /* Prevent autosuspend during the reset */
3012 usb_autoresume_device(udev, 1);
3013
Alan Stern79efa092006-06-01 13:33:42 -04003014 if (iface && iface->condition != USB_INTERFACE_BINDING)
3015 iface = NULL;
3016
3017 if (config) {
3018 int i;
3019 struct usb_interface *cintf;
3020 struct usb_driver *drv;
3021
3022 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3023 cintf = config->interface[i];
3024 if (cintf != iface)
3025 down(&cintf->dev.sem);
3026 if (device_is_registered(&cintf->dev) &&
3027 cintf->dev.driver) {
3028 drv = to_usb_driver(cintf->dev.driver);
3029 if (drv->pre_reset)
3030 (drv->pre_reset)(cintf);
3031 }
3032 }
3033 }
3034
3035 ret = usb_reset_device(udev);
3036
3037 if (config) {
3038 int i;
3039 struct usb_interface *cintf;
3040 struct usb_driver *drv;
3041
3042 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3043 cintf = config->interface[i];
3044 if (device_is_registered(&cintf->dev) &&
3045 cintf->dev.driver) {
3046 drv = to_usb_driver(cintf->dev.driver);
3047 if (drv->post_reset)
3048 (drv->post_reset)(cintf);
3049 }
3050 if (cintf != iface)
3051 up(&cintf->dev.sem);
3052 }
3053 }
3054
Alan Stern645daaa2006-08-30 15:47:02 -04003055 usb_autosuspend_device(udev, 1);
Alan Stern79efa092006-06-01 13:33:42 -04003056 return ret;
3057}
Alan Stern140d8f62006-07-01 22:07:21 -04003058EXPORT_SYMBOL(usb_reset_composite_device);