2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <linux/slab.h>
25 #include <asm/unaligned.h>
28 #include "xhci-trace.h"
30 #define PORT_WAKE_BITS (PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E)
31 #define PORT_RWC_BITS (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
32 PORT_RC | PORT_PLC | PORT_PE)
34 /* USB 3 BOS descriptor and a capability descriptors, combined.
35 * Fields will be adjusted and added later in xhci_create_usb3_bos_desc()
37 static u8 usb_bos_descriptor [] = {
38 USB_DT_BOS_SIZE, /* __u8 bLength, 5 bytes */
39 USB_DT_BOS, /* __u8 bDescriptorType */
40 0x0F, 0x00, /* __le16 wTotalLength, 15 bytes */
41 0x1, /* __u8 bNumDeviceCaps */
42 /* First device capability, SuperSpeed */
43 USB_DT_USB_SS_CAP_SIZE, /* __u8 bLength, 10 bytes */
44 USB_DT_DEVICE_CAPABILITY, /* Device Capability */
45 USB_SS_CAP_TYPE, /* bDevCapabilityType, SUPERSPEED_USB */
46 0x00, /* bmAttributes, LTM off by default */
47 USB_5GBPS_OPERATION, 0x00, /* wSpeedsSupported, 5Gbps only */
48 0x03, /* bFunctionalitySupport,
50 0x00, /* bU1DevExitLat, set later. */
51 0x00, 0x00, /* __le16 bU2DevExitLat, set later. */
52 /* Second device capability, SuperSpeedPlus */
53 0x1c, /* bLength 28, will be adjusted later */
54 USB_DT_DEVICE_CAPABILITY, /* Device Capability */
55 USB_SSP_CAP_TYPE, /* bDevCapabilityType SUPERSPEED_PLUS */
56 0x00, /* bReserved 0 */
57 0x23, 0x00, 0x00, 0x00, /* bmAttributes, SSAC=3 SSIC=1 */
58 0x01, 0x00, /* wFunctionalitySupport */
59 0x00, 0x00, /* wReserved 0 */
60 /* Default Sublink Speed Attributes, overwrite if custom PSI exists */
61 0x34, 0x00, 0x05, 0x00, /* 5Gbps, symmetric, rx, ID = 4 */
62 0xb4, 0x00, 0x05, 0x00, /* 5Gbps, symmetric, tx, ID = 4 */
63 0x35, 0x40, 0x0a, 0x00, /* 10Gbps, SSP, symmetric, rx, ID = 5 */
64 0xb5, 0x40, 0x0a, 0x00, /* 10Gbps, SSP, symmetric, tx, ID = 5 */
67 static int xhci_create_usb3_bos_desc(struct xhci_hcd *xhci, char *buf,
72 u16 desc_size, ssp_cap_size, ssa_size = 0;
75 desc_size = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
76 ssp_cap_size = sizeof(usb_bos_descriptor) - desc_size;
78 /* does xhci support USB 3.1 Enhanced SuperSpeed */
79 if (xhci->usb3_rhub.min_rev >= 0x01) {
80 /* does xhci provide a PSI table for SSA speed attributes? */
81 if (xhci->usb3_rhub.psi_count) {
82 /* two SSA entries for each unique PSI ID, RX and TX */
83 ssa_count = xhci->usb3_rhub.psi_uid_count * 2;
84 ssa_size = ssa_count * sizeof(u32);
85 ssp_cap_size -= 16; /* skip copying the default SSA */
87 desc_size += ssp_cap_size;
90 memcpy(buf, &usb_bos_descriptor, min(desc_size, wLength));
93 /* modify bos descriptor bNumDeviceCaps and wTotalLength */
95 put_unaligned_le16(desc_size + ssa_size, &buf[2]);
98 if (wLength < USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE)
101 /* Indicate whether the host has LTM support. */
102 temp = readl(&xhci->cap_regs->hcc_params);
104 buf[8] |= USB_LTM_SUPPORT;
106 /* Set the U1 and U2 exit latencies. */
107 if ((xhci->quirks & XHCI_LPM_SUPPORT)) {
108 temp = readl(&xhci->cap_regs->hcs_params3);
109 buf[12] = HCS_U1_LATENCY(temp);
110 put_unaligned_le16(HCS_U2_LATENCY(temp), &buf[13]);
113 /* If PSI table exists, add the custom speed attributes from it */
114 if (usb3_1 && xhci->usb3_rhub.psi_count) {
115 u32 ssp_cap_base, bm_attrib, psi;
118 ssp_cap_base = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
120 if (wLength < desc_size)
122 buf[ssp_cap_base] = ssp_cap_size + ssa_size;
124 /* attribute count SSAC bits 4:0 and ID count SSIC bits 8:5 */
125 bm_attrib = (ssa_count - 1) & 0x1f;
126 bm_attrib |= (xhci->usb3_rhub.psi_uid_count - 1) << 5;
127 put_unaligned_le32(bm_attrib, &buf[ssp_cap_base + 4]);
129 if (wLength < desc_size + ssa_size)
132 * Create the Sublink Speed Attributes (SSA) array.
133 * The xhci PSI field and USB 3.1 SSA fields are very similar,
134 * but link type bits 7:6 differ for values 01b and 10b.
135 * xhci has also only one PSI entry for a symmetric link when
136 * USB 3.1 requires two SSA entries (RX and TX) for every link
139 for (i = 0; i < xhci->usb3_rhub.psi_count; i++) {
140 psi = xhci->usb3_rhub.psi[i];
141 psi &= ~USB_SSP_SUBLINK_SPEED_RSVD;
142 if ((psi & PLT_MASK) == PLT_SYM) {
143 /* Symmetric, create SSA RX and TX from one PSI entry */
144 put_unaligned_le32(psi, &buf[offset]);
145 psi |= 1 << 7; /* turn entry to TX */
147 if (offset >= desc_size + ssa_size)
148 return desc_size + ssa_size;
149 } else if ((psi & PLT_MASK) == PLT_ASYM_RX) {
150 /* Asymetric RX, flip bits 7:6 for SSA */
153 put_unaligned_le32(psi, &buf[offset]);
155 if (offset >= desc_size + ssa_size)
156 return desc_size + ssa_size;
159 /* ssa_size is 0 for other than usb 3.1 hosts */
160 return desc_size + ssa_size;
163 static void xhci_common_hub_descriptor(struct xhci_hcd *xhci,
164 struct usb_hub_descriptor *desc, int ports)
168 desc->bPwrOn2PwrGood = 10; /* xhci section 5.4.9 says 20ms max */
169 desc->bHubContrCurrent = 0;
171 desc->bNbrPorts = ports;
173 /* Bits 1:0 - support per-port power switching, or power always on */
174 if (HCC_PPC(xhci->hcc_params))
175 temp |= HUB_CHAR_INDV_PORT_LPSM;
177 temp |= HUB_CHAR_NO_LPSM;
178 /* Bit 2 - root hubs are not part of a compound device */
179 /* Bits 4:3 - individual port over current protection */
180 temp |= HUB_CHAR_INDV_PORT_OCPM;
181 /* Bits 6:5 - no TTs in root ports */
182 /* Bit 7 - no port indicators */
183 desc->wHubCharacteristics = cpu_to_le16(temp);
186 /* Fill in the USB 2.0 roothub descriptor */
187 static void xhci_usb2_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
188 struct usb_hub_descriptor *desc)
192 __u8 port_removable[(USB_MAXCHILDREN + 1 + 7) / 8];
196 ports = xhci->num_usb2_ports;
198 xhci_common_hub_descriptor(xhci, desc, ports);
199 desc->bDescriptorType = USB_DT_HUB;
200 temp = 1 + (ports / 8);
201 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * temp;
203 /* The Device Removable bits are reported on a byte granularity.
204 * If the port doesn't exist within that byte, the bit is set to 0.
206 memset(port_removable, 0, sizeof(port_removable));
207 for (i = 0; i < ports; i++) {
208 portsc = readl(xhci->usb2_ports[i]);
209 /* If a device is removable, PORTSC reports a 0, same as in the
210 * hub descriptor DeviceRemovable bits.
212 if (portsc & PORT_DEV_REMOVE)
213 /* This math is hairy because bit 0 of DeviceRemovable
214 * is reserved, and bit 1 is for port 1, etc.
216 port_removable[(i + 1) / 8] |= 1 << ((i + 1) % 8);
219 /* ch11.h defines a hub descriptor that has room for USB_MAXCHILDREN
220 * ports on it. The USB 2.0 specification says that there are two
221 * variable length fields at the end of the hub descriptor:
222 * DeviceRemovable and PortPwrCtrlMask. But since we can have less than
223 * USB_MAXCHILDREN ports, we may need to use the DeviceRemovable array
224 * to set PortPwrCtrlMask bits. PortPwrCtrlMask must always be set to
225 * 0xFF, so we initialize the both arrays (DeviceRemovable and
226 * PortPwrCtrlMask) to 0xFF. Then we set the DeviceRemovable for each
227 * set of ports that actually exist.
229 memset(desc->u.hs.DeviceRemovable, 0xff,
230 sizeof(desc->u.hs.DeviceRemovable));
231 memset(desc->u.hs.PortPwrCtrlMask, 0xff,
232 sizeof(desc->u.hs.PortPwrCtrlMask));
234 for (i = 0; i < (ports + 1 + 7) / 8; i++)
235 memset(&desc->u.hs.DeviceRemovable[i], port_removable[i],
239 /* Fill in the USB 3.0 roothub descriptor */
240 static void xhci_usb3_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
241 struct usb_hub_descriptor *desc)
248 ports = xhci->num_usb3_ports;
249 xhci_common_hub_descriptor(xhci, desc, ports);
250 desc->bDescriptorType = USB_DT_SS_HUB;
251 desc->bDescLength = USB_DT_SS_HUB_SIZE;
253 /* header decode latency should be zero for roothubs,
254 * see section 4.23.5.2.
256 desc->u.ss.bHubHdrDecLat = 0;
257 desc->u.ss.wHubDelay = 0;
260 /* bit 0 is reserved, bit 1 is for port 1, etc. */
261 for (i = 0; i < ports; i++) {
262 portsc = readl(xhci->usb3_ports[i]);
263 if (portsc & PORT_DEV_REMOVE)
264 port_removable |= 1 << (i + 1);
267 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
270 static void xhci_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
271 struct usb_hub_descriptor *desc)
274 if (hcd->speed >= HCD_USB3)
275 xhci_usb3_hub_descriptor(hcd, xhci, desc);
277 xhci_usb2_hub_descriptor(hcd, xhci, desc);
281 static unsigned int xhci_port_speed(unsigned int port_status)
283 if (DEV_LOWSPEED(port_status))
284 return USB_PORT_STAT_LOW_SPEED;
285 if (DEV_HIGHSPEED(port_status))
286 return USB_PORT_STAT_HIGH_SPEED;
288 * FIXME: Yes, we should check for full speed, but the core uses that as
289 * a default in portspeed() in usb/core/hub.c (which is the only place
290 * USB_PORT_STAT_*_SPEED is used).
296 * These bits are Read Only (RO) and should be saved and written to the
297 * registers: 0, 3, 10:13, 30
298 * connect status, over-current status, port speed, and device removable.
299 * connect status and port speed are also sticky - meaning they're in
300 * the AUX well and they aren't changed by a hot, warm, or cold reset.
302 #define XHCI_PORT_RO ((1<<0) | (1<<3) | (0xf<<10) | (1<<30))
304 * These bits are RW; writing a 0 clears the bit, writing a 1 sets the bit:
305 * bits 5:8, 9, 14:15, 25:27
306 * link state, port power, port indicator state, "wake on" enable state
308 #define XHCI_PORT_RWS ((0xf<<5) | (1<<9) | (0x3<<14) | (0x7<<25))
310 * These bits are RW; writing a 1 sets the bit, writing a 0 has no effect:
313 #define XHCI_PORT_RW1S ((1<<4))
315 * These bits are RW; writing a 1 clears the bit, writing a 0 has no effect:
316 * bits 1, 17, 18, 19, 20, 21, 22, 23
317 * port enable/disable, and
318 * change bits: connect, PED, warm port reset changed (reserved zero for USB 2.0 ports),
319 * over-current, reset, link state, and L1 change
321 #define XHCI_PORT_RW1CS ((1<<1) | (0x7f<<17))
323 * Bit 16 is RW, and writing a '1' to it causes the link state control to be
326 #define XHCI_PORT_RW ((1<<16))
328 * These bits are Reserved Zero (RsvdZ) and zero should be written to them:
331 #define XHCI_PORT_RZ ((1<<2) | (1<<24) | (0xf<<28))
334 * Given a port state, this function returns a value that would result in the
335 * port being in the same state, if the value was written to the port status
337 * Save Read Only (RO) bits and save read/write bits where
338 * writing a 0 clears the bit and writing a 1 sets the bit (RWS).
339 * For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect.
341 u32 xhci_port_state_to_neutral(u32 state)
343 /* Save read-only status and port state */
344 return (state & XHCI_PORT_RO) | (state & XHCI_PORT_RWS);
348 * find slot id based on port number.
349 * @port: The one-based port number from one of the two split roothubs.
351 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
356 enum usb_device_speed speed;
359 for (i = 0; i < MAX_HC_SLOTS; i++) {
362 speed = xhci->devs[i]->udev->speed;
363 if (((speed >= USB_SPEED_SUPER) == (hcd->speed >= HCD_USB3))
364 && xhci->devs[i]->fake_port == port) {
375 * It issues stop endpoint command for EP 0 to 30. And wait the last command
377 * suspend will set to 1, if suspend bit need to set in command.
379 static int xhci_stop_device(struct xhci_hcd *xhci, int slot_id, int suspend)
381 struct xhci_virt_device *virt_dev;
382 struct xhci_command *cmd;
388 virt_dev = xhci->devs[slot_id];
392 trace_xhci_stop_device(virt_dev);
394 cmd = xhci_alloc_command(xhci, false, true, GFP_NOIO);
398 spin_lock_irqsave(&xhci->lock, flags);
399 for (i = LAST_EP_INDEX; i > 0; i--) {
400 if (virt_dev->eps[i].ring && virt_dev->eps[i].ring->dequeue) {
401 struct xhci_ep_ctx *ep_ctx;
402 struct xhci_command *command;
404 ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->out_ctx, i);
406 /* Check ep is running, required by AMD SNPS 3.1 xHC */
407 if (GET_EP_CTX_STATE(ep_ctx) != EP_STATE_RUNNING)
410 command = xhci_alloc_command(xhci, false, false,
413 spin_unlock_irqrestore(&xhci->lock, flags);
414 xhci_free_command(xhci, cmd);
417 xhci_queue_stop_endpoint(xhci, command, slot_id, i,
421 xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
422 xhci_ring_cmd_db(xhci);
423 spin_unlock_irqrestore(&xhci->lock, flags);
425 /* Wait for last stop endpoint command to finish */
426 wait_for_completion(cmd->completion);
428 if (cmd->status == COMP_COMMAND_ABORTED ||
429 cmd->status == COMP_COMMAND_RING_STOPPED) {
430 xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
433 xhci_free_command(xhci, cmd);
438 * Ring device, it rings the all doorbells unconditionally.
440 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
443 struct xhci_virt_ep *ep;
445 for (i = 0; i < LAST_EP_INDEX + 1; i++) {
446 ep = &xhci->devs[slot_id]->eps[i];
448 if (ep->ep_state & EP_HAS_STREAMS) {
449 for (s = 1; s < ep->stream_info->num_streams; s++)
450 xhci_ring_ep_doorbell(xhci, slot_id, i, s);
451 } else if (ep->ring && ep->ring->dequeue) {
452 xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
459 static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
460 u16 wIndex, __le32 __iomem *addr, u32 port_status)
462 /* Don't allow the USB core to disable SuperSpeed ports. */
463 if (hcd->speed >= HCD_USB3) {
464 xhci_dbg(xhci, "Ignoring request to disable "
465 "SuperSpeed port.\n");
469 if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
471 "Broken Port Enabled/Disabled, ignoring port disable request.\n");
475 /* Write 1 to disable the port */
476 writel(port_status | PORT_PE, addr);
477 port_status = readl(addr);
478 xhci_dbg(xhci, "disable port, actual port %d status = 0x%x\n",
479 wIndex, port_status);
482 static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
483 u16 wIndex, __le32 __iomem *addr, u32 port_status)
485 char *port_change_bit;
489 case USB_PORT_FEAT_C_RESET:
491 port_change_bit = "reset";
493 case USB_PORT_FEAT_C_BH_PORT_RESET:
495 port_change_bit = "warm(BH) reset";
497 case USB_PORT_FEAT_C_CONNECTION:
499 port_change_bit = "connect";
501 case USB_PORT_FEAT_C_OVER_CURRENT:
503 port_change_bit = "over-current";
505 case USB_PORT_FEAT_C_ENABLE:
507 port_change_bit = "enable/disable";
509 case USB_PORT_FEAT_C_SUSPEND:
511 port_change_bit = "suspend/resume";
513 case USB_PORT_FEAT_C_PORT_LINK_STATE:
515 port_change_bit = "link state";
517 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
519 port_change_bit = "config error";
522 /* Should never happen */
525 /* Change bits are all write 1 to clear */
526 writel(port_status | status, addr);
527 port_status = readl(addr);
528 xhci_dbg(xhci, "clear port %s change, actual port %d status = 0x%x\n",
529 port_change_bit, wIndex, port_status);
532 static int xhci_get_ports(struct usb_hcd *hcd, __le32 __iomem ***port_array)
535 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
537 if (hcd->speed >= HCD_USB3) {
538 max_ports = xhci->num_usb3_ports;
539 *port_array = xhci->usb3_ports;
541 max_ports = xhci->num_usb2_ports;
542 *port_array = xhci->usb2_ports;
548 static __le32 __iomem *xhci_get_port_io_addr(struct usb_hcd *hcd, int index)
550 __le32 __iomem **port_array;
552 xhci_get_ports(hcd, &port_array);
553 return port_array[index];
557 * xhci_set_port_power() must be called with xhci->lock held.
558 * It will release and re-aquire the lock while calling ACPI
561 static void xhci_set_port_power(struct xhci_hcd *xhci, struct usb_hcd *hcd,
562 u16 index, bool on, unsigned long *flags)
564 __le32 __iomem *addr;
567 addr = xhci_get_port_io_addr(hcd, index);
569 temp = xhci_port_state_to_neutral(temp);
572 writel(temp | PORT_POWER, addr);
574 xhci_dbg(xhci, "set port power, actual port %d status = 0x%x\n",
578 writel(temp & ~PORT_POWER, addr);
581 spin_unlock_irqrestore(&xhci->lock, *flags);
582 temp = usb_acpi_power_manageable(hcd->self.root_hub,
585 usb_acpi_set_power_state(hcd->self.root_hub,
587 spin_lock_irqsave(&xhci->lock, *flags);
590 static void xhci_port_set_test_mode(struct xhci_hcd *xhci,
591 u16 test_mode, u16 wIndex)
594 __le32 __iomem *addr;
596 /* xhci only supports test mode for usb2 ports, i.e. xhci->main_hcd */
597 addr = xhci_get_port_io_addr(xhci->main_hcd, wIndex);
598 temp = readl(addr + PORTPMSC);
599 temp |= test_mode << PORT_TEST_MODE_SHIFT;
600 writel(temp, addr + PORTPMSC);
601 xhci->test_mode = test_mode;
602 if (test_mode == TEST_FORCE_EN)
606 static int xhci_enter_test_mode(struct xhci_hcd *xhci,
607 u16 test_mode, u16 wIndex, unsigned long *flags)
611 /* Disable all Device Slots */
612 xhci_dbg(xhci, "Disable all slots\n");
613 for (i = 1; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
614 retval = xhci_disable_slot(xhci, NULL, i);
616 xhci_err(xhci, "Failed to disable slot %d, %d. Enter test mode anyway\n",
619 /* Put all ports to the Disable state by clear PP */
620 xhci_dbg(xhci, "Disable all port (PP = 0)\n");
621 /* Power off USB3 ports*/
622 for (i = 0; i < xhci->num_usb3_ports; i++)
623 xhci_set_port_power(xhci, xhci->shared_hcd, i, false, flags);
624 /* Power off USB2 ports*/
625 for (i = 0; i < xhci->num_usb2_ports; i++)
626 xhci_set_port_power(xhci, xhci->main_hcd, i, false, flags);
627 /* Stop the controller */
628 xhci_dbg(xhci, "Stop controller\n");
629 retval = xhci_halt(xhci);
632 /* Disable runtime PM for test mode */
633 pm_runtime_forbid(xhci_to_hcd(xhci)->self.controller);
634 /* Set PORTPMSC.PTC field to enter selected test mode */
635 /* Port is selected by wIndex. port_id = wIndex + 1 */
636 xhci_dbg(xhci, "Enter Test Mode: %d, Port_id=%d\n",
637 test_mode, wIndex + 1);
638 xhci_port_set_test_mode(xhci, test_mode, wIndex);
642 static int xhci_exit_test_mode(struct xhci_hcd *xhci)
646 if (!xhci->test_mode) {
647 xhci_err(xhci, "Not in test mode, do nothing.\n");
650 if (xhci->test_mode == TEST_FORCE_EN &&
651 !(xhci->xhc_state & XHCI_STATE_HALTED)) {
652 retval = xhci_halt(xhci);
656 pm_runtime_allow(xhci_to_hcd(xhci)->self.controller);
658 return xhci_reset(xhci);
661 void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
662 int port_id, u32 link_state)
666 temp = readl(port_array[port_id]);
667 temp = xhci_port_state_to_neutral(temp);
668 temp &= ~PORT_PLS_MASK;
669 temp |= PORT_LINK_STROBE | link_state;
670 writel(temp, port_array[port_id]);
673 static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
674 __le32 __iomem **port_array, int port_id, u16 wake_mask)
678 temp = readl(port_array[port_id]);
679 temp = xhci_port_state_to_neutral(temp);
681 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
682 temp |= PORT_WKCONN_E;
684 temp &= ~PORT_WKCONN_E;
686 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
687 temp |= PORT_WKDISC_E;
689 temp &= ~PORT_WKDISC_E;
691 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
694 temp &= ~PORT_WKOC_E;
696 writel(temp, port_array[port_id]);
699 /* Test and clear port RWC bit */
700 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
701 int port_id, u32 port_bit)
705 temp = readl(port_array[port_id]);
706 if (temp & port_bit) {
707 temp = xhci_port_state_to_neutral(temp);
709 writel(temp, port_array[port_id]);
713 /* Updates Link Status for USB 2.1 port */
714 static void xhci_hub_report_usb2_link_state(u32 *status, u32 status_reg)
716 if ((status_reg & PORT_PLS_MASK) == XDEV_U2)
717 *status |= USB_PORT_STAT_L1;
720 /* Updates Link Status for super Speed port */
721 static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
722 u32 *status, u32 status_reg)
724 u32 pls = status_reg & PORT_PLS_MASK;
726 /* resume state is a xHCI internal state.
727 * Do not report it to usb core, instead, pretend to be U3,
728 * thus usb core knows it's not ready for transfer
730 if (pls == XDEV_RESUME) {
731 *status |= USB_SS_PORT_LS_U3;
735 /* When the CAS bit is set then warm reset
736 * should be performed on port
738 if (status_reg & PORT_CAS) {
739 /* The CAS bit can be set while the port is
741 * Only roothubs have CAS bit, so we
742 * pretend to be in compliance mode
743 * unless we're already in compliance
744 * or the inactive state.
746 if (pls != USB_SS_PORT_LS_COMP_MOD &&
747 pls != USB_SS_PORT_LS_SS_INACTIVE) {
748 pls = USB_SS_PORT_LS_COMP_MOD;
750 /* Return also connection bit -
751 * hub state machine resets port
752 * when this bit is set.
754 pls |= USB_PORT_STAT_CONNECTION;
757 * If CAS bit isn't set but the Port is already at
758 * Compliance Mode, fake a connection so the USB core
759 * notices the Compliance state and resets the port.
760 * This resolves an issue generated by the SN65LVPE502CP
761 * in which sometimes the port enters compliance mode
762 * caused by a delay on the host-device negotiation.
764 if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
765 (pls == USB_SS_PORT_LS_COMP_MOD))
766 pls |= USB_PORT_STAT_CONNECTION;
769 /* update status field */
774 * Function for Compliance Mode Quirk.
776 * This Function verifies if all xhc USB3 ports have entered U0, if so,
777 * the compliance mode timer is deleted. A port won't enter
778 * compliance mode if it has previously entered U0.
780 static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
783 u32 all_ports_seen_u0 = ((1 << xhci->num_usb3_ports)-1);
784 bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);
786 if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
789 if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
790 xhci->port_status_u0 |= 1 << wIndex;
791 if (xhci->port_status_u0 == all_ports_seen_u0) {
792 del_timer_sync(&xhci->comp_mode_recovery_timer);
793 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
794 "All USB3 ports have entered U0 already!");
795 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
796 "Compliance Mode Recovery Timer Deleted.");
801 static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
806 /* only support rx and tx lane counts of 1 in usb3.1 spec */
807 speed_id = DEV_PORT_SPEED(raw_port_status);
808 ext_stat |= speed_id; /* bits 3:0, RX speed id */
809 ext_stat |= speed_id << 4; /* bits 7:4, TX speed id */
811 ext_stat |= PORT_RX_LANES(port_li) << 8; /* bits 11:8 Rx lane count */
812 ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */
818 * Converts a raw xHCI port status into the format that external USB 2.0 or USB
821 * Possible side effects:
822 * - Mark a port as being done with device resume,
823 * and ring the endpoint doorbells.
824 * - Stop the Synopsys redriver Compliance Mode polling.
825 * - Drop and reacquire the xHCI lock, in order to wait for port resume.
827 static u32 xhci_get_port_status(struct usb_hcd *hcd,
828 struct xhci_bus_state *bus_state,
829 __le32 __iomem **port_array,
830 u16 wIndex, u32 raw_port_status,
832 __releases(&xhci->lock)
833 __acquires(&xhci->lock)
835 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
839 /* wPortChange bits */
840 if (raw_port_status & PORT_CSC)
841 status |= USB_PORT_STAT_C_CONNECTION << 16;
842 if (raw_port_status & PORT_PEC)
843 status |= USB_PORT_STAT_C_ENABLE << 16;
844 if ((raw_port_status & PORT_OCC))
845 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
846 if ((raw_port_status & PORT_RC))
847 status |= USB_PORT_STAT_C_RESET << 16;
849 if (hcd->speed >= HCD_USB3) {
850 /* Port link change with port in resume state should not be
851 * reported to usbcore, as this is an internal state to be
852 * handled by xhci driver. Reporting PLC to usbcore may
853 * cause usbcore clearing PLC first and port change event
854 * irq won't be generated.
856 if ((raw_port_status & PORT_PLC) &&
857 (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME)
858 status |= USB_PORT_STAT_C_LINK_STATE << 16;
859 if ((raw_port_status & PORT_WRC))
860 status |= USB_PORT_STAT_C_BH_RESET << 16;
861 if ((raw_port_status & PORT_CEC))
862 status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;
865 if (hcd->speed < HCD_USB3) {
866 if ((raw_port_status & PORT_PLS_MASK) == XDEV_U3
867 && (raw_port_status & PORT_POWER))
868 status |= USB_PORT_STAT_SUSPEND;
870 if ((raw_port_status & PORT_PLS_MASK) == XDEV_RESUME &&
871 !DEV_SUPERSPEED_ANY(raw_port_status)) {
872 if ((raw_port_status & PORT_RESET) ||
873 !(raw_port_status & PORT_PE))
875 /* did port event handler already start resume timing? */
876 if (!bus_state->resume_done[wIndex]) {
877 /* If not, maybe we are in a host initated resume? */
878 if (test_bit(wIndex, &bus_state->resuming_ports)) {
879 /* Host initated resume doesn't time the resume
880 * signalling using resume_done[].
881 * It manually sets RESUME state, sleeps 20ms
882 * and sets U0 state. This should probably be
883 * changed, but not right now.
886 /* port resume was discovered now and here,
887 * start resume timing
889 unsigned long timeout = jiffies +
890 msecs_to_jiffies(USB_RESUME_TIMEOUT);
892 set_bit(wIndex, &bus_state->resuming_ports);
893 bus_state->resume_done[wIndex] = timeout;
894 mod_timer(&hcd->rh_timer, timeout);
896 /* Has resume been signalled for USB_RESUME_TIME yet? */
897 } else if (time_after_eq(jiffies,
898 bus_state->resume_done[wIndex])) {
901 xhci_dbg(xhci, "Resume USB2 port %d\n",
903 bus_state->resume_done[wIndex] = 0;
904 clear_bit(wIndex, &bus_state->resuming_ports);
906 set_bit(wIndex, &bus_state->rexit_ports);
908 xhci_test_and_clear_bit(xhci, port_array, wIndex,
910 xhci_set_link_state(xhci, port_array, wIndex,
913 spin_unlock_irqrestore(&xhci->lock, flags);
914 time_left = wait_for_completion_timeout(
915 &bus_state->rexit_done[wIndex],
917 XHCI_MAX_REXIT_TIMEOUT));
918 spin_lock_irqsave(&xhci->lock, flags);
921 slot_id = xhci_find_slot_id_by_port(hcd,
924 xhci_dbg(xhci, "slot_id is zero\n");
927 xhci_ring_device(xhci, slot_id);
929 int port_status = readl(port_array[wIndex]);
930 xhci_warn(xhci, "Port resume took longer than %i msec, port status = 0x%x\n",
931 XHCI_MAX_REXIT_TIMEOUT,
933 status |= USB_PORT_STAT_SUSPEND;
934 clear_bit(wIndex, &bus_state->rexit_ports);
937 bus_state->port_c_suspend |= 1 << wIndex;
938 bus_state->suspended_ports &= ~(1 << wIndex);
941 * The resume has been signaling for less than
942 * USB_RESUME_TIME. Report the port status as SUSPEND,
943 * let the usbcore check port status again and clear
944 * resume signaling later.
946 status |= USB_PORT_STAT_SUSPEND;
950 * Clear stale usb2 resume signalling variables in case port changed
951 * state during resume signalling. For example on error
953 if ((bus_state->resume_done[wIndex] ||
954 test_bit(wIndex, &bus_state->resuming_ports)) &&
955 (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
956 (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
957 bus_state->resume_done[wIndex] = 0;
958 clear_bit(wIndex, &bus_state->resuming_ports);
962 if ((raw_port_status & PORT_PLS_MASK) == XDEV_U0 &&
963 (raw_port_status & PORT_POWER)) {
964 if (bus_state->suspended_ports & (1 << wIndex)) {
965 bus_state->suspended_ports &= ~(1 << wIndex);
966 if (hcd->speed < HCD_USB3)
967 bus_state->port_c_suspend |= 1 << wIndex;
969 bus_state->resume_done[wIndex] = 0;
970 clear_bit(wIndex, &bus_state->resuming_ports);
972 if (raw_port_status & PORT_CONNECT) {
973 status |= USB_PORT_STAT_CONNECTION;
974 status |= xhci_port_speed(raw_port_status);
976 if (raw_port_status & PORT_PE)
977 status |= USB_PORT_STAT_ENABLE;
978 if (raw_port_status & PORT_OC)
979 status |= USB_PORT_STAT_OVERCURRENT;
980 if (raw_port_status & PORT_RESET)
981 status |= USB_PORT_STAT_RESET;
982 if (raw_port_status & PORT_POWER) {
983 if (hcd->speed >= HCD_USB3)
984 status |= USB_SS_PORT_STAT_POWER;
986 status |= USB_PORT_STAT_POWER;
988 /* Update Port Link State */
989 if (hcd->speed >= HCD_USB3) {
990 xhci_hub_report_usb3_link_state(xhci, &status, raw_port_status);
992 * Verify if all USB3 Ports Have entered U0 already.
993 * Delete Compliance Mode Timer if so.
995 xhci_del_comp_mod_timer(xhci, raw_port_status, wIndex);
997 xhci_hub_report_usb2_link_state(&status, raw_port_status);
999 if (bus_state->port_c_suspend & (1 << wIndex))
1000 status |= USB_PORT_STAT_C_SUSPEND << 16;
1005 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
1006 u16 wIndex, char *buf, u16 wLength)
1008 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1010 unsigned long flags;
1013 __le32 __iomem **port_array;
1015 struct xhci_bus_state *bus_state;
1021 max_ports = xhci_get_ports(hcd, &port_array);
1022 bus_state = &xhci->bus_state[hcd_index(hcd)];
1024 spin_lock_irqsave(&xhci->lock, flags);
1027 /* No power source, over-current reported per port */
1030 case GetHubDescriptor:
1031 /* Check to make sure userspace is asking for the USB 3.0 hub
1032 * descriptor for the USB 3.0 roothub. If not, we stall the
1033 * endpoint, like external hubs do.
1035 if (hcd->speed >= HCD_USB3 &&
1036 (wLength < USB_DT_SS_HUB_SIZE ||
1037 wValue != (USB_DT_SS_HUB << 8))) {
1038 xhci_dbg(xhci, "Wrong hub descriptor type for "
1039 "USB 3.0 roothub.\n");
1042 xhci_hub_descriptor(hcd, xhci,
1043 (struct usb_hub_descriptor *) buf);
1045 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
1046 if ((wValue & 0xff00) != (USB_DT_BOS << 8))
1049 if (hcd->speed < HCD_USB3)
1052 retval = xhci_create_usb3_bos_desc(xhci, buf, wLength);
1053 spin_unlock_irqrestore(&xhci->lock, flags);
1056 if (!wIndex || wIndex > max_ports)
1059 temp = readl(port_array[wIndex]);
1060 if (temp == ~(u32)0) {
1065 status = xhci_get_port_status(hcd, bus_state, port_array,
1066 wIndex, temp, flags);
1067 if (status == 0xffffffff)
1070 xhci_dbg(xhci, "get port status, actual port %d status = 0x%x\n",
1072 xhci_dbg(xhci, "Get port status returned 0x%x\n", status);
1074 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
1075 /* if USB 3.1 extended port status return additional 4 bytes */
1076 if (wValue == 0x02) {
1079 if (hcd->speed < HCD_USB31 || wLength != 8) {
1080 xhci_err(xhci, "get ext port status invalid parameter\n");
1084 port_li = readl(port_array[wIndex] + PORTLI);
1085 status = xhci_get_ext_port_status(temp, port_li);
1086 put_unaligned_le32(cpu_to_le32(status), &buf[4]);
1089 case SetPortFeature:
1090 if (wValue == USB_PORT_FEAT_LINK_STATE)
1091 link_state = (wIndex & 0xff00) >> 3;
1092 if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
1093 wake_mask = wIndex & 0xff00;
1094 if (wValue == USB_PORT_FEAT_TEST)
1095 test_mode = (wIndex & 0xff00) >> 8;
1096 /* The MSB of wIndex is the U1/U2 timeout */
1097 timeout = (wIndex & 0xff00) >> 8;
1099 if (!wIndex || wIndex > max_ports)
1102 temp = readl(port_array[wIndex]);
1103 if (temp == ~(u32)0) {
1108 temp = xhci_port_state_to_neutral(temp);
1109 /* FIXME: What new port features do we need to support? */
1111 case USB_PORT_FEAT_SUSPEND:
1112 temp = readl(port_array[wIndex]);
1113 if ((temp & PORT_PLS_MASK) != XDEV_U0) {
1114 /* Resume the port to U0 first */
1115 xhci_set_link_state(xhci, port_array, wIndex,
1117 spin_unlock_irqrestore(&xhci->lock, flags);
1119 spin_lock_irqsave(&xhci->lock, flags);
1121 /* In spec software should not attempt to suspend
1122 * a port unless the port reports that it is in the
1123 * enabled (PED = ‘1’,PLS < ‘3’) state.
1125 temp = readl(port_array[wIndex]);
1126 if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
1127 || (temp & PORT_PLS_MASK) >= XDEV_U3) {
1128 xhci_warn(xhci, "USB core suspending device not in U0/U1/U2.\n");
1132 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1135 xhci_warn(xhci, "slot_id is zero\n");
1138 /* unlock to execute stop endpoint commands */
1139 spin_unlock_irqrestore(&xhci->lock, flags);
1140 xhci_stop_device(xhci, slot_id, 1);
1141 spin_lock_irqsave(&xhci->lock, flags);
1143 xhci_set_link_state(xhci, port_array, wIndex, XDEV_U3);
1145 spin_unlock_irqrestore(&xhci->lock, flags);
1146 msleep(10); /* wait device to enter */
1147 spin_lock_irqsave(&xhci->lock, flags);
1149 temp = readl(port_array[wIndex]);
1150 bus_state->suspended_ports |= 1 << wIndex;
1152 case USB_PORT_FEAT_LINK_STATE:
1153 temp = readl(port_array[wIndex]);
1156 if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
1157 xhci_dbg(xhci, "Disable port %d\n", wIndex);
1158 temp = xhci_port_state_to_neutral(temp);
1160 * Clear all change bits, so that we get a new
1163 temp |= PORT_CSC | PORT_PEC | PORT_WRC |
1164 PORT_OCC | PORT_RC | PORT_PLC |
1166 writel(temp | PORT_PE, port_array[wIndex]);
1167 temp = readl(port_array[wIndex]);
1171 /* Put link in RxDetect (enable port) */
1172 if (link_state == USB_SS_PORT_LS_RX_DETECT) {
1173 xhci_dbg(xhci, "Enable port %d\n", wIndex);
1174 xhci_set_link_state(xhci, port_array, wIndex,
1176 temp = readl(port_array[wIndex]);
1180 /* Software should not attempt to set
1181 * port link state above '3' (U3) and the port
1184 if ((temp & PORT_PE) == 0 ||
1185 (link_state > USB_SS_PORT_LS_U3)) {
1186 xhci_warn(xhci, "Cannot set link state.\n");
1190 if (link_state == USB_SS_PORT_LS_U3) {
1191 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1194 /* unlock to execute stop endpoint
1196 spin_unlock_irqrestore(&xhci->lock,
1198 xhci_stop_device(xhci, slot_id, 1);
1199 spin_lock_irqsave(&xhci->lock, flags);
1203 xhci_set_link_state(xhci, port_array, wIndex,
1206 spin_unlock_irqrestore(&xhci->lock, flags);
1207 msleep(20); /* wait device to enter */
1208 spin_lock_irqsave(&xhci->lock, flags);
1210 temp = readl(port_array[wIndex]);
1211 if (link_state == USB_SS_PORT_LS_U3)
1212 bus_state->suspended_ports |= 1 << wIndex;
1214 case USB_PORT_FEAT_POWER:
1216 * Turn on ports, even if there isn't per-port switching.
1217 * HC will report connect events even before this is set.
1218 * However, hub_wq will ignore the roothub events until
1219 * the roothub is registered.
1221 xhci_set_port_power(xhci, hcd, wIndex, true, &flags);
1223 case USB_PORT_FEAT_RESET:
1224 temp = (temp | PORT_RESET);
1225 writel(temp, port_array[wIndex]);
1227 temp = readl(port_array[wIndex]);
1228 xhci_dbg(xhci, "set port reset, actual port %d status = 0x%x\n", wIndex, temp);
1230 case USB_PORT_FEAT_REMOTE_WAKE_MASK:
1231 xhci_set_remote_wake_mask(xhci, port_array,
1233 temp = readl(port_array[wIndex]);
1234 xhci_dbg(xhci, "set port remote wake mask, "
1235 "actual port %d status = 0x%x\n",
1238 case USB_PORT_FEAT_BH_PORT_RESET:
1240 writel(temp, port_array[wIndex]);
1242 temp = readl(port_array[wIndex]);
1244 case USB_PORT_FEAT_U1_TIMEOUT:
1245 if (hcd->speed < HCD_USB3)
1247 temp = readl(port_array[wIndex] + PORTPMSC);
1248 temp &= ~PORT_U1_TIMEOUT_MASK;
1249 temp |= PORT_U1_TIMEOUT(timeout);
1250 writel(temp, port_array[wIndex] + PORTPMSC);
1252 case USB_PORT_FEAT_U2_TIMEOUT:
1253 if (hcd->speed < HCD_USB3)
1255 temp = readl(port_array[wIndex] + PORTPMSC);
1256 temp &= ~PORT_U2_TIMEOUT_MASK;
1257 temp |= PORT_U2_TIMEOUT(timeout);
1258 writel(temp, port_array[wIndex] + PORTPMSC);
1260 case USB_PORT_FEAT_TEST:
1261 /* 4.19.6 Port Test Modes (USB2 Test Mode) */
1262 if (hcd->speed != HCD_USB2)
1264 if (test_mode > TEST_FORCE_EN || test_mode < TEST_J)
1266 retval = xhci_enter_test_mode(xhci, test_mode, wIndex,
1272 /* unblock any posted writes */
1273 temp = readl(port_array[wIndex]);
1275 case ClearPortFeature:
1276 if (!wIndex || wIndex > max_ports)
1279 temp = readl(port_array[wIndex]);
1280 if (temp == ~(u32)0) {
1285 /* FIXME: What new port features do we need to support? */
1286 temp = xhci_port_state_to_neutral(temp);
1288 case USB_PORT_FEAT_SUSPEND:
1289 temp = readl(port_array[wIndex]);
1290 xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
1291 xhci_dbg(xhci, "PORTSC %04x\n", temp);
1292 if (temp & PORT_RESET)
1294 if ((temp & PORT_PLS_MASK) == XDEV_U3) {
1295 if ((temp & PORT_PE) == 0)
1298 set_bit(wIndex, &bus_state->resuming_ports);
1299 xhci_set_link_state(xhci, port_array, wIndex,
1301 spin_unlock_irqrestore(&xhci->lock, flags);
1302 msleep(USB_RESUME_TIMEOUT);
1303 spin_lock_irqsave(&xhci->lock, flags);
1304 xhci_set_link_state(xhci, port_array, wIndex,
1306 clear_bit(wIndex, &bus_state->resuming_ports);
1308 bus_state->port_c_suspend |= 1 << wIndex;
1310 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1313 xhci_dbg(xhci, "slot_id is zero\n");
1316 xhci_ring_device(xhci, slot_id);
1318 case USB_PORT_FEAT_C_SUSPEND:
1319 bus_state->port_c_suspend &= ~(1 << wIndex);
1320 case USB_PORT_FEAT_C_RESET:
1321 case USB_PORT_FEAT_C_BH_PORT_RESET:
1322 case USB_PORT_FEAT_C_CONNECTION:
1323 case USB_PORT_FEAT_C_OVER_CURRENT:
1324 case USB_PORT_FEAT_C_ENABLE:
1325 case USB_PORT_FEAT_C_PORT_LINK_STATE:
1326 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
1327 xhci_clear_port_change_bit(xhci, wValue, wIndex,
1328 port_array[wIndex], temp);
1330 case USB_PORT_FEAT_ENABLE:
1331 xhci_disable_port(hcd, xhci, wIndex,
1332 port_array[wIndex], temp);
1334 case USB_PORT_FEAT_POWER:
1335 xhci_set_port_power(xhci, hcd, wIndex, false, &flags);
1337 case USB_PORT_FEAT_TEST:
1338 retval = xhci_exit_test_mode(xhci);
1346 /* "stall" on error */
1349 spin_unlock_irqrestore(&xhci->lock, flags);
1354 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
1355 * Ports are 0-indexed from the HCD point of view,
1356 * and 1-indexed from the USB core pointer of view.
1358 * Note that the status change bits will be cleared as soon as a port status
1359 * change event is generated, so we use the saved status from that event.
1361 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
1363 unsigned long flags;
1367 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1369 __le32 __iomem **port_array;
1370 struct xhci_bus_state *bus_state;
1371 bool reset_change = false;
1373 max_ports = xhci_get_ports(hcd, &port_array);
1374 bus_state = &xhci->bus_state[hcd_index(hcd)];
1376 /* Initial status is no changes */
1377 retval = (max_ports + 8) / 8;
1378 memset(buf, 0, retval);
1381 * Inform the usbcore about resume-in-progress by returning
1382 * a non-zero value even if there are no status changes.
1384 status = bus_state->resuming_ports;
1386 mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;
1388 spin_lock_irqsave(&xhci->lock, flags);
1389 /* For each port, did anything change? If so, set that bit in buf. */
1390 for (i = 0; i < max_ports; i++) {
1391 temp = readl(port_array[i]);
1392 if (temp == ~(u32)0) {
1397 if ((temp & mask) != 0 ||
1398 (bus_state->port_c_suspend & 1 << i) ||
1399 (bus_state->resume_done[i] && time_after_eq(
1400 jiffies, bus_state->resume_done[i]))) {
1401 buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
1404 if ((temp & PORT_RC))
1405 reset_change = true;
1407 if (!status && !reset_change) {
1408 xhci_dbg(xhci, "%s: stopping port polling.\n", __func__);
1409 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1411 spin_unlock_irqrestore(&xhci->lock, flags);
1412 return status ? retval : 0;
1417 int xhci_bus_suspend(struct usb_hcd *hcd)
1419 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1420 int max_ports, port_index;
1421 __le32 __iomem **port_array;
1422 struct xhci_bus_state *bus_state;
1423 unsigned long flags;
1425 max_ports = xhci_get_ports(hcd, &port_array);
1426 bus_state = &xhci->bus_state[hcd_index(hcd)];
1428 spin_lock_irqsave(&xhci->lock, flags);
1430 if (hcd->self.root_hub->do_remote_wakeup) {
1431 if (bus_state->resuming_ports || /* USB2 */
1432 bus_state->port_remote_wakeup) { /* USB3 */
1433 spin_unlock_irqrestore(&xhci->lock, flags);
1434 xhci_dbg(xhci, "suspend failed because a port is resuming\n");
1439 port_index = max_ports;
1440 bus_state->bus_suspended = 0;
1441 while (port_index--) {
1442 /* suspend the port if the port is not suspended */
1446 t1 = readl(port_array[port_index]);
1447 t2 = xhci_port_state_to_neutral(t1);
1449 if ((t1 & PORT_PE) && !(t1 & PORT_PLS_MASK)) {
1450 xhci_dbg(xhci, "port %d not suspended\n", port_index);
1451 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1454 spin_unlock_irqrestore(&xhci->lock, flags);
1455 xhci_stop_device(xhci, slot_id, 1);
1456 spin_lock_irqsave(&xhci->lock, flags);
1458 t2 &= ~PORT_PLS_MASK;
1459 t2 |= PORT_LINK_STROBE | XDEV_U3;
1460 set_bit(port_index, &bus_state->bus_suspended);
1462 /* USB core sets remote wake mask for USB 3.0 hubs,
1463 * including the USB 3.0 roothub, but only if CONFIG_PM
1464 * is enabled, so also enable remote wake here.
1466 if (hcd->self.root_hub->do_remote_wakeup) {
1467 if (t1 & PORT_CONNECT) {
1468 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
1469 t2 &= ~PORT_WKCONN_E;
1471 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
1472 t2 &= ~PORT_WKDISC_E;
1474 if ((xhci->quirks & XHCI_U2_DISABLE_WAKE) &&
1475 (hcd->speed < HCD_USB3))
1476 t2 &= ~PORT_WAKE_BITS;
1478 t2 &= ~PORT_WAKE_BITS;
1480 t1 = xhci_port_state_to_neutral(t1);
1482 writel(t2, port_array[port_index]);
1484 hcd->state = HC_STATE_SUSPENDED;
1485 bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
1486 spin_unlock_irqrestore(&xhci->lock, flags);
1491 * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
1492 * warm reset a USB3 device stuck in polling or compliance mode after resume.
1493 * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
1495 static bool xhci_port_missing_cas_quirk(int port_index,
1496 __le32 __iomem **port_array)
1500 portsc = readl(port_array[port_index]);
1502 /* if any of these are set we are not stuck */
1503 if (portsc & (PORT_CONNECT | PORT_CAS))
1506 if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
1507 ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
1510 /* clear wakeup/change bits, and do a warm port reset */
1511 portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1513 writel(portsc, port_array[port_index]);
1515 readl(port_array[port_index]);
1519 int xhci_bus_resume(struct usb_hcd *hcd)
1521 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1522 int max_ports, port_index;
1523 __le32 __iomem **port_array;
1524 struct xhci_bus_state *bus_state;
1526 unsigned long flags;
1527 unsigned long port_was_suspended = 0;
1528 bool need_usb2_u3_exit = false;
1532 max_ports = xhci_get_ports(hcd, &port_array);
1533 bus_state = &xhci->bus_state[hcd_index(hcd)];
1535 if (time_before(jiffies, bus_state->next_statechange))
1538 spin_lock_irqsave(&xhci->lock, flags);
1539 if (!HCD_HW_ACCESSIBLE(hcd)) {
1540 spin_unlock_irqrestore(&xhci->lock, flags);
1544 /* delay the irqs */
1545 temp = readl(&xhci->op_regs->command);
1547 writel(temp, &xhci->op_regs->command);
1549 port_index = max_ports;
1550 while (port_index--) {
1551 /* Check whether need resume ports. If needed
1552 resume port and disable remote wakeup */
1555 temp = readl(port_array[port_index]);
1557 /* warm reset CAS limited ports stuck in polling/compliance */
1558 if ((xhci->quirks & XHCI_MISSING_CAS) &&
1559 (hcd->speed >= HCD_USB3) &&
1560 xhci_port_missing_cas_quirk(port_index, port_array)) {
1561 xhci_dbg(xhci, "reset stuck port %d\n", port_index);
1564 if (DEV_SUPERSPEED_ANY(temp))
1565 temp &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1567 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
1568 if (test_bit(port_index, &bus_state->bus_suspended) &&
1569 (temp & PORT_PLS_MASK)) {
1570 set_bit(port_index, &port_was_suspended);
1571 if (!DEV_SUPERSPEED_ANY(temp)) {
1572 xhci_set_link_state(xhci, port_array,
1573 port_index, XDEV_RESUME);
1574 need_usb2_u3_exit = true;
1577 writel(temp, port_array[port_index]);
1580 if (need_usb2_u3_exit) {
1581 spin_unlock_irqrestore(&xhci->lock, flags);
1582 msleep(USB_RESUME_TIMEOUT);
1583 spin_lock_irqsave(&xhci->lock, flags);
1586 port_index = max_ports;
1587 while (port_index--) {
1588 if (!(port_was_suspended & BIT(port_index)))
1590 /* Clear PLC to poll it later after XDEV_U0 */
1591 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1592 xhci_set_link_state(xhci, port_array, port_index, XDEV_U0);
1595 port_index = max_ports;
1596 while (port_index--) {
1597 if (!(port_was_suspended & BIT(port_index)))
1599 /* Poll and Clear PLC */
1600 sret = xhci_handshake(port_array[port_index], PORT_PLC,
1601 PORT_PLC, 10 * 1000);
1603 xhci_warn(xhci, "port %d resume PLC timeout\n",
1605 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1606 slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
1608 xhci_ring_device(xhci, slot_id);
1611 (void) readl(&xhci->op_regs->command);
1613 bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
1614 /* re-enable irqs */
1615 temp = readl(&xhci->op_regs->command);
1617 writel(temp, &xhci->op_regs->command);
1618 temp = readl(&xhci->op_regs->command);
1620 spin_unlock_irqrestore(&xhci->lock, flags);
1624 #endif /* CONFIG_PM */