drivers/usb/host/ehci-orion.c

   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)        readl_relaxed(hcd->regs + (off))
  29 #define wrl(off, val)   writel_relaxed((val), hcd->regs + (off))
  30
  31 #define USB_CMD                 0x140
  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))
  43 #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
  50 #define USB_SBUSCFG             0x90
  51
  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)
  57
  58 #define USB_SBUSCFG_DEF_VAL (USB_SBUSCFG_BAWR_ALIGN_128B        \
  59                              | USB_SBUSCFG_BARD_ALIGN_128B      \
  60                              | USB_SBUSCFG_AHBBRST_INCR16)
  61
  62 #define DRIVER_DESC "EHCI orion driver"
  63
  64 #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
  65
  66 struct orion_ehci_hcd {
  67         struct clk *clk;
  68         struct phy *phy;
  69 };
  70
  71 static const char hcd_name[] = "ehci-orion";
  72
  73 static struct hc_driver __read_mostly ehci_orion_hc_driver;
  74
  75 /*
  76  * Implement Orion USB controller specification guidelines
  77  */
  78 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
  79 {
  80         /* The below GLs are according to the Orion Errata document */
  81         /*
  82          * Clear interrupt cause and mask
  83          */
  84         wrl(USB_CAUSE, 0);
  85         wrl(USB_MASK, 0);
  86
  87         /*
  88          * Reset controller
  89          */
  90         wrl(USB_CMD, rdl(USB_CMD) | USB_CMD_RESET);
  91         while (rdl(USB_CMD) & USB_CMD_RESET);
  92
  93         /*
  94          * GL# USB-10: Set IPG for non start of frame packets
  95          * Bits[14:8]=0xc
  96          */
  97         wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
  98
  99         /*
 100          * GL# USB-9: USB 2.0 Power Control
 101          * BG_VSEL[7:6]=0x1
 102          */
 103         wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
 104
 105         /*
 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
 108          */
 109         wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
 110
 111         /*
 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
 115          */
 116         wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
 117
 118         /*
 119          * GL# USB-3 GL# USB-9: USB PHY IVREF Control
 120          * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
 121          */
 122         wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
 123
 124         /*
 125          * GL# USB-3 GL# USB-9: USB PHY Test Group Control
 126          * REG_FIFO_SQ_RST[15]=0
 127          */
 128         wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
 129
 130         /*
 131          * Stop and reset controller
 132          */
 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);
 136
 137         /*
 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
 141          */
 142         wrl(USB_MODE, USB_MODE_SDIS | USB_MODE_HOST);
 143 }
 144
 145 static void
 146 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
 147                              const struct mbus_dram_target_info *dram)
 148 {
 149         int i;
 150
 151         for (i = 0; i < 4; i++) {
 152                 wrl(USB_WINDOW_CTRL(i), 0);
 153                 wrl(USB_WINDOW_BASE(i), 0);
 154         }
 155
 156         for (i = 0; i < dram->num_cs; i++) {
 157                 const struct mbus_dram_window *cs = dram->cs + i;
 158
 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);
 163         }
 164 }
 165
 166 static int ehci_orion_drv_reset(struct usb_hcd *hcd)
 167 {
 168         struct device *dev = hcd->self.controller;
 169         int ret;
 170
 171         ret = ehci_setup(hcd);
 172         if (ret)
 173                 return ret;
 174
 175         /*
 176          * For SoC without hlock, need to program sbuscfg value to guarantee
 177          * AHB master's burst would not overrun or underrun FIFO.
 178          *
 179          * sbuscfg reg has to be set after usb controller reset, otherwise
 180          * the value would be override to 0.
 181          */
 182         if (of_device_is_compatible(dev->of_node, "marvell,armada-3700-ehci"))
 183                 wrl(USB_SBUSCFG, USB_SBUSCFG_DEF_VAL);
 184
 185         return ret;
 186 }
 187
 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,
 191 };
 192
 193 static int ehci_orion_drv_probe(struct platform_device *pdev)
 194 {
 195         struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
 196         const struct mbus_dram_target_info *dram;
 197         struct resource *res;
 198         struct usb_hcd *hcd;
 199         struct ehci_hcd *ehci;
 200         void __iomem *regs;
 201         int irq, err;
 202         enum orion_ehci_phy_ver phy_version;
 203         struct orion_ehci_hcd *priv;
 204
 205         if (usb_disabled())
 206                 return -ENODEV;
 207
 208         pr_debug("Initializing Orion-SoC USB Host Controller\n");
 209
 210         irq = platform_get_irq(pdev, 0);
 211         if (irq <= 0) {
 212                 dev_err(&pdev->dev,
 213                         "Found HC with no IRQ. Check %s setup!\n",
 214                         dev_name(&pdev->dev));
 215                 err = -ENODEV;
 216                 goto err;
 217         }
 218
 219         /*
 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.
 223          */
 224         err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 225         if (err)
 226                 goto err;
 227
 228         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 229         regs = devm_ioremap_resource(&pdev->dev, res);
 230         if (IS_ERR(regs)) {
 231                 err = PTR_ERR(regs);
 232                 goto err;
 233         }
 234
 235         hcd = usb_create_hcd(&ehci_orion_hc_driver,
 236                         &pdev->dev, dev_name(&pdev->dev));
 237         if (!hcd) {
 238                 err = -ENOMEM;
 239                 goto err;
 240         }
 241
 242         hcd->rsrc_start = res->start;
 243         hcd->rsrc_len = resource_size(res);
 244         hcd->regs = regs;
 245
 246         ehci = hcd_to_ehci(hcd);
 247         ehci->caps = hcd->regs + 0x100;
 248         hcd->has_tt = 1;
 249
 250         priv = hcd_to_orion_priv(hcd);
 251         /*
 252          * Not all platforms can gate the clock, so it is not an error if
 253          * the clock does not exists.
 254          */
 255         priv->clk = devm_clk_get(&pdev->dev, NULL);
 256         if (!IS_ERR(priv->clk))
 257                 clk_prepare_enable(priv->clk);
 258
 259         priv->phy = devm_phy_optional_get(&pdev->dev, "usb");
 260         if (IS_ERR(priv->phy)) {
 261                 err = PTR_ERR(priv->phy);
 262                 if (err != -ENOSYS)
 263                         goto err_phy_get;
 264         } else {
 265                 err = phy_init(priv->phy);
 266                 if (err)
 267                         goto err_phy_init;
 268
 269                 err = phy_power_on(priv->phy);
 270                 if (err)
 271                         goto err_phy_power_on;
 272         }
 273
 274         /*
 275          * (Re-)program MBUS remapping windows if we are asked to.
 276          */
 277         dram = mv_mbus_dram_info();
 278         if (dram)
 279                 ehci_orion_conf_mbus_windows(hcd, dram);
 280
 281         /*
 282          * setup Orion USB controller.
 283          */
 284         if (pdev->dev.of_node)
 285                 phy_version = EHCI_PHY_NA;
 286         else
 287                 phy_version = pd->phy_version;
 288
 289         switch (phy_version) {
 290         case EHCI_PHY_NA:       /* dont change USB phy settings */
 291                 break;
 292         case EHCI_PHY_ORION:
 293                 orion_usb_phy_v1_setup(hcd);
 294                 break;
 295         case EHCI_PHY_DD:
 296         case EHCI_PHY_KW:
 297         default:
 298                 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
 299         }
 300
 301         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 302         if (err)
 303                 goto err_add_hcd;
 304
 305         device_wakeup_enable(hcd->self.controller);
 306         return 0;
 307
 308 err_add_hcd:
 309         if (!IS_ERR(priv->phy))
 310                 phy_power_off(priv->phy);
 311 err_phy_power_on:
 312         if (!IS_ERR(priv->phy))
 313                 phy_exit(priv->phy);
 314 err_phy_init:
 315 err_phy_get:
 316         if (!IS_ERR(priv->clk))
 317                 clk_disable_unprepare(priv->clk);
 318         usb_put_hcd(hcd);
 319 err:
 320         dev_err(&pdev->dev, "init %s fail, %d\n",
 321                 dev_name(&pdev->dev), err);
 322
 323         return err;
 324 }
 325
 326 static int ehci_orion_drv_remove(struct platform_device *pdev)
 327 {
 328         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 329         struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
 330
 331         usb_remove_hcd(hcd);
 332
 333         if (!IS_ERR(priv->phy)) {
 334                 phy_power_off(priv->phy);
 335                 phy_exit(priv->phy);
 336         }
 337
 338         if (!IS_ERR(priv->clk))
 339                 clk_disable_unprepare(priv->clk);
 340
 341         usb_put_hcd(hcd);
 342
 343         return 0;
 344 }
 345
 346 static const struct of_device_id ehci_orion_dt_ids[] = {
 347         { .compatible = "marvell,orion-ehci", },
 348         { .compatible = "marvell,armada-3700-ehci", },
 349         {},
 350 };
 351 MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
 352
 353 static struct platform_driver ehci_orion_driver = {
 354         .probe          = ehci_orion_drv_probe,
 355         .remove         = ehci_orion_drv_remove,
 356         .shutdown       = usb_hcd_platform_shutdown,
 357         .driver = {
 358                 .name   = "orion-ehci",
 359                 .of_match_table = ehci_orion_dt_ids,
 360         },
 361 };
 362
 363 static int __init ehci_orion_init(void)
 364 {
 365         if (usb_disabled())
 366                 return -ENODEV;
 367
 368         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 369
 370         ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
 371         return platform_driver_register(&ehci_orion_driver);
 372 }
 373 module_init(ehci_orion_init);
 374
 375 static void __exit ehci_orion_cleanup(void)
 376 {
 377         platform_driver_unregister(&ehci_orion_driver);
 378 }
 379 module_exit(ehci_orion_cleanup);
 380
 381 MODULE_DESCRIPTION(DRIVER_DESC);
 382 MODULE_ALIAS("platform:orion-ehci");
 383 MODULE_AUTHOR("Tzachi Perelstein");
 384 MODULE_LICENSE("GPL v2");