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 <plat/ehci-orion.h>
  17
  18 #define rdl(off)        __raw_readl(hcd->regs + (off))
  19 #define wrl(off, val)   __raw_writel((val), hcd->regs + (off))
  20
  21 #define USB_CMD                 0x140
  22 #define USB_MODE                0x1a8
  23 #define USB_CAUSE               0x310
  24 #define USB_MASK                0x314
  25 #define USB_WINDOW_CTRL(i)      (0x320 + ((i) << 4))
  26 #define USB_WINDOW_BASE(i)      (0x324 + ((i) << 4))
  27 #define USB_IPG                 0x360
  28 #define USB_PHY_PWR_CTRL        0x400
  29 #define USB_PHY_TX_CTRL         0x420
  30 #define USB_PHY_RX_CTRL         0x430
  31 #define USB_PHY_IVREF_CTRL      0x440
  32 #define USB_PHY_TST_GRP_CTRL    0x450
  33
  34 /*
  35  * Implement Orion USB controller specification guidelines
  36  */
  37 static void orion_usb_phy_v1_setup(struct usb_hcd *hcd)
  38 {
  39         /* The below GLs are according to the Orion Errata document */
  40         /*
  41          * Clear interrupt cause and mask
  42          */
  43         wrl(USB_CAUSE, 0);
  44         wrl(USB_MASK, 0);
  45
  46         /*
  47          * Reset controller
  48          */
  49         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
  50         while (rdl(USB_CMD) & 0x2);
  51
  52         /*
  53          * GL# USB-10: Set IPG for non start of frame packets
  54          * Bits[14:8]=0xc
  55          */
  56         wrl(USB_IPG, (rdl(USB_IPG) & ~0x7f00) | 0xc00);
  57
  58         /*
  59          * GL# USB-9: USB 2.0 Power Control
  60          * BG_VSEL[7:6]=0x1
  61          */
  62         wrl(USB_PHY_PWR_CTRL, (rdl(USB_PHY_PWR_CTRL) & ~0xc0)| 0x40);
  63
  64         /*
  65          * GL# USB-1: USB PHY Tx Control - force calibration to '8'
  66          * TXDATA_BLOCK_EN[21]=0x1, EXT_RCAL_EN[13]=0x1, IMP_CAL[6:3]=0x8
  67          */
  68         wrl(USB_PHY_TX_CTRL, (rdl(USB_PHY_TX_CTRL) & ~0x78) | 0x202040);
  69
  70         /*
  71          * GL# USB-3 GL# USB-9: USB PHY Rx Control
  72          * RXDATA_BLOCK_LENGHT[31:30]=0x3, EDGE_DET_SEL[27:26]=0,
  73          * CDR_FASTLOCK_EN[21]=0, DISCON_THRESHOLD[9:8]=0, SQ_THRESH[7:4]=0x1
  74          */
  75         wrl(USB_PHY_RX_CTRL, (rdl(USB_PHY_RX_CTRL) & ~0xc2003f0) | 0xc0000010);
  76
  77         /*
  78          * GL# USB-3 GL# USB-9: USB PHY IVREF Control
  79          * PLLVDD12[1:0]=0x2, RXVDD[5:4]=0x3, Reserved[19]=0
  80          */
  81         wrl(USB_PHY_IVREF_CTRL, (rdl(USB_PHY_IVREF_CTRL) & ~0x80003 ) | 0x32);
  82
  83         /*
  84          * GL# USB-3 GL# USB-9: USB PHY Test Group Control
  85          * REG_FIFO_SQ_RST[15]=0
  86          */
  87         wrl(USB_PHY_TST_GRP_CTRL, rdl(USB_PHY_TST_GRP_CTRL) & ~0x8000);
  88
  89         /*
  90          * Stop and reset controller
  91          */
  92         wrl(USB_CMD, rdl(USB_CMD) & ~0x1);
  93         wrl(USB_CMD, rdl(USB_CMD) | 0x2);
  94         while (rdl(USB_CMD) & 0x2);
  95
  96         /*
  97          * GL# USB-5 Streaming disable REG_USB_MODE[4]=1
  98          * TBD: This need to be done after each reset!
  99          * GL# USB-4 Setup USB Host mode
 100          */
 101         wrl(USB_MODE, 0x13);
 102 }
 103
 104 static int ehci_orion_setup(struct usb_hcd *hcd)
 105 {
 106         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 107         int retval;
 108
 109         hcd->has_tt = 1;
 110
 111         retval = ehci_halt(ehci);
 112         if (retval)
 113                 return retval;
 114
 115         /*
 116          * data structure init
 117          */
 118         retval = ehci_init(hcd);
 119         if (retval)
 120                 return retval;
 121
 122         ehci_reset(ehci);
 123
 124         ehci_port_power(ehci, 0);
 125
 126         return retval;
 127 }
 128
 129 static const struct hc_driver ehci_orion_hc_driver = {
 130         .description = hcd_name,
 131         .product_desc = "Marvell Orion EHCI",
 132         .hcd_priv_size = sizeof(struct ehci_hcd),
 133
 134         /*
 135          * generic hardware linkage
 136          */
 137         .irq = ehci_irq,
 138         .flags = HCD_MEMORY | HCD_USB2,
 139
 140         /*
 141          * basic lifecycle operations
 142          */
 143         .reset = ehci_orion_setup,
 144         .start = ehci_run,
 145         .stop = ehci_stop,
 146         .shutdown = ehci_shutdown,
 147
 148         /*
 149          * managing i/o requests and associated device resources
 150          */
 151         .urb_enqueue = ehci_urb_enqueue,
 152         .urb_dequeue = ehci_urb_dequeue,
 153         .endpoint_disable = ehci_endpoint_disable,
 154         .endpoint_reset = ehci_endpoint_reset,
 155
 156         /*
 157          * scheduling support
 158          */
 159         .get_frame_number = ehci_get_frame,
 160
 161         /*
 162          * root hub support
 163          */
 164         .hub_status_data = ehci_hub_status_data,
 165         .hub_control = ehci_hub_control,
 166         .bus_suspend = ehci_bus_suspend,
 167         .bus_resume = ehci_bus_resume,
 168         .relinquish_port = ehci_relinquish_port,
 169         .port_handed_over = ehci_port_handed_over,
 170
 171         .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
 172 };
 173
 174 static void __init
 175 ehci_orion_conf_mbus_windows(struct usb_hcd *hcd,
 176                              const struct mbus_dram_target_info *dram)
 177 {
 178         int i;
 179
 180         for (i = 0; i < 4; i++) {
 181                 wrl(USB_WINDOW_CTRL(i), 0);
 182                 wrl(USB_WINDOW_BASE(i), 0);
 183         }
 184
 185         for (i = 0; i < dram->num_cs; i++) {
 186                 const struct mbus_dram_window *cs = dram->cs + i;
 187
 188                 wrl(USB_WINDOW_CTRL(i), ((cs->size - 1) & 0xffff0000) |
 189                                         (cs->mbus_attr << 8) |
 190                                         (dram->mbus_dram_target_id << 4) | 1);
 191                 wrl(USB_WINDOW_BASE(i), cs->base);
 192         }
 193 }
 194
 195 static int __devinit ehci_orion_drv_probe(struct platform_device *pdev)
 196 {
 197         struct orion_ehci_data *pd = pdev->dev.platform_data;
 198         const struct mbus_dram_target_info *dram;
 199         struct resource *res;
 200         struct usb_hcd *hcd;
 201         struct ehci_hcd *ehci;
 202         struct clk *clk;
 203         void __iomem *regs;
 204         int irq, err;
 205
 206         if (usb_disabled())
 207                 return -ENODEV;
 208
 209         pr_debug("Initializing Orion-SoC USB Host Controller\n");
 210
 211         irq = platform_get_irq(pdev, 0);
 212         if (irq <= 0) {
 213                 dev_err(&pdev->dev,
 214                         "Found HC with no IRQ. Check %s setup!\n",
 215                         dev_name(&pdev->dev));
 216                 err = -ENODEV;
 217                 goto err1;
 218         }
 219
 220         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 221         if (!res) {
 222                 dev_err(&pdev->dev,
 223                         "Found HC with no register addr. Check %s setup!\n",
 224                         dev_name(&pdev->dev));
 225                 err = -ENODEV;
 226                 goto err1;
 227         }
 228
 229         if (!request_mem_region(res->start, resource_size(res),
 230                                 ehci_orion_hc_driver.description)) {
 231                 dev_dbg(&pdev->dev, "controller already in use\n");
 232                 err = -EBUSY;
 233                 goto err1;
 234         }
 235
 236         regs = ioremap(res->start, resource_size(res));
 237         if (regs == NULL) {
 238                 dev_dbg(&pdev->dev, "error mapping memory\n");
 239                 err = -EFAULT;
 240                 goto err2;
 241         }
 242
 243         /* Not all platforms can gate the clock, so it is not
 244            an error if the clock does not exists. */
 245         clk = clk_get(&pdev->dev, NULL);
 246         if (!IS_ERR(clk)) {
 247                 clk_prepare_enable(clk);
 248                 clk_put(clk);
 249         }
 250
 251         hcd = usb_create_hcd(&ehci_orion_hc_driver,
 252                         &pdev->dev, dev_name(&pdev->dev));
 253         if (!hcd) {
 254                 err = -ENOMEM;
 255                 goto err3;
 256         }
 257
 258         hcd->rsrc_start = res->start;
 259         hcd->rsrc_len = resource_size(res);
 260         hcd->regs = regs;
 261
 262         ehci = hcd_to_ehci(hcd);
 263         ehci->caps = hcd->regs + 0x100;
 264         ehci->regs = hcd->regs + 0x100 +
 265                 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 266         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
 267         hcd->has_tt = 1;
 268         ehci->sbrn = 0x20;
 269
 270         /*
 271          * (Re-)program MBUS remapping windows if we are asked to.
 272          */
 273         dram = mv_mbus_dram_info();
 274         if (dram)
 275                 ehci_orion_conf_mbus_windows(hcd, dram);
 276
 277         /*
 278          * setup Orion USB controller.
 279          */
 280         switch (pd->phy_version) {
 281         case EHCI_PHY_NA:       /* dont change USB phy settings */
 282                 break;
 283         case EHCI_PHY_ORION:
 284                 orion_usb_phy_v1_setup(hcd);
 285                 break;
 286         case EHCI_PHY_DD:
 287         case EHCI_PHY_KW:
 288         default:
 289                 printk(KERN_WARNING "Orion ehci -USB phy version isn't supported.\n");
 290         }
 291
 292         err = usb_add_hcd(hcd, irq, IRQF_SHARED);
 293         if (err)
 294                 goto err4;
 295
 296         return 0;
 297
 298 err4:
 299         usb_put_hcd(hcd);
 300 err3:
 301         iounmap(regs);
 302 err2:
 303         release_mem_region(res->start, resource_size(res));
 304 err1:
 305         dev_err(&pdev->dev, "init %s fail, %d\n",
 306                 dev_name(&pdev->dev), err);
 307
 308         return err;
 309 }
 310
 311 static int __exit ehci_orion_drv_remove(struct platform_device *pdev)
 312 {
 313         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 314         struct clk *clk;
 315
 316         usb_remove_hcd(hcd);
 317         iounmap(hcd->regs);
 318         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 319         usb_put_hcd(hcd);
 320
 321         clk = clk_get(&pdev->dev, NULL);
 322         if (!IS_ERR(clk)) {
 323                 clk_disable_unprepare(clk);
 324                 clk_put(clk);
 325         }
 326         return 0;
 327 }
 328
 329 MODULE_ALIAS("platform:orion-ehci");
 330
 331 static struct platform_driver ehci_orion_driver = {
 332         .probe          = ehci_orion_drv_probe,
 333         .remove         = __exit_p(ehci_orion_drv_remove),
 334         .shutdown       = usb_hcd_platform_shutdown,
 335         .driver.name    = "orion-ehci",
 336 };