2 * dwc3-pci.c - PCI Specific glue layer
4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
6 * Authors: Felipe Balbi <balbi@ti.com>,
7 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
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 of
11 * the License as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/pci.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/platform_device.h>
25 #include <linux/gpio/consumer.h>
26 #include <linux/acpi.h>
27 #include <linux/delay.h>
29 #define PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3 0xabcd
30 #define PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3_AXI 0xabce
31 #define PCI_DEVICE_ID_SYNOPSYS_HAPSUSB31 0xabcf
32 #define PCI_DEVICE_ID_INTEL_BYT 0x0f37
33 #define PCI_DEVICE_ID_INTEL_MRFLD 0x119e
34 #define PCI_DEVICE_ID_INTEL_BSW 0x22b7
35 #define PCI_DEVICE_ID_INTEL_SPTLP 0x9d30
36 #define PCI_DEVICE_ID_INTEL_SPTH 0xa130
37 #define PCI_DEVICE_ID_INTEL_BXT 0x0aaa
38 #define PCI_DEVICE_ID_INTEL_BXT_M 0x1aaa
39 #define PCI_DEVICE_ID_INTEL_APL 0x5aaa
40 #define PCI_DEVICE_ID_INTEL_KBP 0xa2b0
41 #define PCI_DEVICE_ID_INTEL_GLK 0x31aa
42 #define PCI_DEVICE_ID_INTEL_CNPLP 0x9dee
43 #define PCI_DEVICE_ID_INTEL_CNPH 0xa36e
44 #define PCI_DEVICE_ID_INTEL_ICLLP 0x34ee
46 #define PCI_INTEL_BXT_DSM_GUID "732b85d5-b7a7-4a1b-9ba0-4bbd00ffd511"
47 #define PCI_INTEL_BXT_FUNC_PMU_PWR 4
48 #define PCI_INTEL_BXT_STATE_D0 0
49 #define PCI_INTEL_BXT_STATE_D3 3
52 * struct dwc3_pci - Driver private structure
53 * @dwc3: child dwc3 platform_device
54 * @pci: our link to PCI bus
56 * @has_dsm_for_pm: true for devices which need to run _DSM on runtime PM
59 struct platform_device *dwc3;
64 unsigned int has_dsm_for_pm:1;
67 static const struct acpi_gpio_params reset_gpios = { 0, 0, false };
68 static const struct acpi_gpio_params cs_gpios = { 1, 0, false };
70 static const struct acpi_gpio_mapping acpi_dwc3_byt_gpios[] = {
71 { "reset-gpios", &reset_gpios, 1 },
72 { "cs-gpios", &cs_gpios, 1 },
76 static int dwc3_pci_quirks(struct dwc3_pci *dwc)
78 struct platform_device *dwc3 = dwc->dwc3;
79 struct pci_dev *pdev = dwc->pci;
81 if (pdev->vendor == PCI_VENDOR_ID_AMD &&
82 pdev->device == PCI_DEVICE_ID_AMD_NL_USB) {
83 struct property_entry properties[] = {
84 PROPERTY_ENTRY_BOOL("snps,has-lpm-erratum"),
85 PROPERTY_ENTRY_U8("snps,lpm-nyet-threshold", 0xf),
86 PROPERTY_ENTRY_BOOL("snps,u2exit_lfps_quirk"),
87 PROPERTY_ENTRY_BOOL("snps,u2ss_inp3_quirk"),
88 PROPERTY_ENTRY_BOOL("snps,req_p1p2p3_quirk"),
89 PROPERTY_ENTRY_BOOL("snps,del_p1p2p3_quirk"),
90 PROPERTY_ENTRY_BOOL("snps,del_phy_power_chg_quirk"),
91 PROPERTY_ENTRY_BOOL("snps,lfps_filter_quirk"),
92 PROPERTY_ENTRY_BOOL("snps,rx_detect_poll_quirk"),
93 PROPERTY_ENTRY_BOOL("snps,tx_de_emphasis_quirk"),
94 PROPERTY_ENTRY_U8("snps,tx_de_emphasis", 1),
96 * FIXME these quirks should be removed when AMD NL
99 PROPERTY_ENTRY_BOOL("snps,disable_scramble_quirk"),
100 PROPERTY_ENTRY_BOOL("snps,dis_u3_susphy_quirk"),
101 PROPERTY_ENTRY_BOOL("snps,dis_u2_susphy_quirk"),
102 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
106 return platform_device_add_properties(dwc3, properties);
109 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
112 struct property_entry properties[] = {
113 PROPERTY_ENTRY_STRING("dr_mode", "peripheral"),
114 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
118 ret = platform_device_add_properties(dwc3, properties);
122 if (pdev->device == PCI_DEVICE_ID_INTEL_BXT ||
123 pdev->device == PCI_DEVICE_ID_INTEL_BXT_M) {
124 guid_parse(PCI_INTEL_BXT_DSM_GUID, &dwc->guid);
125 dwc->has_dsm_for_pm = true;
128 if (pdev->device == PCI_DEVICE_ID_INTEL_BYT) {
129 struct gpio_desc *gpio;
131 ret = devm_acpi_dev_add_driver_gpios(&pdev->dev,
132 acpi_dwc3_byt_gpios);
134 dev_dbg(&pdev->dev, "failed to add mapping table\n");
137 * These GPIOs will turn on the USB2 PHY. Note that we have to
138 * put the gpio descriptors again here because the phy driver
139 * might want to grab them, too.
141 gpio = gpiod_get_optional(&pdev->dev, "cs", GPIOD_OUT_LOW);
143 return PTR_ERR(gpio);
145 gpiod_set_value_cansleep(gpio, 1);
148 gpio = gpiod_get_optional(&pdev->dev, "reset", GPIOD_OUT_LOW);
150 return PTR_ERR(gpio);
153 gpiod_set_value_cansleep(gpio, 1);
155 usleep_range(10000, 11000);
160 if (pdev->vendor == PCI_VENDOR_ID_SYNOPSYS &&
161 (pdev->device == PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3 ||
162 pdev->device == PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3_AXI ||
163 pdev->device == PCI_DEVICE_ID_SYNOPSYS_HAPSUSB31)) {
164 struct property_entry properties[] = {
165 PROPERTY_ENTRY_BOOL("snps,usb3_lpm_capable"),
166 PROPERTY_ENTRY_BOOL("snps,has-lpm-erratum"),
167 PROPERTY_ENTRY_BOOL("snps,dis_enblslpm_quirk"),
168 PROPERTY_ENTRY_BOOL("linux,sysdev_is_parent"),
172 return platform_device_add_properties(dwc3, properties);
178 static int dwc3_pci_probe(struct pci_dev *pci,
179 const struct pci_device_id *id)
181 struct dwc3_pci *dwc;
182 struct resource res[2];
184 struct device *dev = &pci->dev;
186 ret = pcim_enable_device(pci);
188 dev_err(dev, "failed to enable pci device\n");
194 dwc = devm_kzalloc(dev, sizeof(*dwc), GFP_KERNEL);
198 dwc->dwc3 = platform_device_alloc("dwc3", PLATFORM_DEVID_AUTO);
202 memset(res, 0x00, sizeof(struct resource) * ARRAY_SIZE(res));
204 res[0].start = pci_resource_start(pci, 0);
205 res[0].end = pci_resource_end(pci, 0);
206 res[0].name = "dwc_usb3";
207 res[0].flags = IORESOURCE_MEM;
209 res[1].start = pci->irq;
210 res[1].name = "dwc_usb3";
211 res[1].flags = IORESOURCE_IRQ;
213 ret = platform_device_add_resources(dwc->dwc3, res, ARRAY_SIZE(res));
215 dev_err(dev, "couldn't add resources to dwc3 device\n");
220 dwc->dwc3->dev.parent = dev;
221 ACPI_COMPANION_SET(&dwc->dwc3->dev, ACPI_COMPANION(dev));
223 ret = dwc3_pci_quirks(dwc);
227 ret = platform_device_add(dwc->dwc3);
229 dev_err(dev, "failed to register dwc3 device\n");
233 device_init_wakeup(dev, true);
234 pci_set_drvdata(pci, dwc);
239 platform_device_put(dwc->dwc3);
243 static void dwc3_pci_remove(struct pci_dev *pci)
245 struct dwc3_pci *dwc = pci_get_drvdata(pci);
247 device_init_wakeup(&pci->dev, false);
248 pm_runtime_get(&pci->dev);
249 platform_device_unregister(dwc->dwc3);
252 static const struct pci_device_id dwc3_pci_id_table[] = {
254 PCI_DEVICE(PCI_VENDOR_ID_SYNOPSYS,
255 PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3),
258 PCI_DEVICE(PCI_VENDOR_ID_SYNOPSYS,
259 PCI_DEVICE_ID_SYNOPSYS_HAPSUSB3_AXI),
262 PCI_DEVICE(PCI_VENDOR_ID_SYNOPSYS,
263 PCI_DEVICE_ID_SYNOPSYS_HAPSUSB31),
265 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BSW), },
266 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BYT), },
267 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_MRFLD), },
268 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SPTLP), },
269 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SPTH), },
270 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BXT), },
271 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BXT_M), },
272 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_APL), },
273 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_KBP), },
274 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_GLK), },
275 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CNPLP), },
276 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CNPH), },
277 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICLLP), },
278 { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_NL_USB), },
279 { } /* Terminating Entry */
281 MODULE_DEVICE_TABLE(pci, dwc3_pci_id_table);
283 #if defined(CONFIG_PM) || defined(CONFIG_PM_SLEEP)
284 static int dwc3_pci_dsm(struct dwc3_pci *dwc, int param)
286 union acpi_object *obj;
287 union acpi_object tmp;
288 union acpi_object argv4 = ACPI_INIT_DSM_ARGV4(1, &tmp);
290 if (!dwc->has_dsm_for_pm)
293 tmp.type = ACPI_TYPE_INTEGER;
294 tmp.integer.value = param;
296 obj = acpi_evaluate_dsm(ACPI_HANDLE(&dwc->pci->dev), &dwc->guid,
297 1, PCI_INTEL_BXT_FUNC_PMU_PWR, &argv4);
299 dev_err(&dwc->pci->dev, "failed to evaluate _DSM\n");
307 #endif /* CONFIG_PM || CONFIG_PM_SLEEP */
310 static int dwc3_pci_runtime_suspend(struct device *dev)
312 struct dwc3_pci *dwc = dev_get_drvdata(dev);
314 if (device_can_wakeup(dev))
315 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
320 static int dwc3_pci_runtime_resume(struct device *dev)
322 struct dwc3_pci *dwc = dev_get_drvdata(dev);
323 struct platform_device *dwc3 = dwc->dwc3;
326 ret = dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
330 return pm_runtime_get(&dwc3->dev);
332 #endif /* CONFIG_PM */
334 #ifdef CONFIG_PM_SLEEP
335 static int dwc3_pci_suspend(struct device *dev)
337 struct dwc3_pci *dwc = dev_get_drvdata(dev);
339 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D3);
342 static int dwc3_pci_resume(struct device *dev)
344 struct dwc3_pci *dwc = dev_get_drvdata(dev);
346 return dwc3_pci_dsm(dwc, PCI_INTEL_BXT_STATE_D0);
348 #endif /* CONFIG_PM_SLEEP */
350 static const struct dev_pm_ops dwc3_pci_dev_pm_ops = {
351 SET_SYSTEM_SLEEP_PM_OPS(dwc3_pci_suspend, dwc3_pci_resume)
352 SET_RUNTIME_PM_OPS(dwc3_pci_runtime_suspend, dwc3_pci_runtime_resume,
356 static struct pci_driver dwc3_pci_driver = {
358 .id_table = dwc3_pci_id_table,
359 .probe = dwc3_pci_probe,
360 .remove = dwc3_pci_remove,
362 .pm = &dwc3_pci_dev_pm_ops,
366 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
367 MODULE_LICENSE("GPL v2");
368 MODULE_DESCRIPTION("DesignWare USB3 PCI Glue Layer");
370 module_pci_driver(dwc3_pci_driver);