drivers/usb/dwc3/dwc3-generic.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Generic DWC3 Glue layer
   4  *
   5  * Copyright (C) 2016 - 2018 Xilinx, Inc.
   6  *
   7  * Based on dwc3-omap.c.
   8  */
   9
  10 #include <common.h>
  11 #include <cpu_func.h>
  12 #include <log.h>
  13 #include <asm-generic/io.h>
  14 #include <dm.h>
  15 #include <dm/device-internal.h>
  16 #include <dm/lists.h>
  17 #include <dwc3-uboot.h>
  18 #include <linux/bitops.h>
  19 #include <linux/usb/ch9.h>
  20 #include <linux/usb/gadget.h>
  21 #include <malloc.h>
  22 #include <usb.h>
  23 #include "core.h"
  24 #include "gadget.h"
  25 #include <reset.h>
  26 #include <clk.h>
  27 #include <usb/xhci.h>
  28
  29 struct dwc3_generic_plat {
  30         fdt_addr_t base;
  31         u32 maximum_speed;
  32         enum usb_dr_mode dr_mode;
  33 };
  34
  35 struct dwc3_generic_priv {
  36         void *base;
  37         struct dwc3 dwc3;
  38         struct phy_bulk phys;
  39 };
  40
  41 struct dwc3_generic_host_priv {
  42         struct xhci_ctrl xhci_ctrl;
  43         struct dwc3_generic_priv gen_priv;
  44 };
  45
  46 static int dwc3_generic_probe(struct udevice *dev,
  47                               struct dwc3_generic_priv *priv)
  48 {
  49         int rc;
  50         struct dwc3_generic_plat *plat = dev_get_platdata(dev);
  51         struct dwc3 *dwc3 = &priv->dwc3;
  52
  53         dwc3->dev = dev;
  54         dwc3->maximum_speed = plat->maximum_speed;
  55         dwc3->dr_mode = plat->dr_mode;
  56 #if CONFIG_IS_ENABLED(OF_CONTROL)
  57         dwc3_of_parse(dwc3);
  58 #endif
  59
  60         rc = dwc3_setup_phy(dev, &priv->phys);
  61         if (rc)
  62                 return rc;
  63
  64         priv->base = map_physmem(plat->base, DWC3_OTG_REGS_END, MAP_NOCACHE);
  65         dwc3->regs = priv->base + DWC3_GLOBALS_REGS_START;
  66
  67
  68         rc =  dwc3_init(dwc3);
  69         if (rc) {
  70                 unmap_physmem(priv->base, MAP_NOCACHE);
  71                 return rc;
  72         }
  73
  74         return 0;
  75 }
  76
  77 static int dwc3_generic_remove(struct udevice *dev,
  78                                struct dwc3_generic_priv *priv)
  79 {
  80         struct dwc3 *dwc3 = &priv->dwc3;
  81
  82         dwc3_remove(dwc3);
  83         dwc3_shutdown_phy(dev, &priv->phys);
  84         unmap_physmem(dwc3->regs, MAP_NOCACHE);
  85
  86         return 0;
  87 }
  88
  89 static int dwc3_generic_ofdata_to_platdata(struct udevice *dev)
  90 {
  91         struct dwc3_generic_plat *plat = dev_get_platdata(dev);
  92         ofnode node = dev->node;
  93
  94         plat->base = dev_read_addr(dev);
  95
  96         plat->maximum_speed = usb_get_maximum_speed(node);
  97         if (plat->maximum_speed == USB_SPEED_UNKNOWN) {
  98                 pr_info("No USB maximum speed specified. Using super speed\n");
  99                 plat->maximum_speed = USB_SPEED_SUPER;
 100         }
 101
 102         plat->dr_mode = usb_get_dr_mode(node);
 103         if (plat->dr_mode == USB_DR_MODE_UNKNOWN) {
 104                 pr_err("Invalid usb mode setup\n");
 105                 return -ENODEV;
 106         }
 107
 108         return 0;
 109 }
 110
 111 #if CONFIG_IS_ENABLED(DM_USB_GADGET)
 112 int dm_usb_gadget_handle_interrupts(struct udevice *dev)
 113 {
 114         struct dwc3_generic_priv *priv = dev_get_priv(dev);
 115         struct dwc3 *dwc3 = &priv->dwc3;
 116
 117         dwc3_gadget_uboot_handle_interrupt(dwc3);
 118
 119         return 0;
 120 }
 121
 122 static int dwc3_generic_peripheral_probe(struct udevice *dev)
 123 {
 124         struct dwc3_generic_priv *priv = dev_get_priv(dev);
 125
 126         return dwc3_generic_probe(dev, priv);
 127 }
 128
 129 static int dwc3_generic_peripheral_remove(struct udevice *dev)
 130 {
 131         struct dwc3_generic_priv *priv = dev_get_priv(dev);
 132
 133         return dwc3_generic_remove(dev, priv);
 134 }
 135
 136 U_BOOT_DRIVER(dwc3_generic_peripheral) = {
 137         .name   = "dwc3-generic-peripheral",
 138         .id     = UCLASS_USB_GADGET_GENERIC,
 139         .ofdata_to_platdata = dwc3_generic_ofdata_to_platdata,
 140         .probe = dwc3_generic_peripheral_probe,
 141         .remove = dwc3_generic_peripheral_remove,
 142         .priv_auto_alloc_size = sizeof(struct dwc3_generic_priv),
 143         .platdata_auto_alloc_size = sizeof(struct dwc3_generic_plat),
 144 };
 145 #endif
 146
 147 #if defined(CONFIG_SPL_USB_HOST_SUPPORT) || !defined(CONFIG_SPL_BUILD)
 148 static int dwc3_generic_host_probe(struct udevice *dev)
 149 {
 150         struct xhci_hcor *hcor;
 151         struct xhci_hccr *hccr;
 152         struct dwc3_generic_host_priv *priv = dev_get_priv(dev);
 153         int rc;
 154
 155         rc = dwc3_generic_probe(dev, &priv->gen_priv);
 156         if (rc)
 157                 return rc;
 158
 159         hccr = (struct xhci_hccr *)priv->gen_priv.base;
 160         hcor = (struct xhci_hcor *)(priv->gen_priv.base +
 161                         HC_LENGTH(xhci_readl(&(hccr)->cr_capbase)));
 162
 163         return xhci_register(dev, hccr, hcor);
 164 }
 165
 166 static int dwc3_generic_host_remove(struct udevice *dev)
 167 {
 168         struct dwc3_generic_host_priv *priv = dev_get_priv(dev);
 169         int rc;
 170
 171         rc = xhci_deregister(dev);
 172         if (rc)
 173                 return rc;
 174
 175         return dwc3_generic_remove(dev, &priv->gen_priv);
 176 }
 177
 178 U_BOOT_DRIVER(dwc3_generic_host) = {
 179         .name   = "dwc3-generic-host",
 180         .id     = UCLASS_USB,
 181         .ofdata_to_platdata = dwc3_generic_ofdata_to_platdata,
 182         .probe = dwc3_generic_host_probe,
 183         .remove = dwc3_generic_host_remove,
 184         .priv_auto_alloc_size = sizeof(struct dwc3_generic_host_priv),
 185         .platdata_auto_alloc_size = sizeof(struct dwc3_generic_plat),
 186         .ops = &xhci_usb_ops,
 187         .flags = DM_FLAG_ALLOC_PRIV_DMA,
 188 };
 189 #endif
 190
 191 struct dwc3_glue_data {
 192         struct clk_bulk         clks;
 193         struct reset_ctl_bulk   resets;
 194         fdt_addr_t regs;
 195 };
 196
 197 struct dwc3_glue_ops {
 198         void (*select_dr_mode)(struct udevice *dev, int index,
 199                                enum usb_dr_mode mode);
 200 };
 201
 202 void dwc3_ti_select_dr_mode(struct udevice *dev, int index,
 203                             enum usb_dr_mode mode)
 204 {
 205 #define USBOTGSS_UTMI_OTG_STATUS                0x0084
 206 #define USBOTGSS_UTMI_OTG_OFFSET                0x0480
 207
 208 /* UTMI_OTG_STATUS REGISTER */
 209 #define USBOTGSS_UTMI_OTG_STATUS_SW_MODE        BIT(31)
 210 #define USBOTGSS_UTMI_OTG_STATUS_POWERPRESENT   BIT(9)
 211 #define USBOTGSS_UTMI_OTG_STATUS_TXBITSTUFFENABLE BIT(8)
 212 #define USBOTGSS_UTMI_OTG_STATUS_IDDIG          BIT(4)
 213 #define USBOTGSS_UTMI_OTG_STATUS_SESSEND        BIT(3)
 214 #define USBOTGSS_UTMI_OTG_STATUS_SESSVALID      BIT(2)
 215 #define USBOTGSS_UTMI_OTG_STATUS_VBUSVALID      BIT(1)
 216 enum dwc3_omap_utmi_mode {
 217         DWC3_OMAP_UTMI_MODE_UNKNOWN = 0,
 218         DWC3_OMAP_UTMI_MODE_HW,
 219         DWC3_OMAP_UTMI_MODE_SW,
 220 };
 221
 222         u32 use_id_pin;
 223         u32 host_mode;
 224         u32 reg;
 225         u32 utmi_mode;
 226         u32 utmi_status_offset = USBOTGSS_UTMI_OTG_STATUS;
 227
 228         struct dwc3_glue_data *glue = dev_get_platdata(dev);
 229         void *base = map_physmem(glue->regs, 0x10000, MAP_NOCACHE);
 230
 231         if (device_is_compatible(dev, "ti,am437x-dwc3"))
 232                 utmi_status_offset += USBOTGSS_UTMI_OTG_OFFSET;
 233
 234         utmi_mode = dev_read_u32_default(dev, "utmi-mode",
 235                                          DWC3_OMAP_UTMI_MODE_UNKNOWN);
 236         if (utmi_mode != DWC3_OMAP_UTMI_MODE_HW) {
 237                 debug("%s: OTG is not supported. defaulting to PERIPHERAL\n",
 238                       dev->name);
 239                 mode = USB_DR_MODE_PERIPHERAL;
 240         }
 241
 242         switch (mode)  {
 243         case USB_DR_MODE_PERIPHERAL:
 244                 use_id_pin = 0;
 245                 host_mode = 0;
 246                 break;
 247         case USB_DR_MODE_HOST:
 248                 use_id_pin = 0;
 249                 host_mode = 1;
 250                 break;
 251         case USB_DR_MODE_OTG:
 252         default:
 253                 use_id_pin = 1;
 254                 host_mode = 0;
 255                 break;
 256         }
 257
 258         reg = readl(base + utmi_status_offset);
 259
 260         reg &= ~(USBOTGSS_UTMI_OTG_STATUS_SW_MODE);
 261         if (!use_id_pin)
 262                 reg |= USBOTGSS_UTMI_OTG_STATUS_SW_MODE;
 263
 264         writel(reg, base + utmi_status_offset);
 265
 266         reg &= ~(USBOTGSS_UTMI_OTG_STATUS_SESSEND |
 267                 USBOTGSS_UTMI_OTG_STATUS_VBUSVALID |
 268                 USBOTGSS_UTMI_OTG_STATUS_IDDIG);
 269
 270         reg |= USBOTGSS_UTMI_OTG_STATUS_SESSVALID |
 271                 USBOTGSS_UTMI_OTG_STATUS_POWERPRESENT;
 272
 273         if (!host_mode)
 274                 reg |= USBOTGSS_UTMI_OTG_STATUS_IDDIG |
 275                         USBOTGSS_UTMI_OTG_STATUS_VBUSVALID;
 276
 277         writel(reg, base + utmi_status_offset);
 278
 279         unmap_physmem(base, MAP_NOCACHE);
 280 }
 281
 282 struct dwc3_glue_ops ti_ops = {
 283         .select_dr_mode = dwc3_ti_select_dr_mode,
 284 };
 285
 286 static int dwc3_glue_bind(struct udevice *parent)
 287 {
 288         ofnode node;
 289         int ret;
 290
 291         ofnode_for_each_subnode(node, parent->node) {
 292                 const char *name = ofnode_get_name(node);
 293                 enum usb_dr_mode dr_mode;
 294                 struct udevice *dev;
 295                 const char *driver = NULL;
 296
 297                 debug("%s: subnode name: %s\n", __func__, name);
 298
 299                 dr_mode = usb_get_dr_mode(node);
 300
 301                 switch (dr_mode) {
 302                 case USB_DR_MODE_PERIPHERAL:
 303                 case USB_DR_MODE_OTG:
 304 #if CONFIG_IS_ENABLED(DM_USB_GADGET)
 305                         debug("%s: dr_mode: OTG or Peripheral\n", __func__);
 306                         driver = "dwc3-generic-peripheral";
 307 #endif
 308                         break;
 309 #if defined(CONFIG_SPL_USB_HOST_SUPPORT) || !defined(CONFIG_SPL_BUILD)
 310                 case USB_DR_MODE_HOST:
 311                         debug("%s: dr_mode: HOST\n", __func__);
 312                         driver = "dwc3-generic-host";
 313                         break;
 314 #endif
 315                 default:
 316                         debug("%s: unsupported dr_mode\n", __func__);
 317                         return -ENODEV;
 318                 };
 319
 320                 if (!driver)
 321                         continue;
 322
 323                 ret = device_bind_driver_to_node(parent, driver, name,
 324                                                  node, &dev);
 325                 if (ret) {
 326                         debug("%s: not able to bind usb device mode\n",
 327                               __func__);
 328                         return ret;
 329                 }
 330         }
 331
 332         return 0;
 333 }
 334
 335 static int dwc3_glue_reset_init(struct udevice *dev,
 336                                 struct dwc3_glue_data *glue)
 337 {
 338         int ret;
 339
 340         ret = reset_get_bulk(dev, &glue->resets);
 341         if (ret == -ENOTSUPP || ret == -ENOENT)
 342                 return 0;
 343         else if (ret)
 344                 return ret;
 345
 346         ret = reset_deassert_bulk(&glue->resets);
 347         if (ret) {
 348                 reset_release_bulk(&glue->resets);
 349                 return ret;
 350         }
 351
 352         return 0;
 353 }
 354
 355 static int dwc3_glue_clk_init(struct udevice *dev,
 356                               struct dwc3_glue_data *glue)
 357 {
 358         int ret;
 359
 360         ret = clk_get_bulk(dev, &glue->clks);
 361         if (ret == -ENOSYS || ret == -ENOENT)
 362                 return 0;
 363         if (ret)
 364                 return ret;
 365
 366 #if CONFIG_IS_ENABLED(CLK)
 367         ret = clk_enable_bulk(&glue->clks);
 368         if (ret) {
 369                 clk_release_bulk(&glue->clks);
 370                 return ret;
 371         }
 372 #endif
 373
 374         return 0;
 375 }
 376
 377 static int dwc3_glue_probe(struct udevice *dev)
 378 {
 379         struct dwc3_glue_ops *ops = (struct dwc3_glue_ops *)dev_get_driver_data(dev);
 380         struct dwc3_glue_data *glue = dev_get_platdata(dev);
 381         struct udevice *child = NULL;
 382         int index = 0;
 383         int ret;
 384
 385         glue->regs = dev_read_addr(dev);
 386
 387         ret = dwc3_glue_clk_init(dev, glue);
 388         if (ret)
 389                 return ret;
 390
 391         ret = dwc3_glue_reset_init(dev, glue);
 392         if (ret)
 393                 return ret;
 394
 395         ret = device_find_first_child(dev, &child);
 396         if (ret)
 397                 return ret;
 398
 399         while (child) {
 400                 enum usb_dr_mode dr_mode;
 401
 402                 dr_mode = usb_get_dr_mode(child->node);
 403                 device_find_next_child(&child);
 404                 if (ops && ops->select_dr_mode)
 405                         ops->select_dr_mode(dev, index, dr_mode);
 406                 index++;
 407         }
 408
 409         return 0;
 410 }
 411
 412 static int dwc3_glue_remove(struct udevice *dev)
 413 {
 414         struct dwc3_glue_data *glue = dev_get_platdata(dev);
 415
 416         reset_release_bulk(&glue->resets);
 417
 418         clk_release_bulk(&glue->clks);
 419
 420         return 0;
 421 }
 422
 423 static const struct udevice_id dwc3_glue_ids[] = {
 424         { .compatible = "xlnx,zynqmp-dwc3" },
 425         { .compatible = "xlnx,versal-dwc3" },
 426         { .compatible = "ti,keystone-dwc3"},
 427         { .compatible = "ti,dwc3", .data = (ulong)&ti_ops },
 428         { .compatible = "ti,am437x-dwc3", .data = (ulong)&ti_ops },
 429         { .compatible = "ti,am654-dwc3" },
 430         { }
 431 };
 432
 433 U_BOOT_DRIVER(dwc3_generic_wrapper) = {
 434         .name   = "dwc3-generic-wrapper",
 435         .id     = UCLASS_NOP,
 436         .of_match = dwc3_glue_ids,
 437         .bind = dwc3_glue_bind,
 438         .probe = dwc3_glue_probe,
 439         .remove = dwc3_glue_remove,
 440         .platdata_auto_alloc_size = sizeof(struct dwc3_glue_data),
 441
 442 };