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         int                                     nch;    /* num. of channels */
 102         struct usbhs_omap_platform_data         *pdata;
 103         /* secure the register updates */
 104         spinlock_t                              lock;
 105 };
 106
 107 /*-------------------------------------------------------------------------*/
 108
 109 const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
 110 struct platform_device  *tll_pdev;
 111
 112 /*-------------------------------------------------------------------------*/
 113
 114 static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
 115 {
 116         __raw_writel(val, base + reg);
 117 }
 118
 119 static inline u32 usbtll_read(void __iomem *base, u32 reg)
 120 {
 121         return __raw_readl(base + reg);
 122 }
 123
 124 static inline void usbtll_writeb(void __iomem *base, u8 reg, u8 val)
 125 {
 126         __raw_writeb(val, base + reg);
 127 }
 128
 129 static inline u8 usbtll_readb(void __iomem *base, u8 reg)
 130 {
 131         return __raw_readb(base + reg);
 132 }
 133
 134 /*-------------------------------------------------------------------------*/
 135
 136 static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
 137 {
 138         switch (pmode) {
 139         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
 140         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
 141         case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
 142         case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
 143         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
 144         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
 145         case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
 146         case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
 147         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
 148         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
 149                 return true;
 150
 151         default:
 152                 return false;
 153         }
 154 }
 155
 156 /*
 157  * convert the port-mode enum to a value we can use in the FSLSMODE
 158  * field of USBTLL_CHANNEL_CONF
 159  */
 160 static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
 161 {
 162         switch (mode) {
 163         case OMAP_USBHS_PORT_MODE_UNUSED:
 164         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
 165                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
 166
 167         case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
 168                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;
 169
 170         case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
 171                 return OMAP_TLL_FSLSMODE_3PIN_PHY;
 172
 173         case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
 174                 return OMAP_TLL_FSLSMODE_4PIN_PHY;
 175
 176         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
 177                 return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;
 178
 179         case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
 180                 return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;
 181
 182         case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
 183                 return OMAP_TLL_FSLSMODE_3PIN_TLL;
 184
 185         case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
 186                 return OMAP_TLL_FSLSMODE_4PIN_TLL;
 187
 188         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
 189                 return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;
 190
 191         case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
 192                 return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
 193         default:
 194                 pr_warn("Invalid port mode, using default\n");
 195                 return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
 196         }
 197 }
 198
 199 /**
 200  * usbtll_omap_probe - initialize TI-based HCDs
 201  *
 202  * Allocates basic resources for this USB host controller.
 203  */
 204 static int usbtll_omap_probe(struct platform_device *pdev)
 205 {
 206         struct device                           *dev =  &pdev->dev;
 207         struct usbhs_omap_platform_data         *pdata = dev->platform_data;
 208         void __iomem                            *base;
 209         struct resource                         *res;
 210         struct usbtll_omap                      *tll;
 211         unsigned                                reg;
 212         unsigned long                           flags;
 213         int                                     ret = 0;
 214         int                                     i, ver;
 215
 216         dev_dbg(dev, "starting TI HSUSB TLL Controller\n");
 217
 218         tll = devm_kzalloc(dev, sizeof(struct usbtll_omap), GFP_KERNEL);
 219         if (!tll) {
 220                 dev_err(dev, "Memory allocation failed\n");
 221                 return -ENOMEM;
 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                 return ret;
 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_p2_fck;
 240         }
 241
 242         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 243         base = devm_request_and_ioremap(dev, res);
 244         if (!base) {
 245                 ret = -EADDRNOTAVAIL;
 246                 dev_err(dev, "Resource request/ioremap failed:%d\n", ret);
 247                 goto err_res;
 248         }
 249
 250         platform_set_drvdata(pdev, tll);
 251         pm_runtime_enable(dev);
 252         pm_runtime_get_sync(dev);
 253
 254         spin_lock_irqsave(&tll->lock, flags);
 255
 256         ver =  usbtll_read(base, OMAP_USBTLL_REVISION);
 257         switch (ver) {
 258         case OMAP_USBTLL_REV1:
 259                 tll->nch = OMAP_TLL_CHANNEL_COUNT;
 260                 break;
 261         case OMAP_USBTLL_REV2:
 262         case OMAP_USBTLL_REV3:
 263                 tll->nch = OMAP_REV2_TLL_CHANNEL_COUNT;
 264                 break;
 265         default:
 266                 tll->nch = OMAP_TLL_CHANNEL_COUNT;
 267                 dev_dbg(dev,
 268                  "USB TLL Rev : 0x%x not recognized, assuming %d channels\n",
 269                         ver, tll->nch);
 270                 break;
 271         }
 272
 273         if (is_ehci_tll_mode(pdata->port_mode[0]) ||
 274             is_ehci_tll_mode(pdata->port_mode[1]) ||
 275             is_ehci_tll_mode(pdata->port_mode[2]) ||
 276             is_ohci_port(pdata->port_mode[0]) ||
 277             is_ohci_port(pdata->port_mode[1]) ||
 278             is_ohci_port(pdata->port_mode[2])) {
 279
 280                 /* Program Common TLL register */
 281                 reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
 282                 reg |= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
 283                         | OMAP_TLL_SHARED_CONF_USB_DIVRATION);
 284                 reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
 285                 reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;
 286
 287                 usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);
 288
 289                 /* Enable channels now */
 290                 for (i = 0; i < tll->nch; i++) {
 291                         reg = usbtll_read(base, OMAP_TLL_CHANNEL_CONF(i));
 292
 293                         if (is_ohci_port(pdata->port_mode[i])) {
 294                                 reg |= ohci_omap3_fslsmode(pdata->port_mode[i])
 295                                 << OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
 296                                 reg |= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
 297                         } else if (pdata->port_mode[i] ==
 298                                         OMAP_EHCI_PORT_MODE_TLL) {
 299                                 /*
 300                                  * Disable AutoIdle, BitStuffing
 301                                  * and use SDR Mode
 302                                  */
 303                                 reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
 304                                         | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
 305                                         | OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
 306                         } else {
 307                                 continue;
 308                         }
 309                         reg |= OMAP_TLL_CHANNEL_CONF_CHANEN;
 310                         usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);
 311
 312                         usbtll_writeb(base,
 313                                       OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
 314                                       0xbe);
 315                 }
 316         }
 317
 318         spin_unlock_irqrestore(&tll->lock, flags);
 319         pm_runtime_put_sync(dev);
 320         tll_pdev = pdev;
 321
 322         return 0;
 323
 324 err_res:
 325         clk_put(tll->usbtll_p2_fck);
 326
 327 err_p2_fck:
 328         clk_put(tll->usbtll_p1_fck);
 329
 330         return ret;
 331 }
 332
 333 /**
 334  * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
 335  * @pdev: USB Host Controller being removed
 336  *
 337  * Reverses the effect of usbtll_omap_probe().
 338  */
 339 static int usbtll_omap_remove(struct platform_device *pdev)
 340 {
 341         struct usbtll_omap *tll = platform_get_drvdata(pdev);
 342
 343         clk_put(tll->usbtll_p2_fck);
 344         clk_put(tll->usbtll_p1_fck);
 345         pm_runtime_disable(&pdev->dev);
 346         return 0;
 347 }
 348
 349 static int usbtll_runtime_resume(struct device *dev)
 350 {
 351         struct usbtll_omap                      *tll = dev_get_drvdata(dev);
 352         struct usbhs_omap_platform_data         *pdata = tll->pdata;
 353         unsigned long                           flags;
 354
 355         dev_dbg(dev, "usbtll_runtime_resume\n");
 356
 357         if (!pdata) {
 358                 dev_dbg(dev, "missing platform_data\n");
 359                 return  -ENODEV;
 360         }
 361
 362         spin_lock_irqsave(&tll->lock, flags);
 363
 364         if (is_ehci_tll_mode(pdata->port_mode[0]))
 365                 clk_enable(tll->usbtll_p1_fck);
 366
 367         if (is_ehci_tll_mode(pdata->port_mode[1]))
 368                 clk_enable(tll->usbtll_p2_fck);
 369
 370         spin_unlock_irqrestore(&tll->lock, flags);
 371
 372         return 0;
 373 }
 374
 375 static int usbtll_runtime_suspend(struct device *dev)
 376 {
 377         struct usbtll_omap                      *tll = dev_get_drvdata(dev);
 378         struct usbhs_omap_platform_data         *pdata = tll->pdata;
 379         unsigned long                           flags;
 380
 381         dev_dbg(dev, "usbtll_runtime_suspend\n");
 382
 383         if (!pdata) {
 384                 dev_dbg(dev, "missing platform_data\n");
 385                 return  -ENODEV;
 386         }
 387
 388         spin_lock_irqsave(&tll->lock, flags);
 389
 390         if (is_ehci_tll_mode(pdata->port_mode[0]))
 391                 clk_disable(tll->usbtll_p1_fck);
 392
 393         if (is_ehci_tll_mode(pdata->port_mode[1]))
 394                 clk_disable(tll->usbtll_p2_fck);
 395
 396         spin_unlock_irqrestore(&tll->lock, flags);
 397
 398         return 0;
 399 }
 400
 401 static const struct dev_pm_ops usbtllomap_dev_pm_ops = {
 402         SET_RUNTIME_PM_OPS(usbtll_runtime_suspend,
 403                            usbtll_runtime_resume,
 404                            NULL)
 405 };
 406
 407 static struct platform_driver usbtll_omap_driver = {
 408         .driver = {
 409                 .name           = (char *)usbtll_driver_name,
 410                 .owner          = THIS_MODULE,
 411                 .pm             = &usbtllomap_dev_pm_ops,
 412         },
 413         .probe          = usbtll_omap_probe,
 414         .remove         = usbtll_omap_remove,
 415 };
 416
 417 int omap_tll_enable(void)
 418 {
 419         if (!tll_pdev) {
 420                 pr_err("missing omap usbhs tll platform_data\n");
 421                 return  -ENODEV;
 422         }
 423         return pm_runtime_get_sync(&tll_pdev->dev);
 424 }
 425 EXPORT_SYMBOL_GPL(omap_tll_enable);
 426
 427 int omap_tll_disable(void)
 428 {
 429         if (!tll_pdev) {
 430                 pr_err("missing omap usbhs tll platform_data\n");
 431                 return  -ENODEV;
 432         }
 433         return pm_runtime_put_sync(&tll_pdev->dev);
 434 }
 435 EXPORT_SYMBOL_GPL(omap_tll_disable);
 436
 437 MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
 438 MODULE_ALIAS("platform:" USBHS_DRIVER_NAME);
 439 MODULE_LICENSE("GPL v2");
 440 MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
 441
 442 static int __init omap_usbtll_drvinit(void)
 443 {
 444         return platform_driver_register(&usbtll_omap_driver);
 445 }
 446
 447 /*
 448  * init before usbhs core driver;
 449  * The usbtll driver should be initialized before
 450  * the usbhs core driver probe function is called.
 451  */
 452 fs_initcall(omap_usbtll_drvinit);
 453
 454 static void __exit omap_usbtll_drvexit(void)
 455 {
 456         platform_driver_unregister(&usbtll_omap_driver);
 457 }
 458 module_exit(omap_usbtll_drvexit);