Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * phy-core.c -- Generic Phy framework.
4 *
5 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
6 *
7 * Author: Kishon Vijay Abraham I <kishon@ti.com>
8 */
9
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>
16#include <linux/of.h>
17#include <linux/phy/phy.h>
18#include <linux/idr.h>
19#include <linux/pm_runtime.h>
20#include <linux/regulator/consumer.h>
21
22static struct class *phy_class;
23static DEFINE_MUTEX(phy_provider_mutex);
24static LIST_HEAD(phy_provider_list);
25static LIST_HEAD(phys);
26static DEFINE_IDA(phy_ida);
27
28static void devm_phy_release(struct device *dev, void *res)
29{
30 struct phy *phy = *(struct phy **)res;
31
32 phy_put(dev, phy);
33}
34
35static void devm_phy_provider_release(struct device *dev, void *res)
36{
37 struct phy_provider *phy_provider = *(struct phy_provider **)res;
38
39 of_phy_provider_unregister(phy_provider);
40}
41
42static void devm_phy_consume(struct device *dev, void *res)
43{
44 struct phy *phy = *(struct phy **)res;
45
46 phy_destroy(phy);
47}
48
49static int devm_phy_match(struct device *dev, void *res, void *match_data)
50{
51 struct phy **phy = res;
52
53 return *phy == match_data;
54}
55
56/**
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
61 *
62 * Creates and registers phy_lookup entry.
63 */
64int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
65{
66 struct phy_lookup *pl;
67
68 if (!phy || !dev_id || !con_id)
69 return -EINVAL;
70
71 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
72 if (!pl)
73 return -ENOMEM;
74
75 pl->dev_id = dev_id;
76 pl->con_id = con_id;
77 pl->phy = phy;
78
79 mutex_lock(&phy_provider_mutex);
80 list_add_tail(&pl->node, &phys);
81 mutex_unlock(&phy_provider_mutex);
82
83 return 0;
84}
85EXPORT_SYMBOL_GPL(phy_create_lookup);
86
87/**
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
92 *
93 * Finds and unregisters phy_lookup entry that was created with
94 * phy_create_lookup().
95 */
96void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id)
97{
98 struct phy_lookup *pl;
99
100 if (!phy || !dev_id || !con_id)
101 return;
102
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)) {
107 list_del(&pl->node);
108 kfree(pl);
109 break;
110 }
111 mutex_unlock(&phy_provider_mutex);
112}
113EXPORT_SYMBOL_GPL(phy_remove_lookup);
114
115static struct phy *phy_find(struct device *dev, const char *con_id)
116{
117 const char *dev_id = dev_name(dev);
118 struct phy_lookup *p, *pl = NULL;
119
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)) {
123 pl = p;
124 break;
125 }
126 mutex_unlock(&phy_provider_mutex);
127
128 return pl ? pl->phy : ERR_PTR(-ENODEV);
129}
130
131static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
132{
133 struct phy_provider *phy_provider;
134 struct device_node *child;
135
136 list_for_each_entry(phy_provider, &phy_provider_list, list) {
137 if (phy_provider->dev->of_node == node)
138 return phy_provider;
139
140 for_each_child_of_node(phy_provider->children, child)
141 if (child == node)
142 return phy_provider;
143 }
144
145 return ERR_PTR(-EPROBE_DEFER);
146}
147
148int phy_pm_runtime_get(struct phy *phy)
149{
150 int ret;
151
152 if (!phy)
153 return 0;
154
155 if (!pm_runtime_enabled(&phy->dev))
156 return -ENOTSUPP;
157
158 ret = pm_runtime_get(&phy->dev);
159 if (ret < 0 && ret != -EINPROGRESS)
160 pm_runtime_put_noidle(&phy->dev);
161
162 return ret;
163}
164EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
165
166int phy_pm_runtime_get_sync(struct phy *phy)
167{
168 int ret;
169
170 if (!phy)
171 return 0;
172
173 if (!pm_runtime_enabled(&phy->dev))
174 return -ENOTSUPP;
175
176 ret = pm_runtime_get_sync(&phy->dev);
177 if (ret < 0)
178 pm_runtime_put_sync(&phy->dev);
179
180 return ret;
181}
182EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
183
184int phy_pm_runtime_put(struct phy *phy)
185{
186 if (!phy)
187 return 0;
188
189 if (!pm_runtime_enabled(&phy->dev))
190 return -ENOTSUPP;
191
192 return pm_runtime_put(&phy->dev);
193}
194EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
195
196int phy_pm_runtime_put_sync(struct phy *phy)
197{
198 if (!phy)
199 return 0;
200
201 if (!pm_runtime_enabled(&phy->dev))
202 return -ENOTSUPP;
203
204 return pm_runtime_put_sync(&phy->dev);
205}
206EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
207
208void phy_pm_runtime_allow(struct phy *phy)
209{
210 if (!phy)
211 return;
212
213 if (!pm_runtime_enabled(&phy->dev))
214 return;
215
216 pm_runtime_allow(&phy->dev);
217}
218EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
219
220void phy_pm_runtime_forbid(struct phy *phy)
221{
222 if (!phy)
223 return;
224
225 if (!pm_runtime_enabled(&phy->dev))
226 return;
227
228 pm_runtime_forbid(&phy->dev);
229}
230EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
231
232/**
233 * phy_init - phy internal initialization before phy operation
234 * @phy: the phy returned by phy_get()
235 *
236 * Used to allow phy's driver to perform phy internal initialization,
237 * such as PLL block powering, clock initialization or anything that's
238 * is required by the phy to perform the start of operation.
239 * Must be called before phy_power_on().
240 *
241 * Return: %0 if successful, a negative error code otherwise
242 */
243int phy_init(struct phy *phy)
244{
245 int ret;
246
247 if (!phy)
248 return 0;
249
250 ret = phy_pm_runtime_get_sync(phy);
251 if (ret < 0 && ret != -ENOTSUPP)
252 return ret;
253 ret = 0; /* Override possible ret == -ENOTSUPP */
254
255 mutex_lock(&phy->mutex);
256 if (phy->power_count > phy->init_count)
257 dev_warn(&phy->dev, "phy_power_on was called before phy_init\n");
258
259 if (phy->init_count == 0 && phy->ops->init) {
260 ret = phy->ops->init(phy);
261 if (ret < 0) {
262 dev_err(&phy->dev, "phy init failed --> %d\n", ret);
263 goto out;
264 }
265 }
266 ++phy->init_count;
267
268out:
269 mutex_unlock(&phy->mutex);
270 phy_pm_runtime_put(phy);
271 return ret;
272}
273EXPORT_SYMBOL_GPL(phy_init);
274
275/**
276 * phy_exit - Phy internal un-initialization
277 * @phy: the phy returned by phy_get()
278 *
279 * Must be called after phy_power_off().
280 *
281 * Return: %0 if successful, a negative error code otherwise
282 */
283int phy_exit(struct phy *phy)
284{
285 int ret;
286
287 if (!phy)
288 return 0;
289
290 ret = phy_pm_runtime_get_sync(phy);
291 if (ret < 0 && ret != -ENOTSUPP)
292 return ret;
293 ret = 0; /* Override possible ret == -ENOTSUPP */
294
295 mutex_lock(&phy->mutex);
296 if (phy->init_count == 1 && phy->ops->exit) {
297 ret = phy->ops->exit(phy);
298 if (ret < 0) {
299 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
300 goto out;
301 }
302 }
303 --phy->init_count;
304
305out:
306 mutex_unlock(&phy->mutex);
307 phy_pm_runtime_put(phy);
308 return ret;
309}
310EXPORT_SYMBOL_GPL(phy_exit);
311
312/**
313 * phy_power_on - Enable the phy and enter proper operation
314 * @phy: the phy returned by phy_get()
315 *
316 * Must be called after phy_init().
317 *
318 * Return: %0 if successful, a negative error code otherwise
319 */
320int phy_power_on(struct phy *phy)
321{
322 int ret = 0;
323
324 if (!phy)
325 goto out;
326
327 if (phy->pwr) {
328 ret = regulator_enable(phy->pwr);
329 if (ret)
330 goto out;
331 }
332
333 ret = phy_pm_runtime_get_sync(phy);
334 if (ret < 0 && ret != -ENOTSUPP)
335 goto err_pm_sync;
336
337 ret = 0; /* Override possible ret == -ENOTSUPP */
338
339 mutex_lock(&phy->mutex);
340 if (phy->power_count == 0 && phy->ops->power_on) {
341 ret = phy->ops->power_on(phy);
342 if (ret < 0) {
343 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
344 goto err_pwr_on;
345 }
346 }
347 ++phy->power_count;
348 mutex_unlock(&phy->mutex);
349 return 0;
350
351err_pwr_on:
352 mutex_unlock(&phy->mutex);
353 phy_pm_runtime_put_sync(phy);
354err_pm_sync:
355 if (phy->pwr)
356 regulator_disable(phy->pwr);
357out:
358 return ret;
359}
360EXPORT_SYMBOL_GPL(phy_power_on);
361
362/**
363 * phy_power_off - Disable the phy.
364 * @phy: the phy returned by phy_get()
365 *
366 * Must be called before phy_exit().
367 *
368 * Return: %0 if successful, a negative error code otherwise
369 */
370int phy_power_off(struct phy *phy)
371{
372 int ret;
373
374 if (!phy)
375 return 0;
376
377 mutex_lock(&phy->mutex);
378 if (phy->power_count == 1 && phy->ops->power_off) {
379 ret = phy->ops->power_off(phy);
380 if (ret < 0) {
381 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
382 mutex_unlock(&phy->mutex);
383 return ret;
384 }
385 }
386 --phy->power_count;
387 mutex_unlock(&phy->mutex);
388 phy_pm_runtime_put(phy);
389
390 if (phy->pwr)
391 regulator_disable(phy->pwr);
392
393 return 0;
394}
395EXPORT_SYMBOL_GPL(phy_power_off);
396
397int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode)
398{
399 int ret;
400
401 if (!phy || !phy->ops->set_mode)
402 return 0;
403
404 mutex_lock(&phy->mutex);
405 ret = phy->ops->set_mode(phy, mode, submode);
406 if (!ret)
407 phy->attrs.mode = mode;
408 mutex_unlock(&phy->mutex);
409
410 return ret;
411}
412EXPORT_SYMBOL_GPL(phy_set_mode_ext);
413
414int phy_set_media(struct phy *phy, enum phy_media media)
415{
416 int ret;
417
418 if (!phy || !phy->ops->set_media)
419 return 0;
420
421 mutex_lock(&phy->mutex);
422 ret = phy->ops->set_media(phy, media);
423 mutex_unlock(&phy->mutex);
424
425 return ret;
426}
427EXPORT_SYMBOL_GPL(phy_set_media);
428
429int phy_set_speed(struct phy *phy, int speed)
430{
431 int ret;
432
433 if (!phy || !phy->ops->set_speed)
434 return 0;
435
436 mutex_lock(&phy->mutex);
437 ret = phy->ops->set_speed(phy, speed);
438 mutex_unlock(&phy->mutex);
439
440 return ret;
441}
442EXPORT_SYMBOL_GPL(phy_set_speed);
443
444int phy_reset(struct phy *phy)
445{
446 int ret;
447
448 if (!phy || !phy->ops->reset)
449 return 0;
450
451 ret = phy_pm_runtime_get_sync(phy);
452 if (ret < 0 && ret != -ENOTSUPP)
453 return ret;
454
455 mutex_lock(&phy->mutex);
456 ret = phy->ops->reset(phy);
457 mutex_unlock(&phy->mutex);
458
459 phy_pm_runtime_put(phy);
460
461 return ret;
462}
463EXPORT_SYMBOL_GPL(phy_reset);
464
465/**
466 * phy_calibrate() - Tunes the phy hw parameters for current configuration
467 * @phy: the phy returned by phy_get()
468 *
469 * Used to calibrate phy hardware, typically by adjusting some parameters in
470 * runtime, which are otherwise lost after host controller reset and cannot
471 * be applied in phy_init() or phy_power_on().
472 *
473 * Return: %0 if successful, a negative error code otherwise
474 */
475int phy_calibrate(struct phy *phy)
476{
477 int ret;
478
479 if (!phy || !phy->ops->calibrate)
480 return 0;
481
482 mutex_lock(&phy->mutex);
483 ret = phy->ops->calibrate(phy);
484 mutex_unlock(&phy->mutex);
485
486 return ret;
487}
488EXPORT_SYMBOL_GPL(phy_calibrate);
489
490/**
491 * phy_configure() - Changes the phy parameters
492 * @phy: the phy returned by phy_get()
493 * @opts: New configuration to apply
494 *
495 * Used to change the PHY parameters. phy_init() must have been called
496 * on the phy. The configuration will be applied on the current phy
497 * mode, that can be changed using phy_set_mode().
498 *
499 * Return: %0 if successful, a negative error code otherwise
500 */
501int phy_configure(struct phy *phy, union phy_configure_opts *opts)
502{
503 int ret;
504
505 if (!phy)
506 return -EINVAL;
507
508 if (!phy->ops->configure)
509 return -EOPNOTSUPP;
510
511 mutex_lock(&phy->mutex);
512 ret = phy->ops->configure(phy, opts);
513 mutex_unlock(&phy->mutex);
514
515 return ret;
516}
517EXPORT_SYMBOL_GPL(phy_configure);
518
519/**
520 * phy_validate() - Checks the phy parameters
521 * @phy: the phy returned by phy_get()
522 * @mode: phy_mode the configuration is applicable to.
523 * @submode: PHY submode the configuration is applicable to.
524 * @opts: Configuration to check
525 *
526 * Used to check that the current set of parameters can be handled by
527 * the phy. Implementations are free to tune the parameters passed as
528 * arguments if needed by some implementation detail or
529 * constraints. It will not change any actual configuration of the
530 * PHY, so calling it as many times as deemed fit will have no side
531 * effect.
532 *
533 * Return: %0 if successful, a negative error code otherwise
534 */
535int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
536 union phy_configure_opts *opts)
537{
538 int ret;
539
540 if (!phy)
541 return -EINVAL;
542
543 if (!phy->ops->validate)
544 return -EOPNOTSUPP;
545
546 mutex_lock(&phy->mutex);
547 ret = phy->ops->validate(phy, mode, submode, opts);
548 mutex_unlock(&phy->mutex);
549
550 return ret;
551}
552EXPORT_SYMBOL_GPL(phy_validate);
553
554/**
555 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
556 * @np: device_node for which to get the phy
557 * @index: the index of the phy
558 *
559 * Returns the phy associated with the given phandle value,
560 * after getting a refcount to it or -ENODEV if there is no such phy or
561 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
562 * not yet loaded. This function uses of_xlate call back function provided
563 * while registering the phy_provider to find the phy instance.
564 */
565static struct phy *_of_phy_get(struct device_node *np, int index)
566{
567 int ret;
568 struct phy_provider *phy_provider;
569 struct phy *phy = NULL;
570 struct of_phandle_args args;
571
572 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
573 index, &args);
574 if (ret)
575 return ERR_PTR(-ENODEV);
576
577 /* This phy type handled by the usb-phy subsystem for now */
578 if (of_device_is_compatible(args.np, "usb-nop-xceiv"))
579 return ERR_PTR(-ENODEV);
580
581 mutex_lock(&phy_provider_mutex);
582 phy_provider = of_phy_provider_lookup(args.np);
583 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
584 phy = ERR_PTR(-EPROBE_DEFER);
585 goto out_unlock;
586 }
587
588 if (!of_device_is_available(args.np)) {
589 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
590 phy = ERR_PTR(-ENODEV);
591 goto out_put_module;
592 }
593
594 phy = phy_provider->of_xlate(phy_provider->dev, &args);
595
596out_put_module:
597 module_put(phy_provider->owner);
598
599out_unlock:
600 mutex_unlock(&phy_provider_mutex);
601 of_node_put(args.np);
602
603 return phy;
604}
605
606/**
607 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
608 * @np: device_node for which to get the phy
609 * @con_id: name of the phy from device's point of view
610 *
611 * Returns the phy driver, after getting a refcount to it; or
612 * -ENODEV if there is no such phy. The caller is responsible for
613 * calling phy_put() to release that count.
614 */
615struct phy *of_phy_get(struct device_node *np, const char *con_id)
616{
617 struct phy *phy = NULL;
618 int index = 0;
619
620 if (con_id)
621 index = of_property_match_string(np, "phy-names", con_id);
622
623 phy = _of_phy_get(np, index);
624 if (IS_ERR(phy))
625 return phy;
626
627 if (!try_module_get(phy->ops->owner))
628 return ERR_PTR(-EPROBE_DEFER);
629
630 get_device(&phy->dev);
631
632 return phy;
633}
634EXPORT_SYMBOL_GPL(of_phy_get);
635
636/**
637 * of_phy_put() - release the PHY
638 * @phy: the phy returned by of_phy_get()
639 *
640 * Releases a refcount the caller received from of_phy_get().
641 */
642void of_phy_put(struct phy *phy)
643{
644 if (!phy || IS_ERR(phy))
645 return;
646
647 mutex_lock(&phy->mutex);
648 if (phy->ops->release)
649 phy->ops->release(phy);
650 mutex_unlock(&phy->mutex);
651
652 module_put(phy->ops->owner);
653 put_device(&phy->dev);
654}
655EXPORT_SYMBOL_GPL(of_phy_put);
656
657/**
658 * phy_put() - release the PHY
659 * @dev: device that wants to release this phy
660 * @phy: the phy returned by phy_get()
661 *
662 * Releases a refcount the caller received from phy_get().
663 */
664void phy_put(struct device *dev, struct phy *phy)
665{
666 device_link_remove(dev, &phy->dev);
667 of_phy_put(phy);
668}
669EXPORT_SYMBOL_GPL(phy_put);
670
671/**
672 * devm_phy_put() - release the PHY
673 * @dev: device that wants to release this phy
674 * @phy: the phy returned by devm_phy_get()
675 *
676 * destroys the devres associated with this phy and invokes phy_put
677 * to release the phy.
678 */
679void devm_phy_put(struct device *dev, struct phy *phy)
680{
681 int r;
682
683 if (!phy)
684 return;
685
686 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
687 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
688}
689EXPORT_SYMBOL_GPL(devm_phy_put);
690
691/**
692 * of_phy_simple_xlate() - returns the phy instance from phy provider
693 * @dev: the PHY provider device
694 * @args: of_phandle_args (not used here)
695 *
696 * Intended to be used by phy provider for the common case where #phy-cells is
697 * 0. For other cases where #phy-cells is greater than '0', the phy provider
698 * should provide a custom of_xlate function that reads the *args* and returns
699 * the appropriate phy.
700 */
701struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
702 *args)
703{
704 struct phy *phy;
705 struct class_dev_iter iter;
706
707 class_dev_iter_init(&iter, phy_class, NULL, NULL);
708 while ((dev = class_dev_iter_next(&iter))) {
709 phy = to_phy(dev);
710 if (args->np != phy->dev.of_node)
711 continue;
712
713 class_dev_iter_exit(&iter);
714 return phy;
715 }
716
717 class_dev_iter_exit(&iter);
718 return ERR_PTR(-ENODEV);
719}
720EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
721
722/**
723 * phy_get() - lookup and obtain a reference to a phy.
724 * @dev: device that requests this phy
725 * @string: the phy name as given in the dt data or the name of the controller
726 * port for non-dt case
727 *
728 * Returns the phy driver, after getting a refcount to it; or
729 * -ENODEV if there is no such phy. The caller is responsible for
730 * calling phy_put() to release that count.
731 */
732struct phy *phy_get(struct device *dev, const char *string)
733{
734 int index = 0;
735 struct phy *phy;
736 struct device_link *link;
737
738 if (dev->of_node) {
739 if (string)
740 index = of_property_match_string(dev->of_node, "phy-names",
741 string);
742 else
743 index = 0;
744 phy = _of_phy_get(dev->of_node, index);
745 } else {
746 if (string == NULL) {
747 dev_WARN(dev, "missing string\n");
748 return ERR_PTR(-EINVAL);
749 }
750 phy = phy_find(dev, string);
751 }
752 if (IS_ERR(phy))
753 return phy;
754
755 if (!try_module_get(phy->ops->owner))
756 return ERR_PTR(-EPROBE_DEFER);
757
758 get_device(&phy->dev);
759
760 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
761 if (!link)
762 dev_dbg(dev, "failed to create device link to %s\n",
763 dev_name(phy->dev.parent));
764
765 return phy;
766}
767EXPORT_SYMBOL_GPL(phy_get);
768
769/**
770 * phy_optional_get() - lookup and obtain a reference to an optional phy.
771 * @dev: device that requests this phy
772 * @string: the phy name as given in the dt data or the name of the controller
773 * port for non-dt case
774 *
775 * Returns the phy driver, after getting a refcount to it; or
776 * NULL if there is no such phy. The caller is responsible for
777 * calling phy_put() to release that count.
778 */
779struct phy *phy_optional_get(struct device *dev, const char *string)
780{
781 struct phy *phy = phy_get(dev, string);
782
783 if (PTR_ERR(phy) == -ENODEV)
784 phy = NULL;
785
786 return phy;
787}
788EXPORT_SYMBOL_GPL(phy_optional_get);
789
790/**
791 * devm_phy_get() - lookup and obtain a reference to a phy.
792 * @dev: device that requests this phy
793 * @string: the phy name as given in the dt data or phy device name
794 * for non-dt case
795 *
796 * Gets the phy using phy_get(), and associates a device with it using
797 * devres. On driver detach, release function is invoked on the devres data,
798 * then, devres data is freed.
799 */
800struct phy *devm_phy_get(struct device *dev, const char *string)
801{
802 struct phy **ptr, *phy;
803
804 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
805 if (!ptr)
806 return ERR_PTR(-ENOMEM);
807
808 phy = phy_get(dev, string);
809 if (!IS_ERR(phy)) {
810 *ptr = phy;
811 devres_add(dev, ptr);
812 } else {
813 devres_free(ptr);
814 }
815
816 return phy;
817}
818EXPORT_SYMBOL_GPL(devm_phy_get);
819
820/**
821 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
822 * @dev: device that requests this phy
823 * @string: the phy name as given in the dt data or phy device name
824 * for non-dt case
825 *
826 * Gets the phy using phy_get(), and associates a device with it using
827 * devres. On driver detach, release function is invoked on the devres
828 * data, then, devres data is freed. This differs to devm_phy_get() in
829 * that if the phy does not exist, it is not considered an error and
830 * -ENODEV will not be returned. Instead the NULL phy is returned,
831 * which can be passed to all other phy consumer calls.
832 */
833struct phy *devm_phy_optional_get(struct device *dev, const char *string)
834{
835 struct phy *phy = devm_phy_get(dev, string);
836
837 if (PTR_ERR(phy) == -ENODEV)
838 phy = NULL;
839
840 return phy;
841}
842EXPORT_SYMBOL_GPL(devm_phy_optional_get);
843
844/**
845 * devm_of_phy_get() - lookup and obtain a reference to a phy.
846 * @dev: device that requests this phy
847 * @np: node containing the phy
848 * @con_id: name of the phy from device's point of view
849 *
850 * Gets the phy using of_phy_get(), and associates a device with it using
851 * devres. On driver detach, release function is invoked on the devres data,
852 * then, devres data is freed.
853 */
854struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
855 const char *con_id)
856{
857 struct phy **ptr, *phy;
858 struct device_link *link;
859
860 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
861 if (!ptr)
862 return ERR_PTR(-ENOMEM);
863
864 phy = of_phy_get(np, con_id);
865 if (!IS_ERR(phy)) {
866 *ptr = phy;
867 devres_add(dev, ptr);
868 } else {
869 devres_free(ptr);
870 return phy;
871 }
872
873 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
874 if (!link)
875 dev_dbg(dev, "failed to create device link to %s\n",
876 dev_name(phy->dev.parent));
877
878 return phy;
879}
880EXPORT_SYMBOL_GPL(devm_of_phy_get);
881
882/**
883 * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
884 * @dev: device that requests this phy
885 * @np: node containing the phy
886 * @index: index of the phy
887 *
888 * Gets the phy using _of_phy_get(), then gets a refcount to it,
889 * and associates a device with it using devres. On driver detach,
890 * release function is invoked on the devres data,
891 * then, devres data is freed.
892 *
893 */
894struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
895 int index)
896{
897 struct phy **ptr, *phy;
898 struct device_link *link;
899
900 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
901 if (!ptr)
902 return ERR_PTR(-ENOMEM);
903
904 phy = _of_phy_get(np, index);
905 if (IS_ERR(phy)) {
906 devres_free(ptr);
907 return phy;
908 }
909
910 if (!try_module_get(phy->ops->owner)) {
911 devres_free(ptr);
912 return ERR_PTR(-EPROBE_DEFER);
913 }
914
915 get_device(&phy->dev);
916
917 *ptr = phy;
918 devres_add(dev, ptr);
919
920 link = device_link_add(dev, &phy->dev, DL_FLAG_STATELESS);
921 if (!link)
922 dev_dbg(dev, "failed to create device link to %s\n",
923 dev_name(phy->dev.parent));
924
925 return phy;
926}
927EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
928
929/**
930 * phy_create() - create a new phy
931 * @dev: device that is creating the new phy
932 * @node: device node of the phy
933 * @ops: function pointers for performing phy operations
934 *
935 * Called to create a phy using phy framework.
936 */
937struct phy *phy_create(struct device *dev, struct device_node *node,
938 const struct phy_ops *ops)
939{
940 int ret;
941 int id;
942 struct phy *phy;
943
944 if (WARN_ON(!dev))
945 return ERR_PTR(-EINVAL);
946
947 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
948 if (!phy)
949 return ERR_PTR(-ENOMEM);
950
951 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
952 if (id < 0) {
953 dev_err(dev, "unable to get id\n");
954 ret = id;
955 goto free_phy;
956 }
957
958 device_initialize(&phy->dev);
959 mutex_init(&phy->mutex);
960
961 phy->dev.class = phy_class;
962 phy->dev.parent = dev;
963 phy->dev.of_node = node ?: dev->of_node;
964 phy->id = id;
965 phy->ops = ops;
966
967 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
968 if (ret)
969 goto put_dev;
970
971 /* phy-supply */
972 phy->pwr = regulator_get_optional(&phy->dev, "phy");
973 if (IS_ERR(phy->pwr)) {
974 ret = PTR_ERR(phy->pwr);
975 if (ret == -EPROBE_DEFER)
976 goto put_dev;
977
978 phy->pwr = NULL;
979 }
980
981 ret = device_add(&phy->dev);
982 if (ret)
983 goto put_dev;
984
985 if (pm_runtime_enabled(dev)) {
986 pm_runtime_enable(&phy->dev);
987 pm_runtime_no_callbacks(&phy->dev);
988 }
989
990 return phy;
991
992put_dev:
993 put_device(&phy->dev); /* calls phy_release() which frees resources */
994 return ERR_PTR(ret);
995
996free_phy:
997 kfree(phy);
998 return ERR_PTR(ret);
999}
1000EXPORT_SYMBOL_GPL(phy_create);
1001
1002/**
1003 * devm_phy_create() - create a new phy
1004 * @dev: device that is creating the new phy
1005 * @node: device node of the phy
1006 * @ops: function pointers for performing phy operations
1007 *
1008 * Creates a new PHY device adding it to the PHY class.
1009 * While at that, it also associates the device with the phy using devres.
1010 * On driver detach, release function is invoked on the devres data,
1011 * then, devres data is freed.
1012 */
1013struct phy *devm_phy_create(struct device *dev, struct device_node *node,
1014 const struct phy_ops *ops)
1015{
1016 struct phy **ptr, *phy;
1017
1018 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
1019 if (!ptr)
1020 return ERR_PTR(-ENOMEM);
1021
1022 phy = phy_create(dev, node, ops);
1023 if (!IS_ERR(phy)) {
1024 *ptr = phy;
1025 devres_add(dev, ptr);
1026 } else {
1027 devres_free(ptr);
1028 }
1029
1030 return phy;
1031}
1032EXPORT_SYMBOL_GPL(devm_phy_create);
1033
1034/**
1035 * phy_destroy() - destroy the phy
1036 * @phy: the phy to be destroyed
1037 *
1038 * Called to destroy the phy.
1039 */
1040void phy_destroy(struct phy *phy)
1041{
1042 pm_runtime_disable(&phy->dev);
1043 device_unregister(&phy->dev);
1044}
1045EXPORT_SYMBOL_GPL(phy_destroy);
1046
1047/**
1048 * devm_phy_destroy() - destroy the PHY
1049 * @dev: device that wants to release this phy
1050 * @phy: the phy returned by devm_phy_get()
1051 *
1052 * destroys the devres associated with this phy and invokes phy_destroy
1053 * to destroy the phy.
1054 */
1055void devm_phy_destroy(struct device *dev, struct phy *phy)
1056{
1057 int r;
1058
1059 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
1060 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
1061}
1062EXPORT_SYMBOL_GPL(devm_phy_destroy);
1063
1064/**
1065 * __of_phy_provider_register() - create/register phy provider with the framework
1066 * @dev: struct device of the phy provider
1067 * @children: device node containing children (if different from dev->of_node)
1068 * @owner: the module owner containing of_xlate
1069 * @of_xlate: function pointer to obtain phy instance from phy provider
1070 *
1071 * Creates struct phy_provider from dev and of_xlate function pointer.
1072 * This is used in the case of dt boot for finding the phy instance from
1073 * phy provider.
1074 *
1075 * If the PHY provider doesn't nest children directly but uses a separate
1076 * child node to contain the individual children, the @children parameter
1077 * can be used to override the default. If NULL, the default (dev->of_node)
1078 * will be used. If non-NULL, the device node must be a child (or further
1079 * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL
1080 * error code is returned.
1081 */
1082struct phy_provider *__of_phy_provider_register(struct device *dev,
1083 struct device_node *children, struct module *owner,
1084 struct phy * (*of_xlate)(struct device *dev,
1085 struct of_phandle_args *args))
1086{
1087 struct phy_provider *phy_provider;
1088
1089 /*
1090 * If specified, the device node containing the children must itself
1091 * be the provider's device node or a child (or further descendant)
1092 * thereof.
1093 */
1094 if (children) {
1095 struct device_node *parent = of_node_get(children), *next;
1096
1097 while (parent) {
1098 if (parent == dev->of_node)
1099 break;
1100
1101 next = of_get_parent(parent);
1102 of_node_put(parent);
1103 parent = next;
1104 }
1105
1106 if (!parent)
1107 return ERR_PTR(-EINVAL);
1108
1109 of_node_put(parent);
1110 } else {
1111 children = dev->of_node;
1112 }
1113
1114 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
1115 if (!phy_provider)
1116 return ERR_PTR(-ENOMEM);
1117
1118 phy_provider->dev = dev;
1119 phy_provider->children = of_node_get(children);
1120 phy_provider->owner = owner;
1121 phy_provider->of_xlate = of_xlate;
1122
1123 mutex_lock(&phy_provider_mutex);
1124 list_add_tail(&phy_provider->list, &phy_provider_list);
1125 mutex_unlock(&phy_provider_mutex);
1126
1127 return phy_provider;
1128}
1129EXPORT_SYMBOL_GPL(__of_phy_provider_register);
1130
1131/**
1132 * __devm_of_phy_provider_register() - create/register phy provider with the
1133 * framework
1134 * @dev: struct device of the phy provider
1135 * @children: device node containing children (if different from dev->of_node)
1136 * @owner: the module owner containing of_xlate
1137 * @of_xlate: function pointer to obtain phy instance from phy provider
1138 *
1139 * Creates struct phy_provider from dev and of_xlate function pointer.
1140 * This is used in the case of dt boot for finding the phy instance from
1141 * phy provider. While at that, it also associates the device with the
1142 * phy provider using devres. On driver detach, release function is invoked
1143 * on the devres data, then, devres data is freed.
1144 */
1145struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
1146 struct device_node *children, struct module *owner,
1147 struct phy * (*of_xlate)(struct device *dev,
1148 struct of_phandle_args *args))
1149{
1150 struct phy_provider **ptr, *phy_provider;
1151
1152 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
1153 if (!ptr)
1154 return ERR_PTR(-ENOMEM);
1155
1156 phy_provider = __of_phy_provider_register(dev, children, owner,
1157 of_xlate);
1158 if (!IS_ERR(phy_provider)) {
1159 *ptr = phy_provider;
1160 devres_add(dev, ptr);
1161 } else {
1162 devres_free(ptr);
1163 }
1164
1165 return phy_provider;
1166}
1167EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
1168
1169/**
1170 * of_phy_provider_unregister() - unregister phy provider from the framework
1171 * @phy_provider: phy provider returned by of_phy_provider_register()
1172 *
1173 * Removes the phy_provider created using of_phy_provider_register().
1174 */
1175void of_phy_provider_unregister(struct phy_provider *phy_provider)
1176{
1177 if (IS_ERR(phy_provider))
1178 return;
1179
1180 mutex_lock(&phy_provider_mutex);
1181 list_del(&phy_provider->list);
1182 of_node_put(phy_provider->children);
1183 kfree(phy_provider);
1184 mutex_unlock(&phy_provider_mutex);
1185}
1186EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
1187
1188/**
1189 * devm_of_phy_provider_unregister() - remove phy provider from the framework
1190 * @dev: struct device of the phy provider
1191 * @phy_provider: phy provider returned by of_phy_provider_register()
1192 *
1193 * destroys the devres associated with this phy provider and invokes
1194 * of_phy_provider_unregister to unregister the phy provider.
1195 */
1196void devm_of_phy_provider_unregister(struct device *dev,
1197 struct phy_provider *phy_provider)
1198{
1199 int r;
1200
1201 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
1202 phy_provider);
1203 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
1204}
1205EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
1206
1207/**
1208 * phy_release() - release the phy
1209 * @dev: the dev member within phy
1210 *
1211 * When the last reference to the device is removed, it is called
1212 * from the embedded kobject as release method.
1213 */
1214static void phy_release(struct device *dev)
1215{
1216 struct phy *phy;
1217
1218 phy = to_phy(dev);
1219 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
1220 regulator_put(phy->pwr);
1221 ida_simple_remove(&phy_ida, phy->id);
1222 kfree(phy);
1223}
1224
1225static int __init phy_core_init(void)
1226{
1227 phy_class = class_create(THIS_MODULE, "phy");
1228 if (IS_ERR(phy_class)) {
1229 pr_err("failed to create phy class --> %ld\n",
1230 PTR_ERR(phy_class));
1231 return PTR_ERR(phy_class);
1232 }
1233
1234 phy_class->dev_release = phy_release;
1235
1236 return 0;
1237}
1238device_initcall(phy_core_init);
1/*
2 * phy-core.c -- Generic Phy framework.
3 *
4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
5 *
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
7 *
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.
12 */
13
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>
20#include <linux/of.h>
21#include <linux/phy/phy.h>
22#include <linux/idr.h>
23#include <linux/pm_runtime.h>
24#include <linux/regulator/consumer.h>
25
26static struct class *phy_class;
27static DEFINE_MUTEX(phy_provider_mutex);
28static LIST_HEAD(phy_provider_list);
29static LIST_HEAD(phys);
30static DEFINE_IDA(phy_ida);
31
32static void devm_phy_release(struct device *dev, void *res)
33{
34 struct phy *phy = *(struct phy **)res;
35
36 phy_put(phy);
37}
38
39static void devm_phy_provider_release(struct device *dev, void *res)
40{
41 struct phy_provider *phy_provider = *(struct phy_provider **)res;
42
43 of_phy_provider_unregister(phy_provider);
44}
45
46static void devm_phy_consume(struct device *dev, void *res)
47{
48 struct phy *phy = *(struct phy **)res;
49
50 phy_destroy(phy);
51}
52
53static int devm_phy_match(struct device *dev, void *res, void *match_data)
54{
55 struct phy **phy = res;
56
57 return *phy == match_data;
58}
59
60/**
61 * phy_create_lookup() - allocate and register PHY/device association
62 * @phy: the phy of the association
63 * @con_id: connection ID string on device
64 * @dev_id: the device of the association
65 *
66 * Creates and registers phy_lookup entry.
67 */
68int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
69{
70 struct phy_lookup *pl;
71
72 if (!phy || !dev_id || !con_id)
73 return -EINVAL;
74
75 pl = kzalloc(sizeof(*pl), GFP_KERNEL);
76 if (!pl)
77 return -ENOMEM;
78
79 pl->dev_id = dev_id;
80 pl->con_id = con_id;
81 pl->phy = phy;
82
83 mutex_lock(&phy_provider_mutex);
84 list_add_tail(&pl->node, &phys);
85 mutex_unlock(&phy_provider_mutex);
86
87 return 0;
88}
89EXPORT_SYMBOL_GPL(phy_create_lookup);
90
91/**
92 * phy_remove_lookup() - find and remove PHY/device association
93 * @phy: the phy of the association
94 * @con_id: connection ID string on device
95 * @dev_id: the device of the association
96 *
97 * Finds and unregisters phy_lookup entry that was created with
98 * phy_create_lookup().
99 */
100void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id)
101{
102 struct phy_lookup *pl;
103
104 if (!phy || !dev_id || !con_id)
105 return;
106
107 mutex_lock(&phy_provider_mutex);
108 list_for_each_entry(pl, &phys, node)
109 if (pl->phy == phy && !strcmp(pl->dev_id, dev_id) &&
110 !strcmp(pl->con_id, con_id)) {
111 list_del(&pl->node);
112 kfree(pl);
113 break;
114 }
115 mutex_unlock(&phy_provider_mutex);
116}
117EXPORT_SYMBOL_GPL(phy_remove_lookup);
118
119static struct phy *phy_find(struct device *dev, const char *con_id)
120{
121 const char *dev_id = dev_name(dev);
122 struct phy_lookup *p, *pl = NULL;
123
124 mutex_lock(&phy_provider_mutex);
125 list_for_each_entry(p, &phys, node)
126 if (!strcmp(p->dev_id, dev_id) && !strcmp(p->con_id, con_id)) {
127 pl = p;
128 break;
129 }
130 mutex_unlock(&phy_provider_mutex);
131
132 return pl ? pl->phy : ERR_PTR(-ENODEV);
133}
134
135static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
136{
137 struct phy_provider *phy_provider;
138 struct device_node *child;
139
140 list_for_each_entry(phy_provider, &phy_provider_list, list) {
141 if (phy_provider->dev->of_node == node)
142 return phy_provider;
143
144 for_each_child_of_node(phy_provider->dev->of_node, child)
145 if (child == node)
146 return phy_provider;
147 }
148
149 return ERR_PTR(-EPROBE_DEFER);
150}
151
152int phy_pm_runtime_get(struct phy *phy)
153{
154 int ret;
155
156 if (!pm_runtime_enabled(&phy->dev))
157 return -ENOTSUPP;
158
159 ret = pm_runtime_get(&phy->dev);
160 if (ret < 0 && ret != -EINPROGRESS)
161 pm_runtime_put_noidle(&phy->dev);
162
163 return ret;
164}
165EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
166
167int phy_pm_runtime_get_sync(struct phy *phy)
168{
169 int ret;
170
171 if (!pm_runtime_enabled(&phy->dev))
172 return -ENOTSUPP;
173
174 ret = pm_runtime_get_sync(&phy->dev);
175 if (ret < 0)
176 pm_runtime_put_sync(&phy->dev);
177
178 return ret;
179}
180EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
181
182int phy_pm_runtime_put(struct phy *phy)
183{
184 if (!pm_runtime_enabled(&phy->dev))
185 return -ENOTSUPP;
186
187 return pm_runtime_put(&phy->dev);
188}
189EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
190
191int phy_pm_runtime_put_sync(struct phy *phy)
192{
193 if (!pm_runtime_enabled(&phy->dev))
194 return -ENOTSUPP;
195
196 return pm_runtime_put_sync(&phy->dev);
197}
198EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
199
200void phy_pm_runtime_allow(struct phy *phy)
201{
202 if (!pm_runtime_enabled(&phy->dev))
203 return;
204
205 pm_runtime_allow(&phy->dev);
206}
207EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
208
209void phy_pm_runtime_forbid(struct phy *phy)
210{
211 if (!pm_runtime_enabled(&phy->dev))
212 return;
213
214 pm_runtime_forbid(&phy->dev);
215}
216EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
217
218int phy_init(struct phy *phy)
219{
220 int ret;
221
222 if (!phy)
223 return 0;
224
225 ret = phy_pm_runtime_get_sync(phy);
226 if (ret < 0 && ret != -ENOTSUPP)
227 return ret;
228 ret = 0; /* Override possible ret == -ENOTSUPP */
229
230 mutex_lock(&phy->mutex);
231 if (phy->init_count == 0 && phy->ops->init) {
232 ret = phy->ops->init(phy);
233 if (ret < 0) {
234 dev_err(&phy->dev, "phy init failed --> %d\n", ret);
235 goto out;
236 }
237 }
238 ++phy->init_count;
239
240out:
241 mutex_unlock(&phy->mutex);
242 phy_pm_runtime_put(phy);
243 return ret;
244}
245EXPORT_SYMBOL_GPL(phy_init);
246
247int phy_exit(struct phy *phy)
248{
249 int ret;
250
251 if (!phy)
252 return 0;
253
254 ret = phy_pm_runtime_get_sync(phy);
255 if (ret < 0 && ret != -ENOTSUPP)
256 return ret;
257 ret = 0; /* Override possible ret == -ENOTSUPP */
258
259 mutex_lock(&phy->mutex);
260 if (phy->init_count == 1 && phy->ops->exit) {
261 ret = phy->ops->exit(phy);
262 if (ret < 0) {
263 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
264 goto out;
265 }
266 }
267 --phy->init_count;
268
269out:
270 mutex_unlock(&phy->mutex);
271 phy_pm_runtime_put(phy);
272 return ret;
273}
274EXPORT_SYMBOL_GPL(phy_exit);
275
276int phy_power_on(struct phy *phy)
277{
278 int ret = 0;
279
280 if (!phy)
281 goto out;
282
283 if (phy->pwr) {
284 ret = regulator_enable(phy->pwr);
285 if (ret)
286 goto out;
287 }
288
289 ret = phy_pm_runtime_get_sync(phy);
290 if (ret < 0 && ret != -ENOTSUPP)
291 goto err_pm_sync;
292
293 ret = 0; /* Override possible ret == -ENOTSUPP */
294
295 mutex_lock(&phy->mutex);
296 if (phy->power_count == 0 && phy->ops->power_on) {
297 ret = phy->ops->power_on(phy);
298 if (ret < 0) {
299 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
300 goto err_pwr_on;
301 }
302 }
303 ++phy->power_count;
304 mutex_unlock(&phy->mutex);
305 return 0;
306
307err_pwr_on:
308 mutex_unlock(&phy->mutex);
309 phy_pm_runtime_put_sync(phy);
310err_pm_sync:
311 if (phy->pwr)
312 regulator_disable(phy->pwr);
313out:
314 return ret;
315}
316EXPORT_SYMBOL_GPL(phy_power_on);
317
318int phy_power_off(struct phy *phy)
319{
320 int ret;
321
322 if (!phy)
323 return 0;
324
325 mutex_lock(&phy->mutex);
326 if (phy->power_count == 1 && phy->ops->power_off) {
327 ret = phy->ops->power_off(phy);
328 if (ret < 0) {
329 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
330 mutex_unlock(&phy->mutex);
331 return ret;
332 }
333 }
334 --phy->power_count;
335 mutex_unlock(&phy->mutex);
336 phy_pm_runtime_put(phy);
337
338 if (phy->pwr)
339 regulator_disable(phy->pwr);
340
341 return 0;
342}
343EXPORT_SYMBOL_GPL(phy_power_off);
344
345/**
346 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
347 * @np: device_node for which to get the phy
348 * @index: the index of the phy
349 *
350 * Returns the phy associated with the given phandle value,
351 * after getting a refcount to it or -ENODEV if there is no such phy or
352 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
353 * not yet loaded. This function uses of_xlate call back function provided
354 * while registering the phy_provider to find the phy instance.
355 */
356static struct phy *_of_phy_get(struct device_node *np, int index)
357{
358 int ret;
359 struct phy_provider *phy_provider;
360 struct phy *phy = NULL;
361 struct of_phandle_args args;
362
363 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
364 index, &args);
365 if (ret)
366 return ERR_PTR(-ENODEV);
367
368 mutex_lock(&phy_provider_mutex);
369 phy_provider = of_phy_provider_lookup(args.np);
370 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
371 phy = ERR_PTR(-EPROBE_DEFER);
372 goto out_unlock;
373 }
374
375 if (!of_device_is_available(args.np)) {
376 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
377 phy = ERR_PTR(-ENODEV);
378 goto out_put_module;
379 }
380
381 phy = phy_provider->of_xlate(phy_provider->dev, &args);
382
383out_put_module:
384 module_put(phy_provider->owner);
385
386out_unlock:
387 mutex_unlock(&phy_provider_mutex);
388 of_node_put(args.np);
389
390 return phy;
391}
392
393/**
394 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
395 * @np: device_node for which to get the phy
396 * @con_id: name of the phy from device's point of view
397 *
398 * Returns the phy driver, after getting a refcount to it; or
399 * -ENODEV if there is no such phy. The caller is responsible for
400 * calling phy_put() to release that count.
401 */
402struct phy *of_phy_get(struct device_node *np, const char *con_id)
403{
404 struct phy *phy = NULL;
405 int index = 0;
406
407 if (con_id)
408 index = of_property_match_string(np, "phy-names", con_id);
409
410 phy = _of_phy_get(np, index);
411 if (IS_ERR(phy))
412 return phy;
413
414 if (!try_module_get(phy->ops->owner))
415 return ERR_PTR(-EPROBE_DEFER);
416
417 get_device(&phy->dev);
418
419 return phy;
420}
421EXPORT_SYMBOL_GPL(of_phy_get);
422
423/**
424 * phy_put() - release the PHY
425 * @phy: the phy returned by phy_get()
426 *
427 * Releases a refcount the caller received from phy_get().
428 */
429void phy_put(struct phy *phy)
430{
431 if (!phy || IS_ERR(phy))
432 return;
433
434 module_put(phy->ops->owner);
435 put_device(&phy->dev);
436}
437EXPORT_SYMBOL_GPL(phy_put);
438
439/**
440 * devm_phy_put() - release the PHY
441 * @dev: device that wants to release this phy
442 * @phy: the phy returned by devm_phy_get()
443 *
444 * destroys the devres associated with this phy and invokes phy_put
445 * to release the phy.
446 */
447void devm_phy_put(struct device *dev, struct phy *phy)
448{
449 int r;
450
451 if (!phy)
452 return;
453
454 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
455 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
456}
457EXPORT_SYMBOL_GPL(devm_phy_put);
458
459/**
460 * of_phy_simple_xlate() - returns the phy instance from phy provider
461 * @dev: the PHY provider device
462 * @args: of_phandle_args (not used here)
463 *
464 * Intended to be used by phy provider for the common case where #phy-cells is
465 * 0. For other cases where #phy-cells is greater than '0', the phy provider
466 * should provide a custom of_xlate function that reads the *args* and returns
467 * the appropriate phy.
468 */
469struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
470 *args)
471{
472 struct phy *phy;
473 struct class_dev_iter iter;
474
475 class_dev_iter_init(&iter, phy_class, NULL, NULL);
476 while ((dev = class_dev_iter_next(&iter))) {
477 phy = to_phy(dev);
478 if (args->np != phy->dev.of_node)
479 continue;
480
481 class_dev_iter_exit(&iter);
482 return phy;
483 }
484
485 class_dev_iter_exit(&iter);
486 return ERR_PTR(-ENODEV);
487}
488EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
489
490/**
491 * phy_get() - lookup and obtain a reference to a phy.
492 * @dev: device that requests this phy
493 * @string: the phy name as given in the dt data or the name of the controller
494 * port for non-dt case
495 *
496 * Returns the phy driver, after getting a refcount to it; or
497 * -ENODEV if there is no such phy. The caller is responsible for
498 * calling phy_put() to release that count.
499 */
500struct phy *phy_get(struct device *dev, const char *string)
501{
502 int index = 0;
503 struct phy *phy;
504
505 if (string == NULL) {
506 dev_WARN(dev, "missing string\n");
507 return ERR_PTR(-EINVAL);
508 }
509
510 if (dev->of_node) {
511 index = of_property_match_string(dev->of_node, "phy-names",
512 string);
513 phy = _of_phy_get(dev->of_node, index);
514 } else {
515 phy = phy_find(dev, string);
516 }
517 if (IS_ERR(phy))
518 return phy;
519
520 if (!try_module_get(phy->ops->owner))
521 return ERR_PTR(-EPROBE_DEFER);
522
523 get_device(&phy->dev);
524
525 return phy;
526}
527EXPORT_SYMBOL_GPL(phy_get);
528
529/**
530 * phy_optional_get() - lookup and obtain a reference to an optional phy.
531 * @dev: device that requests this phy
532 * @string: the phy name as given in the dt data or the name of the controller
533 * port for non-dt case
534 *
535 * Returns the phy driver, after getting a refcount to it; or
536 * NULL if there is no such phy. The caller is responsible for
537 * calling phy_put() to release that count.
538 */
539struct phy *phy_optional_get(struct device *dev, const char *string)
540{
541 struct phy *phy = phy_get(dev, string);
542
543 if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
544 phy = NULL;
545
546 return phy;
547}
548EXPORT_SYMBOL_GPL(phy_optional_get);
549
550/**
551 * devm_phy_get() - lookup and obtain a reference to a phy.
552 * @dev: device that requests this phy
553 * @string: the phy name as given in the dt data or phy device name
554 * for non-dt case
555 *
556 * Gets the phy using phy_get(), and associates a device with it using
557 * devres. On driver detach, release function is invoked on the devres data,
558 * then, devres data is freed.
559 */
560struct phy *devm_phy_get(struct device *dev, const char *string)
561{
562 struct phy **ptr, *phy;
563
564 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
565 if (!ptr)
566 return ERR_PTR(-ENOMEM);
567
568 phy = phy_get(dev, string);
569 if (!IS_ERR(phy)) {
570 *ptr = phy;
571 devres_add(dev, ptr);
572 } else {
573 devres_free(ptr);
574 }
575
576 return phy;
577}
578EXPORT_SYMBOL_GPL(devm_phy_get);
579
580/**
581 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
582 * @dev: device that requests this phy
583 * @string: the phy name as given in the dt data or phy device name
584 * for non-dt case
585 *
586 * Gets the phy using phy_get(), and associates a device with it using
587 * devres. On driver detach, release function is invoked on the devres
588 * data, then, devres data is freed. This differs to devm_phy_get() in
589 * that if the phy does not exist, it is not considered an error and
590 * -ENODEV will not be returned. Instead the NULL phy is returned,
591 * which can be passed to all other phy consumer calls.
592 */
593struct phy *devm_phy_optional_get(struct device *dev, const char *string)
594{
595 struct phy *phy = devm_phy_get(dev, string);
596
597 if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
598 phy = NULL;
599
600 return phy;
601}
602EXPORT_SYMBOL_GPL(devm_phy_optional_get);
603
604/**
605 * devm_of_phy_get() - lookup and obtain a reference to a phy.
606 * @dev: device that requests this phy
607 * @np: node containing the phy
608 * @con_id: name of the phy from device's point of view
609 *
610 * Gets the phy using of_phy_get(), and associates a device with it using
611 * devres. On driver detach, release function is invoked on the devres data,
612 * then, devres data is freed.
613 */
614struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
615 const char *con_id)
616{
617 struct phy **ptr, *phy;
618
619 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
620 if (!ptr)
621 return ERR_PTR(-ENOMEM);
622
623 phy = of_phy_get(np, con_id);
624 if (!IS_ERR(phy)) {
625 *ptr = phy;
626 devres_add(dev, ptr);
627 } else {
628 devres_free(ptr);
629 }
630
631 return phy;
632}
633EXPORT_SYMBOL_GPL(devm_of_phy_get);
634
635/**
636 * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
637 * @dev: device that requests this phy
638 * @np: node containing the phy
639 * @index: index of the phy
640 *
641 * Gets the phy using _of_phy_get(), then gets a refcount to it,
642 * and associates a device with it using devres. On driver detach,
643 * release function is invoked on the devres data,
644 * then, devres data is freed.
645 *
646 */
647struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
648 int index)
649{
650 struct phy **ptr, *phy;
651
652 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
653 if (!ptr)
654 return ERR_PTR(-ENOMEM);
655
656 phy = _of_phy_get(np, index);
657 if (IS_ERR(phy)) {
658 devres_free(ptr);
659 return phy;
660 }
661
662 if (!try_module_get(phy->ops->owner)) {
663 devres_free(ptr);
664 return ERR_PTR(-EPROBE_DEFER);
665 }
666
667 get_device(&phy->dev);
668
669 *ptr = phy;
670 devres_add(dev, ptr);
671
672 return phy;
673}
674EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
675
676/**
677 * phy_create() - create a new phy
678 * @dev: device that is creating the new phy
679 * @node: device node of the phy
680 * @ops: function pointers for performing phy operations
681 *
682 * Called to create a phy using phy framework.
683 */
684struct phy *phy_create(struct device *dev, struct device_node *node,
685 const struct phy_ops *ops)
686{
687 int ret;
688 int id;
689 struct phy *phy;
690
691 if (WARN_ON(!dev))
692 return ERR_PTR(-EINVAL);
693
694 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
695 if (!phy)
696 return ERR_PTR(-ENOMEM);
697
698 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
699 if (id < 0) {
700 dev_err(dev, "unable to get id\n");
701 ret = id;
702 goto free_phy;
703 }
704
705 device_initialize(&phy->dev);
706 mutex_init(&phy->mutex);
707
708 phy->dev.class = phy_class;
709 phy->dev.parent = dev;
710 phy->dev.of_node = node ?: dev->of_node;
711 phy->id = id;
712 phy->ops = ops;
713
714 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
715 if (ret)
716 goto put_dev;
717
718 /* phy-supply */
719 phy->pwr = regulator_get_optional(&phy->dev, "phy");
720 if (IS_ERR(phy->pwr)) {
721 ret = PTR_ERR(phy->pwr);
722 if (ret == -EPROBE_DEFER)
723 goto put_dev;
724
725 phy->pwr = NULL;
726 }
727
728 ret = device_add(&phy->dev);
729 if (ret)
730 goto put_dev;
731
732 if (pm_runtime_enabled(dev)) {
733 pm_runtime_enable(&phy->dev);
734 pm_runtime_no_callbacks(&phy->dev);
735 }
736
737 return phy;
738
739put_dev:
740 put_device(&phy->dev); /* calls phy_release() which frees resources */
741 return ERR_PTR(ret);
742
743free_phy:
744 kfree(phy);
745 return ERR_PTR(ret);
746}
747EXPORT_SYMBOL_GPL(phy_create);
748
749/**
750 * devm_phy_create() - create a new phy
751 * @dev: device that is creating the new phy
752 * @node: device node of the phy
753 * @ops: function pointers for performing phy operations
754 *
755 * Creates a new PHY device adding it to the PHY class.
756 * While at that, it also associates the device with the phy using devres.
757 * On driver detach, release function is invoked on the devres data,
758 * then, devres data is freed.
759 */
760struct phy *devm_phy_create(struct device *dev, struct device_node *node,
761 const struct phy_ops *ops)
762{
763 struct phy **ptr, *phy;
764
765 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
766 if (!ptr)
767 return ERR_PTR(-ENOMEM);
768
769 phy = phy_create(dev, node, ops);
770 if (!IS_ERR(phy)) {
771 *ptr = phy;
772 devres_add(dev, ptr);
773 } else {
774 devres_free(ptr);
775 }
776
777 return phy;
778}
779EXPORT_SYMBOL_GPL(devm_phy_create);
780
781/**
782 * phy_destroy() - destroy the phy
783 * @phy: the phy to be destroyed
784 *
785 * Called to destroy the phy.
786 */
787void phy_destroy(struct phy *phy)
788{
789 pm_runtime_disable(&phy->dev);
790 device_unregister(&phy->dev);
791}
792EXPORT_SYMBOL_GPL(phy_destroy);
793
794/**
795 * devm_phy_destroy() - destroy the PHY
796 * @dev: device that wants to release this phy
797 * @phy: the phy returned by devm_phy_get()
798 *
799 * destroys the devres associated with this phy and invokes phy_destroy
800 * to destroy the phy.
801 */
802void devm_phy_destroy(struct device *dev, struct phy *phy)
803{
804 int r;
805
806 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
807 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
808}
809EXPORT_SYMBOL_GPL(devm_phy_destroy);
810
811/**
812 * __of_phy_provider_register() - create/register phy provider with the framework
813 * @dev: struct device of the phy provider
814 * @owner: the module owner containing of_xlate
815 * @of_xlate: function pointer to obtain phy instance from phy provider
816 *
817 * Creates struct phy_provider from dev and of_xlate function pointer.
818 * This is used in the case of dt boot for finding the phy instance from
819 * phy provider.
820 */
821struct phy_provider *__of_phy_provider_register(struct device *dev,
822 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
823 struct of_phandle_args *args))
824{
825 struct phy_provider *phy_provider;
826
827 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
828 if (!phy_provider)
829 return ERR_PTR(-ENOMEM);
830
831 phy_provider->dev = dev;
832 phy_provider->owner = owner;
833 phy_provider->of_xlate = of_xlate;
834
835 mutex_lock(&phy_provider_mutex);
836 list_add_tail(&phy_provider->list, &phy_provider_list);
837 mutex_unlock(&phy_provider_mutex);
838
839 return phy_provider;
840}
841EXPORT_SYMBOL_GPL(__of_phy_provider_register);
842
843/**
844 * __devm_of_phy_provider_register() - create/register phy provider with the
845 * framework
846 * @dev: struct device of the phy provider
847 * @owner: the module owner containing of_xlate
848 * @of_xlate: function pointer to obtain phy instance from phy provider
849 *
850 * Creates struct phy_provider from dev and of_xlate function pointer.
851 * This is used in the case of dt boot for finding the phy instance from
852 * phy provider. While at that, it also associates the device with the
853 * phy provider using devres. On driver detach, release function is invoked
854 * on the devres data, then, devres data is freed.
855 */
856struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
857 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
858 struct of_phandle_args *args))
859{
860 struct phy_provider **ptr, *phy_provider;
861
862 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
863 if (!ptr)
864 return ERR_PTR(-ENOMEM);
865
866 phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
867 if (!IS_ERR(phy_provider)) {
868 *ptr = phy_provider;
869 devres_add(dev, ptr);
870 } else {
871 devres_free(ptr);
872 }
873
874 return phy_provider;
875}
876EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
877
878/**
879 * of_phy_provider_unregister() - unregister phy provider from the framework
880 * @phy_provider: phy provider returned by of_phy_provider_register()
881 *
882 * Removes the phy_provider created using of_phy_provider_register().
883 */
884void of_phy_provider_unregister(struct phy_provider *phy_provider)
885{
886 if (IS_ERR(phy_provider))
887 return;
888
889 mutex_lock(&phy_provider_mutex);
890 list_del(&phy_provider->list);
891 kfree(phy_provider);
892 mutex_unlock(&phy_provider_mutex);
893}
894EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
895
896/**
897 * devm_of_phy_provider_unregister() - remove phy provider from the framework
898 * @dev: struct device of the phy provider
899 *
900 * destroys the devres associated with this phy provider and invokes
901 * of_phy_provider_unregister to unregister the phy provider.
902 */
903void devm_of_phy_provider_unregister(struct device *dev,
904 struct phy_provider *phy_provider) {
905 int r;
906
907 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
908 phy_provider);
909 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
910}
911EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
912
913/**
914 * phy_release() - release the phy
915 * @dev: the dev member within phy
916 *
917 * When the last reference to the device is removed, it is called
918 * from the embedded kobject as release method.
919 */
920static void phy_release(struct device *dev)
921{
922 struct phy *phy;
923
924 phy = to_phy(dev);
925 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
926 regulator_put(phy->pwr);
927 ida_simple_remove(&phy_ida, phy->id);
928 kfree(phy);
929}
930
931static int __init phy_core_init(void)
932{
933 phy_class = class_create(THIS_MODULE, "phy");
934 if (IS_ERR(phy_class)) {
935 pr_err("failed to create phy class --> %ld\n",
936 PTR_ERR(phy_class));
937 return PTR_ERR(phy_class);
938 }
939
940 phy_class->dev_release = phy_release;
941
942 return 0;
943}
944module_init(phy_core_init);
945
946static void __exit phy_core_exit(void)
947{
948 class_destroy(phy_class);
949}
950module_exit(phy_core_exit);
951
952MODULE_DESCRIPTION("Generic PHY Framework");
953MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
954MODULE_LICENSE("GPL v2");