]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/phy/phy-core.c
drivers: phy: Make NULL a valid phy reference
[karo-tx-linux.git] / drivers / phy / phy-core.c
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
25 static struct class *phy_class;
26 static DEFINE_MUTEX(phy_provider_mutex);
27 static LIST_HEAD(phy_provider_list);
28 static DEFINE_IDA(phy_ida);
29
30 static void devm_phy_release(struct device *dev, void *res)
31 {
32         struct phy *phy = *(struct phy **)res;
33
34         phy_put(phy);
35 }
36
37 static void devm_phy_provider_release(struct device *dev, void *res)
38 {
39         struct phy_provider *phy_provider = *(struct phy_provider **)res;
40
41         of_phy_provider_unregister(phy_provider);
42 }
43
44 static void devm_phy_consume(struct device *dev, void *res)
45 {
46         struct phy *phy = *(struct phy **)res;
47
48         phy_destroy(phy);
49 }
50
51 static int devm_phy_match(struct device *dev, void *res, void *match_data)
52 {
53         return res == match_data;
54 }
55
56 static struct phy *phy_lookup(struct device *device, const char *port)
57 {
58         unsigned int count;
59         struct phy *phy;
60         struct device *dev;
61         struct phy_consumer *consumers;
62         struct class_dev_iter iter;
63
64         class_dev_iter_init(&iter, phy_class, NULL, NULL);
65         while ((dev = class_dev_iter_next(&iter))) {
66                 phy = to_phy(dev);
67                 count = phy->init_data->num_consumers;
68                 consumers = phy->init_data->consumers;
69                 while (count--) {
70                         if (!strcmp(consumers->dev_name, dev_name(device)) &&
71                                         !strcmp(consumers->port, port)) {
72                                 class_dev_iter_exit(&iter);
73                                 return phy;
74                         }
75                         consumers++;
76                 }
77         }
78
79         class_dev_iter_exit(&iter);
80         return ERR_PTR(-ENODEV);
81 }
82
83 static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
84 {
85         struct phy_provider *phy_provider;
86
87         list_for_each_entry(phy_provider, &phy_provider_list, list) {
88                 if (phy_provider->dev->of_node == node)
89                         return phy_provider;
90         }
91
92         return ERR_PTR(-EPROBE_DEFER);
93 }
94
95 int phy_pm_runtime_get(struct phy *phy)
96 {
97         int ret;
98
99         if (!pm_runtime_enabled(&phy->dev))
100                 return -ENOTSUPP;
101
102         ret = pm_runtime_get(&phy->dev);
103         if (ret < 0 && ret != -EINPROGRESS)
104                 pm_runtime_put_noidle(&phy->dev);
105
106         return ret;
107 }
108 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
109
110 int phy_pm_runtime_get_sync(struct phy *phy)
111 {
112         int ret;
113
114         if (!pm_runtime_enabled(&phy->dev))
115                 return -ENOTSUPP;
116
117         ret = pm_runtime_get_sync(&phy->dev);
118         if (ret < 0)
119                 pm_runtime_put_sync(&phy->dev);
120
121         return ret;
122 }
123 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
124
125 int phy_pm_runtime_put(struct phy *phy)
126 {
127         if (!pm_runtime_enabled(&phy->dev))
128                 return -ENOTSUPP;
129
130         return pm_runtime_put(&phy->dev);
131 }
132 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
133
134 int phy_pm_runtime_put_sync(struct phy *phy)
135 {
136         if (!pm_runtime_enabled(&phy->dev))
137                 return -ENOTSUPP;
138
139         return pm_runtime_put_sync(&phy->dev);
140 }
141 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
142
143 void phy_pm_runtime_allow(struct phy *phy)
144 {
145         if (!pm_runtime_enabled(&phy->dev))
146                 return;
147
148         pm_runtime_allow(&phy->dev);
149 }
150 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
151
152 void phy_pm_runtime_forbid(struct phy *phy)
153 {
154         if (!pm_runtime_enabled(&phy->dev))
155                 return;
156
157         pm_runtime_forbid(&phy->dev);
158 }
159 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
160
161 int phy_init(struct phy *phy)
162 {
163         int ret;
164
165         if (!phy)
166                 return 0;
167
168         ret = phy_pm_runtime_get_sync(phy);
169         if (ret < 0 && ret != -ENOTSUPP)
170                 return ret;
171
172         mutex_lock(&phy->mutex);
173         if (phy->init_count == 0 && phy->ops->init) {
174                 ret = phy->ops->init(phy);
175                 if (ret < 0) {
176                         dev_err(&phy->dev, "phy init failed --> %d\n", ret);
177                         goto out;
178                 }
179         }
180         ++phy->init_count;
181
182 out:
183         mutex_unlock(&phy->mutex);
184         phy_pm_runtime_put(phy);
185         return ret;
186 }
187 EXPORT_SYMBOL_GPL(phy_init);
188
189 int phy_exit(struct phy *phy)
190 {
191         int ret;
192
193         if (!phy)
194                 return 0;
195
196         ret = phy_pm_runtime_get_sync(phy);
197         if (ret < 0 && ret != -ENOTSUPP)
198                 return ret;
199
200         mutex_lock(&phy->mutex);
201         if (phy->init_count == 1 && phy->ops->exit) {
202                 ret = phy->ops->exit(phy);
203                 if (ret < 0) {
204                         dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
205                         goto out;
206                 }
207         }
208         --phy->init_count;
209
210 out:
211         mutex_unlock(&phy->mutex);
212         phy_pm_runtime_put(phy);
213         return ret;
214 }
215 EXPORT_SYMBOL_GPL(phy_exit);
216
217 int phy_power_on(struct phy *phy)
218 {
219         int ret;
220
221         if (!phy)
222                 return 0;
223
224         ret = phy_pm_runtime_get_sync(phy);
225         if (ret < 0 && ret != -ENOTSUPP)
226                 return ret;
227
228         mutex_lock(&phy->mutex);
229         if (phy->power_count == 0 && phy->ops->power_on) {
230                 ret = phy->ops->power_on(phy);
231                 if (ret < 0) {
232                         dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
233                         goto out;
234                 }
235         }
236         ++phy->power_count;
237         mutex_unlock(&phy->mutex);
238         return 0;
239
240 out:
241         mutex_unlock(&phy->mutex);
242         phy_pm_runtime_put_sync(phy);
243
244         return ret;
245 }
246 EXPORT_SYMBOL_GPL(phy_power_on);
247
248 int phy_power_off(struct phy *phy)
249 {
250         int ret;
251
252         if (!phy)
253                 return 0;
254
255         mutex_lock(&phy->mutex);
256         if (phy->power_count == 1 && phy->ops->power_off) {
257                 ret =  phy->ops->power_off(phy);
258                 if (ret < 0) {
259                         dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
260                         mutex_unlock(&phy->mutex);
261                         return ret;
262                 }
263         }
264         --phy->power_count;
265         mutex_unlock(&phy->mutex);
266         phy_pm_runtime_put(phy);
267
268         return 0;
269 }
270 EXPORT_SYMBOL_GPL(phy_power_off);
271
272 /**
273  * of_phy_get() - lookup and obtain a reference to a phy by phandle
274  * @dev: device that requests this phy
275  * @index: the index of the phy
276  *
277  * Returns the phy associated with the given phandle value,
278  * after getting a refcount to it or -ENODEV if there is no such phy or
279  * -EPROBE_DEFER if there is a phandle to the phy, but the device is
280  * not yet loaded. This function uses of_xlate call back function provided
281  * while registering the phy_provider to find the phy instance.
282  */
283 static struct phy *of_phy_get(struct device *dev, int index)
284 {
285         int ret;
286         struct phy_provider *phy_provider;
287         struct phy *phy = NULL;
288         struct of_phandle_args args;
289
290         ret = of_parse_phandle_with_args(dev->of_node, "phys", "#phy-cells",
291                 index, &args);
292         if (ret) {
293                 dev_dbg(dev, "failed to get phy in %s node\n",
294                         dev->of_node->full_name);
295                 return ERR_PTR(-ENODEV);
296         }
297
298         mutex_lock(&phy_provider_mutex);
299         phy_provider = of_phy_provider_lookup(args.np);
300         if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
301                 phy = ERR_PTR(-EPROBE_DEFER);
302                 goto err0;
303         }
304
305         phy = phy_provider->of_xlate(phy_provider->dev, &args);
306         module_put(phy_provider->owner);
307
308 err0:
309         mutex_unlock(&phy_provider_mutex);
310         of_node_put(args.np);
311
312         return phy;
313 }
314
315 /**
316  * phy_put() - release the PHY
317  * @phy: the phy returned by phy_get()
318  *
319  * Releases a refcount the caller received from phy_get().
320  */
321 void phy_put(struct phy *phy)
322 {
323         if (!phy || IS_ERR(phy))
324                 return;
325
326         module_put(phy->ops->owner);
327         put_device(&phy->dev);
328 }
329 EXPORT_SYMBOL_GPL(phy_put);
330
331 /**
332  * devm_phy_put() - release the PHY
333  * @dev: device that wants to release this phy
334  * @phy: the phy returned by devm_phy_get()
335  *
336  * destroys the devres associated with this phy and invokes phy_put
337  * to release the phy.
338  */
339 void devm_phy_put(struct device *dev, struct phy *phy)
340 {
341         int r;
342
343         if (!phy)
344                 return;
345
346         r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
347         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
348 }
349 EXPORT_SYMBOL_GPL(devm_phy_put);
350
351 /**
352  * of_phy_simple_xlate() - returns the phy instance from phy provider
353  * @dev: the PHY provider device
354  * @args: of_phandle_args (not used here)
355  *
356  * Intended to be used by phy provider for the common case where #phy-cells is
357  * 0. For other cases where #phy-cells is greater than '0', the phy provider
358  * should provide a custom of_xlate function that reads the *args* and returns
359  * the appropriate phy.
360  */
361 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
362         *args)
363 {
364         struct phy *phy;
365         struct class_dev_iter iter;
366         struct device_node *node = dev->of_node;
367
368         class_dev_iter_init(&iter, phy_class, NULL, NULL);
369         while ((dev = class_dev_iter_next(&iter))) {
370                 phy = to_phy(dev);
371                 if (node != phy->dev.of_node)
372                         continue;
373
374                 class_dev_iter_exit(&iter);
375                 return phy;
376         }
377
378         class_dev_iter_exit(&iter);
379         return ERR_PTR(-ENODEV);
380 }
381 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
382
383 /**
384  * phy_get() - lookup and obtain a reference to a phy.
385  * @dev: device that requests this phy
386  * @string: the phy name as given in the dt data or the name of the controller
387  * port for non-dt case
388  *
389  * Returns the phy driver, after getting a refcount to it; or
390  * -ENODEV if there is no such phy.  The caller is responsible for
391  * calling phy_put() to release that count.
392  */
393 struct phy *phy_get(struct device *dev, const char *string)
394 {
395         int index = 0;
396         struct phy *phy;
397
398         if (string == NULL) {
399                 dev_WARN(dev, "missing string\n");
400                 return ERR_PTR(-EINVAL);
401         }
402
403         if (dev->of_node) {
404                 index = of_property_match_string(dev->of_node, "phy-names",
405                         string);
406                 phy = of_phy_get(dev, index);
407                 if (IS_ERR(phy)) {
408                         dev_err(dev, "unable to find phy\n");
409                         return phy;
410                 }
411         } else {
412                 phy = phy_lookup(dev, string);
413                 if (IS_ERR(phy)) {
414                         dev_err(dev, "unable to find phy\n");
415                         return phy;
416                 }
417         }
418
419         if (!try_module_get(phy->ops->owner))
420                 return ERR_PTR(-EPROBE_DEFER);
421
422         get_device(&phy->dev);
423
424         return phy;
425 }
426 EXPORT_SYMBOL_GPL(phy_get);
427
428 /**
429  * devm_phy_get() - lookup and obtain a reference to a phy.
430  * @dev: device that requests this phy
431  * @string: the phy name as given in the dt data or phy device name
432  * for non-dt case
433  *
434  * Gets the phy using phy_get(), and associates a device with it using
435  * devres. On driver detach, release function is invoked on the devres data,
436  * then, devres data is freed.
437  */
438 struct phy *devm_phy_get(struct device *dev, const char *string)
439 {
440         struct phy **ptr, *phy;
441
442         ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
443         if (!ptr)
444                 return ERR_PTR(-ENOMEM);
445
446         phy = phy_get(dev, string);
447         if (!IS_ERR(phy)) {
448                 *ptr = phy;
449                 devres_add(dev, ptr);
450         } else {
451                 devres_free(ptr);
452         }
453
454         return phy;
455 }
456 EXPORT_SYMBOL_GPL(devm_phy_get);
457
458 /**
459  * phy_create() - create a new phy
460  * @dev: device that is creating the new phy
461  * @ops: function pointers for performing phy operations
462  * @init_data: contains the list of PHY consumers or NULL
463  *
464  * Called to create a phy using phy framework.
465  */
466 struct phy *phy_create(struct device *dev, const struct phy_ops *ops,
467         struct phy_init_data *init_data)
468 {
469         int ret;
470         int id;
471         struct phy *phy;
472
473         if (WARN_ON(!dev))
474                 return ERR_PTR(-EINVAL);
475
476         phy = kzalloc(sizeof(*phy), GFP_KERNEL);
477         if (!phy)
478                 return ERR_PTR(-ENOMEM);
479
480         id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
481         if (id < 0) {
482                 dev_err(dev, "unable to get id\n");
483                 ret = id;
484                 goto free_phy;
485         }
486
487         device_initialize(&phy->dev);
488         mutex_init(&phy->mutex);
489
490         phy->dev.class = phy_class;
491         phy->dev.parent = dev;
492         phy->dev.of_node = dev->of_node;
493         phy->id = id;
494         phy->ops = ops;
495         phy->init_data = init_data;
496
497         ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
498         if (ret)
499                 goto put_dev;
500
501         ret = device_add(&phy->dev);
502         if (ret)
503                 goto put_dev;
504
505         if (pm_runtime_enabled(dev)) {
506                 pm_runtime_enable(&phy->dev);
507                 pm_runtime_no_callbacks(&phy->dev);
508         }
509
510         return phy;
511
512 put_dev:
513         put_device(&phy->dev);
514         ida_remove(&phy_ida, phy->id);
515 free_phy:
516         kfree(phy);
517         return ERR_PTR(ret);
518 }
519 EXPORT_SYMBOL_GPL(phy_create);
520
521 /**
522  * devm_phy_create() - create a new phy
523  * @dev: device that is creating the new phy
524  * @ops: function pointers for performing phy operations
525  * @init_data: contains the list of PHY consumers or NULL
526  *
527  * Creates a new PHY device adding it to the PHY class.
528  * While at that, it also associates the device with the phy using devres.
529  * On driver detach, release function is invoked on the devres data,
530  * then, devres data is freed.
531  */
532 struct phy *devm_phy_create(struct device *dev, const struct phy_ops *ops,
533         struct phy_init_data *init_data)
534 {
535         struct phy **ptr, *phy;
536
537         ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
538         if (!ptr)
539                 return ERR_PTR(-ENOMEM);
540
541         phy = phy_create(dev, ops, init_data);
542         if (!IS_ERR(phy)) {
543                 *ptr = phy;
544                 devres_add(dev, ptr);
545         } else {
546                 devres_free(ptr);
547         }
548
549         return phy;
550 }
551 EXPORT_SYMBOL_GPL(devm_phy_create);
552
553 /**
554  * phy_destroy() - destroy the phy
555  * @phy: the phy to be destroyed
556  *
557  * Called to destroy the phy.
558  */
559 void phy_destroy(struct phy *phy)
560 {
561         pm_runtime_disable(&phy->dev);
562         device_unregister(&phy->dev);
563 }
564 EXPORT_SYMBOL_GPL(phy_destroy);
565
566 /**
567  * devm_phy_destroy() - destroy the PHY
568  * @dev: device that wants to release this phy
569  * @phy: the phy returned by devm_phy_get()
570  *
571  * destroys the devres associated with this phy and invokes phy_destroy
572  * to destroy the phy.
573  */
574 void devm_phy_destroy(struct device *dev, struct phy *phy)
575 {
576         int r;
577
578         r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
579         dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
580 }
581 EXPORT_SYMBOL_GPL(devm_phy_destroy);
582
583 /**
584  * __of_phy_provider_register() - create/register phy provider with the framework
585  * @dev: struct device of the phy provider
586  * @owner: the module owner containing of_xlate
587  * @of_xlate: function pointer to obtain phy instance from phy provider
588  *
589  * Creates struct phy_provider from dev and of_xlate function pointer.
590  * This is used in the case of dt boot for finding the phy instance from
591  * phy provider.
592  */
593 struct phy_provider *__of_phy_provider_register(struct device *dev,
594         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
595         struct of_phandle_args *args))
596 {
597         struct phy_provider *phy_provider;
598
599         phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
600         if (!phy_provider)
601                 return ERR_PTR(-ENOMEM);
602
603         phy_provider->dev = dev;
604         phy_provider->owner = owner;
605         phy_provider->of_xlate = of_xlate;
606
607         mutex_lock(&phy_provider_mutex);
608         list_add_tail(&phy_provider->list, &phy_provider_list);
609         mutex_unlock(&phy_provider_mutex);
610
611         return phy_provider;
612 }
613 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
614
615 /**
616  * __devm_of_phy_provider_register() - create/register phy provider with the
617  * framework
618  * @dev: struct device of the phy provider
619  * @owner: the module owner containing of_xlate
620  * @of_xlate: function pointer to obtain phy instance from phy provider
621  *
622  * Creates struct phy_provider from dev and of_xlate function pointer.
623  * This is used in the case of dt boot for finding the phy instance from
624  * phy provider. While at that, it also associates the device with the
625  * phy provider using devres. On driver detach, release function is invoked
626  * on the devres data, then, devres data is freed.
627  */
628 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
629         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
630         struct of_phandle_args *args))
631 {
632         struct phy_provider **ptr, *phy_provider;
633
634         ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
635         if (!ptr)
636                 return ERR_PTR(-ENOMEM);
637
638         phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
639         if (!IS_ERR(phy_provider)) {
640                 *ptr = phy_provider;
641                 devres_add(dev, ptr);
642         } else {
643                 devres_free(ptr);
644         }
645
646         return phy_provider;
647 }
648 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
649
650 /**
651  * of_phy_provider_unregister() - unregister phy provider from the framework
652  * @phy_provider: phy provider returned by of_phy_provider_register()
653  *
654  * Removes the phy_provider created using of_phy_provider_register().
655  */
656 void of_phy_provider_unregister(struct phy_provider *phy_provider)
657 {
658         if (IS_ERR(phy_provider))
659                 return;
660
661         mutex_lock(&phy_provider_mutex);
662         list_del(&phy_provider->list);
663         kfree(phy_provider);
664         mutex_unlock(&phy_provider_mutex);
665 }
666 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
667
668 /**
669  * devm_of_phy_provider_unregister() - remove phy provider from the framework
670  * @dev: struct device of the phy provider
671  *
672  * destroys the devres associated with this phy provider and invokes
673  * of_phy_provider_unregister to unregister the phy provider.
674  */
675 void devm_of_phy_provider_unregister(struct device *dev,
676         struct phy_provider *phy_provider) {
677         int r;
678
679         r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
680                 phy_provider);
681         dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
682 }
683 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
684
685 /**
686  * phy_release() - release the phy
687  * @dev: the dev member within phy
688  *
689  * When the last reference to the device is removed, it is called
690  * from the embedded kobject as release method.
691  */
692 static void phy_release(struct device *dev)
693 {
694         struct phy *phy;
695
696         phy = to_phy(dev);
697         dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
698         ida_remove(&phy_ida, phy->id);
699         kfree(phy);
700 }
701
702 static int __init phy_core_init(void)
703 {
704         phy_class = class_create(THIS_MODULE, "phy");
705         if (IS_ERR(phy_class)) {
706                 pr_err("failed to create phy class --> %ld\n",
707                         PTR_ERR(phy_class));
708                 return PTR_ERR(phy_class);
709         }
710
711         phy_class->dev_release = phy_release;
712
713         return 0;
714 }
715 module_init(phy_core_init);
716
717 static void __exit phy_core_exit(void)
718 {
719         class_destroy(phy_class);
720 }
721 module_exit(phy_core_exit);
722
723 MODULE_DESCRIPTION("Generic PHY Framework");
724 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
725 MODULE_LICENSE("GPL v2");