blob: 46f5161c78913c75678ae3416f4031099b880090 [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>
Lan Tianyuad493e52013-01-23 04:26:30 +080029#include <linux/pm_qos.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <asm/uaccess.h>
32#include <asm/byteorder.h>
33
Lan Tianyu6e30d7c2013-01-11 20:10:38 +080034#include "hub.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Ming Leie6f30de2012-10-24 11:59:24 +080036#define USB_VENDOR_GENESYS_LOGIC 0x05e3
37#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
38
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -070039/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050040 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42static DEFINE_SPINLOCK(device_state_lock);
43
44/* khubd's worklist and its lock */
45static DEFINE_SPINLOCK(hub_event_lock);
46static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
47
48/* Wakes up khubd */
49static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
50
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070051static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Dan Williamsd8521af2014-05-20 18:08:28 -070053/* synchronize hub-port add/remove and peering operations */
54DEFINE_MUTEX(usb_port_peer_mutex);
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/* cycle leds on hubs that aren't blinking for attention */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103057static bool blinkenlights = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058module_param (blinkenlights, bool, S_IRUGO);
59MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
60
61/*
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020062 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
63 * 10 seconds to send reply for the initial 64-byte descriptor request.
64 */
65/* define initial 64-byte descriptor request timeout in milliseconds */
66static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
67module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
Wu Fengguangb9cef6c2008-12-15 15:32:01 +080068MODULE_PARM_DESC(initial_descriptor_timeout,
69 "initial 64-byte descriptor request timeout in milliseconds "
70 "(default 5000 - 5.0 seconds)");
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020071
72/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * As of 2.6.10 we introduce a new USB device initialization scheme which
74 * closely resembles the way Windows works. Hopefully it will be compatible
75 * with a wider range of devices than the old scheme. However some previously
76 * working devices may start giving rise to "device not accepting address"
77 * errors; if that happens the user can try the old scheme by adjusting the
78 * following module parameters.
79 *
80 * For maximum flexibility there are two boolean parameters to control the
81 * hub driver's behavior. On the first initialization attempt, if the
82 * "old_scheme_first" parameter is set then the old scheme will be used,
83 * otherwise the new scheme is used. If that fails and "use_both_schemes"
84 * is set, then the driver will make another attempt, using the other scheme.
85 */
Rusty Russell90ab5ee2012-01-13 09:32:20 +103086static bool old_scheme_first = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
88MODULE_PARM_DESC(old_scheme_first,
89 "start with the old device initialization scheme");
90
Rusty Russell90ab5ee2012-01-13 09:32:20 +103091static bool use_both_schemes = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
93MODULE_PARM_DESC(use_both_schemes,
94 "try the other device initialization scheme if the "
95 "first one fails");
96
Alan Stern32fe0192007-10-10 16:27:07 -040097/* Mutual exclusion for EHCI CF initialization. This interferes with
98 * port reset on some companion controllers.
99 */
100DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
101EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
102
Lan Tianyuad493e52013-01-23 04:26:30 +0800103#define HUB_DEBOUNCE_TIMEOUT 2000
Alan Stern948fea32008-04-28 11:07:07 -0400104#define HUB_DEBOUNCE_STEP 25
105#define HUB_DEBOUNCE_STABLE 100
106
Ming Lei742120c2008-06-18 22:00:29 +0800107static int usb_reset_and_verify_device(struct usb_device *udev);
108
Sarah Sharp131dec32010-12-06 21:00:19 -0800109static inline char *portspeed(struct usb_hub *hub, int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
Sarah Sharp131dec32010-12-06 21:00:19 -0800111 if (hub_is_superspeed(hub->hdev))
112 return "5.0 Gb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500113 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Matthias Beyer469271f2013-10-10 23:41:27 +0200114 return "480 Mb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500115 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 return "1.5 Mb/s";
117 else
118 return "12 Mb/s";
119}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121/* Note that hdev or one of its children must be locked! */
Lan Tianyuad493e52013-01-23 04:26:30 +0800122struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Lan Tianyuff823c792012-09-05 13:44:32 +0800124 if (!hdev || !hdev->actconfig || !hdev->maxchild)
Alan Stern251180842009-07-22 14:41:18 -0400125 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 return usb_get_intfdata(hdev->actconfig->interface[0]);
127}
128
Sarah Sharp140e3022014-01-22 13:35:02 -0800129static int usb_device_supports_lpm(struct usb_device *udev)
Sarah Sharpd9b20992012-02-20 08:31:26 -0800130{
131 /* USB 2.1 (and greater) devices indicate LPM support through
132 * their USB 2.0 Extended Capabilities BOS descriptor.
133 */
134 if (udev->speed == USB_SPEED_HIGH) {
135 if (udev->bos->ext_cap &&
136 (USB_LPM_SUPPORT &
137 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
138 return 1;
139 return 0;
140 }
Sarah Sharp51e0a012012-02-20 12:02:19 -0800141
Sarah Sharp25cd2882014-01-17 14:15:44 -0800142 /*
143 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
144 * However, there are some that don't, and they set the U1/U2 exit
145 * latencies to zero.
Sarah Sharp51e0a012012-02-20 12:02:19 -0800146 */
147 if (!udev->bos->ss_cap) {
Sarah Sharp25cd2882014-01-17 14:15:44 -0800148 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
Sarah Sharp51e0a012012-02-20 12:02:19 -0800149 return 0;
150 }
Sarah Sharp51e0a012012-02-20 12:02:19 -0800151
Sarah Sharp25cd2882014-01-17 14:15:44 -0800152 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
153 udev->bos->ss_cap->bU2DevExitLat == 0) {
154 if (udev->parent)
155 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
156 else
157 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
158 return 0;
159 }
160
161 if (!udev->parent || udev->parent->lpm_capable)
162 return 1;
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
Lan Tianyuad493e52013-01-23 04:26:30 +0800304 hub = usb_hub_to_struct_hub(udev->parent);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800305 /* 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;
Xenia Ragiadakou4d967992013-08-31 18:09:13 +0300312 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800313 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
Xenia Ragiadakou4d967992013-08-31 18:09:13 +0300314 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800315
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 */
Lan Tianyuad493e52013-01-23 04:26:30 +0800396int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
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
Dan Williamsd99f6b42014-05-20 18:08:17 -0700413static char *to_led_name(int selector)
414{
415 switch (selector) {
416 case HUB_LED_AMBER:
417 return "amber";
418 case HUB_LED_GREEN:
419 return "green";
420 case HUB_LED_OFF:
421 return "off";
422 case HUB_LED_AUTO:
423 return "auto";
424 default:
425 return "??";
426 }
427}
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429/*
430 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
431 * for info about using port indicators
432 */
Dan Williamsd99f6b42014-05-20 18:08:17 -0700433static void set_port_led(struct usb_hub *hub, int port1, int selector)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434{
Dan Williamsd99f6b42014-05-20 18:08:17 -0700435 struct usb_port *port_dev = hub->ports[port1 - 1];
436 int status;
437
438 status = set_port_feature(hub->hdev, (selector << 8) | port1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 USB_PORT_FEAT_INDICATOR);
Dan Williamsd99f6b42014-05-20 18:08:17 -0700440 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
441 to_led_name(selector), status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442}
443
444#define LED_CYCLE_PERIOD ((2*HZ)/3)
445
David Howellsc4028952006-11-22 14:57:56 +0000446static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447{
David Howellsc4028952006-11-22 14:57:56 +0000448 struct usb_hub *hub =
449 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 struct usb_device *hdev = hub->hdev;
451 unsigned i;
452 unsigned changed = 0;
453 int cursor = -1;
454
455 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
456 return;
457
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200458 for (i = 0; i < hdev->maxchild; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 unsigned selector, mode;
460
461 /* 30%-50% duty cycle */
462
463 switch (hub->indicator[i]) {
464 /* cycle marker */
465 case INDICATOR_CYCLE:
466 cursor = i;
467 selector = HUB_LED_AUTO;
468 mode = INDICATOR_AUTO;
469 break;
470 /* blinking green = sw attention */
471 case INDICATOR_GREEN_BLINK:
472 selector = HUB_LED_GREEN;
473 mode = INDICATOR_GREEN_BLINK_OFF;
474 break;
475 case INDICATOR_GREEN_BLINK_OFF:
476 selector = HUB_LED_OFF;
477 mode = INDICATOR_GREEN_BLINK;
478 break;
479 /* blinking amber = hw attention */
480 case INDICATOR_AMBER_BLINK:
481 selector = HUB_LED_AMBER;
482 mode = INDICATOR_AMBER_BLINK_OFF;
483 break;
484 case INDICATOR_AMBER_BLINK_OFF:
485 selector = HUB_LED_OFF;
486 mode = INDICATOR_AMBER_BLINK;
487 break;
488 /* blink green/amber = reserved */
489 case INDICATOR_ALT_BLINK:
490 selector = HUB_LED_GREEN;
491 mode = INDICATOR_ALT_BLINK_OFF;
492 break;
493 case INDICATOR_ALT_BLINK_OFF:
494 selector = HUB_LED_AMBER;
495 mode = INDICATOR_ALT_BLINK;
496 break;
497 default:
498 continue;
499 }
500 if (selector != HUB_LED_AUTO)
501 changed = 1;
502 set_port_led(hub, i + 1, selector);
503 hub->indicator[i] = mode;
504 }
505 if (!changed && blinkenlights) {
506 cursor++;
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200507 cursor %= hdev->maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
509 hub->indicator[cursor] = INDICATOR_CYCLE;
510 changed++;
511 }
512 if (changed)
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -0800513 queue_delayed_work(system_power_efficient_wq,
514 &hub->leds, LED_CYCLE_PERIOD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515}
516
517/* use a short timeout for hub/port status fetches */
518#define USB_STS_TIMEOUT 1000
519#define USB_STS_RETRIES 5
520
521/*
522 * USB 2.0 spec Section 11.24.2.6
523 */
524static int get_hub_status(struct usb_device *hdev,
525 struct usb_hub_status *data)
526{
527 int i, status = -ETIMEDOUT;
528
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200529 for (i = 0; i < USB_STS_RETRIES &&
530 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
532 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
533 data, sizeof(*data), USB_STS_TIMEOUT);
534 }
535 return status;
536}
537
538/*
539 * USB 2.0 spec Section 11.24.2.7
540 */
541static int get_port_status(struct usb_device *hdev, int port1,
542 struct usb_port_status *data)
543{
544 int i, status = -ETIMEDOUT;
545
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200546 for (i = 0; i < USB_STS_RETRIES &&
547 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
549 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
550 data, sizeof(*data), USB_STS_TIMEOUT);
551 }
552 return status;
553}
554
Alan Stern3eb14912008-03-03 15:15:43 -0500555static int hub_port_status(struct usb_hub *hub, int port1,
556 u16 *status, u16 *change)
557{
558 int ret;
559
560 mutex_lock(&hub->status_mutex);
561 ret = get_port_status(hub->hdev, port1, &hub->status->port);
562 if (ret < 4) {
Alan Sterne9e88fb2013-03-27 16:14:01 -0400563 if (ret != -ENODEV)
564 dev_err(hub->intfdev,
565 "%s failed (err = %d)\n", __func__, ret);
Alan Stern3eb14912008-03-03 15:15:43 -0500566 if (ret >= 0)
567 ret = -EIO;
568 } else {
569 *status = le16_to_cpu(hub->status->port.wPortStatus);
570 *change = le16_to_cpu(hub->status->port.wPortChange);
John Youndbe79bb2001-09-17 00:00:00 -0700571
Alan Stern3eb14912008-03-03 15:15:43 -0500572 ret = 0;
573 }
574 mutex_unlock(&hub->status_mutex);
575 return ret;
576}
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578static void kick_khubd(struct usb_hub *hub)
579{
580 unsigned long flags;
581
582 spin_lock_irqsave(&hub_event_lock, flags);
Roel Kluin2e2c5ee2007-10-26 23:54:35 +0200583 if (!hub->disconnected && list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 list_add_tail(&hub->event_list, &hub_event_list);
Alan Stern8e4ceb32009-12-07 13:01:37 -0500585
586 /* Suppress autosuspend until khubd runs */
587 usb_autopm_get_interface_no_resume(
588 to_usb_interface(hub->intfdev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 wake_up(&khubd_wait);
590 }
591 spin_unlock_irqrestore(&hub_event_lock, flags);
592}
593
594void usb_kick_khubd(struct usb_device *hdev)
595{
Lan Tianyuad493e52013-01-23 04:26:30 +0800596 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Alan Stern251180842009-07-22 14:41:18 -0400597
598 if (hub)
599 kick_khubd(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600}
601
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800602/*
603 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
604 * Notification, which indicates it had initiated remote wakeup.
605 *
606 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
607 * device initiates resume, so the USB core will not receive notice of the
608 * resume through the normal hub interrupt URB.
609 */
610void usb_wakeup_notification(struct usb_device *hdev,
611 unsigned int portnum)
612{
613 struct usb_hub *hub;
614
615 if (!hdev)
616 return;
617
Lan Tianyuad493e52013-01-23 04:26:30 +0800618 hub = usb_hub_to_struct_hub(hdev);
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800619 if (hub) {
620 set_bit(portnum, hub->wakeup_bits);
621 kick_khubd(hub);
622 }
623}
624EXPORT_SYMBOL_GPL(usb_wakeup_notification);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100627static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200629 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400630 int status = urb->status;
Roel Kluin71d27182009-03-13 12:19:18 +0100631 unsigned i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 unsigned long bits;
633
Alan Sterne0152682007-08-24 15:42:52 -0400634 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 case -ENOENT: /* synchronous unlink */
636 case -ECONNRESET: /* async unlink */
637 case -ESHUTDOWN: /* hardware going away */
638 return;
639
640 default: /* presumably an error */
641 /* Cause a hub reset after 10 consecutive errors */
Alan Sterne0152682007-08-24 15:42:52 -0400642 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 if ((++hub->nerrors < 10) || hub->error)
644 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400645 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 /* let khubd handle things */
649 case 0: /* we got data: port status changed */
650 bits = 0;
651 for (i = 0; i < urb->actual_length; ++i)
652 bits |= ((unsigned long) ((*hub->buffer)[i]))
653 << (i*8);
654 hub->event_bits[0] = bits;
655 break;
656 }
657
658 hub->nerrors = 0;
659
660 /* Something happened, let khubd figure it out */
661 kick_khubd(hub);
662
663resubmit:
664 if (hub->quiescing)
665 return;
666
667 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
668 && status != -ENODEV && status != -EPERM)
669 dev_err (hub->intfdev, "resubmit --> %d\n", status);
670}
671
672/* USB 2.0 spec Section 11.24.2.3 */
673static inline int
674hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
675{
William Gulland2c7b8712013-06-27 16:10:20 -0700676 /* Need to clear both directions for control ep */
677 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
678 USB_ENDPOINT_XFER_CONTROL) {
679 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
680 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
681 devinfo ^ 0x8000, tt, NULL, 0, 1000);
682 if (status)
683 return status;
684 }
Alan Sternc2f65952009-11-18 11:37:15 -0500685 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
687 tt, NULL, 0, 1000);
688}
689
690/*
691 * enumeration blocks khubd for a long time. we use keventd instead, since
692 * long blocking there is the exception, not the rule. accordingly, HCDs
693 * talking to TTs must queue control transfers (not just bulk and iso), so
694 * both can talk to the same hub concurrently.
695 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400696static void hub_tt_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
David Howellsc4028952006-11-22 14:57:56 +0000698 struct usb_hub *hub =
Alan Sterncb88a1b2009-06-29 10:43:32 -0400699 container_of(work, struct usb_hub, tt.clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 unsigned long flags;
701
702 spin_lock_irqsave (&hub->tt.lock, flags);
Octavian Purdila3b6054d2012-10-01 22:21:12 +0300703 while (!list_empty(&hub->tt.clear_list)) {
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400704 struct list_head *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 struct usb_tt_clear *clear;
706 struct usb_device *hdev = hub->hdev;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400707 const struct hc_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 int status;
709
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400710 next = hub->tt.clear_list.next;
711 clear = list_entry (next, struct usb_tt_clear, clear_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 list_del (&clear->clear_list);
713
714 /* drop lock so HCD can concurrently report other TT errors */
715 spin_unlock_irqrestore (&hub->tt.lock, flags);
716 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
Alan Sterne9e88fb2013-03-27 16:14:01 -0400717 if (status && status != -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 dev_err (&hdev->dev,
719 "clear tt %d (%04x) error %d\n",
720 clear->tt, clear->devinfo, status);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400721
722 /* Tell the HCD, even if the operation failed */
723 drv = clear->hcd->driver;
724 if (drv->clear_tt_buffer_complete)
725 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
726
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700727 kfree(clear);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400728 spin_lock_irqsave(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 }
730 spin_unlock_irqrestore (&hub->tt.lock, flags);
731}
732
733/**
Lan Tianyu971fcd42013-01-23 04:26:29 +0800734 * usb_hub_set_port_power - control hub port's power state
Mathias Nyman413412612013-06-18 17:28:48 +0300735 * @hdev: USB device belonging to the usb hub
736 * @hub: target hub
Lan Tianyu971fcd42013-01-23 04:26:29 +0800737 * @port1: port index
738 * @set: expected status
739 *
740 * call this function to control port's power via setting or
741 * clearing the port's PORT_POWER feature.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200742 *
743 * Return: 0 if successful. A negative error code otherwise.
Lan Tianyu971fcd42013-01-23 04:26:29 +0800744 */
Mathias Nyman413412612013-06-18 17:28:48 +0300745int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
746 int port1, bool set)
Lan Tianyu971fcd42013-01-23 04:26:29 +0800747{
748 int ret;
749
750 if (set)
751 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
752 else
Lan Tianyuad493e52013-01-23 04:26:30 +0800753 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
754
Dan Williamsd5c38342014-05-20 18:08:52 -0700755 if (ret)
756 return ret;
757
758 if (set)
759 set_bit(port1, hub->power_bits);
760 else
761 clear_bit(port1, hub->power_bits);
762 return 0;
Lan Tianyu971fcd42013-01-23 04:26:29 +0800763}
764
765/**
Alan Sterncb88a1b2009-06-29 10:43:32 -0400766 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
767 * @urb: an URB associated with the failed or incomplete split transaction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 *
769 * High speed HCDs use this to tell the hub driver that some split control or
770 * bulk transaction failed in a way that requires clearing internal state of
771 * a transaction translator. This is normally detected (and reported) from
772 * interrupt context.
773 *
774 * It may not be possible for that hub to handle additional full (or low)
775 * speed transactions until that state is fully cleared out.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200776 *
777 * Return: 0 if successful. A negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400779int usb_hub_clear_tt_buffer(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780{
Alan Sterncb88a1b2009-06-29 10:43:32 -0400781 struct usb_device *udev = urb->dev;
782 int pipe = urb->pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 struct usb_tt *tt = udev->tt;
784 unsigned long flags;
785 struct usb_tt_clear *clear;
786
787 /* we've got to cope with an arbitrary number of pending TT clears,
788 * since each TT has "at least two" buffers that can need it (and
789 * there can be many TTs per hub). even if they're uncommon.
790 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800791 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
793 /* FIXME recover somehow ... RESET_TT? */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400794 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
796
797 /* info that CLEAR_TT_BUFFER needs */
798 clear->tt = tt->multi ? udev->ttport : 1;
799 clear->devinfo = usb_pipeendpoint (pipe);
800 clear->devinfo |= udev->devnum << 4;
801 clear->devinfo |= usb_pipecontrol (pipe)
802 ? (USB_ENDPOINT_XFER_CONTROL << 11)
803 : (USB_ENDPOINT_XFER_BULK << 11);
804 if (usb_pipein (pipe))
805 clear->devinfo |= 1 << 15;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400806
807 /* info for completion callback */
808 clear->hcd = bus_to_hcd(udev->bus);
809 clear->ep = urb->ep;
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 /* tell keventd to clear state for this TT */
812 spin_lock_irqsave (&tt->lock, flags);
813 list_add_tail (&clear->clear_list, &tt->clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400814 schedule_work(&tt->clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 spin_unlock_irqrestore (&tt->lock, flags);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400816 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
Alan Sterncb88a1b2009-06-29 10:43:32 -0400818EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Dan Williams7ad3c472014-05-20 18:08:57 -0700820static void hub_power_on(struct usb_hub *hub, bool do_delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821{
822 int port1;
823
Alan Stern4489a572006-04-27 15:54:22 -0400824 /* Enable power on each port. Some hubs have reserved values
825 * of LPSM (> 2) in their descriptors, even though they are
826 * USB 2.0 hubs. Some hubs do not implement port-power switching
827 * but only emulate it. In all cases, the ports won't work
828 * unless we send these messages to the hub.
829 */
Dan Williams9262c192014-05-20 18:08:12 -0700830 if (hub_is_port_power_switchable(hub))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400832 else
833 dev_dbg(hub->intfdev, "trying to enable port power on "
834 "non-switchable hub\n");
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200835 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
Dan Williamsd5c38342014-05-20 18:08:52 -0700836 if (test_bit(port1, hub->power_bits))
Lan Tianyuad493e52013-01-23 04:26:30 +0800837 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
838 else
839 usb_clear_port_feature(hub->hdev, port1,
840 USB_PORT_FEAT_POWER);
Alan Stern8520f382008-09-22 14:44:26 -0400841 if (do_delay)
Dan Williams7ad3c472014-05-20 18:08:57 -0700842 msleep(hub_power_on_good_delay(hub));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843}
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845static int hub_hub_status(struct usb_hub *hub,
846 u16 *status, u16 *change)
847{
848 int ret;
849
Alan Sterndb90e7a2007-02-05 09:56:15 -0500850 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 ret = get_hub_status(hub->hdev, &hub->status->hub);
Alan Sterne9e88fb2013-03-27 16:14:01 -0400852 if (ret < 0) {
853 if (ret != -ENODEV)
854 dev_err(hub->intfdev,
855 "%s failed (err = %d)\n", __func__, ret);
856 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 *status = le16_to_cpu(hub->status->hub.wHubStatus);
Matthias Beyer469271f2013-10-10 23:41:27 +0200858 *change = le16_to_cpu(hub->status->hub.wHubChange);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 ret = 0;
860 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500861 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 return ret;
863}
864
Sarah Sharp41e7e052012-11-14 16:42:32 -0800865static int hub_set_port_link_state(struct usb_hub *hub, int port1,
866 unsigned int link_status)
867{
868 return set_port_feature(hub->hdev,
869 port1 | (link_status << 3),
870 USB_PORT_FEAT_LINK_STATE);
871}
872
873/*
874 * If USB 3.0 ports are placed into the Disabled state, they will no longer
875 * detect any device connects or disconnects. This is generally not what the
876 * USB core wants, since it expects a disabled port to produce a port status
877 * change event when a new device connects.
878 *
879 * Instead, set the link state to Disabled, wait for the link to settle into
880 * that state, clear any change bits, and then put the port into the RxDetect
881 * state.
882 */
883static int hub_usb3_port_disable(struct usb_hub *hub, int port1)
884{
885 int ret;
886 int total_time;
887 u16 portchange, portstatus;
888
889 if (!hub_is_superspeed(hub->hdev))
890 return -EINVAL;
891
Gavin Guobb86cf52014-07-18 01:12:13 +0800892 ret = hub_port_status(hub, port1, &portstatus, &portchange);
893 if (ret < 0)
894 return ret;
895
896 /*
897 * USB controller Advanced Micro Devices, Inc. [AMD] FCH USB XHCI
898 * Controller [1022:7814] will have spurious result making the following
899 * usb 3.0 device hotplugging route to the 2.0 root hub and recognized
900 * as high-speed device if we set the usb 3.0 port link state to
901 * Disabled. Since it's already in USB_SS_PORT_LS_RX_DETECT state, we
902 * check the state here to avoid the bug.
903 */
904 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
905 USB_SS_PORT_LS_RX_DETECT) {
906 dev_dbg(&hub->ports[port1 - 1]->dev,
907 "Not disabling port; link state is RxDetect\n");
908 return ret;
909 }
910
Sarah Sharp41e7e052012-11-14 16:42:32 -0800911 ret = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_SS_DISABLED);
Alan Sterne9e88fb2013-03-27 16:14:01 -0400912 if (ret)
Sarah Sharp41e7e052012-11-14 16:42:32 -0800913 return ret;
Sarah Sharp41e7e052012-11-14 16:42:32 -0800914
915 /* Wait for the link to enter the disabled state. */
916 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
917 ret = hub_port_status(hub, port1, &portstatus, &portchange);
918 if (ret < 0)
919 return ret;
920
921 if ((portstatus & USB_PORT_STAT_LINK_STATE) ==
922 USB_SS_PORT_LS_SS_DISABLED)
923 break;
924 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
925 break;
926 msleep(HUB_DEBOUNCE_STEP);
927 }
928 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
Dan Williamsd99f6b42014-05-20 18:08:17 -0700929 dev_warn(&hub->ports[port1 - 1]->dev,
930 "Could not disable after %d ms\n", total_time);
Sarah Sharp41e7e052012-11-14 16:42:32 -0800931
932 return hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_RX_DETECT);
933}
934
Alan Stern8b28c752005-08-10 17:04:13 -0400935static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
936{
Dan Williamsd99f6b42014-05-20 18:08:17 -0700937 struct usb_port *port_dev = hub->ports[port1 - 1];
Alan Stern8b28c752005-08-10 17:04:13 -0400938 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400939 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400940
Dan Williamsd99f6b42014-05-20 18:08:17 -0700941 if (port_dev->child && set_state)
942 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
Sarah Sharp41e7e052012-11-14 16:42:32 -0800943 if (!hub->error) {
944 if (hub_is_superspeed(hub->hdev))
945 ret = hub_usb3_port_disable(hub, port1);
946 else
Lan Tianyuad493e52013-01-23 04:26:30 +0800947 ret = usb_clear_port_feature(hdev, port1,
Sarah Sharp41e7e052012-11-14 16:42:32 -0800948 USB_PORT_FEAT_ENABLE);
949 }
Alan Sterne9e88fb2013-03-27 16:14:01 -0400950 if (ret && ret != -ENODEV)
Dan Williamsd99f6b42014-05-20 18:08:17 -0700951 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400952 return ret;
953}
954
Alan Stern0458d5b2007-05-04 11:52:20 -0400955/*
Justin P. Mattock6d42fcd2011-02-26 20:33:56 -0800956 * Disable a port and mark a logical connect-change event, so that some
Alan Stern0458d5b2007-05-04 11:52:20 -0400957 * time later khubd will disconnect() any existing usb_device on the port
958 * and will re-enumerate if there actually is a device attached.
959 */
960static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
961{
Dan Williamsd99f6b42014-05-20 18:08:17 -0700962 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
Alan Stern0458d5b2007-05-04 11:52:20 -0400963 hub_port_disable(hub, port1, 1);
964
965 /* FIXME let caller ask to power down the port:
966 * - some devices won't enumerate without a VBUS power cycle
967 * - SRP saves power that way
968 * - ... new call, TBD ...
969 * That's easy if this hub can switch power per-port, and
970 * khubd reactivates the port later (timer, SRP, etc).
971 * Powerdown must be optional, because of reset/DFU.
972 */
973
974 set_bit(port1, hub->change_bits);
Matthias Beyer469271f2013-10-10 23:41:27 +0200975 kick_khubd(hub);
Alan Stern0458d5b2007-05-04 11:52:20 -0400976}
977
Alan Stern253e0572009-10-27 15:20:13 -0400978/**
979 * usb_remove_device - disable a device's port on its parent hub
980 * @udev: device to be disabled and removed
981 * Context: @udev locked, must be able to sleep.
982 *
983 * After @udev's port has been disabled, khubd is notified and it will
984 * see that the device has been disconnected. When the device is
985 * physically unplugged and something is plugged in, the events will
986 * be received and processed normally.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200987 *
988 * Return: 0 if successful. A negative error code otherwise.
Alan Stern253e0572009-10-27 15:20:13 -0400989 */
990int usb_remove_device(struct usb_device *udev)
991{
992 struct usb_hub *hub;
993 struct usb_interface *intf;
994
995 if (!udev->parent) /* Can't remove a root hub */
996 return -EINVAL;
Lan Tianyuad493e52013-01-23 04:26:30 +0800997 hub = usb_hub_to_struct_hub(udev->parent);
Alan Stern253e0572009-10-27 15:20:13 -0400998 intf = to_usb_interface(hub->intfdev);
999
1000 usb_autopm_get_interface(intf);
1001 set_bit(udev->portnum, hub->removed_bits);
1002 hub_port_logical_disconnect(hub, udev->portnum);
1003 usb_autopm_put_interface(intf);
1004 return 0;
1005}
1006
Alan Stern6ee0b272008-04-28 11:06:42 -04001007enum hub_activation_type {
Alan Stern8e4ceb32009-12-07 13:01:37 -05001008 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
Alan Stern8520f382008-09-22 14:44:26 -04001009 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
Alan Stern6ee0b272008-04-28 11:06:42 -04001010};
Alan Stern5e6effa2008-03-03 15:15:51 -05001011
Alan Stern8520f382008-09-22 14:44:26 -04001012static void hub_init_func2(struct work_struct *ws);
1013static void hub_init_func3(struct work_struct *ws);
1014
Alan Sternf2835212008-04-28 11:07:17 -04001015static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
Alan Stern5e6effa2008-03-03 15:15:51 -05001016{
1017 struct usb_device *hdev = hub->hdev;
Sarah Sharp653a39d2010-12-23 11:12:42 -08001018 struct usb_hcd *hcd;
1019 int ret;
Alan Stern5e6effa2008-03-03 15:15:51 -05001020 int port1;
Alan Sternf2835212008-04-28 11:07:17 -04001021 int status;
Alan Stern948fea32008-04-28 11:07:07 -04001022 bool need_debounce_delay = false;
Alan Stern8520f382008-09-22 14:44:26 -04001023 unsigned delay;
1024
1025 /* Continue a partial initialization */
1026 if (type == HUB_INIT2)
1027 goto init2;
1028 if (type == HUB_INIT3)
1029 goto init3;
Alan Stern5e6effa2008-03-03 15:15:51 -05001030
Elric Fua45aa3b2012-02-18 13:32:27 +08001031 /* The superspeed hub except for root hub has to use Hub Depth
1032 * value as an offset into the route string to locate the bits
1033 * it uses to determine the downstream port number. So hub driver
1034 * should send a set hub depth request to superspeed hub after
1035 * the superspeed hub is set configuration in initialization or
1036 * reset procedure.
1037 *
1038 * After a resume, port power should still be on.
Alan Sternf2835212008-04-28 11:07:17 -04001039 * For any other type of activation, turn it on.
1040 */
Alan Stern8520f382008-09-22 14:44:26 -04001041 if (type != HUB_RESUME) {
Elric Fua45aa3b2012-02-18 13:32:27 +08001042 if (hdev->parent && hub_is_superspeed(hdev)) {
1043 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1044 HUB_SET_DEPTH, USB_RT_HUB,
1045 hdev->level - 1, 0, NULL, 0,
1046 USB_CTRL_SET_TIMEOUT);
1047 if (ret < 0)
1048 dev_err(hub->intfdev,
1049 "set hub depth failed\n");
1050 }
Alan Stern8520f382008-09-22 14:44:26 -04001051
1052 /* Speed up system boot by using a delayed_work for the
1053 * hub's initial power-up delays. This is pretty awkward
1054 * and the implementation looks like a home-brewed sort of
1055 * setjmp/longjmp, but it saves at least 100 ms for each
1056 * root hub (assuming usbcore is compiled into the kernel
1057 * rather than as a module). It adds up.
1058 *
1059 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1060 * because for those activation types the ports have to be
1061 * operational when we return. In theory this could be done
1062 * for HUB_POST_RESET, but it's easier not to.
1063 */
1064 if (type == HUB_INIT) {
Dan Williams7ad3c472014-05-20 18:08:57 -07001065 unsigned delay = hub_power_on_good_delay(hub);
1066
1067 hub_power_on(hub, false);
Tejun Heo77fa83c2014-03-07 10:24:48 -05001068 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001069 queue_delayed_work(system_power_efficient_wq,
1070 &hub->init_work,
Alan Stern8520f382008-09-22 14:44:26 -04001071 msecs_to_jiffies(delay));
Alan Stern61fbeba2008-10-27 12:07:44 -04001072
1073 /* Suppress autosuspend until init is done */
Alan Stern8e4ceb32009-12-07 13:01:37 -05001074 usb_autopm_get_interface_no_resume(
1075 to_usb_interface(hub->intfdev));
Alan Stern8520f382008-09-22 14:44:26 -04001076 return; /* Continues at init2: below */
Sarah Sharp653a39d2010-12-23 11:12:42 -08001077 } else if (type == HUB_RESET_RESUME) {
1078 /* The internal host controller state for the hub device
1079 * may be gone after a host power loss on system resume.
1080 * Update the device's info so the HW knows it's a hub.
1081 */
1082 hcd = bus_to_hcd(hdev->bus);
1083 if (hcd->driver->update_hub_device) {
1084 ret = hcd->driver->update_hub_device(hcd, hdev,
1085 &hub->tt, GFP_NOIO);
1086 if (ret < 0) {
1087 dev_err(hub->intfdev, "Host not "
1088 "accepting hub info "
1089 "update.\n");
1090 dev_err(hub->intfdev, "LS/FS devices "
1091 "and hubs may not work "
1092 "under this hub\n.");
1093 }
1094 }
1095 hub_power_on(hub, true);
Alan Stern8520f382008-09-22 14:44:26 -04001096 } else {
1097 hub_power_on(hub, true);
1098 }
1099 }
1100 init2:
Alan Sternf2835212008-04-28 11:07:17 -04001101
Dan Williamsd99f6b42014-05-20 18:08:17 -07001102 /*
1103 * Check each port and set hub->change_bits to let khubd know
Alan Stern6ee0b272008-04-28 11:06:42 -04001104 * which ports need attention.
Alan Stern5e6effa2008-03-03 15:15:51 -05001105 */
1106 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07001107 struct usb_port *port_dev = hub->ports[port1 - 1];
1108 struct usb_device *udev = port_dev->child;
Alan Stern5e6effa2008-03-03 15:15:51 -05001109 u16 portstatus, portchange;
1110
Alan Stern6ee0b272008-04-28 11:06:42 -04001111 portstatus = portchange = 0;
1112 status = hub_port_status(hub, port1, &portstatus, &portchange);
1113 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
Dan Williamsd99f6b42014-05-20 18:08:17 -07001114 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1115 portstatus, portchange);
Alan Stern5e6effa2008-03-03 15:15:51 -05001116
Dan Williamsd99f6b42014-05-20 18:08:17 -07001117 /*
1118 * After anything other than HUB_RESUME (i.e., initialization
Alan Stern6ee0b272008-04-28 11:06:42 -04001119 * or any sort of reset), every port should be disabled.
1120 * Unconnected ports should likewise be disabled (paranoia),
1121 * and so should ports for which we have no usb_device.
Alan Stern5e6effa2008-03-03 15:15:51 -05001122 */
Alan Stern6ee0b272008-04-28 11:06:42 -04001123 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1124 type != HUB_RESUME ||
1125 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1126 !udev ||
1127 udev->state == USB_STATE_NOTATTACHED)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001128 /*
1129 * USB3 protocol ports will automatically transition
1130 * to Enabled state when detect an USB3.0 device attach.
Dan Williamsfd1ac4c2013-10-07 11:58:20 -07001131 * Do not disable USB3 protocol ports, just pretend
1132 * power was lost
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001133 */
Dan Williamsfd1ac4c2013-10-07 11:58:20 -07001134 portstatus &= ~USB_PORT_STAT_ENABLE;
1135 if (!hub_is_superspeed(hdev))
Lan Tianyuad493e52013-01-23 04:26:30 +08001136 usb_clear_port_feature(hdev, port1,
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001137 USB_PORT_FEAT_ENABLE);
Alan Stern6ee0b272008-04-28 11:06:42 -04001138 }
1139
Alan Stern948fea32008-04-28 11:07:07 -04001140 /* Clear status-change flags; we'll debounce later */
1141 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1142 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001143 usb_clear_port_feature(hub->hdev, port1,
Alan Stern948fea32008-04-28 11:07:07 -04001144 USB_PORT_FEAT_C_CONNECTION);
1145 }
1146 if (portchange & USB_PORT_STAT_C_ENABLE) {
1147 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001148 usb_clear_port_feature(hub->hdev, port1,
Alan Stern948fea32008-04-28 11:07:07 -04001149 USB_PORT_FEAT_C_ENABLE);
1150 }
Julius Wernere92aee32013-10-15 17:45:00 -07001151 if (portchange & USB_PORT_STAT_C_RESET) {
1152 need_debounce_delay = true;
1153 usb_clear_port_feature(hub->hdev, port1,
1154 USB_PORT_FEAT_C_RESET);
1155 }
Don Zickus79c3dd82011-11-03 09:07:18 -04001156 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1157 hub_is_superspeed(hub->hdev)) {
1158 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001159 usb_clear_port_feature(hub->hdev, port1,
Don Zickus79c3dd82011-11-03 09:07:18 -04001160 USB_PORT_FEAT_C_BH_PORT_RESET);
1161 }
Alan Stern253e0572009-10-27 15:20:13 -04001162 /* We can forget about a "removed" device when there's a
1163 * physical disconnect or the connect status changes.
1164 */
1165 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1166 (portchange & USB_PORT_STAT_C_CONNECTION))
1167 clear_bit(port1, hub->removed_bits);
1168
Alan Stern6ee0b272008-04-28 11:06:42 -04001169 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1170 /* Tell khubd to disconnect the device or
1171 * check for a new connection
1172 */
Shen Guang08d1dec2014-01-08 14:45:42 +08001173 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1174 (portstatus & USB_PORT_STAT_OVERCURRENT))
Alan Stern6ee0b272008-04-28 11:06:42 -04001175 set_bit(port1, hub->change_bits);
1176
1177 } else if (portstatus & USB_PORT_STAT_ENABLE) {
Sarah Sharp72937e12012-01-24 11:46:50 -08001178 bool port_resumed = (portstatus &
1179 USB_PORT_STAT_LINK_STATE) ==
1180 USB_SS_PORT_LS_U0;
Alan Stern6ee0b272008-04-28 11:06:42 -04001181 /* The power session apparently survived the resume.
1182 * If there was an overcurrent or suspend change
1183 * (i.e., remote wakeup request), have khubd
Sarah Sharp72937e12012-01-24 11:46:50 -08001184 * take care of it. Look at the port link state
1185 * for USB 3.0 hubs, since they don't have a suspend
1186 * change bit, and they don't set the port link change
1187 * bit on device-initiated resume.
Alan Stern6ee0b272008-04-28 11:06:42 -04001188 */
Sarah Sharp72937e12012-01-24 11:46:50 -08001189 if (portchange || (hub_is_superspeed(hub->hdev) &&
1190 port_resumed))
Alan Stern6ee0b272008-04-28 11:06:42 -04001191 set_bit(port1, hub->change_bits);
1192
1193 } else if (udev->persist_enabled) {
Alan Stern6ee0b272008-04-28 11:06:42 -04001194#ifdef CONFIG_PM
Alan Stern5e6effa2008-03-03 15:15:51 -05001195 udev->reset_resume = 1;
Alan Stern6ee0b272008-04-28 11:06:42 -04001196#endif
Lan Tianyuad493e52013-01-23 04:26:30 +08001197 /* Don't set the change_bits when the device
1198 * was powered off.
1199 */
Dan Williamsd5c38342014-05-20 18:08:52 -07001200 if (test_bit(port1, hub->power_bits))
Lan Tianyuad493e52013-01-23 04:26:30 +08001201 set_bit(port1, hub->change_bits);
Alan Stern8808f002008-04-28 11:06:55 -04001202
Alan Stern6ee0b272008-04-28 11:06:42 -04001203 } else {
1204 /* The power session is gone; tell khubd */
1205 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1206 set_bit(port1, hub->change_bits);
Alan Stern5e6effa2008-03-03 15:15:51 -05001207 }
Alan Stern5e6effa2008-03-03 15:15:51 -05001208 }
1209
Alan Stern948fea32008-04-28 11:07:07 -04001210 /* If no port-status-change flags were set, we don't need any
1211 * debouncing. If flags were set we can try to debounce the
1212 * ports all at once right now, instead of letting khubd do them
1213 * one at a time later on.
1214 *
1215 * If any port-status changes do occur during this delay, khubd
1216 * will see them later and handle them normally.
1217 */
Alan Stern8520f382008-09-22 14:44:26 -04001218 if (need_debounce_delay) {
1219 delay = HUB_DEBOUNCE_STABLE;
Alan Sternf2835212008-04-28 11:07:17 -04001220
Alan Stern8520f382008-09-22 14:44:26 -04001221 /* Don't do a long sleep inside a workqueue routine */
1222 if (type == HUB_INIT2) {
Tejun Heo77fa83c2014-03-07 10:24:48 -05001223 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001224 queue_delayed_work(system_power_efficient_wq,
1225 &hub->init_work,
Alan Stern8520f382008-09-22 14:44:26 -04001226 msecs_to_jiffies(delay));
1227 return; /* Continues at init3: below */
1228 } else {
1229 msleep(delay);
1230 }
1231 }
1232 init3:
Alan Sternf2835212008-04-28 11:07:17 -04001233 hub->quiescing = 0;
1234
1235 status = usb_submit_urb(hub->urb, GFP_NOIO);
1236 if (status < 0)
1237 dev_err(hub->intfdev, "activate --> %d\n", status);
1238 if (hub->has_indicators && blinkenlights)
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001239 queue_delayed_work(system_power_efficient_wq,
1240 &hub->leds, LED_CYCLE_PERIOD);
Alan Sternf2835212008-04-28 11:07:17 -04001241
1242 /* Scan all ports that need attention */
1243 kick_khubd(hub);
Alan Stern8e4ceb32009-12-07 13:01:37 -05001244
1245 /* Allow autosuspend if it was suppressed */
1246 if (type <= HUB_INIT3)
1247 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
Alan Stern5e6effa2008-03-03 15:15:51 -05001248}
1249
Alan Stern8520f382008-09-22 14:44:26 -04001250/* Implement the continuations for the delays above */
1251static void hub_init_func2(struct work_struct *ws)
1252{
1253 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1254
1255 hub_activate(hub, HUB_INIT2);
1256}
1257
1258static void hub_init_func3(struct work_struct *ws)
1259{
1260 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1261
1262 hub_activate(hub, HUB_INIT3);
1263}
1264
Alan Stern43303542008-04-28 11:07:31 -04001265enum hub_quiescing_type {
1266 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1267};
1268
1269static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1270{
1271 struct usb_device *hdev = hub->hdev;
1272 int i;
1273
Alan Stern8520f382008-09-22 14:44:26 -04001274 cancel_delayed_work_sync(&hub->init_work);
1275
Alan Stern43303542008-04-28 11:07:31 -04001276 /* khubd and related activity won't re-trigger */
1277 hub->quiescing = 1;
1278
1279 if (type != HUB_SUSPEND) {
1280 /* Disconnect all the children */
1281 for (i = 0; i < hdev->maxchild; ++i) {
Lan Tianyuff823c792012-09-05 13:44:32 +08001282 if (hub->ports[i]->child)
1283 usb_disconnect(&hub->ports[i]->child);
Alan Stern43303542008-04-28 11:07:31 -04001284 }
1285 }
1286
1287 /* Stop khubd and related activity */
1288 usb_kill_urb(hub->urb);
1289 if (hub->has_indicators)
1290 cancel_delayed_work_sync(&hub->leds);
1291 if (hub->tt.hub)
Octavian Purdila036546b2012-10-23 11:33:12 +03001292 flush_work(&hub->tt.clear_work);
Alan Stern43303542008-04-28 11:07:31 -04001293}
1294
Alan Stern600856c2014-05-20 18:08:07 -07001295static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1296{
1297 int i;
1298
1299 for (i = 0; i < hub->hdev->maxchild; ++i)
1300 pm_runtime_barrier(&hub->ports[i]->dev);
1301}
1302
Alan Stern3eb14912008-03-03 15:15:43 -05001303/* caller has locked the hub device */
1304static int hub_pre_reset(struct usb_interface *intf)
1305{
1306 struct usb_hub *hub = usb_get_intfdata(intf);
1307
Alan Stern43303542008-04-28 11:07:31 -04001308 hub_quiesce(hub, HUB_PRE_RESET);
Alan Stern600856c2014-05-20 18:08:07 -07001309 hub->in_reset = 1;
1310 hub_pm_barrier_for_all_ports(hub);
Alan Sternf07600c2007-05-30 15:38:16 -04001311 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001312}
1313
1314/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -04001315static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -05001316{
Alan Stern7de18d82006-06-01 13:37:24 -04001317 struct usb_hub *hub = usb_get_intfdata(intf);
1318
Alan Stern600856c2014-05-20 18:08:07 -07001319 hub->in_reset = 0;
1320 hub_pm_barrier_for_all_ports(hub);
Alan Sternf2835212008-04-28 11:07:17 -04001321 hub_activate(hub, HUB_POST_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -04001322 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001323}
1324
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325static int hub_configure(struct usb_hub *hub,
1326 struct usb_endpoint_descriptor *endpoint)
1327{
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001328 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 struct usb_device *hdev = hub->hdev;
1330 struct device *hub_dev = hub->intfdev;
1331 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001332 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 unsigned int pipe;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001334 int maxp, ret, i;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001335 char *message = "out of memory";
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001336 unsigned unit_load;
1337 unsigned full_load;
Dan Williamsd8521af2014-05-20 18:08:28 -07001338 unsigned maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Alan Sternd697cdd2009-10-27 15:18:46 -04001340 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 if (!hub->buffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 ret = -ENOMEM;
1343 goto fail;
1344 }
1345
1346 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1347 if (!hub->status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 ret = -ENOMEM;
1349 goto fail;
1350 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001351 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
1353 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1354 if (!hub->descriptor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 ret = -ENOMEM;
1356 goto fail;
1357 }
1358
1359 /* Request the entire hub descriptor.
1360 * hub->descriptor can handle USB_MAXCHILDREN ports,
1361 * but the hub can/will return fewer bytes here.
1362 */
John Youndbe79bb2001-09-17 00:00:00 -07001363 ret = get_hub_descriptor(hdev, hub->descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 if (ret < 0) {
1365 message = "can't read hub descriptor";
1366 goto fail;
1367 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1368 message = "hub has too many ports!";
1369 ret = -ENODEV;
1370 goto fail;
David Linares769d73682013-03-25 10:50:27 +00001371 } else if (hub->descriptor->bNbrPorts == 0) {
1372 message = "hub doesn't have any ports!";
1373 ret = -ENODEV;
1374 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 }
1376
Dan Williamsd8521af2014-05-20 18:08:28 -07001377 maxchild = hub->descriptor->bNbrPorts;
1378 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1379 (maxchild == 1) ? "" : "s");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Dan Williamsd8521af2014-05-20 18:08:28 -07001381 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
Lan Tianyuff823c792012-09-05 13:44:32 +08001382 if (!hub->ports) {
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001383 ret = -ENOMEM;
1384 goto fail;
1385 }
1386
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001387 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001388 if (hub_is_superspeed(hdev)) {
1389 unit_load = 150;
1390 full_load = 900;
1391 } else {
1392 unit_load = 100;
1393 full_load = 500;
1394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
John Youndbe79bb2001-09-17 00:00:00 -07001396 /* FIXME for USB 3.0, skip for now */
1397 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1398 !(hub_is_superspeed(hdev))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 int i;
Matthias Beyer469271f2013-10-10 23:41:27 +02001400 char portstr[USB_MAXCHILDREN + 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Dan Williamsd8521af2014-05-20 18:08:28 -07001402 for (i = 0; i < maxchild; i++)
John Youndbe79bb2001-09-17 00:00:00 -07001403 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1405 ? 'F' : 'R';
Dan Williamsd8521af2014-05-20 18:08:28 -07001406 portstr[maxchild] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1408 } else
1409 dev_dbg(hub_dev, "standalone hub\n");
1410
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001411 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301412 case HUB_CHAR_COMMON_LPSM:
1413 dev_dbg(hub_dev, "ganged power switching\n");
1414 break;
1415 case HUB_CHAR_INDV_PORT_LPSM:
1416 dev_dbg(hub_dev, "individual port power switching\n");
1417 break;
1418 case HUB_CHAR_NO_LPSM:
1419 case HUB_CHAR_LPSM:
1420 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1421 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 }
1423
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001424 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301425 case HUB_CHAR_COMMON_OCPM:
1426 dev_dbg(hub_dev, "global over-current protection\n");
1427 break;
1428 case HUB_CHAR_INDV_PORT_OCPM:
1429 dev_dbg(hub_dev, "individual port over-current protection\n");
1430 break;
1431 case HUB_CHAR_NO_OCPM:
1432 case HUB_CHAR_OCPM:
1433 dev_dbg(hub_dev, "no over-current protection\n");
1434 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 }
1436
1437 spin_lock_init (&hub->tt.lock);
1438 INIT_LIST_HEAD (&hub->tt.clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -04001439 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 switch (hdev->descriptor.bDeviceProtocol) {
Aman Deep7bf01182011-12-08 12:05:22 +05301441 case USB_HUB_PR_FS:
1442 break;
1443 case USB_HUB_PR_HS_SINGLE_TT:
1444 dev_dbg(hub_dev, "Single TT\n");
1445 hub->tt.hub = hdev;
1446 break;
1447 case USB_HUB_PR_HS_MULTI_TT:
1448 ret = usb_set_interface(hdev, 0, 1);
1449 if (ret == 0) {
1450 dev_dbg(hub_dev, "TT per port\n");
1451 hub->tt.multi = 1;
1452 } else
1453 dev_err(hub_dev, "Using single TT (err %d)\n",
1454 ret);
1455 hub->tt.hub = hdev;
1456 break;
1457 case USB_HUB_PR_SS:
1458 /* USB 3.0 hubs don't have a TT */
1459 break;
1460 default:
1461 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1462 hdev->descriptor.bDeviceProtocol);
1463 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 }
1465
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001466 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001467 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
Matthias Beyer469271f2013-10-10 23:41:27 +02001468 case HUB_TTTT_8_BITS:
1469 if (hdev->descriptor.bDeviceProtocol != 0) {
1470 hub->tt.think_time = 666;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001471 dev_dbg(hub_dev, "TT requires at most %d "
1472 "FS bit times (%d ns)\n",
Matthias Beyer469271f2013-10-10 23:41:27 +02001473 8, hub->tt.think_time);
1474 }
1475 break;
1476 case HUB_TTTT_16_BITS:
1477 hub->tt.think_time = 666 * 2;
1478 dev_dbg(hub_dev, "TT requires at most %d "
1479 "FS bit times (%d ns)\n",
1480 16, hub->tt.think_time);
1481 break;
1482 case HUB_TTTT_24_BITS:
1483 hub->tt.think_time = 666 * 3;
1484 dev_dbg(hub_dev, "TT requires at most %d "
1485 "FS bit times (%d ns)\n",
1486 24, hub->tt.think_time);
1487 break;
1488 case HUB_TTTT_32_BITS:
1489 hub->tt.think_time = 666 * 4;
1490 dev_dbg(hub_dev, "TT requires at most %d "
1491 "FS bit times (%d ns)\n",
1492 32, hub->tt.think_time);
1493 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 }
1495
1496 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001497 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 hub->has_indicators = 1;
1499 dev_dbg(hub_dev, "Port indicators are supported\n");
1500 }
1501
1502 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1503 hub->descriptor->bPwrOn2PwrGood * 2);
1504
1505 /* power budgeting mostly matters with bus-powered hubs,
1506 * and battery-powered root hubs (may provide just 8 mA).
1507 */
1508 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern15b73362013-07-30 15:35:40 -04001509 if (ret) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 message = "can't get hub status";
1511 goto fail;
1512 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001513 hcd = bus_to_hcd(hdev->bus);
Alan Stern7d35b922005-04-25 11:18:32 -04001514 if (hdev == hdev->bus->root_hub) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001515 if (hcd->power_budget > 0)
1516 hdev->bus_mA = hcd->power_budget;
1517 else
Dan Williamsd8521af2014-05-20 18:08:28 -07001518 hdev->bus_mA = full_load * maxchild;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001519 if (hdev->bus_mA >= full_load)
1520 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001521 else {
1522 hub->mA_per_port = hdev->bus_mA;
1523 hub->limited_power = 1;
1524 }
Alan Stern7d35b922005-04-25 11:18:32 -04001525 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001526 int remaining = hdev->bus_mA -
1527 hub->descriptor->bHubContrCurrent;
1528
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1530 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -05001531 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Dan Williamsd8521af2014-05-20 18:08:28 -07001533 if (remaining < maxchild * unit_load)
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001534 dev_warn(hub_dev,
Alan Stern55c52712005-11-23 12:03:12 -05001535 "insufficient power available "
1536 "to use all downstream ports\n");
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001537 hub->mA_per_port = unit_load; /* 7.2.1 */
1538
Alan Stern55c52712005-11-23 12:03:12 -05001539 } else { /* Self-powered external hub */
1540 /* FIXME: What about battery-powered external hubs that
1541 * provide less current per port? */
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001542 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001543 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001544 if (hub->mA_per_port < full_load)
Alan Stern55c52712005-11-23 12:03:12 -05001545 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1546 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
1548 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1549 if (ret < 0) {
1550 message = "can't get hub status";
1551 goto fail;
1552 }
1553
1554 /* local power status reports aren't always correct */
1555 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1556 dev_dbg(hub_dev, "local power source is %s\n",
1557 (hubstatus & HUB_STATUS_LOCAL_POWER)
1558 ? "lost (inactive)" : "good");
1559
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001560 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 dev_dbg(hub_dev, "%sover-current condition exists\n",
1562 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1563
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -07001564 /* set up the interrupt endpoint
1565 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1566 * bytes as USB2.0[11.12.3] says because some hubs are known
1567 * to send more data (and thus cause overflow). For root hubs,
1568 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1569 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1571 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1572
1573 if (maxp > sizeof(*hub->buffer))
1574 maxp = sizeof(*hub->buffer);
1575
1576 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1577 if (!hub->urb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 ret = -ENOMEM;
1579 goto fail;
1580 }
1581
1582 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1583 hub, endpoint->bInterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
1585 /* maybe cycle the hub leds */
1586 if (hub->has_indicators && blinkenlights)
Matthias Beyer469271f2013-10-10 23:41:27 +02001587 hub->indicator[0] = INDICATOR_CYCLE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Dan Williamsd8521af2014-05-20 18:08:28 -07001589 mutex_lock(&usb_port_peer_mutex);
1590 for (i = 0; i < maxchild; i++) {
Krzysztof Mazure58547e2013-08-22 14:49:39 +02001591 ret = usb_hub_create_port_device(hub, i + 1);
1592 if (ret < 0) {
Lan Tianyufa2a9562012-09-05 13:44:31 +08001593 dev_err(hub->intfdev,
1594 "couldn't create port%d device.\n", i + 1);
Dan Williamsd8521af2014-05-20 18:08:28 -07001595 break;
Krzysztof Mazure58547e2013-08-22 14:49:39 +02001596 }
1597 }
Dan Williamsd8521af2014-05-20 18:08:28 -07001598 hdev->maxchild = i;
Dan Williamse3d10502014-06-17 16:16:32 -07001599 for (i = 0; i < hdev->maxchild; i++) {
1600 struct usb_port *port_dev = hub->ports[i];
1601
1602 pm_runtime_put(&port_dev->dev);
1603 }
1604
Dan Williamsd8521af2014-05-20 18:08:28 -07001605 mutex_unlock(&usb_port_peer_mutex);
1606 if (ret < 0)
1607 goto fail;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001608
Dan Williamse3d95582014-06-05 14:23:04 -07001609 /* Update the HCD's internal representation of this hub before khubd
1610 * starts getting port status changes for devices under the hub.
1611 */
1612 if (hcd->driver->update_hub_device) {
1613 ret = hcd->driver->update_hub_device(hcd, hdev,
1614 &hub->tt, GFP_KERNEL);
1615 if (ret < 0) {
1616 message = "can't update HCD hub info";
1617 goto fail;
1618 }
1619 }
1620
Lan Tianyud2123fd2013-01-21 22:18:00 +08001621 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1622
Alan Sternf2835212008-04-28 11:07:17 -04001623 hub_activate(hub, HUB_INIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 return 0;
1625
1626fail:
1627 dev_err (hub_dev, "config failed, %s (err %d)\n",
1628 message, ret);
1629 /* hub_disconnect() frees urb and descriptor */
1630 return ret;
1631}
1632
Alan Sterne8054852007-05-04 11:55:11 -04001633static void hub_release(struct kref *kref)
1634{
1635 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1636
1637 usb_put_intf(to_usb_interface(hub->intfdev));
1638 kfree(hub);
1639}
1640
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641static unsigned highspeed_hubs;
1642
1643static void hub_disconnect(struct usb_interface *intf)
1644{
Huajun Li88162302012-03-12 21:00:19 +08001645 struct usb_hub *hub = usb_get_intfdata(intf);
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07001646 struct usb_device *hdev = interface_to_usbdev(intf);
Alan Stern543d7782014-01-07 10:43:02 -05001647 int port1;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001648
Alan Sterne8054852007-05-04 11:55:11 -04001649 /* Take the hub off the event list and don't let it be added again */
1650 spin_lock_irq(&hub_event_lock);
Alan Stern8e4ceb32009-12-07 13:01:37 -05001651 if (!list_empty(&hub->event_list)) {
1652 list_del_init(&hub->event_list);
1653 usb_autopm_put_interface_no_suspend(intf);
1654 }
Alan Sterne8054852007-05-04 11:55:11 -04001655 hub->disconnected = 1;
1656 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Alan Stern7de18d82006-06-01 13:37:24 -04001658 /* Disconnect all children and quiesce the hub */
1659 hub->error = 0;
Alan Stern43303542008-04-28 11:07:31 -04001660 hub_quiesce(hub, HUB_DISCONNECT);
Alan Stern7de18d82006-06-01 13:37:24 -04001661
Dan Williamsd8521af2014-05-20 18:08:28 -07001662 mutex_lock(&usb_port_peer_mutex);
1663
Alan Stern543d7782014-01-07 10:43:02 -05001664 /* Avoid races with recursively_mark_NOTATTACHED() */
1665 spin_lock_irq(&device_state_lock);
1666 port1 = hdev->maxchild;
1667 hdev->maxchild = 0;
1668 usb_set_intfdata(intf, NULL);
1669 spin_unlock_irq(&device_state_lock);
Alexander Shishkin1f2235b2012-09-12 14:48:31 +03001670
Alan Stern543d7782014-01-07 10:43:02 -05001671 for (; port1 > 0; --port1)
1672 usb_hub_remove_port_device(hub, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Dan Williamsd8521af2014-05-20 18:08:28 -07001674 mutex_unlock(&usb_port_peer_mutex);
1675
Alan Sterne8054852007-05-04 11:55:11 -04001676 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 highspeed_hubs--;
1678
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 usb_free_urb(hub->urb);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001680 kfree(hub->ports);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001681 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001682 kfree(hub->status);
Alan Sternd697cdd2009-10-27 15:18:46 -04001683 kfree(hub->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Lan Tianyu971fcd42013-01-23 04:26:29 +08001685 pm_suspend_ignore_children(&intf->dev, false);
Alan Sterne8054852007-05-04 11:55:11 -04001686 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687}
1688
1689static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1690{
1691 struct usb_host_interface *desc;
1692 struct usb_endpoint_descriptor *endpoint;
1693 struct usb_device *hdev;
1694 struct usb_hub *hub;
1695
1696 desc = intf->cur_altsetting;
1697 hdev = interface_to_usbdev(intf);
1698
Ming Lei596d7892012-10-24 11:59:25 +08001699 /*
1700 * Set default autosuspend delay as 0 to speedup bus suspend,
1701 * based on the below considerations:
1702 *
1703 * - Unlike other drivers, the hub driver does not rely on the
1704 * autosuspend delay to provide enough time to handle a wakeup
1705 * event, and the submitted status URB is just to check future
1706 * change on hub downstream ports, so it is safe to do it.
1707 *
1708 * - The patch might cause one or more auto supend/resume for
1709 * below very rare devices when they are plugged into hub
1710 * first time:
1711 *
1712 * devices having trouble initializing, and disconnect
1713 * themselves from the bus and then reconnect a second
1714 * or so later
1715 *
1716 * devices just for downloading firmware, and disconnects
1717 * themselves after completing it
1718 *
1719 * For these quite rare devices, their drivers may change the
1720 * autosuspend delay of their parent hub in the probe() to one
1721 * appropriate value to avoid the subtle problem if someone
1722 * does care it.
1723 *
1724 * - The patch may cause one or more auto suspend/resume on
1725 * hub during running 'lsusb', but it is probably too
1726 * infrequent to worry about.
1727 *
1728 * - Change autosuspend delay of hub can avoid unnecessary auto
1729 * suspend timer for hub, also may decrease power consumption
1730 * of USB bus.
Roger Quadrosbdd405d2014-08-04 12:44:46 +03001731 *
1732 * - If user has indicated to prevent autosuspend by passing
1733 * usbcore.autosuspend = -1 then keep autosuspend disabled.
Ming Lei596d7892012-10-24 11:59:25 +08001734 */
Greg Kroah-Hartmana9ef8032014-08-27 16:55:29 -07001735#ifdef CONFIG_PM_RUNTIME
Roger Quadrosbdd405d2014-08-04 12:44:46 +03001736 if (hdev->dev.power.autosuspend_delay >= 0)
1737 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
Greg Kroah-Hartmana9ef8032014-08-27 16:55:29 -07001738#endif
Ming Lei596d7892012-10-24 11:59:25 +08001739
Alan Stern8ef42dd2014-05-23 10:45:54 -04001740 /*
1741 * Hubs have proper suspend/resume support, except for root hubs
1742 * where the controller driver doesn't have bus_suspend and
1743 * bus_resume methods.
1744 */
1745 if (hdev->parent) { /* normal device */
1746 usb_enable_autosuspend(hdev);
1747 } else { /* root hub */
1748 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1749
1750 if (drv->bus_suspend && drv->bus_resume)
1751 usb_enable_autosuspend(hdev);
1752 }
Alan Stern088f7fe2010-01-08 12:56:54 -05001753
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001754 if (hdev->level == MAX_TOPO_LEVEL) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001755 dev_err(&intf->dev,
1756 "Unsupported bus topology: hub nested too deep\n");
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001757 return -E2BIG;
1758 }
1759
David Brownell89ccbdc2006-04-02 10:18:09 -08001760#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1761 if (hdev->parent) {
1762 dev_warn(&intf->dev, "ignoring external hub\n");
1763 return -ENODEV;
1764 }
1765#endif
1766
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 /* Some hubs have a subclass of 1, which AFAICT according to the */
1768 /* specs is not defined, but it works */
1769 if ((desc->desc.bInterfaceSubClass != 0) &&
1770 (desc->desc.bInterfaceSubClass != 1)) {
1771descriptor_error:
1772 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1773 return -EIO;
1774 }
1775
1776 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1777 if (desc->desc.bNumEndpoints != 1)
1778 goto descriptor_error;
1779
1780 endpoint = &desc->endpoint[0].desc;
1781
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -07001782 /* If it's not an interrupt in endpoint, we'd better punt! */
1783 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 goto descriptor_error;
1785
1786 /* We found a hub */
1787 dev_info (&intf->dev, "USB hub found\n");
1788
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001789 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 if (!hub) {
1791 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1792 return -ENOMEM;
1793 }
1794
Alan Sterne8054852007-05-04 11:55:11 -04001795 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 INIT_LIST_HEAD(&hub->event_list);
1797 hub->intfdev = &intf->dev;
1798 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001799 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Stern8520f382008-09-22 14:44:26 -04001800 INIT_DELAYED_WORK(&hub->init_work, NULL);
Alan Sterne8054852007-05-04 11:55:11 -04001801 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
1803 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001804 intf->needs_remote_wakeup = 1;
Lan Tianyu971fcd42013-01-23 04:26:29 +08001805 pm_suspend_ignore_children(&intf->dev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
1807 if (hdev->speed == USB_SPEED_HIGH)
1808 highspeed_hubs++;
1809
Ming Leie6f30de2012-10-24 11:59:24 +08001810 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1811 hub->quirk_check_port_auto_suspend = 1;
1812
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 if (hub_configure(hub, endpoint) >= 0)
1814 return 0;
1815
1816 hub_disconnect (intf);
1817 return -ENODEV;
1818}
1819
1820static int
1821hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1822{
1823 struct usb_device *hdev = interface_to_usbdev (intf);
Lan Tianyuad493e52013-01-23 04:26:30 +08001824 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
1826 /* assert ifno == 0 (part of hub spec) */
1827 switch (code) {
1828 case USBDEVFS_HUB_PORTINFO: {
1829 struct usbdevfs_hub_portinfo *info = user_data;
1830 int i;
1831
1832 spin_lock_irq(&device_state_lock);
1833 if (hdev->devnum <= 0)
1834 info->nports = 0;
1835 else {
1836 info->nports = hdev->maxchild;
1837 for (i = 0; i < info->nports; i++) {
Lan Tianyuff823c792012-09-05 13:44:32 +08001838 if (hub->ports[i]->child == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 info->port[i] = 0;
1840 else
1841 info->port[i] =
Lan Tianyuff823c792012-09-05 13:44:32 +08001842 hub->ports[i]->child->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 }
1844 }
1845 spin_unlock_irq(&device_state_lock);
1846
1847 return info->nports + 1;
1848 }
1849
1850 default:
1851 return -ENOSYS;
1852 }
1853}
1854
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001855/*
1856 * Allow user programs to claim ports on a hub. When a device is attached
1857 * to one of these "claimed" ports, the program will "own" the device.
1858 */
1859static int find_port_owner(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001860 struct usb_dev_state ***ppowner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001861{
Mathias Nyman413412612013-06-18 17:28:48 +03001862 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1863
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001864 if (hdev->state == USB_STATE_NOTATTACHED)
1865 return -ENODEV;
1866 if (port1 == 0 || port1 > hdev->maxchild)
1867 return -EINVAL;
1868
Mathias Nyman413412612013-06-18 17:28:48 +03001869 /* Devices not managed by the hub driver
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001870 * will always have maxchild equal to 0.
1871 */
Mathias Nyman413412612013-06-18 17:28:48 +03001872 *ppowner = &(hub->ports[port1 - 1]->port_owner);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001873 return 0;
1874}
1875
1876/* In the following three functions, the caller must hold hdev's lock */
Lan Tianyu336c5c32012-07-06 14:13:52 +08001877int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001878 struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001879{
1880 int rc;
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001881 struct usb_dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001882
1883 rc = find_port_owner(hdev, port1, &powner);
1884 if (rc)
1885 return rc;
1886 if (*powner)
1887 return -EBUSY;
1888 *powner = owner;
1889 return rc;
1890}
Valentina Manea6080cd02014-03-08 14:53:34 +02001891EXPORT_SYMBOL_GPL(usb_hub_claim_port);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001892
Lan Tianyu336c5c32012-07-06 14:13:52 +08001893int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001894 struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001895{
1896 int rc;
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001897 struct usb_dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001898
1899 rc = find_port_owner(hdev, port1, &powner);
1900 if (rc)
1901 return rc;
1902 if (*powner != owner)
1903 return -ENOENT;
1904 *powner = NULL;
1905 return rc;
1906}
Valentina Manea6080cd02014-03-08 14:53:34 +02001907EXPORT_SYMBOL_GPL(usb_hub_release_port);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001908
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001909void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001910{
Lan Tianyuad493e52013-01-23 04:26:30 +08001911 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001912 int n;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001913
Lan Tianyufa2a9562012-09-05 13:44:31 +08001914 for (n = 0; n < hdev->maxchild; n++) {
1915 if (hub->ports[n]->port_owner == owner)
1916 hub->ports[n]->port_owner = NULL;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001917 }
Lan Tianyufa2a9562012-09-05 13:44:31 +08001918
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001919}
1920
1921/* The caller must hold udev's lock */
1922bool usb_device_is_owned(struct usb_device *udev)
1923{
1924 struct usb_hub *hub;
1925
1926 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1927 return false;
Lan Tianyuad493e52013-01-23 04:26:30 +08001928 hub = usb_hub_to_struct_hub(udev->parent);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001929 return !!hub->ports[udev->portnum - 1]->port_owner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001930}
1931
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1933{
Lan Tianyuad493e52013-01-23 04:26:30 +08001934 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 int i;
1936
1937 for (i = 0; i < udev->maxchild; ++i) {
Lan Tianyuff823c792012-09-05 13:44:32 +08001938 if (hub->ports[i]->child)
1939 recursively_mark_NOTATTACHED(hub->ports[i]->child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 }
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001941 if (udev->state == USB_STATE_SUSPENDED)
Sarah Sharp15123002007-12-21 16:54:15 -08001942 udev->active_duration -= jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 udev->state = USB_STATE_NOTATTACHED;
1944}
1945
1946/**
1947 * usb_set_device_state - change a device's current state (usbcore, hcds)
1948 * @udev: pointer to device whose state should be changed
1949 * @new_state: new state value to be stored
1950 *
1951 * udev->state is _not_ fully protected by the device lock. Although
1952 * most transitions are made only while holding the lock, the state can
1953 * can change to USB_STATE_NOTATTACHED at almost any time. This
1954 * is so that devices can be marked as disconnected as soon as possible,
1955 * without having to wait for any semaphores to be released. As a result,
1956 * all changes to any device's state must be protected by the
1957 * device_state_lock spinlock.
1958 *
1959 * Once a device has been added to the device tree, all changes to its state
1960 * should be made using this routine. The state should _not_ be set directly.
1961 *
1962 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1963 * Otherwise udev->state is set to new_state, and if new_state is
1964 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1965 * to USB_STATE_NOTATTACHED.
1966 */
1967void usb_set_device_state(struct usb_device *udev,
1968 enum usb_device_state new_state)
1969{
1970 unsigned long flags;
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001971 int wakeup = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973 spin_lock_irqsave(&device_state_lock, flags);
1974 if (udev->state == USB_STATE_NOTATTACHED)
1975 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001976 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001977
1978 /* root hub wakeup capabilities are managed out-of-band
1979 * and may involve silicon errata ... ignore them here.
1980 */
1981 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001982 if (udev->state == USB_STATE_SUSPENDED
1983 || new_state == USB_STATE_SUSPENDED)
1984 ; /* No change to wakeup settings */
1985 else if (new_state == USB_STATE_CONFIGURED)
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001986 wakeup = udev->actconfig->desc.bmAttributes
1987 & USB_CONFIG_ATT_WAKEUP;
Alan Stern645daaa2006-08-30 15:47:02 -04001988 else
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001989 wakeup = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001990 }
Sarah Sharp15123002007-12-21 16:54:15 -08001991 if (udev->state == USB_STATE_SUSPENDED &&
1992 new_state != USB_STATE_SUSPENDED)
1993 udev->active_duration -= jiffies;
1994 else if (new_state == USB_STATE_SUSPENDED &&
1995 udev->state != USB_STATE_SUSPENDED)
1996 udev->active_duration += jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -04001997 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001998 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 recursively_mark_NOTATTACHED(udev);
2000 spin_unlock_irqrestore(&device_state_lock, flags);
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01002001 if (wakeup >= 0)
2002 device_set_wakeup_capable(&udev->dev, wakeup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003}
David Vrabel6da9c992009-02-18 14:43:47 +00002004EXPORT_SYMBOL_GPL(usb_set_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002006/*
Alan Stern3b29b682011-02-22 09:53:41 -05002007 * Choose a device number.
2008 *
2009 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2010 * USB-2.0 buses they are also used as device addresses, however on
2011 * USB-3.0 buses the address is assigned by the controller hardware
2012 * and it usually is not the same as the device number.
2013 *
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002014 * WUSB devices are simple: they have no hubs behind, so the mapping
2015 * device <-> virtual port number becomes 1:1. Why? to simplify the
2016 * life of the device connection logic in
2017 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2018 * handshake we need to assign a temporary address in the unauthorized
2019 * space. For simplicity we use the first virtual port number found to
2020 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2021 * and that becomes it's address [X < 128] or its unauthorized address
2022 * [X | 0x80].
2023 *
2024 * We add 1 as an offset to the one-based USB-stack port number
2025 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2026 * 0 is reserved by USB for default address; (b) Linux's USB stack
2027 * uses always #1 for the root hub of the controller. So USB stack's
2028 * port #1, which is wusb virtual-port #0 has address #2.
Sarah Sharpc6515272009-04-27 19:57:26 -07002029 *
2030 * Devices connected under xHCI are not as simple. The host controller
2031 * supports virtualization, so the hardware assigns device addresses and
2032 * the HCD must setup data structures before issuing a set address
2033 * command to the hardware.
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002034 */
Alan Stern3b29b682011-02-22 09:53:41 -05002035static void choose_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036{
2037 int devnum;
2038 struct usb_bus *bus = udev->bus;
2039
2040 /* If khubd ever becomes multithreaded, this will need a lock */
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002041 if (udev->wusb) {
2042 devnum = udev->portnum + 1;
2043 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2044 } else {
2045 /* Try to allocate the next devnum beginning at
2046 * bus->devnum_next. */
2047 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2048 bus->devnum_next);
2049 if (devnum >= 128)
2050 devnum = find_next_zero_bit(bus->devmap.devicemap,
2051 128, 1);
Matthias Beyer469271f2013-10-10 23:41:27 +02002052 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 if (devnum < 128) {
2055 set_bit(devnum, bus->devmap.devicemap);
2056 udev->devnum = devnum;
2057 }
2058}
2059
Alan Stern3b29b682011-02-22 09:53:41 -05002060static void release_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061{
2062 if (udev->devnum > 0) {
2063 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2064 udev->devnum = -1;
2065 }
2066}
2067
Alan Stern3b29b682011-02-22 09:53:41 -05002068static void update_devnum(struct usb_device *udev, int devnum)
David Vrabel4953d142008-04-08 13:24:46 -07002069{
2070 /* The address for a WUSB device is managed by wusbcore. */
2071 if (!udev->wusb)
2072 udev->devnum = devnum;
2073}
2074
Herbert Xuf7410ce2010-01-10 20:15:03 +11002075static void hub_free_dev(struct usb_device *udev)
2076{
2077 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2078
2079 /* Root hubs aren't real devices, so don't free HCD resources */
2080 if (hcd->driver->free_dev && udev->parent)
2081 hcd->driver->free_dev(hcd, udev);
2082}
2083
Dan Williams7027df32014-05-20 18:09:36 -07002084static void hub_disconnect_children(struct usb_device *udev)
2085{
2086 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2087 int i;
2088
2089 /* Free up all the children before we remove this device */
2090 for (i = 0; i < udev->maxchild; i++) {
2091 if (hub->ports[i]->child)
2092 usb_disconnect(&hub->ports[i]->child);
2093 }
2094}
2095
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096/**
2097 * usb_disconnect - disconnect a device (usbcore-internal)
2098 * @pdev: pointer to device being disconnected
2099 * Context: !in_interrupt ()
2100 *
2101 * Something got disconnected. Get rid of it and all of its children.
2102 *
2103 * If *pdev is a normal device then the parent hub must already be locked.
Bjorn Helgaasdb8f2aa2013-09-13 13:57:34 -06002104 * If *pdev is a root hub then the caller must hold the usb_bus_list_lock,
2105 * which protects the set of root hubs as well as the list of buses.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 *
2107 * Only hub drivers (including virtual root hub drivers for host
2108 * controllers) should ever call this.
2109 *
2110 * This call is synchronous, and may not be used in an interrupt context.
2111 */
2112void usb_disconnect(struct usb_device **pdev)
2113{
Dan Williams7027df32014-05-20 18:09:36 -07002114 struct usb_port *port_dev = NULL;
2115 struct usb_device *udev = *pdev;
Peter Chen5b1dc202014-08-19 08:56:21 +08002116 struct usb_hub *hub = NULL;
2117 int port1 = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 /* mark the device as inactive, so any further urb submissions for
2120 * this device (and any of its children) will fail immediately.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002121 * this quiesces everything except pending urbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 */
2123 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern3b29b682011-02-22 09:53:41 -05002124 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2125 udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002127 usb_lock_device(udev);
2128
Dan Williams7027df32014-05-20 18:09:36 -07002129 hub_disconnect_children(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131 /* deallocate hcd/hardware state ... nuking all pending urbs and
2132 * cleaning up all state associated with the current configuration
2133 * so that the hardware is now fully quiesced.
2134 */
Alan Stern782da722006-07-01 22:09:35 -04002135 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 usb_disable_device(udev, 0);
Alan Sterncde217a2008-10-21 15:28:46 -04002137 usb_hcd_synchronize_unlinks(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
Lan Tianyufde26382013-01-20 01:53:33 +08002139 if (udev->parent) {
Dan Williams7027df32014-05-20 18:09:36 -07002140 port1 = udev->portnum;
2141 hub = usb_hub_to_struct_hub(udev->parent);
2142 port_dev = hub->ports[port1 - 1];
Lan Tianyufde26382013-01-20 01:53:33 +08002143
2144 sysfs_remove_link(&udev->dev.kobj, "port");
2145 sysfs_remove_link(&port_dev->dev.kobj, "device");
Lan Tianyu971fcd42013-01-23 04:26:29 +08002146
Dan Williams7027df32014-05-20 18:09:36 -07002147 /*
2148 * As usb_port_runtime_resume() de-references udev, make
2149 * sure no resumes occur during removal
2150 */
2151 if (!test_and_set_bit(port1, hub->child_usage_bits))
2152 pm_runtime_get_sync(&port_dev->dev);
Lan Tianyufde26382013-01-20 01:53:33 +08002153 }
2154
Alan Stern3b23dd62008-12-05 14:10:34 -05002155 usb_remove_ep_devs(&udev->ep0);
Alan Stern782da722006-07-01 22:09:35 -04002156 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07002157
Alan Stern782da722006-07-01 22:09:35 -04002158 /* Unregister the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002159 * for de-configuring the device and invoking the remove-device
2160 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002161 */
2162 device_del(&udev->dev);
2163
2164 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 * (or root_hub) pointer.
2166 */
Alan Stern3b29b682011-02-22 09:53:41 -05002167 release_devnum(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
2169 /* Avoid races with recursively_mark_NOTATTACHED() */
2170 spin_lock_irq(&device_state_lock);
2171 *pdev = NULL;
2172 spin_unlock_irq(&device_state_lock);
2173
Dan Williams7027df32014-05-20 18:09:36 -07002174 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2175 pm_runtime_put(&port_dev->dev);
2176
Herbert Xuf7410ce2010-01-10 20:15:03 +11002177 hub_free_dev(udev);
2178
Alan Stern782da722006-07-01 22:09:35 -04002179 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180}
2181
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002182#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183static void show_string(struct usb_device *udev, char *id, char *string)
2184{
2185 if (!string)
2186 return;
Joe Perchesf2ec5222012-10-28 01:05:51 -07002187 dev_info(&udev->dev, "%s: %s\n", id, string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188}
2189
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002190static void announce_device(struct usb_device *udev)
2191{
2192 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2193 le16_to_cpu(udev->descriptor.idVendor),
2194 le16_to_cpu(udev->descriptor.idProduct));
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002195 dev_info(&udev->dev,
2196 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002197 udev->descriptor.iManufacturer,
2198 udev->descriptor.iProduct,
2199 udev->descriptor.iSerialNumber);
2200 show_string(udev, "Product", udev->product);
2201 show_string(udev, "Manufacturer", udev->manufacturer);
2202 show_string(udev, "SerialNumber", udev->serial);
2203}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204#else
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002205static inline void announce_device(struct usb_device *udev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206#endif
2207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208#ifdef CONFIG_USB_OTG
2209#include "otg_whitelist.h"
2210#endif
2211
Oliver Neukum3ede7602007-01-11 14:35:50 +01002212/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002213 * usb_enumerate_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01002214 * @udev: newly addressed device (in ADDRESS state)
2215 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002216 * Finish enumeration for On-The-Go devices
Yacine Belkadi626f0902013-08-02 20:10:04 +02002217 *
2218 * Return: 0 if successful. A negative error code otherwise.
Oliver Neukum3ede7602007-01-11 14:35:50 +01002219 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002220static int usb_enumerate_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002222 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
2224#ifdef CONFIG_USB_OTG
2225 /*
2226 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2227 * to wake us after we've powered off VBUS; and HNP, switching roles
2228 * "host" to "peripheral". The OTG descriptor helps figure this out.
2229 */
2230 if (!udev->bus->is_b_host
2231 && udev->config
2232 && udev->parent == udev->bus->root_hub) {
Felipe Balbi2eb50522009-12-04 15:47:43 +02002233 struct usb_otg_descriptor *desc = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 struct usb_bus *bus = udev->bus;
2235
2236 /* descriptor may appear anywhere in config */
2237 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2238 le16_to_cpu(udev->config[0].desc.wTotalLength),
2239 USB_DT_OTG, (void **) &desc) == 0) {
2240 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05002241 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07002242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 dev_info(&udev->dev,
2244 "Dual-Role OTG device on %sHNP port\n",
2245 (port1 == bus->otg_port)
2246 ? "" : "non-");
2247
2248 /* enable HNP before suspend, it's simpler */
2249 if (port1 == bus->otg_port)
2250 bus->b_hnp_enable = 1;
2251 err = usb_control_msg(udev,
2252 usb_sndctrlpipe(udev, 0),
2253 USB_REQ_SET_FEATURE, 0,
2254 bus->b_hnp_enable
2255 ? USB_DEVICE_B_HNP_ENABLE
2256 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2257 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2258 if (err < 0) {
2259 /* OTG MESSAGE: report errors here,
2260 * customize to match your product.
2261 */
2262 dev_info(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002263 "can't set HNP mode: %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 err);
2265 bus->b_hnp_enable = 0;
2266 }
2267 }
2268 }
2269 }
2270
2271 if (!is_targeted(udev)) {
2272
2273 /* Maybe it can talk to us, though we can't talk to it.
2274 * (Includes HNP test device.)
2275 */
2276 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
David Brownell634a84f2009-01-15 13:51:28 -08002277 err = usb_port_suspend(udev, PMSG_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 if (err < 0)
2279 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2280 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07002281 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 goto fail;
2283 }
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002284fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002286 return err;
2287}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002289
2290/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002291 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002292 * @udev: newly addressed device (in ADDRESS state)
2293 *
2294 * This is only called by usb_new_device() and usb_authorize_device()
2295 * and FIXME -- all comments that apply to them apply here wrt to
2296 * environment.
2297 *
2298 * If the device is WUSB and not authorized, we don't attempt to read
2299 * the string descriptors, as they will be errored out by the device
2300 * until it has been authorized.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002301 *
2302 * Return: 0 if successful. A negative error code otherwise.
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002303 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002304static int usb_enumerate_device(struct usb_device *udev)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002305{
2306 int err;
2307
2308 if (udev->config == NULL) {
2309 err = usb_get_configuration(udev);
2310 if (err < 0) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04002311 if (err != -ENODEV)
2312 dev_err(&udev->dev, "can't read configurations, error %d\n",
2313 err);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002314 return err;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002315 }
2316 }
Thomas Pugliese83e83ec2013-12-09 13:40:29 -06002317
2318 /* read the standard strings and cache them if present */
2319 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2320 udev->manufacturer = usb_cache_string(udev,
2321 udev->descriptor.iManufacturer);
2322 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2323
Alan Stern8d8558d2009-12-08 15:50:41 -05002324 err = usb_enumerate_device_otg(udev);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002325 if (err < 0)
2326 return err;
2327
2328 usb_detect_interface_quirks(udev);
2329
2330 return 0;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002331}
2332
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002333static void set_usb_port_removable(struct usb_device *udev)
2334{
2335 struct usb_device *hdev = udev->parent;
2336 struct usb_hub *hub;
2337 u8 port = udev->portnum;
2338 u16 wHubCharacteristics;
2339 bool removable = true;
2340
2341 if (!hdev)
2342 return;
2343
Lan Tianyuad493e52013-01-23 04:26:30 +08002344 hub = usb_hub_to_struct_hub(udev->parent);
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002345
2346 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2347
2348 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2349 return;
2350
2351 if (hub_is_superspeed(hdev)) {
Lan Tianyuca3c1532012-09-11 04:22:36 +08002352 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2353 & (1 << port))
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002354 removable = false;
2355 } else {
2356 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2357 removable = false;
2358 }
2359
2360 if (removable)
2361 udev->removable = USB_DEVICE_REMOVABLE;
2362 else
2363 udev->removable = USB_DEVICE_FIXED;
Dan Williamsa4204ff2014-05-20 18:08:22 -07002364
2365 /*
2366 * Platform firmware may have populated an alternative value for
2367 * removable. If the parent port has a known connect_type use
2368 * that instead.
2369 */
2370 switch (hub->ports[udev->portnum - 1]->connect_type) {
2371 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2372 udev->removable = USB_DEVICE_REMOVABLE;
2373 break;
2374 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2375 udev->removable = USB_DEVICE_FIXED;
2376 break;
2377 default: /* use what was set above */
2378 break;
2379 }
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002380}
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002381
2382/**
2383 * usb_new_device - perform initial device setup (usbcore-internal)
2384 * @udev: newly addressed device (in ADDRESS state)
2385 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002386 * This is called with devices which have been detected but not fully
2387 * enumerated. The device descriptor is available, but not descriptors
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002388 * for any device configuration. The caller must have locked either
2389 * the parent hub (if udev is a normal device) or else the
2390 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2391 * udev has already been installed, but udev is not yet visible through
2392 * sysfs or other filesystem code.
2393 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002394 * This call is synchronous, and may not be used in an interrupt context.
2395 *
2396 * Only the hub driver or root-hub registrar should ever call this.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002397 *
2398 * Return: Whether the device is configured properly or not. Zero if the
2399 * interface was registered with the driver core; else a negative errno
2400 * value.
2401 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002402 */
2403int usb_new_device(struct usb_device *udev)
2404{
2405 int err;
2406
Dan Streetman16985402010-01-06 09:56:53 -05002407 if (udev->parent) {
Dan Streetman16985402010-01-06 09:56:53 -05002408 /* Initialize non-root-hub device wakeup to disabled;
2409 * device (un)configuration controls wakeup capable
2410 * sysfs power/wakeup controls wakeup enabled/disabled
2411 */
2412 device_init_wakeup(&udev->dev, 0);
Dan Streetman16985402010-01-06 09:56:53 -05002413 }
2414
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002415 /* Tell the runtime-PM framework the device is active */
2416 pm_runtime_set_active(&udev->dev);
Alan Sternc08512c2010-11-15 15:57:58 -05002417 pm_runtime_get_noresume(&udev->dev);
Alan Sternfcc4a012010-11-15 15:57:51 -05002418 pm_runtime_use_autosuspend(&udev->dev);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002419 pm_runtime_enable(&udev->dev);
2420
Alan Sternc08512c2010-11-15 15:57:58 -05002421 /* By default, forbid autosuspend for all devices. It will be
2422 * allowed for hubs during binding.
2423 */
2424 usb_disable_autosuspend(udev);
2425
Alan Stern8d8558d2009-12-08 15:50:41 -05002426 err = usb_enumerate_device(udev); /* Read descriptors */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002427 if (err < 0)
2428 goto fail;
Sarah Sharpc6515272009-04-27 19:57:26 -07002429 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2430 udev->devnum, udev->bus->busnum,
2431 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002432 /* export the usbdev device-node for libusb */
2433 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2434 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2435
Alan Stern6cd13202008-11-13 15:08:30 -05002436 /* Tell the world! */
2437 announce_device(udev);
Alan Stern195af2c2007-07-16 15:28:19 -04002438
Theodore Ts'ob04b3152012-07-04 11:22:20 -04002439 if (udev->serial)
2440 add_device_randomness(udev->serial, strlen(udev->serial));
2441 if (udev->product)
2442 add_device_randomness(udev->product, strlen(udev->product));
2443 if (udev->manufacturer)
2444 add_device_randomness(udev->manufacturer,
2445 strlen(udev->manufacturer));
2446
Rafael J. Wysocki927bc912010-02-08 19:18:16 +01002447 device_enable_async_suspend(&udev->dev);
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002448
Dan Williamsa4204ff2014-05-20 18:08:22 -07002449 /* check whether the hub or firmware marks this port as non-removable */
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002450 if (udev->parent)
2451 set_usb_port_removable(udev);
2452
Alan Stern782da722006-07-01 22:09:35 -04002453 /* Register the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002454 * for configuring the device and invoking the add-device
2455 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002456 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002457 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 if (err) {
2459 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2460 goto fail;
2461 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002462
Lan Tianyufde26382013-01-20 01:53:33 +08002463 /* Create link files between child device and usb port device. */
2464 if (udev->parent) {
Lan Tianyuad493e52013-01-23 04:26:30 +08002465 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
Dan Williamsd5c38342014-05-20 18:08:52 -07002466 int port1 = udev->portnum;
2467 struct usb_port *port_dev = hub->ports[port1 - 1];
Lan Tianyufde26382013-01-20 01:53:33 +08002468
2469 err = sysfs_create_link(&udev->dev.kobj,
2470 &port_dev->dev.kobj, "port");
2471 if (err)
2472 goto fail;
2473
2474 err = sysfs_create_link(&port_dev->dev.kobj,
2475 &udev->dev.kobj, "device");
2476 if (err) {
2477 sysfs_remove_link(&udev->dev.kobj, "port");
2478 goto fail;
2479 }
Lan Tianyu971fcd42013-01-23 04:26:29 +08002480
Dan Williamsd5c38342014-05-20 18:08:52 -07002481 if (!test_and_set_bit(port1, hub->child_usage_bits))
2482 pm_runtime_get_sync(&port_dev->dev);
Lan Tianyufde26382013-01-20 01:53:33 +08002483 }
2484
Alan Stern3b23dd62008-12-05 14:10:34 -05002485 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
Alan Sternc08512c2010-11-15 15:57:58 -05002486 usb_mark_last_busy(udev);
2487 pm_runtime_put_sync_autosuspend(&udev->dev);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07002488 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489
2490fail:
2491 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002492 pm_runtime_disable(&udev->dev);
2493 pm_runtime_set_suspended(&udev->dev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002494 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495}
2496
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002497
2498/**
Randy Dunlapfd39c862007-10-15 17:30:02 -07002499 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2500 * @usb_dev: USB device
2501 *
2502 * Move the USB device to a very basic state where interfaces are disabled
2503 * and the device is in fact unconfigured and unusable.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002504 *
2505 * We share a lock (that we have) with device_del(), so we need to
2506 * defer its call.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002507 *
2508 * Return: 0.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002509 */
2510int usb_deauthorize_device(struct usb_device *usb_dev)
2511{
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002512 usb_lock_device(usb_dev);
2513 if (usb_dev->authorized == 0)
2514 goto out_unauthorized;
Alan Sternda307122009-12-08 15:54:44 -05002515
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002516 usb_dev->authorized = 0;
2517 usb_set_configuration(usb_dev, -1);
Alan Sternda307122009-12-08 15:54:44 -05002518
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002519out_unauthorized:
2520 usb_unlock_device(usb_dev);
2521 return 0;
2522}
2523
2524
2525int usb_authorize_device(struct usb_device *usb_dev)
2526{
2527 int result = 0, c;
Alan Sternda307122009-12-08 15:54:44 -05002528
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002529 usb_lock_device(usb_dev);
2530 if (usb_dev->authorized == 1)
2531 goto out_authorized;
Alan Sternda307122009-12-08 15:54:44 -05002532
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002533 result = usb_autoresume_device(usb_dev);
2534 if (result < 0) {
2535 dev_err(&usb_dev->dev,
2536 "can't autoresume for authorization: %d\n", result);
2537 goto error_autoresume;
2538 }
2539 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2540 if (result < 0) {
2541 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2542 "authorization: %d\n", result);
2543 goto error_device_descriptor;
2544 }
Alan Sternda307122009-12-08 15:54:44 -05002545
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002546 usb_dev->authorized = 1;
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002547 /* Choose and set the configuration. This registers the interfaces
2548 * with the driver core and lets interface drivers bind to them.
2549 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06002550 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002551 if (c >= 0) {
2552 result = usb_set_configuration(usb_dev, c);
2553 if (result) {
2554 dev_err(&usb_dev->dev,
2555 "can't set config #%d, error %d\n", c, result);
2556 /* This need not be fatal. The user can try to
2557 * set other configurations. */
2558 }
2559 }
2560 dev_info(&usb_dev->dev, "authorized to connect\n");
Alan Sternda307122009-12-08 15:54:44 -05002561
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002562error_device_descriptor:
Alan Sternda307122009-12-08 15:54:44 -05002563 usb_autosuspend_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002564error_autoresume:
2565out_authorized:
Matthias Beyer781b2132013-10-10 23:41:29 +02002566 usb_unlock_device(usb_dev); /* complements locktree */
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002567 return result;
2568}
2569
2570
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002571/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2572static unsigned hub_is_wusb(struct usb_hub *hub)
2573{
2574 struct usb_hcd *hcd;
2575 if (hub->hdev->parent != NULL) /* not a root hub? */
2576 return 0;
2577 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2578 return hcd->wireless;
2579}
2580
2581
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582#define PORT_RESET_TRIES 5
2583#define SET_ADDRESS_TRIES 2
2584#define GET_DESCRIPTOR_TRIES 2
2585#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
Rusty Russell90ab5ee2012-01-13 09:32:20 +10302586#define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587
2588#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2589#define HUB_SHORT_RESET_TIME 10
Andiry Xu75d7cf72011-09-13 16:41:11 -07002590#define HUB_BH_RESET_TIME 50
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591#define HUB_LONG_RESET_TIME 200
Sarah Sharp77c7f072012-11-14 17:16:52 -08002592#define HUB_RESET_TIMEOUT 800
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593
Dan Williams48fc7db2013-12-05 17:07:27 -08002594/*
2595 * "New scheme" enumeration causes an extra state transition to be
2596 * exposed to an xhci host and causes USB3 devices to receive control
2597 * commands in the default state. This has been seen to cause
2598 * enumeration failures, so disable this enumeration scheme for USB3
2599 * devices.
2600 */
2601static bool use_new_scheme(struct usb_device *udev, int retry)
2602{
2603 if (udev->speed == USB_SPEED_SUPER)
2604 return false;
2605
2606 return USE_NEW_SCHEME(retry);
2607}
2608
Sarah Sharp10d674a2011-09-14 14:24:52 -07002609static int hub_port_reset(struct usb_hub *hub, int port1,
2610 struct usb_device *udev, unsigned int delay, bool warm);
2611
Rahul Bedarkar025d4432014-01-04 11:24:41 +05302612/* Is a USB 3.0 port in the Inactive or Compliance Mode state?
Stanislaw Ledwon8bea2bd2012-06-18 15:20:00 +02002613 * Port worm reset is required to recover
2614 */
Dan Williams3cd12f92014-05-29 12:58:46 -07002615static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2616 u16 portstatus)
Sarah Sharp10d674a2011-09-14 14:24:52 -07002617{
Dan Williams3cd12f92014-05-29 12:58:46 -07002618 u16 link_state;
2619
2620 if (!hub_is_superspeed(hub->hdev))
2621 return false;
2622
2623 if (test_bit(port1, hub->warm_reset_bits))
2624 return true;
2625
2626 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2627 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2628 || link_state == USB_SS_PORT_LS_COMP_MOD;
Sarah Sharp10d674a2011-09-14 14:24:52 -07002629}
2630
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631static int hub_port_wait_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002632 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633{
2634 int delay_time, ret;
2635 u16 portstatus;
2636 u16 portchange;
2637
2638 for (delay_time = 0;
2639 delay_time < HUB_RESET_TIMEOUT;
2640 delay_time += delay) {
2641 /* wait to give the device a chance to reset */
2642 msleep(delay);
2643
2644 /* read and decode port status */
2645 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2646 if (ret < 0)
2647 return ret;
2648
Sarah Sharp4f434472012-11-15 14:58:04 -08002649 /* The port state is unknown until the reset completes. */
Sarah Sharp470f0be2012-12-11 10:14:03 -08002650 if (!(portstatus & USB_PORT_STAT_RESET))
2651 break;
Sarah Sharp4f434472012-11-15 14:58:04 -08002652
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 /* switch to the long delay after two short delay failures */
2654 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2655 delay = HUB_LONG_RESET_TIME;
2656
Dan Williamsd99f6b42014-05-20 18:08:17 -07002657 dev_dbg(&hub->ports[port1 - 1]->dev,
2658 "not %sreset yet, waiting %dms\n",
2659 warm ? "warm " : "", delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 }
2661
Sarah Sharp470f0be2012-12-11 10:14:03 -08002662 if ((portstatus & USB_PORT_STAT_RESET))
2663 return -EBUSY;
2664
Dan Williams3cd12f92014-05-29 12:58:46 -07002665 if (hub_port_warm_reset_required(hub, port1, portstatus))
Sarah Sharp470f0be2012-12-11 10:14:03 -08002666 return -ENOTCONN;
2667
2668 /* Device went away? */
2669 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2670 return -ENOTCONN;
2671
2672 /* bomb out completely if the connection bounced. A USB 3.0
2673 * connection may bounce if multiple warm resets were issued,
2674 * but the device may have successfully re-connected. Ignore it.
2675 */
2676 if (!hub_is_superspeed(hub->hdev) &&
2677 (portchange & USB_PORT_STAT_C_CONNECTION))
2678 return -ENOTCONN;
2679
2680 if (!(portstatus & USB_PORT_STAT_ENABLE))
2681 return -EBUSY;
2682
2683 if (!udev)
2684 return 0;
2685
2686 if (hub_is_wusb(hub))
2687 udev->speed = USB_SPEED_WIRELESS;
2688 else if (hub_is_superspeed(hub->hdev))
2689 udev->speed = USB_SPEED_SUPER;
2690 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2691 udev->speed = USB_SPEED_HIGH;
2692 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2693 udev->speed = USB_SPEED_LOW;
2694 else
2695 udev->speed = USB_SPEED_FULL;
2696 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697}
2698
Andiry Xu75d7cf72011-09-13 16:41:11 -07002699static void hub_port_finish_reset(struct usb_hub *hub, int port1,
Sarah Sharpa24a6072012-11-01 11:20:44 -07002700 struct usb_device *udev, int *status)
Andiry Xu75d7cf72011-09-13 16:41:11 -07002701{
2702 switch (*status) {
2703 case 0:
Sarah Sharpa24a6072012-11-01 11:20:44 -07002704 /* TRSTRCY = 10 ms; plus some extra */
2705 msleep(10 + 40);
2706 if (udev) {
2707 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2708
2709 update_devnum(udev, 0);
2710 /* The xHC may think the device is already reset,
2711 * so ignore the status.
2712 */
2713 if (hcd->driver->reset_device)
2714 hcd->driver->reset_device(hcd, udev);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002715 }
2716 /* FALL THROUGH */
2717 case -ENOTCONN:
2718 case -ENODEV:
Lan Tianyuad493e52013-01-23 04:26:30 +08002719 usb_clear_port_feature(hub->hdev,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002720 port1, USB_PORT_FEAT_C_RESET);
Sarah Sharp1c7439c62012-11-14 15:58:52 -08002721 if (hub_is_superspeed(hub->hdev)) {
Lan Tianyuad493e52013-01-23 04:26:30 +08002722 usb_clear_port_feature(hub->hdev, port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002723 USB_PORT_FEAT_C_BH_PORT_RESET);
Lan Tianyuad493e52013-01-23 04:26:30 +08002724 usb_clear_port_feature(hub->hdev, port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002725 USB_PORT_FEAT_C_PORT_LINK_STATE);
Lan Tianyuad493e52013-01-23 04:26:30 +08002726 usb_clear_port_feature(hub->hdev, port1,
Sarah Sharpa24a6072012-11-01 11:20:44 -07002727 USB_PORT_FEAT_C_CONNECTION);
Sarah Sharp1c7439c62012-11-14 15:58:52 -08002728 }
Sarah Sharpa24a6072012-11-01 11:20:44 -07002729 if (udev)
Andiry Xu75d7cf72011-09-13 16:41:11 -07002730 usb_set_device_state(udev, *status
2731 ? USB_STATE_NOTATTACHED
2732 : USB_STATE_DEFAULT);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002733 break;
2734 }
2735}
2736
2737/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738static int hub_port_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002739 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740{
2741 int i, status;
Sarah Sharpa24a6072012-11-01 11:20:44 -07002742 u16 portchange, portstatus;
Dan Williamsd99f6b42014-05-20 18:08:17 -07002743 struct usb_port *port_dev = hub->ports[port1 - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002745 if (!hub_is_superspeed(hub->hdev)) {
2746 if (warm) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002747 dev_err(hub->intfdev, "only USB3 hub support "
2748 "warm reset\n");
2749 return -EINVAL;
2750 }
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002751 /* Block EHCI CF initialization during the port reset.
2752 * Some companion controllers don't like it when they mix.
2753 */
2754 down_read(&ehci_cf_port_reset_rwsem);
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07002755 } else if (!warm) {
2756 /*
2757 * If the caller hasn't explicitly requested a warm reset,
2758 * double check and see if one is needed.
2759 */
2760 status = hub_port_status(hub, port1,
2761 &portstatus, &portchange);
2762 if (status < 0)
2763 goto done;
2764
Dan Williams3cd12f92014-05-29 12:58:46 -07002765 if (hub_port_warm_reset_required(hub, port1, portstatus))
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07002766 warm = true;
Andiry Xu75d7cf72011-09-13 16:41:11 -07002767 }
Dan Williams3cd12f92014-05-29 12:58:46 -07002768 clear_bit(port1, hub->warm_reset_bits);
Alan Stern32fe0192007-10-10 16:27:07 -04002769
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 /* Reset the port */
2771 for (i = 0; i < PORT_RESET_TRIES; i++) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002772 status = set_port_feature(hub->hdev, port1, (warm ?
2773 USB_PORT_FEAT_BH_PORT_RESET :
2774 USB_PORT_FEAT_RESET));
Alan Sterne9e88fb2013-03-27 16:14:01 -04002775 if (status == -ENODEV) {
2776 ; /* The hub is gone */
2777 } else if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002778 dev_err(&port_dev->dev,
2779 "cannot %sreset (err = %d)\n",
2780 warm ? "warm " : "", status);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002781 } else {
2782 status = hub_port_wait_reset(hub, port1, udev, delay,
2783 warm);
Alan Sterne9e88fb2013-03-27 16:14:01 -04002784 if (status && status != -ENOTCONN && status != -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 dev_dbg(hub->intfdev,
2786 "port_wait_reset: err = %d\n",
2787 status);
2788 }
2789
Sarah Sharpa24a6072012-11-01 11:20:44 -07002790 /* Check for disconnect or reset */
Andiry Xu75d7cf72011-09-13 16:41:11 -07002791 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
Sarah Sharpa24a6072012-11-01 11:20:44 -07002792 hub_port_finish_reset(hub, port1, udev, &status);
2793
2794 if (!hub_is_superspeed(hub->hdev))
2795 goto done;
2796
2797 /*
2798 * If a USB 3.0 device migrates from reset to an error
2799 * state, re-issue the warm reset.
2800 */
2801 if (hub_port_status(hub, port1,
2802 &portstatus, &portchange) < 0)
2803 goto done;
2804
Dan Williams3cd12f92014-05-29 12:58:46 -07002805 if (!hub_port_warm_reset_required(hub, port1,
2806 portstatus))
Sarah Sharpa24a6072012-11-01 11:20:44 -07002807 goto done;
2808
2809 /*
2810 * If the port is in SS.Inactive or Compliance Mode, the
2811 * hot or warm reset failed. Try another warm reset.
2812 */
2813 if (!warm) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002814 dev_dbg(&port_dev->dev,
2815 "hot reset failed, warm reset\n");
Sarah Sharpa24a6072012-11-01 11:20:44 -07002816 warm = true;
2817 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818 }
2819
Dan Williamsd99f6b42014-05-20 18:08:17 -07002820 dev_dbg(&port_dev->dev,
2821 "not enabled, trying %sreset again...\n",
2822 warm ? "warm " : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 delay = HUB_LONG_RESET_TIME;
2824 }
2825
Dan Williamsd99f6b42014-05-20 18:08:17 -07002826 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827
Andiry Xu75d7cf72011-09-13 16:41:11 -07002828done:
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002829 if (!hub_is_superspeed(hub->hdev))
Andiry Xu75d7cf72011-09-13 16:41:11 -07002830 up_read(&ehci_cf_port_reset_rwsem);
2831
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832 return status;
2833}
2834
Andiry Xu0ed9a572011-04-27 18:07:43 +08002835/* Check if a port is power on */
2836static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2837{
2838 int ret = 0;
2839
2840 if (hub_is_superspeed(hub->hdev)) {
2841 if (portstatus & USB_SS_PORT_STAT_POWER)
2842 ret = 1;
2843 } else {
2844 if (portstatus & USB_PORT_STAT_POWER)
2845 ret = 1;
2846 }
2847
2848 return ret;
2849}
2850
Dan Williams5c79a1e2014-05-20 18:09:26 -07002851static void usb_lock_port(struct usb_port *port_dev)
2852 __acquires(&port_dev->status_lock)
2853{
2854 mutex_lock(&port_dev->status_lock);
2855 __acquire(&port_dev->status_lock);
2856}
2857
2858static void usb_unlock_port(struct usb_port *port_dev)
2859 __releases(&port_dev->status_lock)
2860{
2861 mutex_unlock(&port_dev->status_lock);
2862 __release(&port_dev->status_lock);
2863}
2864
Alan Sternd388dab2006-07-01 22:14:24 -04002865#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866
Andiry Xu0ed9a572011-04-27 18:07:43 +08002867/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2868static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2869{
2870 int ret = 0;
2871
2872 if (hub_is_superspeed(hub->hdev)) {
2873 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2874 == USB_SS_PORT_LS_U3)
2875 ret = 1;
2876 } else {
2877 if (portstatus & USB_PORT_STAT_SUSPEND)
2878 ret = 1;
2879 }
2880
2881 return ret;
2882}
Alan Sternb01b03f2008-04-28 11:06:11 -04002883
2884/* Determine whether the device on a port is ready for a normal resume,
2885 * is ready for a reset-resume, or should be disconnected.
2886 */
2887static int check_port_resume_type(struct usb_device *udev,
2888 struct usb_hub *hub, int port1,
2889 int status, unsigned portchange, unsigned portstatus)
2890{
Dan Williamsd99f6b42014-05-20 18:08:17 -07002891 struct usb_port *port_dev = hub->ports[port1 - 1];
2892
Dan Williams3cd12f92014-05-29 12:58:46 -07002893 /* Is a warm reset needed to recover the connection? */
2894 if (status == 0 && udev->reset_resume
2895 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2896 /* pass */;
2897 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002898 /* Is the device still present? */
Dan Williams3cd12f92014-05-29 12:58:46 -07002899 else if (status || port_is_suspended(hub, portstatus) ||
Andiry Xu0ed9a572011-04-27 18:07:43 +08002900 !port_is_power_on(hub, portstatus) ||
2901 !(portstatus & USB_PORT_STAT_CONNECTION)) {
Alan Sternb01b03f2008-04-28 11:06:11 -04002902 if (status >= 0)
2903 status = -ENODEV;
2904 }
2905
Alan Stern86c57ed2008-06-30 11:14:43 -04002906 /* Can't do a normal resume if the port isn't enabled,
2907 * so try a reset-resume instead.
2908 */
2909 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2910 if (udev->persist_enabled)
2911 udev->reset_resume = 1;
2912 else
2913 status = -ENODEV;
2914 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002915
2916 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002917 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2918 portchange, portstatus, status);
Alan Sternb01b03f2008-04-28 11:06:11 -04002919 } else if (udev->reset_resume) {
2920
2921 /* Late port handoff can set status-change bits */
2922 if (portchange & USB_PORT_STAT_C_CONNECTION)
Lan Tianyuad493e52013-01-23 04:26:30 +08002923 usb_clear_port_feature(hub->hdev, port1,
Alan Sternb01b03f2008-04-28 11:06:11 -04002924 USB_PORT_FEAT_C_CONNECTION);
2925 if (portchange & USB_PORT_STAT_C_ENABLE)
Lan Tianyuad493e52013-01-23 04:26:30 +08002926 usb_clear_port_feature(hub->hdev, port1,
Alan Sternb01b03f2008-04-28 11:06:11 -04002927 USB_PORT_FEAT_C_ENABLE);
2928 }
2929
2930 return status;
2931}
2932
Sarah Sharpf74631e2012-06-25 12:08:08 -07002933int usb_disable_ltm(struct usb_device *udev)
2934{
2935 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2936
2937 /* Check if the roothub and device supports LTM. */
2938 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2939 !usb_device_supports_ltm(udev))
2940 return 0;
2941
2942 /* Clear Feature LTM Enable can only be sent if the device is
2943 * configured.
2944 */
2945 if (!udev->actconfig)
2946 return 0;
2947
2948 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2949 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2950 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2951 USB_CTRL_SET_TIMEOUT);
2952}
2953EXPORT_SYMBOL_GPL(usb_disable_ltm);
2954
2955void usb_enable_ltm(struct usb_device *udev)
2956{
2957 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2958
2959 /* Check if the roothub and device supports LTM. */
2960 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2961 !usb_device_supports_ltm(udev))
2962 return;
2963
2964 /* Set Feature LTM Enable can only be sent if the device is
2965 * configured.
2966 */
2967 if (!udev->actconfig)
2968 return;
2969
2970 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2971 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2972 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
2973 USB_CTRL_SET_TIMEOUT);
2974}
2975EXPORT_SYMBOL_GPL(usb_enable_ltm);
2976
Lan Tianyu54a3ac02013-01-24 10:31:28 +08002977/*
Alan Stern28e861652013-07-30 15:37:33 -04002978 * usb_enable_remote_wakeup - enable remote wakeup for a device
Lan Tianyu54a3ac02013-01-24 10:31:28 +08002979 * @udev: target device
2980 *
Alan Stern28e861652013-07-30 15:37:33 -04002981 * For USB-2 devices: Set the device's remote wakeup feature.
2982 *
2983 * For USB-3 devices: Assume there's only one function on the device and
2984 * enable remote wake for the first interface. FIXME if the interface
2985 * association descriptor shows there's more than one function.
Lan Tianyu54a3ac02013-01-24 10:31:28 +08002986 */
Alan Stern28e861652013-07-30 15:37:33 -04002987static int usb_enable_remote_wakeup(struct usb_device *udev)
Lan Tianyu54a3ac02013-01-24 10:31:28 +08002988{
Alan Stern28e861652013-07-30 15:37:33 -04002989 if (udev->speed < USB_SPEED_SUPER)
2990 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2991 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2992 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
2993 USB_CTRL_SET_TIMEOUT);
2994 else
2995 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2996 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
2997 USB_INTRF_FUNC_SUSPEND,
2998 USB_INTRF_FUNC_SUSPEND_RW |
2999 USB_INTRF_FUNC_SUSPEND_LP,
3000 NULL, 0, USB_CTRL_SET_TIMEOUT);
3001}
3002
3003/*
3004 * usb_disable_remote_wakeup - disable remote wakeup for a device
3005 * @udev: target device
3006 *
3007 * For USB-2 devices: Clear the device's remote wakeup feature.
3008 *
3009 * For USB-3 devices: Assume there's only one function on the device and
3010 * disable remote wake for the first interface. FIXME if the interface
3011 * association descriptor shows there's more than one function.
3012 */
3013static int usb_disable_remote_wakeup(struct usb_device *udev)
3014{
3015 if (udev->speed < USB_SPEED_SUPER)
3016 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3017 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3018 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3019 USB_CTRL_SET_TIMEOUT);
3020 else
3021 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003022 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
3023 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3024 USB_CTRL_SET_TIMEOUT);
3025}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026
Alan Sterne583d9d2013-07-11 14:58:04 -04003027/* Count of wakeup-enabled devices at or below udev */
3028static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3029{
3030 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3031
3032 return udev->do_remote_wakeup +
3033 (hub ? hub->wakeup_enabled_descendants : 0);
3034}
3035
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036/*
Alan Stern140d8f62006-07-01 22:07:21 -04003037 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04003038 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07003039 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040 *
3041 * Suspends a USB device that isn't in active use, conserving power.
3042 * Devices may wake out of a suspend, if anything important happens,
3043 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04003044 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045 * to disconnect devices while they are suspended.
3046 *
David Brownell390a8c32005-09-13 19:57:27 -07003047 * This only affects the USB hardware for a device; its interfaces
3048 * (and, for hubs, child devices) must already have been suspended.
3049 *
Alan Stern624d6c02007-05-30 15:35:16 -04003050 * Selective port suspend reduces power; most suspended devices draw
3051 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3052 * All devices below the suspended port are also suspended.
3053 *
3054 * Devices leave suspend state when the host wakes them up. Some devices
3055 * also support "remote wakeup", where the device can activate the USB
3056 * tree above them to deliver data, such as a keypress or packet. In
3057 * some cases, this wakes the USB host.
3058 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059 * Suspending OTG devices may trigger HNP, if that's been enabled
3060 * between a pair of dual-role devices. That will change roles, such
3061 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3062 *
Alan Stern4956ecc2007-05-30 16:51:28 -04003063 * Devices on USB hub ports have only one "suspend" state, corresponding
3064 * to ACPI D2, "may cause the device to lose some context".
3065 * State transitions include:
3066 *
3067 * - suspend, resume ... when the VBUS power link stays live
3068 * - suspend, disconnect ... VBUS lost
3069 *
3070 * Once VBUS drop breaks the circuit, the port it's using has to go through
3071 * normal re-enumeration procedures, starting with enabling VBUS power.
3072 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3073 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
3074 * timer, no SRP, no requests through sysfs.
3075 *
Alan Sterne583d9d2013-07-11 14:58:04 -04003076 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3077 * suspended until their bus goes into global suspend (i.e., the root
Alan Stern0aa28322013-03-27 16:14:19 -04003078 * hub is suspended). Nevertheless, we change @udev->state to
3079 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3080 * upstream port setting is stored in @udev->port_is_suspended.
Alan Stern4956ecc2007-05-30 16:51:28 -04003081 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 * Returns 0 on success, else negative errno.
3083 */
Alan Stern65bfd292008-11-25 16:39:18 -05003084int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085{
Lan Tianyuad493e52013-01-23 04:26:30 +08003086 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3087 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
Alan Stern624d6c02007-05-30 15:35:16 -04003088 int port1 = udev->portnum;
3089 int status;
Alan Stern0aa28322013-03-27 16:14:19 -04003090 bool really_suspend = true;
Alan Stern4956ecc2007-05-30 16:51:28 -04003091
Dan Williams5c79a1e2014-05-20 18:09:26 -07003092 usb_lock_port(port_dev);
3093
Alan Stern624d6c02007-05-30 15:35:16 -04003094 /* enable remote wakeup when appropriate; this lets the device
3095 * wake up the upstream hub (including maybe the root hub).
3096 *
3097 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3098 * we don't explicitly enable it here.
3099 */
3100 if (udev->do_remote_wakeup) {
Alan Stern28e861652013-07-30 15:37:33 -04003101 status = usb_enable_remote_wakeup(udev);
Oliver Neukum0c487202009-10-19 13:19:41 +02003102 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04003103 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3104 status);
Oliver Neukum0c487202009-10-19 13:19:41 +02003105 /* bail if autosuspend is requested */
Alan Stern5b1b0b82011-08-19 23:49:48 +02003106 if (PMSG_IS_AUTO(msg))
Alan Stern4fae6f02013-07-30 15:39:02 -04003107 goto err_wakeup;
Oliver Neukum0c487202009-10-19 13:19:41 +02003108 }
Alan Stern624d6c02007-05-30 15:35:16 -04003109 }
3110
Andiry Xu65580b432011-09-23 14:19:52 -07003111 /* disable USB2 hardware LPM */
3112 if (udev->usb2_hw_lpm_enabled == 1)
3113 usb_set_usb2_hardware_lpm(udev, 0);
3114
Sarah Sharpf74631e2012-06-25 12:08:08 -07003115 if (usb_disable_ltm(udev)) {
Alan Stern4fae6f02013-07-30 15:39:02 -04003116 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3117 status = -ENOMEM;
3118 if (PMSG_IS_AUTO(msg))
3119 goto err_ltm;
Sarah Sharpf74631e2012-06-25 12:08:08 -07003120 }
Sarah Sharp83060952012-05-02 14:25:52 -07003121 if (usb_unlocked_disable_lpm(udev)) {
Alan Stern4fae6f02013-07-30 15:39:02 -04003122 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3123 status = -ENOMEM;
3124 if (PMSG_IS_AUTO(msg))
3125 goto err_lpm3;
Sarah Sharp83060952012-05-02 14:25:52 -07003126 }
3127
Alan Stern624d6c02007-05-30 15:35:16 -04003128 /* see 7.1.7.6 */
Andiry Xua7114232011-04-27 18:07:50 +08003129 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08003130 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
Alan Sterne583d9d2013-07-11 14:58:04 -04003131
Alan Stern0aa28322013-03-27 16:14:19 -04003132 /*
3133 * For system suspend, we do not need to enable the suspend feature
3134 * on individual USB-2 ports. The devices will automatically go
3135 * into suspend a few ms after the root hub stops sending packets.
3136 * The USB 2.0 spec calls this "global suspend".
Alan Sterne583d9d2013-07-11 14:58:04 -04003137 *
3138 * However, many USB hubs have a bug: They don't relay wakeup requests
3139 * from a downstream port if the port's suspend feature isn't on.
3140 * Therefore we will turn on the suspend feature if udev or any of its
3141 * descendants is enabled for remote wakeup.
Alan Stern0aa28322013-03-27 16:14:19 -04003142 */
Alan Sterne583d9d2013-07-11 14:58:04 -04003143 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3144 status = set_port_feature(hub->hdev, port1,
3145 USB_PORT_FEAT_SUSPEND);
Alan Stern0aa28322013-03-27 16:14:19 -04003146 else {
3147 really_suspend = false;
3148 status = 0;
3149 }
Alan Stern624d6c02007-05-30 15:35:16 -04003150 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003151 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
Alan Sterncbb33002011-06-15 16:29:16 -04003152
Alan Stern4fae6f02013-07-30 15:39:02 -04003153 /* Try to enable USB3 LPM and LTM again */
3154 usb_unlocked_enable_lpm(udev);
3155 err_lpm3:
3156 usb_enable_ltm(udev);
3157 err_ltm:
Andiry Xuc3e751e2012-05-05 00:50:10 +08003158 /* Try to enable USB2 hardware LPM again */
3159 if (udev->usb2_hw_lpm_capable == 1)
3160 usb_set_usb2_hardware_lpm(udev, 1);
3161
Alan Stern4fae6f02013-07-30 15:39:02 -04003162 if (udev->do_remote_wakeup)
3163 (void) usb_disable_remote_wakeup(udev);
3164 err_wakeup:
Sarah Sharp83060952012-05-02 14:25:52 -07003165
Alan Sterncbb33002011-06-15 16:29:16 -04003166 /* System sleep transitions should never fail */
Alan Stern5b1b0b82011-08-19 23:49:48 +02003167 if (!PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04003168 status = 0;
Alan Stern624d6c02007-05-30 15:35:16 -04003169 } else {
Alan Stern30b1a7a2011-09-27 21:54:22 +02003170 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3171 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3172 udev->do_remote_wakeup);
Alan Stern0aa28322013-03-27 16:14:19 -04003173 if (really_suspend) {
3174 udev->port_is_suspended = 1;
Alan Sterne583d9d2013-07-11 14:58:04 -04003175
3176 /* device has up to 10 msec to fully suspend */
Alan Stern0aa28322013-03-27 16:14:19 -04003177 msleep(10);
3178 }
Alan Sterne583d9d2013-07-11 14:58:04 -04003179 usb_set_device_state(udev, USB_STATE_SUSPENDED);
Alan Stern624d6c02007-05-30 15:35:16 -04003180 }
Lan Tianyuad493e52013-01-23 04:26:30 +08003181
Dan Williamsd5c38342014-05-20 18:08:52 -07003182 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3183 && test_and_clear_bit(port1, hub->child_usage_bits))
Lan Tianyu98a4f1f2013-07-03 22:17:54 +08003184 pm_runtime_put_sync(&port_dev->dev);
Lan Tianyuad493e52013-01-23 04:26:30 +08003185
Alan Sternc08512c2010-11-15 15:57:58 -05003186 usb_mark_last_busy(hub->hdev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07003187
3188 usb_unlock_port(port_dev);
Alan Stern4956ecc2007-05-30 16:51:28 -04003189 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190}
David Brownellf3f32532005-09-22 22:37:29 -07003191
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192/*
David Brownell390a8c32005-09-13 19:57:27 -07003193 * If the USB "suspend" state is in use (rather than "global suspend"),
3194 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04003195 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196 * hardware resume signaling is finished, either because of selective
3197 * resume (by host) or remote wakeup (by device) ... now see what changed
3198 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04003199 *
3200 * If @udev->reset_resume is set then the device is reset before the
3201 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202 */
Alan Stern140d8f62006-07-01 22:07:21 -04003203static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204{
Alan Stern54515fe2007-05-30 15:38:58 -04003205 int status = 0;
Oliver Neukum07e72b92012-11-29 15:05:57 +01003206 u16 devstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207
3208 /* caller owns the udev device lock */
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08003209 dev_dbg(&udev->dev, "%s\n",
3210 udev->reset_resume ? "finish reset-resume" : "finish resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211
3212 /* usb ch9 identifies four variants of SUSPENDED, based on what
3213 * state the device resumes to. Linux currently won't see the
3214 * first two on the host side; they'd be inside hub_port_init()
3215 * during many timeouts, but khubd can't suspend until later.
3216 */
3217 usb_set_device_state(udev, udev->actconfig
3218 ? USB_STATE_CONFIGURED
3219 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220
Alan Stern54515fe2007-05-30 15:38:58 -04003221 /* 10.5.4.5 says not to reset a suspended port if the attached
3222 * device is enabled for remote wakeup. Hence the reset
3223 * operation is carried out here, after the port has been
3224 * resumed.
3225 */
Alan Stern1d102552014-03-18 10:39:05 -04003226 if (udev->reset_resume) {
3227 /*
3228 * If the device morphs or switches modes when it is reset,
3229 * we don't want to perform a reset-resume. We'll fail the
3230 * resume, which will cause a logical disconnect, and then
3231 * the device will be rediscovered.
3232 */
Alan Stern86c57ed2008-06-30 11:14:43 -04003233 retry_reset_resume:
Alan Stern1d102552014-03-18 10:39:05 -04003234 if (udev->quirks & USB_QUIRK_RESET)
3235 status = -ENODEV;
3236 else
3237 status = usb_reset_and_verify_device(udev);
3238 }
Alan Stern54515fe2007-05-30 15:38:58 -04003239
Matthias Beyer469271f2013-10-10 23:41:27 +02003240 /* 10.5.4.5 says be sure devices in the tree are still there.
3241 * For now let's assume the device didn't go crazy on resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 * and device drivers will know about any resume quirks.
3243 */
Alan Stern54515fe2007-05-30 15:38:58 -04003244 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04003245 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04003246 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Stern86c57ed2008-06-30 11:14:43 -04003247
3248 /* If a normal resume failed, try doing a reset-resume */
3249 if (status && !udev->reset_resume && udev->persist_enabled) {
3250 dev_dbg(&udev->dev, "retry with reset-resume\n");
3251 udev->reset_resume = 1;
3252 goto retry_reset_resume;
3253 }
Alan Stern54515fe2007-05-30 15:38:58 -04003254 }
Alan Sternb40b7a92006-06-19 15:12:38 -04003255
Alan Stern624d6c02007-05-30 15:35:16 -04003256 if (status) {
3257 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3258 status);
Oliver Neukum07e72b92012-11-29 15:05:57 +01003259 /*
3260 * There are a few quirky devices which violate the standard
3261 * by claiming to have remote wakeup enabled after a reset,
3262 * which crash if the feature is cleared, hence check for
3263 * udev->reset_resume
3264 */
3265 } else if (udev->actconfig && !udev->reset_resume) {
Alan Stern28e861652013-07-30 15:37:33 -04003266 if (udev->speed < USB_SPEED_SUPER) {
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003267 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
Alan Stern28e861652013-07-30 15:37:33 -04003268 status = usb_disable_remote_wakeup(udev);
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003269 } else {
3270 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3271 &devstatus);
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003272 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3273 | USB_INTRF_STAT_FUNC_RW))
Alan Stern28e861652013-07-30 15:37:33 -04003274 status = usb_disable_remote_wakeup(udev);
Alan Stern4bf0ba82005-11-21 11:58:07 -05003275 }
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003276
3277 if (status)
3278 dev_dbg(&udev->dev,
3279 "disable remote wakeup, status %d\n",
3280 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282 }
3283 return status;
3284}
3285
Alan Stern624d6c02007-05-30 15:35:16 -04003286/*
Pratyush Ananda40178b2014-07-18 12:37:10 +05303287 * There are some SS USB devices which take longer time for link training.
3288 * XHCI specs 4.19.4 says that when Link training is successful, port
3289 * sets CSC bit to 1. So if SW reads port status before successful link
3290 * training, then it will not find device to be present.
3291 * USB Analyzer log with such buggy devices show that in some cases
3292 * device switch on the RX termination after long delay of host enabling
3293 * the VBUS. In few other cases it has been seen that device fails to
3294 * negotiate link training in first attempt. It has been
3295 * reported till now that few devices take as long as 2000 ms to train
3296 * the link after host enabling its VBUS and termination. Following
3297 * routine implements a 2000 ms timeout for link training. If in a case
3298 * link trains before timeout, loop will exit earlier.
3299 *
3300 * FIXME: If a device was connected before suspend, but was removed
3301 * while system was asleep, then the loop in the following routine will
3302 * only exit at timeout.
3303 *
3304 * This routine should only be called when persist is enabled for a SS
3305 * device.
3306 */
3307static int wait_for_ss_port_enable(struct usb_device *udev,
3308 struct usb_hub *hub, int *port1,
3309 u16 *portchange, u16 *portstatus)
3310{
3311 int status = 0, delay_ms = 0;
3312
3313 while (delay_ms < 2000) {
3314 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3315 break;
3316 msleep(20);
3317 delay_ms += 20;
3318 status = hub_port_status(hub, *port1, portstatus, portchange);
3319 }
3320 return status;
3321}
3322
3323/*
Alan Stern624d6c02007-05-30 15:35:16 -04003324 * usb_port_resume - re-activate a suspended usb device's upstream port
3325 * @udev: device to re-activate, not a root hub
3326 * Context: must be able to sleep; device not locked; pm locks held
3327 *
3328 * This will re-activate the suspended device, increasing power usage
3329 * while letting drivers communicate again with its endpoints.
3330 * USB resume explicitly guarantees that the power session between
3331 * the host and the device is the same as it was when the device
3332 * suspended.
3333 *
Alan Sternfeccc302008-03-03 15:15:59 -05003334 * If @udev->reset_resume is set then this routine won't check that the
3335 * port is still enabled. Furthermore, finish_port_resume() above will
Alan Stern54515fe2007-05-30 15:38:58 -04003336 * reset @udev. The end result is that a broken power session can be
3337 * recovered and @udev will appear to persist across a loss of VBUS power.
3338 *
3339 * For example, if a host controller doesn't maintain VBUS suspend current
3340 * during a system sleep or is reset when the system wakes up, all the USB
3341 * power sessions below it will be broken. This is especially troublesome
3342 * for mass-storage devices containing mounted filesystems, since the
3343 * device will appear to have disconnected and all the memory mappings
3344 * to it will be lost. Using the USB_PERSIST facility, the device can be
3345 * made to appear as if it had not disconnected.
3346 *
Ming Lei742120c2008-06-18 22:00:29 +08003347 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
Alan Sternfeccc302008-03-03 15:15:59 -05003348 * every effort to insure that the same device is present after the
Alan Stern54515fe2007-05-30 15:38:58 -04003349 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3350 * quite possible for a device to remain unaltered but its media to be
3351 * changed. If the user replaces a flash memory card while the system is
3352 * asleep, he will have only himself to blame when the filesystem on the
3353 * new card is corrupted and the system crashes.
3354 *
Alan Stern624d6c02007-05-30 15:35:16 -04003355 * Returns 0 on success, else negative errno.
3356 */
Alan Stern65bfd292008-11-25 16:39:18 -05003357int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003358{
Lan Tianyuad493e52013-01-23 04:26:30 +08003359 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3360 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
Alan Stern624d6c02007-05-30 15:35:16 -04003361 int port1 = udev->portnum;
3362 int status;
3363 u16 portchange, portstatus;
Alan Sternd25450c2006-11-20 11:14:30 -05003364
Dan Williamsd5c38342014-05-20 18:08:52 -07003365 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
Lan Tianyuad493e52013-01-23 04:26:30 +08003366 status = pm_runtime_get_sync(&port_dev->dev);
Lan Tianyuad493e52013-01-23 04:26:30 +08003367 if (status < 0) {
3368 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3369 status);
3370 return status;
3371 }
3372 }
3373
Dan Williams5c79a1e2014-05-20 18:09:26 -07003374 usb_lock_port(port_dev);
3375
Alan Sternd25450c2006-11-20 11:14:30 -05003376 /* Skip the initial Clear-Suspend step for a remote wakeup */
3377 status = hub_port_status(hub, port1, &portstatus, &portchange);
Andiry Xu0ed9a572011-04-27 18:07:43 +08003378 if (status == 0 && !port_is_suspended(hub, portstatus))
Alan Sternd25450c2006-11-20 11:14:30 -05003379 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003380
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381 /* see 7.1.7.7; affects power usage, but not budgeting */
Andiry Xua7114232011-04-27 18:07:50 +08003382 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08003383 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
Andiry Xua7114232011-04-27 18:07:50 +08003384 else
Lan Tianyuad493e52013-01-23 04:26:30 +08003385 status = usb_clear_port_feature(hub->hdev,
Andiry Xua7114232011-04-27 18:07:50 +08003386 port1, USB_PORT_FEAT_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003388 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003389 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003390 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04003391 dev_dbg(&udev->dev, "usb %sresume\n",
Alan Stern5b1b0b82011-08-19 23:49:48 +02003392 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393 msleep(25);
3394
Linus Torvalds1da177e2005-04-16 15:20:36 -07003395 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3396 * stop resume signaling. Then finish the resume
3397 * sequence.
3398 */
Alan Sternd25450c2006-11-20 11:14:30 -05003399 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04003400
Alan Sternb01b03f2008-04-28 11:06:11 -04003401 /* TRSMRCY = 10 msec */
3402 msleep(10);
3403 }
Alan Stern54515fe2007-05-30 15:38:58 -04003404
Alan Sternb01b03f2008-04-28 11:06:11 -04003405 SuspendCleared:
3406 if (status == 0) {
Alan Sternbfd1e912012-10-19 11:03:39 -04003407 udev->port_is_suspended = 0;
Andiry Xua7114232011-04-27 18:07:50 +08003408 if (hub_is_superspeed(hub->hdev)) {
3409 if (portchange & USB_PORT_STAT_C_LINK_STATE)
Lan Tianyuad493e52013-01-23 04:26:30 +08003410 usb_clear_port_feature(hub->hdev, port1,
Andiry Xua7114232011-04-27 18:07:50 +08003411 USB_PORT_FEAT_C_PORT_LINK_STATE);
3412 } else {
3413 if (portchange & USB_PORT_STAT_C_SUSPEND)
Lan Tianyuad493e52013-01-23 04:26:30 +08003414 usb_clear_port_feature(hub->hdev, port1,
Andiry Xua7114232011-04-27 18:07:50 +08003415 USB_PORT_FEAT_C_SUSPEND);
3416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003418
Pratyush Ananda40178b2014-07-18 12:37:10 +05303419 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3420 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3421 &portstatus);
3422
Alan Sternb01b03f2008-04-28 11:06:11 -04003423 status = check_port_resume_type(udev,
3424 hub, port1, status, portchange, portstatus);
Alan Stern54515fe2007-05-30 15:38:58 -04003425 if (status == 0)
3426 status = finish_port_resume(udev);
3427 if (status < 0) {
3428 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3429 hub_port_logical_disconnect(hub, port1);
Andiry Xu65580b432011-09-23 14:19:52 -07003430 } else {
3431 /* Try to enable USB2 hardware LPM */
3432 if (udev->usb2_hw_lpm_capable == 1)
3433 usb_set_usb2_hardware_lpm(udev, 1);
Sarah Sharp83060952012-05-02 14:25:52 -07003434
Sarah Sharpf74631e2012-06-25 12:08:08 -07003435 /* Try to enable USB3 LTM and LPM */
3436 usb_enable_ltm(udev);
Sarah Sharp83060952012-05-02 14:25:52 -07003437 usb_unlocked_enable_lpm(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04003438 }
Andiry Xu65580b432011-09-23 14:19:52 -07003439
Dan Williams5c79a1e2014-05-20 18:09:26 -07003440 usb_unlock_port(port_dev);
3441
Linus Torvalds1da177e2005-04-16 15:20:36 -07003442 return status;
3443}
3444
Alan Stern84ebc102013-03-27 16:14:46 -04003445#ifdef CONFIG_PM_RUNTIME
3446
Alan Stern0534d462010-01-08 12:56:30 -05003447int usb_remote_wakeup(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003448{
3449 int status = 0;
3450
Dan Williams5c79a1e2014-05-20 18:09:26 -07003451 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04003453 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern9bbdf1e2010-01-08 12:57:28 -05003454 status = usb_autoresume_device(udev);
3455 if (status == 0) {
3456 /* Let the drivers do their thing, then... */
3457 usb_autosuspend_device(udev);
3458 }
Alan Sternd25450c2006-11-20 11:14:30 -05003459 }
Dan Williams5c79a1e2014-05-20 18:09:26 -07003460 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003461 return status;
3462}
3463
Dan Williams7e73be22014-05-20 18:09:31 -07003464/* Returns 1 if there was a remote wakeup and a connect status change. */
3465static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3466 u16 portstatus, u16 portchange)
3467 __must_hold(&port_dev->status_lock)
3468{
3469 struct usb_port *port_dev = hub->ports[port - 1];
3470 struct usb_device *hdev;
3471 struct usb_device *udev;
3472 int connect_change = 0;
3473 int ret;
3474
3475 hdev = hub->hdev;
3476 udev = port_dev->child;
3477 if (!hub_is_superspeed(hdev)) {
3478 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3479 return 0;
3480 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3481 } else {
3482 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3483 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3484 USB_SS_PORT_LS_U0)
3485 return 0;
3486 }
3487
3488 if (udev) {
3489 /* TRSMRCY = 10 msec */
3490 msleep(10);
3491
3492 usb_unlock_port(port_dev);
3493 ret = usb_remote_wakeup(udev);
3494 usb_lock_port(port_dev);
3495 if (ret < 0)
3496 connect_change = 1;
3497 } else {
3498 ret = -ENODEV;
3499 hub_port_disable(hub, port, 1);
3500 }
3501 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3502 return connect_change;
3503}
3504
3505#else
3506
3507static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3508 u16 portstatus, u16 portchange)
3509{
3510 return 0;
3511}
3512
Alan Sternd388dab2006-07-01 22:14:24 -04003513#endif
3514
Ming Leie6f30de2012-10-24 11:59:24 +08003515static int check_ports_changed(struct usb_hub *hub)
3516{
3517 int port1;
3518
3519 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3520 u16 portstatus, portchange;
3521 int status;
3522
3523 status = hub_port_status(hub, port1, &portstatus, &portchange);
3524 if (!status && portchange)
3525 return 1;
3526 }
3527 return 0;
3528}
3529
David Brownelldb690872005-09-13 19:56:33 -07003530static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531{
3532 struct usb_hub *hub = usb_get_intfdata (intf);
3533 struct usb_device *hdev = hub->hdev;
3534 unsigned port1;
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003535 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536
Alan Sterne583d9d2013-07-11 14:58:04 -04003537 /*
3538 * Warn if children aren't already suspended.
3539 * Also, add up the number of wakeup-enabled descendants.
3540 */
3541 hub->wakeup_enabled_descendants = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003543 struct usb_port *port_dev = hub->ports[port1 - 1];
3544 struct usb_device *udev = port_dev->child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003545
Alan Stern6840d252007-09-10 11:34:26 -04003546 if (udev && udev->can_submit) {
Dan Williamsb658b8f2014-06-17 16:16:22 -07003547 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3548 dev_name(&udev->dev));
Alan Stern5b1b0b82011-08-19 23:49:48 +02003549 if (PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04003550 return -EBUSY;
David Brownellc9f89fa2005-09-13 19:57:04 -07003551 }
Alan Sterne583d9d2013-07-11 14:58:04 -04003552 if (udev)
3553 hub->wakeup_enabled_descendants +=
3554 wakeup_enabled_descendants(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003555 }
Ming Leie6f30de2012-10-24 11:59:24 +08003556
3557 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3558 /* check if there are changes pending on hub ports */
3559 if (check_ports_changed(hub)) {
3560 if (PMSG_IS_AUTO(msg))
3561 return -EBUSY;
3562 pm_wakeup_event(&hdev->dev, 2000);
3563 }
3564 }
3565
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003566 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3567 /* Enable hub to send remote wakeup for all ports. */
3568 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3569 status = set_port_feature(hdev,
3570 port1 |
3571 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3572 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3573 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3574 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3575 }
3576 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577
Harvey Harrison441b62c2008-03-03 16:08:34 -08003578 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Stern40f122f2006-11-09 14:44:33 -05003579
David Brownellc9f89fa2005-09-13 19:57:04 -07003580 /* stop khubd and related activity */
Alan Stern43303542008-04-28 11:07:31 -04003581 hub_quiesce(hub, HUB_SUSPEND);
Alan Sternb6f64362007-05-04 11:51:54 -04003582 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583}
3584
3585static int hub_resume(struct usb_interface *intf)
3586{
Alan Stern5e6effa2008-03-03 15:15:51 -05003587 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588
Alan Stern5e6effa2008-03-03 15:15:51 -05003589 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003590 hub_activate(hub, HUB_RESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003591 return 0;
3592}
3593
Alan Sternb41a60e2007-05-30 15:39:33 -04003594static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04003595{
Alan Sternb41a60e2007-05-30 15:39:33 -04003596 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04003597
Alan Stern5e6effa2008-03-03 15:15:51 -05003598 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003599 hub_activate(hub, HUB_RESET_RESUME);
Alan Sternf07600c2007-05-30 15:38:16 -04003600 return 0;
3601}
3602
Alan Stern54515fe2007-05-30 15:38:58 -04003603/**
3604 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3605 * @rhdev: struct usb_device for the root hub
3606 *
3607 * The USB host controller driver calls this function when its root hub
3608 * is resumed and Vbus power has been interrupted or the controller
Alan Sternfeccc302008-03-03 15:15:59 -05003609 * has been reset. The routine marks @rhdev as having lost power.
3610 * When the hub driver is resumed it will take notice and carry out
3611 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3612 * the others will be disconnected.
Alan Stern54515fe2007-05-30 15:38:58 -04003613 */
3614void usb_root_hub_lost_power(struct usb_device *rhdev)
3615{
3616 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3617 rhdev->reset_resume = 1;
3618}
3619EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3620
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003621static const char * const usb3_lpm_names[] = {
3622 "U0",
3623 "U1",
3624 "U2",
3625 "U3",
3626};
3627
3628/*
3629 * Send a Set SEL control transfer to the device, prior to enabling
3630 * device-initiated U1 or U2. This lets the device know the exit latencies from
3631 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3632 * packet from the host.
3633 *
3634 * This function will fail if the SEL or PEL values for udev are greater than
3635 * the maximum allowed values for the link state to be enabled.
3636 */
3637static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3638{
3639 struct usb_set_sel_req *sel_values;
3640 unsigned long long u1_sel;
3641 unsigned long long u1_pel;
3642 unsigned long long u2_sel;
3643 unsigned long long u2_pel;
3644 int ret;
3645
Xenia Ragiadakou38d7f682013-09-04 17:24:45 +03003646 if (udev->state != USB_STATE_CONFIGURED)
3647 return 0;
3648
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003649 /* Convert SEL and PEL stored in ns to us */
3650 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3651 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3652 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3653 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3654
3655 /*
3656 * Make sure that the calculated SEL and PEL values for the link
3657 * state we're enabling aren't bigger than the max SEL/PEL
3658 * value that will fit in the SET SEL control transfer.
3659 * Otherwise the device would get an incorrect idea of the exit
3660 * latency for the link state, and could start a device-initiated
3661 * U1/U2 when the exit latencies are too high.
3662 */
3663 if ((state == USB3_LPM_U1 &&
3664 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3665 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3666 (state == USB3_LPM_U2 &&
3667 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3668 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
Sarah Sharp1510a1a2012-10-05 10:30:35 -07003669 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 -07003670 usb3_lpm_names[state], u1_sel, u1_pel);
3671 return -EINVAL;
3672 }
3673
3674 /*
3675 * If we're enabling device-initiated LPM for one link state,
3676 * but the other link state has a too high SEL or PEL value,
3677 * just set those values to the max in the Set SEL request.
3678 */
3679 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3680 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3681
3682 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3683 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3684
3685 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3686 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3687
3688 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3689 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3690
3691 /*
3692 * usb_enable_lpm() can be called as part of a failed device reset,
3693 * which may be initiated by an error path of a mass storage driver.
3694 * Therefore, use GFP_NOIO.
3695 */
3696 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3697 if (!sel_values)
3698 return -ENOMEM;
3699
3700 sel_values->u1_sel = u1_sel;
3701 sel_values->u1_pel = u1_pel;
3702 sel_values->u2_sel = cpu_to_le16(u2_sel);
3703 sel_values->u2_pel = cpu_to_le16(u2_pel);
3704
3705 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3706 USB_REQ_SET_SEL,
3707 USB_RECIP_DEVICE,
3708 0, 0,
3709 sel_values, sizeof *(sel_values),
3710 USB_CTRL_SET_TIMEOUT);
3711 kfree(sel_values);
3712 return ret;
3713}
3714
3715/*
3716 * Enable or disable device-initiated U1 or U2 transitions.
3717 */
3718static int usb_set_device_initiated_lpm(struct usb_device *udev,
3719 enum usb3_link_state state, bool enable)
3720{
3721 int ret;
3722 int feature;
3723
3724 switch (state) {
3725 case USB3_LPM_U1:
3726 feature = USB_DEVICE_U1_ENABLE;
3727 break;
3728 case USB3_LPM_U2:
3729 feature = USB_DEVICE_U2_ENABLE;
3730 break;
3731 default:
3732 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3733 __func__, enable ? "enable" : "disable");
3734 return -EINVAL;
3735 }
3736
3737 if (udev->state != USB_STATE_CONFIGURED) {
3738 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3739 "for unconfigured device.\n",
3740 __func__, enable ? "enable" : "disable",
3741 usb3_lpm_names[state]);
3742 return 0;
3743 }
3744
3745 if (enable) {
3746 /*
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003747 * Now send the control transfer to enable device-initiated LPM
3748 * for either U1 or U2.
3749 */
3750 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3751 USB_REQ_SET_FEATURE,
3752 USB_RECIP_DEVICE,
3753 feature,
3754 0, NULL, 0,
3755 USB_CTRL_SET_TIMEOUT);
3756 } else {
3757 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3758 USB_REQ_CLEAR_FEATURE,
3759 USB_RECIP_DEVICE,
3760 feature,
3761 0, NULL, 0,
3762 USB_CTRL_SET_TIMEOUT);
3763 }
3764 if (ret < 0) {
3765 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3766 enable ? "Enable" : "Disable",
3767 usb3_lpm_names[state]);
3768 return -EBUSY;
3769 }
3770 return 0;
3771}
3772
3773static int usb_set_lpm_timeout(struct usb_device *udev,
3774 enum usb3_link_state state, int timeout)
3775{
3776 int ret;
3777 int feature;
3778
3779 switch (state) {
3780 case USB3_LPM_U1:
3781 feature = USB_PORT_FEAT_U1_TIMEOUT;
3782 break;
3783 case USB3_LPM_U2:
3784 feature = USB_PORT_FEAT_U2_TIMEOUT;
3785 break;
3786 default:
3787 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3788 __func__);
3789 return -EINVAL;
3790 }
3791
3792 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3793 timeout != USB3_LPM_DEVICE_INITIATED) {
3794 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3795 "which is a reserved value.\n",
3796 usb3_lpm_names[state], timeout);
3797 return -EINVAL;
3798 }
3799
3800 ret = set_port_feature(udev->parent,
3801 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3802 feature);
3803 if (ret < 0) {
3804 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3805 "error code %i\n", usb3_lpm_names[state],
3806 timeout, ret);
3807 return -EBUSY;
3808 }
3809 if (state == USB3_LPM_U1)
3810 udev->u1_params.timeout = timeout;
3811 else
3812 udev->u2_params.timeout = timeout;
3813 return 0;
3814}
3815
3816/*
3817 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3818 * U1/U2 entry.
3819 *
3820 * We will attempt to enable U1 or U2, but there are no guarantees that the
3821 * control transfers to set the hub timeout or enable device-initiated U1/U2
3822 * will be successful.
3823 *
3824 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3825 * driver know about it. If that call fails, it should be harmless, and just
3826 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3827 */
3828static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3829 enum usb3_link_state state)
3830{
Sarah Sharp65a95b72012-10-05 10:32:07 -07003831 int timeout, ret;
Sarah Sharpae8963a2012-10-03 11:18:05 -07003832 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3833 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3834
3835 /* If the device says it doesn't have *any* exit latency to come out of
3836 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3837 * state.
3838 */
3839 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3840 (state == USB3_LPM_U2 && u2_mel == 0))
3841 return;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003842
Sarah Sharp65a95b72012-10-05 10:32:07 -07003843 /*
3844 * First, let the device know about the exit latencies
3845 * associated with the link state we're about to enable.
3846 */
3847 ret = usb_req_set_sel(udev, state);
3848 if (ret < 0) {
3849 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3850 usb3_lpm_names[state]);
3851 return;
3852 }
3853
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003854 /* We allow the host controller to set the U1/U2 timeout internally
3855 * first, so that it can change its schedule to account for the
3856 * additional latency to send data to a device in a lower power
3857 * link state.
3858 */
3859 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3860
3861 /* xHCI host controller doesn't want to enable this LPM state. */
3862 if (timeout == 0)
3863 return;
3864
3865 if (timeout < 0) {
3866 dev_warn(&udev->dev, "Could not enable %s link state, "
3867 "xHCI error %i.\n", usb3_lpm_names[state],
3868 timeout);
3869 return;
3870 }
3871
3872 if (usb_set_lpm_timeout(udev, state, timeout))
3873 /* If we can't set the parent hub U1/U2 timeout,
3874 * device-initiated LPM won't be allowed either, so let the xHCI
3875 * host know that this link state won't be enabled.
3876 */
3877 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3878
3879 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3880 else if (udev->actconfig)
3881 usb_set_device_initiated_lpm(udev, state, true);
3882
3883}
3884
3885/*
3886 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3887 * U1/U2 entry.
3888 *
3889 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3890 * If zero is returned, the parent will not allow the link to go into U1/U2.
3891 *
3892 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3893 * it won't have an effect on the bus link state because the parent hub will
3894 * still disallow device-initiated U1/U2 entry.
3895 *
3896 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3897 * possible. The result will be slightly more bus bandwidth will be taken up
3898 * (to account for U1/U2 exit latency), but it should be harmless.
3899 */
3900static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3901 enum usb3_link_state state)
3902{
3903 int feature;
3904
3905 switch (state) {
3906 case USB3_LPM_U1:
3907 feature = USB_PORT_FEAT_U1_TIMEOUT;
3908 break;
3909 case USB3_LPM_U2:
3910 feature = USB_PORT_FEAT_U2_TIMEOUT;
3911 break;
3912 default:
3913 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3914 __func__);
3915 return -EINVAL;
3916 }
3917
3918 if (usb_set_lpm_timeout(udev, state, 0))
3919 return -EBUSY;
3920
3921 usb_set_device_initiated_lpm(udev, state, false);
3922
3923 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3924 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3925 "bus schedule bandwidth may be impacted.\n",
3926 usb3_lpm_names[state]);
3927 return 0;
3928}
3929
3930/*
3931 * Disable hub-initiated and device-initiated U1 and U2 entry.
3932 * Caller must own the bandwidth_mutex.
3933 *
3934 * This will call usb_enable_lpm() on failure, which will decrement
3935 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
3936 */
3937int usb_disable_lpm(struct usb_device *udev)
3938{
3939 struct usb_hcd *hcd;
3940
3941 if (!udev || !udev->parent ||
3942 udev->speed != USB_SPEED_SUPER ||
Pratyush Anand51df62f2014-07-04 17:01:27 +03003943 !udev->lpm_capable ||
3944 udev->state < USB_STATE_DEFAULT)
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003945 return 0;
3946
3947 hcd = bus_to_hcd(udev->bus);
3948 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
3949 return 0;
3950
3951 udev->lpm_disable_count++;
Dan Carpenter55558c32012-05-22 20:54:34 +03003952 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003953 return 0;
3954
3955 /* If LPM is enabled, attempt to disable it. */
3956 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
3957 goto enable_lpm;
3958 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
3959 goto enable_lpm;
3960
3961 return 0;
3962
3963enable_lpm:
3964 usb_enable_lpm(udev);
3965 return -EBUSY;
3966}
3967EXPORT_SYMBOL_GPL(usb_disable_lpm);
3968
3969/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
3970int usb_unlocked_disable_lpm(struct usb_device *udev)
3971{
3972 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3973 int ret;
3974
3975 if (!hcd)
3976 return -EINVAL;
3977
3978 mutex_lock(hcd->bandwidth_mutex);
3979 ret = usb_disable_lpm(udev);
3980 mutex_unlock(hcd->bandwidth_mutex);
3981
3982 return ret;
3983}
3984EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
3985
3986/*
3987 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
3988 * xHCI host policy may prevent U1 or U2 from being enabled.
3989 *
3990 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
3991 * until the lpm_disable_count drops to zero. Caller must own the
3992 * bandwidth_mutex.
3993 */
3994void usb_enable_lpm(struct usb_device *udev)
3995{
3996 struct usb_hcd *hcd;
3997
3998 if (!udev || !udev->parent ||
3999 udev->speed != USB_SPEED_SUPER ||
Pratyush Anand51df62f2014-07-04 17:01:27 +03004000 !udev->lpm_capable ||
4001 udev->state < USB_STATE_DEFAULT)
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004002 return;
4003
4004 udev->lpm_disable_count--;
4005 hcd = bus_to_hcd(udev->bus);
4006 /* Double check that we can both enable and disable LPM.
4007 * Device must be configured to accept set feature U1/U2 timeout.
4008 */
4009 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4010 !hcd->driver->disable_usb3_lpm_timeout)
4011 return;
4012
4013 if (udev->lpm_disable_count > 0)
4014 return;
4015
4016 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4017 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4018}
4019EXPORT_SYMBOL_GPL(usb_enable_lpm);
4020
4021/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4022void usb_unlocked_enable_lpm(struct usb_device *udev)
4023{
4024 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4025
4026 if (!hcd)
4027 return;
4028
4029 mutex_lock(hcd->bandwidth_mutex);
4030 usb_enable_lpm(udev);
4031 mutex_unlock(hcd->bandwidth_mutex);
4032}
4033EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4034
4035
Alan Sternd388dab2006-07-01 22:14:24 -04004036#else /* CONFIG_PM */
4037
Alan Sternf07600c2007-05-30 15:38:16 -04004038#define hub_suspend NULL
4039#define hub_resume NULL
4040#define hub_reset_resume NULL
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004041
4042int usb_disable_lpm(struct usb_device *udev)
4043{
4044 return 0;
4045}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004046EXPORT_SYMBOL_GPL(usb_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004047
4048void usb_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004049EXPORT_SYMBOL_GPL(usb_enable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004050
4051int usb_unlocked_disable_lpm(struct usb_device *udev)
4052{
4053 return 0;
4054}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004055EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004056
4057void usb_unlocked_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004058EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
Sarah Sharpf74631e2012-06-25 12:08:08 -07004059
4060int usb_disable_ltm(struct usb_device *udev)
4061{
4062 return 0;
4063}
4064EXPORT_SYMBOL_GPL(usb_disable_ltm);
4065
4066void usb_enable_ltm(struct usb_device *udev) { }
4067EXPORT_SYMBOL_GPL(usb_enable_ltm);
Alan Sternc4b51a42013-07-11 14:58:23 -04004068
Stephen Rothwell4a95b1f2014-05-29 18:55:06 +10004069static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4070 u16 portstatus, u16 portchange)
4071{
4072 return 0;
4073}
4074
Alan Sternc4b51a42013-07-11 14:58:23 -04004075#endif /* CONFIG_PM */
Alan Sternd388dab2006-07-01 22:14:24 -04004076
Linus Torvalds1da177e2005-04-16 15:20:36 -07004077
4078/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4079 *
4080 * Between connect detection and reset signaling there must be a delay
4081 * of 100ms at least for debounce and power-settling. The corresponding
4082 * timer shall restart whenever the downstream port detects a disconnect.
Matthias Beyer469271f2013-10-10 23:41:27 +02004083 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004084 * Apparently there are some bluetooth and irda-dongles and a number of
4085 * low-speed devices for which this debounce period may last over a second.
4086 * Not covered by the spec - but easy to deal with.
4087 *
4088 * This implementation uses a 1500ms total debounce timeout; if the
4089 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4090 * every 25ms for transient disconnects. When the port status has been
4091 * unchanged for 100ms it returns the port status.
4092 */
Lan Tianyuad493e52013-01-23 04:26:30 +08004093int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004094{
4095 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004096 u16 portchange, portstatus;
4097 unsigned connection = 0xffff;
Dan Williamsd99f6b42014-05-20 18:08:17 -07004098 int total_time, stable_time = 0;
4099 struct usb_port *port_dev = hub->ports[port1 - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07004100
4101 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4102 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4103 if (ret < 0)
4104 return ret;
4105
4106 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4107 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004108 if (!must_be_connected ||
4109 (connection == USB_PORT_STAT_CONNECTION))
4110 stable_time += HUB_DEBOUNCE_STEP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004111 if (stable_time >= HUB_DEBOUNCE_STABLE)
4112 break;
4113 } else {
4114 stable_time = 0;
4115 connection = portstatus & USB_PORT_STAT_CONNECTION;
4116 }
4117
4118 if (portchange & USB_PORT_STAT_C_CONNECTION) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004119 usb_clear_port_feature(hub->hdev, port1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004120 USB_PORT_FEAT_C_CONNECTION);
4121 }
4122
4123 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4124 break;
4125 msleep(HUB_DEBOUNCE_STEP);
4126 }
4127
Dan Williamsd99f6b42014-05-20 18:08:17 -07004128 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4129 total_time, stable_time, portstatus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004130
4131 if (stable_time < HUB_DEBOUNCE_STABLE)
4132 return -ETIMEDOUT;
4133 return portstatus;
4134}
4135
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004136void usb_ep0_reinit(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004137{
Alan Sternddeac4e2009-01-15 17:03:33 -05004138 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4139 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
Alan Stern2caf7fc2008-12-31 11:31:33 -05004140 usb_enable_endpoint(udev, &udev->ep0, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004141}
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004142EXPORT_SYMBOL_GPL(usb_ep0_reinit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004143
4144#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4145#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4146
Alan Stern4326ed02007-07-30 17:08:43 -04004147static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004148{
4149 int retval;
Sarah Sharpc6515272009-04-27 19:57:26 -07004150 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004151
Sarah Sharpc6515272009-04-27 19:57:26 -07004152 /*
4153 * The host controller will choose the device address,
4154 * instead of the core having chosen it earlier
4155 */
4156 if (!hcd->driver->address_device && devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004157 return -EINVAL;
4158 if (udev->state == USB_STATE_ADDRESS)
4159 return 0;
4160 if (udev->state != USB_STATE_DEFAULT)
4161 return -EINVAL;
Andiry Xuc8d4af82010-10-14 07:22:51 -07004162 if (hcd->driver->address_device)
Sarah Sharpc6515272009-04-27 19:57:26 -07004163 retval = hcd->driver->address_device(hcd, udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07004164 else
Sarah Sharpc6515272009-04-27 19:57:26 -07004165 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4166 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4167 NULL, 0, USB_CTRL_SET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004168 if (retval == 0) {
Alan Stern3b29b682011-02-22 09:53:41 -05004169 update_devnum(udev, devnum);
David Vrabel4953d142008-04-08 13:24:46 -07004170 /* Device now using proper address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004171 usb_set_device_state(udev, USB_STATE_ADDRESS);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004172 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004173 }
4174 return retval;
4175}
4176
Mathias Nyman890dae82013-09-30 17:26:31 +03004177/*
4178 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4179 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4180 * enabled.
4181 *
4182 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4183 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4184 * support bit in the BOS descriptor.
4185 */
4186static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4187{
Dan Williamsd99f6b42014-05-20 18:08:17 -07004188 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4189 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
Mathias Nyman890dae82013-09-30 17:26:31 +03004190
4191 if (!udev->usb2_hw_lpm_capable)
4192 return;
4193
Dan Williamsd99f6b42014-05-20 18:08:17 -07004194 if (hub)
4195 connect_type = hub->ports[udev->portnum - 1]->connect_type;
Mathias Nyman890dae82013-09-30 17:26:31 +03004196
Bjørn Mork23c05822014-02-27 14:23:55 +01004197 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
Mathias Nyman890dae82013-09-30 17:26:31 +03004198 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4199 udev->usb2_hw_lpm_allowed = 1;
4200 usb_set_usb2_hardware_lpm(udev, 1);
4201 }
4202}
4203
Dan Williams48fc7db2013-12-05 17:07:27 -08004204static int hub_enable_device(struct usb_device *udev)
4205{
4206 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4207
4208 if (!hcd->driver->enable_device)
4209 return 0;
4210 if (udev->state == USB_STATE_ADDRESS)
4211 return 0;
4212 if (udev->state != USB_STATE_DEFAULT)
4213 return -EINVAL;
4214
4215 return hcd->driver->enable_device(hcd, udev);
4216}
4217
Linus Torvalds1da177e2005-04-16 15:20:36 -07004218/* Reset device, (re)assign address, get device descriptor.
4219 * Device connection must be stable, no more debouncing needed.
4220 * Returns device in USB_STATE_ADDRESS, except on error.
4221 *
4222 * If this is called for an already-existing device (as part of
Dan Williams5c79a1e2014-05-20 18:09:26 -07004223 * usb_reset_and_verify_device), the caller must own the device lock and
4224 * the port lock. For a newly detected device that is not accessible
4225 * through any global pointers, it's not necessary to lock the device,
4226 * but it is still necessary to lock the port.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004227 */
4228static int
4229hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4230 int retry_counter)
4231{
Linus Torvalds1da177e2005-04-16 15:20:36 -07004232 struct usb_device *hdev = hub->hdev;
Sarah Sharpe7b77172009-04-27 19:54:26 -07004233 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004234 int i, j, retval;
4235 unsigned delay = HUB_SHORT_RESET_TIME;
4236 enum usb_device_speed oldspeed = udev->speed;
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004237 const char *speed;
Alan Stern4326ed02007-07-30 17:08:43 -04004238 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004239
4240 /* root hub ports have a slightly longer reset period
4241 * (from USB 2.0 spec, section 7.1.7.5)
4242 */
4243 if (!hdev->parent) {
4244 delay = HUB_ROOT_RESET_TIME;
4245 if (port1 == hdev->bus->otg_port)
4246 hdev->bus->b_hnp_enable = 0;
4247 }
4248
4249 /* Some low speed devices have problems with the quick delay, so */
4250 /* be a bit pessimistic with those devices. RHbug #23670 */
4251 if (oldspeed == USB_SPEED_LOW)
4252 delay = HUB_LONG_RESET_TIME;
4253
Todd E Brandt6fecd4f2014-05-19 10:55:32 -07004254 mutex_lock(&hdev->bus->usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004255
Luben Tuikov07194ab2011-02-11 11:33:10 -08004256 /* Reset the device; full speed may morph to high speed */
4257 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
Andiry Xu75d7cf72011-09-13 16:41:11 -07004258 retval = hub_port_reset(hub, port1, udev, delay, false);
Luben Tuikov07194ab2011-02-11 11:33:10 -08004259 if (retval < 0) /* error or disconnect */
4260 goto fail;
4261 /* success, speed is known */
4262
Linus Torvalds1da177e2005-04-16 15:20:36 -07004263 retval = -ENODEV;
4264
4265 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4266 dev_dbg(&udev->dev, "device reset changed speed!\n");
4267 goto fail;
4268 }
4269 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04004270
Linus Torvalds1da177e2005-04-16 15:20:36 -07004271 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4272 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004273 * For Wireless USB devices, ep0 max packet is always 512 (tho
4274 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07004275 */
4276 switch (udev->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -07004277 case USB_SPEED_SUPER:
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08004278 case USB_SPEED_WIRELESS: /* fixed at 512 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004279 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004280 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004281 case USB_SPEED_HIGH: /* fixed at 64 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004282 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004283 break;
4284 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4285 /* to determine the ep0 maxpacket size, try to read
4286 * the device descriptor to get bMaxPacketSize0 and
4287 * then correct our initial guess.
4288 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004289 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004290 break;
4291 case USB_SPEED_LOW: /* fixed at 8 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004292 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004293 break;
4294 default:
4295 goto fail;
4296 }
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004297
4298 if (udev->speed == USB_SPEED_WIRELESS)
4299 speed = "variable speed Wireless";
4300 else
4301 speed = usb_speed_string(udev->speed);
4302
Sarah Sharpc6515272009-04-27 19:57:26 -07004303 if (udev->speed != USB_SPEED_SUPER)
4304 dev_info(&udev->dev,
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004305 "%s %s USB device number %d using %s\n",
4306 (udev->config) ? "reset" : "new", speed,
Alan Stern3b29b682011-02-22 09:53:41 -05004307 devnum, udev->bus->controller->driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004308
4309 /* Set up TT records, if needed */
4310 if (hdev->tt) {
4311 udev->tt = hdev->tt;
4312 udev->ttport = hdev->ttport;
4313 } else if (udev->speed != USB_SPEED_HIGH
4314 && hdev->speed == USB_SPEED_HIGH) {
Alan Sternd199c962011-01-31 10:56:37 -05004315 if (!hub->tt.hub) {
4316 dev_err(&udev->dev, "parent hub has no TT\n");
4317 retval = -EINVAL;
4318 goto fail;
4319 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004320 udev->tt = &hub->tt;
4321 udev->ttport = port1;
4322 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004323
Linus Torvalds1da177e2005-04-16 15:20:36 -07004324 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4325 * Because device hardware and firmware is sometimes buggy in
4326 * this area, and this is how Linux has done it for ages.
4327 * Change it cautiously.
4328 *
Dan Williams48fc7db2013-12-05 17:07:27 -08004329 * NOTE: If use_new_scheme() is true we will start by issuing
Linus Torvalds1da177e2005-04-16 15:20:36 -07004330 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4331 * so it may help with some non-standards-compliant devices.
4332 * Otherwise we start with SET_ADDRESS and then try to read the
4333 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4334 * value.
4335 */
4336 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
Dan Williams48fc7db2013-12-05 17:07:27 -08004337 bool did_new_scheme = false;
4338
4339 if (use_new_scheme(udev, retry_counter)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004340 struct usb_device_descriptor *buf;
4341 int r = 0;
4342
Dan Williams48fc7db2013-12-05 17:07:27 -08004343 did_new_scheme = true;
4344 retval = hub_enable_device(udev);
Oliver Neukum938569e2014-02-27 10:57:10 +01004345 if (retval < 0) {
4346 dev_err(&udev->dev,
4347 "hub failed to enable device, error %d\n",
4348 retval);
Dan Williams48fc7db2013-12-05 17:07:27 -08004349 goto fail;
Oliver Neukum938569e2014-02-27 10:57:10 +01004350 }
Dan Williams48fc7db2013-12-05 17:07:27 -08004351
Linus Torvalds1da177e2005-04-16 15:20:36 -07004352#define GET_DESCRIPTOR_BUFSIZE 64
4353 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4354 if (!buf) {
4355 retval = -ENOMEM;
4356 continue;
4357 }
4358
Alan Sternb89ee192007-05-11 10:19:04 -04004359 /* Retry on all errors; some devices are flakey.
4360 * 255 is for WUSB devices, we actually need to use
4361 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07004362 */
4363 for (j = 0; j < 3; ++j) {
4364 buf->bMaxPacketSize0 = 0;
4365 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4366 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4367 USB_DT_DEVICE << 8, 0,
4368 buf, GET_DESCRIPTOR_BUFSIZE,
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +02004369 initial_descriptor_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004370 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004371 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07004372 if (buf->bDescriptorType ==
4373 USB_DT_DEVICE) {
4374 r = 0;
4375 break;
4376 }
4377 /* FALL THROUGH */
4378 default:
4379 if (r == 0)
4380 r = -EPROTO;
4381 break;
4382 }
4383 if (r == 0)
4384 break;
4385 }
4386 udev->descriptor.bMaxPacketSize0 =
4387 buf->bMaxPacketSize0;
4388 kfree(buf);
4389
Andiry Xu75d7cf72011-09-13 16:41:11 -07004390 retval = hub_port_reset(hub, port1, udev, delay, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004391 if (retval < 0) /* error or disconnect */
4392 goto fail;
4393 if (oldspeed != udev->speed) {
4394 dev_dbg(&udev->dev,
4395 "device reset changed speed!\n");
4396 retval = -ENODEV;
4397 goto fail;
4398 }
4399 if (r) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004400 if (r != -ENODEV)
4401 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4402 r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004403 retval = -EMSGSIZE;
4404 continue;
4405 }
4406#undef GET_DESCRIPTOR_BUFSIZE
4407 }
4408
Matthias Beyer469271f2013-10-10 23:41:27 +02004409 /*
4410 * If device is WUSB, we already assigned an
4411 * unauthorized address in the Connect Ack sequence;
4412 * authorization will assign the final address.
4413 */
Sarah Sharpc6515272009-04-27 19:57:26 -07004414 if (udev->wusb == 0) {
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004415 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4416 retval = hub_set_address(udev, devnum);
4417 if (retval >= 0)
4418 break;
4419 msleep(200);
4420 }
4421 if (retval < 0) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004422 if (retval != -ENODEV)
4423 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4424 devnum, retval);
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004425 goto fail;
4426 }
Sarah Sharpc6515272009-04-27 19:57:26 -07004427 if (udev->speed == USB_SPEED_SUPER) {
4428 devnum = udev->devnum;
4429 dev_info(&udev->dev,
Alan Stern3b29b682011-02-22 09:53:41 -05004430 "%s SuperSpeed USB device number %d using %s\n",
Sarah Sharpc6515272009-04-27 19:57:26 -07004431 (udev->config) ? "reset" : "new",
Alan Stern3b29b682011-02-22 09:53:41 -05004432 devnum, udev->bus->controller->driver->name);
Sarah Sharpc6515272009-04-27 19:57:26 -07004433 }
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004434
4435 /* cope with hardware quirkiness:
4436 * - let SET_ADDRESS settle, some device hardware wants it
4437 * - read ep0 maxpacket even for high and low speed,
4438 */
4439 msleep(10);
Dan Williams48fc7db2013-12-05 17:07:27 -08004440 /* use_new_scheme() checks the speed which may have
4441 * changed since the initial look so we cache the result
4442 * in did_new_scheme
4443 */
4444 if (did_new_scheme)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004445 break;
Matthias Beyer469271f2013-10-10 23:41:27 +02004446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004447
4448 retval = usb_get_device_descriptor(udev, 8);
4449 if (retval < 8) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004450 if (retval != -ENODEV)
4451 dev_err(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08004452 "device descriptor read/8, error %d\n",
4453 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004454 if (retval >= 0)
4455 retval = -EMSGSIZE;
4456 } else {
4457 retval = 0;
4458 break;
4459 }
4460 }
4461 if (retval)
4462 goto fail;
4463
Peter Chenb76baa82012-11-09 09:44:43 +08004464 if (hcd->phy && !hdev->parent)
Peter Chenac965112012-11-09 09:44:44 +08004465 usb_phy_notify_connect(hcd->phy, udev->speed);
Peter Chenb76baa82012-11-09 09:44:43 +08004466
Elric Fud8aec3d2012-03-26 21:16:02 +08004467 /*
4468 * Some superspeed devices have finished the link training process
4469 * and attached to a superspeed hub port, but the device descriptor
4470 * got from those devices show they aren't superspeed devices. Warm
4471 * reset the port attached by the devices can fix them.
4472 */
4473 if ((udev->speed == USB_SPEED_SUPER) &&
4474 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4475 dev_err(&udev->dev, "got a wrong device descriptor, "
4476 "warm reset device\n");
4477 hub_port_reset(hub, port1, udev,
4478 HUB_BH_RESET_TIME, true);
4479 retval = -EINVAL;
4480 goto fail;
4481 }
4482
Sarah Sharp6b403b02009-04-27 19:54:10 -07004483 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4484 udev->speed == USB_SPEED_SUPER)
4485 i = 512;
4486 else
4487 i = udev->descriptor.bMaxPacketSize0;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07004488 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
Alan Stern56626a72010-10-14 15:25:21 -04004489 if (udev->speed == USB_SPEED_LOW ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07004490 !(i == 8 || i == 16 || i == 32 || i == 64)) {
Alan Stern56626a72010-10-14 15:25:21 -04004491 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004492 retval = -EMSGSIZE;
4493 goto fail;
4494 }
Alan Stern56626a72010-10-14 15:25:21 -04004495 if (udev->speed == USB_SPEED_FULL)
4496 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4497 else
4498 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004499 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004500 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004501 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004502
Linus Torvalds1da177e2005-04-16 15:20:36 -07004503 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4504 if (retval < (signed)sizeof(udev->descriptor)) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004505 if (retval != -ENODEV)
4506 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4507 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004508 if (retval >= 0)
4509 retval = -ENOMSG;
4510 goto fail;
4511 }
4512
Andiry Xu1ff4df52011-09-23 14:19:48 -07004513 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4514 retval = usb_get_bos_descriptor(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004515 if (!retval) {
Sarah Sharpd9b20992012-02-20 08:31:26 -08004516 udev->lpm_capable = usb_device_supports_lpm(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004517 usb_set_lpm_parameters(udev);
4518 }
Andiry Xu1ff4df52011-09-23 14:19:48 -07004519 }
Andiry Xu3148bf02011-09-23 14:19:47 -07004520
Linus Torvalds1da177e2005-04-16 15:20:36 -07004521 retval = 0;
Alek Du48f24972010-06-04 15:47:55 +08004522 /* notify HCD that we have a device connected and addressed */
4523 if (hcd->driver->update_device)
4524 hcd->driver->update_device(hcd, udev);
Mathias Nyman890dae82013-09-30 17:26:31 +03004525 hub_set_initial_usb2_lpm_policy(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004526fail:
Alan Stern4326ed02007-07-30 17:08:43 -04004527 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004528 hub_port_disable(hub, port1, 0);
Alan Stern3b29b682011-02-22 09:53:41 -05004529 update_devnum(udev, devnum); /* for disconnect processing */
Alan Stern4326ed02007-07-30 17:08:43 -04004530 }
Todd E Brandt6fecd4f2014-05-19 10:55:32 -07004531 mutex_unlock(&hdev->bus->usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004532 return retval;
4533}
4534
4535static void
4536check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4537{
4538 struct usb_qualifier_descriptor *qual;
4539 int status;
4540
Christoph Lametere94b1762006-12-06 20:33:17 -08004541 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004542 if (qual == NULL)
4543 return;
4544
4545 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4546 qual, sizeof *qual);
4547 if (status == sizeof *qual) {
4548 dev_info(&udev->dev, "not running at top speed; "
4549 "connect to a high speed hub\n");
4550 /* hub LEDs are probably harder to miss than syslog */
4551 if (hub->has_indicators) {
4552 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08004553 queue_delayed_work(system_power_efficient_wq,
4554 &hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004555 }
4556 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07004557 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004558}
4559
4560static unsigned
4561hub_power_remaining (struct usb_hub *hub)
4562{
4563 struct usb_device *hdev = hub->hdev;
4564 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05004565 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004566
Alan Stern55c52712005-11-23 12:03:12 -05004567 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004568 return 0;
4569
Alan Stern55c52712005-11-23 12:03:12 -05004570 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4571 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07004572 struct usb_port *port_dev = hub->ports[port1 - 1];
4573 struct usb_device *udev = port_dev->child;
4574 unsigned unit_load;
4575 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004576
4577 if (!udev)
4578 continue;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004579 if (hub_is_superspeed(udev))
4580 unit_load = 150;
4581 else
4582 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004583
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004584 /*
4585 * Unconfigured devices may not use more than one unit load,
4586 * or 8mA for OTG ports
4587 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004588 if (udev->actconfig)
Sebastian Andrzej Siewior8d8479d2012-12-18 15:25:46 +01004589 delta = usb_get_max_power(udev, udev->actconfig);
Alan Stern55c52712005-11-23 12:03:12 -05004590 else if (port1 != udev->bus->otg_port || hdev->parent)
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004591 delta = unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004592 else
Alan Stern55c52712005-11-23 12:03:12 -05004593 delta = 8;
4594 if (delta > hub->mA_per_port)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004595 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4596 delta, hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004597 remaining -= delta;
4598 }
4599 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05004600 dev_warn(hub->intfdev, "%dmA over power budget!\n",
Matthias Beyer469271f2013-10-10 23:41:27 +02004601 -remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004602 remaining = 0;
4603 }
4604 return remaining;
4605}
4606
Dan Williamsaf376a42014-05-20 18:09:15 -07004607static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4608 u16 portchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004609{
Linus Torvalds1da177e2005-04-16 15:20:36 -07004610 int status, i;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004611 unsigned unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004612 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004613 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004614 struct usb_port *port_dev = hub->ports[port1 - 1];
Dan Williamsaf376a42014-05-20 18:09:15 -07004615 struct usb_device *udev = port_dev->child;
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004616 static int unreliable_port = -1;
Alan Stern8808f002008-04-28 11:06:55 -04004617
Alan Stern24618b02008-04-28 11:06:28 -04004618 /* Disconnect any existing devices under this port */
Peter Chenb76baa82012-11-09 09:44:43 +08004619 if (udev) {
4620 if (hcd->phy && !hdev->parent &&
4621 !(portstatus & USB_PORT_STAT_CONNECTION))
Peter Chenac965112012-11-09 09:44:44 +08004622 usb_phy_notify_disconnect(hcd->phy, udev->speed);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004623 usb_disconnect(&port_dev->child);
Peter Chenb76baa82012-11-09 09:44:43 +08004624 }
Alan Stern24618b02008-04-28 11:06:28 -04004625
Alan Stern253e0572009-10-27 15:20:13 -04004626 /* We can forget about a "removed" device when there's a physical
4627 * disconnect or the connect status changes.
4628 */
4629 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4630 (portchange & USB_PORT_STAT_C_CONNECTION))
4631 clear_bit(port1, hub->removed_bits);
4632
Alan Stern5257d972008-09-22 14:43:08 -04004633 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4634 USB_PORT_STAT_C_ENABLE)) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004635 status = hub_port_debounce_be_stable(hub, port1);
Alan Stern5257d972008-09-22 14:43:08 -04004636 if (status < 0) {
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004637 if (status != -ENODEV &&
4638 port1 != unreliable_port &&
4639 printk_ratelimit())
Takashi Iwaidd5f5002014-08-19 17:37:55 +02004640 dev_err(&port_dev->dev, "connect-debounce failed\n");
Alan Stern5257d972008-09-22 14:43:08 -04004641 portstatus &= ~USB_PORT_STAT_CONNECTION;
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004642 unreliable_port = port1;
Alan Stern5257d972008-09-22 14:43:08 -04004643 } else {
4644 portstatus = status;
4645 }
4646 }
4647
Alan Stern253e0572009-10-27 15:20:13 -04004648 /* Return now if debouncing failed or nothing is connected or
4649 * the device was "removed".
4650 */
4651 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4652 test_bit(port1, hub->removed_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004653
4654 /* maybe switch power back on (e.g. root hub was reset) */
Dan Williams9262c192014-05-20 18:08:12 -07004655 if (hub_is_port_power_switchable(hub)
Andiry Xu0ed9a572011-04-27 18:07:43 +08004656 && !port_is_power_on(hub, portstatus))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004657 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
Alan Stern5257d972008-09-22 14:43:08 -04004658
Linus Torvalds1da177e2005-04-16 15:20:36 -07004659 if (portstatus & USB_PORT_STAT_ENABLE)
Matthias Beyer469271f2013-10-10 23:41:27 +02004660 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004661 return;
4662 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004663 if (hub_is_superspeed(hub->hdev))
4664 unit_load = 150;
4665 else
4666 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004667
Alan Sterne9e88fb2013-03-27 16:14:01 -04004668 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004669 for (i = 0; i < SET_CONFIG_TRIES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004670
4671 /* reallocate for each attempt, since references
4672 * to the previous one can escape in various ways
4673 */
4674 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4675 if (!udev) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07004676 dev_err(&port_dev->dev,
4677 "couldn't allocate usb_device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004678 goto done;
4679 }
4680
4681 usb_set_device_state(udev, USB_STATE_POWERED);
Matthias Beyer469271f2013-10-10 23:41:27 +02004682 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04004683 udev->level = hdev->level + 1;
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07004684 udev->wusb = hub_is_wusb(hub);
Alan Stern55c52712005-11-23 12:03:12 -05004685
Sarah Sharp131dec32010-12-06 21:00:19 -08004686 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4687 if (hub_is_superspeed(hub->hdev))
Sarah Sharpe7b77172009-04-27 19:54:26 -07004688 udev->speed = USB_SPEED_SUPER;
4689 else
4690 udev->speed = USB_SPEED_UNKNOWN;
4691
Alan Stern3b29b682011-02-22 09:53:41 -05004692 choose_devnum(udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07004693 if (udev->devnum <= 0) {
4694 status = -ENOTCONN; /* Don't retry */
4695 goto loop;
Sarah Sharpc6515272009-04-27 19:57:26 -07004696 }
4697
Sarah Sharpe7b77172009-04-27 19:54:26 -07004698 /* reset (non-USB 3.0 devices) and get descriptor */
Dan Williams5c79a1e2014-05-20 18:09:26 -07004699 usb_lock_port(port_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004700 status = hub_port_init(hub, udev, port1, i);
Dan Williams5c79a1e2014-05-20 18:09:26 -07004701 usb_unlock_port(port_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004702 if (status < 0)
4703 goto loop;
4704
Phil Dibowitz93362a82010-07-22 00:05:01 +02004705 usb_detect_quirks(udev);
4706 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4707 msleep(1000);
4708
Linus Torvalds1da177e2005-04-16 15:20:36 -07004709 /* consecutive bus-powered hubs aren't reliable; they can
4710 * violate the voltage drop budget. if the new child has
4711 * a "powered" LED, users should notice we didn't enable it
4712 * (without reading syslog), even without per-port LEDs
4713 * on the parent.
4714 */
4715 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004716 && udev->bus_mA <= unit_load) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004717 u16 devstat;
4718
4719 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4720 &devstat);
Alan Stern15b73362013-07-30 15:35:40 -04004721 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004722 dev_dbg(&udev->dev, "get status %d ?\n", status);
4723 goto loop_disable;
4724 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004725 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4726 dev_err(&udev->dev,
4727 "can't connect bus-powered hub "
4728 "to this port\n");
4729 if (hub->has_indicators) {
4730 hub->indicator[port1-1] =
4731 INDICATOR_AMBER_BLINK;
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08004732 queue_delayed_work(
4733 system_power_efficient_wq,
4734 &hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004735 }
4736 status = -ENOTCONN; /* Don't retry */
4737 goto loop_disable;
4738 }
4739 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004740
Linus Torvalds1da177e2005-04-16 15:20:36 -07004741 /* check for devices running slower than they could */
4742 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4743 && udev->speed == USB_SPEED_FULL
4744 && highspeed_hubs != 0)
4745 check_highspeed (hub, udev, port1);
4746
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07004747 /* Store the parent's children[] pointer. At this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07004748 * udev becomes globally accessible, although presumably
4749 * no one will look at it until hdev is unlocked.
4750 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004751 status = 0;
4752
Dan Williamsd8521af2014-05-20 18:08:28 -07004753 mutex_lock(&usb_port_peer_mutex);
4754
Linus Torvalds1da177e2005-04-16 15:20:36 -07004755 /* We mustn't add new devices if the parent hub has
4756 * been disconnected; we would race with the
4757 * recursively_mark_NOTATTACHED() routine.
4758 */
4759 spin_lock_irq(&device_state_lock);
4760 if (hdev->state == USB_STATE_NOTATTACHED)
4761 status = -ENOTCONN;
4762 else
Dan Williamsd99f6b42014-05-20 18:08:17 -07004763 port_dev->child = udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004764 spin_unlock_irq(&device_state_lock);
Dan Williamsd8521af2014-05-20 18:08:28 -07004765 mutex_unlock(&usb_port_peer_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004766
4767 /* Run it through the hoops (find a driver, etc) */
4768 if (!status) {
4769 status = usb_new_device(udev);
4770 if (status) {
Dan Williamsd8521af2014-05-20 18:08:28 -07004771 mutex_lock(&usb_port_peer_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004772 spin_lock_irq(&device_state_lock);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004773 port_dev->child = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004774 spin_unlock_irq(&device_state_lock);
Dan Williamsd8521af2014-05-20 18:08:28 -07004775 mutex_unlock(&usb_port_peer_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004776 }
4777 }
4778
Linus Torvalds1da177e2005-04-16 15:20:36 -07004779 if (status)
4780 goto loop_disable;
4781
4782 status = hub_power_remaining(hub);
4783 if (status)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004784 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004785
4786 return;
4787
4788loop_disable:
4789 hub_port_disable(hub, port1, 1);
4790loop:
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004791 usb_ep0_reinit(udev);
Alan Stern3b29b682011-02-22 09:53:41 -05004792 release_devnum(udev);
Herbert Xuf7410ce2010-01-10 20:15:03 +11004793 hub_free_dev(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004794 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07004795 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004796 break;
4797 }
Alan Stern3a311552008-05-20 16:58:29 -04004798 if (hub->hdev->parent ||
4799 !hcd->driver->port_handed_over ||
Alan Sterne9e88fb2013-03-27 16:14:01 -04004800 !(hcd->driver->port_handed_over)(hcd, port1)) {
4801 if (status != -ENOTCONN && status != -ENODEV)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004802 dev_err(&port_dev->dev,
4803 "unable to enumerate USB device\n");
Alan Sterne9e88fb2013-03-27 16:14:01 -04004804 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004805
Linus Torvalds1da177e2005-04-16 15:20:36 -07004806done:
4807 hub_port_disable(hub, port1, 1);
Balaji Rao90da0962007-11-22 01:58:14 +05304808 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4809 hcd->driver->relinquish_port(hcd, port1);
Dan Williamsaf376a42014-05-20 18:09:15 -07004810
Linus Torvalds1da177e2005-04-16 15:20:36 -07004811}
4812
Dan Williamsaf376a42014-05-20 18:09:15 -07004813/* Handle physical or logical connection change events.
4814 * This routine is called when:
4815 * a port connection-change occurs;
4816 * a port enable-change occurs (often caused by EMI);
4817 * usb_reset_and_verify_device() encounters changed descriptors (as from
4818 * a firmware download)
4819 * caller already locked the hub
4820 */
4821static void hub_port_connect_change(struct usb_hub *hub, int port1,
4822 u16 portstatus, u16 portchange)
Dan Williams5c79a1e2014-05-20 18:09:26 -07004823 __must_hold(&port_dev->status_lock)
Sarah Sharp714b07b2012-01-24 13:53:18 -08004824{
Dan Williamsaf376a42014-05-20 18:09:15 -07004825 struct usb_port *port_dev = hub->ports[port1 - 1];
4826 struct usb_device *udev = port_dev->child;
4827 int status = -ENODEV;
Sarah Sharp714b07b2012-01-24 13:53:18 -08004828
Dan Williamsaf376a42014-05-20 18:09:15 -07004829 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4830 portchange, portspeed(hub, portstatus));
4831
4832 if (hub->has_indicators) {
4833 set_port_led(hub, port1, HUB_LED_AUTO);
4834 hub->indicator[port1-1] = INDICATOR_AUTO;
Sarah Sharp4ee823b2011-11-14 18:00:01 -08004835 }
4836
Dan Williamsaf376a42014-05-20 18:09:15 -07004837#ifdef CONFIG_USB_OTG
4838 /* during HNP, don't repeat the debounce */
4839 if (hub->hdev->bus->is_b_host)
4840 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4841 USB_PORT_STAT_C_ENABLE);
4842#endif
Sarah Sharp714b07b2012-01-24 13:53:18 -08004843
Dan Williamsaf376a42014-05-20 18:09:15 -07004844 /* Try to resuscitate an existing device */
4845 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4846 udev->state != USB_STATE_NOTATTACHED) {
4847 if (portstatus & USB_PORT_STAT_ENABLE) {
4848 status = 0; /* Nothing to do */
4849#ifdef CONFIG_PM_RUNTIME
4850 } else if (udev->state == USB_STATE_SUSPENDED &&
4851 udev->persist_enabled) {
4852 /* For a suspended device, treat this as a
4853 * remote wakeup event.
4854 */
Dan Williams5c79a1e2014-05-20 18:09:26 -07004855 usb_unlock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07004856 status = usb_remote_wakeup(udev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07004857 usb_lock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07004858#endif
4859 } else {
4860 /* Don't resuscitate */;
4861 }
Sarah Sharp714b07b2012-01-24 13:53:18 -08004862 }
Dan Williamsaf376a42014-05-20 18:09:15 -07004863 clear_bit(port1, hub->change_bits);
4864
Dan Williams5c79a1e2014-05-20 18:09:26 -07004865 /* successfully revalidated the connection */
Dan Williamsaf376a42014-05-20 18:09:15 -07004866 if (status == 0)
4867 return;
4868
Dan Williams5c79a1e2014-05-20 18:09:26 -07004869 usb_unlock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07004870 hub_port_connect(hub, port1, portstatus, portchange);
Dan Williams5c79a1e2014-05-20 18:09:26 -07004871 usb_lock_port(port_dev);
Sarah Sharp714b07b2012-01-24 13:53:18 -08004872}
4873
Dan Williamsaf376a42014-05-20 18:09:15 -07004874static void port_event(struct usb_hub *hub, int port1)
Dan Williams5c79a1e2014-05-20 18:09:26 -07004875 __must_hold(&port_dev->status_lock)
Dan Williamsaf376a42014-05-20 18:09:15 -07004876{
4877 int connect_change, reset_device = 0;
4878 struct usb_port *port_dev = hub->ports[port1 - 1];
4879 struct usb_device *udev = port_dev->child;
4880 struct usb_device *hdev = hub->hdev;
4881 u16 portstatus, portchange;
4882
4883 connect_change = test_bit(port1, hub->change_bits);
4884 clear_bit(port1, hub->event_bits);
4885 clear_bit(port1, hub->wakeup_bits);
4886
4887 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
4888 return;
4889
4890 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4891 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
4892 connect_change = 1;
4893 }
4894
4895 if (portchange & USB_PORT_STAT_C_ENABLE) {
4896 if (!connect_change)
4897 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
4898 portstatus);
4899 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
4900
4901 /*
4902 * EM interference sometimes causes badly shielded USB devices
4903 * to be shutdown by the hub, this hack enables them again.
4904 * Works at least with mouse driver.
4905 */
4906 if (!(portstatus & USB_PORT_STAT_ENABLE)
4907 && !connect_change && udev) {
4908 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
4909 connect_change = 1;
4910 }
4911 }
4912
4913 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
4914 u16 status = 0, unused;
4915
4916 dev_dbg(&port_dev->dev, "over-current change\n");
4917 usb_clear_port_feature(hdev, port1,
4918 USB_PORT_FEAT_C_OVER_CURRENT);
4919 msleep(100); /* Cool down */
4920 hub_power_on(hub, true);
4921 hub_port_status(hub, port1, &status, &unused);
4922 if (status & USB_PORT_STAT_OVERCURRENT)
4923 dev_err(&port_dev->dev, "over-current condition\n");
4924 }
4925
4926 if (portchange & USB_PORT_STAT_C_RESET) {
4927 dev_dbg(&port_dev->dev, "reset change\n");
4928 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
4929 }
4930 if ((portchange & USB_PORT_STAT_C_BH_RESET)
4931 && hub_is_superspeed(hdev)) {
4932 dev_dbg(&port_dev->dev, "warm reset change\n");
4933 usb_clear_port_feature(hdev, port1,
4934 USB_PORT_FEAT_C_BH_PORT_RESET);
4935 }
4936 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
4937 dev_dbg(&port_dev->dev, "link state change\n");
4938 usb_clear_port_feature(hdev, port1,
4939 USB_PORT_FEAT_C_PORT_LINK_STATE);
4940 }
4941 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
4942 dev_warn(&port_dev->dev, "config error\n");
4943 usb_clear_port_feature(hdev, port1,
4944 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
4945 }
4946
Dan Williams097a1552014-05-20 18:09:20 -07004947 /* skip port actions that require the port to be powered on */
4948 if (!pm_runtime_active(&port_dev->dev))
4949 return;
4950
Dan Williamsaf376a42014-05-20 18:09:15 -07004951 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
4952 connect_change = 1;
4953
4954 /*
4955 * Warm reset a USB3 protocol port if it's in
4956 * SS.Inactive state.
4957 */
Dan Williams3cd12f92014-05-29 12:58:46 -07004958 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
Dan Williamsaf376a42014-05-20 18:09:15 -07004959 dev_dbg(&port_dev->dev, "do warm reset\n");
4960 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
4961 || udev->state == USB_STATE_NOTATTACHED) {
4962 if (hub_port_reset(hub, port1, NULL,
4963 HUB_BH_RESET_TIME, true) < 0)
4964 hub_port_disable(hub, port1, 1);
4965 } else
4966 reset_device = 1;
4967 }
4968
4969 /*
4970 * On disconnect USB3 protocol ports transit from U0 to
4971 * SS.Inactive to Rx.Detect. If this happens a warm-
4972 * reset is not needed, but a (re)connect may happen
4973 * before khubd runs and sees the disconnect, and the
4974 * device may be an unknown state.
4975 *
4976 * If the port went through SS.Inactive without khubd
4977 * seeing it the C_LINK_STATE change flag will be set,
4978 * and we reset the dev to put it in a known state.
4979 */
4980 if (reset_device || (udev && hub_is_superspeed(hub->hdev)
4981 && (portchange & USB_PORT_STAT_C_LINK_STATE)
4982 && (portstatus & USB_PORT_STAT_CONNECTION))) {
Dan Williams5c79a1e2014-05-20 18:09:26 -07004983 usb_unlock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07004984 usb_lock_device(udev);
4985 usb_reset_device(udev);
4986 usb_unlock_device(udev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07004987 usb_lock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07004988 connect_change = 0;
4989 }
4990
4991 if (connect_change)
4992 hub_port_connect_change(hub, port1, portstatus, portchange);
4993}
4994
4995
Linus Torvalds1da177e2005-04-16 15:20:36 -07004996static void hub_events(void)
4997{
4998 struct list_head *tmp;
4999 struct usb_device *hdev;
5000 struct usb_interface *intf;
5001 struct usb_hub *hub;
5002 struct device *hub_dev;
5003 u16 hubstatus;
5004 u16 hubchange;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005005 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005006
5007 /*
5008 * We restart the list every time to avoid a deadlock with
5009 * deleting hubs downstream from this one. This should be
5010 * safe since we delete the hub from the event list.
5011 * Not the most efficient, but avoids deadlocks.
5012 */
5013 while (1) {
5014
5015 /* Grab the first entry at the beginning of the list */
5016 spin_lock_irq(&hub_event_lock);
5017 if (list_empty(&hub_event_list)) {
5018 spin_unlock_irq(&hub_event_lock);
5019 break;
5020 }
5021
5022 tmp = hub_event_list.next;
5023 list_del_init(tmp);
5024
5025 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04005026 kref_get(&hub->kref);
5027 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005028
Alan Sterne8054852007-05-04 11:55:11 -04005029 hdev = hub->hdev;
5030 hub_dev = hub->intfdev;
5031 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05005032 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +02005033 hdev->state, hdev->maxchild,
Linus Torvalds1da177e2005-04-16 15:20:36 -07005034 /* NOTE: expects max 15 ports... */
5035 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05005036 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005037
Linus Torvalds1da177e2005-04-16 15:20:36 -07005038 /* Lock the device, then check to see if we were
5039 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04005040 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04005041 if (unlikely(hub->disconnected))
Alan Stern9bbdf1e2010-01-08 12:57:28 -05005042 goto loop_disconnected;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005043
5044 /* If the hub has died, clean up after it */
5045 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04005046 hub->error = -ENODEV;
Alan Stern43303542008-04-28 11:07:31 -04005047 hub_quiesce(hub, HUB_DISCONNECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005048 goto loop;
5049 }
5050
Alan Stern40f122f2006-11-09 14:44:33 -05005051 /* Autoresume */
5052 ret = usb_autopm_get_interface(intf);
5053 if (ret) {
5054 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005055 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05005056 }
5057
5058 /* If this is an inactive hub, do nothing */
5059 if (hub->quiescing)
5060 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005061
5062 if (hub->error) {
5063 dev_dbg (hub_dev, "resetting for error %d\n",
5064 hub->error);
5065
Ming Lei742120c2008-06-18 22:00:29 +08005066 ret = usb_reset_device(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005067 if (ret) {
5068 dev_dbg (hub_dev,
5069 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05005070 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005071 }
5072
5073 hub->nerrors = 0;
5074 hub->error = 0;
5075 }
5076
5077 /* deal with port status changes */
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +02005078 for (i = 1; i <= hdev->maxchild; i++) {
Dan Williams097a1552014-05-20 18:09:20 -07005079 struct usb_port *port_dev = hub->ports[i - 1];
Hans de Goedea82b76f2013-11-08 13:41:05 +01005080
Dan Williams5c79a1e2014-05-20 18:09:26 -07005081 if (test_bit(i, hub->event_bits)
5082 || test_bit(i, hub->change_bits)
5083 || test_bit(i, hub->wakeup_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005084 /*
Dan Williams097a1552014-05-20 18:09:20 -07005085 * The get_noresume and barrier ensure that if
5086 * the port was in the process of resuming, we
5087 * flush that work and keep the port active for
5088 * the duration of the port_event(). However,
5089 * if the port is runtime pm suspended
5090 * (powered-off), we leave it in that state, run
5091 * an abbreviated port_event(), and move on.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005092 */
Dan Williams097a1552014-05-20 18:09:20 -07005093 pm_runtime_get_noresume(&port_dev->dev);
5094 pm_runtime_barrier(&port_dev->dev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005095 usb_lock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07005096 port_event(hub, i);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005097 usb_unlock_port(port_dev);
Dan Williams097a1552014-05-20 18:09:20 -07005098 pm_runtime_put_sync(&port_dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005099 }
Dan Williamsaf376a42014-05-20 18:09:15 -07005100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005101
5102 /* deal with hub status changes */
5103 if (test_and_clear_bit(0, hub->event_bits) == 0)
5104 ; /* do nothing */
5105 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5106 dev_err (hub_dev, "get_hub_status failed\n");
5107 else {
5108 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5109 dev_dbg (hub_dev, "power change\n");
5110 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05005111 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5112 /* FIXME: Is this always true? */
Alan Stern55c52712005-11-23 12:03:12 -05005113 hub->limited_power = 1;
jidong xiao403fae72007-09-14 00:08:51 +08005114 else
5115 hub->limited_power = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005116 }
5117 if (hubchange & HUB_CHANGE_OVERCURRENT) {
Paul Bolle752d57a2011-03-11 18:03:52 +01005118 u16 status = 0;
5119 u16 unused;
5120
5121 dev_dbg(hub_dev, "over-current change\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07005122 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
Paul Bolle752d57a2011-03-11 18:03:52 +01005123 msleep(500); /* Cool down */
Matthias Beyer469271f2013-10-10 23:41:27 +02005124 hub_power_on(hub, true);
Paul Bolle752d57a2011-03-11 18:03:52 +01005125 hub_hub_status(hub, &status, &unused);
5126 if (status & HUB_STATUS_OVERCURRENT)
5127 dev_err(hub_dev, "over-current "
5128 "condition\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07005129 }
5130 }
5131
Alan Stern8e4ceb32009-12-07 13:01:37 -05005132 loop_autopm:
5133 /* Balance the usb_autopm_get_interface() above */
5134 usb_autopm_put_interface_no_suspend(intf);
5135 loop:
5136 /* Balance the usb_autopm_get_interface_no_resume() in
5137 * kick_khubd() and allow autosuspend.
5138 */
5139 usb_autopm_put_interface(intf);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05005140 loop_disconnected:
Linus Torvalds1da177e2005-04-16 15:20:36 -07005141 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04005142 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005143
Matthias Beyer469271f2013-10-10 23:41:27 +02005144 } /* end while (1) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005145}
5146
5147static int hub_thread(void *__unused)
5148{
Rahul Bedarkar025d4432014-01-04 11:24:41 +05305149 /* khubd needs to be freezable to avoid interfering with USB-PERSIST
Alan Stern3bb1af52008-03-03 15:15:36 -05005150 * port handover. Otherwise it might see that a full-speed device
5151 * was gone before the EHCI controller had handed its port over to
5152 * the companion full-speed controller.
5153 */
Rafael J. Wysocki83144182007-07-17 04:03:35 -07005154 set_freezable();
Alan Stern3bb1af52008-03-03 15:15:36 -05005155
Linus Torvalds1da177e2005-04-16 15:20:36 -07005156 do {
5157 hub_events();
Rafael J. Wysockie42837b2007-10-18 03:04:45 -07005158 wait_event_freezable(khubd_wait,
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07005159 !list_empty(&hub_event_list) ||
5160 kthread_should_stop());
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07005161 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07005162
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07005163 pr_debug("%s: khubd exiting\n", usbcore_name);
5164 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005165}
5166
Németh Márton1e927d92010-01-10 15:34:53 +01005167static const struct usb_device_id hub_id_table[] = {
Ming Leie6f30de2012-10-24 11:59:24 +08005168 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
Matthias Beyer469271f2013-10-10 23:41:27 +02005169 | USB_DEVICE_ID_MATCH_INT_CLASS,
Ming Leie6f30de2012-10-24 11:59:24 +08005170 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5171 .bInterfaceClass = USB_CLASS_HUB,
5172 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
Linus Torvalds1da177e2005-04-16 15:20:36 -07005173 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5174 .bDeviceClass = USB_CLASS_HUB},
5175 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5176 .bInterfaceClass = USB_CLASS_HUB},
5177 { } /* Terminating entry */
5178};
5179
5180MODULE_DEVICE_TABLE (usb, hub_id_table);
5181
5182static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005183 .name = "hub",
5184 .probe = hub_probe,
5185 .disconnect = hub_disconnect,
5186 .suspend = hub_suspend,
5187 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04005188 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04005189 .pre_reset = hub_pre_reset,
5190 .post_reset = hub_post_reset,
Andi Kleenc532b292010-06-01 23:04:41 +02005191 .unlocked_ioctl = hub_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07005192 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05005193 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07005194};
5195
5196int usb_hub_init(void)
5197{
Linus Torvalds1da177e2005-04-16 15:20:36 -07005198 if (usb_register(&hub_driver) < 0) {
5199 printk(KERN_ERR "%s: can't register hub driver\n",
5200 usbcore_name);
5201 return -1;
5202 }
5203
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07005204 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5205 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07005206 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005207
5208 /* Fall through if kernel_thread failed */
5209 usb_deregister(&hub_driver);
5210 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5211
5212 return -1;
5213}
5214
5215void usb_hub_cleanup(void)
5216{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07005217 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005218
5219 /*
5220 * Hub resources are freed for us by usb_deregister. It calls
5221 * usb_driver_purge on every device which in turn calls that
5222 * devices disconnect function if it is using this driver.
5223 * The hub_disconnect function takes care of releasing the
5224 * individual hub resources. -greg
5225 */
5226 usb_deregister(&hub_driver);
5227} /* usb_hub_cleanup() */
5228
Alan Sterneb764c42008-03-03 15:16:04 -05005229static int descriptors_changed(struct usb_device *udev,
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005230 struct usb_device_descriptor *old_device_descriptor,
5231 struct usb_host_bos *old_bos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005232{
Alan Sterneb764c42008-03-03 15:16:04 -05005233 int changed = 0;
5234 unsigned index;
5235 unsigned serial_len = 0;
5236 unsigned len;
5237 unsigned old_length;
5238 int length;
5239 char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005240
Alan Sterneb764c42008-03-03 15:16:04 -05005241 if (memcmp(&udev->descriptor, old_device_descriptor,
5242 sizeof(*old_device_descriptor)) != 0)
5243 return 1;
5244
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005245 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5246 return 1;
5247 if (udev->bos) {
Xenia Ragiadakoub9a10482013-08-31 04:40:49 +03005248 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5249 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005250 return 1;
Xenia Ragiadakoub9a10482013-08-31 04:40:49 +03005251 if (memcmp(udev->bos->desc, old_bos->desc, len))
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005252 return 1;
5253 }
5254
Alan Sterneb764c42008-03-03 15:16:04 -05005255 /* Since the idVendor, idProduct, and bcdDevice values in the
5256 * device descriptor haven't changed, we will assume the
5257 * Manufacturer and Product strings haven't changed either.
5258 * But the SerialNumber string could be different (e.g., a
5259 * different flash card of the same brand).
5260 */
5261 if (udev->serial)
5262 serial_len = strlen(udev->serial) + 1;
5263
5264 len = serial_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005265 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05005266 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5267 len = max(len, old_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005268 }
Alan Sterneb764c42008-03-03 15:16:04 -05005269
Oliver Neukum0cc1a512008-01-10 10:31:48 +01005270 buf = kmalloc(len, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005271 if (buf == NULL) {
5272 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5273 /* assume the worst */
5274 return 1;
5275 }
5276 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05005277 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005278 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5279 old_length);
Alan Sterneb764c42008-03-03 15:16:04 -05005280 if (length != old_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005281 dev_dbg(&udev->dev, "config index %d, error %d\n",
5282 index, length);
Alan Sterneb764c42008-03-03 15:16:04 -05005283 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005284 break;
5285 }
5286 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5287 != 0) {
5288 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
Alan Sterneb764c42008-03-03 15:16:04 -05005289 index,
5290 ((struct usb_config_descriptor *) buf)->
5291 bConfigurationValue);
5292 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005293 break;
5294 }
5295 }
Alan Sterneb764c42008-03-03 15:16:04 -05005296
5297 if (!changed && serial_len) {
5298 length = usb_string(udev, udev->descriptor.iSerialNumber,
5299 buf, serial_len);
5300 if (length + 1 != serial_len) {
5301 dev_dbg(&udev->dev, "serial string error %d\n",
5302 length);
5303 changed = 1;
5304 } else if (memcmp(buf, udev->serial, length) != 0) {
5305 dev_dbg(&udev->dev, "serial string changed\n");
5306 changed = 1;
5307 }
5308 }
5309
Linus Torvalds1da177e2005-04-16 15:20:36 -07005310 kfree(buf);
Alan Sterneb764c42008-03-03 15:16:04 -05005311 return changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005312}
5313
5314/**
Ming Lei742120c2008-06-18 22:00:29 +08005315 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
Linus Torvalds1da177e2005-04-16 15:20:36 -07005316 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5317 *
Alan Stern79efa092006-06-01 13:33:42 -04005318 * WARNING - don't use this routine to reset a composite device
5319 * (one with multiple interfaces owned by separate drivers)!
Ming Lei742120c2008-06-18 22:00:29 +08005320 * Use usb_reset_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005321 *
5322 * Do a port reset, reassign the device's address, and establish its
5323 * former operating configuration. If the reset fails, or the device's
5324 * descriptors change from their values before the reset, or the original
5325 * configuration and altsettings cannot be restored, a flag will be set
5326 * telling khubd to pretend the device has been disconnected and then
5327 * re-connected. All drivers will be unbound, and the device will be
5328 * re-enumerated and probed all over again.
5329 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005330 * Return: 0 if the reset succeeded, -ENODEV if the device has been
Linus Torvalds1da177e2005-04-16 15:20:36 -07005331 * flagged for logical disconnection, or some other negative error code
5332 * if the reset wasn't even attempted.
5333 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005334 * Note:
Dan Williams5c79a1e2014-05-20 18:09:26 -07005335 * The caller must own the device lock and the port lock, the latter is
5336 * taken by usb_reset_device(). For example, it's safe to use
5337 * usb_reset_device() from a driver probe() routine after downloading
5338 * new firmware. For calls that might not occur during probe(), drivers
5339 * should lock the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04005340 *
5341 * Locking exception: This routine may also be called from within an
5342 * autoresume handler. Such usage won't conflict with other tasks
5343 * holding the device lock because these tasks should always call
Dan Williams5c79a1e2014-05-20 18:09:26 -07005344 * usb_autopm_resume_device(), thereby preventing any unwanted
5345 * autoresume. The autoresume handler is expected to have already
5346 * acquired the port lock before calling this routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005347 */
Ming Lei742120c2008-06-18 22:00:29 +08005348static int usb_reset_and_verify_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005349{
5350 struct usb_device *parent_hdev = udev->parent;
5351 struct usb_hub *parent_hub;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005352 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005353 struct usb_device_descriptor descriptor = udev->descriptor;
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005354 struct usb_host_bos *bos;
Hans de Goede7a7b5622013-11-08 16:37:26 +01005355 int i, j, ret = 0;
Alan Stern12c3da32005-11-23 12:09:52 -05005356 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005357
5358 if (udev->state == USB_STATE_NOTATTACHED ||
5359 udev->state == USB_STATE_SUSPENDED) {
5360 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5361 udev->state);
5362 return -EINVAL;
5363 }
5364
Dan Williams5c79a1e2014-05-20 18:09:26 -07005365 if (!parent_hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005366 return -EISDIR;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005367
Lan Tianyuad493e52013-01-23 04:26:30 +08005368 parent_hub = usb_hub_to_struct_hub(parent_hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005369
Sarah Sharpdcc01c02013-09-30 17:26:29 +03005370 /* Disable USB2 hardware LPM.
5371 * It will be re-enabled by the enumeration process.
5372 */
5373 if (udev->usb2_hw_lpm_enabled == 1)
5374 usb_set_usb2_hardware_lpm(udev, 0);
5375
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005376 bos = udev->bos;
5377 udev->bos = NULL;
5378
Sarah Sharpf74631e2012-06-25 12:08:08 -07005379 /* Disable LPM and LTM while we reset the device and reinstall the alt
5380 * settings. Device-initiated LPM settings, and system exit latency
5381 * settings are cleared when the device is reset, so we have to set
5382 * them up again.
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005383 */
5384 ret = usb_unlocked_disable_lpm(udev);
5385 if (ret) {
5386 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5387 goto re_enumerate;
5388 }
Sarah Sharpf74631e2012-06-25 12:08:08 -07005389 ret = usb_disable_ltm(udev);
5390 if (ret) {
5391 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5392 __func__);
5393 goto re_enumerate;
5394 }
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005395
Linus Torvalds1da177e2005-04-16 15:20:36 -07005396 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5397
5398 /* ep0 maxpacket size may change; let the HCD know about it.
5399 * Other endpoints will be handled by re-enumeration. */
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07005400 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005401 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04005402 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005403 break;
5404 }
Alan Sternd5cbad42006-08-11 16:52:39 -04005405
Linus Torvalds1da177e2005-04-16 15:20:36 -07005406 if (ret < 0)
5407 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005408
Linus Torvalds1da177e2005-04-16 15:20:36 -07005409 /* Device might have changed firmware (DFU or similar) */
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005410 if (descriptors_changed(udev, &descriptor, bos)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005411 dev_info(&udev->dev, "device firmware changed\n");
5412 udev->descriptor = descriptor; /* for disconnect() calls */
5413 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005414 }
Alan Stern4fe03872009-02-26 10:21:02 -05005415
5416 /* Restore the device's previous configuration */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005417 if (!udev->actconfig)
5418 goto done;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005419
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005420 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005421 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5422 if (ret < 0) {
5423 dev_warn(&udev->dev,
5424 "Busted HC? Not enough HCD resources for "
5425 "old configuration.\n");
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005426 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005427 goto re_enumerate;
5428 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005429 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5430 USB_REQ_SET_CONFIGURATION, 0,
5431 udev->actconfig->desc.bConfigurationValue, 0,
5432 NULL, 0, USB_CTRL_SET_TIMEOUT);
5433 if (ret < 0) {
5434 dev_err(&udev->dev,
5435 "can't restore configuration #%d (error=%d)\n",
5436 udev->actconfig->desc.bConfigurationValue, ret);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005437 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005438 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005439 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005440 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005441 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5442
Alan Stern4fe03872009-02-26 10:21:02 -05005443 /* Put interfaces back into the same altsettings as before.
5444 * Don't bother to send the Set-Interface request for interfaces
5445 * that were already in altsetting 0; besides being unnecessary,
5446 * many devices can't handle it. Instead just reset the host-side
5447 * endpoint state.
5448 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005449 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005450 struct usb_host_config *config = udev->actconfig;
5451 struct usb_interface *intf = config->interface[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07005452 struct usb_interface_descriptor *desc;
5453
Linus Torvalds1da177e2005-04-16 15:20:36 -07005454 desc = &intf->cur_altsetting->desc;
Alan Stern4fe03872009-02-26 10:21:02 -05005455 if (desc->bAlternateSetting == 0) {
5456 usb_disable_interface(udev, intf, true);
5457 usb_enable_interface(udev, intf, true);
5458 ret = 0;
5459 } else {
Sarah Sharp04a723e2010-01-06 10:16:51 -08005460 /* Let the bandwidth allocation function know that this
5461 * device has been reset, and it will have to use
5462 * alternate setting 0 as the current alternate setting.
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005463 */
Sarah Sharp04a723e2010-01-06 10:16:51 -08005464 intf->resetting_device = 1;
Alan Stern4fe03872009-02-26 10:21:02 -05005465 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5466 desc->bAlternateSetting);
Sarah Sharp04a723e2010-01-06 10:16:51 -08005467 intf->resetting_device = 0;
Alan Stern4fe03872009-02-26 10:21:02 -05005468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005469 if (ret < 0) {
5470 dev_err(&udev->dev, "failed to restore interface %d "
5471 "altsetting %d (error=%d)\n",
5472 desc->bInterfaceNumber,
5473 desc->bAlternateSetting,
5474 ret);
5475 goto re_enumerate;
5476 }
Hans de Goede7a7b5622013-11-08 16:37:26 +01005477 /* Resetting also frees any allocated streams */
5478 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5479 intf->cur_altsetting->endpoint[j].streams = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005480 }
5481
5482done:
Sarah Sharpf74631e2012-06-25 12:08:08 -07005483 /* Now that the alt settings are re-installed, enable LTM and LPM. */
Sarah Sharpde68bab2013-09-30 17:26:28 +03005484 usb_set_usb2_hardware_lpm(udev, 1);
Alan Stern78d9a482008-06-23 16:00:40 -04005485 usb_unlocked_enable_lpm(udev);
Sarah Sharpf74631e2012-06-25 12:08:08 -07005486 usb_enable_ltm(udev);
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005487 usb_release_bos_descriptor(udev);
5488 udev->bos = bos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005489 return 0;
Matthias Beyer469271f2013-10-10 23:41:27 +02005490
Linus Torvalds1da177e2005-04-16 15:20:36 -07005491re_enumerate:
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005492 /* LPM state doesn't matter when we're about to destroy the device. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005493 hub_port_logical_disconnect(parent_hub, port1);
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005494 usb_release_bos_descriptor(udev);
5495 udev->bos = bos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005496 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005497}
5498
5499/**
5500 * usb_reset_device - warn interface drivers and perform a USB port reset
5501 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5502 *
Alan Stern79efa092006-06-01 13:33:42 -04005503 * Warns all drivers bound to registered interfaces (using their pre_reset
5504 * method), performs the port reset, and then lets the drivers know that
Ming Lei742120c2008-06-18 22:00:29 +08005505 * the reset is over (using their post_reset method).
Alan Stern79efa092006-06-01 13:33:42 -04005506 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005507 * Return: The same as for usb_reset_and_verify_device().
Alan Stern79efa092006-06-01 13:33:42 -04005508 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005509 * Note:
Alan Stern79efa092006-06-01 13:33:42 -04005510 * The caller must own the device lock. For example, it's safe to use
5511 * this from a driver probe() routine after downloading new firmware.
5512 * For calls that might not occur during probe(), drivers should lock
Ming Lei742120c2008-06-18 22:00:29 +08005513 * the device using usb_lock_device_for_reset().
Alan Stern79efa092006-06-01 13:33:42 -04005514 *
5515 * If an interface is currently being probed or disconnected, we assume
5516 * its driver knows how to handle resets. For all other interfaces,
5517 * if the driver doesn't have pre_reset and post_reset methods then
5518 * we attempt to unbind it and rebind afterward.
Alan Stern79efa092006-06-01 13:33:42 -04005519 */
Ming Lei742120c2008-06-18 22:00:29 +08005520int usb_reset_device(struct usb_device *udev)
Alan Stern79efa092006-06-01 13:33:42 -04005521{
5522 int ret;
Alan Stern852c4b42007-12-03 15:44:29 -05005523 int i;
Ming Lei4d769de2013-02-22 16:34:22 -08005524 unsigned int noio_flag;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005525 struct usb_port *port_dev;
Alan Stern79efa092006-06-01 13:33:42 -04005526 struct usb_host_config *config = udev->actconfig;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005527 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
Alan Stern79efa092006-06-01 13:33:42 -04005528
5529 if (udev->state == USB_STATE_NOTATTACHED ||
5530 udev->state == USB_STATE_SUSPENDED) {
5531 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5532 udev->state);
5533 return -EINVAL;
5534 }
5535
Dan Williams5c79a1e2014-05-20 18:09:26 -07005536 if (!udev->parent) {
5537 /* this requires hcd-specific logic; see ohci_restart() */
5538 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5539 return -EISDIR;
5540 }
5541
5542 port_dev = hub->ports[udev->portnum - 1];
5543
Ming Lei4d769de2013-02-22 16:34:22 -08005544 /*
5545 * Don't allocate memory with GFP_KERNEL in current
5546 * context to avoid possible deadlock if usb mass
5547 * storage interface or usbnet interface(iSCSI case)
5548 * is included in current configuration. The easist
5549 * approach is to do it for every device reset,
5550 * because the device 'memalloc_noio' flag may have
5551 * not been set before reseting the usb device.
5552 */
5553 noio_flag = memalloc_noio_save();
5554
Alan Stern645daaa2006-08-30 15:47:02 -04005555 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05005556 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04005557
Alan Stern79efa092006-06-01 13:33:42 -04005558 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005559 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005560 struct usb_interface *cintf = config->interface[i];
5561 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005562 int unbind = 0;
Alan Stern852c4b42007-12-03 15:44:29 -05005563
5564 if (cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005565 drv = to_usb_driver(cintf->dev.driver);
Alan Stern78d9a482008-06-23 16:00:40 -04005566 if (drv->pre_reset && drv->post_reset)
5567 unbind = (drv->pre_reset)(cintf);
5568 else if (cintf->condition ==
5569 USB_INTERFACE_BOUND)
5570 unbind = 1;
5571 if (unbind)
5572 usb_forced_unbind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04005573 }
5574 }
5575 }
5576
Dan Williams5c79a1e2014-05-20 18:09:26 -07005577 usb_lock_port(port_dev);
Ming Lei742120c2008-06-18 22:00:29 +08005578 ret = usb_reset_and_verify_device(udev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005579 usb_unlock_port(port_dev);
Alan Stern79efa092006-06-01 13:33:42 -04005580
5581 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005582 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005583 struct usb_interface *cintf = config->interface[i];
5584 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005585 int rebind = cintf->needs_binding;
Alan Stern852c4b42007-12-03 15:44:29 -05005586
Alan Stern78d9a482008-06-23 16:00:40 -04005587 if (!rebind && cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005588 drv = to_usb_driver(cintf->dev.driver);
5589 if (drv->post_reset)
Alan Stern78d9a482008-06-23 16:00:40 -04005590 rebind = (drv->post_reset)(cintf);
5591 else if (cintf->condition ==
5592 USB_INTERFACE_BOUND)
5593 rebind = 1;
Alan Stern6aec0442014-03-12 11:30:38 -04005594 if (rebind)
5595 cintf->needs_binding = 1;
Alan Stern79efa092006-06-01 13:33:42 -04005596 }
Alan Stern79efa092006-06-01 13:33:42 -04005597 }
Alan Stern6aec0442014-03-12 11:30:38 -04005598 usb_unbind_and_rebind_marked_interfaces(udev);
Alan Stern79efa092006-06-01 13:33:42 -04005599 }
5600
Alan Stern94fcda12006-11-20 11:38:46 -05005601 usb_autosuspend_device(udev);
Ming Lei4d769de2013-02-22 16:34:22 -08005602 memalloc_noio_restore(noio_flag);
Alan Stern79efa092006-06-01 13:33:42 -04005603 return ret;
5604}
Ming Lei742120c2008-06-18 22:00:29 +08005605EXPORT_SYMBOL_GPL(usb_reset_device);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005606
5607
5608/**
5609 * usb_queue_reset_device - Reset a USB device from an atomic context
5610 * @iface: USB interface belonging to the device to reset
5611 *
5612 * This function can be used to reset a USB device from an atomic
5613 * context, where usb_reset_device() won't work (as it blocks).
5614 *
5615 * Doing a reset via this method is functionally equivalent to calling
5616 * usb_reset_device(), except for the fact that it is delayed to a
5617 * workqueue. This means that any drivers bound to other interfaces
5618 * might be unbound, as well as users from usbfs in user space.
5619 *
5620 * Corner cases:
5621 *
5622 * - Scheduling two resets at the same time from two different drivers
5623 * attached to two different interfaces of the same device is
5624 * possible; depending on how the driver attached to each interface
5625 * handles ->pre_reset(), the second reset might happen or not.
5626 *
5627 * - If a driver is unbound and it had a pending reset, the reset will
5628 * be cancelled.
5629 *
5630 * - This function can be called during .probe() or .disconnect()
5631 * times. On return from .disconnect(), any pending resets will be
5632 * cancelled.
5633 *
5634 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5635 * does its own.
5636 *
5637 * NOTE: We don't do any reference count tracking because it is not
5638 * needed. The lifecycle of the work_struct is tied to the
5639 * usb_interface. Before destroying the interface we cancel the
5640 * work_struct, so the fact that work_struct is queued and or
5641 * running means the interface (and thus, the device) exist and
5642 * are referenced.
5643 */
5644void usb_queue_reset_device(struct usb_interface *iface)
5645{
5646 schedule_work(&iface->reset_ws);
5647}
5648EXPORT_SYMBOL_GPL(usb_queue_reset_device);
Lan Tianyuff823c792012-09-05 13:44:32 +08005649
5650/**
5651 * usb_hub_find_child - Get the pointer of child device
5652 * attached to the port which is specified by @port1.
5653 * @hdev: USB device belonging to the usb hub
5654 * @port1: port num to indicate which port the child device
5655 * is attached to.
5656 *
5657 * USB drivers call this function to get hub's child device
5658 * pointer.
5659 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005660 * Return: %NULL if input param is invalid and
Lan Tianyuff823c792012-09-05 13:44:32 +08005661 * child's usb_device pointer if non-NULL.
5662 */
5663struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5664 int port1)
5665{
Lan Tianyuad493e52013-01-23 04:26:30 +08005666 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyuff823c792012-09-05 13:44:32 +08005667
5668 if (port1 < 1 || port1 > hdev->maxchild)
5669 return NULL;
5670 return hub->ports[port1 - 1]->child;
5671}
5672EXPORT_SYMBOL_GPL(usb_hub_find_child);
Lan Tianyud5575422012-09-05 13:44:33 +08005673
Lan Tianyud2123fd2013-01-21 22:18:00 +08005674void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5675 struct usb_hub_descriptor *desc)
5676{
Dan Williamsd99f6b42014-05-20 18:08:17 -07005677 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyud2123fd2013-01-21 22:18:00 +08005678 enum usb_port_connect_type connect_type;
5679 int i;
5680
Dan Williamsd99f6b42014-05-20 18:08:17 -07005681 if (!hub)
5682 return;
5683
Lan Tianyud2123fd2013-01-21 22:18:00 +08005684 if (!hub_is_superspeed(hdev)) {
5685 for (i = 1; i <= hdev->maxchild; i++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005686 struct usb_port *port_dev = hub->ports[i - 1];
Lan Tianyud2123fd2013-01-21 22:18:00 +08005687
Dan Williamsd99f6b42014-05-20 18:08:17 -07005688 connect_type = port_dev->connect_type;
Lan Tianyud2123fd2013-01-21 22:18:00 +08005689 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5690 u8 mask = 1 << (i%8);
5691
5692 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005693 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
Lan Tianyud2123fd2013-01-21 22:18:00 +08005694 desc->u.hs.DeviceRemovable[i/8] |= mask;
5695 }
5696 }
5697 }
5698 } else {
5699 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5700
5701 for (i = 1; i <= hdev->maxchild; i++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005702 struct usb_port *port_dev = hub->ports[i - 1];
Lan Tianyud2123fd2013-01-21 22:18:00 +08005703
Dan Williamsd99f6b42014-05-20 18:08:17 -07005704 connect_type = port_dev->connect_type;
Lan Tianyud2123fd2013-01-21 22:18:00 +08005705 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5706 u16 mask = 1 << i;
5707
5708 if (!(port_removable & mask)) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005709 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
Lan Tianyud2123fd2013-01-21 22:18:00 +08005710 port_removable |= mask;
5711 }
5712 }
5713 }
5714
5715 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5716 }
5717}
5718
Lan Tianyud5575422012-09-05 13:44:33 +08005719#ifdef CONFIG_ACPI
5720/**
5721 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5722 * @hdev: USB device belonging to the usb hub
5723 * @port1: port num of the port
5724 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005725 * Return: Port's acpi handle if successful, %NULL if params are
5726 * invalid.
Lan Tianyud5575422012-09-05 13:44:33 +08005727 */
5728acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5729 int port1)
5730{
Lan Tianyuad493e52013-01-23 04:26:30 +08005731 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyud5575422012-09-05 13:44:33 +08005732
Mathias Nyman413412612013-06-18 17:28:48 +03005733 if (!hub)
5734 return NULL;
5735
Rafael J. Wysocki3a83f992013-11-14 23:17:21 +01005736 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
Lan Tianyud5575422012-09-05 13:44:33 +08005737}
5738#endif