1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * phy-core.c -- Generic Phy framework.
5 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
7 * Author: Kishon Vijay Abraham I <kishon@ti.com>
10 #include <linux/kernel.h>
11 #include <linux/export.h>
12 #include <linux/module.h>
13 #include <linux/err.h>
14 #include <linux/device.h>
15 #include <linux/slab.h>
17 #include <linux/phy/phy.h>
18 #include <linux/idr.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/regulator/consumer.h>
22 static struct class *phy_class;
23 static DEFINE_MUTEX(phy_provider_mutex);
24 static LIST_HEAD(phy_provider_list);
25 static LIST_HEAD(phys);
26 static DEFINE_IDA(phy_ida);
28 static void devm_phy_release(struct device *dev, void *res)
30 struct phy *phy = *(struct phy **)res;
35 static void devm_phy_provider_release(struct device *dev, void *res)
37 struct phy_provider *phy_provider = *(struct phy_provider **)res;
39 of_phy_provider_unregister(phy_provider);
42 static void devm_phy_consume(struct device *dev, void *res)
44 struct phy *phy = *(struct phy **)res;
49 static int devm_phy_match(struct device *dev, void *res, void *match_data)
51 struct phy **phy = res;
53 return *phy == match_data;
57 * phy_create_lookup() - allocate and register PHY/device association
58 * @phy: the phy of the association
59 * @con_id: connection ID string on device
60 * @dev_id: the device of the association
62 * Creates and registers phy_lookup entry.
64 int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
66 struct phy_lookup *pl;
68 if (!phy || !dev_id || !con_id)
71 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
79 mutex_lock(&phy_provider_mutex);
80 list_add_tail(&pl->node, &phys);
81 mutex_unlock(&phy_provider_mutex);
85 EXPORT_SYMBOL_GPL(phy_create_lookup);
88 * phy_remove_lookup() - find and remove PHY/device association
89 * @phy: the phy of the association
90 * @con_id: connection ID string on device
91 * @dev_id: the device of the association
93 * Finds and unregisters phy_lookup entry that was created with
94 * phy_create_lookup().
96 void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id)
98 struct phy_lookup *pl;
100 if (!phy || !dev_id || !con_id)
103 mutex_lock(&phy_provider_mutex);
104 list_for_each_entry(pl, &phys, node)
105 if (pl->phy == phy && !strcmp(pl->dev_id, dev_id) &&
106 !strcmp(pl->con_id, con_id)) {
111 mutex_unlock(&phy_provider_mutex);
113 EXPORT_SYMBOL_GPL(phy_remove_lookup);
115 static struct phy *phy_find(struct device *dev, const char *con_id)
117 const char *dev_id = dev_name(dev);
118 struct phy_lookup *p, *pl = NULL;
120 mutex_lock(&phy_provider_mutex);
121 list_for_each_entry(p, &phys, node)
122 if (!strcmp(p->dev_id, dev_id) && !strcmp(p->con_id, con_id)) {
126 mutex_unlock(&phy_provider_mutex);
128 return pl ? pl->phy : ERR_PTR(-ENODEV);
131 static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
133 struct phy_provider *phy_provider;
134 struct device_node *child;
136 list_for_each_entry(phy_provider, &phy_provider_list, list) {
137 if (phy_provider->dev->of_node == node)
140 for_each_child_of_node(phy_provider->children, child)
145 return ERR_PTR(-EPROBE_DEFER);
148 int phy_pm_runtime_get(struct phy *phy)
155 if (!pm_runtime_enabled(&phy->dev))
158 ret = pm_runtime_get(&phy->dev);
159 if (ret < 0 && ret != -EINPROGRESS)
160 pm_runtime_put_noidle(&phy->dev);
164 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
166 int phy_pm_runtime_get_sync(struct phy *phy)
173 if (!pm_runtime_enabled(&phy->dev))
176 ret = pm_runtime_get_sync(&phy->dev);
178 pm_runtime_put_sync(&phy->dev);
182 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
184 int phy_pm_runtime_put(struct phy *phy)
189 if (!pm_runtime_enabled(&phy->dev))
192 return pm_runtime_put(&phy->dev);
194 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
196 int phy_pm_runtime_put_sync(struct phy *phy)
201 if (!pm_runtime_enabled(&phy->dev))
204 return pm_runtime_put_sync(&phy->dev);
206 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
208 void phy_pm_runtime_allow(struct phy *phy)
213 if (!pm_runtime_enabled(&phy->dev))
216 pm_runtime_allow(&phy->dev);
218 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
220 void phy_pm_runtime_forbid(struct phy *phy)
225 if (!pm_runtime_enabled(&phy->dev))
228 pm_runtime_forbid(&phy->dev);
230 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
232 int phy_init(struct phy *phy)
239 ret = phy_pm_runtime_get_sync(phy);
240 if (ret < 0 && ret != -ENOTSUPP)
242 ret = 0; /* Override possible ret == -ENOTSUPP */
244 mutex_lock(&phy->mutex);
245 if (phy->init_count == 0 && phy->ops->init) {
246 ret = phy->ops->init(phy);
248 dev_err(&phy->dev, "phy init failed --> %d\n", ret);
255 mutex_unlock(&phy->mutex);
256 phy_pm_runtime_put(phy);
259 EXPORT_SYMBOL_GPL(phy_init);
261 int phy_exit(struct phy *phy)
268 ret = phy_pm_runtime_get_sync(phy);
269 if (ret < 0 && ret != -ENOTSUPP)
271 ret = 0; /* Override possible ret == -ENOTSUPP */
273 mutex_lock(&phy->mutex);
274 if (phy->init_count == 1 && phy->ops->exit) {
275 ret = phy->ops->exit(phy);
277 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
284 mutex_unlock(&phy->mutex);
285 phy_pm_runtime_put(phy);
288 EXPORT_SYMBOL_GPL(phy_exit);
290 int phy_power_on(struct phy *phy)
298 ret = regulator_enable(phy->pwr);
303 ret = phy_pm_runtime_get_sync(phy);
304 if (ret < 0 && ret != -ENOTSUPP)
307 ret = 0; /* Override possible ret == -ENOTSUPP */
309 mutex_lock(&phy->mutex);
310 if (phy->power_count == 0 && phy->ops->power_on) {
311 ret = phy->ops->power_on(phy);
313 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
318 mutex_unlock(&phy->mutex);
322 mutex_unlock(&phy->mutex);
323 phy_pm_runtime_put_sync(phy);
326 regulator_disable(phy->pwr);
330 EXPORT_SYMBOL_GPL(phy_power_on);
332 int phy_power_off(struct phy *phy)
339 mutex_lock(&phy->mutex);
340 if (phy->power_count == 1 && phy->ops->power_off) {
341 ret = phy->ops->power_off(phy);
343 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
344 mutex_unlock(&phy->mutex);
349 mutex_unlock(&phy->mutex);
350 phy_pm_runtime_put(phy);
353 regulator_disable(phy->pwr);
357 EXPORT_SYMBOL_GPL(phy_power_off);
359 int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode)
363 if (!phy || !phy->ops->set_mode)
366 mutex_lock(&phy->mutex);
367 ret = phy->ops->set_mode(phy, mode, submode);
369 phy->attrs.mode = mode;
370 mutex_unlock(&phy->mutex);
374 EXPORT_SYMBOL_GPL(phy_set_mode_ext);
376 int phy_reset(struct phy *phy)
380 if (!phy || !phy->ops->reset)
383 ret = phy_pm_runtime_get_sync(phy);
384 if (ret < 0 && ret != -ENOTSUPP)
387 mutex_lock(&phy->mutex);
388 ret = phy->ops->reset(phy);
389 mutex_unlock(&phy->mutex);
391 phy_pm_runtime_put(phy);
395 EXPORT_SYMBOL_GPL(phy_reset);
398 * phy_calibrate() - Tunes the phy hw parameters for current configuration
399 * @phy: the phy returned by phy_get()
401 * Used to calibrate phy hardware, typically by adjusting some parameters in
402 * runtime, which are otherwise lost after host controller reset and cannot
403 * be applied in phy_init() or phy_power_on().
405 * Returns: 0 if successful, an negative error code otherwise
407 int phy_calibrate(struct phy *phy)
411 if (!phy || !phy->ops->calibrate)
414 mutex_lock(&phy->mutex);
415 ret = phy->ops->calibrate(phy);
416 mutex_unlock(&phy->mutex);
420 EXPORT_SYMBOL_GPL(phy_calibrate);
423 * phy_configure() - Changes the phy parameters
424 * @phy: the phy returned by phy_get()
425 * @opts: New configuration to apply
427 * Used to change the PHY parameters. phy_init() must have been called
428 * on the phy. The configuration will be applied on the current phy
429 * mode, that can be changed using phy_set_mode().
431 * Returns: 0 if successful, an negative error code otherwise
433 int phy_configure(struct phy *phy, union phy_configure_opts *opts)
440 if (!phy->ops->configure)
443 mutex_lock(&phy->mutex);
444 ret = phy->ops->configure(phy, opts);
445 mutex_unlock(&phy->mutex);
449 EXPORT_SYMBOL_GPL(phy_configure);
452 * phy_validate() - Checks the phy parameters
453 * @phy: the phy returned by phy_get()
454 * @mode: phy_mode the configuration is applicable to.
455 * @submode: PHY submode the configuration is applicable to.
456 * @opts: Configuration to check
458 * Used to check that the current set of parameters can be handled by
459 * the phy. Implementations are free to tune the parameters passed as
460 * arguments if needed by some implementation detail or
461 * constraints. It will not change any actual configuration of the
462 * PHY, so calling it as many times as deemed fit will have no side
465 * Returns: 0 if successful, an negative error code otherwise
467 int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
468 union phy_configure_opts *opts)
475 if (!phy->ops->validate)
478 mutex_lock(&phy->mutex);
479 ret = phy->ops->validate(phy, mode, submode, opts);
480 mutex_unlock(&phy->mutex);
484 EXPORT_SYMBOL_GPL(phy_validate);
487 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
488 * @np: device_node for which to get the phy
489 * @index: the index of the phy
491 * Returns the phy associated with the given phandle value,
492 * after getting a refcount to it or -ENODEV if there is no such phy or
493 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
494 * not yet loaded. This function uses of_xlate call back function provided
495 * while registering the phy_provider to find the phy instance.
497 static struct phy *_of_phy_get(struct device_node *np, int index)
500 struct phy_provider *phy_provider;
501 struct phy *phy = NULL;
502 struct of_phandle_args args;
504 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
507 return ERR_PTR(-ENODEV);
509 /* This phy type handled by the usb-phy subsystem for now */
510 if (of_device_is_compatible(args.np, "usb-nop-xceiv"))
511 return ERR_PTR(-ENODEV);
513 mutex_lock(&phy_provider_mutex);
514 phy_provider = of_phy_provider_lookup(args.np);
515 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
516 phy = ERR_PTR(-EPROBE_DEFER);
520 if (!of_device_is_available(args.np)) {
521 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
522 phy = ERR_PTR(-ENODEV);
526 phy = phy_provider->of_xlate(phy_provider->dev, &args);
529 module_put(phy_provider->owner);
532 mutex_unlock(&phy_provider_mutex);
533 of_node_put(args.np);
539 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
540 * @np: device_node for which to get the phy
541 * @con_id: name of the phy from device's point of view
543 * Returns the phy driver, after getting a refcount to it; or
544 * -ENODEV if there is no such phy. The caller is responsible for
545 * calling phy_put() to release that count.
547 struct phy *of_phy_get(struct device_node *np, const char *con_id)
549 struct phy *phy = NULL;
553 index = of_property_match_string(np, "phy-names", con_id);
555 phy = _of_phy_get(np, index);
559 if (!try_module_get(phy->ops->owner))
560 return ERR_PTR(-EPROBE_DEFER);
562 get_device(&phy->dev);
566 EXPORT_SYMBOL_GPL(of_phy_get);
569 * of_phy_put() - release the PHY
570 * @phy: the phy returned by of_phy_get()
572 * Releases a refcount the caller received from of_phy_get().
574 void of_phy_put(struct phy *phy)
576 if (!phy || IS_ERR(phy))
579 mutex_lock(&phy->mutex);
580 if (phy->ops->release)
581 phy->ops->release(phy);
582 mutex_unlock(&phy->mutex);
584 module_put(phy->ops->owner);
585 put_device(&phy->dev);
587 EXPORT_SYMBOL_GPL(of_phy_put);
590 * phy_put() - release the PHY
591 * @dev: device that wants to release this phy
592 * @phy: the phy returned by phy_get()
594 * Releases a refcount the caller received from phy_get().
596 void phy_put(struct device *dev, struct phy *phy)
598 device_link_remove(dev, &phy->dev);
601 EXPORT_SYMBOL_GPL(phy_put);
604 * devm_phy_put() - release the PHY
605 * @dev: device that wants to release this phy
606 * @phy: the phy returned by devm_phy_get()
608 * destroys the devres associated with this phy and invokes phy_put
609 * to release the phy.
611 void devm_phy_put(struct device *dev, struct phy *phy)
618 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
619 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
621 EXPORT_SYMBOL_GPL(devm_phy_put);
624 * of_phy_simple_xlate() - returns the phy instance from phy provider
625 * @dev: the PHY provider device
626 * @args: of_phandle_args (not used here)
628 * Intended to be used by phy provider for the common case where #phy-cells is
629 * 0. For other cases where #phy-cells is greater than '0', the phy provider
630 * should provide a custom of_xlate function that reads the *args* and returns
631 * the appropriate phy.
633 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
637 struct class_dev_iter iter;
639 class_dev_iter_init(&iter, phy_class, NULL, NULL);
640 while ((dev = class_dev_iter_next(&iter))) {
642 if (args->np != phy->dev.of_node)
645 class_dev_iter_exit(&iter);
649 class_dev_iter_exit(&iter);
650 return ERR_PTR(-ENODEV);
652 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
655 * phy_get() - lookup and obtain a reference to a phy.
656 * @dev: device that requests this phy
657 * @string: the phy name as given in the dt data or the name of the controller
658 * port for non-dt case
660 * Returns the phy driver, after getting a refcount to it; or
661 * -ENODEV if there is no such phy. The caller is responsible for
662 * calling phy_put() to release that count.
664 struct phy *phy_get(struct device *dev, const char *string)
668 struct device_link *link;
670 if (string == NULL) {
671 dev_WARN(dev, "missing string\n");
672 return ERR_PTR(-EINVAL);
676 index = of_property_match_string(dev->of_node, "phy-names",
678 phy = _of_phy_get(dev->of_node, index);
680 phy = phy_find(dev, string);
685 if (!try_module_get(phy->ops->owner))
686 return ERR_PTR(-EPROBE_DEFER);
688 get_device(&phy->dev);
690 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
692 dev_dbg(dev, "failed to create device link to %s\n",
693 dev_name(phy->dev.parent));
697 EXPORT_SYMBOL_GPL(phy_get);
700 * phy_optional_get() - lookup and obtain a reference to an optional phy.
701 * @dev: device that requests this phy
702 * @string: the phy name as given in the dt data or the name of the controller
703 * port for non-dt case
705 * Returns the phy driver, after getting a refcount to it; or
706 * NULL if there is no such phy. The caller is responsible for
707 * calling phy_put() to release that count.
709 struct phy *phy_optional_get(struct device *dev, const char *string)
711 struct phy *phy = phy_get(dev, string);
713 if (PTR_ERR(phy) == -ENODEV)
718 EXPORT_SYMBOL_GPL(phy_optional_get);
721 * devm_phy_get() - lookup and obtain a reference to a phy.
722 * @dev: device that requests this phy
723 * @string: the phy name as given in the dt data or phy device name
726 * Gets the phy using phy_get(), and associates a device with it using
727 * devres. On driver detach, release function is invoked on the devres data,
728 * then, devres data is freed.
730 struct phy *devm_phy_get(struct device *dev, const char *string)
732 struct phy **ptr, *phy;
734 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
736 return ERR_PTR(-ENOMEM);
738 phy = phy_get(dev, string);
741 devres_add(dev, ptr);
748 EXPORT_SYMBOL_GPL(devm_phy_get);
751 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
752 * @dev: device that requests this phy
753 * @string: the phy name as given in the dt data or phy device name
756 * Gets the phy using phy_get(), and associates a device with it using
757 * devres. On driver detach, release function is invoked on the devres
758 * data, then, devres data is freed. This differs to devm_phy_get() in
759 * that if the phy does not exist, it is not considered an error and
760 * -ENODEV will not be returned. Instead the NULL phy is returned,
761 * which can be passed to all other phy consumer calls.
763 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
765 struct phy *phy = devm_phy_get(dev, string);
767 if (PTR_ERR(phy) == -ENODEV)
772 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
775 * devm_of_phy_get() - lookup and obtain a reference to a phy.
776 * @dev: device that requests this phy
777 * @np: node containing the phy
778 * @con_id: name of the phy from device's point of view
780 * Gets the phy using of_phy_get(), and associates a device with it using
781 * devres. On driver detach, release function is invoked on the devres data,
782 * then, devres data is freed.
784 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
787 struct phy **ptr, *phy;
788 struct device_link *link;
790 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
792 return ERR_PTR(-ENOMEM);
794 phy = of_phy_get(np, con_id);
797 devres_add(dev, ptr);
803 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
805 dev_dbg(dev, "failed to create device link to %s\n",
806 dev_name(phy->dev.parent));
810 EXPORT_SYMBOL_GPL(devm_of_phy_get);
813 * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
814 * @dev: device that requests this phy
815 * @np: node containing the phy
816 * @index: index of the phy
818 * Gets the phy using _of_phy_get(), then gets a refcount to it,
819 * and associates a device with it using devres. On driver detach,
820 * release function is invoked on the devres data,
821 * then, devres data is freed.
824 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
827 struct phy **ptr, *phy;
828 struct device_link *link;
830 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
832 return ERR_PTR(-ENOMEM);
834 phy = _of_phy_get(np, index);
840 if (!try_module_get(phy->ops->owner)) {
842 return ERR_PTR(-EPROBE_DEFER);
845 get_device(&phy->dev);
848 devres_add(dev, ptr);
850 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
852 dev_dbg(dev, "failed to create device link to %s\n",
853 dev_name(phy->dev.parent));
857 EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
860 * phy_create() - create a new phy
861 * @dev: device that is creating the new phy
862 * @node: device node of the phy
863 * @ops: function pointers for performing phy operations
865 * Called to create a phy using phy framework.
867 struct phy *phy_create(struct device *dev, struct device_node *node,
868 const struct phy_ops *ops)
875 return ERR_PTR(-EINVAL);
877 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
879 return ERR_PTR(-ENOMEM);
881 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
883 dev_err(dev, "unable to get id\n");
888 device_initialize(&phy->dev);
889 mutex_init(&phy->mutex);
891 phy->dev.class = phy_class;
892 phy->dev.parent = dev;
893 phy->dev.of_node = node ?: dev->of_node;
897 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
902 phy->pwr = regulator_get_optional(&phy->dev, "phy");
903 if (IS_ERR(phy->pwr)) {
904 ret = PTR_ERR(phy->pwr);
905 if (ret == -EPROBE_DEFER)
911 ret = device_add(&phy->dev);
915 if (pm_runtime_enabled(dev)) {
916 pm_runtime_enable(&phy->dev);
917 pm_runtime_no_callbacks(&phy->dev);
923 put_device(&phy->dev); /* calls phy_release() which frees resources */
930 EXPORT_SYMBOL_GPL(phy_create);
933 * devm_phy_create() - create a new phy
934 * @dev: device that is creating the new phy
935 * @node: device node of the phy
936 * @ops: function pointers for performing phy operations
938 * Creates a new PHY device adding it to the PHY class.
939 * While at that, it also associates the device with the phy using devres.
940 * On driver detach, release function is invoked on the devres data,
941 * then, devres data is freed.
943 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
944 const struct phy_ops *ops)
946 struct phy **ptr, *phy;
948 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
950 return ERR_PTR(-ENOMEM);
952 phy = phy_create(dev, node, ops);
955 devres_add(dev, ptr);
962 EXPORT_SYMBOL_GPL(devm_phy_create);
965 * phy_destroy() - destroy the phy
966 * @phy: the phy to be destroyed
968 * Called to destroy the phy.
970 void phy_destroy(struct phy *phy)
972 pm_runtime_disable(&phy->dev);
973 device_unregister(&phy->dev);
975 EXPORT_SYMBOL_GPL(phy_destroy);
978 * devm_phy_destroy() - destroy the PHY
979 * @dev: device that wants to release this phy
980 * @phy: the phy returned by devm_phy_get()
982 * destroys the devres associated with this phy and invokes phy_destroy
983 * to destroy the phy.
985 void devm_phy_destroy(struct device *dev, struct phy *phy)
989 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
990 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
992 EXPORT_SYMBOL_GPL(devm_phy_destroy);
995 * __of_phy_provider_register() - create/register phy provider with the framework
996 * @dev: struct device of the phy provider
997 * @children: device node containing children (if different from dev->of_node)
998 * @owner: the module owner containing of_xlate
999 * @of_xlate: function pointer to obtain phy instance from phy provider
1001 * Creates struct phy_provider from dev and of_xlate function pointer.
1002 * This is used in the case of dt boot for finding the phy instance from
1005 * If the PHY provider doesn't nest children directly but uses a separate
1006 * child node to contain the individual children, the @children parameter
1007 * can be used to override the default. If NULL, the default (dev->of_node)
1008 * will be used. If non-NULL, the device node must be a child (or further
1009 * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL
1010 * error code is returned.
1012 struct phy_provider *__of_phy_provider_register(struct device *dev,
1013 struct device_node *children, struct module *owner,
1014 struct phy * (*of_xlate)(struct device *dev,
1015 struct of_phandle_args *args))
1017 struct phy_provider *phy_provider;
1020 * If specified, the device node containing the children must itself
1021 * be the provider's device node or a child (or further descendant)
1025 struct device_node *parent = of_node_get(children), *next;
1028 if (parent == dev->of_node)
1031 next = of_get_parent(parent);
1032 of_node_put(parent);
1037 return ERR_PTR(-EINVAL);
1039 of_node_put(parent);
1041 children = dev->of_node;
1044 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
1046 return ERR_PTR(-ENOMEM);
1048 phy_provider->dev = dev;
1049 phy_provider->children = of_node_get(children);
1050 phy_provider->owner = owner;
1051 phy_provider->of_xlate = of_xlate;
1053 mutex_lock(&phy_provider_mutex);
1054 list_add_tail(&phy_provider->list, &phy_provider_list);
1055 mutex_unlock(&phy_provider_mutex);
1057 return phy_provider;
1059 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
1062 * __devm_of_phy_provider_register() - create/register phy provider with the
1064 * @dev: struct device of the phy provider
1065 * @children: device node containing children (if different from dev->of_node)
1066 * @owner: the module owner containing of_xlate
1067 * @of_xlate: function pointer to obtain phy instance from phy provider
1069 * Creates struct phy_provider from dev and of_xlate function pointer.
1070 * This is used in the case of dt boot for finding the phy instance from
1071 * phy provider. While at that, it also associates the device with the
1072 * phy provider using devres. On driver detach, release function is invoked
1073 * on the devres data, then, devres data is freed.
1075 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
1076 struct device_node *children, struct module *owner,
1077 struct phy * (*of_xlate)(struct device *dev,
1078 struct of_phandle_args *args))
1080 struct phy_provider **ptr, *phy_provider;
1082 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
1084 return ERR_PTR(-ENOMEM);
1086 phy_provider = __of_phy_provider_register(dev, children, owner,
1088 if (!IS_ERR(phy_provider)) {
1089 *ptr = phy_provider;
1090 devres_add(dev, ptr);
1095 return phy_provider;
1097 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
1100 * of_phy_provider_unregister() - unregister phy provider from the framework
1101 * @phy_provider: phy provider returned by of_phy_provider_register()
1103 * Removes the phy_provider created using of_phy_provider_register().
1105 void of_phy_provider_unregister(struct phy_provider *phy_provider)
1107 if (IS_ERR(phy_provider))
1110 mutex_lock(&phy_provider_mutex);
1111 list_del(&phy_provider->list);
1112 of_node_put(phy_provider->children);
1113 kfree(phy_provider);
1114 mutex_unlock(&phy_provider_mutex);
1116 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
1119 * devm_of_phy_provider_unregister() - remove phy provider from the framework
1120 * @dev: struct device of the phy provider
1121 * @phy_provider: phy provider returned by of_phy_provider_register()
1123 * destroys the devres associated with this phy provider and invokes
1124 * of_phy_provider_unregister to unregister the phy provider.
1126 void devm_of_phy_provider_unregister(struct device *dev,
1127 struct phy_provider *phy_provider)
1131 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
1133 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
1135 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
1138 * phy_release() - release the phy
1139 * @dev: the dev member within phy
1141 * When the last reference to the device is removed, it is called
1142 * from the embedded kobject as release method.
1144 static void phy_release(struct device *dev)
1149 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
1150 regulator_put(phy->pwr);
1151 ida_simple_remove(&phy_ida, phy->id);
1155 static int __init phy_core_init(void)
1157 phy_class = class_create(THIS_MODULE, "phy");
1158 if (IS_ERR(phy_class)) {
1159 pr_err("failed to create phy class --> %ld\n",
1160 PTR_ERR(phy_class));
1161 return PTR_ERR(phy_class);
1164 phy_class->dev_release = phy_release;
1168 device_initcall(phy_core_init);