xref: /openbmc/linux/drivers/phy/phy-core.c (revision 491e049064a4ea69ba4b35bdf614f12bc762a717)
1ff764963SKishon Vijay Abraham I /*
2ff764963SKishon Vijay Abraham I  * phy-core.c  --  Generic Phy framework.
3ff764963SKishon Vijay Abraham I  *
4ff764963SKishon Vijay Abraham I  * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
5ff764963SKishon Vijay Abraham I  *
6ff764963SKishon Vijay Abraham I  * Author: Kishon Vijay Abraham I <kishon@ti.com>
7ff764963SKishon Vijay Abraham I  *
8ff764963SKishon Vijay Abraham I  * This program is free software; you can redistribute  it and/or modify it
9ff764963SKishon Vijay Abraham I  * under  the terms of  the GNU General  Public License as published by the
10ff764963SKishon Vijay Abraham I  * Free Software Foundation;  either version 2 of the  License, or (at your
11ff764963SKishon Vijay Abraham I  * option) any later version.
12ff764963SKishon Vijay Abraham I  */
13ff764963SKishon Vijay Abraham I 
14ff764963SKishon Vijay Abraham I #include <linux/kernel.h>
15ff764963SKishon Vijay Abraham I #include <linux/export.h>
16ff764963SKishon Vijay Abraham I #include <linux/module.h>
17ff764963SKishon Vijay Abraham I #include <linux/err.h>
18ff764963SKishon Vijay Abraham I #include <linux/device.h>
19ff764963SKishon Vijay Abraham I #include <linux/slab.h>
20ff764963SKishon Vijay Abraham I #include <linux/of.h>
21ff764963SKishon Vijay Abraham I #include <linux/phy/phy.h>
22ff764963SKishon Vijay Abraham I #include <linux/idr.h>
23ff764963SKishon Vijay Abraham I #include <linux/pm_runtime.h>
243be88125SRoger Quadros #include <linux/regulator/consumer.h>
25ff764963SKishon Vijay Abraham I 
26ff764963SKishon Vijay Abraham I static struct class *phy_class;
27ff764963SKishon Vijay Abraham I static DEFINE_MUTEX(phy_provider_mutex);
28ff764963SKishon Vijay Abraham I static LIST_HEAD(phy_provider_list);
29ff764963SKishon Vijay Abraham I static DEFINE_IDA(phy_ida);
30ff764963SKishon Vijay Abraham I 
31ff764963SKishon Vijay Abraham I static void devm_phy_release(struct device *dev, void *res)
32ff764963SKishon Vijay Abraham I {
33ff764963SKishon Vijay Abraham I 	struct phy *phy = *(struct phy **)res;
34ff764963SKishon Vijay Abraham I 
35ff764963SKishon Vijay Abraham I 	phy_put(phy);
36ff764963SKishon Vijay Abraham I }
37ff764963SKishon Vijay Abraham I 
38ff764963SKishon Vijay Abraham I static void devm_phy_provider_release(struct device *dev, void *res)
39ff764963SKishon Vijay Abraham I {
40ff764963SKishon Vijay Abraham I 	struct phy_provider *phy_provider = *(struct phy_provider **)res;
41ff764963SKishon Vijay Abraham I 
42ff764963SKishon Vijay Abraham I 	of_phy_provider_unregister(phy_provider);
43ff764963SKishon Vijay Abraham I }
44ff764963SKishon Vijay Abraham I 
45ff764963SKishon Vijay Abraham I static void devm_phy_consume(struct device *dev, void *res)
46ff764963SKishon Vijay Abraham I {
47ff764963SKishon Vijay Abraham I 	struct phy *phy = *(struct phy **)res;
48ff764963SKishon Vijay Abraham I 
49ff764963SKishon Vijay Abraham I 	phy_destroy(phy);
50ff764963SKishon Vijay Abraham I }
51ff764963SKishon Vijay Abraham I 
52ff764963SKishon Vijay Abraham I static int devm_phy_match(struct device *dev, void *res, void *match_data)
53ff764963SKishon Vijay Abraham I {
54ff764963SKishon Vijay Abraham I 	return res == match_data;
55ff764963SKishon Vijay Abraham I }
56ff764963SKishon Vijay Abraham I 
57ff764963SKishon Vijay Abraham I static struct phy *phy_lookup(struct device *device, const char *port)
58ff764963SKishon Vijay Abraham I {
59ff764963SKishon Vijay Abraham I 	unsigned int count;
60ff764963SKishon Vijay Abraham I 	struct phy *phy;
61ff764963SKishon Vijay Abraham I 	struct device *dev;
62ff764963SKishon Vijay Abraham I 	struct phy_consumer *consumers;
63ff764963SKishon Vijay Abraham I 	struct class_dev_iter iter;
64ff764963SKishon Vijay Abraham I 
65ff764963SKishon Vijay Abraham I 	class_dev_iter_init(&iter, phy_class, NULL, NULL);
66ff764963SKishon Vijay Abraham I 	while ((dev = class_dev_iter_next(&iter))) {
67ff764963SKishon Vijay Abraham I 		phy = to_phy(dev);
68743bb387SSergei Shtylyov 
69743bb387SSergei Shtylyov 		if (!phy->init_data)
70743bb387SSergei Shtylyov 			continue;
71ff764963SKishon Vijay Abraham I 		count = phy->init_data->num_consumers;
72ff764963SKishon Vijay Abraham I 		consumers = phy->init_data->consumers;
73ff764963SKishon Vijay Abraham I 		while (count--) {
74ff764963SKishon Vijay Abraham I 			if (!strcmp(consumers->dev_name, dev_name(device)) &&
75ff764963SKishon Vijay Abraham I 					!strcmp(consumers->port, port)) {
76ff764963SKishon Vijay Abraham I 				class_dev_iter_exit(&iter);
77ff764963SKishon Vijay Abraham I 				return phy;
78ff764963SKishon Vijay Abraham I 			}
79ff764963SKishon Vijay Abraham I 			consumers++;
80ff764963SKishon Vijay Abraham I 		}
81ff764963SKishon Vijay Abraham I 	}
82ff764963SKishon Vijay Abraham I 
83ff764963SKishon Vijay Abraham I 	class_dev_iter_exit(&iter);
84ff764963SKishon Vijay Abraham I 	return ERR_PTR(-ENODEV);
85ff764963SKishon Vijay Abraham I }
86ff764963SKishon Vijay Abraham I 
87ff764963SKishon Vijay Abraham I static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
88ff764963SKishon Vijay Abraham I {
89ff764963SKishon Vijay Abraham I 	struct phy_provider *phy_provider;
902a4c3701SKishon Vijay Abraham I 	struct device_node *child;
91ff764963SKishon Vijay Abraham I 
92ff764963SKishon Vijay Abraham I 	list_for_each_entry(phy_provider, &phy_provider_list, list) {
93ff764963SKishon Vijay Abraham I 		if (phy_provider->dev->of_node == node)
94ff764963SKishon Vijay Abraham I 			return phy_provider;
952a4c3701SKishon Vijay Abraham I 
962a4c3701SKishon Vijay Abraham I 		for_each_child_of_node(phy_provider->dev->of_node, child)
972a4c3701SKishon Vijay Abraham I 			if (child == node)
982a4c3701SKishon Vijay Abraham I 				return phy_provider;
99ff764963SKishon Vijay Abraham I 	}
100ff764963SKishon Vijay Abraham I 
101ff764963SKishon Vijay Abraham I 	return ERR_PTR(-EPROBE_DEFER);
102ff764963SKishon Vijay Abraham I }
103ff764963SKishon Vijay Abraham I 
104ff764963SKishon Vijay Abraham I int phy_pm_runtime_get(struct phy *phy)
105ff764963SKishon Vijay Abraham I {
106cedb7f89SFelipe Balbi 	int ret;
107cedb7f89SFelipe Balbi 
108ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
109ff764963SKishon Vijay Abraham I 		return -ENOTSUPP;
110ff764963SKishon Vijay Abraham I 
111cedb7f89SFelipe Balbi 	ret = pm_runtime_get(&phy->dev);
112cedb7f89SFelipe Balbi 	if (ret < 0 && ret != -EINPROGRESS)
113cedb7f89SFelipe Balbi 		pm_runtime_put_noidle(&phy->dev);
114cedb7f89SFelipe Balbi 
115cedb7f89SFelipe Balbi 	return ret;
116ff764963SKishon Vijay Abraham I }
117ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
118ff764963SKishon Vijay Abraham I 
119ff764963SKishon Vijay Abraham I int phy_pm_runtime_get_sync(struct phy *phy)
120ff764963SKishon Vijay Abraham I {
121cedb7f89SFelipe Balbi 	int ret;
122cedb7f89SFelipe Balbi 
123ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
124ff764963SKishon Vijay Abraham I 		return -ENOTSUPP;
125ff764963SKishon Vijay Abraham I 
126cedb7f89SFelipe Balbi 	ret = pm_runtime_get_sync(&phy->dev);
127cedb7f89SFelipe Balbi 	if (ret < 0)
128cedb7f89SFelipe Balbi 		pm_runtime_put_sync(&phy->dev);
129cedb7f89SFelipe Balbi 
130cedb7f89SFelipe Balbi 	return ret;
131ff764963SKishon Vijay Abraham I }
132ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync);
133ff764963SKishon Vijay Abraham I 
134ff764963SKishon Vijay Abraham I int phy_pm_runtime_put(struct phy *phy)
135ff764963SKishon Vijay Abraham I {
136ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
137ff764963SKishon Vijay Abraham I 		return -ENOTSUPP;
138ff764963SKishon Vijay Abraham I 
139ff764963SKishon Vijay Abraham I 	return pm_runtime_put(&phy->dev);
140ff764963SKishon Vijay Abraham I }
141ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_put);
142ff764963SKishon Vijay Abraham I 
143ff764963SKishon Vijay Abraham I int phy_pm_runtime_put_sync(struct phy *phy)
144ff764963SKishon Vijay Abraham I {
145ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
146ff764963SKishon Vijay Abraham I 		return -ENOTSUPP;
147ff764963SKishon Vijay Abraham I 
148ff764963SKishon Vijay Abraham I 	return pm_runtime_put_sync(&phy->dev);
149ff764963SKishon Vijay Abraham I }
150ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync);
151ff764963SKishon Vijay Abraham I 
152ff764963SKishon Vijay Abraham I void phy_pm_runtime_allow(struct phy *phy)
153ff764963SKishon Vijay Abraham I {
154ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
155ff764963SKishon Vijay Abraham I 		return;
156ff764963SKishon Vijay Abraham I 
157ff764963SKishon Vijay Abraham I 	pm_runtime_allow(&phy->dev);
158ff764963SKishon Vijay Abraham I }
159ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_allow);
160ff764963SKishon Vijay Abraham I 
161ff764963SKishon Vijay Abraham I void phy_pm_runtime_forbid(struct phy *phy)
162ff764963SKishon Vijay Abraham I {
163ff764963SKishon Vijay Abraham I 	if (!pm_runtime_enabled(&phy->dev))
164ff764963SKishon Vijay Abraham I 		return;
165ff764963SKishon Vijay Abraham I 
166ff764963SKishon Vijay Abraham I 	pm_runtime_forbid(&phy->dev);
167ff764963SKishon Vijay Abraham I }
168ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid);
169ff764963SKishon Vijay Abraham I 
170ff764963SKishon Vijay Abraham I int phy_init(struct phy *phy)
171ff764963SKishon Vijay Abraham I {
172ff764963SKishon Vijay Abraham I 	int ret;
173ff764963SKishon Vijay Abraham I 
17404c2facaSAndrew Lunn 	if (!phy)
17504c2facaSAndrew Lunn 		return 0;
17604c2facaSAndrew Lunn 
177ff764963SKishon Vijay Abraham I 	ret = phy_pm_runtime_get_sync(phy);
178ff764963SKishon Vijay Abraham I 	if (ret < 0 && ret != -ENOTSUPP)
179ff764963SKishon Vijay Abraham I 		return ret;
180ff764963SKishon Vijay Abraham I 
181ff764963SKishon Vijay Abraham I 	mutex_lock(&phy->mutex);
182637d378cSKishon Vijay Abraham I 	if (phy->init_count == 0 && phy->ops->init) {
183ff764963SKishon Vijay Abraham I 		ret = phy->ops->init(phy);
184ff764963SKishon Vijay Abraham I 		if (ret < 0) {
185ff764963SKishon Vijay Abraham I 			dev_err(&phy->dev, "phy init failed --> %d\n", ret);
186ff764963SKishon Vijay Abraham I 			goto out;
187ff764963SKishon Vijay Abraham I 		}
188767a1b5dSHans de Goede 	} else {
189767a1b5dSHans de Goede 		ret = 0; /* Override possible ret == -ENOTSUPP */
190ff764963SKishon Vijay Abraham I 	}
191637d378cSKishon Vijay Abraham I 	++phy->init_count;
192ff764963SKishon Vijay Abraham I 
193ff764963SKishon Vijay Abraham I out:
194ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy->mutex);
195ff764963SKishon Vijay Abraham I 	phy_pm_runtime_put(phy);
196ff764963SKishon Vijay Abraham I 	return ret;
197ff764963SKishon Vijay Abraham I }
198ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_init);
199ff764963SKishon Vijay Abraham I 
200ff764963SKishon Vijay Abraham I int phy_exit(struct phy *phy)
201ff764963SKishon Vijay Abraham I {
202ff764963SKishon Vijay Abraham I 	int ret;
203ff764963SKishon Vijay Abraham I 
20404c2facaSAndrew Lunn 	if (!phy)
20504c2facaSAndrew Lunn 		return 0;
20604c2facaSAndrew Lunn 
207ff764963SKishon Vijay Abraham I 	ret = phy_pm_runtime_get_sync(phy);
208ff764963SKishon Vijay Abraham I 	if (ret < 0 && ret != -ENOTSUPP)
209ff764963SKishon Vijay Abraham I 		return ret;
210ff764963SKishon Vijay Abraham I 
211ff764963SKishon Vijay Abraham I 	mutex_lock(&phy->mutex);
212637d378cSKishon Vijay Abraham I 	if (phy->init_count == 1 && phy->ops->exit) {
213ff764963SKishon Vijay Abraham I 		ret = phy->ops->exit(phy);
214ff764963SKishon Vijay Abraham I 		if (ret < 0) {
215ff764963SKishon Vijay Abraham I 			dev_err(&phy->dev, "phy exit failed --> %d\n", ret);
216ff764963SKishon Vijay Abraham I 			goto out;
217ff764963SKishon Vijay Abraham I 		}
218ff764963SKishon Vijay Abraham I 	}
219637d378cSKishon Vijay Abraham I 	--phy->init_count;
220ff764963SKishon Vijay Abraham I 
221ff764963SKishon Vijay Abraham I out:
222ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy->mutex);
223ff764963SKishon Vijay Abraham I 	phy_pm_runtime_put(phy);
224ff764963SKishon Vijay Abraham I 	return ret;
225ff764963SKishon Vijay Abraham I }
226ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_exit);
227ff764963SKishon Vijay Abraham I 
228ff764963SKishon Vijay Abraham I int phy_power_on(struct phy *phy)
229ff764963SKishon Vijay Abraham I {
230d18c9604SKishon Vijay Abraham I 	int ret;
231ff764963SKishon Vijay Abraham I 
23204c2facaSAndrew Lunn 	if (!phy)
23304c2facaSAndrew Lunn 		return 0;
23404c2facaSAndrew Lunn 
2353be88125SRoger Quadros 	if (phy->pwr) {
2363be88125SRoger Quadros 		ret = regulator_enable(phy->pwr);
2373be88125SRoger Quadros 		if (ret)
2383be88125SRoger Quadros 			return ret;
2393be88125SRoger Quadros 	}
2403be88125SRoger Quadros 
241ff764963SKishon Vijay Abraham I 	ret = phy_pm_runtime_get_sync(phy);
242ff764963SKishon Vijay Abraham I 	if (ret < 0 && ret != -ENOTSUPP)
243ff764963SKishon Vijay Abraham I 		return ret;
244ff764963SKishon Vijay Abraham I 
245ff764963SKishon Vijay Abraham I 	mutex_lock(&phy->mutex);
246637d378cSKishon Vijay Abraham I 	if (phy->power_count == 0 && phy->ops->power_on) {
247ff764963SKishon Vijay Abraham I 		ret = phy->ops->power_on(phy);
248ff764963SKishon Vijay Abraham I 		if (ret < 0) {
249ff764963SKishon Vijay Abraham I 			dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
250ff764963SKishon Vijay Abraham I 			goto out;
251ff764963SKishon Vijay Abraham I 		}
252767a1b5dSHans de Goede 	} else {
253767a1b5dSHans de Goede 		ret = 0; /* Override possible ret == -ENOTSUPP */
254ff764963SKishon Vijay Abraham I 	}
255637d378cSKishon Vijay Abraham I 	++phy->power_count;
256637d378cSKishon Vijay Abraham I 	mutex_unlock(&phy->mutex);
257637d378cSKishon Vijay Abraham I 	return 0;
258ff764963SKishon Vijay Abraham I 
259ff764963SKishon Vijay Abraham I out:
260ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy->mutex);
261637d378cSKishon Vijay Abraham I 	phy_pm_runtime_put_sync(phy);
2623be88125SRoger Quadros 	if (phy->pwr)
2633be88125SRoger Quadros 		regulator_disable(phy->pwr);
264ff764963SKishon Vijay Abraham I 
265ff764963SKishon Vijay Abraham I 	return ret;
266ff764963SKishon Vijay Abraham I }
267ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_power_on);
268ff764963SKishon Vijay Abraham I 
269ff764963SKishon Vijay Abraham I int phy_power_off(struct phy *phy)
270ff764963SKishon Vijay Abraham I {
271d18c9604SKishon Vijay Abraham I 	int ret;
272ff764963SKishon Vijay Abraham I 
27304c2facaSAndrew Lunn 	if (!phy)
27404c2facaSAndrew Lunn 		return 0;
27504c2facaSAndrew Lunn 
276ff764963SKishon Vijay Abraham I 	mutex_lock(&phy->mutex);
277637d378cSKishon Vijay Abraham I 	if (phy->power_count == 1 && phy->ops->power_off) {
278ff764963SKishon Vijay Abraham I 		ret =  phy->ops->power_off(phy);
279ff764963SKishon Vijay Abraham I 		if (ret < 0) {
280ff764963SKishon Vijay Abraham I 			dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
281637d378cSKishon Vijay Abraham I 			mutex_unlock(&phy->mutex);
282637d378cSKishon Vijay Abraham I 			return ret;
283ff764963SKishon Vijay Abraham I 		}
284ff764963SKishon Vijay Abraham I 	}
285637d378cSKishon Vijay Abraham I 	--phy->power_count;
286ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy->mutex);
287ff764963SKishon Vijay Abraham I 	phy_pm_runtime_put(phy);
288ff764963SKishon Vijay Abraham I 
2893be88125SRoger Quadros 	if (phy->pwr)
2903be88125SRoger Quadros 		regulator_disable(phy->pwr);
2913be88125SRoger Quadros 
292637d378cSKishon Vijay Abraham I 	return 0;
293ff764963SKishon Vijay Abraham I }
294ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_power_off);
295ff764963SKishon Vijay Abraham I 
296ff764963SKishon Vijay Abraham I /**
2970b3f3b2cSKamil Debski  * _of_phy_get() - lookup and obtain a reference to a phy by phandle
2980b3f3b2cSKamil Debski  * @np: device_node for which to get the phy
299ff764963SKishon Vijay Abraham I  * @index: the index of the phy
300ff764963SKishon Vijay Abraham I  *
301ff764963SKishon Vijay Abraham I  * Returns the phy associated with the given phandle value,
302ff764963SKishon Vijay Abraham I  * after getting a refcount to it or -ENODEV if there is no such phy or
303ff764963SKishon Vijay Abraham I  * -EPROBE_DEFER if there is a phandle to the phy, but the device is
304ff764963SKishon Vijay Abraham I  * not yet loaded. This function uses of_xlate call back function provided
305ff764963SKishon Vijay Abraham I  * while registering the phy_provider to find the phy instance.
306ff764963SKishon Vijay Abraham I  */
3070b3f3b2cSKamil Debski static struct phy *_of_phy_get(struct device_node *np, int index)
308ff764963SKishon Vijay Abraham I {
309ff764963SKishon Vijay Abraham I 	int ret;
310ff764963SKishon Vijay Abraham I 	struct phy_provider *phy_provider;
311ff764963SKishon Vijay Abraham I 	struct phy *phy = NULL;
312ff764963SKishon Vijay Abraham I 	struct of_phandle_args args;
313ff764963SKishon Vijay Abraham I 
3140b3f3b2cSKamil Debski 	ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
315ff764963SKishon Vijay Abraham I 		index, &args);
3160b3f3b2cSKamil Debski 	if (ret)
317ff764963SKishon Vijay Abraham I 		return ERR_PTR(-ENODEV);
318ff764963SKishon Vijay Abraham I 
319ff764963SKishon Vijay Abraham I 	mutex_lock(&phy_provider_mutex);
320ff764963SKishon Vijay Abraham I 	phy_provider = of_phy_provider_lookup(args.np);
321ff764963SKishon Vijay Abraham I 	if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
322ff764963SKishon Vijay Abraham I 		phy = ERR_PTR(-EPROBE_DEFER);
323ff764963SKishon Vijay Abraham I 		goto err0;
324ff764963SKishon Vijay Abraham I 	}
325ff764963SKishon Vijay Abraham I 
326ff764963SKishon Vijay Abraham I 	phy = phy_provider->of_xlate(phy_provider->dev, &args);
327ff764963SKishon Vijay Abraham I 	module_put(phy_provider->owner);
328ff764963SKishon Vijay Abraham I 
329ff764963SKishon Vijay Abraham I err0:
330ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy_provider_mutex);
331ff764963SKishon Vijay Abraham I 	of_node_put(args.np);
332ff764963SKishon Vijay Abraham I 
333ff764963SKishon Vijay Abraham I 	return phy;
334ff764963SKishon Vijay Abraham I }
335ff764963SKishon Vijay Abraham I 
336ff764963SKishon Vijay Abraham I /**
3370b3f3b2cSKamil Debski  * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
3380b3f3b2cSKamil Debski  * @np: device_node for which to get the phy
3390b3f3b2cSKamil Debski  * @con_id: name of the phy from device's point of view
3400b3f3b2cSKamil Debski  *
3410b3f3b2cSKamil Debski  * Returns the phy driver, after getting a refcount to it; or
3420b3f3b2cSKamil Debski  * -ENODEV if there is no such phy. The caller is responsible for
3430b3f3b2cSKamil Debski  * calling phy_put() to release that count.
3440b3f3b2cSKamil Debski  */
3450b3f3b2cSKamil Debski struct phy *of_phy_get(struct device_node *np, const char *con_id)
3460b3f3b2cSKamil Debski {
3470b3f3b2cSKamil Debski 	struct phy *phy = NULL;
3480b3f3b2cSKamil Debski 	int index = 0;
3490b3f3b2cSKamil Debski 
3500b3f3b2cSKamil Debski 	if (con_id)
3510b3f3b2cSKamil Debski 		index = of_property_match_string(np, "phy-names", con_id);
3520b3f3b2cSKamil Debski 
3530b3f3b2cSKamil Debski 	phy = _of_phy_get(np, index);
3540b3f3b2cSKamil Debski 	if (IS_ERR(phy))
3550b3f3b2cSKamil Debski 		return phy;
3560b3f3b2cSKamil Debski 
3570b3f3b2cSKamil Debski 	if (!try_module_get(phy->ops->owner))
3580b3f3b2cSKamil Debski 		return ERR_PTR(-EPROBE_DEFER);
3590b3f3b2cSKamil Debski 
3600b3f3b2cSKamil Debski 	get_device(&phy->dev);
3610b3f3b2cSKamil Debski 
3620b3f3b2cSKamil Debski 	return phy;
3630b3f3b2cSKamil Debski }
3640b3f3b2cSKamil Debski EXPORT_SYMBOL_GPL(of_phy_get);
3650b3f3b2cSKamil Debski 
3660b3f3b2cSKamil Debski /**
367ff764963SKishon Vijay Abraham I  * phy_put() - release the PHY
368ff764963SKishon Vijay Abraham I  * @phy: the phy returned by phy_get()
369ff764963SKishon Vijay Abraham I  *
370ff764963SKishon Vijay Abraham I  * Releases a refcount the caller received from phy_get().
371ff764963SKishon Vijay Abraham I  */
372ff764963SKishon Vijay Abraham I void phy_put(struct phy *phy)
373ff764963SKishon Vijay Abraham I {
37404c2facaSAndrew Lunn 	if (!phy || IS_ERR(phy))
375ff764963SKishon Vijay Abraham I 		return;
376ff764963SKishon Vijay Abraham I 
377ff764963SKishon Vijay Abraham I 	module_put(phy->ops->owner);
378ff764963SKishon Vijay Abraham I 	put_device(&phy->dev);
379ff764963SKishon Vijay Abraham I }
380ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_put);
381ff764963SKishon Vijay Abraham I 
382ff764963SKishon Vijay Abraham I /**
383ff764963SKishon Vijay Abraham I  * devm_phy_put() - release the PHY
384ff764963SKishon Vijay Abraham I  * @dev: device that wants to release this phy
385ff764963SKishon Vijay Abraham I  * @phy: the phy returned by devm_phy_get()
386ff764963SKishon Vijay Abraham I  *
387ff764963SKishon Vijay Abraham I  * destroys the devres associated with this phy and invokes phy_put
388ff764963SKishon Vijay Abraham I  * to release the phy.
389ff764963SKishon Vijay Abraham I  */
390ff764963SKishon Vijay Abraham I void devm_phy_put(struct device *dev, struct phy *phy)
391ff764963SKishon Vijay Abraham I {
392ff764963SKishon Vijay Abraham I 	int r;
393ff764963SKishon Vijay Abraham I 
39404c2facaSAndrew Lunn 	if (!phy)
39504c2facaSAndrew Lunn 		return;
39604c2facaSAndrew Lunn 
397ff764963SKishon Vijay Abraham I 	r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
398ff764963SKishon Vijay Abraham I 	dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
399ff764963SKishon Vijay Abraham I }
400ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_phy_put);
401ff764963SKishon Vijay Abraham I 
402ff764963SKishon Vijay Abraham I /**
403ff764963SKishon Vijay Abraham I  * of_phy_simple_xlate() - returns the phy instance from phy provider
404ff764963SKishon Vijay Abraham I  * @dev: the PHY provider device
405ff764963SKishon Vijay Abraham I  * @args: of_phandle_args (not used here)
406ff764963SKishon Vijay Abraham I  *
407ff764963SKishon Vijay Abraham I  * Intended to be used by phy provider for the common case where #phy-cells is
408ff764963SKishon Vijay Abraham I  * 0. For other cases where #phy-cells is greater than '0', the phy provider
409ff764963SKishon Vijay Abraham I  * should provide a custom of_xlate function that reads the *args* and returns
410ff764963SKishon Vijay Abraham I  * the appropriate phy.
411ff764963SKishon Vijay Abraham I  */
412ff764963SKishon Vijay Abraham I struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
413ff764963SKishon Vijay Abraham I 	*args)
414ff764963SKishon Vijay Abraham I {
415ff764963SKishon Vijay Abraham I 	struct phy *phy;
416ff764963SKishon Vijay Abraham I 	struct class_dev_iter iter;
417ff764963SKishon Vijay Abraham I 
418ff764963SKishon Vijay Abraham I 	class_dev_iter_init(&iter, phy_class, NULL, NULL);
419ff764963SKishon Vijay Abraham I 	while ((dev = class_dev_iter_next(&iter))) {
420ff764963SKishon Vijay Abraham I 		phy = to_phy(dev);
421*491e0490SKishon Vijay Abraham I 		if (args->np != phy->dev.of_node)
422ff764963SKishon Vijay Abraham I 			continue;
423ff764963SKishon Vijay Abraham I 
424ff764963SKishon Vijay Abraham I 		class_dev_iter_exit(&iter);
425ff764963SKishon Vijay Abraham I 		return phy;
426ff764963SKishon Vijay Abraham I 	}
427ff764963SKishon Vijay Abraham I 
428ff764963SKishon Vijay Abraham I 	class_dev_iter_exit(&iter);
429ff764963SKishon Vijay Abraham I 	return ERR_PTR(-ENODEV);
430ff764963SKishon Vijay Abraham I }
431ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
432ff764963SKishon Vijay Abraham I 
433ff764963SKishon Vijay Abraham I /**
434ff764963SKishon Vijay Abraham I  * phy_get() - lookup and obtain a reference to a phy.
435ff764963SKishon Vijay Abraham I  * @dev: device that requests this phy
436ff764963SKishon Vijay Abraham I  * @string: the phy name as given in the dt data or the name of the controller
437ff764963SKishon Vijay Abraham I  * port for non-dt case
438ff764963SKishon Vijay Abraham I  *
439ff764963SKishon Vijay Abraham I  * Returns the phy driver, after getting a refcount to it; or
440ff764963SKishon Vijay Abraham I  * -ENODEV if there is no such phy.  The caller is responsible for
441ff764963SKishon Vijay Abraham I  * calling phy_put() to release that count.
442ff764963SKishon Vijay Abraham I  */
443ff764963SKishon Vijay Abraham I struct phy *phy_get(struct device *dev, const char *string)
444ff764963SKishon Vijay Abraham I {
445ff764963SKishon Vijay Abraham I 	int index = 0;
446d18c9604SKishon Vijay Abraham I 	struct phy *phy;
447ff764963SKishon Vijay Abraham I 
448ff764963SKishon Vijay Abraham I 	if (string == NULL) {
449ff764963SKishon Vijay Abraham I 		dev_WARN(dev, "missing string\n");
450ff764963SKishon Vijay Abraham I 		return ERR_PTR(-EINVAL);
451ff764963SKishon Vijay Abraham I 	}
452ff764963SKishon Vijay Abraham I 
453ff764963SKishon Vijay Abraham I 	if (dev->of_node) {
454ff764963SKishon Vijay Abraham I 		index = of_property_match_string(dev->of_node, "phy-names",
455ff764963SKishon Vijay Abraham I 			string);
4560b3f3b2cSKamil Debski 		phy = _of_phy_get(dev->of_node, index);
457ff764963SKishon Vijay Abraham I 	} else {
458ff764963SKishon Vijay Abraham I 		phy = phy_lookup(dev, string);
459f40037fdSHans de Goede 	}
460f40037fdSHans de Goede 	if (IS_ERR(phy))
461ff764963SKishon Vijay Abraham I 		return phy;
462ff764963SKishon Vijay Abraham I 
463ff764963SKishon Vijay Abraham I 	if (!try_module_get(phy->ops->owner))
464ff764963SKishon Vijay Abraham I 		return ERR_PTR(-EPROBE_DEFER);
465ff764963SKishon Vijay Abraham I 
466ff764963SKishon Vijay Abraham I 	get_device(&phy->dev);
467ff764963SKishon Vijay Abraham I 
468ff764963SKishon Vijay Abraham I 	return phy;
469ff764963SKishon Vijay Abraham I }
470ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_get);
471ff764963SKishon Vijay Abraham I 
472ff764963SKishon Vijay Abraham I /**
473788a4d56SAndrew Lunn  * phy_optional_get() - lookup and obtain a reference to an optional phy.
474788a4d56SAndrew Lunn  * @dev: device that requests this phy
475788a4d56SAndrew Lunn  * @string: the phy name as given in the dt data or the name of the controller
476788a4d56SAndrew Lunn  * port for non-dt case
477788a4d56SAndrew Lunn  *
478788a4d56SAndrew Lunn  * Returns the phy driver, after getting a refcount to it; or
479788a4d56SAndrew Lunn  * NULL if there is no such phy.  The caller is responsible for
480788a4d56SAndrew Lunn  * calling phy_put() to release that count.
481788a4d56SAndrew Lunn  */
482788a4d56SAndrew Lunn struct phy *phy_optional_get(struct device *dev, const char *string)
483788a4d56SAndrew Lunn {
484788a4d56SAndrew Lunn 	struct phy *phy = phy_get(dev, string);
485788a4d56SAndrew Lunn 
486788a4d56SAndrew Lunn 	if (PTR_ERR(phy) == -ENODEV)
487788a4d56SAndrew Lunn 		phy = NULL;
488788a4d56SAndrew Lunn 
489788a4d56SAndrew Lunn 	return phy;
490788a4d56SAndrew Lunn }
491788a4d56SAndrew Lunn EXPORT_SYMBOL_GPL(phy_optional_get);
492788a4d56SAndrew Lunn 
493788a4d56SAndrew Lunn /**
494ff764963SKishon Vijay Abraham I  * devm_phy_get() - lookup and obtain a reference to a phy.
495ff764963SKishon Vijay Abraham I  * @dev: device that requests this phy
496ff764963SKishon Vijay Abraham I  * @string: the phy name as given in the dt data or phy device name
497ff764963SKishon Vijay Abraham I  * for non-dt case
498ff764963SKishon Vijay Abraham I  *
499ff764963SKishon Vijay Abraham I  * Gets the phy using phy_get(), and associates a device with it using
500ff764963SKishon Vijay Abraham I  * devres. On driver detach, release function is invoked on the devres data,
501ff764963SKishon Vijay Abraham I  * then, devres data is freed.
502ff764963SKishon Vijay Abraham I  */
503ff764963SKishon Vijay Abraham I struct phy *devm_phy_get(struct device *dev, const char *string)
504ff764963SKishon Vijay Abraham I {
505ff764963SKishon Vijay Abraham I 	struct phy **ptr, *phy;
506ff764963SKishon Vijay Abraham I 
507ff764963SKishon Vijay Abraham I 	ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
508ff764963SKishon Vijay Abraham I 	if (!ptr)
509ff764963SKishon Vijay Abraham I 		return ERR_PTR(-ENOMEM);
510ff764963SKishon Vijay Abraham I 
511ff764963SKishon Vijay Abraham I 	phy = phy_get(dev, string);
512ff764963SKishon Vijay Abraham I 	if (!IS_ERR(phy)) {
513ff764963SKishon Vijay Abraham I 		*ptr = phy;
514ff764963SKishon Vijay Abraham I 		devres_add(dev, ptr);
515ff764963SKishon Vijay Abraham I 	} else {
516ff764963SKishon Vijay Abraham I 		devres_free(ptr);
517ff764963SKishon Vijay Abraham I 	}
518ff764963SKishon Vijay Abraham I 
519ff764963SKishon Vijay Abraham I 	return phy;
520ff764963SKishon Vijay Abraham I }
521ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_phy_get);
522ff764963SKishon Vijay Abraham I 
523ff764963SKishon Vijay Abraham I /**
524788a4d56SAndrew Lunn  * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
525788a4d56SAndrew Lunn  * @dev: device that requests this phy
526788a4d56SAndrew Lunn  * @string: the phy name as given in the dt data or phy device name
527788a4d56SAndrew Lunn  * for non-dt case
528788a4d56SAndrew Lunn  *
529788a4d56SAndrew Lunn  * Gets the phy using phy_get(), and associates a device with it using
530788a4d56SAndrew Lunn  * devres. On driver detach, release function is invoked on the devres
531788a4d56SAndrew Lunn  * data, then, devres data is freed. This differs to devm_phy_get() in
532788a4d56SAndrew Lunn  * that if the phy does not exist, it is not considered an error and
533788a4d56SAndrew Lunn  * -ENODEV will not be returned. Instead the NULL phy is returned,
534788a4d56SAndrew Lunn  * which can be passed to all other phy consumer calls.
535788a4d56SAndrew Lunn  */
536788a4d56SAndrew Lunn struct phy *devm_phy_optional_get(struct device *dev, const char *string)
537788a4d56SAndrew Lunn {
538788a4d56SAndrew Lunn 	struct phy *phy = devm_phy_get(dev, string);
539788a4d56SAndrew Lunn 
540788a4d56SAndrew Lunn 	if (PTR_ERR(phy) == -ENODEV)
541788a4d56SAndrew Lunn 		phy = NULL;
542788a4d56SAndrew Lunn 
543788a4d56SAndrew Lunn 	return phy;
544788a4d56SAndrew Lunn }
545788a4d56SAndrew Lunn EXPORT_SYMBOL_GPL(devm_phy_optional_get);
546788a4d56SAndrew Lunn 
547788a4d56SAndrew Lunn /**
548b5d682f4SKamil Debski  * devm_of_phy_get() - lookup and obtain a reference to a phy.
549b5d682f4SKamil Debski  * @dev: device that requests this phy
550b5d682f4SKamil Debski  * @np: node containing the phy
551b5d682f4SKamil Debski  * @con_id: name of the phy from device's point of view
552b5d682f4SKamil Debski  *
553b5d682f4SKamil Debski  * Gets the phy using of_phy_get(), and associates a device with it using
554b5d682f4SKamil Debski  * devres. On driver detach, release function is invoked on the devres data,
555b5d682f4SKamil Debski  * then, devres data is freed.
556b5d682f4SKamil Debski  */
557b5d682f4SKamil Debski struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
558b5d682f4SKamil Debski 			    const char *con_id)
559b5d682f4SKamil Debski {
560b5d682f4SKamil Debski 	struct phy **ptr, *phy;
561b5d682f4SKamil Debski 
562b5d682f4SKamil Debski 	ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
563b5d682f4SKamil Debski 	if (!ptr)
564b5d682f4SKamil Debski 		return ERR_PTR(-ENOMEM);
565b5d682f4SKamil Debski 
566b5d682f4SKamil Debski 	phy = of_phy_get(np, con_id);
567b5d682f4SKamil Debski 	if (!IS_ERR(phy)) {
568b5d682f4SKamil Debski 		*ptr = phy;
569b5d682f4SKamil Debski 		devres_add(dev, ptr);
570b5d682f4SKamil Debski 	} else {
571b5d682f4SKamil Debski 		devres_free(ptr);
572b5d682f4SKamil Debski 	}
573b5d682f4SKamil Debski 
574b5d682f4SKamil Debski 	return phy;
575b5d682f4SKamil Debski }
576b5d682f4SKamil Debski EXPORT_SYMBOL_GPL(devm_of_phy_get);
577b5d682f4SKamil Debski 
578b5d682f4SKamil Debski /**
579ff764963SKishon Vijay Abraham I  * phy_create() - create a new phy
580ff764963SKishon Vijay Abraham I  * @dev: device that is creating the new phy
581f0ed8176SKishon Vijay Abraham I  * @node: device node of the phy
582ff764963SKishon Vijay Abraham I  * @ops: function pointers for performing phy operations
583ff764963SKishon Vijay Abraham I  * @init_data: contains the list of PHY consumers or NULL
584ff764963SKishon Vijay Abraham I  *
585ff764963SKishon Vijay Abraham I  * Called to create a phy using phy framework.
586ff764963SKishon Vijay Abraham I  */
587f0ed8176SKishon Vijay Abraham I struct phy *phy_create(struct device *dev, struct device_node *node,
588f0ed8176SKishon Vijay Abraham I 		       const struct phy_ops *ops,
589ff764963SKishon Vijay Abraham I 		       struct phy_init_data *init_data)
590ff764963SKishon Vijay Abraham I {
591ff764963SKishon Vijay Abraham I 	int ret;
592ff764963SKishon Vijay Abraham I 	int id;
593ff764963SKishon Vijay Abraham I 	struct phy *phy;
594ff764963SKishon Vijay Abraham I 
59552797d29SDan Carpenter 	if (WARN_ON(!dev))
59652797d29SDan Carpenter 		return ERR_PTR(-EINVAL);
597ff764963SKishon Vijay Abraham I 
598ff764963SKishon Vijay Abraham I 	phy = kzalloc(sizeof(*phy), GFP_KERNEL);
59952797d29SDan Carpenter 	if (!phy)
60052797d29SDan Carpenter 		return ERR_PTR(-ENOMEM);
601ff764963SKishon Vijay Abraham I 
602ff764963SKishon Vijay Abraham I 	id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
603ff764963SKishon Vijay Abraham I 	if (id < 0) {
604ff764963SKishon Vijay Abraham I 		dev_err(dev, "unable to get id\n");
605ff764963SKishon Vijay Abraham I 		ret = id;
60652797d29SDan Carpenter 		goto free_phy;
607ff764963SKishon Vijay Abraham I 	}
608ff764963SKishon Vijay Abraham I 
6093be88125SRoger Quadros 	/* phy-supply */
6103be88125SRoger Quadros 	phy->pwr = regulator_get_optional(dev, "phy");
6113be88125SRoger Quadros 	if (IS_ERR(phy->pwr)) {
6123be88125SRoger Quadros 		if (PTR_ERR(phy->pwr) == -EPROBE_DEFER) {
6133be88125SRoger Quadros 			ret = -EPROBE_DEFER;
6143be88125SRoger Quadros 			goto free_ida;
6153be88125SRoger Quadros 		}
6163be88125SRoger Quadros 		phy->pwr = NULL;
6173be88125SRoger Quadros 	}
6183be88125SRoger Quadros 
619ff764963SKishon Vijay Abraham I 	device_initialize(&phy->dev);
620ff764963SKishon Vijay Abraham I 	mutex_init(&phy->mutex);
621ff764963SKishon Vijay Abraham I 
622ff764963SKishon Vijay Abraham I 	phy->dev.class = phy_class;
623ff764963SKishon Vijay Abraham I 	phy->dev.parent = dev;
624f0ed8176SKishon Vijay Abraham I 	phy->dev.of_node = node ?: dev->of_node;
625ff764963SKishon Vijay Abraham I 	phy->id = id;
626ff764963SKishon Vijay Abraham I 	phy->ops = ops;
627ff764963SKishon Vijay Abraham I 	phy->init_data = init_data;
628ff764963SKishon Vijay Abraham I 
629ff764963SKishon Vijay Abraham I 	ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
630ff764963SKishon Vijay Abraham I 	if (ret)
63152797d29SDan Carpenter 		goto put_dev;
632ff764963SKishon Vijay Abraham I 
633ff764963SKishon Vijay Abraham I 	ret = device_add(&phy->dev);
634ff764963SKishon Vijay Abraham I 	if (ret)
63552797d29SDan Carpenter 		goto put_dev;
636ff764963SKishon Vijay Abraham I 
637ff764963SKishon Vijay Abraham I 	if (pm_runtime_enabled(dev)) {
638ff764963SKishon Vijay Abraham I 		pm_runtime_enable(&phy->dev);
639ff764963SKishon Vijay Abraham I 		pm_runtime_no_callbacks(&phy->dev);
640ff764963SKishon Vijay Abraham I 	}
641ff764963SKishon Vijay Abraham I 
642ff764963SKishon Vijay Abraham I 	return phy;
643ff764963SKishon Vijay Abraham I 
64452797d29SDan Carpenter put_dev:
645e73b49f1SRoger Quadros 	put_device(&phy->dev);  /* calls phy_release() which frees resources */
646e73b49f1SRoger Quadros 	return ERR_PTR(ret);
647e73b49f1SRoger Quadros 
6483be88125SRoger Quadros free_ida:
6493be88125SRoger Quadros 	ida_simple_remove(&phy_ida, phy->id);
6503be88125SRoger Quadros 
65152797d29SDan Carpenter free_phy:
652ff764963SKishon Vijay Abraham I 	kfree(phy);
653ff764963SKishon Vijay Abraham I 	return ERR_PTR(ret);
654ff764963SKishon Vijay Abraham I }
655ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_create);
656ff764963SKishon Vijay Abraham I 
657ff764963SKishon Vijay Abraham I /**
658ff764963SKishon Vijay Abraham I  * devm_phy_create() - create a new phy
659ff764963SKishon Vijay Abraham I  * @dev: device that is creating the new phy
660f0ed8176SKishon Vijay Abraham I  * @node: device node of the phy
661ff764963SKishon Vijay Abraham I  * @ops: function pointers for performing phy operations
662ff764963SKishon Vijay Abraham I  * @init_data: contains the list of PHY consumers or NULL
663ff764963SKishon Vijay Abraham I  *
664ff764963SKishon Vijay Abraham I  * Creates a new PHY device adding it to the PHY class.
665ff764963SKishon Vijay Abraham I  * While at that, it also associates the device with the phy using devres.
666ff764963SKishon Vijay Abraham I  * On driver detach, release function is invoked on the devres data,
667ff764963SKishon Vijay Abraham I  * then, devres data is freed.
668ff764963SKishon Vijay Abraham I  */
669f0ed8176SKishon Vijay Abraham I struct phy *devm_phy_create(struct device *dev, struct device_node *node,
670f0ed8176SKishon Vijay Abraham I 			    const struct phy_ops *ops,
671ff764963SKishon Vijay Abraham I 			    struct phy_init_data *init_data)
672ff764963SKishon Vijay Abraham I {
673ff764963SKishon Vijay Abraham I 	struct phy **ptr, *phy;
674ff764963SKishon Vijay Abraham I 
675ff764963SKishon Vijay Abraham I 	ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
676ff764963SKishon Vijay Abraham I 	if (!ptr)
677ff764963SKishon Vijay Abraham I 		return ERR_PTR(-ENOMEM);
678ff764963SKishon Vijay Abraham I 
679f0ed8176SKishon Vijay Abraham I 	phy = phy_create(dev, node, ops, init_data);
680ff764963SKishon Vijay Abraham I 	if (!IS_ERR(phy)) {
681ff764963SKishon Vijay Abraham I 		*ptr = phy;
682ff764963SKishon Vijay Abraham I 		devres_add(dev, ptr);
683ff764963SKishon Vijay Abraham I 	} else {
684ff764963SKishon Vijay Abraham I 		devres_free(ptr);
685ff764963SKishon Vijay Abraham I 	}
686ff764963SKishon Vijay Abraham I 
687ff764963SKishon Vijay Abraham I 	return phy;
688ff764963SKishon Vijay Abraham I }
689ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_phy_create);
690ff764963SKishon Vijay Abraham I 
691ff764963SKishon Vijay Abraham I /**
692ff764963SKishon Vijay Abraham I  * phy_destroy() - destroy the phy
693ff764963SKishon Vijay Abraham I  * @phy: the phy to be destroyed
694ff764963SKishon Vijay Abraham I  *
695ff764963SKishon Vijay Abraham I  * Called to destroy the phy.
696ff764963SKishon Vijay Abraham I  */
697ff764963SKishon Vijay Abraham I void phy_destroy(struct phy *phy)
698ff764963SKishon Vijay Abraham I {
699ff764963SKishon Vijay Abraham I 	pm_runtime_disable(&phy->dev);
700ff764963SKishon Vijay Abraham I 	device_unregister(&phy->dev);
701ff764963SKishon Vijay Abraham I }
702ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(phy_destroy);
703ff764963SKishon Vijay Abraham I 
704ff764963SKishon Vijay Abraham I /**
705ff764963SKishon Vijay Abraham I  * devm_phy_destroy() - destroy the PHY
706ff764963SKishon Vijay Abraham I  * @dev: device that wants to release this phy
707ff764963SKishon Vijay Abraham I  * @phy: the phy returned by devm_phy_get()
708ff764963SKishon Vijay Abraham I  *
709ff764963SKishon Vijay Abraham I  * destroys the devres associated with this phy and invokes phy_destroy
710ff764963SKishon Vijay Abraham I  * to destroy the phy.
711ff764963SKishon Vijay Abraham I  */
712ff764963SKishon Vijay Abraham I void devm_phy_destroy(struct device *dev, struct phy *phy)
713ff764963SKishon Vijay Abraham I {
714ff764963SKishon Vijay Abraham I 	int r;
715ff764963SKishon Vijay Abraham I 
716ff764963SKishon Vijay Abraham I 	r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
717ff764963SKishon Vijay Abraham I 	dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
718ff764963SKishon Vijay Abraham I }
719ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_phy_destroy);
720ff764963SKishon Vijay Abraham I 
721ff764963SKishon Vijay Abraham I /**
722ff764963SKishon Vijay Abraham I  * __of_phy_provider_register() - create/register phy provider with the framework
723ff764963SKishon Vijay Abraham I  * @dev: struct device of the phy provider
724ff764963SKishon Vijay Abraham I  * @owner: the module owner containing of_xlate
725ff764963SKishon Vijay Abraham I  * @of_xlate: function pointer to obtain phy instance from phy provider
726ff764963SKishon Vijay Abraham I  *
727ff764963SKishon Vijay Abraham I  * Creates struct phy_provider from dev and of_xlate function pointer.
728ff764963SKishon Vijay Abraham I  * This is used in the case of dt boot for finding the phy instance from
729ff764963SKishon Vijay Abraham I  * phy provider.
730ff764963SKishon Vijay Abraham I  */
731ff764963SKishon Vijay Abraham I struct phy_provider *__of_phy_provider_register(struct device *dev,
732ff764963SKishon Vijay Abraham I 	struct module *owner, struct phy * (*of_xlate)(struct device *dev,
733ff764963SKishon Vijay Abraham I 	struct of_phandle_args *args))
734ff764963SKishon Vijay Abraham I {
735ff764963SKishon Vijay Abraham I 	struct phy_provider *phy_provider;
736ff764963SKishon Vijay Abraham I 
737ff764963SKishon Vijay Abraham I 	phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
738ff764963SKishon Vijay Abraham I 	if (!phy_provider)
739ff764963SKishon Vijay Abraham I 		return ERR_PTR(-ENOMEM);
740ff764963SKishon Vijay Abraham I 
741ff764963SKishon Vijay Abraham I 	phy_provider->dev = dev;
742ff764963SKishon Vijay Abraham I 	phy_provider->owner = owner;
743ff764963SKishon Vijay Abraham I 	phy_provider->of_xlate = of_xlate;
744ff764963SKishon Vijay Abraham I 
745ff764963SKishon Vijay Abraham I 	mutex_lock(&phy_provider_mutex);
746ff764963SKishon Vijay Abraham I 	list_add_tail(&phy_provider->list, &phy_provider_list);
747ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy_provider_mutex);
748ff764963SKishon Vijay Abraham I 
749ff764963SKishon Vijay Abraham I 	return phy_provider;
750ff764963SKishon Vijay Abraham I }
751ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__of_phy_provider_register);
752ff764963SKishon Vijay Abraham I 
753ff764963SKishon Vijay Abraham I /**
754ff764963SKishon Vijay Abraham I  * __devm_of_phy_provider_register() - create/register phy provider with the
755ff764963SKishon Vijay Abraham I  * framework
756ff764963SKishon Vijay Abraham I  * @dev: struct device of the phy provider
757ff764963SKishon Vijay Abraham I  * @owner: the module owner containing of_xlate
758ff764963SKishon Vijay Abraham I  * @of_xlate: function pointer to obtain phy instance from phy provider
759ff764963SKishon Vijay Abraham I  *
760ff764963SKishon Vijay Abraham I  * Creates struct phy_provider from dev and of_xlate function pointer.
761ff764963SKishon Vijay Abraham I  * This is used in the case of dt boot for finding the phy instance from
762ff764963SKishon Vijay Abraham I  * phy provider. While at that, it also associates the device with the
763ff764963SKishon Vijay Abraham I  * phy provider using devres. On driver detach, release function is invoked
764ff764963SKishon Vijay Abraham I  * on the devres data, then, devres data is freed.
765ff764963SKishon Vijay Abraham I  */
766ff764963SKishon Vijay Abraham I struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
767ff764963SKishon Vijay Abraham I 	struct module *owner, struct phy * (*of_xlate)(struct device *dev,
768ff764963SKishon Vijay Abraham I 	struct of_phandle_args *args))
769ff764963SKishon Vijay Abraham I {
770ff764963SKishon Vijay Abraham I 	struct phy_provider **ptr, *phy_provider;
771ff764963SKishon Vijay Abraham I 
772ff764963SKishon Vijay Abraham I 	ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
773ff764963SKishon Vijay Abraham I 	if (!ptr)
774ff764963SKishon Vijay Abraham I 		return ERR_PTR(-ENOMEM);
775ff764963SKishon Vijay Abraham I 
776ff764963SKishon Vijay Abraham I 	phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
777ff764963SKishon Vijay Abraham I 	if (!IS_ERR(phy_provider)) {
778ff764963SKishon Vijay Abraham I 		*ptr = phy_provider;
779ff764963SKishon Vijay Abraham I 		devres_add(dev, ptr);
780ff764963SKishon Vijay Abraham I 	} else {
781ff764963SKishon Vijay Abraham I 		devres_free(ptr);
782ff764963SKishon Vijay Abraham I 	}
783ff764963SKishon Vijay Abraham I 
784ff764963SKishon Vijay Abraham I 	return phy_provider;
785ff764963SKishon Vijay Abraham I }
786ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
787ff764963SKishon Vijay Abraham I 
788ff764963SKishon Vijay Abraham I /**
789ff764963SKishon Vijay Abraham I  * of_phy_provider_unregister() - unregister phy provider from the framework
790ff764963SKishon Vijay Abraham I  * @phy_provider: phy provider returned by of_phy_provider_register()
791ff764963SKishon Vijay Abraham I  *
792ff764963SKishon Vijay Abraham I  * Removes the phy_provider created using of_phy_provider_register().
793ff764963SKishon Vijay Abraham I  */
794ff764963SKishon Vijay Abraham I void of_phy_provider_unregister(struct phy_provider *phy_provider)
795ff764963SKishon Vijay Abraham I {
796ff764963SKishon Vijay Abraham I 	if (IS_ERR(phy_provider))
797ff764963SKishon Vijay Abraham I 		return;
798ff764963SKishon Vijay Abraham I 
799ff764963SKishon Vijay Abraham I 	mutex_lock(&phy_provider_mutex);
800ff764963SKishon Vijay Abraham I 	list_del(&phy_provider->list);
801ff764963SKishon Vijay Abraham I 	kfree(phy_provider);
802ff764963SKishon Vijay Abraham I 	mutex_unlock(&phy_provider_mutex);
803ff764963SKishon Vijay Abraham I }
804ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
805ff764963SKishon Vijay Abraham I 
806ff764963SKishon Vijay Abraham I /**
807ff764963SKishon Vijay Abraham I  * devm_of_phy_provider_unregister() - remove phy provider from the framework
808ff764963SKishon Vijay Abraham I  * @dev: struct device of the phy provider
809ff764963SKishon Vijay Abraham I  *
810ff764963SKishon Vijay Abraham I  * destroys the devres associated with this phy provider and invokes
811ff764963SKishon Vijay Abraham I  * of_phy_provider_unregister to unregister the phy provider.
812ff764963SKishon Vijay Abraham I  */
813ff764963SKishon Vijay Abraham I void devm_of_phy_provider_unregister(struct device *dev,
814ff764963SKishon Vijay Abraham I 	struct phy_provider *phy_provider) {
815ff764963SKishon Vijay Abraham I 	int r;
816ff764963SKishon Vijay Abraham I 
817ff764963SKishon Vijay Abraham I 	r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
818ff764963SKishon Vijay Abraham I 		phy_provider);
819ff764963SKishon Vijay Abraham I 	dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
820ff764963SKishon Vijay Abraham I }
821ff764963SKishon Vijay Abraham I EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
822ff764963SKishon Vijay Abraham I 
823ff764963SKishon Vijay Abraham I /**
824ff764963SKishon Vijay Abraham I  * phy_release() - release the phy
825ff764963SKishon Vijay Abraham I  * @dev: the dev member within phy
826ff764963SKishon Vijay Abraham I  *
827ff764963SKishon Vijay Abraham I  * When the last reference to the device is removed, it is called
828ff764963SKishon Vijay Abraham I  * from the embedded kobject as release method.
829ff764963SKishon Vijay Abraham I  */
830ff764963SKishon Vijay Abraham I static void phy_release(struct device *dev)
831ff764963SKishon Vijay Abraham I {
832ff764963SKishon Vijay Abraham I 	struct phy *phy;
833ff764963SKishon Vijay Abraham I 
834ff764963SKishon Vijay Abraham I 	phy = to_phy(dev);
835ff764963SKishon Vijay Abraham I 	dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
8363be88125SRoger Quadros 	regulator_put(phy->pwr);
837e73b49f1SRoger Quadros 	ida_simple_remove(&phy_ida, phy->id);
838ff764963SKishon Vijay Abraham I 	kfree(phy);
839ff764963SKishon Vijay Abraham I }
840ff764963SKishon Vijay Abraham I 
841ff764963SKishon Vijay Abraham I static int __init phy_core_init(void)
842ff764963SKishon Vijay Abraham I {
843ff764963SKishon Vijay Abraham I 	phy_class = class_create(THIS_MODULE, "phy");
844ff764963SKishon Vijay Abraham I 	if (IS_ERR(phy_class)) {
845ff764963SKishon Vijay Abraham I 		pr_err("failed to create phy class --> %ld\n",
846ff764963SKishon Vijay Abraham I 			PTR_ERR(phy_class));
847ff764963SKishon Vijay Abraham I 		return PTR_ERR(phy_class);
848ff764963SKishon Vijay Abraham I 	}
849ff764963SKishon Vijay Abraham I 
850ff764963SKishon Vijay Abraham I 	phy_class->dev_release = phy_release;
851ff764963SKishon Vijay Abraham I 
852ff764963SKishon Vijay Abraham I 	return 0;
853ff764963SKishon Vijay Abraham I }
854ff764963SKishon Vijay Abraham I module_init(phy_core_init);
855ff764963SKishon Vijay Abraham I 
856ff764963SKishon Vijay Abraham I static void __exit phy_core_exit(void)
857ff764963SKishon Vijay Abraham I {
858ff764963SKishon Vijay Abraham I 	class_destroy(phy_class);
859ff764963SKishon Vijay Abraham I }
860ff764963SKishon Vijay Abraham I module_exit(phy_core_exit);
861ff764963SKishon Vijay Abraham I 
862ff764963SKishon Vijay Abraham I MODULE_DESCRIPTION("Generic PHY Framework");
863ff764963SKishon Vijay Abraham I MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
864ff764963SKishon Vijay Abraham I MODULE_LICENSE("GPL v2");
865