fix a kmap leak in virtio_console
[linux/fpc-iii.git] / drivers / phy / phy-core.c
blob645c867c12573e554d43e3700155db5469841caa
1 /*
2 * phy-core.c -- Generic Phy framework.
4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/export.h>
16 #include <linux/module.h>
17 #include <linux/err.h>
18 #include <linux/device.h>
19 #include <linux/slab.h>
20 #include <linux/of.h>
21 #include <linux/phy/phy.h>
22 #include <linux/idr.h>
23 #include <linux/pm_runtime.h>
25 static struct class *phy_class;
26 static DEFINE_MUTEX(phy_provider_mutex);
27 static LIST_HEAD(phy_provider_list);
28 static DEFINE_IDA(phy_ida);
30 static void devm_phy_release(struct device *dev, void *res)
32 struct phy *phy = *(struct phy **)res;
34 phy_put(phy);
37 static void devm_phy_provider_release(struct device *dev, void *res)
39 struct phy_provider *phy_provider = *(struct phy_provider **)res;
41 of_phy_provider_unregister(phy_provider);
44 static void devm_phy_consume(struct device *dev, void *res)
46 struct phy *phy = *(struct phy **)res;
48 phy_destroy(phy);
51 static int devm_phy_match(struct device *dev, void *res, void *match_data)
53 return res == match_data;
56 static struct phy *phy_lookup(struct device *device, const char *port)
58 unsigned int count;
59 struct phy *phy;
60 struct device *dev;
61 struct phy_consumer *consumers;
62 struct class_dev_iter iter;
64 class_dev_iter_init(&iter, phy_class, NULL, NULL);
65 while ((dev = class_dev_iter_next(&iter))) {
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;
75 consumers++;
79 class_dev_iter_exit(&iter);
80 return ERR_PTR(-ENODEV);
83 static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
85 struct phy_provider *phy_provider;
87 list_for_each_entry(phy_provider, &phy_provider_list, list) {
88 if (phy_provider->dev->of_node == node)
89 return phy_provider;
92 return ERR_PTR(-EPROBE_DEFER);
95 int phy_pm_runtime_get(struct phy *phy)
97 int ret;
99 if (!pm_runtime_enabled(&phy->dev))
100 return -ENOTSUPP;
102 ret = pm_runtime_get(&phy->dev);
103 if (ret < 0 && ret != -EINPROGRESS)
104 pm_runtime_put_noidle(&phy->dev);
106 return ret;
108 EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
110 int phy_pm_runtime_get_sync(struct phy *phy)
112 int ret;
114 if (!pm_runtime_enabled(&phy->dev))
115 return -ENOTSUPP;
117 ret = pm_runtime_get_sync(&phy->dev);
118 if (ret < 0)
119 pm_runtime_put_sync(&phy->dev);
121 return ret;
123 EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
125 int phy_pm_runtime_put(struct phy *phy)
127 if (!pm_runtime_enabled(&phy->dev))
128 return -ENOTSUPP;
130 return pm_runtime_put(&phy->dev);
132 EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
134 int phy_pm_runtime_put_sync(struct phy *phy)
136 if (!pm_runtime_enabled(&phy->dev))
137 return -ENOTSUPP;
139 return pm_runtime_put_sync(&phy->dev);
141 EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
143 void phy_pm_runtime_allow(struct phy *phy)
145 if (!pm_runtime_enabled(&phy->dev))
146 return;
148 pm_runtime_allow(&phy->dev);
150 EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
152 void phy_pm_runtime_forbid(struct phy *phy)
154 if (!pm_runtime_enabled(&phy->dev))
155 return;
157 pm_runtime_forbid(&phy->dev);
159 EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
161 int phy_init(struct phy *phy)
163 int ret;
165 ret = phy_pm_runtime_get_sync(phy);
166 if (ret < 0 && ret != -ENOTSUPP)
167 return ret;
169 mutex_lock(&phy->mutex);
170 if (phy->init_count == 0 && phy->ops->init) {
171 ret = phy->ops->init(phy);
172 if (ret < 0) {
173 dev_err(&phy->dev, "phy init failed --> %d\n", ret);
174 goto out;
177 ++phy->init_count;
179 out:
180 mutex_unlock(&phy->mutex);
181 phy_pm_runtime_put(phy);
182 return ret;
184 EXPORT_SYMBOL_GPL(phy_init);
186 int phy_exit(struct phy *phy)
188 int ret;
190 ret = phy_pm_runtime_get_sync(phy);
191 if (ret < 0 && ret != -ENOTSUPP)
192 return ret;
194 mutex_lock(&phy->mutex);
195 if (phy->init_count == 1 && phy->ops->exit) {
196 ret = phy->ops->exit(phy);
197 if (ret < 0) {
198 dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
199 goto out;
202 --phy->init_count;
204 out:
205 mutex_unlock(&phy->mutex);
206 phy_pm_runtime_put(phy);
207 return ret;
209 EXPORT_SYMBOL_GPL(phy_exit);
211 int phy_power_on(struct phy *phy)
213 int ret;
215 ret = phy_pm_runtime_get_sync(phy);
216 if (ret < 0 && ret != -ENOTSUPP)
217 return ret;
219 mutex_lock(&phy->mutex);
220 if (phy->power_count == 0 && phy->ops->power_on) {
221 ret = phy->ops->power_on(phy);
222 if (ret < 0) {
223 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
224 goto out;
227 ++phy->power_count;
228 mutex_unlock(&phy->mutex);
229 return 0;
231 out:
232 mutex_unlock(&phy->mutex);
233 phy_pm_runtime_put_sync(phy);
235 return ret;
237 EXPORT_SYMBOL_GPL(phy_power_on);
239 int phy_power_off(struct phy *phy)
241 int ret;
243 mutex_lock(&phy->mutex);
244 if (phy->power_count == 1 && phy->ops->power_off) {
245 ret = phy->ops->power_off(phy);
246 if (ret < 0) {
247 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
248 mutex_unlock(&phy->mutex);
249 return ret;
252 --phy->power_count;
253 mutex_unlock(&phy->mutex);
254 phy_pm_runtime_put(phy);
256 return 0;
258 EXPORT_SYMBOL_GPL(phy_power_off);
261 * of_phy_get() - lookup and obtain a reference to a phy by phandle
262 * @dev: device that requests this phy
263 * @index: the index of the phy
265 * Returns the phy associated with the given phandle value,
266 * after getting a refcount to it or -ENODEV if there is no such phy or
267 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
268 * not yet loaded. This function uses of_xlate call back function provided
269 * while registering the phy_provider to find the phy instance.
271 static struct phy *of_phy_get(struct device *dev, int index)
273 int ret;
274 struct phy_provider *phy_provider;
275 struct phy *phy = NULL;
276 struct of_phandle_args args;
278 ret = of_parse_phandle_with_args(dev->of_node, "phys", "#phy-cells",
279 index, &args);
280 if (ret) {
281 dev_dbg(dev, "failed to get phy in %s node\n",
282 dev->of_node->full_name);
283 return ERR_PTR(-ENODEV);
286 mutex_lock(&phy_provider_mutex);
287 phy_provider = of_phy_provider_lookup(args.np);
288 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
289 phy = ERR_PTR(-EPROBE_DEFER);
290 goto err0;
293 phy = phy_provider->of_xlate(phy_provider->dev, &args);
294 module_put(phy_provider->owner);
296 err0:
297 mutex_unlock(&phy_provider_mutex);
298 of_node_put(args.np);
300 return phy;
304 * phy_put() - release the PHY
305 * @phy: the phy returned by phy_get()
307 * Releases a refcount the caller received from phy_get().
309 void phy_put(struct phy *phy)
311 if (IS_ERR(phy))
312 return;
314 module_put(phy->ops->owner);
315 put_device(&phy->dev);
317 EXPORT_SYMBOL_GPL(phy_put);
320 * devm_phy_put() - release the PHY
321 * @dev: device that wants to release this phy
322 * @phy: the phy returned by devm_phy_get()
324 * destroys the devres associated with this phy and invokes phy_put
325 * to release the phy.
327 void devm_phy_put(struct device *dev, struct phy *phy)
329 int r;
331 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
332 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
334 EXPORT_SYMBOL_GPL(devm_phy_put);
337 * of_phy_simple_xlate() - returns the phy instance from phy provider
338 * @dev: the PHY provider device
339 * @args: of_phandle_args (not used here)
341 * Intended to be used by phy provider for the common case where #phy-cells is
342 * 0. For other cases where #phy-cells is greater than '0', the phy provider
343 * should provide a custom of_xlate function that reads the *args* and returns
344 * the appropriate phy.
346 struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
347 *args)
349 struct phy *phy;
350 struct class_dev_iter iter;
351 struct device_node *node = dev->of_node;
353 class_dev_iter_init(&iter, phy_class, NULL, NULL);
354 while ((dev = class_dev_iter_next(&iter))) {
355 phy = to_phy(dev);
356 if (node != phy->dev.of_node)
357 continue;
359 class_dev_iter_exit(&iter);
360 return phy;
363 class_dev_iter_exit(&iter);
364 return ERR_PTR(-ENODEV);
366 EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
369 * phy_get() - lookup and obtain a reference to a phy.
370 * @dev: device that requests this phy
371 * @string: the phy name as given in the dt data or the name of the controller
372 * port for non-dt case
374 * Returns the phy driver, after getting a refcount to it; or
375 * -ENODEV if there is no such phy. The caller is responsible for
376 * calling phy_put() to release that count.
378 struct phy *phy_get(struct device *dev, const char *string)
380 int index = 0;
381 struct phy *phy;
383 if (string == NULL) {
384 dev_WARN(dev, "missing string\n");
385 return ERR_PTR(-EINVAL);
388 if (dev->of_node) {
389 index = of_property_match_string(dev->of_node, "phy-names",
390 string);
391 phy = of_phy_get(dev, index);
392 if (IS_ERR(phy)) {
393 dev_err(dev, "unable to find phy\n");
394 return phy;
396 } else {
397 phy = phy_lookup(dev, string);
398 if (IS_ERR(phy)) {
399 dev_err(dev, "unable to find phy\n");
400 return phy;
404 if (!try_module_get(phy->ops->owner))
405 return ERR_PTR(-EPROBE_DEFER);
407 get_device(&phy->dev);
409 return phy;
411 EXPORT_SYMBOL_GPL(phy_get);
414 * devm_phy_get() - lookup and obtain a reference to a phy.
415 * @dev: device that requests this phy
416 * @string: the phy name as given in the dt data or phy device name
417 * for non-dt case
419 * Gets the phy using phy_get(), and associates a device with it using
420 * devres. On driver detach, release function is invoked on the devres data,
421 * then, devres data is freed.
423 struct phy *devm_phy_get(struct device *dev, const char *string)
425 struct phy **ptr, *phy;
427 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
428 if (!ptr)
429 return ERR_PTR(-ENOMEM);
431 phy = phy_get(dev, string);
432 if (!IS_ERR(phy)) {
433 *ptr = phy;
434 devres_add(dev, ptr);
435 } else {
436 devres_free(ptr);
439 return phy;
441 EXPORT_SYMBOL_GPL(devm_phy_get);
444 * phy_create() - create a new phy
445 * @dev: device that is creating the new phy
446 * @ops: function pointers for performing phy operations
447 * @init_data: contains the list of PHY consumers or NULL
449 * Called to create a phy using phy framework.
451 struct phy *phy_create(struct device *dev, const struct phy_ops *ops,
452 struct phy_init_data *init_data)
454 int ret;
455 int id;
456 struct phy *phy;
458 if (WARN_ON(!dev))
459 return ERR_PTR(-EINVAL);
461 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
462 if (!phy)
463 return ERR_PTR(-ENOMEM);
465 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
466 if (id < 0) {
467 dev_err(dev, "unable to get id\n");
468 ret = id;
469 goto free_phy;
472 device_initialize(&phy->dev);
473 mutex_init(&phy->mutex);
475 phy->dev.class = phy_class;
476 phy->dev.parent = dev;
477 phy->dev.of_node = dev->of_node;
478 phy->id = id;
479 phy->ops = ops;
480 phy->init_data = init_data;
482 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
483 if (ret)
484 goto put_dev;
486 ret = device_add(&phy->dev);
487 if (ret)
488 goto put_dev;
490 if (pm_runtime_enabled(dev)) {
491 pm_runtime_enable(&phy->dev);
492 pm_runtime_no_callbacks(&phy->dev);
495 return phy;
497 put_dev:
498 put_device(&phy->dev);
499 ida_remove(&phy_ida, phy->id);
500 free_phy:
501 kfree(phy);
502 return ERR_PTR(ret);
504 EXPORT_SYMBOL_GPL(phy_create);
507 * devm_phy_create() - create a new phy
508 * @dev: device that is creating the new phy
509 * @ops: function pointers for performing phy operations
510 * @init_data: contains the list of PHY consumers or NULL
512 * Creates a new PHY device adding it to the PHY class.
513 * While at that, it also associates the device with the phy using devres.
514 * On driver detach, release function is invoked on the devres data,
515 * then, devres data is freed.
517 struct phy *devm_phy_create(struct device *dev, const struct phy_ops *ops,
518 struct phy_init_data *init_data)
520 struct phy **ptr, *phy;
522 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
523 if (!ptr)
524 return ERR_PTR(-ENOMEM);
526 phy = phy_create(dev, ops, init_data);
527 if (!IS_ERR(phy)) {
528 *ptr = phy;
529 devres_add(dev, ptr);
530 } else {
531 devres_free(ptr);
534 return phy;
536 EXPORT_SYMBOL_GPL(devm_phy_create);
539 * phy_destroy() - destroy the phy
540 * @phy: the phy to be destroyed
542 * Called to destroy the phy.
544 void phy_destroy(struct phy *phy)
546 pm_runtime_disable(&phy->dev);
547 device_unregister(&phy->dev);
549 EXPORT_SYMBOL_GPL(phy_destroy);
552 * devm_phy_destroy() - destroy the PHY
553 * @dev: device that wants to release this phy
554 * @phy: the phy returned by devm_phy_get()
556 * destroys the devres associated with this phy and invokes phy_destroy
557 * to destroy the phy.
559 void devm_phy_destroy(struct device *dev, struct phy *phy)
561 int r;
563 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
564 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
566 EXPORT_SYMBOL_GPL(devm_phy_destroy);
569 * __of_phy_provider_register() - create/register phy provider with the framework
570 * @dev: struct device of the phy provider
571 * @owner: the module owner containing of_xlate
572 * @of_xlate: function pointer to obtain phy instance from phy provider
574 * Creates struct phy_provider from dev and of_xlate function pointer.
575 * This is used in the case of dt boot for finding the phy instance from
576 * phy provider.
578 struct phy_provider *__of_phy_provider_register(struct device *dev,
579 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
580 struct of_phandle_args *args))
582 struct phy_provider *phy_provider;
584 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
585 if (!phy_provider)
586 return ERR_PTR(-ENOMEM);
588 phy_provider->dev = dev;
589 phy_provider->owner = owner;
590 phy_provider->of_xlate = of_xlate;
592 mutex_lock(&phy_provider_mutex);
593 list_add_tail(&phy_provider->list, &phy_provider_list);
594 mutex_unlock(&phy_provider_mutex);
596 return phy_provider;
598 EXPORT_SYMBOL_GPL(__of_phy_provider_register);
601 * __devm_of_phy_provider_register() - create/register phy provider with the
602 * framework
603 * @dev: struct device of the phy provider
604 * @owner: the module owner containing of_xlate
605 * @of_xlate: function pointer to obtain phy instance from phy provider
607 * Creates struct phy_provider from dev and of_xlate function pointer.
608 * This is used in the case of dt boot for finding the phy instance from
609 * phy provider. While at that, it also associates the device with the
610 * phy provider using devres. On driver detach, release function is invoked
611 * on the devres data, then, devres data is freed.
613 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
614 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
615 struct of_phandle_args *args))
617 struct phy_provider **ptr, *phy_provider;
619 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
620 if (!ptr)
621 return ERR_PTR(-ENOMEM);
623 phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
624 if (!IS_ERR(phy_provider)) {
625 *ptr = phy_provider;
626 devres_add(dev, ptr);
627 } else {
628 devres_free(ptr);
631 return phy_provider;
633 EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
636 * of_phy_provider_unregister() - unregister phy provider from the framework
637 * @phy_provider: phy provider returned by of_phy_provider_register()
639 * Removes the phy_provider created using of_phy_provider_register().
641 void of_phy_provider_unregister(struct phy_provider *phy_provider)
643 if (IS_ERR(phy_provider))
644 return;
646 mutex_lock(&phy_provider_mutex);
647 list_del(&phy_provider->list);
648 kfree(phy_provider);
649 mutex_unlock(&phy_provider_mutex);
651 EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
654 * devm_of_phy_provider_unregister() - remove phy provider from the framework
655 * @dev: struct device of the phy provider
657 * destroys the devres associated with this phy provider and invokes
658 * of_phy_provider_unregister to unregister the phy provider.
660 void devm_of_phy_provider_unregister(struct device *dev,
661 struct phy_provider *phy_provider) {
662 int r;
664 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
665 phy_provider);
666 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
668 EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
671 * phy_release() - release the phy
672 * @dev: the dev member within phy
674 * When the last reference to the device is removed, it is called
675 * from the embedded kobject as release method.
677 static void phy_release(struct device *dev)
679 struct phy *phy;
681 phy = to_phy(dev);
682 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
683 ida_remove(&phy_ida, phy->id);
684 kfree(phy);
687 static int __init phy_core_init(void)
689 phy_class = class_create(THIS_MODULE, "phy");
690 if (IS_ERR(phy_class)) {
691 pr_err("failed to create phy class --> %ld\n",
692 PTR_ERR(phy_class));
693 return PTR_ERR(phy_class);
696 phy_class->dev_release = phy_release;
698 return 0;
700 module_init(phy_core_init);
702 static void __exit phy_core_exit(void)
704 class_destroy(phy_class);
706 module_exit(phy_core_exit);
708 MODULE_DESCRIPTION("Generic PHY Framework");
709 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
710 MODULE_LICENSE("GPL v2");