blob: ac1ef1527dd289b9f23ee6a3a834aef38c908ca5 [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;
Alan Sterne8054852007-05-04 11:55:11 -040037 struct kref kref;
Alan Stern1bb5f662006-11-06 11:56:13 -050038 struct urb *urb; /* for interrupt polling pipe */
39
40 /* buffer for urb ... with extra space in case of babble */
41 char (*buffer)[8];
42 dma_addr_t buffer_dma; /* DMA address for buffer */
43 union {
44 struct usb_hub_status hub;
45 struct usb_port_status port;
46 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050047 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050048
49 int error; /* last reported error */
50 int nerrors; /* track consecutive errors */
51
52 struct list_head event_list; /* hubs w/data or errs ready */
53 unsigned long event_bits[1]; /* status change bitmask */
54 unsigned long change_bits[1]; /* ports with logical connect
55 status change */
56 unsigned long busy_bits[1]; /* ports being reset or
57 resumed */
58#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
59#error event_bits[] is too short!
60#endif
61
62 struct usb_hub_descriptor *descriptor; /* class descriptor */
63 struct usb_tt tt; /* Transaction Translator */
64
65 unsigned mA_per_port; /* current for each child */
66
67 unsigned limited_power:1;
68 unsigned quiescing:1;
69 unsigned activating:1;
Alan Sterne8054852007-05-04 11:55:11 -040070 unsigned disconnected:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050071
72 unsigned has_indicators:1;
73 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000074 struct delayed_work leds;
Alan Stern1bb5f662006-11-06 11:56:13 -050075};
76
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050079 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
81static DEFINE_SPINLOCK(device_state_lock);
82
83/* khubd's worklist and its lock */
84static DEFINE_SPINLOCK(hub_event_lock);
85static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
86
87/* Wakes up khubd */
88static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
89
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070090static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92/* cycle leds on hubs that aren't blinking for attention */
93static int blinkenlights = 0;
94module_param (blinkenlights, bool, S_IRUGO);
95MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
96
97/*
98 * As of 2.6.10 we introduce a new USB device initialization scheme which
99 * closely resembles the way Windows works. Hopefully it will be compatible
100 * with a wider range of devices than the old scheme. However some previously
101 * working devices may start giving rise to "device not accepting address"
102 * errors; if that happens the user can try the old scheme by adjusting the
103 * following module parameters.
104 *
105 * For maximum flexibility there are two boolean parameters to control the
106 * hub driver's behavior. On the first initialization attempt, if the
107 * "old_scheme_first" parameter is set then the old scheme will be used,
108 * otherwise the new scheme is used. If that fails and "use_both_schemes"
109 * is set, then the driver will make another attempt, using the other scheme.
110 */
111static int old_scheme_first = 0;
112module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
113MODULE_PARM_DESC(old_scheme_first,
114 "start with the old device initialization scheme");
115
116static int use_both_schemes = 1;
117module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
118MODULE_PARM_DESC(use_both_schemes,
119 "try the other device initialization scheme if the "
120 "first one fails");
121
122
Dan Williams404d5b12007-04-26 00:12:10 -0700123static inline char *portspeed(int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
125 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
126 return "480 Mb/s";
127 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
128 return "1.5 Mb/s";
129 else
130 return "12 Mb/s";
131}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133/* Note that hdev or one of its children must be locked! */
134static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
135{
136 return usb_get_intfdata(hdev->actconfig->interface[0]);
137}
138
139/* USB 2.0 spec Section 11.24.4.5 */
140static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
141{
142 int i, ret;
143
144 for (i = 0; i < 3; i++) {
145 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
146 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
147 USB_DT_HUB << 8, 0, data, size,
148 USB_CTRL_GET_TIMEOUT);
149 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
150 return ret;
151 }
152 return -EINVAL;
153}
154
155/*
156 * USB 2.0 spec Section 11.24.2.1
157 */
158static int clear_hub_feature(struct usb_device *hdev, int feature)
159{
160 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
161 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
162}
163
164/*
165 * USB 2.0 spec Section 11.24.2.2
166 */
167static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
168{
169 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
170 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
171 NULL, 0, 1000);
172}
173
174/*
175 * USB 2.0 spec Section 11.24.2.13
176 */
177static int set_port_feature(struct usb_device *hdev, int port1, int feature)
178{
179 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
180 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
181 NULL, 0, 1000);
182}
183
184/*
185 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
186 * for info about using port indicators
187 */
188static void set_port_led(
189 struct usb_hub *hub,
190 int port1,
191 int selector
192)
193{
194 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
195 USB_PORT_FEAT_INDICATOR);
196 if (status < 0)
197 dev_dbg (hub->intfdev,
198 "port %d indicator %s status %d\n",
199 port1,
200 ({ char *s; switch (selector) {
201 case HUB_LED_AMBER: s = "amber"; break;
202 case HUB_LED_GREEN: s = "green"; break;
203 case HUB_LED_OFF: s = "off"; break;
204 case HUB_LED_AUTO: s = "auto"; break;
205 default: s = "??"; break;
206 }; s; }),
207 status);
208}
209
210#define LED_CYCLE_PERIOD ((2*HZ)/3)
211
David Howellsc4028952006-11-22 14:57:56 +0000212static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
David Howellsc4028952006-11-22 14:57:56 +0000214 struct usb_hub *hub =
215 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 struct usb_device *hdev = hub->hdev;
217 unsigned i;
218 unsigned changed = 0;
219 int cursor = -1;
220
221 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
222 return;
223
224 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
225 unsigned selector, mode;
226
227 /* 30%-50% duty cycle */
228
229 switch (hub->indicator[i]) {
230 /* cycle marker */
231 case INDICATOR_CYCLE:
232 cursor = i;
233 selector = HUB_LED_AUTO;
234 mode = INDICATOR_AUTO;
235 break;
236 /* blinking green = sw attention */
237 case INDICATOR_GREEN_BLINK:
238 selector = HUB_LED_GREEN;
239 mode = INDICATOR_GREEN_BLINK_OFF;
240 break;
241 case INDICATOR_GREEN_BLINK_OFF:
242 selector = HUB_LED_OFF;
243 mode = INDICATOR_GREEN_BLINK;
244 break;
245 /* blinking amber = hw attention */
246 case INDICATOR_AMBER_BLINK:
247 selector = HUB_LED_AMBER;
248 mode = INDICATOR_AMBER_BLINK_OFF;
249 break;
250 case INDICATOR_AMBER_BLINK_OFF:
251 selector = HUB_LED_OFF;
252 mode = INDICATOR_AMBER_BLINK;
253 break;
254 /* blink green/amber = reserved */
255 case INDICATOR_ALT_BLINK:
256 selector = HUB_LED_GREEN;
257 mode = INDICATOR_ALT_BLINK_OFF;
258 break;
259 case INDICATOR_ALT_BLINK_OFF:
260 selector = HUB_LED_AMBER;
261 mode = INDICATOR_ALT_BLINK;
262 break;
263 default:
264 continue;
265 }
266 if (selector != HUB_LED_AUTO)
267 changed = 1;
268 set_port_led(hub, i + 1, selector);
269 hub->indicator[i] = mode;
270 }
271 if (!changed && blinkenlights) {
272 cursor++;
273 cursor %= hub->descriptor->bNbrPorts;
274 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
275 hub->indicator[cursor] = INDICATOR_CYCLE;
276 changed++;
277 }
278 if (changed)
279 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
280}
281
282/* use a short timeout for hub/port status fetches */
283#define USB_STS_TIMEOUT 1000
284#define USB_STS_RETRIES 5
285
286/*
287 * USB 2.0 spec Section 11.24.2.6
288 */
289static int get_hub_status(struct usb_device *hdev,
290 struct usb_hub_status *data)
291{
292 int i, status = -ETIMEDOUT;
293
294 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
295 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
296 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
297 data, sizeof(*data), USB_STS_TIMEOUT);
298 }
299 return status;
300}
301
302/*
303 * USB 2.0 spec Section 11.24.2.7
304 */
305static int get_port_status(struct usb_device *hdev, int port1,
306 struct usb_port_status *data)
307{
308 int i, status = -ETIMEDOUT;
309
310 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
311 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
312 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
313 data, sizeof(*data), USB_STS_TIMEOUT);
314 }
315 return status;
316}
317
318static void kick_khubd(struct usb_hub *hub)
319{
320 unsigned long flags;
321
Alan Stern40f122f2006-11-09 14:44:33 -0500322 /* Suppress autosuspend until khubd runs */
323 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
324
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 spin_lock_irqsave(&hub_event_lock, flags);
Alan Sterne8054852007-05-04 11:55:11 -0400326 if (!hub->disconnected & list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 list_add_tail(&hub->event_list, &hub_event_list);
328 wake_up(&khubd_wait);
329 }
330 spin_unlock_irqrestore(&hub_event_lock, flags);
331}
332
333void usb_kick_khubd(struct usb_device *hdev)
334{
Alan Sterne8054852007-05-04 11:55:11 -0400335 /* FIXME: What if hdev isn't bound to the hub driver? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 kick_khubd(hdev_to_hub(hdev));
337}
338
339
340/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100341static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200343 struct usb_hub *hub = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 int status;
345 int i;
346 unsigned long bits;
347
348 switch (urb->status) {
349 case -ENOENT: /* synchronous unlink */
350 case -ECONNRESET: /* async unlink */
351 case -ESHUTDOWN: /* hardware going away */
352 return;
353
354 default: /* presumably an error */
355 /* Cause a hub reset after 10 consecutive errors */
356 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
357 if ((++hub->nerrors < 10) || hub->error)
358 goto resubmit;
359 hub->error = urb->status;
360 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 /* let khubd handle things */
363 case 0: /* we got data: port status changed */
364 bits = 0;
365 for (i = 0; i < urb->actual_length; ++i)
366 bits |= ((unsigned long) ((*hub->buffer)[i]))
367 << (i*8);
368 hub->event_bits[0] = bits;
369 break;
370 }
371
372 hub->nerrors = 0;
373
374 /* Something happened, let khubd figure it out */
375 kick_khubd(hub);
376
377resubmit:
378 if (hub->quiescing)
379 return;
380
381 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
382 && status != -ENODEV && status != -EPERM)
383 dev_err (hub->intfdev, "resubmit --> %d\n", status);
384}
385
386/* USB 2.0 spec Section 11.24.2.3 */
387static inline int
388hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
389{
390 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
391 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
392 tt, NULL, 0, 1000);
393}
394
395/*
396 * enumeration blocks khubd for a long time. we use keventd instead, since
397 * long blocking there is the exception, not the rule. accordingly, HCDs
398 * talking to TTs must queue control transfers (not just bulk and iso), so
399 * both can talk to the same hub concurrently.
400 */
David Howellsc4028952006-11-22 14:57:56 +0000401static void hub_tt_kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
David Howellsc4028952006-11-22 14:57:56 +0000403 struct usb_hub *hub =
404 container_of(work, struct usb_hub, tt.kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 unsigned long flags;
Mark Lord55e5fdf2007-05-14 19:48:02 -0400406 int limit = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408 spin_lock_irqsave (&hub->tt.lock, flags);
Mark Lord55e5fdf2007-05-14 19:48:02 -0400409 while (--limit && !list_empty (&hub->tt.clear_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 struct list_head *temp;
411 struct usb_tt_clear *clear;
412 struct usb_device *hdev = hub->hdev;
413 int status;
414
415 temp = hub->tt.clear_list.next;
416 clear = list_entry (temp, struct usb_tt_clear, clear_list);
417 list_del (&clear->clear_list);
418
419 /* drop lock so HCD can concurrently report other TT errors */
420 spin_unlock_irqrestore (&hub->tt.lock, flags);
421 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
422 spin_lock_irqsave (&hub->tt.lock, flags);
423
424 if (status)
425 dev_err (&hdev->dev,
426 "clear tt %d (%04x) error %d\n",
427 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700428 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 }
430 spin_unlock_irqrestore (&hub->tt.lock, flags);
431}
432
433/**
434 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
435 * @udev: the device whose split transaction failed
436 * @pipe: identifies the endpoint of the failed transaction
437 *
438 * High speed HCDs use this to tell the hub driver that some split control or
439 * bulk transaction failed in a way that requires clearing internal state of
440 * a transaction translator. This is normally detected (and reported) from
441 * interrupt context.
442 *
443 * It may not be possible for that hub to handle additional full (or low)
444 * speed transactions until that state is fully cleared out.
445 */
446void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
447{
448 struct usb_tt *tt = udev->tt;
449 unsigned long flags;
450 struct usb_tt_clear *clear;
451
452 /* we've got to cope with an arbitrary number of pending TT clears,
453 * since each TT has "at least two" buffers that can need it (and
454 * there can be many TTs per hub). even if they're uncommon.
455 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800456 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
458 /* FIXME recover somehow ... RESET_TT? */
459 return;
460 }
461
462 /* info that CLEAR_TT_BUFFER needs */
463 clear->tt = tt->multi ? udev->ttport : 1;
464 clear->devinfo = usb_pipeendpoint (pipe);
465 clear->devinfo |= udev->devnum << 4;
466 clear->devinfo |= usb_pipecontrol (pipe)
467 ? (USB_ENDPOINT_XFER_CONTROL << 11)
468 : (USB_ENDPOINT_XFER_BULK << 11);
469 if (usb_pipein (pipe))
470 clear->devinfo |= 1 << 15;
471
472 /* tell keventd to clear state for this TT */
473 spin_lock_irqsave (&tt->lock, flags);
474 list_add_tail (&clear->clear_list, &tt->clear_list);
475 schedule_work (&tt->kevent);
476 spin_unlock_irqrestore (&tt->lock, flags);
477}
478
479static void hub_power_on(struct usb_hub *hub)
480{
481 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700482 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400483 u16 wHubCharacteristics =
484 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Alan Stern4489a572006-04-27 15:54:22 -0400486 /* Enable power on each port. Some hubs have reserved values
487 * of LPSM (> 2) in their descriptors, even though they are
488 * USB 2.0 hubs. Some hubs do not implement port-power switching
489 * but only emulate it. In all cases, the ports won't work
490 * unless we send these messages to the hub.
491 */
492 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400494 else
495 dev_dbg(hub->intfdev, "trying to enable port power on "
496 "non-switchable hub\n");
497 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
498 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
David Brownellb7896962005-08-31 10:41:44 -0700500 /* Wait at least 100 msec for power to become stable */
501 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502}
503
Alan Stern02c399e2006-08-30 15:47:11 -0400504static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
David Brownell979d5192005-09-22 22:32:24 -0700506 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700508 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700509
David Brownell979d5192005-09-22 22:32:24 -0700510 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 usb_kill_urb(hub->urb);
512 if (hub->has_indicators)
513 cancel_delayed_work(&hub->leds);
514 if (hub->has_indicators || hub->tt.hub)
515 flush_scheduled_work();
516}
517
518static void hub_activate(struct usb_hub *hub)
519{
520 int status;
521
522 hub->quiescing = 0;
523 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 status = usb_submit_urb(hub->urb, GFP_NOIO);
526 if (status < 0)
527 dev_err(hub->intfdev, "activate --> %d\n", status);
528 if (hub->has_indicators && blinkenlights)
529 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
530
531 /* scan all ports ASAP */
532 kick_khubd(hub);
533}
534
535static int hub_hub_status(struct usb_hub *hub,
536 u16 *status, u16 *change)
537{
538 int ret;
539
Alan Sterndb90e7a2007-02-05 09:56:15 -0500540 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 ret = get_hub_status(hub->hdev, &hub->status->hub);
542 if (ret < 0)
543 dev_err (hub->intfdev,
544 "%s failed (err = %d)\n", __FUNCTION__, ret);
545 else {
546 *status = le16_to_cpu(hub->status->hub.wHubStatus);
547 *change = le16_to_cpu(hub->status->hub.wHubChange);
548 ret = 0;
549 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500550 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return ret;
552}
553
Alan Stern8b28c752005-08-10 17:04:13 -0400554static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
555{
556 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400557 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400558
Alan Stern0458d5b2007-05-04 11:52:20 -0400559 if (hdev->children[port1-1] && set_state)
Alan Stern8b28c752005-08-10 17:04:13 -0400560 usb_set_device_state(hdev->children[port1-1],
561 USB_STATE_NOTATTACHED);
Alan Stern0458d5b2007-05-04 11:52:20 -0400562 if (!hub->error)
563 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
Alan Stern8b28c752005-08-10 17:04:13 -0400564 if (ret)
565 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
Alan Stern0458d5b2007-05-04 11:52:20 -0400566 port1, ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400567 return ret;
568}
569
Alan Stern0458d5b2007-05-04 11:52:20 -0400570/*
571 * Disable a port and mark a logical connnect-change event, so that some
572 * time later khubd will disconnect() any existing usb_device on the port
573 * and will re-enumerate if there actually is a device attached.
574 */
575static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
576{
577 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
578 hub_port_disable(hub, port1, 1);
579
580 /* FIXME let caller ask to power down the port:
581 * - some devices won't enumerate without a VBUS power cycle
582 * - SRP saves power that way
583 * - ... new call, TBD ...
584 * That's easy if this hub can switch power per-port, and
585 * khubd reactivates the port later (timer, SRP, etc).
586 * Powerdown must be optional, because of reset/DFU.
587 */
588
589 set_bit(port1, hub->change_bits);
590 kick_khubd(hub);
591}
592
593static void disconnect_all_children(struct usb_hub *hub, int logical)
594{
595 struct usb_device *hdev = hub->hdev;
596 int port1;
597
598 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
599 if (hdev->children[port1-1]) {
600 if (logical)
601 hub_port_logical_disconnect(hub, port1);
602 else
603 usb_disconnect(&hdev->children[port1-1]);
604 }
605 }
606}
607
608#ifdef CONFIG_USB_PERSIST
609
610#define USB_PERSIST 1
611
612/* For "persistent-device" resets we must mark the child devices for reset
613 * and turn off a possible connect-change status (so khubd won't disconnect
614 * them later).
615 */
616static void mark_children_for_reset_resume(struct usb_hub *hub)
617{
618 struct usb_device *hdev = hub->hdev;
619 int port1;
620
621 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
622 struct usb_device *child = hdev->children[port1-1];
623
624 if (child) {
625 child->reset_resume = 1;
626 clear_port_feature(hdev, port1,
627 USB_PORT_FEAT_C_CONNECTION);
628 }
629 }
630}
631
632#else
633
634#define USB_PERSIST 0
635
636static inline void mark_children_for_reset_resume(struct usb_hub *hub)
637{ }
638
639#endif /* CONFIG_USB_PERSIST */
Alan Stern7d069b72005-11-18 12:06:34 -0500640
641/* caller has locked the hub device */
Alan Stern7de18d82006-06-01 13:37:24 -0400642static void hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500643{
Alan Stern7de18d82006-06-01 13:37:24 -0400644 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Stern7d069b72005-11-18 12:06:34 -0500645
Alan Stern0458d5b2007-05-04 11:52:20 -0400646 /* This routine doesn't run as part of a reset-resume, so it's safe
647 * to disconnect all the drivers below the hub.
648 */
649 disconnect_all_children(hub, 0);
Alan Stern7d069b72005-11-18 12:06:34 -0500650 hub_quiesce(hub);
651}
652
653/* caller has locked the hub device */
Alan Stern0458d5b2007-05-04 11:52:20 -0400654static void hub_post_reset(struct usb_interface *intf, int reset_resume)
Alan Stern7d069b72005-11-18 12:06:34 -0500655{
Alan Stern7de18d82006-06-01 13:37:24 -0400656 struct usb_hub *hub = usb_get_intfdata(intf);
657
Alan Stern7d069b72005-11-18 12:06:34 -0500658 hub_power_on(hub);
Alan Stern0458d5b2007-05-04 11:52:20 -0400659 if (reset_resume) {
660 if (USB_PERSIST)
661 mark_children_for_reset_resume(hub);
662 else {
663 /* Reset-resume doesn't call pre_reset, so we have to
664 * disconnect the children here. But we may not lock
665 * the child devices, so we have to do a "logical"
666 * disconnect.
667 */
668 disconnect_all_children(hub, 1);
669 }
670 }
671 hub_activate(hub);
Alan Stern7d069b72005-11-18 12:06:34 -0500672}
673
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675static int hub_configure(struct usb_hub *hub,
676 struct usb_endpoint_descriptor *endpoint)
677{
678 struct usb_device *hdev = hub->hdev;
679 struct device *hub_dev = hub->intfdev;
680 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700681 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 unsigned int pipe;
683 int maxp, ret;
684 char *message;
685
686 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
687 &hub->buffer_dma);
688 if (!hub->buffer) {
689 message = "can't allocate hub irq buffer";
690 ret = -ENOMEM;
691 goto fail;
692 }
693
694 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
695 if (!hub->status) {
696 message = "can't kmalloc hub status buffer";
697 ret = -ENOMEM;
698 goto fail;
699 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500700 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
703 if (!hub->descriptor) {
704 message = "can't kmalloc hub descriptor";
705 ret = -ENOMEM;
706 goto fail;
707 }
708
709 /* Request the entire hub descriptor.
710 * hub->descriptor can handle USB_MAXCHILDREN ports,
711 * but the hub can/will return fewer bytes here.
712 */
713 ret = get_hub_descriptor(hdev, hub->descriptor,
714 sizeof(*hub->descriptor));
715 if (ret < 0) {
716 message = "can't read hub descriptor";
717 goto fail;
718 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
719 message = "hub has too many ports!";
720 ret = -ENODEV;
721 goto fail;
722 }
723
724 hdev->maxchild = hub->descriptor->bNbrPorts;
725 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
726 (hdev->maxchild == 1) ? "" : "s");
727
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700728 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700730 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 int i;
732 char portstr [USB_MAXCHILDREN + 1];
733
734 for (i = 0; i < hdev->maxchild; i++)
735 portstr[i] = hub->descriptor->DeviceRemovable
736 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
737 ? 'F' : 'R';
738 portstr[hdev->maxchild] = 0;
739 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
740 } else
741 dev_dbg(hub_dev, "standalone hub\n");
742
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700743 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 case 0x00:
745 dev_dbg(hub_dev, "ganged power switching\n");
746 break;
747 case 0x01:
748 dev_dbg(hub_dev, "individual port power switching\n");
749 break;
750 case 0x02:
751 case 0x03:
752 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
753 break;
754 }
755
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700756 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 case 0x00:
758 dev_dbg(hub_dev, "global over-current protection\n");
759 break;
760 case 0x08:
761 dev_dbg(hub_dev, "individual port over-current protection\n");
762 break;
763 case 0x10:
764 case 0x18:
765 dev_dbg(hub_dev, "no over-current protection\n");
766 break;
767 }
768
769 spin_lock_init (&hub->tt.lock);
770 INIT_LIST_HEAD (&hub->tt.clear_list);
David Howellsc4028952006-11-22 14:57:56 +0000771 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 switch (hdev->descriptor.bDeviceProtocol) {
773 case 0:
774 break;
775 case 1:
776 dev_dbg(hub_dev, "Single TT\n");
777 hub->tt.hub = hdev;
778 break;
779 case 2:
780 ret = usb_set_interface(hdev, 0, 1);
781 if (ret == 0) {
782 dev_dbg(hub_dev, "TT per port\n");
783 hub->tt.multi = 1;
784 } else
785 dev_err(hub_dev, "Using single TT (err %d)\n",
786 ret);
787 hub->tt.hub = hdev;
788 break;
789 default:
790 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
791 hdev->descriptor.bDeviceProtocol);
792 break;
793 }
794
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700795 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700796 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700797 case HUB_TTTT_8_BITS:
798 if (hdev->descriptor.bDeviceProtocol != 0) {
799 hub->tt.think_time = 666;
800 dev_dbg(hub_dev, "TT requires at most %d "
801 "FS bit times (%d ns)\n",
802 8, hub->tt.think_time);
803 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700805 case HUB_TTTT_16_BITS:
806 hub->tt.think_time = 666 * 2;
807 dev_dbg(hub_dev, "TT requires at most %d "
808 "FS bit times (%d ns)\n",
809 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700811 case HUB_TTTT_24_BITS:
812 hub->tt.think_time = 666 * 3;
813 dev_dbg(hub_dev, "TT requires at most %d "
814 "FS bit times (%d ns)\n",
815 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700817 case HUB_TTTT_32_BITS:
818 hub->tt.think_time = 666 * 4;
819 dev_dbg(hub_dev, "TT requires at most %d "
820 "FS bit times (%d ns)\n",
821 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 break;
823 }
824
825 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700826 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 hub->has_indicators = 1;
828 dev_dbg(hub_dev, "Port indicators are supported\n");
829 }
830
831 dev_dbg(hub_dev, "power on to power good time: %dms\n",
832 hub->descriptor->bPwrOn2PwrGood * 2);
833
834 /* power budgeting mostly matters with bus-powered hubs,
835 * and battery-powered root hubs (may provide just 8 mA).
836 */
837 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500838 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 message = "can't get hub status";
840 goto fail;
841 }
Alan Stern7d35b922005-04-25 11:18:32 -0400842 le16_to_cpus(&hubstatus);
843 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500844 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
845 hub->mA_per_port = 500;
846 else {
847 hub->mA_per_port = hdev->bus_mA;
848 hub->limited_power = 1;
849 }
Alan Stern7d35b922005-04-25 11:18:32 -0400850 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
852 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500853 hub->limited_power = 1;
854 if (hdev->maxchild > 0) {
855 int remaining = hdev->bus_mA -
856 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Alan Stern55c52712005-11-23 12:03:12 -0500858 if (remaining < hdev->maxchild * 100)
859 dev_warn(hub_dev,
860 "insufficient power available "
861 "to use all downstream ports\n");
862 hub->mA_per_port = 100; /* 7.2.1.1 */
863 }
864 } else { /* Self-powered external hub */
865 /* FIXME: What about battery-powered external hubs that
866 * provide less current per port? */
867 hub->mA_per_port = 500;
868 }
869 if (hub->mA_per_port < 500)
870 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
871 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
873 ret = hub_hub_status(hub, &hubstatus, &hubchange);
874 if (ret < 0) {
875 message = "can't get hub status";
876 goto fail;
877 }
878
879 /* local power status reports aren't always correct */
880 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
881 dev_dbg(hub_dev, "local power source is %s\n",
882 (hubstatus & HUB_STATUS_LOCAL_POWER)
883 ? "lost (inactive)" : "good");
884
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700885 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 dev_dbg(hub_dev, "%sover-current condition exists\n",
887 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
888
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700889 /* set up the interrupt endpoint
890 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
891 * bytes as USB2.0[11.12.3] says because some hubs are known
892 * to send more data (and thus cause overflow). For root hubs,
893 * maxpktsize is defined in hcd.c's fake endpoint descriptors
894 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
896 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
897
898 if (maxp > sizeof(*hub->buffer))
899 maxp = sizeof(*hub->buffer);
900
901 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
902 if (!hub->urb) {
903 message = "couldn't allocate interrupt urb";
904 ret = -ENOMEM;
905 goto fail;
906 }
907
908 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
909 hub, endpoint->bInterval);
910 hub->urb->transfer_dma = hub->buffer_dma;
911 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
912
913 /* maybe cycle the hub leds */
914 if (hub->has_indicators && blinkenlights)
915 hub->indicator [0] = INDICATOR_CYCLE;
916
917 hub_power_on(hub);
918 hub_activate(hub);
919 return 0;
920
921fail:
922 dev_err (hub_dev, "config failed, %s (err %d)\n",
923 message, ret);
924 /* hub_disconnect() frees urb and descriptor */
925 return ret;
926}
927
Alan Sterne8054852007-05-04 11:55:11 -0400928static void hub_release(struct kref *kref)
929{
930 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
931
932 usb_put_intf(to_usb_interface(hub->intfdev));
933 kfree(hub);
934}
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936static unsigned highspeed_hubs;
937
938static void hub_disconnect(struct usb_interface *intf)
939{
940 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Sterne8054852007-05-04 11:55:11 -0400941
942 /* Take the hub off the event list and don't let it be added again */
943 spin_lock_irq(&hub_event_lock);
944 list_del_init(&hub->event_list);
945 hub->disconnected = 1;
946 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Alan Stern7de18d82006-06-01 13:37:24 -0400948 /* Disconnect all children and quiesce the hub */
949 hub->error = 0;
950 hub_pre_reset(intf);
951
Alan Stern8b28c752005-08-10 17:04:13 -0400952 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Alan Sterne8054852007-05-04 11:55:11 -0400954 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 highspeed_hubs--;
956
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 usb_free_urb(hub->urb);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700958 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700959 kfree(hub->status);
Alan Sterne8054852007-05-04 11:55:11 -0400960 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
961 hub->buffer_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Alan Sterne8054852007-05-04 11:55:11 -0400963 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964}
965
966static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
967{
968 struct usb_host_interface *desc;
969 struct usb_endpoint_descriptor *endpoint;
970 struct usb_device *hdev;
971 struct usb_hub *hub;
972
973 desc = intf->cur_altsetting;
974 hdev = interface_to_usbdev(intf);
975
David Brownell89ccbdc2006-04-02 10:18:09 -0800976#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
977 if (hdev->parent) {
978 dev_warn(&intf->dev, "ignoring external hub\n");
979 return -ENODEV;
980 }
981#endif
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 /* Some hubs have a subclass of 1, which AFAICT according to the */
984 /* specs is not defined, but it works */
985 if ((desc->desc.bInterfaceSubClass != 0) &&
986 (desc->desc.bInterfaceSubClass != 1)) {
987descriptor_error:
988 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
989 return -EIO;
990 }
991
992 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
993 if (desc->desc.bNumEndpoints != 1)
994 goto descriptor_error;
995
996 endpoint = &desc->endpoint[0].desc;
997
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700998 /* If it's not an interrupt in endpoint, we'd better punt! */
999 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 goto descriptor_error;
1001
1002 /* We found a hub */
1003 dev_info (&intf->dev, "USB hub found\n");
1004
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001005 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 if (!hub) {
1007 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1008 return -ENOMEM;
1009 }
1010
Alan Sterne8054852007-05-04 11:55:11 -04001011 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 INIT_LIST_HEAD(&hub->event_list);
1013 hub->intfdev = &intf->dev;
1014 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001015 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Sterne8054852007-05-04 11:55:11 -04001016 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
1018 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001019 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 if (hdev->speed == USB_SPEED_HIGH)
1022 highspeed_hubs++;
1023
1024 if (hub_configure(hub, endpoint) >= 0)
1025 return 0;
1026
1027 hub_disconnect (intf);
1028 return -ENODEV;
1029}
1030
1031static int
1032hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1033{
1034 struct usb_device *hdev = interface_to_usbdev (intf);
1035
1036 /* assert ifno == 0 (part of hub spec) */
1037 switch (code) {
1038 case USBDEVFS_HUB_PORTINFO: {
1039 struct usbdevfs_hub_portinfo *info = user_data;
1040 int i;
1041
1042 spin_lock_irq(&device_state_lock);
1043 if (hdev->devnum <= 0)
1044 info->nports = 0;
1045 else {
1046 info->nports = hdev->maxchild;
1047 for (i = 0; i < info->nports; i++) {
1048 if (hdev->children[i] == NULL)
1049 info->port[i] = 0;
1050 else
1051 info->port[i] =
1052 hdev->children[i]->devnum;
1053 }
1054 }
1055 spin_unlock_irq(&device_state_lock);
1056
1057 return info->nports + 1;
1058 }
1059
1060 default:
1061 return -ENOSYS;
1062 }
1063}
1064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1067{
1068 int i;
1069
1070 for (i = 0; i < udev->maxchild; ++i) {
1071 if (udev->children[i])
1072 recursively_mark_NOTATTACHED(udev->children[i]);
1073 }
Alan Sternee49fb52006-11-22 16:55:54 -05001074 if (udev->state == USB_STATE_SUSPENDED)
1075 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 udev->state = USB_STATE_NOTATTACHED;
1077}
1078
1079/**
1080 * usb_set_device_state - change a device's current state (usbcore, hcds)
1081 * @udev: pointer to device whose state should be changed
1082 * @new_state: new state value to be stored
1083 *
1084 * udev->state is _not_ fully protected by the device lock. Although
1085 * most transitions are made only while holding the lock, the state can
1086 * can change to USB_STATE_NOTATTACHED at almost any time. This
1087 * is so that devices can be marked as disconnected as soon as possible,
1088 * without having to wait for any semaphores to be released. As a result,
1089 * all changes to any device's state must be protected by the
1090 * device_state_lock spinlock.
1091 *
1092 * Once a device has been added to the device tree, all changes to its state
1093 * should be made using this routine. The state should _not_ be set directly.
1094 *
1095 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1096 * Otherwise udev->state is set to new_state, and if new_state is
1097 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1098 * to USB_STATE_NOTATTACHED.
1099 */
1100void usb_set_device_state(struct usb_device *udev,
1101 enum usb_device_state new_state)
1102{
1103 unsigned long flags;
1104
1105 spin_lock_irqsave(&device_state_lock, flags);
1106 if (udev->state == USB_STATE_NOTATTACHED)
1107 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001108 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001109
1110 /* root hub wakeup capabilities are managed out-of-band
1111 * and may involve silicon errata ... ignore them here.
1112 */
1113 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001114 if (udev->state == USB_STATE_SUSPENDED
1115 || new_state == USB_STATE_SUSPENDED)
1116 ; /* No change to wakeup settings */
1117 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001118 device_init_wakeup(&udev->dev,
1119 (udev->actconfig->desc.bmAttributes
1120 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001121 else
David Brownellfb669cc2006-01-24 08:40:27 -08001122 device_init_wakeup(&udev->dev, 0);
1123 }
Alan Stern645daaa2006-08-30 15:47:02 -04001124 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001125 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 recursively_mark_NOTATTACHED(udev);
1127 spin_unlock_irqrestore(&device_state_lock, flags);
1128}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
1130
Alan Sternd388dab2006-07-01 22:14:24 -04001131#ifdef CONFIG_PM
Alan Stern1c50c312005-11-14 11:45:38 -05001132
1133/**
Alan Stern0458d5b2007-05-04 11:52:20 -04001134 * usb_reset_suspended_device - reset a suspended device instead of resuming it
1135 * @udev: device to be reset instead of resumed
1136 *
1137 * If a host controller doesn't maintain VBUS suspend current during a
1138 * system sleep or is reset when the system wakes up, all the USB
1139 * power sessions below it will be broken. This is especially troublesome
1140 * for mass-storage devices containing mounted filesystems, since the
1141 * device will appear to have disconnected and all the memory mappings
1142 * to it will be lost.
1143 *
1144 * As an alternative, this routine attempts to recover power sessions for
1145 * devices that are still present by resetting them instead of resuming
1146 * them. If all goes well, the devices will appear to persist across the
1147 * the interruption of the power sessions.
1148 *
1149 * This facility is inherently dangerous. Although usb_reset_device()
1150 * makes every effort to insure that the same device is present after the
1151 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1152 * quite possible for a device to remain unaltered but its media to be
1153 * changed. If the user replaces a flash memory card while the system is
1154 * asleep, he will have only himself to blame when the filesystem on the
1155 * new card is corrupted and the system crashes.
1156 */
1157int usb_reset_suspended_device(struct usb_device *udev)
1158{
1159 int rc = 0;
1160
1161 dev_dbg(&udev->dev, "usb %sresume\n", "reset-");
1162
1163 /* After we're done the device won't be suspended any more.
1164 * In addition, the reset won't work if udev->state is SUSPENDED.
1165 */
1166 usb_set_device_state(udev, udev->actconfig
1167 ? USB_STATE_CONFIGURED
1168 : USB_STATE_ADDRESS);
1169
1170 /* Root hubs don't need to be (and can't be) reset */
1171 if (udev->parent)
1172 rc = usb_reset_device(udev);
1173 return rc;
1174}
1175
1176/**
Alan Stern1c50c312005-11-14 11:45:38 -05001177 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1178 * @rhdev: struct usb_device for the root hub
1179 *
1180 * The USB host controller driver calls this function when its root hub
1181 * is resumed and Vbus power has been interrupted or the controller
Alan Stern0458d5b2007-05-04 11:52:20 -04001182 * has been reset. The routine marks @rhdev as having lost power. When
1183 * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
1184 * is enabled then it will carry out power-session recovery, otherwise
1185 * it will disconnect all the child devices.
Alan Stern1c50c312005-11-14 11:45:38 -05001186 */
1187void usb_root_hub_lost_power(struct usb_device *rhdev)
1188{
Alan Stern1c50c312005-11-14 11:45:38 -05001189 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
Alan Stern0458d5b2007-05-04 11:52:20 -04001190 rhdev->reset_resume = 1;
Alan Stern1c50c312005-11-14 11:45:38 -05001191}
1192EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1193
Alan Sternd388dab2006-07-01 22:14:24 -04001194#endif /* CONFIG_PM */
Alan Stern1c50c312005-11-14 11:45:38 -05001195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196static void choose_address(struct usb_device *udev)
1197{
1198 int devnum;
1199 struct usb_bus *bus = udev->bus;
1200
1201 /* If khubd ever becomes multithreaded, this will need a lock */
1202
1203 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1204 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1205 bus->devnum_next);
1206 if (devnum >= 128)
1207 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1208
1209 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1210
1211 if (devnum < 128) {
1212 set_bit(devnum, bus->devmap.devicemap);
1213 udev->devnum = devnum;
1214 }
1215}
1216
1217static void release_address(struct usb_device *udev)
1218{
1219 if (udev->devnum > 0) {
1220 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1221 udev->devnum = -1;
1222 }
1223}
1224
Alan Sternd5d4db72007-05-29 16:34:52 -04001225#ifdef CONFIG_USB_SUSPEND
1226
1227static void usb_stop_pm(struct usb_device *udev)
1228{
1229 /* Synchronize with the ksuspend thread to prevent any more
1230 * autosuspend requests from being submitted, and decrement
1231 * the parent's count of unsuspended children.
1232 */
1233 usb_pm_lock(udev);
1234 if (udev->parent && !udev->discon_suspended)
1235 usb_autosuspend_device(udev->parent);
1236 usb_pm_unlock(udev);
1237
1238 /* Stop any autosuspend requests already submitted */
1239 cancel_rearming_delayed_work(&udev->autosuspend);
1240}
1241
1242#else
1243
1244static inline void usb_stop_pm(struct usb_device *udev)
1245{ }
1246
1247#endif
1248
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249/**
1250 * usb_disconnect - disconnect a device (usbcore-internal)
1251 * @pdev: pointer to device being disconnected
1252 * Context: !in_interrupt ()
1253 *
1254 * Something got disconnected. Get rid of it and all of its children.
1255 *
1256 * If *pdev is a normal device then the parent hub must already be locked.
1257 * If *pdev is a root hub then this routine will acquire the
1258 * usb_bus_list_lock on behalf of the caller.
1259 *
1260 * Only hub drivers (including virtual root hub drivers for host
1261 * controllers) should ever call this.
1262 *
1263 * This call is synchronous, and may not be used in an interrupt context.
1264 */
1265void usb_disconnect(struct usb_device **pdev)
1266{
1267 struct usb_device *udev = *pdev;
1268 int i;
1269
1270 if (!udev) {
1271 pr_debug ("%s nodev\n", __FUNCTION__);
1272 return;
1273 }
1274
1275 /* mark the device as inactive, so any further urb submissions for
1276 * this device (and any of its children) will fail immediately.
1277 * this quiesces everyting except pending urbs.
1278 */
1279 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1281
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001282 usb_lock_device(udev);
1283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 /* Free up all the children before we remove this device */
1285 for (i = 0; i < USB_MAXCHILDREN; i++) {
1286 if (udev->children[i])
1287 usb_disconnect(&udev->children[i]);
1288 }
1289
1290 /* deallocate hcd/hardware state ... nuking all pending urbs and
1291 * cleaning up all state associated with the current configuration
1292 * so that the hardware is now fully quiesced.
1293 */
Alan Stern782da722006-07-01 22:09:35 -04001294 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 usb_disable_device(udev, 0);
1296
Alan Stern782da722006-07-01 22:09:35 -04001297 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001298
Alan Stern782da722006-07-01 22:09:35 -04001299 /* Unregister the device. The device driver is responsible
1300 * for removing the device files from usbfs and sysfs and for
1301 * de-configuring the device.
1302 */
1303 device_del(&udev->dev);
1304
1305 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 * (or root_hub) pointer.
1307 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310 /* Avoid races with recursively_mark_NOTATTACHED() */
1311 spin_lock_irq(&device_state_lock);
1312 *pdev = NULL;
1313 spin_unlock_irq(&device_state_lock);
1314
Alan Sternd5d4db72007-05-29 16:34:52 -04001315 usb_stop_pm(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001316
Alan Stern782da722006-07-01 22:09:35 -04001317 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318}
1319
1320#ifdef DEBUG
1321static void show_string(struct usb_device *udev, char *id, char *string)
1322{
1323 if (!string)
1324 return;
1325 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1326}
1327
1328#else
1329static inline void show_string(struct usb_device *udev, char *id, char *string)
1330{}
1331#endif
1332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
1334#ifdef CONFIG_USB_OTG
1335#include "otg_whitelist.h"
1336#endif
1337
Oliver Neukum3ede7602007-01-11 14:35:50 +01001338/**
1339 * usb_new_device - perform initial device setup (usbcore-internal)
1340 * @udev: newly addressed device (in ADDRESS state)
1341 *
1342 * This is called with devices which have been enumerated, but not yet
1343 * configured. The device descriptor is available, but not descriptors
1344 * for any device configuration. The caller must have locked either
1345 * the parent hub (if udev is a normal device) or else the
1346 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1347 * udev has already been installed, but udev is not yet visible through
1348 * sysfs or other filesystem code.
1349 *
1350 * It will return if the device is configured properly or not. Zero if
1351 * the interface was registered with the driver core; else a negative
1352 * errno value.
1353 *
1354 * This call is synchronous, and may not be used in an interrupt context.
1355 *
1356 * Only the hub driver or root-hub registrar should ever call this.
1357 */
1358int usb_new_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359{
1360 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Oliver Neukum7ceec1f2007-01-26 14:26:21 +01001362 /* Determine quirks */
1363 usb_detect_quirks(udev);
1364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 err = usb_get_configuration(udev);
1366 if (err < 0) {
1367 dev_err(&udev->dev, "can't read configurations, error %d\n",
1368 err);
1369 goto fail;
1370 }
1371
1372 /* read the standard strings and cache them if present */
Alan Stern4f62efe2005-10-24 16:24:14 -04001373 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1374 udev->manufacturer = usb_cache_string(udev,
1375 udev->descriptor.iManufacturer);
1376 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
1378 /* Tell the world! */
1379 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1380 "SerialNumber=%d\n",
1381 udev->descriptor.iManufacturer,
1382 udev->descriptor.iProduct,
1383 udev->descriptor.iSerialNumber);
1384 show_string(udev, "Product", udev->product);
1385 show_string(udev, "Manufacturer", udev->manufacturer);
1386 show_string(udev, "SerialNumber", udev->serial);
1387
1388#ifdef CONFIG_USB_OTG
1389 /*
1390 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1391 * to wake us after we've powered off VBUS; and HNP, switching roles
1392 * "host" to "peripheral". The OTG descriptor helps figure this out.
1393 */
1394 if (!udev->bus->is_b_host
1395 && udev->config
1396 && udev->parent == udev->bus->root_hub) {
1397 struct usb_otg_descriptor *desc = 0;
1398 struct usb_bus *bus = udev->bus;
1399
1400 /* descriptor may appear anywhere in config */
1401 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1402 le16_to_cpu(udev->config[0].desc.wTotalLength),
1403 USB_DT_OTG, (void **) &desc) == 0) {
1404 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001405 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 dev_info(&udev->dev,
1408 "Dual-Role OTG device on %sHNP port\n",
1409 (port1 == bus->otg_port)
1410 ? "" : "non-");
1411
1412 /* enable HNP before suspend, it's simpler */
1413 if (port1 == bus->otg_port)
1414 bus->b_hnp_enable = 1;
1415 err = usb_control_msg(udev,
1416 usb_sndctrlpipe(udev, 0),
1417 USB_REQ_SET_FEATURE, 0,
1418 bus->b_hnp_enable
1419 ? USB_DEVICE_B_HNP_ENABLE
1420 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1421 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1422 if (err < 0) {
1423 /* OTG MESSAGE: report errors here,
1424 * customize to match your product.
1425 */
1426 dev_info(&udev->dev,
1427 "can't set HNP mode; %d\n",
1428 err);
1429 bus->b_hnp_enable = 0;
1430 }
1431 }
1432 }
1433 }
1434
1435 if (!is_targeted(udev)) {
1436
1437 /* Maybe it can talk to us, though we can't talk to it.
1438 * (Includes HNP test device.)
1439 */
1440 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern4956ecc2007-05-30 16:51:28 -04001441 err = usb_port_suspend(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 if (err < 0)
1443 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1444 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07001445 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 goto fail;
1447 }
1448#endif
1449
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001450 /* export the usbdev device-node for libusb */
1451 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1452 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1453
Alan Stern782da722006-07-01 22:09:35 -04001454 /* Register the device. The device driver is responsible
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001455 * for adding the device files to sysfs and for configuring
1456 * the device.
Alan Stern782da722006-07-01 22:09:35 -04001457 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001458 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 if (err) {
1460 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1461 goto fail;
1462 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001463
Alan Sternee49fb52006-11-22 16:55:54 -05001464 /* Increment the parent's count of unsuspended children */
1465 if (udev->parent)
Alan Stern94fcda12006-11-20 11:38:46 -05001466 usb_autoresume_device(udev->parent);
Alan Sternee49fb52006-11-22 16:55:54 -05001467
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001468exit:
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001469 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
1471fail:
1472 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001473 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476static int hub_port_status(struct usb_hub *hub, int port1,
1477 u16 *status, u16 *change)
1478{
1479 int ret;
1480
Alan Sterndb90e7a2007-02-05 09:56:15 -05001481 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001483 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 dev_err (hub->intfdev,
1485 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001486 if (ret >= 0)
1487 ret = -EIO;
1488 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 *status = le16_to_cpu(hub->status->port.wPortStatus);
1490 *change = le16_to_cpu(hub->status->port.wPortChange);
1491 ret = 0;
1492 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001493 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 return ret;
1495}
1496
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001497
1498/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1499static unsigned hub_is_wusb(struct usb_hub *hub)
1500{
1501 struct usb_hcd *hcd;
1502 if (hub->hdev->parent != NULL) /* not a root hub? */
1503 return 0;
1504 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1505 return hcd->wireless;
1506}
1507
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509#define PORT_RESET_TRIES 5
1510#define SET_ADDRESS_TRIES 2
1511#define GET_DESCRIPTOR_TRIES 2
1512#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1513#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1514
1515#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1516#define HUB_SHORT_RESET_TIME 10
1517#define HUB_LONG_RESET_TIME 200
1518#define HUB_RESET_TIMEOUT 500
1519
1520static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1521 struct usb_device *udev, unsigned int delay)
1522{
1523 int delay_time, ret;
1524 u16 portstatus;
1525 u16 portchange;
1526
1527 for (delay_time = 0;
1528 delay_time < HUB_RESET_TIMEOUT;
1529 delay_time += delay) {
1530 /* wait to give the device a chance to reset */
1531 msleep(delay);
1532
1533 /* read and decode port status */
1534 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1535 if (ret < 0)
1536 return ret;
1537
1538 /* Device went away? */
1539 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1540 return -ENOTCONN;
1541
Alan Sterndd4dd192007-05-04 11:55:54 -04001542 /* bomb out completely if the connection bounced */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 if ((portchange & USB_PORT_STAT_C_CONNECTION))
Alan Sterndd4dd192007-05-04 11:55:54 -04001544 return -ENOTCONN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
1546 /* if we`ve finished resetting, then break out of the loop */
1547 if (!(portstatus & USB_PORT_STAT_RESET) &&
1548 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001549 if (hub_is_wusb(hub))
1550 udev->speed = USB_SPEED_VARIABLE;
1551 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 udev->speed = USB_SPEED_HIGH;
1553 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1554 udev->speed = USB_SPEED_LOW;
1555 else
1556 udev->speed = USB_SPEED_FULL;
1557 return 0;
1558 }
1559
1560 /* switch to the long delay after two short delay failures */
1561 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1562 delay = HUB_LONG_RESET_TIME;
1563
1564 dev_dbg (hub->intfdev,
1565 "port %d not reset yet, waiting %dms\n",
1566 port1, delay);
1567 }
1568
1569 return -EBUSY;
1570}
1571
1572static int hub_port_reset(struct usb_hub *hub, int port1,
1573 struct usb_device *udev, unsigned int delay)
1574{
1575 int i, status;
1576
1577 /* Reset the port */
1578 for (i = 0; i < PORT_RESET_TRIES; i++) {
1579 status = set_port_feature(hub->hdev,
1580 port1, USB_PORT_FEAT_RESET);
1581 if (status)
1582 dev_err(hub->intfdev,
1583 "cannot reset port %d (err = %d)\n",
1584 port1, status);
1585 else {
1586 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001587 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 dev_dbg(hub->intfdev,
1589 "port_wait_reset: err = %d\n",
1590 status);
1591 }
1592
1593 /* return on disconnect or reset */
1594 switch (status) {
1595 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001596 /* TRSTRCY = 10 ms; plus some extra */
1597 msleep(10 + 40);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 /* FALL THROUGH */
1599 case -ENOTCONN:
1600 case -ENODEV:
1601 clear_port_feature(hub->hdev,
1602 port1, USB_PORT_FEAT_C_RESET);
1603 /* FIXME need disconnect() for NOTATTACHED device */
1604 usb_set_device_state(udev, status
1605 ? USB_STATE_NOTATTACHED
1606 : USB_STATE_DEFAULT);
1607 return status;
1608 }
1609
1610 dev_dbg (hub->intfdev,
1611 "port %d not enabled, trying reset again...\n",
1612 port1);
1613 delay = HUB_LONG_RESET_TIME;
1614 }
1615
1616 dev_err (hub->intfdev,
1617 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1618 port1);
1619
1620 return status;
1621}
1622
Alan Sternd388dab2006-07-01 22:14:24 -04001623#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
1625#ifdef CONFIG_USB_SUSPEND
1626
1627/*
1628 * Selective port suspend reduces power; most suspended devices draw
1629 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1630 * All devices below the suspended port are also suspended.
1631 *
1632 * Devices leave suspend state when the host wakes them up. Some devices
1633 * also support "remote wakeup", where the device can activate the USB
1634 * tree above them to deliver data, such as a keypress or packet. In
1635 * some cases, this wakes the USB host.
1636 */
1637static int hub_port_suspend(struct usb_hub *hub, int port1,
1638 struct usb_device *udev)
1639{
1640 int status;
1641
1642 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1643
1644 /* enable remote wakeup when appropriate; this lets the device
1645 * wake up the upstream hub (including maybe the root hub).
1646 *
1647 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1648 * we don't explicitly enable it here.
1649 */
Alan Stern645daaa2006-08-30 15:47:02 -04001650 if (udev->do_remote_wakeup) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1652 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1653 USB_DEVICE_REMOTE_WAKEUP, 0,
1654 NULL, 0,
1655 USB_CTRL_SET_TIMEOUT);
1656 if (status)
1657 dev_dbg(&udev->dev,
1658 "won't remote wakeup, status %d\n",
1659 status);
1660 }
1661
1662 /* see 7.1.7.6 */
1663 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1664 if (status) {
1665 dev_dbg(hub->intfdev,
1666 "can't suspend port %d, status %d\n",
1667 port1, status);
1668 /* paranoia: "should not happen" */
1669 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1670 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1671 USB_DEVICE_REMOTE_WAKEUP, 0,
1672 NULL, 0,
1673 USB_CTRL_SET_TIMEOUT);
1674 } else {
1675 /* device has up to 10 msec to fully suspend */
Alan Stern645daaa2006-08-30 15:47:02 -04001676 dev_dbg(&udev->dev, "usb %ssuspend\n",
1677 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1679 msleep(10);
1680 }
1681 return status;
1682}
1683
1684/*
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 *
Alan Stern4956ecc2007-05-30 16:51:28 -04001702 * Devices on USB hub ports have only one "suspend" state, corresponding
1703 * to ACPI D2, "may cause the device to lose some context".
1704 * State transitions include:
1705 *
1706 * - suspend, resume ... when the VBUS power link stays live
1707 * - suspend, disconnect ... VBUS lost
1708 *
1709 * Once VBUS drop breaks the circuit, the port it's using has to go through
1710 * normal re-enumeration procedures, starting with enabling VBUS power.
1711 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1712 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1713 * timer, no SRP, no requests through sysfs.
1714 *
1715 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1716 * the root hub for their bus goes into global suspend ... so we don't
1717 * (falsely) update the device power state to say it suspended.
1718 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 * Returns 0 on success, else negative errno.
1720 */
Alan Stern140d8f62006-07-01 22:07:21 -04001721int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722{
Alan Stern4956ecc2007-05-30 16:51:28 -04001723 int status = 0;
1724
Alan Stern686314c2007-05-30 15:34:36 -04001725 status = hub_port_suspend(hdev_to_hub(udev->parent),
1726 udev->portnum, udev);
Alan Stern4956ecc2007-05-30 16:51:28 -04001727 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728}
David Brownellf3f32532005-09-22 22:37:29 -07001729
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730/*
David Brownell390a8c32005-09-13 19:57:27 -07001731 * If the USB "suspend" state is in use (rather than "global suspend"),
1732 * many devices will be individually taken out of suspend state using
1733 * special" resume" signaling. These routines kick in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 * hardware resume signaling is finished, either because of selective
1735 * resume (by host) or remote wakeup (by device) ... now see what changed
1736 * in the tree that's rooted at this device.
1737 */
Alan Stern140d8f62006-07-01 22:07:21 -04001738static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739{
1740 int status;
1741 u16 devstatus;
1742
1743 /* caller owns the udev device lock */
David Brownellf3f32532005-09-22 22:37:29 -07001744 dev_dbg(&udev->dev, "finish resume\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
1746 /* usb ch9 identifies four variants of SUSPENDED, based on what
1747 * state the device resumes to. Linux currently won't see the
1748 * first two on the host side; they'd be inside hub_port_init()
1749 * during many timeouts, but khubd can't suspend until later.
1750 */
1751 usb_set_device_state(udev, udev->actconfig
1752 ? USB_STATE_CONFIGURED
1753 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
1755 /* 10.5.4.5 says be sure devices in the tree are still there.
1756 * For now let's assume the device didn't go crazy on resume,
1757 * and device drivers will know about any resume quirks.
1758 */
1759 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Sternb40b7a92006-06-19 15:12:38 -04001760 if (status >= 0)
1761 status = (status == 2 ? 0 : -ENODEV);
1762
1763 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 dev_dbg(&udev->dev,
1765 "gone after usb resume? status %d\n",
1766 status);
1767 else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 le16_to_cpus(&devstatus);
Alan Stern686314c2007-05-30 15:34:36 -04001769 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 status = usb_control_msg(udev,
1771 usb_sndctrlpipe(udev, 0),
1772 USB_REQ_CLEAR_FEATURE,
1773 USB_RECIP_DEVICE,
1774 USB_DEVICE_REMOTE_WAKEUP, 0,
1775 NULL, 0,
1776 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001777 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 dev_dbg(&udev->dev, "disable remote "
1779 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 }
1783 return status;
1784}
1785
1786static int
1787hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1788{
1789 int status;
Alan Sternd25450c2006-11-20 11:14:30 -05001790 u16 portchange, portstatus;
1791
1792 /* Skip the initial Clear-Suspend step for a remote wakeup */
1793 status = hub_port_status(hub, port1, &portstatus, &portchange);
1794 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1795 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
1797 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1798
Alan Sternd5cbad42006-08-11 16:52:39 -04001799 set_bit(port1, hub->busy_bits);
1800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 /* see 7.1.7.7; affects power usage, but not budgeting */
1802 status = clear_port_feature(hub->hdev,
1803 port1, USB_PORT_FEAT_SUSPEND);
1804 if (status) {
1805 dev_dbg(hub->intfdev,
1806 "can't resume port %d, status %d\n",
1807 port1, status);
1808 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04001810 dev_dbg(&udev->dev, "usb %sresume\n",
1811 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 msleep(25);
1813
1814#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1815 | USB_PORT_STAT_ENABLE \
1816 | USB_PORT_STAT_CONNECTION)
1817
1818 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1819 * stop resume signaling. Then finish the resume
1820 * sequence.
1821 */
Alan Sternd25450c2006-11-20 11:14:30 -05001822 status = hub_port_status(hub, port1, &portstatus, &portchange);
1823SuspendCleared:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 if (status < 0
Alan Sternd25450c2006-11-20 11:14:30 -05001825 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1826 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 ) {
1828 dev_dbg(hub->intfdev,
1829 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001830 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001831 if (status >= 0)
1832 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 } else {
Alan Stern20307942006-06-28 11:20:41 -04001834 if (portchange & USB_PORT_STAT_C_SUSPEND)
1835 clear_port_feature(hub->hdev, port1,
1836 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 /* TRSMRCY = 10 msec */
1838 msleep(10);
Alan Stern686314c2007-05-30 15:34:36 -04001839 status = finish_port_resume(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 }
1841 }
1842 if (status < 0)
1843 hub_port_logical_disconnect(hub, port1);
1844
Alan Sternd5cbad42006-08-11 16:52:39 -04001845 clear_bit(port1, hub->busy_bits);
1846 if (!hub->hdev->parent && !hub->busy_bits[0])
1847 usb_enable_root_hub_irq(hub->hdev->bus);
1848
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 return status;
1850}
1851
David Brownell5edbfb72005-09-22 22:45:26 -07001852/*
Alan Stern140d8f62006-07-01 22:07:21 -04001853 * usb_port_resume - re-activate a suspended usb device's upstream port
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 * @udev: device to re-activate
David Brownell5edbfb72005-09-22 22:45:26 -07001855 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 *
1857 * This will re-activate the suspended device, increasing power usage
1858 * while letting drivers communicate again with its endpoints.
1859 * USB resume explicitly guarantees that the power session between
1860 * the host and the device is the same as it was when the device
1861 * suspended.
1862 *
1863 * Returns 0 on success, else negative errno.
1864 */
Alan Stern140d8f62006-07-01 22:07:21 -04001865int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866{
Alan Sternd388dab2006-07-01 22:14:24 -04001867 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
Alan Stern686314c2007-05-30 15:34:36 -04001869 status = hub_port_resume(hdev_to_hub(udev->parent),
1870 udev->portnum, udev);
David Brownellf3f32532005-09-22 22:37:29 -07001871 if (status < 0)
Alan Sterna8e7c562006-07-01 22:11:02 -04001872 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 return status;
1874}
1875
1876static int remote_wakeup(struct usb_device *udev)
1877{
1878 int status = 0;
1879
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001880 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001882 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern19410442007-03-27 13:33:59 -04001883 usb_mark_last_busy(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04001884 status = usb_external_resume_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001885 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001886 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 return status;
1888}
1889
Alan Sternd388dab2006-07-01 22:14:24 -04001890#else /* CONFIG_USB_SUSPEND */
1891
1892/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1893
1894int usb_port_suspend(struct usb_device *udev)
1895{
1896 return 0;
1897}
1898
1899static inline int
1900finish_port_resume(struct usb_device *udev)
1901{
1902 return 0;
1903}
1904
1905static inline int
1906hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1907{
1908 return 0;
1909}
1910
1911int usb_port_resume(struct usb_device *udev)
1912{
1913 return 0;
1914}
1915
1916static inline int remote_wakeup(struct usb_device *udev)
1917{
1918 return 0;
1919}
1920
1921#endif
1922
David Brownelldb690872005-09-13 19:56:33 -07001923static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924{
1925 struct usb_hub *hub = usb_get_intfdata (intf);
1926 struct usb_device *hdev = hub->hdev;
1927 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
David Brownellc9f89fa2005-09-13 19:57:04 -07001929 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1931 struct usb_device *udev;
1932
1933 udev = hdev->children [port1-1];
Alan Stern114b3682006-07-01 22:13:04 -04001934 if (udev && msg.event == PM_EVENT_SUSPEND &&
David Brownellf3f32532005-09-22 22:37:29 -07001935#ifdef CONFIG_USB_SUSPEND
Alan Stern114b3682006-07-01 22:13:04 -04001936 udev->state != USB_STATE_SUSPENDED
1937#else
1938 udev->dev.power.power_state.event
1939 == PM_EVENT_ON
David Brownellf3f32532005-09-22 22:37:29 -07001940#endif
Alan Stern114b3682006-07-01 22:13:04 -04001941 ) {
Alan Stern645daaa2006-08-30 15:47:02 -04001942 if (!hdev->auto_pm)
1943 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1944 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001945 return -EBUSY;
1946 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 }
1948
Alan Stern40f122f2006-11-09 14:44:33 -05001949 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1950
David Brownellc9f89fa2005-09-13 19:57:04 -07001951 /* stop khubd and related activity */
1952 hub_quiesce(hub);
Alan Sternb6f64362007-05-04 11:51:54 -04001953 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954}
1955
1956static int hub_resume(struct usb_interface *intf)
1957{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
Alan Stern40f122f2006-11-09 14:44:33 -05001960 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1961
Alan Sterna8e7c562006-07-01 22:11:02 -04001962 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001963 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 return 0;
1965}
1966
Alan Sternd388dab2006-07-01 22:14:24 -04001967#else /* CONFIG_PM */
1968
1969static inline int remote_wakeup(struct usb_device *udev)
1970{
1971 return 0;
1972}
1973
Andrew Morton511366d2006-08-14 23:11:02 -07001974#define hub_suspend NULL
1975#define hub_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04001976#endif
1977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
1979/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
1980 *
1981 * Between connect detection and reset signaling there must be a delay
1982 * of 100ms at least for debounce and power-settling. The corresponding
1983 * timer shall restart whenever the downstream port detects a disconnect.
1984 *
1985 * Apparently there are some bluetooth and irda-dongles and a number of
1986 * low-speed devices for which this debounce period may last over a second.
1987 * Not covered by the spec - but easy to deal with.
1988 *
1989 * This implementation uses a 1500ms total debounce timeout; if the
1990 * connection isn't stable by then it returns -ETIMEDOUT. It checks
1991 * every 25ms for transient disconnects. When the port status has been
1992 * unchanged for 100ms it returns the port status.
1993 */
1994
1995#define HUB_DEBOUNCE_TIMEOUT 1500
1996#define HUB_DEBOUNCE_STEP 25
1997#define HUB_DEBOUNCE_STABLE 100
1998
1999static int hub_port_debounce(struct usb_hub *hub, int port1)
2000{
2001 int ret;
2002 int total_time, stable_time = 0;
2003 u16 portchange, portstatus;
2004 unsigned connection = 0xffff;
2005
2006 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2007 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2008 if (ret < 0)
2009 return ret;
2010
2011 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2012 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2013 stable_time += HUB_DEBOUNCE_STEP;
2014 if (stable_time >= HUB_DEBOUNCE_STABLE)
2015 break;
2016 } else {
2017 stable_time = 0;
2018 connection = portstatus & USB_PORT_STAT_CONNECTION;
2019 }
2020
2021 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2022 clear_port_feature(hub->hdev, port1,
2023 USB_PORT_FEAT_C_CONNECTION);
2024 }
2025
2026 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2027 break;
2028 msleep(HUB_DEBOUNCE_STEP);
2029 }
2030
2031 dev_dbg (hub->intfdev,
2032 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2033 port1, total_time, stable_time, portstatus);
2034
2035 if (stable_time < HUB_DEBOUNCE_STABLE)
2036 return -ETIMEDOUT;
2037 return portstatus;
2038}
2039
2040static void ep0_reinit(struct usb_device *udev)
2041{
2042 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2043 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2044 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2045}
2046
2047#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2048#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2049
2050static int hub_set_address(struct usb_device *udev)
2051{
2052 int retval;
2053
2054 if (udev->devnum == 0)
2055 return -EINVAL;
2056 if (udev->state == USB_STATE_ADDRESS)
2057 return 0;
2058 if (udev->state != USB_STATE_DEFAULT)
2059 return -EINVAL;
2060 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2061 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2062 NULL, 0, USB_CTRL_SET_TIMEOUT);
2063 if (retval == 0) {
2064 usb_set_device_state(udev, USB_STATE_ADDRESS);
2065 ep0_reinit(udev);
2066 }
2067 return retval;
2068}
2069
2070/* Reset device, (re)assign address, get device descriptor.
2071 * Device connection must be stable, no more debouncing needed.
2072 * Returns device in USB_STATE_ADDRESS, except on error.
2073 *
2074 * If this is called for an already-existing device (as part of
2075 * usb_reset_device), the caller must own the device lock. For a
2076 * newly detected device that is not accessible through any global
2077 * pointers, it's not necessary to lock the device.
2078 */
2079static int
2080hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2081 int retry_counter)
2082{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002083 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084
2085 struct usb_device *hdev = hub->hdev;
2086 int i, j, retval;
2087 unsigned delay = HUB_SHORT_RESET_TIME;
2088 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002089 char *speed, *type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
2091 /* root hub ports have a slightly longer reset period
2092 * (from USB 2.0 spec, section 7.1.7.5)
2093 */
2094 if (!hdev->parent) {
2095 delay = HUB_ROOT_RESET_TIME;
2096 if (port1 == hdev->bus->otg_port)
2097 hdev->bus->b_hnp_enable = 0;
2098 }
2099
2100 /* Some low speed devices have problems with the quick delay, so */
2101 /* be a bit pessimistic with those devices. RHbug #23670 */
2102 if (oldspeed == USB_SPEED_LOW)
2103 delay = HUB_LONG_RESET_TIME;
2104
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002105 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
2107 /* Reset the device; full speed may morph to high speed */
2108 retval = hub_port_reset(hub, port1, udev, delay);
2109 if (retval < 0) /* error or disconnect */
2110 goto fail;
2111 /* success, speed is known */
2112 retval = -ENODEV;
2113
2114 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2115 dev_dbg(&udev->dev, "device reset changed speed!\n");
2116 goto fail;
2117 }
2118 oldspeed = udev->speed;
2119
2120 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2121 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002122 * For Wireless USB devices, ep0 max packet is always 512 (tho
2123 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 */
2125 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002126 case USB_SPEED_VARIABLE: /* fixed at 512 */
2127 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2128 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 case USB_SPEED_HIGH: /* fixed at 64 */
2130 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2131 break;
2132 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2133 /* to determine the ep0 maxpacket size, try to read
2134 * the device descriptor to get bMaxPacketSize0 and
2135 * then correct our initial guess.
2136 */
2137 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2138 break;
2139 case USB_SPEED_LOW: /* fixed at 8 */
2140 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2141 break;
2142 default:
2143 goto fail;
2144 }
2145
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002146 type = "";
2147 switch (udev->speed) {
2148 case USB_SPEED_LOW: speed = "low"; break;
2149 case USB_SPEED_FULL: speed = "full"; break;
2150 case USB_SPEED_HIGH: speed = "high"; break;
2151 case USB_SPEED_VARIABLE:
2152 speed = "variable";
2153 type = "Wireless ";
2154 break;
2155 default: speed = "?"; break;
2156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002158 "%s %s speed %sUSB device using %s and address %d\n",
2159 (udev->config) ? "reset" : "new", speed, type,
2160 udev->bus->controller->driver->name, udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161
2162 /* Set up TT records, if needed */
2163 if (hdev->tt) {
2164 udev->tt = hdev->tt;
2165 udev->ttport = hdev->ttport;
2166 } else if (udev->speed != USB_SPEED_HIGH
2167 && hdev->speed == USB_SPEED_HIGH) {
2168 udev->tt = &hub->tt;
2169 udev->ttport = port1;
2170 }
2171
2172 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2173 * Because device hardware and firmware is sometimes buggy in
2174 * this area, and this is how Linux has done it for ages.
2175 * Change it cautiously.
2176 *
2177 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2178 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2179 * so it may help with some non-standards-compliant devices.
2180 * Otherwise we start with SET_ADDRESS and then try to read the
2181 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2182 * value.
2183 */
2184 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2185 if (USE_NEW_SCHEME(retry_counter)) {
2186 struct usb_device_descriptor *buf;
2187 int r = 0;
2188
2189#define GET_DESCRIPTOR_BUFSIZE 64
2190 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2191 if (!buf) {
2192 retval = -ENOMEM;
2193 continue;
2194 }
2195
Alan Sternb89ee192007-05-11 10:19:04 -04002196 /* Retry on all errors; some devices are flakey.
2197 * 255 is for WUSB devices, we actually need to use
2198 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 */
2200 for (j = 0; j < 3; ++j) {
2201 buf->bMaxPacketSize0 = 0;
2202 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2203 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2204 USB_DT_DEVICE << 8, 0,
2205 buf, GET_DESCRIPTOR_BUFSIZE,
Alan Sternb89ee192007-05-11 10:19:04 -04002206 USB_CTRL_GET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002208 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 if (buf->bDescriptorType ==
2210 USB_DT_DEVICE) {
2211 r = 0;
2212 break;
2213 }
2214 /* FALL THROUGH */
2215 default:
2216 if (r == 0)
2217 r = -EPROTO;
2218 break;
2219 }
2220 if (r == 0)
2221 break;
2222 }
2223 udev->descriptor.bMaxPacketSize0 =
2224 buf->bMaxPacketSize0;
2225 kfree(buf);
2226
2227 retval = hub_port_reset(hub, port1, udev, delay);
2228 if (retval < 0) /* error or disconnect */
2229 goto fail;
2230 if (oldspeed != udev->speed) {
2231 dev_dbg(&udev->dev,
2232 "device reset changed speed!\n");
2233 retval = -ENODEV;
2234 goto fail;
2235 }
2236 if (r) {
2237 dev_err(&udev->dev, "device descriptor "
2238 "read/%s, error %d\n",
2239 "64", r);
2240 retval = -EMSGSIZE;
2241 continue;
2242 }
2243#undef GET_DESCRIPTOR_BUFSIZE
2244 }
2245
2246 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2247 retval = hub_set_address(udev);
2248 if (retval >= 0)
2249 break;
2250 msleep(200);
2251 }
2252 if (retval < 0) {
2253 dev_err(&udev->dev,
2254 "device not accepting address %d, error %d\n",
2255 udev->devnum, retval);
2256 goto fail;
2257 }
2258
2259 /* cope with hardware quirkiness:
2260 * - let SET_ADDRESS settle, some device hardware wants it
2261 * - read ep0 maxpacket even for high and low speed,
2262 */
2263 msleep(10);
2264 if (USE_NEW_SCHEME(retry_counter))
2265 break;
2266
2267 retval = usb_get_device_descriptor(udev, 8);
2268 if (retval < 8) {
2269 dev_err(&udev->dev, "device descriptor "
2270 "read/%s, error %d\n",
2271 "8", retval);
2272 if (retval >= 0)
2273 retval = -EMSGSIZE;
2274 } else {
2275 retval = 0;
2276 break;
2277 }
2278 }
2279 if (retval)
2280 goto fail;
2281
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002282 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2283 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2285 if (udev->speed != USB_SPEED_FULL ||
2286 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2287 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2288 retval = -EMSGSIZE;
2289 goto fail;
2290 }
2291 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2292 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2293 ep0_reinit(udev);
2294 }
2295
2296 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2297 if (retval < (signed)sizeof(udev->descriptor)) {
2298 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2299 "all", retval);
2300 if (retval >= 0)
2301 retval = -ENOMSG;
2302 goto fail;
2303 }
2304
2305 retval = 0;
2306
2307fail:
2308 if (retval)
2309 hub_port_disable(hub, port1, 0);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002310 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 return retval;
2312}
2313
2314static void
2315check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2316{
2317 struct usb_qualifier_descriptor *qual;
2318 int status;
2319
Christoph Lametere94b1762006-12-06 20:33:17 -08002320 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 if (qual == NULL)
2322 return;
2323
2324 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2325 qual, sizeof *qual);
2326 if (status == sizeof *qual) {
2327 dev_info(&udev->dev, "not running at top speed; "
2328 "connect to a high speed hub\n");
2329 /* hub LEDs are probably harder to miss than syslog */
2330 if (hub->has_indicators) {
2331 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002332 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 }
2334 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002335 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336}
2337
2338static unsigned
2339hub_power_remaining (struct usb_hub *hub)
2340{
2341 struct usb_device *hdev = hub->hdev;
2342 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002343 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344
Alan Stern55c52712005-11-23 12:03:12 -05002345 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 return 0;
2347
Alan Stern55c52712005-11-23 12:03:12 -05002348 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2349 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2350 struct usb_device *udev = hdev->children[port1 - 1];
2351 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352
2353 if (!udev)
2354 continue;
2355
Alan Stern55c52712005-11-23 12:03:12 -05002356 /* Unconfigured devices may not use more than 100mA,
2357 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002359 delta = udev->actconfig->desc.bMaxPower * 2;
2360 else if (port1 != udev->bus->otg_port || hdev->parent)
2361 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 else
Alan Stern55c52712005-11-23 12:03:12 -05002363 delta = 8;
2364 if (delta > hub->mA_per_port)
2365 dev_warn(&udev->dev, "%dmA is over %umA budget "
2366 "for port %d!\n",
2367 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 remaining -= delta;
2369 }
2370 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002371 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2372 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 remaining = 0;
2374 }
2375 return remaining;
2376}
2377
2378/* Handle physical or logical connection change events.
2379 * This routine is called when:
2380 * a port connection-change occurs;
2381 * a port enable-change occurs (often caused by EMI);
2382 * usb_reset_device() encounters changed descriptors (as from
2383 * a firmware download)
2384 * caller already locked the hub
2385 */
2386static void hub_port_connect_change(struct usb_hub *hub, int port1,
2387 u16 portstatus, u16 portchange)
2388{
2389 struct usb_device *hdev = hub->hdev;
2390 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002391 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 int status, i;
2393
2394 dev_dbg (hub_dev,
2395 "port %d, status %04x, change %04x, %s\n",
2396 port1, portstatus, portchange, portspeed (portstatus));
2397
2398 if (hub->has_indicators) {
2399 set_port_led(hub, port1, HUB_LED_AUTO);
2400 hub->indicator[port1-1] = INDICATOR_AUTO;
2401 }
2402
2403 /* Disconnect any existing devices under this port */
2404 if (hdev->children[port1-1])
2405 usb_disconnect(&hdev->children[port1-1]);
2406 clear_bit(port1, hub->change_bits);
2407
2408#ifdef CONFIG_USB_OTG
2409 /* during HNP, don't repeat the debounce */
2410 if (hdev->bus->is_b_host)
2411 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2412#endif
2413
2414 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2415 status = hub_port_debounce(hub, port1);
Alan Sternd4b7d8e2007-05-22 11:48:17 -04002416 if (status < 0) {
2417 if (printk_ratelimit())
2418 dev_err (hub_dev, "connect-debounce failed, "
2419 "port %d disabled\n", port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 goto done;
2421 }
2422 portstatus = status;
2423 }
2424
2425 /* Return now if nothing is connected */
2426 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2427
2428 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002429 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2431 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2432
2433 if (portstatus & USB_PORT_STAT_ENABLE)
2434 goto done;
2435 return;
2436 }
2437
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2439 struct usb_device *udev;
2440
2441 /* reallocate for each attempt, since references
2442 * to the previous one can escape in various ways
2443 */
2444 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2445 if (!udev) {
2446 dev_err (hub_dev,
2447 "couldn't allocate port %d usb_device\n",
2448 port1);
2449 goto done;
2450 }
2451
2452 usb_set_device_state(udev, USB_STATE_POWERED);
2453 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002454 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002455 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002456
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 /* set the address */
2458 choose_address(udev);
2459 if (udev->devnum <= 0) {
2460 status = -ENOTCONN; /* Don't retry */
2461 goto loop;
2462 }
2463
2464 /* reset and get descriptor */
2465 status = hub_port_init(hub, udev, port1, i);
2466 if (status < 0)
2467 goto loop;
2468
2469 /* consecutive bus-powered hubs aren't reliable; they can
2470 * violate the voltage drop budget. if the new child has
2471 * a "powered" LED, users should notice we didn't enable it
2472 * (without reading syslog), even without per-port LEDs
2473 * on the parent.
2474 */
2475 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002476 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 u16 devstat;
2478
2479 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2480 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002481 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 dev_dbg(&udev->dev, "get status %d ?\n", status);
2483 goto loop_disable;
2484 }
Alan Stern55c52712005-11-23 12:03:12 -05002485 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2487 dev_err(&udev->dev,
2488 "can't connect bus-powered hub "
2489 "to this port\n");
2490 if (hub->has_indicators) {
2491 hub->indicator[port1-1] =
2492 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002493 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 }
2495 status = -ENOTCONN; /* Don't retry */
2496 goto loop_disable;
2497 }
2498 }
2499
2500 /* check for devices running slower than they could */
2501 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2502 && udev->speed == USB_SPEED_FULL
2503 && highspeed_hubs != 0)
2504 check_highspeed (hub, udev, port1);
2505
2506 /* Store the parent's children[] pointer. At this point
2507 * udev becomes globally accessible, although presumably
2508 * no one will look at it until hdev is unlocked.
2509 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 status = 0;
2511
2512 /* We mustn't add new devices if the parent hub has
2513 * been disconnected; we would race with the
2514 * recursively_mark_NOTATTACHED() routine.
2515 */
2516 spin_lock_irq(&device_state_lock);
2517 if (hdev->state == USB_STATE_NOTATTACHED)
2518 status = -ENOTCONN;
2519 else
2520 hdev->children[port1-1] = udev;
2521 spin_unlock_irq(&device_state_lock);
2522
2523 /* Run it through the hoops (find a driver, etc) */
2524 if (!status) {
2525 status = usb_new_device(udev);
2526 if (status) {
2527 spin_lock_irq(&device_state_lock);
2528 hdev->children[port1-1] = NULL;
2529 spin_unlock_irq(&device_state_lock);
2530 }
2531 }
2532
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 if (status)
2534 goto loop_disable;
2535
2536 status = hub_power_remaining(hub);
2537 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002538 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539
2540 return;
2541
2542loop_disable:
2543 hub_port_disable(hub, port1, 1);
2544loop:
2545 ep0_reinit(udev);
2546 release_address(udev);
2547 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07002548 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 break;
2550 }
2551
2552done:
2553 hub_port_disable(hub, port1, 1);
2554}
2555
2556static void hub_events(void)
2557{
2558 struct list_head *tmp;
2559 struct usb_device *hdev;
2560 struct usb_interface *intf;
2561 struct usb_hub *hub;
2562 struct device *hub_dev;
2563 u16 hubstatus;
2564 u16 hubchange;
2565 u16 portstatus;
2566 u16 portchange;
2567 int i, ret;
2568 int connect_change;
2569
2570 /*
2571 * We restart the list every time to avoid a deadlock with
2572 * deleting hubs downstream from this one. This should be
2573 * safe since we delete the hub from the event list.
2574 * Not the most efficient, but avoids deadlocks.
2575 */
2576 while (1) {
2577
2578 /* Grab the first entry at the beginning of the list */
2579 spin_lock_irq(&hub_event_lock);
2580 if (list_empty(&hub_event_list)) {
2581 spin_unlock_irq(&hub_event_lock);
2582 break;
2583 }
2584
2585 tmp = hub_event_list.next;
2586 list_del_init(tmp);
2587
2588 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04002589 kref_get(&hub->kref);
2590 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591
Alan Sterne8054852007-05-04 11:55:11 -04002592 hdev = hub->hdev;
2593 hub_dev = hub->intfdev;
2594 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05002595 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596 hdev->state, hub->descriptor
2597 ? hub->descriptor->bNbrPorts
2598 : 0,
2599 /* NOTE: expects max 15 ports... */
2600 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002601 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 /* Lock the device, then check to see if we were
2604 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04002605 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04002606 if (unlikely(hub->disconnected))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 goto loop;
2608
2609 /* If the hub has died, clean up after it */
2610 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002611 hub->error = -ENODEV;
2612 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 goto loop;
2614 }
2615
Alan Stern40f122f2006-11-09 14:44:33 -05002616 /* Autoresume */
2617 ret = usb_autopm_get_interface(intf);
2618 if (ret) {
2619 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002621 }
2622
2623 /* If this is an inactive hub, do nothing */
2624 if (hub->quiescing)
2625 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626
2627 if (hub->error) {
2628 dev_dbg (hub_dev, "resetting for error %d\n",
2629 hub->error);
2630
Alan Stern7de18d82006-06-01 13:37:24 -04002631 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 if (ret) {
2633 dev_dbg (hub_dev,
2634 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002635 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 }
2637
2638 hub->nerrors = 0;
2639 hub->error = 0;
2640 }
2641
2642 /* deal with port status changes */
2643 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2644 if (test_bit(i, hub->busy_bits))
2645 continue;
2646 connect_change = test_bit(i, hub->change_bits);
2647 if (!test_and_clear_bit(i, hub->event_bits) &&
2648 !connect_change && !hub->activating)
2649 continue;
2650
2651 ret = hub_port_status(hub, i,
2652 &portstatus, &portchange);
2653 if (ret < 0)
2654 continue;
2655
2656 if (hub->activating && !hdev->children[i-1] &&
2657 (portstatus &
2658 USB_PORT_STAT_CONNECTION))
2659 connect_change = 1;
2660
2661 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2662 clear_port_feature(hdev, i,
2663 USB_PORT_FEAT_C_CONNECTION);
2664 connect_change = 1;
2665 }
2666
2667 if (portchange & USB_PORT_STAT_C_ENABLE) {
2668 if (!connect_change)
2669 dev_dbg (hub_dev,
2670 "port %d enable change, "
2671 "status %08x\n",
2672 i, portstatus);
2673 clear_port_feature(hdev, i,
2674 USB_PORT_FEAT_C_ENABLE);
2675
2676 /*
2677 * EM interference sometimes causes badly
2678 * shielded USB devices to be shutdown by
2679 * the hub, this hack enables them again.
2680 * Works at least with mouse driver.
2681 */
2682 if (!(portstatus & USB_PORT_STAT_ENABLE)
2683 && !connect_change
2684 && hdev->children[i-1]) {
2685 dev_err (hub_dev,
2686 "port %i "
2687 "disabled by hub (EMI?), "
2688 "re-enabling...\n",
2689 i);
2690 connect_change = 1;
2691 }
2692 }
2693
2694 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2695 clear_port_feature(hdev, i,
2696 USB_PORT_FEAT_C_SUSPEND);
2697 if (hdev->children[i-1]) {
2698 ret = remote_wakeup(hdev->
2699 children[i-1]);
2700 if (ret < 0)
2701 connect_change = 1;
2702 } else {
2703 ret = -ENODEV;
2704 hub_port_disable(hub, i, 1);
2705 }
2706 dev_dbg (hub_dev,
2707 "resume on port %d, status %d\n",
2708 i, ret);
2709 }
2710
2711 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2712 dev_err (hub_dev,
2713 "over-current change on port %d\n",
2714 i);
2715 clear_port_feature(hdev, i,
2716 USB_PORT_FEAT_C_OVER_CURRENT);
2717 hub_power_on(hub);
2718 }
2719
2720 if (portchange & USB_PORT_STAT_C_RESET) {
2721 dev_dbg (hub_dev,
2722 "reset change on port %d\n",
2723 i);
2724 clear_port_feature(hdev, i,
2725 USB_PORT_FEAT_C_RESET);
2726 }
2727
2728 if (connect_change)
2729 hub_port_connect_change(hub, i,
2730 portstatus, portchange);
2731 } /* end for i */
2732
2733 /* deal with hub status changes */
2734 if (test_and_clear_bit(0, hub->event_bits) == 0)
2735 ; /* do nothing */
2736 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2737 dev_err (hub_dev, "get_hub_status failed\n");
2738 else {
2739 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2740 dev_dbg (hub_dev, "power change\n");
2741 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002742 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2743 /* FIXME: Is this always true? */
2744 hub->limited_power = 0;
2745 else
2746 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 }
2748 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2749 dev_dbg (hub_dev, "overcurrent change\n");
2750 msleep(500); /* Cool down */
2751 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2752 hub_power_on(hub);
2753 }
2754 }
2755
2756 hub->activating = 0;
2757
Alan Sternd5926ae72005-04-21 15:56:37 -04002758 /* If this is a root hub, tell the HCD it's okay to
2759 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002760 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002761 usb_enable_root_hub_irq(hdev->bus);
2762
Alan Stern40f122f2006-11-09 14:44:33 -05002763loop_autopm:
2764 /* Allow autosuspend if we're not going to run again */
2765 if (list_empty(&hub->event_list))
2766 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767loop:
2768 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04002769 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770
2771 } /* end while (1) */
2772}
2773
2774static int hub_thread(void *__unused)
2775{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 do {
2777 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002778 wait_event_interruptible(khubd_wait,
2779 !list_empty(&hub_event_list) ||
2780 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002781 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002782 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002784 pr_debug("%s: khubd exiting\n", usbcore_name);
2785 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786}
2787
2788static struct usb_device_id hub_id_table [] = {
2789 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2790 .bDeviceClass = USB_CLASS_HUB},
2791 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2792 .bInterfaceClass = USB_CLASS_HUB},
2793 { } /* Terminating entry */
2794};
2795
2796MODULE_DEVICE_TABLE (usb, hub_id_table);
2797
2798static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 .name = "hub",
2800 .probe = hub_probe,
2801 .disconnect = hub_disconnect,
2802 .suspend = hub_suspend,
2803 .resume = hub_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002804 .pre_reset = hub_pre_reset,
2805 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 .ioctl = hub_ioctl,
2807 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002808 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809};
2810
2811int usb_hub_init(void)
2812{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813 if (usb_register(&hub_driver) < 0) {
2814 printk(KERN_ERR "%s: can't register hub driver\n",
2815 usbcore_name);
2816 return -1;
2817 }
2818
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002819 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2820 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822
2823 /* Fall through if kernel_thread failed */
2824 usb_deregister(&hub_driver);
2825 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2826
2827 return -1;
2828}
2829
2830void usb_hub_cleanup(void)
2831{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002832 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833
2834 /*
2835 * Hub resources are freed for us by usb_deregister. It calls
2836 * usb_driver_purge on every device which in turn calls that
2837 * devices disconnect function if it is using this driver.
2838 * The hub_disconnect function takes care of releasing the
2839 * individual hub resources. -greg
2840 */
2841 usb_deregister(&hub_driver);
2842} /* usb_hub_cleanup() */
2843
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844static int config_descriptors_changed(struct usb_device *udev)
2845{
2846 unsigned index;
2847 unsigned len = 0;
2848 struct usb_config_descriptor *buf;
2849
2850 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2851 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2852 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2853 }
Christoph Lametere94b1762006-12-06 20:33:17 -08002854 buf = kmalloc (len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855 if (buf == NULL) {
2856 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2857 /* assume the worst */
2858 return 1;
2859 }
2860 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2861 int length;
2862 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2863
2864 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2865 old_length);
2866 if (length < old_length) {
2867 dev_dbg(&udev->dev, "config index %d, error %d\n",
2868 index, length);
2869 break;
2870 }
2871 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2872 != 0) {
2873 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2874 index, buf->bConfigurationValue);
2875 break;
2876 }
2877 }
2878 kfree(buf);
2879 return index != udev->descriptor.bNumConfigurations;
2880}
2881
2882/**
2883 * usb_reset_device - perform a USB port reset to reinitialize a device
2884 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2885 *
Alan Stern79efa092006-06-01 13:33:42 -04002886 * WARNING - don't use this routine to reset a composite device
2887 * (one with multiple interfaces owned by separate drivers)!
2888 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 *
2890 * Do a port reset, reassign the device's address, and establish its
2891 * former operating configuration. If the reset fails, or the device's
2892 * descriptors change from their values before the reset, or the original
2893 * configuration and altsettings cannot be restored, a flag will be set
2894 * telling khubd to pretend the device has been disconnected and then
2895 * re-connected. All drivers will be unbound, and the device will be
2896 * re-enumerated and probed all over again.
2897 *
2898 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2899 * flagged for logical disconnection, or some other negative error code
2900 * if the reset wasn't even attempted.
2901 *
2902 * The caller must own the device lock. For example, it's safe to use
2903 * this from a driver probe() routine after downloading new firmware.
2904 * For calls that might not occur during probe(), drivers should lock
2905 * the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04002906 *
2907 * Locking exception: This routine may also be called from within an
2908 * autoresume handler. Such usage won't conflict with other tasks
2909 * holding the device lock because these tasks should always call
2910 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 */
2912int usb_reset_device(struct usb_device *udev)
2913{
2914 struct usb_device *parent_hdev = udev->parent;
2915 struct usb_hub *parent_hub;
2916 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05002917 int i, ret = 0;
2918 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919
2920 if (udev->state == USB_STATE_NOTATTACHED ||
2921 udev->state == USB_STATE_SUSPENDED) {
2922 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2923 udev->state);
2924 return -EINVAL;
2925 }
2926
2927 if (!parent_hdev) {
2928 /* this requires hcd-specific logic; see OHCI hc_restart() */
2929 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2930 return -EISDIR;
2931 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932 parent_hub = hdev_to_hub(parent_hdev);
2933
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 set_bit(port1, parent_hub->busy_bits);
2935 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2936
2937 /* ep0 maxpacket size may change; let the HCD know about it.
2938 * Other endpoints will be handled by re-enumeration. */
2939 ep0_reinit(udev);
2940 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04002941 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 break;
2943 }
2944 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002945 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2946 usb_enable_root_hub_irq(parent_hdev->bus);
2947
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948 if (ret < 0)
2949 goto re_enumerate;
2950
2951 /* Device might have changed firmware (DFU or similar) */
2952 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2953 || config_descriptors_changed (udev)) {
2954 dev_info(&udev->dev, "device firmware changed\n");
2955 udev->descriptor = descriptor; /* for disconnect() calls */
2956 goto re_enumerate;
2957 }
2958
2959 if (!udev->actconfig)
2960 goto done;
2961
2962 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2963 USB_REQ_SET_CONFIGURATION, 0,
2964 udev->actconfig->desc.bConfigurationValue, 0,
2965 NULL, 0, USB_CTRL_SET_TIMEOUT);
2966 if (ret < 0) {
2967 dev_err(&udev->dev,
2968 "can't restore configuration #%d (error=%d)\n",
2969 udev->actconfig->desc.bConfigurationValue, ret);
2970 goto re_enumerate;
2971 }
2972 usb_set_device_state(udev, USB_STATE_CONFIGURED);
2973
2974 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
2975 struct usb_interface *intf = udev->actconfig->interface[i];
2976 struct usb_interface_descriptor *desc;
2977
2978 /* set_interface resets host side toggle even
2979 * for altsetting zero. the interface may have no driver.
2980 */
2981 desc = &intf->cur_altsetting->desc;
2982 ret = usb_set_interface(udev, desc->bInterfaceNumber,
2983 desc->bAlternateSetting);
2984 if (ret < 0) {
2985 dev_err(&udev->dev, "failed to restore interface %d "
2986 "altsetting %d (error=%d)\n",
2987 desc->bInterfaceNumber,
2988 desc->bAlternateSetting,
2989 ret);
2990 goto re_enumerate;
2991 }
2992 }
2993
2994done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995 return 0;
2996
2997re_enumerate:
2998 hub_port_logical_disconnect(parent_hub, port1);
2999 return -ENODEV;
3000}
Alan Stern140d8f62006-07-01 22:07:21 -04003001EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003002
3003/**
3004 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3005 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3006 * @iface: interface bound to the driver making the request (optional)
3007 *
3008 * Warns all drivers bound to registered interfaces (using their pre_reset
3009 * method), performs the port reset, and then lets the drivers know that
3010 * the reset is over (using their post_reset method).
3011 *
3012 * Return value is the same as for usb_reset_device().
3013 *
3014 * The caller must own the device lock. For example, it's safe to use
3015 * this from a driver probe() routine after downloading new firmware.
3016 * For calls that might not occur during probe(), drivers should lock
3017 * the device using usb_lock_device_for_reset().
3018 *
3019 * The interface locks are acquired during the pre_reset stage and released
3020 * during the post_reset stage. However if iface is not NULL and is
3021 * currently being probed, we assume that the caller already owns its
3022 * lock.
3023 */
3024int usb_reset_composite_device(struct usb_device *udev,
3025 struct usb_interface *iface)
3026{
3027 int ret;
3028 struct usb_host_config *config = udev->actconfig;
3029
3030 if (udev->state == USB_STATE_NOTATTACHED ||
3031 udev->state == USB_STATE_SUSPENDED) {
3032 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3033 udev->state);
3034 return -EINVAL;
3035 }
3036
Alan Stern645daaa2006-08-30 15:47:02 -04003037 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003038 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003039
Alan Stern79efa092006-06-01 13:33:42 -04003040 if (iface && iface->condition != USB_INTERFACE_BINDING)
3041 iface = NULL;
3042
3043 if (config) {
3044 int i;
3045 struct usb_interface *cintf;
3046 struct usb_driver *drv;
3047
3048 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3049 cintf = config->interface[i];
3050 if (cintf != iface)
3051 down(&cintf->dev.sem);
3052 if (device_is_registered(&cintf->dev) &&
3053 cintf->dev.driver) {
3054 drv = to_usb_driver(cintf->dev.driver);
3055 if (drv->pre_reset)
3056 (drv->pre_reset)(cintf);
3057 }
3058 }
3059 }
3060
3061 ret = usb_reset_device(udev);
3062
3063 if (config) {
3064 int i;
3065 struct usb_interface *cintf;
3066 struct usb_driver *drv;
3067
3068 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3069 cintf = config->interface[i];
3070 if (device_is_registered(&cintf->dev) &&
3071 cintf->dev.driver) {
3072 drv = to_usb_driver(cintf->dev.driver);
3073 if (drv->post_reset)
Alan Stern0458d5b2007-05-04 11:52:20 -04003074 (drv->post_reset)(cintf, 0);
Alan Stern79efa092006-06-01 13:33:42 -04003075 }
3076 if (cintf != iface)
3077 up(&cintf->dev.sem);
3078 }
3079 }
3080
Alan Stern94fcda12006-11-20 11:38:46 -05003081 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003082 return ret;
3083}
Alan Stern140d8f62006-07-01 22:07:21 -04003084EXPORT_SYMBOL(usb_reset_composite_device);