blob: 41400743ce2cc85b5a173d7360b6c0066cc54b8a [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>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080025#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#include <asm/semaphore.h>
28#include <asm/uaccess.h>
29#include <asm/byteorder.h>
30
31#include "usb.h"
32#include "hcd.h"
33#include "hub.h"
34
Alan Stern1bb5f662006-11-06 11:56:13 -050035struct usb_hub {
36 struct device *intfdev; /* the "interface" device */
37 struct usb_device *hdev;
38 struct urb *urb; /* for interrupt polling pipe */
39
40 /* buffer for urb ... with extra space in case of babble */
41 char (*buffer)[8];
42 dma_addr_t buffer_dma; /* DMA address for buffer */
43 union {
44 struct usb_hub_status hub;
45 struct usb_port_status port;
46 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050047 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050048
49 int error; /* last reported error */
50 int nerrors; /* track consecutive errors */
51
52 struct list_head event_list; /* hubs w/data or errs ready */
53 unsigned long event_bits[1]; /* status change bitmask */
54 unsigned long change_bits[1]; /* ports with logical connect
55 status change */
56 unsigned long busy_bits[1]; /* ports being reset or
57 resumed */
58#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
59#error event_bits[] is too short!
60#endif
61
62 struct usb_hub_descriptor *descriptor; /* class descriptor */
63 struct usb_tt tt; /* Transaction Translator */
64
65 unsigned mA_per_port; /* current for each child */
66
67 unsigned limited_power:1;
68 unsigned quiescing:1;
69 unsigned activating:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050070
71 unsigned has_indicators:1;
72 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000073 struct delayed_work leds;
Alan Stern1bb5f662006-11-06 11:56:13 -050074};
75
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050078 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
80static DEFINE_SPINLOCK(device_state_lock);
81
82/* khubd's worklist and its lock */
83static DEFINE_SPINLOCK(hub_event_lock);
84static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
85
86/* Wakes up khubd */
87static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
88
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070089static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91/* cycle leds on hubs that aren't blinking for attention */
92static int blinkenlights = 0;
93module_param (blinkenlights, bool, S_IRUGO);
94MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
95
96/*
97 * As of 2.6.10 we introduce a new USB device initialization scheme which
98 * closely resembles the way Windows works. Hopefully it will be compatible
99 * with a wider range of devices than the old scheme. However some previously
100 * working devices may start giving rise to "device not accepting address"
101 * errors; if that happens the user can try the old scheme by adjusting the
102 * following module parameters.
103 *
104 * For maximum flexibility there are two boolean parameters to control the
105 * hub driver's behavior. On the first initialization attempt, if the
106 * "old_scheme_first" parameter is set then the old scheme will be used,
107 * otherwise the new scheme is used. If that fails and "use_both_schemes"
108 * is set, then the driver will make another attempt, using the other scheme.
109 */
110static int old_scheme_first = 0;
111module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
112MODULE_PARM_DESC(old_scheme_first,
113 "start with the old device initialization scheme");
114
115static int use_both_schemes = 1;
116module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
117MODULE_PARM_DESC(use_both_schemes,
118 "try the other device initialization scheme if the "
119 "first one fails");
120
121
122#ifdef DEBUG
123static inline char *portspeed (int portstatus)
124{
125 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
126 return "480 Mb/s";
127 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
128 return "1.5 Mb/s";
129 else
130 return "12 Mb/s";
131}
132#endif
133
134/* Note that hdev or one of its children must be locked! */
135static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
136{
137 return usb_get_intfdata(hdev->actconfig->interface[0]);
138}
139
140/* USB 2.0 spec Section 11.24.4.5 */
141static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
142{
143 int i, ret;
144
145 for (i = 0; i < 3; i++) {
146 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
147 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
148 USB_DT_HUB << 8, 0, data, size,
149 USB_CTRL_GET_TIMEOUT);
150 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
151 return ret;
152 }
153 return -EINVAL;
154}
155
156/*
157 * USB 2.0 spec Section 11.24.2.1
158 */
159static int clear_hub_feature(struct usb_device *hdev, int feature)
160{
161 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
162 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
163}
164
165/*
166 * USB 2.0 spec Section 11.24.2.2
167 */
168static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
169{
170 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
171 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
172 NULL, 0, 1000);
173}
174
175/*
176 * USB 2.0 spec Section 11.24.2.13
177 */
178static int set_port_feature(struct usb_device *hdev, int port1, int feature)
179{
180 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
181 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
182 NULL, 0, 1000);
183}
184
185/*
186 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
187 * for info about using port indicators
188 */
189static void set_port_led(
190 struct usb_hub *hub,
191 int port1,
192 int selector
193)
194{
195 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
196 USB_PORT_FEAT_INDICATOR);
197 if (status < 0)
198 dev_dbg (hub->intfdev,
199 "port %d indicator %s status %d\n",
200 port1,
201 ({ char *s; switch (selector) {
202 case HUB_LED_AMBER: s = "amber"; break;
203 case HUB_LED_GREEN: s = "green"; break;
204 case HUB_LED_OFF: s = "off"; break;
205 case HUB_LED_AUTO: s = "auto"; break;
206 default: s = "??"; break;
207 }; s; }),
208 status);
209}
210
211#define LED_CYCLE_PERIOD ((2*HZ)/3)
212
David Howellsc4028952006-11-22 14:57:56 +0000213static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
David Howellsc4028952006-11-22 14:57:56 +0000215 struct usb_hub *hub =
216 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 struct usb_device *hdev = hub->hdev;
218 unsigned i;
219 unsigned changed = 0;
220 int cursor = -1;
221
222 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
223 return;
224
225 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
226 unsigned selector, mode;
227
228 /* 30%-50% duty cycle */
229
230 switch (hub->indicator[i]) {
231 /* cycle marker */
232 case INDICATOR_CYCLE:
233 cursor = i;
234 selector = HUB_LED_AUTO;
235 mode = INDICATOR_AUTO;
236 break;
237 /* blinking green = sw attention */
238 case INDICATOR_GREEN_BLINK:
239 selector = HUB_LED_GREEN;
240 mode = INDICATOR_GREEN_BLINK_OFF;
241 break;
242 case INDICATOR_GREEN_BLINK_OFF:
243 selector = HUB_LED_OFF;
244 mode = INDICATOR_GREEN_BLINK;
245 break;
246 /* blinking amber = hw attention */
247 case INDICATOR_AMBER_BLINK:
248 selector = HUB_LED_AMBER;
249 mode = INDICATOR_AMBER_BLINK_OFF;
250 break;
251 case INDICATOR_AMBER_BLINK_OFF:
252 selector = HUB_LED_OFF;
253 mode = INDICATOR_AMBER_BLINK;
254 break;
255 /* blink green/amber = reserved */
256 case INDICATOR_ALT_BLINK:
257 selector = HUB_LED_GREEN;
258 mode = INDICATOR_ALT_BLINK_OFF;
259 break;
260 case INDICATOR_ALT_BLINK_OFF:
261 selector = HUB_LED_AMBER;
262 mode = INDICATOR_ALT_BLINK;
263 break;
264 default:
265 continue;
266 }
267 if (selector != HUB_LED_AUTO)
268 changed = 1;
269 set_port_led(hub, i + 1, selector);
270 hub->indicator[i] = mode;
271 }
272 if (!changed && blinkenlights) {
273 cursor++;
274 cursor %= hub->descriptor->bNbrPorts;
275 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
276 hub->indicator[cursor] = INDICATOR_CYCLE;
277 changed++;
278 }
279 if (changed)
280 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
281}
282
283/* use a short timeout for hub/port status fetches */
284#define USB_STS_TIMEOUT 1000
285#define USB_STS_RETRIES 5
286
287/*
288 * USB 2.0 spec Section 11.24.2.6
289 */
290static int get_hub_status(struct usb_device *hdev,
291 struct usb_hub_status *data)
292{
293 int i, status = -ETIMEDOUT;
294
295 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
296 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
297 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
298 data, sizeof(*data), USB_STS_TIMEOUT);
299 }
300 return status;
301}
302
303/*
304 * USB 2.0 spec Section 11.24.2.7
305 */
306static int get_port_status(struct usb_device *hdev, int port1,
307 struct usb_port_status *data)
308{
309 int i, status = -ETIMEDOUT;
310
311 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
312 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
313 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
314 data, sizeof(*data), USB_STS_TIMEOUT);
315 }
316 return status;
317}
318
319static void kick_khubd(struct usb_hub *hub)
320{
321 unsigned long flags;
322
Alan Stern40f122f2006-11-09 14:44:33 -0500323 /* Suppress autosuspend until khubd runs */
324 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 spin_lock_irqsave(&hub_event_lock, flags);
327 if (list_empty(&hub->event_list)) {
328 list_add_tail(&hub->event_list, &hub_event_list);
329 wake_up(&khubd_wait);
330 }
331 spin_unlock_irqrestore(&hub_event_lock, flags);
332}
333
334void usb_kick_khubd(struct usb_device *hdev)
335{
336 kick_khubd(hdev_to_hub(hdev));
337}
338
339
340/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100341static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200343 struct usb_hub *hub = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 int status;
345 int i;
346 unsigned long bits;
347
348 switch (urb->status) {
349 case -ENOENT: /* synchronous unlink */
350 case -ECONNRESET: /* async unlink */
351 case -ESHUTDOWN: /* hardware going away */
352 return;
353
354 default: /* presumably an error */
355 /* Cause a hub reset after 10 consecutive errors */
356 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
357 if ((++hub->nerrors < 10) || hub->error)
358 goto resubmit;
359 hub->error = urb->status;
360 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 /* let khubd handle things */
363 case 0: /* we got data: port status changed */
364 bits = 0;
365 for (i = 0; i < urb->actual_length; ++i)
366 bits |= ((unsigned long) ((*hub->buffer)[i]))
367 << (i*8);
368 hub->event_bits[0] = bits;
369 break;
370 }
371
372 hub->nerrors = 0;
373
374 /* Something happened, let khubd figure it out */
375 kick_khubd(hub);
376
377resubmit:
378 if (hub->quiescing)
379 return;
380
381 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
382 && status != -ENODEV && status != -EPERM)
383 dev_err (hub->intfdev, "resubmit --> %d\n", status);
384}
385
386/* USB 2.0 spec Section 11.24.2.3 */
387static inline int
388hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
389{
390 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
391 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
392 tt, NULL, 0, 1000);
393}
394
395/*
396 * enumeration blocks khubd for a long time. we use keventd instead, since
397 * long blocking there is the exception, not the rule. accordingly, HCDs
398 * talking to TTs must queue control transfers (not just bulk and iso), so
399 * both can talk to the same hub concurrently.
400 */
David Howellsc4028952006-11-22 14:57:56 +0000401static void hub_tt_kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
David Howellsc4028952006-11-22 14:57:56 +0000403 struct usb_hub *hub =
404 container_of(work, struct usb_hub, tt.kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 unsigned long flags;
406
407 spin_lock_irqsave (&hub->tt.lock, flags);
408 while (!list_empty (&hub->tt.clear_list)) {
409 struct list_head *temp;
410 struct usb_tt_clear *clear;
411 struct usb_device *hdev = hub->hdev;
412 int status;
413
414 temp = hub->tt.clear_list.next;
415 clear = list_entry (temp, struct usb_tt_clear, clear_list);
416 list_del (&clear->clear_list);
417
418 /* drop lock so HCD can concurrently report other TT errors */
419 spin_unlock_irqrestore (&hub->tt.lock, flags);
420 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
421 spin_lock_irqsave (&hub->tt.lock, flags);
422
423 if (status)
424 dev_err (&hdev->dev,
425 "clear tt %d (%04x) error %d\n",
426 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700427 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429 spin_unlock_irqrestore (&hub->tt.lock, flags);
430}
431
432/**
433 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
434 * @udev: the device whose split transaction failed
435 * @pipe: identifies the endpoint of the failed transaction
436 *
437 * High speed HCDs use this to tell the hub driver that some split control or
438 * bulk transaction failed in a way that requires clearing internal state of
439 * a transaction translator. This is normally detected (and reported) from
440 * interrupt context.
441 *
442 * It may not be possible for that hub to handle additional full (or low)
443 * speed transactions until that state is fully cleared out.
444 */
445void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
446{
447 struct usb_tt *tt = udev->tt;
448 unsigned long flags;
449 struct usb_tt_clear *clear;
450
451 /* we've got to cope with an arbitrary number of pending TT clears,
452 * since each TT has "at least two" buffers that can need it (and
453 * there can be many TTs per hub). even if they're uncommon.
454 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800455 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
457 /* FIXME recover somehow ... RESET_TT? */
458 return;
459 }
460
461 /* info that CLEAR_TT_BUFFER needs */
462 clear->tt = tt->multi ? udev->ttport : 1;
463 clear->devinfo = usb_pipeendpoint (pipe);
464 clear->devinfo |= udev->devnum << 4;
465 clear->devinfo |= usb_pipecontrol (pipe)
466 ? (USB_ENDPOINT_XFER_CONTROL << 11)
467 : (USB_ENDPOINT_XFER_BULK << 11);
468 if (usb_pipein (pipe))
469 clear->devinfo |= 1 << 15;
470
471 /* tell keventd to clear state for this TT */
472 spin_lock_irqsave (&tt->lock, flags);
473 list_add_tail (&clear->clear_list, &tt->clear_list);
474 schedule_work (&tt->kevent);
475 spin_unlock_irqrestore (&tt->lock, flags);
476}
477
478static void hub_power_on(struct usb_hub *hub)
479{
480 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700481 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400482 u16 wHubCharacteristics =
483 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Alan Stern4489a572006-04-27 15:54:22 -0400485 /* Enable power on each port. Some hubs have reserved values
486 * of LPSM (> 2) in their descriptors, even though they are
487 * USB 2.0 hubs. Some hubs do not implement port-power switching
488 * but only emulate it. In all cases, the ports won't work
489 * unless we send these messages to the hub.
490 */
491 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400493 else
494 dev_dbg(hub->intfdev, "trying to enable port power on "
495 "non-switchable hub\n");
496 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
497 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
David Brownellb7896962005-08-31 10:41:44 -0700499 /* Wait at least 100 msec for power to become stable */
500 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
Alan Stern02c399e2006-08-30 15:47:11 -0400503static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
David Brownell979d5192005-09-22 22:32:24 -0700505 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700507 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700508
David Brownell979d5192005-09-22 22:32:24 -0700509 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 usb_kill_urb(hub->urb);
511 if (hub->has_indicators)
512 cancel_delayed_work(&hub->leds);
513 if (hub->has_indicators || hub->tt.hub)
514 flush_scheduled_work();
515}
516
517static void hub_activate(struct usb_hub *hub)
518{
519 int status;
520
521 hub->quiescing = 0;
522 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 status = usb_submit_urb(hub->urb, GFP_NOIO);
525 if (status < 0)
526 dev_err(hub->intfdev, "activate --> %d\n", status);
527 if (hub->has_indicators && blinkenlights)
528 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
529
530 /* scan all ports ASAP */
531 kick_khubd(hub);
532}
533
534static int hub_hub_status(struct usb_hub *hub,
535 u16 *status, u16 *change)
536{
537 int ret;
538
Alan Sterndb90e7a2007-02-05 09:56:15 -0500539 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 ret = get_hub_status(hub->hdev, &hub->status->hub);
541 if (ret < 0)
542 dev_err (hub->intfdev,
543 "%s failed (err = %d)\n", __FUNCTION__, ret);
544 else {
545 *status = le16_to_cpu(hub->status->hub.wHubStatus);
546 *change = le16_to_cpu(hub->status->hub.wHubChange);
547 ret = 0;
548 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500549 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return ret;
551}
552
Alan Stern8b28c752005-08-10 17:04:13 -0400553static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
554{
555 struct usb_device *hdev = hub->hdev;
556 int ret;
557
558 if (hdev->children[port1-1] && set_state) {
559 usb_set_device_state(hdev->children[port1-1],
560 USB_STATE_NOTATTACHED);
561 }
562 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
563 if (ret)
564 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
565 port1, ret);
566
567 return ret;
568}
569
Alan Stern7d069b72005-11-18 12:06:34 -0500570
571/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400572static void hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500573{
Alan Stern7de18d82006-06-01 13:37:24 -0400574 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Stern7d069b72005-11-18 12:06:34 -0500575 struct usb_device *hdev = hub->hdev;
576 int port1;
577
578 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
579 if (hdev->children[port1 - 1]) {
580 usb_disconnect(&hdev->children[port1 - 1]);
Alan Stern7de18d82006-06-01 13:37:24 -0400581 if (hub->error == 0)
Alan Stern7d069b72005-11-18 12:06:34 -0500582 hub_port_disable(hub, port1, 0);
583 }
584 }
585 hub_quiesce(hub);
586}
587
588/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400589static void hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500590{
Alan Stern7de18d82006-06-01 13:37:24 -0400591 struct usb_hub *hub = usb_get_intfdata(intf);
592
Alan Stern7d069b72005-11-18 12:06:34 -0500593 hub_activate(hub);
594 hub_power_on(hub);
595}
596
597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598static int hub_configure(struct usb_hub *hub,
599 struct usb_endpoint_descriptor *endpoint)
600{
601 struct usb_device *hdev = hub->hdev;
602 struct device *hub_dev = hub->intfdev;
603 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700604 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 unsigned int pipe;
606 int maxp, ret;
607 char *message;
608
609 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
610 &hub->buffer_dma);
611 if (!hub->buffer) {
612 message = "can't allocate hub irq buffer";
613 ret = -ENOMEM;
614 goto fail;
615 }
616
617 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
618 if (!hub->status) {
619 message = "can't kmalloc hub status buffer";
620 ret = -ENOMEM;
621 goto fail;
622 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500623 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
626 if (!hub->descriptor) {
627 message = "can't kmalloc hub descriptor";
628 ret = -ENOMEM;
629 goto fail;
630 }
631
632 /* Request the entire hub descriptor.
633 * hub->descriptor can handle USB_MAXCHILDREN ports,
634 * but the hub can/will return fewer bytes here.
635 */
636 ret = get_hub_descriptor(hdev, hub->descriptor,
637 sizeof(*hub->descriptor));
638 if (ret < 0) {
639 message = "can't read hub descriptor";
640 goto fail;
641 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
642 message = "hub has too many ports!";
643 ret = -ENODEV;
644 goto fail;
645 }
646
647 hdev->maxchild = hub->descriptor->bNbrPorts;
648 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
649 (hdev->maxchild == 1) ? "" : "s");
650
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700651 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700653 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 int i;
655 char portstr [USB_MAXCHILDREN + 1];
656
657 for (i = 0; i < hdev->maxchild; i++)
658 portstr[i] = hub->descriptor->DeviceRemovable
659 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
660 ? 'F' : 'R';
661 portstr[hdev->maxchild] = 0;
662 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
663 } else
664 dev_dbg(hub_dev, "standalone hub\n");
665
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700666 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 case 0x00:
668 dev_dbg(hub_dev, "ganged power switching\n");
669 break;
670 case 0x01:
671 dev_dbg(hub_dev, "individual port power switching\n");
672 break;
673 case 0x02:
674 case 0x03:
675 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
676 break;
677 }
678
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700679 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 case 0x00:
681 dev_dbg(hub_dev, "global over-current protection\n");
682 break;
683 case 0x08:
684 dev_dbg(hub_dev, "individual port over-current protection\n");
685 break;
686 case 0x10:
687 case 0x18:
688 dev_dbg(hub_dev, "no over-current protection\n");
689 break;
690 }
691
692 spin_lock_init (&hub->tt.lock);
693 INIT_LIST_HEAD (&hub->tt.clear_list);
David Howellsc4028952006-11-22 14:57:56 +0000694 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 switch (hdev->descriptor.bDeviceProtocol) {
696 case 0:
697 break;
698 case 1:
699 dev_dbg(hub_dev, "Single TT\n");
700 hub->tt.hub = hdev;
701 break;
702 case 2:
703 ret = usb_set_interface(hdev, 0, 1);
704 if (ret == 0) {
705 dev_dbg(hub_dev, "TT per port\n");
706 hub->tt.multi = 1;
707 } else
708 dev_err(hub_dev, "Using single TT (err %d)\n",
709 ret);
710 hub->tt.hub = hdev;
711 break;
712 default:
713 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
714 hdev->descriptor.bDeviceProtocol);
715 break;
716 }
717
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700718 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700719 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700720 case HUB_TTTT_8_BITS:
721 if (hdev->descriptor.bDeviceProtocol != 0) {
722 hub->tt.think_time = 666;
723 dev_dbg(hub_dev, "TT requires at most %d "
724 "FS bit times (%d ns)\n",
725 8, hub->tt.think_time);
726 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700728 case HUB_TTTT_16_BITS:
729 hub->tt.think_time = 666 * 2;
730 dev_dbg(hub_dev, "TT requires at most %d "
731 "FS bit times (%d ns)\n",
732 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700734 case HUB_TTTT_24_BITS:
735 hub->tt.think_time = 666 * 3;
736 dev_dbg(hub_dev, "TT requires at most %d "
737 "FS bit times (%d ns)\n",
738 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700740 case HUB_TTTT_32_BITS:
741 hub->tt.think_time = 666 * 4;
742 dev_dbg(hub_dev, "TT requires at most %d "
743 "FS bit times (%d ns)\n",
744 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 break;
746 }
747
748 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700749 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 hub->has_indicators = 1;
751 dev_dbg(hub_dev, "Port indicators are supported\n");
752 }
753
754 dev_dbg(hub_dev, "power on to power good time: %dms\n",
755 hub->descriptor->bPwrOn2PwrGood * 2);
756
757 /* power budgeting mostly matters with bus-powered hubs,
758 * and battery-powered root hubs (may provide just 8 mA).
759 */
760 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500761 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 message = "can't get hub status";
763 goto fail;
764 }
Alan Stern7d35b922005-04-25 11:18:32 -0400765 le16_to_cpus(&hubstatus);
766 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500767 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
768 hub->mA_per_port = 500;
769 else {
770 hub->mA_per_port = hdev->bus_mA;
771 hub->limited_power = 1;
772 }
Alan Stern7d35b922005-04-25 11:18:32 -0400773 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
775 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500776 hub->limited_power = 1;
777 if (hdev->maxchild > 0) {
778 int remaining = hdev->bus_mA -
779 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Alan Stern55c52712005-11-23 12:03:12 -0500781 if (remaining < hdev->maxchild * 100)
782 dev_warn(hub_dev,
783 "insufficient power available "
784 "to use all downstream ports\n");
785 hub->mA_per_port = 100; /* 7.2.1.1 */
786 }
787 } else { /* Self-powered external hub */
788 /* FIXME: What about battery-powered external hubs that
789 * provide less current per port? */
790 hub->mA_per_port = 500;
791 }
792 if (hub->mA_per_port < 500)
793 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
794 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
796 ret = hub_hub_status(hub, &hubstatus, &hubchange);
797 if (ret < 0) {
798 message = "can't get hub status";
799 goto fail;
800 }
801
802 /* local power status reports aren't always correct */
803 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
804 dev_dbg(hub_dev, "local power source is %s\n",
805 (hubstatus & HUB_STATUS_LOCAL_POWER)
806 ? "lost (inactive)" : "good");
807
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700808 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 dev_dbg(hub_dev, "%sover-current condition exists\n",
810 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
811
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700812 /* set up the interrupt endpoint
813 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
814 * bytes as USB2.0[11.12.3] says because some hubs are known
815 * to send more data (and thus cause overflow). For root hubs,
816 * maxpktsize is defined in hcd.c's fake endpoint descriptors
817 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
819 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
820
821 if (maxp > sizeof(*hub->buffer))
822 maxp = sizeof(*hub->buffer);
823
824 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
825 if (!hub->urb) {
826 message = "couldn't allocate interrupt urb";
827 ret = -ENOMEM;
828 goto fail;
829 }
830
831 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
832 hub, endpoint->bInterval);
833 hub->urb->transfer_dma = hub->buffer_dma;
834 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
835
836 /* maybe cycle the hub leds */
837 if (hub->has_indicators && blinkenlights)
838 hub->indicator [0] = INDICATOR_CYCLE;
839
840 hub_power_on(hub);
841 hub_activate(hub);
842 return 0;
843
844fail:
845 dev_err (hub_dev, "config failed, %s (err %d)\n",
846 message, ret);
847 /* hub_disconnect() frees urb and descriptor */
848 return ret;
849}
850
851static unsigned highspeed_hubs;
852
853static void hub_disconnect(struct usb_interface *intf)
854{
855 struct usb_hub *hub = usb_get_intfdata (intf);
856 struct usb_device *hdev;
857
Alan Stern7de18d82006-06-01 13:37:24 -0400858 /* Disconnect all children and quiesce the hub */
859 hub->error = 0;
860 hub_pre_reset(intf);
861
Alan Stern8b28c752005-08-10 17:04:13 -0400862 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 hdev = hub->hdev;
864
865 if (hdev->speed == USB_SPEED_HIGH)
866 highspeed_hubs--;
867
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 usb_free_urb(hub->urb);
869 hub->urb = NULL;
870
871 spin_lock_irq(&hub_event_lock);
872 list_del_init(&hub->event_list);
873 spin_unlock_irq(&hub_event_lock);
874
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700875 kfree(hub->descriptor);
876 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700878 kfree(hub->status);
879 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
881 if (hub->buffer) {
882 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
883 hub->buffer_dma);
884 hub->buffer = NULL;
885 }
886
Alan Stern7d069b72005-11-18 12:06:34 -0500887 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
890static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
891{
892 struct usb_host_interface *desc;
893 struct usb_endpoint_descriptor *endpoint;
894 struct usb_device *hdev;
895 struct usb_hub *hub;
896
897 desc = intf->cur_altsetting;
898 hdev = interface_to_usbdev(intf);
899
David Brownell89ccbdc2006-04-02 10:18:09 -0800900#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
901 if (hdev->parent) {
902 dev_warn(&intf->dev, "ignoring external hub\n");
903 return -ENODEV;
904 }
905#endif
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 /* Some hubs have a subclass of 1, which AFAICT according to the */
908 /* specs is not defined, but it works */
909 if ((desc->desc.bInterfaceSubClass != 0) &&
910 (desc->desc.bInterfaceSubClass != 1)) {
911descriptor_error:
912 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
913 return -EIO;
914 }
915
916 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
917 if (desc->desc.bNumEndpoints != 1)
918 goto descriptor_error;
919
920 endpoint = &desc->endpoint[0].desc;
921
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700922 /* If it's not an interrupt in endpoint, we'd better punt! */
923 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 goto descriptor_error;
925
926 /* We found a hub */
927 dev_info (&intf->dev, "USB hub found\n");
928
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400929 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 if (!hub) {
931 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
932 return -ENOMEM;
933 }
934
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 INIT_LIST_HEAD(&hub->event_list);
936 hub->intfdev = &intf->dev;
937 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +0000938 INIT_DELAYED_WORK(&hub->leds, led_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
940 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -0500941 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
943 if (hdev->speed == USB_SPEED_HIGH)
944 highspeed_hubs++;
945
946 if (hub_configure(hub, endpoint) >= 0)
947 return 0;
948
949 hub_disconnect (intf);
950 return -ENODEV;
951}
952
953static int
954hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
955{
956 struct usb_device *hdev = interface_to_usbdev (intf);
957
958 /* assert ifno == 0 (part of hub spec) */
959 switch (code) {
960 case USBDEVFS_HUB_PORTINFO: {
961 struct usbdevfs_hub_portinfo *info = user_data;
962 int i;
963
964 spin_lock_irq(&device_state_lock);
965 if (hdev->devnum <= 0)
966 info->nports = 0;
967 else {
968 info->nports = hdev->maxchild;
969 for (i = 0; i < info->nports; i++) {
970 if (hdev->children[i] == NULL)
971 info->port[i] = 0;
972 else
973 info->port[i] =
974 hdev->children[i]->devnum;
975 }
976 }
977 spin_unlock_irq(&device_state_lock);
978
979 return info->nports + 1;
980 }
981
982 default:
983 return -ENOSYS;
984 }
985}
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
988/* grab device/port lock, returning index of that port (zero based).
989 * protects the upstream link used by this device from concurrent
990 * tree operations like suspend, resume, reset, and disconnect, which
991 * apply to everything downstream of a given port.
992 */
993static int locktree(struct usb_device *udev)
994{
995 int t;
996 struct usb_device *hdev;
997
998 if (!udev)
999 return -ENODEV;
1000
1001 /* root hub is always the first lock in the series */
1002 hdev = udev->parent;
1003 if (!hdev) {
1004 usb_lock_device(udev);
1005 return 0;
1006 }
1007
1008 /* on the path from root to us, lock everything from
1009 * top down, dropping parent locks when not needed
1010 */
1011 t = locktree(hdev);
1012 if (t < 0)
1013 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Alan Stern12c3da32005-11-23 12:09:52 -05001015 /* everything is fail-fast once disconnect
1016 * processing starts
1017 */
1018 if (udev->state == USB_STATE_NOTATTACHED) {
1019 usb_unlock_device(hdev);
1020 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 }
Alan Stern12c3da32005-11-23 12:09:52 -05001022
1023 /* when everyone grabs locks top->bottom,
1024 * non-overlapping work may be concurrent
1025 */
1026 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -05001028 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029}
1030
1031static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1032{
1033 int i;
1034
1035 for (i = 0; i < udev->maxchild; ++i) {
1036 if (udev->children[i])
1037 recursively_mark_NOTATTACHED(udev->children[i]);
1038 }
Alan Sternee49fb52006-11-22 16:55:54 -05001039 if (udev->state == USB_STATE_SUSPENDED)
1040 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 udev->state = USB_STATE_NOTATTACHED;
1042}
1043
1044/**
1045 * usb_set_device_state - change a device's current state (usbcore, hcds)
1046 * @udev: pointer to device whose state should be changed
1047 * @new_state: new state value to be stored
1048 *
1049 * udev->state is _not_ fully protected by the device lock. Although
1050 * most transitions are made only while holding the lock, the state can
1051 * can change to USB_STATE_NOTATTACHED at almost any time. This
1052 * is so that devices can be marked as disconnected as soon as possible,
1053 * without having to wait for any semaphores to be released. As a result,
1054 * all changes to any device's state must be protected by the
1055 * device_state_lock spinlock.
1056 *
1057 * Once a device has been added to the device tree, all changes to its state
1058 * should be made using this routine. The state should _not_ be set directly.
1059 *
1060 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1061 * Otherwise udev->state is set to new_state, and if new_state is
1062 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1063 * to USB_STATE_NOTATTACHED.
1064 */
1065void usb_set_device_state(struct usb_device *udev,
1066 enum usb_device_state new_state)
1067{
1068 unsigned long flags;
1069
1070 spin_lock_irqsave(&device_state_lock, flags);
1071 if (udev->state == USB_STATE_NOTATTACHED)
1072 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001073 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001074
1075 /* root hub wakeup capabilities are managed out-of-band
1076 * and may involve silicon errata ... ignore them here.
1077 */
1078 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001079 if (udev->state == USB_STATE_SUSPENDED
1080 || new_state == USB_STATE_SUSPENDED)
1081 ; /* No change to wakeup settings */
1082 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001083 device_init_wakeup(&udev->dev,
1084 (udev->actconfig->desc.bmAttributes
1085 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001086 else
David Brownellfb669cc2006-01-24 08:40:27 -08001087 device_init_wakeup(&udev->dev, 0);
1088 }
Alan Stern645daaa2006-08-30 15:47:02 -04001089 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001090 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 recursively_mark_NOTATTACHED(udev);
1092 spin_unlock_irqrestore(&device_state_lock, flags);
1093}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
1095
Alan Sternd388dab2006-07-01 22:14:24 -04001096#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001097
1098/**
1099 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1100 * @rhdev: struct usb_device for the root hub
1101 *
1102 * The USB host controller driver calls this function when its root hub
1103 * is resumed and Vbus power has been interrupted or the controller
1104 * has been reset. The routine marks all the children of the root hub
1105 * as NOTATTACHED and marks logical connect-change events on their ports.
1106 */
1107void usb_root_hub_lost_power(struct usb_device *rhdev)
1108{
1109 struct usb_hub *hub;
1110 int port1;
1111 unsigned long flags;
1112
1113 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
Alan Stern353a4092006-09-19 10:07:58 -04001114
1115 /* Make sure no potential wakeup events get lost,
1116 * by forcing the root hub to be resumed.
1117 */
1118 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1119
Alan Stern1c50c312005-11-14 11:45:38 -05001120 spin_lock_irqsave(&device_state_lock, flags);
1121 hub = hdev_to_hub(rhdev);
1122 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1123 if (rhdev->children[port1 - 1]) {
1124 recursively_mark_NOTATTACHED(
1125 rhdev->children[port1 - 1]);
1126 set_bit(port1, hub->change_bits);
1127 }
1128 }
1129 spin_unlock_irqrestore(&device_state_lock, flags);
1130}
1131EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1132
Alan Sternd388dab2006-07-01 22:14:24 -04001133#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001134
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135static void choose_address(struct usb_device *udev)
1136{
1137 int devnum;
1138 struct usb_bus *bus = udev->bus;
1139
1140 /* If khubd ever becomes multithreaded, this will need a lock */
1141
1142 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1143 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1144 bus->devnum_next);
1145 if (devnum >= 128)
1146 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1147
1148 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1149
1150 if (devnum < 128) {
1151 set_bit(devnum, bus->devmap.devicemap);
1152 udev->devnum = devnum;
1153 }
1154}
1155
1156static void release_address(struct usb_device *udev)
1157{
1158 if (udev->devnum > 0) {
1159 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1160 udev->devnum = -1;
1161 }
1162}
1163
1164/**
1165 * usb_disconnect - disconnect a device (usbcore-internal)
1166 * @pdev: pointer to device being disconnected
1167 * Context: !in_interrupt ()
1168 *
1169 * Something got disconnected. Get rid of it and all of its children.
1170 *
1171 * If *pdev is a normal device then the parent hub must already be locked.
1172 * If *pdev is a root hub then this routine will acquire the
1173 * usb_bus_list_lock on behalf of the caller.
1174 *
1175 * Only hub drivers (including virtual root hub drivers for host
1176 * controllers) should ever call this.
1177 *
1178 * This call is synchronous, and may not be used in an interrupt context.
1179 */
1180void usb_disconnect(struct usb_device **pdev)
1181{
1182 struct usb_device *udev = *pdev;
1183 int i;
1184
1185 if (!udev) {
1186 pr_debug ("%s nodev\n", __FUNCTION__);
1187 return;
1188 }
1189
1190 /* mark the device as inactive, so any further urb submissions for
1191 * this device (and any of its children) will fail immediately.
1192 * this quiesces everyting except pending urbs.
1193 */
1194 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1196
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001197 usb_lock_device(udev);
1198
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 /* Free up all the children before we remove this device */
1200 for (i = 0; i < USB_MAXCHILDREN; i++) {
1201 if (udev->children[i])
1202 usb_disconnect(&udev->children[i]);
1203 }
1204
1205 /* deallocate hcd/hardware state ... nuking all pending urbs and
1206 * cleaning up all state associated with the current configuration
1207 * so that the hardware is now fully quiesced.
1208 */
Alan Stern782da722006-07-01 22:09:35 -04001209 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 usb_disable_device(udev, 0);
1211
Alan Stern782da722006-07-01 22:09:35 -04001212 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001213
Alan Stern782da722006-07-01 22:09:35 -04001214 /* Unregister the device. The device driver is responsible
1215 * for removing the device files from usbfs and sysfs and for
1216 * de-configuring the device.
1217 */
1218 device_del(&udev->dev);
1219
1220 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 * (or root_hub) pointer.
1222 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225 /* Avoid races with recursively_mark_NOTATTACHED() */
1226 spin_lock_irq(&device_state_lock);
1227 *pdev = NULL;
1228 spin_unlock_irq(&device_state_lock);
1229
Alan Sternee49fb52006-11-22 16:55:54 -05001230 /* Decrement the parent's count of unsuspended children */
1231 if (udev->parent) {
1232 usb_pm_lock(udev);
1233 if (!udev->discon_suspended)
Alan Stern94fcda12006-11-20 11:38:46 -05001234 usb_autosuspend_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001235 usb_pm_unlock(udev);
1236 }
1237
Alan Stern782da722006-07-01 22:09:35 -04001238 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239}
1240
1241#ifdef DEBUG
1242static void show_string(struct usb_device *udev, char *id, char *string)
1243{
1244 if (!string)
1245 return;
1246 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1247}
1248
1249#else
1250static inline void show_string(struct usb_device *udev, char *id, char *string)
1251{}
1252#endif
1253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
1255#ifdef CONFIG_USB_OTG
1256#include "otg_whitelist.h"
David Brownell11bd44a2006-11-01 14:26:26 -08001257static int __usb_port_suspend(struct usb_device *, int port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258#endif
1259
Oliver Neukum3ede7602007-01-11 14:35:50 +01001260/**
1261 * usb_new_device - perform initial device setup (usbcore-internal)
1262 * @udev: newly addressed device (in ADDRESS state)
1263 *
1264 * This is called with devices which have been enumerated, but not yet
1265 * configured. The device descriptor is available, but not descriptors
1266 * for any device configuration. The caller must have locked either
1267 * the parent hub (if udev is a normal device) or else the
1268 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1269 * udev has already been installed, but udev is not yet visible through
1270 * sysfs or other filesystem code.
1271 *
1272 * It will return if the device is configured properly or not. Zero if
1273 * the interface was registered with the driver core; else a negative
1274 * errno value.
1275 *
1276 * This call is synchronous, and may not be used in an interrupt context.
1277 *
1278 * Only the hub driver or root-hub registrar should ever call this.
1279 */
1280int usb_new_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281{
1282 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001284 /* Lock ourself into memory in order to keep a probe sequence
1285 * sleeping in a new thread from allowing us to be unloaded.
1286 */
1287 if (!try_module_get(THIS_MODULE))
1288 return -EINVAL;
1289
Oliver Neukum7ceec1f2007-01-26 14:26:21 +01001290 /* Determine quirks */
1291 usb_detect_quirks(udev);
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 err = usb_get_configuration(udev);
1294 if (err < 0) {
1295 dev_err(&udev->dev, "can't read configurations, error %d\n",
1296 err);
1297 goto fail;
1298 }
1299
1300 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001301 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1302 udev->manufacturer = usb_cache_string(udev,
1303 udev->descriptor.iManufacturer);
1304 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305
1306 /* Tell the world! */
1307 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1308 "SerialNumber=%d\n",
1309 udev->descriptor.iManufacturer,
1310 udev->descriptor.iProduct,
1311 udev->descriptor.iSerialNumber);
1312 show_string(udev, "Product", udev->product);
1313 show_string(udev, "Manufacturer", udev->manufacturer);
1314 show_string(udev, "SerialNumber", udev->serial);
1315
1316#ifdef CONFIG_USB_OTG
1317 /*
1318 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1319 * to wake us after we've powered off VBUS; and HNP, switching roles
1320 * "host" to "peripheral". The OTG descriptor helps figure this out.
1321 */
1322 if (!udev->bus->is_b_host
1323 && udev->config
1324 && udev->parent == udev->bus->root_hub) {
1325 struct usb_otg_descriptor *desc = 0;
1326 struct usb_bus *bus = udev->bus;
1327
1328 /* descriptor may appear anywhere in config */
1329 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1330 le16_to_cpu(udev->config[0].desc.wTotalLength),
1331 USB_DT_OTG, (void **) &desc) == 0) {
1332 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001333 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 dev_info(&udev->dev,
1336 "Dual-Role OTG device on %sHNP port\n",
1337 (port1 == bus->otg_port)
1338 ? "" : "non-");
1339
1340 /* enable HNP before suspend, it's simpler */
1341 if (port1 == bus->otg_port)
1342 bus->b_hnp_enable = 1;
1343 err = usb_control_msg(udev,
1344 usb_sndctrlpipe(udev, 0),
1345 USB_REQ_SET_FEATURE, 0,
1346 bus->b_hnp_enable
1347 ? USB_DEVICE_B_HNP_ENABLE
1348 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1349 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1350 if (err < 0) {
1351 /* OTG MESSAGE: report errors here,
1352 * customize to match your product.
1353 */
1354 dev_info(&udev->dev,
1355 "can't set HNP mode; %d\n",
1356 err);
1357 bus->b_hnp_enable = 0;
1358 }
1359 }
1360 }
1361 }
1362
1363 if (!is_targeted(udev)) {
1364
1365 /* Maybe it can talk to us, though we can't talk to it.
1366 * (Includes HNP test device.)
1367 */
1368 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern140d8f62006-07-01 22:07:21 -04001369 err = __usb_port_suspend(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 if (err < 0)
1371 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1372 }
1373 err = -ENODEV;
1374 goto fail;
1375 }
1376#endif
1377
Alan Stern782da722006-07-01 22:09:35 -04001378 /* Register the device. The device driver is responsible
1379 * for adding the device files to usbfs and sysfs and for
1380 * configuring the device.
1381 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 err = device_add (&udev->dev);
1383 if (err) {
1384 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1385 goto fail;
1386 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001387
Alan Sternee49fb52006-11-22 16:55:54 -05001388 /* Increment the parent's count of unsuspended children */
1389 if (udev->parent)
Alan Stern94fcda12006-11-20 11:38:46 -05001390 usb_autoresume_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001391
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001392exit:
1393 module_put(THIS_MODULE);
1394 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
1396fail:
1397 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001398 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399}
1400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401static int hub_port_status(struct usb_hub *hub, int port1,
1402 u16 *status, u16 *change)
1403{
1404 int ret;
1405
Alan Sterndb90e7a2007-02-05 09:56:15 -05001406 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001408 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 dev_err (hub->intfdev,
1410 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001411 if (ret >= 0)
1412 ret = -EIO;
1413 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 *status = le16_to_cpu(hub->status->port.wPortStatus);
1415 *change = le16_to_cpu(hub->status->port.wPortChange);
1416 ret = 0;
1417 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001418 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 return ret;
1420}
1421
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001422
1423/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1424static unsigned hub_is_wusb(struct usb_hub *hub)
1425{
1426 struct usb_hcd *hcd;
1427 if (hub->hdev->parent != NULL) /* not a root hub? */
1428 return 0;
1429 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1430 return hcd->wireless;
1431}
1432
1433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434#define PORT_RESET_TRIES 5
1435#define SET_ADDRESS_TRIES 2
1436#define GET_DESCRIPTOR_TRIES 2
1437#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1438#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1439
1440#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1441#define HUB_SHORT_RESET_TIME 10
1442#define HUB_LONG_RESET_TIME 200
1443#define HUB_RESET_TIMEOUT 500
1444
1445static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1446 struct usb_device *udev, unsigned int delay)
1447{
1448 int delay_time, ret;
1449 u16 portstatus;
1450 u16 portchange;
1451
1452 for (delay_time = 0;
1453 delay_time < HUB_RESET_TIMEOUT;
1454 delay_time += delay) {
1455 /* wait to give the device a chance to reset */
1456 msleep(delay);
1457
1458 /* read and decode port status */
1459 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1460 if (ret < 0)
1461 return ret;
1462
1463 /* Device went away? */
1464 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1465 return -ENOTCONN;
1466
1467 /* bomb out completely if something weird happened */
1468 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1469 return -EINVAL;
1470
1471 /* if we`ve finished resetting, then break out of the loop */
1472 if (!(portstatus & USB_PORT_STAT_RESET) &&
1473 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001474 if (hub_is_wusb(hub))
1475 udev->speed = USB_SPEED_VARIABLE;
1476 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 udev->speed = USB_SPEED_HIGH;
1478 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1479 udev->speed = USB_SPEED_LOW;
1480 else
1481 udev->speed = USB_SPEED_FULL;
1482 return 0;
1483 }
1484
1485 /* switch to the long delay after two short delay failures */
1486 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1487 delay = HUB_LONG_RESET_TIME;
1488
1489 dev_dbg (hub->intfdev,
1490 "port %d not reset yet, waiting %dms\n",
1491 port1, delay);
1492 }
1493
1494 return -EBUSY;
1495}
1496
1497static int hub_port_reset(struct usb_hub *hub, int port1,
1498 struct usb_device *udev, unsigned int delay)
1499{
1500 int i, status;
1501
1502 /* Reset the port */
1503 for (i = 0; i < PORT_RESET_TRIES; i++) {
1504 status = set_port_feature(hub->hdev,
1505 port1, USB_PORT_FEAT_RESET);
1506 if (status)
1507 dev_err(hub->intfdev,
1508 "cannot reset port %d (err = %d)\n",
1509 port1, status);
1510 else {
1511 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001512 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 dev_dbg(hub->intfdev,
1514 "port_wait_reset: err = %d\n",
1515 status);
1516 }
1517
1518 /* return on disconnect or reset */
1519 switch (status) {
1520 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001521 /* TRSTRCY = 10 ms; plus some extra */
1522 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 /* FALL THROUGH */
1524 case -ENOTCONN:
1525 case -ENODEV:
1526 clear_port_feature(hub->hdev,
1527 port1, USB_PORT_FEAT_C_RESET);
1528 /* FIXME need disconnect() for NOTATTACHED device */
1529 usb_set_device_state(udev, status
1530 ? USB_STATE_NOTATTACHED
1531 : USB_STATE_DEFAULT);
1532 return status;
1533 }
1534
1535 dev_dbg (hub->intfdev,
1536 "port %d not enabled, trying reset again...\n",
1537 port1);
1538 delay = HUB_LONG_RESET_TIME;
1539 }
1540
1541 dev_err (hub->intfdev,
1542 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1543 port1);
1544
1545 return status;
1546}
1547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548/*
1549 * Disable a port and mark a logical connnect-change event, so that some
1550 * time later khubd will disconnect() any existing usb_device on the port
1551 * and will re-enumerate if there actually is a device attached.
1552 */
1553static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1554{
1555 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1556 hub_port_disable(hub, port1, 1);
1557
1558 /* FIXME let caller ask to power down the port:
1559 * - some devices won't enumerate without a VBUS power cycle
1560 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001561 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 * That's easy if this hub can switch power per-port, and
1563 * khubd reactivates the port later (timer, SRP, etc).
1564 * Powerdown must be optional, because of reset/DFU.
1565 */
1566
1567 set_bit(port1, hub->change_bits);
1568 kick_khubd(hub);
1569}
1570
Alan Sternd388dab2006-07-01 22:14:24 -04001571#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
1573#ifdef CONFIG_USB_SUSPEND
1574
1575/*
1576 * Selective port suspend reduces power; most suspended devices draw
1577 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1578 * All devices below the suspended port are also suspended.
1579 *
1580 * Devices leave suspend state when the host wakes them up. Some devices
1581 * also support "remote wakeup", where the device can activate the USB
1582 * tree above them to deliver data, such as a keypress or packet. In
1583 * some cases, this wakes the USB host.
1584 */
1585static int hub_port_suspend(struct usb_hub *hub, int port1,
1586 struct usb_device *udev)
1587{
1588 int status;
1589
1590 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1591
1592 /* enable remote wakeup when appropriate; this lets the device
1593 * wake up the upstream hub (including maybe the root hub).
1594 *
1595 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1596 * we don't explicitly enable it here.
1597 */
Alan Stern645daaa2006-08-30 15:47:02 -04001598 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1600 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1601 USB_DEVICE_REMOTE_WAKEUP, 0,
1602 NULL, 0,
1603 USB_CTRL_SET_TIMEOUT);
1604 if (status)
1605 dev_dbg(&udev->dev,
1606 "won't remote wakeup, status %d\n",
1607 status);
1608 }
1609
1610 /* see 7.1.7.6 */
1611 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1612 if (status) {
1613 dev_dbg(hub->intfdev,
1614 "can't suspend port %d, status %d\n",
1615 port1, status);
1616 /* paranoia: "should not happen" */
1617 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1618 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1619 USB_DEVICE_REMOTE_WAKEUP, 0,
1620 NULL, 0,
1621 USB_CTRL_SET_TIMEOUT);
1622 } else {
1623 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001624 dev_dbg(&udev->dev, "usb %ssuspend\n",
1625 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1627 msleep(10);
1628 }
1629 return status;
1630}
1631
1632/*
1633 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001634 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 * State transitions include:
1636 *
1637 * - suspend, resume ... when the VBUS power link stays live
1638 * - suspend, disconnect ... VBUS lost
1639 *
1640 * Once VBUS drop breaks the circuit, the port it's using has to go through
1641 * normal re-enumeration procedures, starting with enabling VBUS power.
1642 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1643 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1644 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001645 *
1646 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1647 * the root hub for their bus goes into global suspend ... so we don't
1648 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 */
Alan Stern140d8f62006-07-01 22:07:21 -04001650static int __usb_port_suspend (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651{
David Brownellf3f32532005-09-22 22:37:29 -07001652 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
1654 /* caller owns the udev device lock */
1655 if (port1 < 0)
1656 return port1;
1657
Alan Stern140d8f62006-07-01 22:07:21 -04001658 /* we change the device's upstream USB link,
1659 * but root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 */
David Brownellf3f32532005-09-22 22:37:29 -07001661 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1663 udev);
Alan Stern2bf40862006-07-01 22:12:19 -04001664 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001665 dev_dbg(&udev->dev, "usb %ssuspend\n",
1666 udev->auto_pm ? "auto-" : "");
Alan Stern2bf40862006-07-01 22:12:19 -04001667 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 return status;
1670}
1671
David Brownell5edbfb72005-09-22 22:45:26 -07001672/*
Alan Stern140d8f62006-07-01 22:07:21 -04001673 * usb_port_suspend - suspend a usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001675 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 *
1677 * Suspends a USB device that isn't in active use, conserving power.
1678 * Devices may wake out of a suspend, if anything important happens,
1679 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001680 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 * to disconnect devices while they are suspended.
1682 *
David Brownell390a8c32005-09-13 19:57:27 -07001683 * This only affects the USB hardware for a device; its interfaces
1684 * (and, for hubs, child devices) must already have been suspended.
1685 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 * Suspending OTG devices may trigger HNP, if that's been enabled
1687 * between a pair of dual-role devices. That will change roles, such
1688 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1689 *
1690 * Returns 0 on success, else negative errno.
1691 */
Alan Stern140d8f62006-07-01 22:07:21 -04001692int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693{
Alan Stern140d8f62006-07-01 22:07:21 -04001694 return __usb_port_suspend(udev, udev->portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695}
David Brownellf3f32532005-09-22 22:37:29 -07001696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697/*
David Brownell390a8c32005-09-13 19:57:27 -07001698 * If the USB "suspend" state is in use (rather than "global suspend"),
1699 * many devices will be individually taken out of suspend state using
1700 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 * hardware resume signaling is finished, either because of selective
1702 * resume (by host) or remote wakeup (by device) ... now see what changed
1703 * in the tree that's rooted at this device.
1704 */
Alan Stern140d8f62006-07-01 22:07:21 -04001705static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706{
1707 int status;
1708 u16 devstatus;
1709
1710 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001711 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
1713 /* usb ch9 identifies four variants of SUSPENDED, based on what
1714 * state the device resumes to. Linux currently won't see the
1715 * first two on the host side; they'd be inside hub_port_init()
1716 * during many timeouts, but khubd can't suspend until later.
1717 */
1718 usb_set_device_state(udev, udev->actconfig
1719 ? USB_STATE_CONFIGURED
1720 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
1722 /* 10.5.4.5 says be sure devices in the tree are still there.
1723 * For now let's assume the device didn't go crazy on resume,
1724 * and device drivers will know about any resume quirks.
1725 */
1726 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001727 if (status >= 0)
1728 status = (status == 2 ? 0 : -ENODEV);
1729
1730 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 dev_dbg(&udev->dev,
1732 "gone after usb resume? status %d\n",
1733 status);
1734 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001736 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001737 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 status = usb_control_msg(udev,
1739 usb_sndctrlpipe(udev, 0),
1740 USB_REQ_CLEAR_FEATURE,
1741 USB_RECIP_DEVICE,
1742 USB_DEVICE_REMOTE_WAKEUP, 0,
1743 NULL, 0,
1744 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001745 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 dev_dbg(&udev->dev, "disable remote "
1747 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 status = 0;
1750
1751 } else if (udev->devnum <= 0) {
1752 dev_dbg(&udev->dev, "bogus resume!\n");
1753 status = -EINVAL;
1754 }
1755 return status;
1756}
1757
1758static int
1759hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1760{
1761 int status;
Alan Sternd25450c2006-11-20 11:14:30 -05001762 u16 portchange, portstatus;
1763
1764 /* Skip the initial Clear-Suspend step for a remote wakeup */
1765 status = hub_port_status(hub, port1, &portstatus, &portchange);
1766 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1767 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
1769 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1770
Alan Sternd5cbad42006-08-11 16:52:39 -04001771 set_bit(port1, hub->busy_bits);
1772
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 /* see 7.1.7.7; affects power usage, but not budgeting */
1774 status = clear_port_feature(hub->hdev,
1775 port1, USB_PORT_FEAT_SUSPEND);
1776 if (status) {
1777 dev_dbg(hub->intfdev,
1778 "can't resume port %d, status %d\n",
1779 port1, status);
1780 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 /* drive resume for at least 20 msec */
1782 if (udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001783 dev_dbg(&udev->dev, "usb %sresume\n",
1784 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 msleep(25);
1786
1787#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1788 | USB_PORT_STAT_ENABLE \
1789 | USB_PORT_STAT_CONNECTION)
1790
1791 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1792 * stop resume signaling. Then finish the resume
1793 * sequence.
1794 */
Alan Sternd25450c2006-11-20 11:14:30 -05001795 status = hub_port_status(hub, port1, &portstatus, &portchange);
1796SuspendCleared:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 if (status < 0
Alan Sternd25450c2006-11-20 11:14:30 -05001798 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1799 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 ) {
1801 dev_dbg(hub->intfdev,
1802 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001803 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001804 if (status >= 0)
1805 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 } else {
Alan Stern20307942006-06-28 11:20:41 -04001807 if (portchange & USB_PORT_STAT_C_SUSPEND)
1808 clear_port_feature(hub->hdev, port1,
1809 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 /* TRSMRCY = 10 msec */
1811 msleep(10);
1812 if (udev)
Alan Stern140d8f62006-07-01 22:07:21 -04001813 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 }
1815 }
1816 if (status < 0)
1817 hub_port_logical_disconnect(hub, port1);
1818
Alan Sternd5cbad42006-08-11 16:52:39 -04001819 clear_bit(port1, hub->busy_bits);
1820 if (!hub->hdev->parent && !hub->busy_bits[0])
1821 usb_enable_root_hub_irq(hub->hdev->bus);
1822
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 return status;
1824}
1825
David Brownell5edbfb72005-09-22 22:45:26 -07001826/*
Alan Stern140d8f62006-07-01 22:07:21 -04001827 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001829 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 *
1831 * This will re-activate the suspended device, increasing power usage
1832 * while letting drivers communicate again with its endpoints.
1833 * USB resume explicitly guarantees that the power session between
1834 * the host and the device is the same as it was when the device
1835 * suspended.
1836 *
1837 * Returns 0 on success, else negative errno.
1838 */
Alan Stern140d8f62006-07-01 22:07:21 -04001839int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840{
Alan Sternd388dab2006-07-01 22:14:24 -04001841 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
Alan Stern140d8f62006-07-01 22:07:21 -04001843 /* we change the device's upstream USB link,
1844 * but root hubs have no upstream USB link.
1845 */
David Brownellf3f32532005-09-22 22:37:29 -07001846 if (udev->parent) {
Alan Stern114b3682006-07-01 22:13:04 -04001847 // NOTE this fails if parent is also suspended...
1848 status = hub_port_resume(hdev_to_hub(udev->parent),
1849 udev->portnum, udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001850 } else {
1851 dev_dbg(&udev->dev, "usb %sresume\n",
1852 udev->auto_pm ? "auto-" : "");
Alan Stern140d8f62006-07-01 22:07:21 -04001853 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001854 }
David Brownellf3f32532005-09-22 22:37:29 -07001855 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001856 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 return status;
1858}
1859
1860static int remote_wakeup(struct usb_device *udev)
1861{
1862 int status = 0;
1863
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001864 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001866 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern94fcda12006-11-20 11:38:46 -05001867 status = usb_autoresume_device(udev);
Alan Sterna8e7c562006-07-01 22:11:02 -04001868
Alan Sternd25450c2006-11-20 11:14:30 -05001869 /* Give the interface drivers a chance to do something,
1870 * then autosuspend the device again. */
1871 if (status == 0)
Alan Stern94fcda12006-11-20 11:38:46 -05001872 usb_autosuspend_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001873 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001874 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 return status;
1876}
1877
Alan Sternd388dab2006-07-01 22:14:24 -04001878#else /* CONFIG_USB_SUSPEND */
1879
1880/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1881
1882int usb_port_suspend(struct usb_device *udev)
1883{
1884 return 0;
1885}
1886
1887static inline int
1888finish_port_resume(struct usb_device *udev)
1889{
1890 return 0;
1891}
1892
1893static inline int
1894hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1895{
1896 return 0;
1897}
1898
1899int usb_port_resume(struct usb_device *udev)
1900{
1901 return 0;
1902}
1903
1904static inline int remote_wakeup(struct usb_device *udev)
1905{
1906 return 0;
1907}
1908
1909#endif
1910
David Brownelldb690872005-09-13 19:56:33 -07001911static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912{
1913 struct usb_hub *hub = usb_get_intfdata (intf);
1914 struct usb_device *hdev = hub->hdev;
1915 unsigned port1;
Alan Stern12f1ff82007-02-01 16:08:41 -05001916 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
David Brownellc9f89fa2005-09-13 19:57:04 -07001918 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1920 struct usb_device *udev;
1921
1922 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001923 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001924#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001925 udev->state != USB_STATE_SUSPENDED
1926#else
1927 udev->dev.power.power_state.event
1928 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001929#endif
Alan Stern114b3682006-07-01 22:13:04 -04001930 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001931 if (!hdev->auto_pm)
1932 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1933 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001934 return -EBUSY;
1935 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 }
1937
Alan Stern40f122f2006-11-09 14:44:33 -05001938 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1939
David Brownellc9f89fa2005-09-13 19:57:04 -07001940 /* stop khubd and related activity */
1941 hub_quiesce(hub);
Alan Stern12f1ff82007-02-01 16:08:41 -05001942
1943 /* "global suspend" of the downstream HC-to-USB interface */
1944 if (!hdev->parent) {
1945 status = hcd_bus_suspend(hdev->bus);
1946 if (status != 0) {
1947 dev_dbg(&hdev->dev, "'global' suspend %d\n", status);
1948 hub_activate(hub);
1949 }
1950 }
1951 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952}
1953
1954static int hub_resume(struct usb_interface *intf)
1955{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Stern40f122f2006-11-09 14:44:33 -05001957 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 int status;
1959
Alan Stern40f122f2006-11-09 14:44:33 -05001960 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1961
David Brownellf3f32532005-09-22 22:37:29 -07001962 /* "global resume" of the downstream HC-to-USB interface */
1963 if (!hdev->parent) {
1964 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001965 if (bus) {
1966 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001967 if (status) {
1968 dev_dbg(&intf->dev, "'global' resume %d\n",
1969 status);
1970 return status;
1971 }
1972 } else
1973 return -EOPNOTSUPP;
1974 if (status == 0) {
1975 /* TRSMRCY = 10 msec */
1976 msleep(10);
1977 }
1978 }
1979
Alan Sterna8e7c562006-07-01 22:11:02 -04001980 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001981 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 return 0;
1983}
1984
Alan Sternd388dab2006-07-01 22:14:24 -04001985#else /* CONFIG_PM */
1986
1987static inline int remote_wakeup(struct usb_device *udev)
1988{
1989 return 0;
1990}
1991
Andrew Morton511366d2006-08-14 23:11:02 -07001992#define hub_suspend NULL
1993#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04001994#endif
1995
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996void usb_resume_root_hub(struct usb_device *hdev)
1997{
1998 struct usb_hub *hub = hdev_to_hub(hdev);
1999
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 kick_khubd(hub);
2001}
2002
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003
2004/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2005 *
2006 * Between connect detection and reset signaling there must be a delay
2007 * of 100ms at least for debounce and power-settling. The corresponding
2008 * timer shall restart whenever the downstream port detects a disconnect.
2009 *
2010 * Apparently there are some bluetooth and irda-dongles and a number of
2011 * low-speed devices for which this debounce period may last over a second.
2012 * Not covered by the spec - but easy to deal with.
2013 *
2014 * This implementation uses a 1500ms total debounce timeout; if the
2015 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2016 * every 25ms for transient disconnects. When the port status has been
2017 * unchanged for 100ms it returns the port status.
2018 */
2019
2020#define HUB_DEBOUNCE_TIMEOUT 1500
2021#define HUB_DEBOUNCE_STEP 25
2022#define HUB_DEBOUNCE_STABLE 100
2023
2024static int hub_port_debounce(struct usb_hub *hub, int port1)
2025{
2026 int ret;
2027 int total_time, stable_time = 0;
2028 u16 portchange, portstatus;
2029 unsigned connection = 0xffff;
2030
2031 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2032 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2033 if (ret < 0)
2034 return ret;
2035
2036 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2037 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2038 stable_time += HUB_DEBOUNCE_STEP;
2039 if (stable_time >= HUB_DEBOUNCE_STABLE)
2040 break;
2041 } else {
2042 stable_time = 0;
2043 connection = portstatus & USB_PORT_STAT_CONNECTION;
2044 }
2045
2046 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2047 clear_port_feature(hub->hdev, port1,
2048 USB_PORT_FEAT_C_CONNECTION);
2049 }
2050
2051 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2052 break;
2053 msleep(HUB_DEBOUNCE_STEP);
2054 }
2055
2056 dev_dbg (hub->intfdev,
2057 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2058 port1, total_time, stable_time, portstatus);
2059
2060 if (stable_time < HUB_DEBOUNCE_STABLE)
2061 return -ETIMEDOUT;
2062 return portstatus;
2063}
2064
2065static void ep0_reinit(struct usb_device *udev)
2066{
2067 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2068 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2069 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2070}
2071
2072#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2073#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2074
2075static int hub_set_address(struct usb_device *udev)
2076{
2077 int retval;
2078
2079 if (udev->devnum == 0)
2080 return -EINVAL;
2081 if (udev->state == USB_STATE_ADDRESS)
2082 return 0;
2083 if (udev->state != USB_STATE_DEFAULT)
2084 return -EINVAL;
2085 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2086 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2087 NULL, 0, USB_CTRL_SET_TIMEOUT);
2088 if (retval == 0) {
2089 usb_set_device_state(udev, USB_STATE_ADDRESS);
2090 ep0_reinit(udev);
2091 }
2092 return retval;
2093}
2094
2095/* Reset device, (re)assign address, get device descriptor.
2096 * Device connection must be stable, no more debouncing needed.
2097 * Returns device in USB_STATE_ADDRESS, except on error.
2098 *
2099 * If this is called for an already-existing device (as part of
2100 * usb_reset_device), the caller must own the device lock. For a
2101 * newly detected device that is not accessible through any global
2102 * pointers, it's not necessary to lock the device.
2103 */
2104static int
2105hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2106 int retry_counter)
2107{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002108 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
2110 struct usb_device *hdev = hub->hdev;
2111 int i, j, retval;
2112 unsigned delay = HUB_SHORT_RESET_TIME;
2113 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002114 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116 /* root hub ports have a slightly longer reset period
2117 * (from USB 2.0 spec, section 7.1.7.5)
2118 */
2119 if (!hdev->parent) {
2120 delay = HUB_ROOT_RESET_TIME;
2121 if (port1 == hdev->bus->otg_port)
2122 hdev->bus->b_hnp_enable = 0;
2123 }
2124
2125 /* Some low speed devices have problems with the quick delay, so */
2126 /* be a bit pessimistic with those devices. RHbug #23670 */
2127 if (oldspeed == USB_SPEED_LOW)
2128 delay = HUB_LONG_RESET_TIME;
2129
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002130 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 /* Reset the device; full speed may morph to high speed */
2133 retval = hub_port_reset(hub, port1, udev, delay);
2134 if (retval < 0) /* error or disconnect */
2135 goto fail;
2136 /* success, speed is known */
2137 retval = -ENODEV;
2138
2139 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2140 dev_dbg(&udev->dev, "device reset changed speed!\n");
2141 goto fail;
2142 }
2143 oldspeed = udev->speed;
2144
2145 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2146 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002147 * For Wireless USB devices, ep0 max packet is always 512 (tho
2148 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 */
2150 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002151 case USB_SPEED_VARIABLE: /* fixed at 512 */
2152 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2153 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 case USB_SPEED_HIGH: /* fixed at 64 */
2155 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2156 break;
2157 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2158 /* to determine the ep0 maxpacket size, try to read
2159 * the device descriptor to get bMaxPacketSize0 and
2160 * then correct our initial guess.
2161 */
2162 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2163 break;
2164 case USB_SPEED_LOW: /* fixed at 8 */
2165 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2166 break;
2167 default:
2168 goto fail;
2169 }
2170
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002171 type = "";
2172 switch (udev->speed) {
2173 case USB_SPEED_LOW: speed = "low"; break;
2174 case USB_SPEED_FULL: speed = "full"; break;
2175 case USB_SPEED_HIGH: speed = "high"; break;
2176 case USB_SPEED_VARIABLE:
2177 speed = "variable";
2178 type = "Wireless ";
2179 break;
2180 default: speed = "?"; break;
2181 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002183 "%s %s speed %sUSB device using %s and address %d\n",
2184 (udev->config) ? "reset" : "new", speed, type,
2185 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186
2187 /* Set up TT records, if needed */
2188 if (hdev->tt) {
2189 udev->tt = hdev->tt;
2190 udev->ttport = hdev->ttport;
2191 } else if (udev->speed != USB_SPEED_HIGH
2192 && hdev->speed == USB_SPEED_HIGH) {
2193 udev->tt = &hub->tt;
2194 udev->ttport = port1;
2195 }
2196
2197 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2198 * Because device hardware and firmware is sometimes buggy in
2199 * this area, and this is how Linux has done it for ages.
2200 * Change it cautiously.
2201 *
2202 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2203 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2204 * so it may help with some non-standards-compliant devices.
2205 * Otherwise we start with SET_ADDRESS and then try to read the
2206 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2207 * value.
2208 */
2209 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2210 if (USE_NEW_SCHEME(retry_counter)) {
2211 struct usb_device_descriptor *buf;
2212 int r = 0;
2213
2214#define GET_DESCRIPTOR_BUFSIZE 64
2215 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2216 if (!buf) {
2217 retval = -ENOMEM;
2218 continue;
2219 }
2220
2221 /* Use a short timeout the first time through,
2222 * so that recalcitrant full-speed devices with
2223 * 8- or 16-byte ep0-maxpackets won't slow things
2224 * down tremendously by NAKing the unexpectedly
2225 * early status stage. Also, retry on all errors;
2226 * some devices are flakey.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002227 * 255 is for WUSB devices, we actually need to use 512.
2228 * WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 */
2230 for (j = 0; j < 3; ++j) {
2231 buf->bMaxPacketSize0 = 0;
2232 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2233 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2234 USB_DT_DEVICE << 8, 0,
2235 buf, GET_DESCRIPTOR_BUFSIZE,
2236 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2237 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002238 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 if (buf->bDescriptorType ==
2240 USB_DT_DEVICE) {
2241 r = 0;
2242 break;
2243 }
2244 /* FALL THROUGH */
2245 default:
2246 if (r == 0)
2247 r = -EPROTO;
2248 break;
2249 }
2250 if (r == 0)
2251 break;
2252 }
2253 udev->descriptor.bMaxPacketSize0 =
2254 buf->bMaxPacketSize0;
2255 kfree(buf);
2256
2257 retval = hub_port_reset(hub, port1, udev, delay);
2258 if (retval < 0) /* error or disconnect */
2259 goto fail;
2260 if (oldspeed != udev->speed) {
2261 dev_dbg(&udev->dev,
2262 "device reset changed speed!\n");
2263 retval = -ENODEV;
2264 goto fail;
2265 }
2266 if (r) {
2267 dev_err(&udev->dev, "device descriptor "
2268 "read/%s, error %d\n",
2269 "64", r);
2270 retval = -EMSGSIZE;
2271 continue;
2272 }
2273#undef GET_DESCRIPTOR_BUFSIZE
2274 }
2275
2276 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2277 retval = hub_set_address(udev);
2278 if (retval >= 0)
2279 break;
2280 msleep(200);
2281 }
2282 if (retval < 0) {
2283 dev_err(&udev->dev,
2284 "device not accepting address %d, error %d\n",
2285 udev->devnum, retval);
2286 goto fail;
2287 }
2288
2289 /* cope with hardware quirkiness:
2290 * - let SET_ADDRESS settle, some device hardware wants it
2291 * - read ep0 maxpacket even for high and low speed,
2292 */
2293 msleep(10);
2294 if (USE_NEW_SCHEME(retry_counter))
2295 break;
2296
2297 retval = usb_get_device_descriptor(udev, 8);
2298 if (retval < 8) {
2299 dev_err(&udev->dev, "device descriptor "
2300 "read/%s, error %d\n",
2301 "8", retval);
2302 if (retval >= 0)
2303 retval = -EMSGSIZE;
2304 } else {
2305 retval = 0;
2306 break;
2307 }
2308 }
2309 if (retval)
2310 goto fail;
2311
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002312 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2313 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2315 if (udev->speed != USB_SPEED_FULL ||
2316 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2317 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2318 retval = -EMSGSIZE;
2319 goto fail;
2320 }
2321 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2322 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2323 ep0_reinit(udev);
2324 }
2325
2326 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2327 if (retval < (signed)sizeof(udev->descriptor)) {
2328 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2329 "all", retval);
2330 if (retval >= 0)
2331 retval = -ENOMSG;
2332 goto fail;
2333 }
2334
2335 retval = 0;
2336
2337fail:
2338 if (retval)
2339 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002340 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 return retval;
2342}
2343
2344static void
2345check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2346{
2347 struct usb_qualifier_descriptor *qual;
2348 int status;
2349
Christoph Lametere94b1762006-12-06 20:33:17 -08002350 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 if (qual == NULL)
2352 return;
2353
2354 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2355 qual, sizeof *qual);
2356 if (status == sizeof *qual) {
2357 dev_info(&udev->dev, "not running at top speed; "
2358 "connect to a high speed hub\n");
2359 /* hub LEDs are probably harder to miss than syslog */
2360 if (hub->has_indicators) {
2361 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002362 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 }
2364 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002365 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366}
2367
2368static unsigned
2369hub_power_remaining (struct usb_hub *hub)
2370{
2371 struct usb_device *hdev = hub->hdev;
2372 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002373 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Alan Stern55c52712005-11-23 12:03:12 -05002375 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 return 0;
2377
Alan Stern55c52712005-11-23 12:03:12 -05002378 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2379 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2380 struct usb_device *udev = hdev->children[port1 - 1];
2381 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382
2383 if (!udev)
2384 continue;
2385
Alan Stern55c52712005-11-23 12:03:12 -05002386 /* Unconfigured devices may not use more than 100mA,
2387 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002389 delta = udev->actconfig->desc.bMaxPower * 2;
2390 else if (port1 != udev->bus->otg_port || hdev->parent)
2391 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 else
Alan Stern55c52712005-11-23 12:03:12 -05002393 delta = 8;
2394 if (delta > hub->mA_per_port)
2395 dev_warn(&udev->dev, "%dmA is over %umA budget "
2396 "for port %d!\n",
2397 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 remaining -= delta;
2399 }
2400 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002401 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2402 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 remaining = 0;
2404 }
2405 return remaining;
2406}
2407
2408/* Handle physical or logical connection change events.
2409 * This routine is called when:
2410 * a port connection-change occurs;
2411 * a port enable-change occurs (often caused by EMI);
2412 * usb_reset_device() encounters changed descriptors (as from
2413 * a firmware download)
2414 * caller already locked the hub
2415 */
2416static void hub_port_connect_change(struct usb_hub *hub, int port1,
2417 u16 portstatus, u16 portchange)
2418{
2419 struct usb_device *hdev = hub->hdev;
2420 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002421 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 int status, i;
2423
2424 dev_dbg (hub_dev,
2425 "port %d, status %04x, change %04x, %s\n",
2426 port1, portstatus, portchange, portspeed (portstatus));
2427
2428 if (hub->has_indicators) {
2429 set_port_led(hub, port1, HUB_LED_AUTO);
2430 hub->indicator[port1-1] = INDICATOR_AUTO;
2431 }
2432
2433 /* Disconnect any existing devices under this port */
2434 if (hdev->children[port1-1])
2435 usb_disconnect(&hdev->children[port1-1]);
2436 clear_bit(port1, hub->change_bits);
2437
2438#ifdef CONFIG_USB_OTG
2439 /* during HNP, don't repeat the debounce */
2440 if (hdev->bus->is_b_host)
2441 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2442#endif
2443
2444 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2445 status = hub_port_debounce(hub, port1);
2446 if (status < 0) {
2447 dev_err (hub_dev,
2448 "connect-debounce failed, port %d disabled\n",
2449 port1);
2450 goto done;
2451 }
2452 portstatus = status;
2453 }
2454
2455 /* Return now if nothing is connected */
2456 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2457
2458 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002459 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2461 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2462
2463 if (portstatus & USB_PORT_STAT_ENABLE)
2464 goto done;
2465 return;
2466 }
2467
2468#ifdef CONFIG_USB_SUSPEND
2469 /* If something is connected, but the port is suspended, wake it up. */
2470 if (portstatus & USB_PORT_STAT_SUSPEND) {
2471 status = hub_port_resume(hub, port1, NULL);
2472 if (status < 0) {
2473 dev_dbg(hub_dev,
2474 "can't clear suspend on port %d; %d\n",
2475 port1, status);
2476 goto done;
2477 }
2478 }
2479#endif
2480
2481 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2482 struct usb_device *udev;
2483
2484 /* reallocate for each attempt, since references
2485 * to the previous one can escape in various ways
2486 */
2487 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2488 if (!udev) {
2489 dev_err (hub_dev,
2490 "couldn't allocate port %d usb_device\n",
2491 port1);
2492 goto done;
2493 }
2494
2495 usb_set_device_state(udev, USB_STATE_POWERED);
2496 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002497 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002498 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002499
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 /* set the address */
2501 choose_address(udev);
2502 if (udev->devnum <= 0) {
2503 status = -ENOTCONN; /* Don't retry */
2504 goto loop;
2505 }
2506
2507 /* reset and get descriptor */
2508 status = hub_port_init(hub, udev, port1, i);
2509 if (status < 0)
2510 goto loop;
2511
2512 /* consecutive bus-powered hubs aren't reliable; they can
2513 * violate the voltage drop budget. if the new child has
2514 * a "powered" LED, users should notice we didn't enable it
2515 * (without reading syslog), even without per-port LEDs
2516 * on the parent.
2517 */
2518 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002519 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 u16 devstat;
2521
2522 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2523 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002524 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 dev_dbg(&udev->dev, "get status %d ?\n", status);
2526 goto loop_disable;
2527 }
Alan Stern55c52712005-11-23 12:03:12 -05002528 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2530 dev_err(&udev->dev,
2531 "can't connect bus-powered hub "
2532 "to this port\n");
2533 if (hub->has_indicators) {
2534 hub->indicator[port1-1] =
2535 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002536 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 }
2538 status = -ENOTCONN; /* Don't retry */
2539 goto loop_disable;
2540 }
2541 }
2542
2543 /* check for devices running slower than they could */
2544 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2545 && udev->speed == USB_SPEED_FULL
2546 && highspeed_hubs != 0)
2547 check_highspeed (hub, udev, port1);
2548
2549 /* Store the parent's children[] pointer. At this point
2550 * udev becomes globally accessible, although presumably
2551 * no one will look at it until hdev is unlocked.
2552 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 status = 0;
2554
2555 /* We mustn't add new devices if the parent hub has
2556 * been disconnected; we would race with the
2557 * recursively_mark_NOTATTACHED() routine.
2558 */
2559 spin_lock_irq(&device_state_lock);
2560 if (hdev->state == USB_STATE_NOTATTACHED)
2561 status = -ENOTCONN;
2562 else
2563 hdev->children[port1-1] = udev;
2564 spin_unlock_irq(&device_state_lock);
2565
2566 /* Run it through the hoops (find a driver, etc) */
2567 if (!status) {
2568 status = usb_new_device(udev);
2569 if (status) {
2570 spin_lock_irq(&device_state_lock);
2571 hdev->children[port1-1] = NULL;
2572 spin_unlock_irq(&device_state_lock);
2573 }
2574 }
2575
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 if (status)
2577 goto loop_disable;
2578
2579 status = hub_power_remaining(hub);
2580 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002581 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582
2583 return;
2584
2585loop_disable:
2586 hub_port_disable(hub, port1, 1);
2587loop:
2588 ep0_reinit(udev);
2589 release_address(udev);
2590 usb_put_dev(udev);
2591 if (status == -ENOTCONN)
2592 break;
2593 }
2594
2595done:
2596 hub_port_disable(hub, port1, 1);
2597}
2598
2599static void hub_events(void)
2600{
2601 struct list_head *tmp;
2602 struct usb_device *hdev;
2603 struct usb_interface *intf;
2604 struct usb_hub *hub;
2605 struct device *hub_dev;
2606 u16 hubstatus;
2607 u16 hubchange;
2608 u16 portstatus;
2609 u16 portchange;
2610 int i, ret;
2611 int connect_change;
2612
2613 /*
2614 * We restart the list every time to avoid a deadlock with
2615 * deleting hubs downstream from this one. This should be
2616 * safe since we delete the hub from the event list.
2617 * Not the most efficient, but avoids deadlocks.
2618 */
2619 while (1) {
2620
2621 /* Grab the first entry at the beginning of the list */
2622 spin_lock_irq(&hub_event_lock);
2623 if (list_empty(&hub_event_list)) {
2624 spin_unlock_irq(&hub_event_lock);
2625 break;
2626 }
2627
2628 tmp = hub_event_list.next;
2629 list_del_init(tmp);
2630
2631 hub = list_entry(tmp, struct usb_hub, event_list);
2632 hdev = hub->hdev;
2633 intf = to_usb_interface(hub->intfdev);
2634 hub_dev = &intf->dev;
2635
Alan Stern40f122f2006-11-09 14:44:33 -05002636 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002637 hdev->state, hub->descriptor
2638 ? hub->descriptor->bNbrPorts
2639 : 0,
2640 /* NOTE: expects max 15 ports... */
2641 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002642 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643
2644 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 spin_unlock_irq(&hub_event_lock);
2646
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 /* Lock the device, then check to see if we were
2648 * disconnected while waiting for the lock to succeed. */
2649 if (locktree(hdev) < 0) {
2650 usb_put_intf(intf);
2651 continue;
2652 }
2653 if (hub != usb_get_intfdata(intf))
2654 goto loop;
2655
2656 /* If the hub has died, clean up after it */
2657 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002658 hub->error = -ENODEV;
2659 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 goto loop;
2661 }
2662
Alan Stern40f122f2006-11-09 14:44:33 -05002663 /* Autoresume */
2664 ret = usb_autopm_get_interface(intf);
2665 if (ret) {
2666 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002668 }
2669
2670 /* If this is an inactive hub, do nothing */
2671 if (hub->quiescing)
2672 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673
2674 if (hub->error) {
2675 dev_dbg (hub_dev, "resetting for error %d\n",
2676 hub->error);
2677
Alan Stern7de18d82006-06-01 13:37:24 -04002678 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 if (ret) {
2680 dev_dbg (hub_dev,
2681 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002682 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683 }
2684
2685 hub->nerrors = 0;
2686 hub->error = 0;
2687 }
2688
2689 /* deal with port status changes */
2690 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2691 if (test_bit(i, hub->busy_bits))
2692 continue;
2693 connect_change = test_bit(i, hub->change_bits);
2694 if (!test_and_clear_bit(i, hub->event_bits) &&
2695 !connect_change && !hub->activating)
2696 continue;
2697
2698 ret = hub_port_status(hub, i,
2699 &portstatus, &portchange);
2700 if (ret < 0)
2701 continue;
2702
2703 if (hub->activating && !hdev->children[i-1] &&
2704 (portstatus &
2705 USB_PORT_STAT_CONNECTION))
2706 connect_change = 1;
2707
2708 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2709 clear_port_feature(hdev, i,
2710 USB_PORT_FEAT_C_CONNECTION);
2711 connect_change = 1;
2712 }
2713
2714 if (portchange & USB_PORT_STAT_C_ENABLE) {
2715 if (!connect_change)
2716 dev_dbg (hub_dev,
2717 "port %d enable change, "
2718 "status %08x\n",
2719 i, portstatus);
2720 clear_port_feature(hdev, i,
2721 USB_PORT_FEAT_C_ENABLE);
2722
2723 /*
2724 * EM interference sometimes causes badly
2725 * shielded USB devices to be shutdown by
2726 * the hub, this hack enables them again.
2727 * Works at least with mouse driver.
2728 */
2729 if (!(portstatus & USB_PORT_STAT_ENABLE)
2730 && !connect_change
2731 && hdev->children[i-1]) {
2732 dev_err (hub_dev,
2733 "port %i "
2734 "disabled by hub (EMI?), "
2735 "re-enabling...\n",
2736 i);
2737 connect_change = 1;
2738 }
2739 }
2740
2741 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2742 clear_port_feature(hdev, i,
2743 USB_PORT_FEAT_C_SUSPEND);
2744 if (hdev->children[i-1]) {
2745 ret = remote_wakeup(hdev->
2746 children[i-1]);
2747 if (ret < 0)
2748 connect_change = 1;
2749 } else {
2750 ret = -ENODEV;
2751 hub_port_disable(hub, i, 1);
2752 }
2753 dev_dbg (hub_dev,
2754 "resume on port %d, status %d\n",
2755 i, ret);
2756 }
2757
2758 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2759 dev_err (hub_dev,
2760 "over-current change on port %d\n",
2761 i);
2762 clear_port_feature(hdev, i,
2763 USB_PORT_FEAT_C_OVER_CURRENT);
2764 hub_power_on(hub);
2765 }
2766
2767 if (portchange & USB_PORT_STAT_C_RESET) {
2768 dev_dbg (hub_dev,
2769 "reset change on port %d\n",
2770 i);
2771 clear_port_feature(hdev, i,
2772 USB_PORT_FEAT_C_RESET);
2773 }
2774
2775 if (connect_change)
2776 hub_port_connect_change(hub, i,
2777 portstatus, portchange);
2778 } /* end for i */
2779
2780 /* deal with hub status changes */
2781 if (test_and_clear_bit(0, hub->event_bits) == 0)
2782 ; /* do nothing */
2783 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2784 dev_err (hub_dev, "get_hub_status failed\n");
2785 else {
2786 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2787 dev_dbg (hub_dev, "power change\n");
2788 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002789 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2790 /* FIXME: Is this always true? */
2791 hub->limited_power = 0;
2792 else
2793 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 }
2795 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2796 dev_dbg (hub_dev, "overcurrent change\n");
2797 msleep(500); /* Cool down */
2798 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2799 hub_power_on(hub);
2800 }
2801 }
2802
2803 hub->activating = 0;
2804
Alan Sternd5926ae72005-04-21 15:56:37 -04002805 /* If this is a root hub, tell the HCD it's okay to
2806 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002807 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002808 usb_enable_root_hub_irq(hdev->bus);
2809
Alan Stern40f122f2006-11-09 14:44:33 -05002810loop_autopm:
2811 /* Allow autosuspend if we're not going to run again */
2812 if (list_empty(&hub->event_list))
2813 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814loop:
2815 usb_unlock_device(hdev);
2816 usb_put_intf(intf);
2817
2818 } /* end while (1) */
2819}
2820
2821static int hub_thread(void *__unused)
2822{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 do {
2824 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002825 wait_event_interruptible(khubd_wait,
2826 !list_empty(&hub_event_list) ||
2827 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002828 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002829 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002831 pr_debug("%s: khubd exiting\n", usbcore_name);
2832 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833}
2834
2835static struct usb_device_id hub_id_table [] = {
2836 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2837 .bDeviceClass = USB_CLASS_HUB},
2838 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2839 .bInterfaceClass = USB_CLASS_HUB},
2840 { } /* Terminating entry */
2841};
2842
2843MODULE_DEVICE_TABLE (usb, hub_id_table);
2844
2845static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846 .name = "hub",
2847 .probe = hub_probe,
2848 .disconnect = hub_disconnect,
2849 .suspend = hub_suspend,
2850 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002851 .pre_reset = hub_pre_reset,
2852 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 .ioctl = hub_ioctl,
2854 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002855 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856};
2857
2858int usb_hub_init(void)
2859{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860 if (usb_register(&hub_driver) < 0) {
2861 printk(KERN_ERR "%s: can't register hub driver\n",
2862 usbcore_name);
2863 return -1;
2864 }
2865
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002866 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2867 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869
2870 /* Fall through if kernel_thread failed */
2871 usb_deregister(&hub_driver);
2872 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2873
2874 return -1;
2875}
2876
2877void usb_hub_cleanup(void)
2878{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002879 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880
2881 /*
2882 * Hub resources are freed for us by usb_deregister. It calls
2883 * usb_driver_purge on every device which in turn calls that
2884 * devices disconnect function if it is using this driver.
2885 * The hub_disconnect function takes care of releasing the
2886 * individual hub resources. -greg
2887 */
2888 usb_deregister(&hub_driver);
2889} /* usb_hub_cleanup() */
2890
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891static int config_descriptors_changed(struct usb_device *udev)
2892{
2893 unsigned index;
2894 unsigned len = 0;
2895 struct usb_config_descriptor *buf;
2896
2897 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2898 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2899 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2900 }
Christoph Lametere94b1762006-12-06 20:33:17 -08002901 buf = kmalloc (len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 if (buf == NULL) {
2903 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2904 /* assume the worst */
2905 return 1;
2906 }
2907 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2908 int length;
2909 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2910
2911 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2912 old_length);
2913 if (length < old_length) {
2914 dev_dbg(&udev->dev, "config index %d, error %d\n",
2915 index, length);
2916 break;
2917 }
2918 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2919 != 0) {
2920 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2921 index, buf->bConfigurationValue);
2922 break;
2923 }
2924 }
2925 kfree(buf);
2926 return index != udev->descriptor.bNumConfigurations;
2927}
2928
2929/**
2930 * usb_reset_device - perform a USB port reset to reinitialize a device
2931 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2932 *
Alan Stern79efa092006-06-01 13:33:42 -04002933 * WARNING - don't use this routine to reset a composite device
2934 * (one with multiple interfaces owned by separate drivers)!
2935 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936 *
2937 * Do a port reset, reassign the device's address, and establish its
2938 * former operating configuration. If the reset fails, or the device's
2939 * descriptors change from their values before the reset, or the original
2940 * configuration and altsettings cannot be restored, a flag will be set
2941 * telling khubd to pretend the device has been disconnected and then
2942 * re-connected. All drivers will be unbound, and the device will be
2943 * re-enumerated and probed all over again.
2944 *
2945 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2946 * flagged for logical disconnection, or some other negative error code
2947 * if the reset wasn't even attempted.
2948 *
2949 * The caller must own the device lock. For example, it's safe to use
2950 * this from a driver probe() routine after downloading new firmware.
2951 * For calls that might not occur during probe(), drivers should lock
2952 * the device using usb_lock_device_for_reset().
2953 */
2954int usb_reset_device(struct usb_device *udev)
2955{
2956 struct usb_device *parent_hdev = udev->parent;
2957 struct usb_hub *parent_hub;
2958 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002959 int i, ret = 0;
2960 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002961
2962 if (udev->state == USB_STATE_NOTATTACHED ||
2963 udev->state == USB_STATE_SUSPENDED) {
2964 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2965 udev->state);
2966 return -EINVAL;
2967 }
2968
2969 if (!parent_hdev) {
2970 /* this requires hcd-specific logic; see OHCI hc_restart() */
2971 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2972 return -EISDIR;
2973 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974 parent_hub = hdev_to_hub(parent_hdev);
2975
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 set_bit(port1, parent_hub->busy_bits);
2977 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2978
2979 /* ep0 maxpacket size may change; let the HCD know about it.
2980 * Other endpoints will be handled by re-enumeration. */
2981 ep0_reinit(udev);
2982 ret = hub_port_init(parent_hub, udev, port1, i);
2983 if (ret >= 0)
2984 break;
2985 }
2986 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002987 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2988 usb_enable_root_hub_irq(parent_hdev->bus);
2989
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990 if (ret < 0)
2991 goto re_enumerate;
2992
2993 /* Device might have changed firmware (DFU or similar) */
2994 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2995 || config_descriptors_changed (udev)) {
2996 dev_info(&udev->dev, "device firmware changed\n");
2997 udev->descriptor = descriptor; /* for disconnect() calls */
2998 goto re_enumerate;
2999 }
3000
3001 if (!udev->actconfig)
3002 goto done;
3003
3004 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3005 USB_REQ_SET_CONFIGURATION, 0,
3006 udev->actconfig->desc.bConfigurationValue, 0,
3007 NULL, 0, USB_CTRL_SET_TIMEOUT);
3008 if (ret < 0) {
3009 dev_err(&udev->dev,
3010 "can't restore configuration #%d (error=%d)\n",
3011 udev->actconfig->desc.bConfigurationValue, ret);
3012 goto re_enumerate;
3013 }
3014 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3015
3016 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3017 struct usb_interface *intf = udev->actconfig->interface[i];
3018 struct usb_interface_descriptor *desc;
3019
3020 /* set_interface resets host side toggle even
3021 * for altsetting zero. the interface may have no driver.
3022 */
3023 desc = &intf->cur_altsetting->desc;
3024 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3025 desc->bAlternateSetting);
3026 if (ret < 0) {
3027 dev_err(&udev->dev, "failed to restore interface %d "
3028 "altsetting %d (error=%d)\n",
3029 desc->bInterfaceNumber,
3030 desc->bAlternateSetting,
3031 ret);
3032 goto re_enumerate;
3033 }
3034 }
3035
3036done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037 return 0;
3038
3039re_enumerate:
3040 hub_port_logical_disconnect(parent_hub, port1);
3041 return -ENODEV;
3042}
Alan Stern140d8f62006-07-01 22:07:21 -04003043EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003044
3045/**
3046 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3047 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3048 * @iface: interface bound to the driver making the request (optional)
3049 *
3050 * Warns all drivers bound to registered interfaces (using their pre_reset
3051 * method), performs the port reset, and then lets the drivers know that
3052 * the reset is over (using their post_reset method).
3053 *
3054 * Return value is the same as for usb_reset_device().
3055 *
3056 * The caller must own the device lock. For example, it's safe to use
3057 * this from a driver probe() routine after downloading new firmware.
3058 * For calls that might not occur during probe(), drivers should lock
3059 * the device using usb_lock_device_for_reset().
3060 *
3061 * The interface locks are acquired during the pre_reset stage and released
3062 * during the post_reset stage. However if iface is not NULL and is
3063 * currently being probed, we assume that the caller already owns its
3064 * lock.
3065 */
3066int usb_reset_composite_device(struct usb_device *udev,
3067 struct usb_interface *iface)
3068{
3069 int ret;
3070 struct usb_host_config *config = udev->actconfig;
3071
3072 if (udev->state == USB_STATE_NOTATTACHED ||
3073 udev->state == USB_STATE_SUSPENDED) {
3074 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3075 udev->state);
3076 return -EINVAL;
3077 }
3078
Alan Stern645daaa2006-08-30 15:47:02 -04003079 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003080 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003081
Alan Stern79efa092006-06-01 13:33:42 -04003082 if (iface && iface->condition != USB_INTERFACE_BINDING)
3083 iface = NULL;
3084
3085 if (config) {
3086 int i;
3087 struct usb_interface *cintf;
3088 struct usb_driver *drv;
3089
3090 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3091 cintf = config->interface[i];
3092 if (cintf != iface)
3093 down(&cintf->dev.sem);
3094 if (device_is_registered(&cintf->dev) &&
3095 cintf->dev.driver) {
3096 drv = to_usb_driver(cintf->dev.driver);
3097 if (drv->pre_reset)
3098 (drv->pre_reset)(cintf);
3099 }
3100 }
3101 }
3102
3103 ret = usb_reset_device(udev);
3104
3105 if (config) {
3106 int i;
3107 struct usb_interface *cintf;
3108 struct usb_driver *drv;
3109
3110 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3111 cintf = config->interface[i];
3112 if (device_is_registered(&cintf->dev) &&
3113 cintf->dev.driver) {
3114 drv = to_usb_driver(cintf->dev.driver);
3115 if (drv->post_reset)
3116 (drv->post_reset)(cintf);
3117 }
3118 if (cintf != iface)
3119 up(&cintf->dev.sem);
3120 }
3121 }
3122
Alan Stern94fcda12006-11-20 11:38:46 -05003123 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003124 return ret;
3125}
Alan Stern140d8f62006-07-01 22:07:21 -04003126EXPORT_SYMBOL(usb_reset_composite_device);