Merge tag 'trace-v5.11-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...

[linux/fpc-iii.git] / drivers / usb / host / xhci-hub.c

// SPDX-License-Identifier: GPL-2.0
/*
 * xHCI host controller driver
 *
 * Copyright (C) 2008 Intel Corp.
 *
 * Author: Sarah Sharp
 * Some code borrowed from the Linux EHCI driver.
 */


#include <linux/slab.h>
#include <asm/unaligned.h>

#include "xhci.h"
#include "xhci-trace.h"

#define PORT_WAKE_BITS  (PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E)
#define PORT_RWC_BITS   (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
                         PORT_RC | PORT_PLC | PORT_PE)

/* USB 3 BOS descriptor and a capability descriptors, combined.
 * Fields will be adjusted and added later in xhci_create_usb3_bos_desc()
 */
static u8 usb_bos_descriptor [] = {
        USB_DT_BOS_SIZE,                /*  __u8 bLength, 5 bytes */
        USB_DT_BOS,                     /*  __u8 bDescriptorType */
        0x0F, 0x00,                     /*  __le16 wTotalLength, 15 bytes */
        0x1,                            /*  __u8 bNumDeviceCaps */
        /* First device capability, SuperSpeed */
        USB_DT_USB_SS_CAP_SIZE,         /*  __u8 bLength, 10 bytes */
        USB_DT_DEVICE_CAPABILITY,       /* Device Capability */
        USB_SS_CAP_TYPE,                /* bDevCapabilityType, SUPERSPEED_USB */
        0x00,                           /* bmAttributes, LTM off by default */
        USB_5GBPS_OPERATION, 0x00,      /* wSpeedsSupported, 5Gbps only */
        0x03,                           /* bFunctionalitySupport,
                                           USB 3.0 speed only */
        0x00,                           /* bU1DevExitLat, set later. */
        0x00, 0x00,                     /* __le16 bU2DevExitLat, set later. */
        /* Second device capability, SuperSpeedPlus */
        0x1c,                           /* bLength 28, will be adjusted later */
        USB_DT_DEVICE_CAPABILITY,       /* Device Capability */
        USB_SSP_CAP_TYPE,               /* bDevCapabilityType SUPERSPEED_PLUS */
        0x00,                           /* bReserved 0 */
        0x23, 0x00, 0x00, 0x00,         /* bmAttributes, SSAC=3 SSIC=1 */
        0x01, 0x00,                     /* wFunctionalitySupport */
        0x00, 0x00,                     /* wReserved 0 */
        /* Default Sublink Speed Attributes, overwrite if custom PSI exists */
        0x34, 0x00, 0x05, 0x00,         /* 5Gbps, symmetric, rx, ID = 4 */
        0xb4, 0x00, 0x05, 0x00,         /* 5Gbps, symmetric, tx, ID = 4 */
        0x35, 0x40, 0x0a, 0x00,         /* 10Gbps, SSP, symmetric, rx, ID = 5 */
        0xb5, 0x40, 0x0a, 0x00,         /* 10Gbps, SSP, symmetric, tx, ID = 5 */
};

static int xhci_create_usb3_bos_desc(struct xhci_hcd *xhci, char *buf,
                                     u16 wLength)
{
        struct xhci_port_cap *port_cap = NULL;
        int i, ssa_count;
        u32 temp;
        u16 desc_size, ssp_cap_size, ssa_size = 0;
        bool usb3_1 = false;

        desc_size = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
        ssp_cap_size = sizeof(usb_bos_descriptor) - desc_size;

        /* does xhci support USB 3.1 Enhanced SuperSpeed */
        for (i = 0; i < xhci->num_port_caps; i++) {
                if (xhci->port_caps[i].maj_rev == 0x03 &&
                    xhci->port_caps[i].min_rev >= 0x01) {
                        usb3_1 = true;
                        port_cap = &xhci->port_caps[i];
                        break;
                }
        }

        if (usb3_1) {
                /* does xhci provide a PSI table for SSA speed attributes? */
                if (port_cap->psi_count) {
                        /* two SSA entries for each unique PSI ID, RX and TX */
                        ssa_count = port_cap->psi_uid_count * 2;
                        ssa_size = ssa_count * sizeof(u32);
                        ssp_cap_size -= 16; /* skip copying the default SSA */
                }
                desc_size += ssp_cap_size;
        }
        memcpy(buf, &usb_bos_descriptor, min(desc_size, wLength));

        if (usb3_1) {
                /* modify bos descriptor bNumDeviceCaps and wTotalLength */
                buf[4] += 1;
                put_unaligned_le16(desc_size + ssa_size, &buf[2]);
        }

        if (wLength < USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE)
                return wLength;

        /* Indicate whether the host has LTM support. */
        temp = readl(&xhci->cap_regs->hcc_params);
        if (HCC_LTC(temp))
                buf[8] |= USB_LTM_SUPPORT;

        /* Set the U1 and U2 exit latencies. */
        if ((xhci->quirks & XHCI_LPM_SUPPORT)) {
                temp = readl(&xhci->cap_regs->hcs_params3);
                buf[12] = HCS_U1_LATENCY(temp);
                put_unaligned_le16(HCS_U2_LATENCY(temp), &buf[13]);
        }

        /* If PSI table exists, add the custom speed attributes from it */
        if (usb3_1 && port_cap->psi_count) {
                u32 ssp_cap_base, bm_attrib, psi, psi_mant, psi_exp;
                int offset;

                ssp_cap_base = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;

                if (wLength < desc_size)
                        return wLength;
                buf[ssp_cap_base] = ssp_cap_size + ssa_size;

                /* attribute count SSAC bits 4:0 and ID count SSIC bits 8:5 */
                bm_attrib = (ssa_count - 1) & 0x1f;
                bm_attrib |= (port_cap->psi_uid_count - 1) << 5;
                put_unaligned_le32(bm_attrib, &buf[ssp_cap_base + 4]);

                if (wLength < desc_size + ssa_size)
                        return wLength;
                /*
                 * Create the Sublink Speed Attributes (SSA) array.
                 * The xhci PSI field and USB 3.1 SSA fields are very similar,
                 * but link type bits 7:6 differ for values 01b and 10b.
                 * xhci has also only one PSI entry for a symmetric link when
                 * USB 3.1 requires two SSA entries (RX and TX) for every link
                 */
                offset = desc_size;
                for (i = 0; i < port_cap->psi_count; i++) {
                        psi = port_cap->psi[i];
                        psi &= ~USB_SSP_SUBLINK_SPEED_RSVD;
                        psi_exp = XHCI_EXT_PORT_PSIE(psi);
                        psi_mant = XHCI_EXT_PORT_PSIM(psi);

                        /* Shift to Gbps and set SSP Link BIT(14) if 10Gpbs */
                        for (; psi_exp < 3; psi_exp++)
                                psi_mant /= 1000;
                        if (psi_mant >= 10)
                                psi |= BIT(14);

                        if ((psi & PLT_MASK) == PLT_SYM) {
                        /* Symmetric, create SSA RX and TX from one PSI entry */
                                put_unaligned_le32(psi, &buf[offset]);
                                psi |= 1 << 7;  /* turn entry to TX */
                                offset += 4;
                                if (offset >= desc_size + ssa_size)
                                        return desc_size + ssa_size;
                        } else if ((psi & PLT_MASK) == PLT_ASYM_RX) {
                                /* Asymetric RX, flip bits 7:6 for SSA */
                                psi ^= PLT_MASK;
                        }
                        put_unaligned_le32(psi, &buf[offset]);
                        offset += 4;
                        if (offset >= desc_size + ssa_size)
                                return desc_size + ssa_size;
                }
        }
        /* ssa_size is 0 for other than usb 3.1 hosts */
        return desc_size + ssa_size;
}

static void xhci_common_hub_descriptor(struct xhci_hcd *xhci,
                struct usb_hub_descriptor *desc, int ports)
{
        u16 temp;

        desc->bPwrOn2PwrGood = 10;      /* xhci section 5.4.9 says 20ms max */
        desc->bHubContrCurrent = 0;

        desc->bNbrPorts = ports;
        temp = 0;
        /* Bits 1:0 - support per-port power switching, or power always on */
        if (HCC_PPC(xhci->hcc_params))
                temp |= HUB_CHAR_INDV_PORT_LPSM;
        else
                temp |= HUB_CHAR_NO_LPSM;
        /* Bit  2 - root hubs are not part of a compound device */
        /* Bits 4:3 - individual port over current protection */
        temp |= HUB_CHAR_INDV_PORT_OCPM;
        /* Bits 6:5 - no TTs in root ports */
        /* Bit  7 - no port indicators */
        desc->wHubCharacteristics = cpu_to_le16(temp);
}

/* Fill in the USB 2.0 roothub descriptor */
static void xhci_usb2_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
                struct usb_hub_descriptor *desc)
{
        int ports;
        u16 temp;
        __u8 port_removable[(USB_MAXCHILDREN + 1 + 7) / 8];
        u32 portsc;
        unsigned int i;
        struct xhci_hub *rhub;

        rhub = &xhci->usb2_rhub;
        ports = rhub->num_ports;
        xhci_common_hub_descriptor(xhci, desc, ports);
        desc->bDescriptorType = USB_DT_HUB;
        temp = 1 + (ports / 8);
        desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * temp;

        /* The Device Removable bits are reported on a byte granularity.
         * If the port doesn't exist within that byte, the bit is set to 0.
         */
        memset(port_removable, 0, sizeof(port_removable));
        for (i = 0; i < ports; i++) {
                portsc = readl(rhub->ports[i]->addr);
                /* If a device is removable, PORTSC reports a 0, same as in the
                 * hub descriptor DeviceRemovable bits.
                 */
                if (portsc & PORT_DEV_REMOVE)
                        /* This math is hairy because bit 0 of DeviceRemovable
                         * is reserved, and bit 1 is for port 1, etc.
                         */
                        port_removable[(i + 1) / 8] |= 1 << ((i + 1) % 8);
        }

        /* ch11.h defines a hub descriptor that has room for USB_MAXCHILDREN
         * ports on it.  The USB 2.0 specification says that there are two
         * variable length fields at the end of the hub descriptor:
         * DeviceRemovable and PortPwrCtrlMask.  But since we can have less than
         * USB_MAXCHILDREN ports, we may need to use the DeviceRemovable array
         * to set PortPwrCtrlMask bits.  PortPwrCtrlMask must always be set to
         * 0xFF, so we initialize the both arrays (DeviceRemovable and
         * PortPwrCtrlMask) to 0xFF.  Then we set the DeviceRemovable for each
         * set of ports that actually exist.
         */
        memset(desc->u.hs.DeviceRemovable, 0xff,
                        sizeof(desc->u.hs.DeviceRemovable));
        memset(desc->u.hs.PortPwrCtrlMask, 0xff,
                        sizeof(desc->u.hs.PortPwrCtrlMask));

        for (i = 0; i < (ports + 1 + 7) / 8; i++)
                memset(&desc->u.hs.DeviceRemovable[i], port_removable[i],
                                sizeof(__u8));
}

/* Fill in the USB 3.0 roothub descriptor */
static void xhci_usb3_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
                struct usb_hub_descriptor *desc)
{
        int ports;
        u16 port_removable;
        u32 portsc;
        unsigned int i;
        struct xhci_hub *rhub;

        rhub = &xhci->usb3_rhub;
        ports = rhub->num_ports;
        xhci_common_hub_descriptor(xhci, desc, ports);
        desc->bDescriptorType = USB_DT_SS_HUB;
        desc->bDescLength = USB_DT_SS_HUB_SIZE;

        /* header decode latency should be zero for roothubs,
         * see section 4.23.5.2.
         */
        desc->u.ss.bHubHdrDecLat = 0;
        desc->u.ss.wHubDelay = 0;

        port_removable = 0;
        /* bit 0 is reserved, bit 1 is for port 1, etc. */
        for (i = 0; i < ports; i++) {
                portsc = readl(rhub->ports[i]->addr);
                if (portsc & PORT_DEV_REMOVE)
                        port_removable |= 1 << (i + 1);
        }

        desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
}

static void xhci_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
                struct usb_hub_descriptor *desc)
{

        if (hcd->speed >= HCD_USB3)
                xhci_usb3_hub_descriptor(hcd, xhci, desc);
        else
                xhci_usb2_hub_descriptor(hcd, xhci, desc);

}

static unsigned int xhci_port_speed(unsigned int port_status)
{
        if (DEV_LOWSPEED(port_status))
                return USB_PORT_STAT_LOW_SPEED;
        if (DEV_HIGHSPEED(port_status))
                return USB_PORT_STAT_HIGH_SPEED;
        /*
         * FIXME: Yes, we should check for full speed, but the core uses that as
         * a default in portspeed() in usb/core/hub.c (which is the only place
         * USB_PORT_STAT_*_SPEED is used).
         */
        return 0;
}

/*
 * These bits are Read Only (RO) and should be saved and written to the
 * registers: 0, 3, 10:13, 30
 * connect status, over-current status, port speed, and device removable.
 * connect status and port speed are also sticky - meaning they're in
 * the AUX well and they aren't changed by a hot, warm, or cold reset.
 */
#define XHCI_PORT_RO    ((1<<0) | (1<<3) | (0xf<<10) | (1<<30))
/*
 * These bits are RW; writing a 0 clears the bit, writing a 1 sets the bit:
 * bits 5:8, 9, 14:15, 25:27
 * link state, port power, port indicator state, "wake on" enable state
 */
#define XHCI_PORT_RWS   ((0xf<<5) | (1<<9) | (0x3<<14) | (0x7<<25))
/*
 * These bits are RW; writing a 1 sets the bit, writing a 0 has no effect:
 * bit 4 (port reset)
 */
#define XHCI_PORT_RW1S  ((1<<4))
/*
 * These bits are RW; writing a 1 clears the bit, writing a 0 has no effect:
 * bits 1, 17, 18, 19, 20, 21, 22, 23
 * port enable/disable, and
 * change bits: connect, PED, warm port reset changed (reserved zero for USB 2.0 ports),
 * over-current, reset, link state, and L1 change
 */
#define XHCI_PORT_RW1CS ((1<<1) | (0x7f<<17))
/*
 * Bit 16 is RW, and writing a '1' to it causes the link state control to be
 * latched in
 */
#define XHCI_PORT_RW    ((1<<16))
/*
 * These bits are Reserved Zero (RsvdZ) and zero should be written to them:
 * bits 2, 24, 28:31
 */
#define XHCI_PORT_RZ    ((1<<2) | (1<<24) | (0xf<<28))

/*
 * Given a port state, this function returns a value that would result in the
 * port being in the same state, if the value was written to the port status
 * control register.
 * Save Read Only (RO) bits and save read/write bits where
 * writing a 0 clears the bit and writing a 1 sets the bit (RWS).
 * For all other types (RW1S, RW1CS, RW, and RZ), writing a '0' has no effect.
 */
u32 xhci_port_state_to_neutral(u32 state)
{
        /* Save read-only status and port state */
        return (state & XHCI_PORT_RO) | (state & XHCI_PORT_RWS);
}

/*
 * find slot id based on port number.
 * @port: The one-based port number from one of the two split roothubs.
 */
int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
                u16 port)
{
        int slot_id;
        int i;
        enum usb_device_speed speed;

        slot_id = 0;
        for (i = 0; i < MAX_HC_SLOTS; i++) {
                if (!xhci->devs[i] || !xhci->devs[i]->udev)
                        continue;
                speed = xhci->devs[i]->udev->speed;
                if (((speed >= USB_SPEED_SUPER) == (hcd->speed >= HCD_USB3))
                                && xhci->devs[i]->fake_port == port) {
                        slot_id = i;
                        break;
                }
        }

        return slot_id;
}

/*
 * Stop device
 * It issues stop endpoint command for EP 0 to 30. And wait the last command
 * to complete.
 * suspend will set to 1, if suspend bit need to set in command.
 */
static int xhci_stop_device(struct xhci_hcd *xhci, int slot_id, int suspend)
{
        struct xhci_virt_device *virt_dev;
        struct xhci_command *cmd;
        unsigned long flags;
        int ret;
        int i;

        ret = 0;
        virt_dev = xhci->devs[slot_id];
        if (!virt_dev)
                return -ENODEV;

        trace_xhci_stop_device(virt_dev);

        cmd = xhci_alloc_command(xhci, true, GFP_NOIO);
        if (!cmd)
                return -ENOMEM;

        spin_lock_irqsave(&xhci->lock, flags);
        for (i = LAST_EP_INDEX; i > 0; i--) {
                if (virt_dev->eps[i].ring && virt_dev->eps[i].ring->dequeue) {
                        struct xhci_ep_ctx *ep_ctx;
                        struct xhci_command *command;

                        ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->out_ctx, i);

                        /* Check ep is running, required by AMD SNPS 3.1 xHC */
                        if (GET_EP_CTX_STATE(ep_ctx) != EP_STATE_RUNNING)
                                continue;

                        command = xhci_alloc_command(xhci, false, GFP_NOWAIT);
                        if (!command) {
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                ret = -ENOMEM;
                                goto cmd_cleanup;
                        }

                        ret = xhci_queue_stop_endpoint(xhci, command, slot_id,
                                                       i, suspend);
                        if (ret) {
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                xhci_free_command(xhci, command);
                                goto cmd_cleanup;
                        }
                }
        }
        ret = xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
        if (ret) {
                spin_unlock_irqrestore(&xhci->lock, flags);
                goto cmd_cleanup;
        }

        xhci_ring_cmd_db(xhci);
        spin_unlock_irqrestore(&xhci->lock, flags);

        /* Wait for last stop endpoint command to finish */
        wait_for_completion(cmd->completion);

        if (cmd->status == COMP_COMMAND_ABORTED ||
            cmd->status == COMP_COMMAND_RING_STOPPED) {
                xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
                ret = -ETIME;
        }

cmd_cleanup:
        xhci_free_command(xhci, cmd);
        return ret;
}

/*
 * Ring device, it rings the all doorbells unconditionally.
 */
void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
{
        int i, s;
        struct xhci_virt_ep *ep;

        for (i = 0; i < LAST_EP_INDEX + 1; i++) {
                ep = &xhci->devs[slot_id]->eps[i];

                if (ep->ep_state & EP_HAS_STREAMS) {
                        for (s = 1; s < ep->stream_info->num_streams; s++)
                                xhci_ring_ep_doorbell(xhci, slot_id, i, s);
                } else if (ep->ring && ep->ring->dequeue) {
                        xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
                }
        }

        return;
}

static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
                u16 wIndex, __le32 __iomem *addr, u32 port_status)
{
        /* Don't allow the USB core to disable SuperSpeed ports. */
        if (hcd->speed >= HCD_USB3) {
                xhci_dbg(xhci, "Ignoring request to disable "
                                "SuperSpeed port.\n");
                return;
        }

        if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
                xhci_dbg(xhci,
                         "Broken Port Enabled/Disabled, ignoring port disable request.\n");
                return;
        }

        /* Write 1 to disable the port */
        writel(port_status | PORT_PE, addr);
        port_status = readl(addr);
        xhci_dbg(xhci, "disable port %d-%d, portsc: 0x%x\n",
                 hcd->self.busnum, wIndex + 1, port_status);
}

static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
                u16 wIndex, __le32 __iomem *addr, u32 port_status)
{
        char *port_change_bit;
        u32 status;

        switch (wValue) {
        case USB_PORT_FEAT_C_RESET:
                status = PORT_RC;
                port_change_bit = "reset";
                break;
        case USB_PORT_FEAT_C_BH_PORT_RESET:
                status = PORT_WRC;
                port_change_bit = "warm(BH) reset";
                break;
        case USB_PORT_FEAT_C_CONNECTION:
                status = PORT_CSC;
                port_change_bit = "connect";
                break;
        case USB_PORT_FEAT_C_OVER_CURRENT:
                status = PORT_OCC;
                port_change_bit = "over-current";
                break;
        case USB_PORT_FEAT_C_ENABLE:
                status = PORT_PEC;
                port_change_bit = "enable/disable";
                break;
        case USB_PORT_FEAT_C_SUSPEND:
                status = PORT_PLC;
                port_change_bit = "suspend/resume";
                break;
        case USB_PORT_FEAT_C_PORT_LINK_STATE:
                status = PORT_PLC;
                port_change_bit = "link state";
                break;
        case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
                status = PORT_CEC;
                port_change_bit = "config error";
                break;
        default:
                /* Should never happen */
                return;
        }
        /* Change bits are all write 1 to clear */
        writel(port_status | status, addr);
        port_status = readl(addr);

        xhci_dbg(xhci, "clear port%d %s change, portsc: 0x%x\n",
                 wIndex + 1, port_change_bit, port_status);
}

struct xhci_hub *xhci_get_rhub(struct usb_hcd *hcd)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);

        if (hcd->speed >= HCD_USB3)
                return &xhci->usb3_rhub;
        return &xhci->usb2_rhub;
}

/*
 * xhci_set_port_power() must be called with xhci->lock held.
 * It will release and re-aquire the lock while calling ACPI
 * method.
 */
static void xhci_set_port_power(struct xhci_hcd *xhci, struct usb_hcd *hcd,
                                u16 index, bool on, unsigned long *flags)
        __must_hold(&xhci->lock)
{
        struct xhci_hub *rhub;
        struct xhci_port *port;
        u32 temp;

        rhub = xhci_get_rhub(hcd);
        port = rhub->ports[index];
        temp = readl(port->addr);

        xhci_dbg(xhci, "set port power %d-%d %s, portsc: 0x%x\n",
                 hcd->self.busnum, index + 1, on ? "ON" : "OFF", temp);

        temp = xhci_port_state_to_neutral(temp);

        if (on) {
                /* Power on */
                writel(temp | PORT_POWER, port->addr);
                readl(port->addr);
        } else {
                /* Power off */
                writel(temp & ~PORT_POWER, port->addr);
        }

        spin_unlock_irqrestore(&xhci->lock, *flags);
        temp = usb_acpi_power_manageable(hcd->self.root_hub,
                                        index);
        if (temp)
                usb_acpi_set_power_state(hcd->self.root_hub,
                        index, on);
        spin_lock_irqsave(&xhci->lock, *flags);
}

static void xhci_port_set_test_mode(struct xhci_hcd *xhci,
        u16 test_mode, u16 wIndex)
{
        u32 temp;
        struct xhci_port *port;

        /* xhci only supports test mode for usb2 ports */
        port = xhci->usb2_rhub.ports[wIndex];
        temp = readl(port->addr + PORTPMSC);
        temp |= test_mode << PORT_TEST_MODE_SHIFT;
        writel(temp, port->addr + PORTPMSC);
        xhci->test_mode = test_mode;
        if (test_mode == USB_TEST_FORCE_ENABLE)
                xhci_start(xhci);
}

static int xhci_enter_test_mode(struct xhci_hcd *xhci,
                                u16 test_mode, u16 wIndex, unsigned long *flags)
        __must_hold(&xhci->lock)
{
        int i, retval;

        /* Disable all Device Slots */
        xhci_dbg(xhci, "Disable all slots\n");
        spin_unlock_irqrestore(&xhci->lock, *flags);
        for (i = 1; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
                if (!xhci->devs[i])
                        continue;

                retval = xhci_disable_slot(xhci, i);
                if (retval)
                        xhci_err(xhci, "Failed to disable slot %d, %d. Enter test mode anyway\n",
                                 i, retval);
        }
        spin_lock_irqsave(&xhci->lock, *flags);
        /* Put all ports to the Disable state by clear PP */
        xhci_dbg(xhci, "Disable all port (PP = 0)\n");
        /* Power off USB3 ports*/
        for (i = 0; i < xhci->usb3_rhub.num_ports; i++)
                xhci_set_port_power(xhci, xhci->shared_hcd, i, false, flags);
        /* Power off USB2 ports*/
        for (i = 0; i < xhci->usb2_rhub.num_ports; i++)
                xhci_set_port_power(xhci, xhci->main_hcd, i, false, flags);
        /* Stop the controller */
        xhci_dbg(xhci, "Stop controller\n");
        retval = xhci_halt(xhci);
        if (retval)
                return retval;
        /* Disable runtime PM for test mode */
        pm_runtime_forbid(xhci_to_hcd(xhci)->self.controller);
        /* Set PORTPMSC.PTC field to enter selected test mode */
        /* Port is selected by wIndex. port_id = wIndex + 1 */
        xhci_dbg(xhci, "Enter Test Mode: %d, Port_id=%d\n",
                                        test_mode, wIndex + 1);
        xhci_port_set_test_mode(xhci, test_mode, wIndex);
        return retval;
}

static int xhci_exit_test_mode(struct xhci_hcd *xhci)
{
        int retval;

        if (!xhci->test_mode) {
                xhci_err(xhci, "Not in test mode, do nothing.\n");
                return 0;
        }
        if (xhci->test_mode == USB_TEST_FORCE_ENABLE &&
                !(xhci->xhc_state & XHCI_STATE_HALTED)) {
                retval = xhci_halt(xhci);
                if (retval)
                        return retval;
        }
        pm_runtime_allow(xhci_to_hcd(xhci)->self.controller);
        xhci->test_mode = 0;
        return xhci_reset(xhci);
}

void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
                         u32 link_state)
{
        u32 temp;
        u32 portsc;

        portsc = readl(port->addr);
        temp = xhci_port_state_to_neutral(portsc);
        temp &= ~PORT_PLS_MASK;
        temp |= PORT_LINK_STROBE | link_state;
        writel(temp, port->addr);

        xhci_dbg(xhci, "Set port %d-%d link state, portsc: 0x%x, write 0x%x",
                 port->rhub->hcd->self.busnum, port->hcd_portnum + 1,
                 portsc, temp);
}

static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
                                      struct xhci_port *port, u16 wake_mask)
{
        u32 temp;

        temp = readl(port->addr);
        temp = xhci_port_state_to_neutral(temp);

        if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
                temp |= PORT_WKCONN_E;
        else
                temp &= ~PORT_WKCONN_E;

        if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
                temp |= PORT_WKDISC_E;
        else
                temp &= ~PORT_WKDISC_E;

        if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
                temp |= PORT_WKOC_E;
        else
                temp &= ~PORT_WKOC_E;

        writel(temp, port->addr);
}

/* Test and clear port RWC bit */
void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
                             u32 port_bit)
{
        u32 temp;

        temp = readl(port->addr);
        if (temp & port_bit) {
                temp = xhci_port_state_to_neutral(temp);
                temp |= port_bit;
                writel(temp, port->addr);
        }
}

/* Updates Link Status for super Speed port */
static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
                u32 *status, u32 status_reg)
{
        u32 pls = status_reg & PORT_PLS_MASK;

        /* When the CAS bit is set then warm reset
         * should be performed on port
         */
        if (status_reg & PORT_CAS) {
                /* The CAS bit can be set while the port is
                 * in any link state.
                 * Only roothubs have CAS bit, so we
                 * pretend to be in compliance mode
                 * unless we're already in compliance
                 * or the inactive state.
                 */
                if (pls != USB_SS_PORT_LS_COMP_MOD &&
                    pls != USB_SS_PORT_LS_SS_INACTIVE) {
                        pls = USB_SS_PORT_LS_COMP_MOD;
                }
                /* Return also connection bit -
                 * hub state machine resets port
                 * when this bit is set.
                 */
                pls |= USB_PORT_STAT_CONNECTION;
        } else {
                /*
                 * Resume state is an xHCI internal state.  Do not report it to
                 * usb core, instead, pretend to be U3, thus usb core knows
                 * it's not ready for transfer.
                 */
                if (pls == XDEV_RESUME) {
                        *status |= USB_SS_PORT_LS_U3;
                        return;
                }

                /*
                 * If CAS bit isn't set but the Port is already at
                 * Compliance Mode, fake a connection so the USB core
                 * notices the Compliance state and resets the port.
                 * This resolves an issue generated by the SN65LVPE502CP
                 * in which sometimes the port enters compliance mode
                 * caused by a delay on the host-device negotiation.
                 */
                if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
                                (pls == USB_SS_PORT_LS_COMP_MOD))
                        pls |= USB_PORT_STAT_CONNECTION;
        }

        /* update status field */
        *status |= pls;
}

/*
 * Function for Compliance Mode Quirk.
 *
 * This Function verifies if all xhc USB3 ports have entered U0, if so,
 * the compliance mode timer is deleted. A port won't enter
 * compliance mode if it has previously entered U0.
 */
static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
                                    u16 wIndex)
{
        u32 all_ports_seen_u0 = ((1 << xhci->usb3_rhub.num_ports) - 1);
        bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);

        if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
                return;

        if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
                xhci->port_status_u0 |= 1 << wIndex;
                if (xhci->port_status_u0 == all_ports_seen_u0) {
                        del_timer_sync(&xhci->comp_mode_recovery_timer);
                        xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "All USB3 ports have entered U0 already!");
                        xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
                                "Compliance Mode Recovery Timer Deleted.");
                }
        }
}

static int xhci_handle_usb2_port_link_resume(struct xhci_port *port,
                                             u32 *status, u32 portsc,
                                             unsigned long *flags)
{
        struct xhci_bus_state *bus_state;
        struct xhci_hcd *xhci;
        struct usb_hcd *hcd;
        int slot_id;
        u32 wIndex;

        hcd = port->rhub->hcd;
        bus_state = &port->rhub->bus_state;
        xhci = hcd_to_xhci(hcd);
        wIndex = port->hcd_portnum;

        if ((portsc & PORT_RESET) || !(portsc & PORT_PE)) {
                *status = 0xffffffff;
                return -EINVAL;
        }
        /* did port event handler already start resume timing? */
        if (!bus_state->resume_done[wIndex]) {
                /* If not, maybe we are in a host initated resume? */
                if (test_bit(wIndex, &bus_state->resuming_ports)) {
                        /* Host initated resume doesn't time the resume
                         * signalling using resume_done[].
                         * It manually sets RESUME state, sleeps 20ms
                         * and sets U0 state. This should probably be
                         * changed, but not right now.
                         */
                } else {
                        /* port resume was discovered now and here,
                         * start resume timing
                         */
                        unsigned long timeout = jiffies +
                                msecs_to_jiffies(USB_RESUME_TIMEOUT);

                        set_bit(wIndex, &bus_state->resuming_ports);
                        bus_state->resume_done[wIndex] = timeout;
                        mod_timer(&hcd->rh_timer, timeout);
                        usb_hcd_start_port_resume(&hcd->self, wIndex);
                }
        /* Has resume been signalled for USB_RESUME_TIME yet? */
        } else if (time_after_eq(jiffies, bus_state->resume_done[wIndex])) {
                int time_left;

                xhci_dbg(xhci, "resume USB2 port %d-%d\n",
                         hcd->self.busnum, wIndex + 1);

                bus_state->resume_done[wIndex] = 0;
                clear_bit(wIndex, &bus_state->resuming_ports);

                set_bit(wIndex, &bus_state->rexit_ports);

                xhci_test_and_clear_bit(xhci, port, PORT_PLC);
                xhci_set_link_state(xhci, port, XDEV_U0);

                spin_unlock_irqrestore(&xhci->lock, *flags);
                time_left = wait_for_completion_timeout(
                        &bus_state->rexit_done[wIndex],
                        msecs_to_jiffies(XHCI_MAX_REXIT_TIMEOUT_MS));
                spin_lock_irqsave(&xhci->lock, *flags);

                if (time_left) {
                        slot_id = xhci_find_slot_id_by_port(hcd, xhci,
                                                            wIndex + 1);
                        if (!slot_id) {
                                xhci_dbg(xhci, "slot_id is zero\n");
                                *status = 0xffffffff;
                                return -ENODEV;
                        }
                        xhci_ring_device(xhci, slot_id);
                } else {
                        int port_status = readl(port->addr);

                        xhci_warn(xhci, "Port resume timed out, port %d-%d: 0x%x\n",
                                  hcd->self.busnum, wIndex + 1, port_status);
                        *status |= USB_PORT_STAT_SUSPEND;
                        clear_bit(wIndex, &bus_state->rexit_ports);
                }

                usb_hcd_end_port_resume(&hcd->self, wIndex);
                bus_state->port_c_suspend |= 1 << wIndex;
                bus_state->suspended_ports &= ~(1 << wIndex);
        } else {
                /*
                 * The resume has been signaling for less than
                 * USB_RESUME_TIME. Report the port status as SUSPEND,
                 * let the usbcore check port status again and clear
                 * resume signaling later.
                 */
                *status |= USB_PORT_STAT_SUSPEND;
        }
        return 0;
}

static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
{
        u32 ext_stat = 0;
        int speed_id;

        /* only support rx and tx lane counts of 1 in usb3.1 spec */
        speed_id = DEV_PORT_SPEED(raw_port_status);
        ext_stat |= speed_id;           /* bits 3:0, RX speed id */
        ext_stat |= speed_id << 4;      /* bits 7:4, TX speed id */

        ext_stat |= PORT_RX_LANES(port_li) << 8;  /* bits 11:8 Rx lane count */
        ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */

        return ext_stat;
}

static void xhci_get_usb3_port_status(struct xhci_port *port, u32 *status,
                                      u32 portsc)
{
        struct xhci_bus_state *bus_state;
        struct xhci_hcd *xhci;
        struct usb_hcd *hcd;
        u32 link_state;
        u32 portnum;

        bus_state = &port->rhub->bus_state;
        xhci = hcd_to_xhci(port->rhub->hcd);
        hcd = port->rhub->hcd;
        link_state = portsc & PORT_PLS_MASK;
        portnum = port->hcd_portnum;

        /* USB3 specific wPortChange bits
         *
         * Port link change with port in resume state should not be
         * reported to usbcore, as this is an internal state to be
         * handled by xhci driver. Reporting PLC to usbcore may
         * cause usbcore clearing PLC first and port change event
         * irq won't be generated.
         */

        if (portsc & PORT_PLC && (link_state != XDEV_RESUME))
                *status |= USB_PORT_STAT_C_LINK_STATE << 16;
        if (portsc & PORT_WRC)
                *status |= USB_PORT_STAT_C_BH_RESET << 16;
        if (portsc & PORT_CEC)
                *status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;

        /* USB3 specific wPortStatus bits */
        if (portsc & PORT_POWER) {
                *status |= USB_SS_PORT_STAT_POWER;
                /* link state handling */
                if (link_state == XDEV_U0)
                        bus_state->suspended_ports &= ~(1 << portnum);
        }

        /* remote wake resume signaling complete */
        if (bus_state->port_remote_wakeup & (1 << portnum) &&
            link_state != XDEV_RESUME &&
            link_state != XDEV_RECOVERY) {
                bus_state->port_remote_wakeup &= ~(1 << portnum);
                usb_hcd_end_port_resume(&hcd->self, portnum);
        }

        xhci_hub_report_usb3_link_state(xhci, status, portsc);
        xhci_del_comp_mod_timer(xhci, portsc, portnum);
}

static void xhci_get_usb2_port_status(struct xhci_port *port, u32 *status,
                                      u32 portsc, unsigned long *flags)
{
        struct xhci_bus_state *bus_state;
        u32 link_state;
        u32 portnum;
        int ret;

        bus_state = &port->rhub->bus_state;
        link_state = portsc & PORT_PLS_MASK;
        portnum = port->hcd_portnum;

        /* USB2 wPortStatus bits */
        if (portsc & PORT_POWER) {
                *status |= USB_PORT_STAT_POWER;

                /* link state is only valid if port is powered */
                if (link_state == XDEV_U3)
                        *status |= USB_PORT_STAT_SUSPEND;
                if (link_state == XDEV_U2)
                        *status |= USB_PORT_STAT_L1;
                if (link_state == XDEV_U0) {
                        bus_state->resume_done[portnum] = 0;
                        clear_bit(portnum, &bus_state->resuming_ports);
                        if (bus_state->suspended_ports & (1 << portnum)) {
                                bus_state->suspended_ports &= ~(1 << portnum);
                                bus_state->port_c_suspend |= 1 << portnum;
                        }
                }
                if (link_state == XDEV_RESUME) {
                        ret = xhci_handle_usb2_port_link_resume(port, status,
                                                                portsc, flags);
                        if (ret)
                                return;
                }
        }
}

/*
 * Converts a raw xHCI port status into the format that external USB 2.0 or USB
 * 3.0 hubs use.
 *
 * Possible side effects:
 *  - Mark a port as being done with device resume,
 *    and ring the endpoint doorbells.
 *  - Stop the Synopsys redriver Compliance Mode polling.
 *  - Drop and reacquire the xHCI lock, in order to wait for port resume.
 */
static u32 xhci_get_port_status(struct usb_hcd *hcd,
                struct xhci_bus_state *bus_state,
        u16 wIndex, u32 raw_port_status,
                unsigned long *flags)
        __releases(&xhci->lock)
        __acquires(&xhci->lock)
{
        u32 status = 0;
        struct xhci_hub *rhub;
        struct xhci_port *port;

        rhub = xhci_get_rhub(hcd);
        port = rhub->ports[wIndex];

        /* common wPortChange bits */
        if (raw_port_status & PORT_CSC)
                status |= USB_PORT_STAT_C_CONNECTION << 16;
        if (raw_port_status & PORT_PEC)
                status |= USB_PORT_STAT_C_ENABLE << 16;
        if ((raw_port_status & PORT_OCC))
                status |= USB_PORT_STAT_C_OVERCURRENT << 16;
        if ((raw_port_status & PORT_RC))
                status |= USB_PORT_STAT_C_RESET << 16;

        /* common wPortStatus bits */
        if (raw_port_status & PORT_CONNECT) {
                status |= USB_PORT_STAT_CONNECTION;
                status |= xhci_port_speed(raw_port_status);
        }
        if (raw_port_status & PORT_PE)
                status |= USB_PORT_STAT_ENABLE;
        if (raw_port_status & PORT_OC)
                status |= USB_PORT_STAT_OVERCURRENT;
        if (raw_port_status & PORT_RESET)
                status |= USB_PORT_STAT_RESET;

        /* USB2 and USB3 specific bits, including Port Link State */
        if (hcd->speed >= HCD_USB3)
                xhci_get_usb3_port_status(port, &status, raw_port_status);
        else
                xhci_get_usb2_port_status(port, &status, raw_port_status,
                                          flags);
        /*
         * Clear stale usb2 resume signalling variables in case port changed
         * state during resume signalling. For example on error
         */
        if ((bus_state->resume_done[wIndex] ||
             test_bit(wIndex, &bus_state->resuming_ports)) &&
            (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
            (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
                bus_state->resume_done[wIndex] = 0;
                clear_bit(wIndex, &bus_state->resuming_ports);
                usb_hcd_end_port_resume(&hcd->self, wIndex);
        }

        if (bus_state->port_c_suspend & (1 << wIndex))
                status |= USB_PORT_STAT_C_SUSPEND << 16;

        return status;
}

int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
                u16 wIndex, char *buf, u16 wLength)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        int max_ports;
        unsigned long flags;
        u32 temp, status;
        int retval = 0;
        int slot_id;
        struct xhci_bus_state *bus_state;
        u16 link_state = 0;
        u16 wake_mask = 0;
        u16 timeout = 0;
        u16 test_mode = 0;
        struct xhci_hub *rhub;
        struct xhci_port **ports;

        rhub = xhci_get_rhub(hcd);
        ports = rhub->ports;
        max_ports = rhub->num_ports;
        bus_state = &rhub->bus_state;

        spin_lock_irqsave(&xhci->lock, flags);
        switch (typeReq) {
        case GetHubStatus:
                /* No power source, over-current reported per port */
                memset(buf, 0, 4);
                break;
        case GetHubDescriptor:
                /* Check to make sure userspace is asking for the USB 3.0 hub
                 * descriptor for the USB 3.0 roothub.  If not, we stall the
                 * endpoint, like external hubs do.
                 */
                if (hcd->speed >= HCD_USB3 &&
                                (wLength < USB_DT_SS_HUB_SIZE ||
                                 wValue != (USB_DT_SS_HUB << 8))) {
                        xhci_dbg(xhci, "Wrong hub descriptor type for "
                                        "USB 3.0 roothub.\n");
                        goto error;
                }
                xhci_hub_descriptor(hcd, xhci,
                                (struct usb_hub_descriptor *) buf);
                break;
        case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
                if ((wValue & 0xff00) != (USB_DT_BOS << 8))
                        goto error;

                if (hcd->speed < HCD_USB3)
                        goto error;

                retval = xhci_create_usb3_bos_desc(xhci, buf, wLength);
                spin_unlock_irqrestore(&xhci->lock, flags);
                return retval;
        case GetPortStatus:
                if (!wIndex || wIndex > max_ports)
                        goto error;
                wIndex--;
                temp = readl(ports[wIndex]->addr);
                if (temp == ~(u32)0) {
                        xhci_hc_died(xhci);
                        retval = -ENODEV;
                        break;
                }
                trace_xhci_get_port_status(wIndex, temp);
                status = xhci_get_port_status(hcd, bus_state, wIndex, temp,
                                              &flags);
                if (status == 0xffffffff)
                        goto error;

                xhci_dbg(xhci, "Get port status %d-%d read: 0x%x, return 0x%x",
                         hcd->self.busnum, wIndex + 1, temp, status);

                put_unaligned(cpu_to_le32(status), (__le32 *) buf);
                /* if USB 3.1 extended port status return additional 4 bytes */
                if (wValue == 0x02) {
                        u32 port_li;

                        if (hcd->speed < HCD_USB31 || wLength != 8) {
                                xhci_err(xhci, "get ext port status invalid parameter\n");
                                retval = -EINVAL;
                                break;
                        }
                        port_li = readl(ports[wIndex]->addr + PORTLI);
                        status = xhci_get_ext_port_status(temp, port_li);
                        put_unaligned_le32(status, &buf[4]);
                }
                break;
        case SetPortFeature:
                if (wValue == USB_PORT_FEAT_LINK_STATE)
                        link_state = (wIndex & 0xff00) >> 3;
                if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
                        wake_mask = wIndex & 0xff00;
                if (wValue == USB_PORT_FEAT_TEST)
                        test_mode = (wIndex & 0xff00) >> 8;
                /* The MSB of wIndex is the U1/U2 timeout */
                timeout = (wIndex & 0xff00) >> 8;
                wIndex &= 0xff;
                if (!wIndex || wIndex > max_ports)
                        goto error;
                wIndex--;
                temp = readl(ports[wIndex]->addr);
                if (temp == ~(u32)0) {
                        xhci_hc_died(xhci);
                        retval = -ENODEV;
                        break;
                }
                temp = xhci_port_state_to_neutral(temp);
                /* FIXME: What new port features do we need to support? */
                switch (wValue) {
                case USB_PORT_FEAT_SUSPEND:
                        temp = readl(ports[wIndex]->addr);
                        if ((temp & PORT_PLS_MASK) != XDEV_U0) {
                                /* Resume the port to U0 first */
                                xhci_set_link_state(xhci, ports[wIndex],
                                                        XDEV_U0);
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                msleep(10);
                                spin_lock_irqsave(&xhci->lock, flags);
                        }
                        /* In spec software should not attempt to suspend
                         * a port unless the port reports that it is in the
                         * enabled (PED = ‘1’,PLS < ‘3’) state.
                         */
                        temp = readl(ports[wIndex]->addr);
                        if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
                                || (temp & PORT_PLS_MASK) >= XDEV_U3) {
                                xhci_warn(xhci, "USB core suspending port %d-%d not in U0/U1/U2\n",
                                          hcd->self.busnum, wIndex + 1);
                                goto error;
                        }

                        slot_id = xhci_find_slot_id_by_port(hcd, xhci,
                                        wIndex + 1);
                        if (!slot_id) {
                                xhci_warn(xhci, "slot_id is zero\n");
                                goto error;
                        }
                        /* unlock to execute stop endpoint commands */
                        spin_unlock_irqrestore(&xhci->lock, flags);
                        xhci_stop_device(xhci, slot_id, 1);
                        spin_lock_irqsave(&xhci->lock, flags);

                        xhci_set_link_state(xhci, ports[wIndex], XDEV_U3);

                        spin_unlock_irqrestore(&xhci->lock, flags);
                        msleep(10); /* wait device to enter */
                        spin_lock_irqsave(&xhci->lock, flags);

                        temp = readl(ports[wIndex]->addr);
                        bus_state->suspended_ports |= 1 << wIndex;
                        break;
                case USB_PORT_FEAT_LINK_STATE:
                        temp = readl(ports[wIndex]->addr);
                        /* Disable port */
                        if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
                                xhci_dbg(xhci, "Disable port %d-%d\n",
                                         hcd->self.busnum, wIndex + 1);
                                temp = xhci_port_state_to_neutral(temp);
                                /*
                                 * Clear all change bits, so that we get a new
                                 * connection event.
                                 */
                                temp |= PORT_CSC | PORT_PEC | PORT_WRC |
                                        PORT_OCC | PORT_RC | PORT_PLC |
                                        PORT_CEC;
                                writel(temp | PORT_PE, ports[wIndex]->addr);
                                temp = readl(ports[wIndex]->addr);
                                break;
                        }

                        /* Put link in RxDetect (enable port) */
                        if (link_state == USB_SS_PORT_LS_RX_DETECT) {
                                xhci_dbg(xhci, "Enable port %d-%d\n",
                                         hcd->self.busnum, wIndex + 1);
                                xhci_set_link_state(xhci, ports[wIndex],
                                                        link_state);
                                temp = readl(ports[wIndex]->addr);
                                break;
                        }

                        /*
                         * For xHCI 1.1 according to section 4.19.1.2.4.1 a
                         * root hub port's transition to compliance mode upon
                         * detecting LFPS timeout may be controlled by an
                         * Compliance Transition Enabled (CTE) flag (not
                         * software visible). This flag is set by writing 0xA
                         * to PORTSC PLS field which will allow transition to
                         * compliance mode the next time LFPS timeout is
                         * encountered. A warm reset will clear it.
                         *
                         * The CTE flag is only supported if the HCCPARAMS2 CTC
                         * flag is set, otherwise, the compliance substate is
                         * automatically entered as on 1.0 and prior.
                         */
                        if (link_state == USB_SS_PORT_LS_COMP_MOD) {
                                if (!HCC2_CTC(xhci->hcc_params2)) {
                                        xhci_dbg(xhci, "CTC flag is 0, port already supports entering compliance mode\n");
                                        break;
                                }

                                if ((temp & PORT_CONNECT)) {
                                        xhci_warn(xhci, "Can't set compliance mode when port is connected\n");
                                        goto error;
                                }

                                xhci_dbg(xhci, "Enable compliance mode transition for port %d-%d\n",
                                         hcd->self.busnum, wIndex + 1);
                                xhci_set_link_state(xhci, ports[wIndex],
                                                link_state);

                                temp = readl(ports[wIndex]->addr);
                                break;
                        }
                        /* Port must be enabled */
                        if (!(temp & PORT_PE)) {
                                retval = -ENODEV;
                                break;
                        }
                        /* Can't set port link state above '3' (U3) */
                        if (link_state > USB_SS_PORT_LS_U3) {
                                xhci_warn(xhci, "Cannot set port %d-%d link state %d\n",
                                          hcd->self.busnum, wIndex + 1,
                                          link_state);
                                goto error;
                        }

                        /*
                         * set link to U0, steps depend on current link state.
                         * U3: set link to U0 and wait for u3exit completion.
                         * U1/U2:  no PLC complete event, only set link to U0.
                         * Resume/Recovery: device initiated U0, only wait for
                         * completion
                         */
                        if (link_state == USB_SS_PORT_LS_U0) {
                                u32 pls = temp & PORT_PLS_MASK;
                                bool wait_u0 = false;

                                /* already in U0 */
                                if (pls == XDEV_U0)
                                        break;
                                if (pls == XDEV_U3 ||
                                    pls == XDEV_RESUME ||
                                    pls == XDEV_RECOVERY) {
                                        wait_u0 = true;
                                        reinit_completion(&bus_state->u3exit_done[wIndex]);
                                }
                                if (pls <= XDEV_U3) /* U1, U2, U3 */
                                        xhci_set_link_state(xhci, ports[wIndex],
                                                            USB_SS_PORT_LS_U0);
                                if (!wait_u0) {
                                        if (pls > XDEV_U3)
                                                goto error;
                                        break;
                                }
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                if (!wait_for_completion_timeout(&bus_state->u3exit_done[wIndex],
                                                                 msecs_to_jiffies(100)))
                                        xhci_dbg(xhci, "missing U0 port change event for port %d-%d\n",
                                                 hcd->self.busnum, wIndex + 1);
                                spin_lock_irqsave(&xhci->lock, flags);
                                temp = readl(ports[wIndex]->addr);
                                break;
                        }

                        if (link_state == USB_SS_PORT_LS_U3) {
                                int retries = 16;
                                slot_id = xhci_find_slot_id_by_port(hcd, xhci,
                                                wIndex + 1);
                                if (slot_id) {
                                        /* unlock to execute stop endpoint
                                         * commands */
                                        spin_unlock_irqrestore(&xhci->lock,
                                                                flags);
                                        xhci_stop_device(xhci, slot_id, 1);
                                        spin_lock_irqsave(&xhci->lock, flags);
                                }
                                xhci_set_link_state(xhci, ports[wIndex], USB_SS_PORT_LS_U3);
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                while (retries--) {
                                        usleep_range(4000, 8000);
                                        temp = readl(ports[wIndex]->addr);
                                        if ((temp & PORT_PLS_MASK) == XDEV_U3)
                                                break;
                                }
                                spin_lock_irqsave(&xhci->lock, flags);
                                temp = readl(ports[wIndex]->addr);
                                bus_state->suspended_ports |= 1 << wIndex;
                        }
                        break;
                case USB_PORT_FEAT_POWER:
                        /*
                         * Turn on ports, even if there isn't per-port switching.
                         * HC will report connect events even before this is set.
                         * However, hub_wq will ignore the roothub events until
                         * the roothub is registered.
                         */
                        xhci_set_port_power(xhci, hcd, wIndex, true, &flags);
                        break;
                case USB_PORT_FEAT_RESET:
                        temp = (temp | PORT_RESET);
                        writel(temp, ports[wIndex]->addr);

                        temp = readl(ports[wIndex]->addr);
                        xhci_dbg(xhci, "set port reset, actual port %d-%d status  = 0x%x\n",
                                 hcd->self.busnum, wIndex + 1, temp);
                        break;
                case USB_PORT_FEAT_REMOTE_WAKE_MASK:
                        xhci_set_remote_wake_mask(xhci, ports[wIndex],
                                                  wake_mask);
                        temp = readl(ports[wIndex]->addr);
                        xhci_dbg(xhci, "set port remote wake mask, actual port %d-%d status  = 0x%x\n",
                                 hcd->self.busnum, wIndex + 1, temp);
                        break;
                case USB_PORT_FEAT_BH_PORT_RESET:
                        temp |= PORT_WR;
                        writel(temp, ports[wIndex]->addr);
                        temp = readl(ports[wIndex]->addr);
                        break;
                case USB_PORT_FEAT_U1_TIMEOUT:
                        if (hcd->speed < HCD_USB3)
                                goto error;
                        temp = readl(ports[wIndex]->addr + PORTPMSC);
                        temp &= ~PORT_U1_TIMEOUT_MASK;
                        temp |= PORT_U1_TIMEOUT(timeout);
                        writel(temp, ports[wIndex]->addr + PORTPMSC);
                        break;
                case USB_PORT_FEAT_U2_TIMEOUT:
                        if (hcd->speed < HCD_USB3)
                                goto error;
                        temp = readl(ports[wIndex]->addr + PORTPMSC);
                        temp &= ~PORT_U2_TIMEOUT_MASK;
                        temp |= PORT_U2_TIMEOUT(timeout);
                        writel(temp, ports[wIndex]->addr + PORTPMSC);
                        break;
                case USB_PORT_FEAT_TEST:
                        /* 4.19.6 Port Test Modes (USB2 Test Mode) */
                        if (hcd->speed != HCD_USB2)
                                goto error;
                        if (test_mode > USB_TEST_FORCE_ENABLE ||
                            test_mode < USB_TEST_J)
                                goto error;
                        retval = xhci_enter_test_mode(xhci, test_mode, wIndex,
                                                      &flags);
                        break;
                default:
                        goto error;
                }
                /* unblock any posted writes */
                temp = readl(ports[wIndex]->addr);
                break;
        case ClearPortFeature:
                if (!wIndex || wIndex > max_ports)
                        goto error;
                wIndex--;
                temp = readl(ports[wIndex]->addr);
                if (temp == ~(u32)0) {
                        xhci_hc_died(xhci);
                        retval = -ENODEV;
                        break;
                }
                /* FIXME: What new port features do we need to support? */
                temp = xhci_port_state_to_neutral(temp);
                switch (wValue) {
                case USB_PORT_FEAT_SUSPEND:
                        temp = readl(ports[wIndex]->addr);
                        xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
                        xhci_dbg(xhci, "PORTSC %04x\n", temp);
                        if (temp & PORT_RESET)
                                goto error;
                        if ((temp & PORT_PLS_MASK) == XDEV_U3) {
                                if ((temp & PORT_PE) == 0)
                                        goto error;

                                set_bit(wIndex, &bus_state->resuming_ports);
                                usb_hcd_start_port_resume(&hcd->self, wIndex);
                                xhci_set_link_state(xhci, ports[wIndex],
                                                    XDEV_RESUME);
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                msleep(USB_RESUME_TIMEOUT);
                                spin_lock_irqsave(&xhci->lock, flags);
                                xhci_set_link_state(xhci, ports[wIndex],
                                                        XDEV_U0);
                                clear_bit(wIndex, &bus_state->resuming_ports);
                                usb_hcd_end_port_resume(&hcd->self, wIndex);
                        }
                        bus_state->port_c_suspend |= 1 << wIndex;

                        slot_id = xhci_find_slot_id_by_port(hcd, xhci,
                                        wIndex + 1);
                        if (!slot_id) {
                                xhci_dbg(xhci, "slot_id is zero\n");
                                goto error;
                        }
                        xhci_ring_device(xhci, slot_id);
                        break;
                case USB_PORT_FEAT_C_SUSPEND:
                        bus_state->port_c_suspend &= ~(1 << wIndex);
                        fallthrough;
                case USB_PORT_FEAT_C_RESET:
                case USB_PORT_FEAT_C_BH_PORT_RESET:
                case USB_PORT_FEAT_C_CONNECTION:
                case USB_PORT_FEAT_C_OVER_CURRENT:
                case USB_PORT_FEAT_C_ENABLE:
                case USB_PORT_FEAT_C_PORT_LINK_STATE:
                case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
                        xhci_clear_port_change_bit(xhci, wValue, wIndex,
                                        ports[wIndex]->addr, temp);
                        break;
                case USB_PORT_FEAT_ENABLE:
                        xhci_disable_port(hcd, xhci, wIndex,
                                        ports[wIndex]->addr, temp);
                        break;
                case USB_PORT_FEAT_POWER:
                        xhci_set_port_power(xhci, hcd, wIndex, false, &flags);
                        break;
                case USB_PORT_FEAT_TEST:
                        retval = xhci_exit_test_mode(xhci);
                        break;
                default:
                        goto error;
                }
                break;
        default:
error:
                /* "stall" on error */
                retval = -EPIPE;
        }
        spin_unlock_irqrestore(&xhci->lock, flags);
        return retval;
}

/*
 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
 * Ports are 0-indexed from the HCD point of view,
 * and 1-indexed from the USB core pointer of view.
 *
 * Note that the status change bits will be cleared as soon as a port status
 * change event is generated, so we use the saved status from that event.
 */
int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
{
        unsigned long flags;
        u32 temp, status;
        u32 mask;
        int i, retval;
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        int max_ports;
        struct xhci_bus_state *bus_state;
        bool reset_change = false;
        struct xhci_hub *rhub;
        struct xhci_port **ports;

        rhub = xhci_get_rhub(hcd);
        ports = rhub->ports;
        max_ports = rhub->num_ports;
        bus_state = &rhub->bus_state;

        /* Initial status is no changes */
        retval = (max_ports + 8) / 8;
        memset(buf, 0, retval);

        /*
         * Inform the usbcore about resume-in-progress by returning
         * a non-zero value even if there are no status changes.
         */
        status = bus_state->resuming_ports;

        mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;

        spin_lock_irqsave(&xhci->lock, flags);
        /* For each port, did anything change?  If so, set that bit in buf. */
        for (i = 0; i < max_ports; i++) {
                temp = readl(ports[i]->addr);
                if (temp == ~(u32)0) {
                        xhci_hc_died(xhci);
                        retval = -ENODEV;
                        break;
                }
                trace_xhci_hub_status_data(i, temp);

                if ((temp & mask) != 0 ||
                        (bus_state->port_c_suspend & 1 << i) ||
                        (bus_state->resume_done[i] && time_after_eq(
                            jiffies, bus_state->resume_done[i]))) {
                        buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
                        status = 1;
                }
                if ((temp & PORT_RC))
                        reset_change = true;
                if (temp & PORT_OC)
                        status = 1;
        }
        if (!status && !reset_change) {
                xhci_dbg(xhci, "%s: stopping port polling.\n", __func__);
                clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
        }
        spin_unlock_irqrestore(&xhci->lock, flags);
        return status ? retval : 0;
}

#ifdef CONFIG_PM

int xhci_bus_suspend(struct usb_hcd *hcd)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        int max_ports, port_index;
        struct xhci_bus_state *bus_state;
        unsigned long flags;
        struct xhci_hub *rhub;
        struct xhci_port **ports;
        u32 portsc_buf[USB_MAXCHILDREN];
        bool wake_enabled;

        rhub = xhci_get_rhub(hcd);
        ports = rhub->ports;
        max_ports = rhub->num_ports;
        bus_state = &rhub->bus_state;
        wake_enabled = hcd->self.root_hub->do_remote_wakeup;

        spin_lock_irqsave(&xhci->lock, flags);

        if (wake_enabled) {
                if (bus_state->resuming_ports ||        /* USB2 */
                    bus_state->port_remote_wakeup) {    /* USB3 */
                        spin_unlock_irqrestore(&xhci->lock, flags);
                        xhci_dbg(xhci, "suspend failed because a port is resuming\n");
                        return -EBUSY;
                }
        }
        /*
         * Prepare ports for suspend, but don't write anything before all ports
         * are checked and we know bus suspend can proceed
         */
        bus_state->bus_suspended = 0;
        port_index = max_ports;
        while (port_index--) {
                u32 t1, t2;
                int retries = 10;
retry:
                t1 = readl(ports[port_index]->addr);
                t2 = xhci_port_state_to_neutral(t1);
                portsc_buf[port_index] = 0;

                /*
                 * Give a USB3 port in link training time to finish, but don't
                 * prevent suspend as port might be stuck
                 */
                if ((hcd->speed >= HCD_USB3) && retries-- &&
                    (t1 & PORT_PLS_MASK) == XDEV_POLLING) {
                        spin_unlock_irqrestore(&xhci->lock, flags);
                        msleep(XHCI_PORT_POLLING_LFPS_TIME);
                        spin_lock_irqsave(&xhci->lock, flags);
                        xhci_dbg(xhci, "port %d-%d polling in bus suspend, waiting\n",
                                 hcd->self.busnum, port_index + 1);
                        goto retry;
                }
                /* bail out if port detected a over-current condition */
                if (t1 & PORT_OC) {
                        bus_state->bus_suspended = 0;
                        spin_unlock_irqrestore(&xhci->lock, flags);
                        xhci_dbg(xhci, "Bus suspend bailout, port over-current detected\n");
                        return -EBUSY;
                }
                /* suspend ports in U0, or bail out for new connect changes */
                if ((t1 & PORT_PE) && (t1 & PORT_PLS_MASK) == XDEV_U0) {
                        if ((t1 & PORT_CSC) && wake_enabled) {
                                bus_state->bus_suspended = 0;
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                xhci_dbg(xhci, "Bus suspend bailout, port connect change\n");
                                return -EBUSY;
                        }
                        xhci_dbg(xhci, "port %d-%d not suspended\n",
                                 hcd->self.busnum, port_index + 1);
                        t2 &= ~PORT_PLS_MASK;
                        t2 |= PORT_LINK_STROBE | XDEV_U3;
                        set_bit(port_index, &bus_state->bus_suspended);
                }
                /* USB core sets remote wake mask for USB 3.0 hubs,
                 * including the USB 3.0 roothub, but only if CONFIG_PM
                 * is enabled, so also enable remote wake here.
                 */
                if (wake_enabled) {
                        if (t1 & PORT_CONNECT) {
                                t2 |= PORT_WKOC_E | PORT_WKDISC_E;
                                t2 &= ~PORT_WKCONN_E;
                        } else {
                                t2 |= PORT_WKOC_E | PORT_WKCONN_E;
                                t2 &= ~PORT_WKDISC_E;
                        }

                        if ((xhci->quirks & XHCI_U2_DISABLE_WAKE) &&
                            (hcd->speed < HCD_USB3)) {
                                if (usb_amd_pt_check_port(hcd->self.controller,
                                                          port_index))
                                        t2 &= ~PORT_WAKE_BITS;
                        }
                } else
                        t2 &= ~PORT_WAKE_BITS;

                t1 = xhci_port_state_to_neutral(t1);
                if (t1 != t2)
                        portsc_buf[port_index] = t2;
        }

        /* write port settings, stopping and suspending ports if needed */
        port_index = max_ports;
        while (port_index--) {
                if (!portsc_buf[port_index])
                        continue;
                if (test_bit(port_index, &bus_state->bus_suspended)) {
                        int slot_id;

                        slot_id = xhci_find_slot_id_by_port(hcd, xhci,
                                                            port_index + 1);
                        if (slot_id) {
                                spin_unlock_irqrestore(&xhci->lock, flags);
                                xhci_stop_device(xhci, slot_id, 1);
                                spin_lock_irqsave(&xhci->lock, flags);
                        }
                }
                writel(portsc_buf[port_index], ports[port_index]->addr);
        }
        hcd->state = HC_STATE_SUSPENDED;
        bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
        spin_unlock_irqrestore(&xhci->lock, flags);

        if (bus_state->bus_suspended)
                usleep_range(5000, 10000);

        return 0;
}

/*
 * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
 * warm reset a USB3 device stuck in polling or compliance mode after resume.
 * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
 */
static bool xhci_port_missing_cas_quirk(struct xhci_port *port)
{
        u32 portsc;

        portsc = readl(port->addr);

        /* if any of these are set we are not stuck */
        if (portsc & (PORT_CONNECT | PORT_CAS))
                return false;

        if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
            ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
                return false;

        /* clear wakeup/change bits, and do a warm port reset */
        portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
        portsc |= PORT_WR;
        writel(portsc, port->addr);
        /* flush write */
        readl(port->addr);
        return true;
}

int xhci_bus_resume(struct usb_hcd *hcd)
{
        struct xhci_hcd *xhci = hcd_to_xhci(hcd);
        struct xhci_bus_state *bus_state;
        unsigned long flags;
        int max_ports, port_index;
        int slot_id;
        int sret;
        u32 next_state;
        u32 temp, portsc;
        struct xhci_hub *rhub;
        struct xhci_port **ports;

        rhub = xhci_get_rhub(hcd);
        ports = rhub->ports;
        max_ports = rhub->num_ports;
        bus_state = &rhub->bus_state;

        if (time_before(jiffies, bus_state->next_statechange))
                msleep(5);

        spin_lock_irqsave(&xhci->lock, flags);
        if (!HCD_HW_ACCESSIBLE(hcd)) {
                spin_unlock_irqrestore(&xhci->lock, flags);
                return -ESHUTDOWN;
        }

        /* delay the irqs */
        temp = readl(&xhci->op_regs->command);
        temp &= ~CMD_EIE;
        writel(temp, &xhci->op_regs->command);

        /* bus specific resume for ports we suspended at bus_suspend */
        if (hcd->speed >= HCD_USB3)
                next_state = XDEV_U0;
        else
                next_state = XDEV_RESUME;

        port_index = max_ports;
        while (port_index--) {
                portsc = readl(ports[port_index]->addr);

                /* warm reset CAS limited ports stuck in polling/compliance */
                if ((xhci->quirks & XHCI_MISSING_CAS) &&
                    (hcd->speed >= HCD_USB3) &&
                    xhci_port_missing_cas_quirk(ports[port_index])) {
                        xhci_dbg(xhci, "reset stuck port %d-%d\n",
                                 hcd->self.busnum, port_index + 1);
                        clear_bit(port_index, &bus_state->bus_suspended);
                        continue;
                }
                /* resume if we suspended the link, and it is still suspended */
                if (test_bit(port_index, &bus_state->bus_suspended))
                        switch (portsc & PORT_PLS_MASK) {
                        case XDEV_U3:
                                portsc = xhci_port_state_to_neutral(portsc);
                                portsc &= ~PORT_PLS_MASK;
                                portsc |= PORT_LINK_STROBE | next_state;
                                break;
                        case XDEV_RESUME:
                                /* resume already initiated */
                                break;
                        default:
                                /* not in a resumeable state, ignore it */
                                clear_bit(port_index,
                                          &bus_state->bus_suspended);
                                break;
                        }
                /* disable wake for all ports, write new link state if needed */
                portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
                writel(portsc, ports[port_index]->addr);
        }

        /* USB2 specific resume signaling delay and U0 link state transition */
        if (hcd->speed < HCD_USB3) {
                if (bus_state->bus_suspended) {
                        spin_unlock_irqrestore(&xhci->lock, flags);
                        msleep(USB_RESUME_TIMEOUT);
                        spin_lock_irqsave(&xhci->lock, flags);
                }
                for_each_set_bit(port_index, &bus_state->bus_suspended,
                                 BITS_PER_LONG) {
                        /* Clear PLC to poll it later for U0 transition */
                        xhci_test_and_clear_bit(xhci, ports[port_index],
                                                PORT_PLC);
                        xhci_set_link_state(xhci, ports[port_index], XDEV_U0);
                }
        }

        /* poll for U0 link state complete, both USB2 and USB3 */
        for_each_set_bit(port_index, &bus_state->bus_suspended, BITS_PER_LONG) {
                sret = xhci_handshake(ports[port_index]->addr, PORT_PLC,
                                      PORT_PLC, 10 * 1000);
                if (sret) {
                        xhci_warn(xhci, "port %d-%d resume PLC timeout\n",
                                  hcd->self.busnum, port_index + 1);
                        continue;
                }
                xhci_test_and_clear_bit(xhci, ports[port_index], PORT_PLC);
                slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
                if (slot_id)
                        xhci_ring_device(xhci, slot_id);
        }
        (void) readl(&xhci->op_regs->command);

        bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
        /* re-enable irqs */
        temp = readl(&xhci->op_regs->command);
        temp |= CMD_EIE;
        writel(temp, &xhci->op_regs->command);
        temp = readl(&xhci->op_regs->command);

        spin_unlock_irqrestore(&xhci->lock, flags);
        return 0;
}

unsigned long xhci_get_resuming_ports(struct usb_hcd *hcd)
{
        struct xhci_hub *rhub = xhci_get_rhub(hcd);

        /* USB3 port wakeups are reported via usb_wakeup_notification() */
        return rhub->bus_state.resuming_ports;  /* USB2 ports only */
}

#endif  /* CONFIG_PM */