Commit | Line | Data |
---|---|---|
aa1f3bb5 | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 LT |
2 | /* |
3 | * USB hub driver. | |
4 | * | |
5 | * (C) Copyright 1999 Linus Torvalds | |
6 | * (C) Copyright 1999 Johannes Erdfelt | |
7 | * (C) Copyright 1999 Gregory P. Smith | |
8 | * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au) | |
9 | * | |
b65fba3d | 10 | * Released under the GPLv2 only. |
1da177e4 LT |
11 | */ |
12 | ||
1da177e4 LT |
13 | #include <linux/kernel.h> |
14 | #include <linux/errno.h> | |
15 | #include <linux/module.h> | |
16 | #include <linux/moduleparam.h> | |
17 | #include <linux/completion.h> | |
5b3cc15a | 18 | #include <linux/sched/mm.h> |
1da177e4 LT |
19 | #include <linux/list.h> |
20 | #include <linux/slab.h> | |
95d23dc2 | 21 | #include <linux/kcov.h> |
1da177e4 LT |
22 | #include <linux/ioctl.h> |
23 | #include <linux/usb.h> | |
24 | #include <linux/usbdevice_fs.h> | |
27729aad | 25 | #include <linux/usb/hcd.h> |
3a6bf4a0 | 26 | #include <linux/usb/onboard_hub.h> |
925aa46b | 27 | #include <linux/usb/otg.h> |
93362a87 | 28 | #include <linux/usb/quirks.h> |
32a69589 | 29 | #include <linux/workqueue.h> |
4186ecf8 | 30 | #include <linux/mutex.h> |
b04b3156 | 31 | #include <linux/random.h> |
ad493e5e | 32 | #include <linux/pm_qos.h> |
201af55d | 33 | #include <linux/kobject.h> |
1da177e4 | 34 | |
0299809b | 35 | #include <linux/bitfield.h> |
7c0f6ba6 | 36 | #include <linux/uaccess.h> |
1da177e4 LT |
37 | #include <asm/byteorder.h> |
38 | ||
6e30d7cb | 39 | #include "hub.h" |
f8f02d5c | 40 | #include "otg_productlist.h" |
1da177e4 | 41 | |
e6f30dea | 42 | #define USB_VENDOR_GENESYS_LOGIC 0x05e3 |
1208f9e1 | 43 | #define USB_VENDOR_SMSC 0x0424 |
76e1ef1d | 44 | #define USB_PRODUCT_USB5534B 0x5534 |
a7d8d1c7 AL |
45 | #define USB_VENDOR_CYPRESS 0x04b4 |
46 | #define USB_PRODUCT_CY7C65632 0x6570 | |
7171b0e2 FS |
47 | #define USB_VENDOR_TEXAS_INSTRUMENTS 0x0451 |
48 | #define USB_PRODUCT_TUSB8041_USB3 0x8140 | |
49 | #define USB_PRODUCT_TUSB8041_USB2 0x8142 | |
e6f30dea | 50 | #define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01 |
1208f9e1 | 51 | #define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02 |
e6f30dea | 52 | |
886ee36e FB |
53 | #define USB_TP_TRANSMISSION_DELAY 40 /* ns */ |
54 | #define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */ | |
1bf2761c | 55 | #define USB_PING_RESPONSE_TIME 400 /* ns */ |
886ee36e | 56 | |
fa286188 | 57 | /* Protect struct usb_device->state and ->children members |
9ad3d6cc | 58 | * Note: Both are also protected by ->dev.sem, except that ->state can |
1da177e4 LT |
59 | * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */ |
60 | static DEFINE_SPINLOCK(device_state_lock); | |
61 | ||
32a69589 PM |
62 | /* workqueue to process hub events */ |
63 | static struct workqueue_struct *hub_wq; | |
64 | static void hub_event(struct work_struct *work); | |
1da177e4 | 65 | |
d8521afe DW |
66 | /* synchronize hub-port add/remove and peering operations */ |
67 | DEFINE_MUTEX(usb_port_peer_mutex); | |
68 | ||
1da177e4 | 69 | /* cycle leds on hubs that aren't blinking for attention */ |
a44007a4 | 70 | static bool blinkenlights; |
166b8639 CM |
71 | module_param(blinkenlights, bool, S_IRUGO); |
72 | MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs"); | |
1da177e4 | 73 | |
fd7c519d JK |
74 | /* |
75 | * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about | |
76 | * 10 seconds to send reply for the initial 64-byte descriptor request. | |
77 | */ | |
78 | /* define initial 64-byte descriptor request timeout in milliseconds */ | |
79 | static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT; | |
80 | module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR); | |
b9cef6c3 WF |
81 | MODULE_PARM_DESC(initial_descriptor_timeout, |
82 | "initial 64-byte descriptor request timeout in milliseconds " | |
83 | "(default 5000 - 5.0 seconds)"); | |
fd7c519d | 84 | |
1da177e4 LT |
85 | /* |
86 | * As of 2.6.10 we introduce a new USB device initialization scheme which | |
87 | * closely resembles the way Windows works. Hopefully it will be compatible | |
88 | * with a wider range of devices than the old scheme. However some previously | |
89 | * working devices may start giving rise to "device not accepting address" | |
90 | * errors; if that happens the user can try the old scheme by adjusting the | |
91 | * following module parameters. | |
92 | * | |
93 | * For maximum flexibility there are two boolean parameters to control the | |
94 | * hub driver's behavior. On the first initialization attempt, if the | |
95 | * "old_scheme_first" parameter is set then the old scheme will be used, | |
96 | * otherwise the new scheme is used. If that fails and "use_both_schemes" | |
97 | * is set, then the driver will make another attempt, using the other scheme. | |
98 | */ | |
a44007a4 | 99 | static bool old_scheme_first; |
1da177e4 LT |
100 | module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR); |
101 | MODULE_PARM_DESC(old_scheme_first, | |
102 | "start with the old device initialization scheme"); | |
103 | ||
b9cf2cb5 | 104 | static bool use_both_schemes = true; |
1da177e4 LT |
105 | module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR); |
106 | MODULE_PARM_DESC(use_both_schemes, | |
107 | "try the other device initialization scheme if the " | |
108 | "first one fails"); | |
109 | ||
32fe0198 AS |
110 | /* Mutual exclusion for EHCI CF initialization. This interferes with |
111 | * port reset on some companion controllers. | |
112 | */ | |
113 | DECLARE_RWSEM(ehci_cf_port_reset_rwsem); | |
114 | EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem); | |
115 | ||
ad493e5e | 116 | #define HUB_DEBOUNCE_TIMEOUT 2000 |
948fea37 AS |
117 | #define HUB_DEBOUNCE_STEP 25 |
118 | #define HUB_DEBOUNCE_STABLE 100 | |
119 | ||
32a69589 | 120 | static void hub_release(struct kref *kref); |
742120c6 | 121 | static int usb_reset_and_verify_device(struct usb_device *udev); |
3bc02bce | 122 | static int hub_port_disable(struct usb_hub *hub, int port1, int set_state); |
4fdc1790 JMG |
123 | static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1, |
124 | u16 portstatus); | |
742120c6 | 125 | |
131dec34 | 126 | static inline char *portspeed(struct usb_hub *hub, int portstatus) |
1da177e4 | 127 | { |
d64aab0c ON |
128 | if (hub_is_superspeedplus(hub->hdev)) |
129 | return "10.0 Gb/s"; | |
131dec34 SS |
130 | if (hub_is_superspeed(hub->hdev)) |
131 | return "5.0 Gb/s"; | |
288ead45 | 132 | if (portstatus & USB_PORT_STAT_HIGH_SPEED) |
469271f8 | 133 | return "480 Mb/s"; |
288ead45 | 134 | else if (portstatus & USB_PORT_STAT_LOW_SPEED) |
1da177e4 LT |
135 | return "1.5 Mb/s"; |
136 | else | |
137 | return "12 Mb/s"; | |
138 | } | |
1da177e4 LT |
139 | |
140 | /* Note that hdev or one of its children must be locked! */ | |
ad493e5e | 141 | struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev) |
1da177e4 | 142 | { |
ff823c79 | 143 | if (!hdev || !hdev->actconfig || !hdev->maxchild) |
25118084 | 144 | return NULL; |
1da177e4 LT |
145 | return usb_get_intfdata(hdev->actconfig->interface[0]); |
146 | } | |
147 | ||
2d2a3167 | 148 | int usb_device_supports_lpm(struct usb_device *udev) |
d9b2099c | 149 | { |
ad87e032 AS |
150 | /* Some devices have trouble with LPM */ |
151 | if (udev->quirks & USB_QUIRK_NO_LPM) | |
152 | return 0; | |
153 | ||
d9b2099c SS |
154 | /* USB 2.1 (and greater) devices indicate LPM support through |
155 | * their USB 2.0 Extended Capabilities BOS descriptor. | |
156 | */ | |
a8425292 | 157 | if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) { |
d9b2099c SS |
158 | if (udev->bos->ext_cap && |
159 | (USB_LPM_SUPPORT & | |
160 | le32_to_cpu(udev->bos->ext_cap->bmAttributes))) | |
161 | return 1; | |
162 | return 0; | |
163 | } | |
51e0a012 | 164 | |
25cd2882 SS |
165 | /* |
166 | * According to the USB 3.0 spec, all USB 3.0 devices must support LPM. | |
167 | * However, there are some that don't, and they set the U1/U2 exit | |
168 | * latencies to zero. | |
51e0a012 SS |
169 | */ |
170 | if (!udev->bos->ss_cap) { | |
25cd2882 | 171 | dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n"); |
51e0a012 SS |
172 | return 0; |
173 | } | |
51e0a012 | 174 | |
25cd2882 SS |
175 | if (udev->bos->ss_cap->bU1devExitLat == 0 && |
176 | udev->bos->ss_cap->bU2DevExitLat == 0) { | |
177 | if (udev->parent) | |
178 | dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n"); | |
179 | else | |
180 | dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n"); | |
51e0a012 SS |
181 | return 0; |
182 | } | |
51e0a012 | 183 | |
25cd2882 SS |
184 | if (!udev->parent || udev->parent->lpm_capable) |
185 | return 1; | |
d9b2099c SS |
186 | return 0; |
187 | } | |
188 | ||
51e0a012 | 189 | /* |
1bf2761c MN |
190 | * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from |
191 | * U1/U2, send a PING to the device and receive a PING_RESPONSE. | |
192 | * See USB 3.1 section C.1.5.2 | |
51e0a012 SS |
193 | */ |
194 | static void usb_set_lpm_mel(struct usb_device *udev, | |
195 | struct usb3_lpm_parameters *udev_lpm_params, | |
196 | unsigned int udev_exit_latency, | |
197 | struct usb_hub *hub, | |
198 | struct usb3_lpm_parameters *hub_lpm_params, | |
199 | unsigned int hub_exit_latency) | |
200 | { | |
201 | unsigned int total_mel; | |
51e0a012 SS |
202 | |
203 | /* | |
1bf2761c MN |
204 | * tMEL1. time to transition path from host to device into U0. |
205 | * MEL for parent already contains the delay up to parent, so only add | |
206 | * the exit latency for the last link (pick the slower exit latency), | |
207 | * and the hub header decode latency. See USB 3.1 section C 2.2.1 | |
208 | * Store MEL in nanoseconds | |
51e0a012 SS |
209 | */ |
210 | total_mel = hub_lpm_params->mel + | |
1bf2761c MN |
211 | max(udev_exit_latency, hub_exit_latency) * 1000 + |
212 | hub->descriptor->u.ss.bHubHdrDecLat * 100; | |
51e0a012 SS |
213 | |
214 | /* | |
1bf2761c MN |
215 | * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for |
216 | * each link + wHubDelay for each hub. Add only for last link. | |
217 | * tMEL4, the time for PING_RESPONSE to traverse upstream is similar. | |
218 | * Multiply by 2 to include it as well. | |
51e0a012 | 219 | */ |
1bf2761c MN |
220 | total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) + |
221 | USB_TP_TRANSMISSION_DELAY) * 2; | |
222 | ||
223 | /* | |
224 | * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE | |
225 | * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4 | |
226 | * to cover the delay if the PING_RESPONSE is queued behind a Max Packet | |
227 | * Size DP. | |
228 | * Note these delays should be added only once for the entire path, so | |
229 | * add them to the MEL of the device connected to the roothub. | |
230 | */ | |
231 | if (!hub->hdev->parent) | |
232 | total_mel += USB_PING_RESPONSE_TIME + 2100; | |
51e0a012 SS |
233 | |
234 | udev_lpm_params->mel = total_mel; | |
235 | } | |
236 | ||
237 | /* | |
238 | * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate | |
239 | * a transition from either U1 or U2. | |
240 | */ | |
241 | static void usb_set_lpm_pel(struct usb_device *udev, | |
242 | struct usb3_lpm_parameters *udev_lpm_params, | |
243 | unsigned int udev_exit_latency, | |
244 | struct usb_hub *hub, | |
245 | struct usb3_lpm_parameters *hub_lpm_params, | |
246 | unsigned int hub_exit_latency, | |
247 | unsigned int port_to_port_exit_latency) | |
248 | { | |
249 | unsigned int first_link_pel; | |
250 | unsigned int hub_pel; | |
251 | ||
252 | /* | |
253 | * First, the device sends an LFPS to transition the link between the | |
254 | * device and the parent hub into U0. The exit latency is the bigger of | |
255 | * the device exit latency or the hub exit latency. | |
256 | */ | |
257 | if (udev_exit_latency > hub_exit_latency) | |
258 | first_link_pel = udev_exit_latency * 1000; | |
259 | else | |
260 | first_link_pel = hub_exit_latency * 1000; | |
261 | ||
262 | /* | |
263 | * When the hub starts to receive the LFPS, there is a slight delay for | |
264 | * it to figure out that one of the ports is sending an LFPS. Then it | |
265 | * will forward the LFPS to its upstream link. The exit latency is the | |
266 | * delay, plus the PEL that we calculated for this hub. | |
267 | */ | |
268 | hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel; | |
269 | ||
270 | /* | |
271 | * According to figure C-7 in the USB 3.0 spec, the PEL for this device | |
272 | * is the greater of the two exit latencies. | |
273 | */ | |
274 | if (first_link_pel > hub_pel) | |
275 | udev_lpm_params->pel = first_link_pel; | |
276 | else | |
277 | udev_lpm_params->pel = hub_pel; | |
278 | } | |
279 | ||
280 | /* | |
281 | * Set the System Exit Latency (SEL) to indicate the total worst-case time from | |
282 | * when a device initiates a transition to U0, until when it will receive the | |
283 | * first packet from the host controller. | |
284 | * | |
285 | * Section C.1.5.1 describes the four components to this: | |
286 | * - t1: device PEL | |
287 | * - t2: time for the ERDY to make it from the device to the host. | |
288 | * - t3: a host-specific delay to process the ERDY. | |
289 | * - t4: time for the packet to make it from the host to the device. | |
290 | * | |
291 | * t3 is specific to both the xHCI host and the platform the host is integrated | |
292 | * into. The Intel HW folks have said it's negligible, FIXME if a different | |
293 | * vendor says otherwise. | |
294 | */ | |
295 | static void usb_set_lpm_sel(struct usb_device *udev, | |
296 | struct usb3_lpm_parameters *udev_lpm_params) | |
297 | { | |
298 | struct usb_device *parent; | |
299 | unsigned int num_hubs; | |
300 | unsigned int total_sel; | |
301 | ||
302 | /* t1 = device PEL */ | |
303 | total_sel = udev_lpm_params->pel; | |
304 | /* How many external hubs are in between the device & the root port. */ | |
305 | for (parent = udev->parent, num_hubs = 0; parent->parent; | |
306 | parent = parent->parent) | |
307 | num_hubs++; | |
308 | /* t2 = 2.1us + 250ns * (num_hubs - 1) */ | |
309 | if (num_hubs > 0) | |
310 | total_sel += 2100 + 250 * (num_hubs - 1); | |
311 | ||
312 | /* t4 = 250ns * num_hubs */ | |
313 | total_sel += 250 * num_hubs; | |
314 | ||
315 | udev_lpm_params->sel = total_sel; | |
316 | } | |
317 | ||
318 | static void usb_set_lpm_parameters(struct usb_device *udev) | |
319 | { | |
320 | struct usb_hub *hub; | |
321 | unsigned int port_to_port_delay; | |
322 | unsigned int udev_u1_del; | |
323 | unsigned int udev_u2_del; | |
324 | unsigned int hub_u1_del; | |
325 | unsigned int hub_u2_del; | |
326 | ||
8a1b2725 | 327 | if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER) |
51e0a012 SS |
328 | return; |
329 | ||
ad493e5e | 330 | hub = usb_hub_to_struct_hub(udev->parent); |
51e0a012 SS |
331 | /* It doesn't take time to transition the roothub into U0, since it |
332 | * doesn't have an upstream link. | |
333 | */ | |
334 | if (!hub) | |
335 | return; | |
336 | ||
337 | udev_u1_del = udev->bos->ss_cap->bU1devExitLat; | |
4d967995 | 338 | udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat); |
51e0a012 | 339 | hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat; |
4d967995 | 340 | hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat); |
51e0a012 SS |
341 | |
342 | usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del, | |
343 | hub, &udev->parent->u1_params, hub_u1_del); | |
344 | ||
345 | usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del, | |
346 | hub, &udev->parent->u2_params, hub_u2_del); | |
347 | ||
348 | /* | |
349 | * Appendix C, section C.2.2.2, says that there is a slight delay from | |
350 | * when the parent hub notices the downstream port is trying to | |
351 | * transition to U0 to when the hub initiates a U0 transition on its | |
352 | * upstream port. The section says the delays are tPort2PortU1EL and | |
353 | * tPort2PortU2EL, but it doesn't define what they are. | |
354 | * | |
355 | * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking | |
356 | * about the same delays. Use the maximum delay calculations from those | |
357 | * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For | |
358 | * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I | |
359 | * assume the device exit latencies they are talking about are the hub | |
360 | * exit latencies. | |
361 | * | |
362 | * What do we do if the U2 exit latency is less than the U1 exit | |
363 | * latency? It's possible, although not likely... | |
364 | */ | |
365 | port_to_port_delay = 1; | |
366 | ||
367 | usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del, | |
368 | hub, &udev->parent->u1_params, hub_u1_del, | |
369 | port_to_port_delay); | |
370 | ||
371 | if (hub_u2_del > hub_u1_del) | |
372 | port_to_port_delay = 1 + hub_u2_del - hub_u1_del; | |
373 | else | |
374 | port_to_port_delay = 1 + hub_u1_del; | |
375 | ||
376 | usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del, | |
377 | hub, &udev->parent->u2_params, hub_u2_del, | |
378 | port_to_port_delay); | |
379 | ||
380 | /* Now that we've got PEL, calculate SEL. */ | |
381 | usb_set_lpm_sel(udev, &udev->u1_params); | |
382 | usb_set_lpm_sel(udev, &udev->u2_params); | |
383 | } | |
384 | ||
1da177e4 | 385 | /* USB 2.0 spec Section 11.24.4.5 */ |
bec444cd JH |
386 | static int get_hub_descriptor(struct usb_device *hdev, |
387 | struct usb_hub_descriptor *desc) | |
1da177e4 | 388 | { |
dbe79bbe JY |
389 | int i, ret, size; |
390 | unsigned dtype; | |
391 | ||
392 | if (hub_is_superspeed(hdev)) { | |
393 | dtype = USB_DT_SS_HUB; | |
394 | size = USB_DT_SS_HUB_SIZE; | |
395 | } else { | |
396 | dtype = USB_DT_HUB; | |
397 | size = sizeof(struct usb_hub_descriptor); | |
398 | } | |
1da177e4 LT |
399 | |
400 | for (i = 0; i < 3; i++) { | |
401 | ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), | |
402 | USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB, | |
bec444cd | 403 | dtype << 8, 0, desc, size, |
1da177e4 | 404 | USB_CTRL_GET_TIMEOUT); |
2c25a2c8 JH |
405 | if (hub_is_superspeed(hdev)) { |
406 | if (ret == size) | |
407 | return ret; | |
bec444cd JH |
408 | } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) { |
409 | /* Make sure we have the DeviceRemovable field. */ | |
410 | size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1; | |
411 | if (ret < size) | |
412 | return -EMSGSIZE; | |
1da177e4 | 413 | return ret; |
2c25a2c8 | 414 | } |
1da177e4 LT |
415 | } |
416 | return -EINVAL; | |
417 | } | |
418 | ||
419 | /* | |
420 | * USB 2.0 spec Section 11.24.2.1 | |
421 | */ | |
422 | static int clear_hub_feature(struct usb_device *hdev, int feature) | |
423 | { | |
1afe33a7 ON |
424 | return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
425 | USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000); | |
1da177e4 LT |
426 | } |
427 | ||
428 | /* | |
429 | * USB 2.0 spec Section 11.24.2.2 | |
430 | */ | |
ad493e5e | 431 | int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature) |
1da177e4 | 432 | { |
1afe33a7 ON |
433 | return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
434 | USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1, | |
435 | NULL, 0, 1000); | |
1da177e4 LT |
436 | } |
437 | ||
438 | /* | |
439 | * USB 2.0 spec Section 11.24.2.13 | |
440 | */ | |
441 | static int set_port_feature(struct usb_device *hdev, int port1, int feature) | |
442 | { | |
1afe33a7 ON |
443 | return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
444 | USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1, | |
445 | NULL, 0, 1000); | |
1da177e4 LT |
446 | } |
447 | ||
d99f6b41 DW |
448 | static char *to_led_name(int selector) |
449 | { | |
450 | switch (selector) { | |
451 | case HUB_LED_AMBER: | |
452 | return "amber"; | |
453 | case HUB_LED_GREEN: | |
454 | return "green"; | |
455 | case HUB_LED_OFF: | |
456 | return "off"; | |
457 | case HUB_LED_AUTO: | |
458 | return "auto"; | |
459 | default: | |
460 | return "??"; | |
461 | } | |
462 | } | |
463 | ||
1da177e4 LT |
464 | /* |
465 | * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7 | |
466 | * for info about using port indicators | |
467 | */ | |
d99f6b41 | 468 | static void set_port_led(struct usb_hub *hub, int port1, int selector) |
1da177e4 | 469 | { |
d99f6b41 DW |
470 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
471 | int status; | |
472 | ||
473 | status = set_port_feature(hub->hdev, (selector << 8) | port1, | |
1da177e4 | 474 | USB_PORT_FEAT_INDICATOR); |
d99f6b41 DW |
475 | dev_dbg(&port_dev->dev, "indicator %s status %d\n", |
476 | to_led_name(selector), status); | |
1da177e4 LT |
477 | } |
478 | ||
479 | #define LED_CYCLE_PERIOD ((2*HZ)/3) | |
480 | ||
166b8639 | 481 | static void led_work(struct work_struct *work) |
1da177e4 | 482 | { |
c4028958 DH |
483 | struct usb_hub *hub = |
484 | container_of(work, struct usb_hub, leds.work); | |
1da177e4 LT |
485 | struct usb_device *hdev = hub->hdev; |
486 | unsigned i; | |
487 | unsigned changed = 0; | |
488 | int cursor = -1; | |
489 | ||
490 | if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing) | |
491 | return; | |
492 | ||
3bbc47d8 | 493 | for (i = 0; i < hdev->maxchild; i++) { |
1da177e4 LT |
494 | unsigned selector, mode; |
495 | ||
496 | /* 30%-50% duty cycle */ | |
497 | ||
498 | switch (hub->indicator[i]) { | |
499 | /* cycle marker */ | |
500 | case INDICATOR_CYCLE: | |
501 | cursor = i; | |
502 | selector = HUB_LED_AUTO; | |
503 | mode = INDICATOR_AUTO; | |
504 | break; | |
505 | /* blinking green = sw attention */ | |
506 | case INDICATOR_GREEN_BLINK: | |
507 | selector = HUB_LED_GREEN; | |
508 | mode = INDICATOR_GREEN_BLINK_OFF; | |
509 | break; | |
510 | case INDICATOR_GREEN_BLINK_OFF: | |
511 | selector = HUB_LED_OFF; | |
512 | mode = INDICATOR_GREEN_BLINK; | |
513 | break; | |
514 | /* blinking amber = hw attention */ | |
515 | case INDICATOR_AMBER_BLINK: | |
516 | selector = HUB_LED_AMBER; | |
517 | mode = INDICATOR_AMBER_BLINK_OFF; | |
518 | break; | |
519 | case INDICATOR_AMBER_BLINK_OFF: | |
520 | selector = HUB_LED_OFF; | |
521 | mode = INDICATOR_AMBER_BLINK; | |
522 | break; | |
523 | /* blink green/amber = reserved */ | |
524 | case INDICATOR_ALT_BLINK: | |
525 | selector = HUB_LED_GREEN; | |
526 | mode = INDICATOR_ALT_BLINK_OFF; | |
527 | break; | |
528 | case INDICATOR_ALT_BLINK_OFF: | |
529 | selector = HUB_LED_AMBER; | |
530 | mode = INDICATOR_ALT_BLINK; | |
531 | break; | |
532 | default: | |
533 | continue; | |
534 | } | |
535 | if (selector != HUB_LED_AUTO) | |
536 | changed = 1; | |
537 | set_port_led(hub, i + 1, selector); | |
538 | hub->indicator[i] = mode; | |
539 | } | |
540 | if (!changed && blinkenlights) { | |
541 | cursor++; | |
3bbc47d8 | 542 | cursor %= hdev->maxchild; |
1da177e4 LT |
543 | set_port_led(hub, cursor + 1, HUB_LED_GREEN); |
544 | hub->indicator[cursor] = INDICATOR_CYCLE; | |
545 | changed++; | |
546 | } | |
547 | if (changed) | |
22f6a0f0 SD |
548 | queue_delayed_work(system_power_efficient_wq, |
549 | &hub->leds, LED_CYCLE_PERIOD); | |
1da177e4 LT |
550 | } |
551 | ||
552 | /* use a short timeout for hub/port status fetches */ | |
553 | #define USB_STS_TIMEOUT 1000 | |
554 | #define USB_STS_RETRIES 5 | |
555 | ||
556 | /* | |
557 | * USB 2.0 spec Section 11.24.2.6 | |
558 | */ | |
559 | static int get_hub_status(struct usb_device *hdev, | |
560 | struct usb_hub_status *data) | |
561 | { | |
562 | int i, status = -ETIMEDOUT; | |
563 | ||
3824c1dd LP |
564 | for (i = 0; i < USB_STS_RETRIES && |
565 | (status == -ETIMEDOUT || status == -EPIPE); i++) { | |
1da177e4 LT |
566 | status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), |
567 | USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0, | |
568 | data, sizeof(*data), USB_STS_TIMEOUT); | |
569 | } | |
570 | return status; | |
571 | } | |
572 | ||
573 | /* | |
574 | * USB 2.0 spec Section 11.24.2.7 | |
0cdd49a1 | 575 | * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6 |
1da177e4 LT |
576 | */ |
577 | static int get_port_status(struct usb_device *hdev, int port1, | |
0cdd49a1 | 578 | void *data, u16 value, u16 length) |
1da177e4 LT |
579 | { |
580 | int i, status = -ETIMEDOUT; | |
581 | ||
3824c1dd LP |
582 | for (i = 0; i < USB_STS_RETRIES && |
583 | (status == -ETIMEDOUT || status == -EPIPE); i++) { | |
1da177e4 | 584 | status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), |
0cdd49a1 MN |
585 | USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value, |
586 | port1, data, length, USB_STS_TIMEOUT); | |
1da177e4 LT |
587 | } |
588 | return status; | |
589 | } | |
590 | ||
0cdd49a1 MN |
591 | static int hub_ext_port_status(struct usb_hub *hub, int port1, int type, |
592 | u16 *status, u16 *change, u32 *ext_status) | |
3eb14915 AS |
593 | { |
594 | int ret; | |
0cdd49a1 MN |
595 | int len = 4; |
596 | ||
597 | if (type != HUB_PORT_STATUS) | |
598 | len = 8; | |
3eb14915 AS |
599 | |
600 | mutex_lock(&hub->status_mutex); | |
0cdd49a1 MN |
601 | ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len); |
602 | if (ret < len) { | |
e9e88fb7 AS |
603 | if (ret != -ENODEV) |
604 | dev_err(hub->intfdev, | |
605 | "%s failed (err = %d)\n", __func__, ret); | |
3eb14915 AS |
606 | if (ret >= 0) |
607 | ret = -EIO; | |
608 | } else { | |
609 | *status = le16_to_cpu(hub->status->port.wPortStatus); | |
610 | *change = le16_to_cpu(hub->status->port.wPortChange); | |
0cdd49a1 MN |
611 | if (type != HUB_PORT_STATUS && ext_status) |
612 | *ext_status = le32_to_cpu( | |
613 | hub->status->port.dwExtPortStatus); | |
3eb14915 AS |
614 | ret = 0; |
615 | } | |
616 | mutex_unlock(&hub->status_mutex); | |
617 | return ret; | |
618 | } | |
619 | ||
f061f43d | 620 | int usb_hub_port_status(struct usb_hub *hub, int port1, |
0cdd49a1 MN |
621 | u16 *status, u16 *change) |
622 | { | |
623 | return hub_ext_port_status(hub, port1, HUB_PORT_STATUS, | |
624 | status, change, NULL); | |
625 | } | |
626 | ||
8eb58994 NSJ |
627 | static void hub_resubmit_irq_urb(struct usb_hub *hub) |
628 | { | |
629 | unsigned long flags; | |
630 | int status; | |
631 | ||
632 | spin_lock_irqsave(&hub->irq_urb_lock, flags); | |
633 | ||
634 | if (hub->quiescing) { | |
635 | spin_unlock_irqrestore(&hub->irq_urb_lock, flags); | |
636 | return; | |
637 | } | |
638 | ||
639 | status = usb_submit_urb(hub->urb, GFP_ATOMIC); | |
640 | if (status && status != -ENODEV && status != -EPERM && | |
641 | status != -ESHUTDOWN) { | |
642 | dev_err(hub->intfdev, "resubmit --> %d\n", status); | |
643 | mod_timer(&hub->irq_urb_retry, jiffies + HZ); | |
644 | } | |
645 | ||
646 | spin_unlock_irqrestore(&hub->irq_urb_lock, flags); | |
647 | } | |
648 | ||
649 | static void hub_retry_irq_urb(struct timer_list *t) | |
650 | { | |
651 | struct usb_hub *hub = from_timer(hub, t, irq_urb_retry); | |
652 | ||
653 | hub_resubmit_irq_urb(hub); | |
654 | } | |
655 | ||
656 | ||
32a69589 | 657 | static void kick_hub_wq(struct usb_hub *hub) |
1da177e4 | 658 | { |
32a69589 | 659 | struct usb_interface *intf; |
1da177e4 | 660 | |
32a69589 PM |
661 | if (hub->disconnected || work_pending(&hub->events)) |
662 | return; | |
8e4ceb38 | 663 | |
32a69589 PM |
664 | /* |
665 | * Suppress autosuspend until the event is proceed. | |
666 | * | |
667 | * Be careful and make sure that the symmetric operation is | |
668 | * always called. We are here only when there is no pending | |
669 | * work for this hub. Therefore put the interface either when | |
670 | * the new work is called or when it is canceled. | |
671 | */ | |
672 | intf = to_usb_interface(hub->intfdev); | |
673 | usb_autopm_get_interface_no_resume(intf); | |
674 | kref_get(&hub->kref); | |
675 | ||
676 | if (queue_work(hub_wq, &hub->events)) | |
677 | return; | |
678 | ||
679 | /* the work has already been scheduled */ | |
680 | usb_autopm_put_interface_async(intf); | |
681 | kref_put(&hub->kref, hub_release); | |
1da177e4 LT |
682 | } |
683 | ||
59d48b3f | 684 | void usb_kick_hub_wq(struct usb_device *hdev) |
1da177e4 | 685 | { |
ad493e5e | 686 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
25118084 AS |
687 | |
688 | if (hub) | |
32a69589 | 689 | kick_hub_wq(hub); |
1da177e4 LT |
690 | } |
691 | ||
4ee823b8 SS |
692 | /* |
693 | * Let the USB core know that a USB 3.0 device has sent a Function Wake Device | |
694 | * Notification, which indicates it had initiated remote wakeup. | |
695 | * | |
696 | * USB 3.0 hubs do not report the port link state change from U3 to U0 when the | |
697 | * device initiates resume, so the USB core will not receive notice of the | |
698 | * resume through the normal hub interrupt URB. | |
699 | */ | |
700 | void usb_wakeup_notification(struct usb_device *hdev, | |
701 | unsigned int portnum) | |
702 | { | |
703 | struct usb_hub *hub; | |
83a62c51 | 704 | struct usb_port *port_dev; |
4ee823b8 SS |
705 | |
706 | if (!hdev) | |
707 | return; | |
708 | ||
ad493e5e | 709 | hub = usb_hub_to_struct_hub(hdev); |
4ee823b8 | 710 | if (hub) { |
83a62c51 RCS |
711 | port_dev = hub->ports[portnum - 1]; |
712 | if (port_dev && port_dev->child) | |
713 | pm_wakeup_event(&port_dev->child->dev, 0); | |
714 | ||
4ee823b8 | 715 | set_bit(portnum, hub->wakeup_bits); |
32a69589 | 716 | kick_hub_wq(hub); |
4ee823b8 SS |
717 | } |
718 | } | |
719 | EXPORT_SYMBOL_GPL(usb_wakeup_notification); | |
1da177e4 LT |
720 | |
721 | /* completion function, fires on port status changes and various faults */ | |
7d12e780 | 722 | static void hub_irq(struct urb *urb) |
1da177e4 | 723 | { |
ec17cf1c | 724 | struct usb_hub *hub = urb->context; |
e015268d | 725 | int status = urb->status; |
71d2718f | 726 | unsigned i; |
1da177e4 LT |
727 | unsigned long bits; |
728 | ||
e015268d | 729 | switch (status) { |
1da177e4 LT |
730 | case -ENOENT: /* synchronous unlink */ |
731 | case -ECONNRESET: /* async unlink */ | |
732 | case -ESHUTDOWN: /* hardware going away */ | |
733 | return; | |
734 | ||
735 | default: /* presumably an error */ | |
736 | /* Cause a hub reset after 10 consecutive errors */ | |
166b8639 | 737 | dev_dbg(hub->intfdev, "transfer --> %d\n", status); |
1da177e4 LT |
738 | if ((++hub->nerrors < 10) || hub->error) |
739 | goto resubmit; | |
e015268d | 740 | hub->error = status; |
df561f66 | 741 | fallthrough; |
ec17cf1c | 742 | |
37ebb549 | 743 | /* let hub_wq handle things */ |
1da177e4 LT |
744 | case 0: /* we got data: port status changed */ |
745 | bits = 0; | |
746 | for (i = 0; i < urb->actual_length; ++i) | |
747 | bits |= ((unsigned long) ((*hub->buffer)[i])) | |
748 | << (i*8); | |
749 | hub->event_bits[0] = bits; | |
750 | break; | |
751 | } | |
752 | ||
753 | hub->nerrors = 0; | |
754 | ||
37ebb549 | 755 | /* Something happened, let hub_wq figure it out */ |
32a69589 | 756 | kick_hub_wq(hub); |
1da177e4 LT |
757 | |
758 | resubmit: | |
8eb58994 | 759 | hub_resubmit_irq_urb(hub); |
1da177e4 LT |
760 | } |
761 | ||
762 | /* USB 2.0 spec Section 11.24.2.3 */ | |
763 | static inline int | |
166b8639 | 764 | hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt) |
1da177e4 | 765 | { |
2c7b871b WG |
766 | /* Need to clear both directions for control ep */ |
767 | if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) == | |
768 | USB_ENDPOINT_XFER_CONTROL) { | |
1afe33a7 ON |
769 | int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
770 | HUB_CLEAR_TT_BUFFER, USB_RT_PORT, | |
771 | devinfo ^ 0x8000, tt, NULL, 0, 1000); | |
2c7b871b WG |
772 | if (status) |
773 | return status; | |
774 | } | |
1afe33a7 ON |
775 | return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
776 | HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo, | |
777 | tt, NULL, 0, 1000); | |
1da177e4 LT |
778 | } |
779 | ||
780 | /* | |
37ebb549 | 781 | * enumeration blocks hub_wq for a long time. we use keventd instead, since |
1da177e4 LT |
782 | * long blocking there is the exception, not the rule. accordingly, HCDs |
783 | * talking to TTs must queue control transfers (not just bulk and iso), so | |
784 | * both can talk to the same hub concurrently. | |
785 | */ | |
cb88a1b8 | 786 | static void hub_tt_work(struct work_struct *work) |
1da177e4 | 787 | { |
c4028958 | 788 | struct usb_hub *hub = |
cb88a1b8 | 789 | container_of(work, struct usb_hub, tt.clear_work); |
1da177e4 LT |
790 | unsigned long flags; |
791 | ||
166b8639 | 792 | spin_lock_irqsave(&hub->tt.lock, flags); |
3b6054da | 793 | while (!list_empty(&hub->tt.clear_list)) { |
d0f830d3 | 794 | struct list_head *next; |
1da177e4 LT |
795 | struct usb_tt_clear *clear; |
796 | struct usb_device *hdev = hub->hdev; | |
cb88a1b8 | 797 | const struct hc_driver *drv; |
1da177e4 LT |
798 | int status; |
799 | ||
d0f830d3 | 800 | next = hub->tt.clear_list.next; |
166b8639 CM |
801 | clear = list_entry(next, struct usb_tt_clear, clear_list); |
802 | list_del(&clear->clear_list); | |
1da177e4 LT |
803 | |
804 | /* drop lock so HCD can concurrently report other TT errors */ | |
166b8639 CM |
805 | spin_unlock_irqrestore(&hub->tt.lock, flags); |
806 | status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt); | |
e9e88fb7 | 807 | if (status && status != -ENODEV) |
166b8639 | 808 | dev_err(&hdev->dev, |
1da177e4 LT |
809 | "clear tt %d (%04x) error %d\n", |
810 | clear->tt, clear->devinfo, status); | |
cb88a1b8 AS |
811 | |
812 | /* Tell the HCD, even if the operation failed */ | |
813 | drv = clear->hcd->driver; | |
814 | if (drv->clear_tt_buffer_complete) | |
815 | (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep); | |
816 | ||
1bc3c9e1 | 817 | kfree(clear); |
cb88a1b8 | 818 | spin_lock_irqsave(&hub->tt.lock, flags); |
1da177e4 | 819 | } |
166b8639 | 820 | spin_unlock_irqrestore(&hub->tt.lock, flags); |
1da177e4 LT |
821 | } |
822 | ||
971fcd49 LT |
823 | /** |
824 | * usb_hub_set_port_power - control hub port's power state | |
41341261 MN |
825 | * @hdev: USB device belonging to the usb hub |
826 | * @hub: target hub | |
971fcd49 LT |
827 | * @port1: port index |
828 | * @set: expected status | |
829 | * | |
830 | * call this function to control port's power via setting or | |
831 | * clearing the port's PORT_POWER feature. | |
626f090c YB |
832 | * |
833 | * Return: 0 if successful. A negative error code otherwise. | |
971fcd49 | 834 | */ |
41341261 MN |
835 | int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub, |
836 | int port1, bool set) | |
971fcd49 LT |
837 | { |
838 | int ret; | |
839 | ||
840 | if (set) | |
841 | ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER); | |
842 | else | |
ad493e5e LT |
843 | ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER); |
844 | ||
d5c3834e DW |
845 | if (ret) |
846 | return ret; | |
847 | ||
848 | if (set) | |
849 | set_bit(port1, hub->power_bits); | |
850 | else | |
851 | clear_bit(port1, hub->power_bits); | |
852 | return 0; | |
971fcd49 LT |
853 | } |
854 | ||
1da177e4 | 855 | /** |
cb88a1b8 AS |
856 | * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub |
857 | * @urb: an URB associated with the failed or incomplete split transaction | |
1da177e4 LT |
858 | * |
859 | * High speed HCDs use this to tell the hub driver that some split control or | |
860 | * bulk transaction failed in a way that requires clearing internal state of | |
861 | * a transaction translator. This is normally detected (and reported) from | |
862 | * interrupt context. | |
863 | * | |
864 | * It may not be possible for that hub to handle additional full (or low) | |
865 | * speed transactions until that state is fully cleared out. | |
626f090c YB |
866 | * |
867 | * Return: 0 if successful. A negative error code otherwise. | |
1da177e4 | 868 | */ |
cb88a1b8 | 869 | int usb_hub_clear_tt_buffer(struct urb *urb) |
1da177e4 | 870 | { |
cb88a1b8 AS |
871 | struct usb_device *udev = urb->dev; |
872 | int pipe = urb->pipe; | |
1da177e4 LT |
873 | struct usb_tt *tt = udev->tt; |
874 | unsigned long flags; | |
875 | struct usb_tt_clear *clear; | |
876 | ||
877 | /* we've got to cope with an arbitrary number of pending TT clears, | |
878 | * since each TT has "at least two" buffers that can need it (and | |
879 | * there can be many TTs per hub). even if they're uncommon. | |
880 | */ | |
d544d273 GKH |
881 | clear = kmalloc(sizeof *clear, GFP_ATOMIC); |
882 | if (clear == NULL) { | |
166b8639 | 883 | dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n"); |
1da177e4 | 884 | /* FIXME recover somehow ... RESET_TT? */ |
cb88a1b8 | 885 | return -ENOMEM; |
1da177e4 LT |
886 | } |
887 | ||
888 | /* info that CLEAR_TT_BUFFER needs */ | |
889 | clear->tt = tt->multi ? udev->ttport : 1; | |
890 | clear->devinfo = usb_pipeendpoint (pipe); | |
4998f1ef | 891 | clear->devinfo |= ((u16)udev->devaddr) << 4; |
166b8639 | 892 | clear->devinfo |= usb_pipecontrol(pipe) |
1da177e4 LT |
893 | ? (USB_ENDPOINT_XFER_CONTROL << 11) |
894 | : (USB_ENDPOINT_XFER_BULK << 11); | |
166b8639 | 895 | if (usb_pipein(pipe)) |
1da177e4 | 896 | clear->devinfo |= 1 << 15; |
cb88a1b8 AS |
897 | |
898 | /* info for completion callback */ | |
899 | clear->hcd = bus_to_hcd(udev->bus); | |
900 | clear->ep = urb->ep; | |
901 | ||
1da177e4 | 902 | /* tell keventd to clear state for this TT */ |
166b8639 CM |
903 | spin_lock_irqsave(&tt->lock, flags); |
904 | list_add_tail(&clear->clear_list, &tt->clear_list); | |
cb88a1b8 | 905 | schedule_work(&tt->clear_work); |
166b8639 | 906 | spin_unlock_irqrestore(&tt->lock, flags); |
cb88a1b8 | 907 | return 0; |
1da177e4 | 908 | } |
cb88a1b8 | 909 | EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer); |
1da177e4 | 910 | |
7ad3c470 | 911 | static void hub_power_on(struct usb_hub *hub, bool do_delay) |
1da177e4 LT |
912 | { |
913 | int port1; | |
4489a571 AS |
914 | |
915 | /* Enable power on each port. Some hubs have reserved values | |
916 | * of LPSM (> 2) in their descriptors, even though they are | |
917 | * USB 2.0 hubs. Some hubs do not implement port-power switching | |
918 | * but only emulate it. In all cases, the ports won't work | |
919 | * unless we send these messages to the hub. | |
920 | */ | |
9262c19d | 921 | if (hub_is_port_power_switchable(hub)) |
1da177e4 | 922 | dev_dbg(hub->intfdev, "enabling power on all ports\n"); |
4489a571 AS |
923 | else |
924 | dev_dbg(hub->intfdev, "trying to enable port power on " | |
925 | "non-switchable hub\n"); | |
3bbc47d8 | 926 | for (port1 = 1; port1 <= hub->hdev->maxchild; port1++) |
d5c3834e | 927 | if (test_bit(port1, hub->power_bits)) |
ad493e5e LT |
928 | set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER); |
929 | else | |
930 | usb_clear_port_feature(hub->hdev, port1, | |
931 | USB_PORT_FEAT_POWER); | |
8520f380 | 932 | if (do_delay) |
7ad3c470 | 933 | msleep(hub_power_on_good_delay(hub)); |
1da177e4 LT |
934 | } |
935 | ||
1da177e4 LT |
936 | static int hub_hub_status(struct usb_hub *hub, |
937 | u16 *status, u16 *change) | |
938 | { | |
939 | int ret; | |
940 | ||
db90e7a1 | 941 | mutex_lock(&hub->status_mutex); |
1da177e4 | 942 | ret = get_hub_status(hub->hdev, &hub->status->hub); |
e9e88fb7 AS |
943 | if (ret < 0) { |
944 | if (ret != -ENODEV) | |
945 | dev_err(hub->intfdev, | |
946 | "%s failed (err = %d)\n", __func__, ret); | |
947 | } else { | |
1da177e4 | 948 | *status = le16_to_cpu(hub->status->hub.wHubStatus); |
469271f8 | 949 | *change = le16_to_cpu(hub->status->hub.wHubChange); |
1da177e4 LT |
950 | ret = 0; |
951 | } | |
db90e7a1 | 952 | mutex_unlock(&hub->status_mutex); |
1da177e4 LT |
953 | return ret; |
954 | } | |
955 | ||
41e7e056 SS |
956 | static int hub_set_port_link_state(struct usb_hub *hub, int port1, |
957 | unsigned int link_status) | |
958 | { | |
959 | return set_port_feature(hub->hdev, | |
960 | port1 | (link_status << 3), | |
961 | USB_PORT_FEAT_LINK_STATE); | |
962 | } | |
963 | ||
0458d5b4 | 964 | /* |
6d42fcdb | 965 | * Disable a port and mark a logical connect-change event, so that some |
37ebb549 | 966 | * time later hub_wq will disconnect() any existing usb_device on the port |
0458d5b4 AS |
967 | * and will re-enumerate if there actually is a device attached. |
968 | */ | |
969 | static void hub_port_logical_disconnect(struct usb_hub *hub, int port1) | |
970 | { | |
d99f6b41 | 971 | dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n"); |
0458d5b4 | 972 | hub_port_disable(hub, port1, 1); |
7d069b7d | 973 | |
0458d5b4 AS |
974 | /* FIXME let caller ask to power down the port: |
975 | * - some devices won't enumerate without a VBUS power cycle | |
976 | * - SRP saves power that way | |
977 | * - ... new call, TBD ... | |
978 | * That's easy if this hub can switch power per-port, and | |
37ebb549 | 979 | * hub_wq reactivates the port later (timer, SRP, etc). |
0458d5b4 AS |
980 | * Powerdown must be optional, because of reset/DFU. |
981 | */ | |
982 | ||
983 | set_bit(port1, hub->change_bits); | |
32a69589 | 984 | kick_hub_wq(hub); |
0458d5b4 AS |
985 | } |
986 | ||
253e0572 AS |
987 | /** |
988 | * usb_remove_device - disable a device's port on its parent hub | |
989 | * @udev: device to be disabled and removed | |
990 | * Context: @udev locked, must be able to sleep. | |
991 | * | |
37ebb549 | 992 | * After @udev's port has been disabled, hub_wq is notified and it will |
253e0572 AS |
993 | * see that the device has been disconnected. When the device is |
994 | * physically unplugged and something is plugged in, the events will | |
995 | * be received and processed normally. | |
626f090c YB |
996 | * |
997 | * Return: 0 if successful. A negative error code otherwise. | |
253e0572 AS |
998 | */ |
999 | int usb_remove_device(struct usb_device *udev) | |
1000 | { | |
1001 | struct usb_hub *hub; | |
1002 | struct usb_interface *intf; | |
60e3f6e4 | 1003 | int ret; |
253e0572 AS |
1004 | |
1005 | if (!udev->parent) /* Can't remove a root hub */ | |
1006 | return -EINVAL; | |
ad493e5e | 1007 | hub = usb_hub_to_struct_hub(udev->parent); |
253e0572 AS |
1008 | intf = to_usb_interface(hub->intfdev); |
1009 | ||
60e3f6e4 ER |
1010 | ret = usb_autopm_get_interface(intf); |
1011 | if (ret < 0) | |
1012 | return ret; | |
1013 | ||
253e0572 AS |
1014 | set_bit(udev->portnum, hub->removed_bits); |
1015 | hub_port_logical_disconnect(hub, udev->portnum); | |
1016 | usb_autopm_put_interface(intf); | |
1017 | return 0; | |
1018 | } | |
1019 | ||
6ee0b270 | 1020 | enum hub_activation_type { |
8e4ceb38 | 1021 | HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */ |
8520f380 | 1022 | HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME, |
6ee0b270 | 1023 | }; |
5e6effae | 1024 | |
8520f380 AS |
1025 | static void hub_init_func2(struct work_struct *ws); |
1026 | static void hub_init_func3(struct work_struct *ws); | |
1027 | ||
f2835219 | 1028 | static void hub_activate(struct usb_hub *hub, enum hub_activation_type type) |
5e6effae AS |
1029 | { |
1030 | struct usb_device *hdev = hub->hdev; | |
653a39d1 SS |
1031 | struct usb_hcd *hcd; |
1032 | int ret; | |
5e6effae | 1033 | int port1; |
f2835219 | 1034 | int status; |
948fea37 | 1035 | bool need_debounce_delay = false; |
8520f380 AS |
1036 | unsigned delay; |
1037 | ||
1038 | /* Continue a partial initialization */ | |
e50293ef | 1039 | if (type == HUB_INIT2 || type == HUB_INIT3) { |
07d316a2 | 1040 | device_lock(&hdev->dev); |
e50293ef AS |
1041 | |
1042 | /* Was the hub disconnected while we were waiting? */ | |
ca5cbc8b AS |
1043 | if (hub->disconnected) |
1044 | goto disconnected; | |
e50293ef AS |
1045 | if (type == HUB_INIT2) |
1046 | goto init2; | |
8520f380 | 1047 | goto init3; |
e50293ef AS |
1048 | } |
1049 | kref_get(&hub->kref); | |
5e6effae | 1050 | |
a45aa3b3 EF |
1051 | /* The superspeed hub except for root hub has to use Hub Depth |
1052 | * value as an offset into the route string to locate the bits | |
1053 | * it uses to determine the downstream port number. So hub driver | |
1054 | * should send a set hub depth request to superspeed hub after | |
1055 | * the superspeed hub is set configuration in initialization or | |
1056 | * reset procedure. | |
1057 | * | |
1058 | * After a resume, port power should still be on. | |
f2835219 AS |
1059 | * For any other type of activation, turn it on. |
1060 | */ | |
8520f380 | 1061 | if (type != HUB_RESUME) { |
a45aa3b3 | 1062 | if (hdev->parent && hub_is_superspeed(hdev)) { |
1afe33a7 ON |
1063 | ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), |
1064 | HUB_SET_DEPTH, USB_RT_HUB, | |
1065 | hdev->level - 1, 0, NULL, 0, | |
1066 | USB_CTRL_SET_TIMEOUT); | |
1067 | if (ret < 0) | |
a45aa3b3 EF |
1068 | dev_err(hub->intfdev, |
1069 | "set hub depth failed\n"); | |
1070 | } | |
8520f380 AS |
1071 | |
1072 | /* Speed up system boot by using a delayed_work for the | |
1073 | * hub's initial power-up delays. This is pretty awkward | |
1074 | * and the implementation looks like a home-brewed sort of | |
1075 | * setjmp/longjmp, but it saves at least 100 ms for each | |
1076 | * root hub (assuming usbcore is compiled into the kernel | |
1077 | * rather than as a module). It adds up. | |
1078 | * | |
1079 | * This can't be done for HUB_RESUME or HUB_RESET_RESUME | |
1080 | * because for those activation types the ports have to be | |
1081 | * operational when we return. In theory this could be done | |
1082 | * for HUB_POST_RESET, but it's easier not to. | |
1083 | */ | |
1084 | if (type == HUB_INIT) { | |
17a364e2 | 1085 | delay = hub_power_on_good_delay(hub); |
7ad3c470 DW |
1086 | |
1087 | hub_power_on(hub, false); | |
77fa83cf | 1088 | INIT_DELAYED_WORK(&hub->init_work, hub_init_func2); |
22f6a0f0 SD |
1089 | queue_delayed_work(system_power_efficient_wq, |
1090 | &hub->init_work, | |
8520f380 | 1091 | msecs_to_jiffies(delay)); |
61fbeba1 AS |
1092 | |
1093 | /* Suppress autosuspend until init is done */ | |
8e4ceb38 AS |
1094 | usb_autopm_get_interface_no_resume( |
1095 | to_usb_interface(hub->intfdev)); | |
8520f380 | 1096 | return; /* Continues at init2: below */ |
653a39d1 SS |
1097 | } else if (type == HUB_RESET_RESUME) { |
1098 | /* The internal host controller state for the hub device | |
1099 | * may be gone after a host power loss on system resume. | |
1100 | * Update the device's info so the HW knows it's a hub. | |
1101 | */ | |
1102 | hcd = bus_to_hcd(hdev->bus); | |
1103 | if (hcd->driver->update_hub_device) { | |
1104 | ret = hcd->driver->update_hub_device(hcd, hdev, | |
1105 | &hub->tt, GFP_NOIO); | |
1106 | if (ret < 0) { | |
1ccc417e JP |
1107 | dev_err(hub->intfdev, |
1108 | "Host not accepting hub info update\n"); | |
1109 | dev_err(hub->intfdev, | |
1110 | "LS/FS devices and hubs may not work under this hub\n"); | |
653a39d1 SS |
1111 | } |
1112 | } | |
1113 | hub_power_on(hub, true); | |
8520f380 AS |
1114 | } else { |
1115 | hub_power_on(hub, true); | |
1116 | } | |
00558586 KHF |
1117 | /* Give some time on remote wakeup to let links to transit to U0 */ |
1118 | } else if (hub_is_superspeed(hub->hdev)) | |
1119 | msleep(20); | |
1120 | ||
8520f380 | 1121 | init2: |
f2835219 | 1122 | |
d99f6b41 | 1123 | /* |
37ebb549 | 1124 | * Check each port and set hub->change_bits to let hub_wq know |
6ee0b270 | 1125 | * which ports need attention. |
5e6effae AS |
1126 | */ |
1127 | for (port1 = 1; port1 <= hdev->maxchild; ++port1) { | |
d99f6b41 DW |
1128 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
1129 | struct usb_device *udev = port_dev->child; | |
5e6effae AS |
1130 | u16 portstatus, portchange; |
1131 | ||
6ee0b270 | 1132 | portstatus = portchange = 0; |
f061f43d | 1133 | status = usb_hub_port_status(hub, port1, &portstatus, &portchange); |
245b2eec GR |
1134 | if (status) |
1135 | goto abort; | |
1136 | ||
6ee0b270 | 1137 | if (udev || (portstatus & USB_PORT_STAT_CONNECTION)) |
d99f6b41 DW |
1138 | dev_dbg(&port_dev->dev, "status %04x change %04x\n", |
1139 | portstatus, portchange); | |
6ee0b270 | 1140 | |
d99f6b41 DW |
1141 | /* |
1142 | * After anything other than HUB_RESUME (i.e., initialization | |
6ee0b270 AS |
1143 | * or any sort of reset), every port should be disabled. |
1144 | * Unconnected ports should likewise be disabled (paranoia), | |
1145 | * and so should ports for which we have no usb_device. | |
1146 | */ | |
1147 | if ((portstatus & USB_PORT_STAT_ENABLE) && ( | |
1148 | type != HUB_RESUME || | |
1149 | !(portstatus & USB_PORT_STAT_CONNECTION) || | |
1150 | !udev || | |
1151 | udev->state == USB_STATE_NOTATTACHED)) { | |
9f0a6cd3 AX |
1152 | /* |
1153 | * USB3 protocol ports will automatically transition | |
1154 | * to Enabled state when detect an USB3.0 device attach. | |
fd1ac4cf DW |
1155 | * Do not disable USB3 protocol ports, just pretend |
1156 | * power was lost | |
9f0a6cd3 | 1157 | */ |
fd1ac4cf DW |
1158 | portstatus &= ~USB_PORT_STAT_ENABLE; |
1159 | if (!hub_is_superspeed(hdev)) | |
ad493e5e | 1160 | usb_clear_port_feature(hdev, port1, |
9f0a6cd3 | 1161 | USB_PORT_FEAT_ENABLE); |
5e6effae AS |
1162 | } |
1163 | ||
4fdc1790 JMG |
1164 | /* Make sure a warm-reset request is handled by port_event */ |
1165 | if (type == HUB_RESUME && | |
1166 | hub_port_warm_reset_required(hub, port1, portstatus)) | |
1167 | set_bit(port1, hub->event_bits); | |
1168 | ||
e8610894 MN |
1169 | /* |
1170 | * Add debounce if USB3 link is in polling/link training state. | |
1171 | * Link will automatically transition to Enabled state after | |
1172 | * link training completes. | |
1173 | */ | |
1174 | if (hub_is_superspeed(hdev) && | |
1175 | ((portstatus & USB_PORT_STAT_LINK_STATE) == | |
1176 | USB_SS_PORT_LS_POLLING)) | |
1177 | need_debounce_delay = true; | |
1178 | ||
948fea37 AS |
1179 | /* Clear status-change flags; we'll debounce later */ |
1180 | if (portchange & USB_PORT_STAT_C_CONNECTION) { | |
1181 | need_debounce_delay = true; | |
ad493e5e | 1182 | usb_clear_port_feature(hub->hdev, port1, |
948fea37 AS |
1183 | USB_PORT_FEAT_C_CONNECTION); |
1184 | } | |
1185 | if (portchange & USB_PORT_STAT_C_ENABLE) { | |
1186 | need_debounce_delay = true; | |
ad493e5e | 1187 | usb_clear_port_feature(hub->hdev, port1, |
948fea37 AS |
1188 | USB_PORT_FEAT_C_ENABLE); |
1189 | } | |
e92aee33 JW |
1190 | if (portchange & USB_PORT_STAT_C_RESET) { |
1191 | need_debounce_delay = true; | |
1192 | usb_clear_port_feature(hub->hdev, port1, | |
1193 | USB_PORT_FEAT_C_RESET); | |
1194 | } | |
79c3dd81 DZ |
1195 | if ((portchange & USB_PORT_STAT_C_BH_RESET) && |
1196 | hub_is_superspeed(hub->hdev)) { | |
1197 | need_debounce_delay = true; | |
ad493e5e | 1198 | usb_clear_port_feature(hub->hdev, port1, |
79c3dd81 DZ |
1199 | USB_PORT_FEAT_C_BH_PORT_RESET); |
1200 | } | |
253e0572 AS |
1201 | /* We can forget about a "removed" device when there's a |
1202 | * physical disconnect or the connect status changes. | |
1203 | */ | |
1204 | if (!(portstatus & USB_PORT_STAT_CONNECTION) || | |
1205 | (portchange & USB_PORT_STAT_C_CONNECTION)) | |
1206 | clear_bit(port1, hub->removed_bits); | |
1207 | ||
6ee0b270 | 1208 | if (!udev || udev->state == USB_STATE_NOTATTACHED) { |
37ebb549 | 1209 | /* Tell hub_wq to disconnect the device or |
249a32b7 BL |
1210 | * check for a new connection or over current condition. |
1211 | * Based on USB2.0 Spec Section 11.12.5, | |
1212 | * C_PORT_OVER_CURRENT could be set while | |
1213 | * PORT_OVER_CURRENT is not. So check for any of them. | |
6ee0b270 | 1214 | */ |
08d1dec6 | 1215 | if (udev || (portstatus & USB_PORT_STAT_CONNECTION) || |
9c06ac4c | 1216 | (portchange & USB_PORT_STAT_C_CONNECTION) || |
249a32b7 BL |
1217 | (portstatus & USB_PORT_STAT_OVERCURRENT) || |
1218 | (portchange & USB_PORT_STAT_C_OVERCURRENT)) | |
6ee0b270 AS |
1219 | set_bit(port1, hub->change_bits); |
1220 | ||
1221 | } else if (portstatus & USB_PORT_STAT_ENABLE) { | |
72937e1e SS |
1222 | bool port_resumed = (portstatus & |
1223 | USB_PORT_STAT_LINK_STATE) == | |
1224 | USB_SS_PORT_LS_U0; | |
6ee0b270 AS |
1225 | /* The power session apparently survived the resume. |
1226 | * If there was an overcurrent or suspend change | |
37ebb549 | 1227 | * (i.e., remote wakeup request), have hub_wq |
72937e1e SS |
1228 | * take care of it. Look at the port link state |
1229 | * for USB 3.0 hubs, since they don't have a suspend | |
1230 | * change bit, and they don't set the port link change | |
1231 | * bit on device-initiated resume. | |
6ee0b270 | 1232 | */ |
72937e1e SS |
1233 | if (portchange || (hub_is_superspeed(hub->hdev) && |
1234 | port_resumed)) | |
0f663729 | 1235 | set_bit(port1, hub->event_bits); |
5e6effae | 1236 | |
6ee0b270 | 1237 | } else if (udev->persist_enabled) { |
6ee0b270 | 1238 | #ifdef CONFIG_PM |
5e6effae | 1239 | udev->reset_resume = 1; |
6ee0b270 | 1240 | #endif |
9f952e26 AS |
1241 | /* Don't set the change_bits when the device |
1242 | * was powered off. | |
1243 | */ | |
1244 | if (test_bit(port1, hub->power_bits)) | |
1245 | set_bit(port1, hub->change_bits); | |
8808f00c | 1246 | |
6ee0b270 | 1247 | } else { |
37ebb549 | 1248 | /* The power session is gone; tell hub_wq */ |
6ee0b270 AS |
1249 | usb_set_device_state(udev, USB_STATE_NOTATTACHED); |
1250 | set_bit(port1, hub->change_bits); | |
5e6effae | 1251 | } |
5e6effae AS |
1252 | } |
1253 | ||
948fea37 AS |
1254 | /* If no port-status-change flags were set, we don't need any |
1255 | * debouncing. If flags were set we can try to debounce the | |
37ebb549 | 1256 | * ports all at once right now, instead of letting hub_wq do them |
948fea37 AS |
1257 | * one at a time later on. |
1258 | * | |
37ebb549 | 1259 | * If any port-status changes do occur during this delay, hub_wq |
948fea37 AS |
1260 | * will see them later and handle them normally. |
1261 | */ | |
8520f380 AS |
1262 | if (need_debounce_delay) { |
1263 | delay = HUB_DEBOUNCE_STABLE; | |
1264 | ||
1265 | /* Don't do a long sleep inside a workqueue routine */ | |
1266 | if (type == HUB_INIT2) { | |
77fa83cf | 1267 | INIT_DELAYED_WORK(&hub->init_work, hub_init_func3); |
22f6a0f0 SD |
1268 | queue_delayed_work(system_power_efficient_wq, |
1269 | &hub->init_work, | |
8520f380 | 1270 | msecs_to_jiffies(delay)); |
07d316a2 | 1271 | device_unlock(&hdev->dev); |
8520f380 AS |
1272 | return; /* Continues at init3: below */ |
1273 | } else { | |
1274 | msleep(delay); | |
1275 | } | |
1276 | } | |
1277 | init3: | |
f2835219 AS |
1278 | hub->quiescing = 0; |
1279 | ||
1280 | status = usb_submit_urb(hub->urb, GFP_NOIO); | |
1281 | if (status < 0) | |
1282 | dev_err(hub->intfdev, "activate --> %d\n", status); | |
1283 | if (hub->has_indicators && blinkenlights) | |
22f6a0f0 SD |
1284 | queue_delayed_work(system_power_efficient_wq, |
1285 | &hub->leds, LED_CYCLE_PERIOD); | |
f2835219 AS |
1286 | |
1287 | /* Scan all ports that need attention */ | |
32a69589 | 1288 | kick_hub_wq(hub); |
245b2eec | 1289 | abort: |
ca5cbc8b AS |
1290 | if (type == HUB_INIT2 || type == HUB_INIT3) { |
1291 | /* Allow autosuspend if it was suppressed */ | |
1292 | disconnected: | |
8e4ceb38 | 1293 | usb_autopm_put_interface_async(to_usb_interface(hub->intfdev)); |
07d316a2 | 1294 | device_unlock(&hdev->dev); |
ca5cbc8b | 1295 | } |
e50293ef AS |
1296 | |
1297 | kref_put(&hub->kref, hub_release); | |
5e6effae AS |
1298 | } |
1299 | ||
8520f380 AS |
1300 | /* Implement the continuations for the delays above */ |
1301 | static void hub_init_func2(struct work_struct *ws) | |
1302 | { | |
1303 | struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work); | |
1304 | ||
1305 | hub_activate(hub, HUB_INIT2); | |
1306 | } | |
1307 | ||
1308 | static void hub_init_func3(struct work_struct *ws) | |
1309 | { | |
1310 | struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work); | |
1311 | ||
1312 | hub_activate(hub, HUB_INIT3); | |
1313 | } | |
1314 | ||
4330354f AS |
1315 | enum hub_quiescing_type { |
1316 | HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND | |
1317 | }; | |
1318 | ||
1319 | static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type) | |
1320 | { | |
1321 | struct usb_device *hdev = hub->hdev; | |
8eb58994 | 1322 | unsigned long flags; |
4330354f AS |
1323 | int i; |
1324 | ||
37ebb549 | 1325 | /* hub_wq and related activity won't re-trigger */ |
8eb58994 | 1326 | spin_lock_irqsave(&hub->irq_urb_lock, flags); |
4330354f | 1327 | hub->quiescing = 1; |
8eb58994 | 1328 | spin_unlock_irqrestore(&hub->irq_urb_lock, flags); |
4330354f AS |
1329 | |
1330 | if (type != HUB_SUSPEND) { | |
1331 | /* Disconnect all the children */ | |
1332 | for (i = 0; i < hdev->maxchild; ++i) { | |
ff823c79 LT |
1333 | if (hub->ports[i]->child) |
1334 | usb_disconnect(&hub->ports[i]->child); | |
4330354f AS |
1335 | } |
1336 | } | |
1337 | ||
37ebb549 | 1338 | /* Stop hub_wq and related activity */ |
8eb58994 | 1339 | del_timer_sync(&hub->irq_urb_retry); |
4330354f AS |
1340 | usb_kill_urb(hub->urb); |
1341 | if (hub->has_indicators) | |
1342 | cancel_delayed_work_sync(&hub->leds); | |
1343 | if (hub->tt.hub) | |
036546bf | 1344 | flush_work(&hub->tt.clear_work); |
4330354f AS |
1345 | } |
1346 | ||
600856c2 AS |
1347 | static void hub_pm_barrier_for_all_ports(struct usb_hub *hub) |
1348 | { | |
1349 | int i; | |
1350 | ||
1351 | for (i = 0; i < hub->hdev->maxchild; ++i) | |
1352 | pm_runtime_barrier(&hub->ports[i]->dev); | |
1353 | } | |
1354 | ||
3eb14915 AS |
1355 | /* caller has locked the hub device */ |
1356 | static int hub_pre_reset(struct usb_interface *intf) | |
1357 | { | |
1358 | struct usb_hub *hub = usb_get_intfdata(intf); | |
1359 | ||
4330354f | 1360 | hub_quiesce(hub, HUB_PRE_RESET); |
600856c2 AS |
1361 | hub->in_reset = 1; |
1362 | hub_pm_barrier_for_all_ports(hub); | |
f07600cf | 1363 | return 0; |
7d069b7d AS |
1364 | } |
1365 | ||
1366 | /* caller has locked the hub device */ | |
f07600cf | 1367 | static int hub_post_reset(struct usb_interface *intf) |
7d069b7d | 1368 | { |
7de18d8b AS |
1369 | struct usb_hub *hub = usb_get_intfdata(intf); |
1370 | ||
600856c2 AS |
1371 | hub->in_reset = 0; |
1372 | hub_pm_barrier_for_all_ports(hub); | |
f2835219 | 1373 | hub_activate(hub, HUB_POST_RESET); |
f07600cf | 1374 | return 0; |
7d069b7d AS |
1375 | } |
1376 | ||
1da177e4 LT |
1377 | static int hub_configure(struct usb_hub *hub, |
1378 | struct usb_endpoint_descriptor *endpoint) | |
1379 | { | |
b356b7c7 | 1380 | struct usb_hcd *hcd; |
1da177e4 LT |
1381 | struct usb_device *hdev = hub->hdev; |
1382 | struct device *hub_dev = hub->intfdev; | |
1383 | u16 hubstatus, hubchange; | |
74ad9bd2 | 1384 | u16 wHubCharacteristics; |
1da177e4 | 1385 | unsigned int pipe; |
fa2a9566 | 1386 | int maxp, ret, i; |
7cbe5dca | 1387 | char *message = "out of memory"; |
430ee58e SAS |
1388 | unsigned unit_load; |
1389 | unsigned full_load; | |
d8521afe | 1390 | unsigned maxchild; |
1da177e4 | 1391 | |
d697cdda | 1392 | hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL); |
1da177e4 | 1393 | if (!hub->buffer) { |
1da177e4 LT |
1394 | ret = -ENOMEM; |
1395 | goto fail; | |
1396 | } | |
1397 | ||
1398 | hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL); | |
1399 | if (!hub->status) { | |
1da177e4 LT |
1400 | ret = -ENOMEM; |
1401 | goto fail; | |
1402 | } | |
db90e7a1 | 1403 | mutex_init(&hub->status_mutex); |
1da177e4 | 1404 | |
bec444cd | 1405 | hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL); |
1da177e4 | 1406 | if (!hub->descriptor) { |
1da177e4 LT |
1407 | ret = -ENOMEM; |
1408 | goto fail; | |
1409 | } | |
1410 | ||
1411 | /* Request the entire hub descriptor. | |
1412 | * hub->descriptor can handle USB_MAXCHILDREN ports, | |
2c25a2c8 | 1413 | * but a (non-SS) hub can/will return fewer bytes here. |
1da177e4 | 1414 | */ |
dbe79bbe | 1415 | ret = get_hub_descriptor(hdev, hub->descriptor); |
1da177e4 LT |
1416 | if (ret < 0) { |
1417 | message = "can't read hub descriptor"; | |
1418 | goto fail; | |
93491ced JH |
1419 | } |
1420 | ||
1421 | maxchild = USB_MAXCHILDREN; | |
1422 | if (hub_is_superspeed(hdev)) | |
1423 | maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS); | |
1424 | ||
1425 | if (hub->descriptor->bNbrPorts > maxchild) { | |
1da177e4 LT |
1426 | message = "hub has too many ports!"; |
1427 | ret = -ENODEV; | |
1428 | goto fail; | |
769d7368 DL |
1429 | } else if (hub->descriptor->bNbrPorts == 0) { |
1430 | message = "hub doesn't have any ports!"; | |
1431 | ret = -ENODEV; | |
1432 | goto fail; | |
1da177e4 LT |
1433 | } |
1434 | ||
886ee36e FB |
1435 | /* |
1436 | * Accumulate wHubDelay + 40ns for every hub in the tree of devices. | |
1437 | * The resulting value will be used for SetIsochDelay() request. | |
1438 | */ | |
1439 | if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) { | |
1440 | u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay); | |
1441 | ||
1442 | if (hdev->parent) | |
1443 | delay += hdev->parent->hub_delay; | |
1444 | ||
1445 | delay += USB_TP_TRANSMISSION_DELAY; | |
1446 | hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX); | |
1447 | } | |
1448 | ||
d8521afe DW |
1449 | maxchild = hub->descriptor->bNbrPorts; |
1450 | dev_info(hub_dev, "%d port%s detected\n", maxchild, | |
1451 | (maxchild == 1) ? "" : "s"); | |
1da177e4 | 1452 | |
6396bb22 | 1453 | hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL); |
ff823c79 | 1454 | if (!hub->ports) { |
7cbe5dca AS |
1455 | ret = -ENOMEM; |
1456 | goto fail; | |
1457 | } | |
1458 | ||
74ad9bd2 | 1459 | wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics); |
430ee58e SAS |
1460 | if (hub_is_superspeed(hdev)) { |
1461 | unit_load = 150; | |
1462 | full_load = 900; | |
1463 | } else { | |
1464 | unit_load = 100; | |
1465 | full_load = 500; | |
1466 | } | |
1da177e4 | 1467 | |
dbe79bbe JY |
1468 | /* FIXME for USB 3.0, skip for now */ |
1469 | if ((wHubCharacteristics & HUB_CHAR_COMPOUND) && | |
1470 | !(hub_is_superspeed(hdev))) { | |
469271f8 | 1471 | char portstr[USB_MAXCHILDREN + 1]; |
1da177e4 | 1472 | |
d8521afe | 1473 | for (i = 0; i < maxchild; i++) |
dbe79bbe | 1474 | portstr[i] = hub->descriptor->u.hs.DeviceRemovable |
1da177e4 LT |
1475 | [((i + 1) / 8)] & (1 << ((i + 1) % 8)) |
1476 | ? 'F' : 'R'; | |
d8521afe | 1477 | portstr[maxchild] = 0; |
1da177e4 LT |
1478 | dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr); |
1479 | } else | |
1480 | dev_dbg(hub_dev, "standalone hub\n"); | |
1481 | ||
74ad9bd2 | 1482 | switch (wHubCharacteristics & HUB_CHAR_LPSM) { |
7bf01185 AD |
1483 | case HUB_CHAR_COMMON_LPSM: |
1484 | dev_dbg(hub_dev, "ganged power switching\n"); | |
1485 | break; | |
1486 | case HUB_CHAR_INDV_PORT_LPSM: | |
1487 | dev_dbg(hub_dev, "individual port power switching\n"); | |
1488 | break; | |
1489 | case HUB_CHAR_NO_LPSM: | |
1490 | case HUB_CHAR_LPSM: | |
1491 | dev_dbg(hub_dev, "no power switching (usb 1.0)\n"); | |
1492 | break; | |
1da177e4 LT |
1493 | } |
1494 | ||
74ad9bd2 | 1495 | switch (wHubCharacteristics & HUB_CHAR_OCPM) { |
7bf01185 AD |
1496 | case HUB_CHAR_COMMON_OCPM: |
1497 | dev_dbg(hub_dev, "global over-current protection\n"); | |
1498 | break; | |
1499 | case HUB_CHAR_INDV_PORT_OCPM: | |
1500 | dev_dbg(hub_dev, "individual port over-current protection\n"); | |
1501 | break; | |
1502 | case HUB_CHAR_NO_OCPM: | |
1503 | case HUB_CHAR_OCPM: | |
1504 | dev_dbg(hub_dev, "no over-current protection\n"); | |
1505 | break; | |
1da177e4 LT |
1506 | } |
1507 | ||
17248569 CM |
1508 | spin_lock_init(&hub->tt.lock); |
1509 | INIT_LIST_HEAD(&hub->tt.clear_list); | |
cb88a1b8 | 1510 | INIT_WORK(&hub->tt.clear_work, hub_tt_work); |
1da177e4 | 1511 | switch (hdev->descriptor.bDeviceProtocol) { |
7bf01185 AD |
1512 | case USB_HUB_PR_FS: |
1513 | break; | |
1514 | case USB_HUB_PR_HS_SINGLE_TT: | |
1515 | dev_dbg(hub_dev, "Single TT\n"); | |
1516 | hub->tt.hub = hdev; | |
1517 | break; | |
1518 | case USB_HUB_PR_HS_MULTI_TT: | |
1519 | ret = usb_set_interface(hdev, 0, 1); | |
1520 | if (ret == 0) { | |
1521 | dev_dbg(hub_dev, "TT per port\n"); | |
1522 | hub->tt.multi = 1; | |
1523 | } else | |
1524 | dev_err(hub_dev, "Using single TT (err %d)\n", | |
1525 | ret); | |
1526 | hub->tt.hub = hdev; | |
1527 | break; | |
1528 | case USB_HUB_PR_SS: | |
1529 | /* USB 3.0 hubs don't have a TT */ | |
1530 | break; | |
1531 | default: | |
1532 | dev_dbg(hub_dev, "Unrecognized hub protocol %d\n", | |
1533 | hdev->descriptor.bDeviceProtocol); | |
1534 | break; | |
1da177e4 LT |
1535 | } |
1536 | ||
e09711ae | 1537 | /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */ |
74ad9bd2 | 1538 | switch (wHubCharacteristics & HUB_CHAR_TTTT) { |
469271f8 MB |
1539 | case HUB_TTTT_8_BITS: |
1540 | if (hdev->descriptor.bDeviceProtocol != 0) { | |
1541 | hub->tt.think_time = 666; | |
e09711ae | 1542 | dev_dbg(hub_dev, "TT requires at most %d " |
1543 | "FS bit times (%d ns)\n", | |
469271f8 MB |
1544 | 8, hub->tt.think_time); |
1545 | } | |
1546 | break; | |
1547 | case HUB_TTTT_16_BITS: | |
1548 | hub->tt.think_time = 666 * 2; | |
1549 | dev_dbg(hub_dev, "TT requires at most %d " | |
1550 | "FS bit times (%d ns)\n", | |
1551 | 16, hub->tt.think_time); | |
1552 | break; | |
1553 | case HUB_TTTT_24_BITS: | |
1554 | hub->tt.think_time = 666 * 3; | |
1555 | dev_dbg(hub_dev, "TT requires at most %d " | |
1556 | "FS bit times (%d ns)\n", | |
1557 | 24, hub->tt.think_time); | |
1558 | break; | |
1559 | case HUB_TTTT_32_BITS: | |
1560 | hub->tt.think_time = 666 * 4; | |
1561 | dev_dbg(hub_dev, "TT requires at most %d " | |
1562 | "FS bit times (%d ns)\n", | |
1563 | 32, hub->tt.think_time); | |
1564 | break; | |
1da177e4 LT |
1565 | } |
1566 | ||
1567 | /* probe() zeroes hub->indicator[] */ | |
74ad9bd2 | 1568 | if (wHubCharacteristics & HUB_CHAR_PORTIND) { |
1da177e4 LT |
1569 | hub->has_indicators = 1; |
1570 | dev_dbg(hub_dev, "Port indicators are supported\n"); | |
1571 | } | |
1572 | ||
1573 | dev_dbg(hub_dev, "power on to power good time: %dms\n", | |
1574 | hub->descriptor->bPwrOn2PwrGood * 2); | |
1575 | ||
1576 | /* power budgeting mostly matters with bus-powered hubs, | |
1577 | * and battery-powered root hubs (may provide just 8 mA). | |
1578 | */ | |
d9e1e148 | 1579 | ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus); |
15b7336e | 1580 | if (ret) { |
1da177e4 LT |
1581 | message = "can't get hub status"; |
1582 | goto fail; | |
1583 | } | |
430ee58e | 1584 | hcd = bus_to_hcd(hdev->bus); |
7d35b929 | 1585 | if (hdev == hdev->bus->root_hub) { |
430ee58e SAS |
1586 | if (hcd->power_budget > 0) |
1587 | hdev->bus_mA = hcd->power_budget; | |
1588 | else | |
d8521afe | 1589 | hdev->bus_mA = full_load * maxchild; |
430ee58e SAS |
1590 | if (hdev->bus_mA >= full_load) |
1591 | hub->mA_per_port = full_load; | |
55c52718 AS |
1592 | else { |
1593 | hub->mA_per_port = hdev->bus_mA; | |
1594 | hub->limited_power = 1; | |
1595 | } | |
7d35b929 | 1596 | } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) { |
430ee58e SAS |
1597 | int remaining = hdev->bus_mA - |
1598 | hub->descriptor->bHubContrCurrent; | |
1599 | ||
1da177e4 LT |
1600 | dev_dbg(hub_dev, "hub controller current requirement: %dmA\n", |
1601 | hub->descriptor->bHubContrCurrent); | |
55c52718 | 1602 | hub->limited_power = 1; |
55c52718 | 1603 | |
d8521afe | 1604 | if (remaining < maxchild * unit_load) |
430ee58e | 1605 | dev_warn(hub_dev, |
55c52718 AS |
1606 | "insufficient power available " |
1607 | "to use all downstream ports\n"); | |
430ee58e SAS |
1608 | hub->mA_per_port = unit_load; /* 7.2.1 */ |
1609 | ||
55c52718 AS |
1610 | } else { /* Self-powered external hub */ |
1611 | /* FIXME: What about battery-powered external hubs that | |
1612 | * provide less current per port? */ | |
430ee58e | 1613 | hub->mA_per_port = full_load; |
7d35b929 | 1614 | } |
430ee58e | 1615 | if (hub->mA_per_port < full_load) |
55c52718 AS |
1616 | dev_dbg(hub_dev, "%umA bus power budget for each child\n", |
1617 | hub->mA_per_port); | |
1da177e4 LT |
1618 | |
1619 | ret = hub_hub_status(hub, &hubstatus, &hubchange); | |
1620 | if (ret < 0) { | |
1621 | message = "can't get hub status"; | |
1622 | goto fail; | |
1623 | } | |
1624 | ||
1625 | /* local power status reports aren't always correct */ | |
1626 | if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER) | |
1627 | dev_dbg(hub_dev, "local power source is %s\n", | |
1628 | (hubstatus & HUB_STATUS_LOCAL_POWER) | |
1629 | ? "lost (inactive)" : "good"); | |
1630 | ||
74ad9bd2 | 1631 | if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0) |
1da177e4 LT |
1632 | dev_dbg(hub_dev, "%sover-current condition exists\n", |
1633 | (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no "); | |
1634 | ||
88fafff9 | 1635 | /* set up the interrupt endpoint |
1636 | * We use the EP's maxpacket size instead of (PORTS+1+7)/8 | |
1637 | * bytes as USB2.0[11.12.3] says because some hubs are known | |
1638 | * to send more data (and thus cause overflow). For root hubs, | |
1639 | * maxpktsize is defined in hcd.c's fake endpoint descriptors | |
1640 | * to be big enough for at least USB_MAXCHILDREN ports. */ | |
1da177e4 | 1641 | pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress); |
dcd2e49b | 1642 | maxp = usb_maxpacket(hdev, pipe); |
1da177e4 LT |
1643 | |
1644 | if (maxp > sizeof(*hub->buffer)) | |
1645 | maxp = sizeof(*hub->buffer); | |
1646 | ||
1647 | hub->urb = usb_alloc_urb(0, GFP_KERNEL); | |
1648 | if (!hub->urb) { | |
1da177e4 LT |
1649 | ret = -ENOMEM; |
1650 | goto fail; | |
1651 | } | |
1652 | ||
1653 | usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq, | |
1654 | hub, endpoint->bInterval); | |
1da177e4 LT |
1655 | |
1656 | /* maybe cycle the hub leds */ | |
1657 | if (hub->has_indicators && blinkenlights) | |
469271f8 | 1658 | hub->indicator[0] = INDICATOR_CYCLE; |
1da177e4 | 1659 | |
d8521afe DW |
1660 | mutex_lock(&usb_port_peer_mutex); |
1661 | for (i = 0; i < maxchild; i++) { | |
e58547eb KM |
1662 | ret = usb_hub_create_port_device(hub, i + 1); |
1663 | if (ret < 0) { | |
fa2a9566 LT |
1664 | dev_err(hub->intfdev, |
1665 | "couldn't create port%d device.\n", i + 1); | |
d8521afe | 1666 | break; |
e58547eb KM |
1667 | } |
1668 | } | |
d8521afe | 1669 | hdev->maxchild = i; |
e3d10505 DW |
1670 | for (i = 0; i < hdev->maxchild; i++) { |
1671 | struct usb_port *port_dev = hub->ports[i]; | |
1672 | ||
1673 | pm_runtime_put(&port_dev->dev); | |
1674 | } | |
1675 | ||
d8521afe DW |
1676 | mutex_unlock(&usb_port_peer_mutex); |
1677 | if (ret < 0) | |
1678 | goto fail; | |
fa2a9566 | 1679 | |
37ebb549 | 1680 | /* Update the HCD's internal representation of this hub before hub_wq |
e3d95580 DW |
1681 | * starts getting port status changes for devices under the hub. |
1682 | */ | |
1683 | if (hcd->driver->update_hub_device) { | |
1684 | ret = hcd->driver->update_hub_device(hcd, hdev, | |
1685 | &hub->tt, GFP_KERNEL); | |
1686 | if (ret < 0) { | |
1687 | message = "can't update HCD hub info"; | |
1688 | goto fail; | |
1689 | } | |
1690 | } | |
1691 | ||
d2123fd9 LT |
1692 | usb_hub_adjust_deviceremovable(hdev, hub->descriptor); |
1693 | ||
f2835219 | 1694 | hub_activate(hub, HUB_INIT); |
1da177e4 LT |
1695 | return 0; |
1696 | ||
1697 | fail: | |
17248569 | 1698 | dev_err(hub_dev, "config failed, %s (err %d)\n", |
1da177e4 LT |
1699 | message, ret); |
1700 | /* hub_disconnect() frees urb and descriptor */ | |
1701 | return ret; | |
1702 | } | |
1703 | ||
e8054854 AS |
1704 | static void hub_release(struct kref *kref) |
1705 | { | |
1706 | struct usb_hub *hub = container_of(kref, struct usb_hub, kref); | |
1707 | ||
5d14f323 | 1708 | usb_put_dev(hub->hdev); |
e8054854 AS |
1709 | usb_put_intf(to_usb_interface(hub->intfdev)); |
1710 | kfree(hub); | |
1711 | } | |
1712 | ||
1da177e4 LT |
1713 | static unsigned highspeed_hubs; |
1714 | ||
1715 | static void hub_disconnect(struct usb_interface *intf) | |
1716 | { | |
8816230e | 1717 | struct usb_hub *hub = usb_get_intfdata(intf); |
fa286188 | 1718 | struct usb_device *hdev = interface_to_usbdev(intf); |
543d7784 | 1719 | int port1; |
fa2a9566 | 1720 | |
32a69589 PM |
1721 | /* |
1722 | * Stop adding new hub events. We do not want to block here and thus | |
1723 | * will not try to remove any pending work item. | |
1724 | */ | |
e8054854 | 1725 | hub->disconnected = 1; |
1da177e4 | 1726 | |
7de18d8b AS |
1727 | /* Disconnect all children and quiesce the hub */ |
1728 | hub->error = 0; | |
4330354f | 1729 | hub_quiesce(hub, HUB_DISCONNECT); |
7de18d8b | 1730 | |
d8521afe DW |
1731 | mutex_lock(&usb_port_peer_mutex); |
1732 | ||
543d7784 AS |
1733 | /* Avoid races with recursively_mark_NOTATTACHED() */ |
1734 | spin_lock_irq(&device_state_lock); | |
1735 | port1 = hdev->maxchild; | |
1736 | hdev->maxchild = 0; | |
1737 | usb_set_intfdata(intf, NULL); | |
1738 | spin_unlock_irq(&device_state_lock); | |
1f2235b8 | 1739 | |
543d7784 AS |
1740 | for (; port1 > 0; --port1) |
1741 | usb_hub_remove_port_device(hub, port1); | |
1da177e4 | 1742 | |
d8521afe DW |
1743 | mutex_unlock(&usb_port_peer_mutex); |
1744 | ||
e8054854 | 1745 | if (hub->hdev->speed == USB_SPEED_HIGH) |
1da177e4 LT |
1746 | highspeed_hubs--; |
1747 | ||
1da177e4 | 1748 | usb_free_urb(hub->urb); |
fa2a9566 | 1749 | kfree(hub->ports); |
1bc3c9e1 | 1750 | kfree(hub->descriptor); |
1bc3c9e1 | 1751 | kfree(hub->status); |
d697cdda | 1752 | kfree(hub->buffer); |
1da177e4 | 1753 | |
971fcd49 | 1754 | pm_suspend_ignore_children(&intf->dev, false); |
1208f9e1 HG |
1755 | |
1756 | if (hub->quirk_disable_autosuspend) | |
1757 | usb_autopm_put_interface(intf); | |
1758 | ||
3a6bf4a0 MK |
1759 | onboard_hub_destroy_pdevs(&hub->onboard_hub_devs); |
1760 | ||
e8054854 | 1761 | kref_put(&hub->kref, hub_release); |
1da177e4 LT |
1762 | } |
1763 | ||
c94dc34f EK |
1764 | static bool hub_descriptor_is_sane(struct usb_host_interface *desc) |
1765 | { | |
1766 | /* Some hubs have a subclass of 1, which AFAICT according to the */ | |
1767 | /* specs is not defined, but it works */ | |
1768 | if (desc->desc.bInterfaceSubClass != 0 && | |
1769 | desc->desc.bInterfaceSubClass != 1) | |
1770 | return false; | |
1771 | ||
1772 | /* Multiple endpoints? What kind of mutant ninja-hub is this? */ | |
1773 | if (desc->desc.bNumEndpoints != 1) | |
1774 | return false; | |
1775 | ||
1776 | /* If the first endpoint is not interrupt IN, we'd better punt! */ | |
1777 | if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc)) | |
1778 | return false; | |
1779 | ||
1780 | return true; | |
1781 | } | |
1782 | ||
1da177e4 LT |
1783 | static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id) |
1784 | { | |
1785 | struct usb_host_interface *desc; | |
1da177e4 LT |
1786 | struct usb_device *hdev; |
1787 | struct usb_hub *hub; | |
1788 | ||
1789 | desc = intf->cur_altsetting; | |
1790 | hdev = interface_to_usbdev(intf); | |
1791 | ||
596d789a ML |
1792 | /* |
1793 | * Set default autosuspend delay as 0 to speedup bus suspend, | |
1794 | * based on the below considerations: | |
1795 | * | |
1796 | * - Unlike other drivers, the hub driver does not rely on the | |
1797 | * autosuspend delay to provide enough time to handle a wakeup | |
1798 | * event, and the submitted status URB is just to check future | |
1799 | * change on hub downstream ports, so it is safe to do it. | |
1800 | * | |
1801 | * - The patch might cause one or more auto supend/resume for | |
1802 | * below very rare devices when they are plugged into hub | |
1803 | * first time: | |
1804 | * | |
1805 | * devices having trouble initializing, and disconnect | |
1806 | * themselves from the bus and then reconnect a second | |
1807 | * or so later | |
1808 | * | |
1809 | * devices just for downloading firmware, and disconnects | |
1810 | * themselves after completing it | |
1811 | * | |
1812 | * For these quite rare devices, their drivers may change the | |
1813 | * autosuspend delay of their parent hub in the probe() to one | |
1814 | * appropriate value to avoid the subtle problem if someone | |
1815 | * does care it. | |
1816 | * | |
1817 | * - The patch may cause one or more auto suspend/resume on | |
1818 | * hub during running 'lsusb', but it is probably too | |
1819 | * infrequent to worry about. | |
1820 | * | |
1821 | * - Change autosuspend delay of hub can avoid unnecessary auto | |
1822 | * suspend timer for hub, also may decrease power consumption | |
1823 | * of USB bus. | |
bdd405d2 RQ |
1824 | * |
1825 | * - If user has indicated to prevent autosuspend by passing | |
1826 | * usbcore.autosuspend = -1 then keep autosuspend disabled. | |
596d789a | 1827 | */ |
ceb6c9c8 | 1828 | #ifdef CONFIG_PM |
bdd405d2 RQ |
1829 | if (hdev->dev.power.autosuspend_delay >= 0) |
1830 | pm_runtime_set_autosuspend_delay(&hdev->dev, 0); | |
a9ef803d | 1831 | #endif |
596d789a | 1832 | |
8ef42ddd AS |
1833 | /* |
1834 | * Hubs have proper suspend/resume support, except for root hubs | |
1835 | * where the controller driver doesn't have bus_suspend and | |
1836 | * bus_resume methods. | |
1837 | */ | |
1838 | if (hdev->parent) { /* normal device */ | |
1839 | usb_enable_autosuspend(hdev); | |
1840 | } else { /* root hub */ | |
1841 | const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver; | |
1842 | ||
1843 | if (drv->bus_suspend && drv->bus_resume) | |
1844 | usb_enable_autosuspend(hdev); | |
1845 | } | |
088f7fec | 1846 | |
38f3ad5e | 1847 | if (hdev->level == MAX_TOPO_LEVEL) { |
b9cef6c3 WF |
1848 | dev_err(&intf->dev, |
1849 | "Unsupported bus topology: hub nested too deep\n"); | |
38f3ad5e FB |
1850 | return -E2BIG; |
1851 | } | |
1852 | ||
9af54301 | 1853 | #ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB |
89ccbdc9 DB |
1854 | if (hdev->parent) { |
1855 | dev_warn(&intf->dev, "ignoring external hub\n"); | |
1856 | return -ENODEV; | |
1857 | } | |
1858 | #endif | |
1859 | ||
c94dc34f | 1860 | if (!hub_descriptor_is_sane(desc)) { |
17248569 | 1861 | dev_err(&intf->dev, "bad descriptor, ignoring hub\n"); |
1da177e4 LT |
1862 | return -EIO; |
1863 | } | |
1864 | ||
1da177e4 | 1865 | /* We found a hub */ |
17248569 | 1866 | dev_info(&intf->dev, "USB hub found\n"); |
1da177e4 | 1867 | |
0a1ef3b5 | 1868 | hub = kzalloc(sizeof(*hub), GFP_KERNEL); |
b74e7062 | 1869 | if (!hub) |
1da177e4 | 1870 | return -ENOMEM; |
1da177e4 | 1871 | |
e8054854 | 1872 | kref_init(&hub->kref); |
1da177e4 LT |
1873 | hub->intfdev = &intf->dev; |
1874 | hub->hdev = hdev; | |
c4028958 | 1875 | INIT_DELAYED_WORK(&hub->leds, led_work); |
8520f380 | 1876 | INIT_DELAYED_WORK(&hub->init_work, NULL); |
32a69589 | 1877 | INIT_WORK(&hub->events, hub_event); |
3a6bf4a0 | 1878 | INIT_LIST_HEAD(&hub->onboard_hub_devs); |
8eb58994 NSJ |
1879 | spin_lock_init(&hub->irq_urb_lock); |
1880 | timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0); | |
e8054854 | 1881 | usb_get_intf(intf); |
5d14f323 | 1882 | usb_get_dev(hdev); |
1da177e4 | 1883 | |
17248569 | 1884 | usb_set_intfdata(intf, hub); |
40f122f3 | 1885 | intf->needs_remote_wakeup = 1; |
971fcd49 | 1886 | pm_suspend_ignore_children(&intf->dev, true); |
1da177e4 LT |
1887 | |
1888 | if (hdev->speed == USB_SPEED_HIGH) | |
1889 | highspeed_hubs++; | |
1890 | ||
e6f30dea ML |
1891 | if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND) |
1892 | hub->quirk_check_port_auto_suspend = 1; | |
1893 | ||
1208f9e1 HG |
1894 | if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) { |
1895 | hub->quirk_disable_autosuspend = 1; | |
63d6d7ed | 1896 | usb_autopm_get_interface_no_resume(intf); |
1208f9e1 HG |
1897 | } |
1898 | ||
3a6bf4a0 MK |
1899 | if (hub_configure(hub, &desc->endpoint[0].desc) >= 0) { |
1900 | onboard_hub_create_pdevs(hdev, &hub->onboard_hub_devs); | |
1901 | ||
1da177e4 | 1902 | return 0; |
3a6bf4a0 | 1903 | } |
1da177e4 | 1904 | |
17248569 | 1905 | hub_disconnect(intf); |
1da177e4 LT |
1906 | return -ENODEV; |
1907 | } | |
1908 | ||
1909 | static int | |
1910 | hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data) | |
1911 | { | |
17248569 | 1912 | struct usb_device *hdev = interface_to_usbdev(intf); |
ad493e5e | 1913 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
1da177e4 LT |
1914 | |
1915 | /* assert ifno == 0 (part of hub spec) */ | |
1916 | switch (code) { | |
1917 | case USBDEVFS_HUB_PORTINFO: { | |
1918 | struct usbdevfs_hub_portinfo *info = user_data; | |
1919 | int i; | |
1920 | ||
1921 | spin_lock_irq(&device_state_lock); | |
1922 | if (hdev->devnum <= 0) | |
1923 | info->nports = 0; | |
1924 | else { | |
1925 | info->nports = hdev->maxchild; | |
1926 | for (i = 0; i < info->nports; i++) { | |
ff823c79 | 1927 | if (hub->ports[i]->child == NULL) |
1da177e4 LT |
1928 | info->port[i] = 0; |
1929 | else | |
1930 | info->port[i] = | |
ff823c79 | 1931 | hub->ports[i]->child->devnum; |
1da177e4 LT |
1932 | } |
1933 | } | |
1934 | spin_unlock_irq(&device_state_lock); | |
1935 | ||
1936 | return info->nports + 1; | |
1937 | } | |
1938 | ||
1939 | default: | |
1940 | return -ENOSYS; | |
1941 | } | |
1942 | } | |
1943 | ||
7cbe5dca AS |
1944 | /* |
1945 | * Allow user programs to claim ports on a hub. When a device is attached | |
1946 | * to one of these "claimed" ports, the program will "own" the device. | |
1947 | */ | |
1948 | static int find_port_owner(struct usb_device *hdev, unsigned port1, | |
9b6f0c4b | 1949 | struct usb_dev_state ***ppowner) |
7cbe5dca | 1950 | { |
41341261 MN |
1951 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
1952 | ||
7cbe5dca AS |
1953 | if (hdev->state == USB_STATE_NOTATTACHED) |
1954 | return -ENODEV; | |
1955 | if (port1 == 0 || port1 > hdev->maxchild) | |
1956 | return -EINVAL; | |
1957 | ||
41341261 | 1958 | /* Devices not managed by the hub driver |
7cbe5dca AS |
1959 | * will always have maxchild equal to 0. |
1960 | */ | |
41341261 | 1961 | *ppowner = &(hub->ports[port1 - 1]->port_owner); |
7cbe5dca AS |
1962 | return 0; |
1963 | } | |
1964 | ||
1965 | /* In the following three functions, the caller must hold hdev's lock */ | |
336c5c31 | 1966 | int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, |
9b6f0c4b | 1967 | struct usb_dev_state *owner) |
7cbe5dca AS |
1968 | { |
1969 | int rc; | |
9b6f0c4b | 1970 | struct usb_dev_state **powner; |
7cbe5dca AS |
1971 | |
1972 | rc = find_port_owner(hdev, port1, &powner); | |
1973 | if (rc) | |
1974 | return rc; | |
1975 | if (*powner) | |
1976 | return -EBUSY; | |
1977 | *powner = owner; | |
1978 | return rc; | |
1979 | } | |
6080cd0e | 1980 | EXPORT_SYMBOL_GPL(usb_hub_claim_port); |
7cbe5dca | 1981 | |
336c5c31 | 1982 | int usb_hub_release_port(struct usb_device *hdev, unsigned port1, |
9b6f0c4b | 1983 | struct usb_dev_state *owner) |
7cbe5dca AS |
1984 | { |
1985 | int rc; | |
9b6f0c4b | 1986 | struct usb_dev_state **powner; |
7cbe5dca AS |
1987 | |
1988 | rc = find_port_owner(hdev, port1, &powner); | |
1989 | if (rc) | |
1990 | return rc; | |
1991 | if (*powner != owner) | |
1992 | return -ENOENT; | |
1993 | *powner = NULL; | |
1994 | return rc; | |
1995 | } | |
6080cd0e | 1996 | EXPORT_SYMBOL_GPL(usb_hub_release_port); |
7cbe5dca | 1997 | |
9b6f0c4b | 1998 | void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner) |
7cbe5dca | 1999 | { |
ad493e5e | 2000 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
7cbe5dca | 2001 | int n; |
7cbe5dca | 2002 | |
fa2a9566 LT |
2003 | for (n = 0; n < hdev->maxchild; n++) { |
2004 | if (hub->ports[n]->port_owner == owner) | |
2005 | hub->ports[n]->port_owner = NULL; | |
7cbe5dca | 2006 | } |
fa2a9566 | 2007 | |
7cbe5dca AS |
2008 | } |
2009 | ||
2010 | /* The caller must hold udev's lock */ | |
2011 | bool usb_device_is_owned(struct usb_device *udev) | |
2012 | { | |
2013 | struct usb_hub *hub; | |
2014 | ||
2015 | if (udev->state == USB_STATE_NOTATTACHED || !udev->parent) | |
2016 | return false; | |
ad493e5e | 2017 | hub = usb_hub_to_struct_hub(udev->parent); |
fa2a9566 | 2018 | return !!hub->ports[udev->portnum - 1]->port_owner; |
7cbe5dca AS |
2019 | } |
2020 | ||
1da177e4 LT |
2021 | static void recursively_mark_NOTATTACHED(struct usb_device *udev) |
2022 | { | |
ad493e5e | 2023 | struct usb_hub *hub = usb_hub_to_struct_hub(udev); |
1da177e4 LT |
2024 | int i; |
2025 | ||
2026 | for (i = 0; i < udev->maxchild; ++i) { | |
ff823c79 LT |
2027 | if (hub->ports[i]->child) |
2028 | recursively_mark_NOTATTACHED(hub->ports[i]->child); | |
1da177e4 | 2029 | } |
9bbdf1e0 | 2030 | if (udev->state == USB_STATE_SUSPENDED) |
15123006 | 2031 | udev->active_duration -= jiffies; |
1da177e4 LT |
2032 | udev->state = USB_STATE_NOTATTACHED; |
2033 | } | |
2034 | ||
2035 | /** | |
2036 | * usb_set_device_state - change a device's current state (usbcore, hcds) | |
2037 | * @udev: pointer to device whose state should be changed | |
2038 | * @new_state: new state value to be stored | |
2039 | * | |
2040 | * udev->state is _not_ fully protected by the device lock. Although | |
2041 | * most transitions are made only while holding the lock, the state can | |
2042 | * can change to USB_STATE_NOTATTACHED at almost any time. This | |
2043 | * is so that devices can be marked as disconnected as soon as possible, | |
2044 | * without having to wait for any semaphores to be released. As a result, | |
2045 | * all changes to any device's state must be protected by the | |
2046 | * device_state_lock spinlock. | |
2047 | * | |
2048 | * Once a device has been added to the device tree, all changes to its state | |
2049 | * should be made using this routine. The state should _not_ be set directly. | |
2050 | * | |
2051 | * If udev->state is already USB_STATE_NOTATTACHED then no change is made. | |
2052 | * Otherwise udev->state is set to new_state, and if new_state is | |
2053 | * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set | |
2054 | * to USB_STATE_NOTATTACHED. | |
2055 | */ | |
2056 | void usb_set_device_state(struct usb_device *udev, | |
2057 | enum usb_device_state new_state) | |
2058 | { | |
2059 | unsigned long flags; | |
4681b171 | 2060 | int wakeup = -1; |
1da177e4 LT |
2061 | |
2062 | spin_lock_irqsave(&device_state_lock, flags); | |
2063 | if (udev->state == USB_STATE_NOTATTACHED) | |
2064 | ; /* do nothing */ | |
b94dc6b5 | 2065 | else if (new_state != USB_STATE_NOTATTACHED) { |
fb669cc0 DB |
2066 | |
2067 | /* root hub wakeup capabilities are managed out-of-band | |
2068 | * and may involve silicon errata ... ignore them here. | |
2069 | */ | |
2070 | if (udev->parent) { | |
645daaab AS |
2071 | if (udev->state == USB_STATE_SUSPENDED |
2072 | || new_state == USB_STATE_SUSPENDED) | |
2073 | ; /* No change to wakeup settings */ | |
2074 | else if (new_state == USB_STATE_CONFIGURED) | |
ddbe1fca LB |
2075 | wakeup = (udev->quirks & |
2076 | USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 : | |
2077 | udev->actconfig->desc.bmAttributes & | |
2078 | USB_CONFIG_ATT_WAKEUP; | |
645daaab | 2079 | else |
4681b171 | 2080 | wakeup = 0; |
fb669cc0 | 2081 | } |
15123006 SS |
2082 | if (udev->state == USB_STATE_SUSPENDED && |
2083 | new_state != USB_STATE_SUSPENDED) | |
2084 | udev->active_duration -= jiffies; | |
2085 | else if (new_state == USB_STATE_SUSPENDED && | |
2086 | udev->state != USB_STATE_SUSPENDED) | |
2087 | udev->active_duration += jiffies; | |
645daaab | 2088 | udev->state = new_state; |
b94dc6b5 | 2089 | } else |
1da177e4 LT |
2090 | recursively_mark_NOTATTACHED(udev); |
2091 | spin_unlock_irqrestore(&device_state_lock, flags); | |
4681b171 RW |
2092 | if (wakeup >= 0) |
2093 | device_set_wakeup_capable(&udev->dev, wakeup); | |
1da177e4 | 2094 | } |
6da9c990 | 2095 | EXPORT_SYMBOL_GPL(usb_set_device_state); |
1da177e4 | 2096 | |
8af548dc | 2097 | /* |
3b29b68b AS |
2098 | * Choose a device number. |
2099 | * | |
2100 | * Device numbers are used as filenames in usbfs. On USB-1.1 and | |
2101 | * USB-2.0 buses they are also used as device addresses, however on | |
2102 | * USB-3.0 buses the address is assigned by the controller hardware | |
2103 | * and it usually is not the same as the device number. | |
2104 | * | |
8af548dc IPG |
2105 | * WUSB devices are simple: they have no hubs behind, so the mapping |
2106 | * device <-> virtual port number becomes 1:1. Why? to simplify the | |
2107 | * life of the device connection logic in | |
2108 | * drivers/usb/wusbcore/devconnect.c. When we do the initial secret | |
2109 | * handshake we need to assign a temporary address in the unauthorized | |
2110 | * space. For simplicity we use the first virtual port number found to | |
2111 | * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()] | |
2112 | * and that becomes it's address [X < 128] or its unauthorized address | |
2113 | * [X | 0x80]. | |
2114 | * | |
2115 | * We add 1 as an offset to the one-based USB-stack port number | |
2116 | * (zero-based wusb virtual port index) for two reasons: (a) dev addr | |
2117 | * 0 is reserved by USB for default address; (b) Linux's USB stack | |
2118 | * uses always #1 for the root hub of the controller. So USB stack's | |
2119 | * port #1, which is wusb virtual-port #0 has address #2. | |
c6515272 SS |
2120 | * |
2121 | * Devices connected under xHCI are not as simple. The host controller | |
2122 | * supports virtualization, so the hardware assigns device addresses and | |
2123 | * the HCD must setup data structures before issuing a set address | |
2124 | * command to the hardware. | |
8af548dc | 2125 | */ |
3b29b68b | 2126 | static void choose_devnum(struct usb_device *udev) |
1da177e4 LT |
2127 | { |
2128 | int devnum; | |
2129 | struct usb_bus *bus = udev->bus; | |
2130 | ||
638139eb | 2131 | /* be safe when more hub events are proceed in parallel */ |
feb26ac3 | 2132 | mutex_lock(&bus->devnum_next_mutex); |
8af548dc IPG |
2133 | if (udev->wusb) { |
2134 | devnum = udev->portnum + 1; | |
2135 | BUG_ON(test_bit(devnum, bus->devmap.devicemap)); | |
2136 | } else { | |
2137 | /* Try to allocate the next devnum beginning at | |
2138 | * bus->devnum_next. */ | |
2139 | devnum = find_next_zero_bit(bus->devmap.devicemap, 128, | |
2140 | bus->devnum_next); | |
2141 | if (devnum >= 128) | |
2142 | devnum = find_next_zero_bit(bus->devmap.devicemap, | |
2143 | 128, 1); | |
469271f8 | 2144 | bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1); |
8af548dc | 2145 | } |
1da177e4 LT |
2146 | if (devnum < 128) { |
2147 | set_bit(devnum, bus->devmap.devicemap); | |
2148 | udev->devnum = devnum; | |
2149 | } | |
feb26ac3 | 2150 | mutex_unlock(&bus->devnum_next_mutex); |
1da177e4 LT |
2151 | } |
2152 | ||
3b29b68b | 2153 | static void release_devnum(struct usb_device *udev) |
1da177e4 LT |
2154 | { |
2155 | if (udev->devnum > 0) { | |
2156 | clear_bit(udev->devnum, udev->bus->devmap.devicemap); | |
2157 | udev->devnum = -1; | |
2158 | } | |
2159 | } | |
2160 | ||
3b29b68b | 2161 | static void update_devnum(struct usb_device *udev, int devnum) |
4953d141 DV |
2162 | { |
2163 | /* The address for a WUSB device is managed by wusbcore. */ | |
2164 | if (!udev->wusb) | |
2165 | udev->devnum = devnum; | |
4998f1ef JL |
2166 | if (!udev->devaddr) |
2167 | udev->devaddr = (u8)devnum; | |
4953d141 DV |
2168 | } |
2169 | ||
f7410ced HX |
2170 | static void hub_free_dev(struct usb_device *udev) |
2171 | { | |
2172 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
2173 | ||
2174 | /* Root hubs aren't real devices, so don't free HCD resources */ | |
2175 | if (hcd->driver->free_dev && udev->parent) | |
2176 | hcd->driver->free_dev(hcd, udev); | |
2177 | } | |
2178 | ||
7027df36 DW |
2179 | static void hub_disconnect_children(struct usb_device *udev) |
2180 | { | |
2181 | struct usb_hub *hub = usb_hub_to_struct_hub(udev); | |
2182 | int i; | |
2183 | ||
2184 | /* Free up all the children before we remove this device */ | |
2185 | for (i = 0; i < udev->maxchild; i++) { | |
2186 | if (hub->ports[i]->child) | |
2187 | usb_disconnect(&hub->ports[i]->child); | |
2188 | } | |
2189 | } | |
2190 | ||
1da177e4 LT |
2191 | /** |
2192 | * usb_disconnect - disconnect a device (usbcore-internal) | |
2193 | * @pdev: pointer to device being disconnected | |
41631d36 AD |
2194 | * |
2195 | * Context: task context, might sleep | |
1da177e4 LT |
2196 | * |
2197 | * Something got disconnected. Get rid of it and all of its children. | |
2198 | * | |
2199 | * If *pdev is a normal device then the parent hub must already be locked. | |
a4b5d606 | 2200 | * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock, |
db8f2aa3 | 2201 | * which protects the set of root hubs as well as the list of buses. |
1da177e4 LT |
2202 | * |
2203 | * Only hub drivers (including virtual root hub drivers for host | |
2204 | * controllers) should ever call this. | |
2205 | * | |
2206 | * This call is synchronous, and may not be used in an interrupt context. | |
2207 | */ | |
2208 | void usb_disconnect(struct usb_device **pdev) | |
2209 | { | |
7027df36 DW |
2210 | struct usb_port *port_dev = NULL; |
2211 | struct usb_device *udev = *pdev; | |
5b1dc209 PC |
2212 | struct usb_hub *hub = NULL; |
2213 | int port1 = 1; | |
1da177e4 | 2214 | |
1da177e4 LT |
2215 | /* mark the device as inactive, so any further urb submissions for |
2216 | * this device (and any of its children) will fail immediately. | |
25985edc | 2217 | * this quiesces everything except pending urbs. |
1da177e4 LT |
2218 | */ |
2219 | usb_set_device_state(udev, USB_STATE_NOTATTACHED); | |
3b29b68b AS |
2220 | dev_info(&udev->dev, "USB disconnect, device number %d\n", |
2221 | udev->devnum); | |
1da177e4 | 2222 | |
f5cccf49 GR |
2223 | /* |
2224 | * Ensure that the pm runtime code knows that the USB device | |
2225 | * is in the process of being disconnected. | |
2226 | */ | |
2227 | pm_runtime_barrier(&udev->dev); | |
2228 | ||
9ad3d6cc AS |
2229 | usb_lock_device(udev); |
2230 | ||
7027df36 | 2231 | hub_disconnect_children(udev); |
1da177e4 LT |
2232 | |
2233 | /* deallocate hcd/hardware state ... nuking all pending urbs and | |
2234 | * cleaning up all state associated with the current configuration | |
2235 | * so that the hardware is now fully quiesced. | |
2236 | */ | |
17248569 | 2237 | dev_dbg(&udev->dev, "unregistering device\n"); |
1da177e4 | 2238 | usb_disable_device(udev, 0); |
cde217a5 | 2239 | usb_hcd_synchronize_unlinks(udev); |
1da177e4 | 2240 | |
fde26380 | 2241 | if (udev->parent) { |
7027df36 DW |
2242 | port1 = udev->portnum; |
2243 | hub = usb_hub_to_struct_hub(udev->parent); | |
2244 | port_dev = hub->ports[port1 - 1]; | |
fde26380 LT |
2245 | |
2246 | sysfs_remove_link(&udev->dev.kobj, "port"); | |
2247 | sysfs_remove_link(&port_dev->dev.kobj, "device"); | |
971fcd49 | 2248 | |
7027df36 DW |
2249 | /* |
2250 | * As usb_port_runtime_resume() de-references udev, make | |
2251 | * sure no resumes occur during removal | |
2252 | */ | |
2253 | if (!test_and_set_bit(port1, hub->child_usage_bits)) | |
2254 | pm_runtime_get_sync(&port_dev->dev); | |
fde26380 LT |
2255 | } |
2256 | ||
3b23dd6f | 2257 | usb_remove_ep_devs(&udev->ep0); |
782da727 AS |
2258 | usb_unlock_device(udev); |
2259 | ||
2260 | /* Unregister the device. The device driver is responsible | |
3b23dd6f AS |
2261 | * for de-configuring the device and invoking the remove-device |
2262 | * notifier chain (used by usbfs and possibly others). | |
782da727 AS |
2263 | */ |
2264 | device_del(&udev->dev); | |
3099e75a | 2265 | |
782da727 | 2266 | /* Free the device number and delete the parent's children[] |
1da177e4 LT |
2267 | * (or root_hub) pointer. |
2268 | */ | |
3b29b68b | 2269 | release_devnum(udev); |
1da177e4 LT |
2270 | |
2271 | /* Avoid races with recursively_mark_NOTATTACHED() */ | |
2272 | spin_lock_irq(&device_state_lock); | |
2273 | *pdev = NULL; | |
2274 | spin_unlock_irq(&device_state_lock); | |
2275 | ||
7027df36 DW |
2276 | if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits)) |
2277 | pm_runtime_put(&port_dev->dev); | |
2278 | ||
f7410ced HX |
2279 | hub_free_dev(udev); |
2280 | ||
782da727 | 2281 | put_device(&udev->dev); |
1da177e4 LT |
2282 | } |
2283 | ||
f2a383e4 | 2284 | #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES |
1da177e4 LT |
2285 | static void show_string(struct usb_device *udev, char *id, char *string) |
2286 | { | |
2287 | if (!string) | |
2288 | return; | |
f2ec522e | 2289 | dev_info(&udev->dev, "%s: %s\n", id, string); |
1da177e4 LT |
2290 | } |
2291 | ||
f2a383e4 GKH |
2292 | static void announce_device(struct usb_device *udev) |
2293 | { | |
73c6d3b2 BL |
2294 | u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice); |
2295 | ||
2296 | dev_info(&udev->dev, | |
2297 | "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n", | |
f2a383e4 | 2298 | le16_to_cpu(udev->descriptor.idVendor), |
73c6d3b2 BL |
2299 | le16_to_cpu(udev->descriptor.idProduct), |
2300 | bcdDevice >> 8, bcdDevice & 0xff); | |
b9cef6c3 WF |
2301 | dev_info(&udev->dev, |
2302 | "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n", | |
f2a383e4 GKH |
2303 | udev->descriptor.iManufacturer, |
2304 | udev->descriptor.iProduct, | |
2305 | udev->descriptor.iSerialNumber); | |
2306 | show_string(udev, "Product", udev->product); | |
2307 | show_string(udev, "Manufacturer", udev->manufacturer); | |
2308 | show_string(udev, "SerialNumber", udev->serial); | |
2309 | } | |
1da177e4 | 2310 | #else |
f2a383e4 | 2311 | static inline void announce_device(struct usb_device *udev) { } |
1da177e4 LT |
2312 | #endif |
2313 | ||
1da177e4 | 2314 | |
3ede760f | 2315 | /** |
8d8558d1 | 2316 | * usb_enumerate_device_otg - FIXME (usbcore-internal) |
3ede760f ON |
2317 | * @udev: newly addressed device (in ADDRESS state) |
2318 | * | |
8d8558d1 | 2319 | * Finish enumeration for On-The-Go devices |
626f090c YB |
2320 | * |
2321 | * Return: 0 if successful. A negative error code otherwise. | |
3ede760f | 2322 | */ |
8d8558d1 | 2323 | static int usb_enumerate_device_otg(struct usb_device *udev) |
1da177e4 | 2324 | { |
d9d16e8a | 2325 | int err = 0; |
1da177e4 LT |
2326 | |
2327 | #ifdef CONFIG_USB_OTG | |
2328 | /* | |
2329 | * OTG-aware devices on OTG-capable root hubs may be able to use SRP, | |
2330 | * to wake us after we've powered off VBUS; and HNP, switching roles | |
2331 | * "host" to "peripheral". The OTG descriptor helps figure this out. | |
2332 | */ | |
2333 | if (!udev->bus->is_b_host | |
2334 | && udev->config | |
2335 | && udev->parent == udev->bus->root_hub) { | |
2eb5052e | 2336 | struct usb_otg_descriptor *desc = NULL; |
1da177e4 | 2337 | struct usb_bus *bus = udev->bus; |
7d2d641c | 2338 | unsigned port1 = udev->portnum; |
1da177e4 LT |
2339 | |
2340 | /* descriptor may appear anywhere in config */ | |
7d2d641c LJ |
2341 | err = __usb_get_extra_descriptor(udev->rawdescriptors[0], |
2342 | le16_to_cpu(udev->config[0].desc.wTotalLength), | |
704620af | 2343 | USB_DT_OTG, (void **) &desc, sizeof(*desc)); |
7d2d641c LJ |
2344 | if (err || !(desc->bmAttributes & USB_OTG_HNP)) |
2345 | return 0; | |
2346 | ||
2347 | dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n", | |
2348 | (port1 == bus->otg_port) ? "" : "non-"); | |
2349 | ||
2350 | /* enable HNP before suspend, it's simpler */ | |
2351 | if (port1 == bus->otg_port) { | |
2352 | bus->b_hnp_enable = 1; | |
1afe33a7 ON |
2353 | err = usb_control_msg(udev, |
2354 | usb_sndctrlpipe(udev, 0), | |
2355 | USB_REQ_SET_FEATURE, 0, | |
2356 | USB_DEVICE_B_HNP_ENABLE, | |
2357 | 0, NULL, 0, | |
2358 | USB_CTRL_SET_TIMEOUT); | |
2359 | if (err < 0) { | |
7d2d641c LJ |
2360 | /* |
2361 | * OTG MESSAGE: report errors here, | |
2362 | * customize to match your product. | |
2363 | */ | |
2364 | dev_err(&udev->dev, "can't set HNP mode: %d\n", | |
2365 | err); | |
2366 | bus->b_hnp_enable = 0; | |
1da177e4 | 2367 | } |
7d2d641c LJ |
2368 | } else if (desc->bLength == sizeof |
2369 | (struct usb_otg_descriptor)) { | |
2370 | /* Set a_alt_hnp_support for legacy otg device */ | |
1afe33a7 ON |
2371 | err = usb_control_msg(udev, |
2372 | usb_sndctrlpipe(udev, 0), | |
2373 | USB_REQ_SET_FEATURE, 0, | |
2374 | USB_DEVICE_A_ALT_HNP_SUPPORT, | |
2375 | 0, NULL, 0, | |
2376 | USB_CTRL_SET_TIMEOUT); | |
2377 | if (err < 0) | |
7d2d641c LJ |
2378 | dev_err(&udev->dev, |
2379 | "set a_alt_hnp_support failed: %d\n", | |
2380 | err); | |
1da177e4 LT |
2381 | } |
2382 | } | |
1da177e4 | 2383 | #endif |
d9d16e8a IPG |
2384 | return err; |
2385 | } | |
2386 | ||
2387 | ||
2388 | /** | |
8d8558d1 | 2389 | * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal) |
d9d16e8a IPG |
2390 | * @udev: newly addressed device (in ADDRESS state) |
2391 | * | |
45bf39f8 AS |
2392 | * This is only called by usb_new_device() -- all comments that apply there |
2393 | * apply here wrt to environment. | |
d9d16e8a IPG |
2394 | * |
2395 | * If the device is WUSB and not authorized, we don't attempt to read | |
2396 | * the string descriptors, as they will be errored out by the device | |
2397 | * until it has been authorized. | |
626f090c YB |
2398 | * |
2399 | * Return: 0 if successful. A negative error code otherwise. | |
d9d16e8a | 2400 | */ |
8d8558d1 | 2401 | static int usb_enumerate_device(struct usb_device *udev) |
d9d16e8a IPG |
2402 | { |
2403 | int err; | |
026f3fcb | 2404 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); |
1da177e4 | 2405 | |
d9d16e8a IPG |
2406 | if (udev->config == NULL) { |
2407 | err = usb_get_configuration(udev); | |
2408 | if (err < 0) { | |
e9e88fb7 AS |
2409 | if (err != -ENODEV) |
2410 | dev_err(&udev->dev, "can't read configurations, error %d\n", | |
2411 | err); | |
80da2e0d | 2412 | return err; |
d9d16e8a IPG |
2413 | } |
2414 | } | |
83e83ecb TP |
2415 | |
2416 | /* read the standard strings and cache them if present */ | |
2417 | udev->product = usb_cache_string(udev, udev->descriptor.iProduct); | |
2418 | udev->manufacturer = usb_cache_string(udev, | |
2419 | udev->descriptor.iManufacturer); | |
2420 | udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber); | |
2421 | ||
8d8558d1 | 2422 | err = usb_enumerate_device_otg(udev); |
80da2e0d LP |
2423 | if (err < 0) |
2424 | return err; | |
2425 | ||
f8f02d5c | 2426 | if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support && |
e5a9d621 | 2427 | !is_targeted(udev)) { |
026f3fcb PC |
2428 | /* Maybe it can talk to us, though we can't talk to it. |
2429 | * (Includes HNP test device.) | |
2430 | */ | |
e5a9d621 PC |
2431 | if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable |
2432 | || udev->bus->is_b_host)) { | |
026f3fcb PC |
2433 | err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND); |
2434 | if (err < 0) | |
2435 | dev_dbg(&udev->dev, "HNP fail, %d\n", err); | |
2436 | } | |
2437 | return -ENOTSUPP; | |
2438 | } | |
2439 | ||
80da2e0d LP |
2440 | usb_detect_interface_quirks(udev); |
2441 | ||
2442 | return 0; | |
d9d16e8a IPG |
2443 | } |
2444 | ||
d35e70d5 MG |
2445 | static void set_usb_port_removable(struct usb_device *udev) |
2446 | { | |
2447 | struct usb_device *hdev = udev->parent; | |
2448 | struct usb_hub *hub; | |
2449 | u8 port = udev->portnum; | |
2450 | u16 wHubCharacteristics; | |
2451 | bool removable = true; | |
2452 | ||
70f400d4 RJ |
2453 | dev_set_removable(&udev->dev, DEVICE_REMOVABLE_UNKNOWN); |
2454 | ||
d35e70d5 MG |
2455 | if (!hdev) |
2456 | return; | |
2457 | ||
ad493e5e | 2458 | hub = usb_hub_to_struct_hub(udev->parent); |
d35e70d5 | 2459 | |
92bfbf71 MG |
2460 | /* |
2461 | * If the platform firmware has provided information about a port, | |
2462 | * use that to determine whether it's removable. | |
2463 | */ | |
2464 | switch (hub->ports[udev->portnum - 1]->connect_type) { | |
2465 | case USB_PORT_CONNECT_TYPE_HOT_PLUG: | |
70f400d4 | 2466 | dev_set_removable(&udev->dev, DEVICE_REMOVABLE); |
92bfbf71 MG |
2467 | return; |
2468 | case USB_PORT_CONNECT_TYPE_HARD_WIRED: | |
58339c2e | 2469 | case USB_PORT_NOT_USED: |
70f400d4 | 2470 | dev_set_removable(&udev->dev, DEVICE_FIXED); |
92bfbf71 | 2471 | return; |
58339c2e MG |
2472 | default: |
2473 | break; | |
92bfbf71 MG |
2474 | } |
2475 | ||
2476 | /* | |
2477 | * Otherwise, check whether the hub knows whether a port is removable | |
2478 | * or not | |
2479 | */ | |
d35e70d5 MG |
2480 | wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics); |
2481 | ||
2482 | if (!(wHubCharacteristics & HUB_CHAR_COMPOUND)) | |
2483 | return; | |
2484 | ||
2485 | if (hub_is_superspeed(hdev)) { | |
ca3c1539 LT |
2486 | if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable) |
2487 | & (1 << port)) | |
d35e70d5 MG |
2488 | removable = false; |
2489 | } else { | |
2490 | if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8))) | |
2491 | removable = false; | |
2492 | } | |
2493 | ||
2494 | if (removable) | |
70f400d4 | 2495 | dev_set_removable(&udev->dev, DEVICE_REMOVABLE); |
d35e70d5 | 2496 | else |
70f400d4 | 2497 | dev_set_removable(&udev->dev, DEVICE_FIXED); |
a4204ff0 | 2498 | |
d35e70d5 | 2499 | } |
d9d16e8a IPG |
2500 | |
2501 | /** | |
2502 | * usb_new_device - perform initial device setup (usbcore-internal) | |
2503 | * @udev: newly addressed device (in ADDRESS state) | |
2504 | * | |
8d8558d1 AS |
2505 | * This is called with devices which have been detected but not fully |
2506 | * enumerated. The device descriptor is available, but not descriptors | |
d9d16e8a IPG |
2507 | * for any device configuration. The caller must have locked either |
2508 | * the parent hub (if udev is a normal device) or else the | |
a4b5d606 | 2509 | * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to |
d9d16e8a IPG |
2510 | * udev has already been installed, but udev is not yet visible through |
2511 | * sysfs or other filesystem code. | |
2512 | * | |
d9d16e8a IPG |
2513 | * This call is synchronous, and may not be used in an interrupt context. |
2514 | * | |
2515 | * Only the hub driver or root-hub registrar should ever call this. | |
626f090c YB |
2516 | * |
2517 | * Return: Whether the device is configured properly or not. Zero if the | |
2518 | * interface was registered with the driver core; else a negative errno | |
2519 | * value. | |
2520 | * | |
d9d16e8a IPG |
2521 | */ |
2522 | int usb_new_device(struct usb_device *udev) | |
2523 | { | |
2524 | int err; | |
2525 | ||
16985408 | 2526 | if (udev->parent) { |
16985408 DS |
2527 | /* Initialize non-root-hub device wakeup to disabled; |
2528 | * device (un)configuration controls wakeup capable | |
2529 | * sysfs power/wakeup controls wakeup enabled/disabled | |
2530 | */ | |
2531 | device_init_wakeup(&udev->dev, 0); | |
16985408 DS |
2532 | } |
2533 | ||
9bbdf1e0 AS |
2534 | /* Tell the runtime-PM framework the device is active */ |
2535 | pm_runtime_set_active(&udev->dev); | |
c08512c7 | 2536 | pm_runtime_get_noresume(&udev->dev); |
fcc4a01e | 2537 | pm_runtime_use_autosuspend(&udev->dev); |
9bbdf1e0 AS |
2538 | pm_runtime_enable(&udev->dev); |
2539 | ||
c08512c7 AS |
2540 | /* By default, forbid autosuspend for all devices. It will be |
2541 | * allowed for hubs during binding. | |
2542 | */ | |
2543 | usb_disable_autosuspend(udev); | |
2544 | ||
8d8558d1 | 2545 | err = usb_enumerate_device(udev); /* Read descriptors */ |
d9d16e8a IPG |
2546 | if (err < 0) |
2547 | goto fail; | |
c6515272 SS |
2548 | dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n", |
2549 | udev->devnum, udev->bus->busnum, | |
2550 | (((udev->bus->busnum-1) * 128) + (udev->devnum-1))); | |
9f8b17e6 KS |
2551 | /* export the usbdev device-node for libusb */ |
2552 | udev->dev.devt = MKDEV(USB_DEVICE_MAJOR, | |
2553 | (((udev->bus->busnum-1) * 128) + (udev->devnum-1))); | |
2554 | ||
6cd13201 AS |
2555 | /* Tell the world! */ |
2556 | announce_device(udev); | |
195af2cc | 2557 | |
b04b3156 TT |
2558 | if (udev->serial) |
2559 | add_device_randomness(udev->serial, strlen(udev->serial)); | |
2560 | if (udev->product) | |
2561 | add_device_randomness(udev->product, strlen(udev->product)); | |
2562 | if (udev->manufacturer) | |
2563 | add_device_randomness(udev->manufacturer, | |
2564 | strlen(udev->manufacturer)); | |
2565 | ||
927bc916 | 2566 | device_enable_async_suspend(&udev->dev); |
d35e70d5 | 2567 | |
a4204ff0 | 2568 | /* check whether the hub or firmware marks this port as non-removable */ |
70f400d4 | 2569 | set_usb_port_removable(udev); |
d35e70d5 | 2570 | |
782da727 | 2571 | /* Register the device. The device driver is responsible |
3b23dd6f AS |
2572 | * for configuring the device and invoking the add-device |
2573 | * notifier chain (used by usbfs and possibly others). | |
782da727 | 2574 | */ |
9f8b17e6 | 2575 | err = device_add(&udev->dev); |
1da177e4 LT |
2576 | if (err) { |
2577 | dev_err(&udev->dev, "can't device_add, error %d\n", err); | |
2578 | goto fail; | |
2579 | } | |
9ad3d6cc | 2580 | |
fde26380 LT |
2581 | /* Create link files between child device and usb port device. */ |
2582 | if (udev->parent) { | |
ad493e5e | 2583 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); |
d5c3834e DW |
2584 | int port1 = udev->portnum; |
2585 | struct usb_port *port_dev = hub->ports[port1 - 1]; | |
fde26380 LT |
2586 | |
2587 | err = sysfs_create_link(&udev->dev.kobj, | |
2588 | &port_dev->dev.kobj, "port"); | |
2589 | if (err) | |
2590 | goto fail; | |
2591 | ||
2592 | err = sysfs_create_link(&port_dev->dev.kobj, | |
2593 | &udev->dev.kobj, "device"); | |
2594 | if (err) { | |
2595 | sysfs_remove_link(&udev->dev.kobj, "port"); | |
2596 | goto fail; | |
2597 | } | |
971fcd49 | 2598 | |
d5c3834e DW |
2599 | if (!test_and_set_bit(port1, hub->child_usage_bits)) |
2600 | pm_runtime_get_sync(&port_dev->dev); | |
fde26380 LT |
2601 | } |
2602 | ||
3b23dd6f | 2603 | (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev); |
c08512c7 AS |
2604 | usb_mark_last_busy(udev); |
2605 | pm_runtime_put_sync_autosuspend(&udev->dev); | |
c066475e | 2606 | return err; |
1da177e4 LT |
2607 | |
2608 | fail: | |
2609 | usb_set_device_state(udev, USB_STATE_NOTATTACHED); | |
9bbdf1e0 AS |
2610 | pm_runtime_disable(&udev->dev); |
2611 | pm_runtime_set_suspended(&udev->dev); | |
d9d16e8a | 2612 | return err; |
1da177e4 LT |
2613 | } |
2614 | ||
93993a0a IPG |
2615 | |
2616 | /** | |
fd39c86b RD |
2617 | * usb_deauthorize_device - deauthorize a device (usbcore-internal) |
2618 | * @usb_dev: USB device | |
2619 | * | |
2620 | * Move the USB device to a very basic state where interfaces are disabled | |
2621 | * and the device is in fact unconfigured and unusable. | |
93993a0a IPG |
2622 | * |
2623 | * We share a lock (that we have) with device_del(), so we need to | |
2624 | * defer its call. | |
626f090c YB |
2625 | * |
2626 | * Return: 0. | |
93993a0a IPG |
2627 | */ |
2628 | int usb_deauthorize_device(struct usb_device *usb_dev) | |
2629 | { | |
93993a0a IPG |
2630 | usb_lock_device(usb_dev); |
2631 | if (usb_dev->authorized == 0) | |
2632 | goto out_unauthorized; | |
da307123 | 2633 | |
93993a0a IPG |
2634 | usb_dev->authorized = 0; |
2635 | usb_set_configuration(usb_dev, -1); | |
da307123 | 2636 | |
93993a0a IPG |
2637 | out_unauthorized: |
2638 | usb_unlock_device(usb_dev); | |
2639 | return 0; | |
2640 | } | |
2641 | ||
2642 | ||
2643 | int usb_authorize_device(struct usb_device *usb_dev) | |
2644 | { | |
2645 | int result = 0, c; | |
da307123 | 2646 | |
93993a0a IPG |
2647 | usb_lock_device(usb_dev); |
2648 | if (usb_dev->authorized == 1) | |
2649 | goto out_authorized; | |
da307123 | 2650 | |
93993a0a IPG |
2651 | result = usb_autoresume_device(usb_dev); |
2652 | if (result < 0) { | |
2653 | dev_err(&usb_dev->dev, | |
2654 | "can't autoresume for authorization: %d\n", result); | |
2655 | goto error_autoresume; | |
2656 | } | |
e50a322e JG |
2657 | |
2658 | if (usb_dev->wusb) { | |
2659 | result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor)); | |
2660 | if (result < 0) { | |
2661 | dev_err(&usb_dev->dev, "can't re-read device descriptor for " | |
2662 | "authorization: %d\n", result); | |
2663 | goto error_device_descriptor; | |
2664 | } | |
93993a0a | 2665 | } |
da307123 | 2666 | |
93993a0a | 2667 | usb_dev->authorized = 1; |
93993a0a IPG |
2668 | /* Choose and set the configuration. This registers the interfaces |
2669 | * with the driver core and lets interface drivers bind to them. | |
2670 | */ | |
b5ea060f | 2671 | c = usb_choose_configuration(usb_dev); |
93993a0a IPG |
2672 | if (c >= 0) { |
2673 | result = usb_set_configuration(usb_dev, c); | |
2674 | if (result) { | |
2675 | dev_err(&usb_dev->dev, | |
2676 | "can't set config #%d, error %d\n", c, result); | |
2677 | /* This need not be fatal. The user can try to | |
2678 | * set other configurations. */ | |
2679 | } | |
2680 | } | |
2681 | dev_info(&usb_dev->dev, "authorized to connect\n"); | |
da307123 | 2682 | |
93993a0a | 2683 | error_device_descriptor: |
da307123 | 2684 | usb_autosuspend_device(usb_dev); |
93993a0a IPG |
2685 | error_autoresume: |
2686 | out_authorized: | |
781b2137 | 2687 | usb_unlock_device(usb_dev); /* complements locktree */ |
93993a0a IPG |
2688 | return result; |
2689 | } | |
2690 | ||
0299809b TN |
2691 | /** |
2692 | * get_port_ssp_rate - Match the extended port status to SSP rate | |
2693 | * @hdev: The hub device | |
2694 | * @ext_portstatus: extended port status | |
2695 | * | |
2696 | * Match the extended port status speed id to the SuperSpeed Plus sublink speed | |
2697 | * capability attributes. Base on the number of connected lanes and speed, | |
2698 | * return the corresponding enum usb_ssp_rate. | |
2699 | */ | |
2700 | static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev, | |
2701 | u32 ext_portstatus) | |
2702 | { | |
2703 | struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap; | |
2704 | u32 attr; | |
2705 | u8 speed_id; | |
2706 | u8 ssac; | |
2707 | u8 lanes; | |
2708 | int i; | |
2709 | ||
2710 | if (!ssp_cap) | |
2711 | goto out; | |
2712 | ||
2713 | speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID; | |
2714 | lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1; | |
2715 | ||
2716 | ssac = le32_to_cpu(ssp_cap->bmAttributes) & | |
2717 | USB_SSP_SUBLINK_SPEED_ATTRIBS; | |
2718 | ||
2719 | for (i = 0; i <= ssac; i++) { | |
2720 | u8 ssid; | |
2721 | ||
2722 | attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]); | |
2723 | ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr); | |
2724 | if (speed_id == ssid) { | |
2725 | u16 mantissa; | |
2726 | u8 lse; | |
2727 | u8 type; | |
2728 | ||
2729 | /* | |
2730 | * Note: currently asymmetric lane types are only | |
2731 | * applicable for SSIC operate in SuperSpeed protocol | |
2732 | */ | |
2733 | type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr); | |
2734 | if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX || | |
2735 | type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX) | |
2736 | goto out; | |
2737 | ||
2738 | if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) != | |
2739 | USB_SSP_SUBLINK_SPEED_LP_SSP) | |
2740 | goto out; | |
2741 | ||
2742 | lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr); | |
2743 | mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr); | |
2744 | ||
2745 | /* Convert to Gbps */ | |
2746 | for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++) | |
2747 | mantissa /= 1000; | |
2748 | ||
2749 | if (mantissa >= 10 && lanes == 1) | |
2750 | return USB_SSP_GEN_2x1; | |
2751 | ||
2752 | if (mantissa >= 10 && lanes == 2) | |
2753 | return USB_SSP_GEN_2x2; | |
2754 | ||
2755 | if (mantissa >= 5 && lanes == 2) | |
2756 | return USB_SSP_GEN_1x2; | |
2757 | ||
2758 | goto out; | |
2759 | } | |
2760 | } | |
2761 | ||
2762 | out: | |
2763 | return USB_SSP_GEN_UNKNOWN; | |
2764 | } | |
2765 | ||
0165de09 IPG |
2766 | /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */ |
2767 | static unsigned hub_is_wusb(struct usb_hub *hub) | |
2768 | { | |
2769 | struct usb_hcd *hcd; | |
2770 | if (hub->hdev->parent != NULL) /* not a root hub? */ | |
2771 | return 0; | |
6ae706ae | 2772 | hcd = bus_to_hcd(hub->hdev->bus); |
0165de09 IPG |
2773 | return hcd->wireless; |
2774 | } | |
2775 | ||
2776 | ||
fb6f076d AS |
2777 | #ifdef CONFIG_USB_FEW_INIT_RETRIES |
2778 | #define PORT_RESET_TRIES 2 | |
2779 | #define SET_ADDRESS_TRIES 1 | |
2780 | #define GET_DESCRIPTOR_TRIES 1 | |
2781 | #define GET_MAXPACKET0_TRIES 1 | |
2782 | #define PORT_INIT_TRIES 4 | |
2783 | ||
2784 | #else | |
1da177e4 LT |
2785 | #define PORT_RESET_TRIES 5 |
2786 | #define SET_ADDRESS_TRIES 2 | |
2787 | #define GET_DESCRIPTOR_TRIES 2 | |
fb6f076d | 2788 | #define GET_MAXPACKET0_TRIES 3 |
19502e69 | 2789 | #define PORT_INIT_TRIES 4 |
fb6f076d | 2790 | #endif /* CONFIG_USB_FEW_INIT_RETRIES */ |
1da177e4 | 2791 | |
f59f93cd MN |
2792 | #define DETECT_DISCONNECT_TRIES 5 |
2793 | ||
74072bae | 2794 | #define HUB_ROOT_RESET_TIME 60 /* times are in msec */ |
1da177e4 | 2795 | #define HUB_SHORT_RESET_TIME 10 |
75d7cf72 | 2796 | #define HUB_BH_RESET_TIME 50 |
1da177e4 | 2797 | #define HUB_LONG_RESET_TIME 200 |
77c7f072 | 2798 | #define HUB_RESET_TIMEOUT 800 |
1da177e4 | 2799 | |
25244227 NB |
2800 | static bool use_new_scheme(struct usb_device *udev, int retry, |
2801 | struct usb_port *port_dev) | |
48fc7dbd | 2802 | { |
25244227 | 2803 | int old_scheme_first_port = |
19502e69 AS |
2804 | (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) || |
2805 | old_scheme_first; | |
25244227 | 2806 | |
19502e69 AS |
2807 | /* |
2808 | * "New scheme" enumeration causes an extra state transition to be | |
2809 | * exposed to an xhci host and causes USB3 devices to receive control | |
2810 | * commands in the default state. This has been seen to cause | |
2811 | * enumeration failures, so disable this enumeration scheme for USB3 | |
2812 | * devices. | |
2813 | */ | |
8a1b2725 | 2814 | if (udev->speed >= USB_SPEED_SUPER) |
48fc7dbd DW |
2815 | return false; |
2816 | ||
19502e69 AS |
2817 | /* |
2818 | * If use_both_schemes is set, use the first scheme (whichever | |
2819 | * it is) for the larger half of the retries, then use the other | |
2820 | * scheme. Otherwise, use the first scheme for all the retries. | |
2821 | */ | |
2822 | if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2) | |
2823 | return old_scheme_first_port; /* Second half */ | |
2824 | return !old_scheme_first_port; /* First half or all */ | |
48fc7dbd DW |
2825 | } |
2826 | ||
025d4430 | 2827 | /* Is a USB 3.0 port in the Inactive or Compliance Mode state? |
d46a6024 | 2828 | * Port warm reset is required to recover |
8bea2bd3 | 2829 | */ |
3cd12f91 DW |
2830 | static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1, |
2831 | u16 portstatus) | |
10d674a8 | 2832 | { |
3cd12f91 DW |
2833 | u16 link_state; |
2834 | ||
2835 | if (!hub_is_superspeed(hub->hdev)) | |
2836 | return false; | |
2837 | ||
2838 | if (test_bit(port1, hub->warm_reset_bits)) | |
2839 | return true; | |
2840 | ||
2841 | link_state = portstatus & USB_PORT_STAT_LINK_STATE; | |
2842 | return link_state == USB_SS_PORT_LS_SS_INACTIVE | |
2843 | || link_state == USB_SS_PORT_LS_COMP_MOD; | |
10d674a8 SS |
2844 | } |
2845 | ||
1da177e4 | 2846 | static int hub_port_wait_reset(struct usb_hub *hub, int port1, |
75d7cf72 | 2847 | struct usb_device *udev, unsigned int delay, bool warm) |
1da177e4 LT |
2848 | { |
2849 | int delay_time, ret; | |
2850 | u16 portstatus; | |
2851 | u16 portchange; | |
0cdd49a1 | 2852 | u32 ext_portstatus = 0; |
1da177e4 LT |
2853 | |
2854 | for (delay_time = 0; | |
2855 | delay_time < HUB_RESET_TIMEOUT; | |
2856 | delay_time += delay) { | |
2857 | /* wait to give the device a chance to reset */ | |
2858 | msleep(delay); | |
2859 | ||
2860 | /* read and decode port status */ | |
0cdd49a1 MN |
2861 | if (hub_is_superspeedplus(hub->hdev)) |
2862 | ret = hub_ext_port_status(hub, port1, | |
2863 | HUB_EXT_PORT_STATUS, | |
2864 | &portstatus, &portchange, | |
2865 | &ext_portstatus); | |
2866 | else | |
f061f43d | 2867 | ret = usb_hub_port_status(hub, port1, &portstatus, |
0cdd49a1 | 2868 | &portchange); |
1da177e4 LT |
2869 | if (ret < 0) |
2870 | return ret; | |
2871 | ||
22547c4c GR |
2872 | /* |
2873 | * The port state is unknown until the reset completes. | |
2874 | * | |
2875 | * On top of that, some chips may require additional time | |
2876 | * to re-establish a connection after the reset is complete, | |
2877 | * so also wait for the connection to be re-established. | |
2878 | */ | |
2879 | if (!(portstatus & USB_PORT_STAT_RESET) && | |
2880 | (portstatus & USB_PORT_STAT_CONNECTION)) | |
470f0be8 | 2881 | break; |
1da177e4 LT |
2882 | |
2883 | /* switch to the long delay after two short delay failures */ | |
2884 | if (delay_time >= 2 * HUB_SHORT_RESET_TIME) | |
2885 | delay = HUB_LONG_RESET_TIME; | |
2886 | ||
d99f6b41 DW |
2887 | dev_dbg(&hub->ports[port1 - 1]->dev, |
2888 | "not %sreset yet, waiting %dms\n", | |
2889 | warm ? "warm " : "", delay); | |
1da177e4 LT |
2890 | } |
2891 | ||
470f0be8 SS |
2892 | if ((portstatus & USB_PORT_STAT_RESET)) |
2893 | return -EBUSY; | |
2894 | ||
3cd12f91 | 2895 | if (hub_port_warm_reset_required(hub, port1, portstatus)) |
470f0be8 SS |
2896 | return -ENOTCONN; |
2897 | ||
2898 | /* Device went away? */ | |
2899 | if (!(portstatus & USB_PORT_STAT_CONNECTION)) | |
2900 | return -ENOTCONN; | |
2901 | ||
1ac7db63 MN |
2902 | /* Retry if connect change is set but status is still connected. |
2903 | * A USB 3.0 connection may bounce if multiple warm resets were issued, | |
470f0be8 SS |
2904 | * but the device may have successfully re-connected. Ignore it. |
2905 | */ | |
2906 | if (!hub_is_superspeed(hub->hdev) && | |
1ac7db63 MN |
2907 | (portchange & USB_PORT_STAT_C_CONNECTION)) { |
2908 | usb_clear_port_feature(hub->hdev, port1, | |
2909 | USB_PORT_FEAT_C_CONNECTION); | |
2910 | return -EAGAIN; | |
2911 | } | |
470f0be8 SS |
2912 | |
2913 | if (!(portstatus & USB_PORT_STAT_ENABLE)) | |
2914 | return -EBUSY; | |
2915 | ||
2916 | if (!udev) | |
2917 | return 0; | |
2918 | ||
013eedb8 MN |
2919 | if (hub_is_superspeedplus(hub->hdev)) { |
2920 | /* extended portstatus Rx and Tx lane count are zero based */ | |
2921 | udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1; | |
2922 | udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1; | |
0299809b | 2923 | udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus); |
013eedb8 MN |
2924 | } else { |
2925 | udev->rx_lanes = 1; | |
2926 | udev->tx_lanes = 1; | |
0299809b | 2927 | udev->ssp_rate = USB_SSP_GEN_UNKNOWN; |
013eedb8 | 2928 | } |
470f0be8 SS |
2929 | if (hub_is_wusb(hub)) |
2930 | udev->speed = USB_SPEED_WIRELESS; | |
a59918cb | 2931 | else if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN) |
0cdd49a1 | 2932 | udev->speed = USB_SPEED_SUPER_PLUS; |
470f0be8 SS |
2933 | else if (hub_is_superspeed(hub->hdev)) |
2934 | udev->speed = USB_SPEED_SUPER; | |
2935 | else if (portstatus & USB_PORT_STAT_HIGH_SPEED) | |
2936 | udev->speed = USB_SPEED_HIGH; | |
2937 | else if (portstatus & USB_PORT_STAT_LOW_SPEED) | |
2938 | udev->speed = USB_SPEED_LOW; | |
2939 | else | |
2940 | udev->speed = USB_SPEED_FULL; | |
2941 | return 0; | |
1da177e4 LT |
2942 | } |
2943 | ||
75d7cf72 | 2944 | /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */ |
1da177e4 | 2945 | static int hub_port_reset(struct usb_hub *hub, int port1, |
75d7cf72 | 2946 | struct usb_device *udev, unsigned int delay, bool warm) |
1da177e4 LT |
2947 | { |
2948 | int i, status; | |
a24a6078 | 2949 | u16 portchange, portstatus; |
d99f6b41 | 2950 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
781f0766 | 2951 | int reset_recovery_time; |
1da177e4 | 2952 | |
0fe51aa5 SS |
2953 | if (!hub_is_superspeed(hub->hdev)) { |
2954 | if (warm) { | |
75d7cf72 AX |
2955 | dev_err(hub->intfdev, "only USB3 hub support " |
2956 | "warm reset\n"); | |
2957 | return -EINVAL; | |
2958 | } | |
0fe51aa5 SS |
2959 | /* Block EHCI CF initialization during the port reset. |
2960 | * Some companion controllers don't like it when they mix. | |
2961 | */ | |
2962 | down_read(&ehci_cf_port_reset_rwsem); | |
d3b9d7a9 SS |
2963 | } else if (!warm) { |
2964 | /* | |
2965 | * If the caller hasn't explicitly requested a warm reset, | |
2966 | * double check and see if one is needed. | |
2967 | */ | |
f061f43d MG |
2968 | if (usb_hub_port_status(hub, port1, &portstatus, |
2969 | &portchange) == 0) | |
fb6d1f7d RS |
2970 | if (hub_port_warm_reset_required(hub, port1, |
2971 | portstatus)) | |
2972 | warm = true; | |
75d7cf72 | 2973 | } |
3cd12f91 | 2974 | clear_bit(port1, hub->warm_reset_bits); |
32fe0198 | 2975 | |
1da177e4 LT |
2976 | /* Reset the port */ |
2977 | for (i = 0; i < PORT_RESET_TRIES; i++) { | |
75d7cf72 AX |
2978 | status = set_port_feature(hub->hdev, port1, (warm ? |
2979 | USB_PORT_FEAT_BH_PORT_RESET : | |
2980 | USB_PORT_FEAT_RESET)); | |
e9e88fb7 AS |
2981 | if (status == -ENODEV) { |
2982 | ; /* The hub is gone */ | |
2983 | } else if (status) { | |
d99f6b41 DW |
2984 | dev_err(&port_dev->dev, |
2985 | "cannot %sreset (err = %d)\n", | |
2986 | warm ? "warm " : "", status); | |
75d7cf72 AX |
2987 | } else { |
2988 | status = hub_port_wait_reset(hub, port1, udev, delay, | |
2989 | warm); | |
e9e88fb7 | 2990 | if (status && status != -ENOTCONN && status != -ENODEV) |
1da177e4 LT |
2991 | dev_dbg(hub->intfdev, |
2992 | "port_wait_reset: err = %d\n", | |
2993 | status); | |
2994 | } | |
2995 | ||
c8968611 KHF |
2996 | /* |
2997 | * Check for disconnect or reset, and bail out after several | |
2998 | * reset attempts to avoid warm reset loop. | |
2999 | */ | |
3000 | if (status == 0 || status == -ENOTCONN || status == -ENODEV || | |
3001 | (status == -EBUSY && i == PORT_RESET_TRIES - 1)) { | |
fb6d1f7d RS |
3002 | usb_clear_port_feature(hub->hdev, port1, |
3003 | USB_PORT_FEAT_C_RESET); | |
a24a6078 SS |
3004 | |
3005 | if (!hub_is_superspeed(hub->hdev)) | |
3006 | goto done; | |
3007 | ||
fb6d1f7d RS |
3008 | usb_clear_port_feature(hub->hdev, port1, |
3009 | USB_PORT_FEAT_C_BH_PORT_RESET); | |
3010 | usb_clear_port_feature(hub->hdev, port1, | |
3011 | USB_PORT_FEAT_C_PORT_LINK_STATE); | |
22454b79 DW |
3012 | |
3013 | if (udev) | |
3014 | usb_clear_port_feature(hub->hdev, port1, | |
fb6d1f7d RS |
3015 | USB_PORT_FEAT_C_CONNECTION); |
3016 | ||
a24a6078 SS |
3017 | /* |
3018 | * If a USB 3.0 device migrates from reset to an error | |
3019 | * state, re-issue the warm reset. | |
3020 | */ | |
f061f43d | 3021 | if (usb_hub_port_status(hub, port1, |
a24a6078 SS |
3022 | &portstatus, &portchange) < 0) |
3023 | goto done; | |
3024 | ||
3cd12f91 DW |
3025 | if (!hub_port_warm_reset_required(hub, port1, |
3026 | portstatus)) | |
a24a6078 SS |
3027 | goto done; |
3028 | ||
3029 | /* | |
3030 | * If the port is in SS.Inactive or Compliance Mode, the | |
3031 | * hot or warm reset failed. Try another warm reset. | |
3032 | */ | |
3033 | if (!warm) { | |
d99f6b41 DW |
3034 | dev_dbg(&port_dev->dev, |
3035 | "hot reset failed, warm reset\n"); | |
a24a6078 SS |
3036 | warm = true; |
3037 | } | |
1da177e4 LT |
3038 | } |
3039 | ||
d99f6b41 DW |
3040 | dev_dbg(&port_dev->dev, |
3041 | "not enabled, trying %sreset again...\n", | |
3042 | warm ? "warm " : ""); | |
1da177e4 LT |
3043 | delay = HUB_LONG_RESET_TIME; |
3044 | } | |
3045 | ||
d99f6b41 | 3046 | dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n"); |
1da177e4 | 3047 | |
75d7cf72 | 3048 | done: |
fb6d1f7d | 3049 | if (status == 0) { |
aa071a92 NB |
3050 | if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM) |
3051 | usleep_range(10000, 12000); | |
781f0766 KHF |
3052 | else { |
3053 | /* TRSTRCY = 10 ms; plus some extra */ | |
3054 | reset_recovery_time = 10 + 40; | |
3055 | ||
3056 | /* Hub needs extra delay after resetting its port. */ | |
3057 | if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET) | |
3058 | reset_recovery_time += 100; | |
3059 | ||
3060 | msleep(reset_recovery_time); | |
3061 | } | |
aa071a92 | 3062 | |
fb6d1f7d RS |
3063 | if (udev) { |
3064 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
3065 | ||
3066 | update_devnum(udev, 0); | |
3067 | /* The xHC may think the device is already reset, | |
3068 | * so ignore the status. | |
3069 | */ | |
3070 | if (hcd->driver->reset_device) | |
3071 | hcd->driver->reset_device(hcd, udev); | |
3072 | ||
3073 | usb_set_device_state(udev, USB_STATE_DEFAULT); | |
3074 | } | |
3075 | } else { | |
3076 | if (udev) | |
3077 | usb_set_device_state(udev, USB_STATE_NOTATTACHED); | |
3078 | } | |
3079 | ||
0fe51aa5 | 3080 | if (!hub_is_superspeed(hub->hdev)) |
75d7cf72 | 3081 | up_read(&ehci_cf_port_reset_rwsem); |
5e467f6e | 3082 | |
75d7cf72 | 3083 | return status; |
5e467f6e AX |
3084 | } |
3085 | ||
430d57f5 RC |
3086 | /* |
3087 | * hub_port_stop_enumerate - stop USB enumeration or ignore port events | |
3088 | * @hub: target hub | |
3089 | * @port1: port num of the port | |
3090 | * @retries: port retries number of hub_port_init() | |
3091 | * | |
3092 | * Return: | |
3093 | * true: ignore port actions/events or give up connection attempts. | |
3094 | * false: keep original behavior. | |
3095 | * | |
3096 | * This function will be based on retries to check whether the port which is | |
3097 | * marked with early_stop attribute would stop enumeration or ignore events. | |
3098 | * | |
3099 | * Note: | |
3100 | * This function didn't change anything if early_stop is not set, and it will | |
3101 | * prevent all connection attempts when early_stop is set and the attempts of | |
3102 | * the port are more than 1. | |
3103 | */ | |
3104 | static bool hub_port_stop_enumerate(struct usb_hub *hub, int port1, int retries) | |
3105 | { | |
3106 | struct usb_port *port_dev = hub->ports[port1 - 1]; | |
3107 | ||
3108 | if (port_dev->early_stop) { | |
3109 | if (port_dev->ignore_event) | |
3110 | return true; | |
3111 | ||
3112 | /* | |
3113 | * We want unsuccessful attempts to fail quickly. | |
3114 | * Since some devices may need one failure during | |
3115 | * port initialization, we allow two tries but no | |
3116 | * more. | |
3117 | */ | |
3118 | if (retries < 2) | |
3119 | return false; | |
3120 | ||
3121 | port_dev->ignore_event = 1; | |
3122 | } else | |
3123 | port_dev->ignore_event = 0; | |
3124 | ||
3125 | return port_dev->ignore_event; | |
3126 | } | |
3127 | ||
0ed9a57e | 3128 | /* Check if a port is power on */ |
f061f43d | 3129 | int usb_port_is_power_on(struct usb_hub *hub, unsigned int portstatus) |
0ed9a57e AX |
3130 | { |
3131 | int ret = 0; | |
3132 | ||
3133 | if (hub_is_superspeed(hub->hdev)) { | |
3134 | if (portstatus & USB_SS_PORT_STAT_POWER) | |
3135 | ret = 1; | |
3136 | } else { | |
3137 | if (portstatus & USB_PORT_STAT_POWER) | |
3138 | ret = 1; | |
3139 | } | |
3140 | ||
3141 | return ret; | |
3142 | } | |
3143 | ||
5c79a1e3 DW |
3144 | static void usb_lock_port(struct usb_port *port_dev) |
3145 | __acquires(&port_dev->status_lock) | |
3146 | { | |
3147 | mutex_lock(&port_dev->status_lock); | |
3148 | __acquire(&port_dev->status_lock); | |
3149 | } | |
3150 | ||
3151 | static void usb_unlock_port(struct usb_port *port_dev) | |
3152 | __releases(&port_dev->status_lock) | |
3153 | { | |
3154 | mutex_unlock(&port_dev->status_lock); | |
3155 | __release(&port_dev->status_lock); | |
3156 | } | |
3157 | ||
d388dab7 | 3158 | #ifdef CONFIG_PM |
1da177e4 | 3159 | |
0ed9a57e AX |
3160 | /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */ |
3161 | static int port_is_suspended(struct usb_hub *hub, unsigned portstatus) | |
3162 | { | |
3163 | int ret = 0; | |
3164 | ||
3165 | if (hub_is_superspeed(hub->hdev)) { | |
3166 | if ((portstatus & USB_PORT_STAT_LINK_STATE) | |
3167 | == USB_SS_PORT_LS_U3) | |
3168 | ret = 1; | |
3169 | } else { | |
3170 | if (portstatus & USB_PORT_STAT_SUSPEND) | |
3171 | ret = 1; | |
3172 | } | |
3173 | ||
3174 | return ret; | |
3175 | } | |
b01b03f3 AS |
3176 | |
3177 | /* Determine whether the device on a port is ready for a normal resume, | |
3178 | * is ready for a reset-resume, or should be disconnected. | |
3179 | */ | |
3180 | static int check_port_resume_type(struct usb_device *udev, | |
3181 | struct usb_hub *hub, int port1, | |
7fa40910 | 3182 | int status, u16 portchange, u16 portstatus) |
b01b03f3 | 3183 | { |
d99f6b41 | 3184 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
7fa40910 | 3185 | int retries = 3; |
d99f6b41 | 3186 | |
7fa40910 | 3187 | retry: |
3cd12f91 DW |
3188 | /* Is a warm reset needed to recover the connection? */ |
3189 | if (status == 0 && udev->reset_resume | |
3190 | && hub_port_warm_reset_required(hub, port1, portstatus)) { | |
3191 | /* pass */; | |
3192 | } | |
b01b03f3 | 3193 | /* Is the device still present? */ |
3cd12f91 | 3194 | else if (status || port_is_suspended(hub, portstatus) || |
f061f43d | 3195 | !usb_port_is_power_on(hub, portstatus)) { |
b01b03f3 AS |
3196 | if (status >= 0) |
3197 | status = -ENODEV; | |
7fa40910 JW |
3198 | } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) { |
3199 | if (retries--) { | |
3200 | usleep_range(200, 300); | |
f061f43d | 3201 | status = usb_hub_port_status(hub, port1, &portstatus, |
7fa40910 JW |
3202 | &portchange); |
3203 | goto retry; | |
3204 | } | |
3205 | status = -ENODEV; | |
b01b03f3 AS |
3206 | } |
3207 | ||
86c57edf AS |
3208 | /* Can't do a normal resume if the port isn't enabled, |
3209 | * so try a reset-resume instead. | |
3210 | */ | |
3211 | else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) { | |
3212 | if (udev->persist_enabled) | |
3213 | udev->reset_resume = 1; | |
3214 | else | |
3215 | status = -ENODEV; | |
3216 | } | |
b01b03f3 AS |
3217 | |
3218 | if (status) { | |
d99f6b41 DW |
3219 | dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n", |
3220 | portchange, portstatus, status); | |
b01b03f3 AS |
3221 | } else if (udev->reset_resume) { |
3222 | ||
3223 | /* Late port handoff can set status-change bits */ | |
3224 | if (portchange & USB_PORT_STAT_C_CONNECTION) | |
ad493e5e | 3225 | usb_clear_port_feature(hub->hdev, port1, |
b01b03f3 AS |
3226 | USB_PORT_FEAT_C_CONNECTION); |
3227 | if (portchange & USB_PORT_STAT_C_ENABLE) | |
ad493e5e | 3228 | usb_clear_port_feature(hub->hdev, port1, |
b01b03f3 | 3229 | USB_PORT_FEAT_C_ENABLE); |
9f952e26 AS |
3230 | |
3231 | /* | |
3232 | * Whatever made this reset-resume necessary may have | |
3233 | * turned on the port1 bit in hub->change_bits. But after | |
3234 | * a successful reset-resume we want the bit to be clear; | |
3235 | * if it was on it would indicate that something happened | |
3236 | * following the reset-resume. | |
3237 | */ | |
3238 | clear_bit(port1, hub->change_bits); | |
b01b03f3 AS |
3239 | } |
3240 | ||
3241 | return status; | |
3242 | } | |
3243 | ||
f74631e3 SS |
3244 | int usb_disable_ltm(struct usb_device *udev) |
3245 | { | |
3246 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
3247 | ||
3248 | /* Check if the roothub and device supports LTM. */ | |
3249 | if (!usb_device_supports_ltm(hcd->self.root_hub) || | |
3250 | !usb_device_supports_ltm(udev)) | |
3251 | return 0; | |
3252 | ||
3253 | /* Clear Feature LTM Enable can only be sent if the device is | |
3254 | * configured. | |
3255 | */ | |
3256 | if (!udev->actconfig) | |
3257 | return 0; | |
3258 | ||
1afe33a7 ON |
3259 | return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3260 | USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE, | |
3261 | USB_DEVICE_LTM_ENABLE, 0, NULL, 0, | |
3262 | USB_CTRL_SET_TIMEOUT); | |
f74631e3 SS |
3263 | } |
3264 | EXPORT_SYMBOL_GPL(usb_disable_ltm); | |
3265 | ||
3266 | void usb_enable_ltm(struct usb_device *udev) | |
3267 | { | |
3268 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
3269 | ||
3270 | /* Check if the roothub and device supports LTM. */ | |
3271 | if (!usb_device_supports_ltm(hcd->self.root_hub) || | |
3272 | !usb_device_supports_ltm(udev)) | |
3273 | return; | |
3274 | ||
3275 | /* Set Feature LTM Enable can only be sent if the device is | |
3276 | * configured. | |
3277 | */ | |
3278 | if (!udev->actconfig) | |
3279 | return; | |
3280 | ||
1afe33a7 ON |
3281 | usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3282 | USB_REQ_SET_FEATURE, USB_RECIP_DEVICE, | |
3283 | USB_DEVICE_LTM_ENABLE, 0, NULL, 0, | |
3284 | USB_CTRL_SET_TIMEOUT); | |
f74631e3 SS |
3285 | } |
3286 | EXPORT_SYMBOL_GPL(usb_enable_ltm); | |
3287 | ||
54a3ac0c | 3288 | /* |
28e86165 | 3289 | * usb_enable_remote_wakeup - enable remote wakeup for a device |
54a3ac0c LT |
3290 | * @udev: target device |
3291 | * | |
28e86165 AS |
3292 | * For USB-2 devices: Set the device's remote wakeup feature. |
3293 | * | |
3294 | * For USB-3 devices: Assume there's only one function on the device and | |
3295 | * enable remote wake for the first interface. FIXME if the interface | |
3296 | * association descriptor shows there's more than one function. | |
54a3ac0c | 3297 | */ |
28e86165 | 3298 | static int usb_enable_remote_wakeup(struct usb_device *udev) |
54a3ac0c | 3299 | { |
28e86165 | 3300 | if (udev->speed < USB_SPEED_SUPER) |
1afe33a7 ON |
3301 | return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3302 | USB_REQ_SET_FEATURE, USB_RECIP_DEVICE, | |
3303 | USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0, | |
3304 | USB_CTRL_SET_TIMEOUT); | |
28e86165 | 3305 | else |
1afe33a7 ON |
3306 | return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3307 | USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE, | |
3308 | USB_INTRF_FUNC_SUSPEND, | |
3309 | USB_INTRF_FUNC_SUSPEND_RW | | |
3310 | USB_INTRF_FUNC_SUSPEND_LP, | |
3311 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
28e86165 AS |
3312 | } |
3313 | ||
3314 | /* | |
3315 | * usb_disable_remote_wakeup - disable remote wakeup for a device | |
3316 | * @udev: target device | |
3317 | * | |
3318 | * For USB-2 devices: Clear the device's remote wakeup feature. | |
3319 | * | |
3320 | * For USB-3 devices: Assume there's only one function on the device and | |
3321 | * disable remote wake for the first interface. FIXME if the interface | |
3322 | * association descriptor shows there's more than one function. | |
3323 | */ | |
3324 | static int usb_disable_remote_wakeup(struct usb_device *udev) | |
3325 | { | |
3326 | if (udev->speed < USB_SPEED_SUPER) | |
1afe33a7 ON |
3327 | return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3328 | USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE, | |
3329 | USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0, | |
3330 | USB_CTRL_SET_TIMEOUT); | |
28e86165 | 3331 | else |
1afe33a7 ON |
3332 | return usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
3333 | USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE, | |
3334 | USB_INTRF_FUNC_SUSPEND, 0, NULL, 0, | |
3335 | USB_CTRL_SET_TIMEOUT); | |
54a3ac0c | 3336 | } |
1da177e4 | 3337 | |
e583d9db | 3338 | /* Count of wakeup-enabled devices at or below udev */ |
7a6127e3 | 3339 | unsigned usb_wakeup_enabled_descendants(struct usb_device *udev) |
e583d9db AS |
3340 | { |
3341 | struct usb_hub *hub = usb_hub_to_struct_hub(udev); | |
3342 | ||
3343 | return udev->do_remote_wakeup + | |
3344 | (hub ? hub->wakeup_enabled_descendants : 0); | |
3345 | } | |
7a6127e3 | 3346 | EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants); |
e583d9db | 3347 | |
1da177e4 | 3348 | /* |
624d6c07 AS |
3349 | * usb_port_suspend - suspend a usb device's upstream port |
3350 | * @udev: device that's no longer in active use, not a root hub | |
3351 | * Context: must be able to sleep; device not locked; pm locks held | |
3352 | * | |
3353 | * Suspends a USB device that isn't in active use, conserving power. | |
3354 | * Devices may wake out of a suspend, if anything important happens, | |
3355 | * using the remote wakeup mechanism. They may also be taken out of | |
3356 | * suspend by the host, using usb_port_resume(). It's also routine | |
3357 | * to disconnect devices while they are suspended. | |
3358 | * | |
3359 | * This only affects the USB hardware for a device; its interfaces | |
3360 | * (and, for hubs, child devices) must already have been suspended. | |
3361 | * | |
1da177e4 LT |
3362 | * Selective port suspend reduces power; most suspended devices draw |
3363 | * less than 500 uA. It's also used in OTG, along with remote wakeup. | |
3364 | * All devices below the suspended port are also suspended. | |
3365 | * | |
3366 | * Devices leave suspend state when the host wakes them up. Some devices | |
3367 | * also support "remote wakeup", where the device can activate the USB | |
3368 | * tree above them to deliver data, such as a keypress or packet. In | |
3369 | * some cases, this wakes the USB host. | |
624d6c07 AS |
3370 | * |
3371 | * Suspending OTG devices may trigger HNP, if that's been enabled | |
3372 | * between a pair of dual-role devices. That will change roles, such | |
3373 | * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral. | |
3374 | * | |
3375 | * Devices on USB hub ports have only one "suspend" state, corresponding | |
3376 | * to ACPI D2, "may cause the device to lose some context". | |
3377 | * State transitions include: | |
3378 | * | |
3379 | * - suspend, resume ... when the VBUS power link stays live | |
3380 | * - suspend, disconnect ... VBUS lost | |
3381 | * | |
3382 | * Once VBUS drop breaks the circuit, the port it's using has to go through | |
3383 | * normal re-enumeration procedures, starting with enabling VBUS power. | |
3384 | * Other than re-initializing the hub (plug/unplug, except for root hubs), | |
37ebb549 | 3385 | * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq |
624d6c07 AS |
3386 | * timer, no SRP, no requests through sysfs. |
3387 | * | |
e583d9db AS |
3388 | * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get |
3389 | * suspended until their bus goes into global suspend (i.e., the root | |
0aa2832d AS |
3390 | * hub is suspended). Nevertheless, we change @udev->state to |
3391 | * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual | |
3392 | * upstream port setting is stored in @udev->port_is_suspended. | |
624d6c07 AS |
3393 | * |
3394 | * Returns 0 on success, else negative errno. | |
1da177e4 | 3395 | */ |
65bfd296 | 3396 | int usb_port_suspend(struct usb_device *udev, pm_message_t msg) |
1da177e4 | 3397 | { |
ad493e5e LT |
3398 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); |
3399 | struct usb_port *port_dev = hub->ports[udev->portnum - 1]; | |
624d6c07 AS |
3400 | int port1 = udev->portnum; |
3401 | int status; | |
0aa2832d | 3402 | bool really_suspend = true; |
1da177e4 | 3403 | |
5c79a1e3 DW |
3404 | usb_lock_port(port_dev); |
3405 | ||
1da177e4 LT |
3406 | /* enable remote wakeup when appropriate; this lets the device |
3407 | * wake up the upstream hub (including maybe the root hub). | |
3408 | * | |
3409 | * NOTE: OTG devices may issue remote wakeup (or SRP) even when | |
3410 | * we don't explicitly enable it here. | |
3411 | */ | |
645daaab | 3412 | if (udev->do_remote_wakeup) { |
28e86165 | 3413 | status = usb_enable_remote_wakeup(udev); |
0c487206 | 3414 | if (status) { |
624d6c07 AS |
3415 | dev_dbg(&udev->dev, "won't remote wakeup, status %d\n", |
3416 | status); | |
0c487206 | 3417 | /* bail if autosuspend is requested */ |
5b1b0b81 | 3418 | if (PMSG_IS_AUTO(msg)) |
4fae6f0f | 3419 | goto err_wakeup; |
0c487206 | 3420 | } |
1da177e4 LT |
3421 | } |
3422 | ||
65580b43 | 3423 | /* disable USB2 hardware LPM */ |
d7a6c0ce | 3424 | usb_disable_usb2_hardware_lpm(udev); |
65580b43 | 3425 | |
f74631e3 | 3426 | if (usb_disable_ltm(udev)) { |
1ccc417e | 3427 | dev_err(&udev->dev, "Failed to disable LTM before suspend\n"); |
4fae6f0f AS |
3428 | status = -ENOMEM; |
3429 | if (PMSG_IS_AUTO(msg)) | |
3430 | goto err_ltm; | |
f74631e3 | 3431 | } |
8306095f | 3432 | |
1da177e4 | 3433 | /* see 7.1.7.6 */ |
a7114230 | 3434 | if (hub_is_superspeed(hub->hdev)) |
c2f60db7 | 3435 | status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3); |
e583d9db | 3436 | |
0aa2832d AS |
3437 | /* |
3438 | * For system suspend, we do not need to enable the suspend feature | |
3439 | * on individual USB-2 ports. The devices will automatically go | |
3440 | * into suspend a few ms after the root hub stops sending packets. | |
3441 | * The USB 2.0 spec calls this "global suspend". | |
e583d9db AS |
3442 | * |
3443 | * However, many USB hubs have a bug: They don't relay wakeup requests | |
3444 | * from a downstream port if the port's suspend feature isn't on. | |
3445 | * Therefore we will turn on the suspend feature if udev or any of its | |
3446 | * descendants is enabled for remote wakeup. | |
0aa2832d | 3447 | */ |
7a6127e3 | 3448 | else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0) |
e583d9db AS |
3449 | status = set_port_feature(hub->hdev, port1, |
3450 | USB_PORT_FEAT_SUSPEND); | |
0aa2832d AS |
3451 | else { |
3452 | really_suspend = false; | |
3453 | status = 0; | |
3454 | } | |
1da177e4 | 3455 | if (status) { |
71424523 CC |
3456 | /* Check if the port has been suspended for the timeout case |
3457 | * to prevent the suspended port from incorrect handling. | |
3458 | */ | |
3459 | if (status == -ETIMEDOUT) { | |
3460 | int ret; | |
3461 | u16 portstatus, portchange; | |
3462 | ||
3463 | portstatus = portchange = 0; | |
f061f43d | 3464 | ret = usb_hub_port_status(hub, port1, &portstatus, |
71424523 CC |
3465 | &portchange); |
3466 | ||
3467 | dev_dbg(&port_dev->dev, | |
3468 | "suspend timeout, status %04x\n", portstatus); | |
3469 | ||
3470 | if (ret == 0 && port_is_suspended(hub, portstatus)) { | |
3471 | status = 0; | |
3472 | goto suspend_done; | |
3473 | } | |
3474 | } | |
3475 | ||
d99f6b41 | 3476 | dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status); |
cbb33004 | 3477 | |
d590c231 | 3478 | /* Try to enable USB3 LTM again */ |
4fae6f0f AS |
3479 | usb_enable_ltm(udev); |
3480 | err_ltm: | |
c3e751e4 | 3481 | /* Try to enable USB2 hardware LPM again */ |
d7a6c0ce | 3482 | usb_enable_usb2_hardware_lpm(udev); |
c3e751e4 | 3483 | |
4fae6f0f AS |
3484 | if (udev->do_remote_wakeup) |
3485 | (void) usb_disable_remote_wakeup(udev); | |
3486 | err_wakeup: | |
8306095f | 3487 | |
cbb33004 | 3488 | /* System sleep transitions should never fail */ |
5b1b0b81 | 3489 | if (!PMSG_IS_AUTO(msg)) |
cbb33004 | 3490 | status = 0; |
1da177e4 | 3491 | } else { |
71424523 | 3492 | suspend_done: |
30b1a7a3 AS |
3493 | dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n", |
3494 | (PMSG_IS_AUTO(msg) ? "auto-" : ""), | |
3495 | udev->do_remote_wakeup); | |
0aa2832d AS |
3496 | if (really_suspend) { |
3497 | udev->port_is_suspended = 1; | |
e583d9db AS |
3498 | |
3499 | /* device has up to 10 msec to fully suspend */ | |
0aa2832d AS |
3500 | msleep(10); |
3501 | } | |
e583d9db | 3502 | usb_set_device_state(udev, USB_STATE_SUSPENDED); |
1da177e4 | 3503 | } |
ad493e5e | 3504 | |
d5c3834e DW |
3505 | if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled |
3506 | && test_and_clear_bit(port1, hub->child_usage_bits)) | |
98a4f1ff | 3507 | pm_runtime_put_sync(&port_dev->dev); |
ad493e5e | 3508 | |
c08512c7 | 3509 | usb_mark_last_busy(hub->hdev); |
5c79a1e3 DW |
3510 | |
3511 | usb_unlock_port(port_dev); | |
1da177e4 LT |
3512 | return status; |
3513 | } | |
3514 | ||
1da177e4 | 3515 | /* |
390a8c34 DB |
3516 | * If the USB "suspend" state is in use (rather than "global suspend"), |
3517 | * many devices will be individually taken out of suspend state using | |
54515fe5 | 3518 | * special "resume" signaling. This routine kicks in shortly after |
1da177e4 LT |
3519 | * hardware resume signaling is finished, either because of selective |
3520 | * resume (by host) or remote wakeup (by device) ... now see what changed | |
3521 | * in the tree that's rooted at this device. | |
54515fe5 AS |
3522 | * |
3523 | * If @udev->reset_resume is set then the device is reset before the | |
3524 | * status check is done. | |
1da177e4 | 3525 | */ |
140d8f68 | 3526 | static int finish_port_resume(struct usb_device *udev) |
1da177e4 | 3527 | { |
54515fe5 | 3528 | int status = 0; |
07e72b95 | 3529 | u16 devstatus = 0; |
1da177e4 LT |
3530 | |
3531 | /* caller owns the udev device lock */ | |
b9cef6c3 WF |
3532 | dev_dbg(&udev->dev, "%s\n", |
3533 | udev->reset_resume ? "finish reset-resume" : "finish resume"); | |
1da177e4 LT |
3534 | |
3535 | /* usb ch9 identifies four variants of SUSPENDED, based on what | |
3536 | * state the device resumes to. Linux currently won't see the | |
3537 | * first two on the host side; they'd be inside hub_port_init() | |
37ebb549 | 3538 | * during many timeouts, but hub_wq can't suspend until later. |
1da177e4 LT |
3539 | */ |
3540 | usb_set_device_state(udev, udev->actconfig | |
3541 | ? USB_STATE_CONFIGURED | |
3542 | : USB_STATE_ADDRESS); | |
1da177e4 | 3543 | |
54515fe5 AS |
3544 | /* 10.5.4.5 says not to reset a suspended port if the attached |
3545 | * device is enabled for remote wakeup. Hence the reset | |
3546 | * operation is carried out here, after the port has been | |
3547 | * resumed. | |
3548 | */ | |
1d10255c AS |
3549 | if (udev->reset_resume) { |
3550 | /* | |
3551 | * If the device morphs or switches modes when it is reset, | |
3552 | * we don't want to perform a reset-resume. We'll fail the | |
3553 | * resume, which will cause a logical disconnect, and then | |
3554 | * the device will be rediscovered. | |
3555 | */ | |
86c57edf | 3556 | retry_reset_resume: |
1d10255c AS |
3557 | if (udev->quirks & USB_QUIRK_RESET) |
3558 | status = -ENODEV; | |
3559 | else | |
3560 | status = usb_reset_and_verify_device(udev); | |
3561 | } | |
54515fe5 | 3562 | |
469271f8 MB |
3563 | /* 10.5.4.5 says be sure devices in the tree are still there. |
3564 | * For now let's assume the device didn't go crazy on resume, | |
1da177e4 LT |
3565 | * and device drivers will know about any resume quirks. |
3566 | */ | |
54515fe5 | 3567 | if (status == 0) { |
46dede46 | 3568 | devstatus = 0; |
d9e1e148 | 3569 | status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus); |
86c57edf AS |
3570 | |
3571 | /* If a normal resume failed, try doing a reset-resume */ | |
3572 | if (status && !udev->reset_resume && udev->persist_enabled) { | |
3573 | dev_dbg(&udev->dev, "retry with reset-resume\n"); | |
3574 | udev->reset_resume = 1; | |
3575 | goto retry_reset_resume; | |
3576 | } | |
54515fe5 | 3577 | } |
b40b7a90 | 3578 | |
624d6c07 AS |
3579 | if (status) { |
3580 | dev_dbg(&udev->dev, "gone after usb resume? status %d\n", | |
3581 | status); | |
07e72b95 ON |
3582 | /* |
3583 | * There are a few quirky devices which violate the standard | |
3584 | * by claiming to have remote wakeup enabled after a reset, | |
3585 | * which crash if the feature is cleared, hence check for | |
3586 | * udev->reset_resume | |
3587 | */ | |
3588 | } else if (udev->actconfig && !udev->reset_resume) { | |
28e86165 | 3589 | if (udev->speed < USB_SPEED_SUPER) { |
54a3ac0c | 3590 | if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) |
28e86165 | 3591 | status = usb_disable_remote_wakeup(udev); |
54a3ac0c | 3592 | } else { |
d9e1e148 | 3593 | status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0, |
54a3ac0c | 3594 | &devstatus); |
54a3ac0c LT |
3595 | if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP |
3596 | | USB_INTRF_STAT_FUNC_RW)) | |
28e86165 | 3597 | status = usb_disable_remote_wakeup(udev); |
4bf0ba86 | 3598 | } |
54a3ac0c LT |
3599 | |
3600 | if (status) | |
3601 | dev_dbg(&udev->dev, | |
3602 | "disable remote wakeup, status %d\n", | |
3603 | status); | |
1da177e4 | 3604 | status = 0; |
1da177e4 LT |
3605 | } |
3606 | return status; | |
3607 | } | |
3608 | ||
a40178b2 PA |
3609 | /* |
3610 | * There are some SS USB devices which take longer time for link training. | |
3611 | * XHCI specs 4.19.4 says that when Link training is successful, port | |
6b82b122 | 3612 | * sets CCS bit to 1. So if SW reads port status before successful link |
a40178b2 PA |
3613 | * training, then it will not find device to be present. |
3614 | * USB Analyzer log with such buggy devices show that in some cases | |
3615 | * device switch on the RX termination after long delay of host enabling | |
3616 | * the VBUS. In few other cases it has been seen that device fails to | |
3617 | * negotiate link training in first attempt. It has been | |
3618 | * reported till now that few devices take as long as 2000 ms to train | |
3619 | * the link after host enabling its VBUS and termination. Following | |
3620 | * routine implements a 2000 ms timeout for link training. If in a case | |
3621 | * link trains before timeout, loop will exit earlier. | |
3622 | * | |
6b82b122 AC |
3623 | * There are also some 2.0 hard drive based devices and 3.0 thumb |
3624 | * drives that, when plugged into a 2.0 only port, take a long | |
3625 | * time to set CCS after VBUS enable. | |
3626 | * | |
a40178b2 PA |
3627 | * FIXME: If a device was connected before suspend, but was removed |
3628 | * while system was asleep, then the loop in the following routine will | |
3629 | * only exit at timeout. | |
3630 | * | |
6b82b122 | 3631 | * This routine should only be called when persist is enabled. |
a40178b2 | 3632 | */ |
6b82b122 | 3633 | static int wait_for_connected(struct usb_device *udev, |
b8f1ba99 | 3634 | struct usb_hub *hub, int port1, |
a40178b2 PA |
3635 | u16 *portchange, u16 *portstatus) |
3636 | { | |
3637 | int status = 0, delay_ms = 0; | |
3638 | ||
3639 | while (delay_ms < 2000) { | |
3640 | if (status || *portstatus & USB_PORT_STAT_CONNECTION) | |
3641 | break; | |
f061f43d | 3642 | if (!usb_port_is_power_on(hub, *portstatus)) { |
5d111f51 DB |
3643 | status = -ENODEV; |
3644 | break; | |
3645 | } | |
a40178b2 PA |
3646 | msleep(20); |
3647 | delay_ms += 20; | |
f061f43d | 3648 | status = usb_hub_port_status(hub, port1, portstatus, portchange); |
a40178b2 | 3649 | } |
6b82b122 | 3650 | dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms); |
a40178b2 PA |
3651 | return status; |
3652 | } | |
3653 | ||
624d6c07 AS |
3654 | /* |
3655 | * usb_port_resume - re-activate a suspended usb device's upstream port | |
3656 | * @udev: device to re-activate, not a root hub | |
3657 | * Context: must be able to sleep; device not locked; pm locks held | |
3658 | * | |
3659 | * This will re-activate the suspended device, increasing power usage | |
3660 | * while letting drivers communicate again with its endpoints. | |
3661 | * USB resume explicitly guarantees that the power session between | |
3662 | * the host and the device is the same as it was when the device | |
3663 | * suspended. | |
3664 | * | |
feccc30d AS |
3665 | * If @udev->reset_resume is set then this routine won't check that the |
3666 | * port is still enabled. Furthermore, finish_port_resume() above will | |
54515fe5 AS |
3667 | * reset @udev. The end result is that a broken power session can be |
3668 | * recovered and @udev will appear to persist across a loss of VBUS power. | |
3669 | * | |
3670 | * For example, if a host controller doesn't maintain VBUS suspend current | |
3671 | * during a system sleep or is reset when the system wakes up, all the USB | |
3672 | * power sessions below it will be broken. This is especially troublesome | |
3673 | * for mass-storage devices containing mounted filesystems, since the | |
3674 | * device will appear to have disconnected and all the memory mappings | |
3675 | * to it will be lost. Using the USB_PERSIST facility, the device can be | |
3676 | * made to appear as if it had not disconnected. | |
3677 | * | |
742120c6 | 3678 | * This facility can be dangerous. Although usb_reset_and_verify_device() makes |
feccc30d | 3679 | * every effort to insure that the same device is present after the |
54515fe5 AS |
3680 | * reset as before, it cannot provide a 100% guarantee. Furthermore it's |
3681 | * quite possible for a device to remain unaltered but its media to be | |
3682 | * changed. If the user replaces a flash memory card while the system is | |
3683 | * asleep, he will have only himself to blame when the filesystem on the | |
3684 | * new card is corrupted and the system crashes. | |
3685 | * | |
624d6c07 AS |
3686 | * Returns 0 on success, else negative errno. |
3687 | */ | |
65bfd296 | 3688 | int usb_port_resume(struct usb_device *udev, pm_message_t msg) |
1da177e4 | 3689 | { |
ad493e5e LT |
3690 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); |
3691 | struct usb_port *port_dev = hub->ports[udev->portnum - 1]; | |
624d6c07 AS |
3692 | int port1 = udev->portnum; |
3693 | int status; | |
3694 | u16 portchange, portstatus; | |
d25450c6 | 3695 | |
d5c3834e | 3696 | if (!test_and_set_bit(port1, hub->child_usage_bits)) { |
025f97d1 | 3697 | status = pm_runtime_resume_and_get(&port_dev->dev); |
ad493e5e LT |
3698 | if (status < 0) { |
3699 | dev_dbg(&udev->dev, "can't resume usb port, status %d\n", | |
3700 | status); | |
3701 | return status; | |
3702 | } | |
3703 | } | |
3704 | ||
5c79a1e3 DW |
3705 | usb_lock_port(port_dev); |
3706 | ||
d25450c6 | 3707 | /* Skip the initial Clear-Suspend step for a remote wakeup */ |
f061f43d | 3708 | status = usb_hub_port_status(hub, port1, &portstatus, &portchange); |
83a62c51 RCS |
3709 | if (status == 0 && !port_is_suspended(hub, portstatus)) { |
3710 | if (portchange & USB_PORT_STAT_C_SUSPEND) | |
3711 | pm_wakeup_event(&udev->dev, 0); | |
d25450c6 | 3712 | goto SuspendCleared; |
83a62c51 | 3713 | } |
1da177e4 | 3714 | |
1da177e4 | 3715 | /* see 7.1.7.7; affects power usage, but not budgeting */ |
a7114230 | 3716 | if (hub_is_superspeed(hub->hdev)) |
c2f60db7 | 3717 | status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0); |
a7114230 | 3718 | else |
ad493e5e | 3719 | status = usb_clear_port_feature(hub->hdev, |
a7114230 | 3720 | port1, USB_PORT_FEAT_SUSPEND); |
1da177e4 | 3721 | if (status) { |
d99f6b41 | 3722 | dev_dbg(&port_dev->dev, "can't resume, status %d\n", status); |
1da177e4 | 3723 | } else { |
bbc78c07 | 3724 | /* drive resume for USB_RESUME_TIMEOUT msec */ |
686314cf | 3725 | dev_dbg(&udev->dev, "usb %sresume\n", |
5b1b0b81 | 3726 | (PMSG_IS_AUTO(msg) ? "auto-" : "")); |
bbc78c07 | 3727 | msleep(USB_RESUME_TIMEOUT); |
1da177e4 | 3728 | |
1da177e4 LT |
3729 | /* Virtual root hubs can trigger on GET_PORT_STATUS to |
3730 | * stop resume signaling. Then finish the resume | |
3731 | * sequence. | |
3732 | */ | |
f061f43d | 3733 | status = usb_hub_port_status(hub, port1, &portstatus, &portchange); |
b01b03f3 AS |
3734 | } |
3735 | ||
54515fe5 | 3736 | SuspendCleared: |
b01b03f3 | 3737 | if (status == 0) { |
bfd1e910 | 3738 | udev->port_is_suspended = 0; |
a7114230 AX |
3739 | if (hub_is_superspeed(hub->hdev)) { |
3740 | if (portchange & USB_PORT_STAT_C_LINK_STATE) | |
ad493e5e | 3741 | usb_clear_port_feature(hub->hdev, port1, |
a7114230 AX |
3742 | USB_PORT_FEAT_C_PORT_LINK_STATE); |
3743 | } else { | |
3744 | if (portchange & USB_PORT_STAT_C_SUSPEND) | |
ad493e5e | 3745 | usb_clear_port_feature(hub->hdev, port1, |
a7114230 AX |
3746 | USB_PORT_FEAT_C_SUSPEND); |
3747 | } | |
975f94c7 CY |
3748 | |
3749 | /* TRSMRCY = 10 msec */ | |
3750 | msleep(10); | |
1da177e4 | 3751 | } |
1da177e4 | 3752 | |
6b82b122 | 3753 | if (udev->persist_enabled) |
b8f1ba99 | 3754 | status = wait_for_connected(udev, hub, port1, &portchange, |
a40178b2 PA |
3755 | &portstatus); |
3756 | ||
b01b03f3 AS |
3757 | status = check_port_resume_type(udev, |
3758 | hub, port1, status, portchange, portstatus); | |
54515fe5 AS |
3759 | if (status == 0) |
3760 | status = finish_port_resume(udev); | |
3761 | if (status < 0) { | |
3762 | dev_dbg(&udev->dev, "can't resume, status %d\n", status); | |
3763 | hub_port_logical_disconnect(hub, port1); | |
65580b43 AX |
3764 | } else { |
3765 | /* Try to enable USB2 hardware LPM */ | |
d7a6c0ce | 3766 | usb_enable_usb2_hardware_lpm(udev); |
8306095f | 3767 | |
d590c231 | 3768 | /* Try to enable USB3 LTM */ |
f74631e3 | 3769 | usb_enable_ltm(udev); |
54515fe5 | 3770 | } |
65580b43 | 3771 | |
5c79a1e3 DW |
3772 | usb_unlock_port(port_dev); |
3773 | ||
1da177e4 LT |
3774 | return status; |
3775 | } | |
3776 | ||
0534d468 | 3777 | int usb_remote_wakeup(struct usb_device *udev) |
1da177e4 LT |
3778 | { |
3779 | int status = 0; | |
3780 | ||
5c79a1e3 | 3781 | usb_lock_device(udev); |
1da177e4 | 3782 | if (udev->state == USB_STATE_SUSPENDED) { |
645daaab | 3783 | dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-"); |
9bbdf1e0 AS |
3784 | status = usb_autoresume_device(udev); |
3785 | if (status == 0) { | |
3786 | /* Let the drivers do their thing, then... */ | |
3787 | usb_autosuspend_device(udev); | |
3788 | } | |
1da177e4 | 3789 | } |
5c79a1e3 | 3790 | usb_unlock_device(udev); |
1da177e4 LT |
3791 | return status; |
3792 | } | |
3793 | ||
7e73be22 DW |
3794 | /* Returns 1 if there was a remote wakeup and a connect status change. */ |
3795 | static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port, | |
3796 | u16 portstatus, u16 portchange) | |
3797 | __must_hold(&port_dev->status_lock) | |
3798 | { | |
3799 | struct usb_port *port_dev = hub->ports[port - 1]; | |
3800 | struct usb_device *hdev; | |
3801 | struct usb_device *udev; | |
3802 | int connect_change = 0; | |
e244c469 | 3803 | u16 link_state; |
7e73be22 DW |
3804 | int ret; |
3805 | ||
3806 | hdev = hub->hdev; | |
3807 | udev = port_dev->child; | |
3808 | if (!hub_is_superspeed(hdev)) { | |
3809 | if (!(portchange & USB_PORT_STAT_C_SUSPEND)) | |
3810 | return 0; | |
3811 | usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND); | |
3812 | } else { | |
e244c469 | 3813 | link_state = portstatus & USB_PORT_STAT_LINK_STATE; |
7e73be22 | 3814 | if (!udev || udev->state != USB_STATE_SUSPENDED || |
e244c469 LC |
3815 | (link_state != USB_SS_PORT_LS_U0 && |
3816 | link_state != USB_SS_PORT_LS_U1 && | |
3817 | link_state != USB_SS_PORT_LS_U2)) | |
7e73be22 DW |
3818 | return 0; |
3819 | } | |
3820 | ||
3821 | if (udev) { | |
3822 | /* TRSMRCY = 10 msec */ | |
3823 | msleep(10); | |
3824 | ||
3825 | usb_unlock_port(port_dev); | |
3826 | ret = usb_remote_wakeup(udev); | |
3827 | usb_lock_port(port_dev); | |
3828 | if (ret < 0) | |
3829 | connect_change = 1; | |
3830 | } else { | |
3831 | ret = -ENODEV; | |
3832 | hub_port_disable(hub, port, 1); | |
3833 | } | |
3834 | dev_dbg(&port_dev->dev, "resume, status %d\n", ret); | |
3835 | return connect_change; | |
3836 | } | |
3837 | ||
e6f30dea ML |
3838 | static int check_ports_changed(struct usb_hub *hub) |
3839 | { | |
3840 | int port1; | |
3841 | ||
3842 | for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) { | |
3843 | u16 portstatus, portchange; | |
3844 | int status; | |
3845 | ||
f061f43d | 3846 | status = usb_hub_port_status(hub, port1, &portstatus, &portchange); |
e6f30dea ML |
3847 | if (!status && portchange) |
3848 | return 1; | |
3849 | } | |
3850 | return 0; | |
3851 | } | |
3852 | ||
db690874 | 3853 | static int hub_suspend(struct usb_interface *intf, pm_message_t msg) |
1da177e4 | 3854 | { |
17248569 | 3855 | struct usb_hub *hub = usb_get_intfdata(intf); |
1da177e4 LT |
3856 | struct usb_device *hdev = hub->hdev; |
3857 | unsigned port1; | |
1da177e4 | 3858 | |
e583d9db AS |
3859 | /* |
3860 | * Warn if children aren't already suspended. | |
3861 | * Also, add up the number of wakeup-enabled descendants. | |
3862 | */ | |
3863 | hub->wakeup_enabled_descendants = 0; | |
1da177e4 | 3864 | for (port1 = 1; port1 <= hdev->maxchild; port1++) { |
d99f6b41 DW |
3865 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
3866 | struct usb_device *udev = port_dev->child; | |
1da177e4 | 3867 | |
6840d255 | 3868 | if (udev && udev->can_submit) { |
b658b8f5 DW |
3869 | dev_warn(&port_dev->dev, "device %s not suspended yet\n", |
3870 | dev_name(&udev->dev)); | |
5b1b0b81 | 3871 | if (PMSG_IS_AUTO(msg)) |
cbb33004 | 3872 | return -EBUSY; |
c9f89fa4 | 3873 | } |
e583d9db AS |
3874 | if (udev) |
3875 | hub->wakeup_enabled_descendants += | |
7a6127e3 | 3876 | usb_wakeup_enabled_descendants(udev); |
1da177e4 | 3877 | } |
e6f30dea ML |
3878 | |
3879 | if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) { | |
3880 | /* check if there are changes pending on hub ports */ | |
3881 | if (check_ports_changed(hub)) { | |
3882 | if (PMSG_IS_AUTO(msg)) | |
3883 | return -EBUSY; | |
3884 | pm_wakeup_event(&hdev->dev, 2000); | |
3885 | } | |
3886 | } | |
3887 | ||
4296c70a SS |
3888 | if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) { |
3889 | /* Enable hub to send remote wakeup for all ports. */ | |
3890 | for (port1 = 1; port1 <= hdev->maxchild; port1++) { | |
3bee346b MM |
3891 | set_port_feature(hdev, |
3892 | port1 | | |
3893 | USB_PORT_FEAT_REMOTE_WAKE_CONNECT | | |
3894 | USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT | | |
3895 | USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT, | |
3896 | USB_PORT_FEAT_REMOTE_WAKE_MASK); | |
4296c70a SS |
3897 | } |
3898 | } | |
1da177e4 | 3899 | |
441b62c1 | 3900 | dev_dbg(&intf->dev, "%s\n", __func__); |
40f122f3 | 3901 | |
37ebb549 | 3902 | /* stop hub_wq and related activity */ |
4330354f | 3903 | hub_quiesce(hub, HUB_SUSPEND); |
b6f6436d | 3904 | return 0; |
1da177e4 LT |
3905 | } |
3906 | ||
379cacc5 AS |
3907 | /* Report wakeup requests from the ports of a resuming root hub */ |
3908 | static void report_wakeup_requests(struct usb_hub *hub) | |
3909 | { | |
3910 | struct usb_device *hdev = hub->hdev; | |
3911 | struct usb_device *udev; | |
3912 | struct usb_hcd *hcd; | |
3913 | unsigned long resuming_ports; | |
3914 | int i; | |
3915 | ||
3916 | if (hdev->parent) | |
3917 | return; /* Not a root hub */ | |
3918 | ||
3919 | hcd = bus_to_hcd(hdev->bus); | |
3920 | if (hcd->driver->get_resuming_ports) { | |
3921 | ||
3922 | /* | |
3923 | * The get_resuming_ports() method returns a bitmap (origin 0) | |
3924 | * of ports which have started wakeup signaling but have not | |
3925 | * yet finished resuming. During system resume we will | |
3926 | * resume all the enabled ports, regardless of any wakeup | |
3927 | * signals, which means the wakeup requests would be lost. | |
3928 | * To prevent this, report them to the PM core here. | |
3929 | */ | |
3930 | resuming_ports = hcd->driver->get_resuming_ports(hcd); | |
3931 | for (i = 0; i < hdev->maxchild; ++i) { | |
3932 | if (test_bit(i, &resuming_ports)) { | |
3933 | udev = hub->ports[i]->child; | |
3934 | if (udev) | |
3935 | pm_wakeup_event(&udev->dev, 0); | |
3936 | } | |
3937 | } | |
3938 | } | |
3939 | } | |
3940 | ||
1da177e4 LT |
3941 | static int hub_resume(struct usb_interface *intf) |
3942 | { | |
5e6effae | 3943 | struct usb_hub *hub = usb_get_intfdata(intf); |
40f122f3 | 3944 | |
5e6effae | 3945 | dev_dbg(&intf->dev, "%s\n", __func__); |
f2835219 | 3946 | hub_activate(hub, HUB_RESUME); |
379cacc5 AS |
3947 | |
3948 | /* | |
3949 | * This should be called only for system resume, not runtime resume. | |
3950 | * We can't tell the difference here, so some wakeup requests will be | |
3951 | * reported at the wrong time or more than once. This shouldn't | |
3952 | * matter much, so long as they do get reported. | |
3953 | */ | |
3954 | report_wakeup_requests(hub); | |
1da177e4 LT |
3955 | return 0; |
3956 | } | |
3957 | ||
b41a60ec | 3958 | static int hub_reset_resume(struct usb_interface *intf) |
f07600cf | 3959 | { |
b41a60ec | 3960 | struct usb_hub *hub = usb_get_intfdata(intf); |
f07600cf | 3961 | |
5e6effae | 3962 | dev_dbg(&intf->dev, "%s\n", __func__); |
f2835219 | 3963 | hub_activate(hub, HUB_RESET_RESUME); |
f07600cf AS |
3964 | return 0; |
3965 | } | |
3966 | ||
54515fe5 AS |
3967 | /** |
3968 | * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power | |
3969 | * @rhdev: struct usb_device for the root hub | |
3970 | * | |
3971 | * The USB host controller driver calls this function when its root hub | |
3972 | * is resumed and Vbus power has been interrupted or the controller | |
feccc30d AS |
3973 | * has been reset. The routine marks @rhdev as having lost power. |
3974 | * When the hub driver is resumed it will take notice and carry out | |
3975 | * power-session recovery for all the "USB-PERSIST"-enabled child devices; | |
3976 | * the others will be disconnected. | |
54515fe5 AS |
3977 | */ |
3978 | void usb_root_hub_lost_power(struct usb_device *rhdev) | |
3979 | { | |
0442d7b0 | 3980 | dev_notice(&rhdev->dev, "root hub lost power or was reset\n"); |
54515fe5 AS |
3981 | rhdev->reset_resume = 1; |
3982 | } | |
3983 | EXPORT_SYMBOL_GPL(usb_root_hub_lost_power); | |
3984 | ||
1ea7e0e8 SS |
3985 | static const char * const usb3_lpm_names[] = { |
3986 | "U0", | |
3987 | "U1", | |
3988 | "U2", | |
3989 | "U3", | |
3990 | }; | |
3991 | ||
3992 | /* | |
3993 | * Send a Set SEL control transfer to the device, prior to enabling | |
3994 | * device-initiated U1 or U2. This lets the device know the exit latencies from | |
3995 | * the time the device initiates a U1 or U2 exit, to the time it will receive a | |
3996 | * packet from the host. | |
3997 | * | |
3998 | * This function will fail if the SEL or PEL values for udev are greater than | |
3999 | * the maximum allowed values for the link state to be enabled. | |
4000 | */ | |
e146caf3 | 4001 | static int usb_req_set_sel(struct usb_device *udev) |
1ea7e0e8 SS |
4002 | { |
4003 | struct usb_set_sel_req *sel_values; | |
4004 | unsigned long long u1_sel; | |
4005 | unsigned long long u1_pel; | |
4006 | unsigned long long u2_sel; | |
4007 | unsigned long long u2_pel; | |
4008 | int ret; | |
4009 | ||
e146caf3 | 4010 | if (!udev->parent || udev->speed < USB_SPEED_SUPER || !udev->lpm_capable) |
38d7f688 XR |
4011 | return 0; |
4012 | ||
1ea7e0e8 SS |
4013 | /* Convert SEL and PEL stored in ns to us */ |
4014 | u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000); | |
4015 | u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000); | |
4016 | u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000); | |
4017 | u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000); | |
4018 | ||
4019 | /* | |
4020 | * Make sure that the calculated SEL and PEL values for the link | |
4021 | * state we're enabling aren't bigger than the max SEL/PEL | |
4022 | * value that will fit in the SET SEL control transfer. | |
4023 | * Otherwise the device would get an incorrect idea of the exit | |
4024 | * latency for the link state, and could start a device-initiated | |
4025 | * U1/U2 when the exit latencies are too high. | |
4026 | */ | |
e146caf3 MN |
4027 | if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL || |
4028 | u1_pel > USB3_LPM_MAX_U1_SEL_PEL || | |
4029 | u2_sel > USB3_LPM_MAX_U2_SEL_PEL || | |
4030 | u2_pel > USB3_LPM_MAX_U2_SEL_PEL) { | |
4031 | dev_dbg(&udev->dev, "Device-initiated U1/U2 disabled due to long SEL or PEL\n"); | |
1ea7e0e8 SS |
4032 | return -EINVAL; |
4033 | } | |
4034 | ||
1ea7e0e8 SS |
4035 | /* |
4036 | * usb_enable_lpm() can be called as part of a failed device reset, | |
4037 | * which may be initiated by an error path of a mass storage driver. | |
4038 | * Therefore, use GFP_NOIO. | |
4039 | */ | |
4040 | sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO); | |
4041 | if (!sel_values) | |
4042 | return -ENOMEM; | |
4043 | ||
4044 | sel_values->u1_sel = u1_sel; | |
4045 | sel_values->u1_pel = u1_pel; | |
4046 | sel_values->u2_sel = cpu_to_le16(u2_sel); | |
4047 | sel_values->u2_pel = cpu_to_le16(u2_pel); | |
4048 | ||
4049 | ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), | |
4050 | USB_REQ_SET_SEL, | |
4051 | USB_RECIP_DEVICE, | |
4052 | 0, 0, | |
4053 | sel_values, sizeof *(sel_values), | |
4054 | USB_CTRL_SET_TIMEOUT); | |
4055 | kfree(sel_values); | |
e146caf3 MN |
4056 | |
4057 | if (ret > 0) | |
4058 | udev->lpm_devinit_allow = 1; | |
4059 | ||
1ea7e0e8 SS |
4060 | return ret; |
4061 | } | |
4062 | ||
4063 | /* | |
4064 | * Enable or disable device-initiated U1 or U2 transitions. | |
4065 | */ | |
4066 | static int usb_set_device_initiated_lpm(struct usb_device *udev, | |
4067 | enum usb3_link_state state, bool enable) | |
4068 | { | |
4069 | int ret; | |
4070 | int feature; | |
4071 | ||
4072 | switch (state) { | |
4073 | case USB3_LPM_U1: | |
4074 | feature = USB_DEVICE_U1_ENABLE; | |
4075 | break; | |
4076 | case USB3_LPM_U2: | |
4077 | feature = USB_DEVICE_U2_ENABLE; | |
4078 | break; | |
4079 | default: | |
4080 | dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n", | |
4081 | __func__, enable ? "enable" : "disable"); | |
4082 | return -EINVAL; | |
4083 | } | |
4084 | ||
4085 | if (udev->state != USB_STATE_CONFIGURED) { | |
4086 | dev_dbg(&udev->dev, "%s: Can't %s %s state " | |
4087 | "for unconfigured device.\n", | |
4088 | __func__, enable ? "enable" : "disable", | |
4089 | usb3_lpm_names[state]); | |
4090 | return 0; | |
4091 | } | |
4092 | ||
4093 | if (enable) { | |
1ea7e0e8 SS |
4094 | /* |
4095 | * Now send the control transfer to enable device-initiated LPM | |
4096 | * for either U1 or U2. | |
4097 | */ | |
4098 | ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), | |
4099 | USB_REQ_SET_FEATURE, | |
4100 | USB_RECIP_DEVICE, | |
4101 | feature, | |
4102 | 0, NULL, 0, | |
4103 | USB_CTRL_SET_TIMEOUT); | |
4104 | } else { | |
4105 | ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), | |
4106 | USB_REQ_CLEAR_FEATURE, | |
4107 | USB_RECIP_DEVICE, | |
4108 | feature, | |
4109 | 0, NULL, 0, | |
4110 | USB_CTRL_SET_TIMEOUT); | |
4111 | } | |
4112 | if (ret < 0) { | |
4113 | dev_warn(&udev->dev, "%s of device-initiated %s failed.\n", | |
4114 | enable ? "Enable" : "Disable", | |
4115 | usb3_lpm_names[state]); | |
4116 | return -EBUSY; | |
4117 | } | |
4118 | return 0; | |
4119 | } | |
4120 | ||
4121 | static int usb_set_lpm_timeout(struct usb_device *udev, | |
4122 | enum usb3_link_state state, int timeout) | |
4123 | { | |
4124 | int ret; | |
4125 | int feature; | |
4126 | ||
4127 | switch (state) { | |
4128 | case USB3_LPM_U1: | |
4129 | feature = USB_PORT_FEAT_U1_TIMEOUT; | |
4130 | break; | |
4131 | case USB3_LPM_U2: | |
4132 | feature = USB_PORT_FEAT_U2_TIMEOUT; | |
4133 | break; | |
4134 | default: | |
4135 | dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n", | |
4136 | __func__); | |
4137 | return -EINVAL; | |
4138 | } | |
4139 | ||
4140 | if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT && | |
4141 | timeout != USB3_LPM_DEVICE_INITIATED) { | |
4142 | dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, " | |
4143 | "which is a reserved value.\n", | |
4144 | usb3_lpm_names[state], timeout); | |
4145 | return -EINVAL; | |
4146 | } | |
4147 | ||
4148 | ret = set_port_feature(udev->parent, | |
4149 | USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum, | |
4150 | feature); | |
4151 | if (ret < 0) { | |
4152 | dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x," | |
4153 | "error code %i\n", usb3_lpm_names[state], | |
4154 | timeout, ret); | |
4155 | return -EBUSY; | |
4156 | } | |
4157 | if (state == USB3_LPM_U1) | |
4158 | udev->u1_params.timeout = timeout; | |
4159 | else | |
4160 | udev->u2_params.timeout = timeout; | |
4161 | return 0; | |
4162 | } | |
4163 | ||
1b7f56fb MN |
4164 | /* |
4165 | * Don't allow device intiated U1/U2 if the system exit latency + one bus | |
4166 | * interval is greater than the minimum service interval of any active | |
4167 | * periodic endpoint. See USB 3.2 section 9.4.9 | |
4168 | */ | |
4169 | static bool usb_device_may_initiate_lpm(struct usb_device *udev, | |
4170 | enum usb3_link_state state) | |
4171 | { | |
4172 | unsigned int sel; /* us */ | |
4173 | int i, j; | |
4174 | ||
e146caf3 MN |
4175 | if (!udev->lpm_devinit_allow) |
4176 | return false; | |
4177 | ||
1b7f56fb MN |
4178 | if (state == USB3_LPM_U1) |
4179 | sel = DIV_ROUND_UP(udev->u1_params.sel, 1000); | |
4180 | else if (state == USB3_LPM_U2) | |
4181 | sel = DIV_ROUND_UP(udev->u2_params.sel, 1000); | |
4182 | else | |
4183 | return false; | |
4184 | ||
4185 | for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) { | |
4186 | struct usb_interface *intf; | |
4187 | struct usb_endpoint_descriptor *desc; | |
4188 | unsigned int interval; | |
4189 | ||
4190 | intf = udev->actconfig->interface[i]; | |
4191 | if (!intf) | |
4192 | continue; | |
4193 | ||
4194 | for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) { | |
4195 | desc = &intf->cur_altsetting->endpoint[j].desc; | |
4196 | ||
4197 | if (usb_endpoint_xfer_int(desc) || | |
4198 | usb_endpoint_xfer_isoc(desc)) { | |
4199 | interval = (1 << (desc->bInterval - 1)) * 125; | |
4200 | if (sel + 125 > interval) | |
4201 | return false; | |
4202 | } | |
4203 | } | |
4204 | } | |
4205 | return true; | |
4206 | } | |
4207 | ||
1ea7e0e8 SS |
4208 | /* |
4209 | * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated | |
4210 | * U1/U2 entry. | |
4211 | * | |
4212 | * We will attempt to enable U1 or U2, but there are no guarantees that the | |
4213 | * control transfers to set the hub timeout or enable device-initiated U1/U2 | |
4214 | * will be successful. | |
4215 | * | |
56175929 TN |
4216 | * If the control transfer to enable device-initiated U1/U2 entry fails, then |
4217 | * hub-initiated U1/U2 will be disabled. | |
4218 | * | |
1ea7e0e8 SS |
4219 | * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI |
4220 | * driver know about it. If that call fails, it should be harmless, and just | |
4221 | * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency. | |
4222 | */ | |
4223 | static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev, | |
4224 | enum usb3_link_state state) | |
4225 | { | |
e146caf3 | 4226 | int timeout; |
ae8963ad SS |
4227 | __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat; |
4228 | __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat; | |
4229 | ||
4230 | /* If the device says it doesn't have *any* exit latency to come out of | |
4231 | * U1 or U2, it's probably lying. Assume it doesn't implement that link | |
4232 | * state. | |
4233 | */ | |
4234 | if ((state == USB3_LPM_U1 && u1_mel == 0) || | |
4235 | (state == USB3_LPM_U2 && u2_mel == 0)) | |
4236 | return; | |
1ea7e0e8 SS |
4237 | |
4238 | /* We allow the host controller to set the U1/U2 timeout internally | |
4239 | * first, so that it can change its schedule to account for the | |
4240 | * additional latency to send data to a device in a lower power | |
4241 | * link state. | |
4242 | */ | |
4243 | timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state); | |
4244 | ||
4245 | /* xHCI host controller doesn't want to enable this LPM state. */ | |
4246 | if (timeout == 0) | |
4247 | return; | |
4248 | ||
4249 | if (timeout < 0) { | |
4250 | dev_warn(&udev->dev, "Could not enable %s link state, " | |
4251 | "xHCI error %i.\n", usb3_lpm_names[state], | |
4252 | timeout); | |
4253 | return; | |
4254 | } | |
4255 | ||
bf5ce5bf | 4256 | if (usb_set_lpm_timeout(udev, state, timeout)) { |
1ea7e0e8 SS |
4257 | /* If we can't set the parent hub U1/U2 timeout, |
4258 | * device-initiated LPM won't be allowed either, so let the xHCI | |
4259 | * host know that this link state won't be enabled. | |
4260 | */ | |
4261 | hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state); | |
56175929 TN |
4262 | return; |
4263 | } | |
4264 | ||
4265 | /* Only a configured device will accept the Set Feature | |
4266 | * U1/U2_ENABLE | |
4267 | */ | |
4268 | if (udev->actconfig && | |
1b7f56fb MN |
4269 | usb_device_may_initiate_lpm(udev, state)) { |
4270 | if (usb_set_device_initiated_lpm(udev, state, true)) { | |
4271 | /* | |
4272 | * Request to enable device initiated U1/U2 failed, | |
4273 | * better to turn off lpm in this case. | |
4274 | */ | |
4275 | usb_set_lpm_timeout(udev, state, 0); | |
4276 | hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state); | |
4277 | return; | |
4278 | } | |
bf5ce5bf | 4279 | } |
1ea7e0e8 | 4280 | |
1b7f56fb MN |
4281 | if (state == USB3_LPM_U1) |
4282 | udev->usb3_lpm_u1_enabled = 1; | |
4283 | else if (state == USB3_LPM_U2) | |
4284 | udev->usb3_lpm_u2_enabled = 1; | |
4285 | } | |
1ea7e0e8 SS |
4286 | /* |
4287 | * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated | |
4288 | * U1/U2 entry. | |
4289 | * | |
4290 | * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry. | |
4291 | * If zero is returned, the parent will not allow the link to go into U1/U2. | |
4292 | * | |
4293 | * If zero is returned, device-initiated U1/U2 entry may still be enabled, but | |
4294 | * it won't have an effect on the bus link state because the parent hub will | |
4295 | * still disallow device-initiated U1/U2 entry. | |
4296 | * | |
4297 | * If zero is returned, the xHCI host controller may still think U1/U2 entry is | |
4298 | * possible. The result will be slightly more bus bandwidth will be taken up | |
4299 | * (to account for U1/U2 exit latency), but it should be harmless. | |
4300 | */ | |
4301 | static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev, | |
4302 | enum usb3_link_state state) | |
4303 | { | |
1ea7e0e8 SS |
4304 | switch (state) { |
4305 | case USB3_LPM_U1: | |
1ea7e0e8 | 4306 | case USB3_LPM_U2: |
1ea7e0e8 SS |
4307 | break; |
4308 | default: | |
4309 | dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n", | |
4310 | __func__); | |
4311 | return -EINVAL; | |
4312 | } | |
4313 | ||
4314 | if (usb_set_lpm_timeout(udev, state, 0)) | |
4315 | return -EBUSY; | |
4316 | ||
4317 | usb_set_device_initiated_lpm(udev, state, false); | |
4318 | ||
4319 | if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state)) | |
4320 | dev_warn(&udev->dev, "Could not disable xHCI %s timeout, " | |
4321 | "bus schedule bandwidth may be impacted.\n", | |
4322 | usb3_lpm_names[state]); | |
bf5ce5bf LB |
4323 | |
4324 | /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM | |
4325 | * is disabled. Hub will disallows link to enter U1/U2 as well, | |
4326 | * even device is initiating LPM. Hence LPM is disabled if hub LPM | |
4327 | * timeout set to 0, no matter device-initiated LPM is disabled or | |
4328 | * not. | |
4329 | */ | |
4330 | if (state == USB3_LPM_U1) | |
4331 | udev->usb3_lpm_u1_enabled = 0; | |
4332 | else if (state == USB3_LPM_U2) | |
4333 | udev->usb3_lpm_u2_enabled = 0; | |
4334 | ||
1ea7e0e8 SS |
4335 | return 0; |
4336 | } | |
4337 | ||
4338 | /* | |
4339 | * Disable hub-initiated and device-initiated U1 and U2 entry. | |
4340 | * Caller must own the bandwidth_mutex. | |
4341 | * | |
4342 | * This will call usb_enable_lpm() on failure, which will decrement | |
4343 | * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero. | |
4344 | */ | |
4345 | int usb_disable_lpm(struct usb_device *udev) | |
4346 | { | |
4347 | struct usb_hcd *hcd; | |
4348 | ||
4349 | if (!udev || !udev->parent || | |
8a1b2725 | 4350 | udev->speed < USB_SPEED_SUPER || |
51df62ff | 4351 | !udev->lpm_capable || |
fea3af5e | 4352 | udev->state < USB_STATE_CONFIGURED) |
1ea7e0e8 SS |
4353 | return 0; |
4354 | ||
4355 | hcd = bus_to_hcd(udev->bus); | |
4356 | if (!hcd || !hcd->driver->disable_usb3_lpm_timeout) | |
4357 | return 0; | |
4358 | ||
4359 | udev->lpm_disable_count++; | |
55558c33 | 4360 | if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0)) |
1ea7e0e8 SS |
4361 | return 0; |
4362 | ||
4363 | /* If LPM is enabled, attempt to disable it. */ | |
4364 | if (usb_disable_link_state(hcd, udev, USB3_LPM_U1)) | |
4365 | goto enable_lpm; | |
4366 | if (usb_disable_link_state(hcd, udev, USB3_LPM_U2)) | |
4367 | goto enable_lpm; | |
4368 | ||
4369 | return 0; | |
4370 | ||
4371 | enable_lpm: | |
4372 | usb_enable_lpm(udev); | |
4373 | return -EBUSY; | |
4374 | } | |
4375 | EXPORT_SYMBOL_GPL(usb_disable_lpm); | |
4376 | ||
4377 | /* Grab the bandwidth_mutex before calling usb_disable_lpm() */ | |
4378 | int usb_unlocked_disable_lpm(struct usb_device *udev) | |
4379 | { | |
4380 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
4381 | int ret; | |
4382 | ||
4383 | if (!hcd) | |
4384 | return -EINVAL; | |
4385 | ||
4386 | mutex_lock(hcd->bandwidth_mutex); | |
4387 | ret = usb_disable_lpm(udev); | |
4388 | mutex_unlock(hcd->bandwidth_mutex); | |
4389 | ||
4390 | return ret; | |
4391 | } | |
4392 | EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm); | |
4393 | ||
4394 | /* | |
4395 | * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The | |
4396 | * xHCI host policy may prevent U1 or U2 from being enabled. | |
4397 | * | |
4398 | * Other callers may have disabled link PM, so U1 and U2 entry will be disabled | |
4399 | * until the lpm_disable_count drops to zero. Caller must own the | |
4400 | * bandwidth_mutex. | |
4401 | */ | |
4402 | void usb_enable_lpm(struct usb_device *udev) | |
4403 | { | |
4404 | struct usb_hcd *hcd; | |
513072d9 LB |
4405 | struct usb_hub *hub; |
4406 | struct usb_port *port_dev; | |
1ea7e0e8 SS |
4407 | |
4408 | if (!udev || !udev->parent || | |
8a1b2725 | 4409 | udev->speed < USB_SPEED_SUPER || |
51df62ff | 4410 | !udev->lpm_capable || |
fea3af5e | 4411 | udev->state < USB_STATE_CONFIGURED) |
1ea7e0e8 SS |
4412 | return; |
4413 | ||
4414 | udev->lpm_disable_count--; | |
4415 | hcd = bus_to_hcd(udev->bus); | |
4416 | /* Double check that we can both enable and disable LPM. | |
4417 | * Device must be configured to accept set feature U1/U2 timeout. | |
4418 | */ | |
4419 | if (!hcd || !hcd->driver->enable_usb3_lpm_timeout || | |
4420 | !hcd->driver->disable_usb3_lpm_timeout) | |
4421 | return; | |
4422 | ||
4423 | if (udev->lpm_disable_count > 0) | |
4424 | return; | |
4425 | ||
513072d9 LB |
4426 | hub = usb_hub_to_struct_hub(udev->parent); |
4427 | if (!hub) | |
4428 | return; | |
4429 | ||
4430 | port_dev = hub->ports[udev->portnum - 1]; | |
4431 | ||
4432 | if (port_dev->usb3_lpm_u1_permit) | |
4433 | usb_enable_link_state(hcd, udev, USB3_LPM_U1); | |
4434 | ||
4435 | if (port_dev->usb3_lpm_u2_permit) | |
4436 | usb_enable_link_state(hcd, udev, USB3_LPM_U2); | |
1ea7e0e8 SS |
4437 | } |
4438 | EXPORT_SYMBOL_GPL(usb_enable_lpm); | |
4439 | ||
4440 | /* Grab the bandwidth_mutex before calling usb_enable_lpm() */ | |
4441 | void usb_unlocked_enable_lpm(struct usb_device *udev) | |
4442 | { | |
4443 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
4444 | ||
4445 | if (!hcd) | |
4446 | return; | |
4447 | ||
4448 | mutex_lock(hcd->bandwidth_mutex); | |
4449 | usb_enable_lpm(udev); | |
4450 | mutex_unlock(hcd->bandwidth_mutex); | |
4451 | } | |
4452 | EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm); | |
4453 | ||
37be6676 MN |
4454 | /* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */ |
4455 | static void hub_usb3_port_prepare_disable(struct usb_hub *hub, | |
4456 | struct usb_port *port_dev) | |
4457 | { | |
4458 | struct usb_device *udev = port_dev->child; | |
4459 | int ret; | |
4460 | ||
4461 | if (udev && udev->port_is_suspended && udev->do_remote_wakeup) { | |
4462 | ret = hub_set_port_link_state(hub, port_dev->portnum, | |
4463 | USB_SS_PORT_LS_U0); | |
4464 | if (!ret) { | |
4465 | msleep(USB_RESUME_TIMEOUT); | |
4466 | ret = usb_disable_remote_wakeup(udev); | |
4467 | } | |
4468 | if (ret) | |
4469 | dev_warn(&udev->dev, | |
4470 | "Port disable: can't disable remote wake\n"); | |
4471 | udev->do_remote_wakeup = 0; | |
4472 | } | |
4473 | } | |
1ea7e0e8 | 4474 | |
d388dab7 AS |
4475 | #else /* CONFIG_PM */ |
4476 | ||
f07600cf AS |
4477 | #define hub_suspend NULL |
4478 | #define hub_resume NULL | |
4479 | #define hub_reset_resume NULL | |
1ea7e0e8 | 4480 | |
37be6676 MN |
4481 | static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub, |
4482 | struct usb_port *port_dev) { } | |
4483 | ||
1ea7e0e8 SS |
4484 | int usb_disable_lpm(struct usb_device *udev) |
4485 | { | |
4486 | return 0; | |
4487 | } | |
e9261fb6 | 4488 | EXPORT_SYMBOL_GPL(usb_disable_lpm); |
1ea7e0e8 SS |
4489 | |
4490 | void usb_enable_lpm(struct usb_device *udev) { } | |
e9261fb6 | 4491 | EXPORT_SYMBOL_GPL(usb_enable_lpm); |
1ea7e0e8 SS |
4492 | |
4493 | int usb_unlocked_disable_lpm(struct usb_device *udev) | |
4494 | { | |
4495 | return 0; | |
4496 | } | |
e9261fb6 | 4497 | EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm); |
1ea7e0e8 SS |
4498 | |
4499 | void usb_unlocked_enable_lpm(struct usb_device *udev) { } | |
e9261fb6 | 4500 | EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm); |
f74631e3 SS |
4501 | |
4502 | int usb_disable_ltm(struct usb_device *udev) | |
4503 | { | |
4504 | return 0; | |
4505 | } | |
4506 | EXPORT_SYMBOL_GPL(usb_disable_ltm); | |
4507 | ||
4508 | void usb_enable_ltm(struct usb_device *udev) { } | |
4509 | EXPORT_SYMBOL_GPL(usb_enable_ltm); | |
c4b51a43 | 4510 | |
4a95b1fc SR |
4511 | static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port, |
4512 | u16 portstatus, u16 portchange) | |
4513 | { | |
4514 | return 0; | |
4515 | } | |
4516 | ||
e146caf3 MN |
4517 | static int usb_req_set_sel(struct usb_device *udev) |
4518 | { | |
4519 | return 0; | |
4520 | } | |
4521 | ||
c4b51a43 | 4522 | #endif /* CONFIG_PM */ |
d388dab7 | 4523 | |
3bc02bce GU |
4524 | /* |
4525 | * USB-3 does not have a similar link state as USB-2 that will avoid negotiating | |
4526 | * a connection with a plugged-in cable but will signal the host when the cable | |
4527 | * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices | |
4528 | */ | |
4529 | static int hub_port_disable(struct usb_hub *hub, int port1, int set_state) | |
4530 | { | |
4531 | struct usb_port *port_dev = hub->ports[port1 - 1]; | |
4532 | struct usb_device *hdev = hub->hdev; | |
4533 | int ret = 0; | |
4534 | ||
4535 | if (!hub->error) { | |
4536 | if (hub_is_superspeed(hub->hdev)) { | |
4537 | hub_usb3_port_prepare_disable(hub, port_dev); | |
4538 | ret = hub_set_port_link_state(hub, port_dev->portnum, | |
4539 | USB_SS_PORT_LS_U3); | |
4540 | } else { | |
4541 | ret = usb_clear_port_feature(hdev, port1, | |
4542 | USB_PORT_FEAT_ENABLE); | |
4543 | } | |
4544 | } | |
4545 | if (port_dev->child && set_state) | |
4546 | usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED); | |
4547 | if (ret && ret != -ENODEV) | |
4548 | dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret); | |
4549 | return ret; | |
4550 | } | |
4551 | ||
8dd8d2c9 DD |
4552 | /* |
4553 | * usb_port_disable - disable a usb device's upstream port | |
4554 | * @udev: device to disable | |
4555 | * Context: @udev locked, must be able to sleep. | |
4556 | * | |
4557 | * Disables a USB device that isn't in active use. | |
4558 | */ | |
4559 | int usb_port_disable(struct usb_device *udev) | |
4560 | { | |
4561 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); | |
4562 | ||
4563 | return hub_port_disable(hub, udev->portnum, 0); | |
4564 | } | |
1da177e4 LT |
4565 | |
4566 | /* USB 2.0 spec, 7.1.7.3 / fig 7-29: | |
4567 | * | |
4568 | * Between connect detection and reset signaling there must be a delay | |
4569 | * of 100ms at least for debounce and power-settling. The corresponding | |
4570 | * timer shall restart whenever the downstream port detects a disconnect. | |
469271f8 | 4571 | * |
1da177e4 LT |
4572 | * Apparently there are some bluetooth and irda-dongles and a number of |
4573 | * low-speed devices for which this debounce period may last over a second. | |
4574 | * Not covered by the spec - but easy to deal with. | |
4575 | * | |
4576 | * This implementation uses a 1500ms total debounce timeout; if the | |
4577 | * connection isn't stable by then it returns -ETIMEDOUT. It checks | |
4578 | * every 25ms for transient disconnects. When the port status has been | |
4579 | * unchanged for 100ms it returns the port status. | |
4580 | */ | |
ad493e5e | 4581 | int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected) |
1da177e4 LT |
4582 | { |
4583 | int ret; | |
1da177e4 LT |
4584 | u16 portchange, portstatus; |
4585 | unsigned connection = 0xffff; | |
d99f6b41 DW |
4586 | int total_time, stable_time = 0; |
4587 | struct usb_port *port_dev = hub->ports[port1 - 1]; | |
1da177e4 LT |
4588 | |
4589 | for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) { | |
f061f43d | 4590 | ret = usb_hub_port_status(hub, port1, &portstatus, &portchange); |
1da177e4 LT |
4591 | if (ret < 0) |
4592 | return ret; | |
4593 | ||
4594 | if (!(portchange & USB_PORT_STAT_C_CONNECTION) && | |
4595 | (portstatus & USB_PORT_STAT_CONNECTION) == connection) { | |
ad493e5e LT |
4596 | if (!must_be_connected || |
4597 | (connection == USB_PORT_STAT_CONNECTION)) | |
4598 | stable_time += HUB_DEBOUNCE_STEP; | |
1da177e4 LT |
4599 | if (stable_time >= HUB_DEBOUNCE_STABLE) |
4600 | break; | |
4601 | } else { | |
4602 | stable_time = 0; | |
4603 | connection = portstatus & USB_PORT_STAT_CONNECTION; | |
4604 | } | |
4605 | ||
4606 | if (portchange & USB_PORT_STAT_C_CONNECTION) { | |
ad493e5e | 4607 | usb_clear_port_feature(hub->hdev, port1, |
1da177e4 LT |
4608 | USB_PORT_FEAT_C_CONNECTION); |
4609 | } | |
4610 | ||
4611 | if (total_time >= HUB_DEBOUNCE_TIMEOUT) | |
4612 | break; | |
4613 | msleep(HUB_DEBOUNCE_STEP); | |
4614 | } | |
4615 | ||
d99f6b41 DW |
4616 | dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n", |
4617 | total_time, stable_time, portstatus); | |
1da177e4 LT |
4618 | |
4619 | if (stable_time < HUB_DEBOUNCE_STABLE) | |
4620 | return -ETIMEDOUT; | |
4621 | return portstatus; | |
4622 | } | |
4623 | ||
fc721f51 | 4624 | void usb_ep0_reinit(struct usb_device *udev) |
1da177e4 | 4625 | { |
ddeac4e7 AS |
4626 | usb_disable_endpoint(udev, 0 + USB_DIR_IN, true); |
4627 | usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true); | |
2caf7fcd | 4628 | usb_enable_endpoint(udev, &udev->ep0, true); |
1da177e4 | 4629 | } |
fc721f51 | 4630 | EXPORT_SYMBOL_GPL(usb_ep0_reinit); |
1da177e4 LT |
4631 | |
4632 | #define usb_sndaddr0pipe() (PIPE_CONTROL << 30) | |
4633 | #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN) | |
4634 | ||
4326ed0b | 4635 | static int hub_set_address(struct usb_device *udev, int devnum) |
1da177e4 LT |
4636 | { |
4637 | int retval; | |
c6515272 | 4638 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); |
1da177e4 | 4639 | |
c6515272 SS |
4640 | /* |
4641 | * The host controller will choose the device address, | |
4642 | * instead of the core having chosen it earlier | |
4643 | */ | |
4644 | if (!hcd->driver->address_device && devnum <= 1) | |
1da177e4 LT |
4645 | return -EINVAL; |
4646 | if (udev->state == USB_STATE_ADDRESS) | |
4647 | return 0; | |
4648 | if (udev->state != USB_STATE_DEFAULT) | |
4649 | return -EINVAL; | |
c8d4af8e | 4650 | if (hcd->driver->address_device) |
c6515272 | 4651 | retval = hcd->driver->address_device(hcd, udev); |
c8d4af8e | 4652 | else |
c6515272 SS |
4653 | retval = usb_control_msg(udev, usb_sndaddr0pipe(), |
4654 | USB_REQ_SET_ADDRESS, 0, devnum, 0, | |
4655 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
1da177e4 | 4656 | if (retval == 0) { |
3b29b68b | 4657 | update_devnum(udev, devnum); |
4953d141 | 4658 | /* Device now using proper address. */ |
1da177e4 | 4659 | usb_set_device_state(udev, USB_STATE_ADDRESS); |
fc721f51 | 4660 | usb_ep0_reinit(udev); |
1da177e4 LT |
4661 | } |
4662 | return retval; | |
4663 | } | |
4664 | ||
890dae88 MN |
4665 | /* |
4666 | * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM | |
4667 | * when they're plugged into a USB 2.0 port, but they don't work when LPM is | |
4668 | * enabled. | |
4669 | * | |
4670 | * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the | |
4671 | * device says it supports the new USB 2.0 Link PM errata by setting the BESL | |
4672 | * support bit in the BOS descriptor. | |
4673 | */ | |
4674 | static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev) | |
4675 | { | |
d99f6b41 DW |
4676 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); |
4677 | int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN; | |
890dae88 | 4678 | |
7b2db29f | 4679 | if (!udev->usb2_hw_lpm_capable || !udev->bos) |
890dae88 MN |
4680 | return; |
4681 | ||
d99f6b41 DW |
4682 | if (hub) |
4683 | connect_type = hub->ports[udev->portnum - 1]->connect_type; | |
890dae88 | 4684 | |
23c05820 | 4685 | if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) || |
890dae88 MN |
4686 | connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) { |
4687 | udev->usb2_hw_lpm_allowed = 1; | |
7529b257 | 4688 | usb_enable_usb2_hardware_lpm(udev); |
890dae88 MN |
4689 | } |
4690 | } | |
4691 | ||
48fc7dbd DW |
4692 | static int hub_enable_device(struct usb_device *udev) |
4693 | { | |
4694 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); | |
4695 | ||
4696 | if (!hcd->driver->enable_device) | |
4697 | return 0; | |
4698 | if (udev->state == USB_STATE_ADDRESS) | |
4699 | return 0; | |
4700 | if (udev->state != USB_STATE_DEFAULT) | |
4701 | return -EINVAL; | |
4702 | ||
4703 | return hcd->driver->enable_device(hcd, udev); | |
4704 | } | |
4705 | ||
1da177e4 LT |
4706 | /* Reset device, (re)assign address, get device descriptor. |
4707 | * Device connection must be stable, no more debouncing needed. | |
4708 | * Returns device in USB_STATE_ADDRESS, except on error. | |
4709 | * | |
4710 | * If this is called for an already-existing device (as part of | |
5c79a1e3 DW |
4711 | * usb_reset_and_verify_device), the caller must own the device lock and |
4712 | * the port lock. For a newly detected device that is not accessible | |
4713 | * through any global pointers, it's not necessary to lock the device, | |
4714 | * but it is still necessary to lock the port. | |
1da177e4 LT |
4715 | */ |
4716 | static int | |
039b3307 | 4717 | hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1, |
1da177e4 LT |
4718 | int retry_counter) |
4719 | { | |
1da177e4 | 4720 | struct usb_device *hdev = hub->hdev; |
e7b77172 | 4721 | struct usb_hcd *hcd = bus_to_hcd(hdev->bus); |
25244227 | 4722 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
0d5ce778 | 4723 | int retries, operations, retval, i; |
1da177e4 LT |
4724 | unsigned delay = HUB_SHORT_RESET_TIME; |
4725 | enum usb_device_speed oldspeed = udev->speed; | |
e538dfda | 4726 | const char *speed; |
4326ed0b | 4727 | int devnum = udev->devnum; |
1bb90cf0 | 4728 | const char *driver_name; |
19502e69 | 4729 | bool do_new_scheme; |
1da177e4 LT |
4730 | |
4731 | /* root hub ports have a slightly longer reset period | |
4732 | * (from USB 2.0 spec, section 7.1.7.5) | |
4733 | */ | |
4734 | if (!hdev->parent) { | |
4735 | delay = HUB_ROOT_RESET_TIME; | |
4736 | if (port1 == hdev->bus->otg_port) | |
4737 | hdev->bus->b_hnp_enable = 0; | |
4738 | } | |
4739 | ||
4740 | /* Some low speed devices have problems with the quick delay, so */ | |
4741 | /* be a bit pessimistic with those devices. RHbug #23670 */ | |
4742 | if (oldspeed == USB_SPEED_LOW) | |
4743 | delay = HUB_LONG_RESET_TIME; | |
4744 | ||
07194ab7 LT |
4745 | /* Reset the device; full speed may morph to high speed */ |
4746 | /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */ | |
75d7cf72 | 4747 | retval = hub_port_reset(hub, port1, udev, delay, false); |
07194ab7 LT |
4748 | if (retval < 0) /* error or disconnect */ |
4749 | goto fail; | |
4750 | /* success, speed is known */ | |
4751 | ||
1da177e4 LT |
4752 | retval = -ENODEV; |
4753 | ||
8a1b2725 MN |
4754 | /* Don't allow speed changes at reset, except usb 3.0 to faster */ |
4755 | if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed && | |
4756 | !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) { | |
1da177e4 LT |
4757 | dev_dbg(&udev->dev, "device reset changed speed!\n"); |
4758 | goto fail; | |
4759 | } | |
4760 | oldspeed = udev->speed; | |
4326ed0b | 4761 | |
1da177e4 LT |
4762 | /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ... |
4763 | * it's fixed size except for full speed devices. | |
5bb6e0ae IPG |
4764 | * For Wireless USB devices, ep0 max packet is always 512 (tho |
4765 | * reported as 0xff in the device descriptor). WUSB1.0[4.8.1]. | |
1da177e4 LT |
4766 | */ |
4767 | switch (udev->speed) { | |
8a1b2725 | 4768 | case USB_SPEED_SUPER_PLUS: |
6b403b02 | 4769 | case USB_SPEED_SUPER: |
551cdbbe | 4770 | case USB_SPEED_WIRELESS: /* fixed at 512 */ |
551509d2 | 4771 | udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512); |
5bb6e0ae | 4772 | break; |
1da177e4 | 4773 | case USB_SPEED_HIGH: /* fixed at 64 */ |
551509d2 | 4774 | udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64); |
1da177e4 LT |
4775 | break; |
4776 | case USB_SPEED_FULL: /* 8, 16, 32, or 64 */ | |
4777 | /* to determine the ep0 maxpacket size, try to read | |
4778 | * the device descriptor to get bMaxPacketSize0 and | |
4779 | * then correct our initial guess. | |
4780 | */ | |
551509d2 | 4781 | udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64); |
1da177e4 LT |
4782 | break; |
4783 | case USB_SPEED_LOW: /* fixed at 8 */ | |
551509d2 | 4784 | udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8); |
1da177e4 LT |
4785 | break; |
4786 | default: | |
4787 | goto fail; | |
4788 | } | |
e538dfda MN |
4789 | |
4790 | if (udev->speed == USB_SPEED_WIRELESS) | |
4791 | speed = "variable speed Wireless"; | |
4792 | else | |
4793 | speed = usb_speed_string(udev->speed); | |
4794 | ||
1bb90cf0 PC |
4795 | /* |
4796 | * The controller driver may be NULL if the controller device | |
4797 | * is the middle device between platform device and roothub. | |
4798 | * This middle device may not need a device driver due to | |
4799 | * all hardware control can be at platform device driver, this | |
4800 | * platform device is usually a dual-role USB controller device. | |
4801 | */ | |
4802 | if (udev->bus->controller->driver) | |
4803 | driver_name = udev->bus->controller->driver->name; | |
4804 | else | |
4805 | driver_name = udev->bus->sysdev->driver->name; | |
4806 | ||
8a1b2725 | 4807 | if (udev->speed < USB_SPEED_SUPER) |
c6515272 | 4808 | dev_info(&udev->dev, |
e538dfda MN |
4809 | "%s %s USB device number %d using %s\n", |
4810 | (udev->config) ? "reset" : "new", speed, | |
1bb90cf0 | 4811 | devnum, driver_name); |
1da177e4 LT |
4812 | |
4813 | /* Set up TT records, if needed */ | |
4814 | if (hdev->tt) { | |
4815 | udev->tt = hdev->tt; | |
4816 | udev->ttport = hdev->ttport; | |
4817 | } else if (udev->speed != USB_SPEED_HIGH | |
4818 | && hdev->speed == USB_SPEED_HIGH) { | |
d199c96d AS |
4819 | if (!hub->tt.hub) { |
4820 | dev_err(&udev->dev, "parent hub has no TT\n"); | |
4821 | retval = -EINVAL; | |
4822 | goto fail; | |
4823 | } | |
1da177e4 LT |
4824 | udev->tt = &hub->tt; |
4825 | udev->ttport = port1; | |
4826 | } | |
469271f8 | 4827 | |
1da177e4 LT |
4828 | /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way? |
4829 | * Because device hardware and firmware is sometimes buggy in | |
4830 | * this area, and this is how Linux has done it for ages. | |
4831 | * Change it cautiously. | |
4832 | * | |
48fc7dbd | 4833 | * NOTE: If use_new_scheme() is true we will start by issuing |
1da177e4 LT |
4834 | * a 64-byte GET_DESCRIPTOR request. This is what Windows does, |
4835 | * so it may help with some non-standards-compliant devices. | |
4836 | * Otherwise we start with SET_ADDRESS and then try to read the | |
4837 | * first 8 bytes of the device descriptor to get the ep0 maxpacket | |
4838 | * value. | |
4839 | */ | |
19502e69 | 4840 | do_new_scheme = use_new_scheme(udev, retry_counter, port_dev); |
48fc7dbd | 4841 | |
19502e69 | 4842 | for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) { |
430d57f5 RC |
4843 | if (hub_port_stop_enumerate(hub, port1, retries)) { |
4844 | retval = -ENODEV; | |
4845 | break; | |
4846 | } | |
4847 | ||
19502e69 | 4848 | if (do_new_scheme) { |
1da177e4 LT |
4849 | struct usb_device_descriptor *buf; |
4850 | int r = 0; | |
4851 | ||
48fc7dbd | 4852 | retval = hub_enable_device(udev); |
938569eb ON |
4853 | if (retval < 0) { |
4854 | dev_err(&udev->dev, | |
4855 | "hub failed to enable device, error %d\n", | |
4856 | retval); | |
48fc7dbd | 4857 | goto fail; |
938569eb | 4858 | } |
48fc7dbd | 4859 | |
1da177e4 LT |
4860 | #define GET_DESCRIPTOR_BUFSIZE 64 |
4861 | buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO); | |
4862 | if (!buf) { | |
4863 | retval = -ENOMEM; | |
4864 | continue; | |
4865 | } | |
4866 | ||
b89ee19a AS |
4867 | /* Retry on all errors; some devices are flakey. |
4868 | * 255 is for WUSB devices, we actually need to use | |
4869 | * 512 (WUSB1.0[4.8.1]). | |
1da177e4 | 4870 | */ |
fb6f076d AS |
4871 | for (operations = 0; operations < GET_MAXPACKET0_TRIES; |
4872 | ++operations) { | |
1da177e4 LT |
4873 | buf->bMaxPacketSize0 = 0; |
4874 | r = usb_control_msg(udev, usb_rcvaddr0pipe(), | |
4875 | USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, | |
4876 | USB_DT_DEVICE << 8, 0, | |
4877 | buf, GET_DESCRIPTOR_BUFSIZE, | |
fd7c519d | 4878 | initial_descriptor_timeout); |
1da177e4 | 4879 | switch (buf->bMaxPacketSize0) { |
5bb6e0ae | 4880 | case 8: case 16: case 32: case 64: case 255: |
1da177e4 LT |
4881 | if (buf->bDescriptorType == |
4882 | USB_DT_DEVICE) { | |
4883 | r = 0; | |
4884 | break; | |
4885 | } | |
0d9b6d49 | 4886 | fallthrough; |
1da177e4 LT |
4887 | default: |
4888 | if (r == 0) | |
4889 | r = -EPROTO; | |
4890 | break; | |
4891 | } | |
264904cc ON |
4892 | /* |
4893 | * Some devices time out if they are powered on | |
4894 | * when already connected. They need a second | |
4895 | * reset. But only on the first attempt, | |
4896 | * lest we get into a time out/reset loop | |
4897 | */ | |
6e01827e MM |
4898 | if (r == 0 || (r == -ETIMEDOUT && |
4899 | retries == 0 && | |
4900 | udev->speed > USB_SPEED_FULL)) | |
1da177e4 LT |
4901 | break; |
4902 | } | |
4903 | udev->descriptor.bMaxPacketSize0 = | |
4904 | buf->bMaxPacketSize0; | |
4905 | kfree(buf); | |
4906 | ||
75d7cf72 | 4907 | retval = hub_port_reset(hub, port1, udev, delay, false); |
1da177e4 LT |
4908 | if (retval < 0) /* error or disconnect */ |
4909 | goto fail; | |
4910 | if (oldspeed != udev->speed) { | |
4911 | dev_dbg(&udev->dev, | |
4912 | "device reset changed speed!\n"); | |
4913 | retval = -ENODEV; | |
4914 | goto fail; | |
4915 | } | |
4916 | if (r) { | |
e9e88fb7 AS |
4917 | if (r != -ENODEV) |
4918 | dev_err(&udev->dev, "device descriptor read/64, error %d\n", | |
4919 | r); | |
1da177e4 LT |
4920 | retval = -EMSGSIZE; |
4921 | continue; | |
4922 | } | |
4923 | #undef GET_DESCRIPTOR_BUFSIZE | |
4924 | } | |
4925 | ||
469271f8 MB |
4926 | /* |
4927 | * If device is WUSB, we already assigned an | |
4928 | * unauthorized address in the Connect Ack sequence; | |
4929 | * authorization will assign the final address. | |
4930 | */ | |
c6515272 | 4931 | if (udev->wusb == 0) { |
0d5ce778 | 4932 | for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) { |
6c529cdc IPG |
4933 | retval = hub_set_address(udev, devnum); |
4934 | if (retval >= 0) | |
4935 | break; | |
4936 | msleep(200); | |
4937 | } | |
4938 | if (retval < 0) { | |
e9e88fb7 AS |
4939 | if (retval != -ENODEV) |
4940 | dev_err(&udev->dev, "device not accepting address %d, error %d\n", | |
4941 | devnum, retval); | |
6c529cdc IPG |
4942 | goto fail; |
4943 | } | |
8a1b2725 | 4944 | if (udev->speed >= USB_SPEED_SUPER) { |
c6515272 SS |
4945 | devnum = udev->devnum; |
4946 | dev_info(&udev->dev, | |
45455e4d | 4947 | "%s SuperSpeed%s%s USB device number %d using %s\n", |
c6515272 | 4948 | (udev->config) ? "reset" : "new", |
45455e4d | 4949 | (udev->speed == USB_SPEED_SUPER_PLUS) ? |
2d0e82c9 TN |
4950 | " Plus" : "", |
4951 | (udev->ssp_rate == USB_SSP_GEN_2x2) ? | |
4952 | " Gen 2x2" : | |
4953 | (udev->ssp_rate == USB_SSP_GEN_2x1) ? | |
4954 | " Gen 2x1" : | |
4955 | (udev->ssp_rate == USB_SSP_GEN_1x2) ? | |
4956 | " Gen 1x2" : "", | |
1bb90cf0 | 4957 | devnum, driver_name); |
c6515272 | 4958 | } |
6c529cdc IPG |
4959 | |
4960 | /* cope with hardware quirkiness: | |
4961 | * - let SET_ADDRESS settle, some device hardware wants it | |
4962 | * - read ep0 maxpacket even for high and low speed, | |
4963 | */ | |
4964 | msleep(10); | |
19502e69 | 4965 | if (do_new_scheme) |
1da177e4 | 4966 | break; |
469271f8 | 4967 | } |
1da177e4 LT |
4968 | |
4969 | retval = usb_get_device_descriptor(udev, 8); | |
4970 | if (retval < 8) { | |
e9e88fb7 AS |
4971 | if (retval != -ENODEV) |
4972 | dev_err(&udev->dev, | |
b9cef6c3 WF |
4973 | "device descriptor read/8, error %d\n", |
4974 | retval); | |
1da177e4 LT |
4975 | if (retval >= 0) |
4976 | retval = -EMSGSIZE; | |
4977 | } else { | |
886ee36e FB |
4978 | u32 delay; |
4979 | ||
1da177e4 | 4980 | retval = 0; |
886ee36e FB |
4981 | |
4982 | delay = udev->parent->hub_delay; | |
4983 | udev->hub_delay = min_t(u32, delay, | |
4984 | USB_TP_TRANSMISSION_DELAY_MAX); | |
4985 | retval = usb_set_isoch_delay(udev); | |
4986 | if (retval) { | |
4987 | dev_dbg(&udev->dev, | |
4988 | "Failed set isoch delay, error %d\n", | |
4989 | retval); | |
4990 | retval = 0; | |
4991 | } | |
1da177e4 LT |
4992 | break; |
4993 | } | |
4994 | } | |
4995 | if (retval) | |
4996 | goto fail; | |
4997 | ||
d8aec3db EF |
4998 | /* |
4999 | * Some superspeed devices have finished the link training process | |
5000 | * and attached to a superspeed hub port, but the device descriptor | |
5001 | * got from those devices show they aren't superspeed devices. Warm | |
5002 | * reset the port attached by the devices can fix them. | |
5003 | */ | |
8a1b2725 | 5004 | if ((udev->speed >= USB_SPEED_SUPER) && |
d8aec3db EF |
5005 | (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) { |
5006 | dev_err(&udev->dev, "got a wrong device descriptor, " | |
5007 | "warm reset device\n"); | |
5008 | hub_port_reset(hub, port1, udev, | |
5009 | HUB_BH_RESET_TIME, true); | |
5010 | retval = -EINVAL; | |
5011 | goto fail; | |
5012 | } | |
5013 | ||
6b403b02 | 5014 | if (udev->descriptor.bMaxPacketSize0 == 0xff || |
8a1b2725 | 5015 | udev->speed >= USB_SPEED_SUPER) |
6b403b02 SS |
5016 | i = 512; |
5017 | else | |
5018 | i = udev->descriptor.bMaxPacketSize0; | |
29cc8897 | 5019 | if (usb_endpoint_maxp(&udev->ep0.desc) != i) { |
56626a72 | 5020 | if (udev->speed == USB_SPEED_LOW || |
1da177e4 | 5021 | !(i == 8 || i == 16 || i == 32 || i == 64)) { |
56626a72 | 5022 | dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i); |
1da177e4 LT |
5023 | retval = -EMSGSIZE; |
5024 | goto fail; | |
5025 | } | |
56626a72 AS |
5026 | if (udev->speed == USB_SPEED_FULL) |
5027 | dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i); | |
5028 | else | |
5029 | dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i); | |
1da177e4 | 5030 | udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i); |
fc721f51 | 5031 | usb_ep0_reinit(udev); |
1da177e4 | 5032 | } |
469271f8 | 5033 | |
1da177e4 LT |
5034 | retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE); |
5035 | if (retval < (signed)sizeof(udev->descriptor)) { | |
e9e88fb7 AS |
5036 | if (retval != -ENODEV) |
5037 | dev_err(&udev->dev, "device descriptor read/all, error %d\n", | |
5038 | retval); | |
1da177e4 LT |
5039 | if (retval >= 0) |
5040 | retval = -ENOMSG; | |
5041 | goto fail; | |
5042 | } | |
5043 | ||
ad87e032 AS |
5044 | usb_detect_quirks(udev); |
5045 | ||
1ff4df56 AX |
5046 | if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) { |
5047 | retval = usb_get_bos_descriptor(udev); | |
51e0a012 | 5048 | if (!retval) { |
d9b2099c | 5049 | udev->lpm_capable = usb_device_supports_lpm(udev); |
cd36facf | 5050 | udev->lpm_disable_count = 1; |
51e0a012 | 5051 | usb_set_lpm_parameters(udev); |
e146caf3 | 5052 | usb_req_set_sel(udev); |
51e0a012 | 5053 | } |
1ff4df56 | 5054 | } |
3148bf04 | 5055 | |
1da177e4 | 5056 | retval = 0; |
48f24970 AD |
5057 | /* notify HCD that we have a device connected and addressed */ |
5058 | if (hcd->driver->update_device) | |
5059 | hcd->driver->update_device(hcd, udev); | |
890dae88 | 5060 | hub_set_initial_usb2_lpm_policy(udev); |
1da177e4 | 5061 | fail: |
4326ed0b | 5062 | if (retval) { |
1da177e4 | 5063 | hub_port_disable(hub, port1, 0); |
3b29b68b | 5064 | update_devnum(udev, devnum); /* for disconnect processing */ |
4326ed0b | 5065 | } |
1da177e4 LT |
5066 | return retval; |
5067 | } | |
5068 | ||
5069 | static void | |
039b3307 | 5070 | check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1) |
1da177e4 LT |
5071 | { |
5072 | struct usb_qualifier_descriptor *qual; | |
5073 | int status; | |
5074 | ||
2a159389 JH |
5075 | if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER) |
5076 | return; | |
5077 | ||
039b3307 | 5078 | qual = kmalloc(sizeof *qual, GFP_KERNEL); |
1da177e4 LT |
5079 | if (qual == NULL) |
5080 | return; | |
5081 | ||
039b3307 | 5082 | status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0, |
1da177e4 LT |
5083 | qual, sizeof *qual); |
5084 | if (status == sizeof *qual) { | |
5085 | dev_info(&udev->dev, "not running at top speed; " | |
5086 | "connect to a high speed hub\n"); | |
5087 | /* hub LEDs are probably harder to miss than syslog */ | |
5088 | if (hub->has_indicators) { | |
5089 | hub->indicator[port1-1] = INDICATOR_GREEN_BLINK; | |
22f6a0f0 SD |
5090 | queue_delayed_work(system_power_efficient_wq, |
5091 | &hub->leds, 0); | |
1da177e4 LT |
5092 | } |
5093 | } | |
1bc3c9e1 | 5094 | kfree(qual); |
1da177e4 LT |
5095 | } |
5096 | ||
5097 | static unsigned | |
039b3307 | 5098 | hub_power_remaining(struct usb_hub *hub) |
1da177e4 LT |
5099 | { |
5100 | struct usb_device *hdev = hub->hdev; | |
5101 | int remaining; | |
55c52718 | 5102 | int port1; |
1da177e4 | 5103 | |
55c52718 | 5104 | if (!hub->limited_power) |
1da177e4 LT |
5105 | return 0; |
5106 | ||
55c52718 AS |
5107 | remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent; |
5108 | for (port1 = 1; port1 <= hdev->maxchild; ++port1) { | |
d99f6b41 DW |
5109 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
5110 | struct usb_device *udev = port_dev->child; | |
5111 | unsigned unit_load; | |
5112 | int delta; | |
1da177e4 LT |
5113 | |
5114 | if (!udev) | |
5115 | continue; | |
430ee58e SAS |
5116 | if (hub_is_superspeed(udev)) |
5117 | unit_load = 150; | |
5118 | else | |
5119 | unit_load = 100; | |
1da177e4 | 5120 | |
430ee58e SAS |
5121 | /* |
5122 | * Unconfigured devices may not use more than one unit load, | |
5123 | * or 8mA for OTG ports | |
5124 | */ | |
1da177e4 | 5125 | if (udev->actconfig) |
8d8479db | 5126 | delta = usb_get_max_power(udev, udev->actconfig); |
55c52718 | 5127 | else if (port1 != udev->bus->otg_port || hdev->parent) |
430ee58e | 5128 | delta = unit_load; |
1da177e4 | 5129 | else |
55c52718 AS |
5130 | delta = 8; |
5131 | if (delta > hub->mA_per_port) | |
d99f6b41 DW |
5132 | dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n", |
5133 | delta, hub->mA_per_port); | |
1da177e4 LT |
5134 | remaining -= delta; |
5135 | } | |
5136 | if (remaining < 0) { | |
55c52718 | 5137 | dev_warn(hub->intfdev, "%dmA over power budget!\n", |
469271f8 | 5138 | -remaining); |
1da177e4 LT |
5139 | remaining = 0; |
5140 | } | |
5141 | return remaining; | |
5142 | } | |
5143 | ||
a4f55d8b DH |
5144 | |
5145 | static int descriptors_changed(struct usb_device *udev, | |
5146 | struct usb_device_descriptor *old_device_descriptor, | |
5147 | struct usb_host_bos *old_bos) | |
5148 | { | |
5149 | int changed = 0; | |
5150 | unsigned index; | |
5151 | unsigned serial_len = 0; | |
5152 | unsigned len; | |
5153 | unsigned old_length; | |
5154 | int length; | |
5155 | char *buf; | |
5156 | ||
5157 | if (memcmp(&udev->descriptor, old_device_descriptor, | |
5158 | sizeof(*old_device_descriptor)) != 0) | |
5159 | return 1; | |
5160 | ||
5161 | if ((old_bos && !udev->bos) || (!old_bos && udev->bos)) | |
5162 | return 1; | |
5163 | if (udev->bos) { | |
5164 | len = le16_to_cpu(udev->bos->desc->wTotalLength); | |
5165 | if (len != le16_to_cpu(old_bos->desc->wTotalLength)) | |
5166 | return 1; | |
5167 | if (memcmp(udev->bos->desc, old_bos->desc, len)) | |
5168 | return 1; | |
5169 | } | |
5170 | ||
5171 | /* Since the idVendor, idProduct, and bcdDevice values in the | |
5172 | * device descriptor haven't changed, we will assume the | |
5173 | * Manufacturer and Product strings haven't changed either. | |
5174 | * But the SerialNumber string could be different (e.g., a | |
5175 | * different flash card of the same brand). | |
5176 | */ | |
5177 | if (udev->serial) | |
5178 | serial_len = strlen(udev->serial) + 1; | |
5179 | ||
5180 | len = serial_len; | |
5181 | for (index = 0; index < udev->descriptor.bNumConfigurations; index++) { | |
5182 | old_length = le16_to_cpu(udev->config[index].desc.wTotalLength); | |
5183 | len = max(len, old_length); | |
5184 | } | |
5185 | ||
5186 | buf = kmalloc(len, GFP_NOIO); | |
5187 | if (!buf) | |
5188 | /* assume the worst */ | |
5189 | return 1; | |
5190 | ||
5191 | for (index = 0; index < udev->descriptor.bNumConfigurations; index++) { | |
5192 | old_length = le16_to_cpu(udev->config[index].desc.wTotalLength); | |
5193 | length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf, | |
5194 | old_length); | |
5195 | if (length != old_length) { | |
5196 | dev_dbg(&udev->dev, "config index %d, error %d\n", | |
5197 | index, length); | |
5198 | changed = 1; | |
5199 | break; | |
5200 | } | |
5201 | if (memcmp(buf, udev->rawdescriptors[index], old_length) | |
5202 | != 0) { | |
5203 | dev_dbg(&udev->dev, "config index %d changed (#%d)\n", | |
5204 | index, | |
5205 | ((struct usb_config_descriptor *) buf)-> | |
5206 | bConfigurationValue); | |
5207 | changed = 1; | |
5208 | break; | |
5209 | } | |
5210 | } | |
5211 | ||
5212 | if (!changed && serial_len) { | |
5213 | length = usb_string(udev, udev->descriptor.iSerialNumber, | |
5214 | buf, serial_len); | |
5215 | if (length + 1 != serial_len) { | |
5216 | dev_dbg(&udev->dev, "serial string error %d\n", | |
5217 | length); | |
5218 | changed = 1; | |
5219 | } else if (memcmp(buf, udev->serial, length) != 0) { | |
5220 | dev_dbg(&udev->dev, "serial string changed\n"); | |
5221 | changed = 1; | |
5222 | } | |
5223 | } | |
5224 | ||
5225 | kfree(buf); | |
5226 | return changed; | |
5227 | } | |
5228 | ||
af376a46 DW |
5229 | static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus, |
5230 | u16 portchange) | |
1da177e4 | 5231 | { |
94c43b98 AS |
5232 | int status = -ENODEV; |
5233 | int i; | |
430ee58e | 5234 | unsigned unit_load; |
1da177e4 | 5235 | struct usb_device *hdev = hub->hdev; |
90da096e | 5236 | struct usb_hcd *hcd = bus_to_hcd(hdev->bus); |
d99f6b41 | 5237 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
af376a46 | 5238 | struct usb_device *udev = port_dev->child; |
5ee0f803 | 5239 | static int unreliable_port = -1; |
6cca13de | 5240 | bool retry_locked; |
8808f00c | 5241 | |
24618b0c | 5242 | /* Disconnect any existing devices under this port */ |
b76baa81 | 5243 | if (udev) { |
b2108f1e | 5244 | if (hcd->usb_phy && !hdev->parent) |
3d46e73d | 5245 | usb_phy_notify_disconnect(hcd->usb_phy, udev->speed); |
d99f6b41 | 5246 | usb_disconnect(&port_dev->child); |
b76baa81 | 5247 | } |
24618b0c | 5248 | |
253e0572 AS |
5249 | /* We can forget about a "removed" device when there's a physical |
5250 | * disconnect or the connect status changes. | |
5251 | */ | |
5252 | if (!(portstatus & USB_PORT_STAT_CONNECTION) || | |
5253 | (portchange & USB_PORT_STAT_C_CONNECTION)) | |
5254 | clear_bit(port1, hub->removed_bits); | |
5255 | ||
5257d97a AS |
5256 | if (portchange & (USB_PORT_STAT_C_CONNECTION | |
5257 | USB_PORT_STAT_C_ENABLE)) { | |
ad493e5e | 5258 | status = hub_port_debounce_be_stable(hub, port1); |
5257d97a | 5259 | if (status < 0) { |
5ee0f803 ON |
5260 | if (status != -ENODEV && |
5261 | port1 != unreliable_port && | |
5262 | printk_ratelimit()) | |
dd5f5006 | 5263 | dev_err(&port_dev->dev, "connect-debounce failed\n"); |
5257d97a | 5264 | portstatus &= ~USB_PORT_STAT_CONNECTION; |
5ee0f803 | 5265 | unreliable_port = port1; |
5257d97a AS |
5266 | } else { |
5267 | portstatus = status; | |
5268 | } | |
5269 | } | |
5270 | ||
253e0572 AS |
5271 | /* Return now if debouncing failed or nothing is connected or |
5272 | * the device was "removed". | |
5273 | */ | |
5274 | if (!(portstatus & USB_PORT_STAT_CONNECTION) || | |
5275 | test_bit(port1, hub->removed_bits)) { | |
1da177e4 | 5276 | |
fbaecff0 DD |
5277 | /* |
5278 | * maybe switch power back on (e.g. root hub was reset) | |
5279 | * but only if the port isn't owned by someone else. | |
5280 | */ | |
9262c19d | 5281 | if (hub_is_port_power_switchable(hub) |
f061f43d | 5282 | && !usb_port_is_power_on(hub, portstatus) |
fbaecff0 | 5283 | && !port_dev->port_owner) |
1da177e4 | 5284 | set_port_feature(hdev, port1, USB_PORT_FEAT_POWER); |
5257d97a | 5285 | |
1da177e4 | 5286 | if (portstatus & USB_PORT_STAT_ENABLE) |
469271f8 | 5287 | goto done; |
1da177e4 LT |
5288 | return; |
5289 | } | |
430ee58e SAS |
5290 | if (hub_is_superspeed(hub->hdev)) |
5291 | unit_load = 150; | |
5292 | else | |
5293 | unit_load = 100; | |
1da177e4 | 5294 | |
e9e88fb7 | 5295 | status = 0; |
6ae6dc22 | 5296 | |
19502e69 | 5297 | for (i = 0; i < PORT_INIT_TRIES; i++) { |
430d57f5 RC |
5298 | if (hub_port_stop_enumerate(hub, port1, i)) { |
5299 | status = -ENODEV; | |
5300 | break; | |
5301 | } | |
5302 | ||
6cca13de MN |
5303 | usb_lock_port(port_dev); |
5304 | mutex_lock(hcd->address0_mutex); | |
5305 | retry_locked = true; | |
1da177e4 LT |
5306 | /* reallocate for each attempt, since references |
5307 | * to the previous one can escape in various ways | |
5308 | */ | |
5309 | udev = usb_alloc_dev(hdev, hdev->bus, port1); | |
5310 | if (!udev) { | |
d99f6b41 DW |
5311 | dev_err(&port_dev->dev, |
5312 | "couldn't allocate usb_device\n"); | |
6cca13de MN |
5313 | mutex_unlock(hcd->address0_mutex); |
5314 | usb_unlock_port(port_dev); | |
1da177e4 LT |
5315 | goto done; |
5316 | } | |
5317 | ||
5318 | usb_set_device_state(udev, USB_STATE_POWERED); | |
469271f8 | 5319 | udev->bus_mA = hub->mA_per_port; |
b6956ffa | 5320 | udev->level = hdev->level + 1; |
8af548dc | 5321 | udev->wusb = hub_is_wusb(hub); |
55c52718 | 5322 | |
8a1b2725 | 5323 | /* Devices connected to SuperSpeed hubs are USB 3.0 or later */ |
131dec34 | 5324 | if (hub_is_superspeed(hub->hdev)) |
e7b77172 SS |
5325 | udev->speed = USB_SPEED_SUPER; |
5326 | else | |
5327 | udev->speed = USB_SPEED_UNKNOWN; | |
5328 | ||
3b29b68b | 5329 | choose_devnum(udev); |
c8d4af8e AX |
5330 | if (udev->devnum <= 0) { |
5331 | status = -ENOTCONN; /* Don't retry */ | |
5332 | goto loop; | |
c6515272 SS |
5333 | } |
5334 | ||
e7b77172 | 5335 | /* reset (non-USB 3.0 devices) and get descriptor */ |
1da177e4 LT |
5336 | status = hub_port_init(hub, udev, port1, i); |
5337 | if (status < 0) | |
5338 | goto loop; | |
5339 | ||
6ae6dc22 | 5340 | mutex_unlock(hcd->address0_mutex); |
6cca13de MN |
5341 | usb_unlock_port(port_dev); |
5342 | retry_locked = false; | |
6ae6dc22 | 5343 | |
93362a87 | 5344 | if (udev->quirks & USB_QUIRK_DELAY_INIT) |
b2a542bb | 5345 | msleep(2000); |
93362a87 | 5346 | |
1da177e4 LT |
5347 | /* consecutive bus-powered hubs aren't reliable; they can |
5348 | * violate the voltage drop budget. if the new child has | |
5349 | * a "powered" LED, users should notice we didn't enable it | |
5350 | * (without reading syslog), even without per-port LEDs | |
5351 | * on the parent. | |
5352 | */ | |
5353 | if (udev->descriptor.bDeviceClass == USB_CLASS_HUB | |
430ee58e | 5354 | && udev->bus_mA <= unit_load) { |
1da177e4 LT |
5355 | u16 devstat; |
5356 | ||
d9e1e148 | 5357 | status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, |
1da177e4 | 5358 | &devstat); |
15b7336e | 5359 | if (status) { |
1da177e4 LT |
5360 | dev_dbg(&udev->dev, "get status %d ?\n", status); |
5361 | goto loop_disable; | |
5362 | } | |
1da177e4 LT |
5363 | if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) { |
5364 | dev_err(&udev->dev, | |
5365 | "can't connect bus-powered hub " | |
5366 | "to this port\n"); | |
5367 | if (hub->has_indicators) { | |
5368 | hub->indicator[port1-1] = | |
5369 | INDICATOR_AMBER_BLINK; | |
22f6a0f0 SD |
5370 | queue_delayed_work( |
5371 | system_power_efficient_wq, | |
5372 | &hub->leds, 0); | |
1da177e4 LT |
5373 | } |
5374 | status = -ENOTCONN; /* Don't retry */ | |
5375 | goto loop_disable; | |
5376 | } | |
5377 | } | |
469271f8 | 5378 | |
1da177e4 LT |
5379 | /* check for devices running slower than they could */ |
5380 | if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200 | |
5381 | && udev->speed == USB_SPEED_FULL | |
5382 | && highspeed_hubs != 0) | |
039b3307 | 5383 | check_highspeed(hub, udev, port1); |
1da177e4 | 5384 | |
fa286188 | 5385 | /* Store the parent's children[] pointer. At this point |
1da177e4 LT |
5386 | * udev becomes globally accessible, although presumably |
5387 | * no one will look at it until hdev is unlocked. | |
5388 | */ | |
1da177e4 LT |
5389 | status = 0; |
5390 | ||
d8521afe DW |
5391 | mutex_lock(&usb_port_peer_mutex); |
5392 | ||
1da177e4 LT |
5393 | /* We mustn't add new devices if the parent hub has |
5394 | * been disconnected; we would race with the | |
5395 | * recursively_mark_NOTATTACHED() routine. | |
5396 | */ | |
5397 | spin_lock_irq(&device_state_lock); | |
5398 | if (hdev->state == USB_STATE_NOTATTACHED) | |
5399 | status = -ENOTCONN; | |
5400 | else | |
d99f6b41 | 5401 | port_dev->child = udev; |
1da177e4 | 5402 | spin_unlock_irq(&device_state_lock); |
d8521afe | 5403 | mutex_unlock(&usb_port_peer_mutex); |
1da177e4 LT |
5404 | |
5405 | /* Run it through the hoops (find a driver, etc) */ | |
5406 | if (!status) { | |
5407 | status = usb_new_device(udev); | |
5408 | if (status) { | |
d8521afe | 5409 | mutex_lock(&usb_port_peer_mutex); |
1da177e4 | 5410 | spin_lock_irq(&device_state_lock); |
d99f6b41 | 5411 | port_dev->child = NULL; |
1da177e4 | 5412 | spin_unlock_irq(&device_state_lock); |
d8521afe | 5413 | mutex_unlock(&usb_port_peer_mutex); |
01ed67dc TZ |
5414 | } else { |
5415 | if (hcd->usb_phy && !hdev->parent) | |
5416 | usb_phy_notify_connect(hcd->usb_phy, | |
5417 | udev->speed); | |
1da177e4 LT |
5418 | } |
5419 | } | |
5420 | ||
1da177e4 LT |
5421 | if (status) |
5422 | goto loop_disable; | |
5423 | ||
5424 | status = hub_power_remaining(hub); | |
5425 | if (status) | |
d99f6b41 | 5426 | dev_dbg(hub->intfdev, "%dmA power budget left\n", status); |
1da177e4 LT |
5427 | |
5428 | return; | |
5429 | ||
5430 | loop_disable: | |
5431 | hub_port_disable(hub, port1, 1); | |
5432 | loop: | |
fc721f51 | 5433 | usb_ep0_reinit(udev); |
3b29b68b | 5434 | release_devnum(udev); |
f7410ced | 5435 | hub_free_dev(udev); |
6cca13de MN |
5436 | if (retry_locked) { |
5437 | mutex_unlock(hcd->address0_mutex); | |
5438 | usb_unlock_port(port_dev); | |
5439 | } | |
1da177e4 | 5440 | usb_put_dev(udev); |
ffcdc18d | 5441 | if ((status == -ENOTCONN) || (status == -ENOTSUPP)) |
1da177e4 | 5442 | break; |
973593a9 ML |
5443 | |
5444 | /* When halfway through our retry count, power-cycle the port */ | |
19502e69 | 5445 | if (i == (PORT_INIT_TRIES - 1) / 2) { |
973593a9 ML |
5446 | dev_info(&port_dev->dev, "attempt power cycle\n"); |
5447 | usb_hub_set_port_power(hdev, hub, port1, false); | |
5448 | msleep(2 * hub_power_on_good_delay(hub)); | |
5449 | usb_hub_set_port_power(hdev, hub, port1, true); | |
5450 | msleep(hub_power_on_good_delay(hub)); | |
5451 | } | |
1da177e4 | 5452 | } |
3a31155c AS |
5453 | if (hub->hdev->parent || |
5454 | !hcd->driver->port_handed_over || | |
e9e88fb7 AS |
5455 | !(hcd->driver->port_handed_over)(hcd, port1)) { |
5456 | if (status != -ENOTCONN && status != -ENODEV) | |
d99f6b41 DW |
5457 | dev_err(&port_dev->dev, |
5458 | "unable to enumerate USB device\n"); | |
e9e88fb7 | 5459 | } |
469271f8 | 5460 | |
1da177e4 LT |
5461 | done: |
5462 | hub_port_disable(hub, port1, 1); | |
94c43b98 AS |
5463 | if (hcd->driver->relinquish_port && !hub->hdev->parent) { |
5464 | if (status != -ENOTCONN && status != -ENODEV) | |
5465 | hcd->driver->relinquish_port(hcd, port1); | |
5466 | } | |
1da177e4 LT |
5467 | } |
5468 | ||
af376a46 DW |
5469 | /* Handle physical or logical connection change events. |
5470 | * This routine is called when: | |
5471 | * a port connection-change occurs; | |
5472 | * a port enable-change occurs (often caused by EMI); | |
5473 | * usb_reset_and_verify_device() encounters changed descriptors (as from | |
5474 | * a firmware download) | |
5475 | * caller already locked the hub | |
5476 | */ | |
5477 | static void hub_port_connect_change(struct usb_hub *hub, int port1, | |
5478 | u16 portstatus, u16 portchange) | |
5c79a1e3 | 5479 | __must_hold(&port_dev->status_lock) |
714b07be | 5480 | { |
af376a46 DW |
5481 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
5482 | struct usb_device *udev = port_dev->child; | |
a4f55d8b | 5483 | struct usb_device_descriptor descriptor; |
af376a46 | 5484 | int status = -ENODEV; |
a4f55d8b | 5485 | int retval; |
714b07be | 5486 | |
af376a46 DW |
5487 | dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus, |
5488 | portchange, portspeed(hub, portstatus)); | |
5489 | ||
5490 | if (hub->has_indicators) { | |
5491 | set_port_led(hub, port1, HUB_LED_AUTO); | |
5492 | hub->indicator[port1-1] = INDICATOR_AUTO; | |
4ee823b8 SS |
5493 | } |
5494 | ||
af376a46 DW |
5495 | #ifdef CONFIG_USB_OTG |
5496 | /* during HNP, don't repeat the debounce */ | |
5497 | if (hub->hdev->bus->is_b_host) | |
5498 | portchange &= ~(USB_PORT_STAT_C_CONNECTION | | |
5499 | USB_PORT_STAT_C_ENABLE); | |
5500 | #endif | |
5501 | ||
5502 | /* Try to resuscitate an existing device */ | |
5503 | if ((portstatus & USB_PORT_STAT_CONNECTION) && udev && | |
5504 | udev->state != USB_STATE_NOTATTACHED) { | |
5505 | if (portstatus & USB_PORT_STAT_ENABLE) { | |
a4f55d8b DH |
5506 | /* |
5507 | * USB-3 connections are initialized automatically by | |
5508 | * the hostcontroller hardware. Therefore check for | |
5509 | * changed device descriptors before resuscitating the | |
5510 | * device. | |
5511 | */ | |
5512 | descriptor = udev->descriptor; | |
5513 | retval = usb_get_device_descriptor(udev, | |
5514 | sizeof(udev->descriptor)); | |
5515 | if (retval < 0) { | |
5516 | dev_dbg(&udev->dev, | |
5517 | "can't read device descriptor %d\n", | |
5518 | retval); | |
5519 | } else { | |
5520 | if (descriptors_changed(udev, &descriptor, | |
5521 | udev->bos)) { | |
5522 | dev_dbg(&udev->dev, | |
5523 | "device descriptor has changed\n"); | |
5524 | /* for disconnect() calls */ | |
5525 | udev->descriptor = descriptor; | |
5526 | } else { | |
5527 | status = 0; /* Nothing to do */ | |
5528 | } | |
5529 | } | |
ceb6c9c8 | 5530 | #ifdef CONFIG_PM |
af376a46 DW |
5531 | } else if (udev->state == USB_STATE_SUSPENDED && |
5532 | udev->persist_enabled) { | |
5533 | /* For a suspended device, treat this as a | |
5534 | * remote wakeup event. | |
5535 | */ | |
5c79a1e3 | 5536 | usb_unlock_port(port_dev); |
af376a46 | 5537 | status = usb_remote_wakeup(udev); |
5c79a1e3 | 5538 | usb_lock_port(port_dev); |
af376a46 DW |
5539 | #endif |
5540 | } else { | |
5541 | /* Don't resuscitate */; | |
5542 | } | |
af376a46 DW |
5543 | } |
5544 | clear_bit(port1, hub->change_bits); | |
5545 | ||
5c79a1e3 | 5546 | /* successfully revalidated the connection */ |
af376a46 DW |
5547 | if (status == 0) |
5548 | return; | |
5549 | ||
5c79a1e3 | 5550 | usb_unlock_port(port_dev); |
af376a46 | 5551 | hub_port_connect(hub, port1, portstatus, portchange); |
5c79a1e3 | 5552 | usb_lock_port(port_dev); |
1da177e4 LT |
5553 | } |
5554 | ||
201af55d JF |
5555 | /* Handle notifying userspace about hub over-current events */ |
5556 | static void port_over_current_notify(struct usb_port *port_dev) | |
5557 | { | |
6c5ba739 | 5558 | char *envp[3] = { NULL, NULL, NULL }; |
201af55d JF |
5559 | struct device *hub_dev; |
5560 | char *port_dev_path; | |
5561 | ||
5562 | sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count"); | |
5563 | ||
5564 | hub_dev = port_dev->dev.parent; | |
5565 | ||
5566 | if (!hub_dev) | |
5567 | return; | |
5568 | ||
5569 | port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL); | |
5570 | if (!port_dev_path) | |
5571 | return; | |
5572 | ||
5573 | envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path); | |
5574 | if (!envp[0]) | |
6c5ba739 | 5575 | goto exit; |
201af55d JF |
5576 | |
5577 | envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u", | |
5578 | port_dev->over_current_count); | |
5579 | if (!envp[1]) | |
5580 | goto exit; | |
5581 | ||
5582 | kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp); | |
5583 | ||
201af55d | 5584 | exit: |
6c5ba739 | 5585 | kfree(envp[1]); |
201af55d | 5586 | kfree(envp[0]); |
bf7f547e | 5587 | kfree(port_dev_path); |
201af55d JF |
5588 | } |
5589 | ||
af376a46 | 5590 | static void port_event(struct usb_hub *hub, int port1) |
5c79a1e3 | 5591 | __must_hold(&port_dev->status_lock) |
af376a46 | 5592 | { |
7671bd1e | 5593 | int connect_change; |
af376a46 DW |
5594 | struct usb_port *port_dev = hub->ports[port1 - 1]; |
5595 | struct usb_device *udev = port_dev->child; | |
5596 | struct usb_device *hdev = hub->hdev; | |
5597 | u16 portstatus, portchange; | |
f59f93cd | 5598 | int i = 0; |
af376a46 DW |
5599 | |
5600 | connect_change = test_bit(port1, hub->change_bits); | |
5601 | clear_bit(port1, hub->event_bits); | |
5602 | clear_bit(port1, hub->wakeup_bits); | |
5603 | ||
f061f43d | 5604 | if (usb_hub_port_status(hub, port1, &portstatus, &portchange) < 0) |
af376a46 DW |
5605 | return; |
5606 | ||
5607 | if (portchange & USB_PORT_STAT_C_CONNECTION) { | |
5608 | usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION); | |
5609 | connect_change = 1; | |
5610 | } | |
5611 | ||
5612 | if (portchange & USB_PORT_STAT_C_ENABLE) { | |
5613 | if (!connect_change) | |
5614 | dev_dbg(&port_dev->dev, "enable change, status %08x\n", | |
5615 | portstatus); | |
5616 | usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE); | |
5617 | ||
5618 | /* | |
5619 | * EM interference sometimes causes badly shielded USB devices | |
5620 | * to be shutdown by the hub, this hack enables them again. | |
5621 | * Works at least with mouse driver. | |
5622 | */ | |
5623 | if (!(portstatus & USB_PORT_STAT_ENABLE) | |
5624 | && !connect_change && udev) { | |
5625 | dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n"); | |
5626 | connect_change = 1; | |
5627 | } | |
5628 | } | |
5629 | ||
5630 | if (portchange & USB_PORT_STAT_C_OVERCURRENT) { | |
5631 | u16 status = 0, unused; | |
1cbd53c8 | 5632 | port_dev->over_current_count++; |
201af55d | 5633 | port_over_current_notify(port_dev); |
af376a46 | 5634 | |
1cbd53c8 RL |
5635 | dev_dbg(&port_dev->dev, "over-current change #%u\n", |
5636 | port_dev->over_current_count); | |
af376a46 DW |
5637 | usb_clear_port_feature(hdev, port1, |
5638 | USB_PORT_FEAT_C_OVER_CURRENT); | |
5639 | msleep(100); /* Cool down */ | |
5640 | hub_power_on(hub, true); | |
f061f43d | 5641 | usb_hub_port_status(hub, port1, &status, &unused); |
af376a46 DW |
5642 | if (status & USB_PORT_STAT_OVERCURRENT) |
5643 | dev_err(&port_dev->dev, "over-current condition\n"); | |
5644 | } | |
5645 | ||
5646 | if (portchange & USB_PORT_STAT_C_RESET) { | |
5647 | dev_dbg(&port_dev->dev, "reset change\n"); | |
5648 | usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET); | |
5649 | } | |
5650 | if ((portchange & USB_PORT_STAT_C_BH_RESET) | |
5651 | && hub_is_superspeed(hdev)) { | |
5652 | dev_dbg(&port_dev->dev, "warm reset change\n"); | |
5653 | usb_clear_port_feature(hdev, port1, | |
5654 | USB_PORT_FEAT_C_BH_PORT_RESET); | |
5655 | } | |
5656 | if (portchange & USB_PORT_STAT_C_LINK_STATE) { | |
5657 | dev_dbg(&port_dev->dev, "link state change\n"); | |
5658 | usb_clear_port_feature(hdev, port1, | |
5659 | USB_PORT_FEAT_C_PORT_LINK_STATE); | |
5660 | } | |
5661 | if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) { | |
5662 | dev_warn(&port_dev->dev, "config error\n"); | |
5663 | usb_clear_port_feature(hdev, port1, | |
5664 | USB_PORT_FEAT_C_PORT_CONFIG_ERROR); | |
5665 | } | |
5666 | ||
097a155f DW |
5667 | /* skip port actions that require the port to be powered on */ |
5668 | if (!pm_runtime_active(&port_dev->dev)) | |
5669 | return; | |
714b07be | 5670 | |
430d57f5 RC |
5671 | /* skip port actions if ignore_event and early_stop are true */ |
5672 | if (port_dev->ignore_event && port_dev->early_stop) | |
5673 | return; | |
5674 | ||
af376a46 DW |
5675 | if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange)) |
5676 | connect_change = 1; | |
5677 | ||
5678 | /* | |
f59f93cd MN |
5679 | * Avoid trying to recover a USB3 SS.Inactive port with a warm reset if |
5680 | * the device was disconnected. A 12ms disconnect detect timer in | |
5681 | * SS.Inactive state transitions the port to RxDetect automatically. | |
5682 | * SS.Inactive link error state is common during device disconnect. | |
af376a46 | 5683 | */ |
f59f93cd MN |
5684 | while (hub_port_warm_reset_required(hub, port1, portstatus)) { |
5685 | if ((i++ < DETECT_DISCONNECT_TRIES) && udev) { | |
5686 | u16 unused; | |
5687 | ||
5688 | msleep(20); | |
f061f43d | 5689 | usb_hub_port_status(hub, port1, &portstatus, &unused); |
f59f93cd MN |
5690 | dev_dbg(&port_dev->dev, "Wait for inactive link disconnect detect\n"); |
5691 | continue; | |
5692 | } else if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION) | |
af376a46 | 5693 | || udev->state == USB_STATE_NOTATTACHED) { |
f59f93cd | 5694 | dev_dbg(&port_dev->dev, "do warm reset, port only\n"); |
af376a46 DW |
5695 | if (hub_port_reset(hub, port1, NULL, |
5696 | HUB_BH_RESET_TIME, true) < 0) | |
5697 | hub_port_disable(hub, port1, 1); | |
7671bd1e | 5698 | } else { |
f59f93cd | 5699 | dev_dbg(&port_dev->dev, "do warm reset, full device\n"); |
7671bd1e ZJC |
5700 | usb_unlock_port(port_dev); |
5701 | usb_lock_device(udev); | |
5702 | usb_reset_device(udev); | |
5703 | usb_unlock_device(udev); | |
5704 | usb_lock_port(port_dev); | |
5705 | connect_change = 0; | |
5706 | } | |
f59f93cd | 5707 | break; |
714b07be | 5708 | } |
af376a46 DW |
5709 | |
5710 | if (connect_change) | |
5711 | hub_port_connect_change(hub, port1, portstatus, portchange); | |
714b07be SS |
5712 | } |
5713 | ||
32a69589 | 5714 | static void hub_event(struct work_struct *work) |
1da177e4 | 5715 | { |
1da177e4 LT |
5716 | struct usb_device *hdev; |
5717 | struct usb_interface *intf; | |
5718 | struct usb_hub *hub; | |
5719 | struct device *hub_dev; | |
5720 | u16 hubstatus; | |
5721 | u16 hubchange; | |
1da177e4 | 5722 | int i, ret; |
1da177e4 | 5723 | |
32a69589 | 5724 | hub = container_of(work, struct usb_hub, events); |
eb6e2924 PM |
5725 | hdev = hub->hdev; |
5726 | hub_dev = hub->intfdev; | |
5727 | intf = to_usb_interface(hub_dev); | |
32a69589 | 5728 | |
95d23dc2 AK |
5729 | kcov_remote_start_usb((u64)hdev->bus->busnum); |
5730 | ||
eb6e2924 PM |
5731 | dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n", |
5732 | hdev->state, hdev->maxchild, | |
5733 | /* NOTE: expects max 15 ports... */ | |
5734 | (u16) hub->change_bits[0], | |
5735 | (u16) hub->event_bits[0]); | |
5736 | ||
5737 | /* Lock the device, then check to see if we were | |
5738 | * disconnected while waiting for the lock to succeed. */ | |
5739 | usb_lock_device(hdev); | |
5740 | if (unlikely(hub->disconnected)) | |
32a69589 | 5741 | goto out_hdev_lock; |
eb6e2924 PM |
5742 | |
5743 | /* If the hub has died, clean up after it */ | |
5744 | if (hdev->state == USB_STATE_NOTATTACHED) { | |
5745 | hub->error = -ENODEV; | |
5746 | hub_quiesce(hub, HUB_DISCONNECT); | |
32a69589 | 5747 | goto out_hdev_lock; |
eb6e2924 PM |
5748 | } |
5749 | ||
5750 | /* Autoresume */ | |
5751 | ret = usb_autopm_get_interface(intf); | |
5752 | if (ret) { | |
5753 | dev_dbg(hub_dev, "Can't autoresume: %d\n", ret); | |
32a69589 | 5754 | goto out_hdev_lock; |
eb6e2924 | 5755 | } |
1da177e4 | 5756 | |
eb6e2924 PM |
5757 | /* If this is an inactive hub, do nothing */ |
5758 | if (hub->quiescing) | |
5759 | goto out_autopm; | |
1da177e4 | 5760 | |
eb6e2924 PM |
5761 | if (hub->error) { |
5762 | dev_dbg(hub_dev, "resetting for error %d\n", hub->error); | |
5763 | ||
5764 | ret = usb_reset_device(hdev); | |
40f122f3 | 5765 | if (ret) { |
eb6e2924 PM |
5766 | dev_dbg(hub_dev, "error resetting hub: %d\n", ret); |
5767 | goto out_autopm; | |
40f122f3 | 5768 | } |
a8e7c565 | 5769 | |
eb6e2924 PM |
5770 | hub->nerrors = 0; |
5771 | hub->error = 0; | |
5772 | } | |
1da177e4 | 5773 | |
eb6e2924 PM |
5774 | /* deal with port status changes */ |
5775 | for (i = 1; i <= hdev->maxchild; i++) { | |
5776 | struct usb_port *port_dev = hub->ports[i - 1]; | |
1da177e4 | 5777 | |
eb6e2924 PM |
5778 | if (test_bit(i, hub->event_bits) |
5779 | || test_bit(i, hub->change_bits) | |
5780 | || test_bit(i, hub->wakeup_bits)) { | |
5781 | /* | |
5782 | * The get_noresume and barrier ensure that if | |
5783 | * the port was in the process of resuming, we | |
5784 | * flush that work and keep the port active for | |
5785 | * the duration of the port_event(). However, | |
5786 | * if the port is runtime pm suspended | |
5787 | * (powered-off), we leave it in that state, run | |
5788 | * an abbreviated port_event(), and move on. | |
5789 | */ | |
5790 | pm_runtime_get_noresume(&port_dev->dev); | |
5791 | pm_runtime_barrier(&port_dev->dev); | |
5792 | usb_lock_port(port_dev); | |
5793 | port_event(hub, i); | |
5794 | usb_unlock_port(port_dev); | |
5795 | pm_runtime_put_sync(&port_dev->dev); | |
1da177e4 | 5796 | } |
eb6e2924 | 5797 | } |
1da177e4 | 5798 | |
eb6e2924 PM |
5799 | /* deal with hub status changes */ |
5800 | if (test_and_clear_bit(0, hub->event_bits) == 0) | |
5801 | ; /* do nothing */ | |
5802 | else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0) | |
5803 | dev_err(hub_dev, "get_hub_status failed\n"); | |
5804 | else { | |
5805 | if (hubchange & HUB_CHANGE_LOCAL_POWER) { | |
5806 | dev_dbg(hub_dev, "power change\n"); | |
5807 | clear_hub_feature(hdev, C_HUB_LOCAL_POWER); | |
5808 | if (hubstatus & HUB_STATUS_LOCAL_POWER) | |
5809 | /* FIXME: Is this always true? */ | |
5810 | hub->limited_power = 1; | |
5811 | else | |
5812 | hub->limited_power = 0; | |
af376a46 | 5813 | } |
eb6e2924 PM |
5814 | if (hubchange & HUB_CHANGE_OVERCURRENT) { |
5815 | u16 status = 0; | |
5816 | u16 unused; | |
1da177e4 | 5817 | |
eb6e2924 PM |
5818 | dev_dbg(hub_dev, "over-current change\n"); |
5819 | clear_hub_feature(hdev, C_HUB_OVER_CURRENT); | |
5820 | msleep(500); /* Cool down */ | |
5821 | hub_power_on(hub, true); | |
5822 | hub_hub_status(hub, &status, &unused); | |
5823 | if (status & HUB_STATUS_OVERCURRENT) | |
5824 | dev_err(hub_dev, "over-current condition\n"); | |
1da177e4 | 5825 | } |
eb6e2924 | 5826 | } |
1da177e4 | 5827 | |
eb6e2924 PM |
5828 | out_autopm: |
5829 | /* Balance the usb_autopm_get_interface() above */ | |
5830 | usb_autopm_put_interface_no_suspend(intf); | |
32a69589 | 5831 | out_hdev_lock: |
eb6e2924 | 5832 | usb_unlock_device(hdev); |
1da177e4 | 5833 | |
32a69589 PM |
5834 | /* Balance the stuff in kick_hub_wq() and allow autosuspend */ |
5835 | usb_autopm_put_interface(intf); | |
5836 | kref_put(&hub->kref, hub_release); | |
95d23dc2 AK |
5837 | |
5838 | kcov_remote_stop(); | |
1da177e4 LT |
5839 | } |
5840 | ||
1e927d96 | 5841 | static const struct usb_device_id hub_id_table[] = { |
76e1ef1d ER |
5842 | { .match_flags = USB_DEVICE_ID_MATCH_VENDOR |
5843 | | USB_DEVICE_ID_MATCH_PRODUCT | |
5844 | | USB_DEVICE_ID_MATCH_INT_CLASS, | |
1208f9e1 | 5845 | .idVendor = USB_VENDOR_SMSC, |
76e1ef1d | 5846 | .idProduct = USB_PRODUCT_USB5534B, |
1208f9e1 HG |
5847 | .bInterfaceClass = USB_CLASS_HUB, |
5848 | .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND}, | |
a7d8d1c7 AL |
5849 | { .match_flags = USB_DEVICE_ID_MATCH_VENDOR |
5850 | | USB_DEVICE_ID_MATCH_PRODUCT, | |
5851 | .idVendor = USB_VENDOR_CYPRESS, | |
5852 | .idProduct = USB_PRODUCT_CY7C65632, | |
5853 | .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND}, | |
e6f30dea | 5854 | { .match_flags = USB_DEVICE_ID_MATCH_VENDOR |
469271f8 | 5855 | | USB_DEVICE_ID_MATCH_INT_CLASS, |
e6f30dea ML |
5856 | .idVendor = USB_VENDOR_GENESYS_LOGIC, |
5857 | .bInterfaceClass = USB_CLASS_HUB, | |
5858 | .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND}, | |
7171b0e2 FS |
5859 | { .match_flags = USB_DEVICE_ID_MATCH_VENDOR |
5860 | | USB_DEVICE_ID_MATCH_PRODUCT, | |
5861 | .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS, | |
5862 | .idProduct = USB_PRODUCT_TUSB8041_USB2, | |
5863 | .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND}, | |
5864 | { .match_flags = USB_DEVICE_ID_MATCH_VENDOR | |
5865 | | USB_DEVICE_ID_MATCH_PRODUCT, | |
5866 | .idVendor = USB_VENDOR_TEXAS_INSTRUMENTS, | |
5867 | .idProduct = USB_PRODUCT_TUSB8041_USB3, | |
5868 | .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND}, | |
1da177e4 LT |
5869 | { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS, |
5870 | .bDeviceClass = USB_CLASS_HUB}, | |
5871 | { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS, | |
5872 | .bInterfaceClass = USB_CLASS_HUB}, | |
5873 | { } /* Terminating entry */ | |
5874 | }; | |
5875 | ||
039b3307 | 5876 | MODULE_DEVICE_TABLE(usb, hub_id_table); |
1da177e4 LT |
5877 | |
5878 | static struct usb_driver hub_driver = { | |
1da177e4 LT |
5879 | .name = "hub", |
5880 | .probe = hub_probe, | |
5881 | .disconnect = hub_disconnect, | |
5882 | .suspend = hub_suspend, | |
5883 | .resume = hub_resume, | |
f07600cf | 5884 | .reset_resume = hub_reset_resume, |
7de18d8b AS |
5885 | .pre_reset = hub_pre_reset, |
5886 | .post_reset = hub_post_reset, | |
c532b29a | 5887 | .unlocked_ioctl = hub_ioctl, |
1da177e4 | 5888 | .id_table = hub_id_table, |
40f122f3 | 5889 | .supports_autosuspend = 1, |
1da177e4 LT |
5890 | }; |
5891 | ||
5892 | int usb_hub_init(void) | |
5893 | { | |
1da177e4 LT |
5894 | if (usb_register(&hub_driver) < 0) { |
5895 | printk(KERN_ERR "%s: can't register hub driver\n", | |
5896 | usbcore_name); | |
5897 | return -1; | |
5898 | } | |
5899 | ||
32a69589 PM |
5900 | /* |
5901 | * The workqueue needs to be freezable to avoid interfering with | |
5902 | * USB-PERSIST port handover. Otherwise it might see that a full-speed | |
5903 | * device was gone before the EHCI controller had handed its port | |
5904 | * over to the companion full-speed controller. | |
32a69589 | 5905 | */ |
638139eb | 5906 | hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0); |
32a69589 | 5907 | if (hub_wq) |
1da177e4 | 5908 | return 0; |
1da177e4 LT |
5909 | |
5910 | /* Fall through if kernel_thread failed */ | |
5911 | usb_deregister(&hub_driver); | |
32a69589 | 5912 | pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name); |
1da177e4 LT |
5913 | |
5914 | return -1; | |
5915 | } | |
5916 | ||
5917 | void usb_hub_cleanup(void) | |
5918 | { | |
32a69589 | 5919 | destroy_workqueue(hub_wq); |
1da177e4 LT |
5920 | |
5921 | /* | |
5922 | * Hub resources are freed for us by usb_deregister. It calls | |
5923 | * usb_driver_purge on every device which in turn calls that | |
5924 | * devices disconnect function if it is using this driver. | |
5925 | * The hub_disconnect function takes care of releasing the | |
5926 | * individual hub resources. -greg | |
5927 | */ | |
5928 | usb_deregister(&hub_driver); | |
5929 | } /* usb_hub_cleanup() */ | |
5930 | ||
1da177e4 | 5931 | /** |
742120c6 | 5932 | * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device |
1da177e4 LT |
5933 | * @udev: device to reset (not in SUSPENDED or NOTATTACHED state) |
5934 | * | |
79efa097 AS |
5935 | * WARNING - don't use this routine to reset a composite device |
5936 | * (one with multiple interfaces owned by separate drivers)! | |
742120c6 | 5937 | * Use usb_reset_device() instead. |
1da177e4 LT |
5938 | * |
5939 | * Do a port reset, reassign the device's address, and establish its | |
5940 | * former operating configuration. If the reset fails, or the device's | |
5941 | * descriptors change from their values before the reset, or the original | |
5942 | * configuration and altsettings cannot be restored, a flag will be set | |
37ebb549 | 5943 | * telling hub_wq to pretend the device has been disconnected and then |
1da177e4 LT |
5944 | * re-connected. All drivers will be unbound, and the device will be |
5945 | * re-enumerated and probed all over again. | |
5946 | * | |
626f090c | 5947 | * Return: 0 if the reset succeeded, -ENODEV if the device has been |
1da177e4 LT |
5948 | * flagged for logical disconnection, or some other negative error code |
5949 | * if the reset wasn't even attempted. | |
5950 | * | |
626f090c | 5951 | * Note: |
5c79a1e3 DW |
5952 | * The caller must own the device lock and the port lock, the latter is |
5953 | * taken by usb_reset_device(). For example, it's safe to use | |
5954 | * usb_reset_device() from a driver probe() routine after downloading | |
5955 | * new firmware. For calls that might not occur during probe(), drivers | |
5956 | * should lock the device using usb_lock_device_for_reset(). | |
6bc6cff5 AS |
5957 | * |
5958 | * Locking exception: This routine may also be called from within an | |
5959 | * autoresume handler. Such usage won't conflict with other tasks | |
5960 | * holding the device lock because these tasks should always call | |
5c79a1e3 DW |
5961 | * usb_autopm_resume_device(), thereby preventing any unwanted |
5962 | * autoresume. The autoresume handler is expected to have already | |
5963 | * acquired the port lock before calling this routine. | |
1da177e4 | 5964 | */ |
742120c6 | 5965 | static int usb_reset_and_verify_device(struct usb_device *udev) |
1da177e4 LT |
5966 | { |
5967 | struct usb_device *parent_hdev = udev->parent; | |
5968 | struct usb_hub *parent_hub; | |
3f0479e0 | 5969 | struct usb_hcd *hcd = bus_to_hcd(udev->bus); |
1da177e4 | 5970 | struct usb_device_descriptor descriptor = udev->descriptor; |
e3376d6c | 5971 | struct usb_host_bos *bos; |
7a7b562d | 5972 | int i, j, ret = 0; |
12c3da34 | 5973 | int port1 = udev->portnum; |
1da177e4 LT |
5974 | |
5975 | if (udev->state == USB_STATE_NOTATTACHED || | |
5976 | udev->state == USB_STATE_SUSPENDED) { | |
5977 | dev_dbg(&udev->dev, "device reset not allowed in state %d\n", | |
5978 | udev->state); | |
5979 | return -EINVAL; | |
5980 | } | |
5981 | ||
5c79a1e3 | 5982 | if (!parent_hdev) |
1da177e4 | 5983 | return -EISDIR; |
5c79a1e3 | 5984 | |
ad493e5e | 5985 | parent_hub = usb_hub_to_struct_hub(parent_hdev); |
1da177e4 | 5986 | |
dcc01c08 SS |
5987 | /* Disable USB2 hardware LPM. |
5988 | * It will be re-enabled by the enumeration process. | |
5989 | */ | |
d7a6c0ce | 5990 | usb_disable_usb2_hardware_lpm(udev); |
dcc01c08 | 5991 | |
464ad8c4 | 5992 | bos = udev->bos; |
e5bdfd50 | 5993 | udev->bos = NULL; |
464ad8c4 | 5994 | |
6ae6dc22 MN |
5995 | mutex_lock(hcd->address0_mutex); |
5996 | ||
19502e69 | 5997 | for (i = 0; i < PORT_INIT_TRIES; ++i) { |
430d57f5 RC |
5998 | if (hub_port_stop_enumerate(parent_hub, port1, i)) { |
5999 | ret = -ENODEV; | |
6000 | break; | |
6001 | } | |
1da177e4 LT |
6002 | |
6003 | /* ep0 maxpacket size may change; let the HCD know about it. | |
6004 | * Other endpoints will be handled by re-enumeration. */ | |
fc721f51 | 6005 | usb_ep0_reinit(udev); |
1da177e4 | 6006 | ret = hub_port_init(parent_hub, udev, port1, i); |
dd4dd19e | 6007 | if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV) |
1da177e4 LT |
6008 | break; |
6009 | } | |
6ae6dc22 | 6010 | mutex_unlock(hcd->address0_mutex); |
d5cbad4b | 6011 | |
1da177e4 LT |
6012 | if (ret < 0) |
6013 | goto re_enumerate; | |
469271f8 | 6014 | |
1da177e4 | 6015 | /* Device might have changed firmware (DFU or similar) */ |
e3376d6c | 6016 | if (descriptors_changed(udev, &descriptor, bos)) { |
1da177e4 LT |
6017 | dev_info(&udev->dev, "device firmware changed\n"); |
6018 | udev->descriptor = descriptor; /* for disconnect() calls */ | |
6019 | goto re_enumerate; | |
469271f8 | 6020 | } |
4fe0387a AS |
6021 | |
6022 | /* Restore the device's previous configuration */ | |
1da177e4 LT |
6023 | if (!udev->actconfig) |
6024 | goto done; | |
3f0479e0 | 6025 | |
d673bfcb | 6026 | mutex_lock(hcd->bandwidth_mutex); |
3f0479e0 SS |
6027 | ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL); |
6028 | if (ret < 0) { | |
6029 | dev_warn(&udev->dev, | |
6030 | "Busted HC? Not enough HCD resources for " | |
6031 | "old configuration.\n"); | |
d673bfcb | 6032 | mutex_unlock(hcd->bandwidth_mutex); |
3f0479e0 SS |
6033 | goto re_enumerate; |
6034 | } | |
1da177e4 LT |
6035 | ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), |
6036 | USB_REQ_SET_CONFIGURATION, 0, | |
6037 | udev->actconfig->desc.bConfigurationValue, 0, | |
6038 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
6039 | if (ret < 0) { | |
6040 | dev_err(&udev->dev, | |
6041 | "can't restore configuration #%d (error=%d)\n", | |
6042 | udev->actconfig->desc.bConfigurationValue, ret); | |
d673bfcb | 6043 | mutex_unlock(hcd->bandwidth_mutex); |
1da177e4 | 6044 | goto re_enumerate; |
469271f8 | 6045 | } |
d673bfcb | 6046 | mutex_unlock(hcd->bandwidth_mutex); |
1da177e4 LT |
6047 | usb_set_device_state(udev, USB_STATE_CONFIGURED); |
6048 | ||
4fe0387a AS |
6049 | /* Put interfaces back into the same altsettings as before. |
6050 | * Don't bother to send the Set-Interface request for interfaces | |
6051 | * that were already in altsetting 0; besides being unnecessary, | |
6052 | * many devices can't handle it. Instead just reset the host-side | |
6053 | * endpoint state. | |
6054 | */ | |
1da177e4 | 6055 | for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) { |
3f0479e0 SS |
6056 | struct usb_host_config *config = udev->actconfig; |
6057 | struct usb_interface *intf = config->interface[i]; | |
1da177e4 LT |
6058 | struct usb_interface_descriptor *desc; |
6059 | ||
1da177e4 | 6060 | desc = &intf->cur_altsetting->desc; |
4fe0387a AS |
6061 | if (desc->bAlternateSetting == 0) { |
6062 | usb_disable_interface(udev, intf, true); | |
6063 | usb_enable_interface(udev, intf, true); | |
6064 | ret = 0; | |
6065 | } else { | |
04a723ea SS |
6066 | /* Let the bandwidth allocation function know that this |
6067 | * device has been reset, and it will have to use | |
6068 | * alternate setting 0 as the current alternate setting. | |
3f0479e0 | 6069 | */ |
04a723ea | 6070 | intf->resetting_device = 1; |
4fe0387a AS |
6071 | ret = usb_set_interface(udev, desc->bInterfaceNumber, |
6072 | desc->bAlternateSetting); | |
04a723ea | 6073 | intf->resetting_device = 0; |
4fe0387a | 6074 | } |
1da177e4 LT |
6075 | if (ret < 0) { |
6076 | dev_err(&udev->dev, "failed to restore interface %d " | |
6077 | "altsetting %d (error=%d)\n", | |
6078 | desc->bInterfaceNumber, | |
6079 | desc->bAlternateSetting, | |
6080 | ret); | |
6081 | goto re_enumerate; | |
6082 | } | |
7a7b562d HG |
6083 | /* Resetting also frees any allocated streams */ |
6084 | for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) | |
6085 | intf->cur_altsetting->endpoint[j].streams = 0; | |
1da177e4 LT |
6086 | } |
6087 | ||
6088 | done: | |
f74631e3 | 6089 | /* Now that the alt settings are re-installed, enable LTM and LPM. */ |
7529b257 | 6090 | usb_enable_usb2_hardware_lpm(udev); |
8306095f | 6091 | usb_unlocked_enable_lpm(udev); |
f74631e3 | 6092 | usb_enable_ltm(udev); |
e5bdfd50 GKH |
6093 | usb_release_bos_descriptor(udev); |
6094 | udev->bos = bos; | |
1da177e4 | 6095 | return 0; |
469271f8 | 6096 | |
1da177e4 | 6097 | re_enumerate: |
e3376d6c XR |
6098 | usb_release_bos_descriptor(udev); |
6099 | udev->bos = bos; | |
464ad8c4 | 6100 | hub_port_logical_disconnect(parent_hub, port1); |
1da177e4 LT |
6101 | return -ENODEV; |
6102 | } | |
79efa097 AS |
6103 | |
6104 | /** | |
742120c6 | 6105 | * usb_reset_device - warn interface drivers and perform a USB port reset |
e76b3bf7 | 6106 | * @udev: device to reset (not in NOTATTACHED state) |
79efa097 AS |
6107 | * |
6108 | * Warns all drivers bound to registered interfaces (using their pre_reset | |
6109 | * method), performs the port reset, and then lets the drivers know that | |
6110 | * the reset is over (using their post_reset method). | |
6111 | * | |
626f090c | 6112 | * Return: The same as for usb_reset_and_verify_device(). |
9c6d7788 | 6113 | * However, if a reset is already in progress (for instance, if a |
766a96dc | 6114 | * driver doesn't have pre_reset() or post_reset() callbacks, and while |
9c6d7788 AS |
6115 | * being unbound or re-bound during the ongoing reset its disconnect() |
6116 | * or probe() routine tries to perform a second, nested reset), the | |
6117 | * routine returns -EINPROGRESS. | |
79efa097 | 6118 | * |
626f090c | 6119 | * Note: |
79efa097 AS |
6120 | * The caller must own the device lock. For example, it's safe to use |
6121 | * this from a driver probe() routine after downloading new firmware. | |
6122 | * For calls that might not occur during probe(), drivers should lock | |
6123 | * the device using usb_lock_device_for_reset(). | |
78d9a487 AS |
6124 | * |
6125 | * If an interface is currently being probed or disconnected, we assume | |
6126 | * its driver knows how to handle resets. For all other interfaces, | |
6127 | * if the driver doesn't have pre_reset and post_reset methods then | |
6128 | * we attempt to unbind it and rebind afterward. | |
79efa097 | 6129 | */ |
742120c6 | 6130 | int usb_reset_device(struct usb_device *udev) |
79efa097 AS |
6131 | { |
6132 | int ret; | |
852c4b43 | 6133 | int i; |
4d769def | 6134 | unsigned int noio_flag; |
5c79a1e3 | 6135 | struct usb_port *port_dev; |
79efa097 | 6136 | struct usb_host_config *config = udev->actconfig; |
5c79a1e3 | 6137 | struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent); |
79efa097 | 6138 | |
e76b3bf7 | 6139 | if (udev->state == USB_STATE_NOTATTACHED) { |
79efa097 AS |
6140 | dev_dbg(&udev->dev, "device reset not allowed in state %d\n", |
6141 | udev->state); | |
6142 | return -EINVAL; | |
6143 | } | |
6144 | ||
5c79a1e3 DW |
6145 | if (!udev->parent) { |
6146 | /* this requires hcd-specific logic; see ohci_restart() */ | |
6147 | dev_dbg(&udev->dev, "%s for root hub!\n", __func__); | |
6148 | return -EISDIR; | |
6149 | } | |
6150 | ||
9c6d7788 AS |
6151 | if (udev->reset_in_progress) |
6152 | return -EINPROGRESS; | |
6153 | udev->reset_in_progress = 1; | |
6154 | ||
5c79a1e3 DW |
6155 | port_dev = hub->ports[udev->portnum - 1]; |
6156 | ||
4d769def ML |
6157 | /* |
6158 | * Don't allocate memory with GFP_KERNEL in current | |
6159 | * context to avoid possible deadlock if usb mass | |
6160 | * storage interface or usbnet interface(iSCSI case) | |
6161 | * is included in current configuration. The easist | |
6162 | * approach is to do it for every device reset, | |
6163 | * because the device 'memalloc_noio' flag may have | |
6164 | * not been set before reseting the usb device. | |
6165 | */ | |
6166 | noio_flag = memalloc_noio_save(); | |
6167 | ||
645daaab | 6168 | /* Prevent autosuspend during the reset */ |
94fcda1f | 6169 | usb_autoresume_device(udev); |
645daaab | 6170 | |
79efa097 | 6171 | if (config) { |
79efa097 | 6172 | for (i = 0; i < config->desc.bNumInterfaces; ++i) { |
852c4b43 AS |
6173 | struct usb_interface *cintf = config->interface[i]; |
6174 | struct usb_driver *drv; | |
78d9a487 | 6175 | int unbind = 0; |
852c4b43 AS |
6176 | |
6177 | if (cintf->dev.driver) { | |
79efa097 | 6178 | drv = to_usb_driver(cintf->dev.driver); |
78d9a487 AS |
6179 | if (drv->pre_reset && drv->post_reset) |
6180 | unbind = (drv->pre_reset)(cintf); | |
6181 | else if (cintf->condition == | |
6182 | USB_INTERFACE_BOUND) | |
6183 | unbind = 1; | |
6184 | if (unbind) | |
6185 | usb_forced_unbind_intf(cintf); | |
79efa097 AS |
6186 | } |
6187 | } | |
6188 | } | |
6189 | ||
5c79a1e3 | 6190 | usb_lock_port(port_dev); |
742120c6 | 6191 | ret = usb_reset_and_verify_device(udev); |
5c79a1e3 | 6192 | usb_unlock_port(port_dev); |
79efa097 AS |
6193 | |
6194 | if (config) { | |
79efa097 | 6195 | for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) { |
852c4b43 AS |
6196 | struct usb_interface *cintf = config->interface[i]; |
6197 | struct usb_driver *drv; | |
78d9a487 | 6198 | int rebind = cintf->needs_binding; |
852c4b43 | 6199 | |
78d9a487 | 6200 | if (!rebind && cintf->dev.driver) { |
79efa097 AS |
6201 | drv = to_usb_driver(cintf->dev.driver); |
6202 | if (drv->post_reset) | |
78d9a487 AS |
6203 | rebind = (drv->post_reset)(cintf); |
6204 | else if (cintf->condition == | |
6205 | USB_INTERFACE_BOUND) | |
6206 | rebind = 1; | |
6aec044c AS |
6207 | if (rebind) |
6208 | cintf->needs_binding = 1; | |
79efa097 | 6209 | } |
79efa097 | 6210 | } |
381419fa AS |
6211 | |
6212 | /* If the reset failed, hub_wq will unbind drivers later */ | |
6213 | if (ret == 0) | |
6214 | usb_unbind_and_rebind_marked_interfaces(udev); | |
79efa097 AS |
6215 | } |
6216 | ||
94fcda1f | 6217 | usb_autosuspend_device(udev); |
4d769def | 6218 | memalloc_noio_restore(noio_flag); |
9c6d7788 | 6219 | udev->reset_in_progress = 0; |
79efa097 AS |
6220 | return ret; |
6221 | } | |
742120c6 | 6222 | EXPORT_SYMBOL_GPL(usb_reset_device); |
dc023dce IPG |
6223 | |
6224 | ||
6225 | /** | |
6226 | * usb_queue_reset_device - Reset a USB device from an atomic context | |
6227 | * @iface: USB interface belonging to the device to reset | |
6228 | * | |
6229 | * This function can be used to reset a USB device from an atomic | |
6230 | * context, where usb_reset_device() won't work (as it blocks). | |
6231 | * | |
6232 | * Doing a reset via this method is functionally equivalent to calling | |
6233 | * usb_reset_device(), except for the fact that it is delayed to a | |
6234 | * workqueue. This means that any drivers bound to other interfaces | |
6235 | * might be unbound, as well as users from usbfs in user space. | |
6236 | * | |
6237 | * Corner cases: | |
6238 | * | |
6239 | * - Scheduling two resets at the same time from two different drivers | |
6240 | * attached to two different interfaces of the same device is | |
6241 | * possible; depending on how the driver attached to each interface | |
6242 | * handles ->pre_reset(), the second reset might happen or not. | |
6243 | * | |
524134d4 AS |
6244 | * - If the reset is delayed so long that the interface is unbound from |
6245 | * its driver, the reset will be skipped. | |
dc023dce | 6246 | * |
524134d4 AS |
6247 | * - This function can be called during .probe(). It can also be called |
6248 | * during .disconnect(), but doing so is pointless because the reset | |
6249 | * will not occur. If you really want to reset the device during | |
6250 | * .disconnect(), call usb_reset_device() directly -- but watch out | |
6251 | * for nested unbinding issues! | |
dc023dce IPG |
6252 | */ |
6253 | void usb_queue_reset_device(struct usb_interface *iface) | |
6254 | { | |
524134d4 AS |
6255 | if (schedule_work(&iface->reset_ws)) |
6256 | usb_get_intf(iface); | |
dc023dce IPG |
6257 | } |
6258 | EXPORT_SYMBOL_GPL(usb_queue_reset_device); | |
ff823c79 LT |
6259 | |
6260 | /** | |
6261 | * usb_hub_find_child - Get the pointer of child device | |
6262 | * attached to the port which is specified by @port1. | |
6263 | * @hdev: USB device belonging to the usb hub | |
6264 | * @port1: port num to indicate which port the child device | |
6265 | * is attached to. | |
6266 | * | |
6267 | * USB drivers call this function to get hub's child device | |
6268 | * pointer. | |
6269 | * | |
626f090c | 6270 | * Return: %NULL if input param is invalid and |
ff823c79 LT |
6271 | * child's usb_device pointer if non-NULL. |
6272 | */ | |
6273 | struct usb_device *usb_hub_find_child(struct usb_device *hdev, | |
6274 | int port1) | |
6275 | { | |
ad493e5e | 6276 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
ff823c79 LT |
6277 | |
6278 | if (port1 < 1 || port1 > hdev->maxchild) | |
6279 | return NULL; | |
6280 | return hub->ports[port1 - 1]->child; | |
6281 | } | |
6282 | EXPORT_SYMBOL_GPL(usb_hub_find_child); | |
d5575424 | 6283 | |
d2123fd9 LT |
6284 | void usb_hub_adjust_deviceremovable(struct usb_device *hdev, |
6285 | struct usb_hub_descriptor *desc) | |
6286 | { | |
d99f6b41 | 6287 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
d2123fd9 LT |
6288 | enum usb_port_connect_type connect_type; |
6289 | int i; | |
6290 | ||
d99f6b41 DW |
6291 | if (!hub) |
6292 | return; | |
6293 | ||
d2123fd9 LT |
6294 | if (!hub_is_superspeed(hdev)) { |
6295 | for (i = 1; i <= hdev->maxchild; i++) { | |
d99f6b41 | 6296 | struct usb_port *port_dev = hub->ports[i - 1]; |
d2123fd9 | 6297 | |
d99f6b41 | 6298 | connect_type = port_dev->connect_type; |
d2123fd9 LT |
6299 | if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) { |
6300 | u8 mask = 1 << (i%8); | |
6301 | ||
6302 | if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) { | |
d99f6b41 | 6303 | dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n"); |
d2123fd9 LT |
6304 | desc->u.hs.DeviceRemovable[i/8] |= mask; |
6305 | } | |
6306 | } | |
6307 | } | |
6308 | } else { | |
6309 | u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable); | |
6310 | ||
6311 | for (i = 1; i <= hdev->maxchild; i++) { | |
d99f6b41 | 6312 | struct usb_port *port_dev = hub->ports[i - 1]; |
d2123fd9 | 6313 | |
d99f6b41 | 6314 | connect_type = port_dev->connect_type; |
d2123fd9 LT |
6315 | if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) { |
6316 | u16 mask = 1 << i; | |
6317 | ||
6318 | if (!(port_removable & mask)) { | |
d99f6b41 | 6319 | dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n"); |
d2123fd9 LT |
6320 | port_removable |= mask; |
6321 | } | |
6322 | } | |
6323 | } | |
6324 | ||
6325 | desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable); | |
6326 | } | |
6327 | } | |
6328 | ||
d5575424 LT |
6329 | #ifdef CONFIG_ACPI |
6330 | /** | |
6331 | * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle | |
6332 | * @hdev: USB device belonging to the usb hub | |
6333 | * @port1: port num of the port | |
6334 | * | |
626f090c YB |
6335 | * Return: Port's acpi handle if successful, %NULL if params are |
6336 | * invalid. | |
d5575424 LT |
6337 | */ |
6338 | acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev, | |
6339 | int port1) | |
6340 | { | |
ad493e5e | 6341 | struct usb_hub *hub = usb_hub_to_struct_hub(hdev); |
d5575424 | 6342 | |
41341261 MN |
6343 | if (!hub) |
6344 | return NULL; | |
6345 | ||
3a83f992 | 6346 | return ACPI_HANDLE(&hub->ports[port1 - 1]->dev); |
d5575424 LT |
6347 | } |
6348 | #endif |