1 // SPDX-License-Identifier: GPL-2.0
3 * xHCI host controller driver
5 * Copyright (C) 2008 Intel Corp.
8 * Some code borrowed from the Linux EHCI driver.
12 #include <linux/slab.h>
13 #include <asm/unaligned.h>
16 #include "xhci-trace.h"
18 #define PORT_WAKE_BITS (PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E)
19 #define PORT_RWC_BITS (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
20 PORT_RC | PORT_PLC | PORT_PE)
22 /* USB 3 BOS descriptor and a capability descriptors, combined.
23 * Fields will be adjusted and added later in xhci_create_usb3_bos_desc()
25 static u8 usb_bos_descriptor [] = {
26 USB_DT_BOS_SIZE, /* __u8 bLength, 5 bytes */
27 USB_DT_BOS, /* __u8 bDescriptorType */
28 0x0F, 0x00, /* __le16 wTotalLength, 15 bytes */
29 0x1, /* __u8 bNumDeviceCaps */
30 /* First device capability, SuperSpeed */
31 USB_DT_USB_SS_CAP_SIZE, /* __u8 bLength, 10 bytes */
32 USB_DT_DEVICE_CAPABILITY, /* Device Capability */
33 USB_SS_CAP_TYPE, /* bDevCapabilityType, SUPERSPEED_USB */
34 0x00, /* bmAttributes, LTM off by default */
35 USB_5GBPS_OPERATION, 0x00, /* wSpeedsSupported, 5Gbps only */
36 0x03, /* bFunctionalitySupport,
38 0x00, /* bU1DevExitLat, set later. */
39 0x00, 0x00, /* __le16 bU2DevExitLat, set later. */
40 /* Second device capability, SuperSpeedPlus */
41 0x1c, /* bLength 28, will be adjusted later */
42 USB_DT_DEVICE_CAPABILITY, /* Device Capability */
43 USB_SSP_CAP_TYPE, /* bDevCapabilityType SUPERSPEED_PLUS */
44 0x00, /* bReserved 0 */
45 0x23, 0x00, 0x00, 0x00, /* bmAttributes, SSAC=3 SSIC=1 */
46 0x01, 0x00, /* wFunctionalitySupport */
47 0x00, 0x00, /* wReserved 0 */
48 /* Default Sublink Speed Attributes, overwrite if custom PSI exists */
49 0x34, 0x00, 0x05, 0x00, /* 5Gbps, symmetric, rx, ID = 4 */
50 0xb4, 0x00, 0x05, 0x00, /* 5Gbps, symmetric, tx, ID = 4 */
51 0x35, 0x40, 0x0a, 0x00, /* 10Gbps, SSP, symmetric, rx, ID = 5 */
52 0xb5, 0x40, 0x0a, 0x00, /* 10Gbps, SSP, symmetric, tx, ID = 5 */
55 static int xhci_create_usb3_bos_desc(struct xhci_hcd *xhci, char *buf,
60 u16 desc_size, ssp_cap_size, ssa_size = 0;
63 desc_size = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
64 ssp_cap_size = sizeof(usb_bos_descriptor) - desc_size;
66 /* does xhci support USB 3.1 Enhanced SuperSpeed */
67 if (xhci->usb3_rhub.min_rev >= 0x01) {
68 /* does xhci provide a PSI table for SSA speed attributes? */
69 if (xhci->usb3_rhub.psi_count) {
70 /* two SSA entries for each unique PSI ID, RX and TX */
71 ssa_count = xhci->usb3_rhub.psi_uid_count * 2;
72 ssa_size = ssa_count * sizeof(u32);
73 ssp_cap_size -= 16; /* skip copying the default SSA */
75 desc_size += ssp_cap_size;
78 memcpy(buf, &usb_bos_descriptor, min(desc_size, wLength));
81 /* modify bos descriptor bNumDeviceCaps and wTotalLength */
83 put_unaligned_le16(desc_size + ssa_size, &buf[2]);
86 if (wLength < USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE)
89 /* Indicate whether the host has LTM support. */
90 temp = readl(&xhci->cap_regs->hcc_params);
92 buf[8] |= USB_LTM_SUPPORT;
94 /* Set the U1 and U2 exit latencies. */
95 if ((xhci->quirks & XHCI_LPM_SUPPORT)) {
96 temp = readl(&xhci->cap_regs->hcs_params3);
97 buf[12] = HCS_U1_LATENCY(temp);
98 put_unaligned_le16(HCS_U2_LATENCY(temp), &buf[13]);
101 /* If PSI table exists, add the custom speed attributes from it */
102 if (usb3_1 && xhci->usb3_rhub.psi_count) {
103 u32 ssp_cap_base, bm_attrib, psi, psi_mant, psi_exp;
106 ssp_cap_base = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
108 if (wLength < desc_size)
110 buf[ssp_cap_base] = ssp_cap_size + ssa_size;
112 /* attribute count SSAC bits 4:0 and ID count SSIC bits 8:5 */
113 bm_attrib = (ssa_count - 1) & 0x1f;
114 bm_attrib |= (xhci->usb3_rhub.psi_uid_count - 1) << 5;
115 put_unaligned_le32(bm_attrib, &buf[ssp_cap_base + 4]);
117 if (wLength < desc_size + ssa_size)
120 * Create the Sublink Speed Attributes (SSA) array.
121 * The xhci PSI field and USB 3.1 SSA fields are very similar,
122 * but link type bits 7:6 differ for values 01b and 10b.
123 * xhci has also only one PSI entry for a symmetric link when
124 * USB 3.1 requires two SSA entries (RX and TX) for every link
127 for (i = 0; i < xhci->usb3_rhub.psi_count; i++) {
128 psi = xhci->usb3_rhub.psi[i];
129 psi &= ~USB_SSP_SUBLINK_SPEED_RSVD;
130 psi_exp = XHCI_EXT_PORT_PSIE(psi);
131 psi_mant = XHCI_EXT_PORT_PSIM(psi);
133 /* Shift to Gbps and set SSP Link BIT(14) if 10Gpbs */
134 for (; psi_exp < 3; psi_exp++)
139 if ((psi & PLT_MASK) == PLT_SYM) {
140 /* Symmetric, create SSA RX and TX from one PSI entry */
141 put_unaligned_le32(psi, &buf[offset]);
142 psi |= 1 << 7; /* turn entry to TX */
144 if (offset >= desc_size + ssa_size)
145 return desc_size + ssa_size;
146 } else if ((psi & PLT_MASK) == PLT_ASYM_RX) {
147 /* Asymetric RX, flip bits 7:6 for SSA */
150 put_unaligned_le32(psi, &buf[offset]);
152 if (offset >= desc_size + ssa_size)
153 return desc_size + ssa_size;
156 /* ssa_size is 0 for other than usb 3.1 hosts */
157 return desc_size + ssa_size;
160 static void xhci_common_hub_descriptor(struct xhci_hcd *xhci,
161 struct usb_hub_descriptor *desc, int ports)
165 desc->bPwrOn2PwrGood = 10; /* xhci section 5.4.9 says 20ms max */
166 desc->bHubContrCurrent = 0;
168 desc->bNbrPorts = ports;
170 /* Bits 1:0 - support per-port power switching, or power always on */
171 if (HCC_PPC(xhci->hcc_params))
172 temp |= HUB_CHAR_INDV_PORT_LPSM;
174 temp |= HUB_CHAR_NO_LPSM;
175 /* Bit 2 - root hubs are not part of a compound device */
176 /* Bits 4:3 - individual port over current protection */
177 temp |= HUB_CHAR_INDV_PORT_OCPM;
178 /* Bits 6:5 - no TTs in root ports */
179 /* Bit 7 - no port indicators */
180 desc->wHubCharacteristics = cpu_to_le16(temp);
183 /* Fill in the USB 2.0 roothub descriptor */
184 static void xhci_usb2_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
185 struct usb_hub_descriptor *desc)
189 __u8 port_removable[(USB_MAXCHILDREN + 1 + 7) / 8];
192 struct xhci_hub *rhub;
194 rhub = &xhci->usb2_rhub;
195 ports = rhub->num_ports;
196 xhci_common_hub_descriptor(xhci, desc, ports);
197 desc->bDescriptorType = USB_DT_HUB;
198 temp = 1 + (ports / 8);
199 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * temp;
201 /* The Device Removable bits are reported on a byte granularity.
202 * If the port doesn't exist within that byte, the bit is set to 0.
204 memset(port_removable, 0, sizeof(port_removable));
205 for (i = 0; i < ports; i++) {
206 portsc = readl(rhub->ports[i]->addr);
207 /* If a device is removable, PORTSC reports a 0, same as in the
208 * hub descriptor DeviceRemovable bits.
210 if (portsc & PORT_DEV_REMOVE)
211 /* This math is hairy because bit 0 of DeviceRemovable
212 * is reserved, and bit 1 is for port 1, etc.
214 port_removable[(i + 1) / 8] |= 1 << ((i + 1) % 8);
217 /* ch11.h defines a hub descriptor that has room for USB_MAXCHILDREN
218 * ports on it. The USB 2.0 specification says that there are two
219 * variable length fields at the end of the hub descriptor:
220 * DeviceRemovable and PortPwrCtrlMask. But since we can have less than
221 * USB_MAXCHILDREN ports, we may need to use the DeviceRemovable array
222 * to set PortPwrCtrlMask bits. PortPwrCtrlMask must always be set to
223 * 0xFF, so we initialize the both arrays (DeviceRemovable and
224 * PortPwrCtrlMask) to 0xFF. Then we set the DeviceRemovable for each
225 * set of ports that actually exist.
227 memset(desc->u.hs.DeviceRemovable, 0xff,
228 sizeof(desc->u.hs.DeviceRemovable));
229 memset(desc->u.hs.PortPwrCtrlMask, 0xff,
230 sizeof(desc->u.hs.PortPwrCtrlMask));
232 for (i = 0; i < (ports + 1 + 7) / 8; i++)
233 memset(&desc->u.hs.DeviceRemovable[i], port_removable[i],
237 /* Fill in the USB 3.0 roothub descriptor */
238 static void xhci_usb3_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
239 struct usb_hub_descriptor *desc)
245 struct xhci_hub *rhub;
247 rhub = &xhci->usb3_rhub;
248 ports = rhub->num_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(rhub->ports[i]->addr);
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++) {
360 if (!xhci->devs[i] || !xhci->devs[i]->udev)
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, 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, GFP_NOWAIT);
412 spin_unlock_irqrestore(&xhci->lock, flags);
417 ret = xhci_queue_stop_endpoint(xhci, command, slot_id,
420 spin_unlock_irqrestore(&xhci->lock, flags);
421 xhci_free_command(xhci, command);
426 ret = xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
428 spin_unlock_irqrestore(&xhci->lock, flags);
432 xhci_ring_cmd_db(xhci);
433 spin_unlock_irqrestore(&xhci->lock, flags);
435 /* Wait for last stop endpoint command to finish */
436 wait_for_completion(cmd->completion);
438 if (cmd->status == COMP_COMMAND_ABORTED ||
439 cmd->status == COMP_COMMAND_RING_STOPPED) {
440 xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
445 xhci_free_command(xhci, cmd);
450 * Ring device, it rings the all doorbells unconditionally.
452 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
455 struct xhci_virt_ep *ep;
457 for (i = 0; i < LAST_EP_INDEX + 1; i++) {
458 ep = &xhci->devs[slot_id]->eps[i];
460 if (ep->ep_state & EP_HAS_STREAMS) {
461 for (s = 1; s < ep->stream_info->num_streams; s++)
462 xhci_ring_ep_doorbell(xhci, slot_id, i, s);
463 } else if (ep->ring && ep->ring->dequeue) {
464 xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
471 static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
472 u16 wIndex, __le32 __iomem *addr, u32 port_status)
474 /* Don't allow the USB core to disable SuperSpeed ports. */
475 if (hcd->speed >= HCD_USB3) {
476 xhci_dbg(xhci, "Ignoring request to disable "
477 "SuperSpeed port.\n");
481 if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
483 "Broken Port Enabled/Disabled, ignoring port disable request.\n");
487 /* Write 1 to disable the port */
488 writel(port_status | PORT_PE, addr);
489 port_status = readl(addr);
490 xhci_dbg(xhci, "disable port %d-%d, portsc: 0x%x\n",
491 hcd->self.busnum, wIndex + 1, port_status);
494 static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
495 u16 wIndex, __le32 __iomem *addr, u32 port_status)
497 char *port_change_bit;
501 case USB_PORT_FEAT_C_RESET:
503 port_change_bit = "reset";
505 case USB_PORT_FEAT_C_BH_PORT_RESET:
507 port_change_bit = "warm(BH) reset";
509 case USB_PORT_FEAT_C_CONNECTION:
511 port_change_bit = "connect";
513 case USB_PORT_FEAT_C_OVER_CURRENT:
515 port_change_bit = "over-current";
517 case USB_PORT_FEAT_C_ENABLE:
519 port_change_bit = "enable/disable";
521 case USB_PORT_FEAT_C_SUSPEND:
523 port_change_bit = "suspend/resume";
525 case USB_PORT_FEAT_C_PORT_LINK_STATE:
527 port_change_bit = "link state";
529 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
531 port_change_bit = "config error";
534 /* Should never happen */
537 /* Change bits are all write 1 to clear */
538 writel(port_status | status, addr);
539 port_status = readl(addr);
541 xhci_dbg(xhci, "clear port%d %s change, portsc: 0x%x\n",
542 wIndex + 1, port_change_bit, port_status);
545 struct xhci_hub *xhci_get_rhub(struct usb_hcd *hcd)
547 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
549 if (hcd->speed >= HCD_USB3)
550 return &xhci->usb3_rhub;
551 return &xhci->usb2_rhub;
555 * xhci_set_port_power() must be called with xhci->lock held.
556 * It will release and re-aquire the lock while calling ACPI
559 static void xhci_set_port_power(struct xhci_hcd *xhci, struct usb_hcd *hcd,
560 u16 index, bool on, unsigned long *flags)
562 struct xhci_hub *rhub;
563 struct xhci_port *port;
566 rhub = xhci_get_rhub(hcd);
567 port = rhub->ports[index];
568 temp = readl(port->addr);
570 xhci_dbg(xhci, "set port power %d-%d %s, portsc: 0x%x\n",
571 hcd->self.busnum, index + 1, on ? "ON" : "OFF", temp);
573 temp = xhci_port_state_to_neutral(temp);
577 writel(temp | PORT_POWER, port->addr);
581 writel(temp & ~PORT_POWER, port->addr);
584 spin_unlock_irqrestore(&xhci->lock, *flags);
585 temp = usb_acpi_power_manageable(hcd->self.root_hub,
588 usb_acpi_set_power_state(hcd->self.root_hub,
590 spin_lock_irqsave(&xhci->lock, *flags);
593 static void xhci_port_set_test_mode(struct xhci_hcd *xhci,
594 u16 test_mode, u16 wIndex)
597 struct xhci_port *port;
599 /* xhci only supports test mode for usb2 ports */
600 port = xhci->usb2_rhub.ports[wIndex];
601 temp = readl(port->addr + PORTPMSC);
602 temp |= test_mode << PORT_TEST_MODE_SHIFT;
603 writel(temp, port->addr + PORTPMSC);
604 xhci->test_mode = test_mode;
605 if (test_mode == TEST_FORCE_EN)
609 static int xhci_enter_test_mode(struct xhci_hcd *xhci,
610 u16 test_mode, u16 wIndex, unsigned long *flags)
614 /* Disable all Device Slots */
615 xhci_dbg(xhci, "Disable all slots\n");
616 spin_unlock_irqrestore(&xhci->lock, *flags);
617 for (i = 1; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
621 retval = xhci_disable_slot(xhci, i);
623 xhci_err(xhci, "Failed to disable slot %d, %d. Enter test mode anyway\n",
626 spin_lock_irqsave(&xhci->lock, *flags);
627 /* Put all ports to the Disable state by clear PP */
628 xhci_dbg(xhci, "Disable all port (PP = 0)\n");
629 /* Power off USB3 ports*/
630 for (i = 0; i < xhci->usb3_rhub.num_ports; i++)
631 xhci_set_port_power(xhci, xhci->shared_hcd, i, false, flags);
632 /* Power off USB2 ports*/
633 for (i = 0; i < xhci->usb2_rhub.num_ports; i++)
634 xhci_set_port_power(xhci, xhci->main_hcd, i, false, flags);
635 /* Stop the controller */
636 xhci_dbg(xhci, "Stop controller\n");
637 retval = xhci_halt(xhci);
640 /* Disable runtime PM for test mode */
641 pm_runtime_forbid(xhci_to_hcd(xhci)->self.controller);
642 /* Set PORTPMSC.PTC field to enter selected test mode */
643 /* Port is selected by wIndex. port_id = wIndex + 1 */
644 xhci_dbg(xhci, "Enter Test Mode: %d, Port_id=%d\n",
645 test_mode, wIndex + 1);
646 xhci_port_set_test_mode(xhci, test_mode, wIndex);
650 static int xhci_exit_test_mode(struct xhci_hcd *xhci)
654 if (!xhci->test_mode) {
655 xhci_err(xhci, "Not in test mode, do nothing.\n");
658 if (xhci->test_mode == TEST_FORCE_EN &&
659 !(xhci->xhc_state & XHCI_STATE_HALTED)) {
660 retval = xhci_halt(xhci);
664 pm_runtime_allow(xhci_to_hcd(xhci)->self.controller);
666 return xhci_reset(xhci);
669 void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
675 portsc = readl(port->addr);
676 temp = xhci_port_state_to_neutral(portsc);
677 temp &= ~PORT_PLS_MASK;
678 temp |= PORT_LINK_STROBE | link_state;
679 writel(temp, port->addr);
681 xhci_dbg(xhci, "Set port %d-%d link state, portsc: 0x%x, write 0x%x",
682 port->rhub->hcd->self.busnum, port->hcd_portnum + 1,
686 static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
687 struct xhci_port *port, u16 wake_mask)
691 temp = readl(port->addr);
692 temp = xhci_port_state_to_neutral(temp);
694 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
695 temp |= PORT_WKCONN_E;
697 temp &= ~PORT_WKCONN_E;
699 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
700 temp |= PORT_WKDISC_E;
702 temp &= ~PORT_WKDISC_E;
704 if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
707 temp &= ~PORT_WKOC_E;
709 writel(temp, port->addr);
712 /* Test and clear port RWC bit */
713 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
718 temp = readl(port->addr);
719 if (temp & port_bit) {
720 temp = xhci_port_state_to_neutral(temp);
722 writel(temp, port->addr);
726 /* Updates Link Status for super Speed port */
727 static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
728 u32 *status, u32 status_reg)
730 u32 pls = status_reg & PORT_PLS_MASK;
732 /* resume state is a xHCI internal state.
733 * Do not report it to usb core, instead, pretend to be U3,
734 * thus usb core knows it's not ready for transfer
736 if (pls == XDEV_RESUME) {
737 *status |= USB_SS_PORT_LS_U3;
741 /* When the CAS bit is set then warm reset
742 * should be performed on port
744 if (status_reg & PORT_CAS) {
745 /* The CAS bit can be set while the port is
747 * Only roothubs have CAS bit, so we
748 * pretend to be in compliance mode
749 * unless we're already in compliance
750 * or the inactive state.
752 if (pls != USB_SS_PORT_LS_COMP_MOD &&
753 pls != USB_SS_PORT_LS_SS_INACTIVE) {
754 pls = USB_SS_PORT_LS_COMP_MOD;
756 /* Return also connection bit -
757 * hub state machine resets port
758 * when this bit is set.
760 pls |= USB_PORT_STAT_CONNECTION;
763 * If CAS bit isn't set but the Port is already at
764 * Compliance Mode, fake a connection so the USB core
765 * notices the Compliance state and resets the port.
766 * This resolves an issue generated by the SN65LVPE502CP
767 * in which sometimes the port enters compliance mode
768 * caused by a delay on the host-device negotiation.
770 if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
771 (pls == USB_SS_PORT_LS_COMP_MOD))
772 pls |= USB_PORT_STAT_CONNECTION;
775 /* update status field */
780 * Function for Compliance Mode Quirk.
782 * This Function verifies if all xhc USB3 ports have entered U0, if so,
783 * the compliance mode timer is deleted. A port won't enter
784 * compliance mode if it has previously entered U0.
786 static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
789 u32 all_ports_seen_u0 = ((1 << xhci->usb3_rhub.num_ports) - 1);
790 bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);
792 if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
795 if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
796 xhci->port_status_u0 |= 1 << wIndex;
797 if (xhci->port_status_u0 == all_ports_seen_u0) {
798 del_timer_sync(&xhci->comp_mode_recovery_timer);
799 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
800 "All USB3 ports have entered U0 already!");
801 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
802 "Compliance Mode Recovery Timer Deleted.");
807 static int xhci_handle_usb2_port_link_resume(struct xhci_port *port,
808 u32 *status, u32 portsc,
811 struct xhci_bus_state *bus_state;
812 struct xhci_hcd *xhci;
817 hcd = port->rhub->hcd;
818 bus_state = &port->rhub->bus_state;
819 xhci = hcd_to_xhci(hcd);
820 wIndex = port->hcd_portnum;
822 if ((portsc & PORT_RESET) || !(portsc & PORT_PE)) {
823 *status = 0xffffffff;
826 /* did port event handler already start resume timing? */
827 if (!bus_state->resume_done[wIndex]) {
828 /* If not, maybe we are in a host initated resume? */
829 if (test_bit(wIndex, &bus_state->resuming_ports)) {
830 /* Host initated resume doesn't time the resume
831 * signalling using resume_done[].
832 * It manually sets RESUME state, sleeps 20ms
833 * and sets U0 state. This should probably be
834 * changed, but not right now.
837 /* port resume was discovered now and here,
838 * start resume timing
840 unsigned long timeout = jiffies +
841 msecs_to_jiffies(USB_RESUME_TIMEOUT);
843 set_bit(wIndex, &bus_state->resuming_ports);
844 bus_state->resume_done[wIndex] = timeout;
845 mod_timer(&hcd->rh_timer, timeout);
846 usb_hcd_start_port_resume(&hcd->self, wIndex);
848 /* Has resume been signalled for USB_RESUME_TIME yet? */
849 } else if (time_after_eq(jiffies, bus_state->resume_done[wIndex])) {
852 xhci_dbg(xhci, "resume USB2 port %d-%d\n",
853 hcd->self.busnum, wIndex + 1);
855 bus_state->resume_done[wIndex] = 0;
856 clear_bit(wIndex, &bus_state->resuming_ports);
858 set_bit(wIndex, &bus_state->rexit_ports);
860 xhci_test_and_clear_bit(xhci, port, PORT_PLC);
861 xhci_set_link_state(xhci, port, XDEV_U0);
863 spin_unlock_irqrestore(&xhci->lock, flags);
864 time_left = wait_for_completion_timeout(
865 &bus_state->rexit_done[wIndex],
866 msecs_to_jiffies(XHCI_MAX_REXIT_TIMEOUT_MS));
867 spin_lock_irqsave(&xhci->lock, flags);
870 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
873 xhci_dbg(xhci, "slot_id is zero\n");
874 *status = 0xffffffff;
877 xhci_ring_device(xhci, slot_id);
879 int port_status = readl(port->addr);
881 xhci_warn(xhci, "Port resume timed out, port %d-%d: 0x%x\n",
882 hcd->self.busnum, wIndex + 1, port_status);
883 *status |= USB_PORT_STAT_SUSPEND;
884 clear_bit(wIndex, &bus_state->rexit_ports);
887 usb_hcd_end_port_resume(&hcd->self, wIndex);
888 bus_state->port_c_suspend |= 1 << wIndex;
889 bus_state->suspended_ports &= ~(1 << wIndex);
892 * The resume has been signaling for less than
893 * USB_RESUME_TIME. Report the port status as SUSPEND,
894 * let the usbcore check port status again and clear
895 * resume signaling later.
897 *status |= USB_PORT_STAT_SUSPEND;
902 static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
907 /* only support rx and tx lane counts of 1 in usb3.1 spec */
908 speed_id = DEV_PORT_SPEED(raw_port_status);
909 ext_stat |= speed_id; /* bits 3:0, RX speed id */
910 ext_stat |= speed_id << 4; /* bits 7:4, TX speed id */
912 ext_stat |= PORT_RX_LANES(port_li) << 8; /* bits 11:8 Rx lane count */
913 ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */
918 static void xhci_get_usb3_port_status(struct xhci_port *port, u32 *status,
921 struct xhci_bus_state *bus_state;
922 struct xhci_hcd *xhci;
926 bus_state = &port->rhub->bus_state;
927 xhci = hcd_to_xhci(port->rhub->hcd);
928 link_state = portsc & PORT_PLS_MASK;
929 portnum = port->hcd_portnum;
931 /* USB3 specific wPortChange bits
933 * Port link change with port in resume state should not be
934 * reported to usbcore, as this is an internal state to be
935 * handled by xhci driver. Reporting PLC to usbcore may
936 * cause usbcore clearing PLC first and port change event
937 * irq won't be generated.
940 if (portsc & PORT_PLC && (link_state != XDEV_RESUME))
941 *status |= USB_PORT_STAT_C_LINK_STATE << 16;
942 if (portsc & PORT_WRC)
943 *status |= USB_PORT_STAT_C_BH_RESET << 16;
944 if (portsc & PORT_CEC)
945 *status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;
947 /* USB3 specific wPortStatus bits */
948 if (portsc & PORT_POWER) {
949 *status |= USB_SS_PORT_STAT_POWER;
950 /* link state handling */
951 if (link_state == XDEV_U0)
952 bus_state->suspended_ports &= ~(1 << portnum);
955 xhci_hub_report_usb3_link_state(xhci, status, portsc);
956 xhci_del_comp_mod_timer(xhci, portsc, portnum);
959 static void xhci_get_usb2_port_status(struct xhci_port *port, u32 *status,
960 u32 portsc, unsigned long flags)
962 struct xhci_bus_state *bus_state;
967 bus_state = &port->rhub->bus_state;
968 link_state = portsc & PORT_PLS_MASK;
969 portnum = port->hcd_portnum;
971 /* USB2 wPortStatus bits */
972 if (portsc & PORT_POWER) {
973 *status |= USB_PORT_STAT_POWER;
975 /* link state is only valid if port is powered */
976 if (link_state == XDEV_U3)
977 *status |= USB_PORT_STAT_SUSPEND;
978 if (link_state == XDEV_U2)
979 *status |= USB_PORT_STAT_L1;
980 if (link_state == XDEV_U0) {
981 bus_state->resume_done[portnum] = 0;
982 clear_bit(portnum, &bus_state->resuming_ports);
983 if (bus_state->suspended_ports & (1 << portnum)) {
984 bus_state->suspended_ports &= ~(1 << portnum);
985 bus_state->port_c_suspend |= 1 << portnum;
988 if (link_state == XDEV_RESUME) {
989 ret = xhci_handle_usb2_port_link_resume(port, status,
998 * Converts a raw xHCI port status into the format that external USB 2.0 or USB
1001 * Possible side effects:
1002 * - Mark a port as being done with device resume,
1003 * and ring the endpoint doorbells.
1004 * - Stop the Synopsys redriver Compliance Mode polling.
1005 * - Drop and reacquire the xHCI lock, in order to wait for port resume.
1007 static u32 xhci_get_port_status(struct usb_hcd *hcd,
1008 struct xhci_bus_state *bus_state,
1009 u16 wIndex, u32 raw_port_status,
1010 unsigned long flags)
1011 __releases(&xhci->lock)
1012 __acquires(&xhci->lock)
1015 struct xhci_hub *rhub;
1016 struct xhci_port *port;
1018 rhub = xhci_get_rhub(hcd);
1019 port = rhub->ports[wIndex];
1021 /* common wPortChange bits */
1022 if (raw_port_status & PORT_CSC)
1023 status |= USB_PORT_STAT_C_CONNECTION << 16;
1024 if (raw_port_status & PORT_PEC)
1025 status |= USB_PORT_STAT_C_ENABLE << 16;
1026 if ((raw_port_status & PORT_OCC))
1027 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
1028 if ((raw_port_status & PORT_RC))
1029 status |= USB_PORT_STAT_C_RESET << 16;
1031 /* common wPortStatus bits */
1032 if (raw_port_status & PORT_CONNECT) {
1033 status |= USB_PORT_STAT_CONNECTION;
1034 status |= xhci_port_speed(raw_port_status);
1036 if (raw_port_status & PORT_PE)
1037 status |= USB_PORT_STAT_ENABLE;
1038 if (raw_port_status & PORT_OC)
1039 status |= USB_PORT_STAT_OVERCURRENT;
1040 if (raw_port_status & PORT_RESET)
1041 status |= USB_PORT_STAT_RESET;
1043 /* USB2 and USB3 specific bits, including Port Link State */
1044 if (hcd->speed >= HCD_USB3)
1045 xhci_get_usb3_port_status(port, &status, raw_port_status);
1047 xhci_get_usb2_port_status(port, &status, raw_port_status,
1050 * Clear stale usb2 resume signalling variables in case port changed
1051 * state during resume signalling. For example on error
1053 if ((bus_state->resume_done[wIndex] ||
1054 test_bit(wIndex, &bus_state->resuming_ports)) &&
1055 (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
1056 (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
1057 bus_state->resume_done[wIndex] = 0;
1058 clear_bit(wIndex, &bus_state->resuming_ports);
1059 usb_hcd_end_port_resume(&hcd->self, wIndex);
1062 if (bus_state->port_c_suspend & (1 << wIndex))
1063 status |= USB_PORT_STAT_C_SUSPEND << 16;
1068 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
1069 u16 wIndex, char *buf, u16 wLength)
1071 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1073 unsigned long flags;
1077 struct xhci_bus_state *bus_state;
1082 struct xhci_hub *rhub;
1083 struct xhci_port **ports;
1085 rhub = xhci_get_rhub(hcd);
1086 ports = rhub->ports;
1087 max_ports = rhub->num_ports;
1088 bus_state = &rhub->bus_state;
1090 spin_lock_irqsave(&xhci->lock, flags);
1093 /* No power source, over-current reported per port */
1096 case GetHubDescriptor:
1097 /* Check to make sure userspace is asking for the USB 3.0 hub
1098 * descriptor for the USB 3.0 roothub. If not, we stall the
1099 * endpoint, like external hubs do.
1101 if (hcd->speed >= HCD_USB3 &&
1102 (wLength < USB_DT_SS_HUB_SIZE ||
1103 wValue != (USB_DT_SS_HUB << 8))) {
1104 xhci_dbg(xhci, "Wrong hub descriptor type for "
1105 "USB 3.0 roothub.\n");
1108 xhci_hub_descriptor(hcd, xhci,
1109 (struct usb_hub_descriptor *) buf);
1111 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
1112 if ((wValue & 0xff00) != (USB_DT_BOS << 8))
1115 if (hcd->speed < HCD_USB3)
1118 retval = xhci_create_usb3_bos_desc(xhci, buf, wLength);
1119 spin_unlock_irqrestore(&xhci->lock, flags);
1122 if (!wIndex || wIndex > max_ports)
1125 temp = readl(ports[wIndex]->addr);
1126 if (temp == ~(u32)0) {
1131 trace_xhci_get_port_status(wIndex, temp);
1132 status = xhci_get_port_status(hcd, bus_state, wIndex, temp,
1134 if (status == 0xffffffff)
1137 xhci_dbg(xhci, "Get port status %d-%d read: 0x%x, return 0x%x",
1138 hcd->self.busnum, wIndex + 1, temp, status);
1140 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
1141 /* if USB 3.1 extended port status return additional 4 bytes */
1142 if (wValue == 0x02) {
1145 if (hcd->speed < HCD_USB31 || wLength != 8) {
1146 xhci_err(xhci, "get ext port status invalid parameter\n");
1150 port_li = readl(ports[wIndex]->addr + PORTLI);
1151 status = xhci_get_ext_port_status(temp, port_li);
1152 put_unaligned_le32(status, &buf[4]);
1155 case SetPortFeature:
1156 if (wValue == USB_PORT_FEAT_LINK_STATE)
1157 link_state = (wIndex & 0xff00) >> 3;
1158 if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
1159 wake_mask = wIndex & 0xff00;
1160 if (wValue == USB_PORT_FEAT_TEST)
1161 test_mode = (wIndex & 0xff00) >> 8;
1162 /* The MSB of wIndex is the U1/U2 timeout */
1163 timeout = (wIndex & 0xff00) >> 8;
1165 if (!wIndex || wIndex > max_ports)
1168 temp = readl(ports[wIndex]->addr);
1169 if (temp == ~(u32)0) {
1174 temp = xhci_port_state_to_neutral(temp);
1175 /* FIXME: What new port features do we need to support? */
1177 case USB_PORT_FEAT_SUSPEND:
1178 temp = readl(ports[wIndex]->addr);
1179 if ((temp & PORT_PLS_MASK) != XDEV_U0) {
1180 /* Resume the port to U0 first */
1181 xhci_set_link_state(xhci, ports[wIndex],
1183 spin_unlock_irqrestore(&xhci->lock, flags);
1185 spin_lock_irqsave(&xhci->lock, flags);
1187 /* In spec software should not attempt to suspend
1188 * a port unless the port reports that it is in the
1189 * enabled (PED = ‘1’,PLS < ‘3’) state.
1191 temp = readl(ports[wIndex]->addr);
1192 if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
1193 || (temp & PORT_PLS_MASK) >= XDEV_U3) {
1194 xhci_warn(xhci, "USB core suspending port %d-%d not in U0/U1/U2\n",
1195 hcd->self.busnum, wIndex + 1);
1199 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1202 xhci_warn(xhci, "slot_id is zero\n");
1205 /* unlock to execute stop endpoint commands */
1206 spin_unlock_irqrestore(&xhci->lock, flags);
1207 xhci_stop_device(xhci, slot_id, 1);
1208 spin_lock_irqsave(&xhci->lock, flags);
1210 xhci_set_link_state(xhci, ports[wIndex], XDEV_U3);
1212 spin_unlock_irqrestore(&xhci->lock, flags);
1213 msleep(10); /* wait device to enter */
1214 spin_lock_irqsave(&xhci->lock, flags);
1216 temp = readl(ports[wIndex]->addr);
1217 bus_state->suspended_ports |= 1 << wIndex;
1219 case USB_PORT_FEAT_LINK_STATE:
1220 temp = readl(ports[wIndex]->addr);
1222 if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
1223 xhci_dbg(xhci, "Disable port %d\n", wIndex);
1224 temp = xhci_port_state_to_neutral(temp);
1226 * Clear all change bits, so that we get a new
1229 temp |= PORT_CSC | PORT_PEC | PORT_WRC |
1230 PORT_OCC | PORT_RC | PORT_PLC |
1232 writel(temp | PORT_PE, ports[wIndex]->addr);
1233 temp = readl(ports[wIndex]->addr);
1237 /* Put link in RxDetect (enable port) */
1238 if (link_state == USB_SS_PORT_LS_RX_DETECT) {
1239 xhci_dbg(xhci, "Enable port %d\n", wIndex);
1240 xhci_set_link_state(xhci, ports[wIndex],
1242 temp = readl(ports[wIndex]->addr);
1247 * For xHCI 1.1 according to section 4.19.1.2.4.1 a
1248 * root hub port's transition to compliance mode upon
1249 * detecting LFPS timeout may be controlled by an
1250 * Compliance Transition Enabled (CTE) flag (not
1251 * software visible). This flag is set by writing 0xA
1252 * to PORTSC PLS field which will allow transition to
1253 * compliance mode the next time LFPS timeout is
1254 * encountered. A warm reset will clear it.
1256 * The CTE flag is only supported if the HCCPARAMS2 CTC
1257 * flag is set, otherwise, the compliance substate is
1258 * automatically entered as on 1.0 and prior.
1260 if (link_state == USB_SS_PORT_LS_COMP_MOD) {
1261 if (!HCC2_CTC(xhci->hcc_params2)) {
1262 xhci_dbg(xhci, "CTC flag is 0, port already supports entering compliance mode\n");
1266 if ((temp & PORT_CONNECT)) {
1267 xhci_warn(xhci, "Can't set compliance mode when port is connected\n");
1271 xhci_dbg(xhci, "Enable compliance mode transition for port %d\n",
1273 xhci_set_link_state(xhci, ports[wIndex],
1276 temp = readl(ports[wIndex]->addr);
1279 /* Port must be enabled */
1280 if (!(temp & PORT_PE)) {
1284 /* Can't set port link state above '3' (U3) */
1285 if (link_state > USB_SS_PORT_LS_U3) {
1286 xhci_warn(xhci, "Cannot set port %d link state %d\n",
1287 wIndex, link_state);
1290 if (link_state == USB_SS_PORT_LS_U3) {
1291 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1294 /* unlock to execute stop endpoint
1296 spin_unlock_irqrestore(&xhci->lock,
1298 xhci_stop_device(xhci, slot_id, 1);
1299 spin_lock_irqsave(&xhci->lock, flags);
1303 xhci_set_link_state(xhci, ports[wIndex], link_state);
1305 spin_unlock_irqrestore(&xhci->lock, flags);
1306 msleep(20); /* wait device to enter */
1307 spin_lock_irqsave(&xhci->lock, flags);
1309 temp = readl(ports[wIndex]->addr);
1310 if (link_state == USB_SS_PORT_LS_U3)
1311 bus_state->suspended_ports |= 1 << wIndex;
1313 case USB_PORT_FEAT_POWER:
1315 * Turn on ports, even if there isn't per-port switching.
1316 * HC will report connect events even before this is set.
1317 * However, hub_wq will ignore the roothub events until
1318 * the roothub is registered.
1320 xhci_set_port_power(xhci, hcd, wIndex, true, &flags);
1322 case USB_PORT_FEAT_RESET:
1323 temp = (temp | PORT_RESET);
1324 writel(temp, ports[wIndex]->addr);
1326 temp = readl(ports[wIndex]->addr);
1327 xhci_dbg(xhci, "set port reset, actual port %d status = 0x%x\n", wIndex, temp);
1329 case USB_PORT_FEAT_REMOTE_WAKE_MASK:
1330 xhci_set_remote_wake_mask(xhci, ports[wIndex],
1332 temp = readl(ports[wIndex]->addr);
1333 xhci_dbg(xhci, "set port remote wake mask, "
1334 "actual port %d status = 0x%x\n",
1337 case USB_PORT_FEAT_BH_PORT_RESET:
1339 writel(temp, ports[wIndex]->addr);
1340 temp = readl(ports[wIndex]->addr);
1342 case USB_PORT_FEAT_U1_TIMEOUT:
1343 if (hcd->speed < HCD_USB3)
1345 temp = readl(ports[wIndex]->addr + PORTPMSC);
1346 temp &= ~PORT_U1_TIMEOUT_MASK;
1347 temp |= PORT_U1_TIMEOUT(timeout);
1348 writel(temp, ports[wIndex]->addr + PORTPMSC);
1350 case USB_PORT_FEAT_U2_TIMEOUT:
1351 if (hcd->speed < HCD_USB3)
1353 temp = readl(ports[wIndex]->addr + PORTPMSC);
1354 temp &= ~PORT_U2_TIMEOUT_MASK;
1355 temp |= PORT_U2_TIMEOUT(timeout);
1356 writel(temp, ports[wIndex]->addr + PORTPMSC);
1358 case USB_PORT_FEAT_TEST:
1359 /* 4.19.6 Port Test Modes (USB2 Test Mode) */
1360 if (hcd->speed != HCD_USB2)
1362 if (test_mode > TEST_FORCE_EN || test_mode < TEST_J)
1364 retval = xhci_enter_test_mode(xhci, test_mode, wIndex,
1370 /* unblock any posted writes */
1371 temp = readl(ports[wIndex]->addr);
1373 case ClearPortFeature:
1374 if (!wIndex || wIndex > max_ports)
1377 temp = readl(ports[wIndex]->addr);
1378 if (temp == ~(u32)0) {
1383 /* FIXME: What new port features do we need to support? */
1384 temp = xhci_port_state_to_neutral(temp);
1386 case USB_PORT_FEAT_SUSPEND:
1387 temp = readl(ports[wIndex]->addr);
1388 xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
1389 xhci_dbg(xhci, "PORTSC %04x\n", temp);
1390 if (temp & PORT_RESET)
1392 if ((temp & PORT_PLS_MASK) == XDEV_U3) {
1393 if ((temp & PORT_PE) == 0)
1396 set_bit(wIndex, &bus_state->resuming_ports);
1397 usb_hcd_start_port_resume(&hcd->self, wIndex);
1398 xhci_set_link_state(xhci, ports[wIndex],
1400 spin_unlock_irqrestore(&xhci->lock, flags);
1401 msleep(USB_RESUME_TIMEOUT);
1402 spin_lock_irqsave(&xhci->lock, flags);
1403 xhci_set_link_state(xhci, ports[wIndex],
1405 clear_bit(wIndex, &bus_state->resuming_ports);
1406 usb_hcd_end_port_resume(&hcd->self, wIndex);
1408 bus_state->port_c_suspend |= 1 << wIndex;
1410 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1413 xhci_dbg(xhci, "slot_id is zero\n");
1416 xhci_ring_device(xhci, slot_id);
1418 case USB_PORT_FEAT_C_SUSPEND:
1419 bus_state->port_c_suspend &= ~(1 << wIndex);
1421 case USB_PORT_FEAT_C_RESET:
1422 case USB_PORT_FEAT_C_BH_PORT_RESET:
1423 case USB_PORT_FEAT_C_CONNECTION:
1424 case USB_PORT_FEAT_C_OVER_CURRENT:
1425 case USB_PORT_FEAT_C_ENABLE:
1426 case USB_PORT_FEAT_C_PORT_LINK_STATE:
1427 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
1428 xhci_clear_port_change_bit(xhci, wValue, wIndex,
1429 ports[wIndex]->addr, temp);
1431 case USB_PORT_FEAT_ENABLE:
1432 xhci_disable_port(hcd, xhci, wIndex,
1433 ports[wIndex]->addr, temp);
1435 case USB_PORT_FEAT_POWER:
1436 xhci_set_port_power(xhci, hcd, wIndex, false, &flags);
1438 case USB_PORT_FEAT_TEST:
1439 retval = xhci_exit_test_mode(xhci);
1447 /* "stall" on error */
1450 spin_unlock_irqrestore(&xhci->lock, flags);
1455 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
1456 * Ports are 0-indexed from the HCD point of view,
1457 * and 1-indexed from the USB core pointer of view.
1459 * Note that the status change bits will be cleared as soon as a port status
1460 * change event is generated, so we use the saved status from that event.
1462 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
1464 unsigned long flags;
1468 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1470 struct xhci_bus_state *bus_state;
1471 bool reset_change = false;
1472 struct xhci_hub *rhub;
1473 struct xhci_port **ports;
1475 rhub = xhci_get_rhub(hcd);
1476 ports = rhub->ports;
1477 max_ports = rhub->num_ports;
1478 bus_state = &rhub->bus_state;
1480 /* Initial status is no changes */
1481 retval = (max_ports + 8) / 8;
1482 memset(buf, 0, retval);
1485 * Inform the usbcore about resume-in-progress by returning
1486 * a non-zero value even if there are no status changes.
1488 status = bus_state->resuming_ports;
1490 mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;
1492 spin_lock_irqsave(&xhci->lock, flags);
1493 /* For each port, did anything change? If so, set that bit in buf. */
1494 for (i = 0; i < max_ports; i++) {
1495 temp = readl(ports[i]->addr);
1496 if (temp == ~(u32)0) {
1501 trace_xhci_hub_status_data(i, temp);
1503 if ((temp & mask) != 0 ||
1504 (bus_state->port_c_suspend & 1 << i) ||
1505 (bus_state->resume_done[i] && time_after_eq(
1506 jiffies, bus_state->resume_done[i]))) {
1507 buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
1510 if ((temp & PORT_RC))
1511 reset_change = true;
1513 if (!status && !reset_change) {
1514 xhci_dbg(xhci, "%s: stopping port polling.\n", __func__);
1515 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1517 spin_unlock_irqrestore(&xhci->lock, flags);
1518 return status ? retval : 0;
1523 int xhci_bus_suspend(struct usb_hcd *hcd)
1525 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1526 int max_ports, port_index;
1527 struct xhci_bus_state *bus_state;
1528 unsigned long flags;
1529 struct xhci_hub *rhub;
1530 struct xhci_port **ports;
1531 u32 portsc_buf[USB_MAXCHILDREN];
1534 rhub = xhci_get_rhub(hcd);
1535 ports = rhub->ports;
1536 max_ports = rhub->num_ports;
1537 bus_state = &rhub->bus_state;
1538 wake_enabled = hcd->self.root_hub->do_remote_wakeup;
1540 spin_lock_irqsave(&xhci->lock, flags);
1543 if (bus_state->resuming_ports || /* USB2 */
1544 bus_state->port_remote_wakeup) { /* USB3 */
1545 spin_unlock_irqrestore(&xhci->lock, flags);
1546 xhci_dbg(xhci, "suspend failed because a port is resuming\n");
1551 * Prepare ports for suspend, but don't write anything before all ports
1552 * are checked and we know bus suspend can proceed
1554 bus_state->bus_suspended = 0;
1555 port_index = max_ports;
1556 while (port_index--) {
1560 t1 = readl(ports[port_index]->addr);
1561 t2 = xhci_port_state_to_neutral(t1);
1562 portsc_buf[port_index] = 0;
1565 * Give a USB3 port in link training time to finish, but don't
1566 * prevent suspend as port might be stuck
1568 if ((hcd->speed >= HCD_USB3) && retries-- &&
1569 (t1 & PORT_PLS_MASK) == XDEV_POLLING) {
1570 spin_unlock_irqrestore(&xhci->lock, flags);
1571 msleep(XHCI_PORT_POLLING_LFPS_TIME);
1572 spin_lock_irqsave(&xhci->lock, flags);
1573 xhci_dbg(xhci, "port %d polling in bus suspend, waiting\n",
1577 /* suspend ports in U0, or bail out for new connect changes */
1578 if ((t1 & PORT_PE) && (t1 & PORT_PLS_MASK) == XDEV_U0) {
1579 if ((t1 & PORT_CSC) && wake_enabled) {
1580 bus_state->bus_suspended = 0;
1581 spin_unlock_irqrestore(&xhci->lock, flags);
1582 xhci_dbg(xhci, "Bus suspend bailout, port connect change\n");
1585 xhci_dbg(xhci, "port %d not suspended\n", port_index);
1586 t2 &= ~PORT_PLS_MASK;
1587 t2 |= PORT_LINK_STROBE | XDEV_U3;
1588 set_bit(port_index, &bus_state->bus_suspended);
1590 /* USB core sets remote wake mask for USB 3.0 hubs,
1591 * including the USB 3.0 roothub, but only if CONFIG_PM
1592 * is enabled, so also enable remote wake here.
1595 if (t1 & PORT_CONNECT) {
1596 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
1597 t2 &= ~PORT_WKCONN_E;
1599 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
1600 t2 &= ~PORT_WKDISC_E;
1603 if ((xhci->quirks & XHCI_U2_DISABLE_WAKE) &&
1604 (hcd->speed < HCD_USB3)) {
1605 if (usb_amd_pt_check_port(hcd->self.controller,
1607 t2 &= ~PORT_WAKE_BITS;
1610 t2 &= ~PORT_WAKE_BITS;
1612 t1 = xhci_port_state_to_neutral(t1);
1614 portsc_buf[port_index] = t2;
1617 /* write port settings, stopping and suspending ports if needed */
1618 port_index = max_ports;
1619 while (port_index--) {
1620 if (!portsc_buf[port_index])
1622 if (test_bit(port_index, &bus_state->bus_suspended)) {
1625 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1628 spin_unlock_irqrestore(&xhci->lock, flags);
1629 xhci_stop_device(xhci, slot_id, 1);
1630 spin_lock_irqsave(&xhci->lock, flags);
1633 writel(portsc_buf[port_index], ports[port_index]->addr);
1635 hcd->state = HC_STATE_SUSPENDED;
1636 bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
1637 spin_unlock_irqrestore(&xhci->lock, flags);
1642 * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
1643 * warm reset a USB3 device stuck in polling or compliance mode after resume.
1644 * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
1646 static bool xhci_port_missing_cas_quirk(struct xhci_port *port)
1650 portsc = readl(port->addr);
1652 /* if any of these are set we are not stuck */
1653 if (portsc & (PORT_CONNECT | PORT_CAS))
1656 if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
1657 ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
1660 /* clear wakeup/change bits, and do a warm port reset */
1661 portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1663 writel(portsc, port->addr);
1669 int xhci_bus_resume(struct usb_hcd *hcd)
1671 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1672 struct xhci_bus_state *bus_state;
1673 unsigned long flags;
1674 int max_ports, port_index;
1679 struct xhci_hub *rhub;
1680 struct xhci_port **ports;
1682 rhub = xhci_get_rhub(hcd);
1683 ports = rhub->ports;
1684 max_ports = rhub->num_ports;
1685 bus_state = &rhub->bus_state;
1687 if (time_before(jiffies, bus_state->next_statechange))
1690 spin_lock_irqsave(&xhci->lock, flags);
1691 if (!HCD_HW_ACCESSIBLE(hcd)) {
1692 spin_unlock_irqrestore(&xhci->lock, flags);
1696 /* delay the irqs */
1697 temp = readl(&xhci->op_regs->command);
1699 writel(temp, &xhci->op_regs->command);
1701 /* bus specific resume for ports we suspended at bus_suspend */
1702 if (hcd->speed >= HCD_USB3)
1703 next_state = XDEV_U0;
1705 next_state = XDEV_RESUME;
1707 port_index = max_ports;
1708 while (port_index--) {
1709 portsc = readl(ports[port_index]->addr);
1711 /* warm reset CAS limited ports stuck in polling/compliance */
1712 if ((xhci->quirks & XHCI_MISSING_CAS) &&
1713 (hcd->speed >= HCD_USB3) &&
1714 xhci_port_missing_cas_quirk(ports[port_index])) {
1715 xhci_dbg(xhci, "reset stuck port %d\n", port_index);
1716 clear_bit(port_index, &bus_state->bus_suspended);
1719 /* resume if we suspended the link, and it is still suspended */
1720 if (test_bit(port_index, &bus_state->bus_suspended))
1721 switch (portsc & PORT_PLS_MASK) {
1723 portsc = xhci_port_state_to_neutral(portsc);
1724 portsc &= ~PORT_PLS_MASK;
1725 portsc |= PORT_LINK_STROBE | next_state;
1728 /* resume already initiated */
1731 /* not in a resumeable state, ignore it */
1732 clear_bit(port_index,
1733 &bus_state->bus_suspended);
1736 /* disable wake for all ports, write new link state if needed */
1737 portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1738 writel(portsc, ports[port_index]->addr);
1741 /* USB2 specific resume signaling delay and U0 link state transition */
1742 if (hcd->speed < HCD_USB3) {
1743 if (bus_state->bus_suspended) {
1744 spin_unlock_irqrestore(&xhci->lock, flags);
1745 msleep(USB_RESUME_TIMEOUT);
1746 spin_lock_irqsave(&xhci->lock, flags);
1748 for_each_set_bit(port_index, &bus_state->bus_suspended,
1750 /* Clear PLC to poll it later for U0 transition */
1751 xhci_test_and_clear_bit(xhci, ports[port_index],
1753 xhci_set_link_state(xhci, ports[port_index], XDEV_U0);
1757 /* poll for U0 link state complete, both USB2 and USB3 */
1758 for_each_set_bit(port_index, &bus_state->bus_suspended, BITS_PER_LONG) {
1759 sret = xhci_handshake(ports[port_index]->addr, PORT_PLC,
1760 PORT_PLC, 10 * 1000);
1762 xhci_warn(xhci, "port %d resume PLC timeout\n",
1766 xhci_test_and_clear_bit(xhci, ports[port_index], PORT_PLC);
1767 slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
1769 xhci_ring_device(xhci, slot_id);
1771 (void) readl(&xhci->op_regs->command);
1773 bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
1774 /* re-enable irqs */
1775 temp = readl(&xhci->op_regs->command);
1777 writel(temp, &xhci->op_regs->command);
1778 temp = readl(&xhci->op_regs->command);
1780 spin_unlock_irqrestore(&xhci->lock, flags);
1784 unsigned long xhci_get_resuming_ports(struct usb_hcd *hcd)
1786 struct xhci_hub *rhub = xhci_get_rhub(hcd);
1788 /* USB3 port wakeups are reported via usb_wakeup_notification() */
1789 return rhub->bus_state.resuming_ports; /* USB2 ports only */
1792 #endif /* CONFIG_PM */