xref: /openbmc/linux/drivers/usb/host/ehci-orion.c (revision a09d2831)
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 	ehci_reset(ehci);
109 	retval = ehci_halt(ehci);
110 	if (retval)
111 		return retval;
112 
113 	/*
114 	 * data structure init
115 	 */
116 	retval = ehci_init(hcd);
117 	if (retval)
118 		return retval;
119 
120 	hcd->has_tt = 1;
121 
122 	ehci_port_power(ehci, 0);
123 
124 	return retval;
125 }
126 
127 static const struct hc_driver ehci_orion_hc_driver = {
128 	.description = hcd_name,
129 	.product_desc = "Marvell Orion EHCI",
130 	.hcd_priv_size = sizeof(struct ehci_hcd),
131 
132 	/*
133 	 * generic hardware linkage
134 	 */
135 	.irq = ehci_irq,
136 	.flags = HCD_MEMORY | HCD_USB2,
137 
138 	/*
139 	 * basic lifecycle operations
140 	 */
141 	.reset = ehci_orion_setup,
142 	.start = ehci_run,
143 	.stop = ehci_stop,
144 	.shutdown = ehci_shutdown,
145 
146 	/*
147 	 * managing i/o requests and associated device resources
148 	 */
149 	.urb_enqueue = ehci_urb_enqueue,
150 	.urb_dequeue = ehci_urb_dequeue,
151 	.endpoint_disable = ehci_endpoint_disable,
152 	.endpoint_reset = ehci_endpoint_reset,
153 
154 	/*
155 	 * scheduling support
156 	 */
157 	.get_frame_number = ehci_get_frame,
158 
159 	/*
160 	 * root hub support
161 	 */
162 	.hub_status_data = ehci_hub_status_data,
163 	.hub_control = ehci_hub_control,
164 	.bus_suspend = ehci_bus_suspend,
165 	.bus_resume = ehci_bus_resume,
166 	.relinquish_port = ehci_relinquish_port,
167 	.port_handed_over = ehci_port_handed_over,
168 
169 	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
170 };
171 
172 static void __init
173 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
174 				struct mbus_dram_target_info *dram)
175 {
176 	int i;
177 
178 	for (i = 0; i < 4; i++) {
179 		wrl(USB_WINDOW_CTRL(i), 0);
180 		wrl(USB_WINDOW_BASE(i), 0);
181 	}
182 
183 	for (i = 0; i < dram->num_cs; i++) {
184 		struct mbus_dram_window *cs = dram->cs + i;
185 
186 		wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
187 					(cs->mbus_attr << 8) |
188 					(dram->mbus_dram_target_id << 4) | 1);
189 		wrl(USB_WINDOW_BASE(i), cs->base);
190 	}
191 }
192 
193 static int __devinit ehci_orion_drv_probe(struct platform_device *pdev)
194 {
195 	struct orion_ehci_data *pd = pdev->dev.platform_data;
196 	struct resource *res;
197 	struct usb_hcd *hcd;
198 	struct ehci_hcd *ehci;
199 	void __iomem *regs;
200 	int irq, err;
201 
202 	if (usb_disabled())
203 		return -ENODEV;
204 
205 	pr_debug("Initializing Orion-SoC USB Host Controller\n");
206 
207 	irq = platform_get_irq(pdev, 0);
208 	if (irq <= 0) {
209 		dev_err(&pdev->dev,
210 			"Found HC with no IRQ. Check %s setup!\n",
211 			dev_name(&pdev->dev));
212 		err = -ENODEV;
213 		goto err1;
214 	}
215 
216 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
217 	if (!res) {
218 		dev_err(&pdev->dev,
219 			"Found HC with no register addr. Check %s setup!\n",
220 			dev_name(&pdev->dev));
221 		err = -ENODEV;
222 		goto err1;
223 	}
224 
225 	if (!request_mem_region(res->start, res->end - res->start + 1,
226 				ehci_orion_hc_driver.description)) {
227 		dev_dbg(&pdev->dev, "controller already in use\n");
228 		err = -EBUSY;
229 		goto err1;
230 	}
231 
232 	regs = ioremap(res->start, res->end - res->start + 1);
233 	if (regs == NULL) {
234 		dev_dbg(&pdev->dev, "error mapping memory\n");
235 		err = -EFAULT;
236 		goto err2;
237 	}
238 
239 	hcd = usb_create_hcd(&ehci_orion_hc_driver,
240 			&pdev->dev, dev_name(&pdev->dev));
241 	if (!hcd) {
242 		err = -ENOMEM;
243 		goto err3;
244 	}
245 
246 	hcd->rsrc_start = res->start;
247 	hcd->rsrc_len = res->end - res->start + 1;
248 	hcd->regs = regs;
249 
250 	ehci = hcd_to_ehci(hcd);
251 	ehci->caps = hcd->regs + 0x100;
252 	ehci->regs = hcd->regs + 0x100 +
253 		HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
254 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
255 	hcd->has_tt = 1;
256 	ehci->sbrn = 0x20;
257 
258 	/*
259 	 * (Re-)program MBUS remapping windows if we are asked to.
260 	 */
261 	if (pd != NULL && pd->dram != NULL)
262 		ehci_orion_conf_mbus_windows(hcd, pd->dram);
263 
264 	/*
265 	 * setup Orion USB controller.
266 	 */
267 	switch (pd->phy_version) {
268 	case EHCI_PHY_NA:	/* dont change USB phy settings */
269 		break;
270 	case EHCI_PHY_ORION:
271 		orion_usb_phy_v1_setup(hcd);
272 		break;
273 	case EHCI_PHY_DD:
274 	case EHCI_PHY_KW:
275 	default:
276 		printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
277 	}
278 
279 	err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
280 	if (err)
281 		goto err4;
282 
283 	return 0;
284 
285 err4:
286 	usb_put_hcd(hcd);
287 err3:
288 	iounmap(regs);
289 err2:
290 	release_mem_region(res->start, res->end - res->start + 1);
291 err1:
292 	dev_err(&pdev->dev, "init %s fail, %d\n",
293 		dev_name(&pdev->dev), err);
294 
295 	return err;
296 }
297 
298 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
299 {
300 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
301 
302 	usb_remove_hcd(hcd);
303 	iounmap(hcd->regs);
304 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
305 	usb_put_hcd(hcd);
306 
307 	return 0;
308 }
309 
310 MODULE_ALIAS("platform:orion-ehci");
311 
312 static struct platform_driver ehci_orion_driver = {
313 	.probe		= ehci_orion_drv_probe,
314 	.remove		= __exit_p(ehci_orion_drv_remove),
315 	.shutdown	= usb_hcd_platform_shutdown,
316 	.driver.name	= "orion-ehci",
317 };
318