drivers/usb/host/ehci-fsl.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2009, 2011, 2016 Freescale Semiconductor, Inc.
   4  *
   5  * (C) Copyright 2008, Excito Elektronik i Sk=E5ne AB
   6  *
   7  * Author: Tor Krill tor@excito.com
   8  */
   9
  10 #include <common.h>
  11 #include <env.h>
  12 #include <log.h>
  13 #include <pci.h>
  14 #include <usb.h>
  15 #include <asm/global_data.h>
  16 #include <asm/io.h>
  17 #include <linux/delay.h>
  18 #include <usb/ehci-ci.h>
  19 #include <hwconfig.h>
  20 #include <fsl_usb.h>
  21 #include <fdt_support.h>
  22 #include <dm.h>
  23
  24 #include "ehci.h"
  25
  26 DECLARE_GLOBAL_DATA_PTR;
  27
  28 struct ehci_fsl_priv {
  29         struct ehci_ctrl ehci;
  30         fdt_addr_t hcd_base;
  31         char *phy_type;
  32 };
  33
  34 static void set_txfifothresh(struct usb_ehci *, u32);
  35 static int ehci_fsl_init(struct ehci_fsl_priv *priv, struct usb_ehci *ehci,
  36                   struct ehci_hccr *hccr, struct ehci_hcor *hcor);
  37
  38 /* Check USB PHY clock valid */
  39 static int usb_phy_clk_valid(struct usb_ehci *ehci)
  40 {
  41         if (!((in_be32(&ehci->control) & PHY_CLK_VALID) ||
  42                         in_be32(&ehci->prictrl))) {
  43                 printf("USB PHY clock invalid!\n");
  44                 return 0;
  45         } else {
  46                 return 1;
  47         }
  48 }
  49
  50 static int ehci_fsl_of_to_plat(struct udevice *dev)
  51 {
  52         struct ehci_fsl_priv *priv = dev_get_priv(dev);
  53         const void *prop;
  54
  55         prop = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy_type",
  56                            NULL);
  57         if (prop) {
  58                 priv->phy_type = (char *)prop;
  59                 debug("phy_type %s\n", priv->phy_type);
  60         }
  61
  62         return 0;
  63 }
  64
  65 static int ehci_fsl_init_after_reset(struct ehci_ctrl *ctrl)
  66 {
  67         struct usb_ehci *ehci = NULL;
  68         struct ehci_fsl_priv *priv = container_of(ctrl, struct ehci_fsl_priv,
  69                                                    ehci);
  70 #ifdef CONFIG_PPC
  71         ehci = (struct usb_ehci *)lower_32_bits(priv->hcd_base);
  72 #else
  73         ehci = (struct usb_ehci *)priv->hcd_base;
  74 #endif
  75
  76         if (ehci_fsl_init(priv, ehci, priv->ehci.hccr, priv->ehci.hcor) < 0)
  77                 return -ENXIO;
  78
  79         return 0;
  80 }
  81
  82 static const struct ehci_ops fsl_ehci_ops = {
  83         .init_after_reset = ehci_fsl_init_after_reset,
  84 };
  85
  86 static int ehci_fsl_probe(struct udevice *dev)
  87 {
  88         struct ehci_fsl_priv *priv = dev_get_priv(dev);
  89         struct usb_ehci *ehci = NULL;
  90         struct ehci_hccr *hccr;
  91         struct ehci_hcor *hcor;
  92         struct ehci_ctrl *ehci_ctrl = &priv->ehci;
  93
  94         /*
  95          * Get the base address for EHCI controller from the device node
  96          */
  97         priv->hcd_base = dev_read_addr(dev);
  98         if (priv->hcd_base == FDT_ADDR_T_NONE) {
  99                 debug("Can't get the EHCI register base address\n");
 100                 return -ENXIO;
 101         }
 102 #ifdef CONFIG_PPC
 103         ehci = (struct usb_ehci *)lower_32_bits(priv->hcd_base);
 104 #else
 105         ehci = (struct usb_ehci *)priv->hcd_base;
 106 #endif
 107         hccr = (struct ehci_hccr *)(&ehci->caplength);
 108         hcor = (struct ehci_hcor *)
 109                 ((void *)hccr + HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
 110
 111         ehci_ctrl->has_fsl_erratum_a005275 = has_erratum_a005275();
 112
 113         if (ehci_fsl_init(priv, ehci, hccr, hcor) < 0)
 114                 return -ENXIO;
 115
 116         debug("ehci-fsl: init hccr %p and hcor %p hc_length %d\n",
 117               (void *)hccr, (void *)hcor,
 118               HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
 119
 120         return ehci_register(dev, hccr, hcor, &fsl_ehci_ops, 0, USB_INIT_HOST);
 121 }
 122
 123 static const struct udevice_id ehci_usb_ids[] = {
 124         { .compatible = "fsl-usb2-mph", },
 125         { .compatible = "fsl-usb2-dr", },
 126         { }
 127 };
 128
 129 U_BOOT_DRIVER(ehci_fsl) = {
 130         .name   = "ehci_fsl",
 131         .id     = UCLASS_USB,
 132         .of_match = ehci_usb_ids,
 133         .of_to_plat = ehci_fsl_of_to_plat,
 134         .probe = ehci_fsl_probe,
 135         .remove = ehci_deregister,
 136         .ops    = &ehci_usb_ops,
 137         .plat_auto      = sizeof(struct usb_plat),
 138         .priv_auto      = sizeof(struct ehci_fsl_priv),
 139         .flags  = DM_FLAG_ALLOC_PRIV_DMA,
 140 };
 141
 142 static int ehci_fsl_init(struct ehci_fsl_priv *priv, struct usb_ehci *ehci,
 143                   struct ehci_hccr *hccr, struct ehci_hcor *hcor)
 144 {
 145         const char *phy_type = NULL;
 146 #ifdef CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY
 147         char usb_phy[5];
 148
 149         usb_phy[0] = '\0';
 150 #endif
 151         if (has_erratum_a007075()) {
 152                 /*
 153                  * A 5ms delay is needed after applying soft-reset to the
 154                  * controller to let external ULPI phy come out of reset.
 155                  * This delay needs to be added before re-initializing
 156                  * the controller after soft-resetting completes
 157                  */
 158                 mdelay(5);
 159         }
 160
 161         /* Set to Host mode */
 162         setbits_le32(&ehci->usbmode, CM_HOST);
 163
 164         out_be32(&ehci->snoop1, SNOOP_SIZE_2GB);
 165         out_be32(&ehci->snoop2, 0x80000000 | SNOOP_SIZE_2GB);
 166
 167         /* Init phy */
 168         if (priv->phy_type)
 169                 phy_type = priv->phy_type;
 170         else
 171                 phy_type = env_get("usb_phy_type");
 172
 173         if (!phy_type) {
 174 #ifdef CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY
 175                 /* if none specified assume internal UTMI */
 176                 strcpy(usb_phy, "utmi");
 177                 phy_type = usb_phy;
 178 #else
 179                 printf("WARNING: USB phy type not defined !!\n");
 180                 return -1;
 181 #endif
 182         }
 183
 184         if (!strncmp(phy_type, "utmi", 4)) {
 185 #if defined(CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY)
 186                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 187                                 PHY_CLK_SEL_UTMI);
 188                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 189                                 UTMI_PHY_EN);
 190                 udelay(1000); /* delay required for PHY Clk to appear */
 191 #endif
 192                 out_le32(&(hcor)->or_portsc[0], PORT_PTS_UTMI);
 193                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 194                                 USB_EN);
 195         } else {
 196                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 197                                 PHY_CLK_SEL_ULPI);
 198                 clrsetbits_be32(&ehci->control, UTMI_PHY_EN |
 199                                 CONTROL_REGISTER_W1C_MASK, USB_EN);
 200                 udelay(1000); /* delay required for PHY Clk to appear */
 201                 if (!usb_phy_clk_valid(ehci))
 202                         return -EINVAL;
 203                 out_le32(&(hcor)->or_portsc[0], PORT_PTS_ULPI);
 204         }
 205
 206         out_be32(&ehci->prictrl, 0x0000000c);
 207         out_be32(&ehci->age_cnt_limit, 0x00000040);
 208         out_be32(&ehci->sictrl, 0x00000001);
 209
 210         in_le32(&ehci->usbmode);
 211
 212         if (has_erratum_a007798())
 213                 set_txfifothresh(ehci, TXFIFOTHRESH);
 214
 215         if (has_erratum_a004477()) {
 216                 /*
 217                  * When reset is issued while any ULPI transaction is ongoing
 218                  * then it may result to corruption of ULPI Function Control
 219                  * Register which eventually causes phy clock to enter low
 220                  * power mode which stops the clock. Thus delay is required
 221                  * before reset to let ongoing ULPI transaction complete.
 222                  */
 223                 udelay(1);
 224         }
 225         return 0;
 226 }
 227
 228 /*
 229  * Setting the value of TXFIFO_THRESH field in TXFILLTUNING register
 230  * to counter DDR latencies in writing data into Tx buffer.
 231  * This prevents Tx buffer from getting underrun
 232  */
 233 static void set_txfifothresh(struct usb_ehci *ehci, u32 txfifo_thresh)
 234 {
 235         u32 cmd;
 236         cmd = ehci_readl(&ehci->txfilltuning);
 237         cmd &= ~TXFIFO_THRESH_MASK;
 238         cmd |= TXFIFO_THRESH(txfifo_thresh);
 239         ehci_writel(&ehci->txfilltuning, cmd);
 240 }