drivers/phy/phy-twl4030-usb.c

   1 /*
   2  * twl4030_usb - TWL4030 USB transceiver, talking to OMAP OTG controller
   3  *
   4  * Copyright (C) 2004-2007 Texas Instruments
   5  * Copyright (C) 2008 Nokia Corporation
   6  * Contact: Felipe Balbi <felipe.balbi@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * Current status:
  23  *      - HS USB ULPI mode works.
  24  *      - 3-pin mode support may be added in future.
  25  */
  26
  27 #include <linux/module.h>
  28 #include <linux/init.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/workqueue.h>
  32 #include <linux/io.h>
  33 #include <linux/delay.h>
  34 #include <linux/usb/otg.h>
  35 #include <linux/phy/phy.h>
  36 #include <linux/pm_runtime.h>
  37 #include <linux/usb/musb.h>
  38 #include <linux/usb/ulpi.h>
  39 #include <linux/i2c/twl.h>
  40 #include <linux/regulator/consumer.h>
  41 #include <linux/err.h>
  42 #include <linux/slab.h>
  43
  44 /* Register defines */
  45
  46 #define MCPC_CTRL                       0x30
  47 #define MCPC_CTRL_RTSOL                 (1 << 7)
  48 #define MCPC_CTRL_EXTSWR                (1 << 6)
  49 #define MCPC_CTRL_EXTSWC                (1 << 5)
  50 #define MCPC_CTRL_VOICESW               (1 << 4)
  51 #define MCPC_CTRL_OUT64K                (1 << 3)
  52 #define MCPC_CTRL_RTSCTSSW              (1 << 2)
  53 #define MCPC_CTRL_HS_UART               (1 << 0)
  54
  55 #define MCPC_IO_CTRL                    0x33
  56 #define MCPC_IO_CTRL_MICBIASEN          (1 << 5)
  57 #define MCPC_IO_CTRL_CTS_NPU            (1 << 4)
  58 #define MCPC_IO_CTRL_RXD_PU             (1 << 3)
  59 #define MCPC_IO_CTRL_TXDTYP             (1 << 2)
  60 #define MCPC_IO_CTRL_CTSTYP             (1 << 1)
  61 #define MCPC_IO_CTRL_RTSTYP             (1 << 0)
  62
  63 #define MCPC_CTRL2                      0x36
  64 #define MCPC_CTRL2_MCPC_CK_EN           (1 << 0)
  65
  66 #define OTHER_FUNC_CTRL                 0x80
  67 #define OTHER_FUNC_CTRL_BDIS_ACON_EN    (1 << 4)
  68 #define OTHER_FUNC_CTRL_FIVEWIRE_MODE   (1 << 2)
  69
  70 #define OTHER_IFC_CTRL                  0x83
  71 #define OTHER_IFC_CTRL_OE_INT_EN        (1 << 6)
  72 #define OTHER_IFC_CTRL_CEA2011_MODE     (1 << 5)
  73 #define OTHER_IFC_CTRL_FSLSSERIALMODE_4PIN      (1 << 4)
  74 #define OTHER_IFC_CTRL_HIZ_ULPI_60MHZ_OUT       (1 << 3)
  75 #define OTHER_IFC_CTRL_HIZ_ULPI         (1 << 2)
  76 #define OTHER_IFC_CTRL_ALT_INT_REROUTE  (1 << 0)
  77
  78 #define OTHER_INT_EN_RISE               0x86
  79 #define OTHER_INT_EN_FALL               0x89
  80 #define OTHER_INT_STS                   0x8C
  81 #define OTHER_INT_LATCH                 0x8D
  82 #define OTHER_INT_VB_SESS_VLD           (1 << 7)
  83 #define OTHER_INT_DM_HI                 (1 << 6) /* not valid for "latch" reg */
  84 #define OTHER_INT_DP_HI                 (1 << 5) /* not valid for "latch" reg */
  85 #define OTHER_INT_BDIS_ACON             (1 << 3) /* not valid for "fall" regs */
  86 #define OTHER_INT_MANU                  (1 << 1)
  87 #define OTHER_INT_ABNORMAL_STRESS       (1 << 0)
  88
  89 #define ID_STATUS                       0x96
  90 #define ID_RES_FLOAT                    (1 << 4)
  91 #define ID_RES_440K                     (1 << 3)
  92 #define ID_RES_200K                     (1 << 2)
  93 #define ID_RES_102K                     (1 << 1)
  94 #define ID_RES_GND                      (1 << 0)
  95
  96 #define POWER_CTRL                      0xAC
  97 #define POWER_CTRL_OTG_ENAB             (1 << 5)
  98
  99 #define OTHER_IFC_CTRL2                 0xAF
 100 #define OTHER_IFC_CTRL2_ULPI_STP_LOW    (1 << 4)
 101 #define OTHER_IFC_CTRL2_ULPI_TXEN_POL   (1 << 3)
 102 #define OTHER_IFC_CTRL2_ULPI_4PIN_2430  (1 << 2)
 103 #define OTHER_IFC_CTRL2_USB_INT_OUTSEL_MASK     (3 << 0) /* bits 0 and 1 */
 104 #define OTHER_IFC_CTRL2_USB_INT_OUTSEL_INT1N    (0 << 0)
 105 #define OTHER_IFC_CTRL2_USB_INT_OUTSEL_INT2N    (1 << 0)
 106
 107 #define REG_CTRL_EN                     0xB2
 108 #define REG_CTRL_ERROR                  0xB5
 109 #define ULPI_I2C_CONFLICT_INTEN         (1 << 0)
 110
 111 #define OTHER_FUNC_CTRL2                0xB8
 112 #define OTHER_FUNC_CTRL2_VBAT_TIMER_EN  (1 << 0)
 113
 114 /* following registers do not have separate _clr and _set registers */
 115 #define VBUS_DEBOUNCE                   0xC0
 116 #define ID_DEBOUNCE                     0xC1
 117 #define VBAT_TIMER                      0xD3
 118 #define PHY_PWR_CTRL                    0xFD
 119 #define PHY_PWR_PHYPWD                  (1 << 0)
 120 #define PHY_CLK_CTRL                    0xFE
 121 #define PHY_CLK_CTRL_CLOCKGATING_EN     (1 << 2)
 122 #define PHY_CLK_CTRL_CLK32K_EN          (1 << 1)
 123 #define REQ_PHY_DPLL_CLK                (1 << 0)
 124 #define PHY_CLK_CTRL_STS                0xFF
 125 #define PHY_DPLL_CLK                    (1 << 0)
 126
 127 /* In module TWL_MODULE_PM_MASTER */
 128 #define STS_HW_CONDITIONS               0x0F
 129
 130 /* In module TWL_MODULE_PM_RECEIVER */
 131 #define VUSB_DEDICATED1                 0x7D
 132 #define VUSB_DEDICATED2                 0x7E
 133 #define VUSB1V5_DEV_GRP                 0x71
 134 #define VUSB1V5_TYPE                    0x72
 135 #define VUSB1V5_REMAP                   0x73
 136 #define VUSB1V8_DEV_GRP                 0x74
 137 #define VUSB1V8_TYPE                    0x75
 138 #define VUSB1V8_REMAP                   0x76
 139 #define VUSB3V1_DEV_GRP                 0x77
 140 #define VUSB3V1_TYPE                    0x78
 141 #define VUSB3V1_REMAP                   0x79
 142
 143 /* In module TWL4030_MODULE_INTBR */
 144 #define PMBR1                           0x0D
 145 #define GPIO_USB_4PIN_ULPI_2430C        (3 << 0)
 146
 147 static irqreturn_t twl4030_usb_irq(int irq, void *_twl);
 148 /*
 149  * If VBUS is valid or ID is ground, then we know a
 150  * cable is present and we need to be runtime-enabled
 151  */
 152 static inline bool cable_present(enum musb_vbus_id_status stat)
 153 {
 154         return stat == MUSB_VBUS_VALID ||
 155                 stat == MUSB_ID_GROUND;
 156 }
 157
 158 struct twl4030_usb {
 159         struct usb_phy          phy;
 160         struct device           *dev;
 161
 162         /* TWL4030 internal USB regulator supplies */
 163         struct regulator        *usb1v5;
 164         struct regulator        *usb1v8;
 165         struct regulator        *usb3v1;
 166
 167         /* for vbus reporting with irqs disabled */
 168         struct mutex            lock;
 169
 170         /* pin configuration */
 171         enum twl4030_usb_mode   usb_mode;
 172
 173         int                     irq;
 174         enum musb_vbus_id_status linkstat;
 175         bool                    vbus_supplied;
 176         bool                    musb_mailbox_pending;
 177
 178         struct delayed_work     id_workaround_work;
 179 };
 180
 181 /* internal define on top of container_of */
 182 #define phy_to_twl(x)           container_of((x), struct twl4030_usb, phy)
 183
 184 /*-------------------------------------------------------------------------*/
 185
 186 static int twl4030_i2c_write_u8_verify(struct twl4030_usb *twl,
 187                 u8 module, u8 data, u8 address)
 188 {
 189         u8 check;
 190
 191         if ((twl_i2c_write_u8(module, data, address) >= 0) &&
 192             (twl_i2c_read_u8(module, &check, address) >= 0) &&
 193                                                 (check == data))
 194                 return 0;
 195         dev_dbg(twl->dev, "Write%d[%d,0x%x] wrote %02x but read %02x\n",
 196                         1, module, address, check, data);
 197
 198         /* Failed once: Try again */
 199         if ((twl_i2c_write_u8(module, data, address) >= 0) &&
 200             (twl_i2c_read_u8(module, &check, address) >= 0) &&
 201                                                 (check == data))
 202                 return 0;
 203         dev_dbg(twl->dev, "Write%d[%d,0x%x] wrote %02x but read %02x\n",
 204                         2, module, address, check, data);
 205
 206         /* Failed again: Return error */
 207         return -EBUSY;
 208 }
 209
 210 #define twl4030_usb_write_verify(twl, address, data)    \
 211         twl4030_i2c_write_u8_verify(twl, TWL_MODULE_USB, (data), (address))
 212
 213 static inline int twl4030_usb_write(struct twl4030_usb *twl,
 214                 u8 address, u8 data)
 215 {
 216         int ret = 0;
 217
 218         ret = twl_i2c_write_u8(TWL_MODULE_USB, data, address);
 219         if (ret < 0)
 220                 dev_dbg(twl->dev,
 221                         "TWL4030:USB:Write[0x%x] Error %d\n", address, ret);
 222         return ret;
 223 }
 224
 225 static inline int twl4030_readb(struct twl4030_usb *twl, u8 module, u8 address)
 226 {
 227         u8 data;
 228         int ret = 0;
 229
 230         ret = twl_i2c_read_u8(module, &data, address);
 231         if (ret >= 0)
 232                 ret = data;
 233         else
 234                 dev_dbg(twl->dev,
 235                         "TWL4030:readb[0x%x,0x%x] Error %d\n",
 236                                         module, address, ret);
 237
 238         return ret;
 239 }
 240
 241 static inline int twl4030_usb_read(struct twl4030_usb *twl, u8 address)
 242 {
 243         return twl4030_readb(twl, TWL_MODULE_USB, address);
 244 }
 245
 246 /*-------------------------------------------------------------------------*/
 247
 248 static inline int
 249 twl4030_usb_set_bits(struct twl4030_usb *twl, u8 reg, u8 bits)
 250 {
 251         return twl4030_usb_write(twl, ULPI_SET(reg), bits);
 252 }
 253
 254 static inline int
 255 twl4030_usb_clear_bits(struct twl4030_usb *twl, u8 reg, u8 bits)
 256 {
 257         return twl4030_usb_write(twl, ULPI_CLR(reg), bits);
 258 }
 259
 260 /*-------------------------------------------------------------------------*/
 261
 262 static bool twl4030_is_driving_vbus(struct twl4030_usb *twl)
 263 {
 264         int ret;
 265
 266         ret = twl4030_usb_read(twl, PHY_CLK_CTRL_STS);
 267         if (ret < 0 || !(ret & PHY_DPLL_CLK))
 268                 /*
 269                  * if clocks are off, registers are not updated,
 270                  * but we can assume we don't drive VBUS in this case
 271                  */
 272                 return false;
 273
 274         ret = twl4030_usb_read(twl, ULPI_OTG_CTRL);
 275         if (ret < 0)
 276                 return false;
 277
 278         return (ret & (ULPI_OTG_DRVVBUS | ULPI_OTG_CHRGVBUS)) ? true : false;
 279 }
 280
 281 static enum musb_vbus_id_status
 282         twl4030_usb_linkstat(struct twl4030_usb *twl)
 283 {
 284         int     status;
 285         enum musb_vbus_id_status linkstat = MUSB_UNKNOWN;
 286
 287         twl->vbus_supplied = false;
 288
 289         /*
 290          * For ID/VBUS sensing, see manual section 15.4.8 ...
 291          * except when using only battery backup power, two
 292          * comparators produce VBUS_PRES and ID_PRES signals,
 293          * which don't match docs elsewhere.  But ... BIT(7)
 294          * and BIT(2) of STS_HW_CONDITIONS, respectively, do
 295          * seem to match up.  If either is true the USB_PRES
 296          * signal is active, the OTG module is activated, and
 297          * its interrupt may be raised (may wake the system).
 298          */
 299         status = twl4030_readb(twl, TWL_MODULE_PM_MASTER, STS_HW_CONDITIONS);
 300         if (status < 0)
 301                 dev_err(twl->dev, "USB link status err %d\n", status);
 302         else if (status & (BIT(7) | BIT(2))) {
 303                 if (status & BIT(7)) {
 304                         if (twl4030_is_driving_vbus(twl))
 305                                 status &= ~BIT(7);
 306                         else
 307                                 twl->vbus_supplied = true;
 308                 }
 309
 310                 if (status & BIT(2))
 311                         linkstat = MUSB_ID_GROUND;
 312                 else if (status & BIT(7))
 313                         linkstat = MUSB_VBUS_VALID;
 314                 else
 315                         linkstat = MUSB_VBUS_OFF;
 316         } else {
 317                 if (twl->linkstat != MUSB_UNKNOWN)
 318                         linkstat = MUSB_VBUS_OFF;
 319         }
 320
 321         dev_dbg(twl->dev, "HW_CONDITIONS 0x%02x/%d; link %d\n",
 322                         status, status, linkstat);
 323
 324         /* REVISIT this assumes host and peripheral controllers
 325          * are registered, and that both are active...
 326          */
 327
 328         return linkstat;
 329 }
 330
 331 static void twl4030_usb_set_mode(struct twl4030_usb *twl, int mode)
 332 {
 333         twl->usb_mode = mode;
 334
 335         switch (mode) {
 336         case T2_USB_MODE_ULPI:
 337                 twl4030_usb_clear_bits(twl, ULPI_IFC_CTRL,
 338                                         ULPI_IFC_CTRL_CARKITMODE);
 339                 twl4030_usb_set_bits(twl, POWER_CTRL, POWER_CTRL_OTG_ENAB);
 340                 twl4030_usb_clear_bits(twl, ULPI_FUNC_CTRL,
 341                                         ULPI_FUNC_CTRL_XCVRSEL_MASK |
 342                                         ULPI_FUNC_CTRL_OPMODE_MASK);
 343                 break;
 344         case -1:
 345                 /* FIXME: power on defaults */
 346                 break;
 347         default:
 348                 dev_err(twl->dev, "unsupported T2 transceiver mode %d\n",
 349                                 mode);
 350                 break;
 351         }
 352 }
 353
 354 static void twl4030_i2c_access(struct twl4030_usb *twl, int on)
 355 {
 356         unsigned long timeout;
 357         int val = twl4030_usb_read(twl, PHY_CLK_CTRL);
 358
 359         if (val >= 0) {
 360                 if (on) {
 361                         /* enable DPLL to access PHY registers over I2C */
 362                         val |= REQ_PHY_DPLL_CLK;
 363                         WARN_ON(twl4030_usb_write_verify(twl, PHY_CLK_CTRL,
 364                                                 (u8)val) < 0);
 365
 366                         timeout = jiffies + HZ;
 367                         while (!(twl4030_usb_read(twl, PHY_CLK_CTRL_STS) &
 368                                                         PHY_DPLL_CLK)
 369                                 && time_before(jiffies, timeout))
 370                                         udelay(10);
 371                         if (!(twl4030_usb_read(twl, PHY_CLK_CTRL_STS) &
 372                                                         PHY_DPLL_CLK))
 373                                 dev_err(twl->dev, "Timeout setting T2 HSUSB "
 374                                                 "PHY DPLL clock\n");
 375                 } else {
 376                         /* let ULPI control the DPLL clock */
 377                         val &= ~REQ_PHY_DPLL_CLK;
 378                         WARN_ON(twl4030_usb_write_verify(twl, PHY_CLK_CTRL,
 379                                                 (u8)val) < 0);
 380                 }
 381         }
 382 }
 383
 384 static void __twl4030_phy_power(struct twl4030_usb *twl, int on)
 385 {
 386         u8 pwr = twl4030_usb_read(twl, PHY_PWR_CTRL);
 387
 388         if (on)
 389                 pwr &= ~PHY_PWR_PHYPWD;
 390         else
 391                 pwr |= PHY_PWR_PHYPWD;
 392
 393         WARN_ON(twl4030_usb_write_verify(twl, PHY_PWR_CTRL, pwr) < 0);
 394 }
 395
 396 static int __maybe_unused twl4030_usb_suspend(struct device *dev)
 397 {
 398         struct twl4030_usb *twl = dev_get_drvdata(dev);
 399
 400         /*
 401          * we need enabled runtime on resume,
 402          * so turn irq off here, so we do not get it early
 403          * note: wakeup on usb plug works independently of this
 404          */
 405         dev_dbg(twl->dev, "%s\n", __func__);
 406         disable_irq(twl->irq);
 407
 408         return 0;
 409 }
 410
 411 static int __maybe_unused twl4030_usb_resume(struct device *dev)
 412 {
 413         struct twl4030_usb *twl = dev_get_drvdata(dev);
 414
 415         dev_dbg(twl->dev, "%s\n", __func__);
 416         enable_irq(twl->irq);
 417         /* check whether cable status changed */
 418         twl4030_usb_irq(0, twl);
 419
 420         return 0;
 421 }
 422
 423 static int __maybe_unused twl4030_usb_runtime_suspend(struct device *dev)
 424 {
 425         struct twl4030_usb *twl = dev_get_drvdata(dev);
 426
 427         dev_dbg(twl->dev, "%s\n", __func__);
 428
 429         __twl4030_phy_power(twl, 0);
 430         regulator_disable(twl->usb1v5);
 431         regulator_disable(twl->usb1v8);
 432         regulator_disable(twl->usb3v1);
 433
 434         return 0;
 435 }
 436
 437 static int __maybe_unused twl4030_usb_runtime_resume(struct device *dev)
 438 {
 439         struct twl4030_usb *twl = dev_get_drvdata(dev);
 440         int res;
 441
 442         dev_dbg(twl->dev, "%s\n", __func__);
 443
 444         res = regulator_enable(twl->usb3v1);
 445         if (res)
 446                 dev_err(twl->dev, "Failed to enable usb3v1\n");
 447
 448         res = regulator_enable(twl->usb1v8);
 449         if (res)
 450                 dev_err(twl->dev, "Failed to enable usb1v8\n");
 451
 452         /*
 453          * Disabling usb3v1 regulator (= writing 0 to VUSB3V1_DEV_GRP
 454          * in twl4030) resets the VUSB_DEDICATED2 register. This reset
 455          * enables VUSB3V1_SLEEP bit that remaps usb3v1 ACTIVE state to
 456          * SLEEP. We work around this by clearing the bit after usv3v1
 457          * is re-activated. This ensures that VUSB3V1 is really active.
 458          */
 459         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB_DEDICATED2);
 460
 461         res = regulator_enable(twl->usb1v5);
 462         if (res)
 463                 dev_err(twl->dev, "Failed to enable usb1v5\n");
 464
 465         __twl4030_phy_power(twl, 1);
 466         twl4030_usb_write(twl, PHY_CLK_CTRL,
 467                           twl4030_usb_read(twl, PHY_CLK_CTRL) |
 468                           (PHY_CLK_CTRL_CLOCKGATING_EN |
 469                            PHY_CLK_CTRL_CLK32K_EN));
 470
 471         twl4030_i2c_access(twl, 1);
 472         twl4030_usb_set_mode(twl, twl->usb_mode);
 473         if (twl->usb_mode == T2_USB_MODE_ULPI)
 474                 twl4030_i2c_access(twl, 0);
 475         /*
 476          * According to the TPS65950 TRM, there has to be at least 50ms
 477          * delay between setting POWER_CTRL_OTG_ENAB and enabling charging
 478          * so wait here so that a fully enabled phy can be expected after
 479          * resume
 480          */
 481         msleep(50);
 482         return 0;
 483 }
 484
 485 static int twl4030_phy_power_off(struct phy *phy)
 486 {
 487         struct twl4030_usb *twl = phy_get_drvdata(phy);
 488
 489         dev_dbg(twl->dev, "%s\n", __func__);
 490
 491         return 0;
 492 }
 493
 494 static int twl4030_phy_power_on(struct phy *phy)
 495 {
 496         struct twl4030_usb *twl = phy_get_drvdata(phy);
 497
 498         dev_dbg(twl->dev, "%s\n", __func__);
 499         pm_runtime_get_sync(twl->dev);
 500         schedule_delayed_work(&twl->id_workaround_work, HZ);
 501         pm_runtime_mark_last_busy(twl->dev);
 502         pm_runtime_put_autosuspend(twl->dev);
 503
 504         return 0;
 505 }
 506
 507 static int twl4030_usb_ldo_init(struct twl4030_usb *twl)
 508 {
 509         /* Enable writing to power configuration registers */
 510         twl_i2c_write_u8(TWL_MODULE_PM_MASTER, TWL4030_PM_MASTER_KEY_CFG1,
 511                          TWL4030_PM_MASTER_PROTECT_KEY);
 512
 513         twl_i2c_write_u8(TWL_MODULE_PM_MASTER, TWL4030_PM_MASTER_KEY_CFG2,
 514                          TWL4030_PM_MASTER_PROTECT_KEY);
 515
 516         /* Keep VUSB3V1 LDO in sleep state until VBUS/ID change detected*/
 517         /*twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB_DEDICATED2);*/
 518
 519         /* input to VUSB3V1 LDO is from VBAT, not VBUS */
 520         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0x14, VUSB_DEDICATED1);
 521
 522         /* Initialize 3.1V regulator */
 523         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB3V1_DEV_GRP);
 524
 525         twl->usb3v1 = devm_regulator_get(twl->dev, "usb3v1");
 526         if (IS_ERR(twl->usb3v1))
 527                 return -ENODEV;
 528
 529         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB3V1_TYPE);
 530
 531         /* Initialize 1.5V regulator */
 532         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB1V5_DEV_GRP);
 533
 534         twl->usb1v5 = devm_regulator_get(twl->dev, "usb1v5");
 535         if (IS_ERR(twl->usb1v5))
 536                 return -ENODEV;
 537
 538         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB1V5_TYPE);
 539
 540         /* Initialize 1.8V regulator */
 541         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB1V8_DEV_GRP);
 542
 543         twl->usb1v8 = devm_regulator_get(twl->dev, "usb1v8");
 544         if (IS_ERR(twl->usb1v8))
 545                 return -ENODEV;
 546
 547         twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER, 0, VUSB1V8_TYPE);
 548
 549         /* disable access to power configuration registers */
 550         twl_i2c_write_u8(TWL_MODULE_PM_MASTER, 0,
 551                          TWL4030_PM_MASTER_PROTECT_KEY);
 552
 553         return 0;
 554 }
 555
 556 static ssize_t twl4030_usb_vbus_show(struct device *dev,
 557                 struct device_attribute *attr, char *buf)
 558 {
 559         struct twl4030_usb *twl = dev_get_drvdata(dev);
 560         int ret = -EINVAL;
 561
 562         mutex_lock(&twl->lock);
 563         ret = sprintf(buf, "%s\n",
 564                         twl->vbus_supplied ? "on" : "off");
 565         mutex_unlock(&twl->lock);
 566
 567         return ret;
 568 }
 569 static DEVICE_ATTR(vbus, 0444, twl4030_usb_vbus_show, NULL);
 570
 571 static irqreturn_t twl4030_usb_irq(int irq, void *_twl)
 572 {
 573         struct twl4030_usb *twl = _twl;
 574         enum musb_vbus_id_status status;
 575         bool status_changed = false;
 576         int err;
 577
 578         status = twl4030_usb_linkstat(twl);
 579
 580         mutex_lock(&twl->lock);
 581         if (status >= 0 && status != twl->linkstat) {
 582                 status_changed =
 583                         cable_present(twl->linkstat) !=
 584                         cable_present(status);
 585                 twl->linkstat = status;
 586         }
 587         mutex_unlock(&twl->lock);
 588
 589         if (status_changed) {
 590                 /* FIXME add a set_power() method so that B-devices can
 591                  * configure the charger appropriately.  It's not always
 592                  * correct to consume VBUS power, and how much current to
 593                  * consume is a function of the USB configuration chosen
 594                  * by the host.
 595                  *
 596                  * REVISIT usb_gadget_vbus_connect(...) as needed, ditto
 597                  * its disconnect() sibling, when changing to/from the
 598                  * USB_LINK_VBUS state.  musb_hdrc won't care until it
 599                  * starts to handle softconnect right.
 600                  */
 601                 if (cable_present(status)) {
 602                         pm_runtime_get_sync(twl->dev);
 603                 } else {
 604                         pm_runtime_mark_last_busy(twl->dev);
 605                         pm_runtime_put_autosuspend(twl->dev);
 606                 }
 607                 twl->musb_mailbox_pending = true;
 608         }
 609         if (twl->musb_mailbox_pending) {
 610                 err = musb_mailbox(status);
 611                 if (!err)
 612                         twl->musb_mailbox_pending = false;
 613         }
 614
 615         /* don't schedule during sleep - irq works right then */
 616         if (status == MUSB_ID_GROUND && pm_runtime_active(twl->dev)) {
 617                 cancel_delayed_work(&twl->id_workaround_work);
 618                 schedule_delayed_work(&twl->id_workaround_work, HZ);
 619         }
 620
 621         if (irq)
 622                 sysfs_notify(&twl->dev->kobj, NULL, "vbus");
 623
 624         return IRQ_HANDLED;
 625 }
 626
 627 static void twl4030_id_workaround_work(struct work_struct *work)
 628 {
 629         struct twl4030_usb *twl = container_of(work, struct twl4030_usb,
 630                 id_workaround_work.work);
 631
 632         twl4030_usb_irq(0, twl);
 633 }
 634
 635 static int twl4030_phy_init(struct phy *phy)
 636 {
 637         struct twl4030_usb *twl = phy_get_drvdata(phy);
 638
 639         pm_runtime_get_sync(twl->dev);
 640         twl->linkstat = MUSB_UNKNOWN;
 641         schedule_delayed_work(&twl->id_workaround_work, HZ);
 642         pm_runtime_mark_last_busy(twl->dev);
 643         pm_runtime_put_autosuspend(twl->dev);
 644
 645         return 0;
 646 }
 647
 648 static int twl4030_set_peripheral(struct usb_otg *otg,
 649                                         struct usb_gadget *gadget)
 650 {
 651         if (!otg)
 652                 return -ENODEV;
 653
 654         otg->gadget = gadget;
 655         if (!gadget)
 656                 otg->state = OTG_STATE_UNDEFINED;
 657
 658         return 0;
 659 }
 660
 661 static int twl4030_set_host(struct usb_otg *otg, struct usb_bus *host)
 662 {
 663         if (!otg)
 664                 return -ENODEV;
 665
 666         otg->host = host;
 667         if (!host)
 668                 otg->state = OTG_STATE_UNDEFINED;
 669
 670         return 0;
 671 }
 672
 673 static const struct phy_ops ops = {
 674         .init           = twl4030_phy_init,
 675         .power_on       = twl4030_phy_power_on,
 676         .power_off      = twl4030_phy_power_off,
 677         .owner          = THIS_MODULE,
 678 };
 679
 680 static const struct dev_pm_ops twl4030_usb_pm_ops = {
 681         SET_RUNTIME_PM_OPS(twl4030_usb_runtime_suspend,
 682                            twl4030_usb_runtime_resume, NULL)
 683         SET_SYSTEM_SLEEP_PM_OPS(twl4030_usb_suspend, twl4030_usb_resume)
 684 };
 685
 686 static int twl4030_usb_probe(struct platform_device *pdev)
 687 {
 688         struct twl4030_usb_data *pdata = dev_get_platdata(&pdev->dev);
 689         struct twl4030_usb      *twl;
 690         struct phy              *phy;
 691         int                     status, err;
 692         struct usb_otg          *otg;
 693         struct device_node      *np = pdev->dev.of_node;
 694         struct phy_provider     *phy_provider;
 695
 696         twl = devm_kzalloc(&pdev->dev, sizeof(*twl), GFP_KERNEL);
 697         if (!twl)
 698                 return -ENOMEM;
 699
 700         if (np)
 701                 of_property_read_u32(np, "usb_mode",
 702                                 (enum twl4030_usb_mode *)&twl->usb_mode);
 703         else if (pdata) {
 704                 twl->usb_mode = pdata->usb_mode;
 705         } else {
 706                 dev_err(&pdev->dev, "twl4030 initialized without pdata\n");
 707                 return -EINVAL;
 708         }
 709
 710         otg = devm_kzalloc(&pdev->dev, sizeof(*otg), GFP_KERNEL);
 711         if (!otg)
 712                 return -ENOMEM;
 713
 714         twl->dev                = &pdev->dev;
 715         twl->irq                = platform_get_irq(pdev, 0);
 716         twl->vbus_supplied      = false;
 717         twl->linkstat           = MUSB_UNKNOWN;
 718         twl->musb_mailbox_pending = false;
 719
 720         twl->phy.dev            = twl->dev;
 721         twl->phy.label          = "twl4030";
 722         twl->phy.otg            = otg;
 723         twl->phy.type           = USB_PHY_TYPE_USB2;
 724
 725         otg->usb_phy            = &twl->phy;
 726         otg->set_host           = twl4030_set_host;
 727         otg->set_peripheral     = twl4030_set_peripheral;
 728
 729         phy = devm_phy_create(twl->dev, NULL, &ops);
 730         if (IS_ERR(phy)) {
 731                 dev_dbg(&pdev->dev, "Failed to create PHY\n");
 732                 return PTR_ERR(phy);
 733         }
 734
 735         phy_set_drvdata(phy, twl);
 736
 737         phy_provider = devm_of_phy_provider_register(twl->dev,
 738                 of_phy_simple_xlate);
 739         if (IS_ERR(phy_provider))
 740                 return PTR_ERR(phy_provider);
 741
 742         /* init mutex for workqueue */
 743         mutex_init(&twl->lock);
 744
 745         INIT_DELAYED_WORK(&twl->id_workaround_work, twl4030_id_workaround_work);
 746
 747         err = twl4030_usb_ldo_init(twl);
 748         if (err) {
 749                 dev_err(&pdev->dev, "ldo init failed\n");
 750                 return err;
 751         }
 752         usb_add_phy_dev(&twl->phy);
 753
 754         platform_set_drvdata(pdev, twl);
 755         if (device_create_file(&pdev->dev, &dev_attr_vbus))
 756                 dev_warn(&pdev->dev, "could not create sysfs file\n");
 757
 758         ATOMIC_INIT_NOTIFIER_HEAD(&twl->phy.notifier);
 759
 760         pm_runtime_use_autosuspend(&pdev->dev);
 761         pm_runtime_set_autosuspend_delay(&pdev->dev, 2000);
 762         pm_runtime_enable(&pdev->dev);
 763         pm_runtime_get_sync(&pdev->dev);
 764
 765         /* Our job is to use irqs and status from the power module
 766          * to keep the transceiver disabled when nothing's connected.
 767          *
 768          * FIXME we actually shouldn't start enabling it until the
 769          * USB controller drivers have said they're ready, by calling
 770          * set_host() and/or set_peripheral() ... OTG_capable boards
 771          * need both handles, otherwise just one suffices.
 772          */
 773         status = devm_request_threaded_irq(twl->dev, twl->irq, NULL,
 774                         twl4030_usb_irq, IRQF_TRIGGER_FALLING |
 775                         IRQF_TRIGGER_RISING | IRQF_ONESHOT, "twl4030_usb", twl);
 776         if (status < 0) {
 777                 dev_dbg(&pdev->dev, "can't get IRQ %d, err %d\n",
 778                         twl->irq, status);
 779                 return status;
 780         }
 781
 782         if (pdata)
 783                 err = phy_create_lookup(phy, "usb", "musb-hdrc.0");
 784         if (err)
 785                 return err;
 786
 787         pm_runtime_mark_last_busy(&pdev->dev);
 788         pm_runtime_put_autosuspend(twl->dev);
 789
 790         dev_info(&pdev->dev, "Initialized TWL4030 USB module\n");
 791         return 0;
 792 }
 793
 794 static int twl4030_usb_remove(struct platform_device *pdev)
 795 {
 796         struct twl4030_usb *twl = platform_get_drvdata(pdev);
 797         int val;
 798
 799         usb_remove_phy(&twl->phy);
 800         pm_runtime_get_sync(twl->dev);
 801         cancel_delayed_work_sync(&twl->id_workaround_work);
 802         device_remove_file(twl->dev, &dev_attr_vbus);
 803
 804         /* set transceiver mode to power on defaults */
 805         twl4030_usb_set_mode(twl, -1);
 806
 807         /* idle ulpi before powering off */
 808         if (cable_present(twl->linkstat))
 809                 pm_runtime_put_noidle(twl->dev);
 810         pm_runtime_mark_last_busy(twl->dev);
 811         pm_runtime_dont_use_autosuspend(&pdev->dev);
 812         pm_runtime_put_sync(twl->dev);
 813         pm_runtime_disable(twl->dev);
 814
 815         /* autogate 60MHz ULPI clock,
 816          * clear dpll clock request for i2c access,
 817          * disable 32KHz
 818          */
 819         val = twl4030_usb_read(twl, PHY_CLK_CTRL);
 820         if (val >= 0) {
 821                 val |= PHY_CLK_CTRL_CLOCKGATING_EN;
 822                 val &= ~(PHY_CLK_CTRL_CLK32K_EN | REQ_PHY_DPLL_CLK);
 823                 twl4030_usb_write(twl, PHY_CLK_CTRL, (u8)val);
 824         }
 825
 826         /* disable complete OTG block */
 827         twl4030_usb_clear_bits(twl, POWER_CTRL, POWER_CTRL_OTG_ENAB);
 828
 829         return 0;
 830 }
 831
 832 #ifdef CONFIG_OF
 833 static const struct of_device_id twl4030_usb_id_table[] = {
 834         { .compatible = "ti,twl4030-usb" },
 835         {}
 836 };
 837 MODULE_DEVICE_TABLE(of, twl4030_usb_id_table);
 838 #endif
 839
 840 static struct platform_driver twl4030_usb_driver = {
 841         .probe          = twl4030_usb_probe,
 842         .remove         = twl4030_usb_remove,
 843         .driver         = {
 844                 .name   = "twl4030_usb",
 845                 .pm     = &twl4030_usb_pm_ops,
 846                 .of_match_table = of_match_ptr(twl4030_usb_id_table),
 847         },
 848 };
 849
 850 static int __init twl4030_usb_init(void)
 851 {
 852         return platform_driver_register(&twl4030_usb_driver);
 853 }
 854 subsys_initcall(twl4030_usb_init);
 855
 856 static void __exit twl4030_usb_exit(void)
 857 {
 858         platform_driver_unregister(&twl4030_usb_driver);
 859 }
 860 module_exit(twl4030_usb_exit);
 861
 862 MODULE_ALIAS("platform:twl4030_usb");
 863 MODULE_AUTHOR("Texas Instruments, Inc, Nokia Corporation");
 864 MODULE_DESCRIPTION("TWL4030 USB transceiver driver");
 865 MODULE_LICENSE("GPL");