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_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  */
  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
 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
 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         /*
 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.
 182          */
 183         err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 184         if (err)
 185                 goto err;
 186
 187         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 188         regs = devm_ioremap_resource(&pdev->dev, res);
 189         if (IS_ERR(regs)) {
 190                 err = PTR_ERR(regs);
 191                 goto err;
 192         }
 193
 194         hcd = usb_create_hcd(&ehci_orion_hc_driver,
 195                         &pdev->dev, dev_name(&pdev->dev));
 196         if (!hcd) {
 197                 err = -ENOMEM;
 198                 goto err;
 199         }
 200
 201         hcd->rsrc_start = res->start;
 202         hcd->rsrc_len = resource_size(res);
 203         hcd->regs = regs;
 204
 205         ehci = hcd_to_ehci(hcd);
 206         ehci->caps = hcd->regs + 0x100;
 207         hcd->has_tt = 1;
 208
 209         priv = hcd_to_orion_priv(hcd);
 210         /*
 211          * Not all platforms can gate the clock, so it is not an error if
 212          * the clock does not exists.
 213          */
 214         priv->clk = devm_clk_get(&pdev->dev, NULL);
 215         if (!IS_ERR(priv->clk))
 216                 clk_prepare_enable(priv->clk);
 217
 218         priv->phy = devm_phy_optional_get(&pdev->dev, "usb");
 219         if (IS_ERR(priv->phy)) {
 220                 err = PTR_ERR(priv->phy);
 221                 goto err_phy_get;
 222         } else {
 223                 err = phy_init(priv->phy);
 224                 if (err)
 225                         goto err_phy_init;
 226
 227                 err = phy_power_on(priv->phy);
 228                 if (err)
 229                         goto err_phy_power_on;
 230         }
 231
 232         /*
 233          * (Re-)program MBUS remapping windows if we are asked to.
 234          */
 235         dram = mv_mbus_dram_info();
 236         if (dram)
 237                 ehci_orion_conf_mbus_windows(hcd, dram);
 238
 239         /*
 240          * setup Orion USB controller.
 241          */
 242         if (pdev->dev.of_node)
 243                 phy_version = EHCI_PHY_NA;
 244         else
 245                 phy_version = pd->phy_version;
 246
 247         switch (phy_version) {
 248         case EHCI_PHY_NA:       /* dont change USB phy settings */
 249                 break;
 250         case EHCI_PHY_ORION:
 251                 orion_usb_phy_v1_setup(hcd);
 252                 break;
 253         case EHCI_PHY_DD:
 254         case EHCI_PHY_KW:
 255         default:
 256                 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
 257         }
 258
 259         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 260         if (err)
 261                 goto err_add_hcd;
 262
 263         device_wakeup_enable(hcd->self.controller);
 264         return 0;
 265
 266 err_add_hcd:
 267         if (!IS_ERR(priv->phy))
 268                 phy_power_off(priv->phy);
 269 err_phy_power_on:
 270         if (!IS_ERR(priv->phy))
 271                 phy_exit(priv->phy);
 272 err_phy_init:
 273 err_phy_get:
 274         if (!IS_ERR(priv->clk))
 275                 clk_disable_unprepare(priv->clk);
 276         usb_put_hcd(hcd);
 277 err:
 278         dev_err(&pdev->dev, "init %s fail, %d\n",
 279                 dev_name(&pdev->dev), err);
 280
 281         return err;
 282 }
 283
 284 static int ehci_orion_drv_remove(struct platform_device *pdev)
 285 {
 286         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 287         struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
 288
 289         usb_remove_hcd(hcd);
 290
 291         if (!IS_ERR(priv->phy)) {
 292                 phy_power_off(priv->phy);
 293                 phy_exit(priv->phy);
 294         }
 295
 296         if (!IS_ERR(priv->clk))
 297                 clk_disable_unprepare(priv->clk);
 298
 299         usb_put_hcd(hcd);
 300
 301         return 0;
 302 }
 303
 304 static const struct of_device_id ehci_orion_dt_ids[] = {
 305         { .compatible = "marvell,orion-ehci", },
 306         {},
 307 };
 308 MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
 309
 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,
 314         .driver = {
 315                 .name   = "orion-ehci",
 316                 .of_match_table = ehci_orion_dt_ids,
 317         },
 318 };
 319
 320 static int __init ehci_orion_init(void)
 321 {
 322         if (usb_disabled())
 323                 return -ENODEV;
 324
 325         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 326
 327         ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
 328         return platform_driver_register(&ehci_orion_driver);
 329 }
 330 module_init(ehci_orion_init);
 331
 332 static void __exit ehci_orion_cleanup(void)
 333 {
 334         platform_driver_unregister(&ehci_orion_driver);
 335 }
 336 module_exit(ehci_orion_cleanup);
 337
 338 MODULE_DESCRIPTION(DRIVER_DESC);
 339 MODULE_ALIAS("platform:orion-ehci");
 340 MODULE_AUTHOR("Tzachi Perelstein");
 341 MODULE_LICENSE("GPL v2");