blob: 24f10a19dbdbc1bbbf6befd31da7018078cfa186 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/ioctl.h>
20#include <linux/usb.h>
21#include <linux/usbdevice_fs.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070022#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010023#include <linux/mutex.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080024#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <asm/semaphore.h>
27#include <asm/uaccess.h>
28#include <asm/byteorder.h>
29
30#include "usb.h"
31#include "hcd.h"
32#include "hub.h"
33
Alan Stern1bb5f662006-11-06 11:56:13 -050034struct usb_hub {
35 struct device *intfdev; /* the "interface" device */
36 struct usb_device *hdev;
37 struct urb *urb; /* for interrupt polling pipe */
38
39 /* buffer for urb ... with extra space in case of babble */
40 char (*buffer)[8];
41 dma_addr_t buffer_dma; /* DMA address for buffer */
42 union {
43 struct usb_hub_status hub;
44 struct usb_port_status port;
45 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050046 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050047
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
90/* cycle leds on hubs that aren't blinking for attention */
91static int blinkenlights = 0;
92module_param (blinkenlights, bool, S_IRUGO);
93MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
94
95/*
96 * As of 2.6.10 we introduce a new USB device initialization scheme which
97 * closely resembles the way Windows works. Hopefully it will be compatible
98 * with a wider range of devices than the old scheme. However some previously
99 * working devices may start giving rise to "device not accepting address"
100 * errors; if that happens the user can try the old scheme by adjusting the
101 * following module parameters.
102 *
103 * For maximum flexibility there are two boolean parameters to control the
104 * hub driver's behavior. On the first initialization attempt, if the
105 * "old_scheme_first" parameter is set then the old scheme will be used,
106 * otherwise the new scheme is used. If that fails and "use_both_schemes"
107 * is set, then the driver will make another attempt, using the other scheme.
108 */
109static int old_scheme_first = 0;
110module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
111MODULE_PARM_DESC(old_scheme_first,
112 "start with the old device initialization scheme");
113
114static int use_both_schemes = 1;
115module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
116MODULE_PARM_DESC(use_both_schemes,
117 "try the other device initialization scheme if the "
118 "first one fails");
119
120
Dan Williams404d5b12007-04-26 00:12:10 -0700121static inline char *portspeed(int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
123 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
124 return "480 Mb/s";
125 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
126 return "1.5 Mb/s";
127 else
128 return "12 Mb/s";
129}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131/* Note that hdev or one of its children must be locked! */
132static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
133{
134 return usb_get_intfdata(hdev->actconfig->interface[0]);
135}
136
137/* USB 2.0 spec Section 11.24.4.5 */
138static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
139{
140 int i, ret;
141
142 for (i = 0; i < 3; i++) {
143 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
144 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
145 USB_DT_HUB << 8, 0, data, size,
146 USB_CTRL_GET_TIMEOUT);
147 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
148 return ret;
149 }
150 return -EINVAL;
151}
152
153/*
154 * USB 2.0 spec Section 11.24.2.1
155 */
156static int clear_hub_feature(struct usb_device *hdev, int feature)
157{
158 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
159 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
160}
161
162/*
163 * USB 2.0 spec Section 11.24.2.2
164 */
165static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
166{
167 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
168 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
169 NULL, 0, 1000);
170}
171
172/*
173 * USB 2.0 spec Section 11.24.2.13
174 */
175static int set_port_feature(struct usb_device *hdev, int port1, int feature)
176{
177 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
178 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
179 NULL, 0, 1000);
180}
181
182/*
183 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
184 * for info about using port indicators
185 */
186static void set_port_led(
187 struct usb_hub *hub,
188 int port1,
189 int selector
190)
191{
192 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
193 USB_PORT_FEAT_INDICATOR);
194 if (status < 0)
195 dev_dbg (hub->intfdev,
196 "port %d indicator %s status %d\n",
197 port1,
198 ({ char *s; switch (selector) {
199 case HUB_LED_AMBER: s = "amber"; break;
200 case HUB_LED_GREEN: s = "green"; break;
201 case HUB_LED_OFF: s = "off"; break;
202 case HUB_LED_AUTO: s = "auto"; break;
203 default: s = "??"; break;
204 }; s; }),
205 status);
206}
207
208#define LED_CYCLE_PERIOD ((2*HZ)/3)
209
David Howellsc4028952006-11-22 14:57:56 +0000210static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211{
David Howellsc4028952006-11-22 14:57:56 +0000212 struct usb_hub *hub =
213 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 struct usb_device *hdev = hub->hdev;
215 unsigned i;
216 unsigned changed = 0;
217 int cursor = -1;
218
219 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
220 return;
221
222 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
223 unsigned selector, mode;
224
225 /* 30%-50% duty cycle */
226
227 switch (hub->indicator[i]) {
228 /* cycle marker */
229 case INDICATOR_CYCLE:
230 cursor = i;
231 selector = HUB_LED_AUTO;
232 mode = INDICATOR_AUTO;
233 break;
234 /* blinking green = sw attention */
235 case INDICATOR_GREEN_BLINK:
236 selector = HUB_LED_GREEN;
237 mode = INDICATOR_GREEN_BLINK_OFF;
238 break;
239 case INDICATOR_GREEN_BLINK_OFF:
240 selector = HUB_LED_OFF;
241 mode = INDICATOR_GREEN_BLINK;
242 break;
243 /* blinking amber = hw attention */
244 case INDICATOR_AMBER_BLINK:
245 selector = HUB_LED_AMBER;
246 mode = INDICATOR_AMBER_BLINK_OFF;
247 break;
248 case INDICATOR_AMBER_BLINK_OFF:
249 selector = HUB_LED_OFF;
250 mode = INDICATOR_AMBER_BLINK;
251 break;
252 /* blink green/amber = reserved */
253 case INDICATOR_ALT_BLINK:
254 selector = HUB_LED_GREEN;
255 mode = INDICATOR_ALT_BLINK_OFF;
256 break;
257 case INDICATOR_ALT_BLINK_OFF:
258 selector = HUB_LED_AMBER;
259 mode = INDICATOR_ALT_BLINK;
260 break;
261 default:
262 continue;
263 }
264 if (selector != HUB_LED_AUTO)
265 changed = 1;
266 set_port_led(hub, i + 1, selector);
267 hub->indicator[i] = mode;
268 }
269 if (!changed && blinkenlights) {
270 cursor++;
271 cursor %= hub->descriptor->bNbrPorts;
272 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
273 hub->indicator[cursor] = INDICATOR_CYCLE;
274 changed++;
275 }
276 if (changed)
277 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
278}
279
280/* use a short timeout for hub/port status fetches */
281#define USB_STS_TIMEOUT 1000
282#define USB_STS_RETRIES 5
283
284/*
285 * USB 2.0 spec Section 11.24.2.6
286 */
287static int get_hub_status(struct usb_device *hdev,
288 struct usb_hub_status *data)
289{
290 int i, status = -ETIMEDOUT;
291
292 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
293 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
294 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
295 data, sizeof(*data), USB_STS_TIMEOUT);
296 }
297 return status;
298}
299
300/*
301 * USB 2.0 spec Section 11.24.2.7
302 */
303static int get_port_status(struct usb_device *hdev, int port1,
304 struct usb_port_status *data)
305{
306 int i, status = -ETIMEDOUT;
307
308 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
309 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
310 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
311 data, sizeof(*data), USB_STS_TIMEOUT);
312 }
313 return status;
314}
315
316static void kick_khubd(struct usb_hub *hub)
317{
318 unsigned long flags;
319
Alan Stern40f122f2006-11-09 14:44:33 -0500320 /* Suppress autosuspend until khubd runs */
321 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 spin_lock_irqsave(&hub_event_lock, flags);
324 if (list_empty(&hub->event_list)) {
325 list_add_tail(&hub->event_list, &hub_event_list);
326 wake_up(&khubd_wait);
327 }
328 spin_unlock_irqrestore(&hub_event_lock, flags);
329}
330
331void usb_kick_khubd(struct usb_device *hdev)
332{
333 kick_khubd(hdev_to_hub(hdev));
334}
335
336
337/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100338static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200340 struct usb_hub *hub = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 int status;
342 int i;
343 unsigned long bits;
344
345 switch (urb->status) {
346 case -ENOENT: /* synchronous unlink */
347 case -ECONNRESET: /* async unlink */
348 case -ESHUTDOWN: /* hardware going away */
349 return;
350
351 default: /* presumably an error */
352 /* Cause a hub reset after 10 consecutive errors */
353 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
354 if ((++hub->nerrors < 10) || hub->error)
355 goto resubmit;
356 hub->error = urb->status;
357 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 /* let khubd handle things */
360 case 0: /* we got data: port status changed */
361 bits = 0;
362 for (i = 0; i < urb->actual_length; ++i)
363 bits |= ((unsigned long) ((*hub->buffer)[i]))
364 << (i*8);
365 hub->event_bits[0] = bits;
366 break;
367 }
368
369 hub->nerrors = 0;
370
371 /* Something happened, let khubd figure it out */
372 kick_khubd(hub);
373
374resubmit:
375 if (hub->quiescing)
376 return;
377
378 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
379 && status != -ENODEV && status != -EPERM)
380 dev_err (hub->intfdev, "resubmit --> %d\n", status);
381}
382
383/* USB 2.0 spec Section 11.24.2.3 */
384static inline int
385hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
386{
387 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
388 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
389 tt, NULL, 0, 1000);
390}
391
392/*
393 * enumeration blocks khubd for a long time. we use keventd instead, since
394 * long blocking there is the exception, not the rule. accordingly, HCDs
395 * talking to TTs must queue control transfers (not just bulk and iso), so
396 * both can talk to the same hub concurrently.
397 */
David Howellsc4028952006-11-22 14:57:56 +0000398static void hub_tt_kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
David Howellsc4028952006-11-22 14:57:56 +0000400 struct usb_hub *hub =
401 container_of(work, struct usb_hub, tt.kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 unsigned long flags;
403
404 spin_lock_irqsave (&hub->tt.lock, flags);
405 while (!list_empty (&hub->tt.clear_list)) {
406 struct list_head *temp;
407 struct usb_tt_clear *clear;
408 struct usb_device *hdev = hub->hdev;
409 int status;
410
411 temp = hub->tt.clear_list.next;
412 clear = list_entry (temp, struct usb_tt_clear, clear_list);
413 list_del (&clear->clear_list);
414
415 /* drop lock so HCD can concurrently report other TT errors */
416 spin_unlock_irqrestore (&hub->tt.lock, flags);
417 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
418 spin_lock_irqsave (&hub->tt.lock, flags);
419
420 if (status)
421 dev_err (&hdev->dev,
422 "clear tt %d (%04x) error %d\n",
423 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700424 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
426 spin_unlock_irqrestore (&hub->tt.lock, flags);
427}
428
429/**
430 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
431 * @udev: the device whose split transaction failed
432 * @pipe: identifies the endpoint of the failed transaction
433 *
434 * High speed HCDs use this to tell the hub driver that some split control or
435 * bulk transaction failed in a way that requires clearing internal state of
436 * a transaction translator. This is normally detected (and reported) from
437 * interrupt context.
438 *
439 * It may not be possible for that hub to handle additional full (or low)
440 * speed transactions until that state is fully cleared out.
441 */
442void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
443{
444 struct usb_tt *tt = udev->tt;
445 unsigned long flags;
446 struct usb_tt_clear *clear;
447
448 /* we've got to cope with an arbitrary number of pending TT clears,
449 * since each TT has "at least two" buffers that can need it (and
450 * there can be many TTs per hub). even if they're uncommon.
451 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800452 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
454 /* FIXME recover somehow ... RESET_TT? */
455 return;
456 }
457
458 /* info that CLEAR_TT_BUFFER needs */
459 clear->tt = tt->multi ? udev->ttport : 1;
460 clear->devinfo = usb_pipeendpoint (pipe);
461 clear->devinfo |= udev->devnum << 4;
462 clear->devinfo |= usb_pipecontrol (pipe)
463 ? (USB_ENDPOINT_XFER_CONTROL << 11)
464 : (USB_ENDPOINT_XFER_BULK << 11);
465 if (usb_pipein (pipe))
466 clear->devinfo |= 1 << 15;
467
468 /* tell keventd to clear state for this TT */
469 spin_lock_irqsave (&tt->lock, flags);
470 list_add_tail (&clear->clear_list, &tt->clear_list);
471 schedule_work (&tt->kevent);
472 spin_unlock_irqrestore (&tt->lock, flags);
473}
474
475static void hub_power_on(struct usb_hub *hub)
476{
477 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700478 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400479 u16 wHubCharacteristics =
480 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Alan Stern4489a572006-04-27 15:54:22 -0400482 /* Enable power on each port. Some hubs have reserved values
483 * of LPSM (> 2) in their descriptors, even though they are
484 * USB 2.0 hubs. Some hubs do not implement port-power switching
485 * but only emulate it. In all cases, the ports won't work
486 * unless we send these messages to the hub.
487 */
488 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400490 else
491 dev_dbg(hub->intfdev, "trying to enable port power on "
492 "non-switchable hub\n");
493 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
494 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
David Brownellb7896962005-08-31 10:41:44 -0700496 /* Wait at least 100 msec for power to become stable */
497 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498}
499
Alan Stern02c399e2006-08-30 15:47:11 -0400500static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501{
David Brownell979d5192005-09-22 22:32:24 -0700502 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700504 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700505
David Brownell979d5192005-09-22 22:32:24 -0700506 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 usb_kill_urb(hub->urb);
508 if (hub->has_indicators)
509 cancel_delayed_work(&hub->leds);
510 if (hub->has_indicators || hub->tt.hub)
511 flush_scheduled_work();
512}
513
514static void hub_activate(struct usb_hub *hub)
515{
516 int status;
517
518 hub->quiescing = 0;
519 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 status = usb_submit_urb(hub->urb, GFP_NOIO);
522 if (status < 0)
523 dev_err(hub->intfdev, "activate --> %d\n", status);
524 if (hub->has_indicators && blinkenlights)
525 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
526
527 /* scan all ports ASAP */
528 kick_khubd(hub);
529}
530
531static int hub_hub_status(struct usb_hub *hub,
532 u16 *status, u16 *change)
533{
534 int ret;
535
Alan Sterndb90e7a2007-02-05 09:56:15 -0500536 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 ret = get_hub_status(hub->hdev, &hub->status->hub);
538 if (ret < 0)
539 dev_err (hub->intfdev,
540 "%s failed (err = %d)\n", __FUNCTION__, ret);
541 else {
542 *status = le16_to_cpu(hub->status->hub.wHubStatus);
543 *change = le16_to_cpu(hub->status->hub.wHubChange);
544 ret = 0;
545 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500546 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 return ret;
548}
549
Alan Stern8b28c752005-08-10 17:04:13 -0400550static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
551{
552 struct usb_device *hdev = hub->hdev;
553 int ret;
554
555 if (hdev->children[port1-1] && set_state) {
556 usb_set_device_state(hdev->children[port1-1],
557 USB_STATE_NOTATTACHED);
558 }
559 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
560 if (ret)
561 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
562 port1, ret);
563
564 return ret;
565}
566
Alan Stern7d069b72005-11-18 12:06:34 -0500567
568/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400569static void hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500570{
Alan Stern7de18d82006-06-01 13:37:24 -0400571 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Stern7d069b72005-11-18 12:06:34 -0500572 struct usb_device *hdev = hub->hdev;
573 int port1;
574
575 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
576 if (hdev->children[port1 - 1]) {
577 usb_disconnect(&hdev->children[port1 - 1]);
Alan Stern7de18d82006-06-01 13:37:24 -0400578 if (hub->error == 0)
Alan Stern7d069b72005-11-18 12:06:34 -0500579 hub_port_disable(hub, port1, 0);
580 }
581 }
582 hub_quiesce(hub);
583}
584
585/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400586static void hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500587{
Alan Stern7de18d82006-06-01 13:37:24 -0400588 struct usb_hub *hub = usb_get_intfdata(intf);
589
Alan Stern7d069b72005-11-18 12:06:34 -0500590 hub_activate(hub);
591 hub_power_on(hub);
592}
593
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595static int hub_configure(struct usb_hub *hub,
596 struct usb_endpoint_descriptor *endpoint)
597{
598 struct usb_device *hdev = hub->hdev;
599 struct device *hub_dev = hub->intfdev;
600 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700601 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 unsigned int pipe;
603 int maxp, ret;
604 char *message;
605
606 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
607 &hub->buffer_dma);
608 if (!hub->buffer) {
609 message = "can't allocate hub irq buffer";
610 ret = -ENOMEM;
611 goto fail;
612 }
613
614 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
615 if (!hub->status) {
616 message = "can't kmalloc hub status buffer";
617 ret = -ENOMEM;
618 goto fail;
619 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500620 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
622 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
623 if (!hub->descriptor) {
624 message = "can't kmalloc hub descriptor";
625 ret = -ENOMEM;
626 goto fail;
627 }
628
629 /* Request the entire hub descriptor.
630 * hub->descriptor can handle USB_MAXCHILDREN ports,
631 * but the hub can/will return fewer bytes here.
632 */
633 ret = get_hub_descriptor(hdev, hub->descriptor,
634 sizeof(*hub->descriptor));
635 if (ret < 0) {
636 message = "can't read hub descriptor";
637 goto fail;
638 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
639 message = "hub has too many ports!";
640 ret = -ENODEV;
641 goto fail;
642 }
643
644 hdev->maxchild = hub->descriptor->bNbrPorts;
645 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
646 (hdev->maxchild == 1) ? "" : "s");
647
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700648 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700650 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 int i;
652 char portstr [USB_MAXCHILDREN + 1];
653
654 for (i = 0; i < hdev->maxchild; i++)
655 portstr[i] = hub->descriptor->DeviceRemovable
656 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
657 ? 'F' : 'R';
658 portstr[hdev->maxchild] = 0;
659 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
660 } else
661 dev_dbg(hub_dev, "standalone hub\n");
662
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700663 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 case 0x00:
665 dev_dbg(hub_dev, "ganged power switching\n");
666 break;
667 case 0x01:
668 dev_dbg(hub_dev, "individual port power switching\n");
669 break;
670 case 0x02:
671 case 0x03:
672 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
673 break;
674 }
675
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700676 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 case 0x00:
678 dev_dbg(hub_dev, "global over-current protection\n");
679 break;
680 case 0x08:
681 dev_dbg(hub_dev, "individual port over-current protection\n");
682 break;
683 case 0x10:
684 case 0x18:
685 dev_dbg(hub_dev, "no over-current protection\n");
686 break;
687 }
688
689 spin_lock_init (&hub->tt.lock);
690 INIT_LIST_HEAD (&hub->tt.clear_list);
David Howellsc4028952006-11-22 14:57:56 +0000691 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 switch (hdev->descriptor.bDeviceProtocol) {
693 case 0:
694 break;
695 case 1:
696 dev_dbg(hub_dev, "Single TT\n");
697 hub->tt.hub = hdev;
698 break;
699 case 2:
700 ret = usb_set_interface(hdev, 0, 1);
701 if (ret == 0) {
702 dev_dbg(hub_dev, "TT per port\n");
703 hub->tt.multi = 1;
704 } else
705 dev_err(hub_dev, "Using single TT (err %d)\n",
706 ret);
707 hub->tt.hub = hdev;
708 break;
709 default:
710 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
711 hdev->descriptor.bDeviceProtocol);
712 break;
713 }
714
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700715 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700716 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700717 case HUB_TTTT_8_BITS:
718 if (hdev->descriptor.bDeviceProtocol != 0) {
719 hub->tt.think_time = 666;
720 dev_dbg(hub_dev, "TT requires at most %d "
721 "FS bit times (%d ns)\n",
722 8, hub->tt.think_time);
723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700725 case HUB_TTTT_16_BITS:
726 hub->tt.think_time = 666 * 2;
727 dev_dbg(hub_dev, "TT requires at most %d "
728 "FS bit times (%d ns)\n",
729 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700731 case HUB_TTTT_24_BITS:
732 hub->tt.think_time = 666 * 3;
733 dev_dbg(hub_dev, "TT requires at most %d "
734 "FS bit times (%d ns)\n",
735 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700737 case HUB_TTTT_32_BITS:
738 hub->tt.think_time = 666 * 4;
739 dev_dbg(hub_dev, "TT requires at most %d "
740 "FS bit times (%d ns)\n",
741 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 break;
743 }
744
745 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700746 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 hub->has_indicators = 1;
748 dev_dbg(hub_dev, "Port indicators are supported\n");
749 }
750
751 dev_dbg(hub_dev, "power on to power good time: %dms\n",
752 hub->descriptor->bPwrOn2PwrGood * 2);
753
754 /* power budgeting mostly matters with bus-powered hubs,
755 * and battery-powered root hubs (may provide just 8 mA).
756 */
757 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500758 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 message = "can't get hub status";
760 goto fail;
761 }
Alan Stern7d35b922005-04-25 11:18:32 -0400762 le16_to_cpus(&hubstatus);
763 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500764 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
765 hub->mA_per_port = 500;
766 else {
767 hub->mA_per_port = hdev->bus_mA;
768 hub->limited_power = 1;
769 }
Alan Stern7d35b922005-04-25 11:18:32 -0400770 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
772 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500773 hub->limited_power = 1;
774 if (hdev->maxchild > 0) {
775 int remaining = hdev->bus_mA -
776 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Alan Stern55c52712005-11-23 12:03:12 -0500778 if (remaining < hdev->maxchild * 100)
779 dev_warn(hub_dev,
780 "insufficient power available "
781 "to use all downstream ports\n");
782 hub->mA_per_port = 100; /* 7.2.1.1 */
783 }
784 } else { /* Self-powered external hub */
785 /* FIXME: What about battery-powered external hubs that
786 * provide less current per port? */
787 hub->mA_per_port = 500;
788 }
789 if (hub->mA_per_port < 500)
790 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
791 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793 ret = hub_hub_status(hub, &hubstatus, &hubchange);
794 if (ret < 0) {
795 message = "can't get hub status";
796 goto fail;
797 }
798
799 /* local power status reports aren't always correct */
800 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
801 dev_dbg(hub_dev, "local power source is %s\n",
802 (hubstatus & HUB_STATUS_LOCAL_POWER)
803 ? "lost (inactive)" : "good");
804
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700805 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 dev_dbg(hub_dev, "%sover-current condition exists\n",
807 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
808
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700809 /* set up the interrupt endpoint
810 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
811 * bytes as USB2.0[11.12.3] says because some hubs are known
812 * to send more data (and thus cause overflow). For root hubs,
813 * maxpktsize is defined in hcd.c's fake endpoint descriptors
814 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
816 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
817
818 if (maxp > sizeof(*hub->buffer))
819 maxp = sizeof(*hub->buffer);
820
821 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
822 if (!hub->urb) {
823 message = "couldn't allocate interrupt urb";
824 ret = -ENOMEM;
825 goto fail;
826 }
827
828 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
829 hub, endpoint->bInterval);
830 hub->urb->transfer_dma = hub->buffer_dma;
831 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
832
833 /* maybe cycle the hub leds */
834 if (hub->has_indicators && blinkenlights)
835 hub->indicator [0] = INDICATOR_CYCLE;
836
837 hub_power_on(hub);
838 hub_activate(hub);
839 return 0;
840
841fail:
842 dev_err (hub_dev, "config failed, %s (err %d)\n",
843 message, ret);
844 /* hub_disconnect() frees urb and descriptor */
845 return ret;
846}
847
848static unsigned highspeed_hubs;
849
850static void hub_disconnect(struct usb_interface *intf)
851{
852 struct usb_hub *hub = usb_get_intfdata (intf);
853 struct usb_device *hdev;
854
Alan Stern7de18d82006-06-01 13:37:24 -0400855 /* Disconnect all children and quiesce the hub */
856 hub->error = 0;
857 hub_pre_reset(intf);
858
Alan Stern8b28c752005-08-10 17:04:13 -0400859 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 hdev = hub->hdev;
861
862 if (hdev->speed == USB_SPEED_HIGH)
863 highspeed_hubs--;
864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 usb_free_urb(hub->urb);
866 hub->urb = NULL;
867
868 spin_lock_irq(&hub_event_lock);
869 list_del_init(&hub->event_list);
870 spin_unlock_irq(&hub_event_lock);
871
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700872 kfree(hub->descriptor);
873 hub->descriptor = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700875 kfree(hub->status);
876 hub->status = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
878 if (hub->buffer) {
879 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
880 hub->buffer_dma);
881 hub->buffer = NULL;
882 }
883
Alan Stern7d069b72005-11-18 12:06:34 -0500884 kfree(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
887static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
888{
889 struct usb_host_interface *desc;
890 struct usb_endpoint_descriptor *endpoint;
891 struct usb_device *hdev;
892 struct usb_hub *hub;
893
894 desc = intf->cur_altsetting;
895 hdev = interface_to_usbdev(intf);
896
David Brownell89ccbdc2006-04-02 10:18:09 -0800897#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
898 if (hdev->parent) {
899 dev_warn(&intf->dev, "ignoring external hub\n");
900 return -ENODEV;
901 }
902#endif
903
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 /* Some hubs have a subclass of 1, which AFAICT according to the */
905 /* specs is not defined, but it works */
906 if ((desc->desc.bInterfaceSubClass != 0) &&
907 (desc->desc.bInterfaceSubClass != 1)) {
908descriptor_error:
909 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
910 return -EIO;
911 }
912
913 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
914 if (desc->desc.bNumEndpoints != 1)
915 goto descriptor_error;
916
917 endpoint = &desc->endpoint[0].desc;
918
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700919 /* If it's not an interrupt in endpoint, we'd better punt! */
920 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 goto descriptor_error;
922
923 /* We found a hub */
924 dev_info (&intf->dev, "USB hub found\n");
925
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400926 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if (!hub) {
928 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
929 return -ENOMEM;
930 }
931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 INIT_LIST_HEAD(&hub->event_list);
933 hub->intfdev = &intf->dev;
934 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +0000935 INIT_DELAYED_WORK(&hub->leds, led_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
937 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -0500938 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
940 if (hdev->speed == USB_SPEED_HIGH)
941 highspeed_hubs++;
942
943 if (hub_configure(hub, endpoint) >= 0)
944 return 0;
945
946 hub_disconnect (intf);
947 return -ENODEV;
948}
949
950static int
951hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
952{
953 struct usb_device *hdev = interface_to_usbdev (intf);
954
955 /* assert ifno == 0 (part of hub spec) */
956 switch (code) {
957 case USBDEVFS_HUB_PORTINFO: {
958 struct usbdevfs_hub_portinfo *info = user_data;
959 int i;
960
961 spin_lock_irq(&device_state_lock);
962 if (hdev->devnum <= 0)
963 info->nports = 0;
964 else {
965 info->nports = hdev->maxchild;
966 for (i = 0; i < info->nports; i++) {
967 if (hdev->children[i] == NULL)
968 info->port[i] = 0;
969 else
970 info->port[i] =
971 hdev->children[i]->devnum;
972 }
973 }
974 spin_unlock_irq(&device_state_lock);
975
976 return info->nports + 1;
977 }
978
979 default:
980 return -ENOSYS;
981 }
982}
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
985/* grab device/port lock, returning index of that port (zero based).
986 * protects the upstream link used by this device from concurrent
987 * tree operations like suspend, resume, reset, and disconnect, which
988 * apply to everything downstream of a given port.
989 */
990static int locktree(struct usb_device *udev)
991{
992 int t;
993 struct usb_device *hdev;
994
995 if (!udev)
996 return -ENODEV;
997
998 /* root hub is always the first lock in the series */
999 hdev = udev->parent;
1000 if (!hdev) {
1001 usb_lock_device(udev);
1002 return 0;
1003 }
1004
1005 /* on the path from root to us, lock everything from
1006 * top down, dropping parent locks when not needed
1007 */
1008 t = locktree(hdev);
1009 if (t < 0)
1010 return t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
Alan Stern12c3da32005-11-23 12:09:52 -05001012 /* everything is fail-fast once disconnect
1013 * processing starts
1014 */
1015 if (udev->state == USB_STATE_NOTATTACHED) {
1016 usb_unlock_device(hdev);
1017 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 }
Alan Stern12c3da32005-11-23 12:09:52 -05001019
1020 /* when everyone grabs locks top->bottom,
1021 * non-overlapping work may be concurrent
1022 */
1023 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 usb_unlock_device(hdev);
Alan Stern12c3da32005-11-23 12:09:52 -05001025 return udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026}
1027
1028static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1029{
1030 int i;
1031
1032 for (i = 0; i < udev->maxchild; ++i) {
1033 if (udev->children[i])
1034 recursively_mark_NOTATTACHED(udev->children[i]);
1035 }
Alan Sternee49fb52006-11-22 16:55:54 -05001036 if (udev->state == USB_STATE_SUSPENDED)
1037 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 udev->state = USB_STATE_NOTATTACHED;
1039}
1040
1041/**
1042 * usb_set_device_state - change a device's current state (usbcore, hcds)
1043 * @udev: pointer to device whose state should be changed
1044 * @new_state: new state value to be stored
1045 *
1046 * udev->state is _not_ fully protected by the device lock. Although
1047 * most transitions are made only while holding the lock, the state can
1048 * can change to USB_STATE_NOTATTACHED at almost any time. This
1049 * is so that devices can be marked as disconnected as soon as possible,
1050 * without having to wait for any semaphores to be released. As a result,
1051 * all changes to any device's state must be protected by the
1052 * device_state_lock spinlock.
1053 *
1054 * Once a device has been added to the device tree, all changes to its state
1055 * should be made using this routine. The state should _not_ be set directly.
1056 *
1057 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1058 * Otherwise udev->state is set to new_state, and if new_state is
1059 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1060 * to USB_STATE_NOTATTACHED.
1061 */
1062void usb_set_device_state(struct usb_device *udev,
1063 enum usb_device_state new_state)
1064{
1065 unsigned long flags;
1066
1067 spin_lock_irqsave(&device_state_lock, flags);
1068 if (udev->state == USB_STATE_NOTATTACHED)
1069 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001070 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001071
1072 /* root hub wakeup capabilities are managed out-of-band
1073 * and may involve silicon errata ... ignore them here.
1074 */
1075 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001076 if (udev->state == USB_STATE_SUSPENDED
1077 || new_state == USB_STATE_SUSPENDED)
1078 ; /* No change to wakeup settings */
1079 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001080 device_init_wakeup(&udev->dev,
1081 (udev->actconfig->desc.bmAttributes
1082 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001083 else
David Brownellfb669cc2006-01-24 08:40:27 -08001084 device_init_wakeup(&udev->dev, 0);
1085 }
Alan Stern645daaa2006-08-30 15:47:02 -04001086 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001087 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 recursively_mark_NOTATTACHED(udev);
1089 spin_unlock_irqrestore(&device_state_lock, flags);
1090}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
1092
Alan Sternd388dab2006-07-01 22:14:24 -04001093#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001094
1095/**
1096 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1097 * @rhdev: struct usb_device for the root hub
1098 *
1099 * The USB host controller driver calls this function when its root hub
1100 * is resumed and Vbus power has been interrupted or the controller
1101 * has been reset. The routine marks all the children of the root hub
1102 * as NOTATTACHED and marks logical connect-change events on their ports.
1103 */
1104void usb_root_hub_lost_power(struct usb_device *rhdev)
1105{
1106 struct usb_hub *hub;
1107 int port1;
1108 unsigned long flags;
1109
1110 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
Alan Stern353a4092006-09-19 10:07:58 -04001111
1112 /* Make sure no potential wakeup events get lost,
1113 * by forcing the root hub to be resumed.
1114 */
1115 rhdev->dev.power.prev_state.event = PM_EVENT_ON;
1116
Alan Stern1c50c312005-11-14 11:45:38 -05001117 spin_lock_irqsave(&device_state_lock, flags);
1118 hub = hdev_to_hub(rhdev);
1119 for (port1 = 1; port1 <= rhdev->maxchild; ++port1) {
1120 if (rhdev->children[port1 - 1]) {
1121 recursively_mark_NOTATTACHED(
1122 rhdev->children[port1 - 1]);
1123 set_bit(port1, hub->change_bits);
1124 }
1125 }
1126 spin_unlock_irqrestore(&device_state_lock, flags);
1127}
1128EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1129
Alan Sternd388dab2006-07-01 22:14:24 -04001130#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132static void choose_address(struct usb_device *udev)
1133{
1134 int devnum;
1135 struct usb_bus *bus = udev->bus;
1136
1137 /* If khubd ever becomes multithreaded, this will need a lock */
1138
1139 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1140 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1141 bus->devnum_next);
1142 if (devnum >= 128)
1143 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1144
1145 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1146
1147 if (devnum < 128) {
1148 set_bit(devnum, bus->devmap.devicemap);
1149 udev->devnum = devnum;
1150 }
1151}
1152
1153static void release_address(struct usb_device *udev)
1154{
1155 if (udev->devnum > 0) {
1156 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1157 udev->devnum = -1;
1158 }
1159}
1160
Alan Sternd5d4db72007-05-29 16:34:52 -04001161#ifdef CONFIG_USB_SUSPEND
1162
1163static void usb_stop_pm(struct usb_device *udev)
1164{
1165 /* Synchronize with the ksuspend thread to prevent any more
1166 * autosuspend requests from being submitted, and decrement
1167 * the parent's count of unsuspended children.
1168 */
1169 usb_pm_lock(udev);
1170 if (udev->parent && !udev->discon_suspended)
1171 usb_autosuspend_device(udev->parent);
1172 usb_pm_unlock(udev);
1173
1174 /* Stop any autosuspend requests already submitted */
1175 cancel_rearming_delayed_work(&udev->autosuspend);
1176}
1177
1178#else
1179
1180static inline void usb_stop_pm(struct usb_device *udev)
1181{ }
1182
1183#endif
1184
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185/**
1186 * usb_disconnect - disconnect a device (usbcore-internal)
1187 * @pdev: pointer to device being disconnected
1188 * Context: !in_interrupt ()
1189 *
1190 * Something got disconnected. Get rid of it and all of its children.
1191 *
1192 * If *pdev is a normal device then the parent hub must already be locked.
1193 * If *pdev is a root hub then this routine will acquire the
1194 * usb_bus_list_lock on behalf of the caller.
1195 *
1196 * Only hub drivers (including virtual root hub drivers for host
1197 * controllers) should ever call this.
1198 *
1199 * This call is synchronous, and may not be used in an interrupt context.
1200 */
1201void usb_disconnect(struct usb_device **pdev)
1202{
1203 struct usb_device *udev = *pdev;
1204 int i;
1205
1206 if (!udev) {
1207 pr_debug ("%s nodev\n", __FUNCTION__);
1208 return;
1209 }
1210
1211 /* mark the device as inactive, so any further urb submissions for
1212 * this device (and any of its children) will fail immediately.
1213 * this quiesces everyting except pending urbs.
1214 */
1215 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1217
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001218 usb_lock_device(udev);
1219
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 /* Free up all the children before we remove this device */
1221 for (i = 0; i < USB_MAXCHILDREN; i++) {
1222 if (udev->children[i])
1223 usb_disconnect(&udev->children[i]);
1224 }
1225
1226 /* deallocate hcd/hardware state ... nuking all pending urbs and
1227 * cleaning up all state associated with the current configuration
1228 * so that the hardware is now fully quiesced.
1229 */
Alan Stern782da722006-07-01 22:09:35 -04001230 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 usb_disable_device(udev, 0);
1232
Alan Stern782da722006-07-01 22:09:35 -04001233 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001234
Alan Stern782da722006-07-01 22:09:35 -04001235 /* Unregister the device. The device driver is responsible
1236 * for removing the device files from usbfs and sysfs and for
1237 * de-configuring the device.
1238 */
1239 device_del(&udev->dev);
1240
1241 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 * (or root_hub) pointer.
1243 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246 /* Avoid races with recursively_mark_NOTATTACHED() */
1247 spin_lock_irq(&device_state_lock);
1248 *pdev = NULL;
1249 spin_unlock_irq(&device_state_lock);
1250
Alan Sternd5d4db72007-05-29 16:34:52 -04001251 usb_stop_pm(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001252
Alan Stern782da722006-07-01 22:09:35 -04001253 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254}
1255
1256#ifdef DEBUG
1257static void show_string(struct usb_device *udev, char *id, char *string)
1258{
1259 if (!string)
1260 return;
1261 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1262}
1263
1264#else
1265static inline void show_string(struct usb_device *udev, char *id, char *string)
1266{}
1267#endif
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
1270#ifdef CONFIG_USB_OTG
1271#include "otg_whitelist.h"
David Brownell11bd44a2006-11-01 14:26:26 -08001272static int __usb_port_suspend(struct usb_device *, int port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273#endif
1274
Oliver Neukum3ede7602007-01-11 14:35:50 +01001275/**
1276 * usb_new_device - perform initial device setup (usbcore-internal)
1277 * @udev: newly addressed device (in ADDRESS state)
1278 *
1279 * This is called with devices which have been enumerated, but not yet
1280 * configured. The device descriptor is available, but not descriptors
1281 * for any device configuration. The caller must have locked either
1282 * the parent hub (if udev is a normal device) or else the
1283 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1284 * udev has already been installed, but udev is not yet visible through
1285 * sysfs or other filesystem code.
1286 *
1287 * It will return if the device is configured properly or not. Zero if
1288 * the interface was registered with the driver core; else a negative
1289 * errno value.
1290 *
1291 * This call is synchronous, and may not be used in an interrupt context.
1292 *
1293 * Only the hub driver or root-hub registrar should ever call this.
1294 */
1295int usb_new_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296{
1297 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Oliver Neukum7ceec1f2007-01-26 14:26:21 +01001299 /* Determine quirks */
1300 usb_detect_quirks(udev);
1301
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 err = usb_get_configuration(udev);
1303 if (err < 0) {
1304 dev_err(&udev->dev, "can't read configurations, error %d\n",
1305 err);
1306 goto fail;
1307 }
1308
1309 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001310 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1311 udev->manufacturer = usb_cache_string(udev,
1312 udev->descriptor.iManufacturer);
1313 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314
1315 /* Tell the world! */
1316 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1317 "SerialNumber=%d\n",
1318 udev->descriptor.iManufacturer,
1319 udev->descriptor.iProduct,
1320 udev->descriptor.iSerialNumber);
1321 show_string(udev, "Product", udev->product);
1322 show_string(udev, "Manufacturer", udev->manufacturer);
1323 show_string(udev, "SerialNumber", udev->serial);
1324
1325#ifdef CONFIG_USB_OTG
1326 /*
1327 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1328 * to wake us after we've powered off VBUS; and HNP, switching roles
1329 * "host" to "peripheral". The OTG descriptor helps figure this out.
1330 */
1331 if (!udev->bus->is_b_host
1332 && udev->config
1333 && udev->parent == udev->bus->root_hub) {
1334 struct usb_otg_descriptor *desc = 0;
1335 struct usb_bus *bus = udev->bus;
1336
1337 /* descriptor may appear anywhere in config */
1338 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1339 le16_to_cpu(udev->config[0].desc.wTotalLength),
1340 USB_DT_OTG, (void **) &desc) == 0) {
1341 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001342 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 dev_info(&udev->dev,
1345 "Dual-Role OTG device on %sHNP port\n",
1346 (port1 == bus->otg_port)
1347 ? "" : "non-");
1348
1349 /* enable HNP before suspend, it's simpler */
1350 if (port1 == bus->otg_port)
1351 bus->b_hnp_enable = 1;
1352 err = usb_control_msg(udev,
1353 usb_sndctrlpipe(udev, 0),
1354 USB_REQ_SET_FEATURE, 0,
1355 bus->b_hnp_enable
1356 ? USB_DEVICE_B_HNP_ENABLE
1357 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1358 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1359 if (err < 0) {
1360 /* OTG MESSAGE: report errors here,
1361 * customize to match your product.
1362 */
1363 dev_info(&udev->dev,
1364 "can't set HNP mode; %d\n",
1365 err);
1366 bus->b_hnp_enable = 0;
1367 }
1368 }
1369 }
1370 }
1371
1372 if (!is_targeted(udev)) {
1373
1374 /* Maybe it can talk to us, though we can't talk to it.
1375 * (Includes HNP test device.)
1376 */
1377 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern140d8f62006-07-01 22:07:21 -04001378 err = __usb_port_suspend(udev, udev->bus->otg_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 if (err < 0)
1380 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1381 }
1382 err = -ENODEV;
1383 goto fail;
1384 }
1385#endif
1386
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001387 /* export the usbdev device-node for libusb */
1388 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1389 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1390
Alan Stern782da722006-07-01 22:09:35 -04001391 /* Register the device. The device driver is responsible
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001392 * for adding the device files to sysfs and for configuring
1393 * the device.
Alan Stern782da722006-07-01 22:09:35 -04001394 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001395 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 if (err) {
1397 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1398 goto fail;
1399 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001400
Alan Sternee49fb52006-11-22 16:55:54 -05001401 /* Increment the parent's count of unsuspended children */
1402 if (udev->parent)
Alan Stern94fcda12006-11-20 11:38:46 -05001403 usb_autoresume_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001404
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001405exit:
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001406 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
1408fail:
1409 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001410 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
1412
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413static int hub_port_status(struct usb_hub *hub, int port1,
1414 u16 *status, u16 *change)
1415{
1416 int ret;
1417
Alan Sterndb90e7a2007-02-05 09:56:15 -05001418 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001420 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 dev_err (hub->intfdev,
1422 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001423 if (ret >= 0)
1424 ret = -EIO;
1425 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 *status = le16_to_cpu(hub->status->port.wPortStatus);
1427 *change = le16_to_cpu(hub->status->port.wPortChange);
1428 ret = 0;
1429 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001430 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 return ret;
1432}
1433
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001434
1435/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1436static unsigned hub_is_wusb(struct usb_hub *hub)
1437{
1438 struct usb_hcd *hcd;
1439 if (hub->hdev->parent != NULL) /* not a root hub? */
1440 return 0;
1441 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1442 return hcd->wireless;
1443}
1444
1445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446#define PORT_RESET_TRIES 5
1447#define SET_ADDRESS_TRIES 2
1448#define GET_DESCRIPTOR_TRIES 2
1449#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1450#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1451
1452#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1453#define HUB_SHORT_RESET_TIME 10
1454#define HUB_LONG_RESET_TIME 200
1455#define HUB_RESET_TIMEOUT 500
1456
1457static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1458 struct usb_device *udev, unsigned int delay)
1459{
1460 int delay_time, ret;
1461 u16 portstatus;
1462 u16 portchange;
1463
1464 for (delay_time = 0;
1465 delay_time < HUB_RESET_TIMEOUT;
1466 delay_time += delay) {
1467 /* wait to give the device a chance to reset */
1468 msleep(delay);
1469
1470 /* read and decode port status */
1471 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1472 if (ret < 0)
1473 return ret;
1474
1475 /* Device went away? */
1476 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1477 return -ENOTCONN;
1478
1479 /* bomb out completely if something weird happened */
1480 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1481 return -EINVAL;
1482
1483 /* if we`ve finished resetting, then break out of the loop */
1484 if (!(portstatus & USB_PORT_STAT_RESET) &&
1485 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001486 if (hub_is_wusb(hub))
1487 udev->speed = USB_SPEED_VARIABLE;
1488 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 udev->speed = USB_SPEED_HIGH;
1490 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1491 udev->speed = USB_SPEED_LOW;
1492 else
1493 udev->speed = USB_SPEED_FULL;
1494 return 0;
1495 }
1496
1497 /* switch to the long delay after two short delay failures */
1498 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1499 delay = HUB_LONG_RESET_TIME;
1500
1501 dev_dbg (hub->intfdev,
1502 "port %d not reset yet, waiting %dms\n",
1503 port1, delay);
1504 }
1505
1506 return -EBUSY;
1507}
1508
1509static int hub_port_reset(struct usb_hub *hub, int port1,
1510 struct usb_device *udev, unsigned int delay)
1511{
1512 int i, status;
1513
1514 /* Reset the port */
1515 for (i = 0; i < PORT_RESET_TRIES; i++) {
1516 status = set_port_feature(hub->hdev,
1517 port1, USB_PORT_FEAT_RESET);
1518 if (status)
1519 dev_err(hub->intfdev,
1520 "cannot reset port %d (err = %d)\n",
1521 port1, status);
1522 else {
1523 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001524 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 dev_dbg(hub->intfdev,
1526 "port_wait_reset: err = %d\n",
1527 status);
1528 }
1529
1530 /* return on disconnect or reset */
1531 switch (status) {
1532 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001533 /* TRSTRCY = 10 ms; plus some extra */
1534 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 /* FALL THROUGH */
1536 case -ENOTCONN:
1537 case -ENODEV:
1538 clear_port_feature(hub->hdev,
1539 port1, USB_PORT_FEAT_C_RESET);
1540 /* FIXME need disconnect() for NOTATTACHED device */
1541 usb_set_device_state(udev, status
1542 ? USB_STATE_NOTATTACHED
1543 : USB_STATE_DEFAULT);
1544 return status;
1545 }
1546
1547 dev_dbg (hub->intfdev,
1548 "port %d not enabled, trying reset again...\n",
1549 port1);
1550 delay = HUB_LONG_RESET_TIME;
1551 }
1552
1553 dev_err (hub->intfdev,
1554 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1555 port1);
1556
1557 return status;
1558}
1559
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560/*
1561 * Disable a port and mark a logical connnect-change event, so that some
1562 * time later khubd will disconnect() any existing usb_device on the port
1563 * and will re-enumerate if there actually is a device attached.
1564 */
1565static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1566{
1567 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1568 hub_port_disable(hub, port1, 1);
1569
1570 /* FIXME let caller ask to power down the port:
1571 * - some devices won't enumerate without a VBUS power cycle
1572 * - SRP saves power that way
David Brownell390a8c32005-09-13 19:57:27 -07001573 * - ... new call, TBD ...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 * That's easy if this hub can switch power per-port, and
1575 * khubd reactivates the port later (timer, SRP, etc).
1576 * Powerdown must be optional, because of reset/DFU.
1577 */
1578
1579 set_bit(port1, hub->change_bits);
1580 kick_khubd(hub);
1581}
1582
Alan Sternd388dab2006-07-01 22:14:24 -04001583#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
1585#ifdef CONFIG_USB_SUSPEND
1586
1587/*
1588 * Selective port suspend reduces power; most suspended devices draw
1589 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1590 * All devices below the suspended port are also suspended.
1591 *
1592 * Devices leave suspend state when the host wakes them up. Some devices
1593 * also support "remote wakeup", where the device can activate the USB
1594 * tree above them to deliver data, such as a keypress or packet. In
1595 * some cases, this wakes the USB host.
1596 */
1597static int hub_port_suspend(struct usb_hub *hub, int port1,
1598 struct usb_device *udev)
1599{
1600 int status;
1601
1602 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1603
1604 /* enable remote wakeup when appropriate; this lets the device
1605 * wake up the upstream hub (including maybe the root hub).
1606 *
1607 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1608 * we don't explicitly enable it here.
1609 */
Alan Stern645daaa2006-08-30 15:47:02 -04001610 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1612 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1613 USB_DEVICE_REMOTE_WAKEUP, 0,
1614 NULL, 0,
1615 USB_CTRL_SET_TIMEOUT);
1616 if (status)
1617 dev_dbg(&udev->dev,
1618 "won't remote wakeup, status %d\n",
1619 status);
1620 }
1621
1622 /* see 7.1.7.6 */
1623 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1624 if (status) {
1625 dev_dbg(hub->intfdev,
1626 "can't suspend port %d, status %d\n",
1627 port1, status);
1628 /* paranoia: "should not happen" */
1629 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1630 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1631 USB_DEVICE_REMOTE_WAKEUP, 0,
1632 NULL, 0,
1633 USB_CTRL_SET_TIMEOUT);
1634 } else {
1635 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001636 dev_dbg(&udev->dev, "usb %ssuspend\n",
1637 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1639 msleep(10);
1640 }
1641 return status;
1642}
1643
1644/*
1645 * Devices on USB hub ports have only one "suspend" state, corresponding
Pavel Machekba9d35f2005-04-18 17:39:24 -07001646 * to ACPI D2, "may cause the device to lose some context".
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 * State transitions include:
1648 *
1649 * - suspend, resume ... when the VBUS power link stays live
1650 * - suspend, disconnect ... VBUS lost
1651 *
1652 * Once VBUS drop breaks the circuit, the port it's using has to go through
1653 * normal re-enumeration procedures, starting with enabling VBUS power.
1654 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1655 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1656 * timer, no SRP, no requests through sysfs.
David Brownell390a8c32005-09-13 19:57:27 -07001657 *
1658 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1659 * the root hub for their bus goes into global suspend ... so we don't
1660 * (falsely) update the device power state to say it suspended.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 */
Alan Stern140d8f62006-07-01 22:07:21 -04001662static int __usb_port_suspend (struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663{
David Brownellf3f32532005-09-22 22:37:29 -07001664 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
1666 /* caller owns the udev device lock */
1667 if (port1 < 0)
1668 return port1;
1669
Alan Stern140d8f62006-07-01 22:07:21 -04001670 /* we change the device's upstream USB link,
1671 * but root hubs have no upstream USB link.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 */
David Brownellf3f32532005-09-22 22:37:29 -07001673 if (udev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1675 udev);
Alan Stern2bf40862006-07-01 22:12:19 -04001676 else {
Alan Stern645daaa2006-08-30 15:47:02 -04001677 dev_dbg(&udev->dev, "usb %ssuspend\n",
1678 udev->auto_pm ? "auto-" : "");
Alan Stern2bf40862006-07-01 22:12:19 -04001679 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 return status;
1682}
1683
David Brownell5edbfb72005-09-22 22:45:26 -07001684/*
Alan Stern140d8f62006-07-01 22:07:21 -04001685 * usb_port_suspend - suspend a usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 * @udev: device that's no longer in active use
David Brownell5edbfb72005-09-22 22:45:26 -07001687 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 *
1689 * Suspends a USB device that isn't in active use, conserving power.
1690 * Devices may wake out of a suspend, if anything important happens,
1691 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001692 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 * to disconnect devices while they are suspended.
1694 *
David Brownell390a8c32005-09-13 19:57:27 -07001695 * This only affects the USB hardware for a device; its interfaces
1696 * (and, for hubs, child devices) must already have been suspended.
1697 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 * Suspending OTG devices may trigger HNP, if that's been enabled
1699 * between a pair of dual-role devices. That will change roles, such
1700 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1701 *
1702 * Returns 0 on success, else negative errno.
1703 */
Alan Stern140d8f62006-07-01 22:07:21 -04001704int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705{
Alan Stern140d8f62006-07-01 22:07:21 -04001706 return __usb_port_suspend(udev, udev->portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
David Brownellf3f32532005-09-22 22:37:29 -07001708
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709/*
David Brownell390a8c32005-09-13 19:57:27 -07001710 * If the USB "suspend" state is in use (rather than "global suspend"),
1711 * many devices will be individually taken out of suspend state using
1712 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 * hardware resume signaling is finished, either because of selective
1714 * resume (by host) or remote wakeup (by device) ... now see what changed
1715 * in the tree that's rooted at this device.
1716 */
Alan Stern140d8f62006-07-01 22:07:21 -04001717static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718{
1719 int status;
1720 u16 devstatus;
1721
1722 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001723 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
1725 /* usb ch9 identifies four variants of SUSPENDED, based on what
1726 * state the device resumes to. Linux currently won't see the
1727 * first two on the host side; they'd be inside hub_port_init()
1728 * during many timeouts, but khubd can't suspend until later.
1729 */
1730 usb_set_device_state(udev, udev->actconfig
1731 ? USB_STATE_CONFIGURED
1732 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
1734 /* 10.5.4.5 says be sure devices in the tree are still there.
1735 * For now let's assume the device didn't go crazy on resume,
1736 * and device drivers will know about any resume quirks.
1737 */
1738 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001739 if (status >= 0)
1740 status = (status == 2 ? 0 : -ENODEV);
1741
1742 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 dev_dbg(&udev->dev,
1744 "gone after usb resume? status %d\n",
1745 status);
1746 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 le16_to_cpus(&devstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001748 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
David Brownellf3f32532005-09-22 22:37:29 -07001749 && udev->parent) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 status = usb_control_msg(udev,
1751 usb_sndctrlpipe(udev, 0),
1752 USB_REQ_CLEAR_FEATURE,
1753 USB_RECIP_DEVICE,
1754 USB_DEVICE_REMOTE_WAKEUP, 0,
1755 NULL, 0,
1756 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001757 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 dev_dbg(&udev->dev, "disable remote "
1759 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001760 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 status = 0;
1762
1763 } else if (udev->devnum <= 0) {
1764 dev_dbg(&udev->dev, "bogus resume!\n");
1765 status = -EINVAL;
1766 }
1767 return status;
1768}
1769
1770static int
1771hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1772{
1773 int status;
Alan Sternd25450c2006-11-20 11:14:30 -05001774 u16 portchange, portstatus;
1775
1776 /* Skip the initial Clear-Suspend step for a remote wakeup */
1777 status = hub_port_status(hub, port1, &portstatus, &portchange);
1778 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1779 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
1781 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1782
Alan Sternd5cbad42006-08-11 16:52:39 -04001783 set_bit(port1, hub->busy_bits);
1784
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 /* see 7.1.7.7; affects power usage, but not budgeting */
1786 status = clear_port_feature(hub->hdev,
1787 port1, USB_PORT_FEAT_SUSPEND);
1788 if (status) {
1789 dev_dbg(hub->intfdev,
1790 "can't resume port %d, status %d\n",
1791 port1, status);
1792 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 /* drive resume for at least 20 msec */
1794 if (udev)
Alan Stern645daaa2006-08-30 15:47:02 -04001795 dev_dbg(&udev->dev, "usb %sresume\n",
1796 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 msleep(25);
1798
1799#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1800 | USB_PORT_STAT_ENABLE \
1801 | USB_PORT_STAT_CONNECTION)
1802
1803 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1804 * stop resume signaling. Then finish the resume
1805 * sequence.
1806 */
Alan Sternd25450c2006-11-20 11:14:30 -05001807 status = hub_port_status(hub, port1, &portstatus, &portchange);
1808SuspendCleared:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 if (status < 0
Alan Sternd25450c2006-11-20 11:14:30 -05001810 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1811 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 ) {
1813 dev_dbg(hub->intfdev,
1814 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001815 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001816 if (status >= 0)
1817 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 } else {
Alan Stern20307942006-06-28 11:20:41 -04001819 if (portchange & USB_PORT_STAT_C_SUSPEND)
1820 clear_port_feature(hub->hdev, port1,
1821 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 /* TRSMRCY = 10 msec */
1823 msleep(10);
1824 if (udev)
Alan Stern140d8f62006-07-01 22:07:21 -04001825 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 }
1827 }
1828 if (status < 0)
1829 hub_port_logical_disconnect(hub, port1);
1830
Alan Sternd5cbad42006-08-11 16:52:39 -04001831 clear_bit(port1, hub->busy_bits);
1832 if (!hub->hdev->parent && !hub->busy_bits[0])
1833 usb_enable_root_hub_irq(hub->hdev->bus);
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 return status;
1836}
1837
David Brownell5edbfb72005-09-22 22:45:26 -07001838/*
Alan Stern140d8f62006-07-01 22:07:21 -04001839 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001841 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 *
1843 * This will re-activate the suspended device, increasing power usage
1844 * while letting drivers communicate again with its endpoints.
1845 * USB resume explicitly guarantees that the power session between
1846 * the host and the device is the same as it was when the device
1847 * suspended.
1848 *
1849 * Returns 0 on success, else negative errno.
1850 */
Alan Stern140d8f62006-07-01 22:07:21 -04001851int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852{
Alan Sternd388dab2006-07-01 22:14:24 -04001853 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
Alan Stern140d8f62006-07-01 22:07:21 -04001855 /* we change the device's upstream USB link,
1856 * but root hubs have no upstream USB link.
1857 */
David Brownellf3f32532005-09-22 22:37:29 -07001858 if (udev->parent) {
Alan Stern114b3682006-07-01 22:13:04 -04001859 // NOTE this fails if parent is also suspended...
1860 status = hub_port_resume(hdev_to_hub(udev->parent),
1861 udev->portnum, udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001862 } else {
1863 dev_dbg(&udev->dev, "usb %sresume\n",
1864 udev->auto_pm ? "auto-" : "");
Alan Stern140d8f62006-07-01 22:07:21 -04001865 status = finish_port_resume(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04001866 }
David Brownellf3f32532005-09-22 22:37:29 -07001867 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001868 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 return status;
1870}
1871
1872static int remote_wakeup(struct usb_device *udev)
1873{
1874 int status = 0;
1875
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001876 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001878 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern19410442007-03-27 13:33:59 -04001879 usb_mark_last_busy(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04001880 status = usb_external_resume_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001881 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001882 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 return status;
1884}
1885
Alan Sternd388dab2006-07-01 22:14:24 -04001886#else /* CONFIG_USB_SUSPEND */
1887
1888/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1889
1890int usb_port_suspend(struct usb_device *udev)
1891{
1892 return 0;
1893}
1894
1895static inline int
1896finish_port_resume(struct usb_device *udev)
1897{
1898 return 0;
1899}
1900
1901static inline int
1902hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1903{
1904 return 0;
1905}
1906
1907int usb_port_resume(struct usb_device *udev)
1908{
1909 return 0;
1910}
1911
1912static inline int remote_wakeup(struct usb_device *udev)
1913{
1914 return 0;
1915}
1916
1917#endif
1918
David Brownelldb690872005-09-13 19:56:33 -07001919static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920{
1921 struct usb_hub *hub = usb_get_intfdata (intf);
1922 struct usb_device *hdev = hub->hdev;
1923 unsigned port1;
Alan Stern12f1ff82007-02-01 16:08:41 -05001924 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
David Brownellc9f89fa2005-09-13 19:57:04 -07001926 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1928 struct usb_device *udev;
1929
1930 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001931 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001932#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001933 udev->state != USB_STATE_SUSPENDED
1934#else
1935 udev->dev.power.power_state.event
1936 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001937#endif
Alan Stern114b3682006-07-01 22:13:04 -04001938 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001939 if (!hdev->auto_pm)
1940 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1941 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001942 return -EBUSY;
1943 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 }
1945
Alan Stern40f122f2006-11-09 14:44:33 -05001946 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1947
David Brownellc9f89fa2005-09-13 19:57:04 -07001948 /* stop khubd and related activity */
1949 hub_quiesce(hub);
Alan Stern12f1ff82007-02-01 16:08:41 -05001950
1951 /* "global suspend" of the downstream HC-to-USB interface */
1952 if (!hdev->parent) {
1953 status = hcd_bus_suspend(hdev->bus);
1954 if (status != 0) {
1955 dev_dbg(&hdev->dev, "'global' suspend %d\n", status);
1956 hub_activate(hub);
1957 }
1958 }
1959 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960}
1961
1962static int hub_resume(struct usb_interface *intf)
1963{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Stern40f122f2006-11-09 14:44:33 -05001965 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 int status;
1967
Alan Stern40f122f2006-11-09 14:44:33 -05001968 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1969
David Brownellf3f32532005-09-22 22:37:29 -07001970 /* "global resume" of the downstream HC-to-USB interface */
1971 if (!hdev->parent) {
1972 struct usb_bus *bus = hdev->bus;
Alan Stern0c0382e2005-10-13 17:08:02 -04001973 if (bus) {
1974 status = hcd_bus_resume (bus);
David Brownellf3f32532005-09-22 22:37:29 -07001975 if (status) {
1976 dev_dbg(&intf->dev, "'global' resume %d\n",
1977 status);
1978 return status;
1979 }
1980 } else
1981 return -EOPNOTSUPP;
1982 if (status == 0) {
1983 /* TRSMRCY = 10 msec */
1984 msleep(10);
1985 }
1986 }
1987
Alan Sterna8e7c562006-07-01 22:11:02 -04001988 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001989 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 return 0;
1991}
1992
Alan Sternd388dab2006-07-01 22:14:24 -04001993#else /* CONFIG_PM */
1994
1995static inline int remote_wakeup(struct usb_device *udev)
1996{
1997 return 0;
1998}
1999
Andrew Morton511366d2006-08-14 23:11:02 -07002000#define hub_suspend NULL
2001#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002002#endif
2003
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004
2005/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2006 *
2007 * Between connect detection and reset signaling there must be a delay
2008 * of 100ms at least for debounce and power-settling. The corresponding
2009 * timer shall restart whenever the downstream port detects a disconnect.
2010 *
2011 * Apparently there are some bluetooth and irda-dongles and a number of
2012 * low-speed devices for which this debounce period may last over a second.
2013 * Not covered by the spec - but easy to deal with.
2014 *
2015 * This implementation uses a 1500ms total debounce timeout; if the
2016 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2017 * every 25ms for transient disconnects. When the port status has been
2018 * unchanged for 100ms it returns the port status.
2019 */
2020
2021#define HUB_DEBOUNCE_TIMEOUT 1500
2022#define HUB_DEBOUNCE_STEP 25
2023#define HUB_DEBOUNCE_STABLE 100
2024
2025static int hub_port_debounce(struct usb_hub *hub, int port1)
2026{
2027 int ret;
2028 int total_time, stable_time = 0;
2029 u16 portchange, portstatus;
2030 unsigned connection = 0xffff;
2031
2032 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2033 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2034 if (ret < 0)
2035 return ret;
2036
2037 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2038 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2039 stable_time += HUB_DEBOUNCE_STEP;
2040 if (stable_time >= HUB_DEBOUNCE_STABLE)
2041 break;
2042 } else {
2043 stable_time = 0;
2044 connection = portstatus & USB_PORT_STAT_CONNECTION;
2045 }
2046
2047 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2048 clear_port_feature(hub->hdev, port1,
2049 USB_PORT_FEAT_C_CONNECTION);
2050 }
2051
2052 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2053 break;
2054 msleep(HUB_DEBOUNCE_STEP);
2055 }
2056
2057 dev_dbg (hub->intfdev,
2058 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2059 port1, total_time, stable_time, portstatus);
2060
2061 if (stable_time < HUB_DEBOUNCE_STABLE)
2062 return -ETIMEDOUT;
2063 return portstatus;
2064}
2065
2066static void ep0_reinit(struct usb_device *udev)
2067{
2068 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2069 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2070 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2071}
2072
2073#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2074#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2075
2076static int hub_set_address(struct usb_device *udev)
2077{
2078 int retval;
2079
2080 if (udev->devnum == 0)
2081 return -EINVAL;
2082 if (udev->state == USB_STATE_ADDRESS)
2083 return 0;
2084 if (udev->state != USB_STATE_DEFAULT)
2085 return -EINVAL;
2086 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2087 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2088 NULL, 0, USB_CTRL_SET_TIMEOUT);
2089 if (retval == 0) {
2090 usb_set_device_state(udev, USB_STATE_ADDRESS);
2091 ep0_reinit(udev);
2092 }
2093 return retval;
2094}
2095
2096/* Reset device, (re)assign address, get device descriptor.
2097 * Device connection must be stable, no more debouncing needed.
2098 * Returns device in USB_STATE_ADDRESS, except on error.
2099 *
2100 * If this is called for an already-existing device (as part of
2101 * usb_reset_device), the caller must own the device lock. For a
2102 * newly detected device that is not accessible through any global
2103 * pointers, it's not necessary to lock the device.
2104 */
2105static int
2106hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2107 int retry_counter)
2108{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002109 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
2111 struct usb_device *hdev = hub->hdev;
2112 int i, j, retval;
2113 unsigned delay = HUB_SHORT_RESET_TIME;
2114 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002115 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
2117 /* root hub ports have a slightly longer reset period
2118 * (from USB 2.0 spec, section 7.1.7.5)
2119 */
2120 if (!hdev->parent) {
2121 delay = HUB_ROOT_RESET_TIME;
2122 if (port1 == hdev->bus->otg_port)
2123 hdev->bus->b_hnp_enable = 0;
2124 }
2125
2126 /* Some low speed devices have problems with the quick delay, so */
2127 /* be a bit pessimistic with those devices. RHbug #23670 */
2128 if (oldspeed == USB_SPEED_LOW)
2129 delay = HUB_LONG_RESET_TIME;
2130
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002131 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133 /* Reset the device; full speed may morph to high speed */
2134 retval = hub_port_reset(hub, port1, udev, delay);
2135 if (retval < 0) /* error or disconnect */
2136 goto fail;
2137 /* success, speed is known */
2138 retval = -ENODEV;
2139
2140 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2141 dev_dbg(&udev->dev, "device reset changed speed!\n");
2142 goto fail;
2143 }
2144 oldspeed = udev->speed;
2145
2146 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2147 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002148 * For Wireless USB devices, ep0 max packet is always 512 (tho
2149 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 */
2151 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002152 case USB_SPEED_VARIABLE: /* fixed at 512 */
2153 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2154 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 case USB_SPEED_HIGH: /* fixed at 64 */
2156 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2157 break;
2158 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2159 /* to determine the ep0 maxpacket size, try to read
2160 * the device descriptor to get bMaxPacketSize0 and
2161 * then correct our initial guess.
2162 */
2163 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2164 break;
2165 case USB_SPEED_LOW: /* fixed at 8 */
2166 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2167 break;
2168 default:
2169 goto fail;
2170 }
2171
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002172 type = "";
2173 switch (udev->speed) {
2174 case USB_SPEED_LOW: speed = "low"; break;
2175 case USB_SPEED_FULL: speed = "full"; break;
2176 case USB_SPEED_HIGH: speed = "high"; break;
2177 case USB_SPEED_VARIABLE:
2178 speed = "variable";
2179 type = "Wireless ";
2180 break;
2181 default: speed = "?"; break;
2182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002184 "%s %s speed %sUSB device using %s and address %d\n",
2185 (udev->config) ? "reset" : "new", speed, type,
2186 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187
2188 /* Set up TT records, if needed */
2189 if (hdev->tt) {
2190 udev->tt = hdev->tt;
2191 udev->ttport = hdev->ttport;
2192 } else if (udev->speed != USB_SPEED_HIGH
2193 && hdev->speed == USB_SPEED_HIGH) {
2194 udev->tt = &hub->tt;
2195 udev->ttport = port1;
2196 }
2197
2198 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2199 * Because device hardware and firmware is sometimes buggy in
2200 * this area, and this is how Linux has done it for ages.
2201 * Change it cautiously.
2202 *
2203 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2204 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2205 * so it may help with some non-standards-compliant devices.
2206 * Otherwise we start with SET_ADDRESS and then try to read the
2207 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2208 * value.
2209 */
2210 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2211 if (USE_NEW_SCHEME(retry_counter)) {
2212 struct usb_device_descriptor *buf;
2213 int r = 0;
2214
2215#define GET_DESCRIPTOR_BUFSIZE 64
2216 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2217 if (!buf) {
2218 retval = -ENOMEM;
2219 continue;
2220 }
2221
Alan Sternb89ee192007-05-11 10:19:04 -04002222 /* Retry on all errors; some devices are flakey.
2223 * 255 is for WUSB devices, we actually need to use
2224 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 */
2226 for (j = 0; j < 3; ++j) {
2227 buf->bMaxPacketSize0 = 0;
2228 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2229 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2230 USB_DT_DEVICE << 8, 0,
2231 buf, GET_DESCRIPTOR_BUFSIZE,
Alan Sternb89ee192007-05-11 10:19:04 -04002232 USB_CTRL_GET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002234 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 if (buf->bDescriptorType ==
2236 USB_DT_DEVICE) {
2237 r = 0;
2238 break;
2239 }
2240 /* FALL THROUGH */
2241 default:
2242 if (r == 0)
2243 r = -EPROTO;
2244 break;
2245 }
2246 if (r == 0)
2247 break;
2248 }
2249 udev->descriptor.bMaxPacketSize0 =
2250 buf->bMaxPacketSize0;
2251 kfree(buf);
2252
2253 retval = hub_port_reset(hub, port1, udev, delay);
2254 if (retval < 0) /* error or disconnect */
2255 goto fail;
2256 if (oldspeed != udev->speed) {
2257 dev_dbg(&udev->dev,
2258 "device reset changed speed!\n");
2259 retval = -ENODEV;
2260 goto fail;
2261 }
2262 if (r) {
2263 dev_err(&udev->dev, "device descriptor "
2264 "read/%s, error %d\n",
2265 "64", r);
2266 retval = -EMSGSIZE;
2267 continue;
2268 }
2269#undef GET_DESCRIPTOR_BUFSIZE
2270 }
2271
2272 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2273 retval = hub_set_address(udev);
2274 if (retval >= 0)
2275 break;
2276 msleep(200);
2277 }
2278 if (retval < 0) {
2279 dev_err(&udev->dev,
2280 "device not accepting address %d, error %d\n",
2281 udev->devnum, retval);
2282 goto fail;
2283 }
2284
2285 /* cope with hardware quirkiness:
2286 * - let SET_ADDRESS settle, some device hardware wants it
2287 * - read ep0 maxpacket even for high and low speed,
2288 */
2289 msleep(10);
2290 if (USE_NEW_SCHEME(retry_counter))
2291 break;
2292
2293 retval = usb_get_device_descriptor(udev, 8);
2294 if (retval < 8) {
2295 dev_err(&udev->dev, "device descriptor "
2296 "read/%s, error %d\n",
2297 "8", retval);
2298 if (retval >= 0)
2299 retval = -EMSGSIZE;
2300 } else {
2301 retval = 0;
2302 break;
2303 }
2304 }
2305 if (retval)
2306 goto fail;
2307
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002308 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2309 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2311 if (udev->speed != USB_SPEED_FULL ||
2312 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2313 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2314 retval = -EMSGSIZE;
2315 goto fail;
2316 }
2317 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2318 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2319 ep0_reinit(udev);
2320 }
2321
2322 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2323 if (retval < (signed)sizeof(udev->descriptor)) {
2324 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2325 "all", retval);
2326 if (retval >= 0)
2327 retval = -ENOMSG;
2328 goto fail;
2329 }
2330
2331 retval = 0;
2332
2333fail:
2334 if (retval)
2335 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002336 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 return retval;
2338}
2339
2340static void
2341check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2342{
2343 struct usb_qualifier_descriptor *qual;
2344 int status;
2345
Christoph Lametere94b1762006-12-06 20:33:17 -08002346 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 if (qual == NULL)
2348 return;
2349
2350 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2351 qual, sizeof *qual);
2352 if (status == sizeof *qual) {
2353 dev_info(&udev->dev, "not running at top speed; "
2354 "connect to a high speed hub\n");
2355 /* hub LEDs are probably harder to miss than syslog */
2356 if (hub->has_indicators) {
2357 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002358 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 }
2360 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002361 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362}
2363
2364static unsigned
2365hub_power_remaining (struct usb_hub *hub)
2366{
2367 struct usb_device *hdev = hub->hdev;
2368 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002369 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
Alan Stern55c52712005-11-23 12:03:12 -05002371 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 return 0;
2373
Alan Stern55c52712005-11-23 12:03:12 -05002374 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2375 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2376 struct usb_device *udev = hdev->children[port1 - 1];
2377 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378
2379 if (!udev)
2380 continue;
2381
Alan Stern55c52712005-11-23 12:03:12 -05002382 /* Unconfigured devices may not use more than 100mA,
2383 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002385 delta = udev->actconfig->desc.bMaxPower * 2;
2386 else if (port1 != udev->bus->otg_port || hdev->parent)
2387 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 else
Alan Stern55c52712005-11-23 12:03:12 -05002389 delta = 8;
2390 if (delta > hub->mA_per_port)
2391 dev_warn(&udev->dev, "%dmA is over %umA budget "
2392 "for port %d!\n",
2393 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 remaining -= delta;
2395 }
2396 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002397 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2398 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 remaining = 0;
2400 }
2401 return remaining;
2402}
2403
2404/* Handle physical or logical connection change events.
2405 * This routine is called when:
2406 * a port connection-change occurs;
2407 * a port enable-change occurs (often caused by EMI);
2408 * usb_reset_device() encounters changed descriptors (as from
2409 * a firmware download)
2410 * caller already locked the hub
2411 */
2412static void hub_port_connect_change(struct usb_hub *hub, int port1,
2413 u16 portstatus, u16 portchange)
2414{
2415 struct usb_device *hdev = hub->hdev;
2416 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002417 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 int status, i;
2419
2420 dev_dbg (hub_dev,
2421 "port %d, status %04x, change %04x, %s\n",
2422 port1, portstatus, portchange, portspeed (portstatus));
2423
2424 if (hub->has_indicators) {
2425 set_port_led(hub, port1, HUB_LED_AUTO);
2426 hub->indicator[port1-1] = INDICATOR_AUTO;
2427 }
2428
2429 /* Disconnect any existing devices under this port */
2430 if (hdev->children[port1-1])
2431 usb_disconnect(&hdev->children[port1-1]);
2432 clear_bit(port1, hub->change_bits);
2433
2434#ifdef CONFIG_USB_OTG
2435 /* during HNP, don't repeat the debounce */
2436 if (hdev->bus->is_b_host)
2437 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2438#endif
2439
2440 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2441 status = hub_port_debounce(hub, port1);
Alan Sternd4b7d8e2007-05-22 11:48:17 -04002442 if (status < 0) {
2443 if (printk_ratelimit())
2444 dev_err (hub_dev, "connect-debounce failed, "
2445 "port %d disabled\n", port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 goto done;
2447 }
2448 portstatus = status;
2449 }
2450
2451 /* Return now if nothing is connected */
2452 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2453
2454 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002455 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2457 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2458
2459 if (portstatus & USB_PORT_STAT_ENABLE)
2460 goto done;
2461 return;
2462 }
2463
2464#ifdef CONFIG_USB_SUSPEND
2465 /* If something is connected, but the port is suspended, wake it up. */
2466 if (portstatus & USB_PORT_STAT_SUSPEND) {
2467 status = hub_port_resume(hub, port1, NULL);
2468 if (status < 0) {
2469 dev_dbg(hub_dev,
2470 "can't clear suspend on port %d; %d\n",
2471 port1, status);
2472 goto done;
2473 }
2474 }
2475#endif
2476
2477 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2478 struct usb_device *udev;
2479
2480 /* reallocate for each attempt, since references
2481 * to the previous one can escape in various ways
2482 */
2483 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2484 if (!udev) {
2485 dev_err (hub_dev,
2486 "couldn't allocate port %d usb_device\n",
2487 port1);
2488 goto done;
2489 }
2490
2491 usb_set_device_state(udev, USB_STATE_POWERED);
2492 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002493 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002494 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002495
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 /* set the address */
2497 choose_address(udev);
2498 if (udev->devnum <= 0) {
2499 status = -ENOTCONN; /* Don't retry */
2500 goto loop;
2501 }
2502
2503 /* reset and get descriptor */
2504 status = hub_port_init(hub, udev, port1, i);
2505 if (status < 0)
2506 goto loop;
2507
2508 /* consecutive bus-powered hubs aren't reliable; they can
2509 * violate the voltage drop budget. if the new child has
2510 * a "powered" LED, users should notice we didn't enable it
2511 * (without reading syslog), even without per-port LEDs
2512 * on the parent.
2513 */
2514 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002515 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 u16 devstat;
2517
2518 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2519 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002520 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 dev_dbg(&udev->dev, "get status %d ?\n", status);
2522 goto loop_disable;
2523 }
Alan Stern55c52712005-11-23 12:03:12 -05002524 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2526 dev_err(&udev->dev,
2527 "can't connect bus-powered hub "
2528 "to this port\n");
2529 if (hub->has_indicators) {
2530 hub->indicator[port1-1] =
2531 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002532 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 }
2534 status = -ENOTCONN; /* Don't retry */
2535 goto loop_disable;
2536 }
2537 }
2538
2539 /* check for devices running slower than they could */
2540 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2541 && udev->speed == USB_SPEED_FULL
2542 && highspeed_hubs != 0)
2543 check_highspeed (hub, udev, port1);
2544
2545 /* Store the parent's children[] pointer. At this point
2546 * udev becomes globally accessible, although presumably
2547 * no one will look at it until hdev is unlocked.
2548 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 status = 0;
2550
2551 /* We mustn't add new devices if the parent hub has
2552 * been disconnected; we would race with the
2553 * recursively_mark_NOTATTACHED() routine.
2554 */
2555 spin_lock_irq(&device_state_lock);
2556 if (hdev->state == USB_STATE_NOTATTACHED)
2557 status = -ENOTCONN;
2558 else
2559 hdev->children[port1-1] = udev;
2560 spin_unlock_irq(&device_state_lock);
2561
2562 /* Run it through the hoops (find a driver, etc) */
2563 if (!status) {
2564 status = usb_new_device(udev);
2565 if (status) {
2566 spin_lock_irq(&device_state_lock);
2567 hdev->children[port1-1] = NULL;
2568 spin_unlock_irq(&device_state_lock);
2569 }
2570 }
2571
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 if (status)
2573 goto loop_disable;
2574
2575 status = hub_power_remaining(hub);
2576 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002577 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578
2579 return;
2580
2581loop_disable:
2582 hub_port_disable(hub, port1, 1);
2583loop:
2584 ep0_reinit(udev);
2585 release_address(udev);
2586 usb_put_dev(udev);
2587 if (status == -ENOTCONN)
2588 break;
2589 }
2590
2591done:
2592 hub_port_disable(hub, port1, 1);
2593}
2594
2595static void hub_events(void)
2596{
2597 struct list_head *tmp;
2598 struct usb_device *hdev;
2599 struct usb_interface *intf;
2600 struct usb_hub *hub;
2601 struct device *hub_dev;
2602 u16 hubstatus;
2603 u16 hubchange;
2604 u16 portstatus;
2605 u16 portchange;
2606 int i, ret;
2607 int connect_change;
2608
2609 /*
2610 * We restart the list every time to avoid a deadlock with
2611 * deleting hubs downstream from this one. This should be
2612 * safe since we delete the hub from the event list.
2613 * Not the most efficient, but avoids deadlocks.
2614 */
2615 while (1) {
2616
2617 /* Grab the first entry at the beginning of the list */
2618 spin_lock_irq(&hub_event_lock);
2619 if (list_empty(&hub_event_list)) {
2620 spin_unlock_irq(&hub_event_lock);
2621 break;
2622 }
2623
2624 tmp = hub_event_list.next;
2625 list_del_init(tmp);
2626
2627 hub = list_entry(tmp, struct usb_hub, event_list);
2628 hdev = hub->hdev;
2629 intf = to_usb_interface(hub->intfdev);
2630 hub_dev = &intf->dev;
2631
Alan Stern40f122f2006-11-09 14:44:33 -05002632 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 hdev->state, hub->descriptor
2634 ? hub->descriptor->bNbrPorts
2635 : 0,
2636 /* NOTE: expects max 15 ports... */
2637 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002638 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
2640 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 spin_unlock_irq(&hub_event_lock);
2642
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 /* Lock the device, then check to see if we were
2644 * disconnected while waiting for the lock to succeed. */
2645 if (locktree(hdev) < 0) {
2646 usb_put_intf(intf);
2647 continue;
2648 }
2649 if (hub != usb_get_intfdata(intf))
2650 goto loop;
2651
2652 /* If the hub has died, clean up after it */
2653 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002654 hub->error = -ENODEV;
2655 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 goto loop;
2657 }
2658
Alan Stern40f122f2006-11-09 14:44:33 -05002659 /* Autoresume */
2660 ret = usb_autopm_get_interface(intf);
2661 if (ret) {
2662 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002664 }
2665
2666 /* If this is an inactive hub, do nothing */
2667 if (hub->quiescing)
2668 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669
2670 if (hub->error) {
2671 dev_dbg (hub_dev, "resetting for error %d\n",
2672 hub->error);
2673
Alan Stern7de18d82006-06-01 13:37:24 -04002674 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675 if (ret) {
2676 dev_dbg (hub_dev,
2677 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002678 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 }
2680
2681 hub->nerrors = 0;
2682 hub->error = 0;
2683 }
2684
2685 /* deal with port status changes */
2686 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2687 if (test_bit(i, hub->busy_bits))
2688 continue;
2689 connect_change = test_bit(i, hub->change_bits);
2690 if (!test_and_clear_bit(i, hub->event_bits) &&
2691 !connect_change && !hub->activating)
2692 continue;
2693
2694 ret = hub_port_status(hub, i,
2695 &portstatus, &portchange);
2696 if (ret < 0)
2697 continue;
2698
2699 if (hub->activating && !hdev->children[i-1] &&
2700 (portstatus &
2701 USB_PORT_STAT_CONNECTION))
2702 connect_change = 1;
2703
2704 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2705 clear_port_feature(hdev, i,
2706 USB_PORT_FEAT_C_CONNECTION);
2707 connect_change = 1;
2708 }
2709
2710 if (portchange & USB_PORT_STAT_C_ENABLE) {
2711 if (!connect_change)
2712 dev_dbg (hub_dev,
2713 "port %d enable change, "
2714 "status %08x\n",
2715 i, portstatus);
2716 clear_port_feature(hdev, i,
2717 USB_PORT_FEAT_C_ENABLE);
2718
2719 /*
2720 * EM interference sometimes causes badly
2721 * shielded USB devices to be shutdown by
2722 * the hub, this hack enables them again.
2723 * Works at least with mouse driver.
2724 */
2725 if (!(portstatus & USB_PORT_STAT_ENABLE)
2726 && !connect_change
2727 && hdev->children[i-1]) {
2728 dev_err (hub_dev,
2729 "port %i "
2730 "disabled by hub (EMI?), "
2731 "re-enabling...\n",
2732 i);
2733 connect_change = 1;
2734 }
2735 }
2736
2737 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2738 clear_port_feature(hdev, i,
2739 USB_PORT_FEAT_C_SUSPEND);
2740 if (hdev->children[i-1]) {
2741 ret = remote_wakeup(hdev->
2742 children[i-1]);
2743 if (ret < 0)
2744 connect_change = 1;
2745 } else {
2746 ret = -ENODEV;
2747 hub_port_disable(hub, i, 1);
2748 }
2749 dev_dbg (hub_dev,
2750 "resume on port %d, status %d\n",
2751 i, ret);
2752 }
2753
2754 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2755 dev_err (hub_dev,
2756 "over-current change on port %d\n",
2757 i);
2758 clear_port_feature(hdev, i,
2759 USB_PORT_FEAT_C_OVER_CURRENT);
2760 hub_power_on(hub);
2761 }
2762
2763 if (portchange & USB_PORT_STAT_C_RESET) {
2764 dev_dbg (hub_dev,
2765 "reset change on port %d\n",
2766 i);
2767 clear_port_feature(hdev, i,
2768 USB_PORT_FEAT_C_RESET);
2769 }
2770
2771 if (connect_change)
2772 hub_port_connect_change(hub, i,
2773 portstatus, portchange);
2774 } /* end for i */
2775
2776 /* deal with hub status changes */
2777 if (test_and_clear_bit(0, hub->event_bits) == 0)
2778 ; /* do nothing */
2779 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2780 dev_err (hub_dev, "get_hub_status failed\n");
2781 else {
2782 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2783 dev_dbg (hub_dev, "power change\n");
2784 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002785 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2786 /* FIXME: Is this always true? */
2787 hub->limited_power = 0;
2788 else
2789 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 }
2791 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2792 dev_dbg (hub_dev, "overcurrent change\n");
2793 msleep(500); /* Cool down */
2794 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2795 hub_power_on(hub);
2796 }
2797 }
2798
2799 hub->activating = 0;
2800
Alan Sternd5926ae72005-04-21 15:56:37 -04002801 /* If this is a root hub, tell the HCD it's okay to
2802 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002803 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002804 usb_enable_root_hub_irq(hdev->bus);
2805
Alan Stern40f122f2006-11-09 14:44:33 -05002806loop_autopm:
2807 /* Allow autosuspend if we're not going to run again */
2808 if (list_empty(&hub->event_list))
2809 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810loop:
2811 usb_unlock_device(hdev);
2812 usb_put_intf(intf);
2813
2814 } /* end while (1) */
2815}
2816
2817static int hub_thread(void *__unused)
2818{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 do {
2820 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002821 wait_event_interruptible(khubd_wait,
2822 !list_empty(&hub_event_list) ||
2823 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002824 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002825 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002827 pr_debug("%s: khubd exiting\n", usbcore_name);
2828 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829}
2830
2831static struct usb_device_id hub_id_table [] = {
2832 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2833 .bDeviceClass = USB_CLASS_HUB},
2834 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2835 .bInterfaceClass = USB_CLASS_HUB},
2836 { } /* Terminating entry */
2837};
2838
2839MODULE_DEVICE_TABLE (usb, hub_id_table);
2840
2841static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 .name = "hub",
2843 .probe = hub_probe,
2844 .disconnect = hub_disconnect,
2845 .suspend = hub_suspend,
2846 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002847 .pre_reset = hub_pre_reset,
2848 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002849 .ioctl = hub_ioctl,
2850 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002851 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002852};
2853
2854int usb_hub_init(void)
2855{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 if (usb_register(&hub_driver) < 0) {
2857 printk(KERN_ERR "%s: can't register hub driver\n",
2858 usbcore_name);
2859 return -1;
2860 }
2861
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002862 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2863 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865
2866 /* Fall through if kernel_thread failed */
2867 usb_deregister(&hub_driver);
2868 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2869
2870 return -1;
2871}
2872
2873void usb_hub_cleanup(void)
2874{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002875 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876
2877 /*
2878 * Hub resources are freed for us by usb_deregister. It calls
2879 * usb_driver_purge on every device which in turn calls that
2880 * devices disconnect function if it is using this driver.
2881 * The hub_disconnect function takes care of releasing the
2882 * individual hub resources. -greg
2883 */
2884 usb_deregister(&hub_driver);
2885} /* usb_hub_cleanup() */
2886
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887static int config_descriptors_changed(struct usb_device *udev)
2888{
2889 unsigned index;
2890 unsigned len = 0;
2891 struct usb_config_descriptor *buf;
2892
2893 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2894 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2895 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2896 }
Christoph Lametere94b1762006-12-06 20:33:17 -08002897 buf = kmalloc (len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 if (buf == NULL) {
2899 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2900 /* assume the worst */
2901 return 1;
2902 }
2903 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2904 int length;
2905 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2906
2907 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2908 old_length);
2909 if (length < old_length) {
2910 dev_dbg(&udev->dev, "config index %d, error %d\n",
2911 index, length);
2912 break;
2913 }
2914 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2915 != 0) {
2916 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2917 index, buf->bConfigurationValue);
2918 break;
2919 }
2920 }
2921 kfree(buf);
2922 return index != udev->descriptor.bNumConfigurations;
2923}
2924
2925/**
2926 * usb_reset_device - perform a USB port reset to reinitialize a device
2927 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2928 *
Alan Stern79efa092006-06-01 13:33:42 -04002929 * WARNING - don't use this routine to reset a composite device
2930 * (one with multiple interfaces owned by separate drivers)!
2931 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932 *
2933 * Do a port reset, reassign the device's address, and establish its
2934 * former operating configuration. If the reset fails, or the device's
2935 * descriptors change from their values before the reset, or the original
2936 * configuration and altsettings cannot be restored, a flag will be set
2937 * telling khubd to pretend the device has been disconnected and then
2938 * re-connected. All drivers will be unbound, and the device will be
2939 * re-enumerated and probed all over again.
2940 *
2941 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2942 * flagged for logical disconnection, or some other negative error code
2943 * if the reset wasn't even attempted.
2944 *
2945 * The caller must own the device lock. For example, it's safe to use
2946 * this from a driver probe() routine after downloading new firmware.
2947 * For calls that might not occur during probe(), drivers should lock
2948 * the device using usb_lock_device_for_reset().
2949 */
2950int usb_reset_device(struct usb_device *udev)
2951{
2952 struct usb_device *parent_hdev = udev->parent;
2953 struct usb_hub *parent_hub;
2954 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002955 int i, ret = 0;
2956 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957
2958 if (udev->state == USB_STATE_NOTATTACHED ||
2959 udev->state == USB_STATE_SUSPENDED) {
2960 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2961 udev->state);
2962 return -EINVAL;
2963 }
2964
2965 if (!parent_hdev) {
2966 /* this requires hcd-specific logic; see OHCI hc_restart() */
2967 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2968 return -EISDIR;
2969 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970 parent_hub = hdev_to_hub(parent_hdev);
2971
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972 set_bit(port1, parent_hub->busy_bits);
2973 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2974
2975 /* ep0 maxpacket size may change; let the HCD know about it.
2976 * Other endpoints will be handled by re-enumeration. */
2977 ep0_reinit(udev);
2978 ret = hub_port_init(parent_hub, udev, port1, i);
2979 if (ret >= 0)
2980 break;
2981 }
2982 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002983 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2984 usb_enable_root_hub_irq(parent_hdev->bus);
2985
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986 if (ret < 0)
2987 goto re_enumerate;
2988
2989 /* Device might have changed firmware (DFU or similar) */
2990 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2991 || config_descriptors_changed (udev)) {
2992 dev_info(&udev->dev, "device firmware changed\n");
2993 udev->descriptor = descriptor; /* for disconnect() calls */
2994 goto re_enumerate;
2995 }
2996
2997 if (!udev->actconfig)
2998 goto done;
2999
3000 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3001 USB_REQ_SET_CONFIGURATION, 0,
3002 udev->actconfig->desc.bConfigurationValue, 0,
3003 NULL, 0, USB_CTRL_SET_TIMEOUT);
3004 if (ret < 0) {
3005 dev_err(&udev->dev,
3006 "can't restore configuration #%d (error=%d)\n",
3007 udev->actconfig->desc.bConfigurationValue, ret);
3008 goto re_enumerate;
3009 }
3010 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3011
3012 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3013 struct usb_interface *intf = udev->actconfig->interface[i];
3014 struct usb_interface_descriptor *desc;
3015
3016 /* set_interface resets host side toggle even
3017 * for altsetting zero. the interface may have no driver.
3018 */
3019 desc = &intf->cur_altsetting->desc;
3020 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3021 desc->bAlternateSetting);
3022 if (ret < 0) {
3023 dev_err(&udev->dev, "failed to restore interface %d "
3024 "altsetting %d (error=%d)\n",
3025 desc->bInterfaceNumber,
3026 desc->bAlternateSetting,
3027 ret);
3028 goto re_enumerate;
3029 }
3030 }
3031
3032done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 return 0;
3034
3035re_enumerate:
3036 hub_port_logical_disconnect(parent_hub, port1);
3037 return -ENODEV;
3038}
Alan Stern140d8f62006-07-01 22:07:21 -04003039EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003040
3041/**
3042 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3043 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3044 * @iface: interface bound to the driver making the request (optional)
3045 *
3046 * Warns all drivers bound to registered interfaces (using their pre_reset
3047 * method), performs the port reset, and then lets the drivers know that
3048 * the reset is over (using their post_reset method).
3049 *
3050 * Return value is the same as for usb_reset_device().
3051 *
3052 * The caller must own the device lock. For example, it's safe to use
3053 * this from a driver probe() routine after downloading new firmware.
3054 * For calls that might not occur during probe(), drivers should lock
3055 * the device using usb_lock_device_for_reset().
3056 *
3057 * The interface locks are acquired during the pre_reset stage and released
3058 * during the post_reset stage. However if iface is not NULL and is
3059 * currently being probed, we assume that the caller already owns its
3060 * lock.
3061 */
3062int usb_reset_composite_device(struct usb_device *udev,
3063 struct usb_interface *iface)
3064{
3065 int ret;
3066 struct usb_host_config *config = udev->actconfig;
3067
3068 if (udev->state == USB_STATE_NOTATTACHED ||
3069 udev->state == USB_STATE_SUSPENDED) {
3070 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3071 udev->state);
3072 return -EINVAL;
3073 }
3074
Alan Stern645daaa2006-08-30 15:47:02 -04003075 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003076 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003077
Alan Stern79efa092006-06-01 13:33:42 -04003078 if (iface && iface->condition != USB_INTERFACE_BINDING)
3079 iface = NULL;
3080
3081 if (config) {
3082 int i;
3083 struct usb_interface *cintf;
3084 struct usb_driver *drv;
3085
3086 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3087 cintf = config->interface[i];
3088 if (cintf != iface)
3089 down(&cintf->dev.sem);
3090 if (device_is_registered(&cintf->dev) &&
3091 cintf->dev.driver) {
3092 drv = to_usb_driver(cintf->dev.driver);
3093 if (drv->pre_reset)
3094 (drv->pre_reset)(cintf);
3095 }
3096 }
3097 }
3098
3099 ret = usb_reset_device(udev);
3100
3101 if (config) {
3102 int i;
3103 struct usb_interface *cintf;
3104 struct usb_driver *drv;
3105
3106 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3107 cintf = config->interface[i];
3108 if (device_is_registered(&cintf->dev) &&
3109 cintf->dev.driver) {
3110 drv = to_usb_driver(cintf->dev.driver);
3111 if (drv->post_reset)
3112 (drv->post_reset)(cintf);
3113 }
3114 if (cintf != iface)
3115 up(&cintf->dev.sem);
3116 }
3117 }
3118
Alan Stern94fcda12006-11-20 11:38:46 -05003119 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003120 return ret;
3121}
Alan Stern140d8f62006-07-01 22:07:21 -04003122EXPORT_SYMBOL(usb_reset_composite_device);