xref: /openbmc/linux/drivers/usb/host/ehci-sh.c (revision ab73b751)
1 /*
2  * SuperH EHCI host controller driver
3  *
4  * Copyright (C) 2010  Paul Mundt
5  *
6  * Based on ohci-sh.c and ehci-atmel.c.
7  *
8  * This file is subject to the terms and conditions of the GNU General Public
9  * License.  See the file "COPYING" in the main directory of this archive
10  * for more details.
11  */
12 #include <linux/platform_device.h>
13 #include <linux/clk.h>
14 #include <linux/platform_data/ehci-sh.h>
15 
16 struct ehci_sh_priv {
17 	struct clk *iclk, *fclk;
18 	struct usb_hcd *hcd;
19 };
20 
21 static int ehci_sh_reset(struct usb_hcd *hcd)
22 {
23 	struct ehci_hcd	*ehci = hcd_to_ehci(hcd);
24 	int ret;
25 
26 	ehci->caps = hcd->regs;
27 	ehci->regs = hcd->regs + HC_LENGTH(ehci, ehci_readl(ehci,
28 		&ehci->caps->hc_capbase));
29 
30 	dbg_hcs_params(ehci, "reset");
31 	dbg_hcc_params(ehci, "reset");
32 
33 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
34 
35 	ret = ehci_halt(ehci);
36 	if (unlikely(ret))
37 		return ret;
38 
39 	ret = ehci_init(hcd);
40 	if (unlikely(ret))
41 		return ret;
42 
43 	ehci->sbrn = 0x20;
44 
45 	ehci_reset(ehci);
46 	ehci_port_power(ehci, 0);
47 
48 	return ret;
49 }
50 
51 static const struct hc_driver ehci_sh_hc_driver = {
52 	.description			= hcd_name,
53 	.product_desc			= "SuperH EHCI",
54 	.hcd_priv_size			= sizeof(struct ehci_hcd),
55 
56 	/*
57 	 * generic hardware linkage
58 	 */
59 	.irq				= ehci_irq,
60 	.flags				= HCD_USB2 | HCD_MEMORY,
61 
62 	/*
63 	 * basic lifecycle operations
64 	 */
65 	.reset				= ehci_sh_reset,
66 	.start				= ehci_run,
67 	.stop				= ehci_stop,
68 	.shutdown			= ehci_shutdown,
69 
70 	/*
71 	 * managing i/o requests and associated device resources
72 	 */
73 	.urb_enqueue			= ehci_urb_enqueue,
74 	.urb_dequeue			= ehci_urb_dequeue,
75 	.endpoint_disable		= ehci_endpoint_disable,
76 	.endpoint_reset			= ehci_endpoint_reset,
77 
78 	/*
79 	 * scheduling support
80 	 */
81 	.get_frame_number		= ehci_get_frame,
82 
83 	/*
84 	 * root hub support
85 	 */
86 	.hub_status_data		= ehci_hub_status_data,
87 	.hub_control			= ehci_hub_control,
88 
89 #ifdef CONFIG_PM
90 	.bus_suspend			= ehci_bus_suspend,
91 	.bus_resume			= ehci_bus_resume,
92 #endif
93 
94 	.relinquish_port		= ehci_relinquish_port,
95 	.port_handed_over		= ehci_port_handed_over,
96 	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
97 };
98 
99 static int ehci_hcd_sh_probe(struct platform_device *pdev)
100 {
101 	const struct hc_driver *driver = &ehci_sh_hc_driver;
102 	struct resource *res;
103 	struct ehci_sh_priv *priv;
104 	struct ehci_sh_platdata *pdata;
105 	struct usb_hcd *hcd;
106 	int irq, ret;
107 
108 	if (usb_disabled())
109 		return -ENODEV;
110 
111 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
112 	if (!res) {
113 		dev_err(&pdev->dev,
114 			"Found HC with no register addr. Check %s setup!\n",
115 			dev_name(&pdev->dev));
116 		ret = -ENODEV;
117 		goto fail_create_hcd;
118 	}
119 
120 	irq = platform_get_irq(pdev, 0);
121 	if (irq <= 0) {
122 		dev_err(&pdev->dev,
123 			"Found HC with no IRQ. Check %s setup!\n",
124 			dev_name(&pdev->dev));
125 		ret = -ENODEV;
126 		goto fail_create_hcd;
127 	}
128 
129 	if (pdev->dev.platform_data != NULL)
130 		pdata = pdev->dev.platform_data;
131 
132 	/* initialize hcd */
133 	hcd = usb_create_hcd(&ehci_sh_hc_driver, &pdev->dev,
134 			     dev_name(&pdev->dev));
135 	if (!hcd) {
136 		ret = -ENOMEM;
137 		goto fail_create_hcd;
138 	}
139 
140 	hcd->rsrc_start = res->start;
141 	hcd->rsrc_len = resource_size(res);
142 
143 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
144 				driver->description)) {
145 		dev_dbg(&pdev->dev, "controller already in use\n");
146 		ret = -EBUSY;
147 		goto fail_request_resource;
148 	}
149 
150 	hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
151 	if (hcd->regs == NULL) {
152 		dev_dbg(&pdev->dev, "error mapping memory\n");
153 		ret = -ENXIO;
154 		goto fail_ioremap;
155 	}
156 
157 	priv = kmalloc(sizeof(struct ehci_sh_priv), GFP_KERNEL);
158 	if (!priv) {
159 		dev_dbg(&pdev->dev, "error allocating priv data\n");
160 		ret = -ENOMEM;
161 		goto fail_alloc;
162 	}
163 
164 	/* These are optional, we don't care if they fail */
165 	priv->fclk = clk_get(&pdev->dev, "usb_fck");
166 	if (IS_ERR(priv->fclk))
167 		priv->fclk = NULL;
168 
169 	priv->iclk = clk_get(&pdev->dev, "usb_ick");
170 	if (IS_ERR(priv->iclk))
171 		priv->iclk = NULL;
172 
173 	clk_enable(priv->fclk);
174 	clk_enable(priv->iclk);
175 
176 	if (pdata && pdata->phy_init)
177 		pdata->phy_init();
178 
179 	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
180 	if (ret != 0) {
181 		dev_err(&pdev->dev, "Failed to add hcd");
182 		goto fail_add_hcd;
183 	}
184 
185 	priv->hcd = hcd;
186 	platform_set_drvdata(pdev, priv);
187 
188 	return ret;
189 
190 fail_add_hcd:
191 	clk_disable(priv->iclk);
192 	clk_disable(priv->fclk);
193 
194 	clk_put(priv->iclk);
195 	clk_put(priv->fclk);
196 
197 	kfree(priv);
198 fail_alloc:
199 	iounmap(hcd->regs);
200 fail_ioremap:
201 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
202 fail_request_resource:
203 	usb_put_hcd(hcd);
204 fail_create_hcd:
205 	dev_err(&pdev->dev, "init %s fail, %d\n", dev_name(&pdev->dev), ret);
206 
207 	return ret;
208 }
209 
210 static int __exit ehci_hcd_sh_remove(struct platform_device *pdev)
211 {
212 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
213 	struct usb_hcd *hcd = priv->hcd;
214 
215 	usb_remove_hcd(hcd);
216 	iounmap(hcd->regs);
217 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
218 	usb_put_hcd(hcd);
219 	platform_set_drvdata(pdev, NULL);
220 
221 	clk_disable(priv->fclk);
222 	clk_disable(priv->iclk);
223 
224 	clk_put(priv->fclk);
225 	clk_put(priv->iclk);
226 
227 	kfree(priv);
228 
229 	return 0;
230 }
231 
232 static void ehci_hcd_sh_shutdown(struct platform_device *pdev)
233 {
234 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
235 	struct usb_hcd *hcd = priv->hcd;
236 
237 	if (hcd->driver->shutdown)
238 		hcd->driver->shutdown(hcd);
239 }
240 
241 static struct platform_driver ehci_hcd_sh_driver = {
242 	.probe		= ehci_hcd_sh_probe,
243 	.remove		= __exit_p(ehci_hcd_sh_remove),
244 	.shutdown	= ehci_hcd_sh_shutdown,
245 	.driver		= {
246 		.name	= "sh_ehci",
247 		.owner	= THIS_MODULE,
248 	},
249 };
250 
251 MODULE_ALIAS("platform:sh_ehci");
252