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.h> 29 #include <linux/usb/phy_companion.h> 30 #include <linux/phy/omap_usb.h> 31 #include <linux/mfd/twl.h> 32 #include <linux/regulator/consumer.h> 33 #include <linux/err.h> 34 #include <linux/slab.h> 35 #include <linux/delay.h> 36 #include <linux/of.h> 37 38 /* usb register definitions */ 39 #define USB_VENDOR_ID_LSB 0x00 40 #define USB_VENDOR_ID_MSB 0x01 41 #define USB_PRODUCT_ID_LSB 0x02 42 #define USB_PRODUCT_ID_MSB 0x03 43 #define USB_VBUS_CTRL_SET 0x04 44 #define USB_VBUS_CTRL_CLR 0x05 45 #define USB_ID_CTRL_SET 0x06 46 #define USB_ID_CTRL_CLR 0x07 47 #define USB_VBUS_INT_SRC 0x08 48 #define USB_VBUS_INT_LATCH_SET 0x09 49 #define USB_VBUS_INT_LATCH_CLR 0x0A 50 #define USB_VBUS_INT_EN_LO_SET 0x0B 51 #define USB_VBUS_INT_EN_LO_CLR 0x0C 52 #define USB_VBUS_INT_EN_HI_SET 0x0D 53 #define USB_VBUS_INT_EN_HI_CLR 0x0E 54 #define USB_ID_INT_SRC 0x0F 55 #define USB_ID_INT_LATCH_SET 0x10 56 #define USB_ID_INT_LATCH_CLR 0x11 57 58 #define USB_ID_INT_EN_LO_SET 0x12 59 #define USB_ID_INT_EN_LO_CLR 0x13 60 #define USB_ID_INT_EN_HI_SET 0x14 61 #define USB_ID_INT_EN_HI_CLR 0x15 62 #define USB_OTG_ADP_CTRL 0x16 63 #define USB_OTG_ADP_HIGH 0x17 64 #define USB_OTG_ADP_LOW 0x18 65 #define USB_OTG_ADP_RISE 0x19 66 #define USB_OTG_REVISION 0x1A 67 68 /* to be moved to LDO */ 69 #define TWL6030_MISC2 0xE5 70 #define TWL6030_CFG_LDO_PD2 0xF5 71 #define TWL6030_BACKUP_REG 0xFA 72 73 #define STS_HW_CONDITIONS 0x21 74 75 /* In module TWL6030_MODULE_PM_MASTER */ 76 #define STS_HW_CONDITIONS 0x21 77 #define STS_USB_ID BIT(2) 78 79 /* In module TWL6030_MODULE_PM_RECEIVER */ 80 #define VUSB_CFG_TRANS 0x71 81 #define VUSB_CFG_STATE 0x72 82 #define VUSB_CFG_VOLTAGE 0x73 83 84 /* in module TWL6030_MODULE_MAIN_CHARGE */ 85 86 #define CHARGERUSB_CTRL1 0x8 87 88 #define CONTROLLER_STAT1 0x03 89 #define VBUS_DET BIT(2) 90 91 struct twl6030_usb { 92 struct phy_companion comparator; 93 struct device *dev; 94 95 /* for vbus reporting with irqs disabled */ 96 spinlock_t lock; 97 98 struct regulator *usb3v3; 99 100 /* used to check initial cable status after probe */ 101 struct delayed_work get_status_work; 102 103 /* used to set vbus, in atomic path */ 104 struct work_struct set_vbus_work; 105 106 int irq1; 107 int irq2; 108 enum musb_vbus_id_status linkstat; 109 u8 asleep; 110 bool vbus_enable; 111 }; 112 113 #define comparator_to_twl(x) container_of((x), struct twl6030_usb, comparator) 114 115 /*-------------------------------------------------------------------------*/ 116 117 static inline int twl6030_writeb(struct twl6030_usb *twl, u8 module, 118 u8 data, u8 address) 119 { 120 int ret = 0; 121 122 ret = twl_i2c_write_u8(module, data, address); 123 if (ret < 0) 124 dev_err(twl->dev, 125 "Write[0x%x] Error %d\n", address, ret); 126 return ret; 127 } 128 129 static inline u8 twl6030_readb(struct twl6030_usb *twl, u8 module, u8 address) 130 { 131 u8 data; 132 int ret; 133 134 ret = twl_i2c_read_u8(module, &data, address); 135 if (ret >= 0) 136 ret = data; 137 else 138 dev_err(twl->dev, 139 "readb[0x%x,0x%x] Error %d\n", 140 module, address, ret); 141 return ret; 142 } 143 144 static int twl6030_start_srp(struct phy_companion *comparator) 145 { 146 struct twl6030_usb *twl = comparator_to_twl(comparator); 147 148 twl6030_writeb(twl, TWL_MODULE_USB, 0x24, USB_VBUS_CTRL_SET); 149 twl6030_writeb(twl, TWL_MODULE_USB, 0x84, USB_VBUS_CTRL_SET); 150 151 mdelay(100); 152 twl6030_writeb(twl, TWL_MODULE_USB, 0xa0, USB_VBUS_CTRL_CLR); 153 154 return 0; 155 } 156 157 static int twl6030_usb_ldo_init(struct twl6030_usb *twl) 158 { 159 /* Set to OTG_REV 1.3 and turn on the ID_WAKEUP_COMP */ 160 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x1, TWL6030_BACKUP_REG); 161 162 /* Program CFG_LDO_PD2 register and set VUSB bit */ 163 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x1, TWL6030_CFG_LDO_PD2); 164 165 /* Program MISC2 register and set bit VUSB_IN_VBAT */ 166 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x10, TWL6030_MISC2); 167 168 twl->usb3v3 = regulator_get(twl->dev, "usb"); 169 if (IS_ERR(twl->usb3v3)) 170 return -ENODEV; 171 172 /* Program the USB_VBUS_CTRL_SET and set VBUS_ACT_COMP bit */ 173 twl6030_writeb(twl, TWL_MODULE_USB, 0x4, USB_VBUS_CTRL_SET); 174 175 /* 176 * Program the USB_ID_CTRL_SET register to enable GND drive 177 * and the ID comparators 178 */ 179 twl6030_writeb(twl, TWL_MODULE_USB, 0x14, USB_ID_CTRL_SET); 180 181 return 0; 182 } 183 184 static ssize_t twl6030_usb_vbus_show(struct device *dev, 185 struct device_attribute *attr, char *buf) 186 { 187 struct twl6030_usb *twl = dev_get_drvdata(dev); 188 unsigned long flags; 189 int ret = -EINVAL; 190 191 spin_lock_irqsave(&twl->lock, flags); 192 193 switch (twl->linkstat) { 194 case MUSB_VBUS_VALID: 195 ret = snprintf(buf, PAGE_SIZE, "vbus\n"); 196 break; 197 case MUSB_ID_GROUND: 198 ret = snprintf(buf, PAGE_SIZE, "id\n"); 199 break; 200 case MUSB_VBUS_OFF: 201 ret = snprintf(buf, PAGE_SIZE, "none\n"); 202 break; 203 default: 204 ret = snprintf(buf, PAGE_SIZE, "UNKNOWN\n"); 205 } 206 spin_unlock_irqrestore(&twl->lock, flags); 207 208 return ret; 209 } 210 static DEVICE_ATTR(vbus, 0444, twl6030_usb_vbus_show, NULL); 211 212 static irqreturn_t twl6030_usb_irq(int irq, void *_twl) 213 { 214 struct twl6030_usb *twl = _twl; 215 enum musb_vbus_id_status status = MUSB_UNKNOWN; 216 u8 vbus_state, hw_state; 217 int ret; 218 219 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS); 220 221 vbus_state = twl6030_readb(twl, TWL_MODULE_MAIN_CHARGE, 222 CONTROLLER_STAT1); 223 if (!(hw_state & STS_USB_ID)) { 224 if (vbus_state & VBUS_DET) { 225 ret = regulator_enable(twl->usb3v3); 226 if (ret) 227 dev_err(twl->dev, "Failed to enable usb3v3\n"); 228 229 twl->asleep = 1; 230 status = MUSB_VBUS_VALID; 231 twl->linkstat = status; 232 ret = musb_mailbox(status); 233 if (ret) 234 twl->linkstat = MUSB_UNKNOWN; 235 } else { 236 if (twl->linkstat != MUSB_UNKNOWN) { 237 status = MUSB_VBUS_OFF; 238 twl->linkstat = status; 239 ret = musb_mailbox(status); 240 if (ret) 241 twl->linkstat = MUSB_UNKNOWN; 242 if (twl->asleep) { 243 regulator_disable(twl->usb3v3); 244 twl->asleep = 0; 245 } 246 } 247 } 248 } 249 sysfs_notify(&twl->dev->kobj, NULL, "vbus"); 250 251 return IRQ_HANDLED; 252 } 253 254 static irqreturn_t twl6030_usbotg_irq(int irq, void *_twl) 255 { 256 struct twl6030_usb *twl = _twl; 257 enum musb_vbus_id_status status = MUSB_UNKNOWN; 258 u8 hw_state; 259 int ret; 260 261 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS); 262 263 if (hw_state & STS_USB_ID) { 264 ret = regulator_enable(twl->usb3v3); 265 if (ret) 266 dev_err(twl->dev, "Failed to enable usb3v3\n"); 267 268 twl->asleep = 1; 269 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_CLR); 270 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_SET); 271 status = MUSB_ID_GROUND; 272 twl->linkstat = status; 273 ret = musb_mailbox(status); 274 if (ret) 275 twl->linkstat = MUSB_UNKNOWN; 276 } else { 277 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_CLR); 278 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET); 279 } 280 twl6030_writeb(twl, TWL_MODULE_USB, status, USB_ID_INT_LATCH_CLR); 281 282 return IRQ_HANDLED; 283 } 284 285 static void twl6030_status_work(struct work_struct *work) 286 { 287 struct twl6030_usb *twl = container_of(work, struct twl6030_usb, 288 get_status_work.work); 289 290 twl6030_usb_irq(twl->irq2, twl); 291 twl6030_usbotg_irq(twl->irq1, twl); 292 } 293 294 static int twl6030_enable_irq(struct twl6030_usb *twl) 295 { 296 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET); 297 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C); 298 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C); 299 300 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK, 301 REG_INT_MSK_LINE_C); 302 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK, 303 REG_INT_MSK_STS_C); 304 305 return 0; 306 } 307 308 static void otg_set_vbus_work(struct work_struct *data) 309 { 310 struct twl6030_usb *twl = container_of(data, struct twl6030_usb, 311 set_vbus_work); 312 313 /* 314 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1 315 * register. This enables boost mode. 316 */ 317 318 if (twl->vbus_enable) 319 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE, 0x40, 320 CHARGERUSB_CTRL1); 321 else 322 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE, 0x00, 323 CHARGERUSB_CTRL1); 324 } 325 326 static int twl6030_set_vbus(struct phy_companion *comparator, bool enabled) 327 { 328 struct twl6030_usb *twl = comparator_to_twl(comparator); 329 330 twl->vbus_enable = enabled; 331 schedule_work(&twl->set_vbus_work); 332 333 return 0; 334 } 335 336 static int twl6030_usb_probe(struct platform_device *pdev) 337 { 338 u32 ret; 339 struct twl6030_usb *twl; 340 int status, err; 341 struct device_node *np = pdev->dev.of_node; 342 struct device *dev = &pdev->dev; 343 344 if (!np) { 345 dev_err(dev, "no DT info\n"); 346 return -EINVAL; 347 } 348 349 twl = devm_kzalloc(dev, sizeof(*twl), GFP_KERNEL); 350 if (!twl) 351 return -ENOMEM; 352 353 twl->dev = &pdev->dev; 354 twl->irq1 = platform_get_irq(pdev, 0); 355 twl->irq2 = platform_get_irq(pdev, 1); 356 twl->linkstat = MUSB_UNKNOWN; 357 358 twl->comparator.set_vbus = twl6030_set_vbus; 359 twl->comparator.start_srp = twl6030_start_srp; 360 361 ret = omap_usb2_set_comparator(&twl->comparator); 362 if (ret == -ENODEV) { 363 dev_info(&pdev->dev, "phy not ready, deferring probe"); 364 return -EPROBE_DEFER; 365 } 366 367 /* init spinlock for workqueue */ 368 spin_lock_init(&twl->lock); 369 370 err = twl6030_usb_ldo_init(twl); 371 if (err) { 372 dev_err(&pdev->dev, "ldo init failed\n"); 373 return err; 374 } 375 376 platform_set_drvdata(pdev, twl); 377 if (device_create_file(&pdev->dev, &dev_attr_vbus)) 378 dev_warn(&pdev->dev, "could not create sysfs file\n"); 379 380 INIT_WORK(&twl->set_vbus_work, otg_set_vbus_work); 381 INIT_DELAYED_WORK(&twl->get_status_work, twl6030_status_work); 382 383 status = request_threaded_irq(twl->irq1, NULL, twl6030_usbotg_irq, 384 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT, 385 "twl6030_usb", twl); 386 if (status < 0) { 387 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n", 388 twl->irq1, status); 389 device_remove_file(twl->dev, &dev_attr_vbus); 390 return status; 391 } 392 393 status = request_threaded_irq(twl->irq2, NULL, twl6030_usb_irq, 394 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT, 395 "twl6030_usb", twl); 396 if (status < 0) { 397 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n", 398 twl->irq2, status); 399 free_irq(twl->irq1, twl); 400 device_remove_file(twl->dev, &dev_attr_vbus); 401 return status; 402 } 403 404 twl->asleep = 0; 405 twl6030_enable_irq(twl); 406 schedule_delayed_work(&twl->get_status_work, HZ); 407 dev_info(&pdev->dev, "Initialized TWL6030 USB module\n"); 408 409 return 0; 410 } 411 412 static int twl6030_usb_remove(struct platform_device *pdev) 413 { 414 struct twl6030_usb *twl = platform_get_drvdata(pdev); 415 416 cancel_delayed_work(&twl->get_status_work); 417 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK, 418 REG_INT_MSK_LINE_C); 419 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK, 420 REG_INT_MSK_STS_C); 421 free_irq(twl->irq1, twl); 422 free_irq(twl->irq2, twl); 423 regulator_put(twl->usb3v3); 424 device_remove_file(twl->dev, &dev_attr_vbus); 425 cancel_work_sync(&twl->set_vbus_work); 426 427 return 0; 428 } 429 430 static const struct of_device_id twl6030_usb_id_table[] = { 431 { .compatible = "ti,twl6030-usb" }, 432 {} 433 }; 434 MODULE_DEVICE_TABLE(of, twl6030_usb_id_table); 435 436 static struct platform_driver twl6030_usb_driver = { 437 .probe = twl6030_usb_probe, 438 .remove = twl6030_usb_remove, 439 .driver = { 440 .name = "twl6030_usb", 441 .of_match_table = of_match_ptr(twl6030_usb_id_table), 442 }, 443 }; 444 445 static int __init twl6030_usb_init(void) 446 { 447 return platform_driver_register(&twl6030_usb_driver); 448 } 449 subsys_initcall(twl6030_usb_init); 450 451 static void __exit twl6030_usb_exit(void) 452 { 453 platform_driver_unregister(&twl6030_usb_driver); 454 } 455 module_exit(twl6030_usb_exit); 456 457 MODULE_ALIAS("platform:twl6030_usb"); 458 MODULE_AUTHOR("Hema HK <hemahk@ti.com>"); 459 MODULE_DESCRIPTION("TWL6030 USB transceiver driver"); 460 MODULE_LICENSE("GPL"); 461