Pileus Git - ~andy/linux/blob - drivers/usb/otg/twl6030-usb.c

   1 /*
   2  * twl6030_usb - TWL6030 USB transceiver, talking to OMAP OTG driver.
   3  *
   4  * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * Author: Hema HK <hemahk@ti.com>
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/io.h>
  28 #include <linux/usb/musb-omap.h>
  29 #include <linux/usb/phy_companion.h>
  30 #include <linux/usb/omap_usb.h>
  31 #include <linux/i2c/twl.h>
  32 #include <linux/regulator/consumer.h>
  33 #include <linux/err.h>
  34 #include <linux/slab.h>
  35 #include <linux/delay.h>
  36
  37 /* usb register definitions */
  38 #define USB_VENDOR_ID_LSB               0x00
  39 #define USB_VENDOR_ID_MSB               0x01
  40 #define USB_PRODUCT_ID_LSB              0x02
  41 #define USB_PRODUCT_ID_MSB              0x03
  42 #define USB_VBUS_CTRL_SET               0x04
  43 #define USB_VBUS_CTRL_CLR               0x05
  44 #define USB_ID_CTRL_SET                 0x06
  45 #define USB_ID_CTRL_CLR                 0x07
  46 #define USB_VBUS_INT_SRC                0x08
  47 #define USB_VBUS_INT_LATCH_SET          0x09
  48 #define USB_VBUS_INT_LATCH_CLR          0x0A
  49 #define USB_VBUS_INT_EN_LO_SET          0x0B
  50 #define USB_VBUS_INT_EN_LO_CLR          0x0C
  51 #define USB_VBUS_INT_EN_HI_SET          0x0D
  52 #define USB_VBUS_INT_EN_HI_CLR          0x0E
  53 #define USB_ID_INT_SRC                  0x0F
  54 #define USB_ID_INT_LATCH_SET            0x10
  55 #define USB_ID_INT_LATCH_CLR            0x11
  56
  57 #define USB_ID_INT_EN_LO_SET            0x12
  58 #define USB_ID_INT_EN_LO_CLR            0x13
  59 #define USB_ID_INT_EN_HI_SET            0x14
  60 #define USB_ID_INT_EN_HI_CLR            0x15
  61 #define USB_OTG_ADP_CTRL                0x16
  62 #define USB_OTG_ADP_HIGH                0x17
  63 #define USB_OTG_ADP_LOW                 0x18
  64 #define USB_OTG_ADP_RISE                0x19
  65 #define USB_OTG_REVISION                0x1A
  66
  67 /* to be moved to LDO */
  68 #define TWL6030_MISC2                   0xE5
  69 #define TWL6030_CFG_LDO_PD2             0xF5
  70 #define TWL6030_BACKUP_REG              0xFA
  71
  72 #define STS_HW_CONDITIONS               0x21
  73
  74 /* In module TWL6030_MODULE_PM_MASTER */
  75 #define STS_HW_CONDITIONS               0x21
  76 #define STS_USB_ID                      BIT(2)
  77
  78 /* In module TWL6030_MODULE_PM_RECEIVER */
  79 #define VUSB_CFG_TRANS                  0x71
  80 #define VUSB_CFG_STATE                  0x72
  81 #define VUSB_CFG_VOLTAGE                0x73
  82
  83 /* in module TWL6030_MODULE_MAIN_CHARGE */
  84
  85 #define CHARGERUSB_CTRL1                0x8
  86
  87 #define CONTROLLER_STAT1                0x03
  88 #define VBUS_DET                        BIT(2)
  89
  90 struct twl6030_usb {
  91         struct phy_companion    comparator;
  92         struct device           *dev;
  93
  94         /* for vbus reporting with irqs disabled */
  95         spinlock_t              lock;
  96
  97         struct regulator                *usb3v3;
  98
  99         /* used to set vbus, in atomic path */
 100         struct work_struct      set_vbus_work;
 101
 102         int                     irq1;
 103         int                     irq2;
 104         enum omap_musb_vbus_id_status linkstat;
 105         u8                      asleep;
 106         bool                    irq_enabled;
 107         bool                    vbus_enable;
 108         unsigned long           features;
 109 };
 110
 111 #define comparator_to_twl(x) container_of((x), struct twl6030_usb, comparator)
 112
 113 /*-------------------------------------------------------------------------*/
 114
 115 static inline int twl6030_writeb(struct twl6030_usb *twl, u8 module,
 116                                                 u8 data, u8 address)
 117 {
 118         int ret = 0;
 119
 120         ret = twl_i2c_write_u8(module, data, address);
 121         if (ret < 0)
 122                 dev_err(twl->dev,
 123                         "Write[0x%x] Error %d\n", address, ret);
 124         return ret;
 125 }
 126
 127 static inline u8 twl6030_readb(struct twl6030_usb *twl, u8 module, u8 address)
 128 {
 129         u8 data, ret = 0;
 130
 131         ret = twl_i2c_read_u8(module, &data, address);
 132         if (ret >= 0)
 133                 ret = data;
 134         else
 135                 dev_err(twl->dev,
 136                         "readb[0x%x,0x%x] Error %d\n",
 137                                         module, address, ret);
 138         return ret;
 139 }
 140
 141 static int twl6030_start_srp(struct phy_companion *comparator)
 142 {
 143         struct twl6030_usb *twl = comparator_to_twl(comparator);
 144
 145         twl6030_writeb(twl, TWL_MODULE_USB, 0x24, USB_VBUS_CTRL_SET);
 146         twl6030_writeb(twl, TWL_MODULE_USB, 0x84, USB_VBUS_CTRL_SET);
 147
 148         mdelay(100);
 149         twl6030_writeb(twl, TWL_MODULE_USB, 0xa0, USB_VBUS_CTRL_CLR);
 150
 151         return 0;
 152 }
 153
 154 static int twl6030_usb_ldo_init(struct twl6030_usb *twl)
 155 {
 156         char *regulator_name;
 157
 158         if (twl->features & TWL6025_SUBCLASS)
 159                 regulator_name = "ldousb";
 160         else
 161                 regulator_name = "vusb";
 162
 163         /* Set to OTG_REV 1.3 and turn on the ID_WAKEUP_COMP */
 164         twl6030_writeb(twl, TWL6030_MODULE_ID0 , 0x1, TWL6030_BACKUP_REG);
 165
 166         /* Program CFG_LDO_PD2 register and set VUSB bit */
 167         twl6030_writeb(twl, TWL6030_MODULE_ID0 , 0x1, TWL6030_CFG_LDO_PD2);
 168
 169         /* Program MISC2 register and set bit VUSB_IN_VBAT */
 170         twl6030_writeb(twl, TWL6030_MODULE_ID0 , 0x10, TWL6030_MISC2);
 171
 172         twl->usb3v3 = regulator_get(twl->dev, regulator_name);
 173         if (IS_ERR(twl->usb3v3))
 174                 return -ENODEV;
 175
 176         /* Program the USB_VBUS_CTRL_SET and set VBUS_ACT_COMP bit */
 177         twl6030_writeb(twl, TWL_MODULE_USB, 0x4, USB_VBUS_CTRL_SET);
 178
 179         /*
 180          * Program the USB_ID_CTRL_SET register to enable GND drive
 181          * and the ID comparators
 182          */
 183         twl6030_writeb(twl, TWL_MODULE_USB, 0x14, USB_ID_CTRL_SET);
 184
 185         return 0;
 186 }
 187
 188 static ssize_t twl6030_usb_vbus_show(struct device *dev,
 189                         struct device_attribute *attr, char *buf)
 190 {
 191         struct twl6030_usb *twl = dev_get_drvdata(dev);
 192         unsigned long flags;
 193         int ret = -EINVAL;
 194
 195         spin_lock_irqsave(&twl->lock, flags);
 196
 197         switch (twl->linkstat) {
 198         case OMAP_MUSB_VBUS_VALID:
 199                ret = snprintf(buf, PAGE_SIZE, "vbus\n");
 200                break;
 201         case OMAP_MUSB_ID_GROUND:
 202                ret = snprintf(buf, PAGE_SIZE, "id\n");
 203                break;
 204         case OMAP_MUSB_VBUS_OFF:
 205                ret = snprintf(buf, PAGE_SIZE, "none\n");
 206                break;
 207         default:
 208                ret = snprintf(buf, PAGE_SIZE, "UNKNOWN\n");
 209         }
 210         spin_unlock_irqrestore(&twl->lock, flags);
 211
 212         return ret;
 213 }
 214 static DEVICE_ATTR(vbus, 0444, twl6030_usb_vbus_show, NULL);
 215
 216 static irqreturn_t twl6030_usb_irq(int irq, void *_twl)
 217 {
 218         struct twl6030_usb *twl = _twl;
 219         enum omap_musb_vbus_id_status status = OMAP_MUSB_UNKNOWN;
 220         u8 vbus_state, hw_state;
 221
 222         hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
 223
 224         vbus_state = twl6030_readb(twl, TWL_MODULE_MAIN_CHARGE,
 225                                                 CONTROLLER_STAT1);
 226         if (!(hw_state & STS_USB_ID)) {
 227                 if (vbus_state & VBUS_DET) {
 228                         regulator_enable(twl->usb3v3);
 229                         twl->asleep = 1;
 230                         status = OMAP_MUSB_VBUS_VALID;
 231                         twl->linkstat = status;
 232                         omap_musb_mailbox(status);
 233                 } else {
 234                         if (twl->linkstat != OMAP_MUSB_UNKNOWN) {
 235                                 status = OMAP_MUSB_VBUS_OFF;
 236                                 twl->linkstat = status;
 237                                 omap_musb_mailbox(status);
 238                                 if (twl->asleep) {
 239                                         regulator_disable(twl->usb3v3);
 240                                         twl->asleep = 0;
 241                                 }
 242                         }
 243                 }
 244         }
 245         sysfs_notify(&twl->dev->kobj, NULL, "vbus");
 246
 247         return IRQ_HANDLED;
 248 }
 249
 250 static irqreturn_t twl6030_usbotg_irq(int irq, void *_twl)
 251 {
 252         struct twl6030_usb *twl = _twl;
 253         enum omap_musb_vbus_id_status status = OMAP_MUSB_UNKNOWN;
 254         u8 hw_state;
 255
 256         hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
 257
 258         if (hw_state & STS_USB_ID) {
 259
 260                 regulator_enable(twl->usb3v3);
 261                 twl->asleep = 1;
 262                 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_CLR);
 263                 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_SET);
 264                 status = OMAP_MUSB_ID_GROUND;
 265                 twl->linkstat = status;
 266                 omap_musb_mailbox(status);
 267         } else  {
 268                 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_CLR);
 269                 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET);
 270         }
 271         twl6030_writeb(twl, TWL_MODULE_USB, status, USB_ID_INT_LATCH_CLR);
 272
 273         return IRQ_HANDLED;
 274 }
 275
 276 static int twl6030_enable_irq(struct twl6030_usb *twl)
 277 {
 278         twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET);
 279         twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C);
 280         twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C);
 281
 282         twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
 283                                 REG_INT_MSK_LINE_C);
 284         twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
 285                                 REG_INT_MSK_STS_C);
 286         twl6030_usb_irq(twl->irq2, twl);
 287         twl6030_usbotg_irq(twl->irq1, twl);
 288
 289         return 0;
 290 }
 291
 292 static void otg_set_vbus_work(struct work_struct *data)
 293 {
 294         struct twl6030_usb *twl = container_of(data, struct twl6030_usb,
 295                                                                 set_vbus_work);
 296
 297         /*
 298          * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1
 299          * register. This enables boost mode.
 300          */
 301
 302         if (twl->vbus_enable)
 303                 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x40,
 304                                                         CHARGERUSB_CTRL1);
 305         else
 306                 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x00,
 307                                                         CHARGERUSB_CTRL1);
 308 }
 309
 310 static int twl6030_set_vbus(struct phy_companion *comparator, bool enabled)
 311 {
 312         struct twl6030_usb *twl = comparator_to_twl(comparator);
 313
 314         twl->vbus_enable = enabled;
 315         schedule_work(&twl->set_vbus_work);
 316
 317         return 0;
 318 }
 319
 320 static int __devinit twl6030_usb_probe(struct platform_device *pdev)
 321 {
 322         u32 ret;
 323         struct twl6030_usb      *twl;
 324         int                     status, err;
 325         struct twl4030_usb_data *pdata;
 326         struct device *dev = &pdev->dev;
 327         pdata = dev->platform_data;
 328
 329         twl = devm_kzalloc(dev, sizeof *twl, GFP_KERNEL);
 330         if (!twl)
 331                 return -ENOMEM;
 332
 333         twl->dev                = &pdev->dev;
 334         twl->irq1               = platform_get_irq(pdev, 0);
 335         twl->irq2               = platform_get_irq(pdev, 1);
 336         twl->features           = pdata->features;
 337         twl->linkstat           = OMAP_MUSB_UNKNOWN;
 338
 339         twl->comparator.set_vbus        = twl6030_set_vbus;
 340         twl->comparator.start_srp       = twl6030_start_srp;
 341
 342         ret = omap_usb2_set_comparator(&twl->comparator);
 343         if (ret == -ENODEV) {
 344                 dev_info(&pdev->dev, "phy not ready, deferring probe");
 345                 return -EPROBE_DEFER;
 346         }
 347
 348         /* init spinlock for workqueue */
 349         spin_lock_init(&twl->lock);
 350
 351         err = twl6030_usb_ldo_init(twl);
 352         if (err) {
 353                 dev_err(&pdev->dev, "ldo init failed\n");
 354                 return err;
 355         }
 356
 357         platform_set_drvdata(pdev, twl);
 358         if (device_create_file(&pdev->dev, &dev_attr_vbus))
 359                 dev_warn(&pdev->dev, "could not create sysfs file\n");
 360
 361         INIT_WORK(&twl->set_vbus_work, otg_set_vbus_work);
 362
 363         twl->irq_enabled = true;
 364         status = request_threaded_irq(twl->irq1, NULL, twl6030_usbotg_irq,
 365                         IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 366                         "twl6030_usb", twl);
 367         if (status < 0) {
 368                 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
 369                         twl->irq1, status);
 370                 device_remove_file(twl->dev, &dev_attr_vbus);
 371                 return status;
 372         }
 373
 374         status = request_threaded_irq(twl->irq2, NULL, twl6030_usb_irq,
 375                         IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 376                         "twl6030_usb", twl);
 377         if (status < 0) {
 378                 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
 379                         twl->irq2, status);
 380                 free_irq(twl->irq1, twl);
 381                 device_remove_file(twl->dev, &dev_attr_vbus);
 382                 return status;
 383         }
 384
 385         twl->asleep = 0;
 386         twl6030_enable_irq(twl);
 387         dev_info(&pdev->dev, "Initialized TWL6030 USB module\n");
 388
 389         return 0;
 390 }
 391
 392 static int __exit twl6030_usb_remove(struct platform_device *pdev)
 393 {
 394         struct twl6030_usb *twl = platform_get_drvdata(pdev);
 395
 396         twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
 397                 REG_INT_MSK_LINE_C);
 398         twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
 399                         REG_INT_MSK_STS_C);
 400         free_irq(twl->irq1, twl);
 401         free_irq(twl->irq2, twl);
 402         regulator_put(twl->usb3v3);
 403         device_remove_file(twl->dev, &dev_attr_vbus);
 404         cancel_work_sync(&twl->set_vbus_work);
 405
 406         return 0;
 407 }
 408
 409 static struct platform_driver twl6030_usb_driver = {
 410         .probe          = twl6030_usb_probe,
 411         .remove         = __exit_p(twl6030_usb_remove),
 412         .driver         = {
 413                 .name   = "twl6030_usb",
 414                 .owner  = THIS_MODULE,
 415         },
 416 };
 417
 418 static int __init twl6030_usb_init(void)
 419 {
 420         return platform_driver_register(&twl6030_usb_driver);
 421 }
 422 subsys_initcall(twl6030_usb_init);
 423
 424 static void __exit twl6030_usb_exit(void)
 425 {
 426         platform_driver_unregister(&twl6030_usb_driver);
 427 }
 428 module_exit(twl6030_usb_exit);
 429
 430 MODULE_ALIAS("platform:twl6030_usb");
 431 MODULE_AUTHOR("Hema HK <hemahk@ti.com>");
 432 MODULE_DESCRIPTION("TWL6030 USB transceiver driver");
 433 MODULE_LICENSE("GPL");