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/of_device.h>
  19 #include <linux/of_irq.h>
  20 #include <linux/usb.h>
  21 #include <linux/usb/hcd.h>
  22 #include <linux/io.h>
  23 #include <linux/dma-mapping.h>
  24
  25 #include "ehci.h"
  26
  27 #define rdl(off)        __raw_readl(hcd->regs + (off))
  28 #define wrl(off, val)   __raw_writel((val), hcd->regs + (off))
  29
  30 #define USB_CMD                 0x140
  31 #define USB_MODE                0x1a8
  32 #define USB_CAUSE               0x310
  33 #define USB_MASK                0x314
  34 #define USB_WINDOW_CTRL(i)      (0x320 + ((i) << 4))
  35 #define USB_WINDOW_BASE(i)      (0x324 + ((i) << 4))
  36 #define USB_IPG                 0x360
  37 #define USB_PHY_PWR_CTRL        0x400
  38 #define USB_PHY_TX_CTRL         0x420
  39 #define USB_PHY_RX_CTRL         0x430
  40 #define USB_PHY_IVREF_CTRL      0x440
  41 #define USB_PHY_TST_GRP_CTRL    0x450
  42
  43 #define DRIVER_DESC "EHCI orion driver"
  44
  45 #define hcd_to_orion_priv(h) ((struct orion_ehci_hcd *)hcd_to_ehci(h)->priv)
  46
  47 struct orion_ehci_hcd {
  48         struct clk *clk;
  49 };
  50
  51 static const char hcd_name[] = "ehci-orion";
  52
  53 static struct hc_driver __read_mostly ehci_orion_hc_driver;
  54
  55 /*
  56  * Implement Orion USB controller specification guidelines
  57  */
  58 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
  59 {
  60         /* The below GLs are according to the Orion Errata document */
  61         /*
  62          * Clear interrupt cause and mask
  63          */
  64         wrl(USB_CAUSE, 0);
  65         wrl(USB_MASK, 0);
  66
  67         /*
  68          * Reset controller
  69          */
  70         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
  71         while (rdl(USB_CMD) & 0x2);
  72
  73         /*
  74          * GL# USB-10: Set IPG for non start of frame packets
  75          * Bits[14:8]=0xc
  76          */
  77         wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
  78
  79         /*
  80          * GL# USB-9: USB 2.0 Power Control
  81          * BG_VSEL[7:6]=0x1
  82          */
  83         wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
  84
  85         /*
  86          * GL# USB-1: USB PHY Tx Control - force calibration to '8'
  87          * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
  88          */
  89         wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
  90
  91         /*
  92          * GL# USB-3 GL# USB-9: USB PHY Rx Control
  93          * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
  94          * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
  95          */
  96         wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
  97
  98         /*
  99          * GL# USB-3 GL# USB-9: USB PHY IVREF Control
 100          * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
 101          */
 102         wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
 103
 104         /*
 105          * GL# USB-3 GL# USB-9: USB PHY Test Group Control
 106          * REG_FIFO_SQ_RST[15]=0
 107          */
 108         wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
 109
 110         /*
 111          * Stop and reset controller
 112          */
 113         wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
 114         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
 115         while (rdl(USB_CMD) & 0x2);
 116
 117         /*
 118          * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
 119          * TBD: This need to be done after each reset!
 120          * GL# USB-4 Setup USB Host mode
 121          */
 122         wrl(USB_MODE, 0x13);
 123 }
 124
 125 static void
 126 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
 127                              const struct mbus_dram_target_info *dram)
 128 {
 129         int i;
 130
 131         for (i = 0; i < 4; i++) {
 132                 wrl(USB_WINDOW_CTRL(i), 0);
 133                 wrl(USB_WINDOW_BASE(i), 0);
 134         }
 135
 136         for (i = 0; i < dram->num_cs; i++) {
 137                 const struct mbus_dram_window *cs = dram->cs + i;
 138
 139                 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
 140                                         (cs->mbus_attr << 8) |
 141                                         (dram->mbus_dram_target_id << 4) | 1);
 142                 wrl(USB_WINDOW_BASE(i), cs->base);
 143         }
 144 }
 145
 146 static const struct ehci_driver_overrides orion_overrides __initconst = {
 147         .extra_priv_size =      sizeof(struct orion_ehci_hcd),
 148 };
 149
 150 static int ehci_orion_drv_probe(struct platform_device *pdev)
 151 {
 152         struct orion_ehci_data *pd = dev_get_platdata(&pdev->dev);
 153         const struct mbus_dram_target_info *dram;
 154         struct resource *res;
 155         struct usb_hcd *hcd;
 156         struct ehci_hcd *ehci;
 157         void __iomem *regs;
 158         int irq, err;
 159         enum orion_ehci_phy_ver phy_version;
 160         struct orion_ehci_hcd *priv;
 161
 162         if (usb_disabled())
 163                 return -ENODEV;
 164
 165         pr_debug("Initializing Orion-SoC USB Host Controller\n");
 166
 167         irq = platform_get_irq(pdev, 0);
 168         if (irq <= 0) {
 169                 dev_err(&pdev->dev,
 170                         "Found HC with no IRQ. Check %s setup!\n",
 171                         dev_name(&pdev->dev));
 172                 err = -ENODEV;
 173                 goto err;
 174         }
 175
 176         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 177         if (!res) {
 178                 dev_err(&pdev->dev,
 179                         "Found HC with no register addr. Check %s setup!\n",
 180                         dev_name(&pdev->dev));
 181                 err = -ENODEV;
 182                 goto err;
 183         }
 184
 185         /*
 186          * Right now device-tree probed devices don't get dma_mask
 187          * set. Since shared usb code relies on it, set it here for
 188          * now. Once we have dma capability bindings this can go away.
 189          */
 190         err = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
 191         if (err)
 192                 goto err;
 193
 194         regs = devm_ioremap_resource(&pdev->dev, res);
 195         if (IS_ERR(regs)) {
 196                 err = PTR_ERR(regs);
 197                 goto err;
 198         }
 199
 200         hcd = usb_create_hcd(&ehci_orion_hc_driver,
 201                         &pdev->dev, dev_name(&pdev->dev));
 202         if (!hcd) {
 203                 err = -ENOMEM;
 204                 goto err;
 205         }
 206
 207         hcd->rsrc_start = res->start;
 208         hcd->rsrc_len = resource_size(res);
 209         hcd->regs = regs;
 210
 211         ehci = hcd_to_ehci(hcd);
 212         ehci->caps = hcd->regs + 0x100;
 213         hcd->has_tt = 1;
 214
 215         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
 224         /*
 225          * (Re-)program MBUS remapping windows if we are asked to.
 226          */
 227         dram = mv_mbus_dram_info();
 228         if (dram)
 229                 ehci_orion_conf_mbus_windows(hcd, dram);
 230
 231         /*
 232          * setup Orion USB controller.
 233          */
 234         if (pdev->dev.of_node)
 235                 phy_version = EHCI_PHY_NA;
 236         else
 237                 phy_version = pd->phy_version;
 238
 239         switch (phy_version) {
 240         case EHCI_PHY_NA:       /* dont change USB phy settings */
 241                 break;
 242         case EHCI_PHY_ORION:
 243                 orion_usb_phy_v1_setup(hcd);
 244                 break;
 245         case EHCI_PHY_DD:
 246         case EHCI_PHY_KW:
 247         default:
 248                 dev_warn(&pdev->dev, "USB phy version isn't supported.\n");
 249         }
 250
 251         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 252         if (err)
 253                 goto err_add_hcd;
 254
 255         device_wakeup_enable(hcd->self.controller);
 256         return 0;
 257
 258 err_add_hcd:
 259         if (!IS_ERR(priv->clk))
 260                 clk_disable_unprepare(priv->clk);
 261         usb_put_hcd(hcd);
 262 err:
 263         dev_err(&pdev->dev, "init %s fail, %d\n",
 264                 dev_name(&pdev->dev), err);
 265
 266         return err;
 267 }
 268
 269 static int ehci_orion_drv_remove(struct platform_device *pdev)
 270 {
 271         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 272         struct orion_ehci_hcd *priv = hcd_to_orion_priv(hcd);
 273
 274         usb_remove_hcd(hcd);
 275
 276         if (!IS_ERR(priv->clk))
 277                 clk_disable_unprepare(priv->clk);
 278
 279         usb_put_hcd(hcd);
 280
 281         return 0;
 282 }
 283
 284 static const struct of_device_id ehci_orion_dt_ids[] = {
 285         { .compatible = "marvell,orion-ehci", },
 286         {},
 287 };
 288 MODULE_DEVICE_TABLE(of, ehci_orion_dt_ids);
 289
 290 static struct platform_driver ehci_orion_driver = {
 291         .probe          = ehci_orion_drv_probe,
 292         .remove         = ehci_orion_drv_remove,
 293         .shutdown       = usb_hcd_platform_shutdown,
 294         .driver = {
 295                 .name   = "orion-ehci",
 296                 .owner  = THIS_MODULE,
 297                 .of_match_table = ehci_orion_dt_ids,
 298         },
 299 };
 300
 301 static int __init ehci_orion_init(void)
 302 {
 303         if (usb_disabled())
 304                 return -ENODEV;
 305
 306         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 307
 308         ehci_init_driver(&ehci_orion_hc_driver, &orion_overrides);
 309         return platform_driver_register(&ehci_orion_driver);
 310 }
 311 module_init(ehci_orion_init);
 312
 313 static void __exit ehci_orion_cleanup(void)
 314 {
 315         platform_driver_unregister(&ehci_orion_driver);
 316 }
 317 module_exit(ehci_orion_cleanup);
 318
 319 MODULE_DESCRIPTION(DRIVER_DESC);
 320 MODULE_ALIAS("platform:orion-ehci");
 321 MODULE_AUTHOR("Tzachi Perelstein");
 322 MODULE_LICENSE("GPL v2");