xref: /openbmc/linux/drivers/usb/host/ehci-orion.c (revision 22246614)
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 <asm/plat-orion/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_setup(struct usb_hcd *hcd)
37 {
38 	/*
39 	 * Clear interrupt cause and mask
40 	 */
41 	wrl(USB_CAUSE, 0);
42 	wrl(USB_MASK, 0);
43 
44 	/*
45 	 * Reset controller
46 	 */
47 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
48 	while (rdl(USB_CMD) & 0x2);
49 
50 	/*
51 	 * GL# USB-10: Set IPG for non start of frame packets
52 	 * Bits[14:8]=0xc
53 	 */
54 	wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
55 
56 	/*
57 	 * GL# USB-9: USB 2.0 Power Control
58 	 * BG_VSEL[7:6]=0x1
59 	 */
60 	wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
61 
62 	/*
63 	 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
64 	 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
65 	 */
66 	wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
67 
68 	/*
69 	 * GL# USB-3 GL# USB-9: USB PHY Rx Control
70 	 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
71 	 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
72 	 */
73 	wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
74 
75 	/*
76 	 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
77 	 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
78 	 */
79 	wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
80 
81 	/*
82 	 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
83 	 * REG_FIFO_SQ_RST[15]=0
84 	 */
85 	wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
86 
87 	/*
88 	 * Stop and reset controller
89 	 */
90 	wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
91 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
92 	while (rdl(USB_CMD) & 0x2);
93 
94 	/*
95 	 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
96 	 * TBD: This need to be done after each reset!
97 	 * GL# USB-4 Setup USB Host mode
98 	 */
99 	wrl(USB_MODE, 0x13);
100 }
101 
102 static int ehci_orion_setup(struct usb_hcd *hcd)
103 {
104 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
105 	int retval;
106 
107 	retval = ehci_halt(ehci);
108 	if (retval)
109 		return retval;
110 
111 	/*
112 	 * data structure init
113 	 */
114 	retval = ehci_init(hcd);
115 	if (retval)
116 		return retval;
117 
118 	ehci_reset(ehci);
119 	ehci_port_power(ehci, 0);
120 
121 	return retval;
122 }
123 
124 static const struct hc_driver ehci_orion_hc_driver = {
125 	.description = hcd_name,
126 	.product_desc = "Marvell Orion EHCI",
127 	.hcd_priv_size = sizeof(struct ehci_hcd),
128 
129 	/*
130 	 * generic hardware linkage
131 	 */
132 	.irq = ehci_irq,
133 	.flags = HCD_MEMORY | HCD_USB2,
134 
135 	/*
136 	 * basic lifecycle operations
137 	 */
138 	.reset = ehci_orion_setup,
139 	.start = ehci_run,
140 #ifdef CONFIG_PM
141 	.suspend = ehci_bus_suspend,
142 	.resume = ehci_bus_resume,
143 #endif
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 
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 };
167 
168 static void __init
169 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
170 				struct mbus_dram_target_info *dram)
171 {
172 	int i;
173 
174 	for (i = 0; i < 4; i++) {
175 		wrl(USB_WINDOW_CTRL(i), 0);
176 		wrl(USB_WINDOW_BASE(i), 0);
177 	}
178 
179 	for (i = 0; i < dram->num_cs; i++) {
180 		struct mbus_dram_window *cs = dram->cs + i;
181 
182 		wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
183 					(cs->mbus_attr << 8) |
184 					(dram->mbus_dram_target_id << 4) | 1);
185 		wrl(USB_WINDOW_BASE(i), cs->base);
186 	}
187 }
188 
189 static int __init ehci_orion_drv_probe(struct platform_device *pdev)
190 {
191 	struct orion_ehci_data *pd = pdev->dev.platform_data;
192 	struct resource *res;
193 	struct usb_hcd *hcd;
194 	struct ehci_hcd *ehci;
195 	void __iomem *regs;
196 	int irq, err;
197 
198 	if (usb_disabled())
199 		return -ENODEV;
200 
201 	pr_debug("Initializing Orion-SoC USB Host Controller\n");
202 
203 	irq = platform_get_irq(pdev, 0);
204 	if (irq <= 0) {
205 		dev_err(&pdev->dev,
206 			"Found HC with no IRQ. Check %s setup!\n",
207 			pdev->dev.bus_id);
208 		err = -ENODEV;
209 		goto err1;
210 	}
211 
212 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
213 	if (!res) {
214 		dev_err(&pdev->dev,
215 			"Found HC with no register addr. Check %s setup!\n",
216 			pdev->dev.bus_id);
217 		err = -ENODEV;
218 		goto err1;
219 	}
220 
221 	if (!request_mem_region(res->start, res->end - res->start + 1,
222 				ehci_orion_hc_driver.description)) {
223 		dev_dbg(&pdev->dev, "controller already in use\n");
224 		err = -EBUSY;
225 		goto err1;
226 	}
227 
228 	regs = ioremap(res->start, res->end - res->start + 1);
229 	if (regs == NULL) {
230 		dev_dbg(&pdev->dev, "error mapping memory\n");
231 		err = -EFAULT;
232 		goto err2;
233 	}
234 
235 	hcd = usb_create_hcd(&ehci_orion_hc_driver,
236 			&pdev->dev, pdev->dev.bus_id);
237 	if (!hcd) {
238 		err = -ENOMEM;
239 		goto err3;
240 	}
241 
242 	hcd->rsrc_start = res->start;
243 	hcd->rsrc_len = res->end - res->start + 1;
244 	hcd->regs = regs;
245 
246 	ehci = hcd_to_ehci(hcd);
247 	ehci->caps = hcd->regs + 0x100;
248 	ehci->regs = hcd->regs + 0x100 +
249 		HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
250 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
251 	ehci->is_tdi_rh_tt = 1;
252 	ehci->sbrn = 0x20;
253 
254 	/*
255 	 * (Re-)program MBUS remapping windows if we are asked to.
256 	 */
257 	if (pd != NULL && pd->dram != NULL)
258 		ehci_orion_conf_mbus_windows(hcd, pd->dram);
259 
260 	/*
261 	 * setup Orion USB controller
262 	 */
263 	orion_usb_setup(hcd);
264 
265 	err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
266 	if (err)
267 		goto err4;
268 
269 	return 0;
270 
271 err4:
272 	usb_put_hcd(hcd);
273 err3:
274 	iounmap(regs);
275 err2:
276 	release_mem_region(res->start, res->end - res->start + 1);
277 err1:
278 	dev_err(&pdev->dev, "init %s fail, %d\n",
279 		pdev->dev.bus_id, err);
280 
281 	return err;
282 }
283 
284 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
285 {
286 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
287 
288 	usb_remove_hcd(hcd);
289 	iounmap(hcd->regs);
290 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
291 	usb_put_hcd(hcd);
292 
293 	return 0;
294 }
295 
296 MODULE_ALIAS("platform:orion-ehci");
297 
298 static struct platform_driver ehci_orion_driver = {
299 	.probe		= ehci_orion_drv_probe,
300 	.remove		= __exit_p(ehci_orion_drv_remove),
301 	.shutdown	= usb_hcd_platform_shutdown,
302 	.driver.name	= "orion-ehci",
303 };
304