drivers/mfd/omap-usb-tll.c

   1 /**
   2  * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
   3  *
   4  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
   5  * Author: Keshava Munegowda <keshava_mgowda@ti.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2  of
   9  * the License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/types.h>
  22 #include <linux/slab.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/platform_device.h>
  25 #include <linux/clk.h>
  26 #include <linux/io.h>
  27 #include <linux/err.h>
  28 #include <linux/pm_runtime.h>
  29 #include <linux/platform_data/usb-omap.h>
  30
  31 #define USBTLL_DRIVER_NAME      "usbhs_tll"
  32
  33 /* TLL Register Set */
  34 #define OMAP_USBTLL_REVISION                            (0x00)
  35 #define OMAP_USBTLL_SYSCONFIG                           (0x10)
  36 #define OMAP_USBTLL_SYSCONFIG_CACTIVITY                 (1 << 8)
  37 #define OMAP_USBTLL_SYSCONFIG_SIDLEMODE                 (1 << 3)
  38 #define OMAP_USBTLL_SYSCONFIG_ENAWAKEUP                 (1 << 2)
  39 #define OMAP_USBTLL_SYSCONFIG_SOFTRESET                 (1 << 1)
  40 #define OMAP_USBTLL_SYSCONFIG_AUTOIDLE                  (1 << 0)
  41
  42 #define OMAP_USBTLL_SYSSTATUS                           (0x14)
  43 #define OMAP_USBTLL_SYSSTATUS_RESETDONE                 (1 << 0)
  44
  45 #define OMAP_USBTLL_IRQSTATUS                           (0x18)
  46 #define OMAP_USBTLL_IRQENABLE                           (0x1C)
  47
  48 #define OMAP_TLL_SHARED_CONF                            (0x30)
  49 #define OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN             (1 << 6)
  50 #define OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN            (1 << 5)
  51 #define OMAP_TLL_SHARED_CONF_USB_DIVRATION              (1 << 2)
  52 #define OMAP_TLL_SHARED_CONF_FCLK_REQ                   (1 << 1)
  53 #define OMAP_TLL_SHARED_CONF_FCLK_IS_ON                 (1 << 0)
  54
  55 #define OMAP_TLL_CHANNEL_CONF(num)                      (0x040 + 0x004 * num)
  56 #define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT            24
  57 #define OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF            (1 << 11)
  58 #define OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE         (1 << 10)
  59 #define OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE              (1 << 9)
  60 #define OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE               (1 << 8)
  61 #define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS             (1 << 1)
  62 #define OMAP_TLL_CHANNEL_CONF_CHANEN                    (1 << 0)
  63
  64 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0              0x0
  65 #define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM                0x1
  66 #define OMAP_TLL_FSLSMODE_3PIN_PHY                      0x2
  67 #define OMAP_TLL_FSLSMODE_4PIN_PHY                      0x3
  68 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0              0x4
  69 #define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM                0x5
  70 #define OMAP_TLL_FSLSMODE_3PIN_TLL                      0x6
  71 #define OMAP_TLL_FSLSMODE_4PIN_TLL                      0x7
  72 #define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0              0xA
  73 #define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM                0xB
  74
  75 #define OMAP_TLL_ULPI_FUNCTION_CTRL(num)                (0x804 + 0x100 * num)
  76 #define OMAP_TLL_ULPI_INTERFACE_CTRL(num)               (0x807 + 0x100 * num)
  77 #define OMAP_TLL_ULPI_OTG_CTRL(num)                     (0x80A + 0x100 * num)
  78 #define OMAP_TLL_ULPI_INT_EN_RISE(num)                  (0x80D + 0x100 * num)
  79 #define OMAP_TLL_ULPI_INT_EN_FALL(num)                  (0x810 + 0x100 * num)
  80 #define OMAP_TLL_ULPI_INT_STATUS(num)                   (0x813 + 0x100 * num)
  81 #define OMAP_TLL_ULPI_INT_LATCH(num)                    (0x814 + 0x100 * num)
  82 #define OMAP_TLL_ULPI_DEBUG(num)                        (0x815 + 0x100 * num)
  83 #define OMAP_TLL_ULPI_SCRATCH_REGISTER(num)             (0x816 + 0x100 * num)
  84
  85 #define OMAP_REV2_TLL_CHANNEL_COUNT                     2
  86 #define OMAP_TLL_CHANNEL_COUNT                          3
  87 #define OMAP_TLL_CHANNEL_1_EN_MASK                      (1 << 0)
  88 #define OMAP_TLL_CHANNEL_2_EN_MASK                      (1 << 1)
  89 #define OMAP_TLL_CHANNEL_3_EN_MASK                      (1 << 2)
  90
  91 /* Values of USBTLL_REVISION - Note: these are not given in the TRM */
  92 #define OMAP_USBTLL_REV1                0x00000015      /* OMAP3 */
  93 #define OMAP_USBTLL_REV2                0x00000018      /* OMAP 3630 */
  94 #define OMAP_USBTLL_REV3                0x00000004      /* OMAP4 */
  95
  96 #define is_ehci_tll_mode(x)     (x == OMAP_EHCI_PORT_MODE_TLL)
  97
  98 struct usbtll_omap {
  99         struct clk                              *usbtll_p1_fck;
 100         struct clk                              *usbtll_p2_fck;
 101         struct usbhs_omap_platform_data         *pdata;
 102         /* secure the register updates */
 103         spinlock_t                              lock;
 104 };
 105
 106 /*-------------------------------------------------------------------------*/
 107
 108 const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
 109 struct platform_device  *tll_pdev;
 110
 111 /*-------------------------------------------------------------------------*/
 112
 113 static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
 114 {
 115         __raw_writel(val, base + reg);
 116 }
 117
 118 static inline u32 usbtll_read(void __iomem *base, u32 reg)
 119 {
 120         return __raw_readl(base + reg);
 121 }
 122
 123 static inline void usbtll_writeb(void __iomem *base, u8 reg, u8 val)
 124 {
 125         __raw_writeb(val, base + reg);
 126 }
 127
 128 static inline u8 usbtll_readb(void __iomem *base, u8 reg)
 129 {
 130         return __raw_readb(base + reg);
 131 }
 132
 133 /*-------------------------------------------------------------------------*/
 134
 135 static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
 136 {
 137         switch (pmode) {
 138         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
 139         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
 140         case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
 141         case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
 142         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
 143         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
 144         case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
 145         case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
 146         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
 147         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
 148                 return true;
 149
 150         default:
 151                 return false;
 152         }
 153 }
 154
 155 /*
 156  * convert the port-mode enum to a value we can use in the FSLSMODE
 157  * field of USBTLL_CHANNEL_CONF
 158  */
 159 static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
 160 {
 161         switch (mode) {
 162         case OMAP_USBHS_PORT_MODE_UNUSED:
 163         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
 164                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
 165
 166         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
 167                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;
 168
 169         case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
 170                 return OMAP_TLL_FSLSMODE_3PIN_PHY;
 171
 172         case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
 173                 return OMAP_TLL_FSLSMODE_4PIN_PHY;
 174
 175         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
 176                 return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;
 177
 178         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
 179                 return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;
 180
 181         case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
 182                 return OMAP_TLL_FSLSMODE_3PIN_TLL;
 183
 184         case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
 185                 return OMAP_TLL_FSLSMODE_4PIN_TLL;
 186
 187         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
 188                 return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;
 189
 190         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
 191                 return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
 192         default:
 193                 pr_warn("Invalid port mode, using default\n");
 194                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
 195         }
 196 }
 197
 198 /**
 199  * usbtll_omap_probe - initialize TI-based HCDs
 200  *
 201  * Allocates basic resources for this USB host controller.
 202  */
 203 static int usbtll_omap_probe(struct platform_device *pdev)
 204 {
 205         struct device                           *dev =  &pdev->dev;
 206         struct usbhs_omap_platform_data         *pdata = dev->platform_data;
 207         void __iomem                            *base;
 208         struct resource                         *res;
 209         struct usbtll_omap                      *tll;
 210         unsigned                                reg;
 211         unsigned long                           flags;
 212         int                                     ret = 0;
 213         int                                     i, ver, count;
 214
 215         dev_dbg(dev, "starting TI HSUSB TLL Controller\n");
 216
 217         tll = kzalloc(sizeof(struct usbtll_omap), GFP_KERNEL);
 218         if (!tll) {
 219                 dev_err(dev, "Memory allocation failed\n");
 220                 ret = -ENOMEM;
 221                 goto end;
 222         }
 223
 224         spin_lock_init(&tll->lock);
 225
 226         tll->pdata = pdata;
 227
 228         tll->usbtll_p1_fck = clk_get(dev, "usb_tll_hs_usb_ch0_clk");
 229         if (IS_ERR(tll->usbtll_p1_fck)) {
 230                 ret = PTR_ERR(tll->usbtll_p1_fck);
 231                 dev_err(dev, "usbtll_p1_fck failed error:%d\n", ret);
 232                 goto err_tll;
 233         }
 234
 235         tll->usbtll_p2_fck = clk_get(dev, "usb_tll_hs_usb_ch1_clk");
 236         if (IS_ERR(tll->usbtll_p2_fck)) {
 237                 ret = PTR_ERR(tll->usbtll_p2_fck);
 238                 dev_err(dev, "usbtll_p2_fck failed error:%d\n", ret);
 239                 goto err_usbtll_p1_fck;
 240         }
 241
 242         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 243         if (!res) {
 244                 dev_err(dev, "usb tll get resource failed\n");
 245                 ret = -ENODEV;
 246                 goto err_usbtll_p2_fck;
 247         }
 248
 249         base = ioremap(res->start, resource_size(res));
 250         if (!base) {
 251                 dev_err(dev, "TLL ioremap failed\n");
 252                 ret = -ENOMEM;
 253                 goto err_usbtll_p2_fck;
 254         }
 255
 256         platform_set_drvdata(pdev, tll);
 257         pm_runtime_enable(dev);
 258         pm_runtime_get_sync(dev);
 259
 260         spin_lock_irqsave(&tll->lock, flags);
 261
 262         ver =  usbtll_read(base, OMAP_USBTLL_REVISION);
 263         switch (ver) {
 264         case OMAP_USBTLL_REV1:
 265         case OMAP_USBTLL_REV2:
 266                 count = OMAP_TLL_CHANNEL_COUNT;
 267                 break;
 268         case OMAP_USBTLL_REV3:
 269                 count = OMAP_REV2_TLL_CHANNEL_COUNT;
 270                 break;
 271         default:
 272                 dev_err(dev, "TLL version failed\n");
 273                 ret = -ENODEV;
 274                 goto err_ioremap;
 275         }
 276
 277         if (is_ehci_tll_mode(pdata->port_mode[0]) ||
 278             is_ehci_tll_mode(pdata->port_mode[1]) ||
 279             is_ehci_tll_mode(pdata->port_mode[2]) ||
 280             is_ohci_port(pdata->port_mode[0]) ||
 281             is_ohci_port(pdata->port_mode[1]) ||
 282             is_ohci_port(pdata->port_mode[2])) {
 283
 284                 /* Program Common TLL register */
 285                 reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
 286                 reg |= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
 287                         | OMAP_TLL_SHARED_CONF_USB_DIVRATION);
 288                 reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
 289                 reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;
 290
 291                 usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);
 292
 293                 /* Enable channels now */
 294                 for (i = 0; i < count; i++) {
 295                         reg = usbtll_read(base, OMAP_TLL_CHANNEL_CONF(i));
 296
 297                         if (is_ohci_port(pdata->port_mode[i])) {
 298                                 reg |= ohci_omap3_fslsmode(pdata->port_mode[i])
 299                                 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
 300                                 reg |= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
 301                         } else if (pdata->port_mode[i] ==
 302                                         OMAP_EHCI_PORT_MODE_TLL) {
 303                                 /*
 304                                  * Disable AutoIdle, BitStuffing
 305                                  * and use SDR Mode
 306                                  */
 307                                 reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
 308                                         | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
 309                                         | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
 310                         } else {
 311                                 continue;
 312                         }
 313                         reg |= OMAP_TLL_CHANNEL_CONF_CHANEN;
 314                         usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);
 315
 316                         usbtll_writeb(base,
 317                                       OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
 318                                       0xbe);
 319                 }
 320         }
 321
 322 err_ioremap:
 323         spin_unlock_irqrestore(&tll->lock, flags);
 324         iounmap(base);
 325         pm_runtime_put_sync(dev);
 326         tll_pdev = pdev;
 327         if (!ret)
 328                 goto end;
 329         pm_runtime_disable(dev);
 330
 331 err_usbtll_p2_fck:
 332         clk_put(tll->usbtll_p2_fck);
 333
 334 err_usbtll_p1_fck:
 335         clk_put(tll->usbtll_p1_fck);
 336
 337 err_tll:
 338         kfree(tll);
 339
 340 end:
 341         return ret;
 342 }
 343
 344 /**
 345  * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
 346  * @pdev: USB Host Controller being removed
 347  *
 348  * Reverses the effect of usbtll_omap_probe().
 349  */
 350 static int usbtll_omap_remove(struct platform_device *pdev)
 351 {
 352         struct usbtll_omap *tll = platform_get_drvdata(pdev);
 353
 354         clk_put(tll->usbtll_p2_fck);
 355         clk_put(tll->usbtll_p1_fck);
 356         pm_runtime_disable(&pdev->dev);
 357         kfree(tll);
 358         return 0;
 359 }
 360
 361 static int usbtll_runtime_resume(struct device *dev)
 362 {
 363         struct usbtll_omap                      *tll = dev_get_drvdata(dev);
 364         struct usbhs_omap_platform_data         *pdata = tll->pdata;
 365         unsigned long                           flags;
 366
 367         dev_dbg(dev, "usbtll_runtime_resume\n");
 368
 369         if (!pdata) {
 370                 dev_dbg(dev, "missing platform_data\n");
 371                 return  -ENODEV;
 372         }
 373
 374         spin_lock_irqsave(&tll->lock, flags);
 375
 376         if (is_ehci_tll_mode(pdata->port_mode[0]))
 377                 clk_enable(tll->usbtll_p1_fck);
 378
 379         if (is_ehci_tll_mode(pdata->port_mode[1]))
 380                 clk_enable(tll->usbtll_p2_fck);
 381
 382         spin_unlock_irqrestore(&tll->lock, flags);
 383
 384         return 0;
 385 }
 386
 387 static int usbtll_runtime_suspend(struct device *dev)
 388 {
 389         struct usbtll_omap                      *tll = dev_get_drvdata(dev);
 390         struct usbhs_omap_platform_data         *pdata = tll->pdata;
 391         unsigned long                           flags;
 392
 393         dev_dbg(dev, "usbtll_runtime_suspend\n");
 394
 395         if (!pdata) {
 396                 dev_dbg(dev, "missing platform_data\n");
 397                 return  -ENODEV;
 398         }
 399
 400         spin_lock_irqsave(&tll->lock, flags);
 401
 402         if (is_ehci_tll_mode(pdata->port_mode[0]))
 403                 clk_disable(tll->usbtll_p1_fck);
 404
 405         if (is_ehci_tll_mode(pdata->port_mode[1]))
 406                 clk_disable(tll->usbtll_p2_fck);
 407
 408         spin_unlock_irqrestore(&tll->lock, flags);
 409
 410         return 0;
 411 }
 412
 413 static const struct dev_pm_ops usbtllomap_dev_pm_ops = {
 414         SET_RUNTIME_PM_OPS(usbtll_runtime_suspend,
 415                            usbtll_runtime_resume,
 416                            NULL)
 417 };
 418
 419 static struct platform_driver usbtll_omap_driver = {
 420         .driver = {
 421                 .name           = (char *)usbtll_driver_name,
 422                 .owner          = THIS_MODULE,
 423                 .pm             = &usbtllomap_dev_pm_ops,
 424         },
 425         .probe          = usbtll_omap_probe,
 426         .remove         = usbtll_omap_remove,
 427 };
 428
 429 int omap_tll_enable(void)
 430 {
 431         if (!tll_pdev) {
 432                 pr_err("missing omap usbhs tll platform_data\n");
 433                 return  -ENODEV;
 434         }
 435         return pm_runtime_get_sync(&tll_pdev->dev);
 436 }
 437 EXPORT_SYMBOL_GPL(omap_tll_enable);
 438
 439 int omap_tll_disable(void)
 440 {
 441         if (!tll_pdev) {
 442                 pr_err("missing omap usbhs tll platform_data\n");
 443                 return  -ENODEV;
 444         }
 445         return pm_runtime_put_sync(&tll_pdev->dev);
 446 }
 447 EXPORT_SYMBOL_GPL(omap_tll_disable);
 448
 449 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
 450 MODULE_ALIAS("platform:" USBHS_DRIVER_NAME);
 451 MODULE_LICENSE("GPL v2");
 452 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
 453
 454 static int __init omap_usbtll_drvinit(void)
 455 {
 456         return platform_driver_register(&usbtll_omap_driver);
 457 }
 458
 459 /*
 460  * init before usbhs core driver;
 461  * The usbtll driver should be initialized before
 462  * the usbhs core driver probe function is called.
 463  */
 464 fs_initcall(omap_usbtll_drvinit);
 465
 466 static void __exit omap_usbtll_drvexit(void)
 467 {
 468         platform_driver_unregister(&usbtll_omap_driver);
 469 }
 470 module_exit(omap_usbtll_drvexit);