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