drivers/usb/musb-new/sunxi.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Allwinner SUNXI "glue layer"
   4  *
   5  * Copyright © 2015 Hans de Goede <hdegoede@redhat.com>
   6  * Copyright © 2013 Jussi Kivilinna <jussi.kivilinna@iki.fi>
   7  *
   8  * Based on the sw_usb "Allwinner OTG Dual Role Controller" code.
   9  *  Copyright 2007-2012 (C) Allwinner Technology Co., Ltd.
  10  *  javen <javen@allwinnertech.com>
  11  *
  12  * Based on the DA8xx "glue layer" code.
  13  *  Copyright (c) 2008-2009 MontaVista Software, Inc. <source@mvista.com>
  14  *  Copyright (C) 2005-2006 by Texas Instruments
  15  *
  16  * This file is part of the Inventra Controller Driver for Linux.
  17  */
  18 #include <common.h>
  19 #include <clk.h>
  20 #include <dm.h>
  21 #include <generic-phy.h>
  22 #include <log.h>
  23 #include <malloc.h>
  24 #include <phy-sun4i-usb.h>
  25 #include <reset.h>
  26 #include <asm/arch/cpu.h>
  27 #include <asm/arch/clock.h>
  28 #include <dm/device_compat.h>
  29 #include <dm/lists.h>
  30 #include <dm/root.h>
  31 #include <linux/bitops.h>
  32 #include <linux/delay.h>
  33 #include <linux/usb/musb.h>
  34 #include "linux-compat.h"
  35 #include "musb_core.h"
  36 #include "musb_uboot.h"
  37
  38 /******************************************************************************
  39  ******************************************************************************
  40  * From the Allwinner driver
  41  ******************************************************************************
  42  ******************************************************************************/
  43
  44 /******************************************************************************
  45  * From include/sunxi_usb_bsp.h
  46  ******************************************************************************/
  47
  48 /* reg offsets */
  49 #define  USBC_REG_o_ISCR        0x0400
  50 #define  USBC_REG_o_PHYCTL      0x0404
  51 #define  USBC_REG_o_PHYBIST     0x0408
  52 #define  USBC_REG_o_PHYTUNE     0x040c
  53
  54 #define  USBC_REG_o_VEND0       0x0043
  55
  56 /* Interface Status and Control */
  57 #define  USBC_BP_ISCR_VBUS_VALID_FROM_DATA      30
  58 #define  USBC_BP_ISCR_VBUS_VALID_FROM_VBUS      29
  59 #define  USBC_BP_ISCR_EXT_ID_STATUS             28
  60 #define  USBC_BP_ISCR_EXT_DM_STATUS             27
  61 #define  USBC_BP_ISCR_EXT_DP_STATUS             26
  62 #define  USBC_BP_ISCR_MERGED_VBUS_STATUS        25
  63 #define  USBC_BP_ISCR_MERGED_ID_STATUS          24
  64
  65 #define  USBC_BP_ISCR_ID_PULLUP_EN              17
  66 #define  USBC_BP_ISCR_DPDM_PULLUP_EN            16
  67 #define  USBC_BP_ISCR_FORCE_ID                  14
  68 #define  USBC_BP_ISCR_FORCE_VBUS_VALID          12
  69 #define  USBC_BP_ISCR_VBUS_VALID_SRC            10
  70
  71 #define  USBC_BP_ISCR_HOSC_EN                   7
  72 #define  USBC_BP_ISCR_VBUS_CHANGE_DETECT        6
  73 #define  USBC_BP_ISCR_ID_CHANGE_DETECT          5
  74 #define  USBC_BP_ISCR_DPDM_CHANGE_DETECT        4
  75 #define  USBC_BP_ISCR_IRQ_ENABLE                3
  76 #define  USBC_BP_ISCR_VBUS_CHANGE_DETECT_EN     2
  77 #define  USBC_BP_ISCR_ID_CHANGE_DETECT_EN       1
  78 #define  USBC_BP_ISCR_DPDM_CHANGE_DETECT_EN     0
  79
  80 /******************************************************************************
  81  * From usbc/usbc.c
  82  ******************************************************************************/
  83
  84 #define OFF_SUN6I_AHB_RESET0    0x2c0
  85
  86 struct sunxi_musb_config {
  87         struct musb_hdrc_config *config;
  88 };
  89
  90 struct sunxi_glue {
  91         struct musb_host_data mdata;
  92         struct clk clk;
  93         struct reset_ctl rst;
  94         struct sunxi_musb_config *cfg;
  95         struct device dev;
  96         struct phy phy;
  97 };
  98 #define to_sunxi_glue(d)        container_of(d, struct sunxi_glue, dev)
  99
 100 static u32 USBC_WakeUp_ClearChangeDetect(u32 reg_val)
 101 {
 102         u32 temp = reg_val;
 103
 104         temp &= ~BIT(USBC_BP_ISCR_VBUS_CHANGE_DETECT);
 105         temp &= ~BIT(USBC_BP_ISCR_ID_CHANGE_DETECT);
 106         temp &= ~BIT(USBC_BP_ISCR_DPDM_CHANGE_DETECT);
 107
 108         return temp;
 109 }
 110
 111 static void USBC_EnableIdPullUp(__iomem void *base)
 112 {
 113         u32 reg_val;
 114
 115         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 116         reg_val |= BIT(USBC_BP_ISCR_ID_PULLUP_EN);
 117         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 118         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 119 }
 120
 121 static void USBC_EnableDpDmPullUp(__iomem void *base)
 122 {
 123         u32 reg_val;
 124
 125         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 126         reg_val |= BIT(USBC_BP_ISCR_DPDM_PULLUP_EN);
 127         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 128         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 129 }
 130
 131 static void USBC_ForceIdToLow(__iomem void *base)
 132 {
 133         u32 reg_val;
 134
 135         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 136         reg_val &= ~(0x03 << USBC_BP_ISCR_FORCE_ID);
 137         reg_val |= (0x02 << USBC_BP_ISCR_FORCE_ID);
 138         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 139         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 140 }
 141
 142 static void USBC_ForceIdToHigh(__iomem void *base)
 143 {
 144         u32 reg_val;
 145
 146         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 147         reg_val &= ~(0x03 << USBC_BP_ISCR_FORCE_ID);
 148         reg_val |= (0x03 << USBC_BP_ISCR_FORCE_ID);
 149         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 150         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 151 }
 152
 153 static void USBC_ForceVbusValidToLow(__iomem void *base)
 154 {
 155         u32 reg_val;
 156
 157         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 158         reg_val &= ~(0x03 << USBC_BP_ISCR_FORCE_VBUS_VALID);
 159         reg_val |= (0x02 << USBC_BP_ISCR_FORCE_VBUS_VALID);
 160         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 161         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 162 }
 163
 164 static void USBC_ForceVbusValidToHigh(__iomem void *base)
 165 {
 166         u32 reg_val;
 167
 168         reg_val = musb_readl(base, USBC_REG_o_ISCR);
 169         reg_val &= ~(0x03 << USBC_BP_ISCR_FORCE_VBUS_VALID);
 170         reg_val |= (0x03 << USBC_BP_ISCR_FORCE_VBUS_VALID);
 171         reg_val = USBC_WakeUp_ClearChangeDetect(reg_val);
 172         musb_writel(base, USBC_REG_o_ISCR, reg_val);
 173 }
 174
 175 static void USBC_ConfigFIFO_Base(void)
 176 {
 177         u32 reg_value;
 178
 179         /* config usb fifo, 8kb mode */
 180         reg_value = readl(SUNXI_SRAMC_BASE + 0x04);
 181         reg_value &= ~(0x03 << 0);
 182         reg_value |= BIT(0);
 183         writel(reg_value, SUNXI_SRAMC_BASE + 0x04);
 184 }
 185
 186 /******************************************************************************
 187  * Needed for the DFU polling magic
 188  ******************************************************************************/
 189
 190 static u8 last_int_usb;
 191
 192 bool dfu_usb_get_reset(void)
 193 {
 194         return !!(last_int_usb & MUSB_INTR_RESET);
 195 }
 196
 197 /******************************************************************************
 198  * MUSB Glue code
 199  ******************************************************************************/
 200
 201 static irqreturn_t sunxi_musb_interrupt(int irq, void *__hci)
 202 {
 203         struct musb             *musb = __hci;
 204         irqreturn_t             retval = IRQ_NONE;
 205
 206         /* read and flush interrupts */
 207         musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
 208         last_int_usb = musb->int_usb;
 209         if (musb->int_usb)
 210                 musb_writeb(musb->mregs, MUSB_INTRUSB, musb->int_usb);
 211         musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
 212         if (musb->int_tx)
 213                 musb_writew(musb->mregs, MUSB_INTRTX, musb->int_tx);
 214         musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
 215         if (musb->int_rx)
 216                 musb_writew(musb->mregs, MUSB_INTRRX, musb->int_rx);
 217
 218         if (musb->int_usb || musb->int_tx || musb->int_rx)
 219                 retval |= musb_interrupt(musb);
 220
 221         return retval;
 222 }
 223
 224 /* musb_core does not call enable / disable in a balanced manner <sigh> */
 225 static bool enabled = false;
 226
 227 static int sunxi_musb_enable(struct musb *musb)
 228 {
 229         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 230         int ret;
 231
 232         pr_debug("%s():\n", __func__);
 233
 234         musb_ep_select(musb->mregs, 0);
 235         musb_writeb(musb->mregs, MUSB_FADDR, 0);
 236
 237         if (enabled)
 238                 return 0;
 239
 240         /* select PIO mode */
 241         musb_writeb(musb->mregs, USBC_REG_o_VEND0, 0);
 242
 243         if (is_host_enabled(musb)) {
 244                 ret = sun4i_usb_phy_id_detect(&glue->phy);
 245                 if (ret == 1) {
 246                         printf("No host cable detected: ");
 247                         return -ENODEV;
 248                 }
 249
 250                 ret = generic_phy_power_on(&glue->phy);
 251                 if (ret) {
 252                         pr_debug("failed to power on USB PHY\n");
 253                         return ret;
 254                 }
 255         }
 256
 257         USBC_ForceVbusValidToHigh(musb->mregs);
 258
 259         enabled = true;
 260         return 0;
 261 }
 262
 263 static void sunxi_musb_disable(struct musb *musb)
 264 {
 265         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 266         int ret;
 267
 268         pr_debug("%s():\n", __func__);
 269
 270         if (!enabled)
 271                 return;
 272
 273         if (is_host_enabled(musb)) {
 274                 ret = generic_phy_power_off(&glue->phy);
 275                 if (ret) {
 276                         pr_debug("failed to power off USB PHY\n");
 277                         return;
 278                 }
 279         }
 280
 281         USBC_ForceVbusValidToLow(musb->mregs);
 282         mdelay(200); /* Wait for the current session to timeout */
 283
 284         enabled = false;
 285 }
 286
 287 static int sunxi_musb_init(struct musb *musb)
 288 {
 289         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 290         int ret;
 291
 292         pr_debug("%s():\n", __func__);
 293
 294         ret = clk_enable(&glue->clk);
 295         if (ret) {
 296                 dev_err(musb->controller, "failed to enable clock\n");
 297                 return ret;
 298         }
 299
 300         if (reset_valid(&glue->rst)) {
 301                 ret = reset_deassert(&glue->rst);
 302                 if (ret) {
 303                         dev_err(musb->controller, "failed to deassert reset\n");
 304                         goto err_clk;
 305                 }
 306         }
 307
 308         ret = generic_phy_init(&glue->phy);
 309         if (ret) {
 310                 dev_dbg(musb->controller, "failed to init USB PHY\n");
 311                 goto err_rst;
 312         }
 313
 314         musb->isr = sunxi_musb_interrupt;
 315
 316         USBC_ConfigFIFO_Base();
 317         USBC_EnableDpDmPullUp(musb->mregs);
 318         USBC_EnableIdPullUp(musb->mregs);
 319
 320         if (is_host_enabled(musb)) {
 321                 /* Host mode */
 322                 USBC_ForceIdToLow(musb->mregs);
 323         } else {
 324                 /* Peripheral mode */
 325                 USBC_ForceIdToHigh(musb->mregs);
 326         }
 327         USBC_ForceVbusValidToHigh(musb->mregs);
 328
 329         return 0;
 330
 331 err_rst:
 332         if (reset_valid(&glue->rst))
 333                 reset_assert(&glue->rst);
 334 err_clk:
 335         clk_disable(&glue->clk);
 336         return ret;
 337 }
 338
 339 static int sunxi_musb_exit(struct musb *musb)
 340 {
 341         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 342         int ret = 0;
 343
 344         if (generic_phy_valid(&glue->phy)) {
 345                 ret = generic_phy_exit(&glue->phy);
 346                 if (ret) {
 347                         dev_dbg(musb->controller,
 348                                 "failed to power off usb phy\n");
 349                         return ret;
 350                 }
 351         }
 352
 353         if (reset_valid(&glue->rst))
 354                 reset_assert(&glue->rst);
 355         clk_disable(&glue->clk);
 356
 357         return 0;
 358 }
 359
 360 static void sunxi_musb_pre_root_reset_end(struct musb *musb)
 361 {
 362         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 363
 364         sun4i_usb_phy_set_squelch_detect(&glue->phy, false);
 365 }
 366
 367 static void sunxi_musb_post_root_reset_end(struct musb *musb)
 368 {
 369         struct sunxi_glue *glue = to_sunxi_glue(musb->controller);
 370
 371         sun4i_usb_phy_set_squelch_detect(&glue->phy, true);
 372 }
 373
 374 static const struct musb_platform_ops sunxi_musb_ops = {
 375         .init           = sunxi_musb_init,
 376         .exit           = sunxi_musb_exit,
 377         .enable         = sunxi_musb_enable,
 378         .disable        = sunxi_musb_disable,
 379         .pre_root_reset_end = sunxi_musb_pre_root_reset_end,
 380         .post_root_reset_end = sunxi_musb_post_root_reset_end,
 381 };
 382
 383 /* Allwinner OTG supports up to 5 endpoints */
 384 #define SUNXI_MUSB_MAX_EP_NUM           6
 385 #define SUNXI_MUSB_RAM_BITS             11
 386
 387 static struct musb_fifo_cfg sunxi_musb_mode_cfg[] = {
 388         MUSB_EP_FIFO_SINGLE(1, FIFO_TX, 512),
 389         MUSB_EP_FIFO_SINGLE(1, FIFO_RX, 512),
 390         MUSB_EP_FIFO_SINGLE(2, FIFO_TX, 512),
 391         MUSB_EP_FIFO_SINGLE(2, FIFO_RX, 512),
 392         MUSB_EP_FIFO_SINGLE(3, FIFO_TX, 512),
 393         MUSB_EP_FIFO_SINGLE(3, FIFO_RX, 512),
 394         MUSB_EP_FIFO_SINGLE(4, FIFO_TX, 512),
 395         MUSB_EP_FIFO_SINGLE(4, FIFO_RX, 512),
 396         MUSB_EP_FIFO_SINGLE(5, FIFO_TX, 512),
 397         MUSB_EP_FIFO_SINGLE(5, FIFO_RX, 512),
 398 };
 399
 400 /* H3/V3s OTG supports only 4 endpoints */
 401 #define SUNXI_MUSB_MAX_EP_NUM_H3        5
 402
 403 static struct musb_fifo_cfg sunxi_musb_mode_cfg_h3[] = {
 404         MUSB_EP_FIFO_SINGLE(1, FIFO_TX, 512),
 405         MUSB_EP_FIFO_SINGLE(1, FIFO_RX, 512),
 406         MUSB_EP_FIFO_SINGLE(2, FIFO_TX, 512),
 407         MUSB_EP_FIFO_SINGLE(2, FIFO_RX, 512),
 408         MUSB_EP_FIFO_SINGLE(3, FIFO_TX, 512),
 409         MUSB_EP_FIFO_SINGLE(3, FIFO_RX, 512),
 410         MUSB_EP_FIFO_SINGLE(4, FIFO_TX, 512),
 411         MUSB_EP_FIFO_SINGLE(4, FIFO_RX, 512),
 412 };
 413
 414 static struct musb_hdrc_config musb_config = {
 415         .fifo_cfg       = sunxi_musb_mode_cfg,
 416         .fifo_cfg_size  = ARRAY_SIZE(sunxi_musb_mode_cfg),
 417         .multipoint     = true,
 418         .dyn_fifo       = true,
 419         .num_eps        = SUNXI_MUSB_MAX_EP_NUM,
 420         .ram_bits       = SUNXI_MUSB_RAM_BITS,
 421 };
 422
 423 static struct musb_hdrc_config musb_config_h3 = {
 424         .fifo_cfg       = sunxi_musb_mode_cfg_h3,
 425         .fifo_cfg_size  = ARRAY_SIZE(sunxi_musb_mode_cfg_h3),
 426         .multipoint     = true,
 427         .dyn_fifo       = true,
 428         .soft_con       = true,
 429         .num_eps        = SUNXI_MUSB_MAX_EP_NUM_H3,
 430         .ram_bits       = SUNXI_MUSB_RAM_BITS,
 431 };
 432
 433 static int musb_usb_probe(struct udevice *dev)
 434 {
 435         struct sunxi_glue *glue = dev_get_priv(dev);
 436         struct musb_host_data *host = &glue->mdata;
 437         struct musb_hdrc_platform_data pdata;
 438         void *base = dev_read_addr_ptr(dev);
 439         int ret;
 440
 441 #ifdef CONFIG_USB_MUSB_HOST
 442         struct usb_bus_priv *priv = dev_get_uclass_priv(dev);
 443 #endif
 444
 445         if (!base)
 446                 return -EINVAL;
 447
 448         glue->cfg = (struct sunxi_musb_config *)dev_get_driver_data(dev);
 449         if (!glue->cfg)
 450                 return -EINVAL;
 451
 452         ret = clk_get_by_index(dev, 0, &glue->clk);
 453         if (ret) {
 454                 dev_err(dev, "failed to get clock\n");
 455                 return ret;
 456         }
 457
 458         ret = reset_get_by_index(dev, 0, &glue->rst);
 459         if (ret && ret != -ENOENT) {
 460                 dev_err(dev, "failed to get reset\n");
 461                 return ret;
 462         }
 463
 464         ret = generic_phy_get_by_name(dev, "usb", &glue->phy);
 465         if (ret) {
 466                 pr_err("failed to get usb PHY\n");
 467                 return ret;
 468         }
 469
 470         memset(&pdata, 0, sizeof(pdata));
 471         pdata.power = 250;
 472         pdata.platform_ops = &sunxi_musb_ops;
 473         pdata.config = glue->cfg->config;
 474
 475 #ifdef CONFIG_USB_MUSB_HOST
 476         priv->desc_before_addr = true;
 477
 478         pdata.mode = MUSB_HOST;
 479         host->host = musb_init_controller(&pdata, &glue->dev, base);
 480         if (!host->host)
 481                 return -EIO;
 482
 483         ret = musb_lowlevel_init(host);
 484         if (!ret)
 485                 printf("Allwinner mUSB OTG (Host)\n");
 486 #else
 487         pdata.mode = MUSB_PERIPHERAL;
 488         host->host = musb_register(&pdata, &glue->dev, base);
 489         if (!host->host)
 490                 return -EIO;
 491
 492         printf("Allwinner mUSB OTG (Peripheral)\n");
 493 #endif
 494
 495         return ret;
 496 }
 497
 498 static int musb_usb_remove(struct udevice *dev)
 499 {
 500         struct sunxi_glue *glue = dev_get_priv(dev);
 501         struct musb_host_data *host = &glue->mdata;
 502
 503         musb_stop(host->host);
 504         free(host->host);
 505         host->host = NULL;
 506
 507         return 0;
 508 }
 509
 510 static const struct sunxi_musb_config sun4i_a10_cfg = {
 511         .config = &musb_config,
 512 };
 513
 514 static const struct sunxi_musb_config sun6i_a31_cfg = {
 515         .config = &musb_config,
 516 };
 517
 518 static const struct sunxi_musb_config sun8i_h3_cfg = {
 519         .config = &musb_config_h3,
 520 };
 521
 522 static const struct udevice_id sunxi_musb_ids[] = {
 523         { .compatible = "allwinner,sun4i-a10-musb",
 524                         .data = (ulong)&sun4i_a10_cfg },
 525         { .compatible = "allwinner,sun6i-a31-musb",
 526                         .data = (ulong)&sun6i_a31_cfg },
 527         { .compatible = "allwinner,sun8i-a33-musb",
 528                         .data = (ulong)&sun6i_a31_cfg },
 529         { .compatible = "allwinner,sun8i-h3-musb",
 530                         .data = (ulong)&sun8i_h3_cfg },
 531         { }
 532 };
 533
 534 U_BOOT_DRIVER(usb_musb) = {
 535         .name           = "sunxi-musb",
 536 #ifdef CONFIG_USB_MUSB_HOST
 537         .id             = UCLASS_USB,
 538 #else
 539         .id             = UCLASS_USB_GADGET_GENERIC,
 540 #endif
 541         .of_match       = sunxi_musb_ids,
 542         .probe          = musb_usb_probe,
 543         .remove         = musb_usb_remove,
 544 #ifdef CONFIG_USB_MUSB_HOST
 545         .ops            = &musb_usb_ops,
 546 #endif
 547         .plat_auto      = sizeof(struct usb_plat),
 548         .priv_auto      = sizeof(struct sunxi_glue),
 549 };