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