kernel/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->dev->of_node, 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 (!pm_runtime_enabled(&phy->dev))
 157                 return -ENOTSUPP;
 158
 159         ret = pm_runtime_get(&phy->dev);
 160         if (ret < 0 && ret != -EINPROGRESS)
 161                 pm_runtime_put_noidle(&phy->dev);
 162
 163         return ret;
 164 }
 165 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
 166
 167 int phy_pm_runtime_get_sync(struct phy *phy)
 168 {
 169         int ret;
 170
 171         if (!pm_runtime_enabled(&phy->dev))
 172                 return -ENOTSUPP;
 173
 174         ret = pm_runtime_get_sync(&phy->dev);
 175         if (ret < 0)
 176                 pm_runtime_put_sync(&phy->dev);
 177
 178         return ret;
 179 }
 180 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
 181
 182 int phy_pm_runtime_put(struct phy *phy)
 183 {
 184         if (!pm_runtime_enabled(&phy->dev))
 185                 return -ENOTSUPP;
 186
 187         return pm_runtime_put(&phy->dev);
 188 }
 189 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
 190
 191 int phy_pm_runtime_put_sync(struct phy *phy)
 192 {
 193         if (!pm_runtime_enabled(&phy->dev))
 194                 return -ENOTSUPP;
 195
 196         return pm_runtime_put_sync(&phy->dev);
 197 }
 198 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
 199
 200 void phy_pm_runtime_allow(struct phy *phy)
 201 {
 202         if (!pm_runtime_enabled(&phy->dev))
 203                 return;
 204
 205         pm_runtime_allow(&phy->dev);
 206 }
 207 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
 208
 209 void phy_pm_runtime_forbid(struct phy *phy)
 210 {
 211         if (!pm_runtime_enabled(&phy->dev))
 212                 return;
 213
 214         pm_runtime_forbid(&phy->dev);
 215 }
 216 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
 217
 218 int phy_init(struct phy *phy)
 219 {
 220         int ret;
 221
 222         if (!phy)
 223                 return 0;
 224
 225         ret = phy_pm_runtime_get_sync(phy);
 226         if (ret < 0 && ret != -ENOTSUPP)
 227                 return ret;
 228         ret = 0; /* Override possible ret == -ENOTSUPP */
 229
 230         mutex_lock(&phy->mutex);
 231         if (phy->init_count == 0 && phy->ops->init) {
 232                 ret = phy->ops->init(phy);
 233                 if (ret < 0) {
 234                         dev_err(&phy->dev, "phy init failed --> %d\n", ret);
 235                         goto out;
 236                 }
 237         }
 238         ++phy->init_count;
 239
 240 out:
 241         mutex_unlock(&phy->mutex);
 242         phy_pm_runtime_put(phy);
 243         return ret;
 244 }
 245 EXPORT_SYMBOL_GPL(phy_init);
 246
 247 int phy_exit(struct phy *phy)
 248 {
 249         int ret;
 250
 251         if (!phy)
 252                 return 0;
 253
 254         ret = phy_pm_runtime_get_sync(phy);
 255         if (ret < 0 && ret != -ENOTSUPP)
 256                 return ret;
 257         ret = 0; /* Override possible ret == -ENOTSUPP */
 258
 259         mutex_lock(&phy->mutex);
 260         if (phy->init_count == 1 && phy->ops->exit) {
 261                 ret = phy->ops->exit(phy);
 262                 if (ret < 0) {
 263                         dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
 264                         goto out;
 265                 }
 266         }
 267         --phy->init_count;
 268
 269 out:
 270         mutex_unlock(&phy->mutex);
 271         phy_pm_runtime_put(phy);
 272         return ret;
 273 }
 274 EXPORT_SYMBOL_GPL(phy_exit);
 275
 276 int phy_power_on(struct phy *phy)
 277 {
 278         int ret = 0;
 279
 280         if (!phy)
 281                 goto out;
 282
 283         if (phy->pwr) {
 284                 ret = regulator_enable(phy->pwr);
 285                 if (ret)
 286                         goto out;
 287         }
 288
 289         ret = phy_pm_runtime_get_sync(phy);
 290         if (ret < 0 && ret != -ENOTSUPP)
 291                 goto err_pm_sync;
 292
 293         ret = 0; /* Override possible ret == -ENOTSUPP */
 294
 295         mutex_lock(&phy->mutex);
 296         if (phy->power_count == 0 && phy->ops->power_on) {
 297                 ret = phy->ops->power_on(phy);
 298                 if (ret < 0) {
 299                         dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
 300                         goto err_pwr_on;
 301                 }
 302         }
 303         ++phy->power_count;
 304         mutex_unlock(&phy->mutex);
 305         return 0;
 306
 307 err_pwr_on:
 308         mutex_unlock(&phy->mutex);
 309         phy_pm_runtime_put_sync(phy);
 310 err_pm_sync:
 311         if (phy->pwr)
 312                 regulator_disable(phy->pwr);
 313 out:
 314         return ret;
 315 }
 316 EXPORT_SYMBOL_GPL(phy_power_on);
 317
 318 int phy_power_off(struct phy *phy)
 319 {
 320         int ret;
 321
 322         if (!phy)
 323                 return 0;
 324
 325         mutex_lock(&phy->mutex);
 326         if (phy->power_count == 1 && phy->ops->power_off) {
 327                 ret =  phy->ops->power_off(phy);
 328                 if (ret < 0) {
 329                         dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
 330                         mutex_unlock(&phy->mutex);
 331                         return ret;
 332                 }
 333         }
 334         --phy->power_count;
 335         mutex_unlock(&phy->mutex);
 336         phy_pm_runtime_put(phy);
 337
 338         if (phy->pwr)
 339                 regulator_disable(phy->pwr);
 340
 341         return 0;
 342 }
 343 EXPORT_SYMBOL_GPL(phy_power_off);
 344
 345 /**
 346  * _of_phy_get() - lookup and obtain a reference to a phy by phandle
 347  * @np: device_node for which to get the phy
 348  * @index: the index of the phy
 349  *
 350  * Returns the phy associated with the given phandle value,
 351  * after getting a refcount to it or -ENODEV if there is no such phy or
 352  * -EPROBE_DEFER if there is a phandle to the phy, but the device is
 353  * not yet loaded. This function uses of_xlate call back function provided
 354  * while registering the phy_provider to find the phy instance.
 355  */
 356 static struct phy *_of_phy_get(struct device_node *np, int index)
 357 {
 358         int ret;
 359         struct phy_provider *phy_provider;
 360         struct phy *phy = NULL;
 361         struct of_phandle_args args;
 362
 363         ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
 364                 index, &args);
 365         if (ret)
 366                 return ERR_PTR(-ENODEV);
 367
 368         mutex_lock(&phy_provider_mutex);
 369         phy_provider = of_phy_provider_lookup(args.np);
 370         if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
 371                 phy = ERR_PTR(-EPROBE_DEFER);
 372                 goto out_unlock;
 373         }
 374
 375         if (!of_device_is_available(args.np)) {
 376                 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
 377                 phy = ERR_PTR(-ENODEV);
 378                 goto out_put_module;
 379         }
 380
 381         phy = phy_provider->of_xlate(phy_provider->dev, &args);
 382
 383 out_put_module:
 384         module_put(phy_provider->owner);
 385
 386 out_unlock:
 387         mutex_unlock(&phy_provider_mutex);
 388         of_node_put(args.np);
 389
 390         return phy;
 391 }
 392
 393 /**
 394  * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
 395  * @np: device_node for which to get the phy
 396  * @con_id: name of the phy from device's point of view
 397  *
 398  * Returns the phy driver, after getting a refcount to it; or
 399  * -ENODEV if there is no such phy. The caller is responsible for
 400  * calling phy_put() to release that count.
 401  */
 402 struct phy *of_phy_get(struct device_node *np, const char *con_id)
 403 {
 404         struct phy *phy = NULL;
 405         int index = 0;
 406
 407         if (con_id)
 408                 index = of_property_match_string(np, "phy-names", con_id);
 409
 410         phy = _of_phy_get(np, index);
 411         if (IS_ERR(phy))
 412                 return phy;
 413
 414         if (!try_module_get(phy->ops->owner))
 415                 return ERR_PTR(-EPROBE_DEFER);
 416
 417         get_device(&phy->dev);
 418
 419         return phy;
 420 }
 421 EXPORT_SYMBOL_GPL(of_phy_get);
 422
 423 /**
 424  * phy_put() - release the PHY
 425  * @phy: the phy returned by phy_get()
 426  *
 427  * Releases a refcount the caller received from phy_get().
 428  */
 429 void phy_put(struct phy *phy)
 430 {
 431         if (!phy || IS_ERR(phy))
 432                 return;
 433
 434         module_put(phy->ops->owner);
 435         put_device(&phy->dev);
 436 }
 437 EXPORT_SYMBOL_GPL(phy_put);
 438
 439 /**
 440  * devm_phy_put() - release the PHY
 441  * @dev: device that wants to release this phy
 442  * @phy: the phy returned by devm_phy_get()
 443  *
 444  * destroys the devres associated with this phy and invokes phy_put
 445  * to release the phy.
 446  */
 447 void devm_phy_put(struct device *dev, struct phy *phy)
 448 {
 449         int r;
 450
 451         if (!phy)
 452                 return;
 453
 454         r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
 455         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 456 }
 457 EXPORT_SYMBOL_GPL(devm_phy_put);
 458
 459 /**
 460  * of_phy_simple_xlate() - returns the phy instance from phy provider
 461  * @dev: the PHY provider device
 462  * @args: of_phandle_args (not used here)
 463  *
 464  * Intended to be used by phy provider for the common case where #phy-cells is
 465  * 0. For other cases where #phy-cells is greater than '0', the phy provider
 466  * should provide a custom of_xlate function that reads the *args* and returns
 467  * the appropriate phy.
 468  */
 469 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
 470         *args)
 471 {
 472         struct phy *phy;
 473         struct class_dev_iter iter;
 474
 475         class_dev_iter_init(&iter, phy_class, NULL, NULL);
 476         while ((dev = class_dev_iter_next(&iter))) {
 477                 phy = to_phy(dev);
 478                 if (args->np != phy->dev.of_node)
 479                         continue;
 480
 481                 class_dev_iter_exit(&iter);
 482                 return phy;
 483         }
 484
 485         class_dev_iter_exit(&iter);
 486         return ERR_PTR(-ENODEV);
 487 }
 488 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
 489
 490 /**
 491  * phy_get() - lookup and obtain a reference to a phy.
 492  * @dev: device that requests this phy
 493  * @string: the phy name as given in the dt data or the name of the controller
 494  * port for non-dt case
 495  *
 496  * Returns the phy driver, after getting a refcount to it; or
 497  * -ENODEV if there is no such phy.  The caller is responsible for
 498  * calling phy_put() to release that count.
 499  */
 500 struct phy *phy_get(struct device *dev, const char *string)
 501 {
 502         int index = 0;
 503         struct phy *phy;
 504
 505         if (string == NULL) {
 506                 dev_WARN(dev, "missing string\n");
 507                 return ERR_PTR(-EINVAL);
 508         }
 509
 510         if (dev->of_node) {
 511                 index = of_property_match_string(dev->of_node, "phy-names",
 512                         string);
 513                 phy = _of_phy_get(dev->of_node, index);
 514         } else {
 515                 phy = phy_find(dev, string);
 516         }
 517         if (IS_ERR(phy))
 518                 return phy;
 519
 520         if (!try_module_get(phy->ops->owner))
 521                 return ERR_PTR(-EPROBE_DEFER);
 522
 523         get_device(&phy->dev);
 524
 525         return phy;
 526 }
 527 EXPORT_SYMBOL_GPL(phy_get);
 528
 529 /**
 530  * phy_optional_get() - lookup and obtain a reference to an optional phy.
 531  * @dev: device that requests this phy
 532  * @string: the phy name as given in the dt data or the name of the controller
 533  * port for non-dt case
 534  *
 535  * Returns the phy driver, after getting a refcount to it; or
 536  * NULL if there is no such phy.  The caller is responsible for
 537  * calling phy_put() to release that count.
 538  */
 539 struct phy *phy_optional_get(struct device *dev, const char *string)
 540 {
 541         struct phy *phy = phy_get(dev, string);
 542
 543         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 544                 phy = NULL;
 545
 546         return phy;
 547 }
 548 EXPORT_SYMBOL_GPL(phy_optional_get);
 549
 550 /**
 551  * devm_phy_get() - lookup and obtain a reference to a phy.
 552  * @dev: device that requests this phy
 553  * @string: the phy name as given in the dt data or phy device name
 554  * for non-dt case
 555  *
 556  * Gets the phy using phy_get(), and associates a device with it using
 557  * devres. On driver detach, release function is invoked on the devres data,
 558  * then, devres data is freed.
 559  */
 560 struct phy *devm_phy_get(struct device *dev, const char *string)
 561 {
 562         struct phy **ptr, *phy;
 563
 564         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 565         if (!ptr)
 566                 return ERR_PTR(-ENOMEM);
 567
 568         phy = phy_get(dev, string);
 569         if (!IS_ERR(phy)) {
 570                 *ptr = phy;
 571                 devres_add(dev, ptr);
 572         } else {
 573                 devres_free(ptr);
 574         }
 575
 576         return phy;
 577 }
 578 EXPORT_SYMBOL_GPL(devm_phy_get);
 579
 580 /**
 581  * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
 582  * @dev: device that requests this phy
 583  * @string: the phy name as given in the dt data or phy device name
 584  * for non-dt case
 585  *
 586  * Gets the phy using phy_get(), and associates a device with it using
 587  * devres. On driver detach, release function is invoked on the devres
 588  * data, then, devres data is freed. This differs to devm_phy_get() in
 589  * that if the phy does not exist, it is not considered an error and
 590  * -ENODEV will not be returned. Instead the NULL phy is returned,
 591  * which can be passed to all other phy consumer calls.
 592  */
 593 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
 594 {
 595         struct phy *phy = devm_phy_get(dev, string);
 596
 597         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 598                 phy = NULL;
 599
 600         return phy;
 601 }
 602 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
 603
 604 /**
 605  * devm_of_phy_get() - lookup and obtain a reference to a phy.
 606  * @dev: device that requests this phy
 607  * @np: node containing the phy
 608  * @con_id: name of the phy from device's point of view
 609  *
 610  * Gets the phy using of_phy_get(), and associates a device with it using
 611  * devres. On driver detach, release function is invoked on the devres data,
 612  * then, devres data is freed.
 613  */
 614 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
 615                             const char *con_id)
 616 {
 617         struct phy **ptr, *phy;
 618
 619         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 620         if (!ptr)
 621                 return ERR_PTR(-ENOMEM);
 622
 623         phy = of_phy_get(np, con_id);
 624         if (!IS_ERR(phy)) {
 625                 *ptr = phy;
 626                 devres_add(dev, ptr);
 627         } else {
 628                 devres_free(ptr);
 629         }
 630
 631         return phy;
 632 }
 633 EXPORT_SYMBOL_GPL(devm_of_phy_get);
 634
 635 /**
 636  * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
 637  * @dev: device that requests this phy
 638  * @np: node containing the phy
 639  * @index: index of the phy
 640  *
 641  * Gets the phy using _of_phy_get(), then gets a refcount to it,
 642  * and associates a device with it using devres. On driver detach,
 643  * release function is invoked on the devres data,
 644  * then, devres data is freed.
 645  *
 646  */
 647 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
 648                                      int index)
 649 {
 650         struct phy **ptr, *phy;
 651
 652         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 653         if (!ptr)
 654                 return ERR_PTR(-ENOMEM);
 655
 656         phy = _of_phy_get(np, index);
 657         if (IS_ERR(phy)) {
 658                 devres_free(ptr);
 659                 return phy;
 660         }
 661
 662         if (!try_module_get(phy->ops->owner)) {
 663                 devres_free(ptr);
 664                 return ERR_PTR(-EPROBE_DEFER);
 665         }
 666
 667         get_device(&phy->dev);
 668
 669         *ptr = phy;
 670         devres_add(dev, ptr);
 671
 672         return phy;
 673 }
 674 EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
 675
 676 /**
 677  * phy_create() - create a new phy
 678  * @dev: device that is creating the new phy
 679  * @node: device node of the phy
 680  * @ops: function pointers for performing phy operations
 681  *
 682  * Called to create a phy using phy framework.
 683  */
 684 struct phy *phy_create(struct device *dev, struct device_node *node,
 685                        const struct phy_ops *ops)
 686 {
 687         int ret;
 688         int id;
 689         struct phy *phy;
 690
 691         if (WARN_ON(!dev))
 692                 return ERR_PTR(-EINVAL);
 693
 694         phy = kzalloc(sizeof(*phy), GFP_KERNEL);
 695         if (!phy)
 696                 return ERR_PTR(-ENOMEM);
 697
 698         id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
 699         if (id < 0) {
 700                 dev_err(dev, "unable to get id\n");
 701                 ret = id;
 702                 goto free_phy;
 703         }
 704
 705         device_initialize(&phy->dev);
 706         mutex_init(&phy->mutex);
 707
 708         phy->dev.class = phy_class;
 709         phy->dev.parent = dev;
 710         phy->dev.of_node = node ?: dev->of_node;
 711         phy->id = id;
 712         phy->ops = ops;
 713
 714         ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
 715         if (ret)
 716                 goto put_dev;
 717
 718         /* phy-supply */
 719         phy->pwr = regulator_get_optional(&phy->dev, "phy");
 720         if (IS_ERR(phy->pwr)) {
 721                 ret = PTR_ERR(phy->pwr);
 722                 if (ret == -EPROBE_DEFER)
 723                         goto put_dev;
 724
 725                 phy->pwr = NULL;
 726         }
 727
 728         ret = device_add(&phy->dev);
 729         if (ret)
 730                 goto put_dev;
 731
 732         if (pm_runtime_enabled(dev)) {
 733                 pm_runtime_enable(&phy->dev);
 734                 pm_runtime_no_callbacks(&phy->dev);
 735         }
 736
 737         return phy;
 738
 739 put_dev:
 740         put_device(&phy->dev);  /* calls phy_release() which frees resources */
 741         return ERR_PTR(ret);
 742
 743 free_phy:
 744         kfree(phy);
 745         return ERR_PTR(ret);
 746 }
 747 EXPORT_SYMBOL_GPL(phy_create);
 748
 749 /**
 750  * devm_phy_create() - create a new phy
 751  * @dev: device that is creating the new phy
 752  * @node: device node of the phy
 753  * @ops: function pointers for performing phy operations
 754  *
 755  * Creates a new PHY device adding it to the PHY class.
 756  * While at that, it also associates the device with the phy using devres.
 757  * On driver detach, release function is invoked on the devres data,
 758  * then, devres data is freed.
 759  */
 760 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
 761                             const struct phy_ops *ops)
 762 {
 763         struct phy **ptr, *phy;
 764
 765         ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
 766         if (!ptr)
 767                 return ERR_PTR(-ENOMEM);
 768
 769         phy = phy_create(dev, node, ops);
 770         if (!IS_ERR(phy)) {
 771                 *ptr = phy;
 772                 devres_add(dev, ptr);
 773         } else {
 774                 devres_free(ptr);
 775         }
 776
 777         return phy;
 778 }
 779 EXPORT_SYMBOL_GPL(devm_phy_create);
 780
 781 /**
 782  * phy_destroy() - destroy the phy
 783  * @phy: the phy to be destroyed
 784  *
 785  * Called to destroy the phy.
 786  */
 787 void phy_destroy(struct phy *phy)
 788 {
 789         pm_runtime_disable(&phy->dev);
 790         device_unregister(&phy->dev);
 791 }
 792 EXPORT_SYMBOL_GPL(phy_destroy);
 793
 794 /**
 795  * devm_phy_destroy() - destroy the PHY
 796  * @dev: device that wants to release this phy
 797  * @phy: the phy returned by devm_phy_get()
 798  *
 799  * destroys the devres associated with this phy and invokes phy_destroy
 800  * to destroy the phy.
 801  */
 802 void devm_phy_destroy(struct device *dev, struct phy *phy)
 803 {
 804         int r;
 805
 806         r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
 807         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 808 }
 809 EXPORT_SYMBOL_GPL(devm_phy_destroy);
 810
 811 /**
 812  * __of_phy_provider_register() - create/register phy provider with the framework
 813  * @dev: struct device of the phy provider
 814  * @owner: the module owner containing of_xlate
 815  * @of_xlate: function pointer to obtain phy instance from phy provider
 816  *
 817  * Creates struct phy_provider from dev and of_xlate function pointer.
 818  * This is used in the case of dt boot for finding the phy instance from
 819  * phy provider.
 820  */
 821 struct phy_provider *__of_phy_provider_register(struct device *dev,
 822         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 823         struct of_phandle_args *args))
 824 {
 825         struct phy_provider *phy_provider;
 826
 827         phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
 828         if (!phy_provider)
 829                 return ERR_PTR(-ENOMEM);
 830
 831         phy_provider->dev = dev;
 832         phy_provider->owner = owner;
 833         phy_provider->of_xlate = of_xlate;
 834
 835         mutex_lock(&phy_provider_mutex);
 836         list_add_tail(&phy_provider->list, &phy_provider_list);
 837         mutex_unlock(&phy_provider_mutex);
 838
 839         return phy_provider;
 840 }
 841 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
 842
 843 /**
 844  * __devm_of_phy_provider_register() - create/register phy provider with the
 845  * framework
 846  * @dev: struct device of the phy provider
 847  * @owner: the module owner containing of_xlate
 848  * @of_xlate: function pointer to obtain phy instance from phy provider
 849  *
 850  * Creates struct phy_provider from dev and of_xlate function pointer.
 851  * This is used in the case of dt boot for finding the phy instance from
 852  * phy provider. While at that, it also associates the device with the
 853  * phy provider using devres. On driver detach, release function is invoked
 854  * on the devres data, then, devres data is freed.
 855  */
 856 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 857         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 858         struct of_phandle_args *args))
 859 {
 860         struct phy_provider **ptr, *phy_provider;
 861
 862         ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
 863         if (!ptr)
 864                 return ERR_PTR(-ENOMEM);
 865
 866         phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
 867         if (!IS_ERR(phy_provider)) {
 868                 *ptr = phy_provider;
 869                 devres_add(dev, ptr);
 870         } else {
 871                 devres_free(ptr);
 872         }
 873
 874         return phy_provider;
 875 }
 876 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
 877
 878 /**
 879  * of_phy_provider_unregister() - unregister phy provider from the framework
 880  * @phy_provider: phy provider returned by of_phy_provider_register()
 881  *
 882  * Removes the phy_provider created using of_phy_provider_register().
 883  */
 884 void of_phy_provider_unregister(struct phy_provider *phy_provider)
 885 {
 886         if (IS_ERR(phy_provider))
 887                 return;
 888
 889         mutex_lock(&phy_provider_mutex);
 890         list_del(&phy_provider->list);
 891         kfree(phy_provider);
 892         mutex_unlock(&phy_provider_mutex);
 893 }
 894 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
 895
 896 /**
 897  * devm_of_phy_provider_unregister() - remove phy provider from the framework
 898  * @dev: struct device of the phy provider
 899  *
 900  * destroys the devres associated with this phy provider and invokes
 901  * of_phy_provider_unregister to unregister the phy provider.
 902  */
 903 void devm_of_phy_provider_unregister(struct device *dev,
 904         struct phy_provider *phy_provider) {
 905         int r;
 906
 907         r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
 908                 phy_provider);
 909         dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
 910 }
 911 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
 912
 913 /**
 914  * phy_release() - release the phy
 915  * @dev: the dev member within phy
 916  *
 917  * When the last reference to the device is removed, it is called
 918  * from the embedded kobject as release method.
 919  */
 920 static void phy_release(struct device *dev)
 921 {
 922         struct phy *phy;
 923
 924         phy = to_phy(dev);
 925         dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
 926         regulator_put(phy->pwr);
 927         ida_simple_remove(&phy_ida, phy->id);
 928         kfree(phy);
 929 }
 930
 931 static int __init phy_core_init(void)
 932 {
 933         phy_class = class_create(THIS_MODULE, "phy");
 934         if (IS_ERR(phy_class)) {
 935                 pr_err("failed to create phy class --> %ld\n",
 936                         PTR_ERR(phy_class));
 937                 return PTR_ERR(phy_class);
 938         }
 939
 940         phy_class->dev_release = phy_release;
 941
 942         return 0;
 943 }
 944 module_init(phy_core_init);
 945
 946 static void __exit phy_core_exit(void)
 947 {
 948         class_destroy(phy_class);
 949 }
 950 module_exit(phy_core_exit);
 951
 952 MODULE_DESCRIPTION("Generic PHY Framework");
 953 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
 954 MODULE_LICENSE("GPL v2");