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_ADL 0x460e
44 #define PCI_DEVICE_ID_INTEL_ADL_PCH 0x51ee
45 #define PCI_DEVICE_ID_INTEL_ADLN 0x465e
46 #define PCI_DEVICE_ID_INTEL_ADLN_PCH 0x54ee
47 #define PCI_DEVICE_ID_INTEL_ADLS 0x7ae1
48 #define PCI_DEVICE_ID_INTEL_RPL 0xa70e
49 #define PCI_DEVICE_ID_INTEL_RPLS 0x7a61
50 #define PCI_DEVICE_ID_INTEL_MTLM 0x7eb1
51 #define PCI_DEVICE_ID_INTEL_MTLP 0x7ec1
52 #define PCI_DEVICE_ID_INTEL_MTLS 0x7f6f
53 #define PCI_DEVICE_ID_INTEL_MTL 0x7e7e
54 #define PCI_DEVICE_ID_INTEL_ARLH 0x7ec1
55 #define PCI_DEVICE_ID_INTEL_ARLH_PCH 0x777e
56 #define PCI_DEVICE_ID_INTEL_TGL 0x9a15
57 #define PCI_DEVICE_ID_AMD_MR 0x163a
59 #define PCI_INTEL_BXT_DSM_GUID "732b85d5-b7a7-4a1b-9ba0-4bbd00ffd511"
60 #define PCI_INTEL_BXT_FUNC_PMU_PWR 4
61 #define PCI_INTEL_BXT_STATE_D0 0
62 #define PCI_INTEL_BXT_STATE_D3 3
65 #define GP_RWREG1 0xa0
66 #define GP_RWREG1_ULPI_REFCLK_DISABLE (1 << 17)
69 * struct dwc3_pci - Driver private structure
70 * @dwc3: child dwc3 platform_device
71 * @pci: our link to PCI bus
73 * @has_dsm_for_pm: true for devices which need to run _DSM on runtime PM
74 * @wakeup_work: work for asynchronous resume
77 struct platform_device *dwc3;
82 unsigned int has_dsm_for_pm:1;
83 struct work_struct wakeup_work;
86 static const struct acpi_gpio_params reset_gpios = { 0, 0, false };
87 static const struct acpi_gpio_params cs_gpios = { 1, 0, false };
89 static const struct acpi_gpio_mapping acpi_dwc3_byt_gpios[] = {
90 { "reset-gpios", &reset_gpios, 1 },
91 { "cs-gpios", &cs_gpios, 1 },
95 static struct gpiod_lookup_table platform_bytcr_gpios = {
96 .dev_id = "0000:00:16.0",
98 GPIO_LOOKUP("INT33FC:00", 54, "cs", GPIO_ACTIVE_HIGH),
99 GPIO_LOOKUP("INT33FC:02", 14, "reset", GPIO_ACTIVE_HIGH),
104 static int dwc3_byt_enable_ulpi_refclock(struct pci_dev *pci)
109 reg = pcim_iomap(pci, GP_RWBAR, 0);
113 value = readl(reg + GP_RWREG1);
114 if (!(value & GP_RWREG1_ULPI_REFCLK_DISABLE))
115 goto unmap; /* ULPI refclk already enabled */
117 value &= ~GP_RWREG1_ULPI_REFCLK_DISABLE;
118 writel(value, reg + GP_RWREG1);
119 /* This comes from the Intel Android x86 tree w/o any explanation */
122 pcim_iounmap(pci, reg);
126 static const struct property_entry dwc3_pci_intel_properties[] = {
127 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
128 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
132 static const struct property_entry dwc3_pci_intel_phy_charger_detect_properties[] = {
133 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
134 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
135 PROPERTY_ENTRY_BOOL("linux,phy_charger_detect"),
136 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
140 static const struct property_entry dwc3_pci_intel_byt_properties[] = {
141 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
142 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
143 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
147 static const struct property_entry dwc3_pci_mrfld_properties[] = {
148 PROPERTY_ENTRY_STRING("dr_mode", "otg"),
149 PROPERTY_ENTRY_STRING("linux,extcon-name", "mrfld_bcove_pwrsrc"),
150 PROPERTY_ENTRY_BOOL("snps,dis_u3_susphy_quirk"),
151 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
152 PROPERTY_ENTRY_BOOL("snps,usb2-gadget-lpm-disable"),
153 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
157 static const struct property_entry dwc3_pci_amd_properties[] = {
158 PROPERTY_ENTRY_BOOL("snps,has-lpm-erratum"),
159 PROPERTY_ENTRY_U8("snps,lpm-nyet-threshold", 0xf),
160 PROPERTY_ENTRY_BOOL("snps,u2exit_lfps_quirk"),
161 PROPERTY_ENTRY_BOOL("snps,u2ss_inp3_quirk"),
162 PROPERTY_ENTRY_BOOL("snps,req_p1p2p3_quirk"),
163 PROPERTY_ENTRY_BOOL("snps,del_p1p2p3_quirk"),
164 PROPERTY_ENTRY_BOOL("snps,del_phy_power_chg_quirk"),
165 PROPERTY_ENTRY_BOOL("snps,lfps_filter_quirk"),
166 PROPERTY_ENTRY_BOOL("snps,rx_detect_poll_quirk"),
167 PROPERTY_ENTRY_BOOL("snps,tx_de_emphasis_quirk"),
168 PROPERTY_ENTRY_U8("snps,tx_de_emphasis", 1),
169 /* FIXME these quirks should be removed when AMD NL tapes out */
170 PROPERTY_ENTRY_BOOL("snps,disable_scramble_quirk"),
171 PROPERTY_ENTRY_BOOL("snps,dis_u3_susphy_quirk"),
172 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
173 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
177 static const struct property_entry dwc3_pci_mr_properties[] = {
178 PROPERTY_ENTRY_STRING("dr_mode", "otg"),
179 PROPERTY_ENTRY_BOOL("usb-role-switch"),
180 PROPERTY_ENTRY_STRING("role-switch-default-mode", "host"),
181 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
185 static const struct software_node dwc3_pci_intel_swnode = {
186 .properties = dwc3_pci_intel_properties,
189 static const struct software_node dwc3_pci_intel_phy_charger_detect_swnode = {
190 .properties = dwc3_pci_intel_phy_charger_detect_properties,
193 static const struct software_node dwc3_pci_intel_byt_swnode = {
194 .properties = dwc3_pci_intel_byt_properties,
197 static const struct software_node dwc3_pci_intel_mrfld_swnode = {
198 .properties = dwc3_pci_mrfld_properties,
201 static const struct software_node dwc3_pci_amd_swnode = {
202 .properties = dwc3_pci_amd_properties,
205 static const struct software_node dwc3_pci_amd_mr_swnode = {
206 .properties = dwc3_pci_mr_properties,
209 static int dwc3_pci_quirks(struct dwc3_pci *dwc,
210 const struct software_node *swnode)
212 struct pci_dev *pdev = dwc->pci;
214 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
215 if (pdev->device == PCI_DEVICE_ID_INTEL_BXT ||
216 pdev->device == PCI_DEVICE_ID_INTEL_BXT_M ||
217 pdev->device == PCI_DEVICE_ID_INTEL_EHL) {
218 guid_parse(PCI_INTEL_BXT_DSM_GUID, &dwc->guid);
219 dwc->has_dsm_for_pm = true;
222 if (pdev->device == PCI_DEVICE_ID_INTEL_BYT) {
223 struct gpio_desc *gpio;
226 /* On BYT the FW does not always enable the refclock */
227 ret = dwc3_byt_enable_ulpi_refclock(pdev);
231 ret = devm_acpi_dev_add_driver_gpios(&pdev->dev,
232 acpi_dwc3_byt_gpios);
234 dev_dbg(&pdev->dev, "failed to add mapping table\n");
237 * A lot of BYT devices lack ACPI resource entries for
238 * the GPIOs. If the ACPI entry for the GPIO controller
239 * is present add a fallback mapping to the reference
240 * design GPIOs which all boards seem to use.
242 if (acpi_dev_present("INT33FC", NULL, -1))
243 gpiod_add_lookup_table(&platform_bytcr_gpios);
246 * These GPIOs will turn on the USB2 PHY. Note that we have to
247 * put the gpio descriptors again here because the phy driver
248 * might want to grab them, too.
250 gpio = gpiod_get_optional(&pdev->dev, "cs", GPIOD_OUT_LOW);
252 return PTR_ERR(gpio);
254 gpiod_set_value_cansleep(gpio, 1);
257 gpio = gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
259 return PTR_ERR(gpio);
262 gpiod_set_value_cansleep(gpio, 1);
264 usleep_range(10000, 11000);
268 * Make the pdev name predictable (only 1 DWC3 on BYT)
269 * and patch the phy dev-name into the lookup table so
270 * that the phy-driver can get the GPIOs.
272 dwc->dwc3->id = PLATFORM_DEVID_NONE;
273 platform_bytcr_gpios.dev_id = "dwc3.ulpi";
276 * Some Android tablets with a Crystal Cove PMIC
277 * (INT33FD), rely on the TUSB1211 phy for charger
278 * detection. These can be identified by them _not_
279 * using the standard ACPI battery and ac drivers.
281 if (acpi_dev_present("INT33FD", "1", 2) &&
282 acpi_quirk_skip_acpi_ac_and_battery()) {
283 dev_info(&pdev->dev, "Using TUSB1211 phy for charger detection\n");
284 swnode = &dwc3_pci_intel_phy_charger_detect_swnode;
289 return device_add_software_node(&dwc->dwc3->dev, swnode);
293 static void dwc3_pci_resume_work(struct work_struct *work)
295 struct dwc3_pci *dwc = container_of(work, struct dwc3_pci, wakeup_work);
296 struct platform_device *dwc3 = dwc->dwc3;
299 ret = pm_runtime_get_sync(&dwc3->dev);
301 pm_runtime_put_sync_autosuspend(&dwc3->dev);
305 pm_runtime_mark_last_busy(&dwc3->dev);
306 pm_runtime_put_sync_autosuspend(&dwc3->dev);
310 static int dwc3_pci_probe(struct pci_dev *pci, const struct pci_device_id *id)
312 struct dwc3_pci *dwc;
313 struct resource res[2];
315 struct device *dev = &pci->dev;
317 ret = pcim_enable_device(pci);
319 dev_err(dev, "failed to enable pci device\n");
325 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
329 dwc->dwc3 = platform_device_alloc("dwc3", PLATFORM_DEVID_AUTO);
333 memset(res, 0x00, sizeof(struct resource) * ARRAY_SIZE(res));
335 res[0].start = pci_resource_start(pci, 0);
336 res[0].end = pci_resource_end(pci, 0);
337 res[0].name = "dwc_usb3";
338 res[0].flags = IORESOURCE_MEM;
340 res[1].start = pci->irq;
341 res[1].name = "dwc_usb3";
342 res[1].flags = IORESOURCE_IRQ;
344 ret = platform_device_add_resources(dwc->dwc3, res, ARRAY_SIZE(res));
346 dev_err(dev, "couldn't add resources to dwc3 device\n");
351 dwc->dwc3->dev.parent = dev;
352 ACPI_COMPANION_SET(&dwc->dwc3->dev, ACPI_COMPANION(dev));
354 ret = dwc3_pci_quirks(dwc, (void *)id->driver_data);
358 ret = platform_device_add(dwc->dwc3);
360 dev_err(dev, "failed to register dwc3 device\n");
364 device_init_wakeup(dev, true);
365 pci_set_drvdata(pci, dwc);
368 INIT_WORK(&dwc->wakeup_work, dwc3_pci_resume_work);
373 device_remove_software_node(&dwc->dwc3->dev);
374 platform_device_put(dwc->dwc3);
378 static void dwc3_pci_remove(struct pci_dev *pci)
380 struct dwc3_pci *dwc = pci_get_drvdata(pci);
381 struct pci_dev *pdev = dwc->pci;
383 if (pdev->device == PCI_DEVICE_ID_INTEL_BYT)
384 gpiod_remove_lookup_table(&platform_bytcr_gpios);
386 cancel_work_sync(&dwc->wakeup_work);
388 device_init_wakeup(&pci->dev, false);
389 pm_runtime_get(&pci->dev);
390 device_remove_software_node(&dwc->dwc3->dev);
391 platform_device_unregister(dwc->dwc3);
394 static const struct pci_device_id dwc3_pci_id_table[] = {
395 { PCI_DEVICE_DATA(INTEL, BSW, &dwc3_pci_intel_swnode) },
396 { PCI_DEVICE_DATA(INTEL, BYT, &dwc3_pci_intel_byt_swnode) },
397 { PCI_DEVICE_DATA(INTEL, MRFLD, &dwc3_pci_intel_mrfld_swnode) },
398 { PCI_DEVICE_DATA(INTEL, CMLLP, &dwc3_pci_intel_swnode) },
399 { PCI_DEVICE_DATA(INTEL, CMLH, &dwc3_pci_intel_swnode) },
400 { PCI_DEVICE_DATA(INTEL, SPTLP, &dwc3_pci_intel_swnode) },
401 { PCI_DEVICE_DATA(INTEL, SPTH, &dwc3_pci_intel_swnode) },
402 { PCI_DEVICE_DATA(INTEL, BXT, &dwc3_pci_intel_swnode) },
403 { PCI_DEVICE_DATA(INTEL, BXT_M, &dwc3_pci_intel_swnode) },
404 { PCI_DEVICE_DATA(INTEL, APL, &dwc3_pci_intel_swnode) },
405 { PCI_DEVICE_DATA(INTEL, KBP, &dwc3_pci_intel_swnode) },
406 { PCI_DEVICE_DATA(INTEL, GLK, &dwc3_pci_intel_swnode) },
407 { PCI_DEVICE_DATA(INTEL, CNPLP, &dwc3_pci_intel_swnode) },
408 { PCI_DEVICE_DATA(INTEL, CNPH, &dwc3_pci_intel_swnode) },
409 { PCI_DEVICE_DATA(INTEL, CNPV, &dwc3_pci_intel_swnode) },
410 { PCI_DEVICE_DATA(INTEL, ICLLP, &dwc3_pci_intel_swnode) },
411 { PCI_DEVICE_DATA(INTEL, EHL, &dwc3_pci_intel_swnode) },
412 { PCI_DEVICE_DATA(INTEL, TGPLP, &dwc3_pci_intel_swnode) },
413 { PCI_DEVICE_DATA(INTEL, TGPH, &dwc3_pci_intel_swnode) },
414 { PCI_DEVICE_DATA(INTEL, JSP, &dwc3_pci_intel_swnode) },
415 { PCI_DEVICE_DATA(INTEL, ADL, &dwc3_pci_intel_swnode) },
416 { PCI_DEVICE_DATA(INTEL, ADL_PCH, &dwc3_pci_intel_swnode) },
417 { PCI_DEVICE_DATA(INTEL, ADLN, &dwc3_pci_intel_swnode) },
418 { PCI_DEVICE_DATA(INTEL, ADLN_PCH, &dwc3_pci_intel_swnode) },
419 { PCI_DEVICE_DATA(INTEL, ADLS, &dwc3_pci_intel_swnode) },
420 { PCI_DEVICE_DATA(INTEL, RPL, &dwc3_pci_intel_swnode) },
421 { PCI_DEVICE_DATA(INTEL, RPLS, &dwc3_pci_intel_swnode) },
422 { PCI_DEVICE_DATA(INTEL, MTLM, &dwc3_pci_intel_swnode) },
423 { PCI_DEVICE_DATA(INTEL, MTLP, &dwc3_pci_intel_swnode) },
424 { PCI_DEVICE_DATA(INTEL, MTL, &dwc3_pci_intel_swnode) },
425 { PCI_DEVICE_DATA(INTEL, MTLS, &dwc3_pci_intel_swnode) },
426 { PCI_DEVICE_DATA(INTEL, ARLH, &dwc3_pci_intel_swnode) },
427 { PCI_DEVICE_DATA(INTEL, ARLH_PCH, &dwc3_pci_intel_swnode) },
428 { PCI_DEVICE_DATA(INTEL, TGL, &dwc3_pci_intel_swnode) },
430 { PCI_DEVICE_DATA(AMD, NL_USB, &dwc3_pci_amd_swnode) },
431 { PCI_DEVICE_DATA(AMD, MR, &dwc3_pci_amd_mr_swnode) },
433 { } /* Terminating Entry */
435 MODULE_DEVICE_TABLE(pci, dwc3_pci_id_table);
437 #if defined(CONFIG_PM) || defined(CONFIG_PM_SLEEP)
438 static int dwc3_pci_dsm(struct dwc3_pci *dwc, int param)
440 union acpi_object *obj;
441 union acpi_object tmp;
442 union acpi_object argv4 = ACPI_INIT_DSM_ARGV4(1, &tmp);
444 if (!dwc->has_dsm_for_pm)
447 tmp.type = ACPI_TYPE_INTEGER;
448 tmp.integer.value = param;
450 obj = acpi_evaluate_dsm(ACPI_HANDLE(&dwc->pci->dev), &dwc->guid,
451 1, PCI_INTEL_BXT_FUNC_PMU_PWR, &argv4);
453 dev_err(&dwc->pci->dev, "failed to evaluate _DSM\n");
461 #endif /* CONFIG_PM || CONFIG_PM_SLEEP */
464 static int dwc3_pci_runtime_suspend(struct device *dev)
466 struct dwc3_pci *dwc = dev_get_drvdata(dev);
468 if (device_can_wakeup(dev))
469 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
474 static int dwc3_pci_runtime_resume(struct device *dev)
476 struct dwc3_pci *dwc = dev_get_drvdata(dev);
479 ret = dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
483 queue_work(pm_wq, &dwc->wakeup_work);
487 #endif /* CONFIG_PM */
489 #ifdef CONFIG_PM_SLEEP
490 static int dwc3_pci_suspend(struct device *dev)
492 struct dwc3_pci *dwc = dev_get_drvdata(dev);
494 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
497 static int dwc3_pci_resume(struct device *dev)
499 struct dwc3_pci *dwc = dev_get_drvdata(dev);
501 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
503 #endif /* CONFIG_PM_SLEEP */
505 static const struct dev_pm_ops dwc3_pci_dev_pm_ops = {
506 SET_SYSTEM_SLEEP_PM_OPS(dwc3_pci_suspend, dwc3_pci_resume)
507 SET_RUNTIME_PM_OPS(dwc3_pci_runtime_suspend, dwc3_pci_runtime_resume,
511 static struct pci_driver dwc3_pci_driver = {
513 .id_table = dwc3_pci_id_table,
514 .probe = dwc3_pci_probe,
515 .remove = dwc3_pci_remove,
517 .pm = &dwc3_pci_dev_pm_ops,
521 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
522 MODULE_LICENSE("GPL v2");
523 MODULE_DESCRIPTION("DesignWare USB3 PCI Glue Layer");
525 module_pci_driver(dwc3_pci_driver);