xref: /linux/drivers/usb/host/ehci-sh.c (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
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 	pdata = pdev->dev.platform_data;
130 
131 	/* initialize hcd */
132 	hcd = usb_create_hcd(&ehci_sh_hc_driver, &pdev->dev,
133 			     dev_name(&pdev->dev));
134 	if (!hcd) {
135 		ret = -ENOMEM;
136 		goto fail_create_hcd;
137 	}
138 
139 	hcd->rsrc_start = res->start;
140 	hcd->rsrc_len = resource_size(res);
141 
142 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
143 				driver->description)) {
144 		dev_dbg(&pdev->dev, "controller already in use\n");
145 		ret = -EBUSY;
146 		goto fail_request_resource;
147 	}
148 
149 	hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
150 	if (hcd->regs == NULL) {
151 		dev_dbg(&pdev->dev, "error mapping memory\n");
152 		ret = -ENXIO;
153 		goto fail_ioremap;
154 	}
155 
156 	priv = kmalloc(sizeof(struct ehci_sh_priv), GFP_KERNEL);
157 	if (!priv) {
158 		dev_dbg(&pdev->dev, "error allocating priv data\n");
159 		ret = -ENOMEM;
160 		goto fail_alloc;
161 	}
162 
163 	/* These are optional, we don't care if they fail */
164 	priv->fclk = clk_get(&pdev->dev, "usb_fck");
165 	if (IS_ERR(priv->fclk))
166 		priv->fclk = NULL;
167 
168 	priv->iclk = clk_get(&pdev->dev, "usb_ick");
169 	if (IS_ERR(priv->iclk))
170 		priv->iclk = NULL;
171 
172 	clk_enable(priv->fclk);
173 	clk_enable(priv->iclk);
174 
175 	if (pdata && pdata->phy_init)
176 		pdata->phy_init();
177 
178 	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
179 	if (ret != 0) {
180 		dev_err(&pdev->dev, "Failed to add hcd");
181 		goto fail_add_hcd;
182 	}
183 
184 	priv->hcd = hcd;
185 	platform_set_drvdata(pdev, priv);
186 
187 	return ret;
188 
189 fail_add_hcd:
190 	clk_disable(priv->iclk);
191 	clk_disable(priv->fclk);
192 
193 	clk_put(priv->iclk);
194 	clk_put(priv->fclk);
195 
196 	kfree(priv);
197 fail_alloc:
198 	iounmap(hcd->regs);
199 fail_ioremap:
200 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
201 fail_request_resource:
202 	usb_put_hcd(hcd);
203 fail_create_hcd:
204 	dev_err(&pdev->dev, "init %s fail, %d\n", dev_name(&pdev->dev), ret);
205 
206 	return ret;
207 }
208 
209 static int __exit ehci_hcd_sh_remove(struct platform_device *pdev)
210 {
211 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
212 	struct usb_hcd *hcd = priv->hcd;
213 
214 	usb_remove_hcd(hcd);
215 	iounmap(hcd->regs);
216 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
217 	usb_put_hcd(hcd);
218 	platform_set_drvdata(pdev, NULL);
219 
220 	clk_disable(priv->fclk);
221 	clk_disable(priv->iclk);
222 
223 	clk_put(priv->fclk);
224 	clk_put(priv->iclk);
225 
226 	kfree(priv);
227 
228 	return 0;
229 }
230 
231 static void ehci_hcd_sh_shutdown(struct platform_device *pdev)
232 {
233 	struct ehci_sh_priv *priv = platform_get_drvdata(pdev);
234 	struct usb_hcd *hcd = priv->hcd;
235 
236 	if (hcd->driver->shutdown)
237 		hcd->driver->shutdown(hcd);
238 }
239 
240 static struct platform_driver ehci_hcd_sh_driver = {
241 	.probe		= ehci_hcd_sh_probe,
242 	.remove		= __exit_p(ehci_hcd_sh_remove),
243 	.shutdown	= ehci_hcd_sh_shutdown,
244 	.driver		= {
245 		.name	= "sh_ehci",
246 		.owner	= THIS_MODULE,
247 	},
248 };
249 
250 MODULE_ALIAS("platform:sh_ehci");
251