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