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_set_media(struct phy *phy, enum phy_media media)
380 if (!phy || !phy->ops->set_media)
383 mutex_lock(&phy->mutex);
384 ret = phy->ops->set_media(phy, media);
385 mutex_unlock(&phy->mutex);
389 EXPORT_SYMBOL_GPL(phy_set_media);
391 int phy_set_speed(struct phy *phy, int speed)
395 if (!phy || !phy->ops->set_speed)
398 mutex_lock(&phy->mutex);
399 ret = phy->ops->set_speed(phy, speed);
400 mutex_unlock(&phy->mutex);
404 EXPORT_SYMBOL_GPL(phy_set_speed);
406 int phy_reset(struct phy *phy)
410 if (!phy || !phy->ops->reset)
413 ret = phy_pm_runtime_get_sync(phy);
414 if (ret < 0 && ret != -ENOTSUPP)
417 mutex_lock(&phy->mutex);
418 ret = phy->ops->reset(phy);
419 mutex_unlock(&phy->mutex);
421 phy_pm_runtime_put(phy);
425 EXPORT_SYMBOL_GPL(phy_reset);
428 * phy_calibrate() - Tunes the phy hw parameters for current configuration
429 * @phy: the phy returned by phy_get()
431 * Used to calibrate phy hardware, typically by adjusting some parameters in
432 * runtime, which are otherwise lost after host controller reset and cannot
433 * be applied in phy_init() or phy_power_on().
435 * Returns: 0 if successful, an negative error code otherwise
437 int phy_calibrate(struct phy *phy)
441 if (!phy || !phy->ops->calibrate)
444 mutex_lock(&phy->mutex);
445 ret = phy->ops->calibrate(phy);
446 mutex_unlock(&phy->mutex);
450 EXPORT_SYMBOL_GPL(phy_calibrate);
453 * phy_configure() - Changes the phy parameters
454 * @phy: the phy returned by phy_get()
455 * @opts: New configuration to apply
457 * Used to change the PHY parameters. phy_init() must have been called
458 * on the phy. The configuration will be applied on the current phy
459 * mode, that can be changed using phy_set_mode().
461 * Returns: 0 if successful, an negative error code otherwise
463 int phy_configure(struct phy *phy, union phy_configure_opts *opts)
470 if (!phy->ops->configure)
473 mutex_lock(&phy->mutex);
474 ret = phy->ops->configure(phy, opts);
475 mutex_unlock(&phy->mutex);
479 EXPORT_SYMBOL_GPL(phy_configure);
482 * phy_validate() - Checks the phy parameters
483 * @phy: the phy returned by phy_get()
484 * @mode: phy_mode the configuration is applicable to.
485 * @submode: PHY submode the configuration is applicable to.
486 * @opts: Configuration to check
488 * Used to check that the current set of parameters can be handled by
489 * the phy. Implementations are free to tune the parameters passed as
490 * arguments if needed by some implementation detail or
491 * constraints. It will not change any actual configuration of the
492 * PHY, so calling it as many times as deemed fit will have no side
495 * Returns: 0 if successful, an negative error code otherwise
497 int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
498 union phy_configure_opts *opts)
505 if (!phy->ops->validate)
508 mutex_lock(&phy->mutex);
509 ret = phy->ops->validate(phy, mode, submode, opts);
510 mutex_unlock(&phy->mutex);
514 EXPORT_SYMBOL_GPL(phy_validate);
517 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
518 * @np: device_node for which to get the phy
519 * @index: the index of the phy
521 * Returns the phy associated with the given phandle value,
522 * after getting a refcount to it or -ENODEV if there is no such phy or
523 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
524 * not yet loaded. This function uses of_xlate call back function provided
525 * while registering the phy_provider to find the phy instance.
527 static struct phy *_of_phy_get(struct device_node *np, int index)
530 struct phy_provider *phy_provider;
531 struct phy *phy = NULL;
532 struct of_phandle_args args;
534 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
537 return ERR_PTR(-ENODEV);
539 /* This phy type handled by the usb-phy subsystem for now */
540 if (of_device_is_compatible(args.np, "usb-nop-xceiv"))
541 return ERR_PTR(-ENODEV);
543 mutex_lock(&phy_provider_mutex);
544 phy_provider = of_phy_provider_lookup(args.np);
545 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
546 phy = ERR_PTR(-EPROBE_DEFER);
550 if (!of_device_is_available(args.np)) {
551 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
552 phy = ERR_PTR(-ENODEV);
556 phy = phy_provider->of_xlate(phy_provider->dev, &args);
559 module_put(phy_provider->owner);
562 mutex_unlock(&phy_provider_mutex);
563 of_node_put(args.np);
569 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
570 * @np: device_node for which to get the phy
571 * @con_id: name of the phy from device's point of view
573 * Returns the phy driver, after getting a refcount to it; or
574 * -ENODEV if there is no such phy. The caller is responsible for
575 * calling phy_put() to release that count.
577 struct phy *of_phy_get(struct device_node *np, const char *con_id)
579 struct phy *phy = NULL;
583 index = of_property_match_string(np, "phy-names", con_id);
585 phy = _of_phy_get(np, index);
589 if (!try_module_get(phy->ops->owner))
590 return ERR_PTR(-EPROBE_DEFER);
592 get_device(&phy->dev);
596 EXPORT_SYMBOL_GPL(of_phy_get);
599 * of_phy_put() - release the PHY
600 * @phy: the phy returned by of_phy_get()
602 * Releases a refcount the caller received from of_phy_get().
604 void of_phy_put(struct phy *phy)
606 if (!phy || IS_ERR(phy))
609 mutex_lock(&phy->mutex);
610 if (phy->ops->release)
611 phy->ops->release(phy);
612 mutex_unlock(&phy->mutex);
614 module_put(phy->ops->owner);
615 put_device(&phy->dev);
617 EXPORT_SYMBOL_GPL(of_phy_put);
620 * phy_put() - release the PHY
621 * @dev: device that wants to release this phy
622 * @phy: the phy returned by phy_get()
624 * Releases a refcount the caller received from phy_get().
626 void phy_put(struct device *dev, struct phy *phy)
628 device_link_remove(dev, &phy->dev);
631 EXPORT_SYMBOL_GPL(phy_put);
634 * devm_phy_put() - release the PHY
635 * @dev: device that wants to release this phy
636 * @phy: the phy returned by devm_phy_get()
638 * destroys the devres associated with this phy and invokes phy_put
639 * to release the phy.
641 void devm_phy_put(struct device *dev, struct phy *phy)
648 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
649 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
651 EXPORT_SYMBOL_GPL(devm_phy_put);
654 * of_phy_simple_xlate() - returns the phy instance from phy provider
655 * @dev: the PHY provider device
656 * @args: of_phandle_args (not used here)
658 * Intended to be used by phy provider for the common case where #phy-cells is
659 * 0. For other cases where #phy-cells is greater than '0', the phy provider
660 * should provide a custom of_xlate function that reads the *args* and returns
661 * the appropriate phy.
663 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
667 struct class_dev_iter iter;
669 class_dev_iter_init(&iter, phy_class, NULL, NULL);
670 while ((dev = class_dev_iter_next(&iter))) {
672 if (args->np != phy->dev.of_node)
675 class_dev_iter_exit(&iter);
679 class_dev_iter_exit(&iter);
680 return ERR_PTR(-ENODEV);
682 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
685 * phy_get() - lookup and obtain a reference to a phy.
686 * @dev: device that requests this phy
687 * @string: the phy name as given in the dt data or the name of the controller
688 * port for non-dt case
690 * Returns the phy driver, after getting a refcount to it; or
691 * -ENODEV if there is no such phy. The caller is responsible for
692 * calling phy_put() to release that count.
694 struct phy *phy_get(struct device *dev, const char *string)
698 struct device_link *link;
700 if (string == NULL) {
701 dev_WARN(dev, "missing string\n");
702 return ERR_PTR(-EINVAL);
706 index = of_property_match_string(dev->of_node, "phy-names",
708 phy = _of_phy_get(dev->of_node, index);
710 phy = phy_find(dev, string);
715 if (!try_module_get(phy->ops->owner))
716 return ERR_PTR(-EPROBE_DEFER);
718 get_device(&phy->dev);
720 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
722 dev_dbg(dev, "failed to create device link to %s\n",
723 dev_name(phy->dev.parent));
727 EXPORT_SYMBOL_GPL(phy_get);
730 * phy_optional_get() - lookup and obtain a reference to an optional phy.
731 * @dev: device that requests this phy
732 * @string: the phy name as given in the dt data or the name of the controller
733 * port for non-dt case
735 * Returns the phy driver, after getting a refcount to it; or
736 * NULL if there is no such phy. The caller is responsible for
737 * calling phy_put() to release that count.
739 struct phy *phy_optional_get(struct device *dev, const char *string)
741 struct phy *phy = phy_get(dev, string);
743 if (PTR_ERR(phy) == -ENODEV)
748 EXPORT_SYMBOL_GPL(phy_optional_get);
751 * devm_phy_get() - lookup and obtain a reference to a 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 data,
758 * then, devres data is freed.
760 struct phy *devm_phy_get(struct device *dev, const char *string)
762 struct phy **ptr, *phy;
764 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
766 return ERR_PTR(-ENOMEM);
768 phy = phy_get(dev, string);
771 devres_add(dev, ptr);
778 EXPORT_SYMBOL_GPL(devm_phy_get);
781 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
782 * @dev: device that requests this phy
783 * @string: the phy name as given in the dt data or phy device name
786 * Gets the phy using phy_get(), and associates a device with it using
787 * devres. On driver detach, release function is invoked on the devres
788 * data, then, devres data is freed. This differs to devm_phy_get() in
789 * that if the phy does not exist, it is not considered an error and
790 * -ENODEV will not be returned. Instead the NULL phy is returned,
791 * which can be passed to all other phy consumer calls.
793 struct phy *devm_phy_optional_get(struct device *dev, const char *string)
795 struct phy *phy = devm_phy_get(dev, string);
797 if (PTR_ERR(phy) == -ENODEV)
802 EXPORT_SYMBOL_GPL(devm_phy_optional_get);
805 * devm_of_phy_get() - lookup and obtain a reference to a phy.
806 * @dev: device that requests this phy
807 * @np: node containing the phy
808 * @con_id: name of the phy from device's point of view
810 * Gets the phy using of_phy_get(), and associates a device with it using
811 * devres. On driver detach, release function is invoked on the devres data,
812 * then, devres data is freed.
814 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
817 struct phy **ptr, *phy;
818 struct device_link *link;
820 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
822 return ERR_PTR(-ENOMEM);
824 phy = of_phy_get(np, con_id);
827 devres_add(dev, ptr);
833 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
835 dev_dbg(dev, "failed to create device link to %s\n",
836 dev_name(phy->dev.parent));
840 EXPORT_SYMBOL_GPL(devm_of_phy_get);
843 * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
844 * @dev: device that requests this phy
845 * @np: node containing the phy
846 * @index: index of the phy
848 * Gets the phy using _of_phy_get(), then gets a refcount to it,
849 * and associates a device with it using devres. On driver detach,
850 * release function is invoked on the devres data,
851 * then, devres data is freed.
854 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
857 struct phy **ptr, *phy;
858 struct device_link *link;
860 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
862 return ERR_PTR(-ENOMEM);
864 phy = _of_phy_get(np, index);
870 if (!try_module_get(phy->ops->owner)) {
872 return ERR_PTR(-EPROBE_DEFER);
875 get_device(&phy->dev);
878 devres_add(dev, ptr);
880 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
882 dev_dbg(dev, "failed to create device link to %s\n",
883 dev_name(phy->dev.parent));
887 EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
890 * phy_create() - create a new phy
891 * @dev: device that is creating the new phy
892 * @node: device node of the phy
893 * @ops: function pointers for performing phy operations
895 * Called to create a phy using phy framework.
897 struct phy *phy_create(struct device *dev, struct device_node *node,
898 const struct phy_ops *ops)
905 return ERR_PTR(-EINVAL);
907 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
909 return ERR_PTR(-ENOMEM);
911 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
913 dev_err(dev, "unable to get id\n");
918 device_initialize(&phy->dev);
919 mutex_init(&phy->mutex);
921 phy->dev.class = phy_class;
922 phy->dev.parent = dev;
923 phy->dev.of_node = node ?: dev->of_node;
927 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
932 phy->pwr = regulator_get_optional(&phy->dev, "phy");
933 if (IS_ERR(phy->pwr)) {
934 ret = PTR_ERR(phy->pwr);
935 if (ret == -EPROBE_DEFER)
941 ret = device_add(&phy->dev);
945 if (pm_runtime_enabled(dev)) {
946 pm_runtime_enable(&phy->dev);
947 pm_runtime_no_callbacks(&phy->dev);
953 put_device(&phy->dev); /* calls phy_release() which frees resources */
960 EXPORT_SYMBOL_GPL(phy_create);
963 * devm_phy_create() - create a new phy
964 * @dev: device that is creating the new phy
965 * @node: device node of the phy
966 * @ops: function pointers for performing phy operations
968 * Creates a new PHY device adding it to the PHY class.
969 * While at that, it also associates the device with the phy using devres.
970 * On driver detach, release function is invoked on the devres data,
971 * then, devres data is freed.
973 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
974 const struct phy_ops *ops)
976 struct phy **ptr, *phy;
978 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
980 return ERR_PTR(-ENOMEM);
982 phy = phy_create(dev, node, ops);
985 devres_add(dev, ptr);
992 EXPORT_SYMBOL_GPL(devm_phy_create);
995 * phy_destroy() - destroy the phy
996 * @phy: the phy to be destroyed
998 * Called to destroy the phy.
1000 void phy_destroy(struct phy *phy)
1002 pm_runtime_disable(&phy->dev);
1003 device_unregister(&phy->dev);
1005 EXPORT_SYMBOL_GPL(phy_destroy);
1008 * devm_phy_destroy() - destroy the PHY
1009 * @dev: device that wants to release this phy
1010 * @phy: the phy returned by devm_phy_get()
1012 * destroys the devres associated with this phy and invokes phy_destroy
1013 * to destroy the phy.
1015 void devm_phy_destroy(struct device *dev, struct phy *phy)
1019 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
1020 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
1022 EXPORT_SYMBOL_GPL(devm_phy_destroy);
1025 * __of_phy_provider_register() - create/register phy provider with the framework
1026 * @dev: struct device of the phy provider
1027 * @children: device node containing children (if different from dev->of_node)
1028 * @owner: the module owner containing of_xlate
1029 * @of_xlate: function pointer to obtain phy instance from phy provider
1031 * Creates struct phy_provider from dev and of_xlate function pointer.
1032 * This is used in the case of dt boot for finding the phy instance from
1035 * If the PHY provider doesn't nest children directly but uses a separate
1036 * child node to contain the individual children, the @children parameter
1037 * can be used to override the default. If NULL, the default (dev->of_node)
1038 * will be used. If non-NULL, the device node must be a child (or further
1039 * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL
1040 * error code is returned.
1042 struct phy_provider *__of_phy_provider_register(struct device *dev,
1043 struct device_node *children, struct module *owner,
1044 struct phy * (*of_xlate)(struct device *dev,
1045 struct of_phandle_args *args))
1047 struct phy_provider *phy_provider;
1050 * If specified, the device node containing the children must itself
1051 * be the provider's device node or a child (or further descendant)
1055 struct device_node *parent = of_node_get(children), *next;
1058 if (parent == dev->of_node)
1061 next = of_get_parent(parent);
1062 of_node_put(parent);
1067 return ERR_PTR(-EINVAL);
1069 of_node_put(parent);
1071 children = dev->of_node;
1074 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
1076 return ERR_PTR(-ENOMEM);
1078 phy_provider->dev = dev;
1079 phy_provider->children = of_node_get(children);
1080 phy_provider->owner = owner;
1081 phy_provider->of_xlate = of_xlate;
1083 mutex_lock(&phy_provider_mutex);
1084 list_add_tail(&phy_provider->list, &phy_provider_list);
1085 mutex_unlock(&phy_provider_mutex);
1087 return phy_provider;
1089 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
1092 * __devm_of_phy_provider_register() - create/register phy provider with the
1094 * @dev: struct device of the phy provider
1095 * @children: device node containing children (if different from dev->of_node)
1096 * @owner: the module owner containing of_xlate
1097 * @of_xlate: function pointer to obtain phy instance from phy provider
1099 * Creates struct phy_provider from dev and of_xlate function pointer.
1100 * This is used in the case of dt boot for finding the phy instance from
1101 * phy provider. While at that, it also associates the device with the
1102 * phy provider using devres. On driver detach, release function is invoked
1103 * on the devres data, then, devres data is freed.
1105 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
1106 struct device_node *children, struct module *owner,
1107 struct phy * (*of_xlate)(struct device *dev,
1108 struct of_phandle_args *args))
1110 struct phy_provider **ptr, *phy_provider;
1112 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
1114 return ERR_PTR(-ENOMEM);
1116 phy_provider = __of_phy_provider_register(dev, children, owner,
1118 if (!IS_ERR(phy_provider)) {
1119 *ptr = phy_provider;
1120 devres_add(dev, ptr);
1125 return phy_provider;
1127 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
1130 * of_phy_provider_unregister() - unregister phy provider from the framework
1131 * @phy_provider: phy provider returned by of_phy_provider_register()
1133 * Removes the phy_provider created using of_phy_provider_register().
1135 void of_phy_provider_unregister(struct phy_provider *phy_provider)
1137 if (IS_ERR(phy_provider))
1140 mutex_lock(&phy_provider_mutex);
1141 list_del(&phy_provider->list);
1142 of_node_put(phy_provider->children);
1143 kfree(phy_provider);
1144 mutex_unlock(&phy_provider_mutex);
1146 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
1149 * devm_of_phy_provider_unregister() - remove phy provider from the framework
1150 * @dev: struct device of the phy provider
1151 * @phy_provider: phy provider returned by of_phy_provider_register()
1153 * destroys the devres associated with this phy provider and invokes
1154 * of_phy_provider_unregister to unregister the phy provider.
1156 void devm_of_phy_provider_unregister(struct device *dev,
1157 struct phy_provider *phy_provider)
1161 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
1163 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
1165 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
1168 * phy_release() - release the phy
1169 * @dev: the dev member within phy
1171 * When the last reference to the device is removed, it is called
1172 * from the embedded kobject as release method.
1174 static void phy_release(struct device *dev)
1179 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
1180 regulator_put(phy->pwr);
1181 ida_simple_remove(&phy_ida, phy->id);
1185 static int __init phy_core_init(void)
1187 phy_class = class_create(THIS_MODULE, "phy");
1188 if (IS_ERR(phy_class)) {
1189 pr_err("failed to create phy class --> %ld\n",
1190 PTR_ERR(phy_class));
1191 return PTR_ERR(phy_class);
1194 phy_class->dev_release = phy_release;
1198 device_initcall(phy_core_init);