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