Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * Palmas USB transceiver driver
0004  *
0005  * Copyright (C) 2013 Texas Instruments Incorporated - https://www.ti.com
0006  * Author: Graeme Gregory <gg@slimlogic.co.uk>
0007  * Author: Kishon Vijay Abraham I <kishon@ti.com>
0008  * Based on twl6030_usb.c
0009  * Author: Hema HK <hemahk@ti.com>
0010  */
0011 
0012 #include <linux/devm-helpers.h>
0013 #include <linux/module.h>
0014 #include <linux/interrupt.h>
0015 #include <linux/platform_device.h>
0016 #include <linux/slab.h>
0017 #include <linux/err.h>
0018 #include <linux/mfd/palmas.h>
0019 #include <linux/of.h>
0020 #include <linux/of_platform.h>
0021 #include <linux/of_gpio.h>
0022 #include <linux/gpio/consumer.h>
0023 #include <linux/workqueue.h>
0024 
0025 #define USB_GPIO_DEBOUNCE_MS    20  /* ms */
0026 
0027 static const unsigned int palmas_extcon_cable[] = {
0028     EXTCON_USB,
0029     EXTCON_USB_HOST,
0030     EXTCON_NONE,
0031 };
0032 
0033 static void palmas_usb_wakeup(struct palmas *palmas, int enable)
0034 {
0035     if (enable)
0036         palmas_write(palmas, PALMAS_USB_OTG_BASE, PALMAS_USB_WAKEUP,
0037             PALMAS_USB_WAKEUP_ID_WK_UP_COMP);
0038     else
0039         palmas_write(palmas, PALMAS_USB_OTG_BASE, PALMAS_USB_WAKEUP, 0);
0040 }
0041 
0042 static irqreturn_t palmas_vbus_irq_handler(int irq, void *_palmas_usb)
0043 {
0044     struct palmas_usb *palmas_usb = _palmas_usb;
0045     struct extcon_dev *edev = palmas_usb->edev;
0046     unsigned int vbus_line_state;
0047 
0048     palmas_read(palmas_usb->palmas, PALMAS_INTERRUPT_BASE,
0049         PALMAS_INT3_LINE_STATE, &vbus_line_state);
0050 
0051     if (vbus_line_state & PALMAS_INT3_LINE_STATE_VBUS) {
0052         if (palmas_usb->linkstat != PALMAS_USB_STATE_VBUS) {
0053             palmas_usb->linkstat = PALMAS_USB_STATE_VBUS;
0054             extcon_set_state_sync(edev, EXTCON_USB, true);
0055             dev_dbg(palmas_usb->dev, "USB cable is attached\n");
0056         } else {
0057             dev_dbg(palmas_usb->dev,
0058                 "Spurious connect event detected\n");
0059         }
0060     } else if (!(vbus_line_state & PALMAS_INT3_LINE_STATE_VBUS)) {
0061         if (palmas_usb->linkstat == PALMAS_USB_STATE_VBUS) {
0062             palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
0063             extcon_set_state_sync(edev, EXTCON_USB, false);
0064             dev_dbg(palmas_usb->dev, "USB cable is detached\n");
0065         } else {
0066             dev_dbg(palmas_usb->dev,
0067                 "Spurious disconnect event detected\n");
0068         }
0069     }
0070 
0071     return IRQ_HANDLED;
0072 }
0073 
0074 static irqreturn_t palmas_id_irq_handler(int irq, void *_palmas_usb)
0075 {
0076     unsigned int set, id_src;
0077     struct palmas_usb *palmas_usb = _palmas_usb;
0078     struct extcon_dev *edev = palmas_usb->edev;
0079 
0080     palmas_read(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0081         PALMAS_USB_ID_INT_LATCH_SET, &set);
0082     palmas_read(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0083         PALMAS_USB_ID_INT_SRC, &id_src);
0084 
0085     if ((set & PALMAS_USB_ID_INT_SRC_ID_GND) &&
0086                 (id_src & PALMAS_USB_ID_INT_SRC_ID_GND)) {
0087         palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0088             PALMAS_USB_ID_INT_LATCH_CLR,
0089             PALMAS_USB_ID_INT_EN_HI_CLR_ID_GND);
0090         palmas_usb->linkstat = PALMAS_USB_STATE_ID;
0091         extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
0092         dev_dbg(palmas_usb->dev, "USB-HOST cable is attached\n");
0093     } else if ((set & PALMAS_USB_ID_INT_SRC_ID_FLOAT) &&
0094                 (id_src & PALMAS_USB_ID_INT_SRC_ID_FLOAT)) {
0095         palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0096             PALMAS_USB_ID_INT_LATCH_CLR,
0097             PALMAS_USB_ID_INT_EN_HI_CLR_ID_FLOAT);
0098         palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
0099         extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
0100         dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
0101     } else if ((palmas_usb->linkstat == PALMAS_USB_STATE_ID) &&
0102                 (!(set & PALMAS_USB_ID_INT_SRC_ID_GND))) {
0103         palmas_usb->linkstat = PALMAS_USB_STATE_DISCONNECT;
0104         extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
0105         dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
0106     } else if ((palmas_usb->linkstat == PALMAS_USB_STATE_DISCONNECT) &&
0107                 (id_src & PALMAS_USB_ID_INT_SRC_ID_GND)) {
0108         palmas_usb->linkstat = PALMAS_USB_STATE_ID;
0109         extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
0110         dev_dbg(palmas_usb->dev, "USB-HOST cable is attached\n");
0111     }
0112 
0113     return IRQ_HANDLED;
0114 }
0115 
0116 static void palmas_gpio_id_detect(struct work_struct *work)
0117 {
0118     int id;
0119     struct palmas_usb *palmas_usb = container_of(to_delayed_work(work),
0120                              struct palmas_usb,
0121                              wq_detectid);
0122     struct extcon_dev *edev = palmas_usb->edev;
0123 
0124     if (!palmas_usb->id_gpiod)
0125         return;
0126 
0127     id = gpiod_get_value_cansleep(palmas_usb->id_gpiod);
0128 
0129     if (id) {
0130         extcon_set_state_sync(edev, EXTCON_USB_HOST, false);
0131         dev_dbg(palmas_usb->dev, "USB-HOST cable is detached\n");
0132     } else {
0133         extcon_set_state_sync(edev, EXTCON_USB_HOST, true);
0134         dev_dbg(palmas_usb->dev, "USB-HOST cable is attached\n");
0135     }
0136 }
0137 
0138 static irqreturn_t palmas_gpio_id_irq_handler(int irq, void *_palmas_usb)
0139 {
0140     struct palmas_usb *palmas_usb = _palmas_usb;
0141 
0142     queue_delayed_work(system_power_efficient_wq, &palmas_usb->wq_detectid,
0143                palmas_usb->sw_debounce_jiffies);
0144 
0145     return IRQ_HANDLED;
0146 }
0147 
0148 static void palmas_enable_irq(struct palmas_usb *palmas_usb)
0149 {
0150     palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0151         PALMAS_USB_VBUS_CTRL_SET,
0152         PALMAS_USB_VBUS_CTRL_SET_VBUS_ACT_COMP);
0153 
0154     if (palmas_usb->enable_id_detection) {
0155         palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0156                  PALMAS_USB_ID_CTRL_SET,
0157                  PALMAS_USB_ID_CTRL_SET_ID_ACT_COMP);
0158 
0159         palmas_write(palmas_usb->palmas, PALMAS_USB_OTG_BASE,
0160                  PALMAS_USB_ID_INT_EN_HI_SET,
0161                  PALMAS_USB_ID_INT_EN_HI_SET_ID_GND |
0162                  PALMAS_USB_ID_INT_EN_HI_SET_ID_FLOAT);
0163     }
0164 
0165     if (palmas_usb->enable_vbus_detection)
0166         palmas_vbus_irq_handler(palmas_usb->vbus_irq, palmas_usb);
0167 
0168     /* cold plug for host mode needs this delay */
0169     if (palmas_usb->enable_id_detection) {
0170         msleep(30);
0171         palmas_id_irq_handler(palmas_usb->id_irq, palmas_usb);
0172     }
0173 }
0174 
0175 static int palmas_usb_probe(struct platform_device *pdev)
0176 {
0177     struct palmas *palmas = dev_get_drvdata(pdev->dev.parent);
0178     struct palmas_usb_platform_data *pdata = dev_get_platdata(&pdev->dev);
0179     struct device_node *node = pdev->dev.of_node;
0180     struct palmas_usb *palmas_usb;
0181     int status;
0182 
0183     if (!palmas) {
0184         dev_err(&pdev->dev, "failed to get valid parent\n");
0185         return -EINVAL;
0186     }
0187 
0188     palmas_usb = devm_kzalloc(&pdev->dev, sizeof(*palmas_usb), GFP_KERNEL);
0189     if (!palmas_usb)
0190         return -ENOMEM;
0191 
0192     if (node && !pdata) {
0193         palmas_usb->wakeup = of_property_read_bool(node, "ti,wakeup");
0194         palmas_usb->enable_id_detection = of_property_read_bool(node,
0195                         "ti,enable-id-detection");
0196         palmas_usb->enable_vbus_detection = of_property_read_bool(node,
0197                         "ti,enable-vbus-detection");
0198     } else {
0199         palmas_usb->wakeup = true;
0200         palmas_usb->enable_id_detection = true;
0201         palmas_usb->enable_vbus_detection = true;
0202 
0203         if (pdata)
0204             palmas_usb->wakeup = pdata->wakeup;
0205     }
0206 
0207     palmas_usb->id_gpiod = devm_gpiod_get_optional(&pdev->dev, "id",
0208                             GPIOD_IN);
0209     if (IS_ERR(palmas_usb->id_gpiod))
0210         return dev_err_probe(&pdev->dev, PTR_ERR(palmas_usb->id_gpiod),
0211                      "failed to get id gpio\n");
0212 
0213     palmas_usb->vbus_gpiod = devm_gpiod_get_optional(&pdev->dev, "vbus",
0214                             GPIOD_IN);
0215     if (IS_ERR(palmas_usb->vbus_gpiod))
0216         return dev_err_probe(&pdev->dev, PTR_ERR(palmas_usb->vbus_gpiod),
0217                      "failed to get id gpio\n");
0218 
0219     if (palmas_usb->enable_id_detection && palmas_usb->id_gpiod) {
0220         palmas_usb->enable_id_detection = false;
0221         palmas_usb->enable_gpio_id_detection = true;
0222     }
0223 
0224     if (palmas_usb->enable_vbus_detection && palmas_usb->vbus_gpiod) {
0225         palmas_usb->enable_vbus_detection = false;
0226         palmas_usb->enable_gpio_vbus_detection = true;
0227     }
0228 
0229     if (palmas_usb->enable_gpio_id_detection) {
0230         u32 debounce;
0231 
0232         if (of_property_read_u32(node, "debounce-delay-ms", &debounce))
0233             debounce = USB_GPIO_DEBOUNCE_MS;
0234 
0235         status = gpiod_set_debounce(palmas_usb->id_gpiod,
0236                         debounce * 1000);
0237         if (status < 0)
0238             palmas_usb->sw_debounce_jiffies = msecs_to_jiffies(debounce);
0239     }
0240 
0241     status = devm_delayed_work_autocancel(&pdev->dev,
0242                           &palmas_usb->wq_detectid,
0243                           palmas_gpio_id_detect);
0244     if (status)
0245         return status;
0246 
0247     palmas->usb = palmas_usb;
0248     palmas_usb->palmas = palmas;
0249 
0250     palmas_usb->dev  = &pdev->dev;
0251 
0252     palmas_usb_wakeup(palmas, palmas_usb->wakeup);
0253 
0254     platform_set_drvdata(pdev, palmas_usb);
0255 
0256     palmas_usb->edev = devm_extcon_dev_allocate(&pdev->dev,
0257                             palmas_extcon_cable);
0258     if (IS_ERR(palmas_usb->edev)) {
0259         dev_err(&pdev->dev, "failed to allocate extcon device\n");
0260         return -ENOMEM;
0261     }
0262 
0263     status = devm_extcon_dev_register(&pdev->dev, palmas_usb->edev);
0264     if (status) {
0265         dev_err(&pdev->dev, "failed to register extcon device\n");
0266         return status;
0267     }
0268 
0269     if (palmas_usb->enable_id_detection) {
0270         palmas_usb->id_otg_irq = regmap_irq_get_virq(palmas->irq_data,
0271                                  PALMAS_ID_OTG_IRQ);
0272         palmas_usb->id_irq = regmap_irq_get_virq(palmas->irq_data,
0273                              PALMAS_ID_IRQ);
0274         status = devm_request_threaded_irq(palmas_usb->dev,
0275                 palmas_usb->id_irq,
0276                 NULL, palmas_id_irq_handler,
0277                 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING |
0278                 IRQF_ONESHOT,
0279                 "palmas_usb_id", palmas_usb);
0280         if (status < 0) {
0281             dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
0282                     palmas_usb->id_irq, status);
0283             return status;
0284         }
0285     } else if (palmas_usb->enable_gpio_id_detection) {
0286         palmas_usb->gpio_id_irq = gpiod_to_irq(palmas_usb->id_gpiod);
0287         if (palmas_usb->gpio_id_irq < 0) {
0288             dev_err(&pdev->dev, "failed to get id irq\n");
0289             return palmas_usb->gpio_id_irq;
0290         }
0291         status = devm_request_threaded_irq(&pdev->dev,
0292                            palmas_usb->gpio_id_irq,
0293                            NULL,
0294                            palmas_gpio_id_irq_handler,
0295                            IRQF_TRIGGER_RISING |
0296                            IRQF_TRIGGER_FALLING |
0297                            IRQF_ONESHOT,
0298                            "palmas_usb_id",
0299                            palmas_usb);
0300         if (status < 0) {
0301             dev_err(&pdev->dev,
0302                 "failed to request handler for id irq\n");
0303             return status;
0304         }
0305     }
0306 
0307     if (palmas_usb->enable_vbus_detection) {
0308         palmas_usb->vbus_otg_irq = regmap_irq_get_virq(palmas->irq_data,
0309                                PALMAS_VBUS_OTG_IRQ);
0310         palmas_usb->vbus_irq = regmap_irq_get_virq(palmas->irq_data,
0311                                PALMAS_VBUS_IRQ);
0312         status = devm_request_threaded_irq(palmas_usb->dev,
0313                 palmas_usb->vbus_irq, NULL,
0314                 palmas_vbus_irq_handler,
0315                 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING |
0316                 IRQF_ONESHOT,
0317                 "palmas_usb_vbus", palmas_usb);
0318         if (status < 0) {
0319             dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
0320                     palmas_usb->vbus_irq, status);
0321             return status;
0322         }
0323     } else if (palmas_usb->enable_gpio_vbus_detection) {
0324         /* remux GPIO_1 as VBUSDET */
0325         status = palmas_update_bits(palmas,
0326             PALMAS_PU_PD_OD_BASE,
0327             PALMAS_PRIMARY_SECONDARY_PAD1,
0328             PALMAS_PRIMARY_SECONDARY_PAD1_GPIO_1_MASK,
0329             (1 << PALMAS_PRIMARY_SECONDARY_PAD1_GPIO_1_SHIFT));
0330         if (status < 0) {
0331             dev_err(&pdev->dev, "can't remux GPIO1\n");
0332             return status;
0333         }
0334 
0335         palmas_usb->vbus_otg_irq = regmap_irq_get_virq(palmas->irq_data,
0336                                PALMAS_VBUS_OTG_IRQ);
0337         palmas_usb->gpio_vbus_irq = gpiod_to_irq(palmas_usb->vbus_gpiod);
0338         if (palmas_usb->gpio_vbus_irq < 0) {
0339             dev_err(&pdev->dev, "failed to get vbus irq\n");
0340             return palmas_usb->gpio_vbus_irq;
0341         }
0342         status = devm_request_threaded_irq(&pdev->dev,
0343                         palmas_usb->gpio_vbus_irq,
0344                         NULL,
0345                         palmas_vbus_irq_handler,
0346                         IRQF_TRIGGER_FALLING |
0347                         IRQF_TRIGGER_RISING |
0348                         IRQF_ONESHOT,
0349                         "palmas_usb_vbus",
0350                         palmas_usb);
0351         if (status < 0) {
0352             dev_err(&pdev->dev,
0353                 "failed to request handler for vbus irq\n");
0354             return status;
0355         }
0356     }
0357 
0358     palmas_enable_irq(palmas_usb);
0359     /* perform initial detection */
0360     if (palmas_usb->enable_gpio_vbus_detection)
0361         palmas_vbus_irq_handler(palmas_usb->gpio_vbus_irq, palmas_usb);
0362     palmas_gpio_id_detect(&palmas_usb->wq_detectid.work);
0363     device_set_wakeup_capable(&pdev->dev, true);
0364     return 0;
0365 }
0366 
0367 #ifdef CONFIG_PM_SLEEP
0368 static int palmas_usb_suspend(struct device *dev)
0369 {
0370     struct palmas_usb *palmas_usb = dev_get_drvdata(dev);
0371 
0372     if (device_may_wakeup(dev)) {
0373         if (palmas_usb->enable_vbus_detection)
0374             enable_irq_wake(palmas_usb->vbus_irq);
0375         if (palmas_usb->enable_gpio_vbus_detection)
0376             enable_irq_wake(palmas_usb->gpio_vbus_irq);
0377         if (palmas_usb->enable_id_detection)
0378             enable_irq_wake(palmas_usb->id_irq);
0379         if (palmas_usb->enable_gpio_id_detection)
0380             enable_irq_wake(palmas_usb->gpio_id_irq);
0381     }
0382     return 0;
0383 }
0384 
0385 static int palmas_usb_resume(struct device *dev)
0386 {
0387     struct palmas_usb *palmas_usb = dev_get_drvdata(dev);
0388 
0389     if (device_may_wakeup(dev)) {
0390         if (palmas_usb->enable_vbus_detection)
0391             disable_irq_wake(palmas_usb->vbus_irq);
0392         if (palmas_usb->enable_gpio_vbus_detection)
0393             disable_irq_wake(palmas_usb->gpio_vbus_irq);
0394         if (palmas_usb->enable_id_detection)
0395             disable_irq_wake(palmas_usb->id_irq);
0396         if (palmas_usb->enable_gpio_id_detection)
0397             disable_irq_wake(palmas_usb->gpio_id_irq);
0398     }
0399 
0400     /* check if GPIO states changed while suspend/resume */
0401     if (palmas_usb->enable_gpio_vbus_detection)
0402         palmas_vbus_irq_handler(palmas_usb->gpio_vbus_irq, palmas_usb);
0403     palmas_gpio_id_detect(&palmas_usb->wq_detectid.work);
0404 
0405     return 0;
0406 };
0407 #endif
0408 
0409 static SIMPLE_DEV_PM_OPS(palmas_pm_ops, palmas_usb_suspend, palmas_usb_resume);
0410 
0411 static const struct of_device_id of_palmas_match_tbl[] = {
0412     { .compatible = "ti,palmas-usb", },
0413     { .compatible = "ti,palmas-usb-vid", },
0414     { .compatible = "ti,twl6035-usb", },
0415     { .compatible = "ti,twl6035-usb-vid", },
0416     { /* end */ }
0417 };
0418 
0419 static struct platform_driver palmas_usb_driver = {
0420     .probe = palmas_usb_probe,
0421     .driver = {
0422         .name = "palmas-usb",
0423         .of_match_table = of_palmas_match_tbl,
0424         .pm = &palmas_pm_ops,
0425     },
0426 };
0427 
0428 module_platform_driver(palmas_usb_driver);
0429 
0430 MODULE_ALIAS("platform:palmas-usb");
0431 MODULE_AUTHOR("Graeme Gregory <gg@slimlogic.co.uk>");
0432 MODULE_DESCRIPTION("Palmas USB transceiver driver");
0433 MODULE_LICENSE("GPL");
0434 MODULE_DEVICE_TABLE(of, of_palmas_match_tbl);