blob: 0ce393eb3c4b0bea98e9a6ec8156ca5272160018 [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
Alan Stern1bb5f662006-11-06 11:56:13 -050034struct usb_hub {
35 struct device *intfdev; /* the "interface" device */
36 struct usb_device *hdev;
37 struct urb *urb; /* for interrupt polling pipe */
38
39 /* buffer for urb ... with extra space in case of babble */
40 char (*buffer)[8];
41 dma_addr_t buffer_dma; /* DMA address for buffer */
42 union {
43 struct usb_hub_status hub;
44 struct usb_port_status port;
45 } *status; /* buffer for status reports */
46
47 int error; /* last reported error */
48 int nerrors; /* track consecutive errors */
49
50 struct list_head event_list; /* hubs w/data or errs ready */
51 unsigned long event_bits[1]; /* status change bitmask */
52 unsigned long change_bits[1]; /* ports with logical connect
53 status change */
54 unsigned long busy_bits[1]; /* ports being reset or
55 resumed */
56#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
57#error event_bits[] is too short!
58#endif
59
60 struct usb_hub_descriptor *descriptor; /* class descriptor */
61 struct usb_tt tt; /* Transaction Translator */
62
63 unsigned mA_per_port; /* current for each child */
64
65 unsigned limited_power:1;
66 unsigned quiescing:1;
67 unsigned activating:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050068
69 unsigned has_indicators:1;
70 u8 indicator[USB_MAXCHILDREN];
71 struct work_struct leds;
72};
73
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050076 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
78static DEFINE_SPINLOCK(device_state_lock);
79
80/* khubd's worklist and its lock */
81static DEFINE_SPINLOCK(hub_event_lock);
82static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
83
84/* Wakes up khubd */
85static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
86
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070087static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -070089/* multithreaded probe logic */
90static int multithread_probe =
91#ifdef CONFIG_USB_MULTITHREAD_PROBE
92 1;
93#else
94 0;
95#endif
96module_param(multithread_probe, bool, S_IRUGO);
97MODULE_PARM_DESC(multithread_probe, "Run each USB device probe in a new thread");
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099/* cycle leds on hubs that aren't blinking for attention */
100static int blinkenlights = 0;
101module_param (blinkenlights, bool, S_IRUGO);
102MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
103
104/*
105 * As of 2.6.10 we introduce a new USB device initialization scheme which
106 * closely resembles the way Windows works. Hopefully it will be compatible
107 * with a wider range of devices than the old scheme. However some previously
108 * working devices may start giving rise to "device not accepting address"
109 * errors; if that happens the user can try the old scheme by adjusting the
110 * following module parameters.
111 *
112 * For maximum flexibility there are two boolean parameters to control the
113 * hub driver's behavior. On the first initialization attempt, if the
114 * "old_scheme_first" parameter is set then the old scheme will be used,
115 * otherwise the new scheme is used. If that fails and "use_both_schemes"
116 * is set, then the driver will make another attempt, using the other scheme.
117 */
118static int old_scheme_first = 0;
119module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
120MODULE_PARM_DESC(old_scheme_first,
121 "start with the old device initialization scheme");
122
123static int use_both_schemes = 1;
124module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
125MODULE_PARM_DESC(use_both_schemes,
126 "try the other device initialization scheme if the "
127 "first one fails");
128
129
130#ifdef DEBUG
131static inline char *portspeed (int portstatus)
132{
133 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
134 return "480 Mb/s";
135 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
136 return "1.5 Mb/s";
137 else
138 return "12 Mb/s";
139}
140#endif
141
142/* Note that hdev or one of its children must be locked! */
143static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
144{
145 return usb_get_intfdata(hdev->actconfig->interface[0]);
146}
147
148/* USB 2.0 spec Section 11.24.4.5 */
149static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
150{
151 int i, ret;
152
153 for (i = 0; i < 3; i++) {
154 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
155 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
156 USB_DT_HUB << 8, 0, data, size,
157 USB_CTRL_GET_TIMEOUT);
158 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
159 return ret;
160 }
161 return -EINVAL;
162}
163
164/*
165 * USB 2.0 spec Section 11.24.2.1
166 */
167static int clear_hub_feature(struct usb_device *hdev, int feature)
168{
169 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
170 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
171}
172
173/*
174 * USB 2.0 spec Section 11.24.2.2
175 */
176static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
177{
178 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
179 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
180 NULL, 0, 1000);
181}
182
183/*
184 * USB 2.0 spec Section 11.24.2.13
185 */
186static int set_port_feature(struct usb_device *hdev, int port1, int feature)
187{
188 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
189 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
190 NULL, 0, 1000);
191}
192
193/*
194 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
195 * for info about using port indicators
196 */
197static void set_port_led(
198 struct usb_hub *hub,
199 int port1,
200 int selector
201)
202{
203 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
204 USB_PORT_FEAT_INDICATOR);
205 if (status < 0)
206 dev_dbg (hub->intfdev,
207 "port %d indicator %s status %d\n",
208 port1,
209 ({ char *s; switch (selector) {
210 case HUB_LED_AMBER: s = "amber"; break;
211 case HUB_LED_GREEN: s = "green"; break;
212 case HUB_LED_OFF: s = "off"; break;
213 case HUB_LED_AUTO: s = "auto"; break;
214 default: s = "??"; break;
215 }; s; }),
216 status);
217}
218
219#define LED_CYCLE_PERIOD ((2*HZ)/3)
220
221static void led_work (void *__hub)
222{
223 struct usb_hub *hub = __hub;
224 struct usb_device *hdev = hub->hdev;
225 unsigned i;
226 unsigned changed = 0;
227 int cursor = -1;
228
229 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
230 return;
231
232 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
233 unsigned selector, mode;
234
235 /* 30%-50% duty cycle */
236
237 switch (hub->indicator[i]) {
238 /* cycle marker */
239 case INDICATOR_CYCLE:
240 cursor = i;
241 selector = HUB_LED_AUTO;
242 mode = INDICATOR_AUTO;
243 break;
244 /* blinking green = sw attention */
245 case INDICATOR_GREEN_BLINK:
246 selector = HUB_LED_GREEN;
247 mode = INDICATOR_GREEN_BLINK_OFF;
248 break;
249 case INDICATOR_GREEN_BLINK_OFF:
250 selector = HUB_LED_OFF;
251 mode = INDICATOR_GREEN_BLINK;
252 break;
253 /* blinking amber = hw attention */
254 case INDICATOR_AMBER_BLINK:
255 selector = HUB_LED_AMBER;
256 mode = INDICATOR_AMBER_BLINK_OFF;
257 break;
258 case INDICATOR_AMBER_BLINK_OFF:
259 selector = HUB_LED_OFF;
260 mode = INDICATOR_AMBER_BLINK;
261 break;
262 /* blink green/amber = reserved */
263 case INDICATOR_ALT_BLINK:
264 selector = HUB_LED_GREEN;
265 mode = INDICATOR_ALT_BLINK_OFF;
266 break;
267 case INDICATOR_ALT_BLINK_OFF:
268 selector = HUB_LED_AMBER;
269 mode = INDICATOR_ALT_BLINK;
270 break;
271 default:
272 continue;
273 }
274 if (selector != HUB_LED_AUTO)
275 changed = 1;
276 set_port_led(hub, i + 1, selector);
277 hub->indicator[i] = mode;
278 }
279 if (!changed && blinkenlights) {
280 cursor++;
281 cursor %= hub->descriptor->bNbrPorts;
282 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
283 hub->indicator[cursor] = INDICATOR_CYCLE;
284 changed++;
285 }
286 if (changed)
287 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
288}
289
290/* use a short timeout for hub/port status fetches */
291#define USB_STS_TIMEOUT 1000
292#define USB_STS_RETRIES 5
293
294/*
295 * USB 2.0 spec Section 11.24.2.6
296 */
297static int get_hub_status(struct usb_device *hdev,
298 struct usb_hub_status *data)
299{
300 int i, status = -ETIMEDOUT;
301
302 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
303 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
304 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
305 data, sizeof(*data), USB_STS_TIMEOUT);
306 }
307 return status;
308}
309
310/*
311 * USB 2.0 spec Section 11.24.2.7
312 */
313static int get_port_status(struct usb_device *hdev, int port1,
314 struct usb_port_status *data)
315{
316 int i, status = -ETIMEDOUT;
317
318 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
319 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
320 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
321 data, sizeof(*data), USB_STS_TIMEOUT);
322 }
323 return status;
324}
325
326static void kick_khubd(struct usb_hub *hub)
327{
328 unsigned long flags;
329
Alan Stern40f122f2006-11-09 14:44:33 -0500330 /* Suppress autosuspend until khubd runs */
331 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 spin_lock_irqsave(&hub_event_lock, flags);
334 if (list_empty(&hub->event_list)) {
335 list_add_tail(&hub->event_list, &hub_event_list);
336 wake_up(&khubd_wait);
337 }
338 spin_unlock_irqrestore(&hub_event_lock, flags);
339}
340
341void usb_kick_khubd(struct usb_device *hdev)
342{
343 kick_khubd(hdev_to_hub(hdev));
344}
345
346
347/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100348static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200350 struct usb_hub *hub = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 int status;
352 int i;
353 unsigned long bits;
354
355 switch (urb->status) {
356 case -ENOENT: /* synchronous unlink */
357 case -ECONNRESET: /* async unlink */
358 case -ESHUTDOWN: /* hardware going away */
359 return;
360
361 default: /* presumably an error */
362 /* Cause a hub reset after 10 consecutive errors */
363 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
364 if ((++hub->nerrors < 10) || hub->error)
365 goto resubmit;
366 hub->error = urb->status;
367 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 /* let khubd handle things */
370 case 0: /* we got data: port status changed */
371 bits = 0;
372 for (i = 0; i < urb->actual_length; ++i)
373 bits |= ((unsigned long) ((*hub->buffer)[i]))
374 << (i*8);
375 hub->event_bits[0] = bits;
376 break;
377 }
378
379 hub->nerrors = 0;
380
381 /* Something happened, let khubd figure it out */
382 kick_khubd(hub);
383
384resubmit:
385 if (hub->quiescing)
386 return;
387
388 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
389 && status != -ENODEV && status != -EPERM)
390 dev_err (hub->intfdev, "resubmit --> %d\n", status);
391}
392
393/* USB 2.0 spec Section 11.24.2.3 */
394static inline int
395hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
396{
397 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
398 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
399 tt, NULL, 0, 1000);
400}
401
402/*
403 * enumeration blocks khubd for a long time. we use keventd instead, since
404 * long blocking there is the exception, not the rule. accordingly, HCDs
405 * talking to TTs must queue control transfers (not just bulk and iso), so
406 * both can talk to the same hub concurrently.
407 */
408static void hub_tt_kevent (void *arg)
409{
410 struct usb_hub *hub = arg;
411 unsigned long flags;
412
413 spin_lock_irqsave (&hub->tt.lock, flags);
414 while (!list_empty (&hub->tt.clear_list)) {
415 struct list_head *temp;
416 struct usb_tt_clear *clear;
417 struct usb_device *hdev = hub->hdev;
418 int status;
419
420 temp = hub->tt.clear_list.next;
421 clear = list_entry (temp, struct usb_tt_clear, clear_list);
422 list_del (&clear->clear_list);
423
424 /* drop lock so HCD can concurrently report other TT errors */
425 spin_unlock_irqrestore (&hub->tt.lock, flags);
426 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
427 spin_lock_irqsave (&hub->tt.lock, flags);
428
429 if (status)
430 dev_err (&hdev->dev,
431 "clear tt %d (%04x) error %d\n",
432 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700433 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 }
435 spin_unlock_irqrestore (&hub->tt.lock, flags);
436}
437
438/**
439 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
440 * @udev: the device whose split transaction failed
441 * @pipe: identifies the endpoint of the failed transaction
442 *
443 * High speed HCDs use this to tell the hub driver that some split control or
444 * bulk transaction failed in a way that requires clearing internal state of
445 * a transaction translator. This is normally detected (and reported) from
446 * interrupt context.
447 *
448 * It may not be possible for that hub to handle additional full (or low)
449 * speed transactions until that state is fully cleared out.
450 */
451void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
452{
453 struct usb_tt *tt = udev->tt;
454 unsigned long flags;
455 struct usb_tt_clear *clear;
456
457 /* we've got to cope with an arbitrary number of pending TT clears,
458 * since each TT has "at least two" buffers that can need it (and
459 * there can be many TTs per hub). even if they're uncommon.
460 */
461 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
462 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
463 /* FIXME recover somehow ... RESET_TT? */
464 return;
465 }
466
467 /* info that CLEAR_TT_BUFFER needs */
468 clear->tt = tt->multi ? udev->ttport : 1;
469 clear->devinfo = usb_pipeendpoint (pipe);
470 clear->devinfo |= udev->devnum << 4;
471 clear->devinfo |= usb_pipecontrol (pipe)
472 ? (USB_ENDPOINT_XFER_CONTROL << 11)
473 : (USB_ENDPOINT_XFER_BULK << 11);
474 if (usb_pipein (pipe))
475 clear->devinfo |= 1 << 15;
476
477 /* tell keventd to clear state for this TT */
478 spin_lock_irqsave (&tt->lock, flags);
479 list_add_tail (&clear->clear_list, &tt->clear_list);
480 schedule_work (&tt->kevent);
481 spin_unlock_irqrestore (&tt->lock, flags);
482}
483
484static void hub_power_on(struct usb_hub *hub)
485{
486 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700487 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400488 u16 wHubCharacteristics =
489 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490
Alan Stern4489a572006-04-27 15:54:22 -0400491 /* Enable power on each port. Some hubs have reserved values
492 * of LPSM (> 2) in their descriptors, even though they are
493 * USB 2.0 hubs. Some hubs do not implement port-power switching
494 * but only emulate it. In all cases, the ports won't work
495 * unless we send these messages to the hub.
496 */
497 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400499 else
500 dev_dbg(hub->intfdev, "trying to enable port power on "
501 "non-switchable hub\n");
502 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
503 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
David Brownellb7896962005-08-31 10:41:44 -0700505 /* Wait at least 100 msec for power to become stable */
506 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
508
Alan Stern02c399e2006-08-30 15:47:11 -0400509static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
David Brownell979d5192005-09-22 22:32:24 -0700511 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700513 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700514
David Brownell979d5192005-09-22 22:32:24 -0700515 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 usb_kill_urb(hub->urb);
517 if (hub->has_indicators)
518 cancel_delayed_work(&hub->leds);
519 if (hub->has_indicators || hub->tt.hub)
520 flush_scheduled_work();
521}
522
523static void hub_activate(struct usb_hub *hub)
524{
525 int status;
526
527 hub->quiescing = 0;
528 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 status = usb_submit_urb(hub->urb, GFP_NOIO);
531 if (status < 0)
532 dev_err(hub->intfdev, "activate --> %d\n", status);
533 if (hub->has_indicators && blinkenlights)
534 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
535
536 /* scan all ports ASAP */
537 kick_khubd(hub);
538}
539
540static int hub_hub_status(struct usb_hub *hub,
541 u16 *status, u16 *change)
542{
543 int ret;
544
545 ret = get_hub_status(hub->hdev, &hub->status->hub);
546 if (ret < 0)
547 dev_err (hub->intfdev,
548 "%s failed (err = %d)\n", __FUNCTION__, ret);
549 else {
550 *status = le16_to_cpu(hub->status->hub.wHubStatus);
551 *change = le16_to_cpu(hub->status->hub.wHubChange);
552 ret = 0;
553 }
554 return ret;
555}
556
Alan Stern8b28c752005-08-10 17:04:13 -0400557static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
558{
559 struct usb_device *hdev = hub->hdev;
560 int ret;
561
562 if (hdev->children[port1-1] && set_state) {
563 usb_set_device_state(hdev->children[port1-1],
564 USB_STATE_NOTATTACHED);
565 }
566 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
567 if (ret)
568 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
569 port1, ret);
570
571 return ret;
572}
573
Alan Stern7d069b72005-11-18 12:06:34 -0500574
575/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400576static void hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500577{
Alan Stern7de18d82006-06-01 13:37:24 -0400578 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Stern7d069b72005-11-18 12:06:34 -0500579 struct usb_device *hdev = hub->hdev;
580 int port1;
581
582 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
583 if (hdev->children[port1 - 1]) {
584 usb_disconnect(&hdev->children[port1 - 1]);
Alan Stern7de18d82006-06-01 13:37:24 -0400585 if (hub->error == 0)
Alan Stern7d069b72005-11-18 12:06:34 -0500586 hub_port_disable(hub, port1, 0);
587 }
588 }
589 hub_quiesce(hub);
590}
591
592/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400593static void hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500594{
Alan Stern7de18d82006-06-01 13:37:24 -0400595 struct usb_hub *hub = usb_get_intfdata(intf);
596
Alan Stern7d069b72005-11-18 12:06:34 -0500597 hub_activate(hub);
598 hub_power_on(hub);
599}
600
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602static int hub_configure(struct usb_hub *hub,
603 struct usb_endpoint_descriptor *endpoint)
604{
605 struct usb_device *hdev = hub->hdev;
606 struct device *hub_dev = hub->intfdev;
607 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700608 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 unsigned int pipe;
610 int maxp, ret;
611 char *message;
612
613 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
614 &hub->buffer_dma);
615 if (!hub->buffer) {
616 message = "can't allocate hub irq buffer";
617 ret = -ENOMEM;
618 goto fail;
619 }
620
621 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
622 if (!hub->status) {
623 message = "can't kmalloc hub status buffer";
624 ret = -ENOMEM;
625 goto fail;
626 }
627
628 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
629 if (!hub->descriptor) {
630 message = "can't kmalloc hub descriptor";
631 ret = -ENOMEM;
632 goto fail;
633 }
634
635 /* Request the entire hub descriptor.
636 * hub->descriptor can handle USB_MAXCHILDREN ports,
637 * but the hub can/will return fewer bytes here.
638 */
639 ret = get_hub_descriptor(hdev, hub->descriptor,
640 sizeof(*hub->descriptor));
641 if (ret < 0) {
642 message = "can't read hub descriptor";
643 goto fail;
644 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
645 message = "hub has too many ports!";
646 ret = -ENODEV;
647 goto fail;
648 }
649
650 hdev->maxchild = hub->descriptor->bNbrPorts;
651 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
652 (hdev->maxchild == 1) ? "" : "s");
653
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700654 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700656 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 int i;
658 char portstr [USB_MAXCHILDREN + 1];
659
660 for (i = 0; i < hdev->maxchild; i++)
661 portstr[i] = hub->descriptor->DeviceRemovable
662 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
663 ? 'F' : 'R';
664 portstr[hdev->maxchild] = 0;
665 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
666 } else
667 dev_dbg(hub_dev, "standalone hub\n");
668
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700669 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 case 0x00:
671 dev_dbg(hub_dev, "ganged power switching\n");
672 break;
673 case 0x01:
674 dev_dbg(hub_dev, "individual port power switching\n");
675 break;
676 case 0x02:
677 case 0x03:
678 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
679 break;
680 }
681
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700682 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 case 0x00:
684 dev_dbg(hub_dev, "global over-current protection\n");
685 break;
686 case 0x08:
687 dev_dbg(hub_dev, "individual port over-current protection\n");
688 break;
689 case 0x10:
690 case 0x18:
691 dev_dbg(hub_dev, "no over-current protection\n");
692 break;
693 }
694
695 spin_lock_init (&hub->tt.lock);
696 INIT_LIST_HEAD (&hub->tt.clear_list);
697 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
698 switch (hdev->descriptor.bDeviceProtocol) {
699 case 0:
700 break;
701 case 1:
702 dev_dbg(hub_dev, "Single TT\n");
703 hub->tt.hub = hdev;
704 break;
705 case 2:
706 ret = usb_set_interface(hdev, 0, 1);
707 if (ret == 0) {
708 dev_dbg(hub_dev, "TT per port\n");
709 hub->tt.multi = 1;
710 } else
711 dev_err(hub_dev, "Using single TT (err %d)\n",
712 ret);
713 hub->tt.hub = hdev;
714 break;
715 default:
716 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
717 hdev->descriptor.bDeviceProtocol);
718 break;
719 }
720
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700721 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700722 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700723 case HUB_TTTT_8_BITS:
724 if (hdev->descriptor.bDeviceProtocol != 0) {
725 hub->tt.think_time = 666;
726 dev_dbg(hub_dev, "TT requires at most %d "
727 "FS bit times (%d ns)\n",
728 8, hub->tt.think_time);
729 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700731 case HUB_TTTT_16_BITS:
732 hub->tt.think_time = 666 * 2;
733 dev_dbg(hub_dev, "TT requires at most %d "
734 "FS bit times (%d ns)\n",
735 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700737 case HUB_TTTT_24_BITS:
738 hub->tt.think_time = 666 * 3;
739 dev_dbg(hub_dev, "TT requires at most %d "
740 "FS bit times (%d ns)\n",
741 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700743 case HUB_TTTT_32_BITS:
744 hub->tt.think_time = 666 * 4;
745 dev_dbg(hub_dev, "TT requires at most %d "
746 "FS bit times (%d ns)\n",
747 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 break;
749 }
750
751 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700752 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 hub->has_indicators = 1;
754 dev_dbg(hub_dev, "Port indicators are supported\n");
755 }
756
757 dev_dbg(hub_dev, "power on to power good time: %dms\n",
758 hub->descriptor->bPwrOn2PwrGood * 2);
759
760 /* power budgeting mostly matters with bus-powered hubs,
761 * and battery-powered root hubs (may provide just 8 mA).
762 */
763 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500764 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 message = "can't get hub status";
766 goto fail;
767 }
Alan Stern7d35b922005-04-25 11:18:32 -0400768 le16_to_cpus(&hubstatus);
769 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500770 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
771 hub->mA_per_port = 500;
772 else {
773 hub->mA_per_port = hdev->bus_mA;
774 hub->limited_power = 1;
775 }
Alan Stern7d35b922005-04-25 11:18:32 -0400776 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
778 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500779 hub->limited_power = 1;
780 if (hdev->maxchild > 0) {
781 int remaining = hdev->bus_mA -
782 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Alan Stern55c52712005-11-23 12:03:12 -0500784 if (remaining < hdev->maxchild * 100)
785 dev_warn(hub_dev,
786 "insufficient power available "
787 "to use all downstream ports\n");
788 hub->mA_per_port = 100; /* 7.2.1.1 */
789 }
790 } else { /* Self-powered external hub */
791 /* FIXME: What about battery-powered external hubs that
792 * provide less current per port? */
793 hub->mA_per_port = 500;
794 }
795 if (hub->mA_per_port < 500)
796 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
797 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799 ret = hub_hub_status(hub, &hubstatus, &hubchange);
800 if (ret < 0) {
801 message = "can't get hub status";
802 goto fail;
803 }
804
805 /* local power status reports aren't always correct */
806 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
807 dev_dbg(hub_dev, "local power source is %s\n",
808 (hubstatus & HUB_STATUS_LOCAL_POWER)
809 ? "lost (inactive)" : "good");
810
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700811 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 dev_dbg(hub_dev, "%sover-current condition exists\n",
813 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
814
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700815 /* set up the interrupt endpoint
816 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
817 * bytes as USB2.0[11.12.3] says because some hubs are known
818 * to send more data (and thus cause overflow). For root hubs,
819 * maxpktsize is defined in hcd.c's fake endpoint descriptors
820 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
822 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
823
824 if (maxp > sizeof(*hub->buffer))
825 maxp = sizeof(*hub->buffer);
826
827 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
828 if (!hub->urb) {
829 message = "couldn't allocate interrupt urb";
830 ret = -ENOMEM;
831 goto fail;
832 }
833
834 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
835 hub, endpoint->bInterval);
836 hub->urb->transfer_dma = hub->buffer_dma;
837 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
838
839 /* maybe cycle the hub leds */
840 if (hub->has_indicators && blinkenlights)
841 hub->indicator [0] = INDICATOR_CYCLE;
842
843 hub_power_on(hub);
844 hub_activate(hub);
845 return 0;
846
847fail:
848 dev_err (hub_dev, "config failed, %s (err %d)\n",
849 message, ret);
850 /* hub_disconnect() frees urb and descriptor */
851 return ret;
852}
853
854static unsigned highspeed_hubs;
855
856static void hub_disconnect(struct usb_interface *intf)
857{
858 struct usb_hub *hub = usb_get_intfdata (intf);
859 struct usb_device *hdev;
860
Alan Stern7de18d82006-06-01 13:37:24 -0400861 /* Disconnect all children and quiesce the hub */
862 hub->error = 0;
863 hub_pre_reset(intf);
864
Alan Stern8b28c752005-08-10 17:04:13 -0400865 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 hdev = hub->hdev;
867
868 if (hdev->speed == USB_SPEED_HIGH)
869 highspeed_hubs--;
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 usb_free_urb(hub->urb);
872 hub->urb = NULL;
873
874 spin_lock_irq(&hub_event_lock);
875 list_del_init(&hub->event_list);
876 spin_unlock_irq(&hub_event_lock);
877
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700878 kfree(hub->descriptor);
879 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700881 kfree(hub->status);
882 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884 if (hub->buffer) {
885 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
886 hub->buffer_dma);
887 hub->buffer = NULL;
888 }
889
Alan Stern7d069b72005-11-18 12:06:34 -0500890 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891}
892
893static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
894{
895 struct usb_host_interface *desc;
896 struct usb_endpoint_descriptor *endpoint;
897 struct usb_device *hdev;
898 struct usb_hub *hub;
899
900 desc = intf->cur_altsetting;
901 hdev = interface_to_usbdev(intf);
902
David Brownell89ccbdc2006-04-02 10:18:09 -0800903#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
904 if (hdev->parent) {
905 dev_warn(&intf->dev, "ignoring external hub\n");
906 return -ENODEV;
907 }
908#endif
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 /* Some hubs have a subclass of 1, which AFAICT according to the */
911 /* specs is not defined, but it works */
912 if ((desc->desc.bInterfaceSubClass != 0) &&
913 (desc->desc.bInterfaceSubClass != 1)) {
914descriptor_error:
915 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
916 return -EIO;
917 }
918
919 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
920 if (desc->desc.bNumEndpoints != 1)
921 goto descriptor_error;
922
923 endpoint = &desc->endpoint[0].desc;
924
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700925 /* If it's not an interrupt in endpoint, we'd better punt! */
926 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 goto descriptor_error;
928
929 /* We found a hub */
930 dev_info (&intf->dev, "USB hub found\n");
931
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400932 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 if (!hub) {
934 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
935 return -ENOMEM;
936 }
937
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 INIT_LIST_HEAD(&hub->event_list);
939 hub->intfdev = &intf->dev;
940 hub->hdev = hdev;
941 INIT_WORK(&hub->leds, led_work, hub);
942
943 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -0500944 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
946 if (hdev->speed == USB_SPEED_HIGH)
947 highspeed_hubs++;
948
949 if (hub_configure(hub, endpoint) >= 0)
950 return 0;
951
952 hub_disconnect (intf);
953 return -ENODEV;
954}
955
956static int
957hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
958{
959 struct usb_device *hdev = interface_to_usbdev (intf);
960
961 /* assert ifno == 0 (part of hub spec) */
962 switch (code) {
963 case USBDEVFS_HUB_PORTINFO: {
964 struct usbdevfs_hub_portinfo *info = user_data;
965 int i;
966
967 spin_lock_irq(&device_state_lock);
968 if (hdev->devnum <= 0)
969 info->nports = 0;
970 else {
971 info->nports = hdev->maxchild;
972 for (i = 0; i < info->nports; i++) {
973 if (hdev->children[i] == NULL)
974 info->port[i] = 0;
975 else
976 info->port[i] =
977 hdev->children[i]->devnum;
978 }
979 }
980 spin_unlock_irq(&device_state_lock);
981
982 return info->nports + 1;
983 }
984
985 default:
986 return -ENOSYS;
987 }
988}
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
991/* grab device/port lock, returning index of that port (zero based).
992 * protects the upstream link used by this device from concurrent
993 * tree operations like suspend, resume, reset, and disconnect, which
994 * apply to everything downstream of a given port.
995 */
996static int locktree(struct usb_device *udev)
997{
998 int t;
999 struct usb_device *hdev;
1000
1001 if (!udev)
1002 return -ENODEV;
1003
1004 /* root hub is always the first lock in the series */
1005 hdev = udev->parent;
1006 if (!hdev) {
1007 usb_lock_device(udev);
1008 return 0;
1009 }
1010
1011 /* on the path from root to us, lock everything from
1012 * top down, dropping parent locks when not needed
1013 */
1014 t = locktree(hdev);
1015 if (t < 0)
1016 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Alan Stern12c3da32005-11-23 12:09:52 -05001018 /* everything is fail-fast once disconnect
1019 * processing starts
1020 */
1021 if (udev->state == USB_STATE_NOTATTACHED) {
1022 usb_unlock_device(hdev);
1023 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 }
Alan Stern12c3da32005-11-23 12:09:52 -05001025
1026 /* when everyone grabs locks top->bottom,
1027 * non-overlapping work may be concurrent
1028 */
1029 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -05001031 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032}
1033
1034static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1035{
1036 int i;
1037
1038 for (i = 0; i < udev->maxchild; ++i) {
1039 if (udev->children[i])
1040 recursively_mark_NOTATTACHED(udev->children[i]);
1041 }
Alan Sternee49fb52006-11-22 16:55:54 -05001042 if (udev->state == USB_STATE_SUSPENDED)
1043 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 udev->state = USB_STATE_NOTATTACHED;
1045}
1046
1047/**
1048 * usb_set_device_state - change a device's current state (usbcore, hcds)
1049 * @udev: pointer to device whose state should be changed
1050 * @new_state: new state value to be stored
1051 *
1052 * udev->state is _not_ fully protected by the device lock. Although
1053 * most transitions are made only while holding the lock, the state can
1054 * can change to USB_STATE_NOTATTACHED at almost any time. This
1055 * is so that devices can be marked as disconnected as soon as possible,
1056 * without having to wait for any semaphores to be released. As a result,
1057 * all changes to any device's state must be protected by the
1058 * device_state_lock spinlock.
1059 *
1060 * Once a device has been added to the device tree, all changes to its state
1061 * should be made using this routine. The state should _not_ be set directly.
1062 *
1063 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1064 * Otherwise udev->state is set to new_state, and if new_state is
1065 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1066 * to USB_STATE_NOTATTACHED.
1067 */
1068void usb_set_device_state(struct usb_device *udev,
1069 enum usb_device_state new_state)
1070{
1071 unsigned long flags;
1072
1073 spin_lock_irqsave(&device_state_lock, flags);
1074 if (udev->state == USB_STATE_NOTATTACHED)
1075 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001076 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001077
1078 /* root hub wakeup capabilities are managed out-of-band
1079 * and may involve silicon errata ... ignore them here.
1080 */
1081 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001082 if (udev->state == USB_STATE_SUSPENDED
1083 || new_state == USB_STATE_SUSPENDED)
1084 ; /* No change to wakeup settings */
1085 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001086 device_init_wakeup(&udev->dev,
1087 (udev->actconfig->desc.bmAttributes
1088 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001089 else
David Brownellfb669cc2006-01-24 08:40:27 -08001090 device_init_wakeup(&udev->dev, 0);
1091 }
Alan Stern645daaa2006-08-30 15:47:02 -04001092 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001093 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 recursively_mark_NOTATTACHED(udev);
1095 spin_unlock_irqrestore(&device_state_lock, flags);
1096}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
1098
Alan Sternd388dab2006-07-01 22:14:24 -04001099#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001100
1101/**
1102 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1103 * @rhdev: struct usb_device for the root hub
1104 *
1105 * The USB host controller driver calls this function when its root hub
1106 * is resumed and Vbus power has been interrupted or the controller
1107 * has been reset. The routine marks all the children of the root hub
1108 * as NOTATTACHED and marks logical connect-change events on their ports.
1109 */
1110void usb_root_hub_lost_power(struct usb_device *rhdev)
1111{
1112 struct usb_hub *hub;
1113 int port1;
1114 unsigned long flags;
1115
1116 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
Alan Stern353a4092006-09-19 10:07:58 -04001117
1118 /* Make sure no potential wakeup events get lost,
1119 * by forcing the root hub to be resumed.
1120 */
1121 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1122
Alan Stern1c50c312005-11-14 11:45:38 -05001123 spin_lock_irqsave(&device_state_lock, flags);
1124 hub = hdev_to_hub(rhdev);
1125 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1126 if (rhdev->children[port1 - 1]) {
1127 recursively_mark_NOTATTACHED(
1128 rhdev->children[port1 - 1]);
1129 set_bit(port1, hub->change_bits);
1130 }
1131 }
1132 spin_unlock_irqrestore(&device_state_lock, flags);
1133}
1134EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1135
Alan Sternd388dab2006-07-01 22:14:24 -04001136#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138static void choose_address(struct usb_device *udev)
1139{
1140 int devnum;
1141 struct usb_bus *bus = udev->bus;
1142
1143 /* If khubd ever becomes multithreaded, this will need a lock */
1144
1145 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1146 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1147 bus->devnum_next);
1148 if (devnum >= 128)
1149 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1150
1151 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1152
1153 if (devnum < 128) {
1154 set_bit(devnum, bus->devmap.devicemap);
1155 udev->devnum = devnum;
1156 }
1157}
1158
1159static void release_address(struct usb_device *udev)
1160{
1161 if (udev->devnum > 0) {
1162 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1163 udev->devnum = -1;
1164 }
1165}
1166
1167/**
1168 * usb_disconnect - disconnect a device (usbcore-internal)
1169 * @pdev: pointer to device being disconnected
1170 * Context: !in_interrupt ()
1171 *
1172 * Something got disconnected. Get rid of it and all of its children.
1173 *
1174 * If *pdev is a normal device then the parent hub must already be locked.
1175 * If *pdev is a root hub then this routine will acquire the
1176 * usb_bus_list_lock on behalf of the caller.
1177 *
1178 * Only hub drivers (including virtual root hub drivers for host
1179 * controllers) should ever call this.
1180 *
1181 * This call is synchronous, and may not be used in an interrupt context.
1182 */
1183void usb_disconnect(struct usb_device **pdev)
1184{
1185 struct usb_device *udev = *pdev;
1186 int i;
1187
1188 if (!udev) {
1189 pr_debug ("%s nodev\n", __FUNCTION__);
1190 return;
1191 }
1192
1193 /* mark the device as inactive, so any further urb submissions for
1194 * this device (and any of its children) will fail immediately.
1195 * this quiesces everyting except pending urbs.
1196 */
1197 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1199
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001200 usb_lock_device(udev);
1201
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 /* Free up all the children before we remove this device */
1203 for (i = 0; i < USB_MAXCHILDREN; i++) {
1204 if (udev->children[i])
1205 usb_disconnect(&udev->children[i]);
1206 }
1207
1208 /* deallocate hcd/hardware state ... nuking all pending urbs and
1209 * cleaning up all state associated with the current configuration
1210 * so that the hardware is now fully quiesced.
1211 */
Alan Stern782da722006-07-01 22:09:35 -04001212 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 usb_disable_device(udev, 0);
1214
Alan Stern782da722006-07-01 22:09:35 -04001215 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001216
Alan Stern782da722006-07-01 22:09:35 -04001217 /* Unregister the device. The device driver is responsible
1218 * for removing the device files from usbfs and sysfs and for
1219 * de-configuring the device.
1220 */
1221 device_del(&udev->dev);
1222
1223 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 * (or root_hub) pointer.
1225 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
1228 /* Avoid races with recursively_mark_NOTATTACHED() */
1229 spin_lock_irq(&device_state_lock);
1230 *pdev = NULL;
1231 spin_unlock_irq(&device_state_lock);
1232
Alan Sternee49fb52006-11-22 16:55:54 -05001233 /* Decrement the parent's count of unsuspended children */
1234 if (udev->parent) {
1235 usb_pm_lock(udev);
1236 if (!udev->discon_suspended)
Alan Stern94fcda12006-11-20 11:38:46 -05001237 usb_autosuspend_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001238 usb_pm_unlock(udev);
1239 }
1240
Alan Stern782da722006-07-01 22:09:35 -04001241 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242}
1243
1244#ifdef DEBUG
1245static void show_string(struct usb_device *udev, char *id, char *string)
1246{
1247 if (!string)
1248 return;
1249 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1250}
1251
1252#else
1253static inline void show_string(struct usb_device *udev, char *id, char *string)
1254{}
1255#endif
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258#ifdef CONFIG_USB_OTG
1259#include "otg_whitelist.h"
David Brownell11bd44a2006-11-01 14:26:26 -08001260static int __usb_port_suspend(struct usb_device *, int port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261#endif
1262
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001263static int __usb_new_device(void *void_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264{
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001265 struct usb_device *udev = void_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001268 /* Lock ourself into memory in order to keep a probe sequence
1269 * sleeping in a new thread from allowing us to be unloaded.
1270 */
1271 if (!try_module_get(THIS_MODULE))
1272 return -EINVAL;
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 err = usb_get_configuration(udev);
1275 if (err < 0) {
1276 dev_err(&udev->dev, "can't read configurations, error %d\n",
1277 err);
1278 goto fail;
1279 }
1280
1281 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001282 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1283 udev->manufacturer = usb_cache_string(udev,
1284 udev->descriptor.iManufacturer);
1285 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 /* Tell the world! */
1288 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1289 "SerialNumber=%d\n",
1290 udev->descriptor.iManufacturer,
1291 udev->descriptor.iProduct,
1292 udev->descriptor.iSerialNumber);
1293 show_string(udev, "Product", udev->product);
1294 show_string(udev, "Manufacturer", udev->manufacturer);
1295 show_string(udev, "SerialNumber", udev->serial);
1296
1297#ifdef CONFIG_USB_OTG
1298 /*
1299 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1300 * to wake us after we've powered off VBUS; and HNP, switching roles
1301 * "host" to "peripheral". The OTG descriptor helps figure this out.
1302 */
1303 if (!udev->bus->is_b_host
1304 && udev->config
1305 && udev->parent == udev->bus->root_hub) {
1306 struct usb_otg_descriptor *desc = 0;
1307 struct usb_bus *bus = udev->bus;
1308
1309 /* descriptor may appear anywhere in config */
1310 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1311 le16_to_cpu(udev->config[0].desc.wTotalLength),
1312 USB_DT_OTG, (void **) &desc) == 0) {
1313 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001314 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 dev_info(&udev->dev,
1317 "Dual-Role OTG device on %sHNP port\n",
1318 (port1 == bus->otg_port)
1319 ? "" : "non-");
1320
1321 /* enable HNP before suspend, it's simpler */
1322 if (port1 == bus->otg_port)
1323 bus->b_hnp_enable = 1;
1324 err = usb_control_msg(udev,
1325 usb_sndctrlpipe(udev, 0),
1326 USB_REQ_SET_FEATURE, 0,
1327 bus->b_hnp_enable
1328 ? USB_DEVICE_B_HNP_ENABLE
1329 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1330 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1331 if (err < 0) {
1332 /* OTG MESSAGE: report errors here,
1333 * customize to match your product.
1334 */
1335 dev_info(&udev->dev,
1336 "can't set HNP mode; %d\n",
1337 err);
1338 bus->b_hnp_enable = 0;
1339 }
1340 }
1341 }
1342 }
1343
1344 if (!is_targeted(udev)) {
1345
1346 /* Maybe it can talk to us, though we can't talk to it.
1347 * (Includes HNP test device.)
1348 */
1349 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern140d8f62006-07-01 22:07:21 -04001350 err = __usb_port_suspend(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 if (err < 0)
1352 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1353 }
1354 err = -ENODEV;
1355 goto fail;
1356 }
1357#endif
1358
Alan Stern782da722006-07-01 22:09:35 -04001359 /* Register the device. The device driver is responsible
1360 * for adding the device files to usbfs and sysfs and for
1361 * configuring the device.
1362 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 err = device_add (&udev->dev);
1364 if (err) {
1365 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1366 goto fail;
1367 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001368
Alan Sternee49fb52006-11-22 16:55:54 -05001369 /* Increment the parent's count of unsuspended children */
1370 if (udev->parent)
Alan Stern94fcda12006-11-20 11:38:46 -05001371 usb_autoresume_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001372
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001373exit:
1374 module_put(THIS_MODULE);
1375 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377fail:
1378 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001379 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
1381
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001382/**
1383 * usb_new_device - perform initial device setup (usbcore-internal)
1384 * @udev: newly addressed device (in ADDRESS state)
1385 *
1386 * This is called with devices which have been enumerated, but not yet
1387 * configured. The device descriptor is available, but not descriptors
1388 * for any device configuration. The caller must have locked either
1389 * the parent hub (if udev is a normal device) or else the
1390 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1391 * udev has already been installed, but udev is not yet visible through
1392 * sysfs or other filesystem code.
1393 *
1394 * The return value for this function depends on if the
1395 * multithread_probe variable is set or not. If it's set, it will
1396 * return a if the probe thread was successfully created or not. If the
1397 * variable is not set, it will return if the device is configured
1398 * properly or not. interfaces, in sysfs); else a negative errno value.
1399 *
1400 * This call is synchronous, and may not be used in an interrupt context.
1401 *
1402 * Only the hub driver or root-hub registrar should ever call this.
1403 */
1404int usb_new_device(struct usb_device *udev)
1405{
1406 struct task_struct *probe_task;
1407 int ret = 0;
1408
1409 if (multithread_probe) {
1410 probe_task = kthread_run(__usb_new_device, udev,
1411 "usb-probe-%s", udev->devnum);
1412 if (IS_ERR(probe_task))
1413 ret = PTR_ERR(probe_task);
1414 } else
1415 ret = __usb_new_device(udev);
1416
1417 return ret;
1418}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
1420static int hub_port_status(struct usb_hub *hub, int port1,
1421 u16 *status, u16 *change)
1422{
1423 int ret;
1424
1425 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001426 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 dev_err (hub->intfdev,
1428 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001429 if (ret >= 0)
1430 ret = -EIO;
1431 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 *status = le16_to_cpu(hub->status->port.wPortStatus);
1433 *change = le16_to_cpu(hub->status->port.wPortChange);
1434 ret = 0;
1435 }
1436 return ret;
1437}
1438
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001439
1440/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1441static unsigned hub_is_wusb(struct usb_hub *hub)
1442{
1443 struct usb_hcd *hcd;
1444 if (hub->hdev->parent != NULL) /* not a root hub? */
1445 return 0;
1446 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1447 return hcd->wireless;
1448}
1449
1450
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451#define PORT_RESET_TRIES 5
1452#define SET_ADDRESS_TRIES 2
1453#define GET_DESCRIPTOR_TRIES 2
1454#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1455#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1456
1457#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1458#define HUB_SHORT_RESET_TIME 10
1459#define HUB_LONG_RESET_TIME 200
1460#define HUB_RESET_TIMEOUT 500
1461
1462static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1463 struct usb_device *udev, unsigned int delay)
1464{
1465 int delay_time, ret;
1466 u16 portstatus;
1467 u16 portchange;
1468
1469 for (delay_time = 0;
1470 delay_time < HUB_RESET_TIMEOUT;
1471 delay_time += delay) {
1472 /* wait to give the device a chance to reset */
1473 msleep(delay);
1474
1475 /* read and decode port status */
1476 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1477 if (ret < 0)
1478 return ret;
1479
1480 /* Device went away? */
1481 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1482 return -ENOTCONN;
1483
1484 /* bomb out completely if something weird happened */
1485 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1486 return -EINVAL;
1487
1488 /* if we`ve finished resetting, then break out of the loop */
1489 if (!(portstatus & USB_PORT_STAT_RESET) &&
1490 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001491 if (hub_is_wusb(hub))
1492 udev->speed = USB_SPEED_VARIABLE;
1493 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 udev->speed = USB_SPEED_HIGH;
1495 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1496 udev->speed = USB_SPEED_LOW;
1497 else
1498 udev->speed = USB_SPEED_FULL;
1499 return 0;
1500 }
1501
1502 /* switch to the long delay after two short delay failures */
1503 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1504 delay = HUB_LONG_RESET_TIME;
1505
1506 dev_dbg (hub->intfdev,
1507 "port %d not reset yet, waiting %dms\n",
1508 port1, delay);
1509 }
1510
1511 return -EBUSY;
1512}
1513
1514static int hub_port_reset(struct usb_hub *hub, int port1,
1515 struct usb_device *udev, unsigned int delay)
1516{
1517 int i, status;
1518
1519 /* Reset the port */
1520 for (i = 0; i < PORT_RESET_TRIES; i++) {
1521 status = set_port_feature(hub->hdev,
1522 port1, USB_PORT_FEAT_RESET);
1523 if (status)
1524 dev_err(hub->intfdev,
1525 "cannot reset port %d (err = %d)\n",
1526 port1, status);
1527 else {
1528 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001529 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 dev_dbg(hub->intfdev,
1531 "port_wait_reset: err = %d\n",
1532 status);
1533 }
1534
1535 /* return on disconnect or reset */
1536 switch (status) {
1537 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001538 /* TRSTRCY = 10 ms; plus some extra */
1539 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 /* FALL THROUGH */
1541 case -ENOTCONN:
1542 case -ENODEV:
1543 clear_port_feature(hub->hdev,
1544 port1, USB_PORT_FEAT_C_RESET);
1545 /* FIXME need disconnect() for NOTATTACHED device */
1546 usb_set_device_state(udev, status
1547 ? USB_STATE_NOTATTACHED
1548 : USB_STATE_DEFAULT);
1549 return status;
1550 }
1551
1552 dev_dbg (hub->intfdev,
1553 "port %d not enabled, trying reset again...\n",
1554 port1);
1555 delay = HUB_LONG_RESET_TIME;
1556 }
1557
1558 dev_err (hub->intfdev,
1559 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1560 port1);
1561
1562 return status;
1563}
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565/*
1566 * Disable a port and mark a logical connnect-change event, so that some
1567 * time later khubd will disconnect() any existing usb_device on the port
1568 * and will re-enumerate if there actually is a device attached.
1569 */
1570static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1571{
1572 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1573 hub_port_disable(hub, port1, 1);
1574
1575 /* FIXME let caller ask to power down the port:
1576 * - some devices won't enumerate without a VBUS power cycle
1577 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001578 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 * That's easy if this hub can switch power per-port, and
1580 * khubd reactivates the port later (timer, SRP, etc).
1581 * Powerdown must be optional, because of reset/DFU.
1582 */
1583
1584 set_bit(port1, hub->change_bits);
1585 kick_khubd(hub);
1586}
1587
Alan Sternd388dab2006-07-01 22:14:24 -04001588#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
1590#ifdef CONFIG_USB_SUSPEND
1591
1592/*
1593 * Selective port suspend reduces power; most suspended devices draw
1594 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1595 * All devices below the suspended port are also suspended.
1596 *
1597 * Devices leave suspend state when the host wakes them up. Some devices
1598 * also support "remote wakeup", where the device can activate the USB
1599 * tree above them to deliver data, such as a keypress or packet. In
1600 * some cases, this wakes the USB host.
1601 */
1602static int hub_port_suspend(struct usb_hub *hub, int port1,
1603 struct usb_device *udev)
1604{
1605 int status;
1606
1607 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1608
1609 /* enable remote wakeup when appropriate; this lets the device
1610 * wake up the upstream hub (including maybe the root hub).
1611 *
1612 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1613 * we don't explicitly enable it here.
1614 */
Alan Stern645daaa2006-08-30 15:47:02 -04001615 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1617 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1618 USB_DEVICE_REMOTE_WAKEUP, 0,
1619 NULL, 0,
1620 USB_CTRL_SET_TIMEOUT);
1621 if (status)
1622 dev_dbg(&udev->dev,
1623 "won't remote wakeup, status %d\n",
1624 status);
1625 }
1626
1627 /* see 7.1.7.6 */
1628 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1629 if (status) {
1630 dev_dbg(hub->intfdev,
1631 "can't suspend port %d, status %d\n",
1632 port1, status);
1633 /* paranoia: "should not happen" */
1634 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1635 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1636 USB_DEVICE_REMOTE_WAKEUP, 0,
1637 NULL, 0,
1638 USB_CTRL_SET_TIMEOUT);
1639 } else {
1640 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001641 dev_dbg(&udev->dev, "usb %ssuspend\n",
1642 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1644 msleep(10);
1645 }
1646 return status;
1647}
1648
1649/*
1650 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001651 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 * State transitions include:
1653 *
1654 * - suspend, resume ... when the VBUS power link stays live
1655 * - suspend, disconnect ... VBUS lost
1656 *
1657 * Once VBUS drop breaks the circuit, the port it's using has to go through
1658 * normal re-enumeration procedures, starting with enabling VBUS power.
1659 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1660 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1661 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001662 *
1663 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1664 * the root hub for their bus goes into global suspend ... so we don't
1665 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 */
Alan Stern140d8f62006-07-01 22:07:21 -04001667static int __usb_port_suspend (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668{
David Brownellf3f32532005-09-22 22:37:29 -07001669 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670
1671 /* caller owns the udev device lock */
1672 if (port1 < 0)
1673 return port1;
1674
Alan Stern140d8f62006-07-01 22:07:21 -04001675 /* we change the device's upstream USB link,
1676 * but root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 */
David Brownellf3f32532005-09-22 22:37:29 -07001678 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1680 udev);
Alan Stern2bf40862006-07-01 22:12:19 -04001681 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001682 dev_dbg(&udev->dev, "usb %ssuspend\n",
1683 udev->auto_pm ? "auto-" : "");
Alan Stern2bf40862006-07-01 22:12:19 -04001684 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1685 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 return status;
1687}
1688
David Brownell5edbfb72005-09-22 22:45:26 -07001689/*
Alan Stern140d8f62006-07-01 22:07:21 -04001690 * usb_port_suspend - suspend a usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001692 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 *
1694 * Suspends a USB device that isn't in active use, conserving power.
1695 * Devices may wake out of a suspend, if anything important happens,
1696 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001697 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 * to disconnect devices while they are suspended.
1699 *
David Brownell390a8c32005-09-13 19:57:27 -07001700 * This only affects the USB hardware for a device; its interfaces
1701 * (and, for hubs, child devices) must already have been suspended.
1702 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 * Suspending OTG devices may trigger HNP, if that's been enabled
1704 * between a pair of dual-role devices. That will change roles, such
1705 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1706 *
1707 * Returns 0 on success, else negative errno.
1708 */
Alan Stern140d8f62006-07-01 22:07:21 -04001709int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710{
Alan Stern140d8f62006-07-01 22:07:21 -04001711 return __usb_port_suspend(udev, udev->portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
David Brownellf3f32532005-09-22 22:37:29 -07001713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714/*
David Brownell390a8c32005-09-13 19:57:27 -07001715 * If the USB "suspend" state is in use (rather than "global suspend"),
1716 * many devices will be individually taken out of suspend state using
1717 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 * hardware resume signaling is finished, either because of selective
1719 * resume (by host) or remote wakeup (by device) ... now see what changed
1720 * in the tree that's rooted at this device.
1721 */
Alan Stern140d8f62006-07-01 22:07:21 -04001722static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723{
1724 int status;
1725 u16 devstatus;
1726
1727 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001728 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
1730 /* usb ch9 identifies four variants of SUSPENDED, based on what
1731 * state the device resumes to. Linux currently won't see the
1732 * first two on the host side; they'd be inside hub_port_init()
1733 * during many timeouts, but khubd can't suspend until later.
1734 */
1735 usb_set_device_state(udev, udev->actconfig
1736 ? USB_STATE_CONFIGURED
1737 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738
1739 /* 10.5.4.5 says be sure devices in the tree are still there.
1740 * For now let's assume the device didn't go crazy on resume,
1741 * and device drivers will know about any resume quirks.
1742 */
1743 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001744 if (status >= 0)
1745 status = (status == 2 ? 0 : -ENODEV);
1746
1747 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 dev_dbg(&udev->dev,
1749 "gone after usb resume? status %d\n",
1750 status);
1751 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001753 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001754 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 status = usb_control_msg(udev,
1756 usb_sndctrlpipe(udev, 0),
1757 USB_REQ_CLEAR_FEATURE,
1758 USB_RECIP_DEVICE,
1759 USB_DEVICE_REMOTE_WAKEUP, 0,
1760 NULL, 0,
1761 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001762 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 dev_dbg(&udev->dev, "disable remote "
1764 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001765 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 status = 0;
1767
1768 } else if (udev->devnum <= 0) {
1769 dev_dbg(&udev->dev, "bogus resume!\n");
1770 status = -EINVAL;
1771 }
1772 return status;
1773}
1774
1775static int
1776hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1777{
1778 int status;
Alan Sternd25450c2006-11-20 11:14:30 -05001779 u16 portchange, portstatus;
1780
1781 /* Skip the initial Clear-Suspend step for a remote wakeup */
1782 status = hub_port_status(hub, port1, &portstatus, &portchange);
1783 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1784 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
1786 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1787
Alan Sternd5cbad42006-08-11 16:52:39 -04001788 set_bit(port1, hub->busy_bits);
1789
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 /* see 7.1.7.7; affects power usage, but not budgeting */
1791 status = clear_port_feature(hub->hdev,
1792 port1, USB_PORT_FEAT_SUSPEND);
1793 if (status) {
1794 dev_dbg(hub->intfdev,
1795 "can't resume port %d, status %d\n",
1796 port1, status);
1797 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 /* drive resume for at least 20 msec */
1799 if (udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001800 dev_dbg(&udev->dev, "usb %sresume\n",
1801 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 msleep(25);
1803
1804#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1805 | USB_PORT_STAT_ENABLE \
1806 | USB_PORT_STAT_CONNECTION)
1807
1808 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1809 * stop resume signaling. Then finish the resume
1810 * sequence.
1811 */
Alan Sternd25450c2006-11-20 11:14:30 -05001812 status = hub_port_status(hub, port1, &portstatus, &portchange);
1813SuspendCleared:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 if (status < 0
Alan Sternd25450c2006-11-20 11:14:30 -05001815 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1816 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 ) {
1818 dev_dbg(hub->intfdev,
1819 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001820 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001821 if (status >= 0)
1822 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 } else {
Alan Stern20307942006-06-28 11:20:41 -04001824 if (portchange & USB_PORT_STAT_C_SUSPEND)
1825 clear_port_feature(hub->hdev, port1,
1826 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 /* TRSMRCY = 10 msec */
1828 msleep(10);
1829 if (udev)
Alan Stern140d8f62006-07-01 22:07:21 -04001830 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 }
1832 }
1833 if (status < 0)
1834 hub_port_logical_disconnect(hub, port1);
1835
Alan Sternd5cbad42006-08-11 16:52:39 -04001836 clear_bit(port1, hub->busy_bits);
1837 if (!hub->hdev->parent && !hub->busy_bits[0])
1838 usb_enable_root_hub_irq(hub->hdev->bus);
1839
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 return status;
1841}
1842
David Brownell5edbfb72005-09-22 22:45:26 -07001843/*
Alan Stern140d8f62006-07-01 22:07:21 -04001844 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001846 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 *
1848 * This will re-activate the suspended device, increasing power usage
1849 * while letting drivers communicate again with its endpoints.
1850 * USB resume explicitly guarantees that the power session between
1851 * the host and the device is the same as it was when the device
1852 * suspended.
1853 *
1854 * Returns 0 on success, else negative errno.
1855 */
Alan Stern140d8f62006-07-01 22:07:21 -04001856int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857{
Alan Sternd388dab2006-07-01 22:14:24 -04001858 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
Alan Stern140d8f62006-07-01 22:07:21 -04001860 /* we change the device's upstream USB link,
1861 * but root hubs have no upstream USB link.
1862 */
David Brownellf3f32532005-09-22 22:37:29 -07001863 if (udev->parent) {
Alan Stern114b3682006-07-01 22:13:04 -04001864 // NOTE this fails if parent is also suspended...
1865 status = hub_port_resume(hdev_to_hub(udev->parent),
1866 udev->portnum, udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001867 } else {
1868 dev_dbg(&udev->dev, "usb %sresume\n",
1869 udev->auto_pm ? "auto-" : "");
Alan Stern140d8f62006-07-01 22:07:21 -04001870 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001871 }
David Brownellf3f32532005-09-22 22:37:29 -07001872 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001873 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 return status;
1875}
1876
1877static int remote_wakeup(struct usb_device *udev)
1878{
1879 int status = 0;
1880
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001881 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001883 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern94fcda12006-11-20 11:38:46 -05001884 status = usb_autoresume_device(udev);
Alan Sterna8e7c562006-07-01 22:11:02 -04001885
Alan Sternd25450c2006-11-20 11:14:30 -05001886 /* Give the interface drivers a chance to do something,
1887 * then autosuspend the device again. */
1888 if (status == 0)
Alan Stern94fcda12006-11-20 11:38:46 -05001889 usb_autosuspend_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001890 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001891 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 return status;
1893}
1894
Alan Sternd388dab2006-07-01 22:14:24 -04001895#else /* CONFIG_USB_SUSPEND */
1896
1897/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1898
1899int usb_port_suspend(struct usb_device *udev)
1900{
1901 return 0;
1902}
1903
1904static inline int
1905finish_port_resume(struct usb_device *udev)
1906{
1907 return 0;
1908}
1909
1910static inline int
1911hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1912{
1913 return 0;
1914}
1915
1916int usb_port_resume(struct usb_device *udev)
1917{
1918 return 0;
1919}
1920
1921static inline int remote_wakeup(struct usb_device *udev)
1922{
1923 return 0;
1924}
1925
1926#endif
1927
David Brownelldb690872005-09-13 19:56:33 -07001928static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929{
1930 struct usb_hub *hub = usb_get_intfdata (intf);
1931 struct usb_device *hdev = hub->hdev;
1932 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
David Brownellc9f89fa2005-09-13 19:57:04 -07001934 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1936 struct usb_device *udev;
1937
1938 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001939 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001940#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001941 udev->state != USB_STATE_SUSPENDED
1942#else
1943 udev->dev.power.power_state.event
1944 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001945#endif
Alan Stern114b3682006-07-01 22:13:04 -04001946 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001947 if (!hdev->auto_pm)
1948 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1949 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001950 return -EBUSY;
1951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
1953
Alan Stern40f122f2006-11-09 14:44:33 -05001954 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1955
David Brownellf3f32532005-09-22 22:37:29 -07001956 /* "global suspend" of the downstream HC-to-USB interface */
1957 if (!hdev->parent) {
1958 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001959 if (bus) {
1960 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001961
1962 if (status != 0) {
1963 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1964 status);
1965 return status;
1966 }
1967 } else
1968 return -EOPNOTSUPP;
1969 }
1970
David Brownellc9f89fa2005-09-13 19:57:04 -07001971 /* stop khubd and related activity */
1972 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 return 0;
1974}
1975
1976static int hub_resume(struct usb_interface *intf)
1977{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Stern40f122f2006-11-09 14:44:33 -05001979 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 int status;
1981
Alan Stern40f122f2006-11-09 14:44:33 -05001982 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1983
David Brownellf3f32532005-09-22 22:37:29 -07001984 /* "global resume" of the downstream HC-to-USB interface */
1985 if (!hdev->parent) {
1986 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001987 if (bus) {
1988 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001989 if (status) {
1990 dev_dbg(&intf->dev, "'global' resume %d\n",
1991 status);
1992 return status;
1993 }
1994 } else
1995 return -EOPNOTSUPP;
1996 if (status == 0) {
1997 /* TRSMRCY = 10 msec */
1998 msleep(10);
1999 }
2000 }
2001
Alan Sterna8e7c562006-07-01 22:11:02 -04002002 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07002003 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 return 0;
2005}
2006
Alan Sternd388dab2006-07-01 22:14:24 -04002007#else /* CONFIG_PM */
2008
2009static inline int remote_wakeup(struct usb_device *udev)
2010{
2011 return 0;
2012}
2013
Andrew Morton511366d2006-08-14 23:11:02 -07002014#define hub_suspend NULL
2015#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002016#endif
2017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018void usb_resume_root_hub(struct usb_device *hdev)
2019{
2020 struct usb_hub *hub = hdev_to_hub(hdev);
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 kick_khubd(hub);
2023}
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025
2026/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2027 *
2028 * Between connect detection and reset signaling there must be a delay
2029 * of 100ms at least for debounce and power-settling. The corresponding
2030 * timer shall restart whenever the downstream port detects a disconnect.
2031 *
2032 * Apparently there are some bluetooth and irda-dongles and a number of
2033 * low-speed devices for which this debounce period may last over a second.
2034 * Not covered by the spec - but easy to deal with.
2035 *
2036 * This implementation uses a 1500ms total debounce timeout; if the
2037 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2038 * every 25ms for transient disconnects. When the port status has been
2039 * unchanged for 100ms it returns the port status.
2040 */
2041
2042#define HUB_DEBOUNCE_TIMEOUT 1500
2043#define HUB_DEBOUNCE_STEP 25
2044#define HUB_DEBOUNCE_STABLE 100
2045
2046static int hub_port_debounce(struct usb_hub *hub, int port1)
2047{
2048 int ret;
2049 int total_time, stable_time = 0;
2050 u16 portchange, portstatus;
2051 unsigned connection = 0xffff;
2052
2053 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2054 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2055 if (ret < 0)
2056 return ret;
2057
2058 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2059 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2060 stable_time += HUB_DEBOUNCE_STEP;
2061 if (stable_time >= HUB_DEBOUNCE_STABLE)
2062 break;
2063 } else {
2064 stable_time = 0;
2065 connection = portstatus & USB_PORT_STAT_CONNECTION;
2066 }
2067
2068 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2069 clear_port_feature(hub->hdev, port1,
2070 USB_PORT_FEAT_C_CONNECTION);
2071 }
2072
2073 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2074 break;
2075 msleep(HUB_DEBOUNCE_STEP);
2076 }
2077
2078 dev_dbg (hub->intfdev,
2079 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2080 port1, total_time, stable_time, portstatus);
2081
2082 if (stable_time < HUB_DEBOUNCE_STABLE)
2083 return -ETIMEDOUT;
2084 return portstatus;
2085}
2086
2087static void ep0_reinit(struct usb_device *udev)
2088{
2089 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2090 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2091 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2092}
2093
2094#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2095#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2096
2097static int hub_set_address(struct usb_device *udev)
2098{
2099 int retval;
2100
2101 if (udev->devnum == 0)
2102 return -EINVAL;
2103 if (udev->state == USB_STATE_ADDRESS)
2104 return 0;
2105 if (udev->state != USB_STATE_DEFAULT)
2106 return -EINVAL;
2107 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2108 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2109 NULL, 0, USB_CTRL_SET_TIMEOUT);
2110 if (retval == 0) {
2111 usb_set_device_state(udev, USB_STATE_ADDRESS);
2112 ep0_reinit(udev);
2113 }
2114 return retval;
2115}
2116
2117/* Reset device, (re)assign address, get device descriptor.
2118 * Device connection must be stable, no more debouncing needed.
2119 * Returns device in USB_STATE_ADDRESS, except on error.
2120 *
2121 * If this is called for an already-existing device (as part of
2122 * usb_reset_device), the caller must own the device lock. For a
2123 * newly detected device that is not accessible through any global
2124 * pointers, it's not necessary to lock the device.
2125 */
2126static int
2127hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2128 int retry_counter)
2129{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002130 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 struct usb_device *hdev = hub->hdev;
2133 int i, j, retval;
2134 unsigned delay = HUB_SHORT_RESET_TIME;
2135 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002136 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137
2138 /* root hub ports have a slightly longer reset period
2139 * (from USB 2.0 spec, section 7.1.7.5)
2140 */
2141 if (!hdev->parent) {
2142 delay = HUB_ROOT_RESET_TIME;
2143 if (port1 == hdev->bus->otg_port)
2144 hdev->bus->b_hnp_enable = 0;
2145 }
2146
2147 /* Some low speed devices have problems with the quick delay, so */
2148 /* be a bit pessimistic with those devices. RHbug #23670 */
2149 if (oldspeed == USB_SPEED_LOW)
2150 delay = HUB_LONG_RESET_TIME;
2151
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002152 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
2154 /* Reset the device; full speed may morph to high speed */
2155 retval = hub_port_reset(hub, port1, udev, delay);
2156 if (retval < 0) /* error or disconnect */
2157 goto fail;
2158 /* success, speed is known */
2159 retval = -ENODEV;
2160
2161 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2162 dev_dbg(&udev->dev, "device reset changed speed!\n");
2163 goto fail;
2164 }
2165 oldspeed = udev->speed;
2166
2167 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2168 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002169 * For Wireless USB devices, ep0 max packet is always 512 (tho
2170 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 */
2172 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002173 case USB_SPEED_VARIABLE: /* fixed at 512 */
2174 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2175 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 case USB_SPEED_HIGH: /* fixed at 64 */
2177 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2178 break;
2179 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2180 /* to determine the ep0 maxpacket size, try to read
2181 * the device descriptor to get bMaxPacketSize0 and
2182 * then correct our initial guess.
2183 */
2184 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2185 break;
2186 case USB_SPEED_LOW: /* fixed at 8 */
2187 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2188 break;
2189 default:
2190 goto fail;
2191 }
2192
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002193 type = "";
2194 switch (udev->speed) {
2195 case USB_SPEED_LOW: speed = "low"; break;
2196 case USB_SPEED_FULL: speed = "full"; break;
2197 case USB_SPEED_HIGH: speed = "high"; break;
2198 case USB_SPEED_VARIABLE:
2199 speed = "variable";
2200 type = "Wireless ";
2201 break;
2202 default: speed = "?"; break;
2203 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002205 "%s %s speed %sUSB device using %s and address %d\n",
2206 (udev->config) ? "reset" : "new", speed, type,
2207 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
2209 /* Set up TT records, if needed */
2210 if (hdev->tt) {
2211 udev->tt = hdev->tt;
2212 udev->ttport = hdev->ttport;
2213 } else if (udev->speed != USB_SPEED_HIGH
2214 && hdev->speed == USB_SPEED_HIGH) {
2215 udev->tt = &hub->tt;
2216 udev->ttport = port1;
2217 }
2218
2219 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2220 * Because device hardware and firmware is sometimes buggy in
2221 * this area, and this is how Linux has done it for ages.
2222 * Change it cautiously.
2223 *
2224 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2225 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2226 * so it may help with some non-standards-compliant devices.
2227 * Otherwise we start with SET_ADDRESS and then try to read the
2228 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2229 * value.
2230 */
2231 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2232 if (USE_NEW_SCHEME(retry_counter)) {
2233 struct usb_device_descriptor *buf;
2234 int r = 0;
2235
2236#define GET_DESCRIPTOR_BUFSIZE 64
2237 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2238 if (!buf) {
2239 retval = -ENOMEM;
2240 continue;
2241 }
2242
2243 /* Use a short timeout the first time through,
2244 * so that recalcitrant full-speed devices with
2245 * 8- or 16-byte ep0-maxpackets won't slow things
2246 * down tremendously by NAKing the unexpectedly
2247 * early status stage. Also, retry on all errors;
2248 * some devices are flakey.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002249 * 255 is for WUSB devices, we actually need to use 512.
2250 * WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 */
2252 for (j = 0; j < 3; ++j) {
2253 buf->bMaxPacketSize0 = 0;
2254 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2255 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2256 USB_DT_DEVICE << 8, 0,
2257 buf, GET_DESCRIPTOR_BUFSIZE,
2258 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2259 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002260 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (buf->bDescriptorType ==
2262 USB_DT_DEVICE) {
2263 r = 0;
2264 break;
2265 }
2266 /* FALL THROUGH */
2267 default:
2268 if (r == 0)
2269 r = -EPROTO;
2270 break;
2271 }
2272 if (r == 0)
2273 break;
2274 }
2275 udev->descriptor.bMaxPacketSize0 =
2276 buf->bMaxPacketSize0;
2277 kfree(buf);
2278
2279 retval = hub_port_reset(hub, port1, udev, delay);
2280 if (retval < 0) /* error or disconnect */
2281 goto fail;
2282 if (oldspeed != udev->speed) {
2283 dev_dbg(&udev->dev,
2284 "device reset changed speed!\n");
2285 retval = -ENODEV;
2286 goto fail;
2287 }
2288 if (r) {
2289 dev_err(&udev->dev, "device descriptor "
2290 "read/%s, error %d\n",
2291 "64", r);
2292 retval = -EMSGSIZE;
2293 continue;
2294 }
2295#undef GET_DESCRIPTOR_BUFSIZE
2296 }
2297
2298 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2299 retval = hub_set_address(udev);
2300 if (retval >= 0)
2301 break;
2302 msleep(200);
2303 }
2304 if (retval < 0) {
2305 dev_err(&udev->dev,
2306 "device not accepting address %d, error %d\n",
2307 udev->devnum, retval);
2308 goto fail;
2309 }
2310
2311 /* cope with hardware quirkiness:
2312 * - let SET_ADDRESS settle, some device hardware wants it
2313 * - read ep0 maxpacket even for high and low speed,
2314 */
2315 msleep(10);
2316 if (USE_NEW_SCHEME(retry_counter))
2317 break;
2318
2319 retval = usb_get_device_descriptor(udev, 8);
2320 if (retval < 8) {
2321 dev_err(&udev->dev, "device descriptor "
2322 "read/%s, error %d\n",
2323 "8", retval);
2324 if (retval >= 0)
2325 retval = -EMSGSIZE;
2326 } else {
2327 retval = 0;
2328 break;
2329 }
2330 }
2331 if (retval)
2332 goto fail;
2333
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002334 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2335 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2337 if (udev->speed != USB_SPEED_FULL ||
2338 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2339 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2340 retval = -EMSGSIZE;
2341 goto fail;
2342 }
2343 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2344 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2345 ep0_reinit(udev);
2346 }
2347
2348 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2349 if (retval < (signed)sizeof(udev->descriptor)) {
2350 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2351 "all", retval);
2352 if (retval >= 0)
2353 retval = -ENOMSG;
2354 goto fail;
2355 }
2356
2357 retval = 0;
2358
2359fail:
2360 if (retval)
2361 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002362 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 return retval;
2364}
2365
2366static void
2367check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2368{
2369 struct usb_qualifier_descriptor *qual;
2370 int status;
2371
2372 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2373 if (qual == NULL)
2374 return;
2375
2376 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2377 qual, sizeof *qual);
2378 if (status == sizeof *qual) {
2379 dev_info(&udev->dev, "not running at top speed; "
2380 "connect to a high speed hub\n");
2381 /* hub LEDs are probably harder to miss than syslog */
2382 if (hub->has_indicators) {
2383 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2384 schedule_work (&hub->leds);
2385 }
2386 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002387 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388}
2389
2390static unsigned
2391hub_power_remaining (struct usb_hub *hub)
2392{
2393 struct usb_device *hdev = hub->hdev;
2394 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002395 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396
Alan Stern55c52712005-11-23 12:03:12 -05002397 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 return 0;
2399
Alan Stern55c52712005-11-23 12:03:12 -05002400 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2401 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2402 struct usb_device *udev = hdev->children[port1 - 1];
2403 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404
2405 if (!udev)
2406 continue;
2407
Alan Stern55c52712005-11-23 12:03:12 -05002408 /* Unconfigured devices may not use more than 100mA,
2409 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002411 delta = udev->actconfig->desc.bMaxPower * 2;
2412 else if (port1 != udev->bus->otg_port || hdev->parent)
2413 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 else
Alan Stern55c52712005-11-23 12:03:12 -05002415 delta = 8;
2416 if (delta > hub->mA_per_port)
2417 dev_warn(&udev->dev, "%dmA is over %umA budget "
2418 "for port %d!\n",
2419 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 remaining -= delta;
2421 }
2422 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002423 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2424 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 remaining = 0;
2426 }
2427 return remaining;
2428}
2429
2430/* Handle physical or logical connection change events.
2431 * This routine is called when:
2432 * a port connection-change occurs;
2433 * a port enable-change occurs (often caused by EMI);
2434 * usb_reset_device() encounters changed descriptors (as from
2435 * a firmware download)
2436 * caller already locked the hub
2437 */
2438static void hub_port_connect_change(struct usb_hub *hub, int port1,
2439 u16 portstatus, u16 portchange)
2440{
2441 struct usb_device *hdev = hub->hdev;
2442 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002443 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 int status, i;
2445
2446 dev_dbg (hub_dev,
2447 "port %d, status %04x, change %04x, %s\n",
2448 port1, portstatus, portchange, portspeed (portstatus));
2449
2450 if (hub->has_indicators) {
2451 set_port_led(hub, port1, HUB_LED_AUTO);
2452 hub->indicator[port1-1] = INDICATOR_AUTO;
2453 }
2454
2455 /* Disconnect any existing devices under this port */
2456 if (hdev->children[port1-1])
2457 usb_disconnect(&hdev->children[port1-1]);
2458 clear_bit(port1, hub->change_bits);
2459
2460#ifdef CONFIG_USB_OTG
2461 /* during HNP, don't repeat the debounce */
2462 if (hdev->bus->is_b_host)
2463 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2464#endif
2465
2466 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2467 status = hub_port_debounce(hub, port1);
2468 if (status < 0) {
2469 dev_err (hub_dev,
2470 "connect-debounce failed, port %d disabled\n",
2471 port1);
2472 goto done;
2473 }
2474 portstatus = status;
2475 }
2476
2477 /* Return now if nothing is connected */
2478 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2479
2480 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002481 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2483 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2484
2485 if (portstatus & USB_PORT_STAT_ENABLE)
2486 goto done;
2487 return;
2488 }
2489
2490#ifdef CONFIG_USB_SUSPEND
2491 /* If something is connected, but the port is suspended, wake it up. */
2492 if (portstatus & USB_PORT_STAT_SUSPEND) {
2493 status = hub_port_resume(hub, port1, NULL);
2494 if (status < 0) {
2495 dev_dbg(hub_dev,
2496 "can't clear suspend on port %d; %d\n",
2497 port1, status);
2498 goto done;
2499 }
2500 }
2501#endif
2502
2503 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2504 struct usb_device *udev;
2505
2506 /* reallocate for each attempt, since references
2507 * to the previous one can escape in various ways
2508 */
2509 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2510 if (!udev) {
2511 dev_err (hub_dev,
2512 "couldn't allocate port %d usb_device\n",
2513 port1);
2514 goto done;
2515 }
2516
2517 usb_set_device_state(udev, USB_STATE_POWERED);
2518 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002519 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002520 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002521
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 /* set the address */
2523 choose_address(udev);
2524 if (udev->devnum <= 0) {
2525 status = -ENOTCONN; /* Don't retry */
2526 goto loop;
2527 }
2528
2529 /* reset and get descriptor */
2530 status = hub_port_init(hub, udev, port1, i);
2531 if (status < 0)
2532 goto loop;
2533
2534 /* consecutive bus-powered hubs aren't reliable; they can
2535 * violate the voltage drop budget. if the new child has
2536 * a "powered" LED, users should notice we didn't enable it
2537 * (without reading syslog), even without per-port LEDs
2538 * on the parent.
2539 */
2540 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002541 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542 u16 devstat;
2543
2544 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2545 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002546 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 dev_dbg(&udev->dev, "get status %d ?\n", status);
2548 goto loop_disable;
2549 }
Alan Stern55c52712005-11-23 12:03:12 -05002550 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2552 dev_err(&udev->dev,
2553 "can't connect bus-powered hub "
2554 "to this port\n");
2555 if (hub->has_indicators) {
2556 hub->indicator[port1-1] =
2557 INDICATOR_AMBER_BLINK;
2558 schedule_work (&hub->leds);
2559 }
2560 status = -ENOTCONN; /* Don't retry */
2561 goto loop_disable;
2562 }
2563 }
2564
2565 /* check for devices running slower than they could */
2566 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2567 && udev->speed == USB_SPEED_FULL
2568 && highspeed_hubs != 0)
2569 check_highspeed (hub, udev, port1);
2570
2571 /* Store the parent's children[] pointer. At this point
2572 * udev becomes globally accessible, although presumably
2573 * no one will look at it until hdev is unlocked.
2574 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 status = 0;
2576
2577 /* We mustn't add new devices if the parent hub has
2578 * been disconnected; we would race with the
2579 * recursively_mark_NOTATTACHED() routine.
2580 */
2581 spin_lock_irq(&device_state_lock);
2582 if (hdev->state == USB_STATE_NOTATTACHED)
2583 status = -ENOTCONN;
2584 else
2585 hdev->children[port1-1] = udev;
2586 spin_unlock_irq(&device_state_lock);
2587
2588 /* Run it through the hoops (find a driver, etc) */
2589 if (!status) {
2590 status = usb_new_device(udev);
2591 if (status) {
2592 spin_lock_irq(&device_state_lock);
2593 hdev->children[port1-1] = NULL;
2594 spin_unlock_irq(&device_state_lock);
2595 }
2596 }
2597
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 if (status)
2599 goto loop_disable;
2600
2601 status = hub_power_remaining(hub);
2602 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002603 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604
2605 return;
2606
2607loop_disable:
2608 hub_port_disable(hub, port1, 1);
2609loop:
2610 ep0_reinit(udev);
2611 release_address(udev);
2612 usb_put_dev(udev);
2613 if (status == -ENOTCONN)
2614 break;
2615 }
2616
2617done:
2618 hub_port_disable(hub, port1, 1);
2619}
2620
2621static void hub_events(void)
2622{
2623 struct list_head *tmp;
2624 struct usb_device *hdev;
2625 struct usb_interface *intf;
2626 struct usb_hub *hub;
2627 struct device *hub_dev;
2628 u16 hubstatus;
2629 u16 hubchange;
2630 u16 portstatus;
2631 u16 portchange;
2632 int i, ret;
2633 int connect_change;
2634
2635 /*
2636 * We restart the list every time to avoid a deadlock with
2637 * deleting hubs downstream from this one. This should be
2638 * safe since we delete the hub from the event list.
2639 * Not the most efficient, but avoids deadlocks.
2640 */
2641 while (1) {
2642
2643 /* Grab the first entry at the beginning of the list */
2644 spin_lock_irq(&hub_event_lock);
2645 if (list_empty(&hub_event_list)) {
2646 spin_unlock_irq(&hub_event_lock);
2647 break;
2648 }
2649
2650 tmp = hub_event_list.next;
2651 list_del_init(tmp);
2652
2653 hub = list_entry(tmp, struct usb_hub, event_list);
2654 hdev = hub->hdev;
2655 intf = to_usb_interface(hub->intfdev);
2656 hub_dev = &intf->dev;
2657
Alan Stern40f122f2006-11-09 14:44:33 -05002658 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 hdev->state, hub->descriptor
2660 ? hub->descriptor->bNbrPorts
2661 : 0,
2662 /* NOTE: expects max 15 ports... */
2663 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002664 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665
2666 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 spin_unlock_irq(&hub_event_lock);
2668
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 /* Lock the device, then check to see if we were
2670 * disconnected while waiting for the lock to succeed. */
2671 if (locktree(hdev) < 0) {
2672 usb_put_intf(intf);
2673 continue;
2674 }
2675 if (hub != usb_get_intfdata(intf))
2676 goto loop;
2677
2678 /* If the hub has died, clean up after it */
2679 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002680 hub->error = -ENODEV;
2681 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 goto loop;
2683 }
2684
Alan Stern40f122f2006-11-09 14:44:33 -05002685 /* Autoresume */
2686 ret = usb_autopm_get_interface(intf);
2687 if (ret) {
2688 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002690 }
2691
2692 /* If this is an inactive hub, do nothing */
2693 if (hub->quiescing)
2694 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695
2696 if (hub->error) {
2697 dev_dbg (hub_dev, "resetting for error %d\n",
2698 hub->error);
2699
Alan Stern7de18d82006-06-01 13:37:24 -04002700 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 if (ret) {
2702 dev_dbg (hub_dev,
2703 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002704 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705 }
2706
2707 hub->nerrors = 0;
2708 hub->error = 0;
2709 }
2710
2711 /* deal with port status changes */
2712 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2713 if (test_bit(i, hub->busy_bits))
2714 continue;
2715 connect_change = test_bit(i, hub->change_bits);
2716 if (!test_and_clear_bit(i, hub->event_bits) &&
2717 !connect_change && !hub->activating)
2718 continue;
2719
2720 ret = hub_port_status(hub, i,
2721 &portstatus, &portchange);
2722 if (ret < 0)
2723 continue;
2724
2725 if (hub->activating && !hdev->children[i-1] &&
2726 (portstatus &
2727 USB_PORT_STAT_CONNECTION))
2728 connect_change = 1;
2729
2730 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2731 clear_port_feature(hdev, i,
2732 USB_PORT_FEAT_C_CONNECTION);
2733 connect_change = 1;
2734 }
2735
2736 if (portchange & USB_PORT_STAT_C_ENABLE) {
2737 if (!connect_change)
2738 dev_dbg (hub_dev,
2739 "port %d enable change, "
2740 "status %08x\n",
2741 i, portstatus);
2742 clear_port_feature(hdev, i,
2743 USB_PORT_FEAT_C_ENABLE);
2744
2745 /*
2746 * EM interference sometimes causes badly
2747 * shielded USB devices to be shutdown by
2748 * the hub, this hack enables them again.
2749 * Works at least with mouse driver.
2750 */
2751 if (!(portstatus & USB_PORT_STAT_ENABLE)
2752 && !connect_change
2753 && hdev->children[i-1]) {
2754 dev_err (hub_dev,
2755 "port %i "
2756 "disabled by hub (EMI?), "
2757 "re-enabling...\n",
2758 i);
2759 connect_change = 1;
2760 }
2761 }
2762
2763 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2764 clear_port_feature(hdev, i,
2765 USB_PORT_FEAT_C_SUSPEND);
2766 if (hdev->children[i-1]) {
2767 ret = remote_wakeup(hdev->
2768 children[i-1]);
2769 if (ret < 0)
2770 connect_change = 1;
2771 } else {
2772 ret = -ENODEV;
2773 hub_port_disable(hub, i, 1);
2774 }
2775 dev_dbg (hub_dev,
2776 "resume on port %d, status %d\n",
2777 i, ret);
2778 }
2779
2780 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2781 dev_err (hub_dev,
2782 "over-current change on port %d\n",
2783 i);
2784 clear_port_feature(hdev, i,
2785 USB_PORT_FEAT_C_OVER_CURRENT);
2786 hub_power_on(hub);
2787 }
2788
2789 if (portchange & USB_PORT_STAT_C_RESET) {
2790 dev_dbg (hub_dev,
2791 "reset change on port %d\n",
2792 i);
2793 clear_port_feature(hdev, i,
2794 USB_PORT_FEAT_C_RESET);
2795 }
2796
2797 if (connect_change)
2798 hub_port_connect_change(hub, i,
2799 portstatus, portchange);
2800 } /* end for i */
2801
2802 /* deal with hub status changes */
2803 if (test_and_clear_bit(0, hub->event_bits) == 0)
2804 ; /* do nothing */
2805 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2806 dev_err (hub_dev, "get_hub_status failed\n");
2807 else {
2808 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2809 dev_dbg (hub_dev, "power change\n");
2810 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002811 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2812 /* FIXME: Is this always true? */
2813 hub->limited_power = 0;
2814 else
2815 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 }
2817 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2818 dev_dbg (hub_dev, "overcurrent change\n");
2819 msleep(500); /* Cool down */
2820 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2821 hub_power_on(hub);
2822 }
2823 }
2824
2825 hub->activating = 0;
2826
Alan Sternd5926ae72005-04-21 15:56:37 -04002827 /* If this is a root hub, tell the HCD it's okay to
2828 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002829 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002830 usb_enable_root_hub_irq(hdev->bus);
2831
Alan Stern40f122f2006-11-09 14:44:33 -05002832loop_autopm:
2833 /* Allow autosuspend if we're not going to run again */
2834 if (list_empty(&hub->event_list))
2835 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836loop:
2837 usb_unlock_device(hdev);
2838 usb_put_intf(intf);
2839
2840 } /* end while (1) */
2841}
2842
2843static int hub_thread(void *__unused)
2844{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 do {
2846 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002847 wait_event_interruptible(khubd_wait,
2848 !list_empty(&hub_event_list) ||
2849 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002850 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002851 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002853 pr_debug("%s: khubd exiting\n", usbcore_name);
2854 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855}
2856
2857static struct usb_device_id hub_id_table [] = {
2858 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2859 .bDeviceClass = USB_CLASS_HUB},
2860 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2861 .bInterfaceClass = USB_CLASS_HUB},
2862 { } /* Terminating entry */
2863};
2864
2865MODULE_DEVICE_TABLE (usb, hub_id_table);
2866
2867static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868 .name = "hub",
2869 .probe = hub_probe,
2870 .disconnect = hub_disconnect,
2871 .suspend = hub_suspend,
2872 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002873 .pre_reset = hub_pre_reset,
2874 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875 .ioctl = hub_ioctl,
2876 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002877 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878};
2879
2880int usb_hub_init(void)
2881{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882 if (usb_register(&hub_driver) < 0) {
2883 printk(KERN_ERR "%s: can't register hub driver\n",
2884 usbcore_name);
2885 return -1;
2886 }
2887
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002888 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2889 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891
2892 /* Fall through if kernel_thread failed */
2893 usb_deregister(&hub_driver);
2894 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2895
2896 return -1;
2897}
2898
2899void usb_hub_cleanup(void)
2900{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002901 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
2903 /*
2904 * Hub resources are freed for us by usb_deregister. It calls
2905 * usb_driver_purge on every device which in turn calls that
2906 * devices disconnect function if it is using this driver.
2907 * The hub_disconnect function takes care of releasing the
2908 * individual hub resources. -greg
2909 */
2910 usb_deregister(&hub_driver);
2911} /* usb_hub_cleanup() */
2912
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913static int config_descriptors_changed(struct usb_device *udev)
2914{
2915 unsigned index;
2916 unsigned len = 0;
2917 struct usb_config_descriptor *buf;
2918
2919 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2920 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2921 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2922 }
2923 buf = kmalloc (len, SLAB_KERNEL);
2924 if (buf == NULL) {
2925 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2926 /* assume the worst */
2927 return 1;
2928 }
2929 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2930 int length;
2931 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2932
2933 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2934 old_length);
2935 if (length < old_length) {
2936 dev_dbg(&udev->dev, "config index %d, error %d\n",
2937 index, length);
2938 break;
2939 }
2940 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2941 != 0) {
2942 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2943 index, buf->bConfigurationValue);
2944 break;
2945 }
2946 }
2947 kfree(buf);
2948 return index != udev->descriptor.bNumConfigurations;
2949}
2950
2951/**
2952 * usb_reset_device - perform a USB port reset to reinitialize a device
2953 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2954 *
Alan Stern79efa092006-06-01 13:33:42 -04002955 * WARNING - don't use this routine to reset a composite device
2956 * (one with multiple interfaces owned by separate drivers)!
2957 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958 *
2959 * Do a port reset, reassign the device's address, and establish its
2960 * former operating configuration. If the reset fails, or the device's
2961 * descriptors change from their values before the reset, or the original
2962 * configuration and altsettings cannot be restored, a flag will be set
2963 * telling khubd to pretend the device has been disconnected and then
2964 * re-connected. All drivers will be unbound, and the device will be
2965 * re-enumerated and probed all over again.
2966 *
2967 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2968 * flagged for logical disconnection, or some other negative error code
2969 * if the reset wasn't even attempted.
2970 *
2971 * The caller must own the device lock. For example, it's safe to use
2972 * this from a driver probe() routine after downloading new firmware.
2973 * For calls that might not occur during probe(), drivers should lock
2974 * the device using usb_lock_device_for_reset().
2975 */
2976int usb_reset_device(struct usb_device *udev)
2977{
2978 struct usb_device *parent_hdev = udev->parent;
2979 struct usb_hub *parent_hub;
2980 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002981 int i, ret = 0;
2982 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983
2984 if (udev->state == USB_STATE_NOTATTACHED ||
2985 udev->state == USB_STATE_SUSPENDED) {
2986 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2987 udev->state);
2988 return -EINVAL;
2989 }
2990
2991 if (!parent_hdev) {
2992 /* this requires hcd-specific logic; see OHCI hc_restart() */
2993 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2994 return -EISDIR;
2995 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996 parent_hub = hdev_to_hub(parent_hdev);
2997
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998 set_bit(port1, parent_hub->busy_bits);
2999 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3000
3001 /* ep0 maxpacket size may change; let the HCD know about it.
3002 * Other endpoints will be handled by re-enumeration. */
3003 ep0_reinit(udev);
3004 ret = hub_port_init(parent_hub, udev, port1, i);
3005 if (ret >= 0)
3006 break;
3007 }
3008 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003009 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3010 usb_enable_root_hub_irq(parent_hdev->bus);
3011
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012 if (ret < 0)
3013 goto re_enumerate;
3014
3015 /* Device might have changed firmware (DFU or similar) */
3016 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3017 || config_descriptors_changed (udev)) {
3018 dev_info(&udev->dev, "device firmware changed\n");
3019 udev->descriptor = descriptor; /* for disconnect() calls */
3020 goto re_enumerate;
3021 }
3022
3023 if (!udev->actconfig)
3024 goto done;
3025
3026 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3027 USB_REQ_SET_CONFIGURATION, 0,
3028 udev->actconfig->desc.bConfigurationValue, 0,
3029 NULL, 0, USB_CTRL_SET_TIMEOUT);
3030 if (ret < 0) {
3031 dev_err(&udev->dev,
3032 "can't restore configuration #%d (error=%d)\n",
3033 udev->actconfig->desc.bConfigurationValue, ret);
3034 goto re_enumerate;
3035 }
3036 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3037
3038 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3039 struct usb_interface *intf = udev->actconfig->interface[i];
3040 struct usb_interface_descriptor *desc;
3041
3042 /* set_interface resets host side toggle even
3043 * for altsetting zero. the interface may have no driver.
3044 */
3045 desc = &intf->cur_altsetting->desc;
3046 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3047 desc->bAlternateSetting);
3048 if (ret < 0) {
3049 dev_err(&udev->dev, "failed to restore interface %d "
3050 "altsetting %d (error=%d)\n",
3051 desc->bInterfaceNumber,
3052 desc->bAlternateSetting,
3053 ret);
3054 goto re_enumerate;
3055 }
3056 }
3057
3058done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059 return 0;
3060
3061re_enumerate:
3062 hub_port_logical_disconnect(parent_hub, port1);
3063 return -ENODEV;
3064}
Alan Stern140d8f62006-07-01 22:07:21 -04003065EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003066
3067/**
3068 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3069 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3070 * @iface: interface bound to the driver making the request (optional)
3071 *
3072 * Warns all drivers bound to registered interfaces (using their pre_reset
3073 * method), performs the port reset, and then lets the drivers know that
3074 * the reset is over (using their post_reset method).
3075 *
3076 * Return value is the same as for usb_reset_device().
3077 *
3078 * The caller must own the device lock. For example, it's safe to use
3079 * this from a driver probe() routine after downloading new firmware.
3080 * For calls that might not occur during probe(), drivers should lock
3081 * the device using usb_lock_device_for_reset().
3082 *
3083 * The interface locks are acquired during the pre_reset stage and released
3084 * during the post_reset stage. However if iface is not NULL and is
3085 * currently being probed, we assume that the caller already owns its
3086 * lock.
3087 */
3088int usb_reset_composite_device(struct usb_device *udev,
3089 struct usb_interface *iface)
3090{
3091 int ret;
3092 struct usb_host_config *config = udev->actconfig;
3093
3094 if (udev->state == USB_STATE_NOTATTACHED ||
3095 udev->state == USB_STATE_SUSPENDED) {
3096 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3097 udev->state);
3098 return -EINVAL;
3099 }
3100
Alan Stern645daaa2006-08-30 15:47:02 -04003101 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003102 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003103
Alan Stern79efa092006-06-01 13:33:42 -04003104 if (iface && iface->condition != USB_INTERFACE_BINDING)
3105 iface = NULL;
3106
3107 if (config) {
3108 int i;
3109 struct usb_interface *cintf;
3110 struct usb_driver *drv;
3111
3112 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3113 cintf = config->interface[i];
3114 if (cintf != iface)
3115 down(&cintf->dev.sem);
3116 if (device_is_registered(&cintf->dev) &&
3117 cintf->dev.driver) {
3118 drv = to_usb_driver(cintf->dev.driver);
3119 if (drv->pre_reset)
3120 (drv->pre_reset)(cintf);
3121 }
3122 }
3123 }
3124
3125 ret = usb_reset_device(udev);
3126
3127 if (config) {
3128 int i;
3129 struct usb_interface *cintf;
3130 struct usb_driver *drv;
3131
3132 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3133 cintf = config->interface[i];
3134 if (device_is_registered(&cintf->dev) &&
3135 cintf->dev.driver) {
3136 drv = to_usb_driver(cintf->dev.driver);
3137 if (drv->post_reset)
3138 (drv->post_reset)(cintf);
3139 }
3140 if (cintf != iface)
3141 up(&cintf->dev.sem);
3142 }
3143 }
3144
Alan Stern94fcda12006-11-20 11:38:46 -05003145 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003146 return ret;
3147}
Alan Stern140d8f62006-07-01 22:07:21 -04003148EXPORT_SYMBOL(usb_reset_composite_device);