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/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 #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 const char *regulator; 112 }; 113 114 #define comparator_to_twl(x) container_of((x), struct twl6030_usb, comparator) 115 116 /*-------------------------------------------------------------------------*/ 117 118 static inline int twl6030_writeb(struct twl6030_usb *twl, u8 module, 119 u8 data, u8 address) 120 { 121 int ret = 0; 122 123 ret = twl_i2c_write_u8(module, data, address); 124 if (ret < 0) 125 dev_err(twl->dev, 126 "Write[0x%x] Error %d\n", address, ret); 127 return ret; 128 } 129 130 static inline u8 twl6030_readb(struct twl6030_usb *twl, u8 module, u8 address) 131 { 132 u8 data; 133 int ret; 134 135 ret = twl_i2c_read_u8(module, &data, address); 136 if (ret >= 0) 137 ret = data; 138 else 139 dev_err(twl->dev, 140 "readb[0x%x,0x%x] Error %d\n", 141 module, address, ret); 142 return ret; 143 } 144 145 static int twl6030_start_srp(struct phy_companion *comparator) 146 { 147 struct twl6030_usb *twl = comparator_to_twl(comparator); 148 149 twl6030_writeb(twl, TWL_MODULE_USB, 0x24, USB_VBUS_CTRL_SET); 150 twl6030_writeb(twl, TWL_MODULE_USB, 0x84, USB_VBUS_CTRL_SET); 151 152 mdelay(100); 153 twl6030_writeb(twl, TWL_MODULE_USB, 0xa0, USB_VBUS_CTRL_CLR); 154 155 return 0; 156 } 157 158 static int twl6030_usb_ldo_init(struct twl6030_usb *twl) 159 { 160 /* Set to OTG_REV 1.3 and turn on the ID_WAKEUP_COMP */ 161 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x1, TWL6030_BACKUP_REG); 162 163 /* Program CFG_LDO_PD2 register and set VUSB bit */ 164 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x1, TWL6030_CFG_LDO_PD2); 165 166 /* Program MISC2 register and set bit VUSB_IN_VBAT */ 167 twl6030_writeb(twl, TWL6030_MODULE_ID0, 0x10, TWL6030_MISC2); 168 169 twl->usb3v3 = regulator_get(twl->dev, twl->regulator); 170 if (IS_ERR(twl->usb3v3)) 171 return -ENODEV; 172 173 /* Program the USB_VBUS_CTRL_SET and set VBUS_ACT_COMP bit */ 174 twl6030_writeb(twl, TWL_MODULE_USB, 0x4, USB_VBUS_CTRL_SET); 175 176 /* 177 * Program the USB_ID_CTRL_SET register to enable GND drive 178 * and the ID comparators 179 */ 180 twl6030_writeb(twl, TWL_MODULE_USB, 0x14, USB_ID_CTRL_SET); 181 182 return 0; 183 } 184 185 static ssize_t twl6030_usb_vbus_show(struct device *dev, 186 struct device_attribute *attr, char *buf) 187 { 188 struct twl6030_usb *twl = dev_get_drvdata(dev); 189 unsigned long flags; 190 int ret = -EINVAL; 191 192 spin_lock_irqsave(&twl->lock, flags); 193 194 switch (twl->linkstat) { 195 case MUSB_VBUS_VALID: 196 ret = snprintf(buf, PAGE_SIZE, "vbus\n"); 197 break; 198 case MUSB_ID_GROUND: 199 ret = snprintf(buf, PAGE_SIZE, "id\n"); 200 break; 201 case MUSB_VBUS_OFF: 202 ret = snprintf(buf, PAGE_SIZE, "none\n"); 203 break; 204 default: 205 ret = snprintf(buf, PAGE_SIZE, "UNKNOWN\n"); 206 } 207 spin_unlock_irqrestore(&twl->lock, flags); 208 209 return ret; 210 } 211 static DEVICE_ATTR(vbus, 0444, twl6030_usb_vbus_show, NULL); 212 213 static irqreturn_t twl6030_usb_irq(int irq, void *_twl) 214 { 215 struct twl6030_usb *twl = _twl; 216 enum musb_vbus_id_status status = MUSB_UNKNOWN; 217 u8 vbus_state, hw_state; 218 int ret; 219 220 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS); 221 222 vbus_state = twl6030_readb(twl, TWL_MODULE_MAIN_CHARGE, 223 CONTROLLER_STAT1); 224 if (!(hw_state & STS_USB_ID)) { 225 if (vbus_state & VBUS_DET) { 226 ret = regulator_enable(twl->usb3v3); 227 if (ret) 228 dev_err(twl->dev, "Failed to enable usb3v3\n"); 229 230 twl->asleep = 1; 231 status = MUSB_VBUS_VALID; 232 twl->linkstat = status; 233 ret = musb_mailbox(status); 234 if (ret) 235 twl->linkstat = MUSB_UNKNOWN; 236 } else { 237 if (twl->linkstat != MUSB_UNKNOWN) { 238 status = MUSB_VBUS_OFF; 239 twl->linkstat = status; 240 ret = musb_mailbox(status); 241 if (ret) 242 twl->linkstat = MUSB_UNKNOWN; 243 if (twl->asleep) { 244 regulator_disable(twl->usb3v3); 245 twl->asleep = 0; 246 } 247 } 248 } 249 } 250 sysfs_notify(&twl->dev->kobj, NULL, "vbus"); 251 252 return IRQ_HANDLED; 253 } 254 255 static irqreturn_t twl6030_usbotg_irq(int irq, void *_twl) 256 { 257 struct twl6030_usb *twl = _twl; 258 enum musb_vbus_id_status status = MUSB_UNKNOWN; 259 u8 hw_state; 260 int ret; 261 262 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS); 263 264 if (hw_state & STS_USB_ID) { 265 ret = regulator_enable(twl->usb3v3); 266 if (ret) 267 dev_err(twl->dev, "Failed to enable usb3v3\n"); 268 269 twl->asleep = 1; 270 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_CLR); 271 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_SET); 272 status = MUSB_ID_GROUND; 273 twl->linkstat = status; 274 ret = musb_mailbox(status); 275 if (ret) 276 twl->linkstat = MUSB_UNKNOWN; 277 } else { 278 twl6030_writeb(twl, TWL_MODULE_USB, 0x10, USB_ID_INT_EN_HI_CLR); 279 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET); 280 } 281 twl6030_writeb(twl, TWL_MODULE_USB, status, USB_ID_INT_LATCH_CLR); 282 283 return IRQ_HANDLED; 284 } 285 286 static void twl6030_status_work(struct work_struct *work) 287 { 288 struct twl6030_usb *twl = container_of(work, struct twl6030_usb, 289 get_status_work.work); 290 291 twl6030_usb_irq(twl->irq2, twl); 292 twl6030_usbotg_irq(twl->irq1, twl); 293 } 294 295 static int twl6030_enable_irq(struct twl6030_usb *twl) 296 { 297 twl6030_writeb(twl, TWL_MODULE_USB, 0x1, USB_ID_INT_EN_HI_SET); 298 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C); 299 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C); 300 301 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK, 302 REG_INT_MSK_LINE_C); 303 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK, 304 REG_INT_MSK_STS_C); 305 306 return 0; 307 } 308 309 static void otg_set_vbus_work(struct work_struct *data) 310 { 311 struct twl6030_usb *twl = container_of(data, struct twl6030_usb, 312 set_vbus_work); 313 314 /* 315 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1 316 * register. This enables boost mode. 317 */ 318 319 if (twl->vbus_enable) 320 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE, 0x40, 321 CHARGERUSB_CTRL1); 322 else 323 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE, 0x00, 324 CHARGERUSB_CTRL1); 325 } 326 327 static int twl6030_set_vbus(struct phy_companion *comparator, bool enabled) 328 { 329 struct twl6030_usb *twl = comparator_to_twl(comparator); 330 331 twl->vbus_enable = enabled; 332 schedule_work(&twl->set_vbus_work); 333 334 return 0; 335 } 336 337 static int twl6030_usb_probe(struct platform_device *pdev) 338 { 339 u32 ret; 340 struct twl6030_usb *twl; 341 int status, err; 342 struct device_node *np = pdev->dev.of_node; 343 struct device *dev = &pdev->dev; 344 struct twl4030_usb_data *pdata = dev_get_platdata(dev); 345 346 twl = devm_kzalloc(dev, sizeof(*twl), GFP_KERNEL); 347 if (!twl) 348 return -ENOMEM; 349 350 twl->dev = &pdev->dev; 351 twl->irq1 = platform_get_irq(pdev, 0); 352 twl->irq2 = platform_get_irq(pdev, 1); 353 twl->linkstat = MUSB_UNKNOWN; 354 355 twl->comparator.set_vbus = twl6030_set_vbus; 356 twl->comparator.start_srp = twl6030_start_srp; 357 358 ret = omap_usb2_set_comparator(&twl->comparator); 359 if (ret == -ENODEV) { 360 dev_info(&pdev->dev, "phy not ready, deferring probe"); 361 return -EPROBE_DEFER; 362 } 363 364 if (np) { 365 twl->regulator = "usb"; 366 } else if (pdata) { 367 if (pdata->features & TWL6032_SUBCLASS) 368 twl->regulator = "ldousb"; 369 else 370 twl->regulator = "vusb"; 371 } else { 372 dev_err(&pdev->dev, "twl6030 initialized without pdata\n"); 373 return -EINVAL; 374 } 375 376 /* init spinlock for workqueue */ 377 spin_lock_init(&twl->lock); 378 379 err = twl6030_usb_ldo_init(twl); 380 if (err) { 381 dev_err(&pdev->dev, "ldo init failed\n"); 382 return err; 383 } 384 385 platform_set_drvdata(pdev, twl); 386 if (device_create_file(&pdev->dev, &dev_attr_vbus)) 387 dev_warn(&pdev->dev, "could not create sysfs file\n"); 388 389 INIT_WORK(&twl->set_vbus_work, otg_set_vbus_work); 390 INIT_DELAYED_WORK(&twl->get_status_work, twl6030_status_work); 391 392 status = request_threaded_irq(twl->irq1, NULL, twl6030_usbotg_irq, 393 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT, 394 "twl6030_usb", twl); 395 if (status < 0) { 396 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n", 397 twl->irq1, status); 398 device_remove_file(twl->dev, &dev_attr_vbus); 399 return status; 400 } 401 402 status = request_threaded_irq(twl->irq2, NULL, twl6030_usb_irq, 403 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING | IRQF_ONESHOT, 404 "twl6030_usb", twl); 405 if (status < 0) { 406 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n", 407 twl->irq2, status); 408 free_irq(twl->irq1, twl); 409 device_remove_file(twl->dev, &dev_attr_vbus); 410 return status; 411 } 412 413 twl->asleep = 0; 414 twl6030_enable_irq(twl); 415 schedule_delayed_work(&twl->get_status_work, HZ); 416 dev_info(&pdev->dev, "Initialized TWL6030 USB module\n"); 417 418 return 0; 419 } 420 421 static int twl6030_usb_remove(struct platform_device *pdev) 422 { 423 struct twl6030_usb *twl = platform_get_drvdata(pdev); 424 425 cancel_delayed_work(&twl->get_status_work); 426 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK, 427 REG_INT_MSK_LINE_C); 428 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK, 429 REG_INT_MSK_STS_C); 430 free_irq(twl->irq1, twl); 431 free_irq(twl->irq2, twl); 432 regulator_put(twl->usb3v3); 433 device_remove_file(twl->dev, &dev_attr_vbus); 434 cancel_work_sync(&twl->set_vbus_work); 435 436 return 0; 437 } 438 439 #ifdef CONFIG_OF 440 static const struct of_device_id twl6030_usb_id_table[] = { 441 { .compatible = "ti,twl6030-usb" }, 442 {} 443 }; 444 MODULE_DEVICE_TABLE(of, twl6030_usb_id_table); 445 #endif 446 447 static struct platform_driver twl6030_usb_driver = { 448 .probe = twl6030_usb_probe, 449 .remove = twl6030_usb_remove, 450 .driver = { 451 .name = "twl6030_usb", 452 .of_match_table = of_match_ptr(twl6030_usb_id_table), 453 }, 454 }; 455 456 static int __init twl6030_usb_init(void) 457 { 458 return platform_driver_register(&twl6030_usb_driver); 459 } 460 subsys_initcall(twl6030_usb_init); 461 462 static void __exit twl6030_usb_exit(void) 463 { 464 platform_driver_unregister(&twl6030_usb_driver); 465 } 466 module_exit(twl6030_usb_exit); 467 468 MODULE_ALIAS("platform:twl6030_usb"); 469 MODULE_AUTHOR("Hema HK <hemahk@ti.com>"); 470 MODULE_DESCRIPTION("TWL6030 USB transceiver driver"); 471 MODULE_LICENSE("GPL"); 472