xref: /openbmc/linux/drivers/usb/host/ehci-orion.c (revision a1e58bbd)
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 <asm/arch/orion.h>
15 
16 #define rdl(off)	__raw_readl(hcd->regs + (off))
17 #define wrl(off, val)	__raw_writel((val), hcd->regs + (off))
18 
19 #define USB_CAUSE		0x310
20 #define USB_MASK		0x314
21 #define USB_CMD			0x140
22 #define USB_MODE		0x1a8
23 #define USB_IPG			0x360
24 #define USB_PHY_PWR_CTRL	0x400
25 #define USB_PHY_TX_CTRL		0x420
26 #define USB_PHY_RX_CTRL		0x430
27 #define USB_PHY_IVREF_CTRL	0x440
28 #define USB_PHY_TST_GRP_CTRL	0x450
29 
30 /*
31  * Implement Orion USB controller specification guidelines
32  */
33 static void orion_usb_setup(struct usb_hcd *hcd)
34 {
35 	/*
36 	 * Clear interrupt cause and mask
37 	 */
38 	wrl(USB_CAUSE, 0);
39 	wrl(USB_MASK, 0);
40 
41 	/*
42 	 * Reset controller
43 	 */
44 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
45 	while (rdl(USB_CMD) & 0x2);
46 
47 	/*
48 	 * GL# USB-10: Set IPG for non start of frame packets
49 	 * Bits[14:8]=0xc
50 	 */
51 	wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
52 
53 	/*
54 	 * GL# USB-9: USB 2.0 Power Control
55 	 * BG_VSEL[7:6]=0x1
56 	 */
57 	wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
58 
59 	/*
60 	 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
61 	 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
62 	 */
63 	wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
64 
65 	/*
66 	 * GL# USB-3 GL# USB-9: USB PHY Rx Control
67 	 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
68 	 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
69 	 */
70 	wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
71 
72 	/*
73 	 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
74 	 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
75 	 */
76 	wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
77 
78 	/*
79 	 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
80 	 * REG_FIFO_SQ_RST[15]=0
81 	 */
82 	wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
83 
84 	/*
85 	 * Stop and reset controller
86 	 */
87 	wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
88 	wrl(USB_CMD, rdl(USB_CMD) | 0x2);
89 	while (rdl(USB_CMD) & 0x2);
90 
91 	/*
92 	 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
93 	 * TBD: This need to be done after each reset!
94 	 * GL# USB-4 Setup USB Host mode
95 	 */
96 	wrl(USB_MODE, 0x13);
97 }
98 
99 static int ehci_orion_setup(struct usb_hcd *hcd)
100 {
101 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
102 	int retval;
103 
104 	retval = ehci_halt(ehci);
105 	if (retval)
106 		return retval;
107 
108 	/*
109 	 * data structure init
110 	 */
111 	retval = ehci_init(hcd);
112 	if (retval)
113 		return retval;
114 
115 	ehci_reset(ehci);
116 	ehci_port_power(ehci, 0);
117 
118 	return retval;
119 }
120 
121 static const struct hc_driver ehci_orion_hc_driver = {
122 	.description = hcd_name,
123 	.product_desc = "Marvell Orion EHCI",
124 	.hcd_priv_size = sizeof(struct ehci_hcd),
125 
126 	/*
127 	 * generic hardware linkage
128 	 */
129 	.irq = ehci_irq,
130 	.flags = HCD_MEMORY | HCD_USB2,
131 
132 	/*
133 	 * basic lifecycle operations
134 	 */
135 	.reset = ehci_orion_setup,
136 	.start = ehci_run,
137 #ifdef CONFIG_PM
138 	.suspend = ehci_bus_suspend,
139 	.resume = ehci_bus_resume,
140 #endif
141 	.stop = ehci_stop,
142 	.shutdown = ehci_shutdown,
143 
144 	/*
145 	 * managing i/o requests and associated device resources
146 	 */
147 	.urb_enqueue = ehci_urb_enqueue,
148 	.urb_dequeue = ehci_urb_dequeue,
149 	.endpoint_disable = ehci_endpoint_disable,
150 
151 	/*
152 	 * scheduling support
153 	 */
154 	.get_frame_number = ehci_get_frame,
155 
156 	/*
157 	 * root hub support
158 	 */
159 	.hub_status_data = ehci_hub_status_data,
160 	.hub_control = ehci_hub_control,
161 	.bus_suspend = ehci_bus_suspend,
162 	.bus_resume = ehci_bus_resume,
163 };
164 
165 static int __init ehci_orion_drv_probe(struct platform_device *pdev)
166 {
167 	struct resource *res;
168 	struct usb_hcd *hcd;
169 	struct ehci_hcd *ehci;
170 	void __iomem *regs;
171 	int irq, err;
172 
173 	if (usb_disabled())
174 		return -ENODEV;
175 
176 	pr_debug("Initializing Orion-SoC USB Host Controller\n");
177 
178 	irq = platform_get_irq(pdev, 0);
179 	if (irq <= 0) {
180 		dev_err(&pdev->dev,
181 			"Found HC with no IRQ. Check %s setup!\n",
182 			pdev->dev.bus_id);
183 		err = -ENODEV;
184 		goto err1;
185 	}
186 
187 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
188 	if (!res) {
189 		dev_err(&pdev->dev,
190 			"Found HC with no register addr. Check %s setup!\n",
191 			pdev->dev.bus_id);
192 		err = -ENODEV;
193 		goto err1;
194 	}
195 
196 	if (!request_mem_region(res->start, res->end - res->start + 1,
197 				ehci_orion_hc_driver.description)) {
198 		dev_dbg(&pdev->dev, "controller already in use\n");
199 		err = -EBUSY;
200 		goto err1;
201 	}
202 
203 	regs = ioremap(res->start, res->end - res->start + 1);
204 	if (regs == NULL) {
205 		dev_dbg(&pdev->dev, "error mapping memory\n");
206 		err = -EFAULT;
207 		goto err2;
208 	}
209 
210 	hcd = usb_create_hcd(&ehci_orion_hc_driver,
211 			&pdev->dev, pdev->dev.bus_id);
212 	if (!hcd) {
213 		err = -ENOMEM;
214 		goto err3;
215 	}
216 
217 	hcd->rsrc_start = res->start;
218 	hcd->rsrc_len = res->end - res->start + 1;
219 	hcd->regs = regs;
220 
221 	ehci = hcd_to_ehci(hcd);
222 	ehci->caps = hcd->regs + 0x100;
223 	ehci->regs = hcd->regs + 0x100 +
224 		HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
225 	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
226 	ehci->is_tdi_rh_tt = 1;
227 	ehci->sbrn = 0x20;
228 
229 	/*
230 	 * setup Orion USB controller
231 	 */
232 	orion_usb_setup(hcd);
233 
234 	err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
235 	if (err)
236 		goto err4;
237 
238 	return 0;
239 
240 err4:
241 	usb_put_hcd(hcd);
242 err3:
243 	iounmap(regs);
244 err2:
245 	release_mem_region(res->start, res->end - res->start + 1);
246 err1:
247 	dev_err(&pdev->dev, "init %s fail, %d\n",
248 		pdev->dev.bus_id, err);
249 
250 	return err;
251 }
252 
253 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
254 {
255 	struct usb_hcd *hcd = platform_get_drvdata(pdev);
256 
257 	usb_remove_hcd(hcd);
258 	iounmap(hcd->regs);
259 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
260 	usb_put_hcd(hcd);
261 
262 	return 0;
263 }
264 
265 MODULE_ALIAS("platform:orion-ehci");
266 
267 static struct platform_driver ehci_orion_driver = {
268 	.probe		= ehci_orion_drv_probe,
269 	.remove		= __exit_p(ehci_orion_drv_remove),
270 	.shutdown	= usb_hcd_platform_shutdown,
271 	.driver.name	= "orion-ehci",
272 };
273