2 * drivers/usb/host/ehci-orion.c
4 * Tzachi Perelstein <tzachi@marvell.com>
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.
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>
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>
24 #include <linux/dma-mapping.h>
28 #define rdl(off) readl_relaxed(hcd->regs + (off))
29 #define wrl(off, val) writel_relaxed((val), hcd->regs + (off))
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))
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
44 #define DRIVER_DESC "EHCI orion driver"
46 #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
48 struct orion_ehci_hcd
{
53 static const char hcd_name
[] = "ehci-orion";
55 static struct hc_driver __read_mostly ehci_orion_hc_driver
;
58 * Implement Orion USB controller specification guidelines
60 static void orion_usb_phy_v1_setup(struct usb_hcd
*hcd
)
62 /* The below GLs are according to the Orion Errata document */
64 * Clear interrupt cause and mask
72 wrl(USB_CMD
, rdl(USB_CMD
) | 0x2);
73 while (rdl(USB_CMD
) & 0x2);
76 * GL# USB-10: Set IPG for non start of frame packets
79 wrl(USB_IPG
, (rdl(USB_IPG
) & ~0x7f00) | 0xc00);
82 * GL# USB-9: USB 2.0 Power Control
85 wrl(USB_PHY_PWR_CTRL
, (rdl(USB_PHY_PWR_CTRL
) & ~0xc0)| 0x40);
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
91 wrl(USB_PHY_TX_CTRL
, (rdl(USB_PHY_TX_CTRL
) & ~0x78) | 0x202040);
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
98 wrl(USB_PHY_RX_CTRL
, (rdl(USB_PHY_RX_CTRL
) & ~0xc2003f0) | 0xc0000010);
101 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
102 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
104 wrl(USB_PHY_IVREF_CTRL
, (rdl(USB_PHY_IVREF_CTRL
) & ~0x80003 ) | 0x32);
107 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
108 * REG_FIFO_SQ_RST[15]=0
110 wrl(USB_PHY_TST_GRP_CTRL
, rdl(USB_PHY_TST_GRP_CTRL
) & ~0x8000);
113 * Stop and reset controller
115 wrl(USB_CMD
, rdl(USB_CMD
) & ~0x1);
116 wrl(USB_CMD
, rdl(USB_CMD
) | 0x2);
117 while (rdl(USB_CMD
) & 0x2);
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
128 ehci_orion_conf_mbus_windows(struct usb_hcd
*hcd
,
129 const struct mbus_dram_target_info
*dram
)
133 for (i
= 0; i
< 4; i
++) {
134 wrl(USB_WINDOW_CTRL(i
), 0);
135 wrl(USB_WINDOW_BASE(i
), 0);
138 for (i
= 0; i
< dram
->num_cs
; i
++) {
139 const struct mbus_dram_window
*cs
= dram
->cs
+ i
;
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
);
148 static const struct ehci_driver_overrides orion_overrides __initconst
= {
149 .extra_priv_size
= sizeof(struct orion_ehci_hcd
),
152 static int ehci_orion_drv_probe(struct platform_device
*pdev
)
154 struct orion_ehci_data
*pd
= dev_get_platdata(&pdev
->dev
);
155 const struct mbus_dram_target_info
*dram
;
156 struct resource
*res
;
158 struct ehci_hcd
*ehci
;
161 enum orion_ehci_phy_ver phy_version
;
162 struct orion_ehci_hcd
*priv
;
167 pr_debug("Initializing Orion-SoC USB Host Controller\n");
169 irq
= platform_get_irq(pdev
, 0);
172 "Found HC with no IRQ. Check %s setup!\n",
173 dev_name(&pdev
->dev
));
179 * Right now device-tree probed devices don't get dma_mask
180 * set. Since shared usb code relies on it, set it here for
181 * now. Once we have dma capability bindings this can go away.
183 err
= dma_coerce_mask_and_coherent(&pdev
->dev
, DMA_BIT_MASK(32));
187 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
188 regs
= devm_ioremap_resource(&pdev
->dev
, res
);
194 hcd
= usb_create_hcd(&ehci_orion_hc_driver
,
195 &pdev
->dev
, dev_name(&pdev
->dev
));
201 hcd
->rsrc_start
= res
->start
;
202 hcd
->rsrc_len
= resource_size(res
);
205 ehci
= hcd_to_ehci(hcd
);
206 ehci
->caps
= hcd
->regs
+ 0x100;
209 priv
= hcd_to_orion_priv(hcd
);
211 * Not all platforms can gate the clock, so it is not an error if
212 * the clock does not exists.
214 priv
->clk
= devm_clk_get(&pdev
->dev
, NULL
);
215 if (!IS_ERR(priv
->clk
))
216 clk_prepare_enable(priv
->clk
);
218 priv
->phy
= devm_phy_optional_get(&pdev
->dev
, "usb");
219 if (IS_ERR(priv
->phy
)) {
220 err
= PTR_ERR(priv
->phy
);
223 err
= phy_init(priv
->phy
);
227 err
= phy_power_on(priv
->phy
);
229 goto err_phy_power_on
;
233 * (Re-)program MBUS remapping windows if we are asked to.
235 dram
= mv_mbus_dram_info();
237 ehci_orion_conf_mbus_windows(hcd
, dram
);
240 * setup Orion USB controller.
242 if (pdev
->dev
.of_node
)
243 phy_version
= EHCI_PHY_NA
;
245 phy_version
= pd
->phy_version
;
247 switch (phy_version
) {
248 case EHCI_PHY_NA
: /* dont change USB phy settings */
251 orion_usb_phy_v1_setup(hcd
);
256 dev_warn(&pdev
->dev
, "USB phy version isn't supported.\n");
259 err
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
263 device_wakeup_enable(hcd
->self
.controller
);
267 if (!IS_ERR(priv
->phy
))
268 phy_power_off(priv
->phy
);
270 if (!IS_ERR(priv
->phy
))
274 if (!IS_ERR(priv
->clk
))
275 clk_disable_unprepare(priv
->clk
);
278 dev_err(&pdev
->dev
, "init %s fail, %d\n",
279 dev_name(&pdev
->dev
), err
);
284 static int ehci_orion_drv_remove(struct platform_device
*pdev
)
286 struct usb_hcd
*hcd
= platform_get_drvdata(pdev
);
287 struct orion_ehci_hcd
*priv
= hcd_to_orion_priv(hcd
);
291 if (!IS_ERR(priv
->phy
)) {
292 phy_power_off(priv
->phy
);
296 if (!IS_ERR(priv
->clk
))
297 clk_disable_unprepare(priv
->clk
);
304 static const struct of_device_id ehci_orion_dt_ids
[] = {
305 { .compatible
= "marvell,orion-ehci", },
308 MODULE_DEVICE_TABLE(of
, ehci_orion_dt_ids
);
310 static struct platform_driver ehci_orion_driver
= {
311 .probe
= ehci_orion_drv_probe
,
312 .remove
= ehci_orion_drv_remove
,
313 .shutdown
= usb_hcd_platform_shutdown
,
315 .name
= "orion-ehci",
316 .of_match_table
= ehci_orion_dt_ids
,
320 static int __init
ehci_orion_init(void)
325 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
327 ehci_init_driver(&ehci_orion_hc_driver
, &orion_overrides
);
328 return platform_driver_register(&ehci_orion_driver
);
330 module_init(ehci_orion_init
);
332 static void __exit
ehci_orion_cleanup(void)
334 platform_driver_unregister(&ehci_orion_driver
);
336 module_exit(ehci_orion_cleanup
);
338 MODULE_DESCRIPTION(DRIVER_DESC
);
339 MODULE_ALIAS("platform:orion-ehci");
340 MODULE_AUTHOR("Tzachi Perelstein");
341 MODULE_LICENSE("GPL v2");