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 <linux/platform_data/usb-ehci-orion.h>
17 #include <linux/of.h>
18 #include <linux/phy/phy.h>
19 #include <linux/of_device.h>
20 #include <linux/of_irq.h>
21 #include <linux/usb.h>
22 #include <linux/usb/hcd.h>
23 #include <linux/io.h>
24 #include <linux/dma-mapping.h>
25
26 #include "ehci.h"
27
28 #define rdl(off) __raw_readl(hcd->regs + (off))
29 #define wrl(off, val) __raw_writel((val), hcd->regs + (off))
30
31 #define USB_CMD 0x140
32 #define USB_MODE 0x1a8
33 #define USB_CAUSE 0x310
34 #define USB_MASK 0x314
35 #define USB_WINDOW_CTRL(i) (0x320 + ((i) << 4))
36 #define USB_WINDOW_BASE(i) (0x324 + ((i) << 4))
37 #define USB_IPG 0x360
38 #define USB_PHY_PWR_CTRL 0x400
39 #define USB_PHY_TX_CTRL 0x420
40 #define USB_PHY_RX_CTRL 0x430
41 #define USB_PHY_IVREF_CTRL 0x440
42 #define USB_PHY_TST_GRP_CTRL 0x450
43
44 #define DRIVER_DESC "EHCI orion driver"
45
46 #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
47
48 struct orion_ehci_hcd {
49 struct clk *clk;
50 struct phy *phy;
51 };
52
53 static const char hcd_name[] = "ehci-orion";
54
55 static struct hc_driver __read_mostly ehci_orion_hc_driver;
56
57 /*
58 * Implement Orion USB controller specification guidelines
59 */
orion_usb_phy_v1_setup(struct usb_hcd * hcd)60 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
61 {
62 /* The below GLs are according to the Orion Errata document */
63 /*
64 * Clear interrupt cause and mask
65 */
66 wrl(USB_CAUSE, 0);
67 wrl(USB_MASK, 0);
68
69 /*
70 * Reset controller
71 */
72 wrl(USB_CMD, rdl(USB_CMD) | 0x2);
73 while (rdl(USB_CMD) & 0x2);
74
75 /*
76 * GL# USB-10: Set IPG for non start of frame packets
77 * Bits[14:8]=0xc
78 */
79 wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
80
81 /*
82 * GL# USB-9: USB 2.0 Power Control
83 * BG_VSEL[7:6]=0x1
84 */
85 wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
86
87 /*
88 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
89 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
90 */
91 wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
92
93 /*
94 * GL# USB-3 GL# USB-9: USB PHY Rx Control
95 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
96 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
97 */
98 wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
99
100 /*
101 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
102 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
103 */
104 wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
105
106 /*
107 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
108 * REG_FIFO_SQ_RST[15]=0
109 */
110 wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
111
112 /*
113 * Stop and reset controller
114 */
115 wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
116 wrl(USB_CMD, rdl(USB_CMD) | 0x2);
117 while (rdl(USB_CMD) & 0x2);
118
119 /*
120 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
121 * TBD: This need to be done after each reset!
122 * GL# USB-4 Setup USB Host mode
123 */
124 wrl(USB_MODE, 0x13);
125 }
126
127 static void
ehci_orion_conf_mbus_windows(struct usb_hcd * hcd,const struct mbus_dram_target_info * dram)128 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
129 const struct mbus_dram_target_info *dram)
130 {
131 int i;
132
133 for (i = 0; i < 4; i++) {
134 wrl(USB_WINDOW_CTRL(i), 0);
135 wrl(USB_WINDOW_BASE(i), 0);
136 }
137
138 for (i = 0; i < dram->num_cs; i++) {
139 const struct mbus_dram_window *cs = dram->cs + i;
140
141 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
142 (cs->mbus_attr << 8) |
143 (dram->mbus_dram_target_id << 4) | 1);
144 wrl(USB_WINDOW_BASE(i), cs->base);
145 }
146 }
147
148 static const struct ehci_driver_overrides orion_overrides __initconst = {
149 .extra_priv_size = sizeof(struct orion_ehci_hcd),
150 };
151
ehci_orion_drv_probe(struct platform_device * pdev)152 static int ehci_orion_drv_probe(struct platform_device *pdev)
153 {
154 struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
155 const struct mbus_dram_target_info *dram;
156 struct resource *res;
157 struct usb_hcd *hcd;
158 struct ehci_hcd *ehci;
159 void __iomem *regs;
160 int irq, err;
161 enum orion_ehci_phy_ver phy_version;
162 struct orion_ehci_hcd *priv;
163
164 if (usb_disabled())
165 return -ENODEV;
166
167 pr_debug("Initializing Orion-SoC USB Host Controller\n");
168
169 irq = platform_get_irq(pdev, 0);
170 if (irq <= 0) {
171 dev_err(&pdev->dev,
172 "Found HC with no IRQ. Check %s setup!\n",
173 dev_name(&pdev->dev));
174 err = -ENODEV;
175 goto err;
176 }
177
178 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
179 if (!res) {
180 dev_err(&pdev->dev,
181 "Found HC with no register addr. Check %s setup!\n",
182 dev_name(&pdev->dev));
183 err = -ENODEV;
184 goto err;
185 }
186
187 /*
188 * Right now device-tree probed devices don't get dma_mask
189 * set. Since shared usb code relies on it, set it here for
190 * now. Once we have dma capability bindings this can go away.
191 */
192 err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
193 if (err)
194 goto err;
195
196 regs = devm_ioremap_resource(&pdev->dev, res);
197 if (IS_ERR(regs)) {
198 err = PTR_ERR(regs);
199 goto err;
200 }
201
202 hcd = usb_create_hcd(&ehci_orion_hc_driver,
203 &pdev->dev, dev_name(&pdev->dev));
204 if (!hcd) {
205 err = -ENOMEM;
206 goto err;
207 }
208
209 hcd->rsrc_start = res->start;
210 hcd->rsrc_len = resource_size(res);
211 hcd->regs = regs;
212
213 ehci = hcd_to_ehci(hcd);
214 ehci->caps = hcd->regs + 0x100;
215 hcd->has_tt = 1;
216
217 priv = hcd_to_orion_priv(hcd);
218 /*
219 * Not all platforms can gate the clock, so it is not an error if
220 * the clock does not exists.
221 */
222 priv->clk = devm_clk_get(&pdev->dev, NULL);
223 if (!IS_ERR(priv->clk))
224 clk_prepare_enable(priv->clk);
225
226 priv->phy = devm_phy_optional_get(&pdev->dev, "usb");
227 if (IS_ERR(priv->phy)) {
228 err = PTR_ERR(priv->phy);
229 if (err != -ENOSYS)
230 goto err_phy_get;
231 } else {
232 err = phy_init(priv->phy);
233 if (err)
234 goto err_phy_init;
235
236 err = phy_power_on(priv->phy);
237 if (err)
238 goto err_phy_power_on;
239 }
240
241 /*
242 * (Re-)program MBUS remapping windows if we are asked to.
243 */
244 dram = mv_mbus_dram_info();
245 if (dram)
246 ehci_orion_conf_mbus_windows(hcd, dram);
247
248 /*
249 * setup Orion USB controller.
250 */
251 if (pdev->dev.of_node)
252 phy_version = EHCI_PHY_NA;
253 else
254 phy_version = pd->phy_version;
255
256 switch (phy_version) {
257 case EHCI_PHY_NA: /* dont change USB phy settings */
258 break;
259 case EHCI_PHY_ORION:
260 orion_usb_phy_v1_setup(hcd);
261 break;
262 case EHCI_PHY_DD:
263 case EHCI_PHY_KW:
264 default:
265 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
266 }
267
268 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
269 if (err)
270 goto err_add_hcd;
271
272 device_wakeup_enable(hcd->self.controller);
273 return 0;
274
275 err_add_hcd:
276 if (!IS_ERR(priv->phy))
277 phy_power_off(priv->phy);
278 err_phy_power_on:
279 if (!IS_ERR(priv->phy))
280 phy_exit(priv->phy);
281 err_phy_init:
282 err_phy_get:
283 if (!IS_ERR(priv->clk))
284 clk_disable_unprepare(priv->clk);
285 usb_put_hcd(hcd);
286 err:
287 dev_err(&pdev->dev, "init %s fail, %d\n",
288 dev_name(&pdev->dev), err);
289
290 return err;
291 }
292
ehci_orion_drv_remove(struct platform_device * pdev)293 static int ehci_orion_drv_remove(struct platform_device *pdev)
294 {
295 struct usb_hcd *hcd = platform_get_drvdata(pdev);
296 struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
297
298 usb_remove_hcd(hcd);
299
300 if (!IS_ERR(priv->phy)) {
301 phy_power_off(priv->phy);
302 phy_exit(priv->phy);
303 }
304
305 if (!IS_ERR(priv->clk))
306 clk_disable_unprepare(priv->clk);
307
308 usb_put_hcd(hcd);
309
310 return 0;
311 }
312
313 static const struct of_device_id ehci_orion_dt_ids[] = {
314 { .compatible = "marvell,orion-ehci", },
315 {},
316 };
317 MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
318
319 static struct platform_driver ehci_orion_driver = {
320 .probe = ehci_orion_drv_probe,
321 .remove = ehci_orion_drv_remove,
322 .shutdown = usb_hcd_platform_shutdown,
323 .driver = {
324 .name = "orion-ehci",
325 .owner = THIS_MODULE,
326 .of_match_table = ehci_orion_dt_ids,
327 },
328 };
329
ehci_orion_init(void)330 static int __init ehci_orion_init(void)
331 {
332 if (usb_disabled())
333 return -ENODEV;
334
335 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
336
337 ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
338 return platform_driver_register(&ehci_orion_driver);
339 }
340 module_init(ehci_orion_init);
341
ehci_orion_cleanup(void)342 static void __exit ehci_orion_cleanup(void)
343 {
344 platform_driver_unregister(&ehci_orion_driver);
345 }
346 module_exit(ehci_orion_cleanup);
347
348 MODULE_DESCRIPTION(DRIVER_DESC);
349 MODULE_ALIAS("platform:orion-ehci");
350 MODULE_AUTHOR("Tzachi Perelstein");
351 MODULE_LICENSE("GPL v2");
352