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