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_CMD_RUN BIT(0)
33 #define USB_CMD_RESET BIT(1)
34 #define USB_MODE 0x1a8
35 #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)
39 #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))
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
50 #define USB_SBUSCFG 0x90
52 /* BAWR = BARD = 3 : Align read/write bursts packets larger than 128 bytes */
53 #define USB_SBUSCFG_BAWR_ALIGN_128B (0x3 << 6)
54 #define USB_SBUSCFG_BARD_ALIGN_128B (0x3 << 3)
55 /* AHBBRST = 3 : Align AHB Burst to INCR16 (64 bytes) */
56 #define USB_SBUSCFG_AHBBRST_INCR16 (0x3 << 0)
58 #define USB_SBUSCFG_DEF_VAL (USB_SBUSCFG_BAWR_ALIGN_128B \
59 | USB_SBUSCFG_BARD_ALIGN_128B \
60 | USB_SBUSCFG_AHBBRST_INCR16)
62 #define DRIVER_DESC "EHCI orion driver"
64 #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
66 struct orion_ehci_hcd {
71 static const char hcd_name[] = "ehci-orion";
73 static struct hc_driver __read_mostly ehci_orion_hc_driver;
76 * Implement Orion USB controller specification guidelines
78 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
80 /* The below GLs are according to the Orion Errata document */
82 * Clear interrupt cause and mask
90 wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET);
91 while (rdl(USB_CMD) & USB_CMD_RESET);
94 * GL# USB-10: Set IPG for non start of frame packets
97 wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
100 * GL# USB-9: USB 2.0 Power Control
103 wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
106 * GL# USB-1: USB PHY Tx Control - force calibration to '8'
107 * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
109 wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
112 * GL# USB-3 GL# USB-9: USB PHY Rx Control
113 * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
114 * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
116 wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
119 * GL# USB-3 GL# USB-9: USB PHY IVREF Control
120 * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
122 wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
125 * GL# USB-3 GL# USB-9: USB PHY Test Group Control
126 * REG_FIFO_SQ_RST[15]=0
128 wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
131 * Stop and reset controller
133 wrl(USB_CMD, rdl(USB_CMD) & ~USB_CMD_RUN);
134 wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET);
135 while (rdl(USB_CMD) & USB_CMD_RESET);
138 * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
139 * TBD: This need to be done after each reset!
140 * GL# USB-4 Setup USB Host mode
142 wrl(USB_MODE, USB_MODE_SDIS | USB_MODE_HOST);
146 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
147 const struct mbus_dram_target_info *dram)
151 for (i = 0; i < 4; i++) {
152 wrl(USB_WINDOW_CTRL(i), 0);
153 wrl(USB_WINDOW_BASE(i), 0);
156 for (i = 0; i < dram->num_cs; i++) {
157 const struct mbus_dram_window *cs = dram->cs + i;
159 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
160 (cs->mbus_attr << 8) |
161 (dram->mbus_dram_target_id << 4) | 1);
162 wrl(USB_WINDOW_BASE(i), cs->base);
166 static int ehci_orion_drv_reset(struct usb_hcd *hcd)
168 struct device *dev = hcd->self.controller;
171 ret = ehci_setup(hcd);
176 * For SoC without hlock, need to program sbuscfg value to guarantee
177 * AHB master's burst would not overrun or underrun FIFO.
179 * sbuscfg reg has to be set after usb controller reset, otherwise
180 * the value would be override to 0.
182 if (of_device_is_compatible(dev->of_node, "marvell,armada-3700-ehci"))
183 wrl(USB_SBUSCFG, USB_SBUSCFG_DEF_VAL);
188 static const struct ehci_driver_overrides orion_overrides __initconst = {
189 .extra_priv_size = sizeof(struct orion_ehci_hcd),
190 .reset = ehci_orion_drv_reset,
193 static int ehci_orion_drv_probe(struct platform_device *pdev)
195 struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
196 const struct mbus_dram_target_info *dram;
197 struct resource *res;
199 struct ehci_hcd *ehci;
202 enum orion_ehci_phy_ver phy_version;
203 struct orion_ehci_hcd *priv;
208 pr_debug("Initializing Orion-SoC USB Host Controller\n");
210 irq = platform_get_irq(pdev, 0);
213 "Found HC with no IRQ. Check %s setup!\n",
214 dev_name(&pdev->dev));
220 * Right now device-tree probed devices don't get dma_mask
221 * set. Since shared usb code relies on it, set it here for
222 * now. Once we have dma capability bindings this can go away.
224 err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
228 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
229 regs = devm_ioremap_resource(&pdev->dev, res);
235 hcd = usb_create_hcd(&ehci_orion_hc_driver,
236 &pdev->dev, dev_name(&pdev->dev));
242 hcd->rsrc_start = res->start;
243 hcd->rsrc_len = resource_size(res);
246 ehci = hcd_to_ehci(hcd);
247 ehci->caps = hcd->regs + 0x100;
250 priv = hcd_to_orion_priv(hcd);
252 * Not all platforms can gate the clock, so it is not an error if
253 * the clock does not exists.
255 priv->clk = devm_clk_get(&pdev->dev, NULL);
256 if (!IS_ERR(priv->clk)) {
257 err = clk_prepare_enable(priv->clk);
262 priv->phy = devm_phy_optional_get(&pdev->dev, "usb");
263 if (IS_ERR(priv->phy)) {
264 err = PTR_ERR(priv->phy);
268 err = phy_init(priv->phy);
272 err = phy_power_on(priv->phy);
274 goto err_phy_power_on;
278 * (Re-)program MBUS remapping windows if we are asked to.
280 dram = mv_mbus_dram_info();
282 ehci_orion_conf_mbus_windows(hcd, dram);
285 * setup Orion USB controller.
287 if (pdev->dev.of_node)
288 phy_version = EHCI_PHY_NA;
290 phy_version = pd->phy_version;
292 switch (phy_version) {
293 case EHCI_PHY_NA: /* dont change USB phy settings */
296 orion_usb_phy_v1_setup(hcd);
301 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
304 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
308 device_wakeup_enable(hcd->self.controller);
312 if (!IS_ERR(priv->phy))
313 phy_power_off(priv->phy);
315 if (!IS_ERR(priv->phy))
319 if (!IS_ERR(priv->clk))
320 clk_disable_unprepare(priv->clk);
324 dev_err(&pdev->dev, "init %s fail, %d\n",
325 dev_name(&pdev->dev), err);
330 static int ehci_orion_drv_remove(struct platform_device *pdev)
332 struct usb_hcd *hcd = platform_get_drvdata(pdev);
333 struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
337 if (!IS_ERR(priv->phy)) {
338 phy_power_off(priv->phy);
342 if (!IS_ERR(priv->clk))
343 clk_disable_unprepare(priv->clk);
350 static const struct of_device_id ehci_orion_dt_ids[] = {
351 { .compatible = "marvell,orion-ehci", },
352 { .compatible = "marvell,armada-3700-ehci", },
355 MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
357 static struct platform_driver ehci_orion_driver = {
358 .probe = ehci_orion_drv_probe,
359 .remove = ehci_orion_drv_remove,
360 .shutdown = usb_hcd_platform_shutdown,
362 .name = "orion-ehci",
363 .of_match_table = ehci_orion_dt_ids,
367 static int __init ehci_orion_init(void)
372 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
374 ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
375 return platform_driver_register(&ehci_orion_driver);
377 module_init(ehci_orion_init);
379 static void __exit ehci_orion_cleanup(void)
381 platform_driver_unregister(&ehci_orion_driver);
383 module_exit(ehci_orion_cleanup);
385 MODULE_DESCRIPTION(DRIVER_DESC);
386 MODULE_ALIAS("platform:orion-ehci");
387 MODULE_AUTHOR("Tzachi Perelstein");
388 MODULE_LICENSE("GPL v2");