xref: /openbmc/linux/drivers/usb/host/ehci-orion.c (revision 15e47304)
1 /*
2  * drivers/usb/host/ehci-orion.c
3  *
4  * Tzachi Perelstein <tzachi@marvell.com>
5  *
6  * This file is licensed under  the terms of the GNU General Public
7  * License version 2. This program is licensed "as is" without any
8  * warranty of any kind, whether express or implied.
9  */
10 
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/mbus.h>
15 #include <linux/clk.h>
16 #include <plat/ehci-orion.h>
17 
18 #define rdl(off)	__raw_readl(hcd->regs + (off))
19 #define wrl(off, val)	__raw_writel((val), hcd->regs + (off))
20 
21 #define USB_CMD			0x140
22 #define USB_MODE		0x1a8
23 #define USB_CAUSE		0x310
24 #define USB_MASK		0x314
25 #define USB_WINDOW_CTRL(i)	(0x320 + ((i) << 4))
26 #define USB_WINDOW_BASE(i)	(0x324 + ((i) << 4))
27 #define USB_IPG			0x360
28 #define USB_PHY_PWR_CTRL	0x400
29 #define USB_PHY_TX_CTRL		0x420
30 #define USB_PHY_RX_CTRL		0x430
31 #define USB_PHY_IVREF_CTRL	0x440
32 #define USB_PHY_TST_GRP_CTRL	0x450
33 
34 /*
35  * Implement Orion USB controller specification guidelines
36  */
37 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
38 {
39 	/* The below GLs are according to the Orion Errata document */
40 	/*
41 	 * Clear interrupt cause and mask
42 	 */
43 	wrl(USB_CAUSE, 0);
44 	wrl(USB_MASK, 0);
45 
46 	/*
47 	 * Reset controller
48 	 */
49 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
50 	while (rdl(USB_CMD) & 0x2);
51 
52 	/*
53 	 * GL# USB-10: Set IPG for non start of frame packets
54 	 * Bits[14:8]=0xc
55 	 */
56 	wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
57 
58 	/*
59 	 * GL# USB-9: USB 2.0 Power Control
60 	 * BG_VSEL[7:6]=0x1
61 	 */
62 	wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
63 
64 	/*
65 	 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
66 	 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
67 	 */
68 	wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
69 
70 	/*
71 	 * GL# USB-3 GL# USB-9: USB PHY Rx Control
72 	 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
73 	 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
74 	 */
75 	wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
76 
77 	/*
78 	 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
79 	 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
80 	 */
81 	wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
82 
83 	/*
84 	 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
85 	 * REG_FIFO_SQ_RST[15]=0
86 	 */
87 	wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
88 
89 	/*
90 	 * Stop and reset controller
91 	 */
92 	wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
93 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
94 	while (rdl(USB_CMD) & 0x2);
95 
96 	/*
97 	 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
98 	 * TBD: This need to be done after each reset!
99 	 * GL# USB-4 Setup USB Host mode
100 	 */
101 	wrl(USB_MODE, 0x13);
102 }
103 
104 static int ehci_orion_setup(struct usb_hcd *hcd)
105 {
106 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
107 	int retval;
108 
109 	retval = ehci_setup(hcd);
110 	if (retval)
111 		return retval;
112 
113 	ehci_port_power(ehci, 0);
114 
115 	return retval;
116 }
117 
118 static const struct hc_driver ehci_orion_hc_driver = {
119 	.description = hcd_name,
120 	.product_desc = "Marvell Orion EHCI",
121 	.hcd_priv_size = sizeof(struct ehci_hcd),
122 
123 	/*
124 	 * generic hardware linkage
125 	 */
126 	.irq = ehci_irq,
127 	.flags = HCD_MEMORY | HCD_USB2,
128 
129 	/*
130 	 * basic lifecycle operations
131 	 */
132 	.reset = ehci_orion_setup,
133 	.start = ehci_run,
134 	.stop = ehci_stop,
135 	.shutdown = ehci_shutdown,
136 
137 	/*
138 	 * managing i/o requests and associated device resources
139 	 */
140 	.urb_enqueue = ehci_urb_enqueue,
141 	.urb_dequeue = ehci_urb_dequeue,
142 	.endpoint_disable = ehci_endpoint_disable,
143 	.endpoint_reset = ehci_endpoint_reset,
144 
145 	/*
146 	 * scheduling support
147 	 */
148 	.get_frame_number = ehci_get_frame,
149 
150 	/*
151 	 * root hub support
152 	 */
153 	.hub_status_data = ehci_hub_status_data,
154 	.hub_control = ehci_hub_control,
155 	.bus_suspend = ehci_bus_suspend,
156 	.bus_resume = ehci_bus_resume,
157 	.relinquish_port = ehci_relinquish_port,
158 	.port_handed_over = ehci_port_handed_over,
159 
160 	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
161 };
162 
163 static void __init
164 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
165 			     const struct mbus_dram_target_info *dram)
166 {
167 	int i;
168 
169 	for (i = 0; i < 4; i++) {
170 		wrl(USB_WINDOW_CTRL(i), 0);
171 		wrl(USB_WINDOW_BASE(i), 0);
172 	}
173 
174 	for (i = 0; i < dram->num_cs; i++) {
175 		const struct mbus_dram_window *cs = dram->cs + i;
176 
177 		wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
178 					(cs->mbus_attr << 8) |
179 					(dram->mbus_dram_target_id << 4) | 1);
180 		wrl(USB_WINDOW_BASE(i), cs->base);
181 	}
182 }
183 
184 static int __devinit ehci_orion_drv_probe(struct platform_device *pdev)
185 {
186 	struct orion_ehci_data *pd = pdev->dev.platform_data;
187 	const struct mbus_dram_target_info *dram;
188 	struct resource *res;
189 	struct usb_hcd *hcd;
190 	struct ehci_hcd *ehci;
191 	struct clk *clk;
192 	void __iomem *regs;
193 	int irq, err;
194 
195 	if (usb_disabled())
196 		return -ENODEV;
197 
198 	pr_debug("Initializing Orion-SoC USB Host Controller\n");
199 
200 	irq = platform_get_irq(pdev, 0);
201 	if (irq <= 0) {
202 		dev_err(&pdev->dev,
203 			"Found HC with no IRQ. Check %s setup!\n",
204 			dev_name(&pdev->dev));
205 		err = -ENODEV;
206 		goto err1;
207 	}
208 
209 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
210 	if (!res) {
211 		dev_err(&pdev->dev,
212 			"Found HC with no register addr. Check %s setup!\n",
213 			dev_name(&pdev->dev));
214 		err = -ENODEV;
215 		goto err1;
216 	}
217 
218 	if (!request_mem_region(res->start, resource_size(res),
219 				ehci_orion_hc_driver.description)) {
220 		dev_dbg(&pdev->dev, "controller already in use\n");
221 		err = -EBUSY;
222 		goto err1;
223 	}
224 
225 	regs = ioremap(res->start, resource_size(res));
226 	if (regs == NULL) {
227 		dev_dbg(&pdev->dev, "error mapping memory\n");
228 		err = -EFAULT;
229 		goto err2;
230 	}
231 
232 	/* Not all platforms can gate the clock, so it is not
233 	   an error if the clock does not exists. */
234 	clk = clk_get(&pdev->dev, NULL);
235 	if (!IS_ERR(clk)) {
236 		clk_prepare_enable(clk);
237 		clk_put(clk);
238 	}
239 
240 	hcd = usb_create_hcd(&ehci_orion_hc_driver,
241 			&pdev->dev, dev_name(&pdev->dev));
242 	if (!hcd) {
243 		err = -ENOMEM;
244 		goto err3;
245 	}
246 
247 	hcd->rsrc_start = res->start;
248 	hcd->rsrc_len = resource_size(res);
249 	hcd->regs = regs;
250 
251 	ehci = hcd_to_ehci(hcd);
252 	ehci->caps = hcd->regs + 0x100;
253 	hcd->has_tt = 1;
254 
255 	/*
256 	 * (Re-)program MBUS remapping windows if we are asked to.
257 	 */
258 	dram = mv_mbus_dram_info();
259 	if (dram)
260 		ehci_orion_conf_mbus_windows(hcd, dram);
261 
262 	/*
263 	 * setup Orion USB controller.
264 	 */
265 	switch (pd->phy_version) {
266 	case EHCI_PHY_NA:	/* dont change USB phy settings */
267 		break;
268 	case EHCI_PHY_ORION:
269 		orion_usb_phy_v1_setup(hcd);
270 		break;
271 	case EHCI_PHY_DD:
272 	case EHCI_PHY_KW:
273 	default:
274 		printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
275 	}
276 
277 	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
278 	if (err)
279 		goto err4;
280 
281 	return 0;
282 
283 err4:
284 	usb_put_hcd(hcd);
285 err3:
286 	if (!IS_ERR(clk)) {
287 		clk_disable_unprepare(clk);
288 		clk_put(clk);
289 	}
290 	iounmap(regs);
291 err2:
292 	release_mem_region(res->start, resource_size(res));
293 err1:
294 	dev_err(&pdev->dev, "init %s fail, %d\n",
295 		dev_name(&pdev->dev), err);
296 
297 	return err;
298 }
299 
300 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
301 {
302 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
303 	struct clk *clk;
304 
305 	usb_remove_hcd(hcd);
306 	iounmap(hcd->regs);
307 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
308 	usb_put_hcd(hcd);
309 
310 	clk = clk_get(&pdev->dev, NULL);
311 	if (!IS_ERR(clk)) {
312 		clk_disable_unprepare(clk);
313 		clk_put(clk);
314 	}
315 	return 0;
316 }
317 
318 MODULE_ALIAS("platform:orion-ehci");
319 
320 static struct platform_driver ehci_orion_driver = {
321 	.probe		= ehci_orion_drv_probe,
322 	.remove		= __exit_p(ehci_orion_drv_remove),
323 	.shutdown	= usb_hcd_platform_shutdown,
324 	.driver.name	= "orion-ehci",
325 };
326