blob: ee8d5faa01947cd6d2c8cf708273c0521762a797 [file] [log] [blame]
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -05001/*
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>
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -040014#include <linux/mbus.h>
Andrew Lunn8c869ed2012-04-15 12:53:47 +020015#include <linux/clk.h>
Arnd Bergmannc02cecb2012-08-24 15:21:54 +020016#include <linux/platform_data/usb-ehci-orion.h>
Andrew Lunn77dae542012-10-20 13:10:00 +020017#include <linux/of.h>
Gregory CLEMENTd4459132014-05-15 12:17:29 +020018#include <linux/phy/phy.h>
Andrew Lunn77dae542012-10-20 13:10:00 +020019#include <linux/of_device.h>
20#include <linux/of_irq.h>
Manjunath Goudara76dd462013-04-02 18:23:59 +020021#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"
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050027
Marcin Wojtas782614b2014-11-13 00:49:50 +010028#define rdl(off) readl_relaxed(hcd->regs + (off))
29#define wrl(off, val) writel_relaxed((val), hcd->regs + (off))
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050030
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050031#define USB_CMD 0x140
Thomas Petazzoni24677af2015-03-19 15:01:07 +010032#define USB_CMD_RUN BIT(0)
33#define USB_CMD_RESET BIT(1)
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050034#define USB_MODE 0x1a8
Thomas Petazzoni24677af2015-03-19 15:01:07 +010035#define USB_MODE_MASK GENMASK(1, 0)
36#define USB_MODE_DEVICE 0x2
37#define USB_MODE_HOST 0x3
38#define USB_MODE_SDIS BIT(4)
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -040039#define USB_CAUSE 0x310
40#define USB_MASK 0x314
41#define USB_WINDOW_CTRL(i) (0x320 + ((i) << 4))
42#define USB_WINDOW_BASE(i) (0x324 + ((i) << 4))
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050043#define USB_IPG 0x360
44#define USB_PHY_PWR_CTRL 0x400
45#define USB_PHY_TX_CTRL 0x420
46#define USB_PHY_RX_CTRL 0x430
47#define USB_PHY_IVREF_CTRL 0x440
48#define USB_PHY_TST_GRP_CTRL 0x450
49
Manjunath Goudara76dd462013-04-02 18:23:59 +020050#define DRIVER_DESC "EHCI orion driver"
51
Gregory CLEMENTac069662014-05-15 12:17:28 +020052#define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
53
54struct orion_ehci_hcd {
55 struct clk *clk;
Gregory CLEMENTd4459132014-05-15 12:17:29 +020056 struct phy *phy;
Gregory CLEMENTac069662014-05-15 12:17:28 +020057};
58
Manjunath Goudara76dd462013-04-02 18:23:59 +020059static const char hcd_name[] = "ehci-orion";
60
61static struct hc_driver __read_mostly ehci_orion_hc_driver;
62
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050063/*
64 * Implement Orion USB controller specification guidelines
65 */
Ronen Shitritfb6f5522008-09-17 10:08:05 +030066static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050067{
Ronen Shitritfb6f5522008-09-17 10:08:05 +030068 /* The below GLs are according to the Orion Errata document */
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050069 /*
70 * Clear interrupt cause and mask
71 */
72 wrl(USB_CAUSE, 0);
73 wrl(USB_MASK, 0);
74
75 /*
76 * Reset controller
77 */
Thomas Petazzoni24677af2015-03-19 15:01:07 +010078 wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET);
79 while (rdl(USB_CMD) & USB_CMD_RESET);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -050080
81 /*
82 * GL# USB-10: Set IPG for non start of frame packets
83 * Bits[14:8]=0xc
84 */
85 wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
86
87 /*
88 * GL# USB-9: USB 2.0 Power Control
89 * BG_VSEL[7:6]=0x1
90 */
91 wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
92
93 /*
94 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
95 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
96 */
97 wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
98
99 /*
100 * GL# USB-3 GL# USB-9: USB PHY Rx Control
101 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
102 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
103 */
104 wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
105
106 /*
107 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
108 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
109 */
110 wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
111
112 /*
113 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
114 * REG_FIFO_SQ_RST[15]=0
115 */
116 wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
117
118 /*
119 * Stop and reset controller
120 */
Thomas Petazzoni24677af2015-03-19 15:01:07 +0100121 wrl(USB_CMD, rdl(USB_CMD) & ~USB_CMD_RUN);
122 wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET);
123 while (rdl(USB_CMD) & USB_CMD_RESET);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500124
125 /*
126 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
127 * TBD: This need to be done after each reset!
128 * GL# USB-4 Setup USB Host mode
129 */
Thomas Petazzoni24677af2015-03-19 15:01:07 +0100130 wrl(USB_MODE, USB_MODE_SDIS | USB_MODE_HOST);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500131}
132
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500133static void
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -0400134ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
Andrew Lunn63a93322011-12-07 21:48:07 +0100135 const struct mbus_dram_target_info *dram)
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -0400136{
137 int i;
138
139 for (i = 0; i < 4; i++) {
140 wrl(USB_WINDOW_CTRL(i), 0);
141 wrl(USB_WINDOW_BASE(i), 0);
142 }
143
144 for (i = 0; i < dram->num_cs; i++) {
Andrew Lunn63a93322011-12-07 21:48:07 +0100145 const struct mbus_dram_window *cs = dram->cs + i;
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -0400146
147 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
148 (cs->mbus_attr << 8) |
149 (dram->mbus_dram_target_id << 4) | 1);
150 wrl(USB_WINDOW_BASE(i), cs->base);
151 }
152}
153
Gregory CLEMENTac069662014-05-15 12:17:28 +0200154static const struct ehci_driver_overrides orion_overrides __initconst = {
155 .extra_priv_size = sizeof(struct orion_ehci_hcd),
156};
157
Bill Pemberton41ac7b32012-11-19 13:21:48 -0500158static int ehci_orion_drv_probe(struct platform_device *pdev)
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500159{
Jingoo Hand4f09e22013-07-30 19:59:40 +0900160 struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
Andrew Lunn63a93322011-12-07 21:48:07 +0100161 const struct mbus_dram_target_info *dram;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500162 struct resource *res;
163 struct usb_hcd *hcd;
164 struct ehci_hcd *ehci;
165 void __iomem *regs;
166 int irq, err;
Andrew Lunn77dae542012-10-20 13:10:00 +0200167 enum orion_ehci_phy_ver phy_version;
Gregory CLEMENTac069662014-05-15 12:17:28 +0200168 struct orion_ehci_hcd *priv;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500169
170 if (usb_disabled())
171 return -ENODEV;
172
173 pr_debug("Initializing Orion-SoC USB Host Controller\n");
174
Thomas Petazzoni88bf6b32014-05-15 12:17:26 +0200175 irq = platform_get_irq(pdev, 0);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500176 if (irq <= 0) {
177 dev_err(&pdev->dev,
178 "Found HC with no IRQ. Check %s setup!\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +0200179 dev_name(&pdev->dev));
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500180 err = -ENODEV;
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200181 goto err;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500182 }
183
Andrew Lunn77dae542012-10-20 13:10:00 +0200184 /*
185 * Right now device-tree probed devices don't get dma_mask
186 * set. Since shared usb code relies on it, set it here for
187 * now. Once we have dma capability bindings this can go away.
188 */
Russell Kinge1fd7342013-06-27 12:36:37 +0100189 err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
Russell King22d9d8e2013-06-10 16:28:49 +0100190 if (err)
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200191 goto err;
Andrew Lunn77dae542012-10-20 13:10:00 +0200192
Varka Bhadram69b89c62014-11-04 07:51:24 +0530193 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Jingoo Han806f6e62013-12-11 16:16:33 +0900194 regs = devm_ioremap_resource(&pdev->dev, res);
195 if (IS_ERR(regs)) {
196 err = PTR_ERR(regs);
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200197 goto err;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500198 }
199
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500200 hcd = usb_create_hcd(&ehci_orion_hc_driver,
Kay Sievers7071a3c2008-05-02 06:02:41 +0200201 &pdev->dev, dev_name(&pdev->dev));
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500202 if (!hcd) {
203 err = -ENOMEM;
Gregory CLEMENTac069662014-05-15 12:17:28 +0200204 goto err;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500205 }
206
207 hcd->rsrc_start = res->start;
H Hartley Sweeten5672b7e2009-12-14 18:13:00 -0500208 hcd->rsrc_len = resource_size(res);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500209 hcd->regs = regs;
210
211 ehci = hcd_to_ehci(hcd);
212 ehci->caps = hcd->regs + 0x100;
Alan Sterna8e51772008-05-20 16:58:11 -0400213 hcd->has_tt = 1;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500214
Gregory CLEMENTac069662014-05-15 12:17:28 +0200215 priv = hcd_to_orion_priv(hcd);
216 /*
217 * Not all platforms can gate the clock, so it is not an error if
218 * the clock does not exists.
219 */
220 priv->clk = devm_clk_get(&pdev->dev, NULL);
221 if (!IS_ERR(priv->clk))
222 clk_prepare_enable(priv->clk);
223
Gregory CLEMENTd4459132014-05-15 12:17:29 +0200224 priv->phy = devm_phy_optional_get(&pdev->dev, "usb");
225 if (IS_ERR(priv->phy)) {
226 err = PTR_ERR(priv->phy);
Jonas Gorskidb1319e2015-08-23 15:01:08 +0200227 if (err != -ENOSYS)
228 goto err_phy_get;
Gregory CLEMENTd4459132014-05-15 12:17:29 +0200229 } else {
230 err = phy_init(priv->phy);
231 if (err)
232 goto err_phy_init;
233
234 err = phy_power_on(priv->phy);
235 if (err)
236 goto err_phy_power_on;
237 }
238
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500239 /*
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -0400240 * (Re-)program MBUS remapping windows if we are asked to.
241 */
Andrew Lunn63a93322011-12-07 21:48:07 +0100242 dram = mv_mbus_dram_info();
243 if (dram)
244 ehci_orion_conf_mbus_windows(hcd, dram);
Lennert Buytenhek92aecfa2008-03-27 14:51:39 -0400245
246 /*
Ronen Shitritfb6f5522008-09-17 10:08:05 +0300247 * setup Orion USB controller.
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500248 */
Andrew Lunn77dae542012-10-20 13:10:00 +0200249 if (pdev->dev.of_node)
250 phy_version = EHCI_PHY_NA;
251 else
252 phy_version = pd->phy_version;
253
254 switch (phy_version) {
Ronen Shitritfb6f5522008-09-17 10:08:05 +0300255 case EHCI_PHY_NA: /* dont change USB phy settings */
256 break;
257 case EHCI_PHY_ORION:
258 orion_usb_phy_v1_setup(hcd);
259 break;
260 case EHCI_PHY_DD:
261 case EHCI_PHY_KW:
262 default:
Jingoo Hanfb53e942013-12-10 21:20:30 +0900263 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
Ronen Shitritfb6f5522008-09-17 10:08:05 +0300264 }
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500265
Yong Zhangb5dd18d2011-09-07 16:10:52 +0800266 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500267 if (err)
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200268 goto err_add_hcd;
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500269
Peter Chen3c9740a2013-11-05 10:46:02 +0800270 device_wakeup_enable(hcd->self.controller);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500271 return 0;
272
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200273err_add_hcd:
Gregory CLEMENTd4459132014-05-15 12:17:29 +0200274 if (!IS_ERR(priv->phy))
275 phy_power_off(priv->phy);
276err_phy_power_on:
277 if (!IS_ERR(priv->phy))
278 phy_exit(priv->phy);
279err_phy_init:
280err_phy_get:
Gregory CLEMENTac069662014-05-15 12:17:28 +0200281 if (!IS_ERR(priv->clk))
282 clk_disable_unprepare(priv->clk);
Jingoo Han806f6e62013-12-11 16:16:33 +0900283 usb_put_hcd(hcd);
Thomas Petazzonid8ea69e2014-05-15 12:17:27 +0200284err:
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500285 dev_err(&pdev->dev, "init %s fail, %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +0200286 dev_name(&pdev->dev), err);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500287
288 return err;
289}
290
Dmitry Torokhov39d35682013-02-24 00:55:07 -0800291static int ehci_orion_drv_remove(struct platform_device *pdev)
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500292{
293 struct usb_hcd *hcd = platform_get_drvdata(pdev);
Gregory CLEMENTac069662014-05-15 12:17:28 +0200294 struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500295
296 usb_remove_hcd(hcd);
Gregory CLEMENTac069662014-05-15 12:17:28 +0200297
Gregory CLEMENTd4459132014-05-15 12:17:29 +0200298 if (!IS_ERR(priv->phy)) {
299 phy_power_off(priv->phy);
300 phy_exit(priv->phy);
301 }
302
Gregory CLEMENTac069662014-05-15 12:17:28 +0200303 if (!IS_ERR(priv->clk))
304 clk_disable_unprepare(priv->clk);
305
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500306 usb_put_hcd(hcd);
307
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500308 return 0;
309}
310
Greg Kroah-Hartman59a609a2012-12-21 13:14:52 -0800311static const struct of_device_id ehci_orion_dt_ids[] = {
Andrew Lunn77dae542012-10-20 13:10:00 +0200312 { .compatible = "marvell,orion-ehci", },
313 {},
314};
315MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
316
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500317static struct platform_driver ehci_orion_driver = {
318 .probe = ehci_orion_drv_probe,
Dmitry Torokhov39d35682013-02-24 00:55:07 -0800319 .remove = ehci_orion_drv_remove,
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500320 .shutdown = usb_hcd_platform_shutdown,
Andrew Lunn77dae542012-10-20 13:10:00 +0200321 .driver = {
322 .name = "orion-ehci",
Sachin Kamata703d7e2013-05-21 17:17:18 +0530323 .of_match_table = ehci_orion_dt_ids,
Andrew Lunn77dae542012-10-20 13:10:00 +0200324 },
Tzachi Perelsteine96ffe22007-12-01 11:07:04 -0500325};
Manjunath Goudara76dd462013-04-02 18:23:59 +0200326
327static int __init ehci_orion_init(void)
328{
329 if (usb_disabled())
330 return -ENODEV;
331
332 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
333
Gregory CLEMENTac069662014-05-15 12:17:28 +0200334 ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
Manjunath Goudara76dd462013-04-02 18:23:59 +0200335 return platform_driver_register(&ehci_orion_driver);
336}
337module_init(ehci_orion_init);
338
339static void __exit ehci_orion_cleanup(void)
340{
341 platform_driver_unregister(&ehci_orion_driver);
342}
343module_exit(ehci_orion_cleanup);
344
345MODULE_DESCRIPTION(DRIVER_DESC);
346MODULE_ALIAS("platform:orion-ehci");
347MODULE_AUTHOR("Tzachi Perelstein");
348MODULE_LICENSE("GPL v2");