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