1 // SPDX-License-Identifier: GPL-2.0
3 * dwc3-pci.c - PCI Specific glue layer
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/pci.h>
15 #include <linux/workqueue.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/platform_device.h>
18 #include <linux/gpio/consumer.h>
19 #include <linux/gpio/machine.h>
20 #include <linux/acpi.h>
21 #include <linux/delay.h>
23 #define PCI_DEVICE_ID_INTEL_BYT 0x0f37
24 #define PCI_DEVICE_ID_INTEL_MRFLD 0x119e
25 #define PCI_DEVICE_ID_INTEL_BSW 0x22b7
26 #define PCI_DEVICE_ID_INTEL_SPTLP 0x9d30
27 #define PCI_DEVICE_ID_INTEL_SPTH 0xa130
28 #define PCI_DEVICE_ID_INTEL_BXT 0x0aaa
29 #define PCI_DEVICE_ID_INTEL_BXT_M 0x1aaa
30 #define PCI_DEVICE_ID_INTEL_APL 0x5aaa
31 #define PCI_DEVICE_ID_INTEL_KBP 0xa2b0
32 #define PCI_DEVICE_ID_INTEL_CMLLP 0x02ee
33 #define PCI_DEVICE_ID_INTEL_CMLH 0x06ee
34 #define PCI_DEVICE_ID_INTEL_GLK 0x31aa
35 #define PCI_DEVICE_ID_INTEL_CNPLP 0x9dee
36 #define PCI_DEVICE_ID_INTEL_CNPH 0xa36e
37 #define PCI_DEVICE_ID_INTEL_CNPV 0xa3b0
38 #define PCI_DEVICE_ID_INTEL_ICLLP 0x34ee
39 #define PCI_DEVICE_ID_INTEL_EHL 0x4b7e
40 #define PCI_DEVICE_ID_INTEL_TGPLP 0xa0ee
41 #define PCI_DEVICE_ID_INTEL_TGPH 0x43ee
42 #define PCI_DEVICE_ID_INTEL_JSP 0x4dee
43 #define PCI_DEVICE_ID_INTEL_ADLP 0x51ee
44 #define PCI_DEVICE_ID_INTEL_ADLM 0x54ee
45 #define PCI_DEVICE_ID_INTEL_ADLS 0x7ae1
46 #define PCI_DEVICE_ID_INTEL_RPLS 0x7a61
47 #define PCI_DEVICE_ID_INTEL_TGL 0x9a15
48 #define PCI_DEVICE_ID_AMD_MR 0x163a
50 #define PCI_INTEL_BXT_DSM_GUID "732b85d5-b7a7-4a1b-9ba0-4bbd00ffd511"
51 #define PCI_INTEL_BXT_FUNC_PMU_PWR 4
52 #define PCI_INTEL_BXT_STATE_D0 0
53 #define PCI_INTEL_BXT_STATE_D3 3
56 #define GP_RWREG1 0xa0
57 #define GP_RWREG1_ULPI_REFCLK_DISABLE (1 << 17)
60 * struct dwc3_pci - Driver private structure
61 * @dwc3: child dwc3 platform_device
62 * @pci: our link to PCI bus
64 * @has_dsm_for_pm: true for devices which need to run _DSM on runtime PM
65 * @wakeup_work: work for asynchronous resume
68 struct platform_device *dwc3;
73 unsigned int has_dsm_for_pm:1;
74 struct work_struct wakeup_work;
77 static const struct acpi_gpio_params reset_gpios = { 0, 0, false };
78 static const struct acpi_gpio_params cs_gpios = { 1, 0, false };
80 static const struct acpi_gpio_mapping acpi_dwc3_byt_gpios[] = {
81 { "reset-gpios", &reset_gpios, 1 },
82 { "cs-gpios", &cs_gpios, 1 },
86 static struct gpiod_lookup_table platform_bytcr_gpios = {
87 .dev_id = "0000:00:16.0",
89 GPIO_LOOKUP("INT33FC:00", 54, "cs", GPIO_ACTIVE_HIGH),
90 GPIO_LOOKUP("INT33FC:02", 14, "reset", GPIO_ACTIVE_HIGH),
95 static int dwc3_byt_enable_ulpi_refclock(struct pci_dev *pci)
100 reg = pcim_iomap(pci, GP_RWBAR, 0);
104 value = readl(reg + GP_RWREG1);
105 if (!(value & GP_RWREG1_ULPI_REFCLK_DISABLE))
106 goto unmap; /* ULPI refclk already enabled */
108 value &= ~GP_RWREG1_ULPI_REFCLK_DISABLE;
109 writel(value, reg + GP_RWREG1);
110 /* This comes from the Intel Android x86 tree w/o any explanation */
113 pcim_iounmap(pci, reg);
117 static const struct property_entry dwc3_pci_intel_properties[] = {
118 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
119 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
123 static const struct property_entry dwc3_pci_intel_byt_properties[] = {
124 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
125 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
126 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
130 static const struct property_entry dwc3_pci_mrfld_properties[] = {
131 PROPERTY_ENTRY_STRING("dr_mode", "otg"),
132 PROPERTY_ENTRY_STRING("linux,extcon-name", "mrfld_bcove_pwrsrc"),
133 PROPERTY_ENTRY_BOOL("snps,dis_u3_susphy_quirk"),
134 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
135 PROPERTY_ENTRY_BOOL("snps,usb2-gadget-lpm-disable"),
136 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
140 static const struct property_entry dwc3_pci_amd_properties[] = {
141 PROPERTY_ENTRY_BOOL("snps,has-lpm-erratum"),
142 PROPERTY_ENTRY_U8("snps,lpm-nyet-threshold", 0xf),
143 PROPERTY_ENTRY_BOOL("snps,u2exit_lfps_quirk"),
144 PROPERTY_ENTRY_BOOL("snps,u2ss_inp3_quirk"),
145 PROPERTY_ENTRY_BOOL("snps,req_p1p2p3_quirk"),
146 PROPERTY_ENTRY_BOOL("snps,del_p1p2p3_quirk"),
147 PROPERTY_ENTRY_BOOL("snps,del_phy_power_chg_quirk"),
148 PROPERTY_ENTRY_BOOL("snps,lfps_filter_quirk"),
149 PROPERTY_ENTRY_BOOL("snps,rx_detect_poll_quirk"),
150 PROPERTY_ENTRY_BOOL("snps,tx_de_emphasis_quirk"),
151 PROPERTY_ENTRY_U8("snps,tx_de_emphasis", 1),
152 /* FIXME these quirks should be removed when AMD NL tapes out */
153 PROPERTY_ENTRY_BOOL("snps,disable_scramble_quirk"),
154 PROPERTY_ENTRY_BOOL("snps,dis_u3_susphy_quirk"),
155 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
156 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
160 static const struct property_entry dwc3_pci_mr_properties[] = {
161 PROPERTY_ENTRY_STRING("dr_mode", "otg"),
162 PROPERTY_ENTRY_BOOL("usb-role-switch"),
163 PROPERTY_ENTRY_STRING("role-switch-default-mode", "host"),
164 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
168 static const struct software_node dwc3_pci_intel_swnode = {
169 .properties = dwc3_pci_intel_properties,
172 static const struct software_node dwc3_pci_intel_byt_swnode = {
173 .properties = dwc3_pci_intel_byt_properties,
176 static const struct software_node dwc3_pci_intel_mrfld_swnode = {
177 .properties = dwc3_pci_mrfld_properties,
180 static const struct software_node dwc3_pci_amd_swnode = {
181 .properties = dwc3_pci_amd_properties,
184 static const struct software_node dwc3_pci_amd_mr_swnode = {
185 .properties = dwc3_pci_mr_properties,
188 static int dwc3_pci_quirks(struct dwc3_pci *dwc)
190 struct pci_dev *pdev = dwc->pci;
192 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
193 if (pdev->device == PCI_DEVICE_ID_INTEL_BXT ||
194 pdev->device == PCI_DEVICE_ID_INTEL_BXT_M ||
195 pdev->device == PCI_DEVICE_ID_INTEL_EHL) {
196 guid_parse(PCI_INTEL_BXT_DSM_GUID, &dwc->guid);
197 dwc->has_dsm_for_pm = true;
200 if (pdev->device == PCI_DEVICE_ID_INTEL_BYT) {
201 struct gpio_desc *gpio;
204 /* On BYT the FW does not always enable the refclock */
205 ret = dwc3_byt_enable_ulpi_refclock(pdev);
209 ret = devm_acpi_dev_add_driver_gpios(&pdev->dev,
210 acpi_dwc3_byt_gpios);
212 dev_dbg(&pdev->dev, "failed to add mapping table\n");
215 * A lot of BYT devices lack ACPI resource entries for
216 * the GPIOs, add a fallback mapping to the reference
217 * design GPIOs which all boards seem to use.
219 gpiod_add_lookup_table(&platform_bytcr_gpios);
222 * These GPIOs will turn on the USB2 PHY. Note that we have to
223 * put the gpio descriptors again here because the phy driver
224 * might want to grab them, too.
226 gpio = gpiod_get_optional(&pdev->dev, "cs", GPIOD_OUT_LOW);
228 return PTR_ERR(gpio);
230 gpiod_set_value_cansleep(gpio, 1);
233 gpio = gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
235 return PTR_ERR(gpio);
238 gpiod_set_value_cansleep(gpio, 1);
240 usleep_range(10000, 11000);
249 static void dwc3_pci_resume_work(struct work_struct *work)
251 struct dwc3_pci *dwc = container_of(work, struct dwc3_pci, wakeup_work);
252 struct platform_device *dwc3 = dwc->dwc3;
255 ret = pm_runtime_get_sync(&dwc3->dev);
257 pm_runtime_put_sync_autosuspend(&dwc3->dev);
261 pm_runtime_mark_last_busy(&dwc3->dev);
262 pm_runtime_put_sync_autosuspend(&dwc3->dev);
266 static int dwc3_pci_probe(struct pci_dev *pci, const struct pci_device_id *id)
268 struct dwc3_pci *dwc;
269 struct resource res[2];
271 struct device *dev = &pci->dev;
273 ret = pcim_enable_device(pci);
275 dev_err(dev, "failed to enable pci device\n");
281 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
285 dwc->dwc3 = platform_device_alloc("dwc3", PLATFORM_DEVID_AUTO);
289 memset(res, 0x00, sizeof(struct resource) * ARRAY_SIZE(res));
291 res[0].start = pci_resource_start(pci, 0);
292 res[0].end = pci_resource_end(pci, 0);
293 res[0].name = "dwc_usb3";
294 res[0].flags = IORESOURCE_MEM;
296 res[1].start = pci->irq;
297 res[1].name = "dwc_usb3";
298 res[1].flags = IORESOURCE_IRQ;
300 ret = platform_device_add_resources(dwc->dwc3, res, ARRAY_SIZE(res));
302 dev_err(dev, "couldn't add resources to dwc3 device\n");
307 dwc->dwc3->dev.parent = dev;
308 ACPI_COMPANION_SET(&dwc->dwc3->dev, ACPI_COMPANION(dev));
310 ret = device_add_software_node(&dwc->dwc3->dev, (void *)id->driver_data);
314 ret = dwc3_pci_quirks(dwc);
318 ret = platform_device_add(dwc->dwc3);
320 dev_err(dev, "failed to register dwc3 device\n");
324 device_init_wakeup(dev, true);
325 pci_set_drvdata(pci, dwc);
328 INIT_WORK(&dwc->wakeup_work, dwc3_pci_resume_work);
333 device_remove_software_node(&dwc->dwc3->dev);
334 platform_device_put(dwc->dwc3);
338 static void dwc3_pci_remove(struct pci_dev *pci)
340 struct dwc3_pci *dwc = pci_get_drvdata(pci);
341 struct pci_dev *pdev = dwc->pci;
343 if (pdev->device == PCI_DEVICE_ID_INTEL_BYT)
344 gpiod_remove_lookup_table(&platform_bytcr_gpios);
346 cancel_work_sync(&dwc->wakeup_work);
348 device_init_wakeup(&pci->dev, false);
349 pm_runtime_get(&pci->dev);
350 device_remove_software_node(&dwc->dwc3->dev);
351 platform_device_unregister(dwc->dwc3);
354 static const struct pci_device_id dwc3_pci_id_table[] = {
355 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_BSW),
356 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
358 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_BYT),
359 (kernel_ulong_t) &dwc3_pci_intel_byt_swnode, },
361 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_MRFLD),
362 (kernel_ulong_t) &dwc3_pci_intel_mrfld_swnode, },
364 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_CMLLP),
365 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
367 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_CMLH),
368 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
370 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_SPTLP),
371 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
373 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_SPTH),
374 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
376 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_BXT),
377 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
379 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_BXT_M),
380 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
382 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_APL),
383 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
385 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_KBP),
386 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
388 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_GLK),
389 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
391 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_CNPLP),
392 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
394 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_CNPH),
395 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
397 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_CNPV),
398 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
400 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICLLP),
401 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
403 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_EHL),
404 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
406 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGPLP),
407 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
409 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGPH),
410 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
412 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_JSP),
413 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
415 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ADLP),
416 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
418 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ADLM),
419 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
421 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ADLS),
422 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
424 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_RPLS),
425 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
427 { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_TGL),
428 (kernel_ulong_t) &dwc3_pci_intel_swnode, },
430 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_NL_USB),
431 (kernel_ulong_t) &dwc3_pci_amd_swnode, },
433 { PCI_VDEVICE(AMD, PCI_DEVICE_ID_AMD_MR),
434 (kernel_ulong_t)&dwc3_pci_amd_mr_swnode, },
436 { } /* Terminating Entry */
438 MODULE_DEVICE_TABLE(pci, dwc3_pci_id_table);
440 #if defined(CONFIG_PM) || defined(CONFIG_PM_SLEEP)
441 static int dwc3_pci_dsm(struct dwc3_pci *dwc, int param)
443 union acpi_object *obj;
444 union acpi_object tmp;
445 union acpi_object argv4 = ACPI_INIT_DSM_ARGV4(1, &tmp);
447 if (!dwc->has_dsm_for_pm)
450 tmp.type = ACPI_TYPE_INTEGER;
451 tmp.integer.value = param;
453 obj = acpi_evaluate_dsm(ACPI_HANDLE(&dwc->pci->dev), &dwc->guid,
454 1, PCI_INTEL_BXT_FUNC_PMU_PWR, &argv4);
456 dev_err(&dwc->pci->dev, "failed to evaluate _DSM\n");
464 #endif /* CONFIG_PM || CONFIG_PM_SLEEP */
467 static int dwc3_pci_runtime_suspend(struct device *dev)
469 struct dwc3_pci *dwc = dev_get_drvdata(dev);
471 if (device_can_wakeup(dev))
472 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
477 static int dwc3_pci_runtime_resume(struct device *dev)
479 struct dwc3_pci *dwc = dev_get_drvdata(dev);
482 ret = dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
486 queue_work(pm_wq, &dwc->wakeup_work);
490 #endif /* CONFIG_PM */
492 #ifdef CONFIG_PM_SLEEP
493 static int dwc3_pci_suspend(struct device *dev)
495 struct dwc3_pci *dwc = dev_get_drvdata(dev);
497 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
500 static int dwc3_pci_resume(struct device *dev)
502 struct dwc3_pci *dwc = dev_get_drvdata(dev);
504 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
506 #endif /* CONFIG_PM_SLEEP */
508 static const struct dev_pm_ops dwc3_pci_dev_pm_ops = {
509 SET_SYSTEM_SLEEP_PM_OPS(dwc3_pci_suspend, dwc3_pci_resume)
510 SET_RUNTIME_PM_OPS(dwc3_pci_runtime_suspend, dwc3_pci_runtime_resume,
514 static struct pci_driver dwc3_pci_driver = {
516 .id_table = dwc3_pci_id_table,
517 .probe = dwc3_pci_probe,
518 .remove = dwc3_pci_remove,
520 .pm = &dwc3_pci_dev_pm_ops,
524 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
525 MODULE_LICENSE("GPL v2");
526 MODULE_DESCRIPTION("DesignWare USB3 PCI Glue Layer");
528 module_pci_driver(dwc3_pci_driver);