drivers/usb/host/xhci-hub.c

   1 /*
   2  * xHCI host controller driver
   3  *
   4  * Copyright (C) 2008 Intel Corp.
   5  *
   6  * Author: Sarah Sharp
   7  * Some code borrowed from the Linux EHCI driver.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23
  24 #include <linux/slab.h>
  25 #include <asm/unaligned.h>
  26
  27 #include "xhci.h"
  28 #include "xhci-trace.h"
  29
  30 #define PORT_WAKE_BITS  (PORT_WKOC_E | PORT_WKDISC_E | PORT_WKCONN_E)
  31 #define PORT_RWC_BITS   (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
  32                          PORT_RC | PORT_PLC | PORT_PE)
  33
  34 /* USB 3 BOS descriptor and a capability descriptors, combined.
  35  * Fields will be adjusted and added later in xhci_create_usb3_bos_desc()
  36  */
  37 static u8 usb_bos_descriptor [] = {
  38         USB_DT_BOS_SIZE,                /*  __u8 bLength, 5 bytes */
  39         USB_DT_BOS,                     /*  __u8 bDescriptorType */
  40         0x0F, 0x00,                     /*  __le16 wTotalLength, 15 bytes */
  41         0x1,                            /*  __u8 bNumDeviceCaps */
  42         /* First device capability, SuperSpeed */
  43         USB_DT_USB_SS_CAP_SIZE,         /*  __u8 bLength, 10 bytes */
  44         USB_DT_DEVICE_CAPABILITY,       /* Device Capability */
  45         USB_SS_CAP_TYPE,                /* bDevCapabilityType, SUPERSPEED_USB */
  46         0x00,                           /* bmAttributes, LTM off by default */
  47         USB_5GBPS_OPERATION, 0x00,      /* wSpeedsSupported, 5Gbps only */
  48         0x03,                           /* bFunctionalitySupport,
  49                                            USB 3.0 speed only */
  50         0x00,                           /* bU1DevExitLat, set later. */
  51         0x00, 0x00,                     /* __le16 bU2DevExitLat, set later. */
  52         /* Second device capability, SuperSpeedPlus */
  53         0x1c,                           /* bLength 28, will be adjusted later */
  54         USB_DT_DEVICE_CAPABILITY,       /* Device Capability */
  55         USB_SSP_CAP_TYPE,               /* bDevCapabilityType SUPERSPEED_PLUS */
  56         0x00,                           /* bReserved 0 */
  57         0x23, 0x00, 0x00, 0x00,         /* bmAttributes, SSAC=3 SSIC=1 */
  58         0x01, 0x00,                     /* wFunctionalitySupport */
  59         0x00, 0x00,                     /* wReserved 0 */
  60         /* Default Sublink Speed Attributes, overwrite if custom PSI exists */
  61         0x34, 0x00, 0x05, 0x00,         /* 5Gbps, symmetric, rx, ID = 4 */
  62         0xb4, 0x00, 0x05, 0x00,         /* 5Gbps, symmetric, tx, ID = 4 */
  63         0x35, 0x40, 0x0a, 0x00,         /* 10Gbps, SSP, symmetric, rx, ID = 5 */
  64         0xb5, 0x40, 0x0a, 0x00,         /* 10Gbps, SSP, symmetric, tx, ID = 5 */
  65 };
  66
  67 static int xhci_create_usb3_bos_desc(struct xhci_hcd *xhci, char *buf,
  68                                      u16 wLength)
  69 {
  70         int i, ssa_count;
  71         u32 temp;
  72         u16 desc_size, ssp_cap_size, ssa_size = 0;
  73         bool usb3_1 = false;
  74
  75         desc_size = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
  76         ssp_cap_size = sizeof(usb_bos_descriptor) - desc_size;
  77
  78         /* does xhci support USB 3.1 Enhanced SuperSpeed */
  79         if (xhci->usb3_rhub.min_rev >= 0x01) {
  80                 /* does xhci provide a PSI table for SSA speed attributes? */
  81                 if (xhci->usb3_rhub.psi_count) {
  82                         /* two SSA entries for each unique PSI ID, RX and TX */
  83                         ssa_count = xhci->usb3_rhub.psi_uid_count * 2;
  84                         ssa_size = ssa_count * sizeof(u32);
  85                         ssp_cap_size -= 16; /* skip copying the default SSA */
  86                 }
  87                 desc_size += ssp_cap_size;
  88                 usb3_1 = true;
  89         }
  90         memcpy(buf, &usb_bos_descriptor, min(desc_size, wLength));
  91
  92         if (usb3_1) {
  93                 /* modify bos descriptor bNumDeviceCaps and wTotalLength */
  94                 buf[4] += 1;
  95                 put_unaligned_le16(desc_size + ssa_size, &buf[2]);
  96         }
  97
  98         if (wLength < USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE)
  99                 return wLength;
 100
 101         /* Indicate whether the host has LTM support. */
 102         temp = readl(&xhci->cap_regs->hcc_params);
 103         if (HCC_LTC(temp))
 104                 buf[8] |= USB_LTM_SUPPORT;
 105
 106         /* Set the U1 and U2 exit latencies. */
 107         if ((xhci->quirks & XHCI_LPM_SUPPORT)) {
 108                 temp = readl(&xhci->cap_regs->hcs_params3);
 109                 buf[12] = HCS_U1_LATENCY(temp);
 110                 put_unaligned_le16(HCS_U2_LATENCY(temp), &buf[13]);
 111         }
 112
 113         /* If PSI table exists, add the custom speed attributes from it */
 114         if (usb3_1 && xhci->usb3_rhub.psi_count) {
 115                 u32 ssp_cap_base, bm_attrib, psi;
 116                 int offset;
 117
 118                 ssp_cap_base = USB_DT_BOS_SIZE + USB_DT_USB_SS_CAP_SIZE;
 119
 120                 if (wLength < desc_size)
 121                         return wLength;
 122                 buf[ssp_cap_base] = ssp_cap_size + ssa_size;
 123
 124                 /* attribute count SSAC bits 4:0 and ID count SSIC bits 8:5 */
 125                 bm_attrib = (ssa_count - 1) & 0x1f;
 126                 bm_attrib |= (xhci->usb3_rhub.psi_uid_count - 1) << 5;
 127                 put_unaligned_le32(bm_attrib, &buf[ssp_cap_base + 4]);
 128
 129                 if (wLength < desc_size + ssa_size)
 130                         return wLength;
 131                 /*
 132                  * Create the Sublink Speed Attributes (SSA) array.
 133                  * The xhci PSI field and USB 3.1 SSA fields are very similar,
 134                  * but link type bits 7:6 differ for values 01b and 10b.
 135                  * xhci has also only one PSI entry for a symmetric link when
 136                  * USB 3.1 requires two SSA entries (RX and TX) for every link
 137                  */
 138                 offset = desc_size;
 139                 for (i = 0; i < xhci->usb3_rhub.psi_count; i++) {
 140                         psi = xhci->usb3_rhub.psi[i];
 141                         psi &= ~USB_SSP_SUBLINK_SPEED_RSVD;
 142                         if ((psi & PLT_MASK) == PLT_SYM) {
 143                         /* Symmetric, create SSA RX and TX from one PSI entry */
 144                                 put_unaligned_le32(psi, &buf[offset]);
 145                                 psi |= 1 << 7;  /* turn entry to TX */
 146                                 offset += 4;
 147                                 if (offset >= desc_size + ssa_size)
 148                                         return desc_size + ssa_size;
 149                         } else if ((psi & PLT_MASK) == PLT_ASYM_RX) {
 150                                 /* Asymetric RX, flip bits 7:6 for SSA */
 151                                 psi ^= PLT_MASK;
 152                         }
 153                         put_unaligned_le32(psi, &buf[offset]);
 154                         offset += 4;
 155                         if (offset >= desc_size + ssa_size)
 156                                 return desc_size + ssa_size;
 157                 }
 158         }
 159         /* ssa_size is 0 for other than usb 3.1 hosts */
 160         return desc_size + ssa_size;
 161 }
 162
 163 static void xhci_common_hub_descriptor(struct xhci_hcd *xhci,
 164                 struct usb_hub_descriptor *desc, int ports)
 165 {
 166         u16 temp;
 167
 168         desc->bPwrOn2PwrGood = 10;      /* xhci section 5.4.9 says 20ms max */
 169         desc->bHubContrCurrent = 0;
 170
 171         desc->bNbrPorts = ports;
 172         temp = 0;
 173         /* Bits 1:0 - support per-port power switching, or power always on */
 174         if (HCC_PPC(xhci->hcc_params))
 175                 temp |= HUB_CHAR_INDV_PORT_LPSM;
 176         else
 177                 temp |= HUB_CHAR_NO_LPSM;
 178         /* Bit  2 - root hubs are not part of a compound device */
 179         /* Bits 4:3 - individual port over current protection */
 180         temp |= HUB_CHAR_INDV_PORT_OCPM;
 181         /* Bits 6:5 - no TTs in root ports */
 182         /* Bit  7 - no port indicators */
 183         desc->wHubCharacteristics = cpu_to_le16(temp);
 184 }
 185
 186 /* Fill in the USB 2.0 roothub descriptor */
 187 static void xhci_usb2_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 188                 struct usb_hub_descriptor *desc)
 189 {
 190         int ports;
 191         u16 temp;
 192         __u8 port_removable[(USB_MAXCHILDREN + 1 + 7) / 8];
 193         u32 portsc;
 194         unsigned int i;
 195
 196         ports = xhci->num_usb2_ports;
 197
 198         xhci_common_hub_descriptor(xhci, desc, ports);
 199         desc->bDescriptorType = USB_DT_HUB;
 200         temp = 1 + (ports / 8);
 201         desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * temp;
 202
 203         /* The Device Removable bits are reported on a byte granularity.
 204          * If the port doesn't exist within that byte, the bit is set to 0.
 205          */
 206         memset(port_removable, 0, sizeof(port_removable));
 207         for (i = 0; i < ports; i++) {
 208                 portsc = readl(xhci->usb2_ports[i]);
 209                 /* If a device is removable, PORTSC reports a 0, same as in the
 210                  * hub descriptor DeviceRemovable bits.
 211                  */
 212                 if (portsc & PORT_DEV_REMOVE)
 213                         /* This math is hairy because bit 0 of DeviceRemovable
 214                          * is reserved, and bit 1 is for port 1, etc.
 215                          */
 216                         port_removable[(i + 1) / 8] |= 1 << ((i + 1) % 8);
 217         }
 218
 219         /* ch11.h defines a hub descriptor that has room for USB_MAXCHILDREN
 220          * ports on it.  The USB 2.0 specification says that there are two
 221          * variable length fields at the end of the hub descriptor:
 222          * DeviceRemovable and PortPwrCtrlMask.  But since we can have less than
 223          * USB_MAXCHILDREN ports, we may need to use the DeviceRemovable array
 224          * to set PortPwrCtrlMask bits.  PortPwrCtrlMask must always be set to
 225          * 0xFF, so we initialize the both arrays (DeviceRemovable and
 226          * PortPwrCtrlMask) to 0xFF.  Then we set the DeviceRemovable for each
 227          * set of ports that actually exist.
 228          */
 229         memset(desc->u.hs.DeviceRemovable, 0xff,
 230                         sizeof(desc->u.hs.DeviceRemovable));
 231         memset(desc->u.hs.PortPwrCtrlMask, 0xff,
 232                         sizeof(desc->u.hs.PortPwrCtrlMask));
 233
 234         for (i = 0; i < (ports + 1 + 7) / 8; i++)
 235                 memset(&desc->u.hs.DeviceRemovable[i], port_removable[i],
 236                                 sizeof(__u8));
 237 }
 238
 239 /* Fill in the USB 3.0 roothub descriptor */
 240 static void xhci_usb3_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 241                 struct usb_hub_descriptor *desc)
 242 {
 243         int ports;
 244         u16 port_removable;
 245         u32 portsc;
 246         unsigned int i;
 247
 248         ports = xhci->num_usb3_ports;
 249         xhci_common_hub_descriptor(xhci, desc, ports);
 250         desc->bDescriptorType = USB_DT_SS_HUB;
 251         desc->bDescLength = USB_DT_SS_HUB_SIZE;
 252
 253         /* header decode latency should be zero for roothubs,
 254          * see section 4.23.5.2.
 255          */
 256         desc->u.ss.bHubHdrDecLat = 0;
 257         desc->u.ss.wHubDelay = 0;
 258
 259         port_removable = 0;
 260         /* bit 0 is reserved, bit 1 is for port 1, etc. */
 261         for (i = 0; i < ports; i++) {
 262                 portsc = readl(xhci->usb3_ports[i]);
 263                 if (portsc & PORT_DEV_REMOVE)
 264                         port_removable |= 1 << (i + 1);
 265         }
 266
 267         desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
 268 }
 269
 270 static void xhci_hub_descriptor(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 271                 struct usb_hub_descriptor *desc)
 272 {
 273
 274         if (hcd->speed >= HCD_USB3)
 275                 xhci_usb3_hub_descriptor(hcd, xhci, desc);
 276         else
 277                 xhci_usb2_hub_descriptor(hcd, xhci, desc);
 278
 279 }
 280
 281 static unsigned int xhci_port_speed(unsigned int port_status)
 282 {
 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;
 287         /*
 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).
 291          */
 292         return 0;
 293 }
 294
 295 /*
 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.
 301  */
 302 #define XHCI_PORT_RO    ((1<<0) | (1<<3) | (0xf<<10) | (1<<30))
 303 /*
 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
 307  */
 308 #define XHCI_PORT_RWS   ((0xf<<5) | (1<<9) | (0x3<<14) | (0x7<<25))
 309 /*
 310  * These bits are RW; writing a 1 sets the bit, writing a 0 has no effect:
 311  * bit 4 (port reset)
 312  */
 313 #define XHCI_PORT_RW1S  ((1<<4))
 314 /*
 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
 320  */
 321 #define XHCI_PORT_RW1CS ((1<<1) | (0x7f<<17))
 322 /*
 323  * Bit 16 is RW, and writing a '1' to it causes the link state control to be
 324  * latched in
 325  */
 326 #define XHCI_PORT_RW    ((1<<16))
 327 /*
 328  * These bits are Reserved Zero (RsvdZ) and zero should be written to them:
 329  * bits 2, 24, 28:31
 330  */
 331 #define XHCI_PORT_RZ    ((1<<2) | (1<<24) | (0xf<<28))
 332
 333 /*
 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
 336  * control register.
 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.
 340  */
 341 u32 xhci_port_state_to_neutral(u32 state)
 342 {
 343         /* Save read-only status and port state */
 344         return (state & XHCI_PORT_RO) | (state & XHCI_PORT_RWS);
 345 }
 346
 347 /*
 348  * find slot id based on port number.
 349  * @port: The one-based port number from one of the two split roothubs.
 350  */
 351 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 352                 u16 port)
 353 {
 354         int slot_id;
 355         int i;
 356         enum usb_device_speed speed;
 357
 358         slot_id = 0;
 359         for (i = 0; i < MAX_HC_SLOTS; i++) {
 360                 if (!xhci->devs[i])
 361                         continue;
 362                 speed = xhci->devs[i]->udev->speed;
 363                 if (((speed >= USB_SPEED_SUPER) == (hcd->speed >= HCD_USB3))
 364                                 && xhci->devs[i]->fake_port == port) {
 365                         slot_id = i;
 366                         break;
 367                 }
 368         }
 369
 370         return slot_id;
 371 }
 372
 373 /*
 374  * Stop device
 375  * It issues stop endpoint command for EP 0 to 30. And wait the last command
 376  * to complete.
 377  * suspend will set to 1, if suspend bit need to set in command.
 378  */
 379 static int xhci_stop_device(struct xhci_hcd *xhci, int slot_id, int suspend)
 380 {
 381         struct xhci_virt_device *virt_dev;
 382         struct xhci_command *cmd;
 383         unsigned long flags;
 384         int ret;
 385         int i;
 386
 387         ret = 0;
 388         virt_dev = xhci->devs[slot_id];
 389         if (!virt_dev)
 390                 return -ENODEV;
 391
 392         trace_xhci_stop_device(virt_dev);
 393
 394         cmd = xhci_alloc_command(xhci, false, true, GFP_NOIO);
 395         if (!cmd)
 396                 return -ENOMEM;
 397
 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;
 403
 404                         ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->out_ctx, i);
 405
 406                         /* Check ep is running, required by AMD SNPS 3.1 xHC */
 407                         if (GET_EP_CTX_STATE(ep_ctx) != EP_STATE_RUNNING)
 408                                 continue;
 409
 410                         command = xhci_alloc_command(xhci, false, false,
 411                                                      GFP_NOWAIT);
 412                         if (!command) {
 413                                 spin_unlock_irqrestore(&xhci->lock, flags);
 414                                 xhci_free_command(xhci, cmd);
 415                                 return -ENOMEM;
 416                         }
 417                         xhci_queue_stop_endpoint(xhci, command, slot_id, i,
 418                                                  suspend);
 419                 }
 420         }
 421         xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
 422         xhci_ring_cmd_db(xhci);
 423         spin_unlock_irqrestore(&xhci->lock, flags);
 424
 425         /* Wait for last stop endpoint command to finish */
 426         wait_for_completion(cmd->completion);
 427
 428         if (cmd->status == COMP_COMMAND_ABORTED ||
 429             cmd->status == COMP_COMMAND_RING_STOPPED) {
 430                 xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
 431                 ret = -ETIME;
 432         }
 433         xhci_free_command(xhci, cmd);
 434         return ret;
 435 }
 436
 437 /*
 438  * Ring device, it rings the all doorbells unconditionally.
 439  */
 440 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
 441 {
 442         int i, s;
 443         struct xhci_virt_ep *ep;
 444
 445         for (i = 0; i < LAST_EP_INDEX + 1; i++) {
 446                 ep = &xhci->devs[slot_id]->eps[i];
 447
 448                 if (ep->ep_state & EP_HAS_STREAMS) {
 449                         for (s = 1; s < ep->stream_info->num_streams; s++)
 450                                 xhci_ring_ep_doorbell(xhci, slot_id, i, s);
 451                 } else if (ep->ring && ep->ring->dequeue) {
 452                         xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
 453                 }
 454         }
 455
 456         return;
 457 }
 458
 459 static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 460                 u16 wIndex, __le32 __iomem *addr, u32 port_status)
 461 {
 462         /* Don't allow the USB core to disable SuperSpeed ports. */
 463         if (hcd->speed >= HCD_USB3) {
 464                 xhci_dbg(xhci, "Ignoring request to disable "
 465                                 "SuperSpeed port.\n");
 466                 return;
 467         }
 468
 469         if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
 470                 xhci_dbg(xhci,
 471                          "Broken Port Enabled/Disabled, ignoring port disable request.\n");
 472                 return;
 473         }
 474
 475         /* Write 1 to disable the port */
 476         writel(port_status | PORT_PE, addr);
 477         port_status = readl(addr);
 478         xhci_dbg(xhci, "disable port, actual port %d status  = 0x%x\n",
 479                         wIndex, port_status);
 480 }
 481
 482 static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
 483                 u16 wIndex, __le32 __iomem *addr, u32 port_status)
 484 {
 485         char *port_change_bit;
 486         u32 status;
 487
 488         switch (wValue) {
 489         case USB_PORT_FEAT_C_RESET:
 490                 status = PORT_RC;
 491                 port_change_bit = "reset";
 492                 break;
 493         case USB_PORT_FEAT_C_BH_PORT_RESET:
 494                 status = PORT_WRC;
 495                 port_change_bit = "warm(BH) reset";
 496                 break;
 497         case USB_PORT_FEAT_C_CONNECTION:
 498                 status = PORT_CSC;
 499                 port_change_bit = "connect";
 500                 break;
 501         case USB_PORT_FEAT_C_OVER_CURRENT:
 502                 status = PORT_OCC;
 503                 port_change_bit = "over-current";
 504                 break;
 505         case USB_PORT_FEAT_C_ENABLE:
 506                 status = PORT_PEC;
 507                 port_change_bit = "enable/disable";
 508                 break;
 509         case USB_PORT_FEAT_C_SUSPEND:
 510                 status = PORT_PLC;
 511                 port_change_bit = "suspend/resume";
 512                 break;
 513         case USB_PORT_FEAT_C_PORT_LINK_STATE:
 514                 status = PORT_PLC;
 515                 port_change_bit = "link state";
 516                 break;
 517         case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
 518                 status = PORT_CEC;
 519                 port_change_bit = "config error";
 520                 break;
 521         default:
 522                 /* Should never happen */
 523                 return;
 524         }
 525         /* Change bits are all write 1 to clear */
 526         writel(port_status | status, addr);
 527         port_status = readl(addr);
 528         xhci_dbg(xhci, "clear port %s change, actual port %d status  = 0x%x\n",
 529                         port_change_bit, wIndex, port_status);
 530 }
 531
 532 static int xhci_get_ports(struct usb_hcd *hcd, __le32 __iomem ***port_array)
 533 {
 534         int max_ports;
 535         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 536
 537         if (hcd->speed >= HCD_USB3) {
 538                 max_ports = xhci->num_usb3_ports;
 539                 *port_array = xhci->usb3_ports;
 540         } else {
 541                 max_ports = xhci->num_usb2_ports;
 542                 *port_array = xhci->usb2_ports;
 543         }
 544
 545         return max_ports;
 546 }
 547
 548 static __le32 __iomem *xhci_get_port_io_addr(struct usb_hcd *hcd, int index)
 549 {
 550         __le32 __iomem **port_array;
 551
 552         xhci_get_ports(hcd, &port_array);
 553         return port_array[index];
 554 }
 555
 556 /*
 557  * xhci_set_port_power() must be called with xhci->lock held.
 558  * It will release and re-aquire the lock while calling ACPI
 559  * method.
 560  */
 561 static void xhci_set_port_power(struct xhci_hcd *xhci, struct usb_hcd *hcd,
 562                                 u16 index, bool on, unsigned long *flags)
 563 {
 564         __le32 __iomem *addr;
 565         u32 temp;
 566
 567         addr = xhci_get_port_io_addr(hcd, index);
 568         temp = readl(addr);
 569         temp = xhci_port_state_to_neutral(temp);
 570         if (on) {
 571                 /* Power on */
 572                 writel(temp | PORT_POWER, addr);
 573                 temp = readl(addr);
 574                 xhci_dbg(xhci, "set port power, actual port %d status  = 0x%x\n",
 575                                                 index, temp);
 576         } else {
 577                 /* Power off */
 578                 writel(temp & ~PORT_POWER, addr);
 579         }
 580
 581         spin_unlock_irqrestore(&xhci->lock, *flags);
 582         temp = usb_acpi_power_manageable(hcd->self.root_hub,
 583                                         index);
 584         if (temp)
 585                 usb_acpi_set_power_state(hcd->self.root_hub,
 586                         index, on);
 587         spin_lock_irqsave(&xhci->lock, *flags);
 588 }
 589
 590 static void xhci_port_set_test_mode(struct xhci_hcd *xhci,
 591         u16 test_mode, u16 wIndex)
 592 {
 593         u32 temp;
 594         __le32 __iomem *addr;
 595
 596         /* xhci only supports test mode for usb2 ports, i.e. xhci->main_hcd */
 597         addr = xhci_get_port_io_addr(xhci->main_hcd, wIndex);
 598         temp = readl(addr + PORTPMSC);
 599         temp |= test_mode << PORT_TEST_MODE_SHIFT;
 600         writel(temp, addr + PORTPMSC);
 601         xhci->test_mode = test_mode;
 602         if (test_mode == TEST_FORCE_EN)
 603                 xhci_start(xhci);
 604 }
 605
 606 static int xhci_enter_test_mode(struct xhci_hcd *xhci,
 607                                 u16 test_mode, u16 wIndex, unsigned long *flags)
 608 {
 609         int i, retval;
 610
 611         /* Disable all Device Slots */
 612         xhci_dbg(xhci, "Disable all slots\n");
 613         for (i = 1; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
 614                 retval = xhci_disable_slot(xhci, NULL, i);
 615                 if (retval)
 616                         xhci_err(xhci, "Failed to disable slot %d, %d. Enter test mode anyway\n",
 617                                  i, retval);
 618         }
 619         /* Put all ports to the Disable state by clear PP */
 620         xhci_dbg(xhci, "Disable all port (PP = 0)\n");
 621         /* Power off USB3 ports*/
 622         for (i = 0; i < xhci->num_usb3_ports; i++)
 623                 xhci_set_port_power(xhci, xhci->shared_hcd, i, false, flags);
 624         /* Power off USB2 ports*/
 625         for (i = 0; i < xhci->num_usb2_ports; i++)
 626                 xhci_set_port_power(xhci, xhci->main_hcd, i, false, flags);
 627         /* Stop the controller */
 628         xhci_dbg(xhci, "Stop controller\n");
 629         retval = xhci_halt(xhci);
 630         if (retval)
 631                 return retval;
 632         /* Disable runtime PM for test mode */
 633         pm_runtime_forbid(xhci_to_hcd(xhci)->self.controller);
 634         /* Set PORTPMSC.PTC field to enter selected test mode */
 635         /* Port is selected by wIndex. port_id = wIndex + 1 */
 636         xhci_dbg(xhci, "Enter Test Mode: %d, Port_id=%d\n",
 637                                         test_mode, wIndex + 1);
 638         xhci_port_set_test_mode(xhci, test_mode, wIndex);
 639         return retval;
 640 }
 641
 642 static int xhci_exit_test_mode(struct xhci_hcd *xhci)
 643 {
 644         int retval;
 645
 646         if (!xhci->test_mode) {
 647                 xhci_err(xhci, "Not in test mode, do nothing.\n");
 648                 return 0;
 649         }
 650         if (xhci->test_mode == TEST_FORCE_EN &&
 651                 !(xhci->xhc_state & XHCI_STATE_HALTED)) {
 652                 retval = xhci_halt(xhci);
 653                 if (retval)
 654                         return retval;
 655         }
 656         pm_runtime_allow(xhci_to_hcd(xhci)->self.controller);
 657         xhci->test_mode = 0;
 658         return xhci_reset(xhci);
 659 }
 660
 661 void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
 662                                 int port_id, u32 link_state)
 663 {
 664         u32 temp;
 665
 666         temp = readl(port_array[port_id]);
 667         temp = xhci_port_state_to_neutral(temp);
 668         temp &= ~PORT_PLS_MASK;
 669         temp |= PORT_LINK_STROBE | link_state;
 670         writel(temp, port_array[port_id]);
 671 }
 672
 673 static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
 674                 __le32 __iomem **port_array, int port_id, u16 wake_mask)
 675 {
 676         u32 temp;
 677
 678         temp = readl(port_array[port_id]);
 679         temp = xhci_port_state_to_neutral(temp);
 680
 681         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
 682                 temp |= PORT_WKCONN_E;
 683         else
 684                 temp &= ~PORT_WKCONN_E;
 685
 686         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
 687                 temp |= PORT_WKDISC_E;
 688         else
 689                 temp &= ~PORT_WKDISC_E;
 690
 691         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
 692                 temp |= PORT_WKOC_E;
 693         else
 694                 temp &= ~PORT_WKOC_E;
 695
 696         writel(temp, port_array[port_id]);
 697 }
 698
 699 /* Test and clear port RWC bit */
 700 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
 701                                 int port_id, u32 port_bit)
 702 {
 703         u32 temp;
 704
 705         temp = readl(port_array[port_id]);
 706         if (temp & port_bit) {
 707                 temp = xhci_port_state_to_neutral(temp);
 708                 temp |= port_bit;
 709                 writel(temp, port_array[port_id]);
 710         }
 711 }
 712
 713 /* Updates Link Status for USB 2.1 port */
 714 static void xhci_hub_report_usb2_link_state(u32 *status, u32 status_reg)
 715 {
 716         if ((status_reg & PORT_PLS_MASK) == XDEV_U2)
 717                 *status |= USB_PORT_STAT_L1;
 718 }
 719
 720 /* Updates Link Status for super Speed port */
 721 static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
 722                 u32 *status, u32 status_reg)
 723 {
 724         u32 pls = status_reg & PORT_PLS_MASK;
 725
 726         /* resume state is a xHCI internal state.
 727          * Do not report it to usb core, instead, pretend to be U3,
 728          * thus usb core knows it's not ready for transfer
 729          */
 730         if (pls == XDEV_RESUME) {
 731                 *status |= USB_SS_PORT_LS_U3;
 732                 return;
 733         }
 734
 735         /* When the CAS bit is set then warm reset
 736          * should be performed on port
 737          */
 738         if (status_reg & PORT_CAS) {
 739                 /* The CAS bit can be set while the port is
 740                  * in any link state.
 741                  * Only roothubs have CAS bit, so we
 742                  * pretend to be in compliance mode
 743                  * unless we're already in compliance
 744                  * or the inactive state.
 745                  */
 746                 if (pls != USB_SS_PORT_LS_COMP_MOD &&
 747                     pls != USB_SS_PORT_LS_SS_INACTIVE) {
 748                         pls = USB_SS_PORT_LS_COMP_MOD;
 749                 }
 750                 /* Return also connection bit -
 751                  * hub state machine resets port
 752                  * when this bit is set.
 753                  */
 754                 pls |= USB_PORT_STAT_CONNECTION;
 755         } else {
 756                 /*
 757                  * If CAS bit isn't set but the Port is already at
 758                  * Compliance Mode, fake a connection so the USB core
 759                  * notices the Compliance state and resets the port.
 760                  * This resolves an issue generated by the SN65LVPE502CP
 761                  * in which sometimes the port enters compliance mode
 762                  * caused by a delay on the host-device negotiation.
 763                  */
 764                 if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
 765                                 (pls == USB_SS_PORT_LS_COMP_MOD))
 766                         pls |= USB_PORT_STAT_CONNECTION;
 767         }
 768
 769         /* update status field */
 770         *status |= pls;
 771 }
 772
 773 /*
 774  * Function for Compliance Mode Quirk.
 775  *
 776  * This Function verifies if all xhc USB3 ports have entered U0, if so,
 777  * the compliance mode timer is deleted. A port won't enter
 778  * compliance mode if it has previously entered U0.
 779  */
 780 static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
 781                                     u16 wIndex)
 782 {
 783         u32 all_ports_seen_u0 = ((1 << xhci->num_usb3_ports)-1);
 784         bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);
 785
 786         if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
 787                 return;
 788
 789         if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
 790                 xhci->port_status_u0 |= 1 << wIndex;
 791                 if (xhci->port_status_u0 == all_ports_seen_u0) {
 792                         del_timer_sync(&xhci->comp_mode_recovery_timer);
 793                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 794                                 "All USB3 ports have entered U0 already!");
 795                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 796                                 "Compliance Mode Recovery Timer Deleted.");
 797                 }
 798         }
 799 }
 800
 801 static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
 802 {
 803         u32 ext_stat = 0;
 804         int speed_id;
 805
 806         /* only support rx and tx lane counts of 1 in usb3.1 spec */
 807         speed_id = DEV_PORT_SPEED(raw_port_status);
 808         ext_stat |= speed_id;           /* bits 3:0, RX speed id */
 809         ext_stat |= speed_id << 4;      /* bits 7:4, TX speed id */
 810
 811         ext_stat |= PORT_RX_LANES(port_li) << 8;  /* bits 11:8 Rx lane count */
 812         ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */
 813
 814         return ext_stat;
 815 }
 816
 817 /*
 818  * Converts a raw xHCI port status into the format that external USB 2.0 or USB
 819  * 3.0 hubs use.
 820  *
 821  * Possible side effects:
 822  *  - Mark a port as being done with device resume,
 823  *    and ring the endpoint doorbells.
 824  *  - Stop the Synopsys redriver Compliance Mode polling.
 825  *  - Drop and reacquire the xHCI lock, in order to wait for port resume.
 826  */
 827 static u32 xhci_get_port_status(struct usb_hcd *hcd,
 828                 struct xhci_bus_state *bus_state,
 829                 __le32 __iomem **port_array,
 830                 u16 wIndex, u32 raw_port_status,
 831                 unsigned long flags)
 832         __releases(&xhci->lock)
 833         __acquires(&xhci->lock)
 834 {
 835         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 836         u32 status = 0;
 837         int slot_id;
 838
 839         /* wPortChange bits */
 840         if (raw_port_status & PORT_CSC)
 841                 status |= USB_PORT_STAT_C_CONNECTION << 16;
 842         if (raw_port_status & PORT_PEC)
 843                 status |= USB_PORT_STAT_C_ENABLE << 16;
 844         if ((raw_port_status & PORT_OCC))
 845                 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
 846         if ((raw_port_status & PORT_RC))
 847                 status |= USB_PORT_STAT_C_RESET << 16;
 848         /* USB3.0 only */
 849         if (hcd->speed >= HCD_USB3) {
 850                 /* Port link change with port in resume state should not be
 851                  * reported to usbcore, as this is an internal state to be
 852                  * handled by xhci driver. Reporting PLC to usbcore may
 853                  * cause usbcore clearing PLC first and port change event
 854                  * irq won't be generated.
 855                  */
 856                 if ((raw_port_status & PORT_PLC) &&
 857                         (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME)
 858                         status |= USB_PORT_STAT_C_LINK_STATE << 16;
 859                 if ((raw_port_status & PORT_WRC))
 860                         status |= USB_PORT_STAT_C_BH_RESET << 16;
 861                 if ((raw_port_status & PORT_CEC))
 862                         status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;
 863         }
 864
 865         if (hcd->speed < HCD_USB3) {
 866                 if ((raw_port_status & PORT_PLS_MASK) == XDEV_U3
 867                                 && (raw_port_status & PORT_POWER))
 868                         status |= USB_PORT_STAT_SUSPEND;
 869         }
 870         if ((raw_port_status & PORT_PLS_MASK) == XDEV_RESUME &&
 871                 !DEV_SUPERSPEED_ANY(raw_port_status)) {
 872                 if ((raw_port_status & PORT_RESET) ||
 873                                 !(raw_port_status & PORT_PE))
 874                         return 0xffffffff;
 875                 /* did port event handler already start resume timing? */
 876                 if (!bus_state->resume_done[wIndex]) {
 877                         /* If not, maybe we are in a host initated resume? */
 878                         if (test_bit(wIndex, &bus_state->resuming_ports)) {
 879                                 /* Host initated resume doesn't time the resume
 880                                  * signalling using resume_done[].
 881                                  * It manually sets RESUME state, sleeps 20ms
 882                                  * and sets U0 state. This should probably be
 883                                  * changed, but not right now.
 884                                  */
 885                         } else {
 886                                 /* port resume was discovered now and here,
 887                                  * start resume timing
 888                                  */
 889                                 unsigned long timeout = jiffies +
 890                                         msecs_to_jiffies(USB_RESUME_TIMEOUT);
 891
 892                                 set_bit(wIndex, &bus_state->resuming_ports);
 893                                 bus_state->resume_done[wIndex] = timeout;
 894                                 mod_timer(&hcd->rh_timer, timeout);
 895                         }
 896                 /* Has resume been signalled for USB_RESUME_TIME yet? */
 897                 } else if (time_after_eq(jiffies,
 898                                          bus_state->resume_done[wIndex])) {
 899                         int time_left;
 900
 901                         xhci_dbg(xhci, "Resume USB2 port %d\n",
 902                                         wIndex + 1);
 903                         bus_state->resume_done[wIndex] = 0;
 904                         clear_bit(wIndex, &bus_state->resuming_ports);
 905
 906                         set_bit(wIndex, &bus_state->rexit_ports);
 907                         xhci_set_link_state(xhci, port_array, wIndex,
 908                                         XDEV_U0);
 909
 910                         spin_unlock_irqrestore(&xhci->lock, flags);
 911                         time_left = wait_for_completion_timeout(
 912                                         &bus_state->rexit_done[wIndex],
 913                                         msecs_to_jiffies(
 914                                                 XHCI_MAX_REXIT_TIMEOUT));
 915                         spin_lock_irqsave(&xhci->lock, flags);
 916
 917                         if (time_left) {
 918                                 slot_id = xhci_find_slot_id_by_port(hcd,
 919                                                 xhci, wIndex + 1);
 920                                 if (!slot_id) {
 921                                         xhci_dbg(xhci, "slot_id is zero\n");
 922                                         return 0xffffffff;
 923                                 }
 924                                 xhci_ring_device(xhci, slot_id);
 925                         } else {
 926                                 int port_status = readl(port_array[wIndex]);
 927                                 xhci_warn(xhci, "Port resume took longer than %i msec, port status = 0x%x\n",
 928                                                 XHCI_MAX_REXIT_TIMEOUT,
 929                                                 port_status);
 930                                 status |= USB_PORT_STAT_SUSPEND;
 931                                 clear_bit(wIndex, &bus_state->rexit_ports);
 932                         }
 933
 934                         bus_state->port_c_suspend |= 1 << wIndex;
 935                         bus_state->suspended_ports &= ~(1 << wIndex);
 936                 } else {
 937                         /*
 938                          * The resume has been signaling for less than
 939                          * USB_RESUME_TIME. Report the port status as SUSPEND,
 940                          * let the usbcore check port status again and clear
 941                          * resume signaling later.
 942                          */
 943                         status |= USB_PORT_STAT_SUSPEND;
 944                 }
 945         }
 946         /*
 947          * Clear stale usb2 resume signalling variables in case port changed
 948          * state during resume signalling. For example on error
 949          */
 950         if ((bus_state->resume_done[wIndex] ||
 951              test_bit(wIndex, &bus_state->resuming_ports)) &&
 952             (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
 953             (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
 954                 bus_state->resume_done[wIndex] = 0;
 955                 clear_bit(wIndex, &bus_state->resuming_ports);
 956         }
 957
 958
 959         if ((raw_port_status & PORT_PLS_MASK) == XDEV_U0 &&
 960             (raw_port_status & PORT_POWER)) {
 961                 if (bus_state->suspended_ports & (1 << wIndex)) {
 962                         bus_state->suspended_ports &= ~(1 << wIndex);
 963                         if (hcd->speed < HCD_USB3)
 964                                 bus_state->port_c_suspend |= 1 << wIndex;
 965                 }
 966                 bus_state->resume_done[wIndex] = 0;
 967                 clear_bit(wIndex, &bus_state->resuming_ports);
 968         }
 969         if (raw_port_status & PORT_CONNECT) {
 970                 status |= USB_PORT_STAT_CONNECTION;
 971                 status |= xhci_port_speed(raw_port_status);
 972         }
 973         if (raw_port_status & PORT_PE)
 974                 status |= USB_PORT_STAT_ENABLE;
 975         if (raw_port_status & PORT_OC)
 976                 status |= USB_PORT_STAT_OVERCURRENT;
 977         if (raw_port_status & PORT_RESET)
 978                 status |= USB_PORT_STAT_RESET;
 979         if (raw_port_status & PORT_POWER) {
 980                 if (hcd->speed >= HCD_USB3)
 981                         status |= USB_SS_PORT_STAT_POWER;
 982                 else
 983                         status |= USB_PORT_STAT_POWER;
 984         }
 985         /* Update Port Link State */
 986         if (hcd->speed >= HCD_USB3) {
 987                 xhci_hub_report_usb3_link_state(xhci, &status, raw_port_status);
 988                 /*
 989                  * Verify if all USB3 Ports Have entered U0 already.
 990                  * Delete Compliance Mode Timer if so.
 991                  */
 992                 xhci_del_comp_mod_timer(xhci, raw_port_status, wIndex);
 993         } else {
 994                 xhci_hub_report_usb2_link_state(&status, raw_port_status);
 995         }
 996         if (bus_state->port_c_suspend & (1 << wIndex))
 997                 status |= USB_PORT_STAT_C_SUSPEND << 16;
 998
 999         return status;
1000 }
1001
1002 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
1003                 u16 wIndex, char *buf, u16 wLength)
1004 {
1005         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1006         int max_ports;
1007         unsigned long flags;
1008         u32 temp, status;
1009         int retval = 0;
1010         __le32 __iomem **port_array;
1011         int slot_id;
1012         struct xhci_bus_state *bus_state;
1013         u16 link_state = 0;
1014         u16 wake_mask = 0;
1015         u16 timeout = 0;
1016         u16 test_mode = 0;
1017
1018         max_ports = xhci_get_ports(hcd, &port_array);
1019         bus_state = &xhci->bus_state[hcd_index(hcd)];
1020
1021         spin_lock_irqsave(&xhci->lock, flags);
1022         switch (typeReq) {
1023         case GetHubStatus:
1024                 /* No power source, over-current reported per port */
1025                 memset(buf, 0, 4);
1026                 break;
1027         case GetHubDescriptor:
1028                 /* Check to make sure userspace is asking for the USB 3.0 hub
1029                  * descriptor for the USB 3.0 roothub.  If not, we stall the
1030                  * endpoint, like external hubs do.
1031                  */
1032                 if (hcd->speed >= HCD_USB3 &&
1033                                 (wLength < USB_DT_SS_HUB_SIZE ||
1034                                  wValue != (USB_DT_SS_HUB << 8))) {
1035                         xhci_dbg(xhci, "Wrong hub descriptor type for "
1036                                         "USB 3.0 roothub.\n");
1037                         goto error;
1038                 }
1039                 xhci_hub_descriptor(hcd, xhci,
1040                                 (struct usb_hub_descriptor *) buf);
1041                 break;
1042         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
1043                 if ((wValue & 0xff00) != (USB_DT_BOS << 8))
1044                         goto error;
1045
1046                 if (hcd->speed < HCD_USB3)
1047                         goto error;
1048
1049                 retval = xhci_create_usb3_bos_desc(xhci, buf, wLength);
1050                 spin_unlock_irqrestore(&xhci->lock, flags);
1051                 return retval;
1052         case GetPortStatus:
1053                 if (!wIndex || wIndex > max_ports)
1054                         goto error;
1055                 wIndex--;
1056                 temp = readl(port_array[wIndex]);
1057                 if (temp == ~(u32)0) {
1058                         xhci_hc_died(xhci);
1059                         retval = -ENODEV;
1060                         break;
1061                 }
1062                 status = xhci_get_port_status(hcd, bus_state, port_array,
1063                                 wIndex, temp, flags);
1064                 if (status == 0xffffffff)
1065                         goto error;
1066
1067                 xhci_dbg(xhci, "get port status, actual port %d status  = 0x%x\n",
1068                                 wIndex, temp);
1069                 xhci_dbg(xhci, "Get port status returned 0x%x\n", status);
1070
1071                 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
1072                 /* if USB 3.1 extended port status return additional 4 bytes */
1073                 if (wValue == 0x02) {
1074                         u32 port_li;
1075
1076                         if (hcd->speed < HCD_USB31 || wLength != 8) {
1077                                 xhci_err(xhci, "get ext port status invalid parameter\n");
1078                                 retval = -EINVAL;
1079                                 break;
1080                         }
1081                         port_li = readl(port_array[wIndex] + PORTLI);
1082                         status = xhci_get_ext_port_status(temp, port_li);
1083                         put_unaligned_le32(cpu_to_le32(status), &buf[4]);
1084                 }
1085                 break;
1086         case SetPortFeature:
1087                 if (wValue == USB_PORT_FEAT_LINK_STATE)
1088                         link_state = (wIndex & 0xff00) >> 3;
1089                 if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
1090                         wake_mask = wIndex & 0xff00;
1091                 if (wValue == USB_PORT_FEAT_TEST)
1092                         test_mode = (wIndex & 0xff00) >> 8;
1093                 /* The MSB of wIndex is the U1/U2 timeout */
1094                 timeout = (wIndex & 0xff00) >> 8;
1095                 wIndex &= 0xff;
1096                 if (!wIndex || wIndex > max_ports)
1097                         goto error;
1098                 wIndex--;
1099                 temp = readl(port_array[wIndex]);
1100                 if (temp == ~(u32)0) {
1101                         xhci_hc_died(xhci);
1102                         retval = -ENODEV;
1103                         break;
1104                 }
1105                 temp = xhci_port_state_to_neutral(temp);
1106                 /* FIXME: What new port features do we need to support? */
1107                 switch (wValue) {
1108                 case USB_PORT_FEAT_SUSPEND:
1109                         temp = readl(port_array[wIndex]);
1110                         if ((temp & PORT_PLS_MASK) != XDEV_U0) {
1111                                 /* Resume the port to U0 first */
1112                                 xhci_set_link_state(xhci, port_array, wIndex,
1113                                                         XDEV_U0);
1114                                 spin_unlock_irqrestore(&xhci->lock, flags);
1115                                 msleep(10);
1116                                 spin_lock_irqsave(&xhci->lock, flags);
1117                         }
1118                         /* In spec software should not attempt to suspend
1119                          * a port unless the port reports that it is in the
1120                          * enabled (PED = ‘1’,PLS < ‘3’) state.
1121                          */
1122                         temp = readl(port_array[wIndex]);
1123                         if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
1124                                 || (temp & PORT_PLS_MASK) >= XDEV_U3) {
1125                                 xhci_warn(xhci, "USB core suspending device not in U0/U1/U2.\n");
1126                                 goto error;
1127                         }
1128
1129                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1130                                         wIndex + 1);
1131                         if (!slot_id) {
1132                                 xhci_warn(xhci, "slot_id is zero\n");
1133                                 goto error;
1134                         }
1135                         /* unlock to execute stop endpoint commands */
1136                         spin_unlock_irqrestore(&xhci->lock, flags);
1137                         xhci_stop_device(xhci, slot_id, 1);
1138                         spin_lock_irqsave(&xhci->lock, flags);
1139
1140                         xhci_set_link_state(xhci, port_array, wIndex, XDEV_U3);
1141
1142                         spin_unlock_irqrestore(&xhci->lock, flags);
1143                         msleep(10); /* wait device to enter */
1144                         spin_lock_irqsave(&xhci->lock, flags);
1145
1146                         temp = readl(port_array[wIndex]);
1147                         bus_state->suspended_ports |= 1 << wIndex;
1148                         break;
1149                 case USB_PORT_FEAT_LINK_STATE:
1150                         temp = readl(port_array[wIndex]);
1151
1152                         /* Disable port */
1153                         if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
1154                                 xhci_dbg(xhci, "Disable port %d\n", wIndex);
1155                                 temp = xhci_port_state_to_neutral(temp);
1156                                 /*
1157                                  * Clear all change bits, so that we get a new
1158                                  * connection event.
1159                                  */
1160                                 temp |= PORT_CSC | PORT_PEC | PORT_WRC |
1161                                         PORT_OCC | PORT_RC | PORT_PLC |
1162                                         PORT_CEC;
1163                                 writel(temp | PORT_PE, port_array[wIndex]);
1164                                 temp = readl(port_array[wIndex]);
1165                                 break;
1166                         }
1167
1168                         /* Put link in RxDetect (enable port) */
1169                         if (link_state == USB_SS_PORT_LS_RX_DETECT) {
1170                                 xhci_dbg(xhci, "Enable port %d\n", wIndex);
1171                                 xhci_set_link_state(xhci, port_array, wIndex,
1172                                                 link_state);
1173                                 temp = readl(port_array[wIndex]);
1174                                 break;
1175                         }
1176
1177                         /* Software should not attempt to set
1178                          * port link state above '3' (U3) and the port
1179                          * must be enabled.
1180                          */
1181                         if ((temp & PORT_PE) == 0 ||
1182                                 (link_state > USB_SS_PORT_LS_U3)) {
1183                                 xhci_warn(xhci, "Cannot set link state.\n");
1184                                 goto error;
1185                         }
1186
1187                         if (link_state == USB_SS_PORT_LS_U3) {
1188                                 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1189                                                 wIndex + 1);
1190                                 if (slot_id) {
1191                                         /* unlock to execute stop endpoint
1192                                          * commands */
1193                                         spin_unlock_irqrestore(&xhci->lock,
1194                                                                 flags);
1195                                         xhci_stop_device(xhci, slot_id, 1);
1196                                         spin_lock_irqsave(&xhci->lock, flags);
1197                                 }
1198                         }
1199
1200                         xhci_set_link_state(xhci, port_array, wIndex,
1201                                                 link_state);
1202
1203                         spin_unlock_irqrestore(&xhci->lock, flags);
1204                         msleep(20); /* wait device to enter */
1205                         spin_lock_irqsave(&xhci->lock, flags);
1206
1207                         temp = readl(port_array[wIndex]);
1208                         if (link_state == USB_SS_PORT_LS_U3)
1209                                 bus_state->suspended_ports |= 1 << wIndex;
1210                         break;
1211                 case USB_PORT_FEAT_POWER:
1212                         /*
1213                          * Turn on ports, even if there isn't per-port switching.
1214                          * HC will report connect events even before this is set.
1215                          * However, hub_wq will ignore the roothub events until
1216                          * the roothub is registered.
1217                          */
1218                         xhci_set_port_power(xhci, hcd, wIndex, true, &flags);
1219                         break;
1220                 case USB_PORT_FEAT_RESET:
1221                         temp = (temp | PORT_RESET);
1222                         writel(temp, port_array[wIndex]);
1223
1224                         temp = readl(port_array[wIndex]);
1225                         xhci_dbg(xhci, "set port reset, actual port %d status  = 0x%x\n", wIndex, temp);
1226                         break;
1227                 case USB_PORT_FEAT_REMOTE_WAKE_MASK:
1228                         xhci_set_remote_wake_mask(xhci, port_array,
1229                                         wIndex, wake_mask);
1230                         temp = readl(port_array[wIndex]);
1231                         xhci_dbg(xhci, "set port remote wake mask, "
1232                                         "actual port %d status  = 0x%x\n",
1233                                         wIndex, temp);
1234                         break;
1235                 case USB_PORT_FEAT_BH_PORT_RESET:
1236                         temp |= PORT_WR;
1237                         writel(temp, port_array[wIndex]);
1238
1239                         temp = readl(port_array[wIndex]);
1240                         break;
1241                 case USB_PORT_FEAT_U1_TIMEOUT:
1242                         if (hcd->speed < HCD_USB3)
1243                                 goto error;
1244                         temp = readl(port_array[wIndex] + PORTPMSC);
1245                         temp &= ~PORT_U1_TIMEOUT_MASK;
1246                         temp |= PORT_U1_TIMEOUT(timeout);
1247                         writel(temp, port_array[wIndex] + PORTPMSC);
1248                         break;
1249                 case USB_PORT_FEAT_U2_TIMEOUT:
1250                         if (hcd->speed < HCD_USB3)
1251                                 goto error;
1252                         temp = readl(port_array[wIndex] + PORTPMSC);
1253                         temp &= ~PORT_U2_TIMEOUT_MASK;
1254                         temp |= PORT_U2_TIMEOUT(timeout);
1255                         writel(temp, port_array[wIndex] + PORTPMSC);
1256                         break;
1257                 case USB_PORT_FEAT_TEST:
1258                         /* 4.19.6 Port Test Modes (USB2 Test Mode) */
1259                         if (hcd->speed != HCD_USB2)
1260                                 goto error;
1261                         if (test_mode > TEST_FORCE_EN || test_mode < TEST_J)
1262                                 goto error;
1263                         retval = xhci_enter_test_mode(xhci, test_mode, wIndex,
1264                                                       &flags);
1265                         break;
1266                 default:
1267                         goto error;
1268                 }
1269                 /* unblock any posted writes */
1270                 temp = readl(port_array[wIndex]);
1271                 break;
1272         case ClearPortFeature:
1273                 if (!wIndex || wIndex > max_ports)
1274                         goto error;
1275                 wIndex--;
1276                 temp = readl(port_array[wIndex]);
1277                 if (temp == ~(u32)0) {
1278                         xhci_hc_died(xhci);
1279                         retval = -ENODEV;
1280                         break;
1281                 }
1282                 /* FIXME: What new port features do we need to support? */
1283                 temp = xhci_port_state_to_neutral(temp);
1284                 switch (wValue) {
1285                 case USB_PORT_FEAT_SUSPEND:
1286                         temp = readl(port_array[wIndex]);
1287                         xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
1288                         xhci_dbg(xhci, "PORTSC %04x\n", temp);
1289                         if (temp & PORT_RESET)
1290                                 goto error;
1291                         if ((temp & PORT_PLS_MASK) == XDEV_U3) {
1292                                 if ((temp & PORT_PE) == 0)
1293                                         goto error;
1294
1295                                 set_bit(wIndex, &bus_state->resuming_ports);
1296                                 xhci_set_link_state(xhci, port_array, wIndex,
1297                                                         XDEV_RESUME);
1298                                 spin_unlock_irqrestore(&xhci->lock, flags);
1299                                 msleep(USB_RESUME_TIMEOUT);
1300                                 spin_lock_irqsave(&xhci->lock, flags);
1301                                 xhci_set_link_state(xhci, port_array, wIndex,
1302                                                         XDEV_U0);
1303                                 clear_bit(wIndex, &bus_state->resuming_ports);
1304                         }
1305                         bus_state->port_c_suspend |= 1 << wIndex;
1306
1307                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1308                                         wIndex + 1);
1309                         if (!slot_id) {
1310                                 xhci_dbg(xhci, "slot_id is zero\n");
1311                                 goto error;
1312                         }
1313                         xhci_ring_device(xhci, slot_id);
1314                         break;
1315                 case USB_PORT_FEAT_C_SUSPEND:
1316                         bus_state->port_c_suspend &= ~(1 << wIndex);
1317                 case USB_PORT_FEAT_C_RESET:
1318                 case USB_PORT_FEAT_C_BH_PORT_RESET:
1319                 case USB_PORT_FEAT_C_CONNECTION:
1320                 case USB_PORT_FEAT_C_OVER_CURRENT:
1321                 case USB_PORT_FEAT_C_ENABLE:
1322                 case USB_PORT_FEAT_C_PORT_LINK_STATE:
1323                 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
1324                         xhci_clear_port_change_bit(xhci, wValue, wIndex,
1325                                         port_array[wIndex], temp);
1326                         break;
1327                 case USB_PORT_FEAT_ENABLE:
1328                         xhci_disable_port(hcd, xhci, wIndex,
1329                                         port_array[wIndex], temp);
1330                         break;
1331                 case USB_PORT_FEAT_POWER:
1332                         xhci_set_port_power(xhci, hcd, wIndex, false, &flags);
1333                         break;
1334                 case USB_PORT_FEAT_TEST:
1335                         retval = xhci_exit_test_mode(xhci);
1336                         break;
1337                 default:
1338                         goto error;
1339                 }
1340                 break;
1341         default:
1342 error:
1343                 /* "stall" on error */
1344                 retval = -EPIPE;
1345         }
1346         spin_unlock_irqrestore(&xhci->lock, flags);
1347         return retval;
1348 }
1349
1350 /*
1351  * Returns 0 if the status hasn't changed, or the number of bytes in buf.
1352  * Ports are 0-indexed from the HCD point of view,
1353  * and 1-indexed from the USB core pointer of view.
1354  *
1355  * Note that the status change bits will be cleared as soon as a port status
1356  * change event is generated, so we use the saved status from that event.
1357  */
1358 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
1359 {
1360         unsigned long flags;
1361         u32 temp, status;
1362         u32 mask;
1363         int i, retval;
1364         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1365         int max_ports;
1366         __le32 __iomem **port_array;
1367         struct xhci_bus_state *bus_state;
1368         bool reset_change = false;
1369
1370         max_ports = xhci_get_ports(hcd, &port_array);
1371         bus_state = &xhci->bus_state[hcd_index(hcd)];
1372
1373         /* Initial status is no changes */
1374         retval = (max_ports + 8) / 8;
1375         memset(buf, 0, retval);
1376
1377         /*
1378          * Inform the usbcore about resume-in-progress by returning
1379          * a non-zero value even if there are no status changes.
1380          */
1381         status = bus_state->resuming_ports;
1382
1383         mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;
1384
1385         spin_lock_irqsave(&xhci->lock, flags);
1386         /* For each port, did anything change?  If so, set that bit in buf. */
1387         for (i = 0; i < max_ports; i++) {
1388                 temp = readl(port_array[i]);
1389                 if (temp == ~(u32)0) {
1390                         xhci_hc_died(xhci);
1391                         retval = -ENODEV;
1392                         break;
1393                 }
1394                 if ((temp & mask) != 0 ||
1395                         (bus_state->port_c_suspend & 1 << i) ||
1396                         (bus_state->resume_done[i] && time_after_eq(
1397                             jiffies, bus_state->resume_done[i]))) {
1398                         buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
1399                         status = 1;
1400                 }
1401                 if ((temp & PORT_RC))
1402                         reset_change = true;
1403         }
1404         if (!status && !reset_change) {
1405                 xhci_dbg(xhci, "%s: stopping port polling.\n", __func__);
1406                 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1407         }
1408         spin_unlock_irqrestore(&xhci->lock, flags);
1409         return status ? retval : 0;
1410 }
1411
1412 #ifdef CONFIG_PM
1413
1414 int xhci_bus_suspend(struct usb_hcd *hcd)
1415 {
1416         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1417         int max_ports, port_index;
1418         __le32 __iomem **port_array;
1419         struct xhci_bus_state *bus_state;
1420         unsigned long flags;
1421
1422         max_ports = xhci_get_ports(hcd, &port_array);
1423         bus_state = &xhci->bus_state[hcd_index(hcd)];
1424
1425         spin_lock_irqsave(&xhci->lock, flags);
1426
1427         if (hcd->self.root_hub->do_remote_wakeup) {
1428                 if (bus_state->resuming_ports ||        /* USB2 */
1429                     bus_state->port_remote_wakeup) {    /* USB3 */
1430                         spin_unlock_irqrestore(&xhci->lock, flags);
1431                         xhci_dbg(xhci, "suspend failed because a port is resuming\n");
1432                         return -EBUSY;
1433                 }
1434         }
1435
1436         port_index = max_ports;
1437         bus_state->bus_suspended = 0;
1438         while (port_index--) {
1439                 /* suspend the port if the port is not suspended */
1440                 u32 t1, t2;
1441                 int slot_id;
1442
1443                 t1 = readl(port_array[port_index]);
1444                 t2 = xhci_port_state_to_neutral(t1);
1445
1446                 if ((t1 & PORT_PE) && !(t1 & PORT_PLS_MASK)) {
1447                         xhci_dbg(xhci, "port %d not suspended\n", port_index);
1448                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1449                                         port_index + 1);
1450                         if (slot_id) {
1451                                 spin_unlock_irqrestore(&xhci->lock, flags);
1452                                 xhci_stop_device(xhci, slot_id, 1);
1453                                 spin_lock_irqsave(&xhci->lock, flags);
1454                         }
1455                         t2 &= ~PORT_PLS_MASK;
1456                         t2 |= PORT_LINK_STROBE | XDEV_U3;
1457                         set_bit(port_index, &bus_state->bus_suspended);
1458                 }
1459                 /* USB core sets remote wake mask for USB 3.0 hubs,
1460                  * including the USB 3.0 roothub, but only if CONFIG_PM
1461                  * is enabled, so also enable remote wake here.
1462                  */
1463                 if (hcd->self.root_hub->do_remote_wakeup) {
1464                         if (t1 & PORT_CONNECT) {
1465                                 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
1466                                 t2 &= ~PORT_WKCONN_E;
1467                         } else {
1468                                 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
1469                                 t2 &= ~PORT_WKDISC_E;
1470                         }
1471                         if ((xhci->quirks & XHCI_U2_DISABLE_WAKE) &&
1472                             (hcd->speed < HCD_USB3))
1473                                 t2 &= ~PORT_WAKE_BITS;
1474                 } else
1475                         t2 &= ~PORT_WAKE_BITS;
1476
1477                 t1 = xhci_port_state_to_neutral(t1);
1478                 if (t1 != t2)
1479                         writel(t2, port_array[port_index]);
1480         }
1481         hcd->state = HC_STATE_SUSPENDED;
1482         bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
1483         spin_unlock_irqrestore(&xhci->lock, flags);
1484         return 0;
1485 }
1486
1487 /*
1488  * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
1489  * warm reset a USB3 device stuck in polling or compliance mode after resume.
1490  * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
1491  */
1492 static bool xhci_port_missing_cas_quirk(int port_index,
1493                                              __le32 __iomem **port_array)
1494 {
1495         u32 portsc;
1496
1497         portsc = readl(port_array[port_index]);
1498
1499         /* if any of these are set we are not stuck */
1500         if (portsc & (PORT_CONNECT | PORT_CAS))
1501                 return false;
1502
1503         if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
1504             ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
1505                 return false;
1506
1507         /* clear wakeup/change bits, and do a warm port reset */
1508         portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1509         portsc |= PORT_WR;
1510         writel(portsc, port_array[port_index]);
1511         /* flush write */
1512         readl(port_array[port_index]);
1513         return true;
1514 }
1515
1516 int xhci_bus_resume(struct usb_hcd *hcd)
1517 {
1518         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1519         int max_ports, port_index;
1520         __le32 __iomem **port_array;
1521         struct xhci_bus_state *bus_state;
1522         u32 temp;
1523         unsigned long flags;
1524         unsigned long port_was_suspended = 0;
1525         bool need_usb2_u3_exit = false;
1526         int slot_id;
1527         int sret;
1528
1529         max_ports = xhci_get_ports(hcd, &port_array);
1530         bus_state = &xhci->bus_state[hcd_index(hcd)];
1531
1532         if (time_before(jiffies, bus_state->next_statechange))
1533                 msleep(5);
1534
1535         spin_lock_irqsave(&xhci->lock, flags);
1536         if (!HCD_HW_ACCESSIBLE(hcd)) {
1537                 spin_unlock_irqrestore(&xhci->lock, flags);
1538                 return -ESHUTDOWN;
1539         }
1540
1541         /* delay the irqs */
1542         temp = readl(&xhci->op_regs->command);
1543         temp &= ~CMD_EIE;
1544         writel(temp, &xhci->op_regs->command);
1545
1546         port_index = max_ports;
1547         while (port_index--) {
1548                 /* Check whether need resume ports. If needed
1549                    resume port and disable remote wakeup */
1550                 u32 temp;
1551
1552                 temp = readl(port_array[port_index]);
1553
1554                 /* warm reset CAS limited ports stuck in polling/compliance */
1555                 if ((xhci->quirks & XHCI_MISSING_CAS) &&
1556                     (hcd->speed >= HCD_USB3) &&
1557                     xhci_port_missing_cas_quirk(port_index, port_array)) {
1558                         xhci_dbg(xhci, "reset stuck port %d\n", port_index);
1559                         continue;
1560                 }
1561                 if (DEV_SUPERSPEED_ANY(temp))
1562                         temp &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1563                 else
1564                         temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
1565                 if (test_bit(port_index, &bus_state->bus_suspended) &&
1566                     (temp & PORT_PLS_MASK)) {
1567                         set_bit(port_index, &port_was_suspended);
1568                         if (!DEV_SUPERSPEED_ANY(temp)) {
1569                                 xhci_set_link_state(xhci, port_array,
1570                                                 port_index, XDEV_RESUME);
1571                                 need_usb2_u3_exit = true;
1572                         }
1573                 } else
1574                         writel(temp, port_array[port_index]);
1575         }
1576
1577         if (need_usb2_u3_exit) {
1578                 spin_unlock_irqrestore(&xhci->lock, flags);
1579                 msleep(USB_RESUME_TIMEOUT);
1580                 spin_lock_irqsave(&xhci->lock, flags);
1581         }
1582
1583         port_index = max_ports;
1584         while (port_index--) {
1585                 if (!(port_was_suspended & BIT(port_index)))
1586                         continue;
1587                 /* Clear PLC to poll it later after XDEV_U0 */
1588                 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1589                 xhci_set_link_state(xhci, port_array, port_index, XDEV_U0);
1590         }
1591
1592         port_index = max_ports;
1593         while (port_index--) {
1594                 if (!(port_was_suspended & BIT(port_index)))
1595                         continue;
1596                 /* Poll and Clear PLC */
1597                 sret = xhci_handshake(port_array[port_index], PORT_PLC,
1598                                       PORT_PLC, 10 * 1000);
1599                 if (sret)
1600                         xhci_warn(xhci, "port %d resume PLC timeout\n",
1601                                   port_index);
1602                 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1603                 slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
1604                 if (slot_id)
1605                         xhci_ring_device(xhci, slot_id);
1606         }
1607
1608         (void) readl(&xhci->op_regs->command);
1609
1610         bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
1611         /* re-enable irqs */
1612         temp = readl(&xhci->op_regs->command);
1613         temp |= CMD_EIE;
1614         writel(temp, &xhci->op_regs->command);
1615         temp = readl(&xhci->op_regs->command);
1616
1617         spin_unlock_irqrestore(&xhci->lock, flags);
1618         return 0;
1619 }
1620
1621 #endif  /* CONFIG_PM */