xref: /OK3568_Linux_fs/kernel/drivers/usb/isp1760/isp1760-if.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Glue code for the ISP1760 driver and bus
4*4882a593Smuzhiyun  * Currently there is support for
5*4882a593Smuzhiyun  * - OpenFirmware
6*4882a593Smuzhiyun  * - PCI
7*4882a593Smuzhiyun  * - PDEV (generic platform device centralized driver model)
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * (c) 2007 Sebastian Siewior <bigeasy@linutronix.de>
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  */
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/usb.h>
14*4882a593Smuzhiyun #include <linux/io.h>
15*4882a593Smuzhiyun #include <linux/module.h>
16*4882a593Smuzhiyun #include <linux/of.h>
17*4882a593Smuzhiyun #include <linux/platform_device.h>
18*4882a593Smuzhiyun #include <linux/slab.h>
19*4882a593Smuzhiyun #include <linux/usb/isp1760.h>
20*4882a593Smuzhiyun #include <linux/usb/hcd.h>
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #include "isp1760-core.h"
23*4882a593Smuzhiyun #include "isp1760-regs.h"
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #ifdef CONFIG_USB_PCI
26*4882a593Smuzhiyun #include <linux/pci.h>
27*4882a593Smuzhiyun #endif
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #ifdef CONFIG_USB_PCI
isp1761_pci_init(struct pci_dev * dev)30*4882a593Smuzhiyun static int isp1761_pci_init(struct pci_dev *dev)
31*4882a593Smuzhiyun {
32*4882a593Smuzhiyun 	resource_size_t mem_start;
33*4882a593Smuzhiyun 	resource_size_t mem_length;
34*4882a593Smuzhiyun 	u8 __iomem *iobase;
35*4882a593Smuzhiyun 	u8 latency, limit;
36*4882a593Smuzhiyun 	int retry_count;
37*4882a593Smuzhiyun 	u32 reg_data;
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 	/* Grab the PLX PCI shared memory of the ISP 1761 we need  */
40*4882a593Smuzhiyun 	mem_start = pci_resource_start(dev, 3);
41*4882a593Smuzhiyun 	mem_length = pci_resource_len(dev, 3);
42*4882a593Smuzhiyun 	if (mem_length < 0xffff) {
43*4882a593Smuzhiyun 		printk(KERN_ERR "memory length for this resource is wrong\n");
44*4882a593Smuzhiyun 		return -ENOMEM;
45*4882a593Smuzhiyun 	}
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	if (!request_mem_region(mem_start, mem_length, "ISP-PCI")) {
48*4882a593Smuzhiyun 		printk(KERN_ERR "host controller already in use\n");
49*4882a593Smuzhiyun 		return -EBUSY;
50*4882a593Smuzhiyun 	}
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	/* map available memory */
53*4882a593Smuzhiyun 	iobase = ioremap(mem_start, mem_length);
54*4882a593Smuzhiyun 	if (!iobase) {
55*4882a593Smuzhiyun 		printk(KERN_ERR "Error ioremap failed\n");
56*4882a593Smuzhiyun 		release_mem_region(mem_start, mem_length);
57*4882a593Smuzhiyun 		return -ENOMEM;
58*4882a593Smuzhiyun 	}
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	/* bad pci latencies can contribute to overruns */
61*4882a593Smuzhiyun 	pci_read_config_byte(dev, PCI_LATENCY_TIMER, &latency);
62*4882a593Smuzhiyun 	if (latency) {
63*4882a593Smuzhiyun 		pci_read_config_byte(dev, PCI_MAX_LAT, &limit);
64*4882a593Smuzhiyun 		if (limit && limit < latency)
65*4882a593Smuzhiyun 			pci_write_config_byte(dev, PCI_LATENCY_TIMER, limit);
66*4882a593Smuzhiyun 	}
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	/* Try to check whether we can access Scratch Register of
69*4882a593Smuzhiyun 	 * Host Controller or not. The initial PCI access is retried until
70*4882a593Smuzhiyun 	 * local init for the PCI bridge is completed
71*4882a593Smuzhiyun 	 */
72*4882a593Smuzhiyun 	retry_count = 20;
73*4882a593Smuzhiyun 	reg_data = 0;
74*4882a593Smuzhiyun 	while ((reg_data != 0xFACE) && retry_count) {
75*4882a593Smuzhiyun 		/*by default host is in 16bit mode, so
76*4882a593Smuzhiyun 		 * io operations at this stage must be 16 bit
77*4882a593Smuzhiyun 		 * */
78*4882a593Smuzhiyun 		writel(0xface, iobase + HC_SCRATCH_REG);
79*4882a593Smuzhiyun 		udelay(100);
80*4882a593Smuzhiyun 		reg_data = readl(iobase + HC_SCRATCH_REG) & 0x0000ffff;
81*4882a593Smuzhiyun 		retry_count--;
82*4882a593Smuzhiyun 	}
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	iounmap(iobase);
85*4882a593Smuzhiyun 	release_mem_region(mem_start, mem_length);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	/* Host Controller presence is detected by writing to scratch register
88*4882a593Smuzhiyun 	 * and reading back and checking the contents are same or not
89*4882a593Smuzhiyun 	 */
90*4882a593Smuzhiyun 	if (reg_data != 0xFACE) {
91*4882a593Smuzhiyun 		dev_err(&dev->dev, "scratch register mismatch %x\n", reg_data);
92*4882a593Smuzhiyun 		return -ENOMEM;
93*4882a593Smuzhiyun 	}
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	/* Grab the PLX PCI mem maped port start address we need  */
96*4882a593Smuzhiyun 	mem_start = pci_resource_start(dev, 0);
97*4882a593Smuzhiyun 	mem_length = pci_resource_len(dev, 0);
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	if (!request_mem_region(mem_start, mem_length, "ISP1761 IO MEM")) {
100*4882a593Smuzhiyun 		printk(KERN_ERR "request region #1\n");
101*4882a593Smuzhiyun 		return -EBUSY;
102*4882a593Smuzhiyun 	}
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	iobase = ioremap(mem_start, mem_length);
105*4882a593Smuzhiyun 	if (!iobase) {
106*4882a593Smuzhiyun 		printk(KERN_ERR "ioremap #1\n");
107*4882a593Smuzhiyun 		release_mem_region(mem_start, mem_length);
108*4882a593Smuzhiyun 		return -ENOMEM;
109*4882a593Smuzhiyun 	}
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	/* configure PLX PCI chip to pass interrupts */
112*4882a593Smuzhiyun #define PLX_INT_CSR_REG 0x68
113*4882a593Smuzhiyun 	reg_data = readl(iobase + PLX_INT_CSR_REG);
114*4882a593Smuzhiyun 	reg_data |= 0x900;
115*4882a593Smuzhiyun 	writel(reg_data, iobase + PLX_INT_CSR_REG);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	/* done with PLX IO access */
118*4882a593Smuzhiyun 	iounmap(iobase);
119*4882a593Smuzhiyun 	release_mem_region(mem_start, mem_length);
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	return 0;
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun 
isp1761_pci_probe(struct pci_dev * dev,const struct pci_device_id * id)124*4882a593Smuzhiyun static int isp1761_pci_probe(struct pci_dev *dev,
125*4882a593Smuzhiyun 		const struct pci_device_id *id)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun 	unsigned int devflags = 0;
128*4882a593Smuzhiyun 	int ret;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	if (!dev->irq)
131*4882a593Smuzhiyun 		return -ENODEV;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	if (pci_enable_device(dev) < 0)
134*4882a593Smuzhiyun 		return -ENODEV;
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	ret = isp1761_pci_init(dev);
137*4882a593Smuzhiyun 	if (ret < 0)
138*4882a593Smuzhiyun 		goto error;
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	pci_set_master(dev);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	ret = isp1760_register(&dev->resource[3], dev->irq, 0, &dev->dev,
143*4882a593Smuzhiyun 			       devflags);
144*4882a593Smuzhiyun 	if (ret < 0)
145*4882a593Smuzhiyun 		goto error;
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	return 0;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun error:
150*4882a593Smuzhiyun 	pci_disable_device(dev);
151*4882a593Smuzhiyun 	return ret;
152*4882a593Smuzhiyun }
153*4882a593Smuzhiyun 
isp1761_pci_remove(struct pci_dev * dev)154*4882a593Smuzhiyun static void isp1761_pci_remove(struct pci_dev *dev)
155*4882a593Smuzhiyun {
156*4882a593Smuzhiyun 	isp1760_unregister(&dev->dev);
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 	pci_disable_device(dev);
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun 
isp1761_pci_shutdown(struct pci_dev * dev)161*4882a593Smuzhiyun static void isp1761_pci_shutdown(struct pci_dev *dev)
162*4882a593Smuzhiyun {
163*4882a593Smuzhiyun 	printk(KERN_ERR "ips1761_pci_shutdown\n");
164*4882a593Smuzhiyun }
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun static const struct pci_device_id isp1760_plx[] = {
167*4882a593Smuzhiyun 	{
168*4882a593Smuzhiyun 		.class          = PCI_CLASS_BRIDGE_OTHER << 8,
169*4882a593Smuzhiyun 		.class_mask     = ~0,
170*4882a593Smuzhiyun 		.vendor		= PCI_VENDOR_ID_PLX,
171*4882a593Smuzhiyun 		.device		= 0x5406,
172*4882a593Smuzhiyun 		.subvendor	= PCI_VENDOR_ID_PLX,
173*4882a593Smuzhiyun 		.subdevice	= 0x9054,
174*4882a593Smuzhiyun 	},
175*4882a593Smuzhiyun 	{ }
176*4882a593Smuzhiyun };
177*4882a593Smuzhiyun MODULE_DEVICE_TABLE(pci, isp1760_plx);
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun static struct pci_driver isp1761_pci_driver = {
180*4882a593Smuzhiyun 	.name =         "isp1760",
181*4882a593Smuzhiyun 	.id_table =     isp1760_plx,
182*4882a593Smuzhiyun 	.probe =        isp1761_pci_probe,
183*4882a593Smuzhiyun 	.remove =       isp1761_pci_remove,
184*4882a593Smuzhiyun 	.shutdown =     isp1761_pci_shutdown,
185*4882a593Smuzhiyun };
186*4882a593Smuzhiyun #endif
187*4882a593Smuzhiyun 
isp1760_plat_probe(struct platform_device * pdev)188*4882a593Smuzhiyun static int isp1760_plat_probe(struct platform_device *pdev)
189*4882a593Smuzhiyun {
190*4882a593Smuzhiyun 	unsigned long irqflags;
191*4882a593Smuzhiyun 	unsigned int devflags = 0;
192*4882a593Smuzhiyun 	struct resource *mem_res;
193*4882a593Smuzhiyun 	struct resource *irq_res;
194*4882a593Smuzhiyun 	int ret;
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 	mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 	irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
199*4882a593Smuzhiyun 	if (!irq_res) {
200*4882a593Smuzhiyun 		pr_warn("isp1760: IRQ resource not available\n");
201*4882a593Smuzhiyun 		return -ENODEV;
202*4882a593Smuzhiyun 	}
203*4882a593Smuzhiyun 	irqflags = irq_res->flags & IRQF_TRIGGER_MASK;
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	if (IS_ENABLED(CONFIG_OF) && pdev->dev.of_node) {
206*4882a593Smuzhiyun 		struct device_node *dp = pdev->dev.of_node;
207*4882a593Smuzhiyun 		u32 bus_width = 0;
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 		if (of_device_is_compatible(dp, "nxp,usb-isp1761"))
210*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_ISP1761;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 		/* Some systems wire up only 16 of the 32 data lines */
213*4882a593Smuzhiyun 		of_property_read_u32(dp, "bus-width", &bus_width);
214*4882a593Smuzhiyun 		if (bus_width == 16)
215*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_BUS_WIDTH_16;
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 		if (of_property_read_bool(dp, "port1-otg"))
218*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_OTG_EN;
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 		if (of_property_read_bool(dp, "analog-oc"))
221*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_ANALOG_OC;
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 		if (of_property_read_bool(dp, "dack-polarity"))
224*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_DACK_POL_HIGH;
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun 		if (of_property_read_bool(dp, "dreq-polarity"))
227*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_DREQ_POL_HIGH;
228*4882a593Smuzhiyun 	} else if (dev_get_platdata(&pdev->dev)) {
229*4882a593Smuzhiyun 		struct isp1760_platform_data *pdata =
230*4882a593Smuzhiyun 			dev_get_platdata(&pdev->dev);
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 		if (pdata->is_isp1761)
233*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_ISP1761;
234*4882a593Smuzhiyun 		if (pdata->bus_width_16)
235*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_BUS_WIDTH_16;
236*4882a593Smuzhiyun 		if (pdata->port1_otg)
237*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_OTG_EN;
238*4882a593Smuzhiyun 		if (pdata->analog_oc)
239*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_ANALOG_OC;
240*4882a593Smuzhiyun 		if (pdata->dack_polarity_high)
241*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_DACK_POL_HIGH;
242*4882a593Smuzhiyun 		if (pdata->dreq_polarity_high)
243*4882a593Smuzhiyun 			devflags |= ISP1760_FLAG_DREQ_POL_HIGH;
244*4882a593Smuzhiyun 	}
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 	ret = isp1760_register(mem_res, irq_res->start, irqflags, &pdev->dev,
247*4882a593Smuzhiyun 			       devflags);
248*4882a593Smuzhiyun 	if (ret < 0)
249*4882a593Smuzhiyun 		return ret;
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun 	pr_info("ISP1760 USB device initialised\n");
252*4882a593Smuzhiyun 	return 0;
253*4882a593Smuzhiyun }
254*4882a593Smuzhiyun 
isp1760_plat_remove(struct platform_device * pdev)255*4882a593Smuzhiyun static int isp1760_plat_remove(struct platform_device *pdev)
256*4882a593Smuzhiyun {
257*4882a593Smuzhiyun 	isp1760_unregister(&pdev->dev);
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun 	return 0;
260*4882a593Smuzhiyun }
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun #ifdef CONFIG_OF
263*4882a593Smuzhiyun static const struct of_device_id isp1760_of_match[] = {
264*4882a593Smuzhiyun 	{ .compatible = "nxp,usb-isp1760", },
265*4882a593Smuzhiyun 	{ .compatible = "nxp,usb-isp1761", },
266*4882a593Smuzhiyun 	{ },
267*4882a593Smuzhiyun };
268*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, isp1760_of_match);
269*4882a593Smuzhiyun #endif
270*4882a593Smuzhiyun 
271*4882a593Smuzhiyun static struct platform_driver isp1760_plat_driver = {
272*4882a593Smuzhiyun 	.probe	= isp1760_plat_probe,
273*4882a593Smuzhiyun 	.remove	= isp1760_plat_remove,
274*4882a593Smuzhiyun 	.driver	= {
275*4882a593Smuzhiyun 		.name	= "isp1760",
276*4882a593Smuzhiyun 		.of_match_table = of_match_ptr(isp1760_of_match),
277*4882a593Smuzhiyun 	},
278*4882a593Smuzhiyun };
279*4882a593Smuzhiyun 
isp1760_init(void)280*4882a593Smuzhiyun static int __init isp1760_init(void)
281*4882a593Smuzhiyun {
282*4882a593Smuzhiyun 	int ret, any_ret = -ENODEV;
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun 	isp1760_init_kmem_once();
285*4882a593Smuzhiyun 
286*4882a593Smuzhiyun 	ret = platform_driver_register(&isp1760_plat_driver);
287*4882a593Smuzhiyun 	if (!ret)
288*4882a593Smuzhiyun 		any_ret = 0;
289*4882a593Smuzhiyun #ifdef CONFIG_USB_PCI
290*4882a593Smuzhiyun 	ret = pci_register_driver(&isp1761_pci_driver);
291*4882a593Smuzhiyun 	if (!ret)
292*4882a593Smuzhiyun 		any_ret = 0;
293*4882a593Smuzhiyun #endif
294*4882a593Smuzhiyun 
295*4882a593Smuzhiyun 	if (any_ret)
296*4882a593Smuzhiyun 		isp1760_deinit_kmem_cache();
297*4882a593Smuzhiyun 	return any_ret;
298*4882a593Smuzhiyun }
299*4882a593Smuzhiyun module_init(isp1760_init);
300*4882a593Smuzhiyun 
isp1760_exit(void)301*4882a593Smuzhiyun static void __exit isp1760_exit(void)
302*4882a593Smuzhiyun {
303*4882a593Smuzhiyun 	platform_driver_unregister(&isp1760_plat_driver);
304*4882a593Smuzhiyun #ifdef CONFIG_USB_PCI
305*4882a593Smuzhiyun 	pci_unregister_driver(&isp1761_pci_driver);
306*4882a593Smuzhiyun #endif
307*4882a593Smuzhiyun 	isp1760_deinit_kmem_cache();
308*4882a593Smuzhiyun }
309*4882a593Smuzhiyun module_exit(isp1760_exit);
310