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);
183 mutex_unlock(&phy->mutex);
184 phy_pm_runtime_put(phy);
187 EXPORT_SYMBOL_GPL(phy_init);
189 int phy_exit(struct phy *phy)
196 ret = phy_pm_runtime_get_sync(phy);
197 if (ret < 0 && ret != -ENOTSUPP)
200 mutex_lock(&phy->mutex);
201 if (phy->init_count == 1 && phy->ops->exit) {
202 ret = phy->ops->exit(phy);
204 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
211 mutex_unlock(&phy->mutex);
212 phy_pm_runtime_put(phy);
215 EXPORT_SYMBOL_GPL(phy_exit);
217 int phy_power_on(struct phy *phy)
224 ret = phy_pm_runtime_get_sync(phy);
225 if (ret < 0 && ret != -ENOTSUPP)
228 mutex_lock(&phy->mutex);
229 if (phy->power_count == 0 && phy->ops->power_on) {
230 ret = phy->ops->power_on(phy);
232 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
237 mutex_unlock(&phy->mutex);
241 mutex_unlock(&phy->mutex);
242 phy_pm_runtime_put_sync(phy);
246 EXPORT_SYMBOL_GPL(phy_power_on);
248 int phy_power_off(struct phy *phy)
255 mutex_lock(&phy->mutex);
256 if (phy->power_count == 1 && phy->ops->power_off) {
257 ret = phy->ops->power_off(phy);
259 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
260 mutex_unlock(&phy->mutex);
265 mutex_unlock(&phy->mutex);
266 phy_pm_runtime_put(phy);
270 EXPORT_SYMBOL_GPL(phy_power_off);
273 * of_phy_get() - lookup and obtain a reference to a phy by phandle
274 * @dev: device that requests this phy
275 * @index: the index of the phy
277 * Returns the phy associated with the given phandle value,
278 * after getting a refcount to it or -ENODEV if there is no such phy or
279 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
280 * not yet loaded. This function uses of_xlate call back function provided
281 * while registering the phy_provider to find the phy instance.
283 static struct phy *of_phy_get(struct device *dev, int index)
286 struct phy_provider *phy_provider;
287 struct phy *phy = NULL;
288 struct of_phandle_args args;
290 ret = of_parse_phandle_with_args(dev->of_node, "phys", "#phy-cells",
293 dev_dbg(dev, "failed to get phy in %s node\n",
294 dev->of_node->full_name);
295 return ERR_PTR(-ENODEV);
298 mutex_lock(&phy_provider_mutex);
299 phy_provider = of_phy_provider_lookup(args.np);
300 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
301 phy = ERR_PTR(-EPROBE_DEFER);
305 phy = phy_provider->of_xlate(phy_provider->dev, &args);
306 module_put(phy_provider->owner);
309 mutex_unlock(&phy_provider_mutex);
310 of_node_put(args.np);
316 * phy_put() - release the PHY
317 * @phy: the phy returned by phy_get()
319 * Releases a refcount the caller received from phy_get().
321 void phy_put(struct phy *phy)
323 if (!phy || IS_ERR(phy))
326 module_put(phy->ops->owner);
327 put_device(&phy->dev);
329 EXPORT_SYMBOL_GPL(phy_put);
332 * devm_phy_put() - release the PHY
333 * @dev: device that wants to release this phy
334 * @phy: the phy returned by devm_phy_get()
336 * destroys the devres associated with this phy and invokes phy_put
337 * to release the phy.
339 void devm_phy_put(struct device *dev, struct phy *phy)
346 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
347 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
349 EXPORT_SYMBOL_GPL(devm_phy_put);
352 * of_phy_simple_xlate() - returns the phy instance from phy provider
353 * @dev: the PHY provider device
354 * @args: of_phandle_args (not used here)
356 * Intended to be used by phy provider for the common case where #phy-cells is
357 * 0. For other cases where #phy-cells is greater than '0', the phy provider
358 * should provide a custom of_xlate function that reads the *args* and returns
359 * the appropriate phy.
361 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
365 struct class_dev_iter iter;
366 struct device_node *node = dev->of_node;
368 class_dev_iter_init(&iter, phy_class, NULL, NULL);
369 while ((dev = class_dev_iter_next(&iter))) {
371 if (node != phy->dev.of_node)
374 class_dev_iter_exit(&iter);
378 class_dev_iter_exit(&iter);
379 return ERR_PTR(-ENODEV);
381 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
384 * phy_get() - lookup and obtain a reference to a phy.
385 * @dev: device that requests this phy
386 * @string: the phy name as given in the dt data or the name of the controller
387 * port for non-dt case
389 * Returns the phy driver, after getting a refcount to it; or
390 * -ENODEV if there is no such phy. The caller is responsible for
391 * calling phy_put() to release that count.
393 struct phy *phy_get(struct device *dev, const char *string)
398 if (string == NULL) {
399 dev_WARN(dev, "missing string\n");
400 return ERR_PTR(-EINVAL);
404 index = of_property_match_string(dev->of_node, "phy-names",
406 phy = of_phy_get(dev, index);
408 phy = phy_lookup(dev, string);
413 if (!try_module_get(phy->ops->owner))
414 return ERR_PTR(-EPROBE_DEFER);
416 get_device(&phy->dev);
420 EXPORT_SYMBOL_GPL(phy_get);
423 * phy_optional_get() - lookup and obtain a reference to an optional phy.
424 * @dev: device that requests this phy
425 * @string: the phy name as given in the dt data or the name of the controller
426 * port for non-dt case
428 * Returns the phy driver, after getting a refcount to it; or
429 * NULL if there is no such phy. The caller is responsible for
430 * calling phy_put() to release that count.
432 struct phy *phy_optional_get(struct device *dev, const char *string)
434 struct phy *phy = phy_get(dev, string);
436 if (PTR_ERR(phy) == -ENODEV)
441 EXPORT_SYMBOL_GPL(phy_optional_get);
444 * devm_phy_get() - lookup and obtain a reference to a phy.
445 * @dev: device that requests this phy
446 * @string: the phy name as given in the dt data or phy device name
449 * Gets the phy using phy_get(), and associates a device with it using
450 * devres. On driver detach, release function is invoked on the devres data,
451 * then, devres data is freed.
453 struct phy *devm_phy_get(struct device *dev, const char *string)
455 struct phy **ptr, *phy;
457 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
459 return ERR_PTR(-ENOMEM);
461 phy = phy_get(dev, string);
464 devres_add(dev, ptr);
471 EXPORT_SYMBOL_GPL(devm_phy_get);
474 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
475 * @dev: device that requests this phy
476 * @string: the phy name as given in the dt data or phy device name
479 * Gets the phy using phy_get(), and associates a device with it using
480 * devres. On driver detach, release function is invoked on the devres
481 * data, then, devres data is freed. This differs to devm_phy_get() in
482 * that if the phy does not exist, it is not considered an error and
483 * -ENODEV will not be returned. Instead the NULL phy is returned,
484 * which can be passed to all other phy consumer calls.
486 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
488 struct phy *phy = devm_phy_get(dev, string);
490 if (PTR_ERR(phy) == -ENODEV)
495 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
498 * phy_create() - create a new phy
499 * @dev: device that is creating the new phy
500 * @ops: function pointers for performing phy operations
501 * @init_data: contains the list of PHY consumers or NULL
503 * Called to create a phy using phy framework.
505 struct phy *phy_create(struct device *dev, const struct phy_ops *ops,
506 struct phy_init_data *init_data)
513 return ERR_PTR(-EINVAL);
515 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
517 return ERR_PTR(-ENOMEM);
519 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
521 dev_err(dev, "unable to get id\n");
526 device_initialize(&phy->dev);
527 mutex_init(&phy->mutex);
529 phy->dev.class = phy_class;
530 phy->dev.parent = dev;
531 phy->dev.of_node = dev->of_node;
534 phy->init_data = init_data;
536 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
540 ret = device_add(&phy->dev);
544 if (pm_runtime_enabled(dev)) {
545 pm_runtime_enable(&phy->dev);
546 pm_runtime_no_callbacks(&phy->dev);
552 put_device(&phy->dev);
553 ida_remove(&phy_ida, phy->id);
558 EXPORT_SYMBOL_GPL(phy_create);
561 * devm_phy_create() - create a new phy
562 * @dev: device that is creating the new phy
563 * @ops: function pointers for performing phy operations
564 * @init_data: contains the list of PHY consumers or NULL
566 * Creates a new PHY device adding it to the PHY class.
567 * While at that, it also associates the device with the phy using devres.
568 * On driver detach, release function is invoked on the devres data,
569 * then, devres data is freed.
571 struct phy *devm_phy_create(struct device *dev, const struct phy_ops *ops,
572 struct phy_init_data *init_data)
574 struct phy **ptr, *phy;
576 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
578 return ERR_PTR(-ENOMEM);
580 phy = phy_create(dev, ops, init_data);
583 devres_add(dev, ptr);
590 EXPORT_SYMBOL_GPL(devm_phy_create);
593 * phy_destroy() - destroy the phy
594 * @phy: the phy to be destroyed
596 * Called to destroy the phy.
598 void phy_destroy(struct phy *phy)
600 pm_runtime_disable(&phy->dev);
601 device_unregister(&phy->dev);
603 EXPORT_SYMBOL_GPL(phy_destroy);
606 * devm_phy_destroy() - destroy the PHY
607 * @dev: device that wants to release this phy
608 * @phy: the phy returned by devm_phy_get()
610 * destroys the devres associated with this phy and invokes phy_destroy
611 * to destroy the phy.
613 void devm_phy_destroy(struct device *dev, struct phy *phy)
617 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
618 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
620 EXPORT_SYMBOL_GPL(devm_phy_destroy);
623 * __of_phy_provider_register() - create/register phy provider with the framework
624 * @dev: struct device of the phy provider
625 * @owner: the module owner containing of_xlate
626 * @of_xlate: function pointer to obtain phy instance from phy provider
628 * Creates struct phy_provider from dev and of_xlate function pointer.
629 * This is used in the case of dt boot for finding the phy instance from
632 struct phy_provider *__of_phy_provider_register(struct device *dev,
633 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
634 struct of_phandle_args *args))
636 struct phy_provider *phy_provider;
638 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
640 return ERR_PTR(-ENOMEM);
642 phy_provider->dev = dev;
643 phy_provider->owner = owner;
644 phy_provider->of_xlate = of_xlate;
646 mutex_lock(&phy_provider_mutex);
647 list_add_tail(&phy_provider->list, &phy_provider_list);
648 mutex_unlock(&phy_provider_mutex);
652 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
655 * __devm_of_phy_provider_register() - create/register phy provider with the
657 * @dev: struct device of the phy provider
658 * @owner: the module owner containing of_xlate
659 * @of_xlate: function pointer to obtain phy instance from phy provider
661 * Creates struct phy_provider from dev and of_xlate function pointer.
662 * This is used in the case of dt boot for finding the phy instance from
663 * phy provider. While at that, it also associates the device with the
664 * phy provider using devres. On driver detach, release function is invoked
665 * on the devres data, then, devres data is freed.
667 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
668 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
669 struct of_phandle_args *args))
671 struct phy_provider **ptr, *phy_provider;
673 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
675 return ERR_PTR(-ENOMEM);
677 phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
678 if (!IS_ERR(phy_provider)) {
680 devres_add(dev, ptr);
687 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
690 * of_phy_provider_unregister() - unregister phy provider from the framework
691 * @phy_provider: phy provider returned by of_phy_provider_register()
693 * Removes the phy_provider created using of_phy_provider_register().
695 void of_phy_provider_unregister(struct phy_provider *phy_provider)
697 if (IS_ERR(phy_provider))
700 mutex_lock(&phy_provider_mutex);
701 list_del(&phy_provider->list);
703 mutex_unlock(&phy_provider_mutex);
705 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
708 * devm_of_phy_provider_unregister() - remove phy provider from the framework
709 * @dev: struct device of the phy provider
711 * destroys the devres associated with this phy provider and invokes
712 * of_phy_provider_unregister to unregister the phy provider.
714 void devm_of_phy_provider_unregister(struct device *dev,
715 struct phy_provider *phy_provider) {
718 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
720 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
722 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
725 * phy_release() - release the phy
726 * @dev: the dev member within phy
728 * When the last reference to the device is removed, it is called
729 * from the embedded kobject as release method.
731 static void phy_release(struct device *dev)
736 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
737 ida_remove(&phy_ida, phy->id);
741 static int __init phy_core_init(void)
743 phy_class = class_create(THIS_MODULE, "phy");
744 if (IS_ERR(phy_class)) {
745 pr_err("failed to create phy class --> %ld\n",
747 return PTR_ERR(phy_class);
750 phy_class->dev_release = phy_release;
754 module_init(phy_core_init);
756 static void __exit phy_core_exit(void)
758 class_destroy(phy_class);
760 module_exit(phy_core_exit);
762 MODULE_DESCRIPTION("Generic PHY Framework");
763 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
764 MODULE_LICENSE("GPL v2");