drivers/usb/phy/phy-generic.c

   1 /*
   2  * NOP USB transceiver for all USB transceiver which are either built-in
   3  * into USB IP or which are mostly autonomous.
   4  *
   5  * Copyright (C) 2009 Texas Instruments Inc
   6  * Author: Ajay Kumar Gupta <ajay.gupta@ti.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * Current status:
  23  *      This provides a "nop" transceiver for PHYs which are
  24  *      autonomous such as isp1504, isp1707, etc.
  25  */
  26
  27 #include <linux/module.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/dma-mapping.h>
  30 #include <linux/usb/gadget.h>
  31 #include <linux/usb/otg.h>
  32 #include <linux/usb/usb_phy_generic.h>
  33 #include <linux/slab.h>
  34 #include <linux/clk.h>
  35 #include <linux/regulator/consumer.h>
  36 #include <linux/of.h>
  37 #include <linux/of_gpio.h>
  38 #include <linux/gpio.h>
  39 #include <linux/delay.h>
  40
  41 #include "phy-generic.h"
  42
  43 #define VBUS_IRQ_FLAGS \
  44         (IRQF_SHARED | IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING | \
  45                 IRQF_ONESHOT)
  46
  47 struct platform_device *usb_phy_generic_register(void)
  48 {
  49         return platform_device_register_simple("usb_phy_generic",
  50                         PLATFORM_DEVID_AUTO, NULL, 0);
  51 }
  52 EXPORT_SYMBOL_GPL(usb_phy_generic_register);
  53
  54 void usb_phy_generic_unregister(struct platform_device *pdev)
  55 {
  56         platform_device_unregister(pdev);
  57 }
  58 EXPORT_SYMBOL_GPL(usb_phy_generic_unregister);
  59
  60 static int nop_set_suspend(struct usb_phy *x, int suspend)
  61 {
  62         return 0;
  63 }
  64
  65 static void nop_reset(struct usb_phy_generic *nop)
  66 {
  67         if (!nop->gpiod_reset)
  68                 return;
  69
  70         gpiod_set_value(nop->gpiod_reset, 1);
  71         usleep_range(10000, 20000);
  72         gpiod_set_value(nop->gpiod_reset, 0);
  73 }
  74
  75 /* interface to regulator framework */
  76 static void nop_set_vbus_draw(struct usb_phy_generic *nop, unsigned mA)
  77 {
  78         struct regulator *vbus_draw = nop->vbus_draw;
  79         int enabled;
  80         int ret;
  81
  82         if (!vbus_draw)
  83                 return;
  84
  85         enabled = nop->vbus_draw_enabled;
  86         if (mA) {
  87                 regulator_set_current_limit(vbus_draw, 0, 1000 * mA);
  88                 if (!enabled) {
  89                         ret = regulator_enable(vbus_draw);
  90                         if (ret < 0)
  91                                 return;
  92                         nop->vbus_draw_enabled = 1;
  93                 }
  94         } else {
  95                 if (enabled) {
  96                         ret = regulator_disable(vbus_draw);
  97                         if (ret < 0)
  98                                 return;
  99                         nop->vbus_draw_enabled = 0;
 100                 }
 101         }
 102         nop->mA = mA;
 103 }
 104
 105
 106 static irqreturn_t nop_gpio_vbus_thread(int irq, void *data)
 107 {
 108         struct usb_phy_generic *nop = data;
 109         struct usb_otg *otg = nop->phy.otg;
 110         int vbus, status;
 111
 112         vbus = gpiod_get_value(nop->gpiod_vbus);
 113         if ((vbus ^ nop->vbus) == 0)
 114                 return IRQ_HANDLED;
 115         nop->vbus = vbus;
 116
 117         if (vbus) {
 118                 status = USB_EVENT_VBUS;
 119                 otg->state = OTG_STATE_B_PERIPHERAL;
 120                 nop->phy.last_event = status;
 121                 if (otg->gadget)
 122                         usb_gadget_vbus_connect(otg->gadget);
 123
 124                 /* drawing a "unit load" is *always* OK, except for OTG */
 125                 nop_set_vbus_draw(nop, 100);
 126
 127                 atomic_notifier_call_chain(&nop->phy.notifier, status,
 128                                            otg->gadget);
 129         } else {
 130                 nop_set_vbus_draw(nop, 0);
 131
 132                 if (otg->gadget)
 133                         usb_gadget_vbus_disconnect(otg->gadget);
 134                 status = USB_EVENT_NONE;
 135                 otg->state = OTG_STATE_B_IDLE;
 136                 nop->phy.last_event = status;
 137
 138                 atomic_notifier_call_chain(&nop->phy.notifier, status,
 139                                            otg->gadget);
 140         }
 141         return IRQ_HANDLED;
 142 }
 143
 144 int usb_gen_phy_init(struct usb_phy *phy)
 145 {
 146         struct usb_phy_generic *nop = dev_get_drvdata(phy->dev);
 147         int ret;
 148
 149         if (!IS_ERR(nop->vcc)) {
 150                 if (regulator_enable(nop->vcc))
 151                         dev_err(phy->dev, "Failed to enable power\n");
 152         }
 153
 154         if (!IS_ERR(nop->clk)) {
 155                 ret = clk_prepare_enable(nop->clk);
 156                 if (ret)
 157                         return ret;
 158         }
 159
 160         nop_reset(nop);
 161
 162         return 0;
 163 }
 164 EXPORT_SYMBOL_GPL(usb_gen_phy_init);
 165
 166 void usb_gen_phy_shutdown(struct usb_phy *phy)
 167 {
 168         struct usb_phy_generic *nop = dev_get_drvdata(phy->dev);
 169
 170         gpiod_set_value(nop->gpiod_reset, 1);
 171
 172         if (!IS_ERR(nop->clk))
 173                 clk_disable_unprepare(nop->clk);
 174
 175         if (!IS_ERR(nop->vcc)) {
 176                 if (regulator_disable(nop->vcc))
 177                         dev_err(phy->dev, "Failed to disable power\n");
 178         }
 179 }
 180 EXPORT_SYMBOL_GPL(usb_gen_phy_shutdown);
 181
 182 static int nop_set_peripheral(struct usb_otg *otg, struct usb_gadget *gadget)
 183 {
 184         if (!otg)
 185                 return -ENODEV;
 186
 187         if (!gadget) {
 188                 otg->gadget = NULL;
 189                 return -ENODEV;
 190         }
 191
 192         otg->gadget = gadget;
 193         if (otg->state == OTG_STATE_B_PERIPHERAL)
 194                 usb_gadget_vbus_connect(gadget);
 195         else
 196                 otg->state = OTG_STATE_B_IDLE;
 197         return 0;
 198 }
 199
 200 static int nop_set_host(struct usb_otg *otg, struct usb_bus *host)
 201 {
 202         if (!otg)
 203                 return -ENODEV;
 204
 205         if (!host) {
 206                 otg->host = NULL;
 207                 return -ENODEV;
 208         }
 209
 210         otg->host = host;
 211         return 0;
 212 }
 213
 214 int usb_phy_gen_create_phy(struct device *dev, struct usb_phy_generic *nop,
 215                 struct usb_phy_generic_platform_data *pdata)
 216 {
 217         enum usb_phy_type type = USB_PHY_TYPE_USB2;
 218         int err = 0;
 219
 220         u32 clk_rate = 0;
 221         bool needs_vcc = false;
 222
 223         if (dev->of_node) {
 224                 struct device_node *node = dev->of_node;
 225
 226                 if (of_property_read_u32(node, "clock-frequency", &clk_rate))
 227                         clk_rate = 0;
 228
 229                 needs_vcc = of_property_read_bool(node, "vcc-supply");
 230                 nop->gpiod_reset = devm_gpiod_get_optional(dev, "reset",
 231                                                            GPIOD_ASIS);
 232                 err = PTR_ERR_OR_ZERO(nop->gpiod_reset);
 233                 if (!err) {
 234                         nop->gpiod_vbus = devm_gpiod_get_optional(dev,
 235                                                          "vbus-detect",
 236                                                          GPIOD_ASIS);
 237                         err = PTR_ERR_OR_ZERO(nop->gpiod_vbus);
 238                 }
 239         } else if (pdata) {
 240                 type = pdata->type;
 241                 clk_rate = pdata->clk_rate;
 242                 needs_vcc = pdata->needs_vcc;
 243                 if (gpio_is_valid(pdata->gpio_reset)) {
 244                         err = devm_gpio_request_one(dev, pdata->gpio_reset,
 245                                                     GPIOF_ACTIVE_LOW,
 246                                                     dev_name(dev));
 247                         if (!err)
 248                                 nop->gpiod_reset =
 249                                         gpio_to_desc(pdata->gpio_reset);
 250                 }
 251                 nop->gpiod_vbus = pdata->gpiod_vbus;
 252         }
 253
 254         if (err == -EPROBE_DEFER)
 255                 return -EPROBE_DEFER;
 256         if (err) {
 257                 dev_err(dev, "Error requesting RESET or VBUS GPIO\n");
 258                 return err;
 259         }
 260         if (nop->gpiod_reset)
 261                 gpiod_direction_output(nop->gpiod_reset, 1);
 262
 263         nop->phy.otg = devm_kzalloc(dev, sizeof(*nop->phy.otg),
 264                         GFP_KERNEL);
 265         if (!nop->phy.otg)
 266                 return -ENOMEM;
 267
 268         nop->clk = devm_clk_get(dev, "main_clk");
 269         if (IS_ERR(nop->clk)) {
 270                 dev_dbg(dev, "Can't get phy clock: %ld\n",
 271                                         PTR_ERR(nop->clk));
 272         }
 273
 274         if (!IS_ERR(nop->clk) && clk_rate) {
 275                 err = clk_set_rate(nop->clk, clk_rate);
 276                 if (err) {
 277                         dev_err(dev, "Error setting clock rate\n");
 278                         return err;
 279                 }
 280         }
 281
 282         nop->vcc = devm_regulator_get(dev, "vcc");
 283         if (IS_ERR(nop->vcc)) {
 284                 dev_dbg(dev, "Error getting vcc regulator: %ld\n",
 285                                         PTR_ERR(nop->vcc));
 286                 if (needs_vcc)
 287                         return -EPROBE_DEFER;
 288         }
 289
 290         nop->dev                = dev;
 291         nop->phy.dev            = nop->dev;
 292         nop->phy.label          = "nop-xceiv";
 293         nop->phy.set_suspend    = nop_set_suspend;
 294         nop->phy.type           = type;
 295
 296         nop->phy.otg->state             = OTG_STATE_UNDEFINED;
 297         nop->phy.otg->usb_phy           = &nop->phy;
 298         nop->phy.otg->set_host          = nop_set_host;
 299         nop->phy.otg->set_peripheral    = nop_set_peripheral;
 300
 301         return 0;
 302 }
 303 EXPORT_SYMBOL_GPL(usb_phy_gen_create_phy);
 304
 305 static int usb_phy_generic_probe(struct platform_device *pdev)
 306 {
 307         struct device *dev = &pdev->dev;
 308         struct usb_phy_generic  *nop;
 309         int err;
 310
 311         nop = devm_kzalloc(dev, sizeof(*nop), GFP_KERNEL);
 312         if (!nop)
 313                 return -ENOMEM;
 314
 315         err = usb_phy_gen_create_phy(dev, nop, dev_get_platdata(&pdev->dev));
 316         if (err)
 317                 return err;
 318         if (nop->gpiod_vbus) {
 319                 err = devm_request_threaded_irq(&pdev->dev,
 320                                                 gpiod_to_irq(nop->gpiod_vbus),
 321                                                 NULL, nop_gpio_vbus_thread,
 322                                                 VBUS_IRQ_FLAGS, "vbus_detect",
 323                                                 nop);
 324                 if (err) {
 325                         dev_err(&pdev->dev, "can't request irq %i, err: %d\n",
 326                                 gpiod_to_irq(nop->gpiod_vbus), err);
 327                         return err;
 328                 }
 329         }
 330
 331         nop->phy.init           = usb_gen_phy_init;
 332         nop->phy.shutdown       = usb_gen_phy_shutdown;
 333
 334         err = usb_add_phy_dev(&nop->phy);
 335         if (err) {
 336                 dev_err(&pdev->dev, "can't register transceiver, err: %d\n",
 337                         err);
 338                 return err;
 339         }
 340
 341         platform_set_drvdata(pdev, nop);
 342
 343         return 0;
 344 }
 345
 346 static int usb_phy_generic_remove(struct platform_device *pdev)
 347 {
 348         struct usb_phy_generic *nop = platform_get_drvdata(pdev);
 349
 350         usb_remove_phy(&nop->phy);
 351
 352         return 0;
 353 }
 354
 355 static const struct of_device_id nop_xceiv_dt_ids[] = {
 356         { .compatible = "usb-nop-xceiv" },
 357         { }
 358 };
 359
 360 MODULE_DEVICE_TABLE(of, nop_xceiv_dt_ids);
 361
 362 static struct platform_driver usb_phy_generic_driver = {
 363         .probe          = usb_phy_generic_probe,
 364         .remove         = usb_phy_generic_remove,
 365         .driver         = {
 366                 .name   = "usb_phy_generic",
 367                 .of_match_table = nop_xceiv_dt_ids,
 368         },
 369 };
 370
 371 static int __init usb_phy_generic_init(void)
 372 {
 373         return platform_driver_register(&usb_phy_generic_driver);
 374 }
 375 subsys_initcall(usb_phy_generic_init);
 376
 377 static void __exit usb_phy_generic_exit(void)
 378 {
 379         platform_driver_unregister(&usb_phy_generic_driver);
 380 }
 381 module_exit(usb_phy_generic_exit);
 382
 383 MODULE_ALIAS("platform:usb_phy_generic");
 384 MODULE_AUTHOR("Texas Instruments Inc");
 385 MODULE_DESCRIPTION("NOP USB Transceiver driver");
 386 MODULE_LICENSE("GPL");