xref: /OK3568_Linux_fs/kernel/drivers/usb/gadget/udc/snps_udc_plat.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * snps_udc_plat.c - Synopsys UDC Platform Driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2016 Broadcom
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/extcon.h>
9*4882a593Smuzhiyun #include <linux/of_address.h>
10*4882a593Smuzhiyun #include <linux/of_irq.h>
11*4882a593Smuzhiyun #include <linux/of_gpio.h>
12*4882a593Smuzhiyun #include <linux/platform_device.h>
13*4882a593Smuzhiyun #include <linux/phy/phy.h>
14*4882a593Smuzhiyun #include <linux/module.h>
15*4882a593Smuzhiyun #include <linux/dmapool.h>
16*4882a593Smuzhiyun #include <linux/interrupt.h>
17*4882a593Smuzhiyun #include <linux/moduleparam.h>
18*4882a593Smuzhiyun #include "amd5536udc.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /* description */
21*4882a593Smuzhiyun #define UDC_MOD_DESCRIPTION     "Synopsys UDC platform driver"
22*4882a593Smuzhiyun 
start_udc(struct udc * udc)23*4882a593Smuzhiyun static void start_udc(struct udc *udc)
24*4882a593Smuzhiyun {
25*4882a593Smuzhiyun 	if (udc->driver) {
26*4882a593Smuzhiyun 		dev_info(udc->dev, "Connecting...\n");
27*4882a593Smuzhiyun 		udc_enable_dev_setup_interrupts(udc);
28*4882a593Smuzhiyun 		udc_basic_init(udc);
29*4882a593Smuzhiyun 		udc->connected = 1;
30*4882a593Smuzhiyun 	}
31*4882a593Smuzhiyun }
32*4882a593Smuzhiyun 
stop_udc(struct udc * udc)33*4882a593Smuzhiyun static void stop_udc(struct udc *udc)
34*4882a593Smuzhiyun {
35*4882a593Smuzhiyun 	int tmp;
36*4882a593Smuzhiyun 	u32 reg;
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	spin_lock(&udc->lock);
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	/* Flush the receieve fifo */
41*4882a593Smuzhiyun 	reg = readl(&udc->regs->ctl);
42*4882a593Smuzhiyun 	reg |= AMD_BIT(UDC_DEVCTL_SRX_FLUSH);
43*4882a593Smuzhiyun 	writel(reg, &udc->regs->ctl);
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	reg = readl(&udc->regs->ctl);
46*4882a593Smuzhiyun 	reg &= ~(AMD_BIT(UDC_DEVCTL_SRX_FLUSH));
47*4882a593Smuzhiyun 	writel(reg, &udc->regs->ctl);
48*4882a593Smuzhiyun 	dev_dbg(udc->dev, "ep rx queue flushed\n");
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun 	/* Mask interrupts. Required more so when the
51*4882a593Smuzhiyun 	 * UDC is connected to a DRD phy.
52*4882a593Smuzhiyun 	 */
53*4882a593Smuzhiyun 	udc_mask_unused_interrupts(udc);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	/* Disconnect gadget driver */
56*4882a593Smuzhiyun 	if (udc->driver) {
57*4882a593Smuzhiyun 		spin_unlock(&udc->lock);
58*4882a593Smuzhiyun 		udc->driver->disconnect(&udc->gadget);
59*4882a593Smuzhiyun 		spin_lock(&udc->lock);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 		/* empty queues */
62*4882a593Smuzhiyun 		for (tmp = 0; tmp < UDC_EP_NUM; tmp++)
63*4882a593Smuzhiyun 			empty_req_queue(&udc->ep[tmp]);
64*4882a593Smuzhiyun 	}
65*4882a593Smuzhiyun 	udc->connected = 0;
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	spin_unlock(&udc->lock);
68*4882a593Smuzhiyun 	dev_info(udc->dev, "Device disconnected\n");
69*4882a593Smuzhiyun }
70*4882a593Smuzhiyun 
udc_drd_work(struct work_struct * work)71*4882a593Smuzhiyun static void udc_drd_work(struct work_struct *work)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun 	struct udc *udc;
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 	udc = container_of(to_delayed_work(work),
76*4882a593Smuzhiyun 			   struct udc, drd_work);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	if (udc->conn_type) {
79*4882a593Smuzhiyun 		dev_dbg(udc->dev, "idle -> device\n");
80*4882a593Smuzhiyun 		start_udc(udc);
81*4882a593Smuzhiyun 	} else {
82*4882a593Smuzhiyun 		dev_dbg(udc->dev, "device -> idle\n");
83*4882a593Smuzhiyun 		stop_udc(udc);
84*4882a593Smuzhiyun 	}
85*4882a593Smuzhiyun }
86*4882a593Smuzhiyun 
usbd_connect_notify(struct notifier_block * self,unsigned long event,void * ptr)87*4882a593Smuzhiyun static int usbd_connect_notify(struct notifier_block *self,
88*4882a593Smuzhiyun 			       unsigned long event, void *ptr)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun 	struct udc *udc = container_of(self, struct udc, nb);
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	dev_dbg(udc->dev, "%s: event: %lu\n", __func__, event);
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	udc->conn_type = event;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	schedule_delayed_work(&udc->drd_work, 0);
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	return NOTIFY_OK;
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun 
udc_plat_probe(struct platform_device * pdev)101*4882a593Smuzhiyun static int udc_plat_probe(struct platform_device *pdev)
102*4882a593Smuzhiyun {
103*4882a593Smuzhiyun 	struct device *dev = &pdev->dev;
104*4882a593Smuzhiyun 	struct resource *res;
105*4882a593Smuzhiyun 	struct udc *udc;
106*4882a593Smuzhiyun 	int ret;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	udc = devm_kzalloc(dev, sizeof(*udc), GFP_KERNEL);
109*4882a593Smuzhiyun 	if (!udc)
110*4882a593Smuzhiyun 		return -ENOMEM;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	spin_lock_init(&udc->lock);
113*4882a593Smuzhiyun 	udc->dev = dev;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
116*4882a593Smuzhiyun 	udc->virt_addr = devm_ioremap_resource(dev, res);
117*4882a593Smuzhiyun 	if (IS_ERR(udc->virt_addr))
118*4882a593Smuzhiyun 		return PTR_ERR(udc->virt_addr);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	/* udc csr registers base */
121*4882a593Smuzhiyun 	udc->csr = udc->virt_addr + UDC_CSR_ADDR;
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	/* dev registers base */
124*4882a593Smuzhiyun 	udc->regs = udc->virt_addr + UDC_DEVCFG_ADDR;
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	/* ep registers base */
127*4882a593Smuzhiyun 	udc->ep_regs = udc->virt_addr + UDC_EPREGS_ADDR;
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	/* fifo's base */
130*4882a593Smuzhiyun 	udc->rxfifo = (u32 __iomem *)(udc->virt_addr + UDC_RXFIFO_ADDR);
131*4882a593Smuzhiyun 	udc->txfifo = (u32 __iomem *)(udc->virt_addr + UDC_TXFIFO_ADDR);
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	udc->phys_addr = (unsigned long)res->start;
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	udc->irq = irq_of_parse_and_map(dev->of_node, 0);
136*4882a593Smuzhiyun 	if (udc->irq <= 0) {
137*4882a593Smuzhiyun 		dev_err(dev, "Can't parse and map interrupt\n");
138*4882a593Smuzhiyun 		return -EINVAL;
139*4882a593Smuzhiyun 	}
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	udc->udc_phy = devm_of_phy_get_by_index(dev, dev->of_node, 0);
142*4882a593Smuzhiyun 	if (IS_ERR(udc->udc_phy)) {
143*4882a593Smuzhiyun 		dev_err(dev, "Failed to obtain phy from device tree\n");
144*4882a593Smuzhiyun 		return PTR_ERR(udc->udc_phy);
145*4882a593Smuzhiyun 	}
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	ret = phy_init(udc->udc_phy);
148*4882a593Smuzhiyun 	if (ret) {
149*4882a593Smuzhiyun 		dev_err(dev, "UDC phy init failed");
150*4882a593Smuzhiyun 		return ret;
151*4882a593Smuzhiyun 	}
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	ret = phy_power_on(udc->udc_phy);
154*4882a593Smuzhiyun 	if (ret) {
155*4882a593Smuzhiyun 		dev_err(dev, "UDC phy power on failed");
156*4882a593Smuzhiyun 		phy_exit(udc->udc_phy);
157*4882a593Smuzhiyun 		return ret;
158*4882a593Smuzhiyun 	}
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun 	/* Register for extcon if supported */
161*4882a593Smuzhiyun 	if (of_get_property(dev->of_node, "extcon", NULL)) {
162*4882a593Smuzhiyun 		udc->edev = extcon_get_edev_by_phandle(dev, 0);
163*4882a593Smuzhiyun 		if (IS_ERR(udc->edev)) {
164*4882a593Smuzhiyun 			if (PTR_ERR(udc->edev) == -EPROBE_DEFER)
165*4882a593Smuzhiyun 				return -EPROBE_DEFER;
166*4882a593Smuzhiyun 			dev_err(dev, "Invalid or missing extcon\n");
167*4882a593Smuzhiyun 			ret = PTR_ERR(udc->edev);
168*4882a593Smuzhiyun 			goto exit_phy;
169*4882a593Smuzhiyun 		}
170*4882a593Smuzhiyun 
171*4882a593Smuzhiyun 		udc->nb.notifier_call = usbd_connect_notify;
172*4882a593Smuzhiyun 		ret = extcon_register_notifier(udc->edev, EXTCON_USB,
173*4882a593Smuzhiyun 					       &udc->nb);
174*4882a593Smuzhiyun 		if (ret < 0) {
175*4882a593Smuzhiyun 			dev_err(dev, "Can't register extcon device\n");
176*4882a593Smuzhiyun 			goto exit_phy;
177*4882a593Smuzhiyun 		}
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 		ret = extcon_get_state(udc->edev, EXTCON_USB);
180*4882a593Smuzhiyun 		if (ret < 0) {
181*4882a593Smuzhiyun 			dev_err(dev, "Can't get cable state\n");
182*4882a593Smuzhiyun 			goto exit_extcon;
183*4882a593Smuzhiyun 		} else if (ret) {
184*4882a593Smuzhiyun 			udc->conn_type = ret;
185*4882a593Smuzhiyun 		}
186*4882a593Smuzhiyun 		INIT_DELAYED_WORK(&udc->drd_work, udc_drd_work);
187*4882a593Smuzhiyun 	}
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	/* init dma pools */
190*4882a593Smuzhiyun 	if (use_dma) {
191*4882a593Smuzhiyun 		ret = init_dma_pools(udc);
192*4882a593Smuzhiyun 		if (ret != 0)
193*4882a593Smuzhiyun 			goto exit_extcon;
194*4882a593Smuzhiyun 	}
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 	ret = devm_request_irq(dev, udc->irq, udc_irq, IRQF_SHARED,
197*4882a593Smuzhiyun 			       "snps-udc", udc);
198*4882a593Smuzhiyun 	if (ret < 0) {
199*4882a593Smuzhiyun 		dev_err(dev, "Request irq %d failed for UDC\n", udc->irq);
200*4882a593Smuzhiyun 		goto exit_dma;
201*4882a593Smuzhiyun 	}
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	platform_set_drvdata(pdev, udc);
204*4882a593Smuzhiyun 	udc->chiprev = UDC_BCM_REV;
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	if (udc_probe(udc)) {
207*4882a593Smuzhiyun 		ret = -ENODEV;
208*4882a593Smuzhiyun 		goto exit_dma;
209*4882a593Smuzhiyun 	}
210*4882a593Smuzhiyun 	dev_info(dev, "Synopsys UDC platform driver probe successful\n");
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	return 0;
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun exit_dma:
215*4882a593Smuzhiyun 	if (use_dma)
216*4882a593Smuzhiyun 		free_dma_pools(udc);
217*4882a593Smuzhiyun exit_extcon:
218*4882a593Smuzhiyun 	if (udc->edev)
219*4882a593Smuzhiyun 		extcon_unregister_notifier(udc->edev, EXTCON_USB, &udc->nb);
220*4882a593Smuzhiyun exit_phy:
221*4882a593Smuzhiyun 	if (udc->udc_phy) {
222*4882a593Smuzhiyun 		phy_power_off(udc->udc_phy);
223*4882a593Smuzhiyun 		phy_exit(udc->udc_phy);
224*4882a593Smuzhiyun 	}
225*4882a593Smuzhiyun 	return ret;
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun 
udc_plat_remove(struct platform_device * pdev)228*4882a593Smuzhiyun static int udc_plat_remove(struct platform_device *pdev)
229*4882a593Smuzhiyun {
230*4882a593Smuzhiyun 	struct udc *dev;
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 	dev = platform_get_drvdata(pdev);
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	usb_del_gadget_udc(&dev->gadget);
235*4882a593Smuzhiyun 	/* gadget driver must not be registered */
236*4882a593Smuzhiyun 	if (WARN_ON(dev->driver))
237*4882a593Smuzhiyun 		return 0;
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	/* dma pool cleanup */
240*4882a593Smuzhiyun 	free_dma_pools(dev);
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun 	udc_remove(dev);
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	platform_set_drvdata(pdev, NULL);
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 	if (dev->drd_wq) {
247*4882a593Smuzhiyun 		flush_workqueue(dev->drd_wq);
248*4882a593Smuzhiyun 		destroy_workqueue(dev->drd_wq);
249*4882a593Smuzhiyun 	}
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun 	phy_power_off(dev->udc_phy);
252*4882a593Smuzhiyun 	phy_exit(dev->udc_phy);
253*4882a593Smuzhiyun 	extcon_unregister_notifier(dev->edev, EXTCON_USB, &dev->nb);
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	dev_info(&pdev->dev, "Synopsys UDC platform driver removed\n");
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 	return 0;
258*4882a593Smuzhiyun }
259*4882a593Smuzhiyun 
260*4882a593Smuzhiyun #ifdef CONFIG_PM_SLEEP
udc_plat_suspend(struct device * dev)261*4882a593Smuzhiyun static int udc_plat_suspend(struct device *dev)
262*4882a593Smuzhiyun {
263*4882a593Smuzhiyun 	struct udc *udc;
264*4882a593Smuzhiyun 
265*4882a593Smuzhiyun 	udc = dev_get_drvdata(dev);
266*4882a593Smuzhiyun 	stop_udc(udc);
267*4882a593Smuzhiyun 
268*4882a593Smuzhiyun 	if (extcon_get_state(udc->edev, EXTCON_USB) > 0) {
269*4882a593Smuzhiyun 		dev_dbg(udc->dev, "device -> idle\n");
270*4882a593Smuzhiyun 		stop_udc(udc);
271*4882a593Smuzhiyun 	}
272*4882a593Smuzhiyun 	phy_power_off(udc->udc_phy);
273*4882a593Smuzhiyun 	phy_exit(udc->udc_phy);
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun 	return 0;
276*4882a593Smuzhiyun }
277*4882a593Smuzhiyun 
udc_plat_resume(struct device * dev)278*4882a593Smuzhiyun static int udc_plat_resume(struct device *dev)
279*4882a593Smuzhiyun {
280*4882a593Smuzhiyun 	struct udc *udc;
281*4882a593Smuzhiyun 	int ret;
282*4882a593Smuzhiyun 
283*4882a593Smuzhiyun 	udc = dev_get_drvdata(dev);
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun 	ret = phy_init(udc->udc_phy);
286*4882a593Smuzhiyun 	if (ret) {
287*4882a593Smuzhiyun 		dev_err(udc->dev, "UDC phy init failure");
288*4882a593Smuzhiyun 		return ret;
289*4882a593Smuzhiyun 	}
290*4882a593Smuzhiyun 
291*4882a593Smuzhiyun 	ret = phy_power_on(udc->udc_phy);
292*4882a593Smuzhiyun 	if (ret) {
293*4882a593Smuzhiyun 		dev_err(udc->dev, "UDC phy power on failure");
294*4882a593Smuzhiyun 		phy_exit(udc->udc_phy);
295*4882a593Smuzhiyun 		return ret;
296*4882a593Smuzhiyun 	}
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun 	if (extcon_get_state(udc->edev, EXTCON_USB) > 0) {
299*4882a593Smuzhiyun 		dev_dbg(udc->dev, "idle -> device\n");
300*4882a593Smuzhiyun 		start_udc(udc);
301*4882a593Smuzhiyun 	}
302*4882a593Smuzhiyun 
303*4882a593Smuzhiyun 	return 0;
304*4882a593Smuzhiyun }
305*4882a593Smuzhiyun static const struct dev_pm_ops udc_plat_pm_ops = {
306*4882a593Smuzhiyun 	.suspend	= udc_plat_suspend,
307*4882a593Smuzhiyun 	.resume		= udc_plat_resume,
308*4882a593Smuzhiyun };
309*4882a593Smuzhiyun #endif
310*4882a593Smuzhiyun 
311*4882a593Smuzhiyun #if defined(CONFIG_OF)
312*4882a593Smuzhiyun static const struct of_device_id of_udc_match[] = {
313*4882a593Smuzhiyun 	{ .compatible = "brcm,ns2-udc", },
314*4882a593Smuzhiyun 	{ .compatible = "brcm,cygnus-udc", },
315*4882a593Smuzhiyun 	{ .compatible = "brcm,iproc-udc", },
316*4882a593Smuzhiyun 	{ }
317*4882a593Smuzhiyun };
318*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, of_udc_match);
319*4882a593Smuzhiyun #endif
320*4882a593Smuzhiyun 
321*4882a593Smuzhiyun static struct platform_driver udc_plat_driver = {
322*4882a593Smuzhiyun 	.probe		= udc_plat_probe,
323*4882a593Smuzhiyun 	.remove		= udc_plat_remove,
324*4882a593Smuzhiyun 	.driver		= {
325*4882a593Smuzhiyun 		.name	= "snps-udc-plat",
326*4882a593Smuzhiyun 		.of_match_table = of_match_ptr(of_udc_match),
327*4882a593Smuzhiyun #ifdef CONFIG_PM_SLEEP
328*4882a593Smuzhiyun 		.pm	= &udc_plat_pm_ops,
329*4882a593Smuzhiyun #endif
330*4882a593Smuzhiyun 	},
331*4882a593Smuzhiyun };
332*4882a593Smuzhiyun module_platform_driver(udc_plat_driver);
333*4882a593Smuzhiyun 
334*4882a593Smuzhiyun MODULE_DESCRIPTION(UDC_MOD_DESCRIPTION);
335*4882a593Smuzhiyun MODULE_AUTHOR("Broadcom");
336*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
337