drivers/phy/phy-core.c

   1 /*
   2  * phy-core.c  --  Generic Phy framework.
   3  *
   4  * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
   5  *
   6  * Author: Kishon Vijay Abraham I <kishon@ti.com>
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  */
  13
  14 #include <linux/kernel.h>
  15 #include <linux/export.h>
  16 #include <linux/module.h>
  17 #include <linux/err.h>
  18 #include <linux/device.h>
  19 #include <linux/slab.h>
  20 #include <linux/of.h>
  21 #include <linux/phy/phy.h>
  22 #include <linux/idr.h>
  23 #include <linux/pm_runtime.h>
  24 #include <linux/regulator/consumer.h>
  25
  26 static struct class *phy_class;
  27 static DEFINE_MUTEX(phy_provider_mutex);
  28 static LIST_HEAD(phy_provider_list);
  29 static LIST_HEAD(phys);
  30 static DEFINE_IDA(phy_ida);
  31
  32 static void devm_phy_release(struct device *dev, void *res)
  33 {
  34         struct phy *phy = *(struct phy **)res;
  35
  36         phy_put(phy);
  37 }
  38
  39 static void devm_phy_provider_release(struct device *dev, void *res)
  40 {
  41         struct phy_provider *phy_provider = *(struct phy_provider **)res;
  42
  43         of_phy_provider_unregister(phy_provider);
  44 }
  45
  46 static void devm_phy_consume(struct device *dev, void *res)
  47 {
  48         struct phy *phy = *(struct phy **)res;
  49
  50         phy_destroy(phy);
  51 }
  52
  53 static int devm_phy_match(struct device *dev, void *res, void *match_data)
  54 {
  55         struct phy **phy = res;
  56
  57         return *phy == match_data;
  58 }
  59
  60 /**
  61  * phy_create_lookup() - allocate and register PHY/device association
  62  * @phy: the phy of the association
  63  * @con_id: connection ID string on device
  64  * @dev_id: the device of the association
  65  *
  66  * Creates and registers phy_lookup entry.
  67  */
  68 int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
  69 {
  70         struct phy_lookup *pl;
  71
  72         if (!phy || !dev_id || !con_id)
  73                 return -EINVAL;
  74
  75         pl = kzalloc(sizeof(*pl), GFP_KERNEL);
  76         if (!pl)
  77                 return -ENOMEM;
  78
  79         pl->dev_id = dev_id;
  80         pl->con_id = con_id;
  81         pl->phy = phy;
  82
  83         mutex_lock(&phy_provider_mutex);
  84         list_add_tail(&pl->node, &phys);
  85         mutex_unlock(&phy_provider_mutex);
  86
  87         return 0;
  88 }
  89 EXPORT_SYMBOL_GPL(phy_create_lookup);
  90
  91 /**
  92  * phy_remove_lookup() - find and remove PHY/device association
  93  * @phy: the phy of the association
  94  * @con_id: connection ID string on device
  95  * @dev_id: the device of the association
  96  *
  97  * Finds and unregisters phy_lookup entry that was created with
  98  * phy_create_lookup().
  99  */
 100 void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id)
 101 {
 102         struct phy_lookup *pl;
 103
 104         if (!phy || !dev_id || !con_id)
 105                 return;
 106
 107         mutex_lock(&phy_provider_mutex);
 108         list_for_each_entry(pl, &phys, node)
 109                 if (pl->phy == phy && !strcmp(pl->dev_id, dev_id) &&
 110                     !strcmp(pl->con_id, con_id)) {
 111                         list_del(&pl->node);
 112                         kfree(pl);
 113                         break;
 114                 }
 115         mutex_unlock(&phy_provider_mutex);
 116 }
 117 EXPORT_SYMBOL_GPL(phy_remove_lookup);
 118
 119 static struct phy *phy_find(struct device *dev, const char *con_id)
 120 {
 121         const char *dev_id = dev_name(dev);
 122         struct phy_lookup *p, *pl = NULL;
 123
 124         mutex_lock(&phy_provider_mutex);
 125         list_for_each_entry(p, &phys, node)
 126                 if (!strcmp(p->dev_id, dev_id) && !strcmp(p->con_id, con_id)) {
 127                         pl = p;
 128                         break;
 129                 }
 130         mutex_unlock(&phy_provider_mutex);
 131
 132         return pl ? pl->phy : ERR_PTR(-ENODEV);
 133 }
 134
 135 static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
 136 {
 137         struct phy_provider *phy_provider;
 138         struct device_node *child;
 139
 140         list_for_each_entry(phy_provider, &phy_provider_list, list) {
 141                 if (phy_provider->dev->of_node == node)
 142                         return phy_provider;
 143
 144                 for_each_child_of_node(phy_provider->children, child)
 145                         if (child == node)
 146                                 return phy_provider;
 147         }
 148
 149         return ERR_PTR(-EPROBE_DEFER);
 150 }
 151
 152 int phy_pm_runtime_get(struct phy *phy)
 153 {
 154         int ret;
 155
 156         if (!phy)
 157                 return 0;
 158
 159         if (!pm_runtime_enabled(&phy->dev))
 160                 return -ENOTSUPP;
 161
 162         ret = pm_runtime_get(&phy->dev);
 163         if (ret < 0 && ret != -EINPROGRESS)
 164                 pm_runtime_put_noidle(&phy->dev);
 165
 166         return ret;
 167 }
 168 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
 169
 170 int phy_pm_runtime_get_sync(struct phy *phy)
 171 {
 172         int ret;
 173
 174         if (!phy)
 175                 return 0;
 176
 177         if (!pm_runtime_enabled(&phy->dev))
 178                 return -ENOTSUPP;
 179
 180         ret = pm_runtime_get_sync(&phy->dev);
 181         if (ret < 0)
 182                 pm_runtime_put_sync(&phy->dev);
 183
 184         return ret;
 185 }
 186 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
 187
 188 int phy_pm_runtime_put(struct phy *phy)
 189 {
 190         if (!phy)
 191                 return 0;
 192
 193         if (!pm_runtime_enabled(&phy->dev))
 194                 return -ENOTSUPP;
 195
 196         return pm_runtime_put(&phy->dev);
 197 }
 198 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
 199
 200 int phy_pm_runtime_put_sync(struct phy *phy)
 201 {
 202         if (!phy)
 203                 return 0;
 204
 205         if (!pm_runtime_enabled(&phy->dev))
 206                 return -ENOTSUPP;
 207
 208         return pm_runtime_put_sync(&phy->dev);
 209 }
 210 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
 211
 212 void phy_pm_runtime_allow(struct phy *phy)
 213 {
 214         if (!phy)
 215                 return;
 216
 217         if (!pm_runtime_enabled(&phy->dev))
 218                 return;
 219
 220         pm_runtime_allow(&phy->dev);
 221 }
 222 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
 223
 224 void phy_pm_runtime_forbid(struct phy *phy)
 225 {
 226         if (!phy)
 227                 return;
 228
 229         if (!pm_runtime_enabled(&phy->dev))
 230                 return;
 231
 232         pm_runtime_forbid(&phy->dev);
 233 }
 234 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
 235
 236 int phy_init(struct phy *phy)
 237 {
 238         int ret;
 239
 240         if (!phy)
 241                 return 0;
 242
 243         ret = phy_pm_runtime_get_sync(phy);
 244         if (ret < 0 && ret != -ENOTSUPP)
 245                 return ret;
 246         ret = 0; /* Override possible ret == -ENOTSUPP */
 247
 248         mutex_lock(&phy->mutex);
 249         if (phy->init_count == 0 && phy->ops->init) {
 250                 ret = phy->ops->init(phy);
 251                 if (ret < 0) {
 252                         dev_err(&phy->dev, "phy init failed --> %d\n", ret);
 253                         goto out;
 254                 }
 255         }
 256         ++phy->init_count;
 257
 258 out:
 259         mutex_unlock(&phy->mutex);
 260         phy_pm_runtime_put(phy);
 261         return ret;
 262 }
 263 EXPORT_SYMBOL_GPL(phy_init);
 264
 265 int phy_exit(struct phy *phy)
 266 {
 267         int ret;
 268
 269         if (!phy)
 270                 return 0;
 271
 272         ret = phy_pm_runtime_get_sync(phy);
 273         if (ret < 0 && ret != -ENOTSUPP)
 274                 return ret;
 275         ret = 0; /* Override possible ret == -ENOTSUPP */
 276
 277         mutex_lock(&phy->mutex);
 278         if (phy->init_count == 1 && phy->ops->exit) {
 279                 ret = phy->ops->exit(phy);
 280                 if (ret < 0) {
 281                         dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
 282                         goto out;
 283                 }
 284         }
 285         --phy->init_count;
 286
 287 out:
 288         mutex_unlock(&phy->mutex);
 289         phy_pm_runtime_put(phy);
 290         return ret;
 291 }
 292 EXPORT_SYMBOL_GPL(phy_exit);
 293
 294 int phy_power_on(struct phy *phy)
 295 {
 296         int ret = 0;
 297
 298         if (!phy)
 299                 goto out;
 300
 301         if (phy->pwr) {
 302                 ret = regulator_enable(phy->pwr);
 303                 if (ret)
 304                         goto out;
 305         }
 306
 307         ret = phy_pm_runtime_get_sync(phy);
 308         if (ret < 0 && ret != -ENOTSUPP)
 309                 goto err_pm_sync;
 310
 311         ret = 0; /* Override possible ret == -ENOTSUPP */
 312
 313         mutex_lock(&phy->mutex);
 314         if (phy->power_count == 0 && phy->ops->power_on) {
 315                 ret = phy->ops->power_on(phy);
 316                 if (ret < 0) {
 317                         dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
 318                         goto err_pwr_on;
 319                 }
 320         }
 321         ++phy->power_count;
 322         mutex_unlock(&phy->mutex);
 323         return 0;
 324
 325 err_pwr_on:
 326         mutex_unlock(&phy->mutex);
 327         phy_pm_runtime_put_sync(phy);
 328 err_pm_sync:
 329         if (phy->pwr)
 330                 regulator_disable(phy->pwr);
 331 out:
 332         return ret;
 333 }
 334 EXPORT_SYMBOL_GPL(phy_power_on);
 335
 336 int phy_power_off(struct phy *phy)
 337 {
 338         int ret;
 339
 340         if (!phy)
 341                 return 0;
 342
 343         mutex_lock(&phy->mutex);
 344         if (phy->power_count == 1 && phy->ops->power_off) {
 345                 ret =  phy->ops->power_off(phy);
 346                 if (ret < 0) {
 347                         dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
 348                         mutex_unlock(&phy->mutex);
 349                         return ret;
 350                 }
 351         }
 352         --phy->power_count;
 353         mutex_unlock(&phy->mutex);
 354         phy_pm_runtime_put(phy);
 355
 356         if (phy->pwr)
 357                 regulator_disable(phy->pwr);
 358
 359         return 0;
 360 }
 361 EXPORT_SYMBOL_GPL(phy_power_off);
 362
 363 int phy_set_mode(struct phy *phy, enum phy_mode mode)
 364 {
 365         int ret;
 366
 367         if (!phy || !phy->ops->set_mode)
 368                 return 0;
 369
 370         mutex_lock(&phy->mutex);
 371         ret = phy->ops->set_mode(phy, mode);
 372         if (!ret)
 373                 phy->attrs.mode = mode;
 374         mutex_unlock(&phy->mutex);
 375
 376         return ret;
 377 }
 378 EXPORT_SYMBOL_GPL(phy_set_mode);
 379
 380 int phy_reset(struct phy *phy)
 381 {
 382         int ret;
 383
 384         if (!phy || !phy->ops->reset)
 385                 return 0;
 386
 387         mutex_lock(&phy->mutex);
 388         ret = phy->ops->reset(phy);
 389         mutex_unlock(&phy->mutex);
 390
 391         return ret;
 392 }
 393 EXPORT_SYMBOL_GPL(phy_reset);
 394
 395 int phy_calibrate(struct phy *phy)
 396 {
 397         int ret;
 398
 399         if (!phy || !phy->ops->calibrate)
 400                 return 0;
 401
 402         mutex_lock(&phy->mutex);
 403         ret = phy->ops->calibrate(phy);
 404         mutex_unlock(&phy->mutex);
 405
 406         return ret;
 407 }
 408 EXPORT_SYMBOL_GPL(phy_calibrate);
 409
 410 /**
 411  * _of_phy_get() - lookup and obtain a reference to a phy by phandle
 412  * @np: device_node for which to get the phy
 413  * @index: the index of the phy
 414  *
 415  * Returns the phy associated with the given phandle value,
 416  * after getting a refcount to it or -ENODEV if there is no such phy or
 417  * -EPROBE_DEFER if there is a phandle to the phy, but the device is
 418  * not yet loaded. This function uses of_xlate call back function provided
 419  * while registering the phy_provider to find the phy instance.
 420  */
 421 static struct phy *_of_phy_get(struct device_node *np, int index)
 422 {
 423         int ret;
 424         struct phy_provider *phy_provider;
 425         struct phy *phy = NULL;
 426         struct of_phandle_args args;
 427
 428         ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
 429                 index, &args);
 430         if (ret)
 431                 return ERR_PTR(-ENODEV);
 432
 433         /* This phy type handled by the usb-phy subsystem for now */
 434         if (of_device_is_compatible(args.np, "usb-nop-xceiv"))
 435                 return ERR_PTR(-ENODEV);
 436
 437         mutex_lock(&phy_provider_mutex);
 438         phy_provider = of_phy_provider_lookup(args.np);
 439         if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
 440                 phy = ERR_PTR(-EPROBE_DEFER);
 441                 goto out_unlock;
 442         }
 443
 444         if (!of_device_is_available(args.np)) {
 445                 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
 446                 phy = ERR_PTR(-ENODEV);
 447                 goto out_put_module;
 448         }
 449
 450         phy = phy_provider->of_xlate(phy_provider->dev, &args);
 451
 452 out_put_module:
 453         module_put(phy_provider->owner);
 454
 455 out_unlock:
 456         mutex_unlock(&phy_provider_mutex);
 457         of_node_put(args.np);
 458
 459         return phy;
 460 }
 461
 462 /**
 463  * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
 464  * @np: device_node for which to get the phy
 465  * @con_id: name of the phy from device's point of view
 466  *
 467  * Returns the phy driver, after getting a refcount to it; or
 468  * -ENODEV if there is no such phy. The caller is responsible for
 469  * calling phy_put() to release that count.
 470  */
 471 struct phy *of_phy_get(struct device_node *np, const char *con_id)
 472 {
 473         struct phy *phy = NULL;
 474         int index = 0;
 475
 476         if (con_id)
 477                 index = of_property_match_string(np, "phy-names", con_id);
 478
 479         phy = _of_phy_get(np, index);
 480         if (IS_ERR(phy))
 481                 return phy;
 482
 483         if (!try_module_get(phy->ops->owner))
 484                 return ERR_PTR(-EPROBE_DEFER);
 485
 486         get_device(&phy->dev);
 487
 488         return phy;
 489 }
 490 EXPORT_SYMBOL_GPL(of_phy_get);
 491
 492 /**
 493  * phy_put() - release the PHY
 494  * @phy: the phy returned by phy_get()
 495  *
 496  * Releases a refcount the caller received from phy_get().
 497  */
 498 void phy_put(struct phy *phy)
 499 {
 500         if (!phy || IS_ERR(phy))
 501                 return;
 502
 503         module_put(phy->ops->owner);
 504         put_device(&phy->dev);
 505 }
 506 EXPORT_SYMBOL_GPL(phy_put);
 507
 508 /**
 509  * devm_phy_put() - release the PHY
 510  * @dev: device that wants to release this phy
 511  * @phy: the phy returned by devm_phy_get()
 512  *
 513  * destroys the devres associated with this phy and invokes phy_put
 514  * to release the phy.
 515  */
 516 void devm_phy_put(struct device *dev, struct phy *phy)
 517 {
 518         int r;
 519
 520         if (!phy)
 521                 return;
 522
 523         r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
 524         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 525 }
 526 EXPORT_SYMBOL_GPL(devm_phy_put);
 527
 528 /**
 529  * of_phy_simple_xlate() - returns the phy instance from phy provider
 530  * @dev: the PHY provider device
 531  * @args: of_phandle_args (not used here)
 532  *
 533  * Intended to be used by phy provider for the common case where #phy-cells is
 534  * 0. For other cases where #phy-cells is greater than '0', the phy provider
 535  * should provide a custom of_xlate function that reads the *args* and returns
 536  * the appropriate phy.
 537  */
 538 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
 539         *args)
 540 {
 541         struct phy *phy;
 542         struct class_dev_iter iter;
 543
 544         class_dev_iter_init(&iter, phy_class, NULL, NULL);
 545         while ((dev = class_dev_iter_next(&iter))) {
 546                 phy = to_phy(dev);
 547                 if (args->np != phy->dev.of_node)
 548                         continue;
 549
 550                 class_dev_iter_exit(&iter);
 551                 return phy;
 552         }
 553
 554         class_dev_iter_exit(&iter);
 555         return ERR_PTR(-ENODEV);
 556 }
 557 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
 558
 559 /**
 560  * phy_get() - lookup and obtain a reference to a phy.
 561  * @dev: device that requests this phy
 562  * @string: the phy name as given in the dt data or the name of the controller
 563  * port for non-dt case
 564  *
 565  * Returns the phy driver, after getting a refcount to it; or
 566  * -ENODEV if there is no such phy.  The caller is responsible for
 567  * calling phy_put() to release that count.
 568  */
 569 struct phy *phy_get(struct device *dev, const char *string)
 570 {
 571         int index = 0;
 572         struct phy *phy;
 573
 574         if (string == NULL) {
 575                 dev_WARN(dev, "missing string\n");
 576                 return ERR_PTR(-EINVAL);
 577         }
 578
 579         if (dev->of_node) {
 580                 index = of_property_match_string(dev->of_node, "phy-names",
 581                         string);
 582                 phy = _of_phy_get(dev->of_node, index);
 583         } else {
 584                 phy = phy_find(dev, string);
 585         }
 586         if (IS_ERR(phy))
 587                 return phy;
 588
 589         if (!try_module_get(phy->ops->owner))
 590                 return ERR_PTR(-EPROBE_DEFER);
 591
 592         get_device(&phy->dev);
 593
 594         return phy;
 595 }
 596 EXPORT_SYMBOL_GPL(phy_get);
 597
 598 /**
 599  * phy_optional_get() - lookup and obtain a reference to an optional phy.
 600  * @dev: device that requests this phy
 601  * @string: the phy name as given in the dt data or the name of the controller
 602  * port for non-dt case
 603  *
 604  * Returns the phy driver, after getting a refcount to it; or
 605  * NULL if there is no such phy.  The caller is responsible for
 606  * calling phy_put() to release that count.
 607  */
 608 struct phy *phy_optional_get(struct device *dev, const char *string)
 609 {
 610         struct phy *phy = phy_get(dev, string);
 611
 612         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 613                 phy = NULL;
 614
 615         return phy;
 616 }
 617 EXPORT_SYMBOL_GPL(phy_optional_get);
 618
 619 /**
 620  * devm_phy_get() - lookup and obtain a reference to a phy.
 621  * @dev: device that requests this phy
 622  * @string: the phy name as given in the dt data or phy device name
 623  * for non-dt case
 624  *
 625  * Gets the phy using phy_get(), and associates a device with it using
 626  * devres. On driver detach, release function is invoked on the devres data,
 627  * then, devres data is freed.
 628  */
 629 struct phy *devm_phy_get(struct device *dev, const char *string)
 630 {
 631         struct phy **ptr, *phy;
 632
 633         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 634         if (!ptr)
 635                 return ERR_PTR(-ENOMEM);
 636
 637         phy = phy_get(dev, string);
 638         if (!IS_ERR(phy)) {
 639                 *ptr = phy;
 640                 devres_add(dev, ptr);
 641         } else {
 642                 devres_free(ptr);
 643         }
 644
 645         return phy;
 646 }
 647 EXPORT_SYMBOL_GPL(devm_phy_get);
 648
 649 /**
 650  * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
 651  * @dev: device that requests this phy
 652  * @string: the phy name as given in the dt data or phy device name
 653  * for non-dt case
 654  *
 655  * Gets the phy using phy_get(), and associates a device with it using
 656  * devres. On driver detach, release function is invoked on the devres
 657  * data, then, devres data is freed. This differs to devm_phy_get() in
 658  * that if the phy does not exist, it is not considered an error and
 659  * -ENODEV will not be returned. Instead the NULL phy is returned,
 660  * which can be passed to all other phy consumer calls.
 661  */
 662 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
 663 {
 664         struct phy *phy = devm_phy_get(dev, string);
 665
 666         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 667                 phy = NULL;
 668
 669         return phy;
 670 }
 671 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
 672
 673 /**
 674  * devm_of_phy_get() - lookup and obtain a reference to a phy.
 675  * @dev: device that requests this phy
 676  * @np: node containing the phy
 677  * @con_id: name of the phy from device's point of view
 678  *
 679  * Gets the phy using of_phy_get(), and associates a device with it using
 680  * devres. On driver detach, release function is invoked on the devres data,
 681  * then, devres data is freed.
 682  */
 683 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
 684                             const char *con_id)
 685 {
 686         struct phy **ptr, *phy;
 687
 688         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 689         if (!ptr)
 690                 return ERR_PTR(-ENOMEM);
 691
 692         phy = of_phy_get(np, con_id);
 693         if (!IS_ERR(phy)) {
 694                 *ptr = phy;
 695                 devres_add(dev, ptr);
 696         } else {
 697                 devres_free(ptr);
 698         }
 699
 700         return phy;
 701 }
 702 EXPORT_SYMBOL_GPL(devm_of_phy_get);
 703
 704 /**
 705  * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
 706  * @dev: device that requests this phy
 707  * @np: node containing the phy
 708  * @index: index of the phy
 709  *
 710  * Gets the phy using _of_phy_get(), then gets a refcount to it,
 711  * and associates a device with it using devres. On driver detach,
 712  * release function is invoked on the devres data,
 713  * then, devres data is freed.
 714  *
 715  */
 716 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
 717                                      int index)
 718 {
 719         struct phy **ptr, *phy;
 720
 721         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 722         if (!ptr)
 723                 return ERR_PTR(-ENOMEM);
 724
 725         phy = _of_phy_get(np, index);
 726         if (IS_ERR(phy)) {
 727                 devres_free(ptr);
 728                 return phy;
 729         }
 730
 731         if (!try_module_get(phy->ops->owner)) {
 732                 devres_free(ptr);
 733                 return ERR_PTR(-EPROBE_DEFER);
 734         }
 735
 736         get_device(&phy->dev);
 737
 738         *ptr = phy;
 739         devres_add(dev, ptr);
 740
 741         return phy;
 742 }
 743 EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
 744
 745 /**
 746  * phy_create() - create a new phy
 747  * @dev: device that is creating the new phy
 748  * @node: device node of the phy
 749  * @ops: function pointers for performing phy operations
 750  *
 751  * Called to create a phy using phy framework.
 752  */
 753 struct phy *phy_create(struct device *dev, struct device_node *node,
 754                        const struct phy_ops *ops)
 755 {
 756         int ret;
 757         int id;
 758         struct phy *phy;
 759
 760         if (WARN_ON(!dev))
 761                 return ERR_PTR(-EINVAL);
 762
 763         phy = kzalloc(sizeof(*phy), GFP_KERNEL);
 764         if (!phy)
 765                 return ERR_PTR(-ENOMEM);
 766
 767         id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
 768         if (id < 0) {
 769                 dev_err(dev, "unable to get id\n");
 770                 ret = id;
 771                 goto free_phy;
 772         }
 773
 774         device_initialize(&phy->dev);
 775         mutex_init(&phy->mutex);
 776
 777         phy->dev.class = phy_class;
 778         phy->dev.parent = dev;
 779         phy->dev.of_node = node ?: dev->of_node;
 780         phy->id = id;
 781         phy->ops = ops;
 782
 783         ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
 784         if (ret)
 785                 goto put_dev;
 786
 787         /* phy-supply */
 788         phy->pwr = regulator_get_optional(&phy->dev, "phy");
 789         if (IS_ERR(phy->pwr)) {
 790                 ret = PTR_ERR(phy->pwr);
 791                 if (ret == -EPROBE_DEFER)
 792                         goto put_dev;
 793
 794                 phy->pwr = NULL;
 795         }
 796
 797         ret = device_add(&phy->dev);
 798         if (ret)
 799                 goto put_dev;
 800
 801         if (pm_runtime_enabled(dev)) {
 802                 pm_runtime_enable(&phy->dev);
 803                 pm_runtime_no_callbacks(&phy->dev);
 804         }
 805
 806         return phy;
 807
 808 put_dev:
 809         put_device(&phy->dev);  /* calls phy_release() which frees resources */
 810         return ERR_PTR(ret);
 811
 812 free_phy:
 813         kfree(phy);
 814         return ERR_PTR(ret);
 815 }
 816 EXPORT_SYMBOL_GPL(phy_create);
 817
 818 /**
 819  * devm_phy_create() - create a new phy
 820  * @dev: device that is creating the new phy
 821  * @node: device node of the phy
 822  * @ops: function pointers for performing phy operations
 823  *
 824  * Creates a new PHY device adding it to the PHY class.
 825  * While at that, it also associates the device with the phy using devres.
 826  * On driver detach, release function is invoked on the devres data,
 827  * then, devres data is freed.
 828  */
 829 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
 830                             const struct phy_ops *ops)
 831 {
 832         struct phy **ptr, *phy;
 833
 834         ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
 835         if (!ptr)
 836                 return ERR_PTR(-ENOMEM);
 837
 838         phy = phy_create(dev, node, ops);
 839         if (!IS_ERR(phy)) {
 840                 *ptr = phy;
 841                 devres_add(dev, ptr);
 842         } else {
 843                 devres_free(ptr);
 844         }
 845
 846         return phy;
 847 }
 848 EXPORT_SYMBOL_GPL(devm_phy_create);
 849
 850 /**
 851  * phy_destroy() - destroy the phy
 852  * @phy: the phy to be destroyed
 853  *
 854  * Called to destroy the phy.
 855  */
 856 void phy_destroy(struct phy *phy)
 857 {
 858         pm_runtime_disable(&phy->dev);
 859         device_unregister(&phy->dev);
 860 }
 861 EXPORT_SYMBOL_GPL(phy_destroy);
 862
 863 /**
 864  * devm_phy_destroy() - destroy the PHY
 865  * @dev: device that wants to release this phy
 866  * @phy: the phy returned by devm_phy_get()
 867  *
 868  * destroys the devres associated with this phy and invokes phy_destroy
 869  * to destroy the phy.
 870  */
 871 void devm_phy_destroy(struct device *dev, struct phy *phy)
 872 {
 873         int r;
 874
 875         r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
 876         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 877 }
 878 EXPORT_SYMBOL_GPL(devm_phy_destroy);
 879
 880 /**
 881  * __of_phy_provider_register() - create/register phy provider with the framework
 882  * @dev: struct device of the phy provider
 883  * @children: device node containing children (if different from dev->of_node)
 884  * @owner: the module owner containing of_xlate
 885  * @of_xlate: function pointer to obtain phy instance from phy provider
 886  *
 887  * Creates struct phy_provider from dev and of_xlate function pointer.
 888  * This is used in the case of dt boot for finding the phy instance from
 889  * phy provider.
 890  *
 891  * If the PHY provider doesn't nest children directly but uses a separate
 892  * child node to contain the individual children, the @children parameter
 893  * can be used to override the default. If NULL, the default (dev->of_node)
 894  * will be used. If non-NULL, the device node must be a child (or further
 895  * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL
 896  * error code is returned.
 897  */
 898 struct phy_provider *__of_phy_provider_register(struct device *dev,
 899         struct device_node *children, struct module *owner,
 900         struct phy * (*of_xlate)(struct device *dev,
 901                                  struct of_phandle_args *args))
 902 {
 903         struct phy_provider *phy_provider;
 904
 905         /*
 906          * If specified, the device node containing the children must itself
 907          * be the provider's device node or a child (or further descendant)
 908          * thereof.
 909          */
 910         if (children) {
 911                 struct device_node *parent = of_node_get(children), *next;
 912
 913                 while (parent) {
 914                         if (parent == dev->of_node)
 915                                 break;
 916
 917                         next = of_get_parent(parent);
 918                         of_node_put(parent);
 919                         parent = next;
 920                 }
 921
 922                 if (!parent)
 923                         return ERR_PTR(-EINVAL);
 924
 925                 of_node_put(parent);
 926         } else {
 927                 children = dev->of_node;
 928         }
 929
 930         phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
 931         if (!phy_provider)
 932                 return ERR_PTR(-ENOMEM);
 933
 934         phy_provider->dev = dev;
 935         phy_provider->children = of_node_get(children);
 936         phy_provider->owner = owner;
 937         phy_provider->of_xlate = of_xlate;
 938
 939         mutex_lock(&phy_provider_mutex);
 940         list_add_tail(&phy_provider->list, &phy_provider_list);
 941         mutex_unlock(&phy_provider_mutex);
 942
 943         return phy_provider;
 944 }
 945 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
 946
 947 /**
 948  * __devm_of_phy_provider_register() - create/register phy provider with the
 949  * framework
 950  * @dev: struct device of the phy provider
 951  * @owner: the module owner containing of_xlate
 952  * @of_xlate: function pointer to obtain phy instance from phy provider
 953  *
 954  * Creates struct phy_provider from dev and of_xlate function pointer.
 955  * This is used in the case of dt boot for finding the phy instance from
 956  * phy provider. While at that, it also associates the device with the
 957  * phy provider using devres. On driver detach, release function is invoked
 958  * on the devres data, then, devres data is freed.
 959  */
 960 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 961         struct device_node *children, struct module *owner,
 962         struct phy * (*of_xlate)(struct device *dev,
 963                                  struct of_phandle_args *args))
 964 {
 965         struct phy_provider **ptr, *phy_provider;
 966
 967         ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
 968         if (!ptr)
 969                 return ERR_PTR(-ENOMEM);
 970
 971         phy_provider = __of_phy_provider_register(dev, children, owner,
 972                                                   of_xlate);
 973         if (!IS_ERR(phy_provider)) {
 974                 *ptr = phy_provider;
 975                 devres_add(dev, ptr);
 976         } else {
 977                 devres_free(ptr);
 978         }
 979
 980         return phy_provider;
 981 }
 982 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
 983
 984 /**
 985  * of_phy_provider_unregister() - unregister phy provider from the framework
 986  * @phy_provider: phy provider returned by of_phy_provider_register()
 987  *
 988  * Removes the phy_provider created using of_phy_provider_register().
 989  */
 990 void of_phy_provider_unregister(struct phy_provider *phy_provider)
 991 {
 992         if (IS_ERR(phy_provider))
 993                 return;
 994
 995         mutex_lock(&phy_provider_mutex);
 996         list_del(&phy_provider->list);
 997         of_node_put(phy_provider->children);
 998         kfree(phy_provider);
 999         mutex_unlock(&phy_provider_mutex);
1000 }
1001 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
1002
1003 /**
1004  * devm_of_phy_provider_unregister() - remove phy provider from the framework
1005  * @dev: struct device of the phy provider
1006  *
1007  * destroys the devres associated with this phy provider and invokes
1008  * of_phy_provider_unregister to unregister the phy provider.
1009  */
1010 void devm_of_phy_provider_unregister(struct device *dev,
1011         struct phy_provider *phy_provider) {
1012         int r;
1013
1014         r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
1015                 phy_provider);
1016         dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
1017 }
1018 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
1019
1020 /**
1021  * phy_release() - release the phy
1022  * @dev: the dev member within phy
1023  *
1024  * When the last reference to the device is removed, it is called
1025  * from the embedded kobject as release method.
1026  */
1027 static void phy_release(struct device *dev)
1028 {
1029         struct phy *phy;
1030
1031         phy = to_phy(dev);
1032         dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
1033         regulator_put(phy->pwr);
1034         ida_simple_remove(&phy_ida, phy->id);
1035         kfree(phy);
1036 }
1037
1038 static int __init phy_core_init(void)
1039 {
1040         phy_class = class_create(THIS_MODULE, "phy");
1041         if (IS_ERR(phy_class)) {
1042                 pr_err("failed to create phy class --> %ld\n",
1043                         PTR_ERR(phy_class));
1044                 return PTR_ERR(phy_class);
1045         }
1046
1047         phy_class->dev_release = phy_release;
1048
1049         return 0;
1050 }
1051 module_init(phy_core_init);
1052
1053 static void __exit phy_core_exit(void)
1054 {
1055         class_destroy(phy_class);
1056 }
1057 module_exit(phy_core_exit);
1058
1059 MODULE_DESCRIPTION("Generic PHY Framework");
1060 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
1061 MODULE_LICENSE("GPL v2");