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 (!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 int phy_set_mode(struct phy *phy, enum phy_mode mode)
 346 {
 347         int ret;
 348
 349         if (!phy || !phy->ops->set_mode)
 350                 return 0;
 351
 352         mutex_lock(&phy->mutex);
 353         ret = phy->ops->set_mode(phy, mode);
 354         mutex_unlock(&phy->mutex);
 355
 356         return ret;
 357 }
 358 EXPORT_SYMBOL_GPL(phy_set_mode);
 359
 360 int phy_reset(struct phy *phy)
 361 {
 362         int ret;
 363
 364         if (!phy || !phy->ops->reset)
 365                 return 0;
 366
 367         mutex_lock(&phy->mutex);
 368         ret = phy->ops->reset(phy);
 369         mutex_unlock(&phy->mutex);
 370
 371         return ret;
 372 }
 373 EXPORT_SYMBOL_GPL(phy_reset);
 374
 375 /**
 376  * _of_phy_get() - lookup and obtain a reference to a phy by phandle
 377  * @np: device_node for which to get the phy
 378  * @index: the index of the phy
 379  *
 380  * Returns the phy associated with the given phandle value,
 381  * after getting a refcount to it or -ENODEV if there is no such phy or
 382  * -EPROBE_DEFER if there is a phandle to the phy, but the device is
 383  * not yet loaded. This function uses of_xlate call back function provided
 384  * while registering the phy_provider to find the phy instance.
 385  */
 386 static struct phy *_of_phy_get(struct device_node *np, int index)
 387 {
 388         int ret;
 389         struct phy_provider *phy_provider;
 390         struct phy *phy = NULL;
 391         struct of_phandle_args args;
 392
 393         ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
 394                 index, &args);
 395         if (ret)
 396                 return ERR_PTR(-ENODEV);
 397
 398         mutex_lock(&phy_provider_mutex);
 399         phy_provider = of_phy_provider_lookup(args.np);
 400         if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
 401                 phy = ERR_PTR(-EPROBE_DEFER);
 402                 goto out_unlock;
 403         }
 404
 405         if (!of_device_is_available(args.np)) {
 406                 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
 407                 phy = ERR_PTR(-ENODEV);
 408                 goto out_put_module;
 409         }
 410
 411         phy = phy_provider->of_xlate(phy_provider->dev, &args);
 412
 413 out_put_module:
 414         module_put(phy_provider->owner);
 415
 416 out_unlock:
 417         mutex_unlock(&phy_provider_mutex);
 418         of_node_put(args.np);
 419
 420         return phy;
 421 }
 422
 423 /**
 424  * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
 425  * @np: device_node for which to get the phy
 426  * @con_id: name of the phy from device's point of view
 427  *
 428  * Returns the phy driver, after getting a refcount to it; or
 429  * -ENODEV if there is no such phy. The caller is responsible for
 430  * calling phy_put() to release that count.
 431  */
 432 struct phy *of_phy_get(struct device_node *np, const char *con_id)
 433 {
 434         struct phy *phy = NULL;
 435         int index = 0;
 436
 437         if (con_id)
 438                 index = of_property_match_string(np, "phy-names", con_id);
 439
 440         phy = _of_phy_get(np, index);
 441         if (IS_ERR(phy))
 442                 return phy;
 443
 444         if (!try_module_get(phy->ops->owner))
 445                 return ERR_PTR(-EPROBE_DEFER);
 446
 447         get_device(&phy->dev);
 448
 449         return phy;
 450 }
 451 EXPORT_SYMBOL_GPL(of_phy_get);
 452
 453 /**
 454  * phy_put() - release the PHY
 455  * @phy: the phy returned by phy_get()
 456  *
 457  * Releases a refcount the caller received from phy_get().
 458  */
 459 void phy_put(struct phy *phy)
 460 {
 461         if (!phy || IS_ERR(phy))
 462                 return;
 463
 464         module_put(phy->ops->owner);
 465         put_device(&phy->dev);
 466 }
 467 EXPORT_SYMBOL_GPL(phy_put);
 468
 469 /**
 470  * devm_phy_put() - release the PHY
 471  * @dev: device that wants to release this phy
 472  * @phy: the phy returned by devm_phy_get()
 473  *
 474  * destroys the devres associated with this phy and invokes phy_put
 475  * to release the phy.
 476  */
 477 void devm_phy_put(struct device *dev, struct phy *phy)
 478 {
 479         int r;
 480
 481         if (!phy)
 482                 return;
 483
 484         r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
 485         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 486 }
 487 EXPORT_SYMBOL_GPL(devm_phy_put);
 488
 489 /**
 490  * of_phy_simple_xlate() - returns the phy instance from phy provider
 491  * @dev: the PHY provider device
 492  * @args: of_phandle_args (not used here)
 493  *
 494  * Intended to be used by phy provider for the common case where #phy-cells is
 495  * 0. For other cases where #phy-cells is greater than '0', the phy provider
 496  * should provide a custom of_xlate function that reads the *args* and returns
 497  * the appropriate phy.
 498  */
 499 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
 500         *args)
 501 {
 502         struct phy *phy;
 503         struct class_dev_iter iter;
 504
 505         class_dev_iter_init(&iter, phy_class, NULL, NULL);
 506         while ((dev = class_dev_iter_next(&iter))) {
 507                 phy = to_phy(dev);
 508                 if (args->np != phy->dev.of_node)
 509                         continue;
 510
 511                 class_dev_iter_exit(&iter);
 512                 return phy;
 513         }
 514
 515         class_dev_iter_exit(&iter);
 516         return ERR_PTR(-ENODEV);
 517 }
 518 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
 519
 520 /**
 521  * phy_get() - lookup and obtain a reference to a phy.
 522  * @dev: device that requests this phy
 523  * @string: the phy name as given in the dt data or the name of the controller
 524  * port for non-dt case
 525  *
 526  * Returns the phy driver, after getting a refcount to it; or
 527  * -ENODEV if there is no such phy.  The caller is responsible for
 528  * calling phy_put() to release that count.
 529  */
 530 struct phy *phy_get(struct device *dev, const char *string)
 531 {
 532         int index = 0;
 533         struct phy *phy;
 534
 535         if (string == NULL) {
 536                 dev_WARN(dev, "missing string\n");
 537                 return ERR_PTR(-EINVAL);
 538         }
 539
 540         if (dev->of_node) {
 541                 index = of_property_match_string(dev->of_node, "phy-names",
 542                         string);
 543                 phy = _of_phy_get(dev->of_node, index);
 544         } else {
 545                 phy = phy_find(dev, string);
 546         }
 547         if (IS_ERR(phy))
 548                 return phy;
 549
 550         if (!try_module_get(phy->ops->owner))
 551                 return ERR_PTR(-EPROBE_DEFER);
 552
 553         get_device(&phy->dev);
 554
 555         return phy;
 556 }
 557 EXPORT_SYMBOL_GPL(phy_get);
 558
 559 /**
 560  * phy_optional_get() - lookup and obtain a reference to an optional 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  * NULL if there is no such phy.  The caller is responsible for
 567  * calling phy_put() to release that count.
 568  */
 569 struct phy *phy_optional_get(struct device *dev, const char *string)
 570 {
 571         struct phy *phy = phy_get(dev, string);
 572
 573         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 574                 phy = NULL;
 575
 576         return phy;
 577 }
 578 EXPORT_SYMBOL_GPL(phy_optional_get);
 579
 580 /**
 581  * devm_phy_get() - lookup and obtain a reference to a 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 data,
 588  * then, devres data is freed.
 589  */
 590 struct phy *devm_phy_get(struct device *dev, const char *string)
 591 {
 592         struct phy **ptr, *phy;
 593
 594         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 595         if (!ptr)
 596                 return ERR_PTR(-ENOMEM);
 597
 598         phy = phy_get(dev, string);
 599         if (!IS_ERR(phy)) {
 600                 *ptr = phy;
 601                 devres_add(dev, ptr);
 602         } else {
 603                 devres_free(ptr);
 604         }
 605
 606         return phy;
 607 }
 608 EXPORT_SYMBOL_GPL(devm_phy_get);
 609
 610 /**
 611  * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
 612  * @dev: device that requests this phy
 613  * @string: the phy name as given in the dt data or phy device name
 614  * for non-dt case
 615  *
 616  * Gets the phy using phy_get(), and associates a device with it using
 617  * devres. On driver detach, release function is invoked on the devres
 618  * data, then, devres data is freed. This differs to devm_phy_get() in
 619  * that if the phy does not exist, it is not considered an error and
 620  * -ENODEV will not be returned. Instead the NULL phy is returned,
 621  * which can be passed to all other phy consumer calls.
 622  */
 623 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
 624 {
 625         struct phy *phy = devm_phy_get(dev, string);
 626
 627         if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
 628                 phy = NULL;
 629
 630         return phy;
 631 }
 632 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
 633
 634 /**
 635  * devm_of_phy_get() - lookup and obtain a reference to a phy.
 636  * @dev: device that requests this phy
 637  * @np: node containing the phy
 638  * @con_id: name of the phy from device's point of view
 639  *
 640  * Gets the phy using of_phy_get(), and associates a device with it using
 641  * devres. On driver detach, release function is invoked on the devres data,
 642  * then, devres data is freed.
 643  */
 644 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
 645                             const char *con_id)
 646 {
 647         struct phy **ptr, *phy;
 648
 649         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 650         if (!ptr)
 651                 return ERR_PTR(-ENOMEM);
 652
 653         phy = of_phy_get(np, con_id);
 654         if (!IS_ERR(phy)) {
 655                 *ptr = phy;
 656                 devres_add(dev, ptr);
 657         } else {
 658                 devres_free(ptr);
 659         }
 660
 661         return phy;
 662 }
 663 EXPORT_SYMBOL_GPL(devm_of_phy_get);
 664
 665 /**
 666  * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
 667  * @dev: device that requests this phy
 668  * @np: node containing the phy
 669  * @index: index of the phy
 670  *
 671  * Gets the phy using _of_phy_get(), then gets a refcount to it,
 672  * and associates a device with it using devres. On driver detach,
 673  * release function is invoked on the devres data,
 674  * then, devres data is freed.
 675  *
 676  */
 677 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
 678                                      int index)
 679 {
 680         struct phy **ptr, *phy;
 681
 682         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
 683         if (!ptr)
 684                 return ERR_PTR(-ENOMEM);
 685
 686         phy = _of_phy_get(np, index);
 687         if (IS_ERR(phy)) {
 688                 devres_free(ptr);
 689                 return phy;
 690         }
 691
 692         if (!try_module_get(phy->ops->owner)) {
 693                 devres_free(ptr);
 694                 return ERR_PTR(-EPROBE_DEFER);
 695         }
 696
 697         get_device(&phy->dev);
 698
 699         *ptr = phy;
 700         devres_add(dev, ptr);
 701
 702         return phy;
 703 }
 704 EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
 705
 706 /**
 707  * phy_create() - create a new phy
 708  * @dev: device that is creating the new phy
 709  * @node: device node of the phy
 710  * @ops: function pointers for performing phy operations
 711  *
 712  * Called to create a phy using phy framework.
 713  */
 714 struct phy *phy_create(struct device *dev, struct device_node *node,
 715                        const struct phy_ops *ops)
 716 {
 717         int ret;
 718         int id;
 719         struct phy *phy;
 720
 721         if (WARN_ON(!dev))
 722                 return ERR_PTR(-EINVAL);
 723
 724         phy = kzalloc(sizeof(*phy), GFP_KERNEL);
 725         if (!phy)
 726                 return ERR_PTR(-ENOMEM);
 727
 728         id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
 729         if (id < 0) {
 730                 dev_err(dev, "unable to get id\n");
 731                 ret = id;
 732                 goto free_phy;
 733         }
 734
 735         device_initialize(&phy->dev);
 736         mutex_init(&phy->mutex);
 737
 738         phy->dev.class = phy_class;
 739         phy->dev.parent = dev;
 740         phy->dev.of_node = node ?: dev->of_node;
 741         phy->id = id;
 742         phy->ops = ops;
 743
 744         ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
 745         if (ret)
 746                 goto put_dev;
 747
 748         /* phy-supply */
 749         phy->pwr = regulator_get_optional(&phy->dev, "phy");
 750         if (IS_ERR(phy->pwr)) {
 751                 ret = PTR_ERR(phy->pwr);
 752                 if (ret == -EPROBE_DEFER)
 753                         goto put_dev;
 754
 755                 phy->pwr = NULL;
 756         }
 757
 758         ret = device_add(&phy->dev);
 759         if (ret)
 760                 goto put_dev;
 761
 762         if (pm_runtime_enabled(dev)) {
 763                 pm_runtime_enable(&phy->dev);
 764                 pm_runtime_no_callbacks(&phy->dev);
 765         }
 766
 767         return phy;
 768
 769 put_dev:
 770         put_device(&phy->dev);  /* calls phy_release() which frees resources */
 771         return ERR_PTR(ret);
 772
 773 free_phy:
 774         kfree(phy);
 775         return ERR_PTR(ret);
 776 }
 777 EXPORT_SYMBOL_GPL(phy_create);
 778
 779 /**
 780  * devm_phy_create() - create a new phy
 781  * @dev: device that is creating the new phy
 782  * @node: device node of the phy
 783  * @ops: function pointers for performing phy operations
 784  *
 785  * Creates a new PHY device adding it to the PHY class.
 786  * While at that, it also associates the device with the phy using devres.
 787  * On driver detach, release function is invoked on the devres data,
 788  * then, devres data is freed.
 789  */
 790 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
 791                             const struct phy_ops *ops)
 792 {
 793         struct phy **ptr, *phy;
 794
 795         ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
 796         if (!ptr)
 797                 return ERR_PTR(-ENOMEM);
 798
 799         phy = phy_create(dev, node, ops);
 800         if (!IS_ERR(phy)) {
 801                 *ptr = phy;
 802                 devres_add(dev, ptr);
 803         } else {
 804                 devres_free(ptr);
 805         }
 806
 807         return phy;
 808 }
 809 EXPORT_SYMBOL_GPL(devm_phy_create);
 810
 811 /**
 812  * phy_destroy() - destroy the phy
 813  * @phy: the phy to be destroyed
 814  *
 815  * Called to destroy the phy.
 816  */
 817 void phy_destroy(struct phy *phy)
 818 {
 819         pm_runtime_disable(&phy->dev);
 820         device_unregister(&phy->dev);
 821 }
 822 EXPORT_SYMBOL_GPL(phy_destroy);
 823
 824 /**
 825  * devm_phy_destroy() - destroy the PHY
 826  * @dev: device that wants to release this phy
 827  * @phy: the phy returned by devm_phy_get()
 828  *
 829  * destroys the devres associated with this phy and invokes phy_destroy
 830  * to destroy the phy.
 831  */
 832 void devm_phy_destroy(struct device *dev, struct phy *phy)
 833 {
 834         int r;
 835
 836         r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
 837         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
 838 }
 839 EXPORT_SYMBOL_GPL(devm_phy_destroy);
 840
 841 /**
 842  * __of_phy_provider_register() - create/register phy provider with the framework
 843  * @dev: struct device of the phy provider
 844  * @children: device node containing children (if different from dev->of_node)
 845  * @owner: the module owner containing of_xlate
 846  * @of_xlate: function pointer to obtain phy instance from phy provider
 847  *
 848  * Creates struct phy_provider from dev and of_xlate function pointer.
 849  * This is used in the case of dt boot for finding the phy instance from
 850  * phy provider.
 851  *
 852  * If the PHY provider doesn't nest children directly but uses a separate
 853  * child node to contain the individual children, the @children parameter
 854  * can be used to override the default. If NULL, the default (dev->of_node)
 855  * will be used. If non-NULL, the device node must be a child (or further
 856  * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL
 857  * error code is returned.
 858  */
 859 struct phy_provider *__of_phy_provider_register(struct device *dev,
 860         struct device_node *children, struct module *owner,
 861         struct phy * (*of_xlate)(struct device *dev,
 862                                  struct of_phandle_args *args))
 863 {
 864         struct phy_provider *phy_provider;
 865
 866         /*
 867          * If specified, the device node containing the children must itself
 868          * be the provider's device node or a child (or further descendant)
 869          * thereof.
 870          */
 871         if (children) {
 872                 struct device_node *parent = of_node_get(children), *next;
 873
 874                 while (parent) {
 875                         if (parent == dev->of_node)
 876                                 break;
 877
 878                         next = of_get_parent(parent);
 879                         of_node_put(parent);
 880                         parent = next;
 881                 }
 882
 883                 if (!parent)
 884                         return ERR_PTR(-EINVAL);
 885
 886                 of_node_put(parent);
 887         } else {
 888                 children = dev->of_node;
 889         }
 890
 891         phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
 892         if (!phy_provider)
 893                 return ERR_PTR(-ENOMEM);
 894
 895         phy_provider->dev = dev;
 896         phy_provider->children = of_node_get(children);
 897         phy_provider->owner = owner;
 898         phy_provider->of_xlate = of_xlate;
 899
 900         mutex_lock(&phy_provider_mutex);
 901         list_add_tail(&phy_provider->list, &phy_provider_list);
 902         mutex_unlock(&phy_provider_mutex);
 903
 904         return phy_provider;
 905 }
 906 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
 907
 908 /**
 909  * __devm_of_phy_provider_register() - create/register phy provider with the
 910  * framework
 911  * @dev: struct device of the phy provider
 912  * @owner: the module owner containing of_xlate
 913  * @of_xlate: function pointer to obtain phy instance from phy provider
 914  *
 915  * Creates struct phy_provider from dev and of_xlate function pointer.
 916  * This is used in the case of dt boot for finding the phy instance from
 917  * phy provider. While at that, it also associates the device with the
 918  * phy provider using devres. On driver detach, release function is invoked
 919  * on the devres data, then, devres data is freed.
 920  */
 921 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 922         struct device_node *children, struct module *owner,
 923         struct phy * (*of_xlate)(struct device *dev,
 924                                  struct of_phandle_args *args))
 925 {
 926         struct phy_provider **ptr, *phy_provider;
 927
 928         ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
 929         if (!ptr)
 930                 return ERR_PTR(-ENOMEM);
 931
 932         phy_provider = __of_phy_provider_register(dev, children, owner,
 933                                                   of_xlate);
 934         if (!IS_ERR(phy_provider)) {
 935                 *ptr = phy_provider;
 936                 devres_add(dev, ptr);
 937         } else {
 938                 devres_free(ptr);
 939         }
 940
 941         return phy_provider;
 942 }
 943 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
 944
 945 /**
 946  * of_phy_provider_unregister() - unregister phy provider from the framework
 947  * @phy_provider: phy provider returned by of_phy_provider_register()
 948  *
 949  * Removes the phy_provider created using of_phy_provider_register().
 950  */
 951 void of_phy_provider_unregister(struct phy_provider *phy_provider)
 952 {
 953         if (IS_ERR(phy_provider))
 954                 return;
 955
 956         mutex_lock(&phy_provider_mutex);
 957         list_del(&phy_provider->list);
 958         of_node_put(phy_provider->children);
 959         kfree(phy_provider);
 960         mutex_unlock(&phy_provider_mutex);
 961 }
 962 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
 963
 964 /**
 965  * devm_of_phy_provider_unregister() - remove phy provider from the framework
 966  * @dev: struct device of the phy provider
 967  *
 968  * destroys the devres associated with this phy provider and invokes
 969  * of_phy_provider_unregister to unregister the phy provider.
 970  */
 971 void devm_of_phy_provider_unregister(struct device *dev,
 972         struct phy_provider *phy_provider) {
 973         int r;
 974
 975         r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
 976                 phy_provider);
 977         dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
 978 }
 979 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
 980
 981 /**
 982  * phy_release() - release the phy
 983  * @dev: the dev member within phy
 984  *
 985  * When the last reference to the device is removed, it is called
 986  * from the embedded kobject as release method.
 987  */
 988 static void phy_release(struct device *dev)
 989 {
 990         struct phy *phy;
 991
 992         phy = to_phy(dev);
 993         dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
 994         regulator_put(phy->pwr);
 995         ida_simple_remove(&phy_ida, phy->id);
 996         kfree(phy);
 997 }
 998
 999 static int __init phy_core_init(void)
1000 {
1001         phy_class = class_create(THIS_MODULE, "phy");
1002         if (IS_ERR(phy_class)) {
1003                 pr_err("failed to create phy class --> %ld\n",
1004                         PTR_ERR(phy_class));
1005                 return PTR_ERR(phy_class);
1006         }
1007
1008         phy_class->dev_release = phy_release;
1009
1010         return 0;
1011 }
1012 module_init(phy_core_init);
1013
1014 static void __exit phy_core_exit(void)
1015 {
1016         class_destroy(phy_class);
1017 }
1018 module_exit(phy_core_exit);
1019
1020 MODULE_DESCRIPTION("Generic PHY Framework");
1021 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
1022 MODULE_LICENSE("GPL v2");