blob: 29ca6ed3bea89969a267f49b7979bbdcea37a73b [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>
Eric Lescouet27729aa2010-04-24 23:21:52 +020022#include <linux/usb/hcd.h>
Richard Zhao925aa462012-07-11 11:09:28 +080023#include <linux/usb/otg.h>
Phil Dibowitz93362a82010-07-22 00:05:01 +020024#include <linux/usb/quirks.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070025#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010026#include <linux/mutex.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080027#include <linux/freezer.h>
Theodore Ts'ob04b3152012-07-04 11:22:20 -040028#include <linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <asm/uaccess.h>
31#include <asm/byteorder.h>
32
Lan Tianyu6e30d7c2013-01-11 20:10:38 +080033#include "hub.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -080035/* if we are in debug mode, always announce new devices */
36#ifdef DEBUG
37#ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
38#define CONFIG_USB_ANNOUNCE_NEW_DEVICES
39#endif
40#endif
41
Ming Leie6f30de2012-10-24 11:59:24 +080042#define USB_VENDOR_GENESYS_LOGIC 0x05e3
43#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
44
John Youndbe79bb2001-09-17 00:00:00 -070045static inline int hub_is_superspeed(struct usb_device *hdev)
46{
Aman Deep7bf01182011-12-08 12:05:22 +053047 return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS);
John Youndbe79bb2001-09-17 00:00:00 -070048}
Alan Stern1bb5f662006-11-06 11:56:13 -050049
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -070050/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050051 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
53static DEFINE_SPINLOCK(device_state_lock);
54
55/* khubd's worklist and its lock */
56static DEFINE_SPINLOCK(hub_event_lock);
57static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
58
59/* Wakes up khubd */
60static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
61
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070062static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64/* cycle leds on hubs that aren't blinking for attention */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103065static bool blinkenlights = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066module_param (blinkenlights, bool, S_IRUGO);
67MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
68
69/*
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020070 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
71 * 10 seconds to send reply for the initial 64-byte descriptor request.
72 */
73/* define initial 64-byte descriptor request timeout in milliseconds */
74static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
75module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
Wu Fengguangb9cef6c2008-12-15 15:32:01 +080076MODULE_PARM_DESC(initial_descriptor_timeout,
77 "initial 64-byte descriptor request timeout in milliseconds "
78 "(default 5000 - 5.0 seconds)");
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020079
80/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * As of 2.6.10 we introduce a new USB device initialization scheme which
82 * closely resembles the way Windows works. Hopefully it will be compatible
83 * with a wider range of devices than the old scheme. However some previously
84 * working devices may start giving rise to "device not accepting address"
85 * errors; if that happens the user can try the old scheme by adjusting the
86 * following module parameters.
87 *
88 * For maximum flexibility there are two boolean parameters to control the
89 * hub driver's behavior. On the first initialization attempt, if the
90 * "old_scheme_first" parameter is set then the old scheme will be used,
91 * otherwise the new scheme is used. If that fails and "use_both_schemes"
92 * is set, then the driver will make another attempt, using the other scheme.
93 */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103094static bool old_scheme_first = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
96MODULE_PARM_DESC(old_scheme_first,
97 "start with the old device initialization scheme");
98
Rusty Russell90ab5ee2012-01-13 09:32:20 +103099static bool use_both_schemes = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
101MODULE_PARM_DESC(use_both_schemes,
102 "try the other device initialization scheme if the "
103 "first one fails");
104
Alan Stern32fe0192007-10-10 16:27:07 -0400105/* Mutual exclusion for EHCI CF initialization. This interferes with
106 * port reset on some companion controllers.
107 */
108DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
109EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
110
Alan Stern948fea32008-04-28 11:07:07 -0400111#define HUB_DEBOUNCE_TIMEOUT 1500
112#define HUB_DEBOUNCE_STEP 25
113#define HUB_DEBOUNCE_STABLE 100
114
Ming Lei742120c2008-06-18 22:00:29 +0800115static int usb_reset_and_verify_device(struct usb_device *udev);
116
Sarah Sharp131dec32010-12-06 21:00:19 -0800117static inline char *portspeed(struct usb_hub *hub, int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
Sarah Sharp131dec32010-12-06 21:00:19 -0800119 if (hub_is_superspeed(hub->hdev))
120 return "5.0 Gb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500121 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 return "480 Mb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500123 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 return "1.5 Mb/s";
125 else
126 return "12 Mb/s";
127}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129/* Note that hdev or one of its children must be locked! */
Alan Stern251180842009-07-22 14:41:18 -0400130static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131{
Lan Tianyuff823c72012-09-05 13:44:32 +0800132 if (!hdev || !hdev->actconfig || !hdev->maxchild)
Alan Stern251180842009-07-22 14:41:18 -0400133 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 return usb_get_intfdata(hdev->actconfig->interface[0]);
135}
136
Sarah Sharpd9b20992012-02-20 08:31:26 -0800137static int usb_device_supports_lpm(struct usb_device *udev)
138{
139 /* USB 2.1 (and greater) devices indicate LPM support through
140 * their USB 2.0 Extended Capabilities BOS descriptor.
141 */
142 if (udev->speed == USB_SPEED_HIGH) {
143 if (udev->bos->ext_cap &&
144 (USB_LPM_SUPPORT &
145 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
146 return 1;
147 return 0;
148 }
Sarah Sharp51e0a012012-02-20 12:02:19 -0800149
150 /* All USB 3.0 must support LPM, but we need their max exit latency
151 * information from the SuperSpeed Extended Capabilities BOS descriptor.
152 */
153 if (!udev->bos->ss_cap) {
154 dev_warn(&udev->dev, "No LPM exit latency info found. "
155 "Power management will be impacted.\n");
156 return 0;
157 }
158 if (udev->parent->lpm_capable)
159 return 1;
160
161 dev_warn(&udev->dev, "Parent hub missing LPM exit latency info. "
162 "Power management will be impacted.\n");
Sarah Sharpd9b20992012-02-20 08:31:26 -0800163 return 0;
164}
165
Sarah Sharp51e0a012012-02-20 12:02:19 -0800166/*
167 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
168 * either U1 or U2.
169 */
170static void usb_set_lpm_mel(struct usb_device *udev,
171 struct usb3_lpm_parameters *udev_lpm_params,
172 unsigned int udev_exit_latency,
173 struct usb_hub *hub,
174 struct usb3_lpm_parameters *hub_lpm_params,
175 unsigned int hub_exit_latency)
176{
177 unsigned int total_mel;
178 unsigned int device_mel;
179 unsigned int hub_mel;
180
181 /*
182 * Calculate the time it takes to transition all links from the roothub
183 * to the parent hub into U0. The parent hub must then decode the
184 * packet (hub header decode latency) to figure out which port it was
185 * bound for.
186 *
187 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
188 * means 0.1us). Multiply that by 100 to get nanoseconds.
189 */
190 total_mel = hub_lpm_params->mel +
191 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
192
193 /*
194 * How long will it take to transition the downstream hub's port into
195 * U0? The greater of either the hub exit latency or the device exit
196 * latency.
197 *
198 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
199 * Multiply that by 1000 to get nanoseconds.
200 */
201 device_mel = udev_exit_latency * 1000;
202 hub_mel = hub_exit_latency * 1000;
203 if (device_mel > hub_mel)
204 total_mel += device_mel;
205 else
206 total_mel += hub_mel;
207
208 udev_lpm_params->mel = total_mel;
209}
210
211/*
212 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
213 * a transition from either U1 or U2.
214 */
215static void usb_set_lpm_pel(struct usb_device *udev,
216 struct usb3_lpm_parameters *udev_lpm_params,
217 unsigned int udev_exit_latency,
218 struct usb_hub *hub,
219 struct usb3_lpm_parameters *hub_lpm_params,
220 unsigned int hub_exit_latency,
221 unsigned int port_to_port_exit_latency)
222{
223 unsigned int first_link_pel;
224 unsigned int hub_pel;
225
226 /*
227 * First, the device sends an LFPS to transition the link between the
228 * device and the parent hub into U0. The exit latency is the bigger of
229 * the device exit latency or the hub exit latency.
230 */
231 if (udev_exit_latency > hub_exit_latency)
232 first_link_pel = udev_exit_latency * 1000;
233 else
234 first_link_pel = hub_exit_latency * 1000;
235
236 /*
237 * When the hub starts to receive the LFPS, there is a slight delay for
238 * it to figure out that one of the ports is sending an LFPS. Then it
239 * will forward the LFPS to its upstream link. The exit latency is the
240 * delay, plus the PEL that we calculated for this hub.
241 */
242 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
243
244 /*
245 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
246 * is the greater of the two exit latencies.
247 */
248 if (first_link_pel > hub_pel)
249 udev_lpm_params->pel = first_link_pel;
250 else
251 udev_lpm_params->pel = hub_pel;
252}
253
254/*
255 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
256 * when a device initiates a transition to U0, until when it will receive the
257 * first packet from the host controller.
258 *
259 * Section C.1.5.1 describes the four components to this:
260 * - t1: device PEL
261 * - t2: time for the ERDY to make it from the device to the host.
262 * - t3: a host-specific delay to process the ERDY.
263 * - t4: time for the packet to make it from the host to the device.
264 *
265 * t3 is specific to both the xHCI host and the platform the host is integrated
266 * into. The Intel HW folks have said it's negligible, FIXME if a different
267 * vendor says otherwise.
268 */
269static void usb_set_lpm_sel(struct usb_device *udev,
270 struct usb3_lpm_parameters *udev_lpm_params)
271{
272 struct usb_device *parent;
273 unsigned int num_hubs;
274 unsigned int total_sel;
275
276 /* t1 = device PEL */
277 total_sel = udev_lpm_params->pel;
278 /* How many external hubs are in between the device & the root port. */
279 for (parent = udev->parent, num_hubs = 0; parent->parent;
280 parent = parent->parent)
281 num_hubs++;
282 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
283 if (num_hubs > 0)
284 total_sel += 2100 + 250 * (num_hubs - 1);
285
286 /* t4 = 250ns * num_hubs */
287 total_sel += 250 * num_hubs;
288
289 udev_lpm_params->sel = total_sel;
290}
291
292static void usb_set_lpm_parameters(struct usb_device *udev)
293{
294 struct usb_hub *hub;
295 unsigned int port_to_port_delay;
296 unsigned int udev_u1_del;
297 unsigned int udev_u2_del;
298 unsigned int hub_u1_del;
299 unsigned int hub_u2_del;
300
301 if (!udev->lpm_capable || udev->speed != USB_SPEED_SUPER)
302 return;
303
304 hub = hdev_to_hub(udev->parent);
305 /* It doesn't take time to transition the roothub into U0, since it
306 * doesn't have an upstream link.
307 */
308 if (!hub)
309 return;
310
311 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
312 udev_u2_del = udev->bos->ss_cap->bU2DevExitLat;
313 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
314 hub_u2_del = udev->parent->bos->ss_cap->bU2DevExitLat;
315
316 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
317 hub, &udev->parent->u1_params, hub_u1_del);
318
319 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
320 hub, &udev->parent->u2_params, hub_u2_del);
321
322 /*
323 * Appendix C, section C.2.2.2, says that there is a slight delay from
324 * when the parent hub notices the downstream port is trying to
325 * transition to U0 to when the hub initiates a U0 transition on its
326 * upstream port. The section says the delays are tPort2PortU1EL and
327 * tPort2PortU2EL, but it doesn't define what they are.
328 *
329 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
330 * about the same delays. Use the maximum delay calculations from those
331 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
332 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
333 * assume the device exit latencies they are talking about are the hub
334 * exit latencies.
335 *
336 * What do we do if the U2 exit latency is less than the U1 exit
337 * latency? It's possible, although not likely...
338 */
339 port_to_port_delay = 1;
340
341 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
342 hub, &udev->parent->u1_params, hub_u1_del,
343 port_to_port_delay);
344
345 if (hub_u2_del > hub_u1_del)
346 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
347 else
348 port_to_port_delay = 1 + hub_u1_del;
349
350 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
351 hub, &udev->parent->u2_params, hub_u2_del,
352 port_to_port_delay);
353
354 /* Now that we've got PEL, calculate SEL. */
355 usb_set_lpm_sel(udev, &udev->u1_params);
356 usb_set_lpm_sel(udev, &udev->u2_params);
357}
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/* USB 2.0 spec Section 11.24.4.5 */
John Youndbe79bb2001-09-17 00:00:00 -0700360static int get_hub_descriptor(struct usb_device *hdev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
John Youndbe79bb2001-09-17 00:00:00 -0700362 int i, ret, size;
363 unsigned dtype;
364
365 if (hub_is_superspeed(hdev)) {
366 dtype = USB_DT_SS_HUB;
367 size = USB_DT_SS_HUB_SIZE;
368 } else {
369 dtype = USB_DT_HUB;
370 size = sizeof(struct usb_hub_descriptor);
371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 for (i = 0; i < 3; i++) {
374 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
375 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
John Youndbe79bb2001-09-17 00:00:00 -0700376 dtype << 8, 0, data, size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 USB_CTRL_GET_TIMEOUT);
378 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
379 return ret;
380 }
381 return -EINVAL;
382}
383
384/*
385 * USB 2.0 spec Section 11.24.2.1
386 */
387static int clear_hub_feature(struct usb_device *hdev, int feature)
388{
389 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
390 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
391}
392
393/*
394 * USB 2.0 spec Section 11.24.2.2
395 */
396static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
397{
398 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
399 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
400 NULL, 0, 1000);
401}
402
403/*
404 * USB 2.0 spec Section 11.24.2.13
405 */
406static int set_port_feature(struct usb_device *hdev, int port1, int feature)
407{
408 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
409 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
410 NULL, 0, 1000);
411}
412
413/*
414 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
415 * for info about using port indicators
416 */
417static void set_port_led(
418 struct usb_hub *hub,
419 int port1,
420 int selector
421)
422{
423 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
424 USB_PORT_FEAT_INDICATOR);
425 if (status < 0)
426 dev_dbg (hub->intfdev,
427 "port %d indicator %s status %d\n",
428 port1,
429 ({ char *s; switch (selector) {
430 case HUB_LED_AMBER: s = "amber"; break;
431 case HUB_LED_GREEN: s = "green"; break;
432 case HUB_LED_OFF: s = "off"; break;
433 case HUB_LED_AUTO: s = "auto"; break;
434 default: s = "??"; break;
435 }; s; }),
436 status);
437}
438
439#define LED_CYCLE_PERIOD ((2*HZ)/3)
440
David Howellsc4028952006-11-22 14:57:56 +0000441static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
David Howellsc4028952006-11-22 14:57:56 +0000443 struct usb_hub *hub =
444 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct usb_device *hdev = hub->hdev;
446 unsigned i;
447 unsigned changed = 0;
448 int cursor = -1;
449
450 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
451 return;
452
453 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
454 unsigned selector, mode;
455
456 /* 30%-50% duty cycle */
457
458 switch (hub->indicator[i]) {
459 /* cycle marker */
460 case INDICATOR_CYCLE:
461 cursor = i;
462 selector = HUB_LED_AUTO;
463 mode = INDICATOR_AUTO;
464 break;
465 /* blinking green = sw attention */
466 case INDICATOR_GREEN_BLINK:
467 selector = HUB_LED_GREEN;
468 mode = INDICATOR_GREEN_BLINK_OFF;
469 break;
470 case INDICATOR_GREEN_BLINK_OFF:
471 selector = HUB_LED_OFF;
472 mode = INDICATOR_GREEN_BLINK;
473 break;
474 /* blinking amber = hw attention */
475 case INDICATOR_AMBER_BLINK:
476 selector = HUB_LED_AMBER;
477 mode = INDICATOR_AMBER_BLINK_OFF;
478 break;
479 case INDICATOR_AMBER_BLINK_OFF:
480 selector = HUB_LED_OFF;
481 mode = INDICATOR_AMBER_BLINK;
482 break;
483 /* blink green/amber = reserved */
484 case INDICATOR_ALT_BLINK:
485 selector = HUB_LED_GREEN;
486 mode = INDICATOR_ALT_BLINK_OFF;
487 break;
488 case INDICATOR_ALT_BLINK_OFF:
489 selector = HUB_LED_AMBER;
490 mode = INDICATOR_ALT_BLINK;
491 break;
492 default:
493 continue;
494 }
495 if (selector != HUB_LED_AUTO)
496 changed = 1;
497 set_port_led(hub, i + 1, selector);
498 hub->indicator[i] = mode;
499 }
500 if (!changed && blinkenlights) {
501 cursor++;
502 cursor %= hub->descriptor->bNbrPorts;
503 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
504 hub->indicator[cursor] = INDICATOR_CYCLE;
505 changed++;
506 }
507 if (changed)
508 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
509}
510
511/* use a short timeout for hub/port status fetches */
512#define USB_STS_TIMEOUT 1000
513#define USB_STS_RETRIES 5
514
515/*
516 * USB 2.0 spec Section 11.24.2.6
517 */
518static int get_hub_status(struct usb_device *hdev,
519 struct usb_hub_status *data)
520{
521 int i, status = -ETIMEDOUT;
522
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200523 for (i = 0; i < USB_STS_RETRIES &&
524 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
526 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
527 data, sizeof(*data), USB_STS_TIMEOUT);
528 }
529 return status;
530}
531
532/*
533 * USB 2.0 spec Section 11.24.2.7
534 */
535static int get_port_status(struct usb_device *hdev, int port1,
536 struct usb_port_status *data)
537{
538 int i, status = -ETIMEDOUT;
539
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200540 for (i = 0; i < USB_STS_RETRIES &&
541 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
543 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
544 data, sizeof(*data), USB_STS_TIMEOUT);
545 }
546 return status;
547}
548
Alan Stern3eb14912008-03-03 15:15:43 -0500549static int hub_port_status(struct usb_hub *hub, int port1,
550 u16 *status, u16 *change)
551{
552 int ret;
553
554 mutex_lock(&hub->status_mutex);
555 ret = get_port_status(hub->hdev, port1, &hub->status->port);
556 if (ret < 4) {
557 dev_err(hub->intfdev,
558 "%s failed (err = %d)\n", __func__, ret);
559 if (ret >= 0)
560 ret = -EIO;
561 } else {
562 *status = le16_to_cpu(hub->status->port.wPortStatus);
563 *change = le16_to_cpu(hub->status->port.wPortChange);
John Youndbe79bb2001-09-17 00:00:00 -0700564
Alan Stern3eb14912008-03-03 15:15:43 -0500565 ret = 0;
566 }
567 mutex_unlock(&hub->status_mutex);
568 return ret;
569}
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571static void kick_khubd(struct usb_hub *hub)
572{
573 unsigned long flags;
574
575 spin_lock_irqsave(&hub_event_lock, flags);
Roel Kluin2e2c5ee2007-10-26 23:54:35 +0200576 if (!hub->disconnected && list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 list_add_tail(&hub->event_list, &hub_event_list);
Alan Stern8e4ceb32009-12-07 13:01:37 -0500578
579 /* Suppress autosuspend until khubd runs */
580 usb_autopm_get_interface_no_resume(
581 to_usb_interface(hub->intfdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 wake_up(&khubd_wait);
583 }
584 spin_unlock_irqrestore(&hub_event_lock, flags);
585}
586
587void usb_kick_khubd(struct usb_device *hdev)
588{
Alan Stern251180842009-07-22 14:41:18 -0400589 struct usb_hub *hub = hdev_to_hub(hdev);
590
591 if (hub)
592 kick_khubd(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593}
594
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800595/*
596 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
597 * Notification, which indicates it had initiated remote wakeup.
598 *
599 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
600 * device initiates resume, so the USB core will not receive notice of the
601 * resume through the normal hub interrupt URB.
602 */
603void usb_wakeup_notification(struct usb_device *hdev,
604 unsigned int portnum)
605{
606 struct usb_hub *hub;
607
608 if (!hdev)
609 return;
610
611 hub = hdev_to_hub(hdev);
612 if (hub) {
613 set_bit(portnum, hub->wakeup_bits);
614 kick_khubd(hub);
615 }
616}
617EXPORT_SYMBOL_GPL(usb_wakeup_notification);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100620static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200622 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400623 int status = urb->status;
Roel Kluin71d27182009-03-13 12:19:18 +0100624 unsigned i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 unsigned long bits;
626
Alan Sterne0152682007-08-24 15:42:52 -0400627 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 case -ENOENT: /* synchronous unlink */
629 case -ECONNRESET: /* async unlink */
630 case -ESHUTDOWN: /* hardware going away */
631 return;
632
633 default: /* presumably an error */
634 /* Cause a hub reset after 10 consecutive errors */
Alan Sterne0152682007-08-24 15:42:52 -0400635 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if ((++hub->nerrors < 10) || hub->error)
637 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400638 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 /* let khubd handle things */
642 case 0: /* we got data: port status changed */
643 bits = 0;
644 for (i = 0; i < urb->actual_length; ++i)
645 bits |= ((unsigned long) ((*hub->buffer)[i]))
646 << (i*8);
647 hub->event_bits[0] = bits;
648 break;
649 }
650
651 hub->nerrors = 0;
652
653 /* Something happened, let khubd figure it out */
654 kick_khubd(hub);
655
656resubmit:
657 if (hub->quiescing)
658 return;
659
660 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
661 && status != -ENODEV && status != -EPERM)
662 dev_err (hub->intfdev, "resubmit --> %d\n", status);
663}
664
665/* USB 2.0 spec Section 11.24.2.3 */
666static inline int
667hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
668{
Alan Sternc2f65952009-11-18 11:37:15 -0500669 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
671 tt, NULL, 0, 1000);
672}
673
674/*
675 * enumeration blocks khubd for a long time. we use keventd instead, since
676 * long blocking there is the exception, not the rule. accordingly, HCDs
677 * talking to TTs must queue control transfers (not just bulk and iso), so
678 * both can talk to the same hub concurrently.
679 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400680static void hub_tt_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
David Howellsc4028952006-11-22 14:57:56 +0000682 struct usb_hub *hub =
Alan Sterncb88a1b2009-06-29 10:43:32 -0400683 container_of(work, struct usb_hub, tt.clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 unsigned long flags;
685
686 spin_lock_irqsave (&hub->tt.lock, flags);
Octavian Purdila3b6054d2012-10-01 22:21:12 +0300687 while (!list_empty(&hub->tt.clear_list)) {
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400688 struct list_head *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 struct usb_tt_clear *clear;
690 struct usb_device *hdev = hub->hdev;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400691 const struct hc_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 int status;
693
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400694 next = hub->tt.clear_list.next;
695 clear = list_entry (next, struct usb_tt_clear, clear_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 list_del (&clear->clear_list);
697
698 /* drop lock so HCD can concurrently report other TT errors */
699 spin_unlock_irqrestore (&hub->tt.lock, flags);
700 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 if (status)
702 dev_err (&hdev->dev,
703 "clear tt %d (%04x) error %d\n",
704 clear->tt, clear->devinfo, status);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400705
706 /* Tell the HCD, even if the operation failed */
707 drv = clear->hcd->driver;
708 if (drv->clear_tt_buffer_complete)
709 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
710
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700711 kfree(clear);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400712 spin_lock_irqsave(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 }
714 spin_unlock_irqrestore (&hub->tt.lock, flags);
715}
716
717/**
Alan Sterncb88a1b2009-06-29 10:43:32 -0400718 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
719 * @urb: an URB associated with the failed or incomplete split transaction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 *
721 * High speed HCDs use this to tell the hub driver that some split control or
722 * bulk transaction failed in a way that requires clearing internal state of
723 * a transaction translator. This is normally detected (and reported) from
724 * interrupt context.
725 *
726 * It may not be possible for that hub to handle additional full (or low)
727 * speed transactions until that state is fully cleared out.
728 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400729int usb_hub_clear_tt_buffer(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Alan Sterncb88a1b2009-06-29 10:43:32 -0400731 struct usb_device *udev = urb->dev;
732 int pipe = urb->pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 struct usb_tt *tt = udev->tt;
734 unsigned long flags;
735 struct usb_tt_clear *clear;
736
737 /* we've got to cope with an arbitrary number of pending TT clears,
738 * since each TT has "at least two" buffers that can need it (and
739 * there can be many TTs per hub). even if they're uncommon.
740 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800741 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
743 /* FIXME recover somehow ... RESET_TT? */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400744 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 }
746
747 /* info that CLEAR_TT_BUFFER needs */
748 clear->tt = tt->multi ? udev->ttport : 1;
749 clear->devinfo = usb_pipeendpoint (pipe);
750 clear->devinfo |= udev->devnum << 4;
751 clear->devinfo |= usb_pipecontrol (pipe)
752 ? (USB_ENDPOINT_XFER_CONTROL << 11)
753 : (USB_ENDPOINT_XFER_BULK << 11);
754 if (usb_pipein (pipe))
755 clear->devinfo |= 1 << 15;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400756
757 /* info for completion callback */
758 clear->hcd = bus_to_hcd(udev->bus);
759 clear->ep = urb->ep;
760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 /* tell keventd to clear state for this TT */
762 spin_lock_irqsave (&tt->lock, flags);
763 list_add_tail (&clear->clear_list, &tt->clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400764 schedule_work(&tt->clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 spin_unlock_irqrestore (&tt->lock, flags);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400766 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
Alan Sterncb88a1b2009-06-29 10:43:32 -0400768EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Alan Stern8520f382008-09-22 14:44:26 -0400770/* If do_delay is false, return the number of milliseconds the caller
771 * needs to delay.
772 */
773static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
775 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700776 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern8520f382008-09-22 14:44:26 -0400777 unsigned delay;
Alan Stern4489a572006-04-27 15:54:22 -0400778 u16 wHubCharacteristics =
779 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Alan Stern4489a572006-04-27 15:54:22 -0400781 /* Enable power on each port. Some hubs have reserved values
782 * of LPSM (> 2) in their descriptors, even though they are
783 * USB 2.0 hubs. Some hubs do not implement port-power switching
784 * but only emulate it. In all cases, the ports won't work
785 * unless we send these messages to the hub.
786 */
787 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400789 else
790 dev_dbg(hub->intfdev, "trying to enable port power on "
791 "non-switchable hub\n");
792 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
Greg Kroah-Hartmana0693bd2012-09-24 13:04:02 -0700793 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
David Brownellb7896962005-08-31 10:41:44 -0700795 /* Wait at least 100 msec for power to become stable */
Alan Stern8520f382008-09-22 14:44:26 -0400796 delay = max(pgood_delay, (unsigned) 100);
797 if (do_delay)
798 msleep(delay);
799 return delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802static int hub_hub_status(struct usb_hub *hub,
803 u16 *status, u16 *change)
804{
805 int ret;
806
Alan Sterndb90e7a2007-02-05 09:56:15 -0500807 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 ret = get_hub_status(hub->hdev, &hub->status->hub);
809 if (ret < 0)
810 dev_err (hub->intfdev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800811 "%s failed (err = %d)\n", __func__, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 else {
813 *status = le16_to_cpu(hub->status->hub.wHubStatus);
814 *change = le16_to_cpu(hub->status->hub.wHubChange);
815 ret = 0;
816 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500817 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 return ret;
819}
820
Sarah Sharp41e7e052012-11-14 16:42:32 -0800821static int hub_set_port_link_state(struct usb_hub *hub, int port1,
822 unsigned int link_status)
823{
824 return set_port_feature(hub->hdev,
825 port1 | (link_status << 3),
826 USB_PORT_FEAT_LINK_STATE);
827}
828
829/*
830 * If USB 3.0 ports are placed into the Disabled state, they will no longer
831 * detect any device connects or disconnects. This is generally not what the
832 * USB core wants, since it expects a disabled port to produce a port status
833 * change event when a new device connects.
834 *
835 * Instead, set the link state to Disabled, wait for the link to settle into
836 * that state, clear any change bits, and then put the port into the RxDetect
837 * state.
838 */
839static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
840{
841 int ret;
842 int total_time;
843 u16 portchange, portstatus;
844
845 if (!hub_is_superspeed(hub->hdev))
846 return -EINVAL;
847
848 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
849 if (ret) {
850 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
851 port1, ret);
852 return ret;
853 }
854
855 /* Wait for the link to enter the disabled state. */
856 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
857 ret = hub_port_status(hub, port1, &portstatus, &portchange);
858 if (ret < 0)
859 return ret;
860
861 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
862 USB_SS_PORT_LS_SS_DISABLED)
863 break;
864 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
865 break;
866 msleep(HUB_DEBOUNCE_STEP);
867 }
868 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
869 dev_warn(hub->intfdev, "Could not disable port %d after %d ms\n",
870 port1, total_time);
871
872 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
873}
874
Alan Stern8b28c752005-08-10 17:04:13 -0400875static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
876{
877 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400878 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400879
Lan Tianyuff823c72012-09-05 13:44:32 +0800880 if (hub->ports[port1 - 1]->child && set_state)
881 usb_set_device_state(hub->ports[port1 - 1]->child,
Alan Stern8b28c752005-08-10 17:04:13 -0400882 USB_STATE_NOTATTACHED);
Sarah Sharp41e7e052012-11-14 16:42:32 -0800883 if (!hub->error) {
884 if (hub_is_superspeed(hub->hdev))
885 ret = hub_usb3_port_disable(hub, port1);
886 else
887 ret = clear_port_feature(hdev, port1,
888 USB_PORT_FEAT_ENABLE);
889 }
Alan Stern8b28c752005-08-10 17:04:13 -0400890 if (ret)
891 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
Alan Stern0458d5b2007-05-04 11:52:20 -0400892 port1, ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400893 return ret;
894}
895
Alan Stern0458d5b2007-05-04 11:52:20 -0400896/*
Justin P. Mattock6d42fcd2011-02-26 20:33:56 -0800897 * Disable a port and mark a logical connect-change event, so that some
Alan Stern0458d5b2007-05-04 11:52:20 -0400898 * time later khubd will disconnect() any existing usb_device on the port
899 * and will re-enumerate if there actually is a device attached.
900 */
901static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
902{
903 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
904 hub_port_disable(hub, port1, 1);
905
906 /* FIXME let caller ask to power down the port:
907 * - some devices won't enumerate without a VBUS power cycle
908 * - SRP saves power that way
909 * - ... new call, TBD ...
910 * That's easy if this hub can switch power per-port, and
911 * khubd reactivates the port later (timer, SRP, etc).
912 * Powerdown must be optional, because of reset/DFU.
913 */
914
915 set_bit(port1, hub->change_bits);
916 kick_khubd(hub);
917}
918
Alan Stern253e0572009-10-27 15:20:13 -0400919/**
920 * usb_remove_device - disable a device's port on its parent hub
921 * @udev: device to be disabled and removed
922 * Context: @udev locked, must be able to sleep.
923 *
924 * After @udev's port has been disabled, khubd is notified and it will
925 * see that the device has been disconnected. When the device is
926 * physically unplugged and something is plugged in, the events will
927 * be received and processed normally.
928 */
929int usb_remove_device(struct usb_device *udev)
930{
931 struct usb_hub *hub;
932 struct usb_interface *intf;
933
934 if (!udev->parent) /* Can't remove a root hub */
935 return -EINVAL;
936 hub = hdev_to_hub(udev->parent);
937 intf = to_usb_interface(hub->intfdev);
938
939 usb_autopm_get_interface(intf);
940 set_bit(udev->portnum, hub->removed_bits);
941 hub_port_logical_disconnect(hub, udev->portnum);
942 usb_autopm_put_interface(intf);
943 return 0;
944}
945
Alan Stern6ee0b272008-04-28 11:06:42 -0400946enum hub_activation_type {
Alan Stern8e4ceb32009-12-07 13:01:37 -0500947 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
Alan Stern8520f382008-09-22 14:44:26 -0400948 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
Alan Stern6ee0b272008-04-28 11:06:42 -0400949};
Alan Stern5e6effa2008-03-03 15:15:51 -0500950
Alan Stern8520f382008-09-22 14:44:26 -0400951static void hub_init_func2(struct work_struct *ws);
952static void hub_init_func3(struct work_struct *ws);
953
Alan Sternf2835212008-04-28 11:07:17 -0400954static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
Alan Stern5e6effa2008-03-03 15:15:51 -0500955{
956 struct usb_device *hdev = hub->hdev;
Sarah Sharp653a39d2010-12-23 11:12:42 -0800957 struct usb_hcd *hcd;
958 int ret;
Alan Stern5e6effa2008-03-03 15:15:51 -0500959 int port1;
Alan Sternf2835212008-04-28 11:07:17 -0400960 int status;
Alan Stern948fea32008-04-28 11:07:07 -0400961 bool need_debounce_delay = false;
Alan Stern8520f382008-09-22 14:44:26 -0400962 unsigned delay;
963
964 /* Continue a partial initialization */
965 if (type == HUB_INIT2)
966 goto init2;
967 if (type == HUB_INIT3)
968 goto init3;
Alan Stern5e6effa2008-03-03 15:15:51 -0500969
Elric Fua45aa3b2012-02-18 13:32:27 +0800970 /* The superspeed hub except for root hub has to use Hub Depth
971 * value as an offset into the route string to locate the bits
972 * it uses to determine the downstream port number. So hub driver
973 * should send a set hub depth request to superspeed hub after
974 * the superspeed hub is set configuration in initialization or
975 * reset procedure.
976 *
977 * After a resume, port power should still be on.
Alan Sternf2835212008-04-28 11:07:17 -0400978 * For any other type of activation, turn it on.
979 */
Alan Stern8520f382008-09-22 14:44:26 -0400980 if (type != HUB_RESUME) {
Elric Fua45aa3b2012-02-18 13:32:27 +0800981 if (hdev->parent && hub_is_superspeed(hdev)) {
982 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
983 HUB_SET_DEPTH, USB_RT_HUB,
984 hdev->level - 1, 0, NULL, 0,
985 USB_CTRL_SET_TIMEOUT);
986 if (ret < 0)
987 dev_err(hub->intfdev,
988 "set hub depth failed\n");
989 }
Alan Stern8520f382008-09-22 14:44:26 -0400990
991 /* Speed up system boot by using a delayed_work for the
992 * hub's initial power-up delays. This is pretty awkward
993 * and the implementation looks like a home-brewed sort of
994 * setjmp/longjmp, but it saves at least 100 ms for each
995 * root hub (assuming usbcore is compiled into the kernel
996 * rather than as a module). It adds up.
997 *
998 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
999 * because for those activation types the ports have to be
1000 * operational when we return. In theory this could be done
1001 * for HUB_POST_RESET, but it's easier not to.
1002 */
1003 if (type == HUB_INIT) {
1004 delay = hub_power_on(hub, false);
1005 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
1006 schedule_delayed_work(&hub->init_work,
1007 msecs_to_jiffies(delay));
Alan Stern61fbeba2008-10-27 12:07:44 -04001008
1009 /* Suppress autosuspend until init is done */
Alan Stern8e4ceb32009-12-07 13:01:37 -05001010 usb_autopm_get_interface_no_resume(
1011 to_usb_interface(hub->intfdev));
Alan Stern8520f382008-09-22 14:44:26 -04001012 return; /* Continues at init2: below */
Sarah Sharp653a39d2010-12-23 11:12:42 -08001013 } else if (type == HUB_RESET_RESUME) {
1014 /* The internal host controller state for the hub device
1015 * may be gone after a host power loss on system resume.
1016 * Update the device's info so the HW knows it's a hub.
1017 */
1018 hcd = bus_to_hcd(hdev->bus);
1019 if (hcd->driver->update_hub_device) {
1020 ret = hcd->driver->update_hub_device(hcd, hdev,
1021 &hub->tt, GFP_NOIO);
1022 if (ret < 0) {
1023 dev_err(hub->intfdev, "Host not "
1024 "accepting hub info "
1025 "update.\n");
1026 dev_err(hub->intfdev, "LS/FS devices "
1027 "and hubs may not work "
1028 "under this hub\n.");
1029 }
1030 }
1031 hub_power_on(hub, true);
Alan Stern8520f382008-09-22 14:44:26 -04001032 } else {
1033 hub_power_on(hub, true);
1034 }
1035 }
1036 init2:
Alan Sternf2835212008-04-28 11:07:17 -04001037
Alan Stern6ee0b272008-04-28 11:06:42 -04001038 /* Check each port and set hub->change_bits to let khubd know
1039 * which ports need attention.
Alan Stern5e6effa2008-03-03 15:15:51 -05001040 */
1041 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001042 struct usb_device *udev = hub->ports[port1 - 1]->child;
Alan Stern5e6effa2008-03-03 15:15:51 -05001043 u16 portstatus, portchange;
1044
Alan Stern6ee0b272008-04-28 11:06:42 -04001045 portstatus = portchange = 0;
1046 status = hub_port_status(hub, port1, &portstatus, &portchange);
1047 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1048 dev_dbg(hub->intfdev,
1049 "port %d: status %04x change %04x\n",
1050 port1, portstatus, portchange);
Alan Stern5e6effa2008-03-03 15:15:51 -05001051
Alan Stern6ee0b272008-04-28 11:06:42 -04001052 /* After anything other than HUB_RESUME (i.e., initialization
1053 * or any sort of reset), every port should be disabled.
1054 * Unconnected ports should likewise be disabled (paranoia),
1055 * and so should ports for which we have no usb_device.
Alan Stern5e6effa2008-03-03 15:15:51 -05001056 */
Alan Stern6ee0b272008-04-28 11:06:42 -04001057 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1058 type != HUB_RESUME ||
1059 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1060 !udev ||
1061 udev->state == USB_STATE_NOTATTACHED)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001062 /*
1063 * USB3 protocol ports will automatically transition
1064 * to Enabled state when detect an USB3.0 device attach.
1065 * Do not disable USB3 protocol ports.
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001066 */
Sarah Sharp131dec32010-12-06 21:00:19 -08001067 if (!hub_is_superspeed(hdev)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001068 clear_port_feature(hdev, port1,
1069 USB_PORT_FEAT_ENABLE);
1070 portstatus &= ~USB_PORT_STAT_ENABLE;
Sarah Sharp85f0ff42010-10-14 07:22:54 -07001071 } else {
1072 /* Pretend that power was lost for USB3 devs */
1073 portstatus &= ~USB_PORT_STAT_ENABLE;
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001074 }
Alan Stern6ee0b272008-04-28 11:06:42 -04001075 }
1076
Alan Stern948fea32008-04-28 11:07:07 -04001077 /* Clear status-change flags; we'll debounce later */
1078 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1079 need_debounce_delay = true;
1080 clear_port_feature(hub->hdev, port1,
1081 USB_PORT_FEAT_C_CONNECTION);
1082 }
1083 if (portchange & USB_PORT_STAT_C_ENABLE) {
1084 need_debounce_delay = true;
1085 clear_port_feature(hub->hdev, port1,
1086 USB_PORT_FEAT_C_ENABLE);
1087 }
Don Zickus79c3dd82011-11-03 09:07:18 -04001088 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1089 hub_is_superspeed(hub->hdev)) {
1090 need_debounce_delay = true;
1091 clear_port_feature(hub->hdev, port1,
1092 USB_PORT_FEAT_C_BH_PORT_RESET);
1093 }
Alan Stern253e0572009-10-27 15:20:13 -04001094 /* We can forget about a "removed" device when there's a
1095 * physical disconnect or the connect status changes.
1096 */
1097 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1098 (portchange & USB_PORT_STAT_C_CONNECTION))
1099 clear_bit(port1, hub->removed_bits);
1100
Alan Stern6ee0b272008-04-28 11:06:42 -04001101 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1102 /* Tell khubd to disconnect the device or
1103 * check for a new connection
1104 */
1105 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1106 set_bit(port1, hub->change_bits);
1107
1108 } else if (portstatus & USB_PORT_STAT_ENABLE) {
Sarah Sharp72937e12012-01-24 11:46:50 -08001109 bool port_resumed = (portstatus &
1110 USB_PORT_STAT_LINK_STATE) ==
1111 USB_SS_PORT_LS_U0;
Alan Stern6ee0b272008-04-28 11:06:42 -04001112 /* The power session apparently survived the resume.
1113 * If there was an overcurrent or suspend change
1114 * (i.e., remote wakeup request), have khubd
Sarah Sharp72937e12012-01-24 11:46:50 -08001115 * take care of it. Look at the port link state
1116 * for USB 3.0 hubs, since they don't have a suspend
1117 * change bit, and they don't set the port link change
1118 * bit on device-initiated resume.
Alan Stern6ee0b272008-04-28 11:06:42 -04001119 */
Sarah Sharp72937e12012-01-24 11:46:50 -08001120 if (portchange || (hub_is_superspeed(hub->hdev) &&
1121 port_resumed))
Alan Stern6ee0b272008-04-28 11:06:42 -04001122 set_bit(port1, hub->change_bits);
1123
1124 } else if (udev->persist_enabled) {
Alan Stern6ee0b272008-04-28 11:06:42 -04001125#ifdef CONFIG_PM
Alan Stern5e6effa2008-03-03 15:15:51 -05001126 udev->reset_resume = 1;
Alan Stern6ee0b272008-04-28 11:06:42 -04001127#endif
Alan Stern8808f002008-04-28 11:06:55 -04001128 set_bit(port1, hub->change_bits);
1129
Alan Stern6ee0b272008-04-28 11:06:42 -04001130 } else {
1131 /* The power session is gone; tell khubd */
1132 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1133 set_bit(port1, hub->change_bits);
Alan Stern5e6effa2008-03-03 15:15:51 -05001134 }
Alan Stern5e6effa2008-03-03 15:15:51 -05001135 }
1136
Alan Stern948fea32008-04-28 11:07:07 -04001137 /* If no port-status-change flags were set, we don't need any
1138 * debouncing. If flags were set we can try to debounce the
1139 * ports all at once right now, instead of letting khubd do them
1140 * one at a time later on.
1141 *
1142 * If any port-status changes do occur during this delay, khubd
1143 * will see them later and handle them normally.
1144 */
Alan Stern8520f382008-09-22 14:44:26 -04001145 if (need_debounce_delay) {
1146 delay = HUB_DEBOUNCE_STABLE;
Alan Sternf2835212008-04-28 11:07:17 -04001147
Alan Stern8520f382008-09-22 14:44:26 -04001148 /* Don't do a long sleep inside a workqueue routine */
1149 if (type == HUB_INIT2) {
1150 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
1151 schedule_delayed_work(&hub->init_work,
1152 msecs_to_jiffies(delay));
1153 return; /* Continues at init3: below */
1154 } else {
1155 msleep(delay);
1156 }
1157 }
1158 init3:
Alan Sternf2835212008-04-28 11:07:17 -04001159 hub->quiescing = 0;
1160
1161 status = usb_submit_urb(hub->urb, GFP_NOIO);
1162 if (status < 0)
1163 dev_err(hub->intfdev, "activate --> %d\n", status);
1164 if (hub->has_indicators && blinkenlights)
1165 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
1166
1167 /* Scan all ports that need attention */
1168 kick_khubd(hub);
Alan Stern8e4ceb32009-12-07 13:01:37 -05001169
1170 /* Allow autosuspend if it was suppressed */
1171 if (type <= HUB_INIT3)
1172 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
Alan Stern5e6effa2008-03-03 15:15:51 -05001173}
1174
Alan Stern8520f382008-09-22 14:44:26 -04001175/* Implement the continuations for the delays above */
1176static void hub_init_func2(struct work_struct *ws)
1177{
1178 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1179
1180 hub_activate(hub, HUB_INIT2);
1181}
1182
1183static void hub_init_func3(struct work_struct *ws)
1184{
1185 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1186
1187 hub_activate(hub, HUB_INIT3);
1188}
1189
Alan Stern43303542008-04-28 11:07:31 -04001190enum hub_quiescing_type {
1191 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1192};
1193
1194static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1195{
1196 struct usb_device *hdev = hub->hdev;
1197 int i;
1198
Alan Stern8520f382008-09-22 14:44:26 -04001199 cancel_delayed_work_sync(&hub->init_work);
1200
Alan Stern43303542008-04-28 11:07:31 -04001201 /* khubd and related activity won't re-trigger */
1202 hub->quiescing = 1;
1203
1204 if (type != HUB_SUSPEND) {
1205 /* Disconnect all the children */
1206 for (i = 0; i < hdev->maxchild; ++i) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001207 if (hub->ports[i]->child)
1208 usb_disconnect(&hub->ports[i]->child);
Alan Stern43303542008-04-28 11:07:31 -04001209 }
1210 }
1211
1212 /* Stop khubd and related activity */
1213 usb_kill_urb(hub->urb);
1214 if (hub->has_indicators)
1215 cancel_delayed_work_sync(&hub->leds);
1216 if (hub->tt.hub)
Octavian Purdila036546b2012-10-23 11:33:12 +03001217 flush_work(&hub->tt.clear_work);
Alan Stern43303542008-04-28 11:07:31 -04001218}
1219
Alan Stern3eb14912008-03-03 15:15:43 -05001220/* caller has locked the hub device */
1221static int hub_pre_reset(struct usb_interface *intf)
1222{
1223 struct usb_hub *hub = usb_get_intfdata(intf);
1224
Alan Stern43303542008-04-28 11:07:31 -04001225 hub_quiesce(hub, HUB_PRE_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -04001226 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001227}
1228
1229/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -04001230static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -05001231{
Alan Stern7de18d82006-06-01 13:37:24 -04001232 struct usb_hub *hub = usb_get_intfdata(intf);
1233
Alan Sternf2835212008-04-28 11:07:17 -04001234 hub_activate(hub, HUB_POST_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -04001235 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001236}
1237
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238static int hub_configure(struct usb_hub *hub,
1239 struct usb_endpoint_descriptor *endpoint)
1240{
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001241 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 struct usb_device *hdev = hub->hdev;
1243 struct device *hub_dev = hub->intfdev;
1244 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001245 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 unsigned int pipe;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001247 int maxp, ret, i;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001248 char *message = "out of memory";
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001249 unsigned unit_load;
1250 unsigned full_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
Alan Sternd697cdd2009-10-27 15:18:46 -04001252 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 if (!hub->buffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 ret = -ENOMEM;
1255 goto fail;
1256 }
1257
1258 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1259 if (!hub->status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 ret = -ENOMEM;
1261 goto fail;
1262 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001263 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
1265 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1266 if (!hub->descriptor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 ret = -ENOMEM;
1268 goto fail;
1269 }
1270
1271 /* Request the entire hub descriptor.
1272 * hub->descriptor can handle USB_MAXCHILDREN ports,
1273 * but the hub can/will return fewer bytes here.
1274 */
John Youndbe79bb2001-09-17 00:00:00 -07001275 ret = get_hub_descriptor(hdev, hub->descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 if (ret < 0) {
1277 message = "can't read hub descriptor";
1278 goto fail;
1279 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1280 message = "hub has too many ports!";
1281 ret = -ENODEV;
1282 goto fail;
1283 }
1284
1285 hdev->maxchild = hub->descriptor->bNbrPorts;
1286 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1287 (hdev->maxchild == 1) ? "" : "s");
1288
Lan Tianyufa2a9562012-09-05 13:44:31 +08001289 hub->ports = kzalloc(hdev->maxchild * sizeof(struct usb_port *),
1290 GFP_KERNEL);
Lan Tianyuff823c72012-09-05 13:44:32 +08001291 if (!hub->ports) {
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001292 ret = -ENOMEM;
1293 goto fail;
1294 }
1295
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001296 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001297 if (hub_is_superspeed(hdev)) {
1298 unit_load = 150;
1299 full_load = 900;
1300 } else {
1301 unit_load = 100;
1302 full_load = 500;
1303 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
John Youndbe79bb2001-09-17 00:00:00 -07001305 /* FIXME for USB 3.0, skip for now */
1306 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1307 !(hub_is_superspeed(hdev))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 int i;
1309 char portstr [USB_MAXCHILDREN + 1];
1310
1311 for (i = 0; i < hdev->maxchild; i++)
John Youndbe79bb2001-09-17 00:00:00 -07001312 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1314 ? 'F' : 'R';
1315 portstr[hdev->maxchild] = 0;
1316 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1317 } else
1318 dev_dbg(hub_dev, "standalone hub\n");
1319
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001320 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301321 case HUB_CHAR_COMMON_LPSM:
1322 dev_dbg(hub_dev, "ganged power switching\n");
1323 break;
1324 case HUB_CHAR_INDV_PORT_LPSM:
1325 dev_dbg(hub_dev, "individual port power switching\n");
1326 break;
1327 case HUB_CHAR_NO_LPSM:
1328 case HUB_CHAR_LPSM:
1329 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1330 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 }
1332
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001333 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301334 case HUB_CHAR_COMMON_OCPM:
1335 dev_dbg(hub_dev, "global over-current protection\n");
1336 break;
1337 case HUB_CHAR_INDV_PORT_OCPM:
1338 dev_dbg(hub_dev, "individual port over-current protection\n");
1339 break;
1340 case HUB_CHAR_NO_OCPM:
1341 case HUB_CHAR_OCPM:
1342 dev_dbg(hub_dev, "no over-current protection\n");
1343 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 }
1345
1346 spin_lock_init (&hub->tt.lock);
1347 INIT_LIST_HEAD (&hub->tt.clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -04001348 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 switch (hdev->descriptor.bDeviceProtocol) {
Aman Deep7bf01182011-12-08 12:05:22 +05301350 case USB_HUB_PR_FS:
1351 break;
1352 case USB_HUB_PR_HS_SINGLE_TT:
1353 dev_dbg(hub_dev, "Single TT\n");
1354 hub->tt.hub = hdev;
1355 break;
1356 case USB_HUB_PR_HS_MULTI_TT:
1357 ret = usb_set_interface(hdev, 0, 1);
1358 if (ret == 0) {
1359 dev_dbg(hub_dev, "TT per port\n");
1360 hub->tt.multi = 1;
1361 } else
1362 dev_err(hub_dev, "Using single TT (err %d)\n",
1363 ret);
1364 hub->tt.hub = hdev;
1365 break;
1366 case USB_HUB_PR_SS:
1367 /* USB 3.0 hubs don't have a TT */
1368 break;
1369 default:
1370 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1371 hdev->descriptor.bDeviceProtocol);
1372 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001375 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001376 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001377 case HUB_TTTT_8_BITS:
1378 if (hdev->descriptor.bDeviceProtocol != 0) {
1379 hub->tt.think_time = 666;
1380 dev_dbg(hub_dev, "TT requires at most %d "
1381 "FS bit times (%d ns)\n",
1382 8, hub->tt.think_time);
1383 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001385 case HUB_TTTT_16_BITS:
1386 hub->tt.think_time = 666 * 2;
1387 dev_dbg(hub_dev, "TT requires at most %d "
1388 "FS bit times (%d ns)\n",
1389 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001391 case HUB_TTTT_24_BITS:
1392 hub->tt.think_time = 666 * 3;
1393 dev_dbg(hub_dev, "TT requires at most %d "
1394 "FS bit times (%d ns)\n",
1395 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001397 case HUB_TTTT_32_BITS:
1398 hub->tt.think_time = 666 * 4;
1399 dev_dbg(hub_dev, "TT requires at most %d "
1400 "FS bit times (%d ns)\n",
1401 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 break;
1403 }
1404
1405 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001406 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 hub->has_indicators = 1;
1408 dev_dbg(hub_dev, "Port indicators are supported\n");
1409 }
1410
1411 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1412 hub->descriptor->bPwrOn2PwrGood * 2);
1413
1414 /* power budgeting mostly matters with bus-powered hubs,
1415 * and battery-powered root hubs (may provide just 8 mA).
1416 */
1417 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -05001418 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 message = "can't get hub status";
1420 goto fail;
1421 }
Alan Stern7d35b922005-04-25 11:18:32 -04001422 le16_to_cpus(&hubstatus);
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001423 hcd = bus_to_hcd(hdev->bus);
Alan Stern7d35b922005-04-25 11:18:32 -04001424 if (hdev == hdev->bus->root_hub) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001425 if (hcd->power_budget > 0)
1426 hdev->bus_mA = hcd->power_budget;
1427 else
1428 hdev->bus_mA = full_load * hdev->maxchild;
1429 if (hdev->bus_mA >= full_load)
1430 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001431 else {
1432 hub->mA_per_port = hdev->bus_mA;
1433 hub->limited_power = 1;
1434 }
Alan Stern7d35b922005-04-25 11:18:32 -04001435 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001436 int remaining = hdev->bus_mA -
1437 hub->descriptor->bHubContrCurrent;
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1440 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -05001441 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001443 if (remaining < hdev->maxchild * unit_load)
1444 dev_warn(hub_dev,
Alan Stern55c52712005-11-23 12:03:12 -05001445 "insufficient power available "
1446 "to use all downstream ports\n");
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001447 hub->mA_per_port = unit_load; /* 7.2.1 */
1448
Alan Stern55c52712005-11-23 12:03:12 -05001449 } else { /* Self-powered external hub */
1450 /* FIXME: What about battery-powered external hubs that
1451 * provide less current per port? */
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001452 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001453 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001454 if (hub->mA_per_port < full_load)
Alan Stern55c52712005-11-23 12:03:12 -05001455 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1456 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001458 /* Update the HCD's internal representation of this hub before khubd
1459 * starts getting port status changes for devices under the hub.
1460 */
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001461 if (hcd->driver->update_hub_device) {
1462 ret = hcd->driver->update_hub_device(hcd, hdev,
1463 &hub->tt, GFP_KERNEL);
1464 if (ret < 0) {
1465 message = "can't update HCD hub info";
1466 goto fail;
1467 }
1468 }
1469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1471 if (ret < 0) {
1472 message = "can't get hub status";
1473 goto fail;
1474 }
1475
1476 /* local power status reports aren't always correct */
1477 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1478 dev_dbg(hub_dev, "local power source is %s\n",
1479 (hubstatus & HUB_STATUS_LOCAL_POWER)
1480 ? "lost (inactive)" : "good");
1481
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001482 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 dev_dbg(hub_dev, "%sover-current condition exists\n",
1484 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1485
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -07001486 /* set up the interrupt endpoint
1487 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1488 * bytes as USB2.0[11.12.3] says because some hubs are known
1489 * to send more data (and thus cause overflow). For root hubs,
1490 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1491 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1493 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1494
1495 if (maxp > sizeof(*hub->buffer))
1496 maxp = sizeof(*hub->buffer);
1497
1498 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1499 if (!hub->urb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 ret = -ENOMEM;
1501 goto fail;
1502 }
1503
1504 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1505 hub, endpoint->bInterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
1507 /* maybe cycle the hub leds */
1508 if (hub->has_indicators && blinkenlights)
1509 hub->indicator [0] = INDICATOR_CYCLE;
1510
Lan Tianyufa2a9562012-09-05 13:44:31 +08001511 for (i = 0; i < hdev->maxchild; i++)
1512 if (usb_hub_create_port_device(hub, i + 1) < 0)
1513 dev_err(hub->intfdev,
1514 "couldn't create port%d device.\n", i + 1);
1515
Lan Tianyud2123fd2013-01-21 22:18:00 +08001516 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1517
Alan Sternf2835212008-04-28 11:07:17 -04001518 hub_activate(hub, HUB_INIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 return 0;
1520
1521fail:
1522 dev_err (hub_dev, "config failed, %s (err %d)\n",
1523 message, ret);
1524 /* hub_disconnect() frees urb and descriptor */
1525 return ret;
1526}
1527
Alan Sterne8054852007-05-04 11:55:11 -04001528static void hub_release(struct kref *kref)
1529{
1530 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1531
1532 usb_put_intf(to_usb_interface(hub->intfdev));
1533 kfree(hub);
1534}
1535
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536static unsigned highspeed_hubs;
1537
1538static void hub_disconnect(struct usb_interface *intf)
1539{
Huajun Li88162302012-03-12 21:00:19 +08001540 struct usb_hub *hub = usb_get_intfdata(intf);
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07001541 struct usb_device *hdev = interface_to_usbdev(intf);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001542 int i;
1543
Alan Sterne8054852007-05-04 11:55:11 -04001544 /* Take the hub off the event list and don't let it be added again */
1545 spin_lock_irq(&hub_event_lock);
Alan Stern8e4ceb32009-12-07 13:01:37 -05001546 if (!list_empty(&hub->event_list)) {
1547 list_del_init(&hub->event_list);
1548 usb_autopm_put_interface_no_suspend(intf);
1549 }
Alan Sterne8054852007-05-04 11:55:11 -04001550 hub->disconnected = 1;
1551 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Alan Stern7de18d82006-06-01 13:37:24 -04001553 /* Disconnect all children and quiesce the hub */
1554 hub->error = 0;
Alan Stern43303542008-04-28 11:07:31 -04001555 hub_quiesce(hub, HUB_DISCONNECT);
Alan Stern7de18d82006-06-01 13:37:24 -04001556
Alan Stern8b28c752005-08-10 17:04:13 -04001557 usb_set_intfdata (intf, NULL);
Alexander Shishkin1f2235b2012-09-12 14:48:31 +03001558
1559 for (i = 0; i < hdev->maxchild; i++)
1560 usb_hub_remove_port_device(hub, i + 1);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001561 hub->hdev->maxchild = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Alan Sterne8054852007-05-04 11:55:11 -04001563 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 highspeed_hubs--;
1565
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 usb_free_urb(hub->urb);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001567 kfree(hub->ports);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001568 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001569 kfree(hub->status);
Alan Sternd697cdd2009-10-27 15:18:46 -04001570 kfree(hub->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Alan Sterne8054852007-05-04 11:55:11 -04001572 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573}
1574
1575static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1576{
1577 struct usb_host_interface *desc;
1578 struct usb_endpoint_descriptor *endpoint;
1579 struct usb_device *hdev;
1580 struct usb_hub *hub;
1581
1582 desc = intf->cur_altsetting;
1583 hdev = interface_to_usbdev(intf);
1584
Ming Lei596d7892012-10-24 11:59:25 +08001585 /*
1586 * Set default autosuspend delay as 0 to speedup bus suspend,
1587 * based on the below considerations:
1588 *
1589 * - Unlike other drivers, the hub driver does not rely on the
1590 * autosuspend delay to provide enough time to handle a wakeup
1591 * event, and the submitted status URB is just to check future
1592 * change on hub downstream ports, so it is safe to do it.
1593 *
1594 * - The patch might cause one or more auto supend/resume for
1595 * below very rare devices when they are plugged into hub
1596 * first time:
1597 *
1598 * devices having trouble initializing, and disconnect
1599 * themselves from the bus and then reconnect a second
1600 * or so later
1601 *
1602 * devices just for downloading firmware, and disconnects
1603 * themselves after completing it
1604 *
1605 * For these quite rare devices, their drivers may change the
1606 * autosuspend delay of their parent hub in the probe() to one
1607 * appropriate value to avoid the subtle problem if someone
1608 * does care it.
1609 *
1610 * - The patch may cause one or more auto suspend/resume on
1611 * hub during running 'lsusb', but it is probably too
1612 * infrequent to worry about.
1613 *
1614 * - Change autosuspend delay of hub can avoid unnecessary auto
1615 * suspend timer for hub, also may decrease power consumption
1616 * of USB bus.
1617 */
1618 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1619
Sarah Sharp2839f5b2012-01-06 16:27:25 -08001620 /* Hubs have proper suspend/resume support. */
1621 usb_enable_autosuspend(hdev);
Alan Stern088f7fe2010-01-08 12:56:54 -05001622
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001623 if (hdev->level == MAX_TOPO_LEVEL) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001624 dev_err(&intf->dev,
1625 "Unsupported bus topology: hub nested too deep\n");
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001626 return -E2BIG;
1627 }
1628
David Brownell89ccbdc2006-04-02 10:18:09 -08001629#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1630 if (hdev->parent) {
1631 dev_warn(&intf->dev, "ignoring external hub\n");
1632 return -ENODEV;
1633 }
1634#endif
1635
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 /* Some hubs have a subclass of 1, which AFAICT according to the */
1637 /* specs is not defined, but it works */
1638 if ((desc->desc.bInterfaceSubClass != 0) &&
1639 (desc->desc.bInterfaceSubClass != 1)) {
1640descriptor_error:
1641 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1642 return -EIO;
1643 }
1644
1645 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1646 if (desc->desc.bNumEndpoints != 1)
1647 goto descriptor_error;
1648
1649 endpoint = &desc->endpoint[0].desc;
1650
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -07001651 /* If it's not an interrupt in endpoint, we'd better punt! */
1652 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 goto descriptor_error;
1654
1655 /* We found a hub */
1656 dev_info (&intf->dev, "USB hub found\n");
1657
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001658 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 if (!hub) {
1660 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1661 return -ENOMEM;
1662 }
1663
Alan Sterne8054852007-05-04 11:55:11 -04001664 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 INIT_LIST_HEAD(&hub->event_list);
1666 hub->intfdev = &intf->dev;
1667 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001668 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Stern8520f382008-09-22 14:44:26 -04001669 INIT_DELAYED_WORK(&hub->init_work, NULL);
Alan Sterne8054852007-05-04 11:55:11 -04001670 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
1672 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001673 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
1675 if (hdev->speed == USB_SPEED_HIGH)
1676 highspeed_hubs++;
1677
Ming Leie6f30de2012-10-24 11:59:24 +08001678 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1679 hub->quirk_check_port_auto_suspend = 1;
1680
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 if (hub_configure(hub, endpoint) >= 0)
1682 return 0;
1683
1684 hub_disconnect (intf);
1685 return -ENODEV;
1686}
1687
1688static int
1689hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1690{
1691 struct usb_device *hdev = interface_to_usbdev (intf);
Lan Tianyuff823c72012-09-05 13:44:32 +08001692 struct usb_hub *hub = hdev_to_hub(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
1694 /* assert ifno == 0 (part of hub spec) */
1695 switch (code) {
1696 case USBDEVFS_HUB_PORTINFO: {
1697 struct usbdevfs_hub_portinfo *info = user_data;
1698 int i;
1699
1700 spin_lock_irq(&device_state_lock);
1701 if (hdev->devnum <= 0)
1702 info->nports = 0;
1703 else {
1704 info->nports = hdev->maxchild;
1705 for (i = 0; i < info->nports; i++) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001706 if (hub->ports[i]->child == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 info->port[i] = 0;
1708 else
1709 info->port[i] =
Lan Tianyuff823c72012-09-05 13:44:32 +08001710 hub->ports[i]->child->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 }
1712 }
1713 spin_unlock_irq(&device_state_lock);
1714
1715 return info->nports + 1;
1716 }
1717
1718 default:
1719 return -ENOSYS;
1720 }
1721}
1722
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001723/*
1724 * Allow user programs to claim ports on a hub. When a device is attached
1725 * to one of these "claimed" ports, the program will "own" the device.
1726 */
1727static int find_port_owner(struct usb_device *hdev, unsigned port1,
Lan Tianyu336c5c32012-07-06 14:13:52 +08001728 struct dev_state ***ppowner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001729{
1730 if (hdev->state == USB_STATE_NOTATTACHED)
1731 return -ENODEV;
1732 if (port1 == 0 || port1 > hdev->maxchild)
1733 return -EINVAL;
1734
1735 /* This assumes that devices not managed by the hub driver
1736 * will always have maxchild equal to 0.
1737 */
Lan Tianyufa2a9562012-09-05 13:44:31 +08001738 *ppowner = &(hdev_to_hub(hdev)->ports[port1 - 1]->port_owner);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001739 return 0;
1740}
1741
1742/* In the following three functions, the caller must hold hdev's lock */
Lan Tianyu336c5c32012-07-06 14:13:52 +08001743int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1744 struct dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001745{
1746 int rc;
Lan Tianyu336c5c32012-07-06 14:13:52 +08001747 struct dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001748
1749 rc = find_port_owner(hdev, port1, &powner);
1750 if (rc)
1751 return rc;
1752 if (*powner)
1753 return -EBUSY;
1754 *powner = owner;
1755 return rc;
1756}
1757
Lan Tianyu336c5c32012-07-06 14:13:52 +08001758int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1759 struct dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001760{
1761 int rc;
Lan Tianyu336c5c32012-07-06 14:13:52 +08001762 struct dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001763
1764 rc = find_port_owner(hdev, port1, &powner);
1765 if (rc)
1766 return rc;
1767 if (*powner != owner)
1768 return -ENOENT;
1769 *powner = NULL;
1770 return rc;
1771}
1772
Lan Tianyu336c5c32012-07-06 14:13:52 +08001773void usb_hub_release_all_ports(struct usb_device *hdev, struct dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001774{
Lan Tianyufa2a9562012-09-05 13:44:31 +08001775 struct usb_hub *hub = hdev_to_hub(hdev);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001776 int n;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001777
Lan Tianyufa2a9562012-09-05 13:44:31 +08001778 for (n = 0; n < hdev->maxchild; n++) {
1779 if (hub->ports[n]->port_owner == owner)
1780 hub->ports[n]->port_owner = NULL;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001781 }
Lan Tianyufa2a9562012-09-05 13:44:31 +08001782
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001783}
1784
1785/* The caller must hold udev's lock */
1786bool usb_device_is_owned(struct usb_device *udev)
1787{
1788 struct usb_hub *hub;
1789
1790 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1791 return false;
1792 hub = hdev_to_hub(udev->parent);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001793 return !!hub->ports[udev->portnum - 1]->port_owner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001794}
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1797{
Lan Tianyuff823c72012-09-05 13:44:32 +08001798 struct usb_hub *hub = hdev_to_hub(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 int i;
1800
1801 for (i = 0; i < udev->maxchild; ++i) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001802 if (hub->ports[i]->child)
1803 recursively_mark_NOTATTACHED(hub->ports[i]->child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 }
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001805 if (udev->state == USB_STATE_SUSPENDED)
Sarah Sharp15123002007-12-21 16:54:15 -08001806 udev->active_duration -= jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 udev->state = USB_STATE_NOTATTACHED;
1808}
1809
1810/**
1811 * usb_set_device_state - change a device's current state (usbcore, hcds)
1812 * @udev: pointer to device whose state should be changed
1813 * @new_state: new state value to be stored
1814 *
1815 * udev->state is _not_ fully protected by the device lock. Although
1816 * most transitions are made only while holding the lock, the state can
1817 * can change to USB_STATE_NOTATTACHED at almost any time. This
1818 * is so that devices can be marked as disconnected as soon as possible,
1819 * without having to wait for any semaphores to be released. As a result,
1820 * all changes to any device's state must be protected by the
1821 * device_state_lock spinlock.
1822 *
1823 * Once a device has been added to the device tree, all changes to its state
1824 * should be made using this routine. The state should _not_ be set directly.
1825 *
1826 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1827 * Otherwise udev->state is set to new_state, and if new_state is
1828 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1829 * to USB_STATE_NOTATTACHED.
1830 */
1831void usb_set_device_state(struct usb_device *udev,
1832 enum usb_device_state new_state)
1833{
1834 unsigned long flags;
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001835 int wakeup = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
1837 spin_lock_irqsave(&device_state_lock, flags);
1838 if (udev->state == USB_STATE_NOTATTACHED)
1839 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001840 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001841
1842 /* root hub wakeup capabilities are managed out-of-band
1843 * and may involve silicon errata ... ignore them here.
1844 */
1845 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001846 if (udev->state == USB_STATE_SUSPENDED
1847 || new_state == USB_STATE_SUSPENDED)
1848 ; /* No change to wakeup settings */
1849 else if (new_state == USB_STATE_CONFIGURED)
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001850 wakeup = udev->actconfig->desc.bmAttributes
1851 & USB_CONFIG_ATT_WAKEUP;
Alan Stern645daaa2006-08-30 15:47:02 -04001852 else
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001853 wakeup = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001854 }
Sarah Sharp15123002007-12-21 16:54:15 -08001855 if (udev->state == USB_STATE_SUSPENDED &&
1856 new_state != USB_STATE_SUSPENDED)
1857 udev->active_duration -= jiffies;
1858 else if (new_state == USB_STATE_SUSPENDED &&
1859 udev->state != USB_STATE_SUSPENDED)
1860 udev->active_duration += jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -04001861 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001862 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 recursively_mark_NOTATTACHED(udev);
1864 spin_unlock_irqrestore(&device_state_lock, flags);
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001865 if (wakeup >= 0)
1866 device_set_wakeup_capable(&udev->dev, wakeup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867}
David Vrabel6da9c992009-02-18 14:43:47 +00001868EXPORT_SYMBOL_GPL(usb_set_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001870/*
Alan Stern3b29b682011-02-22 09:53:41 -05001871 * Choose a device number.
1872 *
1873 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1874 * USB-2.0 buses they are also used as device addresses, however on
1875 * USB-3.0 buses the address is assigned by the controller hardware
1876 * and it usually is not the same as the device number.
1877 *
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001878 * WUSB devices are simple: they have no hubs behind, so the mapping
1879 * device <-> virtual port number becomes 1:1. Why? to simplify the
1880 * life of the device connection logic in
1881 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1882 * handshake we need to assign a temporary address in the unauthorized
1883 * space. For simplicity we use the first virtual port number found to
1884 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1885 * and that becomes it's address [X < 128] or its unauthorized address
1886 * [X | 0x80].
1887 *
1888 * We add 1 as an offset to the one-based USB-stack port number
1889 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1890 * 0 is reserved by USB for default address; (b) Linux's USB stack
1891 * uses always #1 for the root hub of the controller. So USB stack's
1892 * port #1, which is wusb virtual-port #0 has address #2.
Sarah Sharpc6515272009-04-27 19:57:26 -07001893 *
1894 * Devices connected under xHCI are not as simple. The host controller
1895 * supports virtualization, so the hardware assigns device addresses and
1896 * the HCD must setup data structures before issuing a set address
1897 * command to the hardware.
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001898 */
Alan Stern3b29b682011-02-22 09:53:41 -05001899static void choose_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900{
1901 int devnum;
1902 struct usb_bus *bus = udev->bus;
1903
1904 /* If khubd ever becomes multithreaded, this will need a lock */
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001905 if (udev->wusb) {
1906 devnum = udev->portnum + 1;
1907 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1908 } else {
1909 /* Try to allocate the next devnum beginning at
1910 * bus->devnum_next. */
1911 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1912 bus->devnum_next);
1913 if (devnum >= 128)
1914 devnum = find_next_zero_bit(bus->devmap.devicemap,
1915 128, 1);
1916 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1917 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 if (devnum < 128) {
1919 set_bit(devnum, bus->devmap.devicemap);
1920 udev->devnum = devnum;
1921 }
1922}
1923
Alan Stern3b29b682011-02-22 09:53:41 -05001924static void release_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925{
1926 if (udev->devnum > 0) {
1927 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1928 udev->devnum = -1;
1929 }
1930}
1931
Alan Stern3b29b682011-02-22 09:53:41 -05001932static void update_devnum(struct usb_device *udev, int devnum)
David Vrabel4953d142008-04-08 13:24:46 -07001933{
1934 /* The address for a WUSB device is managed by wusbcore. */
1935 if (!udev->wusb)
1936 udev->devnum = devnum;
1937}
1938
Herbert Xuf7410ce2010-01-10 20:15:03 +11001939static void hub_free_dev(struct usb_device *udev)
1940{
1941 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1942
1943 /* Root hubs aren't real devices, so don't free HCD resources */
1944 if (hcd->driver->free_dev && udev->parent)
1945 hcd->driver->free_dev(hcd, udev);
1946}
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948/**
1949 * usb_disconnect - disconnect a device (usbcore-internal)
1950 * @pdev: pointer to device being disconnected
1951 * Context: !in_interrupt ()
1952 *
1953 * Something got disconnected. Get rid of it and all of its children.
1954 *
1955 * If *pdev is a normal device then the parent hub must already be locked.
1956 * If *pdev is a root hub then this routine will acquire the
1957 * usb_bus_list_lock on behalf of the caller.
1958 *
1959 * Only hub drivers (including virtual root hub drivers for host
1960 * controllers) should ever call this.
1961 *
1962 * This call is synchronous, and may not be used in an interrupt context.
1963 */
1964void usb_disconnect(struct usb_device **pdev)
1965{
1966 struct usb_device *udev = *pdev;
Lan Tianyuff823c72012-09-05 13:44:32 +08001967 struct usb_hub *hub = hdev_to_hub(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 int i;
1969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 /* mark the device as inactive, so any further urb submissions for
1971 * this device (and any of its children) will fail immediately.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001972 * this quiesces everything except pending urbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 */
1974 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern3b29b682011-02-22 09:53:41 -05001975 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1976 udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001978 usb_lock_device(udev);
1979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 /* Free up all the children before we remove this device */
Huajun Li88162302012-03-12 21:00:19 +08001981 for (i = 0; i < udev->maxchild; i++) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001982 if (hub->ports[i]->child)
1983 usb_disconnect(&hub->ports[i]->child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 }
1985
1986 /* deallocate hcd/hardware state ... nuking all pending urbs and
1987 * cleaning up all state associated with the current configuration
1988 * so that the hardware is now fully quiesced.
1989 */
Alan Stern782da722006-07-01 22:09:35 -04001990 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 usb_disable_device(udev, 0);
Alan Sterncde217a2008-10-21 15:28:46 -04001992 usb_hcd_synchronize_unlinks(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Lan Tianyufde26382013-01-20 01:53:33 +08001994 if (udev->parent) {
1995 struct usb_port *port_dev =
1996 hdev_to_hub(udev->parent)->ports[udev->portnum - 1];
1997
1998 sysfs_remove_link(&udev->dev.kobj, "port");
1999 sysfs_remove_link(&port_dev->dev.kobj, "device");
2000 }
2001
Alan Stern3b23dd62008-12-05 14:10:34 -05002002 usb_remove_ep_devs(&udev->ep0);
Alan Stern782da722006-07-01 22:09:35 -04002003 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07002004
Alan Stern782da722006-07-01 22:09:35 -04002005 /* Unregister the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002006 * for de-configuring the device and invoking the remove-device
2007 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002008 */
2009 device_del(&udev->dev);
2010
2011 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 * (or root_hub) pointer.
2013 */
Alan Stern3b29b682011-02-22 09:53:41 -05002014 release_devnum(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
2016 /* Avoid races with recursively_mark_NOTATTACHED() */
2017 spin_lock_irq(&device_state_lock);
2018 *pdev = NULL;
2019 spin_unlock_irq(&device_state_lock);
2020
Herbert Xuf7410ce2010-01-10 20:15:03 +11002021 hub_free_dev(udev);
2022
Alan Stern782da722006-07-01 22:09:35 -04002023 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024}
2025
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002026#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027static void show_string(struct usb_device *udev, char *id, char *string)
2028{
2029 if (!string)
2030 return;
Joe Perchesf2ec5222012-10-28 01:05:51 -07002031 dev_info(&udev->dev, "%s: %s\n", id, string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032}
2033
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002034static void announce_device(struct usb_device *udev)
2035{
2036 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2037 le16_to_cpu(udev->descriptor.idVendor),
2038 le16_to_cpu(udev->descriptor.idProduct));
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002039 dev_info(&udev->dev,
2040 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002041 udev->descriptor.iManufacturer,
2042 udev->descriptor.iProduct,
2043 udev->descriptor.iSerialNumber);
2044 show_string(udev, "Product", udev->product);
2045 show_string(udev, "Manufacturer", udev->manufacturer);
2046 show_string(udev, "SerialNumber", udev->serial);
2047}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048#else
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002049static inline void announce_device(struct usb_device *udev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050#endif
2051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052#ifdef CONFIG_USB_OTG
2053#include "otg_whitelist.h"
2054#endif
2055
Oliver Neukum3ede7602007-01-11 14:35:50 +01002056/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002057 * usb_enumerate_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01002058 * @udev: newly addressed device (in ADDRESS state)
2059 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002060 * Finish enumeration for On-The-Go devices
Oliver Neukum3ede7602007-01-11 14:35:50 +01002061 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002062static int usb_enumerate_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002064 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066#ifdef CONFIG_USB_OTG
2067 /*
2068 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2069 * to wake us after we've powered off VBUS; and HNP, switching roles
2070 * "host" to "peripheral". The OTG descriptor helps figure this out.
2071 */
2072 if (!udev->bus->is_b_host
2073 && udev->config
2074 && udev->parent == udev->bus->root_hub) {
Felipe Balbi2eb50522009-12-04 15:47:43 +02002075 struct usb_otg_descriptor *desc = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 struct usb_bus *bus = udev->bus;
2077
2078 /* descriptor may appear anywhere in config */
2079 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2080 le16_to_cpu(udev->config[0].desc.wTotalLength),
2081 USB_DT_OTG, (void **) &desc) == 0) {
2082 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05002083 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07002084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 dev_info(&udev->dev,
2086 "Dual-Role OTG device on %sHNP port\n",
2087 (port1 == bus->otg_port)
2088 ? "" : "non-");
2089
2090 /* enable HNP before suspend, it's simpler */
2091 if (port1 == bus->otg_port)
2092 bus->b_hnp_enable = 1;
2093 err = usb_control_msg(udev,
2094 usb_sndctrlpipe(udev, 0),
2095 USB_REQ_SET_FEATURE, 0,
2096 bus->b_hnp_enable
2097 ? USB_DEVICE_B_HNP_ENABLE
2098 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2099 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2100 if (err < 0) {
2101 /* OTG MESSAGE: report errors here,
2102 * customize to match your product.
2103 */
2104 dev_info(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002105 "can't set HNP mode: %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 err);
2107 bus->b_hnp_enable = 0;
2108 }
2109 }
2110 }
2111 }
2112
2113 if (!is_targeted(udev)) {
2114
2115 /* Maybe it can talk to us, though we can't talk to it.
2116 * (Includes HNP test device.)
2117 */
2118 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell634a84f2009-01-15 13:51:28 -08002119 err = usb_port_suspend(udev, PMSG_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 if (err < 0)
2121 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2122 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07002123 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 goto fail;
2125 }
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002126fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002128 return err;
2129}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002131
2132/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002133 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002134 * @udev: newly addressed device (in ADDRESS state)
2135 *
2136 * This is only called by usb_new_device() and usb_authorize_device()
2137 * and FIXME -- all comments that apply to them apply here wrt to
2138 * environment.
2139 *
2140 * If the device is WUSB and not authorized, we don't attempt to read
2141 * the string descriptors, as they will be errored out by the device
2142 * until it has been authorized.
2143 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002144static int usb_enumerate_device(struct usb_device *udev)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002145{
2146 int err;
2147
2148 if (udev->config == NULL) {
2149 err = usb_get_configuration(udev);
2150 if (err < 0) {
2151 dev_err(&udev->dev, "can't read configurations, error %d\n",
2152 err);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002153 return err;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002154 }
2155 }
2156 if (udev->wusb == 1 && udev->authorized == 0) {
2157 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2158 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2159 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
2160 }
2161 else {
2162 /* read the standard strings and cache them if present */
2163 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2164 udev->manufacturer = usb_cache_string(udev,
2165 udev->descriptor.iManufacturer);
2166 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2167 }
Alan Stern8d8558d2009-12-08 15:50:41 -05002168 err = usb_enumerate_device_otg(udev);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002169 if (err < 0)
2170 return err;
2171
2172 usb_detect_interface_quirks(udev);
2173
2174 return 0;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002175}
2176
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002177static void set_usb_port_removable(struct usb_device *udev)
2178{
2179 struct usb_device *hdev = udev->parent;
2180 struct usb_hub *hub;
2181 u8 port = udev->portnum;
2182 u16 wHubCharacteristics;
2183 bool removable = true;
2184
2185 if (!hdev)
2186 return;
2187
2188 hub = hdev_to_hub(udev->parent);
2189
2190 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2191
2192 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2193 return;
2194
2195 if (hub_is_superspeed(hdev)) {
Lan Tianyuca3c1532012-09-11 04:22:36 +08002196 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2197 & (1 << port))
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002198 removable = false;
2199 } else {
2200 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2201 removable = false;
2202 }
2203
2204 if (removable)
2205 udev->removable = USB_DEVICE_REMOVABLE;
2206 else
2207 udev->removable = USB_DEVICE_FIXED;
2208}
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002209
2210/**
2211 * usb_new_device - perform initial device setup (usbcore-internal)
2212 * @udev: newly addressed device (in ADDRESS state)
2213 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002214 * This is called with devices which have been detected but not fully
2215 * enumerated. The device descriptor is available, but not descriptors
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002216 * for any device configuration. The caller must have locked either
2217 * the parent hub (if udev is a normal device) or else the
2218 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2219 * udev has already been installed, but udev is not yet visible through
2220 * sysfs or other filesystem code.
2221 *
2222 * It will return if the device is configured properly or not. Zero if
2223 * the interface was registered with the driver core; else a negative
2224 * errno value.
2225 *
2226 * This call is synchronous, and may not be used in an interrupt context.
2227 *
2228 * Only the hub driver or root-hub registrar should ever call this.
2229 */
2230int usb_new_device(struct usb_device *udev)
2231{
2232 int err;
2233
Dan Streetman16985402010-01-06 09:56:53 -05002234 if (udev->parent) {
Dan Streetman16985402010-01-06 09:56:53 -05002235 /* Initialize non-root-hub device wakeup to disabled;
2236 * device (un)configuration controls wakeup capable
2237 * sysfs power/wakeup controls wakeup enabled/disabled
2238 */
2239 device_init_wakeup(&udev->dev, 0);
Dan Streetman16985402010-01-06 09:56:53 -05002240 }
2241
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002242 /* Tell the runtime-PM framework the device is active */
2243 pm_runtime_set_active(&udev->dev);
Alan Sternc08512c2010-11-15 15:57:58 -05002244 pm_runtime_get_noresume(&udev->dev);
Alan Sternfcc4a012010-11-15 15:57:51 -05002245 pm_runtime_use_autosuspend(&udev->dev);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002246 pm_runtime_enable(&udev->dev);
2247
Alan Sternc08512c2010-11-15 15:57:58 -05002248 /* By default, forbid autosuspend for all devices. It will be
2249 * allowed for hubs during binding.
2250 */
2251 usb_disable_autosuspend(udev);
2252
Alan Stern8d8558d2009-12-08 15:50:41 -05002253 err = usb_enumerate_device(udev); /* Read descriptors */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002254 if (err < 0)
2255 goto fail;
Sarah Sharpc6515272009-04-27 19:57:26 -07002256 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2257 udev->devnum, udev->bus->busnum,
2258 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002259 /* export the usbdev device-node for libusb */
2260 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2261 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2262
Alan Stern6cd13202008-11-13 15:08:30 -05002263 /* Tell the world! */
2264 announce_device(udev);
Alan Stern195af2c2007-07-16 15:28:19 -04002265
Theodore Ts'ob04b3152012-07-04 11:22:20 -04002266 if (udev->serial)
2267 add_device_randomness(udev->serial, strlen(udev->serial));
2268 if (udev->product)
2269 add_device_randomness(udev->product, strlen(udev->product));
2270 if (udev->manufacturer)
2271 add_device_randomness(udev->manufacturer,
2272 strlen(udev->manufacturer));
2273
Rafael J. Wysocki927bc912010-02-08 19:18:16 +01002274 device_enable_async_suspend(&udev->dev);
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002275
2276 /*
2277 * check whether the hub marks this port as non-removable. Do it
2278 * now so that platform-specific data can override it in
2279 * device_add()
2280 */
2281 if (udev->parent)
2282 set_usb_port_removable(udev);
2283
Alan Stern782da722006-07-01 22:09:35 -04002284 /* Register the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002285 * for configuring the device and invoking the add-device
2286 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002287 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002288 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 if (err) {
2290 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2291 goto fail;
2292 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002293
Lan Tianyufde26382013-01-20 01:53:33 +08002294 /* Create link files between child device and usb port device. */
2295 if (udev->parent) {
2296 struct usb_port *port_dev =
2297 hdev_to_hub(udev->parent)->ports[udev->portnum - 1];
2298
2299 err = sysfs_create_link(&udev->dev.kobj,
2300 &port_dev->dev.kobj, "port");
2301 if (err)
2302 goto fail;
2303
2304 err = sysfs_create_link(&port_dev->dev.kobj,
2305 &udev->dev.kobj, "device");
2306 if (err) {
2307 sysfs_remove_link(&udev->dev.kobj, "port");
2308 goto fail;
2309 }
2310 }
2311
Alan Stern3b23dd62008-12-05 14:10:34 -05002312 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
Alan Sternc08512c2010-11-15 15:57:58 -05002313 usb_mark_last_busy(udev);
2314 pm_runtime_put_sync_autosuspend(&udev->dev);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07002315 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316
2317fail:
2318 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002319 pm_runtime_disable(&udev->dev);
2320 pm_runtime_set_suspended(&udev->dev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002321 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322}
2323
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002324
2325/**
Randy Dunlapfd39c862007-10-15 17:30:02 -07002326 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2327 * @usb_dev: USB device
2328 *
2329 * Move the USB device to a very basic state where interfaces are disabled
2330 * and the device is in fact unconfigured and unusable.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002331 *
2332 * We share a lock (that we have) with device_del(), so we need to
2333 * defer its call.
2334 */
2335int usb_deauthorize_device(struct usb_device *usb_dev)
2336{
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002337 usb_lock_device(usb_dev);
2338 if (usb_dev->authorized == 0)
2339 goto out_unauthorized;
Alan Sternda307122009-12-08 15:54:44 -05002340
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002341 usb_dev->authorized = 0;
2342 usb_set_configuration(usb_dev, -1);
Alan Sternda307122009-12-08 15:54:44 -05002343
2344 kfree(usb_dev->product);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002345 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05002346 kfree(usb_dev->manufacturer);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002347 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05002348 kfree(usb_dev->serial);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002349 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
Alan Sternda307122009-12-08 15:54:44 -05002350
2351 usb_destroy_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002352 usb_dev->descriptor.bNumConfigurations = 0;
Alan Sternda307122009-12-08 15:54:44 -05002353
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002354out_unauthorized:
2355 usb_unlock_device(usb_dev);
2356 return 0;
2357}
2358
2359
2360int usb_authorize_device(struct usb_device *usb_dev)
2361{
2362 int result = 0, c;
Alan Sternda307122009-12-08 15:54:44 -05002363
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002364 usb_lock_device(usb_dev);
2365 if (usb_dev->authorized == 1)
2366 goto out_authorized;
Alan Sternda307122009-12-08 15:54:44 -05002367
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002368 result = usb_autoresume_device(usb_dev);
2369 if (result < 0) {
2370 dev_err(&usb_dev->dev,
2371 "can't autoresume for authorization: %d\n", result);
2372 goto error_autoresume;
2373 }
2374 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2375 if (result < 0) {
2376 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2377 "authorization: %d\n", result);
2378 goto error_device_descriptor;
2379 }
Alan Sternda307122009-12-08 15:54:44 -05002380
2381 kfree(usb_dev->product);
2382 usb_dev->product = NULL;
2383 kfree(usb_dev->manufacturer);
2384 usb_dev->manufacturer = NULL;
2385 kfree(usb_dev->serial);
2386 usb_dev->serial = NULL;
2387
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002388 usb_dev->authorized = 1;
Alan Stern8d8558d2009-12-08 15:50:41 -05002389 result = usb_enumerate_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002390 if (result < 0)
Alan Stern8d8558d2009-12-08 15:50:41 -05002391 goto error_enumerate;
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002392 /* Choose and set the configuration. This registers the interfaces
2393 * with the driver core and lets interface drivers bind to them.
2394 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06002395 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002396 if (c >= 0) {
2397 result = usb_set_configuration(usb_dev, c);
2398 if (result) {
2399 dev_err(&usb_dev->dev,
2400 "can't set config #%d, error %d\n", c, result);
2401 /* This need not be fatal. The user can try to
2402 * set other configurations. */
2403 }
2404 }
2405 dev_info(&usb_dev->dev, "authorized to connect\n");
Alan Sternda307122009-12-08 15:54:44 -05002406
Alan Stern8d8558d2009-12-08 15:50:41 -05002407error_enumerate:
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002408error_device_descriptor:
Alan Sternda307122009-12-08 15:54:44 -05002409 usb_autosuspend_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002410error_autoresume:
2411out_authorized:
2412 usb_unlock_device(usb_dev); // complements locktree
2413 return result;
2414}
2415
2416
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002417/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2418static unsigned hub_is_wusb(struct usb_hub *hub)
2419{
2420 struct usb_hcd *hcd;
2421 if (hub->hdev->parent != NULL) /* not a root hub? */
2422 return 0;
2423 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2424 return hcd->wireless;
2425}
2426
2427
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428#define PORT_RESET_TRIES 5
2429#define SET_ADDRESS_TRIES 2
2430#define GET_DESCRIPTOR_TRIES 2
2431#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
Rusty Russell90ab5ee2012-01-13 09:32:20 +10302432#define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433
2434#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2435#define HUB_SHORT_RESET_TIME 10
Andiry Xu75d7cf72011-09-13 16:41:11 -07002436#define HUB_BH_RESET_TIME 50
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437#define HUB_LONG_RESET_TIME 200
Sarah Sharp77c7f072012-11-14 17:16:52 -08002438#define HUB_RESET_TIMEOUT 800
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439
Sarah Sharp10d674a2011-09-14 14:24:52 -07002440static int hub_port_reset(struct usb_hub *hub, int port1,
2441 struct usb_device *udev, unsigned int delay, bool warm);
2442
Stanislaw Ledwon8bea2bd2012-06-18 15:20:00 +02002443/* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2444 * Port worm reset is required to recover
2445 */
2446static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
Sarah Sharp10d674a2011-09-14 14:24:52 -07002447{
2448 return hub_is_superspeed(hub->hdev) &&
Stanislaw Ledwon8bea2bd2012-06-18 15:20:00 +02002449 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2450 USB_SS_PORT_LS_SS_INACTIVE) ||
2451 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2452 USB_SS_PORT_LS_COMP_MOD)) ;
Sarah Sharp10d674a2011-09-14 14:24:52 -07002453}
2454
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455static int hub_port_wait_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002456 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457{
2458 int delay_time, ret;
2459 u16 portstatus;
2460 u16 portchange;
2461
2462 for (delay_time = 0;
2463 delay_time < HUB_RESET_TIMEOUT;
2464 delay_time += delay) {
2465 /* wait to give the device a chance to reset */
2466 msleep(delay);
2467
2468 /* read and decode port status */
2469 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2470 if (ret < 0)
2471 return ret;
2472
Sarah Sharp4f434472012-11-15 14:58:04 -08002473 /* The port state is unknown until the reset completes. */
Sarah Sharp470f0be2012-12-11 10:14:03 -08002474 if (!(portstatus & USB_PORT_STAT_RESET))
2475 break;
Sarah Sharp4f434472012-11-15 14:58:04 -08002476
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 /* switch to the long delay after two short delay failures */
2478 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2479 delay = HUB_LONG_RESET_TIME;
2480
2481 dev_dbg (hub->intfdev,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002482 "port %d not %sreset yet, waiting %dms\n",
2483 port1, warm ? "warm " : "", delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 }
2485
Sarah Sharp470f0be2012-12-11 10:14:03 -08002486 if ((portstatus & USB_PORT_STAT_RESET))
2487 return -EBUSY;
2488
2489 if (hub_port_warm_reset_required(hub, portstatus))
2490 return -ENOTCONN;
2491
2492 /* Device went away? */
2493 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2494 return -ENOTCONN;
2495
2496 /* bomb out completely if the connection bounced. A USB 3.0
2497 * connection may bounce if multiple warm resets were issued,
2498 * but the device may have successfully re-connected. Ignore it.
2499 */
2500 if (!hub_is_superspeed(hub->hdev) &&
2501 (portchange & USB_PORT_STAT_C_CONNECTION))
2502 return -ENOTCONN;
2503
2504 if (!(portstatus & USB_PORT_STAT_ENABLE))
2505 return -EBUSY;
2506
2507 if (!udev)
2508 return 0;
2509
2510 if (hub_is_wusb(hub))
2511 udev->speed = USB_SPEED_WIRELESS;
2512 else if (hub_is_superspeed(hub->hdev))
2513 udev->speed = USB_SPEED_SUPER;
2514 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2515 udev->speed = USB_SPEED_HIGH;
2516 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2517 udev->speed = USB_SPEED_LOW;
2518 else
2519 udev->speed = USB_SPEED_FULL;
2520 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521}
2522
Andiry Xu75d7cf72011-09-13 16:41:11 -07002523static void hub_port_finish_reset(struct usb_hub *hub, int port1,
Sarah Sharpa24a6072012-11-01 11:20:44 -07002524 struct usb_device *udev, int *status)
Andiry Xu75d7cf72011-09-13 16:41:11 -07002525{
2526 switch (*status) {
2527 case 0:
Sarah Sharpa24a6072012-11-01 11:20:44 -07002528 /* TRSTRCY = 10 ms; plus some extra */
2529 msleep(10 + 40);
2530 if (udev) {
2531 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2532
2533 update_devnum(udev, 0);
2534 /* The xHC may think the device is already reset,
2535 * so ignore the status.
2536 */
2537 if (hcd->driver->reset_device)
2538 hcd->driver->reset_device(hcd, udev);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002539 }
2540 /* FALL THROUGH */
2541 case -ENOTCONN:
2542 case -ENODEV:
2543 clear_port_feature(hub->hdev,
2544 port1, USB_PORT_FEAT_C_RESET);
Sarah Sharp1c7439c62012-11-14 15:58:52 -08002545 if (hub_is_superspeed(hub->hdev)) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002546 clear_port_feature(hub->hdev, port1,
2547 USB_PORT_FEAT_C_BH_PORT_RESET);
2548 clear_port_feature(hub->hdev, port1,
2549 USB_PORT_FEAT_C_PORT_LINK_STATE);
Sarah Sharpa24a6072012-11-01 11:20:44 -07002550 clear_port_feature(hub->hdev, port1,
2551 USB_PORT_FEAT_C_CONNECTION);
Sarah Sharp1c7439c62012-11-14 15:58:52 -08002552 }
Sarah Sharpa24a6072012-11-01 11:20:44 -07002553 if (udev)
Andiry Xu75d7cf72011-09-13 16:41:11 -07002554 usb_set_device_state(udev, *status
2555 ? USB_STATE_NOTATTACHED
2556 : USB_STATE_DEFAULT);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002557 break;
2558 }
2559}
2560
2561/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562static int hub_port_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002563 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564{
2565 int i, status;
Sarah Sharpa24a6072012-11-01 11:20:44 -07002566 u16 portchange, portstatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002568 if (!hub_is_superspeed(hub->hdev)) {
2569 if (warm) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002570 dev_err(hub->intfdev, "only USB3 hub support "
2571 "warm reset\n");
2572 return -EINVAL;
2573 }
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002574 /* Block EHCI CF initialization during the port reset.
2575 * Some companion controllers don't like it when they mix.
2576 */
2577 down_read(&ehci_cf_port_reset_rwsem);
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07002578 } else if (!warm) {
2579 /*
2580 * If the caller hasn't explicitly requested a warm reset,
2581 * double check and see if one is needed.
2582 */
2583 status = hub_port_status(hub, port1,
2584 &portstatus, &portchange);
2585 if (status < 0)
2586 goto done;
2587
2588 if (hub_port_warm_reset_required(hub, portstatus))
2589 warm = true;
Andiry Xu75d7cf72011-09-13 16:41:11 -07002590 }
Alan Stern32fe0192007-10-10 16:27:07 -04002591
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592 /* Reset the port */
2593 for (i = 0; i < PORT_RESET_TRIES; i++) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002594 status = set_port_feature(hub->hdev, port1, (warm ?
2595 USB_PORT_FEAT_BH_PORT_RESET :
2596 USB_PORT_FEAT_RESET));
2597 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 dev_err(hub->intfdev,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002599 "cannot %sreset port %d (err = %d)\n",
2600 warm ? "warm " : "", port1, status);
2601 } else {
2602 status = hub_port_wait_reset(hub, port1, udev, delay,
2603 warm);
David Brownelldd165252005-08-31 10:45:25 -07002604 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 dev_dbg(hub->intfdev,
2606 "port_wait_reset: err = %d\n",
2607 status);
2608 }
2609
Sarah Sharpa24a6072012-11-01 11:20:44 -07002610 /* Check for disconnect or reset */
Andiry Xu75d7cf72011-09-13 16:41:11 -07002611 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
Sarah Sharpa24a6072012-11-01 11:20:44 -07002612 hub_port_finish_reset(hub, port1, udev, &status);
2613
2614 if (!hub_is_superspeed(hub->hdev))
2615 goto done;
2616
2617 /*
2618 * If a USB 3.0 device migrates from reset to an error
2619 * state, re-issue the warm reset.
2620 */
2621 if (hub_port_status(hub, port1,
2622 &portstatus, &portchange) < 0)
2623 goto done;
2624
2625 if (!hub_port_warm_reset_required(hub, portstatus))
2626 goto done;
2627
2628 /*
2629 * If the port is in SS.Inactive or Compliance Mode, the
2630 * hot or warm reset failed. Try another warm reset.
2631 */
2632 if (!warm) {
2633 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2634 port1);
2635 warm = true;
2636 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002637 }
2638
2639 dev_dbg (hub->intfdev,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002640 "port %d not enabled, trying %sreset again...\n",
2641 port1, warm ? "warm " : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642 delay = HUB_LONG_RESET_TIME;
2643 }
2644
2645 dev_err (hub->intfdev,
2646 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2647 port1);
2648
Andiry Xu75d7cf72011-09-13 16:41:11 -07002649done:
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002650 if (!hub_is_superspeed(hub->hdev))
Andiry Xu75d7cf72011-09-13 16:41:11 -07002651 up_read(&ehci_cf_port_reset_rwsem);
2652
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 return status;
2654}
2655
Andiry Xu0ed9a572011-04-27 18:07:43 +08002656/* Check if a port is power on */
2657static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2658{
2659 int ret = 0;
2660
2661 if (hub_is_superspeed(hub->hdev)) {
2662 if (portstatus & USB_SS_PORT_STAT_POWER)
2663 ret = 1;
2664 } else {
2665 if (portstatus & USB_PORT_STAT_POWER)
2666 ret = 1;
2667 }
2668
2669 return ret;
2670}
2671
Alan Sternd388dab2006-07-01 22:14:24 -04002672#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673
Andiry Xu0ed9a572011-04-27 18:07:43 +08002674/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2675static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2676{
2677 int ret = 0;
2678
2679 if (hub_is_superspeed(hub->hdev)) {
2680 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2681 == USB_SS_PORT_LS_U3)
2682 ret = 1;
2683 } else {
2684 if (portstatus & USB_PORT_STAT_SUSPEND)
2685 ret = 1;
2686 }
2687
2688 return ret;
2689}
Alan Sternb01b03f2008-04-28 11:06:11 -04002690
2691/* Determine whether the device on a port is ready for a normal resume,
2692 * is ready for a reset-resume, or should be disconnected.
2693 */
2694static int check_port_resume_type(struct usb_device *udev,
2695 struct usb_hub *hub, int port1,
2696 int status, unsigned portchange, unsigned portstatus)
2697{
2698 /* Is the device still present? */
Andiry Xu0ed9a572011-04-27 18:07:43 +08002699 if (status || port_is_suspended(hub, portstatus) ||
2700 !port_is_power_on(hub, portstatus) ||
2701 !(portstatus & USB_PORT_STAT_CONNECTION)) {
Alan Sternb01b03f2008-04-28 11:06:11 -04002702 if (status >= 0)
2703 status = -ENODEV;
2704 }
2705
Alan Stern86c57ed2008-06-30 11:14:43 -04002706 /* Can't do a normal resume if the port isn't enabled,
2707 * so try a reset-resume instead.
2708 */
2709 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2710 if (udev->persist_enabled)
2711 udev->reset_resume = 1;
2712 else
2713 status = -ENODEV;
2714 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002715
2716 if (status) {
2717 dev_dbg(hub->intfdev,
2718 "port %d status %04x.%04x after resume, %d\n",
2719 port1, portchange, portstatus, status);
2720 } else if (udev->reset_resume) {
2721
2722 /* Late port handoff can set status-change bits */
2723 if (portchange & USB_PORT_STAT_C_CONNECTION)
2724 clear_port_feature(hub->hdev, port1,
2725 USB_PORT_FEAT_C_CONNECTION);
2726 if (portchange & USB_PORT_STAT_C_ENABLE)
2727 clear_port_feature(hub->hdev, port1,
2728 USB_PORT_FEAT_C_ENABLE);
2729 }
2730
2731 return status;
2732}
2733
Sarah Sharpf74631e2012-06-25 12:08:08 -07002734int usb_disable_ltm(struct usb_device *udev)
2735{
2736 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2737
2738 /* Check if the roothub and device supports LTM. */
2739 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2740 !usb_device_supports_ltm(udev))
2741 return 0;
2742
2743 /* Clear Feature LTM Enable can only be sent if the device is
2744 * configured.
2745 */
2746 if (!udev->actconfig)
2747 return 0;
2748
2749 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2750 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2751 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2752 USB_CTRL_SET_TIMEOUT);
2753}
2754EXPORT_SYMBOL_GPL(usb_disable_ltm);
2755
2756void usb_enable_ltm(struct usb_device *udev)
2757{
2758 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2759
2760 /* Check if the roothub and device supports LTM. */
2761 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2762 !usb_device_supports_ltm(udev))
2763 return;
2764
2765 /* Set Feature LTM Enable can only be sent if the device is
2766 * configured.
2767 */
2768 if (!udev->actconfig)
2769 return;
2770
2771 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2772 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2773 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2774 USB_CTRL_SET_TIMEOUT);
2775}
2776EXPORT_SYMBOL_GPL(usb_enable_ltm);
2777
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778#ifdef CONFIG_USB_SUSPEND
2779
2780/*
Alan Stern140d8f62006-07-01 22:07:21 -04002781 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04002782 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07002783 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 *
2785 * Suspends a USB device that isn't in active use, conserving power.
2786 * Devices may wake out of a suspend, if anything important happens,
2787 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04002788 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 * to disconnect devices while they are suspended.
2790 *
David Brownell390a8c32005-09-13 19:57:27 -07002791 * This only affects the USB hardware for a device; its interfaces
2792 * (and, for hubs, child devices) must already have been suspended.
2793 *
Alan Stern624d6c02007-05-30 15:35:16 -04002794 * Selective port suspend reduces power; most suspended devices draw
2795 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2796 * All devices below the suspended port are also suspended.
2797 *
2798 * Devices leave suspend state when the host wakes them up. Some devices
2799 * also support "remote wakeup", where the device can activate the USB
2800 * tree above them to deliver data, such as a keypress or packet. In
2801 * some cases, this wakes the USB host.
2802 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 * Suspending OTG devices may trigger HNP, if that's been enabled
2804 * between a pair of dual-role devices. That will change roles, such
2805 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2806 *
Alan Stern4956ecc2007-05-30 16:51:28 -04002807 * Devices on USB hub ports have only one "suspend" state, corresponding
2808 * to ACPI D2, "may cause the device to lose some context".
2809 * State transitions include:
2810 *
2811 * - suspend, resume ... when the VBUS power link stays live
2812 * - suspend, disconnect ... VBUS lost
2813 *
2814 * Once VBUS drop breaks the circuit, the port it's using has to go through
2815 * normal re-enumeration procedures, starting with enabling VBUS power.
2816 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2817 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2818 * timer, no SRP, no requests through sysfs.
2819 *
2820 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2821 * the root hub for their bus goes into global suspend ... so we don't
2822 * (falsely) update the device power state to say it suspended.
2823 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 * Returns 0 on success, else negative errno.
2825 */
Alan Stern65bfd292008-11-25 16:39:18 -05002826int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827{
Alan Stern624d6c02007-05-30 15:35:16 -04002828 struct usb_hub *hub = hdev_to_hub(udev->parent);
2829 int port1 = udev->portnum;
2830 int status;
Alan Stern4956ecc2007-05-30 16:51:28 -04002831
Alan Stern624d6c02007-05-30 15:35:16 -04002832 /* enable remote wakeup when appropriate; this lets the device
2833 * wake up the upstream hub (including maybe the root hub).
2834 *
2835 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2836 * we don't explicitly enable it here.
2837 */
2838 if (udev->do_remote_wakeup) {
Sarah Sharp623bef92011-11-11 14:57:33 -08002839 if (!hub_is_superspeed(hub->hdev)) {
2840 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2841 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2842 USB_DEVICE_REMOTE_WAKEUP, 0,
2843 NULL, 0,
2844 USB_CTRL_SET_TIMEOUT);
2845 } else {
2846 /* Assume there's only one function on the USB 3.0
2847 * device and enable remote wake for the first
2848 * interface. FIXME if the interface association
2849 * descriptor shows there's more than one function.
2850 */
2851 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2852 USB_REQ_SET_FEATURE,
2853 USB_RECIP_INTERFACE,
2854 USB_INTRF_FUNC_SUSPEND,
Sarah Sharp3b9b6ac2012-01-06 15:48:30 -08002855 USB_INTRF_FUNC_SUSPEND_RW |
2856 USB_INTRF_FUNC_SUSPEND_LP,
Sarah Sharp623bef92011-11-11 14:57:33 -08002857 NULL, 0,
2858 USB_CTRL_SET_TIMEOUT);
2859 }
Oliver Neukum0c487202009-10-19 13:19:41 +02002860 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04002861 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2862 status);
Oliver Neukum0c487202009-10-19 13:19:41 +02002863 /* bail if autosuspend is requested */
Alan Stern5b1b0b82011-08-19 23:49:48 +02002864 if (PMSG_IS_AUTO(msg))
Oliver Neukum0c487202009-10-19 13:19:41 +02002865 return status;
2866 }
Alan Stern624d6c02007-05-30 15:35:16 -04002867 }
2868
Andiry Xu65580b432011-09-23 14:19:52 -07002869 /* disable USB2 hardware LPM */
2870 if (udev->usb2_hw_lpm_enabled == 1)
2871 usb_set_usb2_hardware_lpm(udev, 0);
2872
Sarah Sharpf74631e2012-06-25 12:08:08 -07002873 if (usb_disable_ltm(udev)) {
2874 dev_err(&udev->dev, "%s Failed to disable LTM before suspend\n.",
2875 __func__);
2876 return -ENOMEM;
2877 }
Sarah Sharp83060952012-05-02 14:25:52 -07002878 if (usb_unlocked_disable_lpm(udev)) {
2879 dev_err(&udev->dev, "%s Failed to disable LPM before suspend\n.",
2880 __func__);
2881 return -ENOMEM;
2882 }
2883
Alan Stern624d6c02007-05-30 15:35:16 -04002884 /* see 7.1.7.6 */
Andiry Xua7114232011-04-27 18:07:50 +08002885 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08002886 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
Andiry Xua8f08d82011-03-31 14:56:50 +08002887 else
2888 status = set_port_feature(hub->hdev, port1,
2889 USB_PORT_FEAT_SUSPEND);
Alan Stern624d6c02007-05-30 15:35:16 -04002890 if (status) {
2891 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2892 port1, status);
2893 /* paranoia: "should not happen" */
Oliver Neukum0c487202009-10-19 13:19:41 +02002894 if (udev->do_remote_wakeup)
2895 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
Alan Stern624d6c02007-05-30 15:35:16 -04002896 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2897 USB_DEVICE_REMOTE_WAKEUP, 0,
2898 NULL, 0,
2899 USB_CTRL_SET_TIMEOUT);
Alan Sterncbb33002011-06-15 16:29:16 -04002900
Andiry Xuc3e751e2012-05-05 00:50:10 +08002901 /* Try to enable USB2 hardware LPM again */
2902 if (udev->usb2_hw_lpm_capable == 1)
2903 usb_set_usb2_hardware_lpm(udev, 1);
2904
Sarah Sharpf74631e2012-06-25 12:08:08 -07002905 /* Try to enable USB3 LTM and LPM again */
2906 usb_enable_ltm(udev);
Sarah Sharp83060952012-05-02 14:25:52 -07002907 usb_unlocked_enable_lpm(udev);
2908
Alan Sterncbb33002011-06-15 16:29:16 -04002909 /* System sleep transitions should never fail */
Alan Stern5b1b0b82011-08-19 23:49:48 +02002910 if (!PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04002911 status = 0;
Alan Stern624d6c02007-05-30 15:35:16 -04002912 } else {
2913 /* device has up to 10 msec to fully suspend */
Alan Stern30b1a7a2011-09-27 21:54:22 +02002914 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2915 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2916 udev->do_remote_wakeup);
Alan Stern624d6c02007-05-30 15:35:16 -04002917 usb_set_device_state(udev, USB_STATE_SUSPENDED);
Alan Sternbfd1e912012-10-19 11:03:39 -04002918 udev->port_is_suspended = 1;
Alan Stern624d6c02007-05-30 15:35:16 -04002919 msleep(10);
2920 }
Alan Sternc08512c2010-11-15 15:57:58 -05002921 usb_mark_last_busy(hub->hdev);
Alan Stern4956ecc2007-05-30 16:51:28 -04002922 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923}
David Brownellf3f32532005-09-22 22:37:29 -07002924
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925/*
David Brownell390a8c32005-09-13 19:57:27 -07002926 * If the USB "suspend" state is in use (rather than "global suspend"),
2927 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04002928 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 * hardware resume signaling is finished, either because of selective
2930 * resume (by host) or remote wakeup (by device) ... now see what changed
2931 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04002932 *
2933 * If @udev->reset_resume is set then the device is reset before the
2934 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 */
Alan Stern140d8f62006-07-01 22:07:21 -04002936static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937{
Alan Stern54515fe2007-05-30 15:38:58 -04002938 int status = 0;
Oliver Neukum07e72b92012-11-29 15:05:57 +01002939 u16 devstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940
2941 /* caller owns the udev device lock */
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002942 dev_dbg(&udev->dev, "%s\n",
2943 udev->reset_resume ? "finish reset-resume" : "finish resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944
2945 /* usb ch9 identifies four variants of SUSPENDED, based on what
2946 * state the device resumes to. Linux currently won't see the
2947 * first two on the host side; they'd be inside hub_port_init()
2948 * during many timeouts, but khubd can't suspend until later.
2949 */
2950 usb_set_device_state(udev, udev->actconfig
2951 ? USB_STATE_CONFIGURED
2952 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953
Alan Stern54515fe2007-05-30 15:38:58 -04002954 /* 10.5.4.5 says not to reset a suspended port if the attached
2955 * device is enabled for remote wakeup. Hence the reset
2956 * operation is carried out here, after the port has been
2957 * resumed.
2958 */
2959 if (udev->reset_resume)
Alan Stern86c57ed2008-06-30 11:14:43 -04002960 retry_reset_resume:
Ming Lei742120c2008-06-18 22:00:29 +08002961 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04002962
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963 /* 10.5.4.5 says be sure devices in the tree are still there.
2964 * For now let's assume the device didn't go crazy on resume,
2965 * and device drivers will know about any resume quirks.
2966 */
Alan Stern54515fe2007-05-30 15:38:58 -04002967 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04002968 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04002969 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2970 if (status >= 0)
Alan Stern46dede42007-08-14 10:56:10 -04002971 status = (status > 0 ? 0 : -ENODEV);
Alan Stern86c57ed2008-06-30 11:14:43 -04002972
2973 /* If a normal resume failed, try doing a reset-resume */
2974 if (status && !udev->reset_resume && udev->persist_enabled) {
2975 dev_dbg(&udev->dev, "retry with reset-resume\n");
2976 udev->reset_resume = 1;
2977 goto retry_reset_resume;
2978 }
Alan Stern54515fe2007-05-30 15:38:58 -04002979 }
Alan Sternb40b7a92006-06-19 15:12:38 -04002980
Alan Stern624d6c02007-05-30 15:35:16 -04002981 if (status) {
2982 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2983 status);
Oliver Neukum07e72b92012-11-29 15:05:57 +01002984 /*
2985 * There are a few quirky devices which violate the standard
2986 * by claiming to have remote wakeup enabled after a reset,
2987 * which crash if the feature is cleared, hence check for
2988 * udev->reset_resume
2989 */
2990 } else if (udev->actconfig && !udev->reset_resume) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991 le16_to_cpus(&devstatus);
Alan Stern686314c2007-05-30 15:34:36 -04002992 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993 status = usb_control_msg(udev,
2994 usb_sndctrlpipe(udev, 0),
2995 USB_REQ_CLEAR_FEATURE,
2996 USB_RECIP_DEVICE,
2997 USB_DEVICE_REMOTE_WAKEUP, 0,
2998 NULL, 0,
2999 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04003000 if (status)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08003001 dev_dbg(&udev->dev,
3002 "disable remote wakeup, status %d\n",
3003 status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05003004 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003005 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006 }
3007 return status;
3008}
3009
Alan Stern624d6c02007-05-30 15:35:16 -04003010/*
3011 * usb_port_resume - re-activate a suspended usb device's upstream port
3012 * @udev: device to re-activate, not a root hub
3013 * Context: must be able to sleep; device not locked; pm locks held
3014 *
3015 * This will re-activate the suspended device, increasing power usage
3016 * while letting drivers communicate again with its endpoints.
3017 * USB resume explicitly guarantees that the power session between
3018 * the host and the device is the same as it was when the device
3019 * suspended.
3020 *
Alan Sternfeccc302008-03-03 15:15:59 -05003021 * If @udev->reset_resume is set then this routine won't check that the
3022 * port is still enabled. Furthermore, finish_port_resume() above will
Alan Stern54515fe2007-05-30 15:38:58 -04003023 * reset @udev. The end result is that a broken power session can be
3024 * recovered and @udev will appear to persist across a loss of VBUS power.
3025 *
3026 * For example, if a host controller doesn't maintain VBUS suspend current
3027 * during a system sleep or is reset when the system wakes up, all the USB
3028 * power sessions below it will be broken. This is especially troublesome
3029 * for mass-storage devices containing mounted filesystems, since the
3030 * device will appear to have disconnected and all the memory mappings
3031 * to it will be lost. Using the USB_PERSIST facility, the device can be
3032 * made to appear as if it had not disconnected.
3033 *
Ming Lei742120c2008-06-18 22:00:29 +08003034 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
Alan Sternfeccc302008-03-03 15:15:59 -05003035 * every effort to insure that the same device is present after the
Alan Stern54515fe2007-05-30 15:38:58 -04003036 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3037 * quite possible for a device to remain unaltered but its media to be
3038 * changed. If the user replaces a flash memory card while the system is
3039 * asleep, he will have only himself to blame when the filesystem on the
3040 * new card is corrupted and the system crashes.
3041 *
Alan Stern624d6c02007-05-30 15:35:16 -04003042 * Returns 0 on success, else negative errno.
3043 */
Alan Stern65bfd292008-11-25 16:39:18 -05003044int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045{
Alan Stern624d6c02007-05-30 15:35:16 -04003046 struct usb_hub *hub = hdev_to_hub(udev->parent);
3047 int port1 = udev->portnum;
3048 int status;
3049 u16 portchange, portstatus;
Alan Sternd25450c2006-11-20 11:14:30 -05003050
3051 /* Skip the initial Clear-Suspend step for a remote wakeup */
3052 status = hub_port_status(hub, port1, &portstatus, &portchange);
Andiry Xu0ed9a572011-04-27 18:07:43 +08003053 if (status == 0 && !port_is_suspended(hub, portstatus))
Alan Sternd25450c2006-11-20 11:14:30 -05003054 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055
3056 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3057
Alan Sternd5cbad42006-08-11 16:52:39 -04003058 set_bit(port1, hub->busy_bits);
3059
Linus Torvalds1da177e2005-04-16 15:20:36 -07003060 /* see 7.1.7.7; affects power usage, but not budgeting */
Andiry Xua7114232011-04-27 18:07:50 +08003061 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08003062 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
Andiry Xua7114232011-04-27 18:07:50 +08003063 else
3064 status = clear_port_feature(hub->hdev,
3065 port1, USB_PORT_FEAT_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04003067 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3068 port1, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04003071 dev_dbg(&udev->dev, "usb %sresume\n",
Alan Stern5b1b0b82011-08-19 23:49:48 +02003072 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073 msleep(25);
3074
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3076 * stop resume signaling. Then finish the resume
3077 * sequence.
3078 */
Alan Sternd25450c2006-11-20 11:14:30 -05003079 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04003080
Alan Sternb01b03f2008-04-28 11:06:11 -04003081 /* TRSMRCY = 10 msec */
3082 msleep(10);
3083 }
Alan Stern54515fe2007-05-30 15:38:58 -04003084
Alan Sternb01b03f2008-04-28 11:06:11 -04003085 SuspendCleared:
3086 if (status == 0) {
Alan Sternbfd1e912012-10-19 11:03:39 -04003087 udev->port_is_suspended = 0;
Andiry Xua7114232011-04-27 18:07:50 +08003088 if (hub_is_superspeed(hub->hdev)) {
3089 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3090 clear_port_feature(hub->hdev, port1,
3091 USB_PORT_FEAT_C_PORT_LINK_STATE);
3092 } else {
3093 if (portchange & USB_PORT_STAT_C_SUSPEND)
3094 clear_port_feature(hub->hdev, port1,
3095 USB_PORT_FEAT_C_SUSPEND);
3096 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003098
Alan Sternd5cbad42006-08-11 16:52:39 -04003099 clear_bit(port1, hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003100
Alan Sternb01b03f2008-04-28 11:06:11 -04003101 status = check_port_resume_type(udev,
3102 hub, port1, status, portchange, portstatus);
Alan Stern54515fe2007-05-30 15:38:58 -04003103 if (status == 0)
3104 status = finish_port_resume(udev);
3105 if (status < 0) {
3106 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3107 hub_port_logical_disconnect(hub, port1);
Andiry Xu65580b432011-09-23 14:19:52 -07003108 } else {
3109 /* Try to enable USB2 hardware LPM */
3110 if (udev->usb2_hw_lpm_capable == 1)
3111 usb_set_usb2_hardware_lpm(udev, 1);
Sarah Sharp83060952012-05-02 14:25:52 -07003112
Sarah Sharpf74631e2012-06-25 12:08:08 -07003113 /* Try to enable USB3 LTM and LPM */
3114 usb_enable_ltm(udev);
Sarah Sharp83060952012-05-02 14:25:52 -07003115 usb_unlocked_enable_lpm(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04003116 }
Andiry Xu65580b432011-09-23 14:19:52 -07003117
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118 return status;
3119}
3120
Alan Stern8808f002008-04-28 11:06:55 -04003121/* caller has locked udev */
Alan Stern0534d462010-01-08 12:56:30 -05003122int usb_remote_wakeup(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003123{
3124 int status = 0;
3125
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04003127 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern9bbdf1e2010-01-08 12:57:28 -05003128 status = usb_autoresume_device(udev);
3129 if (status == 0) {
3130 /* Let the drivers do their thing, then... */
3131 usb_autosuspend_device(udev);
3132 }
Alan Sternd25450c2006-11-20 11:14:30 -05003133 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134 return status;
3135}
3136
Alan Sternd388dab2006-07-01 22:14:24 -04003137#else /* CONFIG_USB_SUSPEND */
3138
3139/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
3140
Alan Stern65bfd292008-11-25 16:39:18 -05003141int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04003142{
3143 return 0;
3144}
3145
Alan Sternb01b03f2008-04-28 11:06:11 -04003146/* However we may need to do a reset-resume */
3147
Alan Stern65bfd292008-11-25 16:39:18 -05003148int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Alan Sternd388dab2006-07-01 22:14:24 -04003149{
Alan Sternb01b03f2008-04-28 11:06:11 -04003150 struct usb_hub *hub = hdev_to_hub(udev->parent);
3151 int port1 = udev->portnum;
3152 int status;
3153 u16 portchange, portstatus;
Alan Stern54515fe2007-05-30 15:38:58 -04003154
Alan Sternb01b03f2008-04-28 11:06:11 -04003155 status = hub_port_status(hub, port1, &portstatus, &portchange);
3156 status = check_port_resume_type(udev,
3157 hub, port1, status, portchange, portstatus);
3158
3159 if (status) {
3160 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3161 hub_port_logical_disconnect(hub, port1);
3162 } else if (udev->reset_resume) {
Alan Stern54515fe2007-05-30 15:38:58 -04003163 dev_dbg(&udev->dev, "reset-resume\n");
Ming Lei742120c2008-06-18 22:00:29 +08003164 status = usb_reset_and_verify_device(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04003165 }
3166 return status;
Alan Sternd388dab2006-07-01 22:14:24 -04003167}
3168
Alan Sternd388dab2006-07-01 22:14:24 -04003169#endif
3170
Ming Leie6f30de2012-10-24 11:59:24 +08003171static int check_ports_changed(struct usb_hub *hub)
3172{
3173 int port1;
3174
3175 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3176 u16 portstatus, portchange;
3177 int status;
3178
3179 status = hub_port_status(hub, port1, &portstatus, &portchange);
3180 if (!status && portchange)
3181 return 1;
3182 }
3183 return 0;
3184}
3185
David Brownelldb690872005-09-13 19:56:33 -07003186static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187{
3188 struct usb_hub *hub = usb_get_intfdata (intf);
3189 struct usb_device *hdev = hub->hdev;
3190 unsigned port1;
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003191 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192
Alan Sterncbb33002011-06-15 16:29:16 -04003193 /* Warn if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3195 struct usb_device *udev;
3196
Lan Tianyuff823c72012-09-05 13:44:32 +08003197 udev = hub->ports[port1 - 1]->child;
Alan Stern6840d252007-09-10 11:34:26 -04003198 if (udev && udev->can_submit) {
Alan Sterncbb33002011-06-15 16:29:16 -04003199 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
Alan Stern5b1b0b82011-08-19 23:49:48 +02003200 if (PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04003201 return -EBUSY;
David Brownellc9f89fa2005-09-13 19:57:04 -07003202 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003203 }
Ming Leie6f30de2012-10-24 11:59:24 +08003204
3205 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3206 /* check if there are changes pending on hub ports */
3207 if (check_ports_changed(hub)) {
3208 if (PMSG_IS_AUTO(msg))
3209 return -EBUSY;
3210 pm_wakeup_event(&hdev->dev, 2000);
3211 }
3212 }
3213
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003214 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3215 /* Enable hub to send remote wakeup for all ports. */
3216 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3217 status = set_port_feature(hdev,
3218 port1 |
3219 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3220 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3221 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3222 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3223 }
3224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225
Harvey Harrison441b62c2008-03-03 16:08:34 -08003226 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Stern40f122f2006-11-09 14:44:33 -05003227
David Brownellc9f89fa2005-09-13 19:57:04 -07003228 /* stop khubd and related activity */
Alan Stern43303542008-04-28 11:07:31 -04003229 hub_quiesce(hub, HUB_SUSPEND);
Alan Sternb6f64362007-05-04 11:51:54 -04003230 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231}
3232
3233static int hub_resume(struct usb_interface *intf)
3234{
Alan Stern5e6effa2008-03-03 15:15:51 -05003235 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236
Alan Stern5e6effa2008-03-03 15:15:51 -05003237 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003238 hub_activate(hub, HUB_RESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239 return 0;
3240}
3241
Alan Sternb41a60e2007-05-30 15:39:33 -04003242static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04003243{
Alan Sternb41a60e2007-05-30 15:39:33 -04003244 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04003245
Alan Stern5e6effa2008-03-03 15:15:51 -05003246 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003247 hub_activate(hub, HUB_RESET_RESUME);
Alan Sternf07600c2007-05-30 15:38:16 -04003248 return 0;
3249}
3250
Alan Stern54515fe2007-05-30 15:38:58 -04003251/**
3252 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3253 * @rhdev: struct usb_device for the root hub
3254 *
3255 * The USB host controller driver calls this function when its root hub
3256 * is resumed and Vbus power has been interrupted or the controller
Alan Sternfeccc302008-03-03 15:15:59 -05003257 * has been reset. The routine marks @rhdev as having lost power.
3258 * When the hub driver is resumed it will take notice and carry out
3259 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3260 * the others will be disconnected.
Alan Stern54515fe2007-05-30 15:38:58 -04003261 */
3262void usb_root_hub_lost_power(struct usb_device *rhdev)
3263{
3264 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3265 rhdev->reset_resume = 1;
3266}
3267EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3268
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003269static const char * const usb3_lpm_names[] = {
3270 "U0",
3271 "U1",
3272 "U2",
3273 "U3",
3274};
3275
3276/*
3277 * Send a Set SEL control transfer to the device, prior to enabling
3278 * device-initiated U1 or U2. This lets the device know the exit latencies from
3279 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3280 * packet from the host.
3281 *
3282 * This function will fail if the SEL or PEL values for udev are greater than
3283 * the maximum allowed values for the link state to be enabled.
3284 */
3285static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3286{
3287 struct usb_set_sel_req *sel_values;
3288 unsigned long long u1_sel;
3289 unsigned long long u1_pel;
3290 unsigned long long u2_sel;
3291 unsigned long long u2_pel;
3292 int ret;
3293
3294 /* Convert SEL and PEL stored in ns to us */
3295 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3296 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3297 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3298 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3299
3300 /*
3301 * Make sure that the calculated SEL and PEL values for the link
3302 * state we're enabling aren't bigger than the max SEL/PEL
3303 * value that will fit in the SET SEL control transfer.
3304 * Otherwise the device would get an incorrect idea of the exit
3305 * latency for the link state, and could start a device-initiated
3306 * U1/U2 when the exit latencies are too high.
3307 */
3308 if ((state == USB3_LPM_U1 &&
3309 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3310 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3311 (state == USB3_LPM_U2 &&
3312 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3313 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
Sarah Sharp1510a1a2012-10-05 10:30:35 -07003314 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003315 usb3_lpm_names[state], u1_sel, u1_pel);
3316 return -EINVAL;
3317 }
3318
3319 /*
3320 * If we're enabling device-initiated LPM for one link state,
3321 * but the other link state has a too high SEL or PEL value,
3322 * just set those values to the max in the Set SEL request.
3323 */
3324 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3325 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3326
3327 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3328 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3329
3330 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3331 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3332
3333 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3334 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3335
3336 /*
3337 * usb_enable_lpm() can be called as part of a failed device reset,
3338 * which may be initiated by an error path of a mass storage driver.
3339 * Therefore, use GFP_NOIO.
3340 */
3341 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3342 if (!sel_values)
3343 return -ENOMEM;
3344
3345 sel_values->u1_sel = u1_sel;
3346 sel_values->u1_pel = u1_pel;
3347 sel_values->u2_sel = cpu_to_le16(u2_sel);
3348 sel_values->u2_pel = cpu_to_le16(u2_pel);
3349
3350 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3351 USB_REQ_SET_SEL,
3352 USB_RECIP_DEVICE,
3353 0, 0,
3354 sel_values, sizeof *(sel_values),
3355 USB_CTRL_SET_TIMEOUT);
3356 kfree(sel_values);
3357 return ret;
3358}
3359
3360/*
3361 * Enable or disable device-initiated U1 or U2 transitions.
3362 */
3363static int usb_set_device_initiated_lpm(struct usb_device *udev,
3364 enum usb3_link_state state, bool enable)
3365{
3366 int ret;
3367 int feature;
3368
3369 switch (state) {
3370 case USB3_LPM_U1:
3371 feature = USB_DEVICE_U1_ENABLE;
3372 break;
3373 case USB3_LPM_U2:
3374 feature = USB_DEVICE_U2_ENABLE;
3375 break;
3376 default:
3377 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3378 __func__, enable ? "enable" : "disable");
3379 return -EINVAL;
3380 }
3381
3382 if (udev->state != USB_STATE_CONFIGURED) {
3383 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3384 "for unconfigured device.\n",
3385 __func__, enable ? "enable" : "disable",
3386 usb3_lpm_names[state]);
3387 return 0;
3388 }
3389
3390 if (enable) {
3391 /*
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003392 * Now send the control transfer to enable device-initiated LPM
3393 * for either U1 or U2.
3394 */
3395 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3396 USB_REQ_SET_FEATURE,
3397 USB_RECIP_DEVICE,
3398 feature,
3399 0, NULL, 0,
3400 USB_CTRL_SET_TIMEOUT);
3401 } else {
3402 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3403 USB_REQ_CLEAR_FEATURE,
3404 USB_RECIP_DEVICE,
3405 feature,
3406 0, NULL, 0,
3407 USB_CTRL_SET_TIMEOUT);
3408 }
3409 if (ret < 0) {
3410 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3411 enable ? "Enable" : "Disable",
3412 usb3_lpm_names[state]);
3413 return -EBUSY;
3414 }
3415 return 0;
3416}
3417
3418static int usb_set_lpm_timeout(struct usb_device *udev,
3419 enum usb3_link_state state, int timeout)
3420{
3421 int ret;
3422 int feature;
3423
3424 switch (state) {
3425 case USB3_LPM_U1:
3426 feature = USB_PORT_FEAT_U1_TIMEOUT;
3427 break;
3428 case USB3_LPM_U2:
3429 feature = USB_PORT_FEAT_U2_TIMEOUT;
3430 break;
3431 default:
3432 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3433 __func__);
3434 return -EINVAL;
3435 }
3436
3437 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3438 timeout != USB3_LPM_DEVICE_INITIATED) {
3439 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3440 "which is a reserved value.\n",
3441 usb3_lpm_names[state], timeout);
3442 return -EINVAL;
3443 }
3444
3445 ret = set_port_feature(udev->parent,
3446 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3447 feature);
3448 if (ret < 0) {
3449 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3450 "error code %i\n", usb3_lpm_names[state],
3451 timeout, ret);
3452 return -EBUSY;
3453 }
3454 if (state == USB3_LPM_U1)
3455 udev->u1_params.timeout = timeout;
3456 else
3457 udev->u2_params.timeout = timeout;
3458 return 0;
3459}
3460
3461/*
3462 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3463 * U1/U2 entry.
3464 *
3465 * We will attempt to enable U1 or U2, but there are no guarantees that the
3466 * control transfers to set the hub timeout or enable device-initiated U1/U2
3467 * will be successful.
3468 *
3469 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3470 * driver know about it. If that call fails, it should be harmless, and just
3471 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3472 */
3473static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3474 enum usb3_link_state state)
3475{
Sarah Sharp65a95b72012-10-05 10:32:07 -07003476 int timeout, ret;
Sarah Sharpae8963a2012-10-03 11:18:05 -07003477 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3478 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3479
3480 /* If the device says it doesn't have *any* exit latency to come out of
3481 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3482 * state.
3483 */
3484 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3485 (state == USB3_LPM_U2 && u2_mel == 0))
3486 return;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003487
Sarah Sharp65a95b72012-10-05 10:32:07 -07003488 /*
3489 * First, let the device know about the exit latencies
3490 * associated with the link state we're about to enable.
3491 */
3492 ret = usb_req_set_sel(udev, state);
3493 if (ret < 0) {
3494 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3495 usb3_lpm_names[state]);
3496 return;
3497 }
3498
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003499 /* We allow the host controller to set the U1/U2 timeout internally
3500 * first, so that it can change its schedule to account for the
3501 * additional latency to send data to a device in a lower power
3502 * link state.
3503 */
3504 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3505
3506 /* xHCI host controller doesn't want to enable this LPM state. */
3507 if (timeout == 0)
3508 return;
3509
3510 if (timeout < 0) {
3511 dev_warn(&udev->dev, "Could not enable %s link state, "
3512 "xHCI error %i.\n", usb3_lpm_names[state],
3513 timeout);
3514 return;
3515 }
3516
3517 if (usb_set_lpm_timeout(udev, state, timeout))
3518 /* If we can't set the parent hub U1/U2 timeout,
3519 * device-initiated LPM won't be allowed either, so let the xHCI
3520 * host know that this link state won't be enabled.
3521 */
3522 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3523
3524 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3525 else if (udev->actconfig)
3526 usb_set_device_initiated_lpm(udev, state, true);
3527
3528}
3529
3530/*
3531 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3532 * U1/U2 entry.
3533 *
3534 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3535 * If zero is returned, the parent will not allow the link to go into U1/U2.
3536 *
3537 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3538 * it won't have an effect on the bus link state because the parent hub will
3539 * still disallow device-initiated U1/U2 entry.
3540 *
3541 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3542 * possible. The result will be slightly more bus bandwidth will be taken up
3543 * (to account for U1/U2 exit latency), but it should be harmless.
3544 */
3545static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3546 enum usb3_link_state state)
3547{
3548 int feature;
3549
3550 switch (state) {
3551 case USB3_LPM_U1:
3552 feature = USB_PORT_FEAT_U1_TIMEOUT;
3553 break;
3554 case USB3_LPM_U2:
3555 feature = USB_PORT_FEAT_U2_TIMEOUT;
3556 break;
3557 default:
3558 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3559 __func__);
3560 return -EINVAL;
3561 }
3562
3563 if (usb_set_lpm_timeout(udev, state, 0))
3564 return -EBUSY;
3565
3566 usb_set_device_initiated_lpm(udev, state, false);
3567
3568 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3569 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3570 "bus schedule bandwidth may be impacted.\n",
3571 usb3_lpm_names[state]);
3572 return 0;
3573}
3574
3575/*
3576 * Disable hub-initiated and device-initiated U1 and U2 entry.
3577 * Caller must own the bandwidth_mutex.
3578 *
3579 * This will call usb_enable_lpm() on failure, which will decrement
3580 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3581 */
3582int usb_disable_lpm(struct usb_device *udev)
3583{
3584 struct usb_hcd *hcd;
3585
3586 if (!udev || !udev->parent ||
3587 udev->speed != USB_SPEED_SUPER ||
3588 !udev->lpm_capable)
3589 return 0;
3590
3591 hcd = bus_to_hcd(udev->bus);
3592 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3593 return 0;
3594
3595 udev->lpm_disable_count++;
Dan Carpenter55558c32012-05-22 20:54:34 +03003596 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003597 return 0;
3598
3599 /* If LPM is enabled, attempt to disable it. */
3600 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3601 goto enable_lpm;
3602 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3603 goto enable_lpm;
3604
3605 return 0;
3606
3607enable_lpm:
3608 usb_enable_lpm(udev);
3609 return -EBUSY;
3610}
3611EXPORT_SYMBOL_GPL(usb_disable_lpm);
3612
3613/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3614int usb_unlocked_disable_lpm(struct usb_device *udev)
3615{
3616 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3617 int ret;
3618
3619 if (!hcd)
3620 return -EINVAL;
3621
3622 mutex_lock(hcd->bandwidth_mutex);
3623 ret = usb_disable_lpm(udev);
3624 mutex_unlock(hcd->bandwidth_mutex);
3625
3626 return ret;
3627}
3628EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3629
3630/*
3631 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3632 * xHCI host policy may prevent U1 or U2 from being enabled.
3633 *
3634 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3635 * until the lpm_disable_count drops to zero. Caller must own the
3636 * bandwidth_mutex.
3637 */
3638void usb_enable_lpm(struct usb_device *udev)
3639{
3640 struct usb_hcd *hcd;
3641
3642 if (!udev || !udev->parent ||
3643 udev->speed != USB_SPEED_SUPER ||
3644 !udev->lpm_capable)
3645 return;
3646
3647 udev->lpm_disable_count--;
3648 hcd = bus_to_hcd(udev->bus);
3649 /* Double check that we can both enable and disable LPM.
3650 * Device must be configured to accept set feature U1/U2 timeout.
3651 */
3652 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
3653 !hcd->driver->disable_usb3_lpm_timeout)
3654 return;
3655
3656 if (udev->lpm_disable_count > 0)
3657 return;
3658
3659 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
3660 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
3661}
3662EXPORT_SYMBOL_GPL(usb_enable_lpm);
3663
3664/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
3665void usb_unlocked_enable_lpm(struct usb_device *udev)
3666{
3667 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3668
3669 if (!hcd)
3670 return;
3671
3672 mutex_lock(hcd->bandwidth_mutex);
3673 usb_enable_lpm(udev);
3674 mutex_unlock(hcd->bandwidth_mutex);
3675}
3676EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
3677
3678
Alan Sternd388dab2006-07-01 22:14:24 -04003679#else /* CONFIG_PM */
3680
Alan Sternf07600c2007-05-30 15:38:16 -04003681#define hub_suspend NULL
3682#define hub_resume NULL
3683#define hub_reset_resume NULL
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003684
3685int usb_disable_lpm(struct usb_device *udev)
3686{
3687 return 0;
3688}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07003689EXPORT_SYMBOL_GPL(usb_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003690
3691void usb_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07003692EXPORT_SYMBOL_GPL(usb_enable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003693
3694int usb_unlocked_disable_lpm(struct usb_device *udev)
3695{
3696 return 0;
3697}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07003698EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003699
3700void usb_unlocked_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07003701EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
Sarah Sharpf74631e2012-06-25 12:08:08 -07003702
3703int usb_disable_ltm(struct usb_device *udev)
3704{
3705 return 0;
3706}
3707EXPORT_SYMBOL_GPL(usb_disable_ltm);
3708
3709void usb_enable_ltm(struct usb_device *udev) { }
3710EXPORT_SYMBOL_GPL(usb_enable_ltm);
Alan Sternd388dab2006-07-01 22:14:24 -04003711#endif
3712
Linus Torvalds1da177e2005-04-16 15:20:36 -07003713
3714/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
3715 *
3716 * Between connect detection and reset signaling there must be a delay
3717 * of 100ms at least for debounce and power-settling. The corresponding
3718 * timer shall restart whenever the downstream port detects a disconnect.
3719 *
3720 * Apparently there are some bluetooth and irda-dongles and a number of
3721 * low-speed devices for which this debounce period may last over a second.
3722 * Not covered by the spec - but easy to deal with.
3723 *
3724 * This implementation uses a 1500ms total debounce timeout; if the
3725 * connection isn't stable by then it returns -ETIMEDOUT. It checks
3726 * every 25ms for transient disconnects. When the port status has been
3727 * unchanged for 100ms it returns the port status.
3728 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003729static int hub_port_debounce(struct usb_hub *hub, int port1)
3730{
3731 int ret;
3732 int total_time, stable_time = 0;
3733 u16 portchange, portstatus;
3734 unsigned connection = 0xffff;
3735
3736 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
3737 ret = hub_port_status(hub, port1, &portstatus, &portchange);
3738 if (ret < 0)
3739 return ret;
3740
3741 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
3742 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
3743 stable_time += HUB_DEBOUNCE_STEP;
3744 if (stable_time >= HUB_DEBOUNCE_STABLE)
3745 break;
3746 } else {
3747 stable_time = 0;
3748 connection = portstatus & USB_PORT_STAT_CONNECTION;
3749 }
3750
3751 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3752 clear_port_feature(hub->hdev, port1,
3753 USB_PORT_FEAT_C_CONNECTION);
3754 }
3755
3756 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
3757 break;
3758 msleep(HUB_DEBOUNCE_STEP);
3759 }
3760
3761 dev_dbg (hub->intfdev,
3762 "debounce: port %d: total %dms stable %dms status 0x%x\n",
3763 port1, total_time, stable_time, portstatus);
3764
3765 if (stable_time < HUB_DEBOUNCE_STABLE)
3766 return -ETIMEDOUT;
3767 return portstatus;
3768}
3769
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003770void usb_ep0_reinit(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003771{
Alan Sternddeac4e72009-01-15 17:03:33 -05003772 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
3773 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
Alan Stern2caf7fc2008-12-31 11:31:33 -05003774 usb_enable_endpoint(udev, &udev->ep0, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003775}
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003776EXPORT_SYMBOL_GPL(usb_ep0_reinit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003777
3778#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
3779#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
3780
Alan Stern4326ed02007-07-30 17:08:43 -04003781static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003782{
3783 int retval;
Sarah Sharpc6515272009-04-27 19:57:26 -07003784 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003785
Sarah Sharpc6515272009-04-27 19:57:26 -07003786 /*
3787 * The host controller will choose the device address,
3788 * instead of the core having chosen it earlier
3789 */
3790 if (!hcd->driver->address_device && devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003791 return -EINVAL;
3792 if (udev->state == USB_STATE_ADDRESS)
3793 return 0;
3794 if (udev->state != USB_STATE_DEFAULT)
3795 return -EINVAL;
Andiry Xuc8d4af82010-10-14 07:22:51 -07003796 if (hcd->driver->address_device)
Sarah Sharpc6515272009-04-27 19:57:26 -07003797 retval = hcd->driver->address_device(hcd, udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07003798 else
Sarah Sharpc6515272009-04-27 19:57:26 -07003799 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
3800 USB_REQ_SET_ADDRESS, 0, devnum, 0,
3801 NULL, 0, USB_CTRL_SET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003802 if (retval == 0) {
Alan Stern3b29b682011-02-22 09:53:41 -05003803 update_devnum(udev, devnum);
David Vrabel4953d142008-04-08 13:24:46 -07003804 /* Device now using proper address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003805 usb_set_device_state(udev, USB_STATE_ADDRESS);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07003806 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003807 }
3808 return retval;
3809}
3810
3811/* Reset device, (re)assign address, get device descriptor.
3812 * Device connection must be stable, no more debouncing needed.
3813 * Returns device in USB_STATE_ADDRESS, except on error.
3814 *
3815 * If this is called for an already-existing device (as part of
Ming Lei742120c2008-06-18 22:00:29 +08003816 * usb_reset_and_verify_device), the caller must own the device lock. For a
Linus Torvalds1da177e2005-04-16 15:20:36 -07003817 * newly detected device that is not accessible through any global
3818 * pointers, it's not necessary to lock the device.
3819 */
3820static int
3821hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
3822 int retry_counter)
3823{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01003824 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003825
3826 struct usb_device *hdev = hub->hdev;
Sarah Sharpe7b77172009-04-27 19:54:26 -07003827 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003828 int i, j, retval;
3829 unsigned delay = HUB_SHORT_RESET_TIME;
3830 enum usb_device_speed oldspeed = udev->speed;
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02003831 const char *speed;
Alan Stern4326ed02007-07-30 17:08:43 -04003832 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003833
3834 /* root hub ports have a slightly longer reset period
3835 * (from USB 2.0 spec, section 7.1.7.5)
3836 */
3837 if (!hdev->parent) {
3838 delay = HUB_ROOT_RESET_TIME;
3839 if (port1 == hdev->bus->otg_port)
3840 hdev->bus->b_hnp_enable = 0;
3841 }
3842
3843 /* Some low speed devices have problems with the quick delay, so */
3844 /* be a bit pessimistic with those devices. RHbug #23670 */
3845 if (oldspeed == USB_SPEED_LOW)
3846 delay = HUB_LONG_RESET_TIME;
3847
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01003848 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003849
Luben Tuikov07194ab2011-02-11 11:33:10 -08003850 /* Reset the device; full speed may morph to high speed */
3851 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
Andiry Xu75d7cf72011-09-13 16:41:11 -07003852 retval = hub_port_reset(hub, port1, udev, delay, false);
Luben Tuikov07194ab2011-02-11 11:33:10 -08003853 if (retval < 0) /* error or disconnect */
3854 goto fail;
3855 /* success, speed is known */
3856
Linus Torvalds1da177e2005-04-16 15:20:36 -07003857 retval = -ENODEV;
3858
3859 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
3860 dev_dbg(&udev->dev, "device reset changed speed!\n");
3861 goto fail;
3862 }
3863 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04003864
Linus Torvalds1da177e2005-04-16 15:20:36 -07003865 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
3866 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07003867 * For Wireless USB devices, ep0 max packet is always 512 (tho
3868 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07003869 */
3870 switch (udev->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -07003871 case USB_SPEED_SUPER:
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08003872 case USB_SPEED_WIRELESS: /* fixed at 512 */
Harvey Harrison551509d2009-02-11 14:11:36 -08003873 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07003874 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003875 case USB_SPEED_HIGH: /* fixed at 64 */
Harvey Harrison551509d2009-02-11 14:11:36 -08003876 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003877 break;
3878 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
3879 /* to determine the ep0 maxpacket size, try to read
3880 * the device descriptor to get bMaxPacketSize0 and
3881 * then correct our initial guess.
3882 */
Harvey Harrison551509d2009-02-11 14:11:36 -08003883 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003884 break;
3885 case USB_SPEED_LOW: /* fixed at 8 */
Harvey Harrison551509d2009-02-11 14:11:36 -08003886 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003887 break;
3888 default:
3889 goto fail;
3890 }
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02003891
3892 if (udev->speed == USB_SPEED_WIRELESS)
3893 speed = "variable speed Wireless";
3894 else
3895 speed = usb_speed_string(udev->speed);
3896
Sarah Sharpc6515272009-04-27 19:57:26 -07003897 if (udev->speed != USB_SPEED_SUPER)
3898 dev_info(&udev->dev,
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02003899 "%s %s USB device number %d using %s\n",
3900 (udev->config) ? "reset" : "new", speed,
Alan Stern3b29b682011-02-22 09:53:41 -05003901 devnum, udev->bus->controller->driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003902
3903 /* Set up TT records, if needed */
3904 if (hdev->tt) {
3905 udev->tt = hdev->tt;
3906 udev->ttport = hdev->ttport;
3907 } else if (udev->speed != USB_SPEED_HIGH
3908 && hdev->speed == USB_SPEED_HIGH) {
Alan Sternd199c962011-01-31 10:56:37 -05003909 if (!hub->tt.hub) {
3910 dev_err(&udev->dev, "parent hub has no TT\n");
3911 retval = -EINVAL;
3912 goto fail;
3913 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003914 udev->tt = &hub->tt;
3915 udev->ttport = port1;
3916 }
3917
3918 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
3919 * Because device hardware and firmware is sometimes buggy in
3920 * this area, and this is how Linux has done it for ages.
3921 * Change it cautiously.
3922 *
3923 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
3924 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
3925 * so it may help with some non-standards-compliant devices.
3926 * Otherwise we start with SET_ADDRESS and then try to read the
3927 * first 8 bytes of the device descriptor to get the ep0 maxpacket
3928 * value.
3929 */
3930 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
Sarah Sharpc6515272009-04-27 19:57:26 -07003931 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003932 struct usb_device_descriptor *buf;
3933 int r = 0;
3934
3935#define GET_DESCRIPTOR_BUFSIZE 64
3936 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
3937 if (!buf) {
3938 retval = -ENOMEM;
3939 continue;
3940 }
3941
Alan Sternb89ee192007-05-11 10:19:04 -04003942 /* Retry on all errors; some devices are flakey.
3943 * 255 is for WUSB devices, we actually need to use
3944 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07003945 */
3946 for (j = 0; j < 3; ++j) {
3947 buf->bMaxPacketSize0 = 0;
3948 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
3949 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
3950 USB_DT_DEVICE << 8, 0,
3951 buf, GET_DESCRIPTOR_BUFSIZE,
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +02003952 initial_descriptor_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003953 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07003954 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003955 if (buf->bDescriptorType ==
3956 USB_DT_DEVICE) {
3957 r = 0;
3958 break;
3959 }
3960 /* FALL THROUGH */
3961 default:
3962 if (r == 0)
3963 r = -EPROTO;
3964 break;
3965 }
3966 if (r == 0)
3967 break;
3968 }
3969 udev->descriptor.bMaxPacketSize0 =
3970 buf->bMaxPacketSize0;
3971 kfree(buf);
3972
Andiry Xu75d7cf72011-09-13 16:41:11 -07003973 retval = hub_port_reset(hub, port1, udev, delay, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003974 if (retval < 0) /* error or disconnect */
3975 goto fail;
3976 if (oldspeed != udev->speed) {
3977 dev_dbg(&udev->dev,
3978 "device reset changed speed!\n");
3979 retval = -ENODEV;
3980 goto fail;
3981 }
3982 if (r) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08003983 dev_err(&udev->dev,
3984 "device descriptor read/64, error %d\n",
3985 r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003986 retval = -EMSGSIZE;
3987 continue;
3988 }
3989#undef GET_DESCRIPTOR_BUFSIZE
3990 }
3991
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07003992 /*
3993 * If device is WUSB, we already assigned an
3994 * unauthorized address in the Connect Ack sequence;
3995 * authorization will assign the final address.
3996 */
Sarah Sharpc6515272009-04-27 19:57:26 -07003997 if (udev->wusb == 0) {
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07003998 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3999 retval = hub_set_address(udev, devnum);
4000 if (retval >= 0)
4001 break;
4002 msleep(200);
4003 }
4004 if (retval < 0) {
4005 dev_err(&udev->dev,
4006 "device not accepting address %d, error %d\n",
4007 devnum, retval);
4008 goto fail;
4009 }
Sarah Sharpc6515272009-04-27 19:57:26 -07004010 if (udev->speed == USB_SPEED_SUPER) {
4011 devnum = udev->devnum;
4012 dev_info(&udev->dev,
Alan Stern3b29b682011-02-22 09:53:41 -05004013 "%s SuperSpeed USB device number %d using %s\n",
Sarah Sharpc6515272009-04-27 19:57:26 -07004014 (udev->config) ? "reset" : "new",
Alan Stern3b29b682011-02-22 09:53:41 -05004015 devnum, udev->bus->controller->driver->name);
Sarah Sharpc6515272009-04-27 19:57:26 -07004016 }
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004017
4018 /* cope with hardware quirkiness:
4019 * - let SET_ADDRESS settle, some device hardware wants it
4020 * - read ep0 maxpacket even for high and low speed,
4021 */
4022 msleep(10);
Sarah Sharpc6515272009-04-27 19:57:26 -07004023 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004024 break;
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004025 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004026
4027 retval = usb_get_device_descriptor(udev, 8);
4028 if (retval < 8) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08004029 dev_err(&udev->dev,
4030 "device descriptor read/8, error %d\n",
4031 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004032 if (retval >= 0)
4033 retval = -EMSGSIZE;
4034 } else {
4035 retval = 0;
4036 break;
4037 }
4038 }
4039 if (retval)
4040 goto fail;
4041
Peter Chenb76baa82012-11-09 09:44:43 +08004042 if (hcd->phy && !hdev->parent)
Peter Chenac965112012-11-09 09:44:44 +08004043 usb_phy_notify_connect(hcd->phy, udev->speed);
Peter Chenb76baa82012-11-09 09:44:43 +08004044
Elric Fud8aec3d2012-03-26 21:16:02 +08004045 /*
4046 * Some superspeed devices have finished the link training process
4047 * and attached to a superspeed hub port, but the device descriptor
4048 * got from those devices show they aren't superspeed devices. Warm
4049 * reset the port attached by the devices can fix them.
4050 */
4051 if ((udev->speed == USB_SPEED_SUPER) &&
4052 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4053 dev_err(&udev->dev, "got a wrong device descriptor, "
4054 "warm reset device\n");
4055 hub_port_reset(hub, port1, udev,
4056 HUB_BH_RESET_TIME, true);
4057 retval = -EINVAL;
4058 goto fail;
4059 }
4060
Sarah Sharp6b403b02009-04-27 19:54:10 -07004061 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4062 udev->speed == USB_SPEED_SUPER)
4063 i = 512;
4064 else
4065 i = udev->descriptor.bMaxPacketSize0;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07004066 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
Alan Stern56626a72010-10-14 15:25:21 -04004067 if (udev->speed == USB_SPEED_LOW ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07004068 !(i == 8 || i == 16 || i == 32 || i == 64)) {
Alan Stern56626a72010-10-14 15:25:21 -04004069 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004070 retval = -EMSGSIZE;
4071 goto fail;
4072 }
Alan Stern56626a72010-10-14 15:25:21 -04004073 if (udev->speed == USB_SPEED_FULL)
4074 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4075 else
4076 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004077 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004078 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004079 }
4080
4081 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4082 if (retval < (signed)sizeof(udev->descriptor)) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08004083 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4084 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004085 if (retval >= 0)
4086 retval = -ENOMSG;
4087 goto fail;
4088 }
4089
Andiry Xu1ff4df52011-09-23 14:19:48 -07004090 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4091 retval = usb_get_bos_descriptor(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004092 if (!retval) {
Sarah Sharpd9b20992012-02-20 08:31:26 -08004093 udev->lpm_capable = usb_device_supports_lpm(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004094 usb_set_lpm_parameters(udev);
4095 }
Andiry Xu1ff4df52011-09-23 14:19:48 -07004096 }
Andiry Xu3148bf02011-09-23 14:19:47 -07004097
Linus Torvalds1da177e2005-04-16 15:20:36 -07004098 retval = 0;
Alek Du48f24972010-06-04 15:47:55 +08004099 /* notify HCD that we have a device connected and addressed */
4100 if (hcd->driver->update_device)
4101 hcd->driver->update_device(hcd, udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004102fail:
Alan Stern4326ed02007-07-30 17:08:43 -04004103 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004104 hub_port_disable(hub, port1, 0);
Alan Stern3b29b682011-02-22 09:53:41 -05004105 update_devnum(udev, devnum); /* for disconnect processing */
Alan Stern4326ed02007-07-30 17:08:43 -04004106 }
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01004107 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004108 return retval;
4109}
4110
4111static void
4112check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4113{
4114 struct usb_qualifier_descriptor *qual;
4115 int status;
4116
Christoph Lametere94b1762006-12-06 20:33:17 -08004117 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004118 if (qual == NULL)
4119 return;
4120
4121 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4122 qual, sizeof *qual);
4123 if (status == sizeof *qual) {
4124 dev_info(&udev->dev, "not running at top speed; "
4125 "connect to a high speed hub\n");
4126 /* hub LEDs are probably harder to miss than syslog */
4127 if (hub->has_indicators) {
4128 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00004129 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004130 }
4131 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07004132 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004133}
4134
4135static unsigned
4136hub_power_remaining (struct usb_hub *hub)
4137{
4138 struct usb_device *hdev = hub->hdev;
4139 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05004140 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004141
Alan Stern55c52712005-11-23 12:03:12 -05004142 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004143 return 0;
4144
Alan Stern55c52712005-11-23 12:03:12 -05004145 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4146 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Lan Tianyuff823c72012-09-05 13:44:32 +08004147 struct usb_device *udev = hub->ports[port1 - 1]->child;
Alan Stern55c52712005-11-23 12:03:12 -05004148 int delta;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004149 unsigned unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004150
4151 if (!udev)
4152 continue;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004153 if (hub_is_superspeed(udev))
4154 unit_load = 150;
4155 else
4156 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004157
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004158 /*
4159 * Unconfigured devices may not use more than one unit load,
4160 * or 8mA for OTG ports
4161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004162 if (udev->actconfig)
Sebastian Andrzej Siewior8d8479d2012-12-18 15:25:46 +01004163 delta = usb_get_max_power(udev, udev->actconfig);
Alan Stern55c52712005-11-23 12:03:12 -05004164 else if (port1 != udev->bus->otg_port || hdev->parent)
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004165 delta = unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004166 else
Alan Stern55c52712005-11-23 12:03:12 -05004167 delta = 8;
4168 if (delta > hub->mA_per_port)
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08004169 dev_warn(&udev->dev,
4170 "%dmA is over %umA budget for port %d!\n",
4171 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004172 remaining -= delta;
4173 }
4174 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05004175 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4176 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004177 remaining = 0;
4178 }
4179 return remaining;
4180}
4181
4182/* Handle physical or logical connection change events.
4183 * This routine is called when:
4184 * a port connection-change occurs;
4185 * a port enable-change occurs (often caused by EMI);
Ming Lei742120c2008-06-18 22:00:29 +08004186 * usb_reset_and_verify_device() encounters changed descriptors (as from
Linus Torvalds1da177e2005-04-16 15:20:36 -07004187 * a firmware download)
4188 * caller already locked the hub
4189 */
4190static void hub_port_connect_change(struct usb_hub *hub, int port1,
4191 u16 portstatus, u16 portchange)
4192{
4193 struct usb_device *hdev = hub->hdev;
4194 struct device *hub_dev = hub->intfdev;
Balaji Rao90da0962007-11-22 01:58:14 +05304195 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Alan Stern24618b02008-04-28 11:06:28 -04004196 unsigned wHubCharacteristics =
4197 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Alan Stern8808f002008-04-28 11:06:55 -04004198 struct usb_device *udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004199 int status, i;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004200 unsigned unit_load;
Alan Stern24618b02008-04-28 11:06:28 -04004201
Linus Torvalds1da177e2005-04-16 15:20:36 -07004202 dev_dbg (hub_dev,
4203 "port %d, status %04x, change %04x, %s\n",
Sarah Sharp131dec32010-12-06 21:00:19 -08004204 port1, portstatus, portchange, portspeed(hub, portstatus));
Linus Torvalds1da177e2005-04-16 15:20:36 -07004205
4206 if (hub->has_indicators) {
4207 set_port_led(hub, port1, HUB_LED_AUTO);
4208 hub->indicator[port1-1] = INDICATOR_AUTO;
4209 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004210
4211#ifdef CONFIG_USB_OTG
4212 /* during HNP, don't repeat the debounce */
4213 if (hdev->bus->is_b_host)
Alan Stern24618b02008-04-28 11:06:28 -04004214 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4215 USB_PORT_STAT_C_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004216#endif
4217
Alan Stern8808f002008-04-28 11:06:55 -04004218 /* Try to resuscitate an existing device */
Lan Tianyuff823c72012-09-05 13:44:32 +08004219 udev = hub->ports[port1 - 1]->child;
Alan Stern8808f002008-04-28 11:06:55 -04004220 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4221 udev->state != USB_STATE_NOTATTACHED) {
Alan Stern8808f002008-04-28 11:06:55 -04004222 usb_lock_device(udev);
4223 if (portstatus & USB_PORT_STAT_ENABLE) {
4224 status = 0; /* Nothing to do */
Alan Stern8808f002008-04-28 11:06:55 -04004225
4226#ifdef CONFIG_USB_SUSPEND
Alan Stern5257d972008-09-22 14:43:08 -04004227 } else if (udev->state == USB_STATE_SUSPENDED &&
4228 udev->persist_enabled) {
Alan Stern8808f002008-04-28 11:06:55 -04004229 /* For a suspended device, treat this as a
4230 * remote wakeup event.
4231 */
Alan Stern0534d462010-01-08 12:56:30 -05004232 status = usb_remote_wakeup(udev);
Alan Stern8808f002008-04-28 11:06:55 -04004233#endif
4234
4235 } else {
Alan Stern5257d972008-09-22 14:43:08 -04004236 status = -ENODEV; /* Don't resuscitate */
Alan Stern8808f002008-04-28 11:06:55 -04004237 }
4238 usb_unlock_device(udev);
4239
4240 if (status == 0) {
4241 clear_bit(port1, hub->change_bits);
4242 return;
4243 }
4244 }
4245
Alan Stern24618b02008-04-28 11:06:28 -04004246 /* Disconnect any existing devices under this port */
Peter Chenb76baa82012-11-09 09:44:43 +08004247 if (udev) {
4248 if (hcd->phy && !hdev->parent &&
4249 !(portstatus & USB_PORT_STAT_CONNECTION))
Peter Chenac965112012-11-09 09:44:44 +08004250 usb_phy_notify_disconnect(hcd->phy, udev->speed);
Lan Tianyuff823c72012-09-05 13:44:32 +08004251 usb_disconnect(&hub->ports[port1 - 1]->child);
Peter Chenb76baa82012-11-09 09:44:43 +08004252 }
Alan Stern24618b02008-04-28 11:06:28 -04004253 clear_bit(port1, hub->change_bits);
4254
Alan Stern253e0572009-10-27 15:20:13 -04004255 /* We can forget about a "removed" device when there's a physical
4256 * disconnect or the connect status changes.
4257 */
4258 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4259 (portchange & USB_PORT_STAT_C_CONNECTION))
4260 clear_bit(port1, hub->removed_bits);
4261
Alan Stern5257d972008-09-22 14:43:08 -04004262 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4263 USB_PORT_STAT_C_ENABLE)) {
4264 status = hub_port_debounce(hub, port1);
4265 if (status < 0) {
4266 if (printk_ratelimit())
4267 dev_err(hub_dev, "connect-debounce failed, "
4268 "port %d disabled\n", port1);
4269 portstatus &= ~USB_PORT_STAT_CONNECTION;
4270 } else {
4271 portstatus = status;
4272 }
4273 }
4274
Alan Stern253e0572009-10-27 15:20:13 -04004275 /* Return now if debouncing failed or nothing is connected or
4276 * the device was "removed".
4277 */
4278 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4279 test_bit(port1, hub->removed_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004280
4281 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07004282 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Andiry Xu0ed9a572011-04-27 18:07:43 +08004283 && !port_is_power_on(hub, portstatus))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004284 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
Alan Stern5257d972008-09-22 14:43:08 -04004285
Linus Torvalds1da177e2005-04-16 15:20:36 -07004286 if (portstatus & USB_PORT_STAT_ENABLE)
4287 goto done;
4288 return;
4289 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004290 if (hub_is_superspeed(hub->hdev))
4291 unit_load = 150;
4292 else
4293 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004294
Linus Torvalds1da177e2005-04-16 15:20:36 -07004295 for (i = 0; i < SET_CONFIG_TRIES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004296
4297 /* reallocate for each attempt, since references
4298 * to the previous one can escape in various ways
4299 */
4300 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4301 if (!udev) {
4302 dev_err (hub_dev,
4303 "couldn't allocate port %d usb_device\n",
4304 port1);
4305 goto done;
4306 }
4307
4308 usb_set_device_state(udev, USB_STATE_POWERED);
Alan Stern55c52712005-11-23 12:03:12 -05004309 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04004310 udev->level = hdev->level + 1;
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07004311 udev->wusb = hub_is_wusb(hub);
Alan Stern55c52712005-11-23 12:03:12 -05004312
Sarah Sharp131dec32010-12-06 21:00:19 -08004313 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4314 if (hub_is_superspeed(hub->hdev))
Sarah Sharpe7b77172009-04-27 19:54:26 -07004315 udev->speed = USB_SPEED_SUPER;
4316 else
4317 udev->speed = USB_SPEED_UNKNOWN;
4318
Alan Stern3b29b682011-02-22 09:53:41 -05004319 choose_devnum(udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07004320 if (udev->devnum <= 0) {
4321 status = -ENOTCONN; /* Don't retry */
4322 goto loop;
Sarah Sharpc6515272009-04-27 19:57:26 -07004323 }
4324
Sarah Sharpe7b77172009-04-27 19:54:26 -07004325 /* reset (non-USB 3.0 devices) and get descriptor */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004326 status = hub_port_init(hub, udev, port1, i);
4327 if (status < 0)
4328 goto loop;
4329
Phil Dibowitz93362a82010-07-22 00:05:01 +02004330 usb_detect_quirks(udev);
4331 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4332 msleep(1000);
4333
Linus Torvalds1da177e2005-04-16 15:20:36 -07004334 /* consecutive bus-powered hubs aren't reliable; they can
4335 * violate the voltage drop budget. if the new child has
4336 * a "powered" LED, users should notice we didn't enable it
4337 * (without reading syslog), even without per-port LEDs
4338 * on the parent.
4339 */
4340 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004341 && udev->bus_mA <= unit_load) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004342 u16 devstat;
4343
4344 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4345 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05004346 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004347 dev_dbg(&udev->dev, "get status %d ?\n", status);
4348 goto loop_disable;
4349 }
Alan Stern55c52712005-11-23 12:03:12 -05004350 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004351 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4352 dev_err(&udev->dev,
4353 "can't connect bus-powered hub "
4354 "to this port\n");
4355 if (hub->has_indicators) {
4356 hub->indicator[port1-1] =
4357 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00004358 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004359 }
4360 status = -ENOTCONN; /* Don't retry */
4361 goto loop_disable;
4362 }
4363 }
4364
4365 /* check for devices running slower than they could */
4366 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4367 && udev->speed == USB_SPEED_FULL
4368 && highspeed_hubs != 0)
4369 check_highspeed (hub, udev, port1);
4370
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07004371 /* Store the parent's children[] pointer. At this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07004372 * udev becomes globally accessible, although presumably
4373 * no one will look at it until hdev is unlocked.
4374 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004375 status = 0;
4376
4377 /* We mustn't add new devices if the parent hub has
4378 * been disconnected; we would race with the
4379 * recursively_mark_NOTATTACHED() routine.
4380 */
4381 spin_lock_irq(&device_state_lock);
4382 if (hdev->state == USB_STATE_NOTATTACHED)
4383 status = -ENOTCONN;
4384 else
Lan Tianyuff823c72012-09-05 13:44:32 +08004385 hub->ports[port1 - 1]->child = udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004386 spin_unlock_irq(&device_state_lock);
4387
4388 /* Run it through the hoops (find a driver, etc) */
4389 if (!status) {
4390 status = usb_new_device(udev);
4391 if (status) {
4392 spin_lock_irq(&device_state_lock);
Lan Tianyuff823c72012-09-05 13:44:32 +08004393 hub->ports[port1 - 1]->child = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004394 spin_unlock_irq(&device_state_lock);
4395 }
4396 }
4397
Linus Torvalds1da177e2005-04-16 15:20:36 -07004398 if (status)
4399 goto loop_disable;
4400
4401 status = hub_power_remaining(hub);
4402 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05004403 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004404
4405 return;
4406
4407loop_disable:
4408 hub_port_disable(hub, port1, 1);
4409loop:
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004410 usb_ep0_reinit(udev);
Alan Stern3b29b682011-02-22 09:53:41 -05004411 release_devnum(udev);
Herbert Xuf7410ce2010-01-10 20:15:03 +11004412 hub_free_dev(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004413 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07004414 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004415 break;
4416 }
Alan Stern3a311552008-05-20 16:58:29 -04004417 if (hub->hdev->parent ||
4418 !hcd->driver->port_handed_over ||
4419 !(hcd->driver->port_handed_over)(hcd, port1))
4420 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4421 port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004422
4423done:
4424 hub_port_disable(hub, port1, 1);
Balaji Rao90da0962007-11-22 01:58:14 +05304425 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4426 hcd->driver->relinquish_port(hcd, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004427}
4428
Sarah Sharp714b07b2012-01-24 13:53:18 -08004429/* Returns 1 if there was a remote wakeup and a connect status change. */
4430static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
Sarah Sharp72937e12012-01-24 11:46:50 -08004431 u16 portstatus, u16 portchange)
Sarah Sharp714b07b2012-01-24 13:53:18 -08004432{
4433 struct usb_device *hdev;
4434 struct usb_device *udev;
4435 int connect_change = 0;
4436 int ret;
4437
4438 hdev = hub->hdev;
Lan Tianyuff823c72012-09-05 13:44:32 +08004439 udev = hub->ports[port - 1]->child;
Sarah Sharp4ee823b2011-11-14 18:00:01 -08004440 if (!hub_is_superspeed(hdev)) {
4441 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4442 return 0;
4443 clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4444 } else {
4445 if (!udev || udev->state != USB_STATE_SUSPENDED ||
Sarah Sharp72937e12012-01-24 11:46:50 -08004446 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4447 USB_SS_PORT_LS_U0)
Sarah Sharp4ee823b2011-11-14 18:00:01 -08004448 return 0;
4449 }
4450
Sarah Sharp714b07b2012-01-24 13:53:18 -08004451 if (udev) {
4452 /* TRSMRCY = 10 msec */
4453 msleep(10);
4454
4455 usb_lock_device(udev);
4456 ret = usb_remote_wakeup(udev);
4457 usb_unlock_device(udev);
4458 if (ret < 0)
4459 connect_change = 1;
4460 } else {
4461 ret = -ENODEV;
4462 hub_port_disable(hub, port, 1);
4463 }
4464 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4465 port, ret);
4466 return connect_change;
4467}
4468
Linus Torvalds1da177e2005-04-16 15:20:36 -07004469static void hub_events(void)
4470{
4471 struct list_head *tmp;
4472 struct usb_device *hdev;
4473 struct usb_interface *intf;
4474 struct usb_hub *hub;
4475 struct device *hub_dev;
4476 u16 hubstatus;
4477 u16 hubchange;
4478 u16 portstatus;
4479 u16 portchange;
4480 int i, ret;
Sarah Sharp4ee823b2011-11-14 18:00:01 -08004481 int connect_change, wakeup_change;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004482
4483 /*
4484 * We restart the list every time to avoid a deadlock with
4485 * deleting hubs downstream from this one. This should be
4486 * safe since we delete the hub from the event list.
4487 * Not the most efficient, but avoids deadlocks.
4488 */
4489 while (1) {
4490
4491 /* Grab the first entry at the beginning of the list */
4492 spin_lock_irq(&hub_event_lock);
4493 if (list_empty(&hub_event_list)) {
4494 spin_unlock_irq(&hub_event_lock);
4495 break;
4496 }
4497
4498 tmp = hub_event_list.next;
4499 list_del_init(tmp);
4500
4501 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04004502 kref_get(&hub->kref);
4503 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004504
Alan Sterne8054852007-05-04 11:55:11 -04004505 hdev = hub->hdev;
4506 hub_dev = hub->intfdev;
4507 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05004508 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07004509 hdev->state, hub->descriptor
4510 ? hub->descriptor->bNbrPorts
4511 : 0,
4512 /* NOTE: expects max 15 ports... */
4513 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05004514 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004515
Linus Torvalds1da177e2005-04-16 15:20:36 -07004516 /* Lock the device, then check to see if we were
4517 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04004518 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04004519 if (unlikely(hub->disconnected))
Alan Stern9bbdf1e2010-01-08 12:57:28 -05004520 goto loop_disconnected;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004521
4522 /* If the hub has died, clean up after it */
4523 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04004524 hub->error = -ENODEV;
Alan Stern43303542008-04-28 11:07:31 -04004525 hub_quiesce(hub, HUB_DISCONNECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004526 goto loop;
4527 }
4528
Alan Stern40f122f2006-11-09 14:44:33 -05004529 /* Autoresume */
4530 ret = usb_autopm_get_interface(intf);
4531 if (ret) {
4532 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004533 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05004534 }
4535
4536 /* If this is an inactive hub, do nothing */
4537 if (hub->quiescing)
4538 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004539
4540 if (hub->error) {
4541 dev_dbg (hub_dev, "resetting for error %d\n",
4542 hub->error);
4543
Ming Lei742120c2008-06-18 22:00:29 +08004544 ret = usb_reset_device(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004545 if (ret) {
4546 dev_dbg (hub_dev,
4547 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05004548 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004549 }
4550
4551 hub->nerrors = 0;
4552 hub->error = 0;
4553 }
4554
4555 /* deal with port status changes */
4556 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
4557 if (test_bit(i, hub->busy_bits))
4558 continue;
4559 connect_change = test_bit(i, hub->change_bits);
Sarah Sharp72937e12012-01-24 11:46:50 -08004560 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004561 if (!test_and_clear_bit(i, hub->event_bits) &&
Sarah Sharp4ee823b2011-11-14 18:00:01 -08004562 !connect_change && !wakeup_change)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004563 continue;
4564
4565 ret = hub_port_status(hub, i,
4566 &portstatus, &portchange);
4567 if (ret < 0)
4568 continue;
4569
Linus Torvalds1da177e2005-04-16 15:20:36 -07004570 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4571 clear_port_feature(hdev, i,
4572 USB_PORT_FEAT_C_CONNECTION);
4573 connect_change = 1;
4574 }
4575
4576 if (portchange & USB_PORT_STAT_C_ENABLE) {
4577 if (!connect_change)
4578 dev_dbg (hub_dev,
4579 "port %d enable change, "
4580 "status %08x\n",
4581 i, portstatus);
4582 clear_port_feature(hdev, i,
4583 USB_PORT_FEAT_C_ENABLE);
4584
4585 /*
4586 * EM interference sometimes causes badly
4587 * shielded USB devices to be shutdown by
4588 * the hub, this hack enables them again.
4589 * Works at least with mouse driver.
4590 */
4591 if (!(portstatus & USB_PORT_STAT_ENABLE)
4592 && !connect_change
Lan Tianyuff823c72012-09-05 13:44:32 +08004593 && hub->ports[i - 1]->child) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004594 dev_err (hub_dev,
4595 "port %i "
4596 "disabled by hub (EMI?), "
4597 "re-enabling...\n",
4598 i);
4599 connect_change = 1;
4600 }
4601 }
4602
Sarah Sharp72937e12012-01-24 11:46:50 -08004603 if (hub_handle_remote_wakeup(hub, i,
4604 portstatus, portchange))
Sarah Sharp714b07b2012-01-24 13:53:18 -08004605 connect_change = 1;
Alan Stern8808f002008-04-28 11:06:55 -04004606
Linus Torvalds1da177e2005-04-16 15:20:36 -07004607 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
Paul Bolle752d57a2011-03-11 18:03:52 +01004608 u16 status = 0;
4609 u16 unused;
4610
4611 dev_dbg(hub_dev, "over-current change on port "
4612 "%d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004613 clear_port_feature(hdev, i,
4614 USB_PORT_FEAT_C_OVER_CURRENT);
Paul Bolle752d57a2011-03-11 18:03:52 +01004615 msleep(100); /* Cool down */
Alan Stern8520f382008-09-22 14:44:26 -04004616 hub_power_on(hub, true);
Paul Bolle752d57a2011-03-11 18:03:52 +01004617 hub_port_status(hub, i, &status, &unused);
4618 if (status & USB_PORT_STAT_OVERCURRENT)
4619 dev_err(hub_dev, "over-current "
4620 "condition on port %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004621 }
4622
4623 if (portchange & USB_PORT_STAT_C_RESET) {
4624 dev_dbg (hub_dev,
4625 "reset change on port %d\n",
4626 i);
4627 clear_port_feature(hdev, i,
4628 USB_PORT_FEAT_C_RESET);
4629 }
Sarah Sharpc7061572010-12-06 15:08:20 -08004630 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
4631 hub_is_superspeed(hub->hdev)) {
4632 dev_dbg(hub_dev,
4633 "warm reset change on port %d\n",
4634 i);
4635 clear_port_feature(hdev, i,
4636 USB_PORT_FEAT_C_BH_PORT_RESET);
4637 }
John Youndbe79bb2001-09-17 00:00:00 -07004638 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4639 clear_port_feature(hub->hdev, i,
4640 USB_PORT_FEAT_C_PORT_LINK_STATE);
4641 }
4642 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4643 dev_warn(hub_dev,
4644 "config error on port %d\n",
4645 i);
4646 clear_port_feature(hub->hdev, i,
4647 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4648 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004649
Andiry Xu5e467f62011-04-27 18:07:54 +08004650 /* Warm reset a USB3 protocol port if it's in
4651 * SS.Inactive state.
4652 */
Stanislaw Ledwon8bea2bd2012-06-18 15:20:00 +02004653 if (hub_port_warm_reset_required(hub, portstatus)) {
Sarah Sharp65bdac52012-11-14 17:58:04 -08004654 int status;
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07004655 struct usb_device *udev =
4656 hub->ports[i - 1]->child;
Sarah Sharp65bdac52012-11-14 17:58:04 -08004657
Andiry Xu5e467f62011-04-27 18:07:54 +08004658 dev_dbg(hub_dev, "warm reset port %d\n", i);
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07004659 if (!udev) {
4660 status = hub_port_reset(hub, i,
4661 NULL, HUB_BH_RESET_TIME,
4662 true);
4663 if (status < 0)
4664 hub_port_disable(hub, i, 1);
4665 } else {
4666 usb_lock_device(udev);
4667 status = usb_reset_device(udev);
4668 usb_unlock_device(udev);
4669 }
Sarah Sharp65bdac52012-11-14 17:58:04 -08004670 connect_change = 0;
Andiry Xu5e467f62011-04-27 18:07:54 +08004671 }
4672
Linus Torvalds1da177e2005-04-16 15:20:36 -07004673 if (connect_change)
4674 hub_port_connect_change(hub, i,
4675 portstatus, portchange);
4676 } /* end for i */
4677
4678 /* deal with hub status changes */
4679 if (test_and_clear_bit(0, hub->event_bits) == 0)
4680 ; /* do nothing */
4681 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
4682 dev_err (hub_dev, "get_hub_status failed\n");
4683 else {
4684 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
4685 dev_dbg (hub_dev, "power change\n");
4686 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05004687 if (hubstatus & HUB_STATUS_LOCAL_POWER)
4688 /* FIXME: Is this always true? */
Alan Stern55c52712005-11-23 12:03:12 -05004689 hub->limited_power = 1;
jidong xiao403fae72007-09-14 00:08:51 +08004690 else
4691 hub->limited_power = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004692 }
4693 if (hubchange & HUB_CHANGE_OVERCURRENT) {
Paul Bolle752d57a2011-03-11 18:03:52 +01004694 u16 status = 0;
4695 u16 unused;
4696
4697 dev_dbg(hub_dev, "over-current change\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004698 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
Paul Bolle752d57a2011-03-11 18:03:52 +01004699 msleep(500); /* Cool down */
Alan Stern8520f382008-09-22 14:44:26 -04004700 hub_power_on(hub, true);
Paul Bolle752d57a2011-03-11 18:03:52 +01004701 hub_hub_status(hub, &status, &unused);
4702 if (status & HUB_STATUS_OVERCURRENT)
4703 dev_err(hub_dev, "over-current "
4704 "condition\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004705 }
4706 }
4707
Alan Stern8e4ceb32009-12-07 13:01:37 -05004708 loop_autopm:
4709 /* Balance the usb_autopm_get_interface() above */
4710 usb_autopm_put_interface_no_suspend(intf);
4711 loop:
4712 /* Balance the usb_autopm_get_interface_no_resume() in
4713 * kick_khubd() and allow autosuspend.
4714 */
4715 usb_autopm_put_interface(intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05004716 loop_disconnected:
Linus Torvalds1da177e2005-04-16 15:20:36 -07004717 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04004718 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004719
4720 } /* end while (1) */
4721}
4722
4723static int hub_thread(void *__unused)
4724{
Alan Stern3bb1af52008-03-03 15:15:36 -05004725 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
4726 * port handover. Otherwise it might see that a full-speed device
4727 * was gone before the EHCI controller had handed its port over to
4728 * the companion full-speed controller.
4729 */
Rafael J. Wysocki83144182007-07-17 04:03:35 -07004730 set_freezable();
Alan Stern3bb1af52008-03-03 15:15:36 -05004731
Linus Torvalds1da177e2005-04-16 15:20:36 -07004732 do {
4733 hub_events();
Rafael J. Wysockie42837b2007-10-18 03:04:45 -07004734 wait_event_freezable(khubd_wait,
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07004735 !list_empty(&hub_event_list) ||
4736 kthread_should_stop());
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07004737 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07004738
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07004739 pr_debug("%s: khubd exiting\n", usbcore_name);
4740 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004741}
4742
Németh Márton1e927d92010-01-10 15:34:53 +01004743static const struct usb_device_id hub_id_table[] = {
Ming Leie6f30de2012-10-24 11:59:24 +08004744 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
4745 | USB_DEVICE_ID_MATCH_INT_CLASS,
4746 .idVendor = USB_VENDOR_GENESYS_LOGIC,
4747 .bInterfaceClass = USB_CLASS_HUB,
4748 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
Linus Torvalds1da177e2005-04-16 15:20:36 -07004749 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
4750 .bDeviceClass = USB_CLASS_HUB},
4751 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
4752 .bInterfaceClass = USB_CLASS_HUB},
4753 { } /* Terminating entry */
4754};
4755
4756MODULE_DEVICE_TABLE (usb, hub_id_table);
4757
4758static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004759 .name = "hub",
4760 .probe = hub_probe,
4761 .disconnect = hub_disconnect,
4762 .suspend = hub_suspend,
4763 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04004764 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04004765 .pre_reset = hub_pre_reset,
4766 .post_reset = hub_post_reset,
Andi Kleenc532b292010-06-01 23:04:41 +02004767 .unlocked_ioctl = hub_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004768 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05004769 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004770};
4771
4772int usb_hub_init(void)
4773{
Linus Torvalds1da177e2005-04-16 15:20:36 -07004774 if (usb_register(&hub_driver) < 0) {
4775 printk(KERN_ERR "%s: can't register hub driver\n",
4776 usbcore_name);
4777 return -1;
4778 }
4779
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07004780 khubd_task = kthread_run(hub_thread, NULL, "khubd");
4781 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004782 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004783
4784 /* Fall through if kernel_thread failed */
4785 usb_deregister(&hub_driver);
4786 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
4787
4788 return -1;
4789}
4790
4791void usb_hub_cleanup(void)
4792{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07004793 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004794
4795 /*
4796 * Hub resources are freed for us by usb_deregister. It calls
4797 * usb_driver_purge on every device which in turn calls that
4798 * devices disconnect function if it is using this driver.
4799 * The hub_disconnect function takes care of releasing the
4800 * individual hub resources. -greg
4801 */
4802 usb_deregister(&hub_driver);
4803} /* usb_hub_cleanup() */
4804
Alan Sterneb764c42008-03-03 15:16:04 -05004805static int descriptors_changed(struct usb_device *udev,
4806 struct usb_device_descriptor *old_device_descriptor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004807{
Alan Sterneb764c42008-03-03 15:16:04 -05004808 int changed = 0;
4809 unsigned index;
4810 unsigned serial_len = 0;
4811 unsigned len;
4812 unsigned old_length;
4813 int length;
4814 char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004815
Alan Sterneb764c42008-03-03 15:16:04 -05004816 if (memcmp(&udev->descriptor, old_device_descriptor,
4817 sizeof(*old_device_descriptor)) != 0)
4818 return 1;
4819
4820 /* Since the idVendor, idProduct, and bcdDevice values in the
4821 * device descriptor haven't changed, we will assume the
4822 * Manufacturer and Product strings haven't changed either.
4823 * But the SerialNumber string could be different (e.g., a
4824 * different flash card of the same brand).
4825 */
4826 if (udev->serial)
4827 serial_len = strlen(udev->serial) + 1;
4828
4829 len = serial_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004830 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05004831 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
4832 len = max(len, old_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004833 }
Alan Sterneb764c42008-03-03 15:16:04 -05004834
Oliver Neukum0cc1a512008-01-10 10:31:48 +01004835 buf = kmalloc(len, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004836 if (buf == NULL) {
4837 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
4838 /* assume the worst */
4839 return 1;
4840 }
4841 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05004842 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004843 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
4844 old_length);
Alan Sterneb764c42008-03-03 15:16:04 -05004845 if (length != old_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004846 dev_dbg(&udev->dev, "config index %d, error %d\n",
4847 index, length);
Alan Sterneb764c42008-03-03 15:16:04 -05004848 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004849 break;
4850 }
4851 if (memcmp (buf, udev->rawdescriptors[index], old_length)
4852 != 0) {
4853 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
Alan Sterneb764c42008-03-03 15:16:04 -05004854 index,
4855 ((struct usb_config_descriptor *) buf)->
4856 bConfigurationValue);
4857 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004858 break;
4859 }
4860 }
Alan Sterneb764c42008-03-03 15:16:04 -05004861
4862 if (!changed && serial_len) {
4863 length = usb_string(udev, udev->descriptor.iSerialNumber,
4864 buf, serial_len);
4865 if (length + 1 != serial_len) {
4866 dev_dbg(&udev->dev, "serial string error %d\n",
4867 length);
4868 changed = 1;
4869 } else if (memcmp(buf, udev->serial, length) != 0) {
4870 dev_dbg(&udev->dev, "serial string changed\n");
4871 changed = 1;
4872 }
4873 }
4874
Linus Torvalds1da177e2005-04-16 15:20:36 -07004875 kfree(buf);
Alan Sterneb764c42008-03-03 15:16:04 -05004876 return changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004877}
4878
4879/**
Ming Lei742120c2008-06-18 22:00:29 +08004880 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
Linus Torvalds1da177e2005-04-16 15:20:36 -07004881 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
4882 *
Alan Stern79efa092006-06-01 13:33:42 -04004883 * WARNING - don't use this routine to reset a composite device
4884 * (one with multiple interfaces owned by separate drivers)!
Ming Lei742120c2008-06-18 22:00:29 +08004885 * Use usb_reset_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004886 *
4887 * Do a port reset, reassign the device's address, and establish its
4888 * former operating configuration. If the reset fails, or the device's
4889 * descriptors change from their values before the reset, or the original
4890 * configuration and altsettings cannot be restored, a flag will be set
4891 * telling khubd to pretend the device has been disconnected and then
4892 * re-connected. All drivers will be unbound, and the device will be
4893 * re-enumerated and probed all over again.
4894 *
4895 * Returns 0 if the reset succeeded, -ENODEV if the device has been
4896 * flagged for logical disconnection, or some other negative error code
4897 * if the reset wasn't even attempted.
4898 *
4899 * The caller must own the device lock. For example, it's safe to use
4900 * this from a driver probe() routine after downloading new firmware.
4901 * For calls that might not occur during probe(), drivers should lock
4902 * the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04004903 *
4904 * Locking exception: This routine may also be called from within an
4905 * autoresume handler. Such usage won't conflict with other tasks
4906 * holding the device lock because these tasks should always call
4907 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004908 */
Ming Lei742120c2008-06-18 22:00:29 +08004909static int usb_reset_and_verify_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004910{
4911 struct usb_device *parent_hdev = udev->parent;
4912 struct usb_hub *parent_hub;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08004913 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004914 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05004915 int i, ret = 0;
4916 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004917
4918 if (udev->state == USB_STATE_NOTATTACHED ||
4919 udev->state == USB_STATE_SUSPENDED) {
4920 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4921 udev->state);
4922 return -EINVAL;
4923 }
4924
4925 if (!parent_hdev) {
Wolfram Sang4bec9912010-08-29 18:17:14 +02004926 /* this requires hcd-specific logic; see ohci_restart() */
Harvey Harrison441b62c2008-03-03 16:08:34 -08004927 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004928 return -EISDIR;
4929 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004930 parent_hub = hdev_to_hub(parent_hdev);
4931
Sarah Sharpf74631e2012-06-25 12:08:08 -07004932 /* Disable LPM and LTM while we reset the device and reinstall the alt
4933 * settings. Device-initiated LPM settings, and system exit latency
4934 * settings are cleared when the device is reset, so we have to set
4935 * them up again.
Sarah Sharp6d1d0512012-07-03 22:49:04 -07004936 */
4937 ret = usb_unlocked_disable_lpm(udev);
4938 if (ret) {
4939 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
4940 goto re_enumerate;
4941 }
Sarah Sharpf74631e2012-06-25 12:08:08 -07004942 ret = usb_disable_ltm(udev);
4943 if (ret) {
4944 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
4945 __func__);
4946 goto re_enumerate;
4947 }
Sarah Sharp6d1d0512012-07-03 22:49:04 -07004948
Linus Torvalds1da177e2005-04-16 15:20:36 -07004949 set_bit(port1, parent_hub->busy_bits);
4950 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
4951
4952 /* ep0 maxpacket size may change; let the HCD know about it.
4953 * Other endpoints will be handled by re-enumeration. */
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004954 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004955 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04004956 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004957 break;
4958 }
4959 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04004960
Linus Torvalds1da177e2005-04-16 15:20:36 -07004961 if (ret < 0)
4962 goto re_enumerate;
4963
4964 /* Device might have changed firmware (DFU or similar) */
Alan Sterneb764c42008-03-03 15:16:04 -05004965 if (descriptors_changed(udev, &descriptor)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004966 dev_info(&udev->dev, "device firmware changed\n");
4967 udev->descriptor = descriptor; /* for disconnect() calls */
4968 goto re_enumerate;
4969 }
Alan Stern4fe03872009-02-26 10:21:02 -05004970
4971 /* Restore the device's previous configuration */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004972 if (!udev->actconfig)
4973 goto done;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08004974
Sarah Sharpd673bfc2010-10-15 08:55:24 -07004975 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08004976 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
4977 if (ret < 0) {
4978 dev_warn(&udev->dev,
4979 "Busted HC? Not enough HCD resources for "
4980 "old configuration.\n");
Sarah Sharpd673bfc2010-10-15 08:55:24 -07004981 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08004982 goto re_enumerate;
4983 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004984 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4985 USB_REQ_SET_CONFIGURATION, 0,
4986 udev->actconfig->desc.bConfigurationValue, 0,
4987 NULL, 0, USB_CTRL_SET_TIMEOUT);
4988 if (ret < 0) {
4989 dev_err(&udev->dev,
4990 "can't restore configuration #%d (error=%d)\n",
4991 udev->actconfig->desc.bConfigurationValue, ret);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07004992 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004993 goto re_enumerate;
4994 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07004995 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004996 usb_set_device_state(udev, USB_STATE_CONFIGURED);
4997
Alan Stern4fe03872009-02-26 10:21:02 -05004998 /* Put interfaces back into the same altsettings as before.
4999 * Don't bother to send the Set-Interface request for interfaces
5000 * that were already in altsetting 0; besides being unnecessary,
5001 * many devices can't handle it. Instead just reset the host-side
5002 * endpoint state.
5003 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005004 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005005 struct usb_host_config *config = udev->actconfig;
5006 struct usb_interface *intf = config->interface[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07005007 struct usb_interface_descriptor *desc;
5008
Linus Torvalds1da177e2005-04-16 15:20:36 -07005009 desc = &intf->cur_altsetting->desc;
Alan Stern4fe03872009-02-26 10:21:02 -05005010 if (desc->bAlternateSetting == 0) {
5011 usb_disable_interface(udev, intf, true);
5012 usb_enable_interface(udev, intf, true);
5013 ret = 0;
5014 } else {
Sarah Sharp04a723e2010-01-06 10:16:51 -08005015 /* Let the bandwidth allocation function know that this
5016 * device has been reset, and it will have to use
5017 * alternate setting 0 as the current alternate setting.
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005018 */
Sarah Sharp04a723e2010-01-06 10:16:51 -08005019 intf->resetting_device = 1;
Alan Stern4fe03872009-02-26 10:21:02 -05005020 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5021 desc->bAlternateSetting);
Sarah Sharp04a723e2010-01-06 10:16:51 -08005022 intf->resetting_device = 0;
Alan Stern4fe03872009-02-26 10:21:02 -05005023 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005024 if (ret < 0) {
5025 dev_err(&udev->dev, "failed to restore interface %d "
5026 "altsetting %d (error=%d)\n",
5027 desc->bInterfaceNumber,
5028 desc->bAlternateSetting,
5029 ret);
5030 goto re_enumerate;
5031 }
5032 }
5033
5034done:
Sarah Sharpf74631e2012-06-25 12:08:08 -07005035 /* Now that the alt settings are re-installed, enable LTM and LPM. */
Alan Stern78d9a482008-06-23 16:00:40 -04005036 usb_unlocked_enable_lpm(udev);
Sarah Sharpf74631e2012-06-25 12:08:08 -07005037 usb_enable_ltm(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005038 return 0;
5039
5040re_enumerate:
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005041 /* LPM state doesn't matter when we're about to destroy the device. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005042 hub_port_logical_disconnect(parent_hub, port1);
5043 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005044}
5045
5046/**
5047 * usb_reset_device - warn interface drivers and perform a USB port reset
5048 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5049 *
Alan Stern79efa092006-06-01 13:33:42 -04005050 * Warns all drivers bound to registered interfaces (using their pre_reset
5051 * method), performs the port reset, and then lets the drivers know that
Ming Lei742120c2008-06-18 22:00:29 +08005052 * the reset is over (using their post_reset method).
Alan Stern79efa092006-06-01 13:33:42 -04005053 *
Alan Stern79efa092006-06-01 13:33:42 -04005054 * Return value is the same as for usb_reset_and_verify_device().
5055 *
5056 * The caller must own the device lock. For example, it's safe to use
5057 * this from a driver probe() routine after downloading new firmware.
5058 * For calls that might not occur during probe(), drivers should lock
Ming Lei742120c2008-06-18 22:00:29 +08005059 * the device using usb_lock_device_for_reset().
Alan Stern79efa092006-06-01 13:33:42 -04005060 *
5061 * If an interface is currently being probed or disconnected, we assume
5062 * its driver knows how to handle resets. For all other interfaces,
5063 * if the driver doesn't have pre_reset and post_reset methods then
5064 * we attempt to unbind it and rebind afterward.
Alan Stern79efa092006-06-01 13:33:42 -04005065 */
Ming Lei742120c2008-06-18 22:00:29 +08005066int usb_reset_device(struct usb_device *udev)
Alan Stern79efa092006-06-01 13:33:42 -04005067{
5068 int ret;
Alan Stern852c4b42007-12-03 15:44:29 -05005069 int i;
Alan Stern79efa092006-06-01 13:33:42 -04005070 struct usb_host_config *config = udev->actconfig;
5071
5072 if (udev->state == USB_STATE_NOTATTACHED ||
5073 udev->state == USB_STATE_SUSPENDED) {
5074 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5075 udev->state);
5076 return -EINVAL;
5077 }
5078
Alan Stern645daaa2006-08-30 15:47:02 -04005079 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05005080 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04005081
Alan Stern79efa092006-06-01 13:33:42 -04005082 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005083 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005084 struct usb_interface *cintf = config->interface[i];
5085 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005086 int unbind = 0;
Alan Stern852c4b42007-12-03 15:44:29 -05005087
5088 if (cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005089 drv = to_usb_driver(cintf->dev.driver);
Alan Stern78d9a482008-06-23 16:00:40 -04005090 if (drv->pre_reset && drv->post_reset)
5091 unbind = (drv->pre_reset)(cintf);
5092 else if (cintf->condition ==
5093 USB_INTERFACE_BOUND)
5094 unbind = 1;
5095 if (unbind)
5096 usb_forced_unbind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04005097 }
5098 }
5099 }
5100
Ming Lei742120c2008-06-18 22:00:29 +08005101 ret = usb_reset_and_verify_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04005102
5103 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005104 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005105 struct usb_interface *cintf = config->interface[i];
5106 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005107 int rebind = cintf->needs_binding;
Alan Stern852c4b42007-12-03 15:44:29 -05005108
Alan Stern78d9a482008-06-23 16:00:40 -04005109 if (!rebind && cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005110 drv = to_usb_driver(cintf->dev.driver);
5111 if (drv->post_reset)
Alan Stern78d9a482008-06-23 16:00:40 -04005112 rebind = (drv->post_reset)(cintf);
5113 else if (cintf->condition ==
5114 USB_INTERFACE_BOUND)
5115 rebind = 1;
Alan Stern79efa092006-06-01 13:33:42 -04005116 }
Alan Stern6c640942008-10-21 15:40:03 -04005117 if (ret == 0 && rebind)
Alan Stern78d9a482008-06-23 16:00:40 -04005118 usb_rebind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04005119 }
5120 }
5121
Alan Stern94fcda12006-11-20 11:38:46 -05005122 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04005123 return ret;
5124}
Ming Lei742120c2008-06-18 22:00:29 +08005125EXPORT_SYMBOL_GPL(usb_reset_device);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005126
5127
5128/**
5129 * usb_queue_reset_device - Reset a USB device from an atomic context
5130 * @iface: USB interface belonging to the device to reset
5131 *
5132 * This function can be used to reset a USB device from an atomic
5133 * context, where usb_reset_device() won't work (as it blocks).
5134 *
5135 * Doing a reset via this method is functionally equivalent to calling
5136 * usb_reset_device(), except for the fact that it is delayed to a
5137 * workqueue. This means that any drivers bound to other interfaces
5138 * might be unbound, as well as users from usbfs in user space.
5139 *
5140 * Corner cases:
5141 *
5142 * - Scheduling two resets at the same time from two different drivers
5143 * attached to two different interfaces of the same device is
5144 * possible; depending on how the driver attached to each interface
5145 * handles ->pre_reset(), the second reset might happen or not.
5146 *
5147 * - If a driver is unbound and it had a pending reset, the reset will
5148 * be cancelled.
5149 *
5150 * - This function can be called during .probe() or .disconnect()
5151 * times. On return from .disconnect(), any pending resets will be
5152 * cancelled.
5153 *
5154 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5155 * does its own.
5156 *
5157 * NOTE: We don't do any reference count tracking because it is not
5158 * needed. The lifecycle of the work_struct is tied to the
5159 * usb_interface. Before destroying the interface we cancel the
5160 * work_struct, so the fact that work_struct is queued and or
5161 * running means the interface (and thus, the device) exist and
5162 * are referenced.
5163 */
5164void usb_queue_reset_device(struct usb_interface *iface)
5165{
5166 schedule_work(&iface->reset_ws);
5167}
5168EXPORT_SYMBOL_GPL(usb_queue_reset_device);
Lan Tianyuff823c72012-09-05 13:44:32 +08005169
5170/**
5171 * usb_hub_find_child - Get the pointer of child device
5172 * attached to the port which is specified by @port1.
5173 * @hdev: USB device belonging to the usb hub
5174 * @port1: port num to indicate which port the child device
5175 * is attached to.
5176 *
5177 * USB drivers call this function to get hub's child device
5178 * pointer.
5179 *
5180 * Return NULL if input param is invalid and
5181 * child's usb_device pointer if non-NULL.
5182 */
5183struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5184 int port1)
5185{
5186 struct usb_hub *hub = hdev_to_hub(hdev);
5187
5188 if (port1 < 1 || port1 > hdev->maxchild)
5189 return NULL;
5190 return hub->ports[port1 - 1]->child;
5191}
5192EXPORT_SYMBOL_GPL(usb_hub_find_child);
Lan Tianyud5575422012-09-05 13:44:33 +08005193
Lan Tianyu05f91682012-09-05 13:44:34 +08005194/**
5195 * usb_set_hub_port_connect_type - set hub port connect type.
5196 * @hdev: USB device belonging to the usb hub
5197 * @port1: port num of the port
5198 * @type: connect type of the port
5199 */
5200void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5201 enum usb_port_connect_type type)
5202{
5203 struct usb_hub *hub = hdev_to_hub(hdev);
5204
5205 hub->ports[port1 - 1]->connect_type = type;
5206}
5207
5208/**
5209 * usb_get_hub_port_connect_type - Get the port's connect type
5210 * @hdev: USB device belonging to the usb hub
5211 * @port1: port num of the port
5212 *
5213 * Return connect type of the port and if input params are
5214 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5215 */
5216enum usb_port_connect_type
5217usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5218{
5219 struct usb_hub *hub = hdev_to_hub(hdev);
5220
5221 return hub->ports[port1 - 1]->connect_type;
5222}
5223
Lan Tianyud2123fd2013-01-21 22:18:00 +08005224void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5225 struct usb_hub_descriptor *desc)
5226{
5227 enum usb_port_connect_type connect_type;
5228 int i;
5229
5230 if (!hub_is_superspeed(hdev)) {
5231 for (i = 1; i <= hdev->maxchild; i++) {
5232 connect_type = usb_get_hub_port_connect_type(hdev, i);
5233
5234 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5235 u8 mask = 1 << (i%8);
5236
5237 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5238 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5239 i);
5240 desc->u.hs.DeviceRemovable[i/8] |= mask;
5241 }
5242 }
5243 }
5244 } else {
5245 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5246
5247 for (i = 1; i <= hdev->maxchild; i++) {
5248 connect_type = usb_get_hub_port_connect_type(hdev, i);
5249
5250 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5251 u16 mask = 1 << i;
5252
5253 if (!(port_removable & mask)) {
5254 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5255 i);
5256 port_removable |= mask;
5257 }
5258 }
5259 }
5260
5261 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5262 }
5263}
5264
Lan Tianyud5575422012-09-05 13:44:33 +08005265#ifdef CONFIG_ACPI
5266/**
5267 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5268 * @hdev: USB device belonging to the usb hub
5269 * @port1: port num of the port
5270 *
5271 * Return port's acpi handle if successful, NULL if params are
5272 * invaild.
5273 */
5274acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5275 int port1)
5276{
5277 struct usb_hub *hub = hdev_to_hub(hdev);
5278
5279 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
5280}
5281#endif