xref: /openbmc/linux/drivers/usb/dwc2/pci.c (revision b9b77222)
1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
2 /*
3  * pci.c - DesignWare HS OTG Controller PCI driver
4  *
5  * Copyright (C) 2004-2013 Synopsys, Inc.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The names of the above-listed copyright holders may not be used
17  *    to endorse or promote products derived from this software without
18  *    specific prior written permission.
19  *
20  * ALTERNATIVELY, this software may be distributed under the terms of the
21  * GNU General Public License ("GPL") as published by the Free Software
22  * Foundation; either version 2 of the License, or (at your option) any
23  * later version.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * Provides the initialization and cleanup entry points for the DWC_otg PCI
40  * driver
41  */
42 #include <linux/kernel.h>
43 #include <linux/module.h>
44 #include <linux/moduleparam.h>
45 #include <linux/spinlock.h>
46 #include <linux/interrupt.h>
47 #include <linux/io.h>
48 #include <linux/slab.h>
49 #include <linux/pci.h>
50 #include <linux/usb.h>
51 
52 #include <linux/usb/hcd.h>
53 #include <linux/usb/ch11.h>
54 #include <linux/platform_device.h>
55 #include <linux/usb/usb_phy_generic.h>
56 
57 #define PCI_PRODUCT_ID_HAPS_HSOTG	0xabc0
58 
59 static const char dwc2_driver_name[] = "dwc2-pci";
60 
61 struct dwc2_pci_glue {
62 	struct platform_device *dwc2;
63 	struct platform_device *phy;
64 };
65 
66 static int dwc2_pci_quirks(struct pci_dev *pdev, struct platform_device *dwc2)
67 {
68 	if (pdev->vendor == PCI_VENDOR_ID_SYNOPSYS &&
69 	    pdev->device == PCI_PRODUCT_ID_HAPS_HSOTG) {
70 		struct property_entry properties[] = {
71 			{ },
72 		};
73 
74 		return platform_device_add_properties(dwc2, properties);
75 	}
76 
77 	return 0;
78 }
79 
80 /**
81  * dwc2_pci_probe() - Provides the cleanup entry points for the DWC_otg PCI
82  * driver
83  *
84  * @pci: The programming view of DWC_otg PCI
85  */
86 static void dwc2_pci_remove(struct pci_dev *pci)
87 {
88 	struct dwc2_pci_glue *glue = pci_get_drvdata(pci);
89 
90 	platform_device_unregister(glue->dwc2);
91 	usb_phy_generic_unregister(glue->phy);
92 	pci_set_drvdata(pci, NULL);
93 }
94 
95 static int dwc2_pci_probe(struct pci_dev *pci,
96 			  const struct pci_device_id *id)
97 {
98 	struct resource		res[2];
99 	struct platform_device	*dwc2;
100 	struct platform_device	*phy;
101 	int			ret;
102 	struct device		*dev = &pci->dev;
103 	struct dwc2_pci_glue	*glue;
104 
105 	ret = pcim_enable_device(pci);
106 	if (ret) {
107 		dev_err(dev, "failed to enable pci device\n");
108 		return -ENODEV;
109 	}
110 
111 	pci_set_master(pci);
112 
113 	phy = usb_phy_generic_register();
114 	if (IS_ERR(phy)) {
115 		dev_err(dev, "error registering generic PHY (%ld)\n",
116 			PTR_ERR(phy));
117 		return PTR_ERR(phy);
118 	}
119 
120 	dwc2 = platform_device_alloc("dwc2", PLATFORM_DEVID_AUTO);
121 	if (!dwc2) {
122 		dev_err(dev, "couldn't allocate dwc2 device\n");
123 		goto err;
124 	}
125 
126 	memset(res, 0x00, sizeof(struct resource) * ARRAY_SIZE(res));
127 
128 	res[0].start	= pci_resource_start(pci, 0);
129 	res[0].end	= pci_resource_end(pci, 0);
130 	res[0].name	= "dwc2";
131 	res[0].flags	= IORESOURCE_MEM;
132 
133 	res[1].start	= pci->irq;
134 	res[1].name	= "dwc2";
135 	res[1].flags	= IORESOURCE_IRQ;
136 
137 	ret = platform_device_add_resources(dwc2, res, ARRAY_SIZE(res));
138 	if (ret) {
139 		dev_err(dev, "couldn't add resources to dwc2 device\n");
140 		goto err;
141 	}
142 
143 	dwc2->dev.parent = dev;
144 
145 	ret = dwc2_pci_quirks(pci, dwc2);
146 	if (ret)
147 		goto err;
148 
149 	glue = devm_kzalloc(dev, sizeof(*glue), GFP_KERNEL);
150 	if (!glue) {
151 		ret = -ENOMEM;
152 		goto err;
153 	}
154 
155 	ret = platform_device_add(dwc2);
156 	if (ret) {
157 		dev_err(dev, "failed to register dwc2 device\n");
158 		goto err;
159 	}
160 
161 	glue->phy = phy;
162 	glue->dwc2 = dwc2;
163 	pci_set_drvdata(pci, glue);
164 
165 	return 0;
166 err:
167 	usb_phy_generic_unregister(phy);
168 	platform_device_put(dwc2);
169 	return ret;
170 }
171 
172 static const struct pci_device_id dwc2_pci_ids[] = {
173 	{
174 		PCI_DEVICE(PCI_VENDOR_ID_SYNOPSYS, PCI_PRODUCT_ID_HAPS_HSOTG),
175 	},
176 	{
177 		PCI_DEVICE(PCI_VENDOR_ID_STMICRO,
178 			   PCI_DEVICE_ID_STMICRO_USB_OTG),
179 	},
180 	{ /* end: all zeroes */ }
181 };
182 MODULE_DEVICE_TABLE(pci, dwc2_pci_ids);
183 
184 static struct pci_driver dwc2_pci_driver = {
185 	.name = dwc2_driver_name,
186 	.id_table = dwc2_pci_ids,
187 	.probe = dwc2_pci_probe,
188 	.remove = dwc2_pci_remove,
189 };
190 
191 module_pci_driver(dwc2_pci_driver);
192 
193 MODULE_DESCRIPTION("DESIGNWARE HS OTG PCI Bus Glue");
194 MODULE_AUTHOR("Synopsys, Inc.");
195 MODULE_LICENSE("Dual BSD/GPL");
196