drivers/extcon/extcon-palmas.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Palmas USB transceiver driver
   4  *
   5  * Copyright (C) 2013 Texas Instruments Incorporated - https://www.ti.com
   6  * Author: Graeme Gregory <gg@slimlogic.co.uk>
   7  * Author: Kishon Vijay Abraham I <kishon@ti.com>
   8  * Based on twl6030_usb.c
   9  * Author: Hema HK <hemahk@ti.com>
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/platform_device.h>
  15 #include <linux/slab.h>
  16 #include <linux/err.h>
  17 #include <linux/mfd/palmas.h>
  18 #include <linux/of.h>
  19 #include <linux/of_platform.h>
  20 #include <linux/of_gpio.h>
  21 #include <linux/gpio/consumer.h>
  22 #include <linux/workqueue.h>
  23
  24 #define USB_GPIO_DEBOUNCE_MS    20      /* ms */
  25
  26 static const unsigned int palmas_extcon_cable[] = {
  27         EXTCON_USB,
  28         EXTCON_USB_HOST,
  29         EXTCON_NONE,
  30 };
  31
  32 static void palmas_usb_wakeup(struct palmas *palmas, int enable)
  33 {
  34         if (enable)
  35                 palmas_write(palmas, PALMAS_USB_OTG_BASE, PALMAS_USB_WAKEUP,
  36                         PALMAS_USB_WAKEUP_ID_WK_UP_COMP);
  37         else
  38                 palmas_write(palmas, PALMAS_USB_OTG_BASE, PALMAS_USB_WAKEUP, 0);
  39 }
  40
  41 static irqreturn_t palmas_vbus_irq_handler(int irq, void *_palmas_usb)
  42 {
  43         struct palmas_usb *palmas_usb = _palmas_usb;
  44         struct extcon_dev *edev = palmas_usb->edev;
  45         unsigned int vbus_line_state;
  46
  47         palmas_read(palmas_usb->palmas, PALMAS_INTERRUPT_BASE,
  48                 PALMAS_INT3_LINE_STATE, &vbus_line_state);
  49
  50         if (vbus_line_state & PALMAS_INT3_LINE_STATE_VBUS) {
  51                 if (palmas_usb->linkstat != PALMAS_USB_STATE_VBUS) {
  52                         palmas_usb->linkstat = PALMAS_USB_STATE_VBUS;
  53                         extcon_set_state_sync(edev, EXTCON_USB, true);
  54                         dev_dbg(palmas_usb->dev, "USB cable is attached\n");
  55                 } else {
  56                         dev_dbg(palmas_usb->dev,
  57                                 "Spurious connect event detected\n");
  58                 }
  59         } else if (!(vbus_line_state & PALMAS_INT3_LINE_STATE_VBUS)) {
  60                 if (palmas_usb->linkstat == PALMAS_USB_STATE_VBUS) {
  61                         palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
  62                         extcon_set_state_sync(edev, EXTCON_USB, false);
  63                         dev_dbg(palmas_usb->dev, "USB cable is detached\n");
  64                 } else {
  65                         dev_dbg(palmas_usb->dev,
  66                                 "Spurious disconnect event detected\n");
  67                 }
  68         }
  69
  70         return IRQ_HANDLED;
  71 }
  72
  73 static irqreturn_t palmas_id_irq_handler(int irq, void *_palmas_usb)
  74 {
  75         unsigned int set, id_src;
  76         struct palmas_usb *palmas_usb = _palmas_usb;
  77         struct extcon_dev *edev = palmas_usb->edev;
  78
  79         palmas_read(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
  80                 PALMAS_USB_ID_INT_LATCH_SET, &set);
  81         palmas_read(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
  82                 PALMAS_USB_ID_INT_SRC, &id_src);
  83
  84         if ((set & PALMAS_USB_ID_INT_SRC_ID_GND) &&
  85                                 (id_src & PALMAS_USB_ID_INT_SRC_ID_GND)) {
  86                 palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
  87                         PALMAS_USB_ID_INT_LATCH_CLR,
  88                         PALMAS_USB_ID_INT_EN_HI_CLR_ID_GND);
  89                 palmas_usb->linkstat = PALMAS_USB_STATE_ID;
  90                 extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
  91                 dev_dbg(palmas_usb->dev, "USB-HOST cable is attached\n");
  92         } else if ((set & PALMAS_USB_ID_INT_SRC_ID_FLOAT) &&
  93                                 (id_src & PALMAS_USB_ID_INT_SRC_ID_FLOAT)) {
  94                 palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
  95                         PALMAS_USB_ID_INT_LATCH_CLR,
  96                         PALMAS_USB_ID_INT_EN_HI_CLR_ID_FLOAT);
  97                 palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
  98                 extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
  99                 dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
 100         } else if ((palmas_usb->linkstat == PALMAS_USB_STATE_ID) &&
 101                                 (!(set & PALMAS_USB_ID_INT_SRC_ID_GND))) {
 102                 palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
 103                 extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
 104                 dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
 105         } else if ((palmas_usb->linkstat == PALMAS_USB_STATE_DISCONNECT) &&
 106                                 (id_src & PALMAS_USB_ID_INT_SRC_ID_GND)) {
 107                 palmas_usb->linkstat = PALMAS_USB_STATE_ID;
 108                 extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
 109                 dev_dbg(palmas_usb->dev, " USB-HOST cable is attached\n");
 110         }
 111
 112         return IRQ_HANDLED;
 113 }
 114
 115 static void palmas_gpio_id_detect(struct work_struct *work)
 116 {
 117         int id;
 118         struct palmas_usb *palmas_usb = container_of(to_delayed_work(work),
 119                                                      struct palmas_usb,
 120                                                      wq_detectid);
 121         struct extcon_dev *edev = palmas_usb->edev;
 122
 123         if (!palmas_usb->id_gpiod)
 124                 return;
 125
 126         id = gpiod_get_value_cansleep(palmas_usb->id_gpiod);
 127
 128         if (id) {
 129                 extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
 130                 dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
 131         } else {
 132                 extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
 133                 dev_dbg(palmas_usb->dev, "USB-HOST cable is attached\n");
 134         }
 135 }
 136
 137 static irqreturn_t palmas_gpio_id_irq_handler(int irq, void *_palmas_usb)
 138 {
 139         struct palmas_usb *palmas_usb = _palmas_usb;
 140
 141         queue_delayed_work(system_power_efficient_wq, &palmas_usb->wq_detectid,
 142                            palmas_usb->sw_debounce_jiffies);
 143
 144         return IRQ_HANDLED;
 145 }
 146
 147 static void palmas_enable_irq(struct palmas_usb *palmas_usb)
 148 {
 149         palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
 150                 PALMAS_USB_VBUS_CTRL_SET,
 151                 PALMAS_USB_VBUS_CTRL_SET_VBUS_ACT_COMP);
 152
 153         if (palmas_usb->enable_id_detection) {
 154                 palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
 155                              PALMAS_USB_ID_CTRL_SET,
 156                              PALMAS_USB_ID_CTRL_SET_ID_ACT_COMP);
 157
 158                 palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
 159                              PALMAS_USB_ID_INT_EN_HI_SET,
 160                              PALMAS_USB_ID_INT_EN_HI_SET_ID_GND |
 161                              PALMAS_USB_ID_INT_EN_HI_SET_ID_FLOAT);
 162         }
 163
 164         if (palmas_usb->enable_vbus_detection)
 165                 palmas_vbus_irq_handler(palmas_usb->vbus_irq, palmas_usb);
 166
 167         /* cold plug for host mode needs this delay */
 168         if (palmas_usb->enable_id_detection) {
 169                 msleep(30);
 170                 palmas_id_irq_handler(palmas_usb->id_irq, palmas_usb);
 171         }
 172 }
 173
 174 static int palmas_usb_probe(struct platform_device *pdev)
 175 {
 176         struct palmas *palmas = dev_get_drvdata(pdev->dev.parent);
 177         struct palmas_usb_platform_data *pdata = dev_get_platdata(&pdev->dev);
 178         struct device_node *node = pdev->dev.of_node;
 179         struct palmas_usb *palmas_usb;
 180         int status;
 181
 182         if (!palmas) {
 183                 dev_err(&pdev->dev, "failed to get valid parent\n");
 184                 return -EINVAL;
 185         }
 186
 187         palmas_usb = devm_kzalloc(&pdev->dev, sizeof(*palmas_usb), GFP_KERNEL);
 188         if (!palmas_usb)
 189                 return -ENOMEM;
 190
 191         if (node && !pdata) {
 192                 palmas_usb->wakeup = of_property_read_bool(node, "ti,wakeup");
 193                 palmas_usb->enable_id_detection = of_property_read_bool(node,
 194                                                 "ti,enable-id-detection");
 195                 palmas_usb->enable_vbus_detection = of_property_read_bool(node,
 196                                                 "ti,enable-vbus-detection");
 197         } else {
 198                 palmas_usb->wakeup = true;
 199                 palmas_usb->enable_id_detection = true;
 200                 palmas_usb->enable_vbus_detection = true;
 201
 202                 if (pdata)
 203                         palmas_usb->wakeup = pdata->wakeup;
 204         }
 205
 206         palmas_usb->id_gpiod = devm_gpiod_get_optional(&pdev->dev, "id",
 207                                                         GPIOD_IN);
 208         if (IS_ERR(palmas_usb->id_gpiod))
 209                 return dev_err_probe(&pdev->dev, PTR_ERR(palmas_usb->id_gpiod),
 210                                      "failed to get id gpio\n");
 211
 212         palmas_usb->vbus_gpiod = devm_gpiod_get_optional(&pdev->dev, "vbus",
 213                                                         GPIOD_IN);
 214         if (IS_ERR(palmas_usb->vbus_gpiod))
 215                 return dev_err_probe(&pdev->dev, PTR_ERR(palmas_usb->vbus_gpiod),
 216                                      "failed to get id gpio\n");
 217
 218         if (palmas_usb->enable_id_detection && palmas_usb->id_gpiod) {
 219                 palmas_usb->enable_id_detection = false;
 220                 palmas_usb->enable_gpio_id_detection = true;
 221         }
 222
 223         if (palmas_usb->enable_vbus_detection && palmas_usb->vbus_gpiod) {
 224                 palmas_usb->enable_vbus_detection = false;
 225                 palmas_usb->enable_gpio_vbus_detection = true;
 226         }
 227
 228         if (palmas_usb->enable_gpio_id_detection) {
 229                 u32 debounce;
 230
 231                 if (of_property_read_u32(node, "debounce-delay-ms", &debounce))
 232                         debounce = USB_GPIO_DEBOUNCE_MS;
 233
 234                 status = gpiod_set_debounce(palmas_usb->id_gpiod,
 235                                             debounce * 1000);
 236                 if (status < 0)
 237                         palmas_usb->sw_debounce_jiffies = msecs_to_jiffies(debounce);
 238         }
 239
 240         INIT_DELAYED_WORK(&palmas_usb->wq_detectid, palmas_gpio_id_detect);
 241
 242         palmas->usb = palmas_usb;
 243         palmas_usb->palmas = palmas;
 244
 245         palmas_usb->dev  = &pdev->dev;
 246
 247         palmas_usb_wakeup(palmas, palmas_usb->wakeup);
 248
 249         platform_set_drvdata(pdev, palmas_usb);
 250
 251         palmas_usb->edev = devm_extcon_dev_allocate(&pdev->dev,
 252                                                     palmas_extcon_cable);
 253         if (IS_ERR(palmas_usb->edev)) {
 254                 dev_err(&pdev->dev, "failed to allocate extcon device\n");
 255                 return -ENOMEM;
 256         }
 257
 258         status = devm_extcon_dev_register(&pdev->dev, palmas_usb->edev);
 259         if (status) {
 260                 dev_err(&pdev->dev, "failed to register extcon device\n");
 261                 return status;
 262         }
 263
 264         if (palmas_usb->enable_id_detection) {
 265                 palmas_usb->id_otg_irq = regmap_irq_get_virq(palmas->irq_data,
 266                                                              PALMAS_ID_OTG_IRQ);
 267                 palmas_usb->id_irq = regmap_irq_get_virq(palmas->irq_data,
 268                                                          PALMAS_ID_IRQ);
 269                 status = devm_request_threaded_irq(palmas_usb->dev,
 270                                 palmas_usb->id_irq,
 271                                 NULL, palmas_id_irq_handler,
 272                                 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING |
 273                                 IRQF_ONESHOT,
 274                                 "palmas_usb_id", palmas_usb);
 275                 if (status < 0) {
 276                         dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
 277                                         palmas_usb->id_irq, status);
 278                         return status;
 279                 }
 280         } else if (palmas_usb->enable_gpio_id_detection) {
 281                 palmas_usb->gpio_id_irq = gpiod_to_irq(palmas_usb->id_gpiod);
 282                 if (palmas_usb->gpio_id_irq < 0) {
 283                         dev_err(&pdev->dev, "failed to get id irq\n");
 284                         return palmas_usb->gpio_id_irq;
 285                 }
 286                 status = devm_request_threaded_irq(&pdev->dev,
 287                                                    palmas_usb->gpio_id_irq,
 288                                                    NULL,
 289                                                    palmas_gpio_id_irq_handler,
 290                                                    IRQF_TRIGGER_RISING |
 291                                                    IRQF_TRIGGER_FALLING |
 292                                                    IRQF_ONESHOT,
 293                                                    "palmas_usb_id",
 294                                                    palmas_usb);
 295                 if (status < 0) {
 296                         dev_err(&pdev->dev,
 297                                 "failed to request handler for id irq\n");
 298                         return status;
 299                 }
 300         }
 301
 302         if (palmas_usb->enable_vbus_detection) {
 303                 palmas_usb->vbus_otg_irq = regmap_irq_get_virq(palmas->irq_data,
 304                                                        PALMAS_VBUS_OTG_IRQ);
 305                 palmas_usb->vbus_irq = regmap_irq_get_virq(palmas->irq_data,
 306                                                            PALMAS_VBUS_IRQ);
 307                 status = devm_request_threaded_irq(palmas_usb->dev,
 308                                 palmas_usb->vbus_irq, NULL,
 309                                 palmas_vbus_irq_handler,
 310                                 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING |
 311                                 IRQF_ONESHOT,
 312                                 "palmas_usb_vbus", palmas_usb);
 313                 if (status < 0) {
 314                         dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
 315                                         palmas_usb->vbus_irq, status);
 316                         return status;
 317                 }
 318         } else if (palmas_usb->enable_gpio_vbus_detection) {
 319                 /* remux GPIO_1 as VBUSDET */
 320                 status = palmas_update_bits(palmas,
 321                         PALMAS_PU_PD_OD_BASE,
 322                         PALMAS_PRIMARY_SECONDARY_PAD1,
 323                         PALMAS_PRIMARY_SECONDARY_PAD1_GPIO_1_MASK,
 324                         (1 << PALMAS_PRIMARY_SECONDARY_PAD1_GPIO_1_SHIFT));
 325                 if (status < 0) {
 326                         dev_err(&pdev->dev, "can't remux GPIO1\n");
 327                         return status;
 328                 }
 329
 330                 palmas_usb->vbus_otg_irq = regmap_irq_get_virq(palmas->irq_data,
 331                                                        PALMAS_VBUS_OTG_IRQ);
 332                 palmas_usb->gpio_vbus_irq = gpiod_to_irq(palmas_usb->vbus_gpiod);
 333                 if (palmas_usb->gpio_vbus_irq < 0) {
 334                         dev_err(&pdev->dev, "failed to get vbus irq\n");
 335                         return palmas_usb->gpio_vbus_irq;
 336                 }
 337                 status = devm_request_threaded_irq(&pdev->dev,
 338                                                 palmas_usb->gpio_vbus_irq,
 339                                                 NULL,
 340                                                 palmas_vbus_irq_handler,
 341                                                 IRQF_TRIGGER_FALLING |
 342                                                 IRQF_TRIGGER_RISING |
 343                                                 IRQF_ONESHOT,
 344                                                 "palmas_usb_vbus",
 345                                                 palmas_usb);
 346                 if (status < 0) {
 347                         dev_err(&pdev->dev,
 348                                 "failed to request handler for vbus irq\n");
 349                         return status;
 350                 }
 351         }
 352
 353         palmas_enable_irq(palmas_usb);
 354         /* perform initial detection */
 355         if (palmas_usb->enable_gpio_vbus_detection)
 356                 palmas_vbus_irq_handler(palmas_usb->gpio_vbus_irq, palmas_usb);
 357         palmas_gpio_id_detect(&palmas_usb->wq_detectid.work);
 358         device_set_wakeup_capable(&pdev->dev, true);
 359         return 0;
 360 }
 361
 362 static int palmas_usb_remove(struct platform_device *pdev)
 363 {
 364         struct palmas_usb *palmas_usb = platform_get_drvdata(pdev);
 365
 366         cancel_delayed_work_sync(&palmas_usb->wq_detectid);
 367
 368         return 0;
 369 }
 370
 371 #ifdef CONFIG_PM_SLEEP
 372 static int palmas_usb_suspend(struct device *dev)
 373 {
 374         struct palmas_usb *palmas_usb = dev_get_drvdata(dev);
 375
 376         if (device_may_wakeup(dev)) {
 377                 if (palmas_usb->enable_vbus_detection)
 378                         enable_irq_wake(palmas_usb->vbus_irq);
 379                 if (palmas_usb->enable_gpio_vbus_detection)
 380                         enable_irq_wake(palmas_usb->gpio_vbus_irq);
 381                 if (palmas_usb->enable_id_detection)
 382                         enable_irq_wake(palmas_usb->id_irq);
 383                 if (palmas_usb->enable_gpio_id_detection)
 384                         enable_irq_wake(palmas_usb->gpio_id_irq);
 385         }
 386         return 0;
 387 }
 388
 389 static int palmas_usb_resume(struct device *dev)
 390 {
 391         struct palmas_usb *palmas_usb = dev_get_drvdata(dev);
 392
 393         if (device_may_wakeup(dev)) {
 394                 if (palmas_usb->enable_vbus_detection)
 395                         disable_irq_wake(palmas_usb->vbus_irq);
 396                 if (palmas_usb->enable_gpio_vbus_detection)
 397                         disable_irq_wake(palmas_usb->gpio_vbus_irq);
 398                 if (palmas_usb->enable_id_detection)
 399                         disable_irq_wake(palmas_usb->id_irq);
 400                 if (palmas_usb->enable_gpio_id_detection)
 401                         disable_irq_wake(palmas_usb->gpio_id_irq);
 402         }
 403
 404         /* check if GPIO states changed while suspend/resume */
 405         if (palmas_usb->enable_gpio_vbus_detection)
 406                 palmas_vbus_irq_handler(palmas_usb->gpio_vbus_irq, palmas_usb);
 407         palmas_gpio_id_detect(&palmas_usb->wq_detectid.work);
 408
 409         return 0;
 410 };
 411 #endif
 412
 413 static SIMPLE_DEV_PM_OPS(palmas_pm_ops, palmas_usb_suspend, palmas_usb_resume);
 414
 415 static const struct of_device_id of_palmas_match_tbl[] = {
 416         { .compatible = "ti,palmas-usb", },
 417         { .compatible = "ti,palmas-usb-vid", },
 418         { .compatible = "ti,twl6035-usb", },
 419         { .compatible = "ti,twl6035-usb-vid", },
 420         { /* end */ }
 421 };
 422
 423 static struct platform_driver palmas_usb_driver = {
 424         .probe = palmas_usb_probe,
 425         .remove = palmas_usb_remove,
 426         .driver = {
 427                 .name = "palmas-usb",
 428                 .of_match_table = of_palmas_match_tbl,
 429                 .pm = &palmas_pm_ops,
 430         },
 431 };
 432
 433 module_platform_driver(palmas_usb_driver);
 434
 435 MODULE_ALIAS("platform:palmas-usb");
 436 MODULE_AUTHOR("Graeme Gregory <gg@slimlogic.co.uk>");
 437 MODULE_DESCRIPTION("Palmas USB transceiver driver");
 438 MODULE_LICENSE("GPL");
 439 MODULE_DEVICE_TABLE(of, of_palmas_match_tbl);