2 * phy-core.c -- Generic Phy framework.
4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
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.
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>
21 #include <linux/phy/phy.h>
22 #include <linux/idr.h>
23 #include <linux/pm_runtime.h>
25 static struct class *phy_class;
26 static DEFINE_MUTEX(phy_provider_mutex);
27 static LIST_HEAD(phy_provider_list);
28 static DEFINE_IDA(phy_ida);
30 static void devm_phy_release(struct device *dev, void *res)
32 struct phy *phy = *(struct phy **)res;
37 static void devm_phy_provider_release(struct device *dev, void *res)
39 struct phy_provider *phy_provider = *(struct phy_provider **)res;
41 of_phy_provider_unregister(phy_provider);
44 static void devm_phy_consume(struct device *dev, void *res)
46 struct phy *phy = *(struct phy **)res;
51 static int devm_phy_match(struct device *dev, void *res, void *match_data)
53 return res == match_data;
56 static struct phy *phy_lookup(struct device *device, const char *port)
61 struct phy_consumer *consumers;
62 struct class_dev_iter iter;
64 class_dev_iter_init(&iter, phy_class, NULL, NULL);
65 while ((dev = class_dev_iter_next(&iter))) {
67 count = phy->init_data->num_consumers;
68 consumers = phy->init_data->consumers;
70 if (!strcmp(consumers->dev_name, dev_name(device)) &&
71 !strcmp(consumers->port, port)) {
72 class_dev_iter_exit(&iter);
79 class_dev_iter_exit(&iter);
80 return ERR_PTR(-ENODEV);
83 static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
85 struct phy_provider *phy_provider;
87 list_for_each_entry(phy_provider, &phy_provider_list, list) {
88 if (phy_provider->dev->of_node == node)
92 return ERR_PTR(-EPROBE_DEFER);
95 int phy_pm_runtime_get(struct phy *phy)
99 if (!pm_runtime_enabled(&phy->dev))
102 ret = pm_runtime_get(&phy->dev);
103 if (ret < 0 && ret != -EINPROGRESS)
104 pm_runtime_put_noidle(&phy->dev);
108 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
110 int phy_pm_runtime_get_sync(struct phy *phy)
114 if (!pm_runtime_enabled(&phy->dev))
117 ret = pm_runtime_get_sync(&phy->dev);
119 pm_runtime_put_sync(&phy->dev);
123 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
125 int phy_pm_runtime_put(struct phy *phy)
127 if (!pm_runtime_enabled(&phy->dev))
130 return pm_runtime_put(&phy->dev);
132 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
134 int phy_pm_runtime_put_sync(struct phy *phy)
136 if (!pm_runtime_enabled(&phy->dev))
139 return pm_runtime_put_sync(&phy->dev);
141 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
143 void phy_pm_runtime_allow(struct phy *phy)
145 if (!pm_runtime_enabled(&phy->dev))
148 pm_runtime_allow(&phy->dev);
150 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
152 void phy_pm_runtime_forbid(struct phy *phy)
154 if (!pm_runtime_enabled(&phy->dev))
157 pm_runtime_forbid(&phy->dev);
159 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
161 int phy_init(struct phy *phy)
168 ret = phy_pm_runtime_get_sync(phy);
169 if (ret < 0 && ret != -ENOTSUPP)
172 mutex_lock(&phy->mutex);
173 if (phy->init_count == 0 && phy->ops->init) {
174 ret = phy->ops->init(phy);
176 dev_err(&phy->dev, "phy init failed --> %d\n", ret);
180 ret = 0; /* Override possible ret == -ENOTSUPP */
185 mutex_unlock(&phy->mutex);
186 phy_pm_runtime_put(phy);
189 EXPORT_SYMBOL_GPL(phy_init);
191 int phy_exit(struct phy *phy)
198 ret = phy_pm_runtime_get_sync(phy);
199 if (ret < 0 && ret != -ENOTSUPP)
202 mutex_lock(&phy->mutex);
203 if (phy->init_count == 1 && phy->ops->exit) {
204 ret = phy->ops->exit(phy);
206 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
213 mutex_unlock(&phy->mutex);
214 phy_pm_runtime_put(phy);
217 EXPORT_SYMBOL_GPL(phy_exit);
219 int phy_power_on(struct phy *phy)
226 ret = phy_pm_runtime_get_sync(phy);
227 if (ret < 0 && ret != -ENOTSUPP)
230 mutex_lock(&phy->mutex);
231 if (phy->power_count == 0 && phy->ops->power_on) {
232 ret = phy->ops->power_on(phy);
234 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
238 ret = 0; /* Override possible ret == -ENOTSUPP */
241 mutex_unlock(&phy->mutex);
245 mutex_unlock(&phy->mutex);
246 phy_pm_runtime_put_sync(phy);
250 EXPORT_SYMBOL_GPL(phy_power_on);
252 int phy_power_off(struct phy *phy)
259 mutex_lock(&phy->mutex);
260 if (phy->power_count == 1 && phy->ops->power_off) {
261 ret = phy->ops->power_off(phy);
263 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
264 mutex_unlock(&phy->mutex);
269 mutex_unlock(&phy->mutex);
270 phy_pm_runtime_put(phy);
274 EXPORT_SYMBOL_GPL(phy_power_off);
277 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
278 * @np: device_node for which to get the phy
279 * @index: the index of the phy
281 * Returns the phy associated with the given phandle value,
282 * after getting a refcount to it or -ENODEV if there is no such phy or
283 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
284 * not yet loaded. This function uses of_xlate call back function provided
285 * while registering the phy_provider to find the phy instance.
287 static struct phy *_of_phy_get(struct device_node *np, int index)
290 struct phy_provider *phy_provider;
291 struct phy *phy = NULL;
292 struct of_phandle_args args;
294 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
297 return ERR_PTR(-ENODEV);
299 mutex_lock(&phy_provider_mutex);
300 phy_provider = of_phy_provider_lookup(args.np);
301 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
302 phy = ERR_PTR(-EPROBE_DEFER);
306 phy = phy_provider->of_xlate(phy_provider->dev, &args);
307 module_put(phy_provider->owner);
310 mutex_unlock(&phy_provider_mutex);
311 of_node_put(args.np);
317 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
318 * @np: device_node for which to get the phy
319 * @con_id: name of the phy from device's point of view
321 * Returns the phy driver, after getting a refcount to it; or
322 * -ENODEV if there is no such phy. The caller is responsible for
323 * calling phy_put() to release that count.
325 struct phy *of_phy_get(struct device_node *np, const char *con_id)
327 struct phy *phy = NULL;
331 index = of_property_match_string(np, "phy-names", con_id);
333 phy = _of_phy_get(np, index);
337 if (!try_module_get(phy->ops->owner))
338 return ERR_PTR(-EPROBE_DEFER);
340 get_device(&phy->dev);
344 EXPORT_SYMBOL_GPL(of_phy_get);
347 * phy_put() - release the PHY
348 * @phy: the phy returned by phy_get()
350 * Releases a refcount the caller received from phy_get().
352 void phy_put(struct phy *phy)
354 if (!phy || IS_ERR(phy))
357 module_put(phy->ops->owner);
358 put_device(&phy->dev);
360 EXPORT_SYMBOL_GPL(phy_put);
363 * devm_phy_put() - release the PHY
364 * @dev: device that wants to release this phy
365 * @phy: the phy returned by devm_phy_get()
367 * destroys the devres associated with this phy and invokes phy_put
368 * to release the phy.
370 void devm_phy_put(struct device *dev, struct phy *phy)
377 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
378 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
380 EXPORT_SYMBOL_GPL(devm_phy_put);
383 * of_phy_simple_xlate() - returns the phy instance from phy provider
384 * @dev: the PHY provider device
385 * @args: of_phandle_args (not used here)
387 * Intended to be used by phy provider for the common case where #phy-cells is
388 * 0. For other cases where #phy-cells is greater than '0', the phy provider
389 * should provide a custom of_xlate function that reads the *args* and returns
390 * the appropriate phy.
392 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
396 struct class_dev_iter iter;
397 struct device_node *node = dev->of_node;
399 class_dev_iter_init(&iter, phy_class, NULL, NULL);
400 while ((dev = class_dev_iter_next(&iter))) {
402 if (node != phy->dev.of_node)
405 class_dev_iter_exit(&iter);
409 class_dev_iter_exit(&iter);
410 return ERR_PTR(-ENODEV);
412 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
415 * phy_get() - lookup and obtain a reference to a phy.
416 * @dev: device that requests this phy
417 * @string: the phy name as given in the dt data or the name of the controller
418 * port for non-dt case
420 * Returns the phy driver, after getting a refcount to it; or
421 * -ENODEV if there is no such phy. The caller is responsible for
422 * calling phy_put() to release that count.
424 struct phy *phy_get(struct device *dev, const char *string)
429 if (string == NULL) {
430 dev_WARN(dev, "missing string\n");
431 return ERR_PTR(-EINVAL);
435 index = of_property_match_string(dev->of_node, "phy-names",
437 phy = _of_phy_get(dev->of_node, index);
439 phy = phy_lookup(dev, string);
444 if (!try_module_get(phy->ops->owner))
445 return ERR_PTR(-EPROBE_DEFER);
447 get_device(&phy->dev);
451 EXPORT_SYMBOL_GPL(phy_get);
454 * phy_optional_get() - lookup and obtain a reference to an optional phy.
455 * @dev: device that requests this phy
456 * @string: the phy name as given in the dt data or the name of the controller
457 * port for non-dt case
459 * Returns the phy driver, after getting a refcount to it; or
460 * NULL if there is no such phy. The caller is responsible for
461 * calling phy_put() to release that count.
463 struct phy *phy_optional_get(struct device *dev, const char *string)
465 struct phy *phy = phy_get(dev, string);
467 if (PTR_ERR(phy) == -ENODEV)
472 EXPORT_SYMBOL_GPL(phy_optional_get);
475 * devm_phy_get() - lookup and obtain a reference to a phy.
476 * @dev: device that requests this phy
477 * @string: the phy name as given in the dt data or phy device name
480 * Gets the phy using phy_get(), and associates a device with it using
481 * devres. On driver detach, release function is invoked on the devres data,
482 * then, devres data is freed.
484 struct phy *devm_phy_get(struct device *dev, const char *string)
486 struct phy **ptr, *phy;
488 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
490 return ERR_PTR(-ENOMEM);
492 phy = phy_get(dev, string);
495 devres_add(dev, ptr);
502 EXPORT_SYMBOL_GPL(devm_phy_get);
505 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
506 * @dev: device that requests this phy
507 * @string: the phy name as given in the dt data or phy device name
510 * Gets the phy using phy_get(), and associates a device with it using
511 * devres. On driver detach, release function is invoked on the devres
512 * data, then, devres data is freed. This differs to devm_phy_get() in
513 * that if the phy does not exist, it is not considered an error and
514 * -ENODEV will not be returned. Instead the NULL phy is returned,
515 * which can be passed to all other phy consumer calls.
517 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
519 struct phy *phy = devm_phy_get(dev, string);
521 if (PTR_ERR(phy) == -ENODEV)
526 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
529 * devm_of_phy_get() - lookup and obtain a reference to a phy.
530 * @dev: device that requests this phy
531 * @np: node containing the phy
532 * @con_id: name of the phy from device's point of view
534 * Gets the phy using of_phy_get(), and associates a device with it using
535 * devres. On driver detach, release function is invoked on the devres data,
536 * then, devres data is freed.
538 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
541 struct phy **ptr, *phy;
543 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
545 return ERR_PTR(-ENOMEM);
547 phy = of_phy_get(np, con_id);
550 devres_add(dev, ptr);
557 EXPORT_SYMBOL_GPL(devm_of_phy_get);
560 * phy_create() - create a new phy
561 * @dev: device that is creating the new phy
562 * @ops: function pointers for performing phy operations
563 * @init_data: contains the list of PHY consumers or NULL
565 * Called to create a phy using phy framework.
567 struct phy *phy_create(struct device *dev, const struct phy_ops *ops,
568 struct phy_init_data *init_data)
575 return ERR_PTR(-EINVAL);
577 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
579 return ERR_PTR(-ENOMEM);
581 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
583 dev_err(dev, "unable to get id\n");
588 device_initialize(&phy->dev);
589 mutex_init(&phy->mutex);
591 phy->dev.class = phy_class;
592 phy->dev.parent = dev;
593 phy->dev.of_node = dev->of_node;
596 phy->init_data = init_data;
598 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
602 ret = device_add(&phy->dev);
606 if (pm_runtime_enabled(dev)) {
607 pm_runtime_enable(&phy->dev);
608 pm_runtime_no_callbacks(&phy->dev);
614 put_device(&phy->dev);
615 ida_remove(&phy_ida, phy->id);
620 EXPORT_SYMBOL_GPL(phy_create);
623 * devm_phy_create() - create a new phy
624 * @dev: device that is creating the new phy
625 * @ops: function pointers for performing phy operations
626 * @init_data: contains the list of PHY consumers or NULL
628 * Creates a new PHY device adding it to the PHY class.
629 * While at that, it also associates the device with the phy using devres.
630 * On driver detach, release function is invoked on the devres data,
631 * then, devres data is freed.
633 struct phy *devm_phy_create(struct device *dev, const struct phy_ops *ops,
634 struct phy_init_data *init_data)
636 struct phy **ptr, *phy;
638 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
640 return ERR_PTR(-ENOMEM);
642 phy = phy_create(dev, ops, init_data);
645 devres_add(dev, ptr);
652 EXPORT_SYMBOL_GPL(devm_phy_create);
655 * phy_destroy() - destroy the phy
656 * @phy: the phy to be destroyed
658 * Called to destroy the phy.
660 void phy_destroy(struct phy *phy)
662 pm_runtime_disable(&phy->dev);
663 device_unregister(&phy->dev);
665 EXPORT_SYMBOL_GPL(phy_destroy);
668 * devm_phy_destroy() - destroy the PHY
669 * @dev: device that wants to release this phy
670 * @phy: the phy returned by devm_phy_get()
672 * destroys the devres associated with this phy and invokes phy_destroy
673 * to destroy the phy.
675 void devm_phy_destroy(struct device *dev, struct phy *phy)
679 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
680 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
682 EXPORT_SYMBOL_GPL(devm_phy_destroy);
685 * __of_phy_provider_register() - create/register phy provider with the framework
686 * @dev: struct device of the phy provider
687 * @owner: the module owner containing of_xlate
688 * @of_xlate: function pointer to obtain phy instance from phy provider
690 * Creates struct phy_provider from dev and of_xlate function pointer.
691 * This is used in the case of dt boot for finding the phy instance from
694 struct phy_provider *__of_phy_provider_register(struct device *dev,
695 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
696 struct of_phandle_args *args))
698 struct phy_provider *phy_provider;
700 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
702 return ERR_PTR(-ENOMEM);
704 phy_provider->dev = dev;
705 phy_provider->owner = owner;
706 phy_provider->of_xlate = of_xlate;
708 mutex_lock(&phy_provider_mutex);
709 list_add_tail(&phy_provider->list, &phy_provider_list);
710 mutex_unlock(&phy_provider_mutex);
714 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
717 * __devm_of_phy_provider_register() - create/register phy provider with the
719 * @dev: struct device of the phy provider
720 * @owner: the module owner containing of_xlate
721 * @of_xlate: function pointer to obtain phy instance from phy provider
723 * Creates struct phy_provider from dev and of_xlate function pointer.
724 * This is used in the case of dt boot for finding the phy instance from
725 * phy provider. While at that, it also associates the device with the
726 * phy provider using devres. On driver detach, release function is invoked
727 * on the devres data, then, devres data is freed.
729 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
730 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
731 struct of_phandle_args *args))
733 struct phy_provider **ptr, *phy_provider;
735 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
737 return ERR_PTR(-ENOMEM);
739 phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
740 if (!IS_ERR(phy_provider)) {
742 devres_add(dev, ptr);
749 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
752 * of_phy_provider_unregister() - unregister phy provider from the framework
753 * @phy_provider: phy provider returned by of_phy_provider_register()
755 * Removes the phy_provider created using of_phy_provider_register().
757 void of_phy_provider_unregister(struct phy_provider *phy_provider)
759 if (IS_ERR(phy_provider))
762 mutex_lock(&phy_provider_mutex);
763 list_del(&phy_provider->list);
765 mutex_unlock(&phy_provider_mutex);
767 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
770 * devm_of_phy_provider_unregister() - remove phy provider from the framework
771 * @dev: struct device of the phy provider
773 * destroys the devres associated with this phy provider and invokes
774 * of_phy_provider_unregister to unregister the phy provider.
776 void devm_of_phy_provider_unregister(struct device *dev,
777 struct phy_provider *phy_provider) {
780 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
782 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
784 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
787 * phy_release() - release the phy
788 * @dev: the dev member within phy
790 * When the last reference to the device is removed, it is called
791 * from the embedded kobject as release method.
793 static void phy_release(struct device *dev)
798 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
799 ida_remove(&phy_ida, phy->id);
803 static int __init phy_core_init(void)
805 phy_class = class_create(THIS_MODULE, "phy");
806 if (IS_ERR(phy_class)) {
807 pr_err("failed to create phy class --> %ld\n",
809 return PTR_ERR(phy_class);
812 phy_class->dev_release = phy_release;
816 module_init(phy_core_init);
818 static void __exit phy_core_exit(void)
820 class_destroy(phy_class);
822 module_exit(phy_core_exit);
824 MODULE_DESCRIPTION("Generic PHY Framework");
825 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
826 MODULE_LICENSE("GPL v2");