xref: /linux/drivers/usb/host/ehci-sh.c (revision 96ac6d435100450f0565708d9b885ea2a7400e0a)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * SuperH EHCI host controller driver
4  *
5  * Copyright (C) 2010  Paul Mundt
6  *
7  * Based on ohci-sh.c and ehci-atmel.c.
8  */
9 #include <linux/platform_device.h>
10 #include <linux/clk.h>
11 #include <linux/platform_data/ehci-sh.h>
12 
13 struct ehci_sh_priv {
14 	struct clk *iclk, *fclk;
15 	struct usb_hcd *hcd;
16 };
17 
18 static int ehci_sh_reset(struct usb_hcd *hcd)
19 {
20 	struct ehci_hcd	*ehci = hcd_to_ehci(hcd);
21 
22 	ehci->caps = hcd->regs;
23 
24 	return ehci_setup(hcd);
25 }
26 
27 static const struct hc_driver ehci_sh_hc_driver = {
28 	.description			= hcd_name,
29 	.product_desc			= "SuperH EHCI",
30 	.hcd_priv_size			= sizeof(struct ehci_hcd),
31 
32 	/*
33 	 * generic hardware linkage
34 	 */
35 	.irq				= ehci_irq,
36 	.flags				= HCD_USB2 | HCD_MEMORY | HCD_BH,
37 
38 	/*
39 	 * basic lifecycle operations
40 	 */
41 	.reset				= ehci_sh_reset,
42 	.start				= ehci_run,
43 	.stop				= ehci_stop,
44 	.shutdown			= ehci_shutdown,
45 
46 	/*
47 	 * managing i/o requests and associated device resources
48 	 */
49 	.urb_enqueue			= ehci_urb_enqueue,
50 	.urb_dequeue			= ehci_urb_dequeue,
51 	.endpoint_disable		= ehci_endpoint_disable,
52 	.endpoint_reset			= ehci_endpoint_reset,
53 
54 	/*
55 	 * scheduling support
56 	 */
57 	.get_frame_number		= ehci_get_frame,
58 
59 	/*
60 	 * root hub support
61 	 */
62 	.hub_status_data		= ehci_hub_status_data,
63 	.hub_control			= ehci_hub_control,
64 
65 #ifdef CONFIG_PM
66 	.bus_suspend			= ehci_bus_suspend,
67 	.bus_resume			= ehci_bus_resume,
68 #endif
69 
70 	.relinquish_port		= ehci_relinquish_port,
71 	.port_handed_over		= ehci_port_handed_over,
72 	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
73 };
74 
75 static int ehci_hcd_sh_probe(struct platform_device *pdev)
76 {
77 	struct resource *res;
78 	struct ehci_sh_priv *priv;
79 	struct ehci_sh_platdata *pdata;
80 	struct usb_hcd *hcd;
81 	int irq, ret;
82 
83 	if (usb_disabled())
84 		return -ENODEV;
85 
86 	irq = platform_get_irq(pdev, 0);
87 	if (irq <= 0) {
88 		dev_err(&pdev->dev,
89 			"Found HC with no IRQ. Check %s setup!\n",
90 			dev_name(&pdev->dev));
91 		ret = -ENODEV;
92 		goto fail_create_hcd;
93 	}
94 
95 	pdata = dev_get_platdata(&pdev->dev);
96 
97 	/* initialize hcd */
98 	hcd = usb_create_hcd(&ehci_sh_hc_driver, &pdev->dev,
99 			     dev_name(&pdev->dev));
100 	if (!hcd) {
101 		ret = -ENOMEM;
102 		goto fail_create_hcd;
103 	}
104 
105 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
106 	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
107 	if (IS_ERR(hcd->regs)) {
108 		ret = PTR_ERR(hcd->regs);
109 		goto fail_request_resource;
110 	}
111 	hcd->rsrc_start = res->start;
112 	hcd->rsrc_len = resource_size(res);
113 
114 	priv = devm_kzalloc(&pdev->dev, sizeof(struct ehci_sh_priv),
115 			    GFP_KERNEL);
116 	if (!priv) {
117 		ret = -ENOMEM;
118 		goto fail_request_resource;
119 	}
120 
121 	/* These are optional, we don't care if they fail */
122 	priv->fclk = devm_clk_get(&pdev->dev, "usb_fck");
123 	if (IS_ERR(priv->fclk))
124 		priv->fclk = NULL;
125 
126 	priv->iclk = devm_clk_get(&pdev->dev, "usb_ick");
127 	if (IS_ERR(priv->iclk))
128 		priv->iclk = NULL;
129 
130 	clk_enable(priv->fclk);
131 	clk_enable(priv->iclk);
132 
133 	if (pdata && pdata->phy_init)
134 		pdata->phy_init();
135 
136 	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
137 	if (ret != 0) {
138 		dev_err(&pdev->dev, "Failed to add hcd");
139 		goto fail_add_hcd;
140 	}
141 	device_wakeup_enable(hcd->self.controller);
142 
143 	priv->hcd = hcd;
144 	platform_set_drvdata(pdev, priv);
145 
146 	return ret;
147 
148 fail_add_hcd:
149 	clk_disable(priv->iclk);
150 	clk_disable(priv->fclk);
151 
152 fail_request_resource:
153 	usb_put_hcd(hcd);
154 fail_create_hcd:
155 	dev_err(&pdev->dev, "init %s fail, %d\n", dev_name(&pdev->dev), ret);
156 
157 	return ret;
158 }
159 
160 static int ehci_hcd_sh_remove(struct platform_device *pdev)
161 {
162 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
163 	struct usb_hcd *hcd = priv->hcd;
164 
165 	usb_remove_hcd(hcd);
166 	usb_put_hcd(hcd);
167 
168 	clk_disable(priv->fclk);
169 	clk_disable(priv->iclk);
170 
171 	return 0;
172 }
173 
174 static void ehci_hcd_sh_shutdown(struct platform_device *pdev)
175 {
176 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
177 	struct usb_hcd *hcd = priv->hcd;
178 
179 	if (hcd->driver->shutdown)
180 		hcd->driver->shutdown(hcd);
181 }
182 
183 static struct platform_driver ehci_hcd_sh_driver = {
184 	.probe		= ehci_hcd_sh_probe,
185 	.remove		= ehci_hcd_sh_remove,
186 	.shutdown	= ehci_hcd_sh_shutdown,
187 	.driver		= {
188 		.name	= "sh_ehci",
189 	},
190 };
191 
192 MODULE_ALIAS("platform:sh_ehci");
193