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