blob: 0f857e6450581159a261fc59d0403b7300fc8b24 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <asm/uaccess.h>
27#include <asm/byteorder.h>
28
29#include "usb.h"
30#include "hcd.h"
31#include "hub.h"
32
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -080033/* if we are in debug mode, always announce new devices */
34#ifdef DEBUG
35#ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36#define CONFIG_USB_ANNOUNCE_NEW_DEVICES
37#endif
38#endif
39
Alan Stern1bb5f662006-11-06 11:56:13 -050040struct usb_hub {
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
Alan Sterne8054852007-05-04 11:55:11 -040043 struct kref kref;
Alan Stern1bb5f662006-11-06 11:56:13 -050044 struct urb *urb; /* for interrupt polling pipe */
45
46 /* buffer for urb ... with extra space in case of babble */
47 char (*buffer)[8];
48 dma_addr_t buffer_dma; /* DMA address for buffer */
49 union {
50 struct usb_hub_status hub;
51 struct usb_port_status port;
52 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050053 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050054
55 int error; /* last reported error */
56 int nerrors; /* track consecutive errors */
57
58 struct list_head event_list; /* hubs w/data or errs ready */
59 unsigned long event_bits[1]; /* status change bitmask */
60 unsigned long change_bits[1]; /* ports with logical connect
61 status change */
62 unsigned long busy_bits[1]; /* ports being reset or
63 resumed */
64#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65#error event_bits[] is too short!
66#endif
67
68 struct usb_hub_descriptor *descriptor; /* class descriptor */
69 struct usb_tt tt; /* Transaction Translator */
70
71 unsigned mA_per_port; /* current for each child */
72
73 unsigned limited_power:1;
74 unsigned quiescing:1;
Alan Sterne8054852007-05-04 11:55:11 -040075 unsigned disconnected:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050076
77 unsigned has_indicators:1;
78 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000079 struct delayed_work leds;
Alan Stern8520f382008-09-22 14:44:26 -040080 struct delayed_work init_work;
Alan Stern7cbe5dc2009-06-29 10:56:54 -040081 void **port_owners;
Alan Stern1bb5f662006-11-06 11:56:13 -050082};
83
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050086 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
88static DEFINE_SPINLOCK(device_state_lock);
89
90/* khubd's worklist and its lock */
91static DEFINE_SPINLOCK(hub_event_lock);
92static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
93
94/* Wakes up khubd */
95static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
96
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070097static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/* cycle leds on hubs that aren't blinking for attention */
100static int blinkenlights = 0;
101module_param (blinkenlights, bool, S_IRUGO);
102MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
103
104/*
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +0200105 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
106 * 10 seconds to send reply for the initial 64-byte descriptor request.
107 */
108/* define initial 64-byte descriptor request timeout in milliseconds */
109static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
110module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
Wu Fengguangb9cef6c2008-12-15 15:32:01 +0800111MODULE_PARM_DESC(initial_descriptor_timeout,
112 "initial 64-byte descriptor request timeout in milliseconds "
113 "(default 5000 - 5.0 seconds)");
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +0200114
115/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 * As of 2.6.10 we introduce a new USB device initialization scheme which
117 * closely resembles the way Windows works. Hopefully it will be compatible
118 * with a wider range of devices than the old scheme. However some previously
119 * working devices may start giving rise to "device not accepting address"
120 * errors; if that happens the user can try the old scheme by adjusting the
121 * following module parameters.
122 *
123 * For maximum flexibility there are two boolean parameters to control the
124 * hub driver's behavior. On the first initialization attempt, if the
125 * "old_scheme_first" parameter is set then the old scheme will be used,
126 * otherwise the new scheme is used. If that fails and "use_both_schemes"
127 * is set, then the driver will make another attempt, using the other scheme.
128 */
129static int old_scheme_first = 0;
130module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
131MODULE_PARM_DESC(old_scheme_first,
132 "start with the old device initialization scheme");
133
134static int use_both_schemes = 1;
135module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
136MODULE_PARM_DESC(use_both_schemes,
137 "try the other device initialization scheme if the "
138 "first one fails");
139
Alan Stern32fe0192007-10-10 16:27:07 -0400140/* Mutual exclusion for EHCI CF initialization. This interferes with
141 * port reset on some companion controllers.
142 */
143DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
144EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
145
Alan Stern948fea32008-04-28 11:07:07 -0400146#define HUB_DEBOUNCE_TIMEOUT 1500
147#define HUB_DEBOUNCE_STEP 25
148#define HUB_DEBOUNCE_STABLE 100
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Ming Lei742120c2008-06-18 22:00:29 +0800151static int usb_reset_and_verify_device(struct usb_device *udev);
152
Dan Williams404d5b12007-04-26 00:12:10 -0700153static inline char *portspeed(int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154{
155 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
156 return "480 Mb/s";
157 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
158 return "1.5 Mb/s";
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700159 else if (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED))
160 return "5.0 Gb/s";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 else
162 return "12 Mb/s";
163}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165/* Note that hdev or one of its children must be locked! */
Alan Stern251180842009-07-22 14:41:18 -0400166static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Alan Stern251180842009-07-22 14:41:18 -0400168 if (!hdev || !hdev->actconfig)
169 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 return usb_get_intfdata(hdev->actconfig->interface[0]);
171}
172
173/* USB 2.0 spec Section 11.24.4.5 */
174static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
175{
176 int i, ret;
177
178 for (i = 0; i < 3; i++) {
179 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
180 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
181 USB_DT_HUB << 8, 0, data, size,
182 USB_CTRL_GET_TIMEOUT);
183 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
184 return ret;
185 }
186 return -EINVAL;
187}
188
189/*
190 * USB 2.0 spec Section 11.24.2.1
191 */
192static int clear_hub_feature(struct usb_device *hdev, int feature)
193{
194 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
195 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
196}
197
198/*
199 * USB 2.0 spec Section 11.24.2.2
200 */
201static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
202{
203 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
204 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
205 NULL, 0, 1000);
206}
207
208/*
209 * USB 2.0 spec Section 11.24.2.13
210 */
211static int set_port_feature(struct usb_device *hdev, int port1, int feature)
212{
213 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
214 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
215 NULL, 0, 1000);
216}
217
218/*
219 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
220 * for info about using port indicators
221 */
222static void set_port_led(
223 struct usb_hub *hub,
224 int port1,
225 int selector
226)
227{
228 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
229 USB_PORT_FEAT_INDICATOR);
230 if (status < 0)
231 dev_dbg (hub->intfdev,
232 "port %d indicator %s status %d\n",
233 port1,
234 ({ char *s; switch (selector) {
235 case HUB_LED_AMBER: s = "amber"; break;
236 case HUB_LED_GREEN: s = "green"; break;
237 case HUB_LED_OFF: s = "off"; break;
238 case HUB_LED_AUTO: s = "auto"; break;
239 default: s = "??"; break;
240 }; s; }),
241 status);
242}
243
244#define LED_CYCLE_PERIOD ((2*HZ)/3)
245
David Howellsc4028952006-11-22 14:57:56 +0000246static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
David Howellsc4028952006-11-22 14:57:56 +0000248 struct usb_hub *hub =
249 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 struct usb_device *hdev = hub->hdev;
251 unsigned i;
252 unsigned changed = 0;
253 int cursor = -1;
254
255 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
256 return;
257
258 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
259 unsigned selector, mode;
260
261 /* 30%-50% duty cycle */
262
263 switch (hub->indicator[i]) {
264 /* cycle marker */
265 case INDICATOR_CYCLE:
266 cursor = i;
267 selector = HUB_LED_AUTO;
268 mode = INDICATOR_AUTO;
269 break;
270 /* blinking green = sw attention */
271 case INDICATOR_GREEN_BLINK:
272 selector = HUB_LED_GREEN;
273 mode = INDICATOR_GREEN_BLINK_OFF;
274 break;
275 case INDICATOR_GREEN_BLINK_OFF:
276 selector = HUB_LED_OFF;
277 mode = INDICATOR_GREEN_BLINK;
278 break;
279 /* blinking amber = hw attention */
280 case INDICATOR_AMBER_BLINK:
281 selector = HUB_LED_AMBER;
282 mode = INDICATOR_AMBER_BLINK_OFF;
283 break;
284 case INDICATOR_AMBER_BLINK_OFF:
285 selector = HUB_LED_OFF;
286 mode = INDICATOR_AMBER_BLINK;
287 break;
288 /* blink green/amber = reserved */
289 case INDICATOR_ALT_BLINK:
290 selector = HUB_LED_GREEN;
291 mode = INDICATOR_ALT_BLINK_OFF;
292 break;
293 case INDICATOR_ALT_BLINK_OFF:
294 selector = HUB_LED_AMBER;
295 mode = INDICATOR_ALT_BLINK;
296 break;
297 default:
298 continue;
299 }
300 if (selector != HUB_LED_AUTO)
301 changed = 1;
302 set_port_led(hub, i + 1, selector);
303 hub->indicator[i] = mode;
304 }
305 if (!changed && blinkenlights) {
306 cursor++;
307 cursor %= hub->descriptor->bNbrPorts;
308 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
309 hub->indicator[cursor] = INDICATOR_CYCLE;
310 changed++;
311 }
312 if (changed)
313 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
314}
315
316/* use a short timeout for hub/port status fetches */
317#define USB_STS_TIMEOUT 1000
318#define USB_STS_RETRIES 5
319
320/*
321 * USB 2.0 spec Section 11.24.2.6
322 */
323static int get_hub_status(struct usb_device *hdev,
324 struct usb_hub_status *data)
325{
326 int i, status = -ETIMEDOUT;
327
328 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
329 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
330 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
331 data, sizeof(*data), USB_STS_TIMEOUT);
332 }
333 return status;
334}
335
336/*
337 * USB 2.0 spec Section 11.24.2.7
338 */
339static int get_port_status(struct usb_device *hdev, int port1,
340 struct usb_port_status *data)
341{
342 int i, status = -ETIMEDOUT;
343
344 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
345 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
346 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
347 data, sizeof(*data), USB_STS_TIMEOUT);
348 }
349 return status;
350}
351
Alan Stern3eb14912008-03-03 15:15:43 -0500352static int hub_port_status(struct usb_hub *hub, int port1,
353 u16 *status, u16 *change)
354{
355 int ret;
356
357 mutex_lock(&hub->status_mutex);
358 ret = get_port_status(hub->hdev, port1, &hub->status->port);
359 if (ret < 4) {
360 dev_err(hub->intfdev,
361 "%s failed (err = %d)\n", __func__, ret);
362 if (ret >= 0)
363 ret = -EIO;
364 } else {
365 *status = le16_to_cpu(hub->status->port.wPortStatus);
366 *change = le16_to_cpu(hub->status->port.wPortChange);
367 ret = 0;
368 }
369 mutex_unlock(&hub->status_mutex);
370 return ret;
371}
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373static void kick_khubd(struct usb_hub *hub)
374{
375 unsigned long flags;
376
Alan Stern40f122f2006-11-09 14:44:33 -0500377 /* Suppress autosuspend until khubd runs */
Alan Sternccf5b802009-06-29 11:00:01 -0400378 atomic_set(&to_usb_interface(hub->intfdev)->pm_usage_cnt, 1);
Alan Stern40f122f2006-11-09 14:44:33 -0500379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 spin_lock_irqsave(&hub_event_lock, flags);
Roel Kluin2e2c5ee2007-10-26 23:54:35 +0200381 if (!hub->disconnected && list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 list_add_tail(&hub->event_list, &hub_event_list);
383 wake_up(&khubd_wait);
384 }
385 spin_unlock_irqrestore(&hub_event_lock, flags);
386}
387
388void usb_kick_khubd(struct usb_device *hdev)
389{
Alan Stern251180842009-07-22 14:41:18 -0400390 struct usb_hub *hub = hdev_to_hub(hdev);
391
392 if (hub)
393 kick_khubd(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394}
395
396
397/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100398static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200400 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400401 int status = urb->status;
Roel Kluin71d27182009-03-13 12:19:18 +0100402 unsigned i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 unsigned long bits;
404
Alan Sterne0152682007-08-24 15:42:52 -0400405 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 case -ENOENT: /* synchronous unlink */
407 case -ECONNRESET: /* async unlink */
408 case -ESHUTDOWN: /* hardware going away */
409 return;
410
411 default: /* presumably an error */
412 /* Cause a hub reset after 10 consecutive errors */
Alan Sterne0152682007-08-24 15:42:52 -0400413 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 if ((++hub->nerrors < 10) || hub->error)
415 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400416 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200418
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 /* let khubd handle things */
420 case 0: /* we got data: port status changed */
421 bits = 0;
422 for (i = 0; i < urb->actual_length; ++i)
423 bits |= ((unsigned long) ((*hub->buffer)[i]))
424 << (i*8);
425 hub->event_bits[0] = bits;
426 break;
427 }
428
429 hub->nerrors = 0;
430
431 /* Something happened, let khubd figure it out */
432 kick_khubd(hub);
433
434resubmit:
435 if (hub->quiescing)
436 return;
437
438 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
439 && status != -ENODEV && status != -EPERM)
440 dev_err (hub->intfdev, "resubmit --> %d\n", status);
441}
442
443/* USB 2.0 spec Section 11.24.2.3 */
444static inline int
445hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
446{
Alan Sternc2f65952009-11-18 11:37:15 -0500447 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
449 tt, NULL, 0, 1000);
450}
451
452/*
453 * enumeration blocks khubd for a long time. we use keventd instead, since
454 * long blocking there is the exception, not the rule. accordingly, HCDs
455 * talking to TTs must queue control transfers (not just bulk and iso), so
456 * both can talk to the same hub concurrently.
457 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400458static void hub_tt_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
David Howellsc4028952006-11-22 14:57:56 +0000460 struct usb_hub *hub =
Alan Sterncb88a1b2009-06-29 10:43:32 -0400461 container_of(work, struct usb_hub, tt.clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 unsigned long flags;
Mark Lord55e5fdf2007-05-14 19:48:02 -0400463 int limit = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
465 spin_lock_irqsave (&hub->tt.lock, flags);
Mark Lord55e5fdf2007-05-14 19:48:02 -0400466 while (--limit && !list_empty (&hub->tt.clear_list)) {
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400467 struct list_head *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 struct usb_tt_clear *clear;
469 struct usb_device *hdev = hub->hdev;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400470 const struct hc_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 int status;
472
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400473 next = hub->tt.clear_list.next;
474 clear = list_entry (next, struct usb_tt_clear, clear_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 list_del (&clear->clear_list);
476
477 /* drop lock so HCD can concurrently report other TT errors */
478 spin_unlock_irqrestore (&hub->tt.lock, flags);
479 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (status)
481 dev_err (&hdev->dev,
482 "clear tt %d (%04x) error %d\n",
483 clear->tt, clear->devinfo, status);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400484
485 /* Tell the HCD, even if the operation failed */
486 drv = clear->hcd->driver;
487 if (drv->clear_tt_buffer_complete)
488 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
489
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700490 kfree(clear);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400491 spin_lock_irqsave(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
493 spin_unlock_irqrestore (&hub->tt.lock, flags);
494}
495
496/**
Alan Sterncb88a1b2009-06-29 10:43:32 -0400497 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
498 * @urb: an URB associated with the failed or incomplete split transaction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 *
500 * High speed HCDs use this to tell the hub driver that some split control or
501 * bulk transaction failed in a way that requires clearing internal state of
502 * a transaction translator. This is normally detected (and reported) from
503 * interrupt context.
504 *
505 * It may not be possible for that hub to handle additional full (or low)
506 * speed transactions until that state is fully cleared out.
507 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400508int usb_hub_clear_tt_buffer(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Alan Sterncb88a1b2009-06-29 10:43:32 -0400510 struct usb_device *udev = urb->dev;
511 int pipe = urb->pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 struct usb_tt *tt = udev->tt;
513 unsigned long flags;
514 struct usb_tt_clear *clear;
515
516 /* we've got to cope with an arbitrary number of pending TT clears,
517 * since each TT has "at least two" buffers that can need it (and
518 * there can be many TTs per hub). even if they're uncommon.
519 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800520 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
522 /* FIXME recover somehow ... RESET_TT? */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400523 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 }
525
526 /* info that CLEAR_TT_BUFFER needs */
527 clear->tt = tt->multi ? udev->ttport : 1;
528 clear->devinfo = usb_pipeendpoint (pipe);
529 clear->devinfo |= udev->devnum << 4;
530 clear->devinfo |= usb_pipecontrol (pipe)
531 ? (USB_ENDPOINT_XFER_CONTROL << 11)
532 : (USB_ENDPOINT_XFER_BULK << 11);
533 if (usb_pipein (pipe))
534 clear->devinfo |= 1 << 15;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400535
536 /* info for completion callback */
537 clear->hcd = bus_to_hcd(udev->bus);
538 clear->ep = urb->ep;
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 /* tell keventd to clear state for this TT */
541 spin_lock_irqsave (&tt->lock, flags);
542 list_add_tail (&clear->clear_list, &tt->clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400543 schedule_work(&tt->clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 spin_unlock_irqrestore (&tt->lock, flags);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400545 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
Alan Sterncb88a1b2009-06-29 10:43:32 -0400547EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Alan Stern8520f382008-09-22 14:44:26 -0400549/* If do_delay is false, return the number of milliseconds the caller
550 * needs to delay.
551 */
552static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
554 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700555 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern8520f382008-09-22 14:44:26 -0400556 unsigned delay;
Alan Stern4489a572006-04-27 15:54:22 -0400557 u16 wHubCharacteristics =
558 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Alan Stern4489a572006-04-27 15:54:22 -0400560 /* Enable power on each port. Some hubs have reserved values
561 * of LPSM (> 2) in their descriptors, even though they are
562 * USB 2.0 hubs. Some hubs do not implement port-power switching
563 * but only emulate it. In all cases, the ports won't work
564 * unless we send these messages to the hub.
565 */
566 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400568 else
569 dev_dbg(hub->intfdev, "trying to enable port power on "
570 "non-switchable hub\n");
571 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
572 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
David Brownellb7896962005-08-31 10:41:44 -0700574 /* Wait at least 100 msec for power to become stable */
Alan Stern8520f382008-09-22 14:44:26 -0400575 delay = max(pgood_delay, (unsigned) 100);
576 if (do_delay)
577 msleep(delay);
578 return delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581static int hub_hub_status(struct usb_hub *hub,
582 u16 *status, u16 *change)
583{
584 int ret;
585
Alan Sterndb90e7a2007-02-05 09:56:15 -0500586 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 ret = get_hub_status(hub->hdev, &hub->status->hub);
588 if (ret < 0)
589 dev_err (hub->intfdev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800590 "%s failed (err = %d)\n", __func__, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 else {
592 *status = le16_to_cpu(hub->status->hub.wHubStatus);
593 *change = le16_to_cpu(hub->status->hub.wHubChange);
594 ret = 0;
595 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500596 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return ret;
598}
599
Alan Stern8b28c752005-08-10 17:04:13 -0400600static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
601{
602 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400603 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400604
Alan Stern0458d5b2007-05-04 11:52:20 -0400605 if (hdev->children[port1-1] && set_state)
Alan Stern8b28c752005-08-10 17:04:13 -0400606 usb_set_device_state(hdev->children[port1-1],
607 USB_STATE_NOTATTACHED);
Alan Stern0458d5b2007-05-04 11:52:20 -0400608 if (!hub->error)
609 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
Alan Stern8b28c752005-08-10 17:04:13 -0400610 if (ret)
611 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
Alan Stern0458d5b2007-05-04 11:52:20 -0400612 port1, ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400613 return ret;
614}
615
Alan Stern0458d5b2007-05-04 11:52:20 -0400616/*
617 * Disable a port and mark a logical connnect-change event, so that some
618 * time later khubd will disconnect() any existing usb_device on the port
619 * and will re-enumerate if there actually is a device attached.
620 */
621static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
622{
623 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
624 hub_port_disable(hub, port1, 1);
625
626 /* FIXME let caller ask to power down the port:
627 * - some devices won't enumerate without a VBUS power cycle
628 * - SRP saves power that way
629 * - ... new call, TBD ...
630 * That's easy if this hub can switch power per-port, and
631 * khubd reactivates the port later (timer, SRP, etc).
632 * Powerdown must be optional, because of reset/DFU.
633 */
634
635 set_bit(port1, hub->change_bits);
636 kick_khubd(hub);
637}
638
Alan Stern6ee0b272008-04-28 11:06:42 -0400639enum hub_activation_type {
Alan Stern8520f382008-09-22 14:44:26 -0400640 HUB_INIT, HUB_INIT2, HUB_INIT3,
641 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
Alan Stern6ee0b272008-04-28 11:06:42 -0400642};
Alan Stern5e6effa2008-03-03 15:15:51 -0500643
Alan Stern8520f382008-09-22 14:44:26 -0400644static void hub_init_func2(struct work_struct *ws);
645static void hub_init_func3(struct work_struct *ws);
646
Alan Sternf2835212008-04-28 11:07:17 -0400647static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
Alan Stern5e6effa2008-03-03 15:15:51 -0500648{
649 struct usb_device *hdev = hub->hdev;
650 int port1;
Alan Sternf2835212008-04-28 11:07:17 -0400651 int status;
Alan Stern948fea32008-04-28 11:07:07 -0400652 bool need_debounce_delay = false;
Alan Stern8520f382008-09-22 14:44:26 -0400653 unsigned delay;
654
655 /* Continue a partial initialization */
656 if (type == HUB_INIT2)
657 goto init2;
658 if (type == HUB_INIT3)
659 goto init3;
Alan Stern5e6effa2008-03-03 15:15:51 -0500660
Alan Sternf2835212008-04-28 11:07:17 -0400661 /* After a resume, port power should still be on.
662 * For any other type of activation, turn it on.
663 */
Alan Stern8520f382008-09-22 14:44:26 -0400664 if (type != HUB_RESUME) {
665
666 /* Speed up system boot by using a delayed_work for the
667 * hub's initial power-up delays. This is pretty awkward
668 * and the implementation looks like a home-brewed sort of
669 * setjmp/longjmp, but it saves at least 100 ms for each
670 * root hub (assuming usbcore is compiled into the kernel
671 * rather than as a module). It adds up.
672 *
673 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
674 * because for those activation types the ports have to be
675 * operational when we return. In theory this could be done
676 * for HUB_POST_RESET, but it's easier not to.
677 */
678 if (type == HUB_INIT) {
679 delay = hub_power_on(hub, false);
680 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
681 schedule_delayed_work(&hub->init_work,
682 msecs_to_jiffies(delay));
Alan Stern61fbeba2008-10-27 12:07:44 -0400683
684 /* Suppress autosuspend until init is done */
Alan Sternccf5b802009-06-29 11:00:01 -0400685 atomic_set(&to_usb_interface(hub->intfdev)->
686 pm_usage_cnt, 1);
Alan Stern8520f382008-09-22 14:44:26 -0400687 return; /* Continues at init2: below */
688 } else {
689 hub_power_on(hub, true);
690 }
691 }
692 init2:
Alan Sternf2835212008-04-28 11:07:17 -0400693
Alan Stern6ee0b272008-04-28 11:06:42 -0400694 /* Check each port and set hub->change_bits to let khubd know
695 * which ports need attention.
Alan Stern5e6effa2008-03-03 15:15:51 -0500696 */
697 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
698 struct usb_device *udev = hdev->children[port1-1];
Alan Stern5e6effa2008-03-03 15:15:51 -0500699 u16 portstatus, portchange;
700
Alan Stern6ee0b272008-04-28 11:06:42 -0400701 portstatus = portchange = 0;
702 status = hub_port_status(hub, port1, &portstatus, &portchange);
703 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
704 dev_dbg(hub->intfdev,
705 "port %d: status %04x change %04x\n",
706 port1, portstatus, portchange);
Alan Stern5e6effa2008-03-03 15:15:51 -0500707
Alan Stern6ee0b272008-04-28 11:06:42 -0400708 /* After anything other than HUB_RESUME (i.e., initialization
709 * or any sort of reset), every port should be disabled.
710 * Unconnected ports should likewise be disabled (paranoia),
711 * and so should ports for which we have no usb_device.
Alan Stern5e6effa2008-03-03 15:15:51 -0500712 */
Alan Stern6ee0b272008-04-28 11:06:42 -0400713 if ((portstatus & USB_PORT_STAT_ENABLE) && (
714 type != HUB_RESUME ||
715 !(portstatus & USB_PORT_STAT_CONNECTION) ||
716 !udev ||
717 udev->state == USB_STATE_NOTATTACHED)) {
718 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
719 portstatus &= ~USB_PORT_STAT_ENABLE;
720 }
721
Alan Stern948fea32008-04-28 11:07:07 -0400722 /* Clear status-change flags; we'll debounce later */
723 if (portchange & USB_PORT_STAT_C_CONNECTION) {
724 need_debounce_delay = true;
725 clear_port_feature(hub->hdev, port1,
726 USB_PORT_FEAT_C_CONNECTION);
727 }
728 if (portchange & USB_PORT_STAT_C_ENABLE) {
729 need_debounce_delay = true;
730 clear_port_feature(hub->hdev, port1,
731 USB_PORT_FEAT_C_ENABLE);
732 }
733
Alan Stern6ee0b272008-04-28 11:06:42 -0400734 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
735 /* Tell khubd to disconnect the device or
736 * check for a new connection
737 */
738 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
739 set_bit(port1, hub->change_bits);
740
741 } else if (portstatus & USB_PORT_STAT_ENABLE) {
742 /* The power session apparently survived the resume.
743 * If there was an overcurrent or suspend change
744 * (i.e., remote wakeup request), have khubd
745 * take care of it.
746 */
747 if (portchange)
748 set_bit(port1, hub->change_bits);
749
750 } else if (udev->persist_enabled) {
Alan Stern6ee0b272008-04-28 11:06:42 -0400751#ifdef CONFIG_PM
Alan Stern5e6effa2008-03-03 15:15:51 -0500752 udev->reset_resume = 1;
Alan Stern6ee0b272008-04-28 11:06:42 -0400753#endif
Alan Stern8808f002008-04-28 11:06:55 -0400754 set_bit(port1, hub->change_bits);
755
Alan Stern6ee0b272008-04-28 11:06:42 -0400756 } else {
757 /* The power session is gone; tell khubd */
758 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
759 set_bit(port1, hub->change_bits);
Alan Stern5e6effa2008-03-03 15:15:51 -0500760 }
Alan Stern5e6effa2008-03-03 15:15:51 -0500761 }
762
Alan Stern948fea32008-04-28 11:07:07 -0400763 /* If no port-status-change flags were set, we don't need any
764 * debouncing. If flags were set we can try to debounce the
765 * ports all at once right now, instead of letting khubd do them
766 * one at a time later on.
767 *
768 * If any port-status changes do occur during this delay, khubd
769 * will see them later and handle them normally.
770 */
Alan Stern8520f382008-09-22 14:44:26 -0400771 if (need_debounce_delay) {
772 delay = HUB_DEBOUNCE_STABLE;
Alan Sternf2835212008-04-28 11:07:17 -0400773
Alan Stern8520f382008-09-22 14:44:26 -0400774 /* Don't do a long sleep inside a workqueue routine */
775 if (type == HUB_INIT2) {
776 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
777 schedule_delayed_work(&hub->init_work,
778 msecs_to_jiffies(delay));
779 return; /* Continues at init3: below */
780 } else {
781 msleep(delay);
782 }
783 }
784 init3:
Alan Sternf2835212008-04-28 11:07:17 -0400785 hub->quiescing = 0;
786
787 status = usb_submit_urb(hub->urb, GFP_NOIO);
788 if (status < 0)
789 dev_err(hub->intfdev, "activate --> %d\n", status);
790 if (hub->has_indicators && blinkenlights)
791 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
792
793 /* Scan all ports that need attention */
794 kick_khubd(hub);
Alan Stern5e6effa2008-03-03 15:15:51 -0500795}
796
Alan Stern8520f382008-09-22 14:44:26 -0400797/* Implement the continuations for the delays above */
798static void hub_init_func2(struct work_struct *ws)
799{
800 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
801
802 hub_activate(hub, HUB_INIT2);
803}
804
805static void hub_init_func3(struct work_struct *ws)
806{
807 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
808
809 hub_activate(hub, HUB_INIT3);
810}
811
Alan Stern43303542008-04-28 11:07:31 -0400812enum hub_quiescing_type {
813 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
814};
815
816static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
817{
818 struct usb_device *hdev = hub->hdev;
819 int i;
820
Alan Stern8520f382008-09-22 14:44:26 -0400821 cancel_delayed_work_sync(&hub->init_work);
822
Alan Stern43303542008-04-28 11:07:31 -0400823 /* khubd and related activity won't re-trigger */
824 hub->quiescing = 1;
825
826 if (type != HUB_SUSPEND) {
827 /* Disconnect all the children */
828 for (i = 0; i < hdev->maxchild; ++i) {
829 if (hdev->children[i])
830 usb_disconnect(&hdev->children[i]);
831 }
832 }
833
834 /* Stop khubd and related activity */
835 usb_kill_urb(hub->urb);
836 if (hub->has_indicators)
837 cancel_delayed_work_sync(&hub->leds);
838 if (hub->tt.hub)
Alan Sterncb88a1b2009-06-29 10:43:32 -0400839 cancel_work_sync(&hub->tt.clear_work);
Alan Stern43303542008-04-28 11:07:31 -0400840}
841
Alan Stern3eb14912008-03-03 15:15:43 -0500842/* caller has locked the hub device */
843static int hub_pre_reset(struct usb_interface *intf)
844{
845 struct usb_hub *hub = usb_get_intfdata(intf);
846
Alan Stern43303542008-04-28 11:07:31 -0400847 hub_quiesce(hub, HUB_PRE_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -0400848 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500849}
850
851/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -0400852static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500853{
Alan Stern7de18d82006-06-01 13:37:24 -0400854 struct usb_hub *hub = usb_get_intfdata(intf);
855
Alan Sternf2835212008-04-28 11:07:17 -0400856 hub_activate(hub, HUB_POST_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -0400857 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500858}
859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860static int hub_configure(struct usb_hub *hub,
861 struct usb_endpoint_descriptor *endpoint)
862{
Sarah Sharpb356b7c2009-09-04 10:53:24 -0700863 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 struct usb_device *hdev = hub->hdev;
865 struct device *hub_dev = hub->intfdev;
866 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700867 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 unsigned int pipe;
869 int maxp, ret;
Alan Stern7cbe5dc2009-06-29 10:56:54 -0400870 char *message = "out of memory";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
873 &hub->buffer_dma);
874 if (!hub->buffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 ret = -ENOMEM;
876 goto fail;
877 }
878
879 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
880 if (!hub->status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 ret = -ENOMEM;
882 goto fail;
883 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500884 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
887 if (!hub->descriptor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 ret = -ENOMEM;
889 goto fail;
890 }
891
892 /* Request the entire hub descriptor.
893 * hub->descriptor can handle USB_MAXCHILDREN ports,
894 * but the hub can/will return fewer bytes here.
895 */
896 ret = get_hub_descriptor(hdev, hub->descriptor,
897 sizeof(*hub->descriptor));
898 if (ret < 0) {
899 message = "can't read hub descriptor";
900 goto fail;
901 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
902 message = "hub has too many ports!";
903 ret = -ENODEV;
904 goto fail;
905 }
906
907 hdev->maxchild = hub->descriptor->bNbrPorts;
908 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
909 (hdev->maxchild == 1) ? "" : "s");
910
Alan Stern7cbe5dc2009-06-29 10:56:54 -0400911 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
912 if (!hub->port_owners) {
913 ret = -ENOMEM;
914 goto fail;
915 }
916
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700917 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700919 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 int i;
921 char portstr [USB_MAXCHILDREN + 1];
922
923 for (i = 0; i < hdev->maxchild; i++)
924 portstr[i] = hub->descriptor->DeviceRemovable
925 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
926 ? 'F' : 'R';
927 portstr[hdev->maxchild] = 0;
928 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
929 } else
930 dev_dbg(hub_dev, "standalone hub\n");
931
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700932 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 case 0x00:
934 dev_dbg(hub_dev, "ganged power switching\n");
935 break;
936 case 0x01:
937 dev_dbg(hub_dev, "individual port power switching\n");
938 break;
939 case 0x02:
940 case 0x03:
941 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
942 break;
943 }
944
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700945 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 case 0x00:
947 dev_dbg(hub_dev, "global over-current protection\n");
948 break;
949 case 0x08:
950 dev_dbg(hub_dev, "individual port over-current protection\n");
951 break;
952 case 0x10:
953 case 0x18:
954 dev_dbg(hub_dev, "no over-current protection\n");
955 break;
956 }
957
958 spin_lock_init (&hub->tt.lock);
959 INIT_LIST_HEAD (&hub->tt.clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400960 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 switch (hdev->descriptor.bDeviceProtocol) {
962 case 0:
963 break;
964 case 1:
965 dev_dbg(hub_dev, "Single TT\n");
966 hub->tt.hub = hdev;
967 break;
968 case 2:
969 ret = usb_set_interface(hdev, 0, 1);
970 if (ret == 0) {
971 dev_dbg(hub_dev, "TT per port\n");
972 hub->tt.multi = 1;
973 } else
974 dev_err(hub_dev, "Using single TT (err %d)\n",
975 ret);
976 hub->tt.hub = hdev;
977 break;
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700978 case 3:
979 /* USB 3.0 hubs don't have a TT */
980 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 default:
982 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
983 hdev->descriptor.bDeviceProtocol);
984 break;
985 }
986
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700987 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700988 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700989 case HUB_TTTT_8_BITS:
990 if (hdev->descriptor.bDeviceProtocol != 0) {
991 hub->tt.think_time = 666;
992 dev_dbg(hub_dev, "TT requires at most %d "
993 "FS bit times (%d ns)\n",
994 8, hub->tt.think_time);
995 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700997 case HUB_TTTT_16_BITS:
998 hub->tt.think_time = 666 * 2;
999 dev_dbg(hub_dev, "TT requires at most %d "
1000 "FS bit times (%d ns)\n",
1001 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001003 case HUB_TTTT_24_BITS:
1004 hub->tt.think_time = 666 * 3;
1005 dev_dbg(hub_dev, "TT requires at most %d "
1006 "FS bit times (%d ns)\n",
1007 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001009 case HUB_TTTT_32_BITS:
1010 hub->tt.think_time = 666 * 4;
1011 dev_dbg(hub_dev, "TT requires at most %d "
1012 "FS bit times (%d ns)\n",
1013 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 break;
1015 }
1016
1017 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001018 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 hub->has_indicators = 1;
1020 dev_dbg(hub_dev, "Port indicators are supported\n");
1021 }
1022
1023 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1024 hub->descriptor->bPwrOn2PwrGood * 2);
1025
1026 /* power budgeting mostly matters with bus-powered hubs,
1027 * and battery-powered root hubs (may provide just 8 mA).
1028 */
1029 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001030 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 message = "can't get hub status";
1032 goto fail;
1033 }
Alan Stern7d35b922005-04-25 11:18:32 -04001034 le16_to_cpus(&hubstatus);
1035 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -05001036 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1037 hub->mA_per_port = 500;
1038 else {
1039 hub->mA_per_port = hdev->bus_mA;
1040 hub->limited_power = 1;
1041 }
Alan Stern7d35b922005-04-25 11:18:32 -04001042 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1044 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -05001045 hub->limited_power = 1;
1046 if (hdev->maxchild > 0) {
1047 int remaining = hdev->bus_mA -
1048 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Alan Stern55c52712005-11-23 12:03:12 -05001050 if (remaining < hdev->maxchild * 100)
1051 dev_warn(hub_dev,
1052 "insufficient power available "
1053 "to use all downstream ports\n");
1054 hub->mA_per_port = 100; /* 7.2.1.1 */
1055 }
1056 } else { /* Self-powered external hub */
1057 /* FIXME: What about battery-powered external hubs that
1058 * provide less current per port? */
1059 hub->mA_per_port = 500;
1060 }
1061 if (hub->mA_per_port < 500)
1062 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1063 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001065 /* Update the HCD's internal representation of this hub before khubd
1066 * starts getting port status changes for devices under the hub.
1067 */
1068 hcd = bus_to_hcd(hdev->bus);
1069 if (hcd->driver->update_hub_device) {
1070 ret = hcd->driver->update_hub_device(hcd, hdev,
1071 &hub->tt, GFP_KERNEL);
1072 if (ret < 0) {
1073 message = "can't update HCD hub info";
1074 goto fail;
1075 }
1076 }
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1079 if (ret < 0) {
1080 message = "can't get hub status";
1081 goto fail;
1082 }
1083
1084 /* local power status reports aren't always correct */
1085 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1086 dev_dbg(hub_dev, "local power source is %s\n",
1087 (hubstatus & HUB_STATUS_LOCAL_POWER)
1088 ? "lost (inactive)" : "good");
1089
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001090 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 dev_dbg(hub_dev, "%sover-current condition exists\n",
1092 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1093
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -07001094 /* set up the interrupt endpoint
1095 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1096 * bytes as USB2.0[11.12.3] says because some hubs are known
1097 * to send more data (and thus cause overflow). For root hubs,
1098 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1099 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1101 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1102
1103 if (maxp > sizeof(*hub->buffer))
1104 maxp = sizeof(*hub->buffer);
1105
1106 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1107 if (!hub->urb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 ret = -ENOMEM;
1109 goto fail;
1110 }
1111
1112 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1113 hub, endpoint->bInterval);
1114 hub->urb->transfer_dma = hub->buffer_dma;
1115 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1116
1117 /* maybe cycle the hub leds */
1118 if (hub->has_indicators && blinkenlights)
1119 hub->indicator [0] = INDICATOR_CYCLE;
1120
Alan Sternf2835212008-04-28 11:07:17 -04001121 hub_activate(hub, HUB_INIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 return 0;
1123
1124fail:
1125 dev_err (hub_dev, "config failed, %s (err %d)\n",
1126 message, ret);
1127 /* hub_disconnect() frees urb and descriptor */
1128 return ret;
1129}
1130
Alan Sterne8054852007-05-04 11:55:11 -04001131static void hub_release(struct kref *kref)
1132{
1133 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1134
1135 usb_put_intf(to_usb_interface(hub->intfdev));
1136 kfree(hub);
1137}
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139static unsigned highspeed_hubs;
1140
1141static void hub_disconnect(struct usb_interface *intf)
1142{
1143 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Sterne8054852007-05-04 11:55:11 -04001144
1145 /* Take the hub off the event list and don't let it be added again */
1146 spin_lock_irq(&hub_event_lock);
1147 list_del_init(&hub->event_list);
1148 hub->disconnected = 1;
1149 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Alan Stern7de18d82006-06-01 13:37:24 -04001151 /* Disconnect all children and quiesce the hub */
1152 hub->error = 0;
Alan Stern43303542008-04-28 11:07:31 -04001153 hub_quiesce(hub, HUB_DISCONNECT);
Alan Stern7de18d82006-06-01 13:37:24 -04001154
Alan Stern8b28c752005-08-10 17:04:13 -04001155 usb_set_intfdata (intf, NULL);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001156 hub->hdev->maxchild = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Alan Sterne8054852007-05-04 11:55:11 -04001158 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 highspeed_hubs--;
1160
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 usb_free_urb(hub->urb);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001162 kfree(hub->port_owners);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001163 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001164 kfree(hub->status);
Alan Sterne8054852007-05-04 11:55:11 -04001165 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1166 hub->buffer_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Alan Sterne8054852007-05-04 11:55:11 -04001168 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169}
1170
1171static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1172{
1173 struct usb_host_interface *desc;
1174 struct usb_endpoint_descriptor *endpoint;
1175 struct usb_device *hdev;
1176 struct usb_hub *hub;
1177
1178 desc = intf->cur_altsetting;
1179 hdev = interface_to_usbdev(intf);
1180
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001181 if (hdev->level == MAX_TOPO_LEVEL) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001182 dev_err(&intf->dev,
1183 "Unsupported bus topology: hub nested too deep\n");
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001184 return -E2BIG;
1185 }
1186
David Brownell89ccbdc2006-04-02 10:18:09 -08001187#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1188 if (hdev->parent) {
1189 dev_warn(&intf->dev, "ignoring external hub\n");
1190 return -ENODEV;
1191 }
1192#endif
1193
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 /* Some hubs have a subclass of 1, which AFAICT according to the */
1195 /* specs is not defined, but it works */
1196 if ((desc->desc.bInterfaceSubClass != 0) &&
1197 (desc->desc.bInterfaceSubClass != 1)) {
1198descriptor_error:
1199 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1200 return -EIO;
1201 }
1202
1203 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1204 if (desc->desc.bNumEndpoints != 1)
1205 goto descriptor_error;
1206
1207 endpoint = &desc->endpoint[0].desc;
1208
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -07001209 /* If it's not an interrupt in endpoint, we'd better punt! */
1210 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 goto descriptor_error;
1212
1213 /* We found a hub */
1214 dev_info (&intf->dev, "USB hub found\n");
1215
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001216 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 if (!hub) {
1218 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1219 return -ENOMEM;
1220 }
1221
Alan Sterne8054852007-05-04 11:55:11 -04001222 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 INIT_LIST_HEAD(&hub->event_list);
1224 hub->intfdev = &intf->dev;
1225 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001226 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Stern8520f382008-09-22 14:44:26 -04001227 INIT_DELAYED_WORK(&hub->init_work, NULL);
Alan Sterne8054852007-05-04 11:55:11 -04001228 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
1230 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001231 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
1233 if (hdev->speed == USB_SPEED_HIGH)
1234 highspeed_hubs++;
1235
1236 if (hub_configure(hub, endpoint) >= 0)
1237 return 0;
1238
1239 hub_disconnect (intf);
1240 return -ENODEV;
1241}
1242
1243static int
1244hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1245{
1246 struct usb_device *hdev = interface_to_usbdev (intf);
1247
1248 /* assert ifno == 0 (part of hub spec) */
1249 switch (code) {
1250 case USBDEVFS_HUB_PORTINFO: {
1251 struct usbdevfs_hub_portinfo *info = user_data;
1252 int i;
1253
1254 spin_lock_irq(&device_state_lock);
1255 if (hdev->devnum <= 0)
1256 info->nports = 0;
1257 else {
1258 info->nports = hdev->maxchild;
1259 for (i = 0; i < info->nports; i++) {
1260 if (hdev->children[i] == NULL)
1261 info->port[i] = 0;
1262 else
1263 info->port[i] =
1264 hdev->children[i]->devnum;
1265 }
1266 }
1267 spin_unlock_irq(&device_state_lock);
1268
1269 return info->nports + 1;
1270 }
1271
1272 default:
1273 return -ENOSYS;
1274 }
1275}
1276
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001277/*
1278 * Allow user programs to claim ports on a hub. When a device is attached
1279 * to one of these "claimed" ports, the program will "own" the device.
1280 */
1281static int find_port_owner(struct usb_device *hdev, unsigned port1,
1282 void ***ppowner)
1283{
1284 if (hdev->state == USB_STATE_NOTATTACHED)
1285 return -ENODEV;
1286 if (port1 == 0 || port1 > hdev->maxchild)
1287 return -EINVAL;
1288
1289 /* This assumes that devices not managed by the hub driver
1290 * will always have maxchild equal to 0.
1291 */
1292 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1293 return 0;
1294}
1295
1296/* In the following three functions, the caller must hold hdev's lock */
1297int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1298{
1299 int rc;
1300 void **powner;
1301
1302 rc = find_port_owner(hdev, port1, &powner);
1303 if (rc)
1304 return rc;
1305 if (*powner)
1306 return -EBUSY;
1307 *powner = owner;
1308 return rc;
1309}
1310
1311int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1312{
1313 int rc;
1314 void **powner;
1315
1316 rc = find_port_owner(hdev, port1, &powner);
1317 if (rc)
1318 return rc;
1319 if (*powner != owner)
1320 return -ENOENT;
1321 *powner = NULL;
1322 return rc;
1323}
1324
1325void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1326{
1327 int n;
1328 void **powner;
1329
1330 n = find_port_owner(hdev, 1, &powner);
1331 if (n == 0) {
1332 for (; n < hdev->maxchild; (++n, ++powner)) {
1333 if (*powner == owner)
1334 *powner = NULL;
1335 }
1336 }
1337}
1338
1339/* The caller must hold udev's lock */
1340bool usb_device_is_owned(struct usb_device *udev)
1341{
1342 struct usb_hub *hub;
1343
1344 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1345 return false;
1346 hub = hdev_to_hub(udev->parent);
1347 return !!hub->port_owners[udev->portnum - 1];
1348}
1349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1352{
1353 int i;
1354
1355 for (i = 0; i < udev->maxchild; ++i) {
1356 if (udev->children[i])
1357 recursively_mark_NOTATTACHED(udev->children[i]);
1358 }
Sarah Sharp15123002007-12-21 16:54:15 -08001359 if (udev->state == USB_STATE_SUSPENDED) {
Alan Sternee49fb52006-11-22 16:55:54 -05001360 udev->discon_suspended = 1;
Sarah Sharp15123002007-12-21 16:54:15 -08001361 udev->active_duration -= jiffies;
1362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 udev->state = USB_STATE_NOTATTACHED;
1364}
1365
1366/**
1367 * usb_set_device_state - change a device's current state (usbcore, hcds)
1368 * @udev: pointer to device whose state should be changed
1369 * @new_state: new state value to be stored
1370 *
1371 * udev->state is _not_ fully protected by the device lock. Although
1372 * most transitions are made only while holding the lock, the state can
1373 * can change to USB_STATE_NOTATTACHED at almost any time. This
1374 * is so that devices can be marked as disconnected as soon as possible,
1375 * without having to wait for any semaphores to be released. As a result,
1376 * all changes to any device's state must be protected by the
1377 * device_state_lock spinlock.
1378 *
1379 * Once a device has been added to the device tree, all changes to its state
1380 * should be made using this routine. The state should _not_ be set directly.
1381 *
1382 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1383 * Otherwise udev->state is set to new_state, and if new_state is
1384 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1385 * to USB_STATE_NOTATTACHED.
1386 */
1387void usb_set_device_state(struct usb_device *udev,
1388 enum usb_device_state new_state)
1389{
1390 unsigned long flags;
1391
1392 spin_lock_irqsave(&device_state_lock, flags);
1393 if (udev->state == USB_STATE_NOTATTACHED)
1394 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001395 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001396
1397 /* root hub wakeup capabilities are managed out-of-band
1398 * and may involve silicon errata ... ignore them here.
1399 */
1400 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001401 if (udev->state == USB_STATE_SUSPENDED
1402 || new_state == USB_STATE_SUSPENDED)
1403 ; /* No change to wakeup settings */
1404 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001405 device_init_wakeup(&udev->dev,
1406 (udev->actconfig->desc.bmAttributes
1407 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001408 else
David Brownellfb669cc2006-01-24 08:40:27 -08001409 device_init_wakeup(&udev->dev, 0);
1410 }
Sarah Sharp15123002007-12-21 16:54:15 -08001411 if (udev->state == USB_STATE_SUSPENDED &&
1412 new_state != USB_STATE_SUSPENDED)
1413 udev->active_duration -= jiffies;
1414 else if (new_state == USB_STATE_SUSPENDED &&
1415 udev->state != USB_STATE_SUSPENDED)
1416 udev->active_duration += jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -04001417 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001418 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 recursively_mark_NOTATTACHED(udev);
1420 spin_unlock_irqrestore(&device_state_lock, flags);
1421}
David Vrabel6da9c992009-02-18 14:43:47 +00001422EXPORT_SYMBOL_GPL(usb_set_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001424/*
1425 * WUSB devices are simple: they have no hubs behind, so the mapping
1426 * device <-> virtual port number becomes 1:1. Why? to simplify the
1427 * life of the device connection logic in
1428 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1429 * handshake we need to assign a temporary address in the unauthorized
1430 * space. For simplicity we use the first virtual port number found to
1431 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1432 * and that becomes it's address [X < 128] or its unauthorized address
1433 * [X | 0x80].
1434 *
1435 * We add 1 as an offset to the one-based USB-stack port number
1436 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1437 * 0 is reserved by USB for default address; (b) Linux's USB stack
1438 * uses always #1 for the root hub of the controller. So USB stack's
1439 * port #1, which is wusb virtual-port #0 has address #2.
Sarah Sharpc6515272009-04-27 19:57:26 -07001440 *
1441 * Devices connected under xHCI are not as simple. The host controller
1442 * supports virtualization, so the hardware assigns device addresses and
1443 * the HCD must setup data structures before issuing a set address
1444 * command to the hardware.
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001445 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446static void choose_address(struct usb_device *udev)
1447{
1448 int devnum;
1449 struct usb_bus *bus = udev->bus;
1450
1451 /* If khubd ever becomes multithreaded, this will need a lock */
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001452 if (udev->wusb) {
1453 devnum = udev->portnum + 1;
1454 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1455 } else {
1456 /* Try to allocate the next devnum beginning at
1457 * bus->devnum_next. */
1458 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1459 bus->devnum_next);
1460 if (devnum >= 128)
1461 devnum = find_next_zero_bit(bus->devmap.devicemap,
1462 128, 1);
1463 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 if (devnum < 128) {
1466 set_bit(devnum, bus->devmap.devicemap);
1467 udev->devnum = devnum;
1468 }
1469}
1470
1471static void release_address(struct usb_device *udev)
1472{
1473 if (udev->devnum > 0) {
1474 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1475 udev->devnum = -1;
1476 }
1477}
1478
David Vrabel4953d142008-04-08 13:24:46 -07001479static void update_address(struct usb_device *udev, int devnum)
1480{
1481 /* The address for a WUSB device is managed by wusbcore. */
1482 if (!udev->wusb)
1483 udev->devnum = devnum;
1484}
1485
Alan Sternd5d4db72007-05-29 16:34:52 -04001486#ifdef CONFIG_USB_SUSPEND
1487
1488static void usb_stop_pm(struct usb_device *udev)
1489{
1490 /* Synchronize with the ksuspend thread to prevent any more
1491 * autosuspend requests from being submitted, and decrement
1492 * the parent's count of unsuspended children.
1493 */
1494 usb_pm_lock(udev);
1495 if (udev->parent && !udev->discon_suspended)
1496 usb_autosuspend_device(udev->parent);
1497 usb_pm_unlock(udev);
1498
Alan Stern9ac39f22008-11-12 16:19:49 -05001499 /* Stop any autosuspend or autoresume requests already submitted */
1500 cancel_delayed_work_sync(&udev->autosuspend);
1501 cancel_work_sync(&udev->autoresume);
Alan Sternd5d4db72007-05-29 16:34:52 -04001502}
1503
1504#else
1505
1506static inline void usb_stop_pm(struct usb_device *udev)
1507{ }
1508
1509#endif
1510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511/**
1512 * usb_disconnect - disconnect a device (usbcore-internal)
1513 * @pdev: pointer to device being disconnected
1514 * Context: !in_interrupt ()
1515 *
1516 * Something got disconnected. Get rid of it and all of its children.
1517 *
1518 * If *pdev is a normal device then the parent hub must already be locked.
1519 * If *pdev is a root hub then this routine will acquire the
1520 * usb_bus_list_lock on behalf of the caller.
1521 *
1522 * Only hub drivers (including virtual root hub drivers for host
1523 * controllers) should ever call this.
1524 *
1525 * This call is synchronous, and may not be used in an interrupt context.
1526 */
1527void usb_disconnect(struct usb_device **pdev)
1528{
1529 struct usb_device *udev = *pdev;
1530 int i;
1531
1532 if (!udev) {
Harvey Harrison441b62c2008-03-03 16:08:34 -08001533 pr_debug ("%s nodev\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 return;
1535 }
1536
1537 /* mark the device as inactive, so any further urb submissions for
1538 * this device (and any of its children) will fail immediately.
1539 * this quiesces everyting except pending urbs.
1540 */
1541 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1543
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001544 usb_lock_device(udev);
1545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 /* Free up all the children before we remove this device */
1547 for (i = 0; i < USB_MAXCHILDREN; i++) {
1548 if (udev->children[i])
1549 usb_disconnect(&udev->children[i]);
1550 }
1551
1552 /* deallocate hcd/hardware state ... nuking all pending urbs and
1553 * cleaning up all state associated with the current configuration
1554 * so that the hardware is now fully quiesced.
1555 */
Alan Stern782da722006-07-01 22:09:35 -04001556 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 usb_disable_device(udev, 0);
Alan Sterncde217a2008-10-21 15:28:46 -04001558 usb_hcd_synchronize_unlinks(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Alan Stern3b23dd62008-12-05 14:10:34 -05001560 usb_remove_ep_devs(&udev->ep0);
Alan Stern782da722006-07-01 22:09:35 -04001561 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001562
Alan Stern782da722006-07-01 22:09:35 -04001563 /* Unregister the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05001564 * for de-configuring the device and invoking the remove-device
1565 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04001566 */
1567 device_del(&udev->dev);
1568
1569 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 * (or root_hub) pointer.
1571 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 /* Avoid races with recursively_mark_NOTATTACHED() */
1575 spin_lock_irq(&device_state_lock);
1576 *pdev = NULL;
1577 spin_unlock_irq(&device_state_lock);
1578
Alan Sternd5d4db72007-05-29 16:34:52 -04001579 usb_stop_pm(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001580
Alan Stern782da722006-07-01 22:09:35 -04001581 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582}
1583
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001584#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585static void show_string(struct usb_device *udev, char *id, char *string)
1586{
1587 if (!string)
1588 return;
1589 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1590}
1591
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001592static void announce_device(struct usb_device *udev)
1593{
1594 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1595 le16_to_cpu(udev->descriptor.idVendor),
1596 le16_to_cpu(udev->descriptor.idProduct));
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001597 dev_info(&udev->dev,
1598 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001599 udev->descriptor.iManufacturer,
1600 udev->descriptor.iProduct,
1601 udev->descriptor.iSerialNumber);
1602 show_string(udev, "Product", udev->product);
1603 show_string(udev, "Manufacturer", udev->manufacturer);
1604 show_string(udev, "SerialNumber", udev->serial);
1605}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606#else
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08001607static inline void announce_device(struct usb_device *udev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608#endif
1609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610#ifdef CONFIG_USB_OTG
1611#include "otg_whitelist.h"
1612#endif
1613
Oliver Neukum3ede7602007-01-11 14:35:50 +01001614/**
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001615 * usb_configure_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01001616 * @udev: newly addressed device (in ADDRESS state)
1617 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001618 * Do configuration for On-The-Go devices
Oliver Neukum3ede7602007-01-11 14:35:50 +01001619 */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001620static int usb_configure_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001622 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
1624#ifdef CONFIG_USB_OTG
1625 /*
1626 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1627 * to wake us after we've powered off VBUS; and HNP, switching roles
1628 * "host" to "peripheral". The OTG descriptor helps figure this out.
1629 */
1630 if (!udev->bus->is_b_host
1631 && udev->config
1632 && udev->parent == udev->bus->root_hub) {
1633 struct usb_otg_descriptor *desc = 0;
1634 struct usb_bus *bus = udev->bus;
1635
1636 /* descriptor may appear anywhere in config */
1637 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1638 le16_to_cpu(udev->config[0].desc.wTotalLength),
1639 USB_DT_OTG, (void **) &desc) == 0) {
1640 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001641 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 dev_info(&udev->dev,
1644 "Dual-Role OTG device on %sHNP port\n",
1645 (port1 == bus->otg_port)
1646 ? "" : "non-");
1647
1648 /* enable HNP before suspend, it's simpler */
1649 if (port1 == bus->otg_port)
1650 bus->b_hnp_enable = 1;
1651 err = usb_control_msg(udev,
1652 usb_sndctrlpipe(udev, 0),
1653 USB_REQ_SET_FEATURE, 0,
1654 bus->b_hnp_enable
1655 ? USB_DEVICE_B_HNP_ENABLE
1656 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1657 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1658 if (err < 0) {
1659 /* OTG MESSAGE: report errors here,
1660 * customize to match your product.
1661 */
1662 dev_info(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001663 "can't set HNP mode: %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 err);
1665 bus->b_hnp_enable = 0;
1666 }
1667 }
1668 }
1669 }
1670
1671 if (!is_targeted(udev)) {
1672
1673 /* Maybe it can talk to us, though we can't talk to it.
1674 * (Includes HNP test device.)
1675 */
1676 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell634a84f2009-01-15 13:51:28 -08001677 err = usb_port_suspend(udev, PMSG_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 if (err < 0)
1679 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1680 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07001681 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 goto fail;
1683 }
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001684fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001686 return err;
1687}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001689
1690/**
1691 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1692 * @udev: newly addressed device (in ADDRESS state)
1693 *
1694 * This is only called by usb_new_device() and usb_authorize_device()
1695 * and FIXME -- all comments that apply to them apply here wrt to
1696 * environment.
1697 *
1698 * If the device is WUSB and not authorized, we don't attempt to read
1699 * the string descriptors, as they will be errored out by the device
1700 * until it has been authorized.
1701 */
1702static int usb_configure_device(struct usb_device *udev)
1703{
1704 int err;
1705
1706 if (udev->config == NULL) {
1707 err = usb_get_configuration(udev);
1708 if (err < 0) {
1709 dev_err(&udev->dev, "can't read configurations, error %d\n",
1710 err);
1711 goto fail;
1712 }
1713 }
1714 if (udev->wusb == 1 && udev->authorized == 0) {
1715 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1716 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1717 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1718 }
1719 else {
1720 /* read the standard strings and cache them if present */
1721 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1722 udev->manufacturer = usb_cache_string(udev,
1723 udev->descriptor.iManufacturer);
1724 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1725 }
1726 err = usb_configure_device_otg(udev);
1727fail:
1728 return err;
1729}
1730
1731
1732/**
1733 * usb_new_device - perform initial device setup (usbcore-internal)
1734 * @udev: newly addressed device (in ADDRESS state)
1735 *
1736 * This is called with devices which have been enumerated, but not yet
1737 * configured. The device descriptor is available, but not descriptors
1738 * for any device configuration. The caller must have locked either
1739 * the parent hub (if udev is a normal device) or else the
1740 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1741 * udev has already been installed, but udev is not yet visible through
1742 * sysfs or other filesystem code.
1743 *
1744 * It will return if the device is configured properly or not. Zero if
1745 * the interface was registered with the driver core; else a negative
1746 * errno value.
1747 *
1748 * This call is synchronous, and may not be used in an interrupt context.
1749 *
1750 * Only the hub driver or root-hub registrar should ever call this.
1751 */
1752int usb_new_device(struct usb_device *udev)
1753{
1754 int err;
1755
Alan Stern6cd13202008-11-13 15:08:30 -05001756 /* Increment the parent's count of unsuspended children */
1757 if (udev->parent)
1758 usb_autoresume_device(udev->parent);
1759
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001760 usb_detect_quirks(udev); /* Determine quirks */
1761 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1762 if (err < 0)
1763 goto fail;
Sarah Sharpc6515272009-04-27 19:57:26 -07001764 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1765 udev->devnum, udev->bus->busnum,
1766 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001767 /* export the usbdev device-node for libusb */
1768 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1769 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1770
Alan Stern6cd13202008-11-13 15:08:30 -05001771 /* Tell the world! */
1772 announce_device(udev);
Alan Stern195af2c2007-07-16 15:28:19 -04001773
Alan Stern782da722006-07-01 22:09:35 -04001774 /* Register the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05001775 * for configuring the device and invoking the add-device
1776 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04001777 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001778 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (err) {
1780 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1781 goto fail;
1782 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001783
Alan Stern3b23dd62008-12-05 14:10:34 -05001784 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001785 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
1787fail:
1788 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern6cd13202008-11-13 15:08:30 -05001789 usb_stop_pm(udev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001790 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791}
1792
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001793
1794/**
Randy Dunlapfd39c862007-10-15 17:30:02 -07001795 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1796 * @usb_dev: USB device
1797 *
1798 * Move the USB device to a very basic state where interfaces are disabled
1799 * and the device is in fact unconfigured and unusable.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001800 *
1801 * We share a lock (that we have) with device_del(), so we need to
1802 * defer its call.
1803 */
1804int usb_deauthorize_device(struct usb_device *usb_dev)
1805{
1806 unsigned cnt;
1807 usb_lock_device(usb_dev);
1808 if (usb_dev->authorized == 0)
1809 goto out_unauthorized;
1810 usb_dev->authorized = 0;
1811 usb_set_configuration(usb_dev, -1);
1812 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1813 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1814 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1815 kfree(usb_dev->config);
1816 usb_dev->config = NULL;
1817 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1818 kfree(usb_dev->rawdescriptors[cnt]);
1819 usb_dev->descriptor.bNumConfigurations = 0;
1820 kfree(usb_dev->rawdescriptors);
1821out_unauthorized:
1822 usb_unlock_device(usb_dev);
1823 return 0;
1824}
1825
1826
1827int usb_authorize_device(struct usb_device *usb_dev)
1828{
1829 int result = 0, c;
1830 usb_lock_device(usb_dev);
1831 if (usb_dev->authorized == 1)
1832 goto out_authorized;
1833 kfree(usb_dev->product);
1834 usb_dev->product = NULL;
1835 kfree(usb_dev->manufacturer);
1836 usb_dev->manufacturer = NULL;
1837 kfree(usb_dev->serial);
1838 usb_dev->serial = NULL;
1839 result = usb_autoresume_device(usb_dev);
1840 if (result < 0) {
1841 dev_err(&usb_dev->dev,
1842 "can't autoresume for authorization: %d\n", result);
1843 goto error_autoresume;
1844 }
1845 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1846 if (result < 0) {
1847 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1848 "authorization: %d\n", result);
1849 goto error_device_descriptor;
1850 }
1851 usb_dev->authorized = 1;
1852 result = usb_configure_device(usb_dev);
1853 if (result < 0)
1854 goto error_configure;
1855 /* Choose and set the configuration. This registers the interfaces
1856 * with the driver core and lets interface drivers bind to them.
1857 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06001858 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001859 if (c >= 0) {
1860 result = usb_set_configuration(usb_dev, c);
1861 if (result) {
1862 dev_err(&usb_dev->dev,
1863 "can't set config #%d, error %d\n", c, result);
1864 /* This need not be fatal. The user can try to
1865 * set other configurations. */
1866 }
1867 }
1868 dev_info(&usb_dev->dev, "authorized to connect\n");
1869error_configure:
1870error_device_descriptor:
1871error_autoresume:
1872out_authorized:
1873 usb_unlock_device(usb_dev); // complements locktree
1874 return result;
1875}
1876
1877
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001878/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1879static unsigned hub_is_wusb(struct usb_hub *hub)
1880{
1881 struct usb_hcd *hcd;
1882 if (hub->hdev->parent != NULL) /* not a root hub? */
1883 return 0;
1884 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1885 return hcd->wireless;
1886}
1887
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889#define PORT_RESET_TRIES 5
1890#define SET_ADDRESS_TRIES 2
1891#define GET_DESCRIPTOR_TRIES 2
1892#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1893#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1894
1895#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1896#define HUB_SHORT_RESET_TIME 10
1897#define HUB_LONG_RESET_TIME 200
1898#define HUB_RESET_TIMEOUT 500
1899
1900static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1901 struct usb_device *udev, unsigned int delay)
1902{
1903 int delay_time, ret;
1904 u16 portstatus;
1905 u16 portchange;
1906
1907 for (delay_time = 0;
1908 delay_time < HUB_RESET_TIMEOUT;
1909 delay_time += delay) {
1910 /* wait to give the device a chance to reset */
1911 msleep(delay);
1912
1913 /* read and decode port status */
1914 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1915 if (ret < 0)
1916 return ret;
1917
1918 /* Device went away? */
1919 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1920 return -ENOTCONN;
1921
Alan Sterndd4dd192007-05-04 11:55:54 -04001922 /* bomb out completely if the connection bounced */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 if ((portchange & USB_PORT_STAT_C_CONNECTION))
Alan Sterndd4dd192007-05-04 11:55:54 -04001924 return -ENOTCONN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
1926 /* if we`ve finished resetting, then break out of the loop */
1927 if (!(portstatus & USB_PORT_STAT_RESET) &&
1928 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001929 if (hub_is_wusb(hub))
1930 udev->speed = USB_SPEED_VARIABLE;
1931 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 udev->speed = USB_SPEED_HIGH;
1933 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1934 udev->speed = USB_SPEED_LOW;
1935 else
1936 udev->speed = USB_SPEED_FULL;
1937 return 0;
1938 }
1939
1940 /* switch to the long delay after two short delay failures */
1941 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1942 delay = HUB_LONG_RESET_TIME;
1943
1944 dev_dbg (hub->intfdev,
1945 "port %d not reset yet, waiting %dms\n",
1946 port1, delay);
1947 }
1948
1949 return -EBUSY;
1950}
1951
1952static int hub_port_reset(struct usb_hub *hub, int port1,
1953 struct usb_device *udev, unsigned int delay)
1954{
1955 int i, status;
1956
Alan Stern32fe0192007-10-10 16:27:07 -04001957 /* Block EHCI CF initialization during the port reset.
1958 * Some companion controllers don't like it when they mix.
1959 */
1960 down_read(&ehci_cf_port_reset_rwsem);
1961
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 /* Reset the port */
1963 for (i = 0; i < PORT_RESET_TRIES; i++) {
1964 status = set_port_feature(hub->hdev,
1965 port1, USB_PORT_FEAT_RESET);
1966 if (status)
1967 dev_err(hub->intfdev,
1968 "cannot reset port %d (err = %d)\n",
1969 port1, status);
1970 else {
1971 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001972 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 dev_dbg(hub->intfdev,
1974 "port_wait_reset: err = %d\n",
1975 status);
1976 }
1977
1978 /* return on disconnect or reset */
1979 switch (status) {
1980 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001981 /* TRSTRCY = 10 ms; plus some extra */
1982 msleep(10 + 40);
David Vrabel4953d142008-04-08 13:24:46 -07001983 update_address(udev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 /* FALL THROUGH */
1985 case -ENOTCONN:
1986 case -ENODEV:
1987 clear_port_feature(hub->hdev,
1988 port1, USB_PORT_FEAT_C_RESET);
1989 /* FIXME need disconnect() for NOTATTACHED device */
1990 usb_set_device_state(udev, status
1991 ? USB_STATE_NOTATTACHED
1992 : USB_STATE_DEFAULT);
Alan Stern32fe0192007-10-10 16:27:07 -04001993 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 }
1995
1996 dev_dbg (hub->intfdev,
1997 "port %d not enabled, trying reset again...\n",
1998 port1);
1999 delay = HUB_LONG_RESET_TIME;
2000 }
2001
2002 dev_err (hub->intfdev,
2003 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2004 port1);
2005
Alan Stern32fe0192007-10-10 16:27:07 -04002006 done:
2007 up_read(&ehci_cf_port_reset_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 return status;
2009}
2010
Alan Sternd388dab2006-07-01 22:14:24 -04002011#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
Alan Sternb01b03f2008-04-28 11:06:11 -04002013#define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2014 USB_PORT_STAT_SUSPEND)
2015#define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2016
2017/* Determine whether the device on a port is ready for a normal resume,
2018 * is ready for a reset-resume, or should be disconnected.
2019 */
2020static int check_port_resume_type(struct usb_device *udev,
2021 struct usb_hub *hub, int port1,
2022 int status, unsigned portchange, unsigned portstatus)
2023{
2024 /* Is the device still present? */
2025 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2026 if (status >= 0)
2027 status = -ENODEV;
2028 }
2029
Alan Stern86c57ed2008-06-30 11:14:43 -04002030 /* Can't do a normal resume if the port isn't enabled,
2031 * so try a reset-resume instead.
2032 */
2033 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2034 if (udev->persist_enabled)
2035 udev->reset_resume = 1;
2036 else
2037 status = -ENODEV;
2038 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002039
2040 if (status) {
2041 dev_dbg(hub->intfdev,
2042 "port %d status %04x.%04x after resume, %d\n",
2043 port1, portchange, portstatus, status);
2044 } else if (udev->reset_resume) {
2045
2046 /* Late port handoff can set status-change bits */
2047 if (portchange & USB_PORT_STAT_C_CONNECTION)
2048 clear_port_feature(hub->hdev, port1,
2049 USB_PORT_FEAT_C_CONNECTION);
2050 if (portchange & USB_PORT_STAT_C_ENABLE)
2051 clear_port_feature(hub->hdev, port1,
2052 USB_PORT_FEAT_C_ENABLE);
2053 }
2054
2055 return status;
2056}
2057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058#ifdef CONFIG_USB_SUSPEND
2059
2060/*
Alan Stern140d8f62006-07-01 22:07:21 -04002061 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04002062 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07002063 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 *
2065 * Suspends a USB device that isn't in active use, conserving power.
2066 * Devices may wake out of a suspend, if anything important happens,
2067 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04002068 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 * to disconnect devices while they are suspended.
2070 *
David Brownell390a8c32005-09-13 19:57:27 -07002071 * This only affects the USB hardware for a device; its interfaces
2072 * (and, for hubs, child devices) must already have been suspended.
2073 *
Alan Stern624d6c02007-05-30 15:35:16 -04002074 * Selective port suspend reduces power; most suspended devices draw
2075 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2076 * All devices below the suspended port are also suspended.
2077 *
2078 * Devices leave suspend state when the host wakes them up. Some devices
2079 * also support "remote wakeup", where the device can activate the USB
2080 * tree above them to deliver data, such as a keypress or packet. In
2081 * some cases, this wakes the USB host.
2082 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 * Suspending OTG devices may trigger HNP, if that's been enabled
2084 * between a pair of dual-role devices. That will change roles, such
2085 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2086 *
Alan Stern4956ecc2007-05-30 16:51:28 -04002087 * Devices on USB hub ports have only one "suspend" state, corresponding
2088 * to ACPI D2, "may cause the device to lose some context".
2089 * State transitions include:
2090 *
2091 * - suspend, resume ... when the VBUS power link stays live
2092 * - suspend, disconnect ... VBUS lost
2093 *
2094 * Once VBUS drop breaks the circuit, the port it's using has to go through
2095 * normal re-enumeration procedures, starting with enabling VBUS power.
2096 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2097 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2098 * timer, no SRP, no requests through sysfs.
2099 *
2100 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2101 * the root hub for their bus goes into global suspend ... so we don't
2102 * (falsely) update the device power state to say it suspended.
2103 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 * Returns 0 on success, else negative errno.
2105 */
Alan Stern65bfd292008-11-25 16:39:18 -05002106int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
Alan Stern624d6c02007-05-30 15:35:16 -04002108 struct usb_hub *hub = hdev_to_hub(udev->parent);
2109 int port1 = udev->portnum;
2110 int status;
Alan Stern4956ecc2007-05-30 16:51:28 -04002111
Alan Stern624d6c02007-05-30 15:35:16 -04002112 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2113
2114 /* enable remote wakeup when appropriate; this lets the device
2115 * wake up the upstream hub (including maybe the root hub).
2116 *
2117 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2118 * we don't explicitly enable it here.
2119 */
2120 if (udev->do_remote_wakeup) {
2121 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2122 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2123 USB_DEVICE_REMOTE_WAKEUP, 0,
2124 NULL, 0,
2125 USB_CTRL_SET_TIMEOUT);
2126 if (status)
2127 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2128 status);
2129 }
2130
2131 /* see 7.1.7.6 */
2132 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2133 if (status) {
2134 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2135 port1, status);
2136 /* paranoia: "should not happen" */
2137 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2138 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2139 USB_DEVICE_REMOTE_WAKEUP, 0,
2140 NULL, 0,
2141 USB_CTRL_SET_TIMEOUT);
2142 } else {
2143 /* device has up to 10 msec to fully suspend */
2144 dev_dbg(&udev->dev, "usb %ssuspend\n",
Alan Stern65bfd292008-11-25 16:39:18 -05002145 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
Alan Stern624d6c02007-05-30 15:35:16 -04002146 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2147 msleep(10);
2148 }
Alan Stern4956ecc2007-05-30 16:51:28 -04002149 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150}
David Brownellf3f32532005-09-22 22:37:29 -07002151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152/*
David Brownell390a8c32005-09-13 19:57:27 -07002153 * If the USB "suspend" state is in use (rather than "global suspend"),
2154 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04002155 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 * hardware resume signaling is finished, either because of selective
2157 * resume (by host) or remote wakeup (by device) ... now see what changed
2158 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04002159 *
2160 * If @udev->reset_resume is set then the device is reset before the
2161 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 */
Alan Stern140d8f62006-07-01 22:07:21 -04002163static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164{
Alan Stern54515fe2007-05-30 15:38:58 -04002165 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 u16 devstatus;
2167
2168 /* caller owns the udev device lock */
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002169 dev_dbg(&udev->dev, "%s\n",
2170 udev->reset_resume ? "finish reset-resume" : "finish resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171
2172 /* usb ch9 identifies four variants of SUSPENDED, based on what
2173 * state the device resumes to. Linux currently won't see the
2174 * first two on the host side; they'd be inside hub_port_init()
2175 * during many timeouts, but khubd can't suspend until later.
2176 */
2177 usb_set_device_state(udev, udev->actconfig
2178 ? USB_STATE_CONFIGURED
2179 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180
Alan Stern54515fe2007-05-30 15:38:58 -04002181 /* 10.5.4.5 says not to reset a suspended port if the attached
2182 * device is enabled for remote wakeup. Hence the reset
2183 * operation is carried out here, after the port has been
2184 * resumed.
2185 */
2186 if (udev->reset_resume)
Alan Stern86c57ed2008-06-30 11:14:43 -04002187 retry_reset_resume:
Ming Lei742120c2008-06-18 22:00:29 +08002188 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04002189
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 /* 10.5.4.5 says be sure devices in the tree are still there.
2191 * For now let's assume the device didn't go crazy on resume,
2192 * and device drivers will know about any resume quirks.
2193 */
Alan Stern54515fe2007-05-30 15:38:58 -04002194 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04002195 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04002196 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2197 if (status >= 0)
Alan Stern46dede42007-08-14 10:56:10 -04002198 status = (status > 0 ? 0 : -ENODEV);
Alan Stern86c57ed2008-06-30 11:14:43 -04002199
2200 /* If a normal resume failed, try doing a reset-resume */
2201 if (status && !udev->reset_resume && udev->persist_enabled) {
2202 dev_dbg(&udev->dev, "retry with reset-resume\n");
2203 udev->reset_resume = 1;
2204 goto retry_reset_resume;
2205 }
Alan Stern54515fe2007-05-30 15:38:58 -04002206 }
Alan Sternb40b7a92006-06-19 15:12:38 -04002207
Alan Stern624d6c02007-05-30 15:35:16 -04002208 if (status) {
2209 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2210 status);
2211 } else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 le16_to_cpus(&devstatus);
Alan Stern686314c2007-05-30 15:34:36 -04002213 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 status = usb_control_msg(udev,
2215 usb_sndctrlpipe(udev, 0),
2216 USB_REQ_CLEAR_FEATURE,
2217 USB_RECIP_DEVICE,
2218 USB_DEVICE_REMOTE_WAKEUP, 0,
2219 NULL, 0,
2220 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04002221 if (status)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002222 dev_dbg(&udev->dev,
2223 "disable remote wakeup, status %d\n",
2224 status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05002225 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 }
2228 return status;
2229}
2230
Alan Stern624d6c02007-05-30 15:35:16 -04002231/*
2232 * usb_port_resume - re-activate a suspended usb device's upstream port
2233 * @udev: device to re-activate, not a root hub
2234 * Context: must be able to sleep; device not locked; pm locks held
2235 *
2236 * This will re-activate the suspended device, increasing power usage
2237 * while letting drivers communicate again with its endpoints.
2238 * USB resume explicitly guarantees that the power session between
2239 * the host and the device is the same as it was when the device
2240 * suspended.
2241 *
Alan Sternfeccc302008-03-03 15:15:59 -05002242 * If @udev->reset_resume is set then this routine won't check that the
2243 * port is still enabled. Furthermore, finish_port_resume() above will
Alan Stern54515fe2007-05-30 15:38:58 -04002244 * reset @udev. The end result is that a broken power session can be
2245 * recovered and @udev will appear to persist across a loss of VBUS power.
2246 *
2247 * For example, if a host controller doesn't maintain VBUS suspend current
2248 * during a system sleep or is reset when the system wakes up, all the USB
2249 * power sessions below it will be broken. This is especially troublesome
2250 * for mass-storage devices containing mounted filesystems, since the
2251 * device will appear to have disconnected and all the memory mappings
2252 * to it will be lost. Using the USB_PERSIST facility, the device can be
2253 * made to appear as if it had not disconnected.
2254 *
Ming Lei742120c2008-06-18 22:00:29 +08002255 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
Alan Sternfeccc302008-03-03 15:15:59 -05002256 * every effort to insure that the same device is present after the
Alan Stern54515fe2007-05-30 15:38:58 -04002257 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2258 * quite possible for a device to remain unaltered but its media to be
2259 * changed. If the user replaces a flash memory card while the system is
2260 * asleep, he will have only himself to blame when the filesystem on the
2261 * new card is corrupted and the system crashes.
2262 *
Alan Stern624d6c02007-05-30 15:35:16 -04002263 * Returns 0 on success, else negative errno.
2264 */
Alan Stern65bfd292008-11-25 16:39:18 -05002265int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266{
Alan Stern624d6c02007-05-30 15:35:16 -04002267 struct usb_hub *hub = hdev_to_hub(udev->parent);
2268 int port1 = udev->portnum;
2269 int status;
2270 u16 portchange, portstatus;
Alan Sternd25450c2006-11-20 11:14:30 -05002271
2272 /* Skip the initial Clear-Suspend step for a remote wakeup */
2273 status = hub_port_status(hub, port1, &portstatus, &portchange);
2274 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2275 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276
2277 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2278
Alan Sternd5cbad42006-08-11 16:52:39 -04002279 set_bit(port1, hub->busy_bits);
2280
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 /* see 7.1.7.7; affects power usage, but not budgeting */
2282 status = clear_port_feature(hub->hdev,
2283 port1, USB_PORT_FEAT_SUSPEND);
2284 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04002285 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2286 port1, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04002289 dev_dbg(&udev->dev, "usb %sresume\n",
Alan Stern65bfd292008-11-25 16:39:18 -05002290 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 msleep(25);
2292
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2294 * stop resume signaling. Then finish the resume
2295 * sequence.
2296 */
Alan Sternd25450c2006-11-20 11:14:30 -05002297 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04002298
Alan Sternb01b03f2008-04-28 11:06:11 -04002299 /* TRSMRCY = 10 msec */
2300 msleep(10);
2301 }
Alan Stern54515fe2007-05-30 15:38:58 -04002302
Alan Sternb01b03f2008-04-28 11:06:11 -04002303 SuspendCleared:
2304 if (status == 0) {
2305 if (portchange & USB_PORT_STAT_C_SUSPEND)
2306 clear_port_feature(hub->hdev, port1,
2307 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Alan Sternd5cbad42006-08-11 16:52:39 -04002310 clear_bit(port1, hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04002311
Alan Sternb01b03f2008-04-28 11:06:11 -04002312 status = check_port_resume_type(udev,
2313 hub, port1, status, portchange, portstatus);
Alan Stern54515fe2007-05-30 15:38:58 -04002314 if (status == 0)
2315 status = finish_port_resume(udev);
2316 if (status < 0) {
2317 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2318 hub_port_logical_disconnect(hub, port1);
2319 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 return status;
2321}
2322
Alan Stern8808f002008-04-28 11:06:55 -04002323/* caller has locked udev */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324static int remote_wakeup(struct usb_device *udev)
2325{
2326 int status = 0;
2327
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04002329 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern19410442007-03-27 13:33:59 -04002330 usb_mark_last_busy(udev);
Alan Stern65bfd292008-11-25 16:39:18 -05002331 status = usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
Alan Sternd25450c2006-11-20 11:14:30 -05002332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 return status;
2334}
2335
Alan Sternd388dab2006-07-01 22:14:24 -04002336#else /* CONFIG_USB_SUSPEND */
2337
2338/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2339
Alan Stern65bfd292008-11-25 16:39:18 -05002340int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04002341{
2342 return 0;
2343}
2344
Alan Sternb01b03f2008-04-28 11:06:11 -04002345/* However we may need to do a reset-resume */
2346
Alan Stern65bfd292008-11-25 16:39:18 -05002347int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04002348{
Alan Sternb01b03f2008-04-28 11:06:11 -04002349 struct usb_hub *hub = hdev_to_hub(udev->parent);
2350 int port1 = udev->portnum;
2351 int status;
2352 u16 portchange, portstatus;
Alan Stern54515fe2007-05-30 15:38:58 -04002353
Alan Sternb01b03f2008-04-28 11:06:11 -04002354 status = hub_port_status(hub, port1, &portstatus, &portchange);
2355 status = check_port_resume_type(udev,
2356 hub, port1, status, portchange, portstatus);
2357
2358 if (status) {
2359 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2360 hub_port_logical_disconnect(hub, port1);
2361 } else if (udev->reset_resume) {
Alan Stern54515fe2007-05-30 15:38:58 -04002362 dev_dbg(&udev->dev, "reset-resume\n");
Ming Lei742120c2008-06-18 22:00:29 +08002363 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04002364 }
2365 return status;
Alan Sternd388dab2006-07-01 22:14:24 -04002366}
2367
2368static inline int remote_wakeup(struct usb_device *udev)
2369{
2370 return 0;
2371}
2372
2373#endif
2374
David Brownelldb690872005-09-13 19:56:33 -07002375static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376{
2377 struct usb_hub *hub = usb_get_intfdata (intf);
2378 struct usb_device *hdev = hub->hdev;
2379 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380
David Brownellc9f89fa2005-09-13 19:57:04 -07002381 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2383 struct usb_device *udev;
2384
2385 udev = hdev->children [port1-1];
Alan Stern6840d252007-09-10 11:34:26 -04002386 if (udev && udev->can_submit) {
Alan Stern65bfd292008-11-25 16:39:18 -05002387 if (!(msg.event & PM_EVENT_AUTO))
Alan Stern645daaa2006-08-30 15:47:02 -04002388 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2389 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07002390 return -EBUSY;
2391 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 }
2393
Harvey Harrison441b62c2008-03-03 16:08:34 -08002394 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Stern40f122f2006-11-09 14:44:33 -05002395
David Brownellc9f89fa2005-09-13 19:57:04 -07002396 /* stop khubd and related activity */
Alan Stern43303542008-04-28 11:07:31 -04002397 hub_quiesce(hub, HUB_SUSPEND);
Alan Sternb6f64362007-05-04 11:51:54 -04002398 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399}
2400
2401static int hub_resume(struct usb_interface *intf)
2402{
Alan Stern5e6effa2008-03-03 15:15:51 -05002403 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404
Alan Stern5e6effa2008-03-03 15:15:51 -05002405 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04002406 hub_activate(hub, HUB_RESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 return 0;
2408}
2409
Alan Sternb41a60e2007-05-30 15:39:33 -04002410static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04002411{
Alan Sternb41a60e2007-05-30 15:39:33 -04002412 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04002413
Alan Stern5e6effa2008-03-03 15:15:51 -05002414 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04002415 hub_activate(hub, HUB_RESET_RESUME);
Alan Sternf07600c2007-05-30 15:38:16 -04002416 return 0;
2417}
2418
Alan Stern54515fe2007-05-30 15:38:58 -04002419/**
2420 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2421 * @rhdev: struct usb_device for the root hub
2422 *
2423 * The USB host controller driver calls this function when its root hub
2424 * is resumed and Vbus power has been interrupted or the controller
Alan Sternfeccc302008-03-03 15:15:59 -05002425 * has been reset. The routine marks @rhdev as having lost power.
2426 * When the hub driver is resumed it will take notice and carry out
2427 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2428 * the others will be disconnected.
Alan Stern54515fe2007-05-30 15:38:58 -04002429 */
2430void usb_root_hub_lost_power(struct usb_device *rhdev)
2431{
2432 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2433 rhdev->reset_resume = 1;
2434}
2435EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2436
Alan Sternd388dab2006-07-01 22:14:24 -04002437#else /* CONFIG_PM */
2438
2439static inline int remote_wakeup(struct usb_device *udev)
2440{
2441 return 0;
2442}
2443
Alan Sternf07600c2007-05-30 15:38:16 -04002444#define hub_suspend NULL
2445#define hub_resume NULL
2446#define hub_reset_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002447#endif
2448
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
2450/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2451 *
2452 * Between connect detection and reset signaling there must be a delay
2453 * of 100ms at least for debounce and power-settling. The corresponding
2454 * timer shall restart whenever the downstream port detects a disconnect.
2455 *
2456 * Apparently there are some bluetooth and irda-dongles and a number of
2457 * low-speed devices for which this debounce period may last over a second.
2458 * Not covered by the spec - but easy to deal with.
2459 *
2460 * This implementation uses a 1500ms total debounce timeout; if the
2461 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2462 * every 25ms for transient disconnects. When the port status has been
2463 * unchanged for 100ms it returns the port status.
2464 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465static int hub_port_debounce(struct usb_hub *hub, int port1)
2466{
2467 int ret;
2468 int total_time, stable_time = 0;
2469 u16 portchange, portstatus;
2470 unsigned connection = 0xffff;
2471
2472 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2473 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2474 if (ret < 0)
2475 return ret;
2476
2477 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2478 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2479 stable_time += HUB_DEBOUNCE_STEP;
2480 if (stable_time >= HUB_DEBOUNCE_STABLE)
2481 break;
2482 } else {
2483 stable_time = 0;
2484 connection = portstatus & USB_PORT_STAT_CONNECTION;
2485 }
2486
2487 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2488 clear_port_feature(hub->hdev, port1,
2489 USB_PORT_FEAT_C_CONNECTION);
2490 }
2491
2492 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2493 break;
2494 msleep(HUB_DEBOUNCE_STEP);
2495 }
2496
2497 dev_dbg (hub->intfdev,
2498 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2499 port1, total_time, stable_time, portstatus);
2500
2501 if (stable_time < HUB_DEBOUNCE_STABLE)
2502 return -ETIMEDOUT;
2503 return portstatus;
2504}
2505
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002506void usb_ep0_reinit(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507{
Alan Sternddeac4e2009-01-15 17:03:33 -05002508 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2509 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
Alan Stern2caf7fc2008-12-31 11:31:33 -05002510 usb_enable_endpoint(udev, &udev->ep0, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511}
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002512EXPORT_SYMBOL_GPL(usb_ep0_reinit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513
2514#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2515#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2516
Alan Stern4326ed02007-07-30 17:08:43 -04002517static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518{
2519 int retval;
Sarah Sharpc6515272009-04-27 19:57:26 -07002520 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
Sarah Sharpc6515272009-04-27 19:57:26 -07002522 /*
2523 * The host controller will choose the device address,
2524 * instead of the core having chosen it earlier
2525 */
2526 if (!hcd->driver->address_device && devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 return -EINVAL;
2528 if (udev->state == USB_STATE_ADDRESS)
2529 return 0;
2530 if (udev->state != USB_STATE_DEFAULT)
2531 return -EINVAL;
Sarah Sharpc6515272009-04-27 19:57:26 -07002532 if (hcd->driver->address_device) {
2533 retval = hcd->driver->address_device(hcd, udev);
2534 } else {
2535 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2536 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2537 NULL, 0, USB_CTRL_SET_TIMEOUT);
2538 if (retval == 0)
2539 update_address(udev, devnum);
2540 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 if (retval == 0) {
David Vrabel4953d142008-04-08 13:24:46 -07002542 /* Device now using proper address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 usb_set_device_state(udev, USB_STATE_ADDRESS);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002544 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 }
2546 return retval;
2547}
2548
2549/* Reset device, (re)assign address, get device descriptor.
2550 * Device connection must be stable, no more debouncing needed.
2551 * Returns device in USB_STATE_ADDRESS, except on error.
2552 *
2553 * If this is called for an already-existing device (as part of
Ming Lei742120c2008-06-18 22:00:29 +08002554 * usb_reset_and_verify_device), the caller must own the device lock. For a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 * newly detected device that is not accessible through any global
2556 * pointers, it's not necessary to lock the device.
2557 */
2558static int
2559hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2560 int retry_counter)
2561{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002562 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563
2564 struct usb_device *hdev = hub->hdev;
Sarah Sharpe7b77172009-04-27 19:54:26 -07002565 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 int i, j, retval;
2567 unsigned delay = HUB_SHORT_RESET_TIME;
2568 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002569 char *speed, *type;
Alan Stern4326ed02007-07-30 17:08:43 -04002570 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571
2572 /* root hub ports have a slightly longer reset period
2573 * (from USB 2.0 spec, section 7.1.7.5)
2574 */
2575 if (!hdev->parent) {
2576 delay = HUB_ROOT_RESET_TIME;
2577 if (port1 == hdev->bus->otg_port)
2578 hdev->bus->b_hnp_enable = 0;
2579 }
2580
2581 /* Some low speed devices have problems with the quick delay, so */
2582 /* be a bit pessimistic with those devices. RHbug #23670 */
2583 if (oldspeed == USB_SPEED_LOW)
2584 delay = HUB_LONG_RESET_TIME;
2585
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002586 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587
Sarah Sharpe7b77172009-04-27 19:54:26 -07002588 if ((hcd->driver->flags & HCD_USB3) && udev->config) {
2589 /* FIXME this will need special handling by the xHCI driver. */
2590 dev_dbg(&udev->dev,
2591 "xHCI reset of configured device "
2592 "not supported yet.\n");
2593 retval = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 goto fail;
Sarah Sharpe7b77172009-04-27 19:54:26 -07002595 } else if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2596 /* Don't reset USB 3.0 devices during an initial setup */
2597 usb_set_device_state(udev, USB_STATE_DEFAULT);
2598 } else {
2599 /* Reset the device; full speed may morph to high speed */
2600 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2601 retval = hub_port_reset(hub, port1, udev, delay);
2602 if (retval < 0) /* error or disconnect */
2603 goto fail;
2604 /* success, speed is known */
2605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 retval = -ENODEV;
2607
2608 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2609 dev_dbg(&udev->dev, "device reset changed speed!\n");
2610 goto fail;
2611 }
2612 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04002613
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2615 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002616 * For Wireless USB devices, ep0 max packet is always 512 (tho
2617 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 */
2619 switch (udev->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -07002620 case USB_SPEED_SUPER:
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002621 case USB_SPEED_VARIABLE: /* fixed at 512 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002622 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002623 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624 case USB_SPEED_HIGH: /* fixed at 64 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002625 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 break;
2627 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2628 /* to determine the ep0 maxpacket size, try to read
2629 * the device descriptor to get bMaxPacketSize0 and
2630 * then correct our initial guess.
2631 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002632 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 break;
2634 case USB_SPEED_LOW: /* fixed at 8 */
Harvey Harrison551509d2009-02-11 14:11:36 -08002635 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 break;
2637 default:
2638 goto fail;
2639 }
2640
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002641 type = "";
2642 switch (udev->speed) {
2643 case USB_SPEED_LOW: speed = "low"; break;
2644 case USB_SPEED_FULL: speed = "full"; break;
2645 case USB_SPEED_HIGH: speed = "high"; break;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002646 case USB_SPEED_SUPER:
2647 speed = "super";
2648 break;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002649 case USB_SPEED_VARIABLE:
2650 speed = "variable";
2651 type = "Wireless ";
2652 break;
2653 default: speed = "?"; break;
2654 }
Sarah Sharpc6515272009-04-27 19:57:26 -07002655 if (udev->speed != USB_SPEED_SUPER)
2656 dev_info(&udev->dev,
2657 "%s %s speed %sUSB device using %s and address %d\n",
2658 (udev->config) ? "reset" : "new", speed, type,
2659 udev->bus->controller->driver->name, devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
2661 /* Set up TT records, if needed */
2662 if (hdev->tt) {
2663 udev->tt = hdev->tt;
2664 udev->ttport = hdev->ttport;
2665 } else if (udev->speed != USB_SPEED_HIGH
2666 && hdev->speed == USB_SPEED_HIGH) {
2667 udev->tt = &hub->tt;
2668 udev->ttport = port1;
2669 }
2670
2671 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2672 * Because device hardware and firmware is sometimes buggy in
2673 * this area, and this is how Linux has done it for ages.
2674 * Change it cautiously.
2675 *
2676 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2677 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2678 * so it may help with some non-standards-compliant devices.
2679 * Otherwise we start with SET_ADDRESS and then try to read the
2680 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2681 * value.
2682 */
2683 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
Sarah Sharpc6515272009-04-27 19:57:26 -07002684 /*
2685 * An xHCI controller cannot send any packets to a device until
2686 * a set address command successfully completes.
2687 */
2688 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 struct usb_device_descriptor *buf;
2690 int r = 0;
2691
2692#define GET_DESCRIPTOR_BUFSIZE 64
2693 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2694 if (!buf) {
2695 retval = -ENOMEM;
2696 continue;
2697 }
2698
Alan Sternb89ee192007-05-11 10:19:04 -04002699 /* Retry on all errors; some devices are flakey.
2700 * 255 is for WUSB devices, we actually need to use
2701 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702 */
2703 for (j = 0; j < 3; ++j) {
2704 buf->bMaxPacketSize0 = 0;
2705 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2706 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2707 USB_DT_DEVICE << 8, 0,
2708 buf, GET_DESCRIPTOR_BUFSIZE,
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +02002709 initial_descriptor_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002711 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 if (buf->bDescriptorType ==
2713 USB_DT_DEVICE) {
2714 r = 0;
2715 break;
2716 }
2717 /* FALL THROUGH */
2718 default:
2719 if (r == 0)
2720 r = -EPROTO;
2721 break;
2722 }
2723 if (r == 0)
2724 break;
2725 }
2726 udev->descriptor.bMaxPacketSize0 =
2727 buf->bMaxPacketSize0;
2728 kfree(buf);
2729
2730 retval = hub_port_reset(hub, port1, udev, delay);
2731 if (retval < 0) /* error or disconnect */
2732 goto fail;
2733 if (oldspeed != udev->speed) {
2734 dev_dbg(&udev->dev,
2735 "device reset changed speed!\n");
2736 retval = -ENODEV;
2737 goto fail;
2738 }
2739 if (r) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002740 dev_err(&udev->dev,
2741 "device descriptor read/64, error %d\n",
2742 r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 retval = -EMSGSIZE;
2744 continue;
2745 }
2746#undef GET_DESCRIPTOR_BUFSIZE
2747 }
2748
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002749 /*
2750 * If device is WUSB, we already assigned an
2751 * unauthorized address in the Connect Ack sequence;
2752 * authorization will assign the final address.
2753 */
Sarah Sharpc6515272009-04-27 19:57:26 -07002754 if (udev->wusb == 0) {
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002755 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2756 retval = hub_set_address(udev, devnum);
2757 if (retval >= 0)
2758 break;
2759 msleep(200);
2760 }
2761 if (retval < 0) {
2762 dev_err(&udev->dev,
2763 "device not accepting address %d, error %d\n",
2764 devnum, retval);
2765 goto fail;
2766 }
Sarah Sharpc6515272009-04-27 19:57:26 -07002767 if (udev->speed == USB_SPEED_SUPER) {
2768 devnum = udev->devnum;
2769 dev_info(&udev->dev,
2770 "%s SuperSpeed USB device using %s and address %d\n",
2771 (udev->config) ? "reset" : "new",
2772 udev->bus->controller->driver->name, devnum);
2773 }
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002774
2775 /* cope with hardware quirkiness:
2776 * - let SET_ADDRESS settle, some device hardware wants it
2777 * - read ep0 maxpacket even for high and low speed,
2778 */
2779 msleep(10);
Sarah Sharpc6515272009-04-27 19:57:26 -07002780 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 break;
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07002782 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
2784 retval = usb_get_device_descriptor(udev, 8);
2785 if (retval < 8) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002786 dev_err(&udev->dev,
2787 "device descriptor read/8, error %d\n",
2788 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 if (retval >= 0)
2790 retval = -EMSGSIZE;
2791 } else {
2792 retval = 0;
2793 break;
2794 }
2795 }
2796 if (retval)
2797 goto fail;
2798
Sarah Sharp6b403b02009-04-27 19:54:10 -07002799 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2800 udev->speed == USB_SPEED_SUPER)
2801 i = 512;
2802 else
2803 i = udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2805 if (udev->speed != USB_SPEED_FULL ||
2806 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2807 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2808 retval = -EMSGSIZE;
2809 goto fail;
2810 }
2811 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2812 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07002813 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814 }
2815
2816 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2817 if (retval < (signed)sizeof(udev->descriptor)) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002818 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2819 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 if (retval >= 0)
2821 retval = -ENOMSG;
2822 goto fail;
2823 }
2824
2825 retval = 0;
2826
2827fail:
Alan Stern4326ed02007-07-30 17:08:43 -04002828 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 hub_port_disable(hub, port1, 0);
David Vrabel4953d142008-04-08 13:24:46 -07002830 update_address(udev, devnum); /* for disconnect processing */
Alan Stern4326ed02007-07-30 17:08:43 -04002831 }
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002832 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 return retval;
2834}
2835
2836static void
2837check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2838{
2839 struct usb_qualifier_descriptor *qual;
2840 int status;
2841
Christoph Lametere94b1762006-12-06 20:33:17 -08002842 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 if (qual == NULL)
2844 return;
2845
2846 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2847 qual, sizeof *qual);
2848 if (status == sizeof *qual) {
2849 dev_info(&udev->dev, "not running at top speed; "
2850 "connect to a high speed hub\n");
2851 /* hub LEDs are probably harder to miss than syslog */
2852 if (hub->has_indicators) {
2853 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002854 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855 }
2856 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002857 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858}
2859
2860static unsigned
2861hub_power_remaining (struct usb_hub *hub)
2862{
2863 struct usb_device *hdev = hub->hdev;
2864 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002865 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866
Alan Stern55c52712005-11-23 12:03:12 -05002867 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868 return 0;
2869
Alan Stern55c52712005-11-23 12:03:12 -05002870 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2871 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2872 struct usb_device *udev = hdev->children[port1 - 1];
2873 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874
2875 if (!udev)
2876 continue;
2877
Alan Stern55c52712005-11-23 12:03:12 -05002878 /* Unconfigured devices may not use more than 100mA,
2879 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002881 delta = udev->actconfig->desc.bMaxPower * 2;
2882 else if (port1 != udev->bus->otg_port || hdev->parent)
2883 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884 else
Alan Stern55c52712005-11-23 12:03:12 -05002885 delta = 8;
2886 if (delta > hub->mA_per_port)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002887 dev_warn(&udev->dev,
2888 "%dmA is over %umA budget for port %d!\n",
2889 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 remaining -= delta;
2891 }
2892 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002893 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2894 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 remaining = 0;
2896 }
2897 return remaining;
2898}
2899
2900/* Handle physical or logical connection change events.
2901 * This routine is called when:
2902 * a port connection-change occurs;
2903 * a port enable-change occurs (often caused by EMI);
Ming Lei742120c2008-06-18 22:00:29 +08002904 * usb_reset_and_verify_device() encounters changed descriptors (as from
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 * a firmware download)
2906 * caller already locked the hub
2907 */
2908static void hub_port_connect_change(struct usb_hub *hub, int port1,
2909 u16 portstatus, u16 portchange)
2910{
2911 struct usb_device *hdev = hub->hdev;
2912 struct device *hub_dev = hub->intfdev;
Balaji Rao90da0962007-11-22 01:58:14 +05302913 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Alan Stern24618b02008-04-28 11:06:28 -04002914 unsigned wHubCharacteristics =
2915 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Alan Stern8808f002008-04-28 11:06:55 -04002916 struct usb_device *udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917 int status, i;
Alan Stern24618b02008-04-28 11:06:28 -04002918
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919 dev_dbg (hub_dev,
2920 "port %d, status %04x, change %04x, %s\n",
2921 port1, portstatus, portchange, portspeed (portstatus));
2922
2923 if (hub->has_indicators) {
2924 set_port_led(hub, port1, HUB_LED_AUTO);
2925 hub->indicator[port1-1] = INDICATOR_AUTO;
2926 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927
2928#ifdef CONFIG_USB_OTG
2929 /* during HNP, don't repeat the debounce */
2930 if (hdev->bus->is_b_host)
Alan Stern24618b02008-04-28 11:06:28 -04002931 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2932 USB_PORT_STAT_C_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933#endif
2934
Alan Stern8808f002008-04-28 11:06:55 -04002935 /* Try to resuscitate an existing device */
2936 udev = hdev->children[port1-1];
2937 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
2938 udev->state != USB_STATE_NOTATTACHED) {
Alan Stern8808f002008-04-28 11:06:55 -04002939 usb_lock_device(udev);
2940 if (portstatus & USB_PORT_STAT_ENABLE) {
2941 status = 0; /* Nothing to do */
Alan Stern8808f002008-04-28 11:06:55 -04002942
2943#ifdef CONFIG_USB_SUSPEND
Alan Stern5257d972008-09-22 14:43:08 -04002944 } else if (udev->state == USB_STATE_SUSPENDED &&
2945 udev->persist_enabled) {
Alan Stern8808f002008-04-28 11:06:55 -04002946 /* For a suspended device, treat this as a
2947 * remote wakeup event.
2948 */
Alan Stern527101c2009-07-22 14:42:54 -04002949 status = remote_wakeup(udev);
Alan Stern8808f002008-04-28 11:06:55 -04002950#endif
2951
2952 } else {
Alan Stern5257d972008-09-22 14:43:08 -04002953 status = -ENODEV; /* Don't resuscitate */
Alan Stern8808f002008-04-28 11:06:55 -04002954 }
2955 usb_unlock_device(udev);
2956
2957 if (status == 0) {
2958 clear_bit(port1, hub->change_bits);
2959 return;
2960 }
2961 }
2962
Alan Stern24618b02008-04-28 11:06:28 -04002963 /* Disconnect any existing devices under this port */
Alan Stern8808f002008-04-28 11:06:55 -04002964 if (udev)
Alan Stern24618b02008-04-28 11:06:28 -04002965 usb_disconnect(&hdev->children[port1-1]);
2966 clear_bit(port1, hub->change_bits);
2967
Alan Stern5257d972008-09-22 14:43:08 -04002968 if (portchange & (USB_PORT_STAT_C_CONNECTION |
2969 USB_PORT_STAT_C_ENABLE)) {
2970 status = hub_port_debounce(hub, port1);
2971 if (status < 0) {
2972 if (printk_ratelimit())
2973 dev_err(hub_dev, "connect-debounce failed, "
2974 "port %d disabled\n", port1);
2975 portstatus &= ~USB_PORT_STAT_CONNECTION;
2976 } else {
2977 portstatus = status;
2978 }
2979 }
2980
Alan Stern24618b02008-04-28 11:06:28 -04002981 /* Return now if debouncing failed or nothing is connected */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2983
2984 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002985 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2987 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
Alan Stern5257d972008-09-22 14:43:08 -04002988
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989 if (portstatus & USB_PORT_STAT_ENABLE)
2990 goto done;
2991 return;
2992 }
2993
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 for (i = 0; i < SET_CONFIG_TRIES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995
2996 /* reallocate for each attempt, since references
2997 * to the previous one can escape in various ways
2998 */
2999 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3000 if (!udev) {
3001 dev_err (hub_dev,
3002 "couldn't allocate port %d usb_device\n",
3003 port1);
3004 goto done;
3005 }
3006
3007 usb_set_device_state(udev, USB_STATE_POWERED);
Alan Stern55c52712005-11-23 12:03:12 -05003008 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04003009 udev->level = hdev->level + 1;
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07003010 udev->wusb = hub_is_wusb(hub);
Alan Stern55c52712005-11-23 12:03:12 -05003011
Sarah Sharpe7b77172009-04-27 19:54:26 -07003012 /*
3013 * USB 3.0 devices are reset automatically before the connect
3014 * port status change appears, and the root hub port status
3015 * shows the correct speed. We also get port change
3016 * notifications for USB 3.0 devices from the USB 3.0 portion of
3017 * an external USB 3.0 hub, but this isn't handled correctly yet
3018 * FIXME.
3019 */
3020
3021 if (!(hcd->driver->flags & HCD_USB3))
3022 udev->speed = USB_SPEED_UNKNOWN;
3023 else if ((hdev->parent == NULL) &&
3024 (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED)))
3025 udev->speed = USB_SPEED_SUPER;
3026 else
3027 udev->speed = USB_SPEED_UNKNOWN;
3028
Sarah Sharpc6515272009-04-27 19:57:26 -07003029 /*
3030 * xHCI needs to issue an address device command later
3031 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3032 */
3033 if (!(hcd->driver->flags & HCD_USB3)) {
3034 /* set the address */
3035 choose_address(udev);
3036 if (udev->devnum <= 0) {
3037 status = -ENOTCONN; /* Don't retry */
3038 goto loop;
3039 }
3040 }
3041
Sarah Sharpe7b77172009-04-27 19:54:26 -07003042 /* reset (non-USB 3.0 devices) and get descriptor */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 status = hub_port_init(hub, udev, port1, i);
3044 if (status < 0)
3045 goto loop;
3046
3047 /* consecutive bus-powered hubs aren't reliable; they can
3048 * violate the voltage drop budget. if the new child has
3049 * a "powered" LED, users should notice we didn't enable it
3050 * (without reading syslog), even without per-port LEDs
3051 * on the parent.
3052 */
3053 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05003054 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 u16 devstat;
3056
3057 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3058 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05003059 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003060 dev_dbg(&udev->dev, "get status %d ?\n", status);
3061 goto loop_disable;
3062 }
Alan Stern55c52712005-11-23 12:03:12 -05003063 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3065 dev_err(&udev->dev,
3066 "can't connect bus-powered hub "
3067 "to this port\n");
3068 if (hub->has_indicators) {
3069 hub->indicator[port1-1] =
3070 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00003071 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072 }
3073 status = -ENOTCONN; /* Don't retry */
3074 goto loop_disable;
3075 }
3076 }
3077
3078 /* check for devices running slower than they could */
3079 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3080 && udev->speed == USB_SPEED_FULL
3081 && highspeed_hubs != 0)
3082 check_highspeed (hub, udev, port1);
3083
3084 /* Store the parent's children[] pointer. At this point
3085 * udev becomes globally accessible, although presumably
3086 * no one will look at it until hdev is unlocked.
3087 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003088 status = 0;
3089
3090 /* We mustn't add new devices if the parent hub has
3091 * been disconnected; we would race with the
3092 * recursively_mark_NOTATTACHED() routine.
3093 */
3094 spin_lock_irq(&device_state_lock);
3095 if (hdev->state == USB_STATE_NOTATTACHED)
3096 status = -ENOTCONN;
3097 else
3098 hdev->children[port1-1] = udev;
3099 spin_unlock_irq(&device_state_lock);
3100
3101 /* Run it through the hoops (find a driver, etc) */
3102 if (!status) {
3103 status = usb_new_device(udev);
3104 if (status) {
3105 spin_lock_irq(&device_state_lock);
3106 hdev->children[port1-1] = NULL;
3107 spin_unlock_irq(&device_state_lock);
3108 }
3109 }
3110
Linus Torvalds1da177e2005-04-16 15:20:36 -07003111 if (status)
3112 goto loop_disable;
3113
3114 status = hub_power_remaining(hub);
3115 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05003116 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117
3118 return;
3119
3120loop_disable:
3121 hub_port_disable(hub, port1, 1);
3122loop:
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003123 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124 release_address(udev);
3125 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07003126 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 break;
3128 }
Alan Stern3a311552008-05-20 16:58:29 -04003129 if (hub->hdev->parent ||
3130 !hcd->driver->port_handed_over ||
3131 !(hcd->driver->port_handed_over)(hcd, port1))
3132 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3133 port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134
3135done:
3136 hub_port_disable(hub, port1, 1);
Balaji Rao90da0962007-11-22 01:58:14 +05303137 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3138 hcd->driver->relinquish_port(hcd, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139}
3140
3141static void hub_events(void)
3142{
3143 struct list_head *tmp;
3144 struct usb_device *hdev;
3145 struct usb_interface *intf;
3146 struct usb_hub *hub;
3147 struct device *hub_dev;
3148 u16 hubstatus;
3149 u16 hubchange;
3150 u16 portstatus;
3151 u16 portchange;
3152 int i, ret;
3153 int connect_change;
3154
3155 /*
3156 * We restart the list every time to avoid a deadlock with
3157 * deleting hubs downstream from this one. This should be
3158 * safe since we delete the hub from the event list.
3159 * Not the most efficient, but avoids deadlocks.
3160 */
3161 while (1) {
3162
3163 /* Grab the first entry at the beginning of the list */
3164 spin_lock_irq(&hub_event_lock);
3165 if (list_empty(&hub_event_list)) {
3166 spin_unlock_irq(&hub_event_lock);
3167 break;
3168 }
3169
3170 tmp = hub_event_list.next;
3171 list_del_init(tmp);
3172
3173 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04003174 kref_get(&hub->kref);
3175 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176
Alan Sterne8054852007-05-04 11:55:11 -04003177 hdev = hub->hdev;
3178 hub_dev = hub->intfdev;
3179 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05003180 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07003181 hdev->state, hub->descriptor
3182 ? hub->descriptor->bNbrPorts
3183 : 0,
3184 /* NOTE: expects max 15 ports... */
3185 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05003186 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188 /* Lock the device, then check to see if we were
3189 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04003190 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04003191 if (unlikely(hub->disconnected))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 goto loop;
3193
3194 /* If the hub has died, clean up after it */
3195 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04003196 hub->error = -ENODEV;
Alan Stern43303542008-04-28 11:07:31 -04003197 hub_quiesce(hub, HUB_DISCONNECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198 goto loop;
3199 }
3200
Alan Stern40f122f2006-11-09 14:44:33 -05003201 /* Autoresume */
3202 ret = usb_autopm_get_interface(intf);
3203 if (ret) {
3204 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05003206 }
3207
3208 /* If this is an inactive hub, do nothing */
3209 if (hub->quiescing)
3210 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211
3212 if (hub->error) {
3213 dev_dbg (hub_dev, "resetting for error %d\n",
3214 hub->error);
3215
Ming Lei742120c2008-06-18 22:00:29 +08003216 ret = usb_reset_device(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217 if (ret) {
3218 dev_dbg (hub_dev,
3219 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05003220 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221 }
3222
3223 hub->nerrors = 0;
3224 hub->error = 0;
3225 }
3226
3227 /* deal with port status changes */
3228 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3229 if (test_bit(i, hub->busy_bits))
3230 continue;
3231 connect_change = test_bit(i, hub->change_bits);
3232 if (!test_and_clear_bit(i, hub->event_bits) &&
Alan Stern6ee0b272008-04-28 11:06:42 -04003233 !connect_change)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234 continue;
3235
3236 ret = hub_port_status(hub, i,
3237 &portstatus, &portchange);
3238 if (ret < 0)
3239 continue;
3240
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3242 clear_port_feature(hdev, i,
3243 USB_PORT_FEAT_C_CONNECTION);
3244 connect_change = 1;
3245 }
3246
3247 if (portchange & USB_PORT_STAT_C_ENABLE) {
3248 if (!connect_change)
3249 dev_dbg (hub_dev,
3250 "port %d enable change, "
3251 "status %08x\n",
3252 i, portstatus);
3253 clear_port_feature(hdev, i,
3254 USB_PORT_FEAT_C_ENABLE);
3255
3256 /*
3257 * EM interference sometimes causes badly
3258 * shielded USB devices to be shutdown by
3259 * the hub, this hack enables them again.
3260 * Works at least with mouse driver.
3261 */
3262 if (!(portstatus & USB_PORT_STAT_ENABLE)
3263 && !connect_change
3264 && hdev->children[i-1]) {
3265 dev_err (hub_dev,
3266 "port %i "
3267 "disabled by hub (EMI?), "
3268 "re-enabling...\n",
3269 i);
3270 connect_change = 1;
3271 }
3272 }
3273
3274 if (portchange & USB_PORT_STAT_C_SUSPEND) {
Alan Stern8808f002008-04-28 11:06:55 -04003275 struct usb_device *udev;
3276
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277 clear_port_feature(hdev, i,
3278 USB_PORT_FEAT_C_SUSPEND);
Alan Stern8808f002008-04-28 11:06:55 -04003279 udev = hdev->children[i-1];
3280 if (udev) {
3281 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282 ret = remote_wakeup(hdev->
3283 children[i-1]);
Alan Stern8808f002008-04-28 11:06:55 -04003284 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003285 if (ret < 0)
3286 connect_change = 1;
3287 } else {
3288 ret = -ENODEV;
3289 hub_port_disable(hub, i, 1);
3290 }
3291 dev_dbg (hub_dev,
3292 "resume on port %d, status %d\n",
3293 i, ret);
3294 }
3295
3296 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3297 dev_err (hub_dev,
3298 "over-current change on port %d\n",
3299 i);
3300 clear_port_feature(hdev, i,
3301 USB_PORT_FEAT_C_OVER_CURRENT);
Alan Stern8520f382008-09-22 14:44:26 -04003302 hub_power_on(hub, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303 }
3304
3305 if (portchange & USB_PORT_STAT_C_RESET) {
3306 dev_dbg (hub_dev,
3307 "reset change on port %d\n",
3308 i);
3309 clear_port_feature(hdev, i,
3310 USB_PORT_FEAT_C_RESET);
3311 }
3312
3313 if (connect_change)
3314 hub_port_connect_change(hub, i,
3315 portstatus, portchange);
3316 } /* end for i */
3317
3318 /* deal with hub status changes */
3319 if (test_and_clear_bit(0, hub->event_bits) == 0)
3320 ; /* do nothing */
3321 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3322 dev_err (hub_dev, "get_hub_status failed\n");
3323 else {
3324 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3325 dev_dbg (hub_dev, "power change\n");
3326 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05003327 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3328 /* FIXME: Is this always true? */
Alan Stern55c52712005-11-23 12:03:12 -05003329 hub->limited_power = 1;
jidong xiao403fae72007-09-14 00:08:51 +08003330 else
3331 hub->limited_power = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332 }
3333 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3334 dev_dbg (hub_dev, "overcurrent change\n");
3335 msleep(500); /* Cool down */
3336 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
Alan Stern8520f382008-09-22 14:44:26 -04003337 hub_power_on(hub, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338 }
3339 }
3340
Alan Stern40f122f2006-11-09 14:44:33 -05003341loop_autopm:
3342 /* Allow autosuspend if we're not going to run again */
3343 if (list_empty(&hub->event_list))
3344 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345loop:
3346 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04003347 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348
3349 } /* end while (1) */
3350}
3351
3352static int hub_thread(void *__unused)
3353{
Alan Stern3bb1af52008-03-03 15:15:36 -05003354 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3355 * port handover. Otherwise it might see that a full-speed device
3356 * was gone before the EHCI controller had handed its port over to
3357 * the companion full-speed controller.
3358 */
Rafael J. Wysocki83144182007-07-17 04:03:35 -07003359 set_freezable();
Alan Stern3bb1af52008-03-03 15:15:36 -05003360
Linus Torvalds1da177e2005-04-16 15:20:36 -07003361 do {
3362 hub_events();
Rafael J. Wysockie42837b2007-10-18 03:04:45 -07003363 wait_event_freezable(khubd_wait,
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003364 !list_empty(&hub_event_list) ||
3365 kthread_should_stop());
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003366 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003368 pr_debug("%s: khubd exiting\n", usbcore_name);
3369 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370}
3371
3372static struct usb_device_id hub_id_table [] = {
3373 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3374 .bDeviceClass = USB_CLASS_HUB},
3375 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3376 .bInterfaceClass = USB_CLASS_HUB},
3377 { } /* Terminating entry */
3378};
3379
3380MODULE_DEVICE_TABLE (usb, hub_id_table);
3381
3382static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003383 .name = "hub",
3384 .probe = hub_probe,
3385 .disconnect = hub_disconnect,
3386 .suspend = hub_suspend,
3387 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04003388 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04003389 .pre_reset = hub_pre_reset,
3390 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003391 .ioctl = hub_ioctl,
3392 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05003393 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003394};
3395
3396int usb_hub_init(void)
3397{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398 if (usb_register(&hub_driver) < 0) {
3399 printk(KERN_ERR "%s: can't register hub driver\n",
3400 usbcore_name);
3401 return -1;
3402 }
3403
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003404 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3405 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407
3408 /* Fall through if kernel_thread failed */
3409 usb_deregister(&hub_driver);
3410 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3411
3412 return -1;
3413}
3414
3415void usb_hub_cleanup(void)
3416{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07003417 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003418
3419 /*
3420 * Hub resources are freed for us by usb_deregister. It calls
3421 * usb_driver_purge on every device which in turn calls that
3422 * devices disconnect function if it is using this driver.
3423 * The hub_disconnect function takes care of releasing the
3424 * individual hub resources. -greg
3425 */
3426 usb_deregister(&hub_driver);
3427} /* usb_hub_cleanup() */
3428
Alan Sterneb764c42008-03-03 15:16:04 -05003429static int descriptors_changed(struct usb_device *udev,
3430 struct usb_device_descriptor *old_device_descriptor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431{
Alan Sterneb764c42008-03-03 15:16:04 -05003432 int changed = 0;
3433 unsigned index;
3434 unsigned serial_len = 0;
3435 unsigned len;
3436 unsigned old_length;
3437 int length;
3438 char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003439
Alan Sterneb764c42008-03-03 15:16:04 -05003440 if (memcmp(&udev->descriptor, old_device_descriptor,
3441 sizeof(*old_device_descriptor)) != 0)
3442 return 1;
3443
3444 /* Since the idVendor, idProduct, and bcdDevice values in the
3445 * device descriptor haven't changed, we will assume the
3446 * Manufacturer and Product strings haven't changed either.
3447 * But the SerialNumber string could be different (e.g., a
3448 * different flash card of the same brand).
3449 */
3450 if (udev->serial)
3451 serial_len = strlen(udev->serial) + 1;
3452
3453 len = serial_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003454 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05003455 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3456 len = max(len, old_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457 }
Alan Sterneb764c42008-03-03 15:16:04 -05003458
Oliver Neukum0cc1a512008-01-10 10:31:48 +01003459 buf = kmalloc(len, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460 if (buf == NULL) {
3461 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3462 /* assume the worst */
3463 return 1;
3464 }
3465 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05003466 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3468 old_length);
Alan Sterneb764c42008-03-03 15:16:04 -05003469 if (length != old_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 dev_dbg(&udev->dev, "config index %d, error %d\n",
3471 index, length);
Alan Sterneb764c42008-03-03 15:16:04 -05003472 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003473 break;
3474 }
3475 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3476 != 0) {
3477 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
Alan Sterneb764c42008-03-03 15:16:04 -05003478 index,
3479 ((struct usb_config_descriptor *) buf)->
3480 bConfigurationValue);
3481 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003482 break;
3483 }
3484 }
Alan Sterneb764c42008-03-03 15:16:04 -05003485
3486 if (!changed && serial_len) {
3487 length = usb_string(udev, udev->descriptor.iSerialNumber,
3488 buf, serial_len);
3489 if (length + 1 != serial_len) {
3490 dev_dbg(&udev->dev, "serial string error %d\n",
3491 length);
3492 changed = 1;
3493 } else if (memcmp(buf, udev->serial, length) != 0) {
3494 dev_dbg(&udev->dev, "serial string changed\n");
3495 changed = 1;
3496 }
3497 }
3498
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499 kfree(buf);
Alan Sterneb764c42008-03-03 15:16:04 -05003500 return changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501}
3502
3503/**
Ming Lei742120c2008-06-18 22:00:29 +08003504 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003505 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3506 *
Alan Stern79efa092006-06-01 13:33:42 -04003507 * WARNING - don't use this routine to reset a composite device
3508 * (one with multiple interfaces owned by separate drivers)!
Ming Lei742120c2008-06-18 22:00:29 +08003509 * Use usb_reset_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510 *
3511 * Do a port reset, reassign the device's address, and establish its
3512 * former operating configuration. If the reset fails, or the device's
3513 * descriptors change from their values before the reset, or the original
3514 * configuration and altsettings cannot be restored, a flag will be set
3515 * telling khubd to pretend the device has been disconnected and then
3516 * re-connected. All drivers will be unbound, and the device will be
3517 * re-enumerated and probed all over again.
3518 *
3519 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3520 * flagged for logical disconnection, or some other negative error code
3521 * if the reset wasn't even attempted.
3522 *
3523 * The caller must own the device lock. For example, it's safe to use
3524 * this from a driver probe() routine after downloading new firmware.
3525 * For calls that might not occur during probe(), drivers should lock
3526 * the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04003527 *
3528 * Locking exception: This routine may also be called from within an
3529 * autoresume handler. Such usage won't conflict with other tasks
3530 * holding the device lock because these tasks should always call
3531 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532 */
Ming Lei742120c2008-06-18 22:00:29 +08003533static int usb_reset_and_verify_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534{
3535 struct usb_device *parent_hdev = udev->parent;
3536 struct usb_hub *parent_hub;
3537 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05003538 int i, ret = 0;
3539 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540
3541 if (udev->state == USB_STATE_NOTATTACHED ||
3542 udev->state == USB_STATE_SUSPENDED) {
3543 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3544 udev->state);
3545 return -EINVAL;
3546 }
3547
3548 if (!parent_hdev) {
3549 /* this requires hcd-specific logic; see OHCI hc_restart() */
Harvey Harrison441b62c2008-03-03 16:08:34 -08003550 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 return -EISDIR;
3552 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553 parent_hub = hdev_to_hub(parent_hdev);
3554
Linus Torvalds1da177e2005-04-16 15:20:36 -07003555 set_bit(port1, parent_hub->busy_bits);
3556 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3557
3558 /* ep0 maxpacket size may change; let the HCD know about it.
3559 * Other endpoints will be handled by re-enumeration. */
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003560 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04003562 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563 break;
3564 }
3565 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003566
Linus Torvalds1da177e2005-04-16 15:20:36 -07003567 if (ret < 0)
3568 goto re_enumerate;
3569
3570 /* Device might have changed firmware (DFU or similar) */
Alan Sterneb764c42008-03-03 15:16:04 -05003571 if (descriptors_changed(udev, &descriptor)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003572 dev_info(&udev->dev, "device firmware changed\n");
3573 udev->descriptor = descriptor; /* for disconnect() calls */
3574 goto re_enumerate;
3575 }
Alan Stern4fe03872009-02-26 10:21:02 -05003576
3577 /* Restore the device's previous configuration */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578 if (!udev->actconfig)
3579 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3581 USB_REQ_SET_CONFIGURATION, 0,
3582 udev->actconfig->desc.bConfigurationValue, 0,
3583 NULL, 0, USB_CTRL_SET_TIMEOUT);
3584 if (ret < 0) {
3585 dev_err(&udev->dev,
3586 "can't restore configuration #%d (error=%d)\n",
3587 udev->actconfig->desc.bConfigurationValue, ret);
3588 goto re_enumerate;
3589 }
3590 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3591
Alan Stern4fe03872009-02-26 10:21:02 -05003592 /* Put interfaces back into the same altsettings as before.
3593 * Don't bother to send the Set-Interface request for interfaces
3594 * that were already in altsetting 0; besides being unnecessary,
3595 * many devices can't handle it. Instead just reset the host-side
3596 * endpoint state.
3597 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3599 struct usb_interface *intf = udev->actconfig->interface[i];
3600 struct usb_interface_descriptor *desc;
3601
Linus Torvalds1da177e2005-04-16 15:20:36 -07003602 desc = &intf->cur_altsetting->desc;
Alan Stern4fe03872009-02-26 10:21:02 -05003603 if (desc->bAlternateSetting == 0) {
3604 usb_disable_interface(udev, intf, true);
3605 usb_enable_interface(udev, intf, true);
3606 ret = 0;
3607 } else {
3608 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3609 desc->bAlternateSetting);
3610 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003611 if (ret < 0) {
3612 dev_err(&udev->dev, "failed to restore interface %d "
3613 "altsetting %d (error=%d)\n",
3614 desc->bInterfaceNumber,
3615 desc->bAlternateSetting,
3616 ret);
3617 goto re_enumerate;
3618 }
3619 }
3620
3621done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622 return 0;
3623
3624re_enumerate:
3625 hub_port_logical_disconnect(parent_hub, port1);
3626 return -ENODEV;
3627}
Alan Stern79efa092006-06-01 13:33:42 -04003628
3629/**
Ming Lei742120c2008-06-18 22:00:29 +08003630 * usb_reset_device - warn interface drivers and perform a USB port reset
Alan Stern79efa092006-06-01 13:33:42 -04003631 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
Alan Stern79efa092006-06-01 13:33:42 -04003632 *
3633 * Warns all drivers bound to registered interfaces (using their pre_reset
3634 * method), performs the port reset, and then lets the drivers know that
3635 * the reset is over (using their post_reset method).
3636 *
Ming Lei742120c2008-06-18 22:00:29 +08003637 * Return value is the same as for usb_reset_and_verify_device().
Alan Stern79efa092006-06-01 13:33:42 -04003638 *
3639 * The caller must own the device lock. For example, it's safe to use
3640 * this from a driver probe() routine after downloading new firmware.
3641 * For calls that might not occur during probe(), drivers should lock
3642 * the device using usb_lock_device_for_reset().
Alan Stern78d9a482008-06-23 16:00:40 -04003643 *
3644 * If an interface is currently being probed or disconnected, we assume
3645 * its driver knows how to handle resets. For all other interfaces,
3646 * if the driver doesn't have pre_reset and post_reset methods then
3647 * we attempt to unbind it and rebind afterward.
Alan Stern79efa092006-06-01 13:33:42 -04003648 */
Ming Lei742120c2008-06-18 22:00:29 +08003649int usb_reset_device(struct usb_device *udev)
Alan Stern79efa092006-06-01 13:33:42 -04003650{
3651 int ret;
Alan Stern852c4b42007-12-03 15:44:29 -05003652 int i;
Alan Stern79efa092006-06-01 13:33:42 -04003653 struct usb_host_config *config = udev->actconfig;
3654
3655 if (udev->state == USB_STATE_NOTATTACHED ||
3656 udev->state == USB_STATE_SUSPENDED) {
3657 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3658 udev->state);
3659 return -EINVAL;
3660 }
3661
Alan Stern645daaa2006-08-30 15:47:02 -04003662 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003663 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003664
Alan Stern79efa092006-06-01 13:33:42 -04003665 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04003666 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
Alan Stern852c4b42007-12-03 15:44:29 -05003667 struct usb_interface *cintf = config->interface[i];
3668 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04003669 int unbind = 0;
Alan Stern852c4b42007-12-03 15:44:29 -05003670
3671 if (cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04003672 drv = to_usb_driver(cintf->dev.driver);
Alan Stern78d9a482008-06-23 16:00:40 -04003673 if (drv->pre_reset && drv->post_reset)
3674 unbind = (drv->pre_reset)(cintf);
3675 else if (cintf->condition ==
3676 USB_INTERFACE_BOUND)
3677 unbind = 1;
3678 if (unbind)
3679 usb_forced_unbind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04003680 }
3681 }
3682 }
3683
Ming Lei742120c2008-06-18 22:00:29 +08003684 ret = usb_reset_and_verify_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003685
3686 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04003687 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
Alan Stern852c4b42007-12-03 15:44:29 -05003688 struct usb_interface *cintf = config->interface[i];
3689 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04003690 int rebind = cintf->needs_binding;
Alan Stern852c4b42007-12-03 15:44:29 -05003691
Alan Stern78d9a482008-06-23 16:00:40 -04003692 if (!rebind && cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04003693 drv = to_usb_driver(cintf->dev.driver);
3694 if (drv->post_reset)
Alan Stern78d9a482008-06-23 16:00:40 -04003695 rebind = (drv->post_reset)(cintf);
3696 else if (cintf->condition ==
3697 USB_INTERFACE_BOUND)
3698 rebind = 1;
Alan Stern79efa092006-06-01 13:33:42 -04003699 }
Alan Stern6c640942008-10-21 15:40:03 -04003700 if (ret == 0 && rebind)
Alan Stern78d9a482008-06-23 16:00:40 -04003701 usb_rebind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04003702 }
3703 }
3704
Alan Stern94fcda12006-11-20 11:38:46 -05003705 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003706 return ret;
3707}
Ming Lei742120c2008-06-18 22:00:29 +08003708EXPORT_SYMBOL_GPL(usb_reset_device);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08003709
3710
3711/**
3712 * usb_queue_reset_device - Reset a USB device from an atomic context
3713 * @iface: USB interface belonging to the device to reset
3714 *
3715 * This function can be used to reset a USB device from an atomic
3716 * context, where usb_reset_device() won't work (as it blocks).
3717 *
3718 * Doing a reset via this method is functionally equivalent to calling
3719 * usb_reset_device(), except for the fact that it is delayed to a
3720 * workqueue. This means that any drivers bound to other interfaces
3721 * might be unbound, as well as users from usbfs in user space.
3722 *
3723 * Corner cases:
3724 *
3725 * - Scheduling two resets at the same time from two different drivers
3726 * attached to two different interfaces of the same device is
3727 * possible; depending on how the driver attached to each interface
3728 * handles ->pre_reset(), the second reset might happen or not.
3729 *
3730 * - If a driver is unbound and it had a pending reset, the reset will
3731 * be cancelled.
3732 *
3733 * - This function can be called during .probe() or .disconnect()
3734 * times. On return from .disconnect(), any pending resets will be
3735 * cancelled.
3736 *
3737 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3738 * does its own.
3739 *
3740 * NOTE: We don't do any reference count tracking because it is not
3741 * needed. The lifecycle of the work_struct is tied to the
3742 * usb_interface. Before destroying the interface we cancel the
3743 * work_struct, so the fact that work_struct is queued and or
3744 * running means the interface (and thus, the device) exist and
3745 * are referenced.
3746 */
3747void usb_queue_reset_device(struct usb_interface *iface)
3748{
3749 schedule_work(&iface->reset_ws);
3750}
3751EXPORT_SYMBOL_GPL(usb_queue_reset_device);