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/io.h>
  16 #include <usb/ehci-ci.h>
  17 #include <hwconfig.h>
  18 #include <fsl_usb.h>
  19 #include <fdt_support.h>
  20 #include <dm.h>
  21
  22 #include "ehci.h"
  23
  24 DECLARE_GLOBAL_DATA_PTR;
  25
  26 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
  27 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
  28 #endif
  29
  30 #if CONFIG_IS_ENABLED(DM_USB)
  31 struct ehci_fsl_priv {
  32         struct ehci_ctrl ehci;
  33         fdt_addr_t hcd_base;
  34         char *phy_type;
  35 };
  36 #endif
  37
  38 static void set_txfifothresh(struct usb_ehci *, u32);
  39 #if CONFIG_IS_ENABLED(DM_USB)
  40 static int ehci_fsl_init(struct ehci_fsl_priv *priv, struct usb_ehci *ehci,
  41                   struct ehci_hccr *hccr, struct ehci_hcor *hcor);
  42 #else
  43 static int ehci_fsl_init(int index, struct usb_ehci *ehci,
  44                          struct ehci_hccr *hccr, struct ehci_hcor *hcor);
  45 #endif
  46
  47 /* Check USB PHY clock valid */
  48 static int usb_phy_clk_valid(struct usb_ehci *ehci)
  49 {
  50         if (!((in_be32(&ehci->control) & PHY_CLK_VALID) ||
  51                         in_be32(&ehci->prictrl))) {
  52                 printf("USB PHY clock invalid!\n");
  53                 return 0;
  54         } else {
  55                 return 1;
  56         }
  57 }
  58
  59 #if CONFIG_IS_ENABLED(DM_USB)
  60 static int ehci_fsl_ofdata_to_platdata(struct udevice *dev)
  61 {
  62         struct ehci_fsl_priv *priv = dev_get_priv(dev);
  63         const void *prop;
  64
  65         prop = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy_type",
  66                            NULL);
  67         if (prop) {
  68                 priv->phy_type = (char *)prop;
  69                 debug("phy_type %s\n", priv->phy_type);
  70         }
  71
  72         return 0;
  73 }
  74
  75 static int ehci_fsl_init_after_reset(struct ehci_ctrl *ctrl)
  76 {
  77         struct usb_ehci *ehci = NULL;
  78         struct ehci_fsl_priv *priv = container_of(ctrl, struct ehci_fsl_priv,
  79                                                    ehci);
  80 #ifdef CONFIG_PPC
  81         ehci = (struct usb_ehci *)lower_32_bits(priv->hcd_base);
  82 #else
  83         ehci = (struct usb_ehci *)priv->hcd_base;
  84 #endif
  85
  86         if (ehci_fsl_init(priv, ehci, priv->ehci.hccr, priv->ehci.hcor) < 0)
  87                 return -ENXIO;
  88
  89         return 0;
  90 }
  91
  92 static const struct ehci_ops fsl_ehci_ops = {
  93         .init_after_reset = ehci_fsl_init_after_reset,
  94 };
  95
  96 static int ehci_fsl_probe(struct udevice *dev)
  97 {
  98         struct ehci_fsl_priv *priv = dev_get_priv(dev);
  99         struct usb_ehci *ehci = NULL;
 100         struct ehci_hccr *hccr;
 101         struct ehci_hcor *hcor;
 102         struct ehci_ctrl *ehci_ctrl = &priv->ehci;
 103
 104         /*
 105          * Get the base address for EHCI controller from the device node
 106          */
 107         priv->hcd_base = devfdt_get_addr(dev);
 108         if (priv->hcd_base == FDT_ADDR_T_NONE) {
 109                 debug("Can't get the EHCI register base address\n");
 110                 return -ENXIO;
 111         }
 112 #ifdef CONFIG_PPC
 113         ehci = (struct usb_ehci *)lower_32_bits(priv->hcd_base);
 114 #else
 115         ehci = (struct usb_ehci *)priv->hcd_base;
 116 #endif
 117         hccr = (struct ehci_hccr *)(&ehci->caplength);
 118         hcor = (struct ehci_hcor *)
 119                 ((void *)hccr + HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
 120
 121         ehci_ctrl->has_fsl_erratum_a005275 = has_erratum_a005275();
 122
 123         if (ehci_fsl_init(priv, ehci, hccr, hcor) < 0)
 124                 return -ENXIO;
 125
 126         debug("ehci-fsl: init hccr %p and hcor %p hc_length %d\n",
 127               (void *)hccr, (void *)hcor,
 128               HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
 129
 130         return ehci_register(dev, hccr, hcor, &fsl_ehci_ops, 0, USB_INIT_HOST);
 131 }
 132
 133 static const struct udevice_id ehci_usb_ids[] = {
 134         { .compatible = "fsl-usb2-mph", },
 135         { .compatible = "fsl-usb2-dr", },
 136         { }
 137 };
 138
 139 U_BOOT_DRIVER(ehci_fsl) = {
 140         .name   = "ehci_fsl",
 141         .id     = UCLASS_USB,
 142         .of_match = ehci_usb_ids,
 143         .ofdata_to_platdata = ehci_fsl_ofdata_to_platdata,
 144         .probe = ehci_fsl_probe,
 145         .remove = ehci_deregister,
 146         .ops    = &ehci_usb_ops,
 147         .platdata_auto_alloc_size = sizeof(struct usb_platdata),
 148         .priv_auto_alloc_size = sizeof(struct ehci_fsl_priv),
 149         .flags  = DM_FLAG_ALLOC_PRIV_DMA,
 150 };
 151 #else
 152 /*
 153  * Create the appropriate control structures to manage
 154  * a new EHCI host controller.
 155  *
 156  * Excerpts from linux ehci fsl driver.
 157  */
 158 int ehci_hcd_init(int index, enum usb_init_type init,
 159                 struct ehci_hccr **hccr, struct ehci_hcor **hcor)
 160 {
 161         struct ehci_ctrl *ehci_ctrl = container_of(hccr,
 162                                         struct ehci_ctrl, hccr);
 163         struct usb_ehci *ehci = NULL;
 164
 165         switch (index) {
 166         case 0:
 167                 ehci = (struct usb_ehci *)CONFIG_SYS_FSL_USB1_ADDR;
 168                 break;
 169         case 1:
 170                 ehci = (struct usb_ehci *)CONFIG_SYS_FSL_USB2_ADDR;
 171                 break;
 172         default:
 173                 printf("ERROR: wrong controller index!!\n");
 174                 return -EINVAL;
 175         };
 176
 177         *hccr = (struct ehci_hccr *)((uint32_t)&ehci->caplength);
 178         *hcor = (struct ehci_hcor *)((uint32_t) *hccr +
 179                         HC_LENGTH(ehci_readl(&(*hccr)->cr_capbase)));
 180
 181         ehci_ctrl->has_fsl_erratum_a005275 = has_erratum_a005275();
 182
 183         return ehci_fsl_init(index, ehci, *hccr, *hcor);
 184 }
 185
 186 /*
 187  * Destroy the appropriate control structures corresponding
 188  * the the EHCI host controller.
 189  */
 190 int ehci_hcd_stop(int index)
 191 {
 192         return 0;
 193 }
 194 #endif
 195
 196 #if CONFIG_IS_ENABLED(DM_USB)
 197 static int ehci_fsl_init(struct ehci_fsl_priv *priv, struct usb_ehci *ehci,
 198                   struct ehci_hccr *hccr, struct ehci_hcor *hcor)
 199 #else
 200 static int ehci_fsl_init(int index, struct usb_ehci *ehci,
 201                          struct ehci_hccr *hccr, struct ehci_hcor *hcor)
 202 #endif
 203 {
 204         const char *phy_type = NULL;
 205 #if !CONFIG_IS_ENABLED(DM_USB)
 206         size_t len;
 207         char current_usb_controller[5];
 208 #endif
 209 #ifdef CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY
 210         char usb_phy[5];
 211
 212         usb_phy[0] = '\0';
 213 #endif
 214         if (has_erratum_a007075()) {
 215                 /*
 216                  * A 5ms delay is needed after applying soft-reset to the
 217                  * controller to let external ULPI phy come out of reset.
 218                  * This delay needs to be added before re-initializing
 219                  * the controller after soft-resetting completes
 220                  */
 221                 mdelay(5);
 222         }
 223
 224         /* Set to Host mode */
 225         setbits_le32(&ehci->usbmode, CM_HOST);
 226
 227         out_be32(&ehci->snoop1, SNOOP_SIZE_2GB);
 228         out_be32(&ehci->snoop2, 0x80000000 | SNOOP_SIZE_2GB);
 229
 230         /* Init phy */
 231 #if CONFIG_IS_ENABLED(DM_USB)
 232         if (priv->phy_type)
 233                 phy_type = priv->phy_type;
 234 #else
 235         memset(current_usb_controller, '\0', 5);
 236         snprintf(current_usb_controller, sizeof(current_usb_controller),
 237                  "usb%d", index+1);
 238
 239         if (hwconfig_sub(current_usb_controller, "phy_type"))
 240                 phy_type = hwconfig_subarg(current_usb_controller,
 241                                 "phy_type", &len);
 242 #endif
 243         else
 244                 phy_type = env_get("usb_phy_type");
 245
 246         if (!phy_type) {
 247 #ifdef CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY
 248                 /* if none specified assume internal UTMI */
 249                 strcpy(usb_phy, "utmi");
 250                 phy_type = usb_phy;
 251 #else
 252                 printf("WARNING: USB phy type not defined !!\n");
 253                 return -1;
 254 #endif
 255         }
 256
 257         if (!strncmp(phy_type, "utmi", 4)) {
 258 #if defined(CONFIG_SYS_FSL_USB_INTERNAL_UTMI_PHY)
 259                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 260                                 PHY_CLK_SEL_UTMI);
 261                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 262                                 UTMI_PHY_EN);
 263                 udelay(1000); /* delay required for PHY Clk to appear */
 264 #endif
 265                 out_le32(&(hcor)->or_portsc[0], PORT_PTS_UTMI);
 266                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 267                                 USB_EN);
 268         } else {
 269                 clrsetbits_be32(&ehci->control, CONTROL_REGISTER_W1C_MASK,
 270                                 PHY_CLK_SEL_ULPI);
 271                 clrsetbits_be32(&ehci->control, UTMI_PHY_EN |
 272                                 CONTROL_REGISTER_W1C_MASK, USB_EN);
 273                 udelay(1000); /* delay required for PHY Clk to appear */
 274                 if (!usb_phy_clk_valid(ehci))
 275                         return -EINVAL;
 276                 out_le32(&(hcor)->or_portsc[0], PORT_PTS_ULPI);
 277         }
 278
 279         out_be32(&ehci->prictrl, 0x0000000c);
 280         out_be32(&ehci->age_cnt_limit, 0x00000040);
 281         out_be32(&ehci->sictrl, 0x00000001);
 282
 283         in_le32(&ehci->usbmode);
 284
 285         if (has_erratum_a007798())
 286                 set_txfifothresh(ehci, TXFIFOTHRESH);
 287
 288         if (has_erratum_a004477()) {
 289                 /*
 290                  * When reset is issued while any ULPI transaction is ongoing
 291                  * then it may result to corruption of ULPI Function Control
 292                  * Register which eventually causes phy clock to enter low
 293                  * power mode which stops the clock. Thus delay is required
 294                  * before reset to let ongoing ULPI transaction complete.
 295                  */
 296                 udelay(1);
 297         }
 298         return 0;
 299 }
 300
 301 /*
 302  * Setting the value of TXFIFO_THRESH field in TXFILLTUNING register
 303  * to counter DDR latencies in writing data into Tx buffer.
 304  * This prevents Tx buffer from getting underrun
 305  */
 306 static void set_txfifothresh(struct usb_ehci *ehci, u32 txfifo_thresh)
 307 {
 308         u32 cmd;
 309         cmd = ehci_readl(&ehci->txfilltuning);
 310         cmd &= ~TXFIFO_THRESH_MASK;
 311         cmd |= TXFIFO_THRESH(txfifo_thresh);
 312         ehci_writel(&ehci->txfilltuning, cmd);
 313 }