USB: add Marvell Orion USB host support

Some glue bits for the on-chip USB host controller in the Marvell Orion
family of ARM SoCs, which is basically EHCI compatible.

Signed-off-by: Tzachi Perelstein <tzachi@marvell.com>
Reviewed-by: Lennert Buytenhek <buytenh@marvell.com>
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

1 files changed, 272 insertions, 0 deletions

diff --git a/drivers/usb/host/ehci-orion.c b/drivers/usb/host/ehci-orion.c
new file mode 100644
index 000000000000..e129981f139f
--- /dev/null
+++ b/drivers/usb/host/ehci-orion.c
@@ -0,0 +1,272 @@
+/*
+ * drivers/usb/host/ehci-orion.c
+ *
+ * Tzachi Perelstein <tzachi@marvell.com>
+ *
+ * This file is licensed under  the terms of the GNU General Public
+ * License version 2. This program is licensed "as is" without any
+ * warranty of any kind, whether express or implied.
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <asm/arch/orion.h>
+
+#define rdl(off)        __raw_readl(hcd->regs + (off))
+#define wrl(off, val)   __raw_writel((val), hcd->regs + (off))
+
+#define USB_CAUSE               0x310
+#define USB_MASK                0x314
+#define USB_CMD                 0x140
+#define USB_MODE                0x1a8
+#define USB_IPG                 0x360
+#define USB_PHY_PWR_CTRL        0x400
+#define USB_PHY_TX_CTRL         0x420
+#define USB_PHY_RX_CTRL         0x430
+#define USB_PHY_IVREF_CTRL      0x440
+#define USB_PHY_TST_GRP_CTRL    0x450
+
+/*
+ * Implement Orion USB controller specification guidelines
+ */
+static void orion_usb_setup(struct usb_hcd *hcd)
+{
+        /*
+         * Clear interrupt cause and mask
+         */
+        wrl(USB_CAUSE, 0);
+        wrl(USB_MASK, 0);
+
+        /*
+         * Reset controller
+         */
+        wrl(USB_CMD, rdl(USB_CMD) | 0x2);
+        while (rdl(USB_CMD) & 0x2);
+
+        /*
+         * GL# USB-10: Set IPG for non start of frame packets
+         * Bits[14:8]=0xc
+         */
+        wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
+
+        /*
+         * GL# USB-9: USB 2.0 Power Control
+         * BG_VSEL[7:6]=0x1
+         */
+        wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
+
+        /*
+         * GL# USB-1: USB PHY Tx Control - force calibration to '8'
+         * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
+         */
+        wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
+
+        /*
+         * GL# USB-3 GL# USB-9: USB PHY Rx Control
+         * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
+         * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
+         */
+        wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
+
+        /*
+         * GL# USB-3 GL# USB-9: USB PHY IVREF Control
+         * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
+         */
+        wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
+
+        /*
+         * GL# USB-3 GL# USB-9: USB PHY Test Group Control
+         * REG_FIFO_SQ_RST[15]=0
+         */
+        wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
+
+        /*
+         * Stop and reset controller
+         */
+        wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
+        wrl(USB_CMD, rdl(USB_CMD) | 0x2);
+        while (rdl(USB_CMD) & 0x2);
+
+        /*
+         * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
+         * TBD: This need to be done after each reset!
+         * GL# USB-4 Setup USB Host mode
+         */
+        wrl(USB_MODE, 0x13);
+}
+
+static int ehci_orion_setup(struct usb_hcd *hcd)
+{
+        struct ehci_hcd *ehci = hcd_to_ehci(hcd);
+        int retval;
+
+        retval = ehci_halt(ehci);
+        if (retval)
+                return retval;
+
+        /*
+         * data structure init
+         */
+        retval = ehci_init(hcd);
+        if (retval)
+                return retval;
+
+        ehci_reset(ehci);
+        ehci_port_power(ehci, 0);
+
+        return retval;
+}
+
+static const struct hc_driver ehci_orion_hc_driver = {
+        .description = hcd_name,
+        .product_desc = "Marvell Orion EHCI",
+        .hcd_priv_size = sizeof(struct ehci_hcd),
+
+        /*
+         * generic hardware linkage
+         */
+        .irq = ehci_irq,
+        .flags = HCD_MEMORY | HCD_USB2,
+
+        /*
+         * basic lifecycle operations
+         */
+        .reset = ehci_orion_setup,
+        .start = ehci_run,
+#ifdef CONFIG_PM
+        .suspend = ehci_bus_suspend,
+        .resume = ehci_bus_resume,
+#endif
+        .stop = ehci_stop,
+        .shutdown = ehci_shutdown,
+
+        /*
+         * managing i/o requests and associated device resources
+         */
+        .urb_enqueue = ehci_urb_enqueue,
+        .urb_dequeue = ehci_urb_dequeue,
+        .endpoint_disable = ehci_endpoint_disable,
+
+        /*
+         * scheduling support
+         */
+        .get_frame_number = ehci_get_frame,
+
+        /*
+         * root hub support
+         */
+        .hub_status_data = ehci_hub_status_data,
+        .hub_control = ehci_hub_control,
+        .bus_suspend = ehci_bus_suspend,
+        .bus_resume = ehci_bus_resume,
+};
+
+static int __init ehci_orion_drv_probe(struct platform_device *pdev)
+{
+        struct resource *res;
+        struct usb_hcd *hcd;
+        struct ehci_hcd *ehci;
+        void __iomem *regs;
+        int irq, err;
+
+        if (usb_disabled())
+                return -ENODEV;
+
+        pr_debug("Initializing Orion-SoC USB Host Controller\n");
+
+        irq = platform_get_irq(pdev, 0);
+        if (irq <= 0) {
+                dev_err(&pdev->dev,
+                        "Found HC with no IRQ. Check %s setup!\n",
+                        pdev->dev.bus_id);
+                err = -ENODEV;
+                goto err1;
+        }
+
+        res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+        if (!res) {
+                dev_err(&pdev->dev,
+                        "Found HC with no register addr. Check %s setup!\n",
+                        pdev->dev.bus_id);
+                err = -ENODEV;
+                goto err1;
+        }
+
+        if (!request_mem_region(res->start, res->end - res->start + 1,
+                                ehci_orion_hc_driver.description)) {
+                dev_dbg(&pdev->dev, "controller already in use\n");
+                err = -EBUSY;
+                goto err1;
+        }
+
+        regs = ioremap(res->start, res->end - res->start + 1);
+        if (regs == NULL) {
+                dev_dbg(&pdev->dev, "error mapping memory\n");
+                err = -EFAULT;
+                goto err2;
+        }
+
+        hcd = usb_create_hcd(&ehci_orion_hc_driver,
+                        &pdev->dev, pdev->dev.bus_id);
+        if (!hcd) {
+                err = -ENOMEM;
+                goto err3;
+        }
+
+        hcd->rsrc_start = res->start;
+        hcd->rsrc_len = res->end - res->start + 1;
+        hcd->regs = regs;
+
+        ehci = hcd_to_ehci(hcd);
+        ehci->caps = hcd->regs + 0x100;
+        ehci->regs = hcd->regs + 0x100 +
+                HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
+        ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
+        ehci->is_tdi_rh_tt = 1;
+        ehci->sbrn = 0x20;
+
+        /*
+         * setup Orion USB controller
+         */
+        orion_usb_setup(hcd);
+
+        err = usb_add_hcd(hcd, irq, IRQF_SHARED | IRQF_DISABLED);
+        if (err)
+                goto err4;
+
+        return 0;
+
+err4:
+        usb_put_hcd(hcd);
+err3:
+        iounmap(regs);
+err2:
+        release_mem_region(res->start, res->end - res->start + 1);
+err1:
+        dev_err(&pdev->dev, "init %s fail, %d\n",
+                pdev->dev.bus_id, err);
+
+        return err;
+}
+
+static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
+{
+        struct usb_hcd *hcd = platform_get_drvdata(pdev);
+
+        usb_remove_hcd(hcd);
+        iounmap(hcd->regs);
+        release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
+        usb_put_hcd(hcd);
+
+        return 0;
+}
+
+MODULE_ALIAS("platform:orion-ehci");
+
+static struct platform_driver ehci_orion_driver = {
+        .probe          = ehci_orion_drv_probe,
+        .remove         = __exit_p(ehci_orion_drv_remove),
+        .shutdown       = usb_hcd_platform_shutdown,
+        .driver.name    = "orion-ehci",
+};