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
))) {
70 count
= phy
->init_data
->num_consumers
;
71 consumers
= phy
->init_data
->consumers
;
73 if (!strcmp(consumers
->dev_name
, dev_name(device
)) &&
74 !strcmp(consumers
->port
, port
)) {
75 class_dev_iter_exit(&iter
);
82 class_dev_iter_exit(&iter
);
83 return ERR_PTR(-ENODEV
);
86 static struct phy_provider
*of_phy_provider_lookup(struct device_node
*node
)
88 struct phy_provider
*phy_provider
;
90 list_for_each_entry(phy_provider
, &phy_provider_list
, list
) {
91 if (phy_provider
->dev
->of_node
== node
)
95 return ERR_PTR(-EPROBE_DEFER
);
98 int phy_pm_runtime_get(struct phy
*phy
)
102 if (!pm_runtime_enabled(&phy
->dev
))
105 ret
= pm_runtime_get(&phy
->dev
);
106 if (ret
< 0 && ret
!= -EINPROGRESS
)
107 pm_runtime_put_noidle(&phy
->dev
);
111 EXPORT_SYMBOL_GPL(phy_pm_runtime_get
);
113 int phy_pm_runtime_get_sync(struct phy
*phy
)
117 if (!pm_runtime_enabled(&phy
->dev
))
120 ret
= pm_runtime_get_sync(&phy
->dev
);
122 pm_runtime_put_sync(&phy
->dev
);
126 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync
);
128 int phy_pm_runtime_put(struct phy
*phy
)
130 if (!pm_runtime_enabled(&phy
->dev
))
133 return pm_runtime_put(&phy
->dev
);
135 EXPORT_SYMBOL_GPL(phy_pm_runtime_put
);
137 int phy_pm_runtime_put_sync(struct phy
*phy
)
139 if (!pm_runtime_enabled(&phy
->dev
))
142 return pm_runtime_put_sync(&phy
->dev
);
144 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync
);
146 void phy_pm_runtime_allow(struct phy
*phy
)
148 if (!pm_runtime_enabled(&phy
->dev
))
151 pm_runtime_allow(&phy
->dev
);
153 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow
);
155 void phy_pm_runtime_forbid(struct phy
*phy
)
157 if (!pm_runtime_enabled(&phy
->dev
))
160 pm_runtime_forbid(&phy
->dev
);
162 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid
);
164 int phy_init(struct phy
*phy
)
171 ret
= phy_pm_runtime_get_sync(phy
);
172 if (ret
< 0 && ret
!= -ENOTSUPP
)
175 mutex_lock(&phy
->mutex
);
176 if (phy
->init_count
== 0 && phy
->ops
->init
) {
177 ret
= phy
->ops
->init(phy
);
179 dev_err(&phy
->dev
, "phy init failed --> %d\n", ret
);
183 ret
= 0; /* Override possible ret == -ENOTSUPP */
188 mutex_unlock(&phy
->mutex
);
189 phy_pm_runtime_put(phy
);
192 EXPORT_SYMBOL_GPL(phy_init
);
194 int phy_exit(struct phy
*phy
)
201 ret
= phy_pm_runtime_get_sync(phy
);
202 if (ret
< 0 && ret
!= -ENOTSUPP
)
205 mutex_lock(&phy
->mutex
);
206 if (phy
->init_count
== 1 && phy
->ops
->exit
) {
207 ret
= phy
->ops
->exit(phy
);
209 dev_err(&phy
->dev
, "phy exit failed --> %d\n", ret
);
216 mutex_unlock(&phy
->mutex
);
217 phy_pm_runtime_put(phy
);
220 EXPORT_SYMBOL_GPL(phy_exit
);
222 int phy_power_on(struct phy
*phy
)
229 ret
= phy_pm_runtime_get_sync(phy
);
230 if (ret
< 0 && ret
!= -ENOTSUPP
)
233 mutex_lock(&phy
->mutex
);
234 if (phy
->power_count
== 0 && phy
->ops
->power_on
) {
235 ret
= phy
->ops
->power_on(phy
);
237 dev_err(&phy
->dev
, "phy poweron failed --> %d\n", ret
);
241 ret
= 0; /* Override possible ret == -ENOTSUPP */
244 mutex_unlock(&phy
->mutex
);
248 mutex_unlock(&phy
->mutex
);
249 phy_pm_runtime_put_sync(phy
);
253 EXPORT_SYMBOL_GPL(phy_power_on
);
255 int phy_power_off(struct phy
*phy
)
262 mutex_lock(&phy
->mutex
);
263 if (phy
->power_count
== 1 && phy
->ops
->power_off
) {
264 ret
= phy
->ops
->power_off(phy
);
266 dev_err(&phy
->dev
, "phy poweroff failed --> %d\n", ret
);
267 mutex_unlock(&phy
->mutex
);
272 mutex_unlock(&phy
->mutex
);
273 phy_pm_runtime_put(phy
);
277 EXPORT_SYMBOL_GPL(phy_power_off
);
280 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
281 * @np: device_node for which to get the phy
282 * @index: the index of the phy
284 * Returns the phy associated with the given phandle value,
285 * after getting a refcount to it or -ENODEV if there is no such phy or
286 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
287 * not yet loaded. This function uses of_xlate call back function provided
288 * while registering the phy_provider to find the phy instance.
290 static struct phy
*_of_phy_get(struct device_node
*np
, int index
)
293 struct phy_provider
*phy_provider
;
294 struct phy
*phy
= NULL
;
295 struct of_phandle_args args
;
297 ret
= of_parse_phandle_with_args(np
, "phys", "#phy-cells",
300 return ERR_PTR(-ENODEV
);
302 mutex_lock(&phy_provider_mutex
);
303 phy_provider
= of_phy_provider_lookup(args
.np
);
304 if (IS_ERR(phy_provider
) || !try_module_get(phy_provider
->owner
)) {
305 phy
= ERR_PTR(-EPROBE_DEFER
);
309 phy
= phy_provider
->of_xlate(phy_provider
->dev
, &args
);
310 module_put(phy_provider
->owner
);
313 mutex_unlock(&phy_provider_mutex
);
314 of_node_put(args
.np
);
320 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
321 * @np: device_node for which to get the phy
322 * @con_id: name of the phy from device's point of view
324 * Returns the phy driver, after getting a refcount to it; or
325 * -ENODEV if there is no such phy. The caller is responsible for
326 * calling phy_put() to release that count.
328 struct phy
*of_phy_get(struct device_node
*np
, const char *con_id
)
330 struct phy
*phy
= NULL
;
334 index
= of_property_match_string(np
, "phy-names", con_id
);
336 phy
= _of_phy_get(np
, index
);
340 if (!try_module_get(phy
->ops
->owner
))
341 return ERR_PTR(-EPROBE_DEFER
);
343 get_device(&phy
->dev
);
347 EXPORT_SYMBOL_GPL(of_phy_get
);
350 * phy_put() - release the PHY
351 * @phy: the phy returned by phy_get()
353 * Releases a refcount the caller received from phy_get().
355 void phy_put(struct phy
*phy
)
357 if (!phy
|| IS_ERR(phy
))
360 module_put(phy
->ops
->owner
);
361 put_device(&phy
->dev
);
363 EXPORT_SYMBOL_GPL(phy_put
);
366 * devm_phy_put() - release the PHY
367 * @dev: device that wants to release this phy
368 * @phy: the phy returned by devm_phy_get()
370 * destroys the devres associated with this phy and invokes phy_put
371 * to release the phy.
373 void devm_phy_put(struct device
*dev
, struct phy
*phy
)
380 r
= devres_destroy(dev
, devm_phy_release
, devm_phy_match
, phy
);
381 dev_WARN_ONCE(dev
, r
, "couldn't find PHY resource\n");
383 EXPORT_SYMBOL_GPL(devm_phy_put
);
386 * of_phy_simple_xlate() - returns the phy instance from phy provider
387 * @dev: the PHY provider device
388 * @args: of_phandle_args (not used here)
390 * Intended to be used by phy provider for the common case where #phy-cells is
391 * 0. For other cases where #phy-cells is greater than '0', the phy provider
392 * should provide a custom of_xlate function that reads the *args* and returns
393 * the appropriate phy.
395 struct phy
*of_phy_simple_xlate(struct device
*dev
, struct of_phandle_args
399 struct class_dev_iter iter
;
400 struct device_node
*node
= dev
->of_node
;
402 class_dev_iter_init(&iter
, phy_class
, NULL
, NULL
);
403 while ((dev
= class_dev_iter_next(&iter
))) {
405 if (node
!= phy
->dev
.of_node
)
408 class_dev_iter_exit(&iter
);
412 class_dev_iter_exit(&iter
);
413 return ERR_PTR(-ENODEV
);
415 EXPORT_SYMBOL_GPL(of_phy_simple_xlate
);
418 * phy_get() - lookup and obtain a reference to a phy.
419 * @dev: device that requests this phy
420 * @string: the phy name as given in the dt data or the name of the controller
421 * port for non-dt case
423 * Returns the phy driver, after getting a refcount to it; or
424 * -ENODEV if there is no such phy. The caller is responsible for
425 * calling phy_put() to release that count.
427 struct phy
*phy_get(struct device
*dev
, const char *string
)
432 if (string
== NULL
) {
433 dev_WARN(dev
, "missing string\n");
434 return ERR_PTR(-EINVAL
);
438 index
= of_property_match_string(dev
->of_node
, "phy-names",
440 phy
= _of_phy_get(dev
->of_node
, index
);
442 phy
= phy_lookup(dev
, string
);
447 if (!try_module_get(phy
->ops
->owner
))
448 return ERR_PTR(-EPROBE_DEFER
);
450 get_device(&phy
->dev
);
454 EXPORT_SYMBOL_GPL(phy_get
);
457 * phy_optional_get() - lookup and obtain a reference to an optional phy.
458 * @dev: device that requests this phy
459 * @string: the phy name as given in the dt data or the name of the controller
460 * port for non-dt case
462 * Returns the phy driver, after getting a refcount to it; or
463 * NULL if there is no such phy. The caller is responsible for
464 * calling phy_put() to release that count.
466 struct phy
*phy_optional_get(struct device
*dev
, const char *string
)
468 struct phy
*phy
= phy_get(dev
, string
);
470 if (PTR_ERR(phy
) == -ENODEV
)
475 EXPORT_SYMBOL_GPL(phy_optional_get
);
478 * devm_phy_get() - lookup and obtain a reference to a phy.
479 * @dev: device that requests this phy
480 * @string: the phy name as given in the dt data or phy device name
483 * Gets the phy using phy_get(), and associates a device with it using
484 * devres. On driver detach, release function is invoked on the devres data,
485 * then, devres data is freed.
487 struct phy
*devm_phy_get(struct device
*dev
, const char *string
)
489 struct phy
**ptr
, *phy
;
491 ptr
= devres_alloc(devm_phy_release
, sizeof(*ptr
), GFP_KERNEL
);
493 return ERR_PTR(-ENOMEM
);
495 phy
= phy_get(dev
, string
);
498 devres_add(dev
, ptr
);
505 EXPORT_SYMBOL_GPL(devm_phy_get
);
508 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
509 * @dev: device that requests this phy
510 * @string: the phy name as given in the dt data or phy device name
513 * Gets the phy using phy_get(), and associates a device with it using
514 * devres. On driver detach, release function is invoked on the devres
515 * data, then, devres data is freed. This differs to devm_phy_get() in
516 * that if the phy does not exist, it is not considered an error and
517 * -ENODEV will not be returned. Instead the NULL phy is returned,
518 * which can be passed to all other phy consumer calls.
520 struct phy
*devm_phy_optional_get(struct device
*dev
, const char *string
)
522 struct phy
*phy
= devm_phy_get(dev
, string
);
524 if (PTR_ERR(phy
) == -ENODEV
)
529 EXPORT_SYMBOL_GPL(devm_phy_optional_get
);
532 * devm_of_phy_get() - lookup and obtain a reference to a phy.
533 * @dev: device that requests this phy
534 * @np: node containing the phy
535 * @con_id: name of the phy from device's point of view
537 * Gets the phy using of_phy_get(), and associates a device with it using
538 * devres. On driver detach, release function is invoked on the devres data,
539 * then, devres data is freed.
541 struct phy
*devm_of_phy_get(struct device
*dev
, struct device_node
*np
,
544 struct phy
**ptr
, *phy
;
546 ptr
= devres_alloc(devm_phy_release
, sizeof(*ptr
), GFP_KERNEL
);
548 return ERR_PTR(-ENOMEM
);
550 phy
= of_phy_get(np
, con_id
);
553 devres_add(dev
, ptr
);
560 EXPORT_SYMBOL_GPL(devm_of_phy_get
);
563 * phy_create() - create a new phy
564 * @dev: device that is creating the new phy
565 * @ops: function pointers for performing phy operations
566 * @init_data: contains the list of PHY consumers or NULL
568 * Called to create a phy using phy framework.
570 struct phy
*phy_create(struct device
*dev
, const struct phy_ops
*ops
,
571 struct phy_init_data
*init_data
)
578 return ERR_PTR(-EINVAL
);
580 phy
= kzalloc(sizeof(*phy
), GFP_KERNEL
);
582 return ERR_PTR(-ENOMEM
);
584 id
= ida_simple_get(&phy_ida
, 0, 0, GFP_KERNEL
);
586 dev_err(dev
, "unable to get id\n");
591 device_initialize(&phy
->dev
);
592 mutex_init(&phy
->mutex
);
594 phy
->dev
.class = phy_class
;
595 phy
->dev
.parent
= dev
;
596 phy
->dev
.of_node
= dev
->of_node
;
599 phy
->init_data
= init_data
;
601 ret
= dev_set_name(&phy
->dev
, "phy-%s.%d", dev_name(dev
), id
);
605 ret
= device_add(&phy
->dev
);
609 if (pm_runtime_enabled(dev
)) {
610 pm_runtime_enable(&phy
->dev
);
611 pm_runtime_no_callbacks(&phy
->dev
);
617 put_device(&phy
->dev
); /* calls phy_release() which frees resources */
624 EXPORT_SYMBOL_GPL(phy_create
);
627 * devm_phy_create() - create a new phy
628 * @dev: device that is creating the new phy
629 * @ops: function pointers for performing phy operations
630 * @init_data: contains the list of PHY consumers or NULL
632 * Creates a new PHY device adding it to the PHY class.
633 * While at that, it also associates the device with the phy using devres.
634 * On driver detach, release function is invoked on the devres data,
635 * then, devres data is freed.
637 struct phy
*devm_phy_create(struct device
*dev
, const struct phy_ops
*ops
,
638 struct phy_init_data
*init_data
)
640 struct phy
**ptr
, *phy
;
642 ptr
= devres_alloc(devm_phy_consume
, sizeof(*ptr
), GFP_KERNEL
);
644 return ERR_PTR(-ENOMEM
);
646 phy
= phy_create(dev
, ops
, init_data
);
649 devres_add(dev
, ptr
);
656 EXPORT_SYMBOL_GPL(devm_phy_create
);
659 * phy_destroy() - destroy the phy
660 * @phy: the phy to be destroyed
662 * Called to destroy the phy.
664 void phy_destroy(struct phy
*phy
)
666 pm_runtime_disable(&phy
->dev
);
667 device_unregister(&phy
->dev
);
669 EXPORT_SYMBOL_GPL(phy_destroy
);
672 * devm_phy_destroy() - destroy the PHY
673 * @dev: device that wants to release this phy
674 * @phy: the phy returned by devm_phy_get()
676 * destroys the devres associated with this phy and invokes phy_destroy
677 * to destroy the phy.
679 void devm_phy_destroy(struct device
*dev
, struct phy
*phy
)
683 r
= devres_destroy(dev
, devm_phy_consume
, devm_phy_match
, phy
);
684 dev_WARN_ONCE(dev
, r
, "couldn't find PHY resource\n");
686 EXPORT_SYMBOL_GPL(devm_phy_destroy
);
689 * __of_phy_provider_register() - create/register phy provider with the framework
690 * @dev: struct device of the phy provider
691 * @owner: the module owner containing of_xlate
692 * @of_xlate: function pointer to obtain phy instance from phy provider
694 * Creates struct phy_provider from dev and of_xlate function pointer.
695 * This is used in the case of dt boot for finding the phy instance from
698 struct phy_provider
*__of_phy_provider_register(struct device
*dev
,
699 struct module
*owner
, struct phy
* (*of_xlate
)(struct device
*dev
,
700 struct of_phandle_args
*args
))
702 struct phy_provider
*phy_provider
;
704 phy_provider
= kzalloc(sizeof(*phy_provider
), GFP_KERNEL
);
706 return ERR_PTR(-ENOMEM
);
708 phy_provider
->dev
= dev
;
709 phy_provider
->owner
= owner
;
710 phy_provider
->of_xlate
= of_xlate
;
712 mutex_lock(&phy_provider_mutex
);
713 list_add_tail(&phy_provider
->list
, &phy_provider_list
);
714 mutex_unlock(&phy_provider_mutex
);
718 EXPORT_SYMBOL_GPL(__of_phy_provider_register
);
721 * __devm_of_phy_provider_register() - create/register phy provider with the
723 * @dev: struct device of the phy provider
724 * @owner: the module owner containing of_xlate
725 * @of_xlate: function pointer to obtain phy instance from phy provider
727 * Creates struct phy_provider from dev and of_xlate function pointer.
728 * This is used in the case of dt boot for finding the phy instance from
729 * phy provider. While at that, it also associates the device with the
730 * phy provider using devres. On driver detach, release function is invoked
731 * on the devres data, then, devres data is freed.
733 struct phy_provider
*__devm_of_phy_provider_register(struct device
*dev
,
734 struct module
*owner
, struct phy
* (*of_xlate
)(struct device
*dev
,
735 struct of_phandle_args
*args
))
737 struct phy_provider
**ptr
, *phy_provider
;
739 ptr
= devres_alloc(devm_phy_provider_release
, sizeof(*ptr
), GFP_KERNEL
);
741 return ERR_PTR(-ENOMEM
);
743 phy_provider
= __of_phy_provider_register(dev
, owner
, of_xlate
);
744 if (!IS_ERR(phy_provider
)) {
746 devres_add(dev
, ptr
);
753 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register
);
756 * of_phy_provider_unregister() - unregister phy provider from the framework
757 * @phy_provider: phy provider returned by of_phy_provider_register()
759 * Removes the phy_provider created using of_phy_provider_register().
761 void of_phy_provider_unregister(struct phy_provider
*phy_provider
)
763 if (IS_ERR(phy_provider
))
766 mutex_lock(&phy_provider_mutex
);
767 list_del(&phy_provider
->list
);
769 mutex_unlock(&phy_provider_mutex
);
771 EXPORT_SYMBOL_GPL(of_phy_provider_unregister
);
774 * devm_of_phy_provider_unregister() - remove phy provider from the framework
775 * @dev: struct device of the phy provider
777 * destroys the devres associated with this phy provider and invokes
778 * of_phy_provider_unregister to unregister the phy provider.
780 void devm_of_phy_provider_unregister(struct device
*dev
,
781 struct phy_provider
*phy_provider
) {
784 r
= devres_destroy(dev
, devm_phy_provider_release
, devm_phy_match
,
786 dev_WARN_ONCE(dev
, r
, "couldn't find PHY provider device resource\n");
788 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister
);
791 * phy_release() - release the phy
792 * @dev: the dev member within phy
794 * When the last reference to the device is removed, it is called
795 * from the embedded kobject as release method.
797 static void phy_release(struct device
*dev
)
802 dev_vdbg(dev
, "releasing '%s'\n", dev_name(dev
));
803 ida_simple_remove(&phy_ida
, phy
->id
);
807 static int __init
phy_core_init(void)
809 phy_class
= class_create(THIS_MODULE
, "phy");
810 if (IS_ERR(phy_class
)) {
811 pr_err("failed to create phy class --> %ld\n",
813 return PTR_ERR(phy_class
);
816 phy_class
->dev_release
= phy_release
;
820 module_init(phy_core_init
);
822 static void __exit
phy_core_exit(void)
824 class_destroy(phy_class
);
826 module_exit(phy_core_exit
);
828 MODULE_DESCRIPTION("Generic PHY Framework");
829 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
830 MODULE_LICENSE("GPL v2");