1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * xHCI host controller driver
4 *
5 * Copyright (C) 2008 Intel Corp.
6 *
7 * Author: Sarah Sharp
8 * Some code borrowed from the Linux EHCI driver.
9 */
10
11
12 #include <linux/slab.h>
13 #include <asm/unaligned.h>
14 #include <linux/bitfield.h>
15
16 #include "xhci.h"
17 #include "xhci-trace.h"
18
19 #define PORT_WAKE_BITS (PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E)
20 #define PORT_RWC_BITS (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
21 PORT_RC | PORT_PLC | PORT_PE)
22
23 /* Default sublink speed attribute of each lane */
24 static u32 ssp_cap_default_ssa[] = {
25 0x00050034, /* USB 3.0 SS Gen1x1 id:4 symmetric rx 5Gbps */
26 0x000500b4, /* USB 3.0 SS Gen1x1 id:4 symmetric tx 5Gbps */
27 0x000a4035, /* USB 3.1 SSP Gen2x1 id:5 symmetric rx 10Gbps */
28 0x000a40b5, /* USB 3.1 SSP Gen2x1 id:5 symmetric tx 10Gbps */
29 0x00054036, /* USB 3.2 SSP Gen1x2 id:6 symmetric rx 5Gbps */
30 0x000540b6, /* USB 3.2 SSP Gen1x2 id:6 symmetric tx 5Gbps */
31 0x000a4037, /* USB 3.2 SSP Gen2x2 id:7 symmetric rx 10Gbps */
32 0x000a40b7, /* USB 3.2 SSP Gen2x2 id:7 symmetric tx 10Gbps */
33 };
34
xhci_create_usb3x_bos_desc(struct xhci_hcd * xhci,char * buf,u16 wLength)35 static int xhci_create_usb3x_bos_desc(struct xhci_hcd *xhci, char *buf,
36 u16 wLength)
37 {
38 struct usb_bos_descriptor *bos;
39 struct usb_ss_cap_descriptor *ss_cap;
40 struct usb_ssp_cap_descriptor *ssp_cap;
41 struct xhci_port_cap *port_cap = NULL;
42 u16 bcdUSB;
43 u32 reg;
44 u32 min_rate = 0;
45 u8 min_ssid;
46 u8 ssac;
47 u8 ssic;
48 int offset;
49 int i;
50
51 /* BOS descriptor */
52 bos = (struct usb_bos_descriptor *)buf;
53 bos->bLength = USB_DT_BOS_SIZE;
54 bos->bDescriptorType = USB_DT_BOS;
55 bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE +
56 USB_DT_USB_SS_CAP_SIZE);
57 bos->bNumDeviceCaps = 1;
58
59 /* Create the descriptor for port with the highest revision */
60 for (i = 0; i < xhci->num_port_caps; i++) {
61 u8 major = xhci->port_caps[i].maj_rev;
62 u8 minor = xhci->port_caps[i].min_rev;
63 u16 rev = (major << 8) | minor;
64
65 if (i == 0 || bcdUSB < rev) {
66 bcdUSB = rev;
67 port_cap = &xhci->port_caps[i];
68 }
69 }
70
71 if (bcdUSB >= 0x0310) {
72 if (port_cap->psi_count) {
73 u8 num_sym_ssa = 0;
74
75 for (i = 0; i < port_cap->psi_count; i++) {
76 if ((port_cap->psi[i] & PLT_MASK) == PLT_SYM)
77 num_sym_ssa++;
78 }
79
80 ssac = port_cap->psi_count + num_sym_ssa - 1;
81 ssic = port_cap->psi_uid_count - 1;
82 } else {
83 if (bcdUSB >= 0x0320)
84 ssac = 7;
85 else
86 ssac = 3;
87
88 ssic = (ssac + 1) / 2 - 1;
89 }
90
91 bos->bNumDeviceCaps++;
92 bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE +
93 USB_DT_USB_SS_CAP_SIZE +
94 USB_DT_USB_SSP_CAP_SIZE(ssac));
95 }
96
97 if (wLength < USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE)
98 return wLength;
99
100 /* SuperSpeed USB Device Capability */
101 ss_cap = (struct usb_ss_cap_descriptor *)&buf[USB_DT_BOS_SIZE];
102 ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
103 ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
104 ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
105 ss_cap->bmAttributes = 0; /* set later */
106 ss_cap->wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION);
107 ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
108 ss_cap->bU1devExitLat = 0; /* set later */
109 ss_cap->bU2DevExitLat = 0; /* set later */
110
111 reg = readl(&xhci->cap_regs->hcc_params);
112 if (HCC_LTC(reg))
113 ss_cap->bmAttributes |= USB_LTM_SUPPORT;
114
115 if ((xhci->quirks & XHCI_LPM_SUPPORT)) {
116 reg = readl(&xhci->cap_regs->hcs_params3);
117 ss_cap->bU1devExitLat = HCS_U1_LATENCY(reg);
118 ss_cap->bU2DevExitLat = cpu_to_le16(HCS_U2_LATENCY(reg));
119 }
120
121 if (wLength < le16_to_cpu(bos->wTotalLength))
122 return wLength;
123
124 if (bcdUSB < 0x0310)
125 return le16_to_cpu(bos->wTotalLength);
126
127 ssp_cap = (struct usb_ssp_cap_descriptor *)&buf[USB_DT_BOS_SIZE +
128 USB_DT_USB_SS_CAP_SIZE];
129 ssp_cap->bLength = USB_DT_USB_SSP_CAP_SIZE(ssac);
130 ssp_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
131 ssp_cap->bDevCapabilityType = USB_SSP_CAP_TYPE;
132 ssp_cap->bReserved = 0;
133 ssp_cap->wReserved = 0;
134 ssp_cap->bmAttributes =
135 cpu_to_le32(FIELD_PREP(USB_SSP_SUBLINK_SPEED_ATTRIBS, ssac) |
136 FIELD_PREP(USB_SSP_SUBLINK_SPEED_IDS, ssic));
137
138 if (!port_cap->psi_count) {
139 for (i = 0; i < ssac + 1; i++)
140 ssp_cap->bmSublinkSpeedAttr[i] =
141 cpu_to_le32(ssp_cap_default_ssa[i]);
142
143 min_ssid = 4;
144 goto out;
145 }
146
147 offset = 0;
148 for (i = 0; i < port_cap->psi_count; i++) {
149 u32 psi;
150 u32 attr;
151 u8 ssid;
152 u8 lp;
153 u8 lse;
154 u8 psie;
155 u16 lane_mantissa;
156 u16 psim;
157 u16 plt;
158
159 psi = port_cap->psi[i];
160 ssid = XHCI_EXT_PORT_PSIV(psi);
161 lp = XHCI_EXT_PORT_LP(psi);
162 psie = XHCI_EXT_PORT_PSIE(psi);
163 psim = XHCI_EXT_PORT_PSIM(psi);
164 plt = psi & PLT_MASK;
165
166 lse = psie;
167 lane_mantissa = psim;
168
169 /* Shift to Gbps and set SSP Link Protocol if 10Gpbs */
170 for (; psie < USB_SSP_SUBLINK_SPEED_LSE_GBPS; psie++)
171 psim /= 1000;
172
173 if (!min_rate || psim < min_rate) {
174 min_ssid = ssid;
175 min_rate = psim;
176 }
177
178 /* Some host controllers don't set the link protocol for SSP */
179 if (psim >= 10)
180 lp = USB_SSP_SUBLINK_SPEED_LP_SSP;
181
182 /*
183 * PSIM and PSIE represent the total speed of PSI. The BOS
184 * descriptor SSP sublink speed attribute lane mantissa
185 * describes the lane speed. E.g. PSIM and PSIE for gen2x2
186 * is 20Gbps, but the BOS descriptor lane speed mantissa is
187 * 10Gbps. Check and modify the mantissa value to match the
188 * lane speed.
189 */
190 if (bcdUSB == 0x0320 && plt == PLT_SYM) {
191 /*
192 * The PSI dword for gen1x2 and gen2x1 share the same
193 * values. But the lane speed for gen1x2 is 5Gbps while
194 * gen2x1 is 10Gbps. If the previous PSI dword SSID is
195 * 5 and the PSIE and PSIM match with SSID 6, let's
196 * assume that the controller follows the default speed
197 * id with SSID 6 for gen1x2.
198 */
199 if (ssid == 6 && psie == 3 && psim == 10 && i) {
200 u32 prev = port_cap->psi[i - 1];
201
202 if ((prev & PLT_MASK) == PLT_SYM &&
203 XHCI_EXT_PORT_PSIV(prev) == 5 &&
204 XHCI_EXT_PORT_PSIE(prev) == 3 &&
205 XHCI_EXT_PORT_PSIM(prev) == 10) {
206 lse = USB_SSP_SUBLINK_SPEED_LSE_GBPS;
207 lane_mantissa = 5;
208 }
209 }
210
211 if (psie == 3 && psim > 10) {
212 lse = USB_SSP_SUBLINK_SPEED_LSE_GBPS;
213 lane_mantissa = 10;
214 }
215 }
216
217 attr = (FIELD_PREP(USB_SSP_SUBLINK_SPEED_SSID, ssid) |
218 FIELD_PREP(USB_SSP_SUBLINK_SPEED_LP, lp) |
219 FIELD_PREP(USB_SSP_SUBLINK_SPEED_LSE, lse) |
220 FIELD_PREP(USB_SSP_SUBLINK_SPEED_LSM, lane_mantissa));
221
222 switch (plt) {
223 case PLT_SYM:
224 attr |= FIELD_PREP(USB_SSP_SUBLINK_SPEED_ST,
225 USB_SSP_SUBLINK_SPEED_ST_SYM_RX);
226 ssp_cap->bmSublinkSpeedAttr[offset++] = cpu_to_le32(attr);
227
228 attr &= ~USB_SSP_SUBLINK_SPEED_ST;
229 attr |= FIELD_PREP(USB_SSP_SUBLINK_SPEED_ST,
230 USB_SSP_SUBLINK_SPEED_ST_SYM_TX);
231 ssp_cap->bmSublinkSpeedAttr[offset++] = cpu_to_le32(attr);
232 break;
233 case PLT_ASYM_RX:
234 attr |= FIELD_PREP(USB_SSP_SUBLINK_SPEED_ST,
235 USB_SSP_SUBLINK_SPEED_ST_ASYM_RX);
236 ssp_cap->bmSublinkSpeedAttr[offset++] = cpu_to_le32(attr);
237 break;
238 case PLT_ASYM_TX:
239 attr |= FIELD_PREP(USB_SSP_SUBLINK_SPEED_ST,
240 USB_SSP_SUBLINK_SPEED_ST_ASYM_TX);
241 ssp_cap->bmSublinkSpeedAttr[offset++] = cpu_to_le32(attr);
242 break;
243 }
244 }
245 out:
246 ssp_cap->wFunctionalitySupport =
247 cpu_to_le16(FIELD_PREP(USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID,
248 min_ssid) |
249 FIELD_PREP(USB_SSP_MIN_RX_LANE_COUNT, 1) |
250 FIELD_PREP(USB_SSP_MIN_TX_LANE_COUNT, 1));
251
252 return le16_to_cpu(bos->wTotalLength);
253 }
254
xhci_common_hub_descriptor(struct xhci_hcd * xhci,struct usb_hub_descriptor * desc,int ports)255 static void xhci_common_hub_descriptor(struct xhci_hcd *xhci,
256 struct usb_hub_descriptor *desc, int ports)
257 {
258 u16 temp;
259
260 desc->bHubContrCurrent = 0;
261
262 desc->bNbrPorts = ports;
263 temp = 0;
264 /* Bits 1:0 - support per-port power switching, or power always on */
265 if (HCC_PPC(xhci->hcc_params))
266 temp |= HUB_CHAR_INDV_PORT_LPSM;
267 else
268 temp |= HUB_CHAR_NO_LPSM;
269 /* Bit 2 - root hubs are not part of a compound device */
270 /* Bits 4:3 - individual port over current protection */
271 temp |= HUB_CHAR_INDV_PORT_OCPM;
272 /* Bits 6:5 - no TTs in root ports */
273 /* Bit 7 - no port indicators */
274 desc->wHubCharacteristics = cpu_to_le16(temp);
275 }
276
277 /* Fill in the USB 2.0 roothub descriptor */
xhci_usb2_hub_descriptor(struct usb_hcd * hcd,struct xhci_hcd * xhci,struct usb_hub_descriptor * desc)278 static void xhci_usb2_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
279 struct usb_hub_descriptor *desc)
280 {
281 int ports;
282 u16 temp;
283 __u8 port_removable[(USB_MAXCHILDREN + 1 + 7) / 8];
284 u32 portsc;
285 unsigned int i;
286 struct xhci_hub *rhub;
287
288 rhub = &xhci->usb2_rhub;
289 ports = rhub->num_ports;
290 xhci_common_hub_descriptor(xhci, desc, ports);
291 desc->bDescriptorType = USB_DT_HUB;
292 temp = 1 + (ports / 8);
293 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * temp;
294 desc->bPwrOn2PwrGood = 10; /* xhci section 5.4.8 says 20ms */
295
296 /* The Device Removable bits are reported on a byte granularity.
297 * If the port doesn't exist within that byte, the bit is set to 0.
298 */
299 memset(port_removable, 0, sizeof(port_removable));
300 for (i = 0; i < ports; i++) {
301 portsc = readl(rhub->ports[i]->addr);
302 /* If a device is removable, PORTSC reports a 0, same as in the
303 * hub descriptor DeviceRemovable bits.
304 */
305 if (portsc & PORT_DEV_REMOVE)
306 /* This math is hairy because bit 0 of DeviceRemovable
307 * is reserved, and bit 1 is for port 1, etc.
308 */
309 port_removable[(i + 1) / 8] |= 1 << ((i + 1) % 8);
310 }
311
312 /* ch11.h defines a hub descriptor that has room for USB_MAXCHILDREN
313 * ports on it. The USB 2.0 specification says that there are two
314 * variable length fields at the end of the hub descriptor:
315 * DeviceRemovable and PortPwrCtrlMask. But since we can have less than
316 * USB_MAXCHILDREN ports, we may need to use the DeviceRemovable array
317 * to set PortPwrCtrlMask bits. PortPwrCtrlMask must always be set to
318 * 0xFF, so we initialize the both arrays (DeviceRemovable and
319 * PortPwrCtrlMask) to 0xFF. Then we set the DeviceRemovable for each
320 * set of ports that actually exist.
321 */
322 memset(desc->u.hs.DeviceRemovable, 0xff,
323 sizeof(desc->u.hs.DeviceRemovable));
324 memset(desc->u.hs.PortPwrCtrlMask, 0xff,
325 sizeof(desc->u.hs.PortPwrCtrlMask));
326
327 for (i = 0; i < (ports + 1 + 7) / 8; i++)
328 memset(&desc->u.hs.DeviceRemovable[i], port_removable[i],
329 sizeof(__u8));
330 }
331
332 /* Fill in the USB 3.0 roothub descriptor */
xhci_usb3_hub_descriptor(struct usb_hcd * hcd,struct xhci_hcd * xhci,struct usb_hub_descriptor * desc)333 static void xhci_usb3_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
334 struct usb_hub_descriptor *desc)
335 {
336 int ports;
337 u16 port_removable;
338 u32 portsc;
339 unsigned int i;
340 struct xhci_hub *rhub;
341
342 rhub = &xhci->usb3_rhub;
343 ports = rhub->num_ports;
344 xhci_common_hub_descriptor(xhci, desc, ports);
345 desc->bDescriptorType = USB_DT_SS_HUB;
346 desc->bDescLength = USB_DT_SS_HUB_SIZE;
347 desc->bPwrOn2PwrGood = 50; /* usb 3.1 may fail if less than 100ms */
348
349 /* header decode latency should be zero for roothubs,
350 * see section 4.23.5.2.
351 */
352 desc->u.ss.bHubHdrDecLat = 0;
353 desc->u.ss.wHubDelay = 0;
354
355 port_removable = 0;
356 /* bit 0 is reserved, bit 1 is for port 1, etc. */
357 for (i = 0; i < ports; i++) {
358 portsc = readl(rhub->ports[i]->addr);
359 if (portsc & PORT_DEV_REMOVE)
360 port_removable |= 1 << (i + 1);
361 }
362
363 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
364 }
365
xhci_hub_descriptor(struct usb_hcd * hcd,struct xhci_hcd * xhci,struct usb_hub_descriptor * desc)366 static void xhci_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
367 struct usb_hub_descriptor *desc)
368 {
369
370 if (hcd->speed >= HCD_USB3)
371 xhci_usb3_hub_descriptor(hcd, xhci, desc);
372 else
373 xhci_usb2_hub_descriptor(hcd, xhci, desc);
374
375 }
376
xhci_port_speed(unsigned int port_status)377 static unsigned int xhci_port_speed(unsigned int port_status)
378 {
379 if (DEV_LOWSPEED(port_status))
380 return USB_PORT_STAT_LOW_SPEED;
381 if (DEV_HIGHSPEED(port_status))
382 return USB_PORT_STAT_HIGH_SPEED;
383 /*
384 * FIXME: Yes, we should check for full speed, but the core uses that as
385 * a default in portspeed() in usb/core/hub.c (which is the only place
386 * USB_PORT_STAT_*_SPEED is used).
387 */
388 return 0;
389 }
390
391 /*
392 * These bits are Read Only (RO) and should be saved and written to the
393 * registers: 0, 3, 10:13, 30
394 * connect status, over-current status, port speed, and device removable.
395 * connect status and port speed are also sticky - meaning they're in
396 * the AUX well and they aren't changed by a hot, warm, or cold reset.
397 */
398 #define XHCI_PORT_RO ((1<<0) | (1<<3) | (0xf<<10) | (1<<30))
399 /*
400 * These bits are RW; writing a 0 clears the bit, writing a 1 sets the bit:
401 * bits 5:8, 9, 14:15, 25:27
402 * link state, port power, port indicator state, "wake on" enable state
403 */
404 #define XHCI_PORT_RWS ((0xf<<5) | (1<<9) | (0x3<<14) | (0x7<<25))
405 /*
406 * These bits are RW; writing a 1 sets the bit, writing a 0 has no effect:
407 * bit 4 (port reset)
408 */
409 #define XHCI_PORT_RW1S ((1<<4))
410 /*
411 * These bits are RW; writing a 1 clears the bit, writing a 0 has no effect:
412 * bits 1, 17, 18, 19, 20, 21, 22, 23
413 * port enable/disable, and
414 * change bits: connect, PED, warm port reset changed (reserved zero for USB 2.0 ports),
415 * over-current, reset, link state, and L1 change
416 */
417 #define XHCI_PORT_RW1CS ((1<<1) | (0x7f<<17))
418 /*
419 * Bit 16 is RW, and writing a '1' to it causes the link state control to be
420 * latched in
421 */
422 #define XHCI_PORT_RW ((1<<16))
423 /*
424 * These bits are Reserved Zero (RsvdZ) and zero should be written to them:
425 * bits 2, 24, 28:31
426 */
427 #define XHCI_PORT_RZ ((1<<2) | (1<<24) | (0xf<<28))
428
429 /*
430 * Given a port state, this function returns a value that would result in the
431 * port being in the same state, if the value was written to the port status
432 * control register.
433 * Save Read Only (RO) bits and save read/write bits where
434 * writing a 0 clears the bit and writing a 1 sets the bit (RWS).
435 * For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect.
436 */
xhci_port_state_to_neutral(u32 state)437 u32 xhci_port_state_to_neutral(u32 state)
438 {
439 /* Save read-only status and port state */
440 return (state & XHCI_PORT_RO) | (state & XHCI_PORT_RWS);
441 }
442
443 /*
444 * find slot id based on port number.
445 * @port: The one-based port number from one of the two split roothubs.
446 */
xhci_find_slot_id_by_port(struct usb_hcd * hcd,struct xhci_hcd * xhci,u16 port)447 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
448 u16 port)
449 {
450 int slot_id;
451 int i;
452 enum usb_device_speed speed;
453
454 slot_id = 0;
455 for (i = 0; i < MAX_HC_SLOTS; i++) {
456 if (!xhci->devs[i] || !xhci->devs[i]->udev)
457 continue;
458 speed = xhci->devs[i]->udev->speed;
459 if (((speed >= USB_SPEED_SUPER) == (hcd->speed >= HCD_USB3))
460 && xhci->devs[i]->fake_port == port) {
461 slot_id = i;
462 break;
463 }
464 }
465
466 return slot_id;
467 }
468
469 /*
470 * Stop device
471 * It issues stop endpoint command for EP 0 to 30. And wait the last command
472 * to complete.
473 * suspend will set to 1, if suspend bit need to set in command.
474 */
xhci_stop_device(struct xhci_hcd * xhci,int slot_id,int suspend)475 static int xhci_stop_device(struct xhci_hcd *xhci, int slot_id, int suspend)
476 {
477 struct xhci_virt_device *virt_dev;
478 struct xhci_command *cmd;
479 unsigned long flags;
480 int ret;
481 int i;
482
483 ret = 0;
484 virt_dev = xhci->devs[slot_id];
485 if (!virt_dev)
486 return -ENODEV;
487
488 trace_xhci_stop_device(virt_dev);
489
490 cmd = xhci_alloc_command(xhci, true, GFP_NOIO);
491 if (!cmd)
492 return -ENOMEM;
493
494 spin_lock_irqsave(&xhci->lock, flags);
495 for (i = LAST_EP_INDEX; i > 0; i--) {
496 if (virt_dev->eps[i].ring && virt_dev->eps[i].ring->dequeue) {
497 struct xhci_ep_ctx *ep_ctx;
498 struct xhci_command *command;
499
500 ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->out_ctx, i);
501
502 /* Check ep is running, required by AMD SNPS 3.1 xHC */
503 if (GET_EP_CTX_STATE(ep_ctx) != EP_STATE_RUNNING)
504 continue;
505
506 command = xhci_alloc_command(xhci, false, GFP_NOWAIT);
507 if (!command) {
508 spin_unlock_irqrestore(&xhci->lock, flags);
509 ret = -ENOMEM;
510 goto cmd_cleanup;
511 }
512
513 ret = xhci_queue_stop_endpoint(xhci, command, slot_id,
514 i, suspend);
515 if (ret) {
516 spin_unlock_irqrestore(&xhci->lock, flags);
517 xhci_free_command(xhci, command);
518 goto cmd_cleanup;
519 }
520 }
521 }
522 ret = xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
523 if (ret) {
524 spin_unlock_irqrestore(&xhci->lock, flags);
525 goto cmd_cleanup;
526 }
527
528 xhci_ring_cmd_db(xhci);
529 spin_unlock_irqrestore(&xhci->lock, flags);
530
531 /* Wait for last stop endpoint command to finish */
532 wait_for_completion(cmd->completion);
533
534 if (cmd->status == COMP_COMMAND_ABORTED ||
535 cmd->status == COMP_COMMAND_RING_STOPPED) {
536 xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
537 ret = -ETIME;
538 }
539
540 cmd_cleanup:
541 xhci_free_command(xhci, cmd);
542 return ret;
543 }
544
545 /*
546 * Ring device, it rings the all doorbells unconditionally.
547 */
xhci_ring_device(struct xhci_hcd * xhci,int slot_id)548 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
549 {
550 int i, s;
551 struct xhci_virt_ep *ep;
552
553 for (i = 0; i < LAST_EP_INDEX + 1; i++) {
554 ep = &xhci->devs[slot_id]->eps[i];
555
556 if (ep->ep_state & EP_HAS_STREAMS) {
557 for (s = 1; s < ep->stream_info->num_streams; s++)
558 xhci_ring_ep_doorbell(xhci, slot_id, i, s);
559 } else if (ep->ring && ep->ring->dequeue) {
560 xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
561 }
562 }
563
564 return;
565 }
566
xhci_disable_port(struct usb_hcd * hcd,struct xhci_hcd * xhci,u16 wIndex,__le32 __iomem * addr,u32 port_status)567 static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
568 u16 wIndex, __le32 __iomem *addr, u32 port_status)
569 {
570 /* Don't allow the USB core to disable SuperSpeed ports. */
571 if (hcd->speed >= HCD_USB3) {
572 xhci_dbg(xhci, "Ignoring request to disable "
573 "SuperSpeed port.\n");
574 return;
575 }
576
577 if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
578 xhci_dbg(xhci,
579 "Broken Port Enabled/Disabled, ignoring port disable request.\n");
580 return;
581 }
582
583 /* Write 1 to disable the port */
584 writel(port_status | PORT_PE, addr);
585 port_status = readl(addr);
586 xhci_dbg(xhci, "disable port %d-%d, portsc: 0x%x\n",
587 hcd->self.busnum, wIndex + 1, port_status);
588 }
589
xhci_clear_port_change_bit(struct xhci_hcd * xhci,u16 wValue,u16 wIndex,__le32 __iomem * addr,u32 port_status)590 static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
591 u16 wIndex, __le32 __iomem *addr, u32 port_status)
592 {
593 char *port_change_bit;
594 u32 status;
595
596 switch (wValue) {
597 case USB_PORT_FEAT_C_RESET:
598 status = PORT_RC;
599 port_change_bit = "reset";
600 break;
601 case USB_PORT_FEAT_C_BH_PORT_RESET:
602 status = PORT_WRC;
603 port_change_bit = "warm(BH) reset";
604 break;
605 case USB_PORT_FEAT_C_CONNECTION:
606 status = PORT_CSC;
607 port_change_bit = "connect";
608 break;
609 case USB_PORT_FEAT_C_OVER_CURRENT:
610 status = PORT_OCC;
611 port_change_bit = "over-current";
612 break;
613 case USB_PORT_FEAT_C_ENABLE:
614 status = PORT_PEC;
615 port_change_bit = "enable/disable";
616 break;
617 case USB_PORT_FEAT_C_SUSPEND:
618 status = PORT_PLC;
619 port_change_bit = "suspend/resume";
620 break;
621 case USB_PORT_FEAT_C_PORT_LINK_STATE:
622 status = PORT_PLC;
623 port_change_bit = "link state";
624 break;
625 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
626 status = PORT_CEC;
627 port_change_bit = "config error";
628 break;
629 default:
630 /* Should never happen */
631 return;
632 }
633 /* Change bits are all write 1 to clear */
634 writel(port_status | status, addr);
635 port_status = readl(addr);
636
637 xhci_dbg(xhci, "clear port%d %s change, portsc: 0x%x\n",
638 wIndex + 1, port_change_bit, port_status);
639 }
640
xhci_get_rhub(struct usb_hcd * hcd)641 struct xhci_hub *xhci_get_rhub(struct usb_hcd *hcd)
642 {
643 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
644
645 if (hcd->speed >= HCD_USB3)
646 return &xhci->usb3_rhub;
647 return &xhci->usb2_rhub;
648 }
649
650 /*
651 * xhci_set_port_power() must be called with xhci->lock held.
652 * It will release and re-aquire the lock while calling ACPI
653 * method.
654 */
xhci_set_port_power(struct xhci_hcd * xhci,struct usb_hcd * hcd,u16 index,bool on,unsigned long * flags)655 static void xhci_set_port_power(struct xhci_hcd *xhci, struct usb_hcd *hcd,
656 u16 index, bool on, unsigned long *flags)
657 __must_hold(&xhci->lock)
658 {
659 struct xhci_hub *rhub;
660 struct xhci_port *port;
661 u32 temp;
662
663 rhub = xhci_get_rhub(hcd);
664 port = rhub->ports[index];
665 temp = readl(port->addr);
666
667 xhci_dbg(xhci, "set port power %d-%d %s, portsc: 0x%x\n",
668 hcd->self.busnum, index + 1, on ? "ON" : "OFF", temp);
669
670 temp = xhci_port_state_to_neutral(temp);
671
672 if (on) {
673 /* Power on */
674 writel(temp | PORT_POWER, port->addr);
675 readl(port->addr);
676 } else {
677 /* Power off */
678 writel(temp & ~PORT_POWER, port->addr);
679 }
680
681 spin_unlock_irqrestore(&xhci->lock, *flags);
682 temp = usb_acpi_power_manageable(hcd->self.root_hub,
683 index);
684 if (temp)
685 usb_acpi_set_power_state(hcd->self.root_hub,
686 index, on);
687 spin_lock_irqsave(&xhci->lock, *flags);
688 }
689
xhci_port_set_test_mode(struct xhci_hcd * xhci,u16 test_mode,u16 wIndex)690 static void xhci_port_set_test_mode(struct xhci_hcd *xhci,
691 u16 test_mode, u16 wIndex)
692 {
693 u32 temp;
694 struct xhci_port *port;
695
696 /* xhci only supports test mode for usb2 ports */
697 port = xhci->usb2_rhub.ports[wIndex];
698 temp = readl(port->addr + PORTPMSC);
699 temp |= test_mode << PORT_TEST_MODE_SHIFT;
700 writel(temp, port->addr + PORTPMSC);
701 xhci->test_mode = test_mode;
702 if (test_mode == USB_TEST_FORCE_ENABLE)
703 xhci_start(xhci);
704 }
705
xhci_enter_test_mode(struct xhci_hcd * xhci,u16 test_mode,u16 wIndex,unsigned long * flags)706 static int xhci_enter_test_mode(struct xhci_hcd *xhci,
707 u16 test_mode, u16 wIndex, unsigned long *flags)
708 __must_hold(&xhci->lock)
709 {
710 int i, retval;
711
712 /* Disable all Device Slots */
713 xhci_dbg(xhci, "Disable all slots\n");
714 spin_unlock_irqrestore(&xhci->lock, *flags);
715 for (i = 1; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
716 if (!xhci->devs[i])
717 continue;
718
719 retval = xhci_disable_slot(xhci, i);
720 xhci_free_virt_device(xhci, i);
721 if (retval)
722 xhci_err(xhci, "Failed to disable slot %d, %d. Enter test mode anyway\n",
723 i, retval);
724 }
725 spin_lock_irqsave(&xhci->lock, *flags);
726 /* Put all ports to the Disable state by clear PP */
727 xhci_dbg(xhci, "Disable all port (PP = 0)\n");
728 /* Power off USB3 ports*/
729 for (i = 0; i < xhci->usb3_rhub.num_ports; i++)
730 xhci_set_port_power(xhci, xhci->shared_hcd, i, false, flags);
731 /* Power off USB2 ports*/
732 for (i = 0; i < xhci->usb2_rhub.num_ports; i++)
733 xhci_set_port_power(xhci, xhci->main_hcd, i, false, flags);
734 /* Stop the controller */
735 xhci_dbg(xhci, "Stop controller\n");
736 retval = xhci_halt(xhci);
737 if (retval)
738 return retval;
739 /* Disable runtime PM for test mode */
740 pm_runtime_forbid(xhci_to_hcd(xhci)->self.controller);
741 /* Set PORTPMSC.PTC field to enter selected test mode */
742 /* Port is selected by wIndex. port_id = wIndex + 1 */
743 xhci_dbg(xhci, "Enter Test Mode: %d, Port_id=%d\n",
744 test_mode, wIndex + 1);
745 xhci_port_set_test_mode(xhci, test_mode, wIndex);
746 return retval;
747 }
748
xhci_exit_test_mode(struct xhci_hcd * xhci)749 static int xhci_exit_test_mode(struct xhci_hcd *xhci)
750 {
751 int retval;
752
753 if (!xhci->test_mode) {
754 xhci_err(xhci, "Not in test mode, do nothing.\n");
755 return 0;
756 }
757 if (xhci->test_mode == USB_TEST_FORCE_ENABLE &&
758 !(xhci->xhc_state & XHCI_STATE_HALTED)) {
759 retval = xhci_halt(xhci);
760 if (retval)
761 return retval;
762 }
763 pm_runtime_allow(xhci_to_hcd(xhci)->self.controller);
764 xhci->test_mode = 0;
765 return xhci_reset(xhci);
766 }
767
xhci_set_link_state(struct xhci_hcd * xhci,struct xhci_port * port,u32 link_state)768 void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
769 u32 link_state)
770 {
771 u32 temp;
772 u32 portsc;
773
774 portsc = readl(port->addr);
775 temp = xhci_port_state_to_neutral(portsc);
776 temp &= ~PORT_PLS_MASK;
777 temp |= PORT_LINK_STROBE | link_state;
778 writel(temp, port->addr);
779
780 xhci_dbg(xhci, "Set port %d-%d link state, portsc: 0x%x, write 0x%x",
781 port->rhub->hcd->self.busnum, port->hcd_portnum + 1,
782 portsc, temp);
783 }
784
xhci_set_remote_wake_mask(struct xhci_hcd * xhci,struct xhci_port * port,u16 wake_mask)785 static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
786 struct xhci_port *port, u16 wake_mask)
787 {
788 u32 temp;
789
790 temp = readl(port->addr);
791 temp = xhci_port_state_to_neutral(temp);
792
793 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
794 temp |= PORT_WKCONN_E;
795 else
796 temp &= ~PORT_WKCONN_E;
797
798 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
799 temp |= PORT_WKDISC_E;
800 else
801 temp &= ~PORT_WKDISC_E;
802
803 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
804 temp |= PORT_WKOC_E;
805 else
806 temp &= ~PORT_WKOC_E;
807
808 writel(temp, port->addr);
809 }
810
811 /* Test and clear port RWC bit */
xhci_test_and_clear_bit(struct xhci_hcd * xhci,struct xhci_port * port,u32 port_bit)812 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
813 u32 port_bit)
814 {
815 u32 temp;
816
817 temp = readl(port->addr);
818 if (temp & port_bit) {
819 temp = xhci_port_state_to_neutral(temp);
820 temp |= port_bit;
821 writel(temp, port->addr);
822 }
823 }
824
825 /* Updates Link Status for super Speed port */
xhci_hub_report_usb3_link_state(struct xhci_hcd * xhci,u32 * status,u32 status_reg)826 static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
827 u32 *status, u32 status_reg)
828 {
829 u32 pls = status_reg & PORT_PLS_MASK;
830
831 /* When the CAS bit is set then warm reset
832 * should be performed on port
833 */
834 if (status_reg & PORT_CAS) {
835 /* The CAS bit can be set while the port is
836 * in any link state.
837 * Only roothubs have CAS bit, so we
838 * pretend to be in compliance mode
839 * unless we're already in compliance
840 * or the inactive state.
841 */
842 if (pls != USB_SS_PORT_LS_COMP_MOD &&
843 pls != USB_SS_PORT_LS_SS_INACTIVE) {
844 pls = USB_SS_PORT_LS_COMP_MOD;
845 }
846 /* Return also connection bit -
847 * hub state machine resets port
848 * when this bit is set.
849 */
850 pls |= USB_PORT_STAT_CONNECTION;
851 } else {
852 /*
853 * Resume state is an xHCI internal state. Do not report it to
854 * usb core, instead, pretend to be U3, thus usb core knows
855 * it's not ready for transfer.
856 */
857 if (pls == XDEV_RESUME) {
858 *status |= USB_SS_PORT_LS_U3;
859 return;
860 }
861
862 /*
863 * If CAS bit isn't set but the Port is already at
864 * Compliance Mode, fake a connection so the USB core
865 * notices the Compliance state and resets the port.
866 * This resolves an issue generated by the SN65LVPE502CP
867 * in which sometimes the port enters compliance mode
868 * caused by a delay on the host-device negotiation.
869 */
870 if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
871 (pls == USB_SS_PORT_LS_COMP_MOD))
872 pls |= USB_PORT_STAT_CONNECTION;
873 }
874
875 /* update status field */
876 *status |= pls;
877 }
878
879 /*
880 * Function for Compliance Mode Quirk.
881 *
882 * This Function verifies if all xhc USB3 ports have entered U0, if so,
883 * the compliance mode timer is deleted. A port won't enter
884 * compliance mode if it has previously entered U0.
885 */
xhci_del_comp_mod_timer(struct xhci_hcd * xhci,u32 status,u16 wIndex)886 static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
887 u16 wIndex)
888 {
889 u32 all_ports_seen_u0 = ((1 << xhci->usb3_rhub.num_ports) - 1);
890 bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);
891
892 if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
893 return;
894
895 if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
896 xhci->port_status_u0 |= 1 << wIndex;
897 if (xhci->port_status_u0 == all_ports_seen_u0) {
898 del_timer_sync(&xhci->comp_mode_recovery_timer);
899 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
900 "All USB3 ports have entered U0 already!");
901 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
902 "Compliance Mode Recovery Timer Deleted.");
903 }
904 }
905 }
906
xhci_handle_usb2_port_link_resume(struct xhci_port * port,u32 * status,u32 portsc,unsigned long * flags)907 static int xhci_handle_usb2_port_link_resume(struct xhci_port *port,
908 u32 *status, u32 portsc,
909 unsigned long *flags)
910 {
911 struct xhci_bus_state *bus_state;
912 struct xhci_hcd *xhci;
913 struct usb_hcd *hcd;
914 int slot_id;
915 u32 wIndex;
916
917 hcd = port->rhub->hcd;
918 bus_state = &port->rhub->bus_state;
919 xhci = hcd_to_xhci(hcd);
920 wIndex = port->hcd_portnum;
921
922 if ((portsc & PORT_RESET) || !(portsc & PORT_PE)) {
923 *status = 0xffffffff;
924 return -EINVAL;
925 }
926 /* did port event handler already start resume timing? */
927 if (!bus_state->resume_done[wIndex]) {
928 /* If not, maybe we are in a host initated resume? */
929 if (test_bit(wIndex, &bus_state->resuming_ports)) {
930 /* Host initated resume doesn't time the resume
931 * signalling using resume_done[].
932 * It manually sets RESUME state, sleeps 20ms
933 * and sets U0 state. This should probably be
934 * changed, but not right now.
935 */
936 } else {
937 /* port resume was discovered now and here,
938 * start resume timing
939 */
940 unsigned long timeout = jiffies +
941 msecs_to_jiffies(USB_RESUME_TIMEOUT);
942
943 set_bit(wIndex, &bus_state->resuming_ports);
944 bus_state->resume_done[wIndex] = timeout;
945 mod_timer(&hcd->rh_timer, timeout);
946 usb_hcd_start_port_resume(&hcd->self, wIndex);
947 }
948 /* Has resume been signalled for USB_RESUME_TIME yet? */
949 } else if (time_after_eq(jiffies, bus_state->resume_done[wIndex])) {
950 int time_left;
951
952 xhci_dbg(xhci, "resume USB2 port %d-%d\n",
953 hcd->self.busnum, wIndex + 1);
954
955 bus_state->resume_done[wIndex] = 0;
956 clear_bit(wIndex, &bus_state->resuming_ports);
957
958 set_bit(wIndex, &bus_state->rexit_ports);
959
960 xhci_test_and_clear_bit(xhci, port, PORT_PLC);
961 xhci_set_link_state(xhci, port, XDEV_U0);
962
963 spin_unlock_irqrestore(&xhci->lock, *flags);
964 time_left = wait_for_completion_timeout(
965 &bus_state->rexit_done[wIndex],
966 msecs_to_jiffies(XHCI_MAX_REXIT_TIMEOUT_MS));
967 spin_lock_irqsave(&xhci->lock, *flags);
968
969 if (time_left) {
970 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
971 wIndex + 1);
972 if (!slot_id) {
973 xhci_dbg(xhci, "slot_id is zero\n");
974 *status = 0xffffffff;
975 return -ENODEV;
976 }
977 xhci_ring_device(xhci, slot_id);
978 } else {
979 int port_status = readl(port->addr);
980
981 xhci_warn(xhci, "Port resume timed out, port %d-%d: 0x%x\n",
982 hcd->self.busnum, wIndex + 1, port_status);
983 *status |= USB_PORT_STAT_SUSPEND;
984 clear_bit(wIndex, &bus_state->rexit_ports);
985 }
986
987 usb_hcd_end_port_resume(&hcd->self, wIndex);
988 bus_state->port_c_suspend |= 1 << wIndex;
989 bus_state->suspended_ports &= ~(1 << wIndex);
990 } else {
991 /*
992 * The resume has been signaling for less than
993 * USB_RESUME_TIME. Report the port status as SUSPEND,
994 * let the usbcore check port status again and clear
995 * resume signaling later.
996 */
997 *status |= USB_PORT_STAT_SUSPEND;
998 }
999 return 0;
1000 }
1001
xhci_get_ext_port_status(u32 raw_port_status,u32 port_li)1002 static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
1003 {
1004 u32 ext_stat = 0;
1005 int speed_id;
1006
1007 /* only support rx and tx lane counts of 1 in usb3.1 spec */
1008 speed_id = DEV_PORT_SPEED(raw_port_status);
1009 ext_stat |= speed_id; /* bits 3:0, RX speed id */
1010 ext_stat |= speed_id << 4; /* bits 7:4, TX speed id */
1011
1012 ext_stat |= PORT_RX_LANES(port_li) << 8; /* bits 11:8 Rx lane count */
1013 ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */
1014
1015 return ext_stat;
1016 }
1017
xhci_get_usb3_port_status(struct xhci_port * port,u32 * status,u32 portsc)1018 static void xhci_get_usb3_port_status(struct xhci_port *port, u32 *status,
1019 u32 portsc)
1020 {
1021 struct xhci_bus_state *bus_state;
1022 struct xhci_hcd *xhci;
1023 struct usb_hcd *hcd;
1024 u32 link_state;
1025 u32 portnum;
1026
1027 bus_state = &port->rhub->bus_state;
1028 xhci = hcd_to_xhci(port->rhub->hcd);
1029 hcd = port->rhub->hcd;
1030 link_state = portsc & PORT_PLS_MASK;
1031 portnum = port->hcd_portnum;
1032
1033 /* USB3 specific wPortChange bits
1034 *
1035 * Port link change with port in resume state should not be
1036 * reported to usbcore, as this is an internal state to be
1037 * handled by xhci driver. Reporting PLC to usbcore may
1038 * cause usbcore clearing PLC first and port change event
1039 * irq won't be generated.
1040 */
1041
1042 if (portsc & PORT_PLC && (link_state != XDEV_RESUME))
1043 *status |= USB_PORT_STAT_C_LINK_STATE << 16;
1044 if (portsc & PORT_WRC)
1045 *status |= USB_PORT_STAT_C_BH_RESET << 16;
1046 if (portsc & PORT_CEC)
1047 *status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;
1048
1049 /* USB3 specific wPortStatus bits */
1050 if (portsc & PORT_POWER) {
1051 *status |= USB_SS_PORT_STAT_POWER;
1052 /* link state handling */
1053 if (link_state == XDEV_U0)
1054 bus_state->suspended_ports &= ~(1 << portnum);
1055 }
1056
1057 /* remote wake resume signaling complete */
1058 if (bus_state->port_remote_wakeup & (1 << portnum) &&
1059 link_state != XDEV_RESUME &&
1060 link_state != XDEV_RECOVERY) {
1061 bus_state->port_remote_wakeup &= ~(1 << portnum);
1062 usb_hcd_end_port_resume(&hcd->self, portnum);
1063 }
1064
1065 xhci_hub_report_usb3_link_state(xhci, status, portsc);
1066 xhci_del_comp_mod_timer(xhci, portsc, portnum);
1067 }
1068
xhci_get_usb2_port_status(struct xhci_port * port,u32 * status,u32 portsc,unsigned long * flags)1069 static void xhci_get_usb2_port_status(struct xhci_port *port, u32 *status,
1070 u32 portsc, unsigned long *flags)
1071 {
1072 struct xhci_bus_state *bus_state;
1073 u32 link_state;
1074 u32 portnum;
1075 int ret;
1076
1077 bus_state = &port->rhub->bus_state;
1078 link_state = portsc & PORT_PLS_MASK;
1079 portnum = port->hcd_portnum;
1080
1081 /* USB2 wPortStatus bits */
1082 if (portsc & PORT_POWER) {
1083 *status |= USB_PORT_STAT_POWER;
1084
1085 /* link state is only valid if port is powered */
1086 if (link_state == XDEV_U3)
1087 *status |= USB_PORT_STAT_SUSPEND;
1088 if (link_state == XDEV_U2)
1089 *status |= USB_PORT_STAT_L1;
1090 if (link_state == XDEV_U0) {
1091 bus_state->resume_done[portnum] = 0;
1092 clear_bit(portnum, &bus_state->resuming_ports);
1093 if (bus_state->suspended_ports & (1 << portnum)) {
1094 bus_state->suspended_ports &= ~(1 << portnum);
1095 bus_state->port_c_suspend |= 1 << portnum;
1096 }
1097 }
1098 if (link_state == XDEV_RESUME) {
1099 ret = xhci_handle_usb2_port_link_resume(port, status,
1100 portsc, flags);
1101 if (ret)
1102 return;
1103 }
1104 }
1105 }
1106
1107 /*
1108 * Converts a raw xHCI port status into the format that external USB 2.0 or USB
1109 * 3.0 hubs use.
1110 *
1111 * Possible side effects:
1112 * - Mark a port as being done with device resume,
1113 * and ring the endpoint doorbells.
1114 * - Stop the Synopsys redriver Compliance Mode polling.
1115 * - Drop and reacquire the xHCI lock, in order to wait for port resume.
1116 */
xhci_get_port_status(struct usb_hcd * hcd,struct xhci_bus_state * bus_state,u16 wIndex,u32 raw_port_status,unsigned long * flags)1117 static u32 xhci_get_port_status(struct usb_hcd *hcd,
1118 struct xhci_bus_state *bus_state,
1119 u16 wIndex, u32 raw_port_status,
1120 unsigned long *flags)
1121 __releases(&xhci->lock)
1122 __acquires(&xhci->lock)
1123 {
1124 u32 status = 0;
1125 struct xhci_hub *rhub;
1126 struct xhci_port *port;
1127
1128 rhub = xhci_get_rhub(hcd);
1129 port = rhub->ports[wIndex];
1130
1131 /* common wPortChange bits */
1132 if (raw_port_status & PORT_CSC)
1133 status |= USB_PORT_STAT_C_CONNECTION << 16;
1134 if (raw_port_status & PORT_PEC)
1135 status |= USB_PORT_STAT_C_ENABLE << 16;
1136 if ((raw_port_status & PORT_OCC))
1137 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1138 if ((raw_port_status & PORT_RC))
1139 status |= USB_PORT_STAT_C_RESET << 16;
1140
1141 /* common wPortStatus bits */
1142 if (raw_port_status & PORT_CONNECT) {
1143 status |= USB_PORT_STAT_CONNECTION;
1144 status |= xhci_port_speed(raw_port_status);
1145 }
1146 if (raw_port_status & PORT_PE)
1147 status |= USB_PORT_STAT_ENABLE;
1148 if (raw_port_status & PORT_OC)
1149 status |= USB_PORT_STAT_OVERCURRENT;
1150 if (raw_port_status & PORT_RESET)
1151 status |= USB_PORT_STAT_RESET;
1152
1153 /* USB2 and USB3 specific bits, including Port Link State */
1154 if (hcd->speed >= HCD_USB3)
1155 xhci_get_usb3_port_status(port, &status, raw_port_status);
1156 else
1157 xhci_get_usb2_port_status(port, &status, raw_port_status,
1158 flags);
1159 /*
1160 * Clear stale usb2 resume signalling variables in case port changed
1161 * state during resume signalling. For example on error
1162 */
1163 if ((bus_state->resume_done[wIndex] ||
1164 test_bit(wIndex, &bus_state->resuming_ports)) &&
1165 (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
1166 (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
1167 bus_state->resume_done[wIndex] = 0;
1168 clear_bit(wIndex, &bus_state->resuming_ports);
1169 usb_hcd_end_port_resume(&hcd->self, wIndex);
1170 }
1171
1172 if (bus_state->port_c_suspend & (1 << wIndex))
1173 status |= USB_PORT_STAT_C_SUSPEND << 16;
1174
1175 return status;
1176 }
1177
xhci_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)1178 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
1179 u16 wIndex, char *buf, u16 wLength)
1180 {
1181 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1182 int max_ports;
1183 unsigned long flags;
1184 u32 temp, status;
1185 int retval = 0;
1186 int slot_id;
1187 struct xhci_bus_state *bus_state;
1188 u16 link_state = 0;
1189 u16 wake_mask = 0;
1190 u16 timeout = 0;
1191 u16 test_mode = 0;
1192 struct xhci_hub *rhub;
1193 struct xhci_port **ports;
1194
1195 rhub = xhci_get_rhub(hcd);
1196 ports = rhub->ports;
1197 max_ports = rhub->num_ports;
1198 bus_state = &rhub->bus_state;
1199
1200 spin_lock_irqsave(&xhci->lock, flags);
1201 switch (typeReq) {
1202 case GetHubStatus:
1203 /* No power source, over-current reported per port */
1204 memset(buf, 0, 4);
1205 break;
1206 case GetHubDescriptor:
1207 /* Check to make sure userspace is asking for the USB 3.0 hub
1208 * descriptor for the USB 3.0 roothub. If not, we stall the
1209 * endpoint, like external hubs do.
1210 */
1211 if (hcd->speed >= HCD_USB3 &&
1212 (wLength < USB_DT_SS_HUB_SIZE ||
1213 wValue != (USB_DT_SS_HUB << 8))) {
1214 xhci_dbg(xhci, "Wrong hub descriptor type for "
1215 "USB 3.0 roothub.\n");
1216 goto error;
1217 }
1218 xhci_hub_descriptor(hcd, xhci,
1219 (struct usb_hub_descriptor *) buf);
1220 break;
1221 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
1222 if ((wValue & 0xff00) != (USB_DT_BOS << 8))
1223 goto error;
1224
1225 if (hcd->speed < HCD_USB3)
1226 goto error;
1227
1228 retval = xhci_create_usb3x_bos_desc(xhci, buf, wLength);
1229 spin_unlock_irqrestore(&xhci->lock, flags);
1230 return retval;
1231 case GetPortStatus:
1232 if (!wIndex || wIndex > max_ports)
1233 goto error;
1234 wIndex--;
1235 temp = readl(ports[wIndex]->addr);
1236 if (temp == ~(u32)0) {
1237 xhci_hc_died(xhci);
1238 retval = -ENODEV;
1239 break;
1240 }
1241 trace_xhci_get_port_status(wIndex, temp);
1242 status = xhci_get_port_status(hcd, bus_state, wIndex, temp,
1243 &flags);
1244 if (status == 0xffffffff)
1245 goto error;
1246
1247 xhci_dbg(xhci, "Get port status %d-%d read: 0x%x, return 0x%x",
1248 hcd->self.busnum, wIndex + 1, temp, status);
1249
1250 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
1251 /* if USB 3.1 extended port status return additional 4 bytes */
1252 if (wValue == 0x02) {
1253 u32 port_li;
1254
1255 if (hcd->speed < HCD_USB31 || wLength != 8) {
1256 xhci_err(xhci, "get ext port status invalid parameter\n");
1257 retval = -EINVAL;
1258 break;
1259 }
1260 port_li = readl(ports[wIndex]->addr + PORTLI);
1261 status = xhci_get_ext_port_status(temp, port_li);
1262 put_unaligned_le32(status, &buf[4]);
1263 }
1264 break;
1265 case SetPortFeature:
1266 if (wValue == USB_PORT_FEAT_LINK_STATE)
1267 link_state = (wIndex & 0xff00) >> 3;
1268 if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
1269 wake_mask = wIndex & 0xff00;
1270 if (wValue == USB_PORT_FEAT_TEST)
1271 test_mode = (wIndex & 0xff00) >> 8;
1272 /* The MSB of wIndex is the U1/U2 timeout */
1273 timeout = (wIndex & 0xff00) >> 8;
1274 wIndex &= 0xff;
1275 if (!wIndex || wIndex > max_ports)
1276 goto error;
1277 wIndex--;
1278 temp = readl(ports[wIndex]->addr);
1279 if (temp == ~(u32)0) {
1280 xhci_hc_died(xhci);
1281 retval = -ENODEV;
1282 break;
1283 }
1284 temp = xhci_port_state_to_neutral(temp);
1285 /* FIXME: What new port features do we need to support? */
1286 switch (wValue) {
1287 case USB_PORT_FEAT_SUSPEND:
1288 temp = readl(ports[wIndex]->addr);
1289 if ((temp & PORT_PLS_MASK) != XDEV_U0) {
1290 /* Resume the port to U0 first */
1291 xhci_set_link_state(xhci, ports[wIndex],
1292 XDEV_U0);
1293 spin_unlock_irqrestore(&xhci->lock, flags);
1294 msleep(10);
1295 spin_lock_irqsave(&xhci->lock, flags);
1296 }
1297 /* In spec software should not attempt to suspend
1298 * a port unless the port reports that it is in the
1299 * enabled (PED = ‘1’,PLS < ‘3’) state.
1300 */
1301 temp = readl(ports[wIndex]->addr);
1302 if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
1303 || (temp & PORT_PLS_MASK) >= XDEV_U3) {
1304 xhci_warn(xhci, "USB core suspending port %d-%d not in U0/U1/U2\n",
1305 hcd->self.busnum, wIndex + 1);
1306 goto error;
1307 }
1308
1309 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1310 wIndex + 1);
1311 if (!slot_id) {
1312 xhci_warn(xhci, "slot_id is zero\n");
1313 goto error;
1314 }
1315 /* unlock to execute stop endpoint commands */
1316 spin_unlock_irqrestore(&xhci->lock, flags);
1317 xhci_stop_device(xhci, slot_id, 1);
1318 spin_lock_irqsave(&xhci->lock, flags);
1319
1320 xhci_set_link_state(xhci, ports[wIndex], XDEV_U3);
1321
1322 spin_unlock_irqrestore(&xhci->lock, flags);
1323 msleep(10); /* wait device to enter */
1324 spin_lock_irqsave(&xhci->lock, flags);
1325
1326 temp = readl(ports[wIndex]->addr);
1327 bus_state->suspended_ports |= 1 << wIndex;
1328 break;
1329 case USB_PORT_FEAT_LINK_STATE:
1330 temp = readl(ports[wIndex]->addr);
1331 /* Disable port */
1332 if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
1333 xhci_dbg(xhci, "Disable port %d-%d\n",
1334 hcd->self.busnum, wIndex + 1);
1335 temp = xhci_port_state_to_neutral(temp);
1336 /*
1337 * Clear all change bits, so that we get a new
1338 * connection event.
1339 */
1340 temp |= PORT_CSC | PORT_PEC | PORT_WRC |
1341 PORT_OCC | PORT_RC | PORT_PLC |
1342 PORT_CEC;
1343 writel(temp | PORT_PE, ports[wIndex]->addr);
1344 temp = readl(ports[wIndex]->addr);
1345 break;
1346 }
1347
1348 /* Put link in RxDetect (enable port) */
1349 if (link_state == USB_SS_PORT_LS_RX_DETECT) {
1350 xhci_dbg(xhci, "Enable port %d-%d\n",
1351 hcd->self.busnum, wIndex + 1);
1352 xhci_set_link_state(xhci, ports[wIndex],
1353 link_state);
1354 temp = readl(ports[wIndex]->addr);
1355 break;
1356 }
1357
1358 /*
1359 * For xHCI 1.1 according to section 4.19.1.2.4.1 a
1360 * root hub port's transition to compliance mode upon
1361 * detecting LFPS timeout may be controlled by an
1362 * Compliance Transition Enabled (CTE) flag (not
1363 * software visible). This flag is set by writing 0xA
1364 * to PORTSC PLS field which will allow transition to
1365 * compliance mode the next time LFPS timeout is
1366 * encountered. A warm reset will clear it.
1367 *
1368 * The CTE flag is only supported if the HCCPARAMS2 CTC
1369 * flag is set, otherwise, the compliance substate is
1370 * automatically entered as on 1.0 and prior.
1371 */
1372 if (link_state == USB_SS_PORT_LS_COMP_MOD) {
1373 if (!HCC2_CTC(xhci->hcc_params2)) {
1374 xhci_dbg(xhci, "CTC flag is 0, port already supports entering compliance mode\n");
1375 break;
1376 }
1377
1378 if ((temp & PORT_CONNECT)) {
1379 xhci_warn(xhci, "Can't set compliance mode when port is connected\n");
1380 goto error;
1381 }
1382
1383 xhci_dbg(xhci, "Enable compliance mode transition for port %d-%d\n",
1384 hcd->self.busnum, wIndex + 1);
1385 xhci_set_link_state(xhci, ports[wIndex],
1386 link_state);
1387
1388 temp = readl(ports[wIndex]->addr);
1389 break;
1390 }
1391 /* Port must be enabled */
1392 if (!(temp & PORT_PE)) {
1393 retval = -ENODEV;
1394 break;
1395 }
1396 /* Can't set port link state above '3' (U3) */
1397 if (link_state > USB_SS_PORT_LS_U3) {
1398 xhci_warn(xhci, "Cannot set port %d-%d link state %d\n",
1399 hcd->self.busnum, wIndex + 1,
1400 link_state);
1401 goto error;
1402 }
1403
1404 /*
1405 * set link to U0, steps depend on current link state.
1406 * U3: set link to U0 and wait for u3exit completion.
1407 * U1/U2: no PLC complete event, only set link to U0.
1408 * Resume/Recovery: device initiated U0, only wait for
1409 * completion
1410 */
1411 if (link_state == USB_SS_PORT_LS_U0) {
1412 u32 pls = temp & PORT_PLS_MASK;
1413 bool wait_u0 = false;
1414
1415 /* already in U0 */
1416 if (pls == XDEV_U0)
1417 break;
1418 if (pls == XDEV_U3 ||
1419 pls == XDEV_RESUME ||
1420 pls == XDEV_RECOVERY) {
1421 wait_u0 = true;
1422 reinit_completion(&bus_state->u3exit_done[wIndex]);
1423 }
1424 if (pls <= XDEV_U3) /* U1, U2, U3 */
1425 xhci_set_link_state(xhci, ports[wIndex],
1426 USB_SS_PORT_LS_U0);
1427 if (!wait_u0) {
1428 if (pls > XDEV_U3)
1429 goto error;
1430 break;
1431 }
1432 spin_unlock_irqrestore(&xhci->lock, flags);
1433 if (!wait_for_completion_timeout(&bus_state->u3exit_done[wIndex],
1434 msecs_to_jiffies(100)))
1435 xhci_dbg(xhci, "missing U0 port change event for port %d-%d\n",
1436 hcd->self.busnum, wIndex + 1);
1437 spin_lock_irqsave(&xhci->lock, flags);
1438 temp = readl(ports[wIndex]->addr);
1439 break;
1440 }
1441
1442 if (link_state == USB_SS_PORT_LS_U3) {
1443 int retries = 16;
1444 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1445 wIndex + 1);
1446 if (slot_id) {
1447 /* unlock to execute stop endpoint
1448 * commands */
1449 spin_unlock_irqrestore(&xhci->lock,
1450 flags);
1451 xhci_stop_device(xhci, slot_id, 1);
1452 spin_lock_irqsave(&xhci->lock, flags);
1453 }
1454 xhci_set_link_state(xhci, ports[wIndex], USB_SS_PORT_LS_U3);
1455 spin_unlock_irqrestore(&xhci->lock, flags);
1456 while (retries--) {
1457 usleep_range(4000, 8000);
1458 temp = readl(ports[wIndex]->addr);
1459 if ((temp & PORT_PLS_MASK) == XDEV_U3)
1460 break;
1461 }
1462 spin_lock_irqsave(&xhci->lock, flags);
1463 temp = readl(ports[wIndex]->addr);
1464 bus_state->suspended_ports |= 1 << wIndex;
1465 }
1466 break;
1467 case USB_PORT_FEAT_POWER:
1468 /*
1469 * Turn on ports, even if there isn't per-port switching.
1470 * HC will report connect events even before this is set.
1471 * However, hub_wq will ignore the roothub events until
1472 * the roothub is registered.
1473 */
1474 xhci_set_port_power(xhci, hcd, wIndex, true, &flags);
1475 break;
1476 case USB_PORT_FEAT_RESET:
1477 temp = (temp | PORT_RESET);
1478 writel(temp, ports[wIndex]->addr);
1479
1480 temp = readl(ports[wIndex]->addr);
1481 xhci_dbg(xhci, "set port reset, actual port %d-%d status = 0x%x\n",
1482 hcd->self.busnum, wIndex + 1, temp);
1483 break;
1484 case USB_PORT_FEAT_REMOTE_WAKE_MASK:
1485 xhci_set_remote_wake_mask(xhci, ports[wIndex],
1486 wake_mask);
1487 temp = readl(ports[wIndex]->addr);
1488 xhci_dbg(xhci, "set port remote wake mask, actual port %d-%d status = 0x%x\n",
1489 hcd->self.busnum, wIndex + 1, temp);
1490 break;
1491 case USB_PORT_FEAT_BH_PORT_RESET:
1492 temp |= PORT_WR;
1493 writel(temp, ports[wIndex]->addr);
1494 temp = readl(ports[wIndex]->addr);
1495 break;
1496 case USB_PORT_FEAT_U1_TIMEOUT:
1497 if (hcd->speed < HCD_USB3)
1498 goto error;
1499 temp = readl(ports[wIndex]->addr + PORTPMSC);
1500 temp &= ~PORT_U1_TIMEOUT_MASK;
1501 temp |= PORT_U1_TIMEOUT(timeout);
1502 writel(temp, ports[wIndex]->addr + PORTPMSC);
1503 break;
1504 case USB_PORT_FEAT_U2_TIMEOUT:
1505 if (hcd->speed < HCD_USB3)
1506 goto error;
1507 temp = readl(ports[wIndex]->addr + PORTPMSC);
1508 temp &= ~PORT_U2_TIMEOUT_MASK;
1509 temp |= PORT_U2_TIMEOUT(timeout);
1510 writel(temp, ports[wIndex]->addr + PORTPMSC);
1511 break;
1512 case USB_PORT_FEAT_TEST:
1513 /* 4.19.6 Port Test Modes (USB2 Test Mode) */
1514 if (hcd->speed != HCD_USB2)
1515 goto error;
1516 if (test_mode > USB_TEST_FORCE_ENABLE ||
1517 test_mode < USB_TEST_J)
1518 goto error;
1519 retval = xhci_enter_test_mode(xhci, test_mode, wIndex,
1520 &flags);
1521 break;
1522 default:
1523 goto error;
1524 }
1525 /* unblock any posted writes */
1526 temp = readl(ports[wIndex]->addr);
1527 break;
1528 case ClearPortFeature:
1529 if (!wIndex || wIndex > max_ports)
1530 goto error;
1531 wIndex--;
1532 temp = readl(ports[wIndex]->addr);
1533 if (temp == ~(u32)0) {
1534 xhci_hc_died(xhci);
1535 retval = -ENODEV;
1536 break;
1537 }
1538 /* FIXME: What new port features do we need to support? */
1539 temp = xhci_port_state_to_neutral(temp);
1540 switch (wValue) {
1541 case USB_PORT_FEAT_SUSPEND:
1542 temp = readl(ports[wIndex]->addr);
1543 xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
1544 xhci_dbg(xhci, "PORTSC %04x\n", temp);
1545 if (temp & PORT_RESET)
1546 goto error;
1547 if ((temp & PORT_PLS_MASK) == XDEV_U3) {
1548 if ((temp & PORT_PE) == 0)
1549 goto error;
1550
1551 set_bit(wIndex, &bus_state->resuming_ports);
1552 usb_hcd_start_port_resume(&hcd->self, wIndex);
1553 xhci_set_link_state(xhci, ports[wIndex],
1554 XDEV_RESUME);
1555 spin_unlock_irqrestore(&xhci->lock, flags);
1556 msleep(USB_RESUME_TIMEOUT);
1557 spin_lock_irqsave(&xhci->lock, flags);
1558 xhci_set_link_state(xhci, ports[wIndex],
1559 XDEV_U0);
1560 clear_bit(wIndex, &bus_state->resuming_ports);
1561 usb_hcd_end_port_resume(&hcd->self, wIndex);
1562 }
1563 bus_state->port_c_suspend |= 1 << wIndex;
1564
1565 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1566 wIndex + 1);
1567 if (!slot_id) {
1568 xhci_dbg(xhci, "slot_id is zero\n");
1569 goto error;
1570 }
1571 xhci_ring_device(xhci, slot_id);
1572 break;
1573 case USB_PORT_FEAT_C_SUSPEND:
1574 bus_state->port_c_suspend &= ~(1 << wIndex);
1575 fallthrough;
1576 case USB_PORT_FEAT_C_RESET:
1577 case USB_PORT_FEAT_C_BH_PORT_RESET:
1578 case USB_PORT_FEAT_C_CONNECTION:
1579 case USB_PORT_FEAT_C_OVER_CURRENT:
1580 case USB_PORT_FEAT_C_ENABLE:
1581 case USB_PORT_FEAT_C_PORT_LINK_STATE:
1582 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
1583 xhci_clear_port_change_bit(xhci, wValue, wIndex,
1584 ports[wIndex]->addr, temp);
1585 break;
1586 case USB_PORT_FEAT_ENABLE:
1587 xhci_disable_port(hcd, xhci, wIndex,
1588 ports[wIndex]->addr, temp);
1589 break;
1590 case USB_PORT_FEAT_POWER:
1591 xhci_set_port_power(xhci, hcd, wIndex, false, &flags);
1592 break;
1593 case USB_PORT_FEAT_TEST:
1594 retval = xhci_exit_test_mode(xhci);
1595 break;
1596 default:
1597 goto error;
1598 }
1599 break;
1600 default:
1601 error:
1602 /* "stall" on error */
1603 retval = -EPIPE;
1604 }
1605 spin_unlock_irqrestore(&xhci->lock, flags);
1606 return retval;
1607 }
1608
1609 /*
1610 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
1611 * Ports are 0-indexed from the HCD point of view,
1612 * and 1-indexed from the USB core pointer of view.
1613 *
1614 * Note that the status change bits will be cleared as soon as a port status
1615 * change event is generated, so we use the saved status from that event.
1616 */
xhci_hub_status_data(struct usb_hcd * hcd,char * buf)1617 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
1618 {
1619 unsigned long flags;
1620 u32 temp, status;
1621 u32 mask;
1622 int i, retval;
1623 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1624 int max_ports;
1625 struct xhci_bus_state *bus_state;
1626 bool reset_change = false;
1627 struct xhci_hub *rhub;
1628 struct xhci_port **ports;
1629
1630 rhub = xhci_get_rhub(hcd);
1631 ports = rhub->ports;
1632 max_ports = rhub->num_ports;
1633 bus_state = &rhub->bus_state;
1634
1635 /* Initial status is no changes */
1636 retval = (max_ports + 8) / 8;
1637 memset(buf, 0, retval);
1638
1639 /*
1640 * Inform the usbcore about resume-in-progress by returning
1641 * a non-zero value even if there are no status changes.
1642 */
1643 spin_lock_irqsave(&xhci->lock, flags);
1644
1645 status = bus_state->resuming_ports;
1646
1647 mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;
1648
1649 /* For each port, did anything change? If so, set that bit in buf. */
1650 for (i = 0; i < max_ports; i++) {
1651 temp = readl(ports[i]->addr);
1652 if (temp == ~(u32)0) {
1653 xhci_hc_died(xhci);
1654 retval = -ENODEV;
1655 break;
1656 }
1657 trace_xhci_hub_status_data(i, temp);
1658
1659 if ((temp & mask) != 0 ||
1660 (bus_state->port_c_suspend & 1 << i) ||
1661 (bus_state->resume_done[i] && time_after_eq(
1662 jiffies, bus_state->resume_done[i]))) {
1663 buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
1664 status = 1;
1665 }
1666 if ((temp & PORT_RC))
1667 reset_change = true;
1668 if (temp & PORT_OC)
1669 status = 1;
1670 }
1671 if (!status && !reset_change) {
1672 xhci_dbg(xhci, "%s: stopping usb%d port polling\n",
1673 __func__, hcd->self.busnum);
1674 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1675 }
1676 spin_unlock_irqrestore(&xhci->lock, flags);
1677 return status ? retval : 0;
1678 }
1679
1680 #ifdef CONFIG_PM
1681
xhci_bus_suspend(struct usb_hcd * hcd)1682 int xhci_bus_suspend(struct usb_hcd *hcd)
1683 {
1684 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1685 int max_ports, port_index;
1686 struct xhci_bus_state *bus_state;
1687 unsigned long flags;
1688 struct xhci_hub *rhub;
1689 struct xhci_port **ports;
1690 u32 portsc_buf[USB_MAXCHILDREN];
1691 bool wake_enabled;
1692
1693 rhub = xhci_get_rhub(hcd);
1694 ports = rhub->ports;
1695 max_ports = rhub->num_ports;
1696 bus_state = &rhub->bus_state;
1697 wake_enabled = hcd->self.root_hub->do_remote_wakeup;
1698
1699 spin_lock_irqsave(&xhci->lock, flags);
1700
1701 if (wake_enabled) {
1702 if (bus_state->resuming_ports || /* USB2 */
1703 bus_state->port_remote_wakeup) { /* USB3 */
1704 spin_unlock_irqrestore(&xhci->lock, flags);
1705 xhci_dbg(xhci, "usb%d bus suspend to fail because a port is resuming\n",
1706 hcd->self.busnum);
1707 return -EBUSY;
1708 }
1709 }
1710 /*
1711 * Prepare ports for suspend, but don't write anything before all ports
1712 * are checked and we know bus suspend can proceed
1713 */
1714 bus_state->bus_suspended = 0;
1715 port_index = max_ports;
1716 while (port_index--) {
1717 u32 t1, t2;
1718 int retries = 10;
1719 retry:
1720 t1 = readl(ports[port_index]->addr);
1721 t2 = xhci_port_state_to_neutral(t1);
1722 portsc_buf[port_index] = 0;
1723
1724 /*
1725 * Give a USB3 port in link training time to finish, but don't
1726 * prevent suspend as port might be stuck
1727 */
1728 if ((hcd->speed >= HCD_USB3) && retries-- &&
1729 (t1 & PORT_PLS_MASK) == XDEV_POLLING) {
1730 spin_unlock_irqrestore(&xhci->lock, flags);
1731 msleep(XHCI_PORT_POLLING_LFPS_TIME);
1732 spin_lock_irqsave(&xhci->lock, flags);
1733 xhci_dbg(xhci, "port %d-%d polling in bus suspend, waiting\n",
1734 hcd->self.busnum, port_index + 1);
1735 goto retry;
1736 }
1737 /* bail out if port detected a over-current condition */
1738 if (t1 & PORT_OC) {
1739 bus_state->bus_suspended = 0;
1740 spin_unlock_irqrestore(&xhci->lock, flags);
1741 xhci_dbg(xhci, "Bus suspend bailout, port over-current detected\n");
1742 return -EBUSY;
1743 }
1744 /* suspend ports in U0, or bail out for new connect changes */
1745 if ((t1 & PORT_PE) && (t1 & PORT_PLS_MASK) == XDEV_U0) {
1746 if ((t1 & PORT_CSC) && wake_enabled) {
1747 bus_state->bus_suspended = 0;
1748 spin_unlock_irqrestore(&xhci->lock, flags);
1749 xhci_dbg(xhci, "Bus suspend bailout, port connect change\n");
1750 return -EBUSY;
1751 }
1752 xhci_dbg(xhci, "port %d-%d not suspended\n",
1753 hcd->self.busnum, port_index + 1);
1754 t2 &= ~PORT_PLS_MASK;
1755 t2 |= PORT_LINK_STROBE | XDEV_U3;
1756 set_bit(port_index, &bus_state->bus_suspended);
1757 }
1758 /* USB core sets remote wake mask for USB 3.0 hubs,
1759 * including the USB 3.0 roothub, but only if CONFIG_PM
1760 * is enabled, so also enable remote wake here.
1761 */
1762 if (wake_enabled) {
1763 if (t1 & PORT_CONNECT) {
1764 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
1765 t2 &= ~PORT_WKCONN_E;
1766 } else {
1767 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
1768 t2 &= ~PORT_WKDISC_E;
1769 }
1770
1771 if ((xhci->quirks & XHCI_U2_DISABLE_WAKE) &&
1772 (hcd->speed < HCD_USB3)) {
1773 if (usb_amd_pt_check_port(hcd->self.controller,
1774 port_index))
1775 t2 &= ~PORT_WAKE_BITS;
1776 }
1777 } else
1778 t2 &= ~PORT_WAKE_BITS;
1779
1780 t1 = xhci_port_state_to_neutral(t1);
1781 if (t1 != t2)
1782 portsc_buf[port_index] = t2;
1783 }
1784
1785 /* write port settings, stopping and suspending ports if needed */
1786 port_index = max_ports;
1787 while (port_index--) {
1788 if (!portsc_buf[port_index])
1789 continue;
1790 if (test_bit(port_index, &bus_state->bus_suspended)) {
1791 int slot_id;
1792
1793 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1794 port_index + 1);
1795 if (slot_id) {
1796 spin_unlock_irqrestore(&xhci->lock, flags);
1797 xhci_stop_device(xhci, slot_id, 1);
1798 spin_lock_irqsave(&xhci->lock, flags);
1799 }
1800 }
1801 writel(portsc_buf[port_index], ports[port_index]->addr);
1802 }
1803 hcd->state = HC_STATE_SUSPENDED;
1804 bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
1805 spin_unlock_irqrestore(&xhci->lock, flags);
1806
1807 if (bus_state->bus_suspended)
1808 usleep_range(5000, 10000);
1809
1810 return 0;
1811 }
1812
1813 /*
1814 * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
1815 * warm reset a USB3 device stuck in polling or compliance mode after resume.
1816 * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
1817 */
xhci_port_missing_cas_quirk(struct xhci_port * port)1818 static bool xhci_port_missing_cas_quirk(struct xhci_port *port)
1819 {
1820 u32 portsc;
1821
1822 portsc = readl(port->addr);
1823
1824 /* if any of these are set we are not stuck */
1825 if (portsc & (PORT_CONNECT | PORT_CAS))
1826 return false;
1827
1828 if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
1829 ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
1830 return false;
1831
1832 /* clear wakeup/change bits, and do a warm port reset */
1833 portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1834 portsc |= PORT_WR;
1835 writel(portsc, port->addr);
1836 /* flush write */
1837 readl(port->addr);
1838 return true;
1839 }
1840
xhci_bus_resume(struct usb_hcd * hcd)1841 int xhci_bus_resume(struct usb_hcd *hcd)
1842 {
1843 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1844 struct xhci_bus_state *bus_state;
1845 unsigned long flags;
1846 int max_ports, port_index;
1847 int slot_id;
1848 int sret;
1849 u32 next_state;
1850 u32 temp, portsc;
1851 struct xhci_hub *rhub;
1852 struct xhci_port **ports;
1853
1854 rhub = xhci_get_rhub(hcd);
1855 ports = rhub->ports;
1856 max_ports = rhub->num_ports;
1857 bus_state = &rhub->bus_state;
1858
1859 if (time_before(jiffies, bus_state->next_statechange))
1860 msleep(5);
1861
1862 spin_lock_irqsave(&xhci->lock, flags);
1863 if (!HCD_HW_ACCESSIBLE(hcd)) {
1864 spin_unlock_irqrestore(&xhci->lock, flags);
1865 return -ESHUTDOWN;
1866 }
1867
1868 /* delay the irqs */
1869 temp = readl(&xhci->op_regs->command);
1870 temp &= ~CMD_EIE;
1871 writel(temp, &xhci->op_regs->command);
1872
1873 /* bus specific resume for ports we suspended at bus_suspend */
1874 if (hcd->speed >= HCD_USB3)
1875 next_state = XDEV_U0;
1876 else
1877 next_state = XDEV_RESUME;
1878
1879 port_index = max_ports;
1880 while (port_index--) {
1881 portsc = readl(ports[port_index]->addr);
1882
1883 /* warm reset CAS limited ports stuck in polling/compliance */
1884 if ((xhci->quirks & XHCI_MISSING_CAS) &&
1885 (hcd->speed >= HCD_USB3) &&
1886 xhci_port_missing_cas_quirk(ports[port_index])) {
1887 xhci_dbg(xhci, "reset stuck port %d-%d\n",
1888 hcd->self.busnum, port_index + 1);
1889 clear_bit(port_index, &bus_state->bus_suspended);
1890 continue;
1891 }
1892 /* resume if we suspended the link, and it is still suspended */
1893 if (test_bit(port_index, &bus_state->bus_suspended))
1894 switch (portsc & PORT_PLS_MASK) {
1895 case XDEV_U3:
1896 portsc = xhci_port_state_to_neutral(portsc);
1897 portsc &= ~PORT_PLS_MASK;
1898 portsc |= PORT_LINK_STROBE | next_state;
1899 break;
1900 case XDEV_RESUME:
1901 /* resume already initiated */
1902 break;
1903 default:
1904 /* not in a resumeable state, ignore it */
1905 clear_bit(port_index,
1906 &bus_state->bus_suspended);
1907 break;
1908 }
1909 /* disable wake for all ports, write new link state if needed */
1910 portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1911 writel(portsc, ports[port_index]->addr);
1912 }
1913
1914 /* USB2 specific resume signaling delay and U0 link state transition */
1915 if (hcd->speed < HCD_USB3) {
1916 if (bus_state->bus_suspended) {
1917 spin_unlock_irqrestore(&xhci->lock, flags);
1918 msleep(USB_RESUME_TIMEOUT);
1919 spin_lock_irqsave(&xhci->lock, flags);
1920 }
1921 for_each_set_bit(port_index, &bus_state->bus_suspended,
1922 BITS_PER_LONG) {
1923 /* Clear PLC to poll it later for U0 transition */
1924 xhci_test_and_clear_bit(xhci, ports[port_index],
1925 PORT_PLC);
1926 xhci_set_link_state(xhci, ports[port_index], XDEV_U0);
1927 }
1928 }
1929
1930 /* poll for U0 link state complete, both USB2 and USB3 */
1931 for_each_set_bit(port_index, &bus_state->bus_suspended, BITS_PER_LONG) {
1932 sret = xhci_handshake(ports[port_index]->addr, PORT_PLC,
1933 PORT_PLC, 10 * 1000);
1934 if (sret) {
1935 xhci_warn(xhci, "port %d-%d resume PLC timeout\n",
1936 hcd->self.busnum, port_index + 1);
1937 continue;
1938 }
1939 xhci_test_and_clear_bit(xhci, ports[port_index], PORT_PLC);
1940 slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
1941 if (slot_id)
1942 xhci_ring_device(xhci, slot_id);
1943 }
1944 (void) readl(&xhci->op_regs->command);
1945
1946 bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
1947 /* re-enable irqs */
1948 temp = readl(&xhci->op_regs->command);
1949 temp |= CMD_EIE;
1950 writel(temp, &xhci->op_regs->command);
1951 temp = readl(&xhci->op_regs->command);
1952
1953 spin_unlock_irqrestore(&xhci->lock, flags);
1954 return 0;
1955 }
1956
xhci_get_resuming_ports(struct usb_hcd * hcd)1957 unsigned long xhci_get_resuming_ports(struct usb_hcd *hcd)
1958 {
1959 struct xhci_hub *rhub = xhci_get_rhub(hcd);
1960
1961 /* USB3 port wakeups are reported via usb_wakeup_notification() */
1962 return rhub->bus_state.resuming_ports; /* USB2 ports only */
1963 }
1964
1965 #endif /* CONFIG_PM */
1966