blob: 1988224b362bf417f2618a8bcb1e448d32f87eee [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 */
47
48 int error; /* last reported error */
49 int nerrors; /* track consecutive errors */
50
51 struct list_head event_list; /* hubs w/data or errs ready */
52 unsigned long event_bits[1]; /* status change bitmask */
53 unsigned long change_bits[1]; /* ports with logical connect
54 status change */
55 unsigned long busy_bits[1]; /* ports being reset or
56 resumed */
57#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
58#error event_bits[] is too short!
59#endif
60
61 struct usb_hub_descriptor *descriptor; /* class descriptor */
62 struct usb_tt tt; /* Transaction Translator */
63
64 unsigned mA_per_port; /* current for each child */
65
66 unsigned limited_power:1;
67 unsigned quiescing:1;
68 unsigned activating:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050069
70 unsigned has_indicators:1;
71 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000072 struct delayed_work leds;
Alan Stern1bb5f662006-11-06 11:56:13 -050073};
74
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050077 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
79static DEFINE_SPINLOCK(device_state_lock);
80
81/* khubd's worklist and its lock */
82static DEFINE_SPINLOCK(hub_event_lock);
83static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
84
85/* Wakes up khubd */
86static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
87
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070088static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -070090/* multithreaded probe logic */
Greg Kroah-Hartmanb1bf4f42007-01-16 15:41:03 -080091static int multithread_probe = 0;
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/* cycle leds on hubs that aren't blinking for attention */
94static int blinkenlights = 0;
95module_param (blinkenlights, bool, S_IRUGO);
96MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
97
98/*
99 * As of 2.6.10 we introduce a new USB device initialization scheme which
100 * closely resembles the way Windows works. Hopefully it will be compatible
101 * with a wider range of devices than the old scheme. However some previously
102 * working devices may start giving rise to "device not accepting address"
103 * errors; if that happens the user can try the old scheme by adjusting the
104 * following module parameters.
105 *
106 * For maximum flexibility there are two boolean parameters to control the
107 * hub driver's behavior. On the first initialization attempt, if the
108 * "old_scheme_first" parameter is set then the old scheme will be used,
109 * otherwise the new scheme is used. If that fails and "use_both_schemes"
110 * is set, then the driver will make another attempt, using the other scheme.
111 */
112static int old_scheme_first = 0;
113module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
114MODULE_PARM_DESC(old_scheme_first,
115 "start with the old device initialization scheme");
116
117static int use_both_schemes = 1;
118module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
119MODULE_PARM_DESC(use_both_schemes,
120 "try the other device initialization scheme if the "
121 "first one fails");
122
123
124#ifdef DEBUG
125static inline char *portspeed (int portstatus)
126{
127 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
128 return "480 Mb/s";
129 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
130 return "1.5 Mb/s";
131 else
132 return "12 Mb/s";
133}
134#endif
135
136/* Note that hdev or one of its children must be locked! */
137static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
138{
139 return usb_get_intfdata(hdev->actconfig->interface[0]);
140}
141
142/* USB 2.0 spec Section 11.24.4.5 */
143static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
144{
145 int i, ret;
146
147 for (i = 0; i < 3; i++) {
148 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
149 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
150 USB_DT_HUB << 8, 0, data, size,
151 USB_CTRL_GET_TIMEOUT);
152 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
153 return ret;
154 }
155 return -EINVAL;
156}
157
158/*
159 * USB 2.0 spec Section 11.24.2.1
160 */
161static int clear_hub_feature(struct usb_device *hdev, int feature)
162{
163 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
164 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
165}
166
167/*
168 * USB 2.0 spec Section 11.24.2.2
169 */
170static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
171{
172 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
173 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
174 NULL, 0, 1000);
175}
176
177/*
178 * USB 2.0 spec Section 11.24.2.13
179 */
180static int set_port_feature(struct usb_device *hdev, int port1, int feature)
181{
182 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
183 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
184 NULL, 0, 1000);
185}
186
187/*
188 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
189 * for info about using port indicators
190 */
191static void set_port_led(
192 struct usb_hub *hub,
193 int port1,
194 int selector
195)
196{
197 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
198 USB_PORT_FEAT_INDICATOR);
199 if (status < 0)
200 dev_dbg (hub->intfdev,
201 "port %d indicator %s status %d\n",
202 port1,
203 ({ char *s; switch (selector) {
204 case HUB_LED_AMBER: s = "amber"; break;
205 case HUB_LED_GREEN: s = "green"; break;
206 case HUB_LED_OFF: s = "off"; break;
207 case HUB_LED_AUTO: s = "auto"; break;
208 default: s = "??"; break;
209 }; s; }),
210 status);
211}
212
213#define LED_CYCLE_PERIOD ((2*HZ)/3)
214
David Howellsc4028952006-11-22 14:57:56 +0000215static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
David Howellsc4028952006-11-22 14:57:56 +0000217 struct usb_hub *hub =
218 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 struct usb_device *hdev = hub->hdev;
220 unsigned i;
221 unsigned changed = 0;
222 int cursor = -1;
223
224 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
225 return;
226
227 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
228 unsigned selector, mode;
229
230 /* 30%-50% duty cycle */
231
232 switch (hub->indicator[i]) {
233 /* cycle marker */
234 case INDICATOR_CYCLE:
235 cursor = i;
236 selector = HUB_LED_AUTO;
237 mode = INDICATOR_AUTO;
238 break;
239 /* blinking green = sw attention */
240 case INDICATOR_GREEN_BLINK:
241 selector = HUB_LED_GREEN;
242 mode = INDICATOR_GREEN_BLINK_OFF;
243 break;
244 case INDICATOR_GREEN_BLINK_OFF:
245 selector = HUB_LED_OFF;
246 mode = INDICATOR_GREEN_BLINK;
247 break;
248 /* blinking amber = hw attention */
249 case INDICATOR_AMBER_BLINK:
250 selector = HUB_LED_AMBER;
251 mode = INDICATOR_AMBER_BLINK_OFF;
252 break;
253 case INDICATOR_AMBER_BLINK_OFF:
254 selector = HUB_LED_OFF;
255 mode = INDICATOR_AMBER_BLINK;
256 break;
257 /* blink green/amber = reserved */
258 case INDICATOR_ALT_BLINK:
259 selector = HUB_LED_GREEN;
260 mode = INDICATOR_ALT_BLINK_OFF;
261 break;
262 case INDICATOR_ALT_BLINK_OFF:
263 selector = HUB_LED_AMBER;
264 mode = INDICATOR_ALT_BLINK;
265 break;
266 default:
267 continue;
268 }
269 if (selector != HUB_LED_AUTO)
270 changed = 1;
271 set_port_led(hub, i + 1, selector);
272 hub->indicator[i] = mode;
273 }
274 if (!changed && blinkenlights) {
275 cursor++;
276 cursor %= hub->descriptor->bNbrPorts;
277 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
278 hub->indicator[cursor] = INDICATOR_CYCLE;
279 changed++;
280 }
281 if (changed)
282 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
283}
284
285/* use a short timeout for hub/port status fetches */
286#define USB_STS_TIMEOUT 1000
287#define USB_STS_RETRIES 5
288
289/*
290 * USB 2.0 spec Section 11.24.2.6
291 */
292static int get_hub_status(struct usb_device *hdev,
293 struct usb_hub_status *data)
294{
295 int i, status = -ETIMEDOUT;
296
297 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
298 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
299 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
300 data, sizeof(*data), USB_STS_TIMEOUT);
301 }
302 return status;
303}
304
305/*
306 * USB 2.0 spec Section 11.24.2.7
307 */
308static int get_port_status(struct usb_device *hdev, int port1,
309 struct usb_port_status *data)
310{
311 int i, status = -ETIMEDOUT;
312
313 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
314 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
315 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
316 data, sizeof(*data), USB_STS_TIMEOUT);
317 }
318 return status;
319}
320
321static void kick_khubd(struct usb_hub *hub)
322{
323 unsigned long flags;
324
Alan Stern40f122f2006-11-09 14:44:33 -0500325 /* Suppress autosuspend until khubd runs */
326 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 spin_lock_irqsave(&hub_event_lock, flags);
329 if (list_empty(&hub->event_list)) {
330 list_add_tail(&hub->event_list, &hub_event_list);
331 wake_up(&khubd_wait);
332 }
333 spin_unlock_irqrestore(&hub_event_lock, flags);
334}
335
336void usb_kick_khubd(struct usb_device *hdev)
337{
338 kick_khubd(hdev_to_hub(hdev));
339}
340
341
342/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100343static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200345 struct usb_hub *hub = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 int status;
347 int i;
348 unsigned long bits;
349
350 switch (urb->status) {
351 case -ENOENT: /* synchronous unlink */
352 case -ECONNRESET: /* async unlink */
353 case -ESHUTDOWN: /* hardware going away */
354 return;
355
356 default: /* presumably an error */
357 /* Cause a hub reset after 10 consecutive errors */
358 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
359 if ((++hub->nerrors < 10) || hub->error)
360 goto resubmit;
361 hub->error = urb->status;
362 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 /* let khubd handle things */
365 case 0: /* we got data: port status changed */
366 bits = 0;
367 for (i = 0; i < urb->actual_length; ++i)
368 bits |= ((unsigned long) ((*hub->buffer)[i]))
369 << (i*8);
370 hub->event_bits[0] = bits;
371 break;
372 }
373
374 hub->nerrors = 0;
375
376 /* Something happened, let khubd figure it out */
377 kick_khubd(hub);
378
379resubmit:
380 if (hub->quiescing)
381 return;
382
383 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
384 && status != -ENODEV && status != -EPERM)
385 dev_err (hub->intfdev, "resubmit --> %d\n", status);
386}
387
388/* USB 2.0 spec Section 11.24.2.3 */
389static inline int
390hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
391{
392 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
393 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
394 tt, NULL, 0, 1000);
395}
396
397/*
398 * enumeration blocks khubd for a long time. we use keventd instead, since
399 * long blocking there is the exception, not the rule. accordingly, HCDs
400 * talking to TTs must queue control transfers (not just bulk and iso), so
401 * both can talk to the same hub concurrently.
402 */
David Howellsc4028952006-11-22 14:57:56 +0000403static void hub_tt_kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
David Howellsc4028952006-11-22 14:57:56 +0000405 struct usb_hub *hub =
406 container_of(work, struct usb_hub, tt.kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 unsigned long flags;
408
409 spin_lock_irqsave (&hub->tt.lock, flags);
410 while (!list_empty (&hub->tt.clear_list)) {
411 struct list_head *temp;
412 struct usb_tt_clear *clear;
413 struct usb_device *hdev = hub->hdev;
414 int status;
415
416 temp = hub->tt.clear_list.next;
417 clear = list_entry (temp, struct usb_tt_clear, clear_list);
418 list_del (&clear->clear_list);
419
420 /* drop lock so HCD can concurrently report other TT errors */
421 spin_unlock_irqrestore (&hub->tt.lock, flags);
422 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
423 spin_lock_irqsave (&hub->tt.lock, flags);
424
425 if (status)
426 dev_err (&hdev->dev,
427 "clear tt %d (%04x) error %d\n",
428 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700429 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 }
431 spin_unlock_irqrestore (&hub->tt.lock, flags);
432}
433
434/**
435 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
436 * @udev: the device whose split transaction failed
437 * @pipe: identifies the endpoint of the failed transaction
438 *
439 * High speed HCDs use this to tell the hub driver that some split control or
440 * bulk transaction failed in a way that requires clearing internal state of
441 * a transaction translator. This is normally detected (and reported) from
442 * interrupt context.
443 *
444 * It may not be possible for that hub to handle additional full (or low)
445 * speed transactions until that state is fully cleared out.
446 */
447void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
448{
449 struct usb_tt *tt = udev->tt;
450 unsigned long flags;
451 struct usb_tt_clear *clear;
452
453 /* we've got to cope with an arbitrary number of pending TT clears,
454 * since each TT has "at least two" buffers that can need it (and
455 * there can be many TTs per hub). even if they're uncommon.
456 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800457 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
459 /* FIXME recover somehow ... RESET_TT? */
460 return;
461 }
462
463 /* info that CLEAR_TT_BUFFER needs */
464 clear->tt = tt->multi ? udev->ttport : 1;
465 clear->devinfo = usb_pipeendpoint (pipe);
466 clear->devinfo |= udev->devnum << 4;
467 clear->devinfo |= usb_pipecontrol (pipe)
468 ? (USB_ENDPOINT_XFER_CONTROL << 11)
469 : (USB_ENDPOINT_XFER_BULK << 11);
470 if (usb_pipein (pipe))
471 clear->devinfo |= 1 << 15;
472
473 /* tell keventd to clear state for this TT */
474 spin_lock_irqsave (&tt->lock, flags);
475 list_add_tail (&clear->clear_list, &tt->clear_list);
476 schedule_work (&tt->kevent);
477 spin_unlock_irqrestore (&tt->lock, flags);
478}
479
480static void hub_power_on(struct usb_hub *hub)
481{
482 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700483 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400484 u16 wHubCharacteristics =
485 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Alan Stern4489a572006-04-27 15:54:22 -0400487 /* Enable power on each port. Some hubs have reserved values
488 * of LPSM (> 2) in their descriptors, even though they are
489 * USB 2.0 hubs. Some hubs do not implement port-power switching
490 * but only emulate it. In all cases, the ports won't work
491 * unless we send these messages to the hub.
492 */
493 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400495 else
496 dev_dbg(hub->intfdev, "trying to enable port power on "
497 "non-switchable hub\n");
498 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
499 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
David Brownellb7896962005-08-31 10:41:44 -0700501 /* Wait at least 100 msec for power to become stable */
502 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503}
504
Alan Stern02c399e2006-08-30 15:47:11 -0400505static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
David Brownell979d5192005-09-22 22:32:24 -0700507 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700509 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700510
David Brownell979d5192005-09-22 22:32:24 -0700511 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 usb_kill_urb(hub->urb);
513 if (hub->has_indicators)
514 cancel_delayed_work(&hub->leds);
515 if (hub->has_indicators || hub->tt.hub)
516 flush_scheduled_work();
517}
518
519static void hub_activate(struct usb_hub *hub)
520{
521 int status;
522
523 hub->quiescing = 0;
524 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 status = usb_submit_urb(hub->urb, GFP_NOIO);
527 if (status < 0)
528 dev_err(hub->intfdev, "activate --> %d\n", status);
529 if (hub->has_indicators && blinkenlights)
530 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
531
532 /* scan all ports ASAP */
533 kick_khubd(hub);
534}
535
536static int hub_hub_status(struct usb_hub *hub,
537 u16 *status, u16 *change)
538{
539 int ret;
540
541 ret = get_hub_status(hub->hdev, &hub->status->hub);
542 if (ret < 0)
543 dev_err (hub->intfdev,
544 "%s failed (err = %d)\n", __FUNCTION__, ret);
545 else {
546 *status = le16_to_cpu(hub->status->hub.wHubStatus);
547 *change = le16_to_cpu(hub->status->hub.wHubChange);
548 ret = 0;
549 }
550 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 }
623
624 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
625 if (!hub->descriptor) {
626 message = "can't kmalloc hub descriptor";
627 ret = -ENOMEM;
628 goto fail;
629 }
630
631 /* Request the entire hub descriptor.
632 * hub->descriptor can handle USB_MAXCHILDREN ports,
633 * but the hub can/will return fewer bytes here.
634 */
635 ret = get_hub_descriptor(hdev, hub->descriptor,
636 sizeof(*hub->descriptor));
637 if (ret < 0) {
638 message = "can't read hub descriptor";
639 goto fail;
640 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
641 message = "hub has too many ports!";
642 ret = -ENODEV;
643 goto fail;
644 }
645
646 hdev->maxchild = hub->descriptor->bNbrPorts;
647 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
648 (hdev->maxchild == 1) ? "" : "s");
649
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700650 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700652 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 int i;
654 char portstr [USB_MAXCHILDREN + 1];
655
656 for (i = 0; i < hdev->maxchild; i++)
657 portstr[i] = hub->descriptor->DeviceRemovable
658 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
659 ? 'F' : 'R';
660 portstr[hdev->maxchild] = 0;
661 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
662 } else
663 dev_dbg(hub_dev, "standalone hub\n");
664
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700665 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 case 0x00:
667 dev_dbg(hub_dev, "ganged power switching\n");
668 break;
669 case 0x01:
670 dev_dbg(hub_dev, "individual port power switching\n");
671 break;
672 case 0x02:
673 case 0x03:
674 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
675 break;
676 }
677
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700678 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 case 0x00:
680 dev_dbg(hub_dev, "global over-current protection\n");
681 break;
682 case 0x08:
683 dev_dbg(hub_dev, "individual port over-current protection\n");
684 break;
685 case 0x10:
686 case 0x18:
687 dev_dbg(hub_dev, "no over-current protection\n");
688 break;
689 }
690
691 spin_lock_init (&hub->tt.lock);
692 INIT_LIST_HEAD (&hub->tt.clear_list);
David Howellsc4028952006-11-22 14:57:56 +0000693 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 switch (hdev->descriptor.bDeviceProtocol) {
695 case 0:
696 break;
697 case 1:
698 dev_dbg(hub_dev, "Single TT\n");
699 hub->tt.hub = hdev;
700 break;
701 case 2:
702 ret = usb_set_interface(hdev, 0, 1);
703 if (ret == 0) {
704 dev_dbg(hub_dev, "TT per port\n");
705 hub->tt.multi = 1;
706 } else
707 dev_err(hub_dev, "Using single TT (err %d)\n",
708 ret);
709 hub->tt.hub = hdev;
710 break;
711 default:
712 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
713 hdev->descriptor.bDeviceProtocol);
714 break;
715 }
716
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700717 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700718 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700719 case HUB_TTTT_8_BITS:
720 if (hdev->descriptor.bDeviceProtocol != 0) {
721 hub->tt.think_time = 666;
722 dev_dbg(hub_dev, "TT requires at most %d "
723 "FS bit times (%d ns)\n",
724 8, hub->tt.think_time);
725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700727 case HUB_TTTT_16_BITS:
728 hub->tt.think_time = 666 * 2;
729 dev_dbg(hub_dev, "TT requires at most %d "
730 "FS bit times (%d ns)\n",
731 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700733 case HUB_TTTT_24_BITS:
734 hub->tt.think_time = 666 * 3;
735 dev_dbg(hub_dev, "TT requires at most %d "
736 "FS bit times (%d ns)\n",
737 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700739 case HUB_TTTT_32_BITS:
740 hub->tt.think_time = 666 * 4;
741 dev_dbg(hub_dev, "TT requires at most %d "
742 "FS bit times (%d ns)\n",
743 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 break;
745 }
746
747 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700748 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 hub->has_indicators = 1;
750 dev_dbg(hub_dev, "Port indicators are supported\n");
751 }
752
753 dev_dbg(hub_dev, "power on to power good time: %dms\n",
754 hub->descriptor->bPwrOn2PwrGood * 2);
755
756 /* power budgeting mostly matters with bus-powered hubs,
757 * and battery-powered root hubs (may provide just 8 mA).
758 */
759 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500760 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 message = "can't get hub status";
762 goto fail;
763 }
Alan Stern7d35b922005-04-25 11:18:32 -0400764 le16_to_cpus(&hubstatus);
765 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500766 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
767 hub->mA_per_port = 500;
768 else {
769 hub->mA_per_port = hdev->bus_mA;
770 hub->limited_power = 1;
771 }
Alan Stern7d35b922005-04-25 11:18:32 -0400772 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
774 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500775 hub->limited_power = 1;
776 if (hdev->maxchild > 0) {
777 int remaining = hdev->bus_mA -
778 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Alan Stern55c52712005-11-23 12:03:12 -0500780 if (remaining < hdev->maxchild * 100)
781 dev_warn(hub_dev,
782 "insufficient power available "
783 "to use all downstream ports\n");
784 hub->mA_per_port = 100; /* 7.2.1.1 */
785 }
786 } else { /* Self-powered external hub */
787 /* FIXME: What about battery-powered external hubs that
788 * provide less current per port? */
789 hub->mA_per_port = 500;
790 }
791 if (hub->mA_per_port < 500)
792 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
793 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
795 ret = hub_hub_status(hub, &hubstatus, &hubchange);
796 if (ret < 0) {
797 message = "can't get hub status";
798 goto fail;
799 }
800
801 /* local power status reports aren't always correct */
802 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
803 dev_dbg(hub_dev, "local power source is %s\n",
804 (hubstatus & HUB_STATUS_LOCAL_POWER)
805 ? "lost (inactive)" : "good");
806
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700807 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 dev_dbg(hub_dev, "%sover-current condition exists\n",
809 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
810
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700811 /* set up the interrupt endpoint
812 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
813 * bytes as USB2.0[11.12.3] says because some hubs are known
814 * to send more data (and thus cause overflow). For root hubs,
815 * maxpktsize is defined in hcd.c's fake endpoint descriptors
816 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
818 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
819
820 if (maxp > sizeof(*hub->buffer))
821 maxp = sizeof(*hub->buffer);
822
823 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
824 if (!hub->urb) {
825 message = "couldn't allocate interrupt urb";
826 ret = -ENOMEM;
827 goto fail;
828 }
829
830 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
831 hub, endpoint->bInterval);
832 hub->urb->transfer_dma = hub->buffer_dma;
833 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
834
835 /* maybe cycle the hub leds */
836 if (hub->has_indicators && blinkenlights)
837 hub->indicator [0] = INDICATOR_CYCLE;
838
839 hub_power_on(hub);
840 hub_activate(hub);
841 return 0;
842
843fail:
844 dev_err (hub_dev, "config failed, %s (err %d)\n",
845 message, ret);
846 /* hub_disconnect() frees urb and descriptor */
847 return ret;
848}
849
850static unsigned highspeed_hubs;
851
852static void hub_disconnect(struct usb_interface *intf)
853{
854 struct usb_hub *hub = usb_get_intfdata (intf);
855 struct usb_device *hdev;
856
Alan Stern7de18d82006-06-01 13:37:24 -0400857 /* Disconnect all children and quiesce the hub */
858 hub->error = 0;
859 hub_pre_reset(intf);
860
Alan Stern8b28c752005-08-10 17:04:13 -0400861 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 hdev = hub->hdev;
863
864 if (hdev->speed == USB_SPEED_HIGH)
865 highspeed_hubs--;
866
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 usb_free_urb(hub->urb);
868 hub->urb = NULL;
869
870 spin_lock_irq(&hub_event_lock);
871 list_del_init(&hub->event_list);
872 spin_unlock_irq(&hub_event_lock);
873
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700874 kfree(hub->descriptor);
875 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700877 kfree(hub->status);
878 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880 if (hub->buffer) {
881 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
882 hub->buffer_dma);
883 hub->buffer = NULL;
884 }
885
Alan Stern7d069b72005-11-18 12:06:34 -0500886 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887}
888
889static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
890{
891 struct usb_host_interface *desc;
892 struct usb_endpoint_descriptor *endpoint;
893 struct usb_device *hdev;
894 struct usb_hub *hub;
895
896 desc = intf->cur_altsetting;
897 hdev = interface_to_usbdev(intf);
898
David Brownell89ccbdc2006-04-02 10:18:09 -0800899#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
900 if (hdev->parent) {
901 dev_warn(&intf->dev, "ignoring external hub\n");
902 return -ENODEV;
903 }
904#endif
905
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 /* Some hubs have a subclass of 1, which AFAICT according to the */
907 /* specs is not defined, but it works */
908 if ((desc->desc.bInterfaceSubClass != 0) &&
909 (desc->desc.bInterfaceSubClass != 1)) {
910descriptor_error:
911 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
912 return -EIO;
913 }
914
915 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
916 if (desc->desc.bNumEndpoints != 1)
917 goto descriptor_error;
918
919 endpoint = &desc->endpoint[0].desc;
920
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700921 /* If it's not an interrupt in endpoint, we'd better punt! */
922 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 goto descriptor_error;
924
925 /* We found a hub */
926 dev_info (&intf->dev, "USB hub found\n");
927
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400928 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 if (!hub) {
930 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
931 return -ENOMEM;
932 }
933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 INIT_LIST_HEAD(&hub->event_list);
935 hub->intfdev = &intf->dev;
936 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +0000937 INIT_DELAYED_WORK(&hub->leds, led_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -0500940 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
942 if (hdev->speed == USB_SPEED_HIGH)
943 highspeed_hubs++;
944
945 if (hub_configure(hub, endpoint) >= 0)
946 return 0;
947
948 hub_disconnect (intf);
949 return -ENODEV;
950}
951
952static int
953hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
954{
955 struct usb_device *hdev = interface_to_usbdev (intf);
956
957 /* assert ifno == 0 (part of hub spec) */
958 switch (code) {
959 case USBDEVFS_HUB_PORTINFO: {
960 struct usbdevfs_hub_portinfo *info = user_data;
961 int i;
962
963 spin_lock_irq(&device_state_lock);
964 if (hdev->devnum <= 0)
965 info->nports = 0;
966 else {
967 info->nports = hdev->maxchild;
968 for (i = 0; i < info->nports; i++) {
969 if (hdev->children[i] == NULL)
970 info->port[i] = 0;
971 else
972 info->port[i] =
973 hdev->children[i]->devnum;
974 }
975 }
976 spin_unlock_irq(&device_state_lock);
977
978 return info->nports + 1;
979 }
980
981 default:
982 return -ENOSYS;
983 }
984}
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
987/* grab device/port lock, returning index of that port (zero based).
988 * protects the upstream link used by this device from concurrent
989 * tree operations like suspend, resume, reset, and disconnect, which
990 * apply to everything downstream of a given port.
991 */
992static int locktree(struct usb_device *udev)
993{
994 int t;
995 struct usb_device *hdev;
996
997 if (!udev)
998 return -ENODEV;
999
1000 /* root hub is always the first lock in the series */
1001 hdev = udev->parent;
1002 if (!hdev) {
1003 usb_lock_device(udev);
1004 return 0;
1005 }
1006
1007 /* on the path from root to us, lock everything from
1008 * top down, dropping parent locks when not needed
1009 */
1010 t = locktree(hdev);
1011 if (t < 0)
1012 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Alan Stern12c3da32005-11-23 12:09:52 -05001014 /* everything is fail-fast once disconnect
1015 * processing starts
1016 */
1017 if (udev->state == USB_STATE_NOTATTACHED) {
1018 usb_unlock_device(hdev);
1019 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 }
Alan Stern12c3da32005-11-23 12:09:52 -05001021
1022 /* when everyone grabs locks top->bottom,
1023 * non-overlapping work may be concurrent
1024 */
1025 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -05001027 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028}
1029
1030static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1031{
1032 int i;
1033
1034 for (i = 0; i < udev->maxchild; ++i) {
1035 if (udev->children[i])
1036 recursively_mark_NOTATTACHED(udev->children[i]);
1037 }
Alan Sternee49fb52006-11-22 16:55:54 -05001038 if (udev->state == USB_STATE_SUSPENDED)
1039 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 udev->state = USB_STATE_NOTATTACHED;
1041}
1042
1043/**
1044 * usb_set_device_state - change a device's current state (usbcore, hcds)
1045 * @udev: pointer to device whose state should be changed
1046 * @new_state: new state value to be stored
1047 *
1048 * udev->state is _not_ fully protected by the device lock. Although
1049 * most transitions are made only while holding the lock, the state can
1050 * can change to USB_STATE_NOTATTACHED at almost any time. This
1051 * is so that devices can be marked as disconnected as soon as possible,
1052 * without having to wait for any semaphores to be released. As a result,
1053 * all changes to any device's state must be protected by the
1054 * device_state_lock spinlock.
1055 *
1056 * Once a device has been added to the device tree, all changes to its state
1057 * should be made using this routine. The state should _not_ be set directly.
1058 *
1059 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1060 * Otherwise udev->state is set to new_state, and if new_state is
1061 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1062 * to USB_STATE_NOTATTACHED.
1063 */
1064void usb_set_device_state(struct usb_device *udev,
1065 enum usb_device_state new_state)
1066{
1067 unsigned long flags;
1068
1069 spin_lock_irqsave(&device_state_lock, flags);
1070 if (udev->state == USB_STATE_NOTATTACHED)
1071 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001072 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001073
1074 /* root hub wakeup capabilities are managed out-of-band
1075 * and may involve silicon errata ... ignore them here.
1076 */
1077 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001078 if (udev->state == USB_STATE_SUSPENDED
1079 || new_state == USB_STATE_SUSPENDED)
1080 ; /* No change to wakeup settings */
1081 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001082 device_init_wakeup(&udev->dev,
1083 (udev->actconfig->desc.bmAttributes
1084 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001085 else
David Brownellfb669cc2006-01-24 08:40:27 -08001086 device_init_wakeup(&udev->dev, 0);
1087 }
Alan Stern645daaa2006-08-30 15:47:02 -04001088 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001089 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 recursively_mark_NOTATTACHED(udev);
1091 spin_unlock_irqrestore(&device_state_lock, flags);
1092}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
1094
Alan Sternd388dab2006-07-01 22:14:24 -04001095#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001096
1097/**
1098 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1099 * @rhdev: struct usb_device for the root hub
1100 *
1101 * The USB host controller driver calls this function when its root hub
1102 * is resumed and Vbus power has been interrupted or the controller
1103 * has been reset. The routine marks all the children of the root hub
1104 * as NOTATTACHED and marks logical connect-change events on their ports.
1105 */
1106void usb_root_hub_lost_power(struct usb_device *rhdev)
1107{
1108 struct usb_hub *hub;
1109 int port1;
1110 unsigned long flags;
1111
1112 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
Alan Stern353a4092006-09-19 10:07:58 -04001113
1114 /* Make sure no potential wakeup events get lost,
1115 * by forcing the root hub to be resumed.
1116 */
1117 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1118
Alan Stern1c50c312005-11-14 11:45:38 -05001119 spin_lock_irqsave(&device_state_lock, flags);
1120 hub = hdev_to_hub(rhdev);
1121 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1122 if (rhdev->children[port1 - 1]) {
1123 recursively_mark_NOTATTACHED(
1124 rhdev->children[port1 - 1]);
1125 set_bit(port1, hub->change_bits);
1126 }
1127 }
1128 spin_unlock_irqrestore(&device_state_lock, flags);
1129}
1130EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1131
Alan Sternd388dab2006-07-01 22:14:24 -04001132#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134static void choose_address(struct usb_device *udev)
1135{
1136 int devnum;
1137 struct usb_bus *bus = udev->bus;
1138
1139 /* If khubd ever becomes multithreaded, this will need a lock */
1140
1141 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1142 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1143 bus->devnum_next);
1144 if (devnum >= 128)
1145 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1146
1147 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1148
1149 if (devnum < 128) {
1150 set_bit(devnum, bus->devmap.devicemap);
1151 udev->devnum = devnum;
1152 }
1153}
1154
1155static void release_address(struct usb_device *udev)
1156{
1157 if (udev->devnum > 0) {
1158 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1159 udev->devnum = -1;
1160 }
1161}
1162
1163/**
1164 * usb_disconnect - disconnect a device (usbcore-internal)
1165 * @pdev: pointer to device being disconnected
1166 * Context: !in_interrupt ()
1167 *
1168 * Something got disconnected. Get rid of it and all of its children.
1169 *
1170 * If *pdev is a normal device then the parent hub must already be locked.
1171 * If *pdev is a root hub then this routine will acquire the
1172 * usb_bus_list_lock on behalf of the caller.
1173 *
1174 * Only hub drivers (including virtual root hub drivers for host
1175 * controllers) should ever call this.
1176 *
1177 * This call is synchronous, and may not be used in an interrupt context.
1178 */
1179void usb_disconnect(struct usb_device **pdev)
1180{
1181 struct usb_device *udev = *pdev;
1182 int i;
1183
1184 if (!udev) {
1185 pr_debug ("%s nodev\n", __FUNCTION__);
1186 return;
1187 }
1188
1189 /* mark the device as inactive, so any further urb submissions for
1190 * this device (and any of its children) will fail immediately.
1191 * this quiesces everyting except pending urbs.
1192 */
1193 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1195
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001196 usb_lock_device(udev);
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 /* Free up all the children before we remove this device */
1199 for (i = 0; i < USB_MAXCHILDREN; i++) {
1200 if (udev->children[i])
1201 usb_disconnect(&udev->children[i]);
1202 }
1203
1204 /* deallocate hcd/hardware state ... nuking all pending urbs and
1205 * cleaning up all state associated with the current configuration
1206 * so that the hardware is now fully quiesced.
1207 */
Alan Stern782da722006-07-01 22:09:35 -04001208 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 usb_disable_device(udev, 0);
1210
Alan Stern782da722006-07-01 22:09:35 -04001211 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001212
Alan Stern782da722006-07-01 22:09:35 -04001213 /* Unregister the device. The device driver is responsible
1214 * for removing the device files from usbfs and sysfs and for
1215 * de-configuring the device.
1216 */
1217 device_del(&udev->dev);
1218
1219 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 * (or root_hub) pointer.
1221 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
1224 /* Avoid races with recursively_mark_NOTATTACHED() */
1225 spin_lock_irq(&device_state_lock);
1226 *pdev = NULL;
1227 spin_unlock_irq(&device_state_lock);
1228
Alan Sternee49fb52006-11-22 16:55:54 -05001229 /* Decrement the parent's count of unsuspended children */
1230 if (udev->parent) {
1231 usb_pm_lock(udev);
1232 if (!udev->discon_suspended)
Alan Stern94fcda12006-11-20 11:38:46 -05001233 usb_autosuspend_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001234 usb_pm_unlock(udev);
1235 }
1236
Alan Stern782da722006-07-01 22:09:35 -04001237 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238}
1239
1240#ifdef DEBUG
1241static void show_string(struct usb_device *udev, char *id, char *string)
1242{
1243 if (!string)
1244 return;
1245 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1246}
1247
1248#else
1249static inline void show_string(struct usb_device *udev, char *id, char *string)
1250{}
1251#endif
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
1254#ifdef CONFIG_USB_OTG
1255#include "otg_whitelist.h"
David Brownell11bd44a2006-11-01 14:26:26 -08001256static int __usb_port_suspend(struct usb_device *, int port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257#endif
1258
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001259static int __usb_new_device(void *void_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001261 struct usb_device *udev = void_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001264 /* Lock ourself into memory in order to keep a probe sequence
1265 * sleeping in a new thread from allowing us to be unloaded.
1266 */
1267 if (!try_module_get(THIS_MODULE))
1268 return -EINVAL;
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 err = usb_get_configuration(udev);
1271 if (err < 0) {
1272 dev_err(&udev->dev, "can't read configurations, error %d\n",
1273 err);
1274 goto fail;
1275 }
1276
1277 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001278 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1279 udev->manufacturer = usb_cache_string(udev,
1280 udev->descriptor.iManufacturer);
1281 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283 /* Tell the world! */
1284 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1285 "SerialNumber=%d\n",
1286 udev->descriptor.iManufacturer,
1287 udev->descriptor.iProduct,
1288 udev->descriptor.iSerialNumber);
1289 show_string(udev, "Product", udev->product);
1290 show_string(udev, "Manufacturer", udev->manufacturer);
1291 show_string(udev, "SerialNumber", udev->serial);
1292
1293#ifdef CONFIG_USB_OTG
1294 /*
1295 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1296 * to wake us after we've powered off VBUS; and HNP, switching roles
1297 * "host" to "peripheral". The OTG descriptor helps figure this out.
1298 */
1299 if (!udev->bus->is_b_host
1300 && udev->config
1301 && udev->parent == udev->bus->root_hub) {
1302 struct usb_otg_descriptor *desc = 0;
1303 struct usb_bus *bus = udev->bus;
1304
1305 /* descriptor may appear anywhere in config */
1306 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1307 le16_to_cpu(udev->config[0].desc.wTotalLength),
1308 USB_DT_OTG, (void **) &desc) == 0) {
1309 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001310 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 dev_info(&udev->dev,
1313 "Dual-Role OTG device on %sHNP port\n",
1314 (port1 == bus->otg_port)
1315 ? "" : "non-");
1316
1317 /* enable HNP before suspend, it's simpler */
1318 if (port1 == bus->otg_port)
1319 bus->b_hnp_enable = 1;
1320 err = usb_control_msg(udev,
1321 usb_sndctrlpipe(udev, 0),
1322 USB_REQ_SET_FEATURE, 0,
1323 bus->b_hnp_enable
1324 ? USB_DEVICE_B_HNP_ENABLE
1325 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1326 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1327 if (err < 0) {
1328 /* OTG MESSAGE: report errors here,
1329 * customize to match your product.
1330 */
1331 dev_info(&udev->dev,
1332 "can't set HNP mode; %d\n",
1333 err);
1334 bus->b_hnp_enable = 0;
1335 }
1336 }
1337 }
1338 }
1339
1340 if (!is_targeted(udev)) {
1341
1342 /* Maybe it can talk to us, though we can't talk to it.
1343 * (Includes HNP test device.)
1344 */
1345 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern140d8f62006-07-01 22:07:21 -04001346 err = __usb_port_suspend(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 if (err < 0)
1348 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1349 }
1350 err = -ENODEV;
1351 goto fail;
1352 }
1353#endif
1354
Alan Stern782da722006-07-01 22:09:35 -04001355 /* Register the device. The device driver is responsible
1356 * for adding the device files to usbfs and sysfs and for
1357 * configuring the device.
1358 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 err = device_add (&udev->dev);
1360 if (err) {
1361 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1362 goto fail;
1363 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001364
Alan Sternee49fb52006-11-22 16:55:54 -05001365 /* Increment the parent's count of unsuspended children */
1366 if (udev->parent)
Alan Stern94fcda12006-11-20 11:38:46 -05001367 usb_autoresume_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001368
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001369exit:
1370 module_put(THIS_MODULE);
1371 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
1373fail:
1374 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001375 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376}
1377
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001378/**
1379 * usb_new_device - perform initial device setup (usbcore-internal)
1380 * @udev: newly addressed device (in ADDRESS state)
1381 *
1382 * This is called with devices which have been enumerated, but not yet
1383 * configured. The device descriptor is available, but not descriptors
1384 * for any device configuration. The caller must have locked either
1385 * the parent hub (if udev is a normal device) or else the
1386 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1387 * udev has already been installed, but udev is not yet visible through
1388 * sysfs or other filesystem code.
1389 *
1390 * The return value for this function depends on if the
1391 * multithread_probe variable is set or not. If it's set, it will
1392 * return a if the probe thread was successfully created or not. If the
1393 * variable is not set, it will return if the device is configured
1394 * properly or not. interfaces, in sysfs); else a negative errno value.
1395 *
1396 * This call is synchronous, and may not be used in an interrupt context.
1397 *
1398 * Only the hub driver or root-hub registrar should ever call this.
1399 */
1400int usb_new_device(struct usb_device *udev)
1401{
1402 struct task_struct *probe_task;
1403 int ret = 0;
1404
1405 if (multithread_probe) {
1406 probe_task = kthread_run(__usb_new_device, udev,
1407 "usb-probe-%s", udev->devnum);
1408 if (IS_ERR(probe_task))
1409 ret = PTR_ERR(probe_task);
1410 } else
1411 ret = __usb_new_device(udev);
1412
1413 return ret;
1414}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
1416static int hub_port_status(struct usb_hub *hub, int port1,
1417 u16 *status, u16 *change)
1418{
1419 int ret;
1420
1421 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001422 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 dev_err (hub->intfdev,
1424 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001425 if (ret >= 0)
1426 ret = -EIO;
1427 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 *status = le16_to_cpu(hub->status->port.wPortStatus);
1429 *change = le16_to_cpu(hub->status->port.wPortChange);
1430 ret = 0;
1431 }
1432 return ret;
1433}
1434
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001435
1436/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1437static unsigned hub_is_wusb(struct usb_hub *hub)
1438{
1439 struct usb_hcd *hcd;
1440 if (hub->hdev->parent != NULL) /* not a root hub? */
1441 return 0;
1442 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1443 return hcd->wireless;
1444}
1445
1446
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447#define PORT_RESET_TRIES 5
1448#define SET_ADDRESS_TRIES 2
1449#define GET_DESCRIPTOR_TRIES 2
1450#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1451#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1452
1453#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1454#define HUB_SHORT_RESET_TIME 10
1455#define HUB_LONG_RESET_TIME 200
1456#define HUB_RESET_TIMEOUT 500
1457
1458static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1459 struct usb_device *udev, unsigned int delay)
1460{
1461 int delay_time, ret;
1462 u16 portstatus;
1463 u16 portchange;
1464
1465 for (delay_time = 0;
1466 delay_time < HUB_RESET_TIMEOUT;
1467 delay_time += delay) {
1468 /* wait to give the device a chance to reset */
1469 msleep(delay);
1470
1471 /* read and decode port status */
1472 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1473 if (ret < 0)
1474 return ret;
1475
1476 /* Device went away? */
1477 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1478 return -ENOTCONN;
1479
1480 /* bomb out completely if something weird happened */
1481 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1482 return -EINVAL;
1483
1484 /* if we`ve finished resetting, then break out of the loop */
1485 if (!(portstatus & USB_PORT_STAT_RESET) &&
1486 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001487 if (hub_is_wusb(hub))
1488 udev->speed = USB_SPEED_VARIABLE;
1489 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 udev->speed = USB_SPEED_HIGH;
1491 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1492 udev->speed = USB_SPEED_LOW;
1493 else
1494 udev->speed = USB_SPEED_FULL;
1495 return 0;
1496 }
1497
1498 /* switch to the long delay after two short delay failures */
1499 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1500 delay = HUB_LONG_RESET_TIME;
1501
1502 dev_dbg (hub->intfdev,
1503 "port %d not reset yet, waiting %dms\n",
1504 port1, delay);
1505 }
1506
1507 return -EBUSY;
1508}
1509
1510static int hub_port_reset(struct usb_hub *hub, int port1,
1511 struct usb_device *udev, unsigned int delay)
1512{
1513 int i, status;
1514
1515 /* Reset the port */
1516 for (i = 0; i < PORT_RESET_TRIES; i++) {
1517 status = set_port_feature(hub->hdev,
1518 port1, USB_PORT_FEAT_RESET);
1519 if (status)
1520 dev_err(hub->intfdev,
1521 "cannot reset port %d (err = %d)\n",
1522 port1, status);
1523 else {
1524 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001525 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 dev_dbg(hub->intfdev,
1527 "port_wait_reset: err = %d\n",
1528 status);
1529 }
1530
1531 /* return on disconnect or reset */
1532 switch (status) {
1533 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001534 /* TRSTRCY = 10 ms; plus some extra */
1535 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 /* FALL THROUGH */
1537 case -ENOTCONN:
1538 case -ENODEV:
1539 clear_port_feature(hub->hdev,
1540 port1, USB_PORT_FEAT_C_RESET);
1541 /* FIXME need disconnect() for NOTATTACHED device */
1542 usb_set_device_state(udev, status
1543 ? USB_STATE_NOTATTACHED
1544 : USB_STATE_DEFAULT);
1545 return status;
1546 }
1547
1548 dev_dbg (hub->intfdev,
1549 "port %d not enabled, trying reset again...\n",
1550 port1);
1551 delay = HUB_LONG_RESET_TIME;
1552 }
1553
1554 dev_err (hub->intfdev,
1555 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1556 port1);
1557
1558 return status;
1559}
1560
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561/*
1562 * Disable a port and mark a logical connnect-change event, so that some
1563 * time later khubd will disconnect() any existing usb_device on the port
1564 * and will re-enumerate if there actually is a device attached.
1565 */
1566static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1567{
1568 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1569 hub_port_disable(hub, port1, 1);
1570
1571 /* FIXME let caller ask to power down the port:
1572 * - some devices won't enumerate without a VBUS power cycle
1573 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001574 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 * That's easy if this hub can switch power per-port, and
1576 * khubd reactivates the port later (timer, SRP, etc).
1577 * Powerdown must be optional, because of reset/DFU.
1578 */
1579
1580 set_bit(port1, hub->change_bits);
1581 kick_khubd(hub);
1582}
1583
Alan Sternd388dab2006-07-01 22:14:24 -04001584#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
1586#ifdef CONFIG_USB_SUSPEND
1587
1588/*
1589 * Selective port suspend reduces power; most suspended devices draw
1590 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1591 * All devices below the suspended port are also suspended.
1592 *
1593 * Devices leave suspend state when the host wakes them up. Some devices
1594 * also support "remote wakeup", where the device can activate the USB
1595 * tree above them to deliver data, such as a keypress or packet. In
1596 * some cases, this wakes the USB host.
1597 */
1598static int hub_port_suspend(struct usb_hub *hub, int port1,
1599 struct usb_device *udev)
1600{
1601 int status;
1602
1603 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1604
1605 /* enable remote wakeup when appropriate; this lets the device
1606 * wake up the upstream hub (including maybe the root hub).
1607 *
1608 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1609 * we don't explicitly enable it here.
1610 */
Alan Stern645daaa2006-08-30 15:47:02 -04001611 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1613 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1614 USB_DEVICE_REMOTE_WAKEUP, 0,
1615 NULL, 0,
1616 USB_CTRL_SET_TIMEOUT);
1617 if (status)
1618 dev_dbg(&udev->dev,
1619 "won't remote wakeup, status %d\n",
1620 status);
1621 }
1622
1623 /* see 7.1.7.6 */
1624 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1625 if (status) {
1626 dev_dbg(hub->intfdev,
1627 "can't suspend port %d, status %d\n",
1628 port1, status);
1629 /* paranoia: "should not happen" */
1630 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1631 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1632 USB_DEVICE_REMOTE_WAKEUP, 0,
1633 NULL, 0,
1634 USB_CTRL_SET_TIMEOUT);
1635 } else {
1636 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001637 dev_dbg(&udev->dev, "usb %ssuspend\n",
1638 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1640 msleep(10);
1641 }
1642 return status;
1643}
1644
1645/*
1646 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001647 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 * State transitions include:
1649 *
1650 * - suspend, resume ... when the VBUS power link stays live
1651 * - suspend, disconnect ... VBUS lost
1652 *
1653 * Once VBUS drop breaks the circuit, the port it's using has to go through
1654 * normal re-enumeration procedures, starting with enabling VBUS power.
1655 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1656 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1657 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001658 *
1659 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1660 * the root hub for their bus goes into global suspend ... so we don't
1661 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 */
Alan Stern140d8f62006-07-01 22:07:21 -04001663static int __usb_port_suspend (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664{
David Brownellf3f32532005-09-22 22:37:29 -07001665 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
1667 /* caller owns the udev device lock */
1668 if (port1 < 0)
1669 return port1;
1670
Alan Stern140d8f62006-07-01 22:07:21 -04001671 /* we change the device's upstream USB link,
1672 * but root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 */
David Brownellf3f32532005-09-22 22:37:29 -07001674 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1676 udev);
Alan Stern2bf40862006-07-01 22:12:19 -04001677 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001678 dev_dbg(&udev->dev, "usb %ssuspend\n",
1679 udev->auto_pm ? "auto-" : "");
Alan Stern2bf40862006-07-01 22:12:19 -04001680 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1681 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return status;
1683}
1684
David Brownell5edbfb72005-09-22 22:45:26 -07001685/*
Alan Stern140d8f62006-07-01 22:07:21 -04001686 * usb_port_suspend - suspend a usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001688 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 *
1690 * Suspends a USB device that isn't in active use, conserving power.
1691 * Devices may wake out of a suspend, if anything important happens,
1692 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001693 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 * to disconnect devices while they are suspended.
1695 *
David Brownell390a8c32005-09-13 19:57:27 -07001696 * This only affects the USB hardware for a device; its interfaces
1697 * (and, for hubs, child devices) must already have been suspended.
1698 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 * Suspending OTG devices may trigger HNP, if that's been enabled
1700 * between a pair of dual-role devices. That will change roles, such
1701 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1702 *
1703 * Returns 0 on success, else negative errno.
1704 */
Alan Stern140d8f62006-07-01 22:07:21 -04001705int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706{
Alan Stern140d8f62006-07-01 22:07:21 -04001707 return __usb_port_suspend(udev, udev->portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708}
David Brownellf3f32532005-09-22 22:37:29 -07001709
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710/*
David Brownell390a8c32005-09-13 19:57:27 -07001711 * If the USB "suspend" state is in use (rather than "global suspend"),
1712 * many devices will be individually taken out of suspend state using
1713 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 * hardware resume signaling is finished, either because of selective
1715 * resume (by host) or remote wakeup (by device) ... now see what changed
1716 * in the tree that's rooted at this device.
1717 */
Alan Stern140d8f62006-07-01 22:07:21 -04001718static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719{
1720 int status;
1721 u16 devstatus;
1722
1723 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001724 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726 /* usb ch9 identifies four variants of SUSPENDED, based on what
1727 * state the device resumes to. Linux currently won't see the
1728 * first two on the host side; they'd be inside hub_port_init()
1729 * during many timeouts, but khubd can't suspend until later.
1730 */
1731 usb_set_device_state(udev, udev->actconfig
1732 ? USB_STATE_CONFIGURED
1733 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
1735 /* 10.5.4.5 says be sure devices in the tree are still there.
1736 * For now let's assume the device didn't go crazy on resume,
1737 * and device drivers will know about any resume quirks.
1738 */
1739 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001740 if (status >= 0)
1741 status = (status == 2 ? 0 : -ENODEV);
1742
1743 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 dev_dbg(&udev->dev,
1745 "gone after usb resume? status %d\n",
1746 status);
1747 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001749 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001750 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 status = usb_control_msg(udev,
1752 usb_sndctrlpipe(udev, 0),
1753 USB_REQ_CLEAR_FEATURE,
1754 USB_RECIP_DEVICE,
1755 USB_DEVICE_REMOTE_WAKEUP, 0,
1756 NULL, 0,
1757 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001758 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 dev_dbg(&udev->dev, "disable remote "
1760 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 status = 0;
1763
1764 } else if (udev->devnum <= 0) {
1765 dev_dbg(&udev->dev, "bogus resume!\n");
1766 status = -EINVAL;
1767 }
1768 return status;
1769}
1770
1771static int
1772hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1773{
1774 int status;
Alan Sternd25450c2006-11-20 11:14:30 -05001775 u16 portchange, portstatus;
1776
1777 /* Skip the initial Clear-Suspend step for a remote wakeup */
1778 status = hub_port_status(hub, port1, &portstatus, &portchange);
1779 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1780 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
1782 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1783
Alan Sternd5cbad42006-08-11 16:52:39 -04001784 set_bit(port1, hub->busy_bits);
1785
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 /* see 7.1.7.7; affects power usage, but not budgeting */
1787 status = clear_port_feature(hub->hdev,
1788 port1, USB_PORT_FEAT_SUSPEND);
1789 if (status) {
1790 dev_dbg(hub->intfdev,
1791 "can't resume port %d, status %d\n",
1792 port1, status);
1793 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 /* drive resume for at least 20 msec */
1795 if (udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001796 dev_dbg(&udev->dev, "usb %sresume\n",
1797 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 msleep(25);
1799
1800#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1801 | USB_PORT_STAT_ENABLE \
1802 | USB_PORT_STAT_CONNECTION)
1803
1804 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1805 * stop resume signaling. Then finish the resume
1806 * sequence.
1807 */
Alan Sternd25450c2006-11-20 11:14:30 -05001808 status = hub_port_status(hub, port1, &portstatus, &portchange);
1809SuspendCleared:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 if (status < 0
Alan Sternd25450c2006-11-20 11:14:30 -05001811 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1812 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 ) {
1814 dev_dbg(hub->intfdev,
1815 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001816 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001817 if (status >= 0)
1818 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 } else {
Alan Stern20307942006-06-28 11:20:41 -04001820 if (portchange & USB_PORT_STAT_C_SUSPEND)
1821 clear_port_feature(hub->hdev, port1,
1822 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 /* TRSMRCY = 10 msec */
1824 msleep(10);
1825 if (udev)
Alan Stern140d8f62006-07-01 22:07:21 -04001826 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 }
1828 }
1829 if (status < 0)
1830 hub_port_logical_disconnect(hub, port1);
1831
Alan Sternd5cbad42006-08-11 16:52:39 -04001832 clear_bit(port1, hub->busy_bits);
1833 if (!hub->hdev->parent && !hub->busy_bits[0])
1834 usb_enable_root_hub_irq(hub->hdev->bus);
1835
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 return status;
1837}
1838
David Brownell5edbfb72005-09-22 22:45:26 -07001839/*
Alan Stern140d8f62006-07-01 22:07:21 -04001840 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001842 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 *
1844 * This will re-activate the suspended device, increasing power usage
1845 * while letting drivers communicate again with its endpoints.
1846 * USB resume explicitly guarantees that the power session between
1847 * the host and the device is the same as it was when the device
1848 * suspended.
1849 *
1850 * Returns 0 on success, else negative errno.
1851 */
Alan Stern140d8f62006-07-01 22:07:21 -04001852int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853{
Alan Sternd388dab2006-07-01 22:14:24 -04001854 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855
Alan Stern140d8f62006-07-01 22:07:21 -04001856 /* we change the device's upstream USB link,
1857 * but root hubs have no upstream USB link.
1858 */
David Brownellf3f32532005-09-22 22:37:29 -07001859 if (udev->parent) {
Alan Stern114b3682006-07-01 22:13:04 -04001860 // NOTE this fails if parent is also suspended...
1861 status = hub_port_resume(hdev_to_hub(udev->parent),
1862 udev->portnum, udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001863 } else {
1864 dev_dbg(&udev->dev, "usb %sresume\n",
1865 udev->auto_pm ? "auto-" : "");
Alan Stern140d8f62006-07-01 22:07:21 -04001866 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001867 }
David Brownellf3f32532005-09-22 22:37:29 -07001868 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001869 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 return status;
1871}
1872
1873static int remote_wakeup(struct usb_device *udev)
1874{
1875 int status = 0;
1876
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001877 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001879 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern94fcda12006-11-20 11:38:46 -05001880 status = usb_autoresume_device(udev);
Alan Sterna8e7c562006-07-01 22:11:02 -04001881
Alan Sternd25450c2006-11-20 11:14:30 -05001882 /* Give the interface drivers a chance to do something,
1883 * then autosuspend the device again. */
1884 if (status == 0)
Alan Stern94fcda12006-11-20 11:38:46 -05001885 usb_autosuspend_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001886 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001887 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 return status;
1889}
1890
Alan Sternd388dab2006-07-01 22:14:24 -04001891#else /* CONFIG_USB_SUSPEND */
1892
1893/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1894
1895int usb_port_suspend(struct usb_device *udev)
1896{
1897 return 0;
1898}
1899
1900static inline int
1901finish_port_resume(struct usb_device *udev)
1902{
1903 return 0;
1904}
1905
1906static inline int
1907hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1908{
1909 return 0;
1910}
1911
1912int usb_port_resume(struct usb_device *udev)
1913{
1914 return 0;
1915}
1916
1917static inline int remote_wakeup(struct usb_device *udev)
1918{
1919 return 0;
1920}
1921
1922#endif
1923
David Brownelldb690872005-09-13 19:56:33 -07001924static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925{
1926 struct usb_hub *hub = usb_get_intfdata (intf);
1927 struct usb_device *hdev = hub->hdev;
1928 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
David Brownellc9f89fa2005-09-13 19:57:04 -07001930 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1932 struct usb_device *udev;
1933
1934 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001935 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001936#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001937 udev->state != USB_STATE_SUSPENDED
1938#else
1939 udev->dev.power.power_state.event
1940 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001941#endif
Alan Stern114b3682006-07-01 22:13:04 -04001942 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001943 if (!hdev->auto_pm)
1944 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1945 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001946 return -EBUSY;
1947 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 }
1949
Alan Stern40f122f2006-11-09 14:44:33 -05001950 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1951
David Brownellf3f32532005-09-22 22:37:29 -07001952 /* "global suspend" of the downstream HC-to-USB interface */
1953 if (!hdev->parent) {
1954 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001955 if (bus) {
1956 int status = hcd_bus_suspend (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001957
1958 if (status != 0) {
1959 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1960 status);
1961 return status;
1962 }
1963 } else
1964 return -EOPNOTSUPP;
1965 }
1966
David Brownellc9f89fa2005-09-13 19:57:04 -07001967 /* stop khubd and related activity */
1968 hub_quiesce(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 return 0;
1970}
1971
1972static int hub_resume(struct usb_interface *intf)
1973{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Stern40f122f2006-11-09 14:44:33 -05001975 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 int status;
1977
Alan Stern40f122f2006-11-09 14:44:33 -05001978 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1979
David Brownellf3f32532005-09-22 22:37:29 -07001980 /* "global resume" of the downstream HC-to-USB interface */
1981 if (!hdev->parent) {
1982 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001983 if (bus) {
1984 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001985 if (status) {
1986 dev_dbg(&intf->dev, "'global' resume %d\n",
1987 status);
1988 return status;
1989 }
1990 } else
1991 return -EOPNOTSUPP;
1992 if (status == 0) {
1993 /* TRSMRCY = 10 msec */
1994 msleep(10);
1995 }
1996 }
1997
Alan Sterna8e7c562006-07-01 22:11:02 -04001998 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001999 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 return 0;
2001}
2002
Alan Sternd388dab2006-07-01 22:14:24 -04002003#else /* CONFIG_PM */
2004
2005static inline int remote_wakeup(struct usb_device *udev)
2006{
2007 return 0;
2008}
2009
Andrew Morton511366d2006-08-14 23:11:02 -07002010#define hub_suspend NULL
2011#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002012#endif
2013
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014void usb_resume_root_hub(struct usb_device *hdev)
2015{
2016 struct usb_hub *hub = hdev_to_hub(hdev);
2017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 kick_khubd(hub);
2019}
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
2022/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2023 *
2024 * Between connect detection and reset signaling there must be a delay
2025 * of 100ms at least for debounce and power-settling. The corresponding
2026 * timer shall restart whenever the downstream port detects a disconnect.
2027 *
2028 * Apparently there are some bluetooth and irda-dongles and a number of
2029 * low-speed devices for which this debounce period may last over a second.
2030 * Not covered by the spec - but easy to deal with.
2031 *
2032 * This implementation uses a 1500ms total debounce timeout; if the
2033 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2034 * every 25ms for transient disconnects. When the port status has been
2035 * unchanged for 100ms it returns the port status.
2036 */
2037
2038#define HUB_DEBOUNCE_TIMEOUT 1500
2039#define HUB_DEBOUNCE_STEP 25
2040#define HUB_DEBOUNCE_STABLE 100
2041
2042static int hub_port_debounce(struct usb_hub *hub, int port1)
2043{
2044 int ret;
2045 int total_time, stable_time = 0;
2046 u16 portchange, portstatus;
2047 unsigned connection = 0xffff;
2048
2049 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2050 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2051 if (ret < 0)
2052 return ret;
2053
2054 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2055 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2056 stable_time += HUB_DEBOUNCE_STEP;
2057 if (stable_time >= HUB_DEBOUNCE_STABLE)
2058 break;
2059 } else {
2060 stable_time = 0;
2061 connection = portstatus & USB_PORT_STAT_CONNECTION;
2062 }
2063
2064 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2065 clear_port_feature(hub->hdev, port1,
2066 USB_PORT_FEAT_C_CONNECTION);
2067 }
2068
2069 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2070 break;
2071 msleep(HUB_DEBOUNCE_STEP);
2072 }
2073
2074 dev_dbg (hub->intfdev,
2075 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2076 port1, total_time, stable_time, portstatus);
2077
2078 if (stable_time < HUB_DEBOUNCE_STABLE)
2079 return -ETIMEDOUT;
2080 return portstatus;
2081}
2082
2083static void ep0_reinit(struct usb_device *udev)
2084{
2085 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2086 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2087 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2088}
2089
2090#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2091#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2092
2093static int hub_set_address(struct usb_device *udev)
2094{
2095 int retval;
2096
2097 if (udev->devnum == 0)
2098 return -EINVAL;
2099 if (udev->state == USB_STATE_ADDRESS)
2100 return 0;
2101 if (udev->state != USB_STATE_DEFAULT)
2102 return -EINVAL;
2103 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2104 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2105 NULL, 0, USB_CTRL_SET_TIMEOUT);
2106 if (retval == 0) {
2107 usb_set_device_state(udev, USB_STATE_ADDRESS);
2108 ep0_reinit(udev);
2109 }
2110 return retval;
2111}
2112
2113/* Reset device, (re)assign address, get device descriptor.
2114 * Device connection must be stable, no more debouncing needed.
2115 * Returns device in USB_STATE_ADDRESS, except on error.
2116 *
2117 * If this is called for an already-existing device (as part of
2118 * usb_reset_device), the caller must own the device lock. For a
2119 * newly detected device that is not accessible through any global
2120 * pointers, it's not necessary to lock the device.
2121 */
2122static int
2123hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2124 int retry_counter)
2125{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002126 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127
2128 struct usb_device *hdev = hub->hdev;
2129 int i, j, retval;
2130 unsigned delay = HUB_SHORT_RESET_TIME;
2131 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002132 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
2134 /* root hub ports have a slightly longer reset period
2135 * (from USB 2.0 spec, section 7.1.7.5)
2136 */
2137 if (!hdev->parent) {
2138 delay = HUB_ROOT_RESET_TIME;
2139 if (port1 == hdev->bus->otg_port)
2140 hdev->bus->b_hnp_enable = 0;
2141 }
2142
2143 /* Some low speed devices have problems with the quick delay, so */
2144 /* be a bit pessimistic with those devices. RHbug #23670 */
2145 if (oldspeed == USB_SPEED_LOW)
2146 delay = HUB_LONG_RESET_TIME;
2147
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002148 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149
2150 /* Reset the device; full speed may morph to high speed */
2151 retval = hub_port_reset(hub, port1, udev, delay);
2152 if (retval < 0) /* error or disconnect */
2153 goto fail;
2154 /* success, speed is known */
2155 retval = -ENODEV;
2156
2157 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2158 dev_dbg(&udev->dev, "device reset changed speed!\n");
2159 goto fail;
2160 }
2161 oldspeed = udev->speed;
2162
2163 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2164 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002165 * For Wireless USB devices, ep0 max packet is always 512 (tho
2166 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 */
2168 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002169 case USB_SPEED_VARIABLE: /* fixed at 512 */
2170 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2171 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 case USB_SPEED_HIGH: /* fixed at 64 */
2173 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2174 break;
2175 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2176 /* to determine the ep0 maxpacket size, try to read
2177 * the device descriptor to get bMaxPacketSize0 and
2178 * then correct our initial guess.
2179 */
2180 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2181 break;
2182 case USB_SPEED_LOW: /* fixed at 8 */
2183 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2184 break;
2185 default:
2186 goto fail;
2187 }
2188
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002189 type = "";
2190 switch (udev->speed) {
2191 case USB_SPEED_LOW: speed = "low"; break;
2192 case USB_SPEED_FULL: speed = "full"; break;
2193 case USB_SPEED_HIGH: speed = "high"; break;
2194 case USB_SPEED_VARIABLE:
2195 speed = "variable";
2196 type = "Wireless ";
2197 break;
2198 default: speed = "?"; break;
2199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002201 "%s %s speed %sUSB device using %s and address %d\n",
2202 (udev->config) ? "reset" : "new", speed, type,
2203 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204
2205 /* Set up TT records, if needed */
2206 if (hdev->tt) {
2207 udev->tt = hdev->tt;
2208 udev->ttport = hdev->ttport;
2209 } else if (udev->speed != USB_SPEED_HIGH
2210 && hdev->speed == USB_SPEED_HIGH) {
2211 udev->tt = &hub->tt;
2212 udev->ttport = port1;
2213 }
2214
2215 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2216 * Because device hardware and firmware is sometimes buggy in
2217 * this area, and this is how Linux has done it for ages.
2218 * Change it cautiously.
2219 *
2220 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2221 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2222 * so it may help with some non-standards-compliant devices.
2223 * Otherwise we start with SET_ADDRESS and then try to read the
2224 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2225 * value.
2226 */
2227 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2228 if (USE_NEW_SCHEME(retry_counter)) {
2229 struct usb_device_descriptor *buf;
2230 int r = 0;
2231
2232#define GET_DESCRIPTOR_BUFSIZE 64
2233 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2234 if (!buf) {
2235 retval = -ENOMEM;
2236 continue;
2237 }
2238
2239 /* Use a short timeout the first time through,
2240 * so that recalcitrant full-speed devices with
2241 * 8- or 16-byte ep0-maxpackets won't slow things
2242 * down tremendously by NAKing the unexpectedly
2243 * early status stage. Also, retry on all errors;
2244 * some devices are flakey.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002245 * 255 is for WUSB devices, we actually need to use 512.
2246 * WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 */
2248 for (j = 0; j < 3; ++j) {
2249 buf->bMaxPacketSize0 = 0;
2250 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2251 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2252 USB_DT_DEVICE << 8, 0,
2253 buf, GET_DESCRIPTOR_BUFSIZE,
2254 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2255 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002256 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257 if (buf->bDescriptorType ==
2258 USB_DT_DEVICE) {
2259 r = 0;
2260 break;
2261 }
2262 /* FALL THROUGH */
2263 default:
2264 if (r == 0)
2265 r = -EPROTO;
2266 break;
2267 }
2268 if (r == 0)
2269 break;
2270 }
2271 udev->descriptor.bMaxPacketSize0 =
2272 buf->bMaxPacketSize0;
2273 kfree(buf);
2274
2275 retval = hub_port_reset(hub, port1, udev, delay);
2276 if (retval < 0) /* error or disconnect */
2277 goto fail;
2278 if (oldspeed != udev->speed) {
2279 dev_dbg(&udev->dev,
2280 "device reset changed speed!\n");
2281 retval = -ENODEV;
2282 goto fail;
2283 }
2284 if (r) {
2285 dev_err(&udev->dev, "device descriptor "
2286 "read/%s, error %d\n",
2287 "64", r);
2288 retval = -EMSGSIZE;
2289 continue;
2290 }
2291#undef GET_DESCRIPTOR_BUFSIZE
2292 }
2293
2294 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2295 retval = hub_set_address(udev);
2296 if (retval >= 0)
2297 break;
2298 msleep(200);
2299 }
2300 if (retval < 0) {
2301 dev_err(&udev->dev,
2302 "device not accepting address %d, error %d\n",
2303 udev->devnum, retval);
2304 goto fail;
2305 }
2306
2307 /* cope with hardware quirkiness:
2308 * - let SET_ADDRESS settle, some device hardware wants it
2309 * - read ep0 maxpacket even for high and low speed,
2310 */
2311 msleep(10);
2312 if (USE_NEW_SCHEME(retry_counter))
2313 break;
2314
2315 retval = usb_get_device_descriptor(udev, 8);
2316 if (retval < 8) {
2317 dev_err(&udev->dev, "device descriptor "
2318 "read/%s, error %d\n",
2319 "8", retval);
2320 if (retval >= 0)
2321 retval = -EMSGSIZE;
2322 } else {
2323 retval = 0;
2324 break;
2325 }
2326 }
2327 if (retval)
2328 goto fail;
2329
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002330 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2331 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2333 if (udev->speed != USB_SPEED_FULL ||
2334 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2335 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2336 retval = -EMSGSIZE;
2337 goto fail;
2338 }
2339 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2340 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2341 ep0_reinit(udev);
2342 }
2343
2344 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2345 if (retval < (signed)sizeof(udev->descriptor)) {
2346 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2347 "all", retval);
2348 if (retval >= 0)
2349 retval = -ENOMSG;
2350 goto fail;
2351 }
2352
2353 retval = 0;
2354
2355fail:
2356 if (retval)
2357 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002358 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 return retval;
2360}
2361
2362static void
2363check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2364{
2365 struct usb_qualifier_descriptor *qual;
2366 int status;
2367
Christoph Lametere94b1762006-12-06 20:33:17 -08002368 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 if (qual == NULL)
2370 return;
2371
2372 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2373 qual, sizeof *qual);
2374 if (status == sizeof *qual) {
2375 dev_info(&udev->dev, "not running at top speed; "
2376 "connect to a high speed hub\n");
2377 /* hub LEDs are probably harder to miss than syslog */
2378 if (hub->has_indicators) {
2379 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002380 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 }
2382 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002383 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384}
2385
2386static unsigned
2387hub_power_remaining (struct usb_hub *hub)
2388{
2389 struct usb_device *hdev = hub->hdev;
2390 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002391 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392
Alan Stern55c52712005-11-23 12:03:12 -05002393 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 return 0;
2395
Alan Stern55c52712005-11-23 12:03:12 -05002396 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2397 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2398 struct usb_device *udev = hdev->children[port1 - 1];
2399 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
2401 if (!udev)
2402 continue;
2403
Alan Stern55c52712005-11-23 12:03:12 -05002404 /* Unconfigured devices may not use more than 100mA,
2405 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002407 delta = udev->actconfig->desc.bMaxPower * 2;
2408 else if (port1 != udev->bus->otg_port || hdev->parent)
2409 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 else
Alan Stern55c52712005-11-23 12:03:12 -05002411 delta = 8;
2412 if (delta > hub->mA_per_port)
2413 dev_warn(&udev->dev, "%dmA is over %umA budget "
2414 "for port %d!\n",
2415 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 remaining -= delta;
2417 }
2418 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002419 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2420 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 remaining = 0;
2422 }
2423 return remaining;
2424}
2425
2426/* Handle physical or logical connection change events.
2427 * This routine is called when:
2428 * a port connection-change occurs;
2429 * a port enable-change occurs (often caused by EMI);
2430 * usb_reset_device() encounters changed descriptors (as from
2431 * a firmware download)
2432 * caller already locked the hub
2433 */
2434static void hub_port_connect_change(struct usb_hub *hub, int port1,
2435 u16 portstatus, u16 portchange)
2436{
2437 struct usb_device *hdev = hub->hdev;
2438 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002439 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 int status, i;
2441
2442 dev_dbg (hub_dev,
2443 "port %d, status %04x, change %04x, %s\n",
2444 port1, portstatus, portchange, portspeed (portstatus));
2445
2446 if (hub->has_indicators) {
2447 set_port_led(hub, port1, HUB_LED_AUTO);
2448 hub->indicator[port1-1] = INDICATOR_AUTO;
2449 }
2450
2451 /* Disconnect any existing devices under this port */
2452 if (hdev->children[port1-1])
2453 usb_disconnect(&hdev->children[port1-1]);
2454 clear_bit(port1, hub->change_bits);
2455
2456#ifdef CONFIG_USB_OTG
2457 /* during HNP, don't repeat the debounce */
2458 if (hdev->bus->is_b_host)
2459 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2460#endif
2461
2462 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2463 status = hub_port_debounce(hub, port1);
2464 if (status < 0) {
2465 dev_err (hub_dev,
2466 "connect-debounce failed, port %d disabled\n",
2467 port1);
2468 goto done;
2469 }
2470 portstatus = status;
2471 }
2472
2473 /* Return now if nothing is connected */
2474 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2475
2476 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002477 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2479 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2480
2481 if (portstatus & USB_PORT_STAT_ENABLE)
2482 goto done;
2483 return;
2484 }
2485
2486#ifdef CONFIG_USB_SUSPEND
2487 /* If something is connected, but the port is suspended, wake it up. */
2488 if (portstatus & USB_PORT_STAT_SUSPEND) {
2489 status = hub_port_resume(hub, port1, NULL);
2490 if (status < 0) {
2491 dev_dbg(hub_dev,
2492 "can't clear suspend on port %d; %d\n",
2493 port1, status);
2494 goto done;
2495 }
2496 }
2497#endif
2498
2499 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2500 struct usb_device *udev;
2501
2502 /* reallocate for each attempt, since references
2503 * to the previous one can escape in various ways
2504 */
2505 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2506 if (!udev) {
2507 dev_err (hub_dev,
2508 "couldn't allocate port %d usb_device\n",
2509 port1);
2510 goto done;
2511 }
2512
2513 usb_set_device_state(udev, USB_STATE_POWERED);
2514 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002515 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002516 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002517
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 /* set the address */
2519 choose_address(udev);
2520 if (udev->devnum <= 0) {
2521 status = -ENOTCONN; /* Don't retry */
2522 goto loop;
2523 }
2524
2525 /* reset and get descriptor */
2526 status = hub_port_init(hub, udev, port1, i);
2527 if (status < 0)
2528 goto loop;
2529
2530 /* consecutive bus-powered hubs aren't reliable; they can
2531 * violate the voltage drop budget. if the new child has
2532 * a "powered" LED, users should notice we didn't enable it
2533 * (without reading syslog), even without per-port LEDs
2534 * on the parent.
2535 */
2536 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002537 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 u16 devstat;
2539
2540 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2541 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002542 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 dev_dbg(&udev->dev, "get status %d ?\n", status);
2544 goto loop_disable;
2545 }
Alan Stern55c52712005-11-23 12:03:12 -05002546 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2548 dev_err(&udev->dev,
2549 "can't connect bus-powered hub "
2550 "to this port\n");
2551 if (hub->has_indicators) {
2552 hub->indicator[port1-1] =
2553 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002554 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 }
2556 status = -ENOTCONN; /* Don't retry */
2557 goto loop_disable;
2558 }
2559 }
2560
2561 /* check for devices running slower than they could */
2562 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2563 && udev->speed == USB_SPEED_FULL
2564 && highspeed_hubs != 0)
2565 check_highspeed (hub, udev, port1);
2566
2567 /* Store the parent's children[] pointer. At this point
2568 * udev becomes globally accessible, although presumably
2569 * no one will look at it until hdev is unlocked.
2570 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 status = 0;
2572
2573 /* We mustn't add new devices if the parent hub has
2574 * been disconnected; we would race with the
2575 * recursively_mark_NOTATTACHED() routine.
2576 */
2577 spin_lock_irq(&device_state_lock);
2578 if (hdev->state == USB_STATE_NOTATTACHED)
2579 status = -ENOTCONN;
2580 else
2581 hdev->children[port1-1] = udev;
2582 spin_unlock_irq(&device_state_lock);
2583
2584 /* Run it through the hoops (find a driver, etc) */
2585 if (!status) {
2586 status = usb_new_device(udev);
2587 if (status) {
2588 spin_lock_irq(&device_state_lock);
2589 hdev->children[port1-1] = NULL;
2590 spin_unlock_irq(&device_state_lock);
2591 }
2592 }
2593
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 if (status)
2595 goto loop_disable;
2596
2597 status = hub_power_remaining(hub);
2598 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002599 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600
2601 return;
2602
2603loop_disable:
2604 hub_port_disable(hub, port1, 1);
2605loop:
2606 ep0_reinit(udev);
2607 release_address(udev);
2608 usb_put_dev(udev);
2609 if (status == -ENOTCONN)
2610 break;
2611 }
2612
2613done:
2614 hub_port_disable(hub, port1, 1);
2615}
2616
2617static void hub_events(void)
2618{
2619 struct list_head *tmp;
2620 struct usb_device *hdev;
2621 struct usb_interface *intf;
2622 struct usb_hub *hub;
2623 struct device *hub_dev;
2624 u16 hubstatus;
2625 u16 hubchange;
2626 u16 portstatus;
2627 u16 portchange;
2628 int i, ret;
2629 int connect_change;
2630
2631 /*
2632 * We restart the list every time to avoid a deadlock with
2633 * deleting hubs downstream from this one. This should be
2634 * safe since we delete the hub from the event list.
2635 * Not the most efficient, but avoids deadlocks.
2636 */
2637 while (1) {
2638
2639 /* Grab the first entry at the beginning of the list */
2640 spin_lock_irq(&hub_event_lock);
2641 if (list_empty(&hub_event_list)) {
2642 spin_unlock_irq(&hub_event_lock);
2643 break;
2644 }
2645
2646 tmp = hub_event_list.next;
2647 list_del_init(tmp);
2648
2649 hub = list_entry(tmp, struct usb_hub, event_list);
2650 hdev = hub->hdev;
2651 intf = to_usb_interface(hub->intfdev);
2652 hub_dev = &intf->dev;
2653
Alan Stern40f122f2006-11-09 14:44:33 -05002654 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 hdev->state, hub->descriptor
2656 ? hub->descriptor->bNbrPorts
2657 : 0,
2658 /* NOTE: expects max 15 ports... */
2659 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002660 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661
2662 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 spin_unlock_irq(&hub_event_lock);
2664
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 /* Lock the device, then check to see if we were
2666 * disconnected while waiting for the lock to succeed. */
2667 if (locktree(hdev) < 0) {
2668 usb_put_intf(intf);
2669 continue;
2670 }
2671 if (hub != usb_get_intfdata(intf))
2672 goto loop;
2673
2674 /* If the hub has died, clean up after it */
2675 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002676 hub->error = -ENODEV;
2677 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 goto loop;
2679 }
2680
Alan Stern40f122f2006-11-09 14:44:33 -05002681 /* Autoresume */
2682 ret = usb_autopm_get_interface(intf);
2683 if (ret) {
2684 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002686 }
2687
2688 /* If this is an inactive hub, do nothing */
2689 if (hub->quiescing)
2690 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691
2692 if (hub->error) {
2693 dev_dbg (hub_dev, "resetting for error %d\n",
2694 hub->error);
2695
Alan Stern7de18d82006-06-01 13:37:24 -04002696 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 if (ret) {
2698 dev_dbg (hub_dev,
2699 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002700 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 }
2702
2703 hub->nerrors = 0;
2704 hub->error = 0;
2705 }
2706
2707 /* deal with port status changes */
2708 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2709 if (test_bit(i, hub->busy_bits))
2710 continue;
2711 connect_change = test_bit(i, hub->change_bits);
2712 if (!test_and_clear_bit(i, hub->event_bits) &&
2713 !connect_change && !hub->activating)
2714 continue;
2715
2716 ret = hub_port_status(hub, i,
2717 &portstatus, &portchange);
2718 if (ret < 0)
2719 continue;
2720
2721 if (hub->activating && !hdev->children[i-1] &&
2722 (portstatus &
2723 USB_PORT_STAT_CONNECTION))
2724 connect_change = 1;
2725
2726 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2727 clear_port_feature(hdev, i,
2728 USB_PORT_FEAT_C_CONNECTION);
2729 connect_change = 1;
2730 }
2731
2732 if (portchange & USB_PORT_STAT_C_ENABLE) {
2733 if (!connect_change)
2734 dev_dbg (hub_dev,
2735 "port %d enable change, "
2736 "status %08x\n",
2737 i, portstatus);
2738 clear_port_feature(hdev, i,
2739 USB_PORT_FEAT_C_ENABLE);
2740
2741 /*
2742 * EM interference sometimes causes badly
2743 * shielded USB devices to be shutdown by
2744 * the hub, this hack enables them again.
2745 * Works at least with mouse driver.
2746 */
2747 if (!(portstatus & USB_PORT_STAT_ENABLE)
2748 && !connect_change
2749 && hdev->children[i-1]) {
2750 dev_err (hub_dev,
2751 "port %i "
2752 "disabled by hub (EMI?), "
2753 "re-enabling...\n",
2754 i);
2755 connect_change = 1;
2756 }
2757 }
2758
2759 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2760 clear_port_feature(hdev, i,
2761 USB_PORT_FEAT_C_SUSPEND);
2762 if (hdev->children[i-1]) {
2763 ret = remote_wakeup(hdev->
2764 children[i-1]);
2765 if (ret < 0)
2766 connect_change = 1;
2767 } else {
2768 ret = -ENODEV;
2769 hub_port_disable(hub, i, 1);
2770 }
2771 dev_dbg (hub_dev,
2772 "resume on port %d, status %d\n",
2773 i, ret);
2774 }
2775
2776 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2777 dev_err (hub_dev,
2778 "over-current change on port %d\n",
2779 i);
2780 clear_port_feature(hdev, i,
2781 USB_PORT_FEAT_C_OVER_CURRENT);
2782 hub_power_on(hub);
2783 }
2784
2785 if (portchange & USB_PORT_STAT_C_RESET) {
2786 dev_dbg (hub_dev,
2787 "reset change on port %d\n",
2788 i);
2789 clear_port_feature(hdev, i,
2790 USB_PORT_FEAT_C_RESET);
2791 }
2792
2793 if (connect_change)
2794 hub_port_connect_change(hub, i,
2795 portstatus, portchange);
2796 } /* end for i */
2797
2798 /* deal with hub status changes */
2799 if (test_and_clear_bit(0, hub->event_bits) == 0)
2800 ; /* do nothing */
2801 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2802 dev_err (hub_dev, "get_hub_status failed\n");
2803 else {
2804 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2805 dev_dbg (hub_dev, "power change\n");
2806 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002807 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2808 /* FIXME: Is this always true? */
2809 hub->limited_power = 0;
2810 else
2811 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 }
2813 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2814 dev_dbg (hub_dev, "overcurrent change\n");
2815 msleep(500); /* Cool down */
2816 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2817 hub_power_on(hub);
2818 }
2819 }
2820
2821 hub->activating = 0;
2822
Alan Sternd5926ae72005-04-21 15:56:37 -04002823 /* If this is a root hub, tell the HCD it's okay to
2824 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002825 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002826 usb_enable_root_hub_irq(hdev->bus);
2827
Alan Stern40f122f2006-11-09 14:44:33 -05002828loop_autopm:
2829 /* Allow autosuspend if we're not going to run again */
2830 if (list_empty(&hub->event_list))
2831 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832loop:
2833 usb_unlock_device(hdev);
2834 usb_put_intf(intf);
2835
2836 } /* end while (1) */
2837}
2838
2839static int hub_thread(void *__unused)
2840{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841 do {
2842 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002843 wait_event_interruptible(khubd_wait,
2844 !list_empty(&hub_event_list) ||
2845 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002846 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002847 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002849 pr_debug("%s: khubd exiting\n", usbcore_name);
2850 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851}
2852
2853static struct usb_device_id hub_id_table [] = {
2854 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2855 .bDeviceClass = USB_CLASS_HUB},
2856 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2857 .bInterfaceClass = USB_CLASS_HUB},
2858 { } /* Terminating entry */
2859};
2860
2861MODULE_DEVICE_TABLE (usb, hub_id_table);
2862
2863static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864 .name = "hub",
2865 .probe = hub_probe,
2866 .disconnect = hub_disconnect,
2867 .suspend = hub_suspend,
2868 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002869 .pre_reset = hub_pre_reset,
2870 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 .ioctl = hub_ioctl,
2872 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002873 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874};
2875
2876int usb_hub_init(void)
2877{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 if (usb_register(&hub_driver) < 0) {
2879 printk(KERN_ERR "%s: can't register hub driver\n",
2880 usbcore_name);
2881 return -1;
2882 }
2883
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002884 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2885 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887
2888 /* Fall through if kernel_thread failed */
2889 usb_deregister(&hub_driver);
2890 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2891
2892 return -1;
2893}
2894
2895void usb_hub_cleanup(void)
2896{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002897 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898
2899 /*
2900 * Hub resources are freed for us by usb_deregister. It calls
2901 * usb_driver_purge on every device which in turn calls that
2902 * devices disconnect function if it is using this driver.
2903 * The hub_disconnect function takes care of releasing the
2904 * individual hub resources. -greg
2905 */
2906 usb_deregister(&hub_driver);
2907} /* usb_hub_cleanup() */
2908
Linus Torvalds1da177e2005-04-16 15:20:36 -07002909static int config_descriptors_changed(struct usb_device *udev)
2910{
2911 unsigned index;
2912 unsigned len = 0;
2913 struct usb_config_descriptor *buf;
2914
2915 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2916 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2917 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2918 }
Christoph Lametere94b1762006-12-06 20:33:17 -08002919 buf = kmalloc (len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920 if (buf == NULL) {
2921 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2922 /* assume the worst */
2923 return 1;
2924 }
2925 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2926 int length;
2927 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2928
2929 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2930 old_length);
2931 if (length < old_length) {
2932 dev_dbg(&udev->dev, "config index %d, error %d\n",
2933 index, length);
2934 break;
2935 }
2936 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2937 != 0) {
2938 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2939 index, buf->bConfigurationValue);
2940 break;
2941 }
2942 }
2943 kfree(buf);
2944 return index != udev->descriptor.bNumConfigurations;
2945}
2946
2947/**
2948 * usb_reset_device - perform a USB port reset to reinitialize a device
2949 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2950 *
Alan Stern79efa092006-06-01 13:33:42 -04002951 * WARNING - don't use this routine to reset a composite device
2952 * (one with multiple interfaces owned by separate drivers)!
2953 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954 *
2955 * Do a port reset, reassign the device's address, and establish its
2956 * former operating configuration. If the reset fails, or the device's
2957 * descriptors change from their values before the reset, or the original
2958 * configuration and altsettings cannot be restored, a flag will be set
2959 * telling khubd to pretend the device has been disconnected and then
2960 * re-connected. All drivers will be unbound, and the device will be
2961 * re-enumerated and probed all over again.
2962 *
2963 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2964 * flagged for logical disconnection, or some other negative error code
2965 * if the reset wasn't even attempted.
2966 *
2967 * The caller must own the device lock. For example, it's safe to use
2968 * this from a driver probe() routine after downloading new firmware.
2969 * For calls that might not occur during probe(), drivers should lock
2970 * the device using usb_lock_device_for_reset().
2971 */
2972int usb_reset_device(struct usb_device *udev)
2973{
2974 struct usb_device *parent_hdev = udev->parent;
2975 struct usb_hub *parent_hub;
2976 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002977 int i, ret = 0;
2978 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979
2980 if (udev->state == USB_STATE_NOTATTACHED ||
2981 udev->state == USB_STATE_SUSPENDED) {
2982 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2983 udev->state);
2984 return -EINVAL;
2985 }
2986
2987 if (!parent_hdev) {
2988 /* this requires hcd-specific logic; see OHCI hc_restart() */
2989 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2990 return -EISDIR;
2991 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002992 parent_hub = hdev_to_hub(parent_hdev);
2993
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 set_bit(port1, parent_hub->busy_bits);
2995 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2996
2997 /* ep0 maxpacket size may change; let the HCD know about it.
2998 * Other endpoints will be handled by re-enumeration. */
2999 ep0_reinit(udev);
3000 ret = hub_port_init(parent_hub, udev, port1, i);
3001 if (ret >= 0)
3002 break;
3003 }
3004 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003005 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3006 usb_enable_root_hub_irq(parent_hdev->bus);
3007
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008 if (ret < 0)
3009 goto re_enumerate;
3010
3011 /* Device might have changed firmware (DFU or similar) */
3012 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3013 || config_descriptors_changed (udev)) {
3014 dev_info(&udev->dev, "device firmware changed\n");
3015 udev->descriptor = descriptor; /* for disconnect() calls */
3016 goto re_enumerate;
3017 }
3018
3019 if (!udev->actconfig)
3020 goto done;
3021
3022 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3023 USB_REQ_SET_CONFIGURATION, 0,
3024 udev->actconfig->desc.bConfigurationValue, 0,
3025 NULL, 0, USB_CTRL_SET_TIMEOUT);
3026 if (ret < 0) {
3027 dev_err(&udev->dev,
3028 "can't restore configuration #%d (error=%d)\n",
3029 udev->actconfig->desc.bConfigurationValue, ret);
3030 goto re_enumerate;
3031 }
3032 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3033
3034 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3035 struct usb_interface *intf = udev->actconfig->interface[i];
3036 struct usb_interface_descriptor *desc;
3037
3038 /* set_interface resets host side toggle even
3039 * for altsetting zero. the interface may have no driver.
3040 */
3041 desc = &intf->cur_altsetting->desc;
3042 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3043 desc->bAlternateSetting);
3044 if (ret < 0) {
3045 dev_err(&udev->dev, "failed to restore interface %d "
3046 "altsetting %d (error=%d)\n",
3047 desc->bInterfaceNumber,
3048 desc->bAlternateSetting,
3049 ret);
3050 goto re_enumerate;
3051 }
3052 }
3053
3054done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 return 0;
3056
3057re_enumerate:
3058 hub_port_logical_disconnect(parent_hub, port1);
3059 return -ENODEV;
3060}
Alan Stern140d8f62006-07-01 22:07:21 -04003061EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003062
3063/**
3064 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3065 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3066 * @iface: interface bound to the driver making the request (optional)
3067 *
3068 * Warns all drivers bound to registered interfaces (using their pre_reset
3069 * method), performs the port reset, and then lets the drivers know that
3070 * the reset is over (using their post_reset method).
3071 *
3072 * Return value is the same as for usb_reset_device().
3073 *
3074 * The caller must own the device lock. For example, it's safe to use
3075 * this from a driver probe() routine after downloading new firmware.
3076 * For calls that might not occur during probe(), drivers should lock
3077 * the device using usb_lock_device_for_reset().
3078 *
3079 * The interface locks are acquired during the pre_reset stage and released
3080 * during the post_reset stage. However if iface is not NULL and is
3081 * currently being probed, we assume that the caller already owns its
3082 * lock.
3083 */
3084int usb_reset_composite_device(struct usb_device *udev,
3085 struct usb_interface *iface)
3086{
3087 int ret;
3088 struct usb_host_config *config = udev->actconfig;
3089
3090 if (udev->state == USB_STATE_NOTATTACHED ||
3091 udev->state == USB_STATE_SUSPENDED) {
3092 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3093 udev->state);
3094 return -EINVAL;
3095 }
3096
Alan Stern645daaa2006-08-30 15:47:02 -04003097 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003098 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003099
Alan Stern79efa092006-06-01 13:33:42 -04003100 if (iface && iface->condition != USB_INTERFACE_BINDING)
3101 iface = NULL;
3102
3103 if (config) {
3104 int i;
3105 struct usb_interface *cintf;
3106 struct usb_driver *drv;
3107
3108 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3109 cintf = config->interface[i];
3110 if (cintf != iface)
3111 down(&cintf->dev.sem);
3112 if (device_is_registered(&cintf->dev) &&
3113 cintf->dev.driver) {
3114 drv = to_usb_driver(cintf->dev.driver);
3115 if (drv->pre_reset)
3116 (drv->pre_reset)(cintf);
3117 }
3118 }
3119 }
3120
3121 ret = usb_reset_device(udev);
3122
3123 if (config) {
3124 int i;
3125 struct usb_interface *cintf;
3126 struct usb_driver *drv;
3127
3128 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3129 cintf = config->interface[i];
3130 if (device_is_registered(&cintf->dev) &&
3131 cintf->dev.driver) {
3132 drv = to_usb_driver(cintf->dev.driver);
3133 if (drv->post_reset)
3134 (drv->post_reset)(cintf);
3135 }
3136 if (cintf != iface)
3137 up(&cintf->dev.sem);
3138 }
3139 }
3140
Alan Stern94fcda12006-11-20 11:38:46 -05003141 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003142 return ret;
3143}
Alan Stern140d8f62006-07-01 22:07:21 -04003144EXPORT_SYMBOL(usb_reset_composite_device);