1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * xHCI host controller driver PCI Bus Glue. 4 * 5 * Copyright (C) 2008 Intel Corp. 6 * 7 * Author: Sarah Sharp 8 * Some code borrowed from the Linux EHCI driver. 9 */ 10 11 #include <linux/pci.h> 12 #include <linux/slab.h> 13 #include <linux/module.h> 14 #include <linux/acpi.h> 15 #include <linux/reset.h> 16 #include <linux/suspend.h> 17 18 #include "xhci.h" 19 #include "xhci-trace.h" 20 #include "xhci-pci.h" 21 22 #define SSIC_PORT_NUM 2 23 #define SSIC_PORT_CFG2 0x880c 24 #define SSIC_PORT_CFG2_OFFSET 0x30 25 #define PROG_DONE (1 << 30) 26 #define SSIC_PORT_UNUSED (1 << 31) 27 #define SPARSE_DISABLE_BIT 17 28 #define SPARSE_CNTL_ENABLE 0xC12C 29 30 /* Device for a quirk */ 31 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73 32 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000 33 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009 0x1009 34 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1100 0x1100 35 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400 36 37 #define PCI_VENDOR_ID_ETRON 0x1b6f 38 #define PCI_DEVICE_ID_EJ168 0x7023 39 #define PCI_DEVICE_ID_EJ188 0x7052 40 41 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31 42 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31 43 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI 0x9cb1 44 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI 0x22b5 45 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI 0xa12f 46 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI 0x9d2f 47 #define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI 0x0aa8 48 #define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI 0x1aa8 49 #define PCI_DEVICE_ID_INTEL_APOLLO_LAKE_XHCI 0x5aa8 50 #define PCI_DEVICE_ID_INTEL_DENVERTON_XHCI 0x19d0 51 #define PCI_DEVICE_ID_INTEL_ICE_LAKE_XHCI 0x8a13 52 #define PCI_DEVICE_ID_INTEL_TIGER_LAKE_XHCI 0x9a13 53 #define PCI_DEVICE_ID_INTEL_TIGER_LAKE_PCH_XHCI 0xa0ed 54 #define PCI_DEVICE_ID_INTEL_COMET_LAKE_XHCI 0xa3af 55 #define PCI_DEVICE_ID_INTEL_ALDER_LAKE_PCH_XHCI 0x51ed 56 #define PCI_DEVICE_ID_INTEL_ALDER_LAKE_N_PCH_XHCI 0x54ed 57 58 /* Thunderbolt */ 59 #define PCI_DEVICE_ID_INTEL_MAPLE_RIDGE_XHCI 0x1138 60 #define PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_XHCI 0x15b5 61 #define PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_XHCI 0x15b6 62 #define PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_XHCI 0x15c1 63 #define PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_XHCI 0x15db 64 #define PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_XHCI 0x15d4 65 #define PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_XHCI 0x15e9 66 #define PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_XHCI 0x15ec 67 #define PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_XHCI 0x15f0 68 69 #define PCI_DEVICE_ID_AMD_RENOIR_XHCI 0x1639 70 #define PCI_DEVICE_ID_AMD_PROMONTORYA_4 0x43b9 71 #define PCI_DEVICE_ID_AMD_PROMONTORYA_3 0x43ba 72 #define PCI_DEVICE_ID_AMD_PROMONTORYA_2 0x43bb 73 #define PCI_DEVICE_ID_AMD_PROMONTORYA_1 0x43bc 74 75 #define PCI_DEVICE_ID_ASMEDIA_1042_XHCI 0x1042 76 #define PCI_DEVICE_ID_ASMEDIA_1042A_XHCI 0x1142 77 #define PCI_DEVICE_ID_ASMEDIA_1142_XHCI 0x1242 78 #define PCI_DEVICE_ID_ASMEDIA_2142_XHCI 0x2142 79 #define PCI_DEVICE_ID_ASMEDIA_3242_XHCI 0x3242 80 81 static const char hcd_name[] = "xhci_hcd"; 82 83 static struct hc_driver __read_mostly xhci_pci_hc_driver; 84 85 static int xhci_pci_setup(struct usb_hcd *hcd); 86 static int xhci_pci_run(struct usb_hcd *hcd); 87 static int xhci_pci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev, 88 struct usb_tt *tt, gfp_t mem_flags); 89 90 static const struct xhci_driver_overrides xhci_pci_overrides __initconst = { 91 .reset = xhci_pci_setup, 92 .start = xhci_pci_run, 93 .update_hub_device = xhci_pci_update_hub_device, 94 }; 95 96 static void xhci_msix_sync_irqs(struct xhci_hcd *xhci) 97 { 98 struct usb_hcd *hcd = xhci_to_hcd(xhci); 99 100 if (hcd->msix_enabled) { 101 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 102 103 /* for now, the driver only supports one primary interrupter */ 104 synchronize_irq(pci_irq_vector(pdev, 0)); 105 } 106 } 107 108 /* Free any IRQs and disable MSI-X */ 109 static void xhci_cleanup_msix(struct xhci_hcd *xhci) 110 { 111 struct usb_hcd *hcd = xhci_to_hcd(xhci); 112 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 113 114 /* return if using legacy interrupt */ 115 if (hcd->irq > 0) 116 return; 117 118 free_irq(pci_irq_vector(pdev, 0), xhci_to_hcd(xhci)); 119 pci_free_irq_vectors(pdev); 120 hcd->msix_enabled = 0; 121 } 122 123 /* Try enabling MSI-X with MSI and legacy IRQ as fallback */ 124 static int xhci_try_enable_msi(struct usb_hcd *hcd) 125 { 126 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 127 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 128 int ret; 129 130 /* 131 * Some Fresco Logic host controllers advertise MSI, but fail to 132 * generate interrupts. Don't even try to enable MSI. 133 */ 134 if (xhci->quirks & XHCI_BROKEN_MSI) 135 goto legacy_irq; 136 137 /* unregister the legacy interrupt */ 138 if (hcd->irq) 139 free_irq(hcd->irq, hcd); 140 hcd->irq = 0; 141 142 /* 143 * calculate number of MSI-X vectors supported. 144 * - HCS_MAX_INTRS: the max number of interrupts the host can handle, 145 * with max number of interrupters based on the xhci HCSPARAMS1. 146 * - num_online_cpus: maximum MSI-X vectors per CPUs core. 147 * Add additional 1 vector to ensure always available interrupt. 148 */ 149 xhci->nvecs = min(num_online_cpus() + 1, 150 HCS_MAX_INTRS(xhci->hcs_params1)); 151 152 /* TODO: Check with MSI Soc for sysdev */ 153 xhci->nvecs = pci_alloc_irq_vectors(pdev, 1, xhci->nvecs, 154 PCI_IRQ_MSIX | PCI_IRQ_MSI); 155 if (xhci->nvecs < 0) { 156 xhci_dbg_trace(xhci, trace_xhci_dbg_init, 157 "failed to allocate IRQ vectors"); 158 goto legacy_irq; 159 } 160 161 ret = request_irq(pci_irq_vector(pdev, 0), xhci_msi_irq, 0, "xhci_hcd", 162 xhci_to_hcd(xhci)); 163 if (ret) 164 goto free_irq_vectors; 165 166 hcd->msi_enabled = 1; 167 hcd->msix_enabled = pdev->msix_enabled; 168 return 0; 169 170 free_irq_vectors: 171 xhci_dbg_trace(xhci, trace_xhci_dbg_init, "disable %s interrupt", 172 pdev->msix_enabled ? "MSI-X" : "MSI"); 173 pci_free_irq_vectors(pdev); 174 175 legacy_irq: 176 if (!pdev->irq) { 177 xhci_err(xhci, "No msi-x/msi found and no IRQ in BIOS\n"); 178 return -EINVAL; 179 } 180 181 if (!strlen(hcd->irq_descr)) 182 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d", 183 hcd->driver->description, hcd->self.busnum); 184 185 /* fall back to legacy interrupt */ 186 ret = request_irq(pdev->irq, &usb_hcd_irq, IRQF_SHARED, hcd->irq_descr, hcd); 187 if (ret) { 188 xhci_err(xhci, "request interrupt %d failed\n", pdev->irq); 189 return ret; 190 } 191 hcd->irq = pdev->irq; 192 return 0; 193 } 194 195 static int xhci_pci_run(struct usb_hcd *hcd) 196 { 197 int ret; 198 199 if (usb_hcd_is_primary_hcd(hcd)) { 200 ret = xhci_try_enable_msi(hcd); 201 if (ret) 202 return ret; 203 } 204 205 return xhci_run(hcd); 206 } 207 208 static void xhci_pci_stop(struct usb_hcd *hcd) 209 { 210 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 211 212 xhci_stop(hcd); 213 214 if (usb_hcd_is_primary_hcd(hcd)) 215 xhci_cleanup_msix(xhci); 216 } 217 218 /* called after powerup, by probe or system-pm "wakeup" */ 219 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev) 220 { 221 /* 222 * TODO: Implement finding debug ports later. 223 * TODO: see if there are any quirks that need to be added to handle 224 * new extended capabilities. 225 */ 226 227 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */ 228 if (!pci_set_mwi(pdev)) 229 xhci_dbg(xhci, "MWI active\n"); 230 231 xhci_dbg(xhci, "Finished xhci_pci_reinit\n"); 232 return 0; 233 } 234 235 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci) 236 { 237 struct pci_dev *pdev = to_pci_dev(dev); 238 struct xhci_driver_data *driver_data; 239 const struct pci_device_id *id; 240 241 id = pci_match_id(to_pci_driver(pdev->dev.driver)->id_table, pdev); 242 243 if (id && id->driver_data) { 244 driver_data = (struct xhci_driver_data *)id->driver_data; 245 xhci->quirks |= driver_data->quirks; 246 } 247 248 /* Look for vendor-specific quirks */ 249 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC && 250 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK || 251 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) { 252 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK && 253 pdev->revision == 0x0) { 254 xhci->quirks |= XHCI_RESET_EP_QUIRK; 255 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks, 256 "XHCI_RESET_EP_QUIRK for this evaluation HW is deprecated"); 257 } 258 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK && 259 pdev->revision == 0x4) { 260 xhci->quirks |= XHCI_SLOW_SUSPEND; 261 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks, 262 "QUIRK: Fresco Logic xHC revision %u" 263 "must be suspended extra slowly", 264 pdev->revision); 265 } 266 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK) 267 xhci->quirks |= XHCI_BROKEN_STREAMS; 268 /* Fresco Logic confirms: all revisions of this chip do not 269 * support MSI, even though some of them claim to in their PCI 270 * capabilities. 271 */ 272 xhci->quirks |= XHCI_BROKEN_MSI; 273 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks, 274 "QUIRK: Fresco Logic revision %u " 275 "has broken MSI implementation", 276 pdev->revision); 277 } 278 279 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC && 280 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009) 281 xhci->quirks |= XHCI_BROKEN_STREAMS; 282 283 if (pdev->vendor == PCI_VENDOR_ID_NEC) 284 xhci->quirks |= XHCI_NEC_HOST; 285 286 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96) 287 xhci->quirks |= XHCI_AMD_0x96_HOST; 288 289 /* AMD PLL quirk */ 290 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_quirk_pll_check()) 291 xhci->quirks |= XHCI_AMD_PLL_FIX; 292 293 if (pdev->vendor == PCI_VENDOR_ID_AMD && 294 (pdev->device == 0x145c || 295 pdev->device == 0x15e0 || 296 pdev->device == 0x15e1 || 297 pdev->device == 0x43bb)) 298 xhci->quirks |= XHCI_SUSPEND_DELAY; 299 300 if (pdev->vendor == PCI_VENDOR_ID_AMD && 301 (pdev->device == 0x15e0 || pdev->device == 0x15e1)) 302 xhci->quirks |= XHCI_SNPS_BROKEN_SUSPEND; 303 304 if (pdev->vendor == PCI_VENDOR_ID_AMD && pdev->device == 0x15e5) { 305 xhci->quirks |= XHCI_DISABLE_SPARSE; 306 xhci->quirks |= XHCI_RESET_ON_RESUME; 307 } 308 309 if (pdev->vendor == PCI_VENDOR_ID_AMD && pdev->device == 0x43f7) 310 xhci->quirks |= XHCI_DEFAULT_PM_RUNTIME_ALLOW; 311 312 if ((pdev->vendor == PCI_VENDOR_ID_AMD) && 313 ((pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_4) || 314 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_3) || 315 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_2) || 316 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_1))) 317 xhci->quirks |= XHCI_U2_DISABLE_WAKE; 318 319 if (pdev->vendor == PCI_VENDOR_ID_AMD && 320 pdev->device == PCI_DEVICE_ID_AMD_RENOIR_XHCI) 321 xhci->quirks |= XHCI_BROKEN_D3COLD_S2I; 322 323 if (pdev->vendor == PCI_VENDOR_ID_INTEL) { 324 xhci->quirks |= XHCI_LPM_SUPPORT; 325 xhci->quirks |= XHCI_INTEL_HOST; 326 xhci->quirks |= XHCI_AVOID_BEI; 327 } 328 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 329 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) { 330 xhci->quirks |= XHCI_EP_LIMIT_QUIRK; 331 xhci->limit_active_eps = 64; 332 xhci->quirks |= XHCI_SW_BW_CHECKING; 333 /* 334 * PPT desktop boards DH77EB and DH77DF will power back on after 335 * a few seconds of being shutdown. The fix for this is to 336 * switch the ports from xHCI to EHCI on shutdown. We can't use 337 * DMI information to find those particular boards (since each 338 * vendor will change the board name), so we have to key off all 339 * PPT chipsets. 340 */ 341 xhci->quirks |= XHCI_SPURIOUS_REBOOT; 342 } 343 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 344 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI || 345 pdev->device == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI)) { 346 xhci->quirks |= XHCI_SPURIOUS_REBOOT; 347 xhci->quirks |= XHCI_SPURIOUS_WAKEUP; 348 } 349 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 350 (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI || 351 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI || 352 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI || 353 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI || 354 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI || 355 pdev->device == PCI_DEVICE_ID_INTEL_APOLLO_LAKE_XHCI || 356 pdev->device == PCI_DEVICE_ID_INTEL_DENVERTON_XHCI || 357 pdev->device == PCI_DEVICE_ID_INTEL_COMET_LAKE_XHCI)) { 358 xhci->quirks |= XHCI_PME_STUCK_QUIRK; 359 } 360 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 361 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) 362 xhci->quirks |= XHCI_SSIC_PORT_UNUSED; 363 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 364 (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI || 365 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI || 366 pdev->device == PCI_DEVICE_ID_INTEL_APOLLO_LAKE_XHCI)) 367 xhci->quirks |= XHCI_INTEL_USB_ROLE_SW; 368 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 369 (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI || 370 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI || 371 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI || 372 pdev->device == PCI_DEVICE_ID_INTEL_APOLLO_LAKE_XHCI || 373 pdev->device == PCI_DEVICE_ID_INTEL_DENVERTON_XHCI)) 374 xhci->quirks |= XHCI_MISSING_CAS; 375 376 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 377 (pdev->device == PCI_DEVICE_ID_INTEL_TIGER_LAKE_PCH_XHCI || 378 pdev->device == PCI_DEVICE_ID_INTEL_ALDER_LAKE_PCH_XHCI || 379 pdev->device == PCI_DEVICE_ID_INTEL_ALDER_LAKE_N_PCH_XHCI)) 380 xhci->quirks |= XHCI_RESET_TO_DEFAULT; 381 382 if (pdev->vendor == PCI_VENDOR_ID_INTEL && 383 (pdev->device == PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_XHCI || 384 pdev->device == PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_XHCI || 385 pdev->device == PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_XHCI || 386 pdev->device == PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_XHCI || 387 pdev->device == PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_XHCI || 388 pdev->device == PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_XHCI || 389 pdev->device == PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_XHCI || 390 pdev->device == PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_XHCI || 391 pdev->device == PCI_DEVICE_ID_INTEL_ICE_LAKE_XHCI || 392 pdev->device == PCI_DEVICE_ID_INTEL_TIGER_LAKE_XHCI || 393 pdev->device == PCI_DEVICE_ID_INTEL_MAPLE_RIDGE_XHCI)) 394 xhci->quirks |= XHCI_DEFAULT_PM_RUNTIME_ALLOW; 395 396 if (pdev->vendor == PCI_VENDOR_ID_ETRON && 397 pdev->device == PCI_DEVICE_ID_EJ168) { 398 xhci->quirks |= XHCI_RESET_ON_RESUME; 399 xhci->quirks |= XHCI_BROKEN_STREAMS; 400 } 401 if (pdev->vendor == PCI_VENDOR_ID_ETRON && 402 pdev->device == PCI_DEVICE_ID_EJ188) { 403 xhci->quirks |= XHCI_RESET_ON_RESUME; 404 xhci->quirks |= XHCI_BROKEN_STREAMS; 405 } 406 407 if (pdev->vendor == PCI_VENDOR_ID_RENESAS && 408 pdev->device == 0x0014) { 409 xhci->quirks |= XHCI_ZERO_64B_REGS; 410 } 411 if (pdev->vendor == PCI_VENDOR_ID_RENESAS && 412 pdev->device == 0x0015) { 413 xhci->quirks |= XHCI_RESET_ON_RESUME; 414 xhci->quirks |= XHCI_ZERO_64B_REGS; 415 } 416 if (pdev->vendor == PCI_VENDOR_ID_VIA) 417 xhci->quirks |= XHCI_RESET_ON_RESUME; 418 419 /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */ 420 if (pdev->vendor == PCI_VENDOR_ID_VIA && 421 pdev->device == 0x3432) 422 xhci->quirks |= XHCI_BROKEN_STREAMS; 423 424 if (pdev->vendor == PCI_VENDOR_ID_VIA && pdev->device == 0x3483) 425 xhci->quirks |= XHCI_LPM_SUPPORT; 426 427 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA && 428 pdev->device == PCI_DEVICE_ID_ASMEDIA_1042_XHCI) { 429 /* 430 * try to tame the ASMedia 1042 controller which reports 0.96 431 * but appears to behave more like 1.0 432 */ 433 xhci->quirks |= XHCI_SPURIOUS_SUCCESS; 434 xhci->quirks |= XHCI_BROKEN_STREAMS; 435 } 436 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA && 437 pdev->device == PCI_DEVICE_ID_ASMEDIA_1042A_XHCI) { 438 xhci->quirks |= XHCI_NO_64BIT_SUPPORT; 439 } 440 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA && 441 (pdev->device == PCI_DEVICE_ID_ASMEDIA_1142_XHCI || 442 pdev->device == PCI_DEVICE_ID_ASMEDIA_2142_XHCI || 443 pdev->device == PCI_DEVICE_ID_ASMEDIA_3242_XHCI)) 444 xhci->quirks |= XHCI_NO_64BIT_SUPPORT; 445 446 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA && 447 pdev->device == PCI_DEVICE_ID_ASMEDIA_1042A_XHCI) 448 xhci->quirks |= XHCI_ASMEDIA_MODIFY_FLOWCONTROL; 449 450 if (pdev->vendor == PCI_VENDOR_ID_TI && pdev->device == 0x8241) 451 xhci->quirks |= XHCI_LIMIT_ENDPOINT_INTERVAL_7; 452 453 if ((pdev->vendor == PCI_VENDOR_ID_BROADCOM || 454 pdev->vendor == PCI_VENDOR_ID_CAVIUM) && 455 pdev->device == 0x9026) 456 xhci->quirks |= XHCI_RESET_PLL_ON_DISCONNECT; 457 458 if (pdev->vendor == PCI_VENDOR_ID_AMD && 459 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_2 || 460 pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_4)) 461 xhci->quirks |= XHCI_NO_SOFT_RETRY; 462 463 if (pdev->vendor == PCI_VENDOR_ID_ZHAOXIN) { 464 xhci->quirks |= XHCI_ZHAOXIN_HOST; 465 xhci->quirks |= XHCI_LPM_SUPPORT; 466 467 if (pdev->device == 0x9202) { 468 xhci->quirks |= XHCI_RESET_ON_RESUME; 469 xhci->quirks |= XHCI_ZHAOXIN_TRB_FETCH; 470 } 471 472 if (pdev->device == 0x9203) 473 xhci->quirks |= XHCI_ZHAOXIN_TRB_FETCH; 474 } 475 476 /* xHC spec requires PCI devices to support D3hot and D3cold */ 477 if (xhci->hci_version >= 0x120) 478 xhci->quirks |= XHCI_DEFAULT_PM_RUNTIME_ALLOW; 479 480 if (xhci->quirks & XHCI_RESET_ON_RESUME) 481 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks, 482 "QUIRK: Resetting on resume"); 483 } 484 485 #ifdef CONFIG_ACPI 486 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) 487 { 488 static const guid_t intel_dsm_guid = 489 GUID_INIT(0xac340cb7, 0xe901, 0x45bf, 490 0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23); 491 union acpi_object *obj; 492 493 obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), &intel_dsm_guid, 3, 1, 494 NULL); 495 ACPI_FREE(obj); 496 } 497 498 static void xhci_find_lpm_incapable_ports(struct usb_hcd *hcd, struct usb_device *hdev) 499 { 500 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 501 struct xhci_hub *rhub = &xhci->usb3_rhub; 502 int ret; 503 int i; 504 505 /* This is not the usb3 roothub we are looking for */ 506 if (hcd != rhub->hcd) 507 return; 508 509 if (hdev->maxchild > rhub->num_ports) { 510 dev_err(&hdev->dev, "USB3 roothub port number mismatch\n"); 511 return; 512 } 513 514 for (i = 0; i < hdev->maxchild; i++) { 515 ret = usb_acpi_port_lpm_incapable(hdev, i); 516 517 dev_dbg(&hdev->dev, "port-%d disable U1/U2 _DSM: %d\n", i + 1, ret); 518 519 if (ret >= 0) { 520 rhub->ports[i]->lpm_incapable = ret; 521 continue; 522 } 523 } 524 } 525 526 #else 527 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { } 528 static void xhci_find_lpm_incapable_ports(struct usb_hcd *hcd, struct usb_device *hdev) { } 529 #endif /* CONFIG_ACPI */ 530 531 /* called during probe() after chip reset completes */ 532 static int xhci_pci_setup(struct usb_hcd *hcd) 533 { 534 struct xhci_hcd *xhci; 535 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 536 int retval; 537 538 xhci = hcd_to_xhci(hcd); 539 if (!xhci->sbrn) 540 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn); 541 542 /* imod_interval is the interrupt moderation value in nanoseconds. */ 543 xhci->imod_interval = 40000; 544 545 retval = xhci_gen_setup(hcd, xhci_pci_quirks); 546 if (retval) 547 return retval; 548 549 if (!usb_hcd_is_primary_hcd(hcd)) 550 return 0; 551 552 if (xhci->quirks & XHCI_PME_STUCK_QUIRK) 553 xhci_pme_acpi_rtd3_enable(pdev); 554 555 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn); 556 557 /* Find any debug ports */ 558 return xhci_pci_reinit(xhci, pdev); 559 } 560 561 static int xhci_pci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev, 562 struct usb_tt *tt, gfp_t mem_flags) 563 { 564 /* Check if acpi claims some USB3 roothub ports are lpm incapable */ 565 if (!hdev->parent) 566 xhci_find_lpm_incapable_ports(hcd, hdev); 567 568 return xhci_update_hub_device(hcd, hdev, tt, mem_flags); 569 } 570 571 /* 572 * We need to register our own PCI probe function (instead of the USB core's 573 * function) in order to create a second roothub under xHCI. 574 */ 575 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) 576 { 577 int retval; 578 struct xhci_hcd *xhci; 579 struct usb_hcd *hcd; 580 struct xhci_driver_data *driver_data; 581 struct reset_control *reset; 582 583 driver_data = (struct xhci_driver_data *)id->driver_data; 584 if (driver_data && driver_data->quirks & XHCI_RENESAS_FW_QUIRK) { 585 retval = renesas_xhci_check_request_fw(dev, id); 586 if (retval) 587 return retval; 588 } 589 590 reset = devm_reset_control_get_optional_exclusive(&dev->dev, NULL); 591 if (IS_ERR(reset)) 592 return PTR_ERR(reset); 593 reset_control_reset(reset); 594 595 /* Prevent runtime suspending between USB-2 and USB-3 initialization */ 596 pm_runtime_get_noresume(&dev->dev); 597 598 /* Register the USB 2.0 roothub. 599 * FIXME: USB core must know to register the USB 2.0 roothub first. 600 * This is sort of silly, because we could just set the HCD driver flags 601 * to say USB 2.0, but I'm not sure what the implications would be in 602 * the other parts of the HCD code. 603 */ 604 retval = usb_hcd_pci_probe(dev, &xhci_pci_hc_driver); 605 606 if (retval) 607 goto put_runtime_pm; 608 609 /* USB 2.0 roothub is stored in the PCI device now. */ 610 hcd = dev_get_drvdata(&dev->dev); 611 xhci = hcd_to_xhci(hcd); 612 xhci->reset = reset; 613 xhci->shared_hcd = usb_create_shared_hcd(&xhci_pci_hc_driver, &dev->dev, 614 pci_name(dev), hcd); 615 if (!xhci->shared_hcd) { 616 retval = -ENOMEM; 617 goto dealloc_usb2_hcd; 618 } 619 620 retval = xhci_ext_cap_init(xhci); 621 if (retval) 622 goto put_usb3_hcd; 623 624 retval = usb_add_hcd(xhci->shared_hcd, dev->irq, 625 IRQF_SHARED); 626 if (retval) 627 goto put_usb3_hcd; 628 /* Roothub already marked as USB 3.0 speed */ 629 630 if (!(xhci->quirks & XHCI_BROKEN_STREAMS) && 631 HCC_MAX_PSA(xhci->hcc_params) >= 4) 632 xhci->shared_hcd->can_do_streams = 1; 633 634 /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */ 635 pm_runtime_put_noidle(&dev->dev); 636 637 if (pci_choose_state(dev, PMSG_SUSPEND) == PCI_D0) 638 pm_runtime_forbid(&dev->dev); 639 else if (xhci->quirks & XHCI_DEFAULT_PM_RUNTIME_ALLOW) 640 pm_runtime_allow(&dev->dev); 641 642 dma_set_max_seg_size(&dev->dev, UINT_MAX); 643 644 return 0; 645 646 put_usb3_hcd: 647 usb_put_hcd(xhci->shared_hcd); 648 dealloc_usb2_hcd: 649 usb_hcd_pci_remove(dev); 650 put_runtime_pm: 651 pm_runtime_put_noidle(&dev->dev); 652 return retval; 653 } 654 655 static void xhci_pci_remove(struct pci_dev *dev) 656 { 657 struct xhci_hcd *xhci; 658 659 xhci = hcd_to_xhci(pci_get_drvdata(dev)); 660 661 xhci->xhc_state |= XHCI_STATE_REMOVING; 662 663 if (xhci->quirks & XHCI_DEFAULT_PM_RUNTIME_ALLOW) 664 pm_runtime_forbid(&dev->dev); 665 666 if (xhci->shared_hcd) { 667 usb_remove_hcd(xhci->shared_hcd); 668 usb_put_hcd(xhci->shared_hcd); 669 xhci->shared_hcd = NULL; 670 } 671 672 /* Workaround for spurious wakeups at shutdown with HSW */ 673 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP) 674 pci_set_power_state(dev, PCI_D3hot); 675 676 usb_hcd_pci_remove(dev); 677 } 678 679 /* 680 * In some Intel xHCI controllers, in order to get D3 working, 681 * through a vendor specific SSIC CONFIG register at offset 0x883c, 682 * SSIC PORT need to be marked as "unused" before putting xHCI 683 * into D3. After D3 exit, the SSIC port need to be marked as "used". 684 * Without this change, xHCI might not enter D3 state. 685 */ 686 static void xhci_ssic_port_unused_quirk(struct usb_hcd *hcd, bool suspend) 687 { 688 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 689 u32 val; 690 void __iomem *reg; 691 int i; 692 693 for (i = 0; i < SSIC_PORT_NUM; i++) { 694 reg = (void __iomem *) xhci->cap_regs + 695 SSIC_PORT_CFG2 + 696 i * SSIC_PORT_CFG2_OFFSET; 697 698 /* Notify SSIC that SSIC profile programming is not done. */ 699 val = readl(reg) & ~PROG_DONE; 700 writel(val, reg); 701 702 /* Mark SSIC port as unused(suspend) or used(resume) */ 703 val = readl(reg); 704 if (suspend) 705 val |= SSIC_PORT_UNUSED; 706 else 707 val &= ~SSIC_PORT_UNUSED; 708 writel(val, reg); 709 710 /* Notify SSIC that SSIC profile programming is done */ 711 val = readl(reg) | PROG_DONE; 712 writel(val, reg); 713 readl(reg); 714 } 715 } 716 717 /* 718 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear 719 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4 720 */ 721 static void xhci_pme_quirk(struct usb_hcd *hcd) 722 { 723 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 724 void __iomem *reg; 725 u32 val; 726 727 reg = (void __iomem *) xhci->cap_regs + 0x80a4; 728 val = readl(reg); 729 writel(val | BIT(28), reg); 730 readl(reg); 731 } 732 733 static void xhci_sparse_control_quirk(struct usb_hcd *hcd) 734 { 735 u32 reg; 736 737 reg = readl(hcd->regs + SPARSE_CNTL_ENABLE); 738 reg &= ~BIT(SPARSE_DISABLE_BIT); 739 writel(reg, hcd->regs + SPARSE_CNTL_ENABLE); 740 } 741 742 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup) 743 { 744 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 745 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 746 int ret; 747 748 /* 749 * Systems with the TI redriver that loses port status change events 750 * need to have the registers polled during D3, so avoid D3cold. 751 */ 752 if (xhci->quirks & XHCI_COMP_MODE_QUIRK) 753 pci_d3cold_disable(pdev); 754 755 #ifdef CONFIG_SUSPEND 756 /* d3cold is broken, but only when s2idle is used */ 757 if (pm_suspend_target_state == PM_SUSPEND_TO_IDLE && 758 xhci->quirks & (XHCI_BROKEN_D3COLD_S2I)) 759 pci_d3cold_disable(pdev); 760 #endif 761 762 if (xhci->quirks & XHCI_PME_STUCK_QUIRK) 763 xhci_pme_quirk(hcd); 764 765 if (xhci->quirks & XHCI_SSIC_PORT_UNUSED) 766 xhci_ssic_port_unused_quirk(hcd, true); 767 768 if (xhci->quirks & XHCI_DISABLE_SPARSE) 769 xhci_sparse_control_quirk(hcd); 770 771 ret = xhci_suspend(xhci, do_wakeup); 772 773 /* synchronize irq when using MSI-X */ 774 xhci_msix_sync_irqs(xhci); 775 776 if (ret && (xhci->quirks & XHCI_SSIC_PORT_UNUSED)) 777 xhci_ssic_port_unused_quirk(hcd, false); 778 779 return ret; 780 } 781 782 static int xhci_pci_resume(struct usb_hcd *hcd, pm_message_t msg) 783 { 784 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 785 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 786 int retval = 0; 787 788 reset_control_reset(xhci->reset); 789 790 /* The BIOS on systems with the Intel Panther Point chipset may or may 791 * not support xHCI natively. That means that during system resume, it 792 * may switch the ports back to EHCI so that users can use their 793 * keyboard to select a kernel from GRUB after resume from hibernate. 794 * 795 * The BIOS is supposed to remember whether the OS had xHCI ports 796 * enabled before resume, and switch the ports back to xHCI when the 797 * BIOS/OS semaphore is written, but we all know we can't trust BIOS 798 * writers. 799 * 800 * Unconditionally switch the ports back to xHCI after a system resume. 801 * It should not matter whether the EHCI or xHCI controller is 802 * resumed first. It's enough to do the switchover in xHCI because 803 * USB core won't notice anything as the hub driver doesn't start 804 * running again until after all the devices (including both EHCI and 805 * xHCI host controllers) have been resumed. 806 */ 807 808 if (pdev->vendor == PCI_VENDOR_ID_INTEL) 809 usb_enable_intel_xhci_ports(pdev); 810 811 if (xhci->quirks & XHCI_SSIC_PORT_UNUSED) 812 xhci_ssic_port_unused_quirk(hcd, false); 813 814 if (xhci->quirks & XHCI_PME_STUCK_QUIRK) 815 xhci_pme_quirk(hcd); 816 817 retval = xhci_resume(xhci, msg); 818 return retval; 819 } 820 821 static int xhci_pci_poweroff_late(struct usb_hcd *hcd, bool do_wakeup) 822 { 823 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 824 struct xhci_port *port; 825 struct usb_device *udev; 826 u32 portsc; 827 int i; 828 829 /* 830 * Systems with XHCI_RESET_TO_DEFAULT quirk have boot firmware that 831 * cause significant boot delay if usb ports are in suspended U3 state 832 * during boot. Some USB devices survive in U3 state over S4 hibernate 833 * 834 * Disable ports that are in U3 if remote wake is not enabled for either 835 * host controller or connected device 836 */ 837 838 if (!(xhci->quirks & XHCI_RESET_TO_DEFAULT)) 839 return 0; 840 841 for (i = 0; i < HCS_MAX_PORTS(xhci->hcs_params1); i++) { 842 port = &xhci->hw_ports[i]; 843 portsc = readl(port->addr); 844 845 if ((portsc & PORT_PLS_MASK) != XDEV_U3) 846 continue; 847 848 if (!port->slot_id || !xhci->devs[port->slot_id]) { 849 xhci_err(xhci, "No dev for slot_id %d for port %d-%d in U3\n", 850 port->slot_id, port->rhub->hcd->self.busnum, 851 port->hcd_portnum + 1); 852 continue; 853 } 854 855 udev = xhci->devs[port->slot_id]->udev; 856 857 /* if wakeup is enabled then don't disable the port */ 858 if (udev->do_remote_wakeup && do_wakeup) 859 continue; 860 861 xhci_dbg(xhci, "port %d-%d in U3 without wakeup, disable it\n", 862 port->rhub->hcd->self.busnum, port->hcd_portnum + 1); 863 portsc = xhci_port_state_to_neutral(portsc); 864 writel(portsc | PORT_PE, port->addr); 865 } 866 867 return 0; 868 } 869 870 static void xhci_pci_shutdown(struct usb_hcd *hcd) 871 { 872 struct xhci_hcd *xhci = hcd_to_xhci(hcd); 873 struct pci_dev *pdev = to_pci_dev(hcd->self.controller); 874 875 xhci_shutdown(hcd); 876 xhci_cleanup_msix(xhci); 877 878 /* Yet another workaround for spurious wakeups at shutdown with HSW */ 879 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP) 880 pci_set_power_state(pdev, PCI_D3hot); 881 } 882 883 /*-------------------------------------------------------------------------*/ 884 885 static const struct xhci_driver_data reneses_data = { 886 .quirks = XHCI_RENESAS_FW_QUIRK, 887 .firmware = "renesas_usb_fw.mem", 888 }; 889 890 /* PCI driver selection metadata; PCI hotplugging uses this */ 891 static const struct pci_device_id pci_ids[] = { 892 { PCI_DEVICE(PCI_VENDOR_ID_RENESAS, 0x0014), 893 .driver_data = (unsigned long)&reneses_data, 894 }, 895 { PCI_DEVICE(PCI_VENDOR_ID_RENESAS, 0x0015), 896 .driver_data = (unsigned long)&reneses_data, 897 }, 898 /* handle any USB 3.0 xHCI controller */ 899 { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0), 900 }, 901 { /* end: all zeroes */ } 902 }; 903 MODULE_DEVICE_TABLE(pci, pci_ids); 904 905 /* 906 * Without CONFIG_USB_XHCI_PCI_RENESAS renesas_xhci_check_request_fw() won't 907 * load firmware, so don't encumber the xhci-pci driver with it. 908 */ 909 #if IS_ENABLED(CONFIG_USB_XHCI_PCI_RENESAS) 910 MODULE_FIRMWARE("renesas_usb_fw.mem"); 911 #endif 912 913 /* pci driver glue; this is a "new style" PCI driver module */ 914 static struct pci_driver xhci_pci_driver = { 915 .name = hcd_name, 916 .id_table = pci_ids, 917 918 .probe = xhci_pci_probe, 919 .remove = xhci_pci_remove, 920 /* suspend and resume implemented later */ 921 922 .shutdown = usb_hcd_pci_shutdown, 923 .driver = { 924 .pm = pm_ptr(&usb_hcd_pci_pm_ops), 925 }, 926 }; 927 928 static int __init xhci_pci_init(void) 929 { 930 xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides); 931 xhci_pci_hc_driver.pci_suspend = pm_ptr(xhci_pci_suspend); 932 xhci_pci_hc_driver.pci_resume = pm_ptr(xhci_pci_resume); 933 xhci_pci_hc_driver.pci_poweroff_late = pm_ptr(xhci_pci_poweroff_late); 934 xhci_pci_hc_driver.shutdown = pm_ptr(xhci_pci_shutdown); 935 xhci_pci_hc_driver.stop = xhci_pci_stop; 936 return pci_register_driver(&xhci_pci_driver); 937 } 938 module_init(xhci_pci_init); 939 940 static void __exit xhci_pci_exit(void) 941 { 942 pci_unregister_driver(&xhci_pci_driver); 943 } 944 module_exit(xhci_pci_exit); 945 946 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver"); 947 MODULE_LICENSE("GPL"); 948