drivers/phy/phy-omap-usb2.c

   1 /*
   2  * omap-usb2.c - USB PHY, talking to musb controller in OMAP.
   3  *
   4  * Copyright (C) 2012 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: Kishon Vijay Abraham I <kishon@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  */
  18
  19 #include <linux/module.h>
  20 #include <linux/platform_device.h>
  21 #include <linux/slab.h>
  22 #include <linux/of.h>
  23 #include <linux/io.h>
  24 #include <linux/phy/omap_usb.h>
  25 #include <linux/usb/phy_companion.h>
  26 #include <linux/clk.h>
  27 #include <linux/err.h>
  28 #include <linux/pm_runtime.h>
  29 #include <linux/delay.h>
  30 #include <linux/phy/omap_control_phy.h>
  31 #include <linux/phy/phy.h>
  32 #include <linux/of_platform.h>
  33
  34 #define USB2PHY_DISCON_BYP_LATCH (1 << 31)
  35 #define USB2PHY_ANA_CONFIG1 0x4c
  36
  37 /**
  38  * omap_usb2_set_comparator - links the comparator present in the sytem with
  39  *      this phy
  40  * @comparator - the companion phy(comparator) for this phy
  41  *
  42  * The phy companion driver should call this API passing the phy_companion
  43  * filled with set_vbus and start_srp to be used by usb phy.
  44  *
  45  * For use by phy companion driver
  46  */
  47 int omap_usb2_set_comparator(struct phy_companion *comparator)
  48 {
  49         struct omap_usb *phy;
  50         struct usb_phy  *x = usb_get_phy(USB_PHY_TYPE_USB2);
  51
  52         if (IS_ERR(x))
  53                 return -ENODEV;
  54
  55         phy = phy_to_omapusb(x);
  56         phy->comparator = comparator;
  57         return 0;
  58 }
  59 EXPORT_SYMBOL_GPL(omap_usb2_set_comparator);
  60
  61 static int omap_usb_set_vbus(struct usb_otg *otg, bool enabled)
  62 {
  63         struct omap_usb *phy = phy_to_omapusb(otg->usb_phy);
  64
  65         if (!phy->comparator)
  66                 return -ENODEV;
  67
  68         return phy->comparator->set_vbus(phy->comparator, enabled);
  69 }
  70
  71 static int omap_usb_start_srp(struct usb_otg *otg)
  72 {
  73         struct omap_usb *phy = phy_to_omapusb(otg->usb_phy);
  74
  75         if (!phy->comparator)
  76                 return -ENODEV;
  77
  78         return phy->comparator->start_srp(phy->comparator);
  79 }
  80
  81 static int omap_usb_set_host(struct usb_otg *otg, struct usb_bus *host)
  82 {
  83         otg->host = host;
  84         if (!host)
  85                 otg->state = OTG_STATE_UNDEFINED;
  86
  87         return 0;
  88 }
  89
  90 static int omap_usb_set_peripheral(struct usb_otg *otg,
  91                 struct usb_gadget *gadget)
  92 {
  93         otg->gadget = gadget;
  94         if (!gadget)
  95                 otg->state = OTG_STATE_UNDEFINED;
  96
  97         return 0;
  98 }
  99
 100 static int omap_usb_power_off(struct phy *x)
 101 {
 102         struct omap_usb *phy = phy_get_drvdata(x);
 103
 104         omap_control_phy_power(phy->control_dev, 0);
 105
 106         return 0;
 107 }
 108
 109 static int omap_usb_power_on(struct phy *x)
 110 {
 111         struct omap_usb *phy = phy_get_drvdata(x);
 112
 113         omap_control_phy_power(phy->control_dev, 1);
 114
 115         return 0;
 116 }
 117
 118 static int omap_usb_init(struct phy *x)
 119 {
 120         struct omap_usb *phy = phy_get_drvdata(x);
 121         u32 val;
 122
 123         if (phy->flags & OMAP_USB2_CALIBRATE_FALSE_DISCONNECT) {
 124                 /*
 125                  *
 126                  * Reduce the sensitivity of internal PHY by enabling the
 127                  * DISCON_BYP_LATCH of the USB2PHY_ANA_CONFIG1 register. This
 128                  * resolves issues with certain devices which can otherwise
 129                  * be prone to false disconnects.
 130                  *
 131                  */
 132                 val = omap_usb_readl(phy->phy_base, USB2PHY_ANA_CONFIG1);
 133                 val |= USB2PHY_DISCON_BYP_LATCH;
 134                 omap_usb_writel(phy->phy_base, USB2PHY_ANA_CONFIG1, val);
 135         }
 136
 137         return 0;
 138 }
 139
 140 static struct phy_ops ops = {
 141         .init           = omap_usb_init,
 142         .power_on       = omap_usb_power_on,
 143         .power_off      = omap_usb_power_off,
 144         .owner          = THIS_MODULE,
 145 };
 146
 147 #ifdef CONFIG_OF
 148 static const struct usb_phy_data omap_usb2_data = {
 149         .label = "omap_usb2",
 150         .flags = OMAP_USB2_HAS_START_SRP | OMAP_USB2_HAS_SET_VBUS,
 151 };
 152
 153 static const struct usb_phy_data omap5_usb2_data = {
 154         .label = "omap5_usb2",
 155         .flags = 0,
 156 };
 157
 158 static const struct usb_phy_data dra7x_usb2_data = {
 159         .label = "dra7x_usb2",
 160         .flags = OMAP_USB2_CALIBRATE_FALSE_DISCONNECT,
 161 };
 162
 163 static const struct usb_phy_data am437x_usb2_data = {
 164         .label = "am437x_usb2",
 165         .flags =  0,
 166 };
 167
 168 static const struct of_device_id omap_usb2_id_table[] = {
 169         {
 170                 .compatible = "ti,omap-usb2",
 171                 .data = &omap_usb2_data,
 172         },
 173         {
 174                 .compatible = "ti,omap5-usb2",
 175                 .data = &omap5_usb2_data,
 176         },
 177         {
 178                 .compatible = "ti,dra7x-usb2",
 179                 .data = &dra7x_usb2_data,
 180         },
 181         {
 182                 .compatible = "ti,am437x-usb2",
 183                 .data = &am437x_usb2_data,
 184         },
 185         {},
 186 };
 187 MODULE_DEVICE_TABLE(of, omap_usb2_id_table);
 188 #endif
 189
 190 static int omap_usb2_probe(struct platform_device *pdev)
 191 {
 192         struct omap_usb *phy;
 193         struct phy *generic_phy;
 194         struct resource *res;
 195         struct phy_provider *phy_provider;
 196         struct usb_otg *otg;
 197         struct device_node *node = pdev->dev.of_node;
 198         struct device_node *control_node;
 199         struct platform_device *control_pdev;
 200         const struct of_device_id *of_id;
 201         struct usb_phy_data *phy_data;
 202
 203         of_id = of_match_device(of_match_ptr(omap_usb2_id_table), &pdev->dev);
 204
 205         if (!of_id)
 206                 return -EINVAL;
 207
 208         phy_data = (struct usb_phy_data *)of_id->data;
 209
 210         phy = devm_kzalloc(&pdev->dev, sizeof(*phy), GFP_KERNEL);
 211         if (!phy)
 212                 return -ENOMEM;
 213
 214         otg = devm_kzalloc(&pdev->dev, sizeof(*otg), GFP_KERNEL);
 215         if (!otg)
 216                 return -ENOMEM;
 217
 218         phy->dev                = &pdev->dev;
 219
 220         phy->phy.dev            = phy->dev;
 221         phy->phy.label          = phy_data->label;
 222         phy->phy.otg            = otg;
 223         phy->phy.type           = USB_PHY_TYPE_USB2;
 224
 225         if (phy_data->flags & OMAP_USB2_CALIBRATE_FALSE_DISCONNECT) {
 226                 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 227                 phy->phy_base = devm_ioremap_resource(&pdev->dev, res);
 228                 if (IS_ERR(phy->phy_base))
 229                         return PTR_ERR(phy->phy_base);
 230                 phy->flags |= OMAP_USB2_CALIBRATE_FALSE_DISCONNECT;
 231         }
 232
 233         control_node = of_parse_phandle(node, "ctrl-module", 0);
 234         if (!control_node) {
 235                 dev_err(&pdev->dev, "Failed to get control device phandle\n");
 236                 return -EINVAL;
 237         }
 238
 239         control_pdev = of_find_device_by_node(control_node);
 240         if (!control_pdev) {
 241                 dev_err(&pdev->dev, "Failed to get control device\n");
 242                 return -EINVAL;
 243         }
 244
 245         phy->control_dev = &control_pdev->dev;
 246         omap_control_phy_power(phy->control_dev, 0);
 247
 248         otg->set_host           = omap_usb_set_host;
 249         otg->set_peripheral     = omap_usb_set_peripheral;
 250         if (phy_data->flags & OMAP_USB2_HAS_SET_VBUS)
 251                 otg->set_vbus           = omap_usb_set_vbus;
 252         if (phy_data->flags & OMAP_USB2_HAS_START_SRP)
 253                 otg->start_srp          = omap_usb_start_srp;
 254         otg->usb_phy            = &phy->phy;
 255
 256         platform_set_drvdata(pdev, phy);
 257         pm_runtime_enable(phy->dev);
 258
 259         generic_phy = devm_phy_create(phy->dev, NULL, &ops);
 260         if (IS_ERR(generic_phy)) {
 261                 pm_runtime_disable(phy->dev);
 262                 return PTR_ERR(generic_phy);
 263         }
 264
 265         phy_set_drvdata(generic_phy, phy);
 266
 267         phy_provider = devm_of_phy_provider_register(phy->dev,
 268                         of_phy_simple_xlate);
 269         if (IS_ERR(phy_provider)) {
 270                 pm_runtime_disable(phy->dev);
 271                 return PTR_ERR(phy_provider);
 272         }
 273
 274         phy->wkupclk = devm_clk_get(phy->dev, "wkupclk");
 275         if (IS_ERR(phy->wkupclk)) {
 276                 dev_warn(&pdev->dev, "unable to get wkupclk, trying old name\n");
 277                 phy->wkupclk = devm_clk_get(phy->dev, "usb_phy_cm_clk32k");
 278                 if (IS_ERR(phy->wkupclk)) {
 279                         dev_err(&pdev->dev, "unable to get usb_phy_cm_clk32k\n");
 280                         return PTR_ERR(phy->wkupclk);
 281                 } else {
 282                         dev_warn(&pdev->dev,
 283                                  "found usb_phy_cm_clk32k, please fix DTS\n");
 284                 }
 285         }
 286         clk_prepare(phy->wkupclk);
 287
 288         phy->optclk = devm_clk_get(phy->dev, "refclk");
 289         if (IS_ERR(phy->optclk)) {
 290                 dev_dbg(&pdev->dev, "unable to get refclk, trying old name\n");
 291                 phy->optclk = devm_clk_get(phy->dev, "usb_otg_ss_refclk960m");
 292                 if (IS_ERR(phy->optclk)) {
 293                         dev_dbg(&pdev->dev,
 294                                 "unable to get usb_otg_ss_refclk960m\n");
 295                 } else {
 296                         dev_warn(&pdev->dev,
 297                                  "found usb_otg_ss_refclk960m, please fix DTS\n");
 298                 }
 299         }
 300
 301         if (!IS_ERR(phy->optclk))
 302                 clk_prepare(phy->optclk);
 303
 304         usb_add_phy_dev(&phy->phy);
 305
 306         return 0;
 307 }
 308
 309 static int omap_usb2_remove(struct platform_device *pdev)
 310 {
 311         struct omap_usb *phy = platform_get_drvdata(pdev);
 312
 313         clk_unprepare(phy->wkupclk);
 314         if (!IS_ERR(phy->optclk))
 315                 clk_unprepare(phy->optclk);
 316         usb_remove_phy(&phy->phy);
 317         pm_runtime_disable(phy->dev);
 318
 319         return 0;
 320 }
 321
 322 #ifdef CONFIG_PM
 323
 324 static int omap_usb2_runtime_suspend(struct device *dev)
 325 {
 326         struct platform_device  *pdev = to_platform_device(dev);
 327         struct omap_usb *phy = platform_get_drvdata(pdev);
 328
 329         clk_disable(phy->wkupclk);
 330         if (!IS_ERR(phy->optclk))
 331                 clk_disable(phy->optclk);
 332
 333         return 0;
 334 }
 335
 336 static int omap_usb2_runtime_resume(struct device *dev)
 337 {
 338         struct platform_device  *pdev = to_platform_device(dev);
 339         struct omap_usb *phy = platform_get_drvdata(pdev);
 340         int ret;
 341
 342         ret = clk_enable(phy->wkupclk);
 343         if (ret < 0) {
 344                 dev_err(phy->dev, "Failed to enable wkupclk %d\n", ret);
 345                 goto err0;
 346         }
 347
 348         if (!IS_ERR(phy->optclk)) {
 349                 ret = clk_enable(phy->optclk);
 350                 if (ret < 0) {
 351                         dev_err(phy->dev, "Failed to enable optclk %d\n", ret);
 352                         goto err1;
 353                 }
 354         }
 355
 356         return 0;
 357
 358 err1:
 359         clk_disable(phy->wkupclk);
 360
 361 err0:
 362         return ret;
 363 }
 364
 365 static const struct dev_pm_ops omap_usb2_pm_ops = {
 366         SET_RUNTIME_PM_OPS(omap_usb2_runtime_suspend, omap_usb2_runtime_resume,
 367                 NULL)
 368 };
 369
 370 #define DEV_PM_OPS     (&omap_usb2_pm_ops)
 371 #else
 372 #define DEV_PM_OPS     NULL
 373 #endif
 374
 375 static struct platform_driver omap_usb2_driver = {
 376         .probe          = omap_usb2_probe,
 377         .remove         = omap_usb2_remove,
 378         .driver         = {
 379                 .name   = "omap-usb2",
 380                 .pm     = DEV_PM_OPS,
 381                 .of_match_table = of_match_ptr(omap_usb2_id_table),
 382         },
 383 };
 384
 385 module_platform_driver(omap_usb2_driver);
 386
 387 MODULE_ALIAS("platform:omap_usb2");
 388 MODULE_AUTHOR("Texas Instruments Inc.");
 389 MODULE_DESCRIPTION("OMAP USB2 phy driver");
 390 MODULE_LICENSE("GPL v2");