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                 xhci_dbg(xhci, "Couldn't allocate command structure.\n");
 397                 return -ENOMEM;
 398         }
 399
 400         spin_lock_irqsave(&xhci->lock, flags);
 401         for (i = LAST_EP_INDEX; i > 0; i--) {
 402                 if (virt_dev->eps[i].ring && virt_dev->eps[i].ring->dequeue) {
 403                         struct xhci_command *command;
 404                         command = xhci_alloc_command(xhci, false, false,
 405                                                      GFP_NOWAIT);
 406                         if (!command) {
 407                                 spin_unlock_irqrestore(&xhci->lock, flags);
 408                                 xhci_free_command(xhci, cmd);
 409                                 return -ENOMEM;
 410
 411                         }
 412                         xhci_queue_stop_endpoint(xhci, command, slot_id, i,
 413                                                  suspend);
 414                 }
 415         }
 416         xhci_queue_stop_endpoint(xhci, cmd, slot_id, 0, suspend);
 417         xhci_ring_cmd_db(xhci);
 418         spin_unlock_irqrestore(&xhci->lock, flags);
 419
 420         /* Wait for last stop endpoint command to finish */
 421         wait_for_completion(cmd->completion);
 422
 423         if (cmd->status == COMP_COMMAND_ABORTED ||
 424                         cmd->status == COMP_STOPPED) {
 425                 xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
 426                 ret = -ETIME;
 427         }
 428         xhci_free_command(xhci, cmd);
 429         return ret;
 430 }
 431
 432 /*
 433  * Ring device, it rings the all doorbells unconditionally.
 434  */
 435 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id)
 436 {
 437         int i, s;
 438         struct xhci_virt_ep *ep;
 439
 440         for (i = 0; i < LAST_EP_INDEX + 1; i++) {
 441                 ep = &xhci->devs[slot_id]->eps[i];
 442
 443                 if (ep->ep_state & EP_HAS_STREAMS) {
 444                         for (s = 1; s < ep->stream_info->num_streams; s++)
 445                                 xhci_ring_ep_doorbell(xhci, slot_id, i, s);
 446                 } else if (ep->ring && ep->ring->dequeue) {
 447                         xhci_ring_ep_doorbell(xhci, slot_id, i, 0);
 448                 }
 449         }
 450
 451         return;
 452 }
 453
 454 static void xhci_disable_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
 455                 u16 wIndex, __le32 __iomem *addr, u32 port_status)
 456 {
 457         /* Don't allow the USB core to disable SuperSpeed ports. */
 458         if (hcd->speed >= HCD_USB3) {
 459                 xhci_dbg(xhci, "Ignoring request to disable "
 460                                 "SuperSpeed port.\n");
 461                 return;
 462         }
 463
 464         if (xhci->quirks & XHCI_BROKEN_PORT_PED) {
 465                 xhci_dbg(xhci,
 466                          "Broken Port Enabled/Disabled, ignoring port disable request.\n");
 467                 return;
 468         }
 469
 470         /* Write 1 to disable the port */
 471         writel(port_status | PORT_PE, addr);
 472         port_status = readl(addr);
 473         xhci_dbg(xhci, "disable port, actual port %d status  = 0x%x\n",
 474                         wIndex, port_status);
 475 }
 476
 477 static void xhci_clear_port_change_bit(struct xhci_hcd *xhci, u16 wValue,
 478                 u16 wIndex, __le32 __iomem *addr, u32 port_status)
 479 {
 480         char *port_change_bit;
 481         u32 status;
 482
 483         switch (wValue) {
 484         case USB_PORT_FEAT_C_RESET:
 485                 status = PORT_RC;
 486                 port_change_bit = "reset";
 487                 break;
 488         case USB_PORT_FEAT_C_BH_PORT_RESET:
 489                 status = PORT_WRC;
 490                 port_change_bit = "warm(BH) reset";
 491                 break;
 492         case USB_PORT_FEAT_C_CONNECTION:
 493                 status = PORT_CSC;
 494                 port_change_bit = "connect";
 495                 break;
 496         case USB_PORT_FEAT_C_OVER_CURRENT:
 497                 status = PORT_OCC;
 498                 port_change_bit = "over-current";
 499                 break;
 500         case USB_PORT_FEAT_C_ENABLE:
 501                 status = PORT_PEC;
 502                 port_change_bit = "enable/disable";
 503                 break;
 504         case USB_PORT_FEAT_C_SUSPEND:
 505                 status = PORT_PLC;
 506                 port_change_bit = "suspend/resume";
 507                 break;
 508         case USB_PORT_FEAT_C_PORT_LINK_STATE:
 509                 status = PORT_PLC;
 510                 port_change_bit = "link state";
 511                 break;
 512         case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
 513                 status = PORT_CEC;
 514                 port_change_bit = "config error";
 515                 break;
 516         default:
 517                 /* Should never happen */
 518                 return;
 519         }
 520         /* Change bits are all write 1 to clear */
 521         writel(port_status | status, addr);
 522         port_status = readl(addr);
 523         xhci_dbg(xhci, "clear port %s change, actual port %d status  = 0x%x\n",
 524                         port_change_bit, wIndex, port_status);
 525 }
 526
 527 static int xhci_get_ports(struct usb_hcd *hcd, __le32 __iomem ***port_array)
 528 {
 529         int max_ports;
 530         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 531
 532         if (hcd->speed >= HCD_USB3) {
 533                 max_ports = xhci->num_usb3_ports;
 534                 *port_array = xhci->usb3_ports;
 535         } else {
 536                 max_ports = xhci->num_usb2_ports;
 537                 *port_array = xhci->usb2_ports;
 538         }
 539
 540         return max_ports;
 541 }
 542
 543 void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
 544                                 int port_id, u32 link_state)
 545 {
 546         u32 temp;
 547
 548         temp = readl(port_array[port_id]);
 549         temp = xhci_port_state_to_neutral(temp);
 550         temp &= ~PORT_PLS_MASK;
 551         temp |= PORT_LINK_STROBE | link_state;
 552         writel(temp, port_array[port_id]);
 553 }
 554
 555 static void xhci_set_remote_wake_mask(struct xhci_hcd *xhci,
 556                 __le32 __iomem **port_array, int port_id, u16 wake_mask)
 557 {
 558         u32 temp;
 559
 560         temp = readl(port_array[port_id]);
 561         temp = xhci_port_state_to_neutral(temp);
 562
 563         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_CONNECT)
 564                 temp |= PORT_WKCONN_E;
 565         else
 566                 temp &= ~PORT_WKCONN_E;
 567
 568         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT)
 569                 temp |= PORT_WKDISC_E;
 570         else
 571                 temp &= ~PORT_WKDISC_E;
 572
 573         if (wake_mask & USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT)
 574                 temp |= PORT_WKOC_E;
 575         else
 576                 temp &= ~PORT_WKOC_E;
 577
 578         writel(temp, port_array[port_id]);
 579 }
 580
 581 /* Test and clear port RWC bit */
 582 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
 583                                 int port_id, u32 port_bit)
 584 {
 585         u32 temp;
 586
 587         temp = readl(port_array[port_id]);
 588         if (temp & port_bit) {
 589                 temp = xhci_port_state_to_neutral(temp);
 590                 temp |= port_bit;
 591                 writel(temp, port_array[port_id]);
 592         }
 593 }
 594
 595 /* Updates Link Status for USB 2.1 port */
 596 static void xhci_hub_report_usb2_link_state(u32 *status, u32 status_reg)
 597 {
 598         if ((status_reg & PORT_PLS_MASK) == XDEV_U2)
 599                 *status |= USB_PORT_STAT_L1;
 600 }
 601
 602 /* Updates Link Status for super Speed port */
 603 static void xhci_hub_report_usb3_link_state(struct xhci_hcd *xhci,
 604                 u32 *status, u32 status_reg)
 605 {
 606         u32 pls = status_reg & PORT_PLS_MASK;
 607
 608         /* resume state is a xHCI internal state.
 609          * Do not report it to usb core, instead, pretend to be U3,
 610          * thus usb core knows it's not ready for transfer
 611          */
 612         if (pls == XDEV_RESUME) {
 613                 *status |= USB_SS_PORT_LS_U3;
 614                 return;
 615         }
 616
 617         /* When the CAS bit is set then warm reset
 618          * should be performed on port
 619          */
 620         if (status_reg & PORT_CAS) {
 621                 /* The CAS bit can be set while the port is
 622                  * in any link state.
 623                  * Only roothubs have CAS bit, so we
 624                  * pretend to be in compliance mode
 625                  * unless we're already in compliance
 626                  * or the inactive state.
 627                  */
 628                 if (pls != USB_SS_PORT_LS_COMP_MOD &&
 629                     pls != USB_SS_PORT_LS_SS_INACTIVE) {
 630                         pls = USB_SS_PORT_LS_COMP_MOD;
 631                 }
 632                 /* Return also connection bit -
 633                  * hub state machine resets port
 634                  * when this bit is set.
 635                  */
 636                 pls |= USB_PORT_STAT_CONNECTION;
 637         } else {
 638                 /*
 639                  * If CAS bit isn't set but the Port is already at
 640                  * Compliance Mode, fake a connection so the USB core
 641                  * notices the Compliance state and resets the port.
 642                  * This resolves an issue generated by the SN65LVPE502CP
 643                  * in which sometimes the port enters compliance mode
 644                  * caused by a delay on the host-device negotiation.
 645                  */
 646                 if ((xhci->quirks & XHCI_COMP_MODE_QUIRK) &&
 647                                 (pls == USB_SS_PORT_LS_COMP_MOD))
 648                         pls |= USB_PORT_STAT_CONNECTION;
 649         }
 650
 651         /* update status field */
 652         *status |= pls;
 653 }
 654
 655 /*
 656  * Function for Compliance Mode Quirk.
 657  *
 658  * This Function verifies if all xhc USB3 ports have entered U0, if so,
 659  * the compliance mode timer is deleted. A port won't enter
 660  * compliance mode if it has previously entered U0.
 661  */
 662 static void xhci_del_comp_mod_timer(struct xhci_hcd *xhci, u32 status,
 663                                     u16 wIndex)
 664 {
 665         u32 all_ports_seen_u0 = ((1 << xhci->num_usb3_ports)-1);
 666         bool port_in_u0 = ((status & PORT_PLS_MASK) == XDEV_U0);
 667
 668         if (!(xhci->quirks & XHCI_COMP_MODE_QUIRK))
 669                 return;
 670
 671         if ((xhci->port_status_u0 != all_ports_seen_u0) && port_in_u0) {
 672                 xhci->port_status_u0 |= 1 << wIndex;
 673                 if (xhci->port_status_u0 == all_ports_seen_u0) {
 674                         del_timer_sync(&xhci->comp_mode_recovery_timer);
 675                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 676                                 "All USB3 ports have entered U0 already!");
 677                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 678                                 "Compliance Mode Recovery Timer Deleted.");
 679                 }
 680         }
 681 }
 682
 683 static u32 xhci_get_ext_port_status(u32 raw_port_status, u32 port_li)
 684 {
 685         u32 ext_stat = 0;
 686         int speed_id;
 687
 688         /* only support rx and tx lane counts of 1 in usb3.1 spec */
 689         speed_id = DEV_PORT_SPEED(raw_port_status);
 690         ext_stat |= speed_id;           /* bits 3:0, RX speed id */
 691         ext_stat |= speed_id << 4;      /* bits 7:4, TX speed id */
 692
 693         ext_stat |= PORT_RX_LANES(port_li) << 8;  /* bits 11:8 Rx lane count */
 694         ext_stat |= PORT_TX_LANES(port_li) << 12; /* bits 15:12 Tx lane count */
 695
 696         return ext_stat;
 697 }
 698
 699 /*
 700  * Converts a raw xHCI port status into the format that external USB 2.0 or USB
 701  * 3.0 hubs use.
 702  *
 703  * Possible side effects:
 704  *  - Mark a port as being done with device resume,
 705  *    and ring the endpoint doorbells.
 706  *  - Stop the Synopsys redriver Compliance Mode polling.
 707  *  - Drop and reacquire the xHCI lock, in order to wait for port resume.
 708  */
 709 static u32 xhci_get_port_status(struct usb_hcd *hcd,
 710                 struct xhci_bus_state *bus_state,
 711                 __le32 __iomem **port_array,
 712                 u16 wIndex, u32 raw_port_status,
 713                 unsigned long flags)
 714         __releases(&xhci->lock)
 715         __acquires(&xhci->lock)
 716 {
 717         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 718         u32 status = 0;
 719         int slot_id;
 720
 721         /* wPortChange bits */
 722         if (raw_port_status & PORT_CSC)
 723                 status |= USB_PORT_STAT_C_CONNECTION << 16;
 724         if (raw_port_status & PORT_PEC)
 725                 status |= USB_PORT_STAT_C_ENABLE << 16;
 726         if ((raw_port_status & PORT_OCC))
 727                 status |= USB_PORT_STAT_C_OVERCURRENT << 16;
 728         if ((raw_port_status & PORT_RC))
 729                 status |= USB_PORT_STAT_C_RESET << 16;
 730         /* USB3.0 only */
 731         if (hcd->speed >= HCD_USB3) {
 732                 /* Port link change with port in resume state should not be
 733                  * reported to usbcore, as this is an internal state to be
 734                  * handled by xhci driver. Reporting PLC to usbcore may
 735                  * cause usbcore clearing PLC first and port change event
 736                  * irq won't be generated.
 737                  */
 738                 if ((raw_port_status & PORT_PLC) &&
 739                         (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME)
 740                         status |= USB_PORT_STAT_C_LINK_STATE << 16;
 741                 if ((raw_port_status & PORT_WRC))
 742                         status |= USB_PORT_STAT_C_BH_RESET << 16;
 743                 if ((raw_port_status & PORT_CEC))
 744                         status |= USB_PORT_STAT_C_CONFIG_ERROR << 16;
 745         }
 746
 747         if (hcd->speed < HCD_USB3) {
 748                 if ((raw_port_status & PORT_PLS_MASK) == XDEV_U3
 749                                 && (raw_port_status & PORT_POWER))
 750                         status |= USB_PORT_STAT_SUSPEND;
 751         }
 752         if ((raw_port_status & PORT_PLS_MASK) == XDEV_RESUME &&
 753                 !DEV_SUPERSPEED_ANY(raw_port_status)) {
 754                 if ((raw_port_status & PORT_RESET) ||
 755                                 !(raw_port_status & PORT_PE))
 756                         return 0xffffffff;
 757                 /* did port event handler already start resume timing? */
 758                 if (!bus_state->resume_done[wIndex]) {
 759                         /* If not, maybe we are in a host initated resume? */
 760                         if (test_bit(wIndex, &bus_state->resuming_ports)) {
 761                                 /* Host initated resume doesn't time the resume
 762                                  * signalling using resume_done[].
 763                                  * It manually sets RESUME state, sleeps 20ms
 764                                  * and sets U0 state. This should probably be
 765                                  * changed, but not right now.
 766                                  */
 767                         } else {
 768                                 /* port resume was discovered now and here,
 769                                  * start resume timing
 770                                  */
 771                                 unsigned long timeout = jiffies +
 772                                         msecs_to_jiffies(USB_RESUME_TIMEOUT);
 773
 774                                 set_bit(wIndex, &bus_state->resuming_ports);
 775                                 bus_state->resume_done[wIndex] = timeout;
 776                                 mod_timer(&hcd->rh_timer, timeout);
 777                         }
 778                 /* Has resume been signalled for USB_RESUME_TIME yet? */
 779                 } else if (time_after_eq(jiffies,
 780                                          bus_state->resume_done[wIndex])) {
 781                         int time_left;
 782
 783                         xhci_dbg(xhci, "Resume USB2 port %d\n",
 784                                         wIndex + 1);
 785                         bus_state->resume_done[wIndex] = 0;
 786                         clear_bit(wIndex, &bus_state->resuming_ports);
 787
 788                         set_bit(wIndex, &bus_state->rexit_ports);
 789                         xhci_set_link_state(xhci, port_array, wIndex,
 790                                         XDEV_U0);
 791
 792                         spin_unlock_irqrestore(&xhci->lock, flags);
 793                         time_left = wait_for_completion_timeout(
 794                                         &bus_state->rexit_done[wIndex],
 795                                         msecs_to_jiffies(
 796                                                 XHCI_MAX_REXIT_TIMEOUT));
 797                         spin_lock_irqsave(&xhci->lock, flags);
 798
 799                         if (time_left) {
 800                                 slot_id = xhci_find_slot_id_by_port(hcd,
 801                                                 xhci, wIndex + 1);
 802                                 if (!slot_id) {
 803                                         xhci_dbg(xhci, "slot_id is zero\n");
 804                                         return 0xffffffff;
 805                                 }
 806                                 xhci_ring_device(xhci, slot_id);
 807                         } else {
 808                                 int port_status = readl(port_array[wIndex]);
 809                                 xhci_warn(xhci, "Port resume took longer than %i msec, port status = 0x%x\n",
 810                                                 XHCI_MAX_REXIT_TIMEOUT,
 811                                                 port_status);
 812                                 status |= USB_PORT_STAT_SUSPEND;
 813                                 clear_bit(wIndex, &bus_state->rexit_ports);
 814                         }
 815
 816                         bus_state->port_c_suspend |= 1 << wIndex;
 817                         bus_state->suspended_ports &= ~(1 << wIndex);
 818                 } else {
 819                         /*
 820                          * The resume has been signaling for less than
 821                          * USB_RESUME_TIME. Report the port status as SUSPEND,
 822                          * let the usbcore check port status again and clear
 823                          * resume signaling later.
 824                          */
 825                         status |= USB_PORT_STAT_SUSPEND;
 826                 }
 827         }
 828         /*
 829          * Clear stale usb2 resume signalling variables in case port changed
 830          * state during resume signalling. For example on error
 831          */
 832         if ((bus_state->resume_done[wIndex] ||
 833              test_bit(wIndex, &bus_state->resuming_ports)) &&
 834             (raw_port_status & PORT_PLS_MASK) != XDEV_U3 &&
 835             (raw_port_status & PORT_PLS_MASK) != XDEV_RESUME) {
 836                 bus_state->resume_done[wIndex] = 0;
 837                 clear_bit(wIndex, &bus_state->resuming_ports);
 838         }
 839
 840
 841         if ((raw_port_status & PORT_PLS_MASK) == XDEV_U0 &&
 842             (raw_port_status & PORT_POWER)) {
 843                 if (bus_state->suspended_ports & (1 << wIndex)) {
 844                         bus_state->suspended_ports &= ~(1 << wIndex);
 845                         if (hcd->speed < HCD_USB3)
 846                                 bus_state->port_c_suspend |= 1 << wIndex;
 847                 }
 848                 bus_state->resume_done[wIndex] = 0;
 849                 clear_bit(wIndex, &bus_state->resuming_ports);
 850         }
 851         if (raw_port_status & PORT_CONNECT) {
 852                 status |= USB_PORT_STAT_CONNECTION;
 853                 status |= xhci_port_speed(raw_port_status);
 854         }
 855         if (raw_port_status & PORT_PE)
 856                 status |= USB_PORT_STAT_ENABLE;
 857         if (raw_port_status & PORT_OC)
 858                 status |= USB_PORT_STAT_OVERCURRENT;
 859         if (raw_port_status & PORT_RESET)
 860                 status |= USB_PORT_STAT_RESET;
 861         if (raw_port_status & PORT_POWER) {
 862                 if (hcd->speed >= HCD_USB3)
 863                         status |= USB_SS_PORT_STAT_POWER;
 864                 else
 865                         status |= USB_PORT_STAT_POWER;
 866         }
 867         /* Update Port Link State */
 868         if (hcd->speed >= HCD_USB3) {
 869                 xhci_hub_report_usb3_link_state(xhci, &status, raw_port_status);
 870                 /*
 871                  * Verify if all USB3 Ports Have entered U0 already.
 872                  * Delete Compliance Mode Timer if so.
 873                  */
 874                 xhci_del_comp_mod_timer(xhci, raw_port_status, wIndex);
 875         } else {
 876                 xhci_hub_report_usb2_link_state(&status, raw_port_status);
 877         }
 878         if (bus_state->port_c_suspend & (1 << wIndex))
 879                 status |= USB_PORT_STAT_C_SUSPEND << 16;
 880
 881         return status;
 882 }
 883
 884 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
 885                 u16 wIndex, char *buf, u16 wLength)
 886 {
 887         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 888         int max_ports;
 889         unsigned long flags;
 890         u32 temp, status;
 891         int retval = 0;
 892         __le32 __iomem **port_array;
 893         int slot_id;
 894         struct xhci_bus_state *bus_state;
 895         u16 link_state = 0;
 896         u16 wake_mask = 0;
 897         u16 timeout = 0;
 898
 899         max_ports = xhci_get_ports(hcd, &port_array);
 900         bus_state = &xhci->bus_state[hcd_index(hcd)];
 901
 902         spin_lock_irqsave(&xhci->lock, flags);
 903         switch (typeReq) {
 904         case GetHubStatus:
 905                 /* No power source, over-current reported per port */
 906                 memset(buf, 0, 4);
 907                 break;
 908         case GetHubDescriptor:
 909                 /* Check to make sure userspace is asking for the USB 3.0 hub
 910                  * descriptor for the USB 3.0 roothub.  If not, we stall the
 911                  * endpoint, like external hubs do.
 912                  */
 913                 if (hcd->speed >= HCD_USB3 &&
 914                                 (wLength < USB_DT_SS_HUB_SIZE ||
 915                                  wValue != (USB_DT_SS_HUB << 8))) {
 916                         xhci_dbg(xhci, "Wrong hub descriptor type for "
 917                                         "USB 3.0 roothub.\n");
 918                         goto error;
 919                 }
 920                 xhci_hub_descriptor(hcd, xhci,
 921                                 (struct usb_hub_descriptor *) buf);
 922                 break;
 923         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
 924                 if ((wValue & 0xff00) != (USB_DT_BOS << 8))
 925                         goto error;
 926
 927                 if (hcd->speed < HCD_USB3)
 928                         goto error;
 929
 930                 retval = xhci_create_usb3_bos_desc(xhci, buf, wLength);
 931                 spin_unlock_irqrestore(&xhci->lock, flags);
 932                 return retval;
 933         case GetPortStatus:
 934                 if (!wIndex || wIndex > max_ports)
 935                         goto error;
 936                 wIndex--;
 937                 temp = readl(port_array[wIndex]);
 938                 if (temp == 0xffffffff) {
 939                         retval = -ENODEV;
 940                         break;
 941                 }
 942                 status = xhci_get_port_status(hcd, bus_state, port_array,
 943                                 wIndex, temp, flags);
 944                 if (status == 0xffffffff)
 945                         goto error;
 946
 947                 xhci_dbg(xhci, "get port status, actual port %d status  = 0x%x\n",
 948                                 wIndex, temp);
 949                 xhci_dbg(xhci, "Get port status returned 0x%x\n", status);
 950
 951                 put_unaligned(cpu_to_le32(status), (__le32 *) buf);
 952                 /* if USB 3.1 extended port status return additional 4 bytes */
 953                 if (wValue == 0x02) {
 954                         u32 port_li;
 955
 956                         if (hcd->speed < HCD_USB31 || wLength != 8) {
 957                                 xhci_err(xhci, "get ext port status invalid parameter\n");
 958                                 retval = -EINVAL;
 959                                 break;
 960                         }
 961                         port_li = readl(port_array[wIndex] + PORTLI);
 962                         status = xhci_get_ext_port_status(temp, port_li);
 963                         put_unaligned_le32(cpu_to_le32(status), &buf[4]);
 964                 }
 965                 break;
 966         case SetPortFeature:
 967                 if (wValue == USB_PORT_FEAT_LINK_STATE)
 968                         link_state = (wIndex & 0xff00) >> 3;
 969                 if (wValue == USB_PORT_FEAT_REMOTE_WAKE_MASK)
 970                         wake_mask = wIndex & 0xff00;
 971                 /* The MSB of wIndex is the U1/U2 timeout */
 972                 timeout = (wIndex & 0xff00) >> 8;
 973                 wIndex &= 0xff;
 974                 if (!wIndex || wIndex > max_ports)
 975                         goto error;
 976                 wIndex--;
 977                 temp = readl(port_array[wIndex]);
 978                 if (temp == 0xffffffff) {
 979                         retval = -ENODEV;
 980                         break;
 981                 }
 982                 temp = xhci_port_state_to_neutral(temp);
 983                 /* FIXME: What new port features do we need to support? */
 984                 switch (wValue) {
 985                 case USB_PORT_FEAT_SUSPEND:
 986                         temp = readl(port_array[wIndex]);
 987                         if ((temp & PORT_PLS_MASK) != XDEV_U0) {
 988                                 /* Resume the port to U0 first */
 989                                 xhci_set_link_state(xhci, port_array, wIndex,
 990                                                         XDEV_U0);
 991                                 spin_unlock_irqrestore(&xhci->lock, flags);
 992                                 msleep(10);
 993                                 spin_lock_irqsave(&xhci->lock, flags);
 994                         }
 995                         /* In spec software should not attempt to suspend
 996                          * a port unless the port reports that it is in the
 997                          * enabled (PED = ‘1’,PLS < ‘3’) state.
 998                          */
 999                         temp = readl(port_array[wIndex]);
1000                         if ((temp & PORT_PE) == 0 || (temp & PORT_RESET)
1001                                 || (temp & PORT_PLS_MASK) >= XDEV_U3) {
1002                                 xhci_warn(xhci, "USB core suspending device not in U0/U1/U2.\n");
1003                                 goto error;
1004                         }
1005
1006                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1007                                         wIndex + 1);
1008                         if (!slot_id) {
1009                                 xhci_warn(xhci, "slot_id is zero\n");
1010                                 goto error;
1011                         }
1012                         /* unlock to execute stop endpoint commands */
1013                         spin_unlock_irqrestore(&xhci->lock, flags);
1014                         xhci_stop_device(xhci, slot_id, 1);
1015                         spin_lock_irqsave(&xhci->lock, flags);
1016
1017                         xhci_set_link_state(xhci, port_array, wIndex, XDEV_U3);
1018
1019                         spin_unlock_irqrestore(&xhci->lock, flags);
1020                         msleep(10); /* wait device to enter */
1021                         spin_lock_irqsave(&xhci->lock, flags);
1022
1023                         temp = readl(port_array[wIndex]);
1024                         bus_state->suspended_ports |= 1 << wIndex;
1025                         break;
1026                 case USB_PORT_FEAT_LINK_STATE:
1027                         temp = readl(port_array[wIndex]);
1028
1029                         /* Disable port */
1030                         if (link_state == USB_SS_PORT_LS_SS_DISABLED) {
1031                                 xhci_dbg(xhci, "Disable port %d\n", wIndex);
1032                                 temp = xhci_port_state_to_neutral(temp);
1033                                 /*
1034                                  * Clear all change bits, so that we get a new
1035                                  * connection event.
1036                                  */
1037                                 temp |= PORT_CSC | PORT_PEC | PORT_WRC |
1038                                         PORT_OCC | PORT_RC | PORT_PLC |
1039                                         PORT_CEC;
1040                                 writel(temp | PORT_PE, port_array[wIndex]);
1041                                 temp = readl(port_array[wIndex]);
1042                                 break;
1043                         }
1044
1045                         /* Put link in RxDetect (enable port) */
1046                         if (link_state == USB_SS_PORT_LS_RX_DETECT) {
1047                                 xhci_dbg(xhci, "Enable port %d\n", wIndex);
1048                                 xhci_set_link_state(xhci, port_array, wIndex,
1049                                                 link_state);
1050                                 temp = readl(port_array[wIndex]);
1051                                 break;
1052                         }
1053
1054                         /* Software should not attempt to set
1055                          * port link state above '3' (U3) and the port
1056                          * must be enabled.
1057                          */
1058                         if ((temp & PORT_PE) == 0 ||
1059                                 (link_state > USB_SS_PORT_LS_U3)) {
1060                                 xhci_warn(xhci, "Cannot set link state.\n");
1061                                 goto error;
1062                         }
1063
1064                         if (link_state == USB_SS_PORT_LS_U3) {
1065                                 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1066                                                 wIndex + 1);
1067                                 if (slot_id) {
1068                                         /* unlock to execute stop endpoint
1069                                          * commands */
1070                                         spin_unlock_irqrestore(&xhci->lock,
1071                                                                 flags);
1072                                         xhci_stop_device(xhci, slot_id, 1);
1073                                         spin_lock_irqsave(&xhci->lock, flags);
1074                                 }
1075                         }
1076
1077                         xhci_set_link_state(xhci, port_array, wIndex,
1078                                                 link_state);
1079
1080                         spin_unlock_irqrestore(&xhci->lock, flags);
1081                         msleep(20); /* wait device to enter */
1082                         spin_lock_irqsave(&xhci->lock, flags);
1083
1084                         temp = readl(port_array[wIndex]);
1085                         if (link_state == USB_SS_PORT_LS_U3)
1086                                 bus_state->suspended_ports |= 1 << wIndex;
1087                         break;
1088                 case USB_PORT_FEAT_POWER:
1089                         /*
1090                          * Turn on ports, even if there isn't per-port switching.
1091                          * HC will report connect events even before this is set.
1092                          * However, hub_wq will ignore the roothub events until
1093                          * the roothub is registered.
1094                          */
1095                         writel(temp | PORT_POWER, port_array[wIndex]);
1096
1097                         temp = readl(port_array[wIndex]);
1098                         xhci_dbg(xhci, "set port power, actual port %d status  = 0x%x\n", wIndex, temp);
1099
1100                         spin_unlock_irqrestore(&xhci->lock, flags);
1101                         temp = usb_acpi_power_manageable(hcd->self.root_hub,
1102                                         wIndex);
1103                         if (temp)
1104                                 usb_acpi_set_power_state(hcd->self.root_hub,
1105                                                 wIndex, true);
1106                         spin_lock_irqsave(&xhci->lock, flags);
1107                         break;
1108                 case USB_PORT_FEAT_RESET:
1109                         temp = (temp | PORT_RESET);
1110                         writel(temp, port_array[wIndex]);
1111
1112                         temp = readl(port_array[wIndex]);
1113                         xhci_dbg(xhci, "set port reset, actual port %d status  = 0x%x\n", wIndex, temp);
1114                         break;
1115                 case USB_PORT_FEAT_REMOTE_WAKE_MASK:
1116                         xhci_set_remote_wake_mask(xhci, port_array,
1117                                         wIndex, wake_mask);
1118                         temp = readl(port_array[wIndex]);
1119                         xhci_dbg(xhci, "set port remote wake mask, "
1120                                         "actual port %d status  = 0x%x\n",
1121                                         wIndex, temp);
1122                         break;
1123                 case USB_PORT_FEAT_BH_PORT_RESET:
1124                         temp |= PORT_WR;
1125                         writel(temp, port_array[wIndex]);
1126
1127                         temp = readl(port_array[wIndex]);
1128                         break;
1129                 case USB_PORT_FEAT_U1_TIMEOUT:
1130                         if (hcd->speed < HCD_USB3)
1131                                 goto error;
1132                         temp = readl(port_array[wIndex] + PORTPMSC);
1133                         temp &= ~PORT_U1_TIMEOUT_MASK;
1134                         temp |= PORT_U1_TIMEOUT(timeout);
1135                         writel(temp, port_array[wIndex] + PORTPMSC);
1136                         break;
1137                 case USB_PORT_FEAT_U2_TIMEOUT:
1138                         if (hcd->speed < HCD_USB3)
1139                                 goto error;
1140                         temp = readl(port_array[wIndex] + PORTPMSC);
1141                         temp &= ~PORT_U2_TIMEOUT_MASK;
1142                         temp |= PORT_U2_TIMEOUT(timeout);
1143                         writel(temp, port_array[wIndex] + PORTPMSC);
1144                         break;
1145                 default:
1146                         goto error;
1147                 }
1148                 /* unblock any posted writes */
1149                 temp = readl(port_array[wIndex]);
1150                 break;
1151         case ClearPortFeature:
1152                 if (!wIndex || wIndex > max_ports)
1153                         goto error;
1154                 wIndex--;
1155                 temp = readl(port_array[wIndex]);
1156                 if (temp == 0xffffffff) {
1157                         retval = -ENODEV;
1158                         break;
1159                 }
1160                 /* FIXME: What new port features do we need to support? */
1161                 temp = xhci_port_state_to_neutral(temp);
1162                 switch (wValue) {
1163                 case USB_PORT_FEAT_SUSPEND:
1164                         temp = readl(port_array[wIndex]);
1165                         xhci_dbg(xhci, "clear USB_PORT_FEAT_SUSPEND\n");
1166                         xhci_dbg(xhci, "PORTSC %04x\n", temp);
1167                         if (temp & PORT_RESET)
1168                                 goto error;
1169                         if ((temp & PORT_PLS_MASK) == XDEV_U3) {
1170                                 if ((temp & PORT_PE) == 0)
1171                                         goto error;
1172
1173                                 set_bit(wIndex, &bus_state->resuming_ports);
1174                                 xhci_set_link_state(xhci, port_array, wIndex,
1175                                                         XDEV_RESUME);
1176                                 spin_unlock_irqrestore(&xhci->lock, flags);
1177                                 msleep(USB_RESUME_TIMEOUT);
1178                                 spin_lock_irqsave(&xhci->lock, flags);
1179                                 xhci_set_link_state(xhci, port_array, wIndex,
1180                                                         XDEV_U0);
1181                                 clear_bit(wIndex, &bus_state->resuming_ports);
1182                         }
1183                         bus_state->port_c_suspend |= 1 << wIndex;
1184
1185                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1186                                         wIndex + 1);
1187                         if (!slot_id) {
1188                                 xhci_dbg(xhci, "slot_id is zero\n");
1189                                 goto error;
1190                         }
1191                         xhci_ring_device(xhci, slot_id);
1192                         break;
1193                 case USB_PORT_FEAT_C_SUSPEND:
1194                         bus_state->port_c_suspend &= ~(1 << wIndex);
1195                 case USB_PORT_FEAT_C_RESET:
1196                 case USB_PORT_FEAT_C_BH_PORT_RESET:
1197                 case USB_PORT_FEAT_C_CONNECTION:
1198                 case USB_PORT_FEAT_C_OVER_CURRENT:
1199                 case USB_PORT_FEAT_C_ENABLE:
1200                 case USB_PORT_FEAT_C_PORT_LINK_STATE:
1201                 case USB_PORT_FEAT_C_PORT_CONFIG_ERROR:
1202                         xhci_clear_port_change_bit(xhci, wValue, wIndex,
1203                                         port_array[wIndex], temp);
1204                         break;
1205                 case USB_PORT_FEAT_ENABLE:
1206                         xhci_disable_port(hcd, xhci, wIndex,
1207                                         port_array[wIndex], temp);
1208                         break;
1209                 case USB_PORT_FEAT_POWER:
1210                         writel(temp & ~PORT_POWER, port_array[wIndex]);
1211
1212                         spin_unlock_irqrestore(&xhci->lock, flags);
1213                         temp = usb_acpi_power_manageable(hcd->self.root_hub,
1214                                         wIndex);
1215                         if (temp)
1216                                 usb_acpi_set_power_state(hcd->self.root_hub,
1217                                                 wIndex, false);
1218                         spin_lock_irqsave(&xhci->lock, flags);
1219                         break;
1220                 default:
1221                         goto error;
1222                 }
1223                 break;
1224         default:
1225 error:
1226                 /* "stall" on error */
1227                 retval = -EPIPE;
1228         }
1229         spin_unlock_irqrestore(&xhci->lock, flags);
1230         return retval;
1231 }
1232
1233 /*
1234  * Returns 0 if the status hasn't changed, or the number of bytes in buf.
1235  * Ports are 0-indexed from the HCD point of view,
1236  * and 1-indexed from the USB core pointer of view.
1237  *
1238  * Note that the status change bits will be cleared as soon as a port status
1239  * change event is generated, so we use the saved status from that event.
1240  */
1241 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf)
1242 {
1243         unsigned long flags;
1244         u32 temp, status;
1245         u32 mask;
1246         int i, retval;
1247         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1248         int max_ports;
1249         __le32 __iomem **port_array;
1250         struct xhci_bus_state *bus_state;
1251         bool reset_change = false;
1252
1253         max_ports = xhci_get_ports(hcd, &port_array);
1254         bus_state = &xhci->bus_state[hcd_index(hcd)];
1255
1256         /* Initial status is no changes */
1257         retval = (max_ports + 8) / 8;
1258         memset(buf, 0, retval);
1259
1260         /*
1261          * Inform the usbcore about resume-in-progress by returning
1262          * a non-zero value even if there are no status changes.
1263          */
1264         status = bus_state->resuming_ports;
1265
1266         mask = PORT_CSC | PORT_PEC | PORT_OCC | PORT_PLC | PORT_WRC | PORT_CEC;
1267
1268         spin_lock_irqsave(&xhci->lock, flags);
1269         /* For each port, did anything change?  If so, set that bit in buf. */
1270         for (i = 0; i < max_ports; i++) {
1271                 temp = readl(port_array[i]);
1272                 if (temp == 0xffffffff) {
1273                         retval = -ENODEV;
1274                         break;
1275                 }
1276                 if ((temp & mask) != 0 ||
1277                         (bus_state->port_c_suspend & 1 << i) ||
1278                         (bus_state->resume_done[i] && time_after_eq(
1279                             jiffies, bus_state->resume_done[i]))) {
1280                         buf[(i + 1) / 8] |= 1 << (i + 1) % 8;
1281                         status = 1;
1282                 }
1283                 if ((temp & PORT_RC))
1284                         reset_change = true;
1285         }
1286         if (!status && !reset_change) {
1287                 xhci_dbg(xhci, "%s: stopping port polling.\n", __func__);
1288                 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1289         }
1290         spin_unlock_irqrestore(&xhci->lock, flags);
1291         return status ? retval : 0;
1292 }
1293
1294 #ifdef CONFIG_PM
1295
1296 int xhci_bus_suspend(struct usb_hcd *hcd)
1297 {
1298         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1299         int max_ports, port_index;
1300         __le32 __iomem **port_array;
1301         struct xhci_bus_state *bus_state;
1302         unsigned long flags;
1303
1304         max_ports = xhci_get_ports(hcd, &port_array);
1305         bus_state = &xhci->bus_state[hcd_index(hcd)];
1306
1307         spin_lock_irqsave(&xhci->lock, flags);
1308
1309         if (hcd->self.root_hub->do_remote_wakeup) {
1310                 if (bus_state->resuming_ports ||        /* USB2 */
1311                     bus_state->port_remote_wakeup) {    /* USB3 */
1312                         spin_unlock_irqrestore(&xhci->lock, flags);
1313                         xhci_dbg(xhci, "suspend failed because a port is resuming\n");
1314                         return -EBUSY;
1315                 }
1316         }
1317
1318         port_index = max_ports;
1319         bus_state->bus_suspended = 0;
1320         while (port_index--) {
1321                 /* suspend the port if the port is not suspended */
1322                 u32 t1, t2;
1323                 int slot_id;
1324
1325                 t1 = readl(port_array[port_index]);
1326                 t2 = xhci_port_state_to_neutral(t1);
1327
1328                 if ((t1 & PORT_PE) && !(t1 & PORT_PLS_MASK)) {
1329                         xhci_dbg(xhci, "port %d not suspended\n", port_index);
1330                         slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1331                                         port_index + 1);
1332                         if (slot_id) {
1333                                 spin_unlock_irqrestore(&xhci->lock, flags);
1334                                 xhci_stop_device(xhci, slot_id, 1);
1335                                 spin_lock_irqsave(&xhci->lock, flags);
1336                         }
1337                         t2 &= ~PORT_PLS_MASK;
1338                         t2 |= PORT_LINK_STROBE | XDEV_U3;
1339                         set_bit(port_index, &bus_state->bus_suspended);
1340                 }
1341                 /* USB core sets remote wake mask for USB 3.0 hubs,
1342                  * including the USB 3.0 roothub, but only if CONFIG_PM
1343                  * is enabled, so also enable remote wake here.
1344                  */
1345                 if (hcd->self.root_hub->do_remote_wakeup) {
1346                         if (t1 & PORT_CONNECT) {
1347                                 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
1348                                 t2 &= ~PORT_WKCONN_E;
1349                         } else {
1350                                 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
1351                                 t2 &= ~PORT_WKDISC_E;
1352                         }
1353                 } else
1354                         t2 &= ~PORT_WAKE_BITS;
1355
1356                 t1 = xhci_port_state_to_neutral(t1);
1357                 if (t1 != t2)
1358                         writel(t2, port_array[port_index]);
1359         }
1360         hcd->state = HC_STATE_SUSPENDED;
1361         bus_state->next_statechange = jiffies + msecs_to_jiffies(10);
1362         spin_unlock_irqrestore(&xhci->lock, flags);
1363         return 0;
1364 }
1365
1366 /*
1367  * Workaround for missing Cold Attach Status (CAS) if device re-plugged in S3.
1368  * warm reset a USB3 device stuck in polling or compliance mode after resume.
1369  * See Intel 100/c230 series PCH specification update Doc #332692-006 Errata #8
1370  */
1371 static bool xhci_port_missing_cas_quirk(int port_index,
1372                                              __le32 __iomem **port_array)
1373 {
1374         u32 portsc;
1375
1376         portsc = readl(port_array[port_index]);
1377
1378         /* if any of these are set we are not stuck */
1379         if (portsc & (PORT_CONNECT | PORT_CAS))
1380                 return false;
1381
1382         if (((portsc & PORT_PLS_MASK) != XDEV_POLLING) &&
1383             ((portsc & PORT_PLS_MASK) != XDEV_COMP_MODE))
1384                 return false;
1385
1386         /* clear wakeup/change bits, and do a warm port reset */
1387         portsc &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1388         portsc |= PORT_WR;
1389         writel(portsc, port_array[port_index]);
1390         /* flush write */
1391         readl(port_array[port_index]);
1392         return true;
1393 }
1394
1395 int xhci_bus_resume(struct usb_hcd *hcd)
1396 {
1397         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
1398         int max_ports, port_index;
1399         __le32 __iomem **port_array;
1400         struct xhci_bus_state *bus_state;
1401         u32 temp;
1402         unsigned long flags;
1403         unsigned long port_was_suspended = 0;
1404         bool need_usb2_u3_exit = false;
1405         int slot_id;
1406         int sret;
1407
1408         max_ports = xhci_get_ports(hcd, &port_array);
1409         bus_state = &xhci->bus_state[hcd_index(hcd)];
1410
1411         if (time_before(jiffies, bus_state->next_statechange))
1412                 msleep(5);
1413
1414         spin_lock_irqsave(&xhci->lock, flags);
1415         if (!HCD_HW_ACCESSIBLE(hcd)) {
1416                 spin_unlock_irqrestore(&xhci->lock, flags);
1417                 return -ESHUTDOWN;
1418         }
1419
1420         /* delay the irqs */
1421         temp = readl(&xhci->op_regs->command);
1422         temp &= ~CMD_EIE;
1423         writel(temp, &xhci->op_regs->command);
1424
1425         port_index = max_ports;
1426         while (port_index--) {
1427                 /* Check whether need resume ports. If needed
1428                    resume port and disable remote wakeup */
1429                 u32 temp;
1430
1431                 temp = readl(port_array[port_index]);
1432
1433                 /* warm reset CAS limited ports stuck in polling/compliance */
1434                 if ((xhci->quirks & XHCI_MISSING_CAS) &&
1435                     (hcd->speed >= HCD_USB3) &&
1436                     xhci_port_missing_cas_quirk(port_index, port_array)) {
1437                         xhci_dbg(xhci, "reset stuck port %d\n", port_index);
1438                         continue;
1439                 }
1440                 if (DEV_SUPERSPEED_ANY(temp))
1441                         temp &= ~(PORT_RWC_BITS | PORT_CEC | PORT_WAKE_BITS);
1442                 else
1443                         temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
1444                 if (test_bit(port_index, &bus_state->bus_suspended) &&
1445                     (temp & PORT_PLS_MASK)) {
1446                         set_bit(port_index, &port_was_suspended);
1447                         if (!DEV_SUPERSPEED_ANY(temp)) {
1448                                 xhci_set_link_state(xhci, port_array,
1449                                                 port_index, XDEV_RESUME);
1450                                 need_usb2_u3_exit = true;
1451                         }
1452                 } else
1453                         writel(temp, port_array[port_index]);
1454         }
1455
1456         if (need_usb2_u3_exit) {
1457                 spin_unlock_irqrestore(&xhci->lock, flags);
1458                 msleep(USB_RESUME_TIMEOUT);
1459                 spin_lock_irqsave(&xhci->lock, flags);
1460         }
1461
1462         port_index = max_ports;
1463         while (port_index--) {
1464                 if (!(port_was_suspended & BIT(port_index)))
1465                         continue;
1466                 /* Clear PLC to poll it later after XDEV_U0 */
1467                 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1468                 xhci_set_link_state(xhci, port_array, port_index, XDEV_U0);
1469         }
1470
1471         port_index = max_ports;
1472         while (port_index--) {
1473                 if (!(port_was_suspended & BIT(port_index)))
1474                         continue;
1475                 /* Poll and Clear PLC */
1476                 sret = xhci_handshake(port_array[port_index], PORT_PLC,
1477                                       PORT_PLC, 10 * 1000);
1478                 if (sret)
1479                         xhci_warn(xhci, "port %d resume PLC timeout\n",
1480                                   port_index);
1481                 xhci_test_and_clear_bit(xhci, port_array, port_index, PORT_PLC);
1482                 slot_id = xhci_find_slot_id_by_port(hcd, xhci, port_index + 1);
1483                 if (slot_id)
1484                         xhci_ring_device(xhci, slot_id);
1485         }
1486
1487         (void) readl(&xhci->op_regs->command);
1488
1489         bus_state->next_statechange = jiffies + msecs_to_jiffies(5);
1490         /* re-enable irqs */
1491         temp = readl(&xhci->op_regs->command);
1492         temp |= CMD_EIE;
1493         writel(temp, &xhci->op_regs->command);
1494         temp = readl(&xhci->op_regs->command);
1495
1496         spin_unlock_irqrestore(&xhci->lock, flags);
1497         return 0;
1498 }
1499
1500 #endif  /* CONFIG_PM */