blob: fc48fac003a62ba124bd7c6820f24d5d040fcbf7 [file] [log] [blame]
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +05301/*
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>
Roger Quadros3be88122014-07-04 12:55:45 +030024#include <linux/regulator/consumer.h>
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053025
26static struct class *phy_class;
27static DEFINE_MUTEX(phy_provider_mutex);
28static LIST_HEAD(phy_provider_list);
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +020029static LIST_HEAD(phys);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053030static 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{
Thierry Reding2f1bce42015-02-25 16:16:29 +010055 struct phy **phy = res;
56
57 return *phy == match_data;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053058}
59
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +020060/**
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;
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +0200123
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
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200132 return pl ? pl->phy : ERR_PTR(-ENODEV);
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +0200133}
134
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530135static struct phy_provider *of_phy_provider_lookup(struct device_node *node)
136{
137 struct phy_provider *phy_provider;
Kishon Vijay Abraham I2a4c3702014-07-14 15:55:01 +0530138 struct device_node *child;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530139
140 list_for_each_entry(phy_provider, &phy_provider_list, list) {
141 if (phy_provider->dev->of_node == node)
142 return phy_provider;
Kishon Vijay Abraham I2a4c3702014-07-14 15:55:01 +0530143
144 for_each_child_of_node(phy_provider->dev->of_node, child)
145 if (child == node)
146 return phy_provider;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530147 }
148
149 return ERR_PTR(-EPROBE_DEFER);
150}
151
152int phy_pm_runtime_get(struct phy *phy)
153{
Felipe Balbicedb7f82013-12-20 15:00:48 -0600154 int ret;
155
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530156 if (!pm_runtime_enabled(&phy->dev))
157 return -ENOTSUPP;
158
Felipe Balbicedb7f82013-12-20 15:00:48 -0600159 ret = pm_runtime_get(&phy->dev);
160 if (ret < 0 && ret != -EINPROGRESS)
161 pm_runtime_put_noidle(&phy->dev);
162
163 return ret;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530164}
165EXPORT_SYMBOL_GPL(phy_pm_runtime_get);
166
167int phy_pm_runtime_get_sync(struct phy *phy)
168{
Felipe Balbicedb7f82013-12-20 15:00:48 -0600169 int ret;
170
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530171 if (!pm_runtime_enabled(&phy->dev))
172 return -ENOTSUPP;
173
Felipe Balbicedb7f82013-12-20 15:00:48 -0600174 ret = pm_runtime_get_sync(&phy->dev);
175 if (ret < 0)
176 pm_runtime_put_sync(&phy->dev);
177
178 return ret;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530179}
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
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100222 if (!phy)
223 return 0;
224
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530225 ret = phy_pm_runtime_get_sync(phy);
226 if (ret < 0 && ret != -ENOTSUPP)
227 return ret;
Axel Lin736b67a2015-03-06 15:55:10 +0800228 ret = 0; /* Override possible ret == -ENOTSUPP */
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530229
230 mutex_lock(&phy->mutex);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530231 if (phy->init_count == 0 && phy->ops->init) {
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530232 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 }
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530238 ++phy->init_count;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530239
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
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100251 if (!phy)
252 return 0;
253
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530254 ret = phy_pm_runtime_get_sync(phy);
255 if (ret < 0 && ret != -ENOTSUPP)
256 return ret;
Axel Lin736b67a2015-03-06 15:55:10 +0800257 ret = 0; /* Override possible ret == -ENOTSUPP */
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530258
259 mutex_lock(&phy->mutex);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530260 if (phy->init_count == 1 && phy->ops->exit) {
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530261 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 }
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530267 --phy->init_count;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530268
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{
Kishon Vijay Abraham Id18c9602013-12-19 20:01:44 +0530278 int ret;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530279
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100280 if (!phy)
281 return 0;
282
Roger Quadros3be88122014-07-04 12:55:45 +0300283 if (phy->pwr) {
284 ret = regulator_enable(phy->pwr);
285 if (ret)
286 return ret;
287 }
288
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530289 ret = phy_pm_runtime_get_sync(phy);
290 if (ret < 0 && ret != -ENOTSUPP)
291 return ret;
Axel Lin736b67a2015-03-06 15:55:10 +0800292 ret = 0; /* Override possible ret == -ENOTSUPP */
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530293
294 mutex_lock(&phy->mutex);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530295 if (phy->power_count == 0 && phy->ops->power_on) {
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530296 ret = phy->ops->power_on(phy);
297 if (ret < 0) {
298 dev_err(&phy->dev, "phy poweron failed --> %d\n", ret);
299 goto out;
300 }
301 }
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530302 ++phy->power_count;
303 mutex_unlock(&phy->mutex);
304 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530305
306out:
307 mutex_unlock(&phy->mutex);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530308 phy_pm_runtime_put_sync(phy);
Roger Quadros3be88122014-07-04 12:55:45 +0300309 if (phy->pwr)
310 regulator_disable(phy->pwr);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530311
312 return ret;
313}
314EXPORT_SYMBOL_GPL(phy_power_on);
315
316int phy_power_off(struct phy *phy)
317{
Kishon Vijay Abraham Id18c9602013-12-19 20:01:44 +0530318 int ret;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530319
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100320 if (!phy)
321 return 0;
322
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530323 mutex_lock(&phy->mutex);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530324 if (phy->power_count == 1 && phy->ops->power_off) {
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530325 ret = phy->ops->power_off(phy);
326 if (ret < 0) {
327 dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret);
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530328 mutex_unlock(&phy->mutex);
329 return ret;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530330 }
331 }
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530332 --phy->power_count;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530333 mutex_unlock(&phy->mutex);
334 phy_pm_runtime_put(phy);
335
Roger Quadros3be88122014-07-04 12:55:45 +0300336 if (phy->pwr)
337 regulator_disable(phy->pwr);
338
Kishon Vijay Abraham I637d3782013-12-20 10:36:49 +0530339 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530340}
341EXPORT_SYMBOL_GPL(phy_power_off);
342
343/**
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100344 * _of_phy_get() - lookup and obtain a reference to a phy by phandle
345 * @np: device_node for which to get the phy
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530346 * @index: the index of the phy
347 *
348 * Returns the phy associated with the given phandle value,
349 * after getting a refcount to it or -ENODEV if there is no such phy or
350 * -EPROBE_DEFER if there is a phandle to the phy, but the device is
351 * not yet loaded. This function uses of_xlate call back function provided
352 * while registering the phy_provider to find the phy instance.
353 */
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100354static struct phy *_of_phy_get(struct device_node *np, int index)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530355{
356 int ret;
357 struct phy_provider *phy_provider;
358 struct phy *phy = NULL;
359 struct of_phandle_args args;
360
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100361 ret = of_parse_phandle_with_args(np, "phys", "#phy-cells",
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530362 index, &args);
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100363 if (ret)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530364 return ERR_PTR(-ENODEV);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530365
366 mutex_lock(&phy_provider_mutex);
367 phy_provider = of_phy_provider_lookup(args.np);
368 if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) {
369 phy = ERR_PTR(-EPROBE_DEFER);
Axel Lin33f434d2015-04-07 12:23:38 +0800370 goto out_unlock;
371 }
372
373 if (!of_device_is_available(args.np)) {
374 dev_warn(phy_provider->dev, "Requested PHY is disabled\n");
375 phy = ERR_PTR(-ENODEV);
376 goto out_put_module;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530377 }
378
379 phy = phy_provider->of_xlate(phy_provider->dev, &args);
Axel Lin33f434d2015-04-07 12:23:38 +0800380
381out_put_module:
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530382 module_put(phy_provider->owner);
383
Axel Lin33f434d2015-04-07 12:23:38 +0800384out_unlock:
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530385 mutex_unlock(&phy_provider_mutex);
386 of_node_put(args.np);
387
388 return phy;
389}
390
391/**
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100392 * of_phy_get() - lookup and obtain a reference to a phy using a device_node.
393 * @np: device_node for which to get the phy
394 * @con_id: name of the phy from device's point of view
395 *
396 * Returns the phy driver, after getting a refcount to it; or
397 * -ENODEV if there is no such phy. The caller is responsible for
398 * calling phy_put() to release that count.
399 */
400struct phy *of_phy_get(struct device_node *np, const char *con_id)
401{
402 struct phy *phy = NULL;
403 int index = 0;
404
405 if (con_id)
406 index = of_property_match_string(np, "phy-names", con_id);
407
408 phy = _of_phy_get(np, index);
409 if (IS_ERR(phy))
410 return phy;
411
412 if (!try_module_get(phy->ops->owner))
413 return ERR_PTR(-EPROBE_DEFER);
414
415 get_device(&phy->dev);
416
417 return phy;
418}
419EXPORT_SYMBOL_GPL(of_phy_get);
420
421/**
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530422 * phy_put() - release the PHY
423 * @phy: the phy returned by phy_get()
424 *
425 * Releases a refcount the caller received from phy_get().
426 */
427void phy_put(struct phy *phy)
428{
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100429 if (!phy || IS_ERR(phy))
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530430 return;
431
432 module_put(phy->ops->owner);
433 put_device(&phy->dev);
434}
435EXPORT_SYMBOL_GPL(phy_put);
436
437/**
438 * devm_phy_put() - release the PHY
439 * @dev: device that wants to release this phy
440 * @phy: the phy returned by devm_phy_get()
441 *
442 * destroys the devres associated with this phy and invokes phy_put
443 * to release the phy.
444 */
445void devm_phy_put(struct device *dev, struct phy *phy)
446{
447 int r;
448
Andrew Lunn04c2fac2014-02-04 18:33:11 +0100449 if (!phy)
450 return;
451
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530452 r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy);
453 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
454}
455EXPORT_SYMBOL_GPL(devm_phy_put);
456
457/**
458 * of_phy_simple_xlate() - returns the phy instance from phy provider
459 * @dev: the PHY provider device
460 * @args: of_phandle_args (not used here)
461 *
462 * Intended to be used by phy provider for the common case where #phy-cells is
463 * 0. For other cases where #phy-cells is greater than '0', the phy provider
464 * should provide a custom of_xlate function that reads the *args* and returns
465 * the appropriate phy.
466 */
467struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args
468 *args)
469{
470 struct phy *phy;
471 struct class_dev_iter iter;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530472
473 class_dev_iter_init(&iter, phy_class, NULL, NULL);
474 while ((dev = class_dev_iter_next(&iter))) {
475 phy = to_phy(dev);
Kishon Vijay Abraham I491e0492014-10-31 14:04:20 +0530476 if (args->np != phy->dev.of_node)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530477 continue;
478
479 class_dev_iter_exit(&iter);
480 return phy;
481 }
482
483 class_dev_iter_exit(&iter);
484 return ERR_PTR(-ENODEV);
485}
486EXPORT_SYMBOL_GPL(of_phy_simple_xlate);
487
488/**
489 * phy_get() - lookup and obtain a reference to a phy.
490 * @dev: device that requests this phy
491 * @string: the phy name as given in the dt data or the name of the controller
492 * port for non-dt case
493 *
494 * Returns the phy driver, after getting a refcount to it; or
495 * -ENODEV if there is no such phy. The caller is responsible for
496 * calling phy_put() to release that count.
497 */
498struct phy *phy_get(struct device *dev, const char *string)
499{
500 int index = 0;
Kishon Vijay Abraham Id18c9602013-12-19 20:01:44 +0530501 struct phy *phy;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530502
503 if (string == NULL) {
504 dev_WARN(dev, "missing string\n");
505 return ERR_PTR(-EINVAL);
506 }
507
508 if (dev->of_node) {
509 index = of_property_match_string(dev->of_node, "phy-names",
510 string);
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100511 phy = _of_phy_get(dev->of_node, index);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530512 } else {
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +0200513 phy = phy_find(dev, string);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530514 }
Hans de Goedef40037f2014-02-17 14:29:22 +0530515 if (IS_ERR(phy))
516 return phy;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530517
518 if (!try_module_get(phy->ops->owner))
519 return ERR_PTR(-EPROBE_DEFER);
520
521 get_device(&phy->dev);
522
523 return phy;
524}
525EXPORT_SYMBOL_GPL(phy_get);
526
527/**
Andrew Lunn788a4d52014-02-04 18:33:12 +0100528 * phy_optional_get() - lookup and obtain a reference to an optional phy.
529 * @dev: device that requests this phy
530 * @string: the phy name as given in the dt data or the name of the controller
531 * port for non-dt case
532 *
533 * Returns the phy driver, after getting a refcount to it; or
534 * NULL if there is no such phy. The caller is responsible for
535 * calling phy_put() to release that count.
536 */
537struct phy *phy_optional_get(struct device *dev, const char *string)
538{
539 struct phy *phy = phy_get(dev, string);
540
Axel Linf83be4c2015-04-08 07:30:15 +0800541 if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
Andrew Lunn788a4d52014-02-04 18:33:12 +0100542 phy = NULL;
543
544 return phy;
545}
546EXPORT_SYMBOL_GPL(phy_optional_get);
547
548/**
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530549 * devm_phy_get() - lookup and obtain a reference to a phy.
550 * @dev: device that requests this phy
551 * @string: the phy name as given in the dt data or phy device name
552 * for non-dt case
553 *
554 * Gets the phy using phy_get(), and associates a device with it using
555 * devres. On driver detach, release function is invoked on the devres data,
556 * then, devres data is freed.
557 */
558struct phy *devm_phy_get(struct device *dev, const char *string)
559{
560 struct phy **ptr, *phy;
561
562 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
563 if (!ptr)
564 return ERR_PTR(-ENOMEM);
565
566 phy = phy_get(dev, string);
567 if (!IS_ERR(phy)) {
568 *ptr = phy;
569 devres_add(dev, ptr);
570 } else {
571 devres_free(ptr);
572 }
573
574 return phy;
575}
576EXPORT_SYMBOL_GPL(devm_phy_get);
577
578/**
Andrew Lunn788a4d52014-02-04 18:33:12 +0100579 * devm_phy_optional_get() - lookup and obtain a reference to an optional phy.
580 * @dev: device that requests this phy
581 * @string: the phy name as given in the dt data or phy device name
582 * for non-dt case
583 *
584 * Gets the phy using phy_get(), and associates a device with it using
585 * devres. On driver detach, release function is invoked on the devres
586 * data, then, devres data is freed. This differs to devm_phy_get() in
587 * that if the phy does not exist, it is not considered an error and
588 * -ENODEV will not be returned. Instead the NULL phy is returned,
589 * which can be passed to all other phy consumer calls.
590 */
591struct phy *devm_phy_optional_get(struct device *dev, const char *string)
592{
593 struct phy *phy = devm_phy_get(dev, string);
594
Axel Linf83be4c2015-04-08 07:30:15 +0800595 if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV))
Andrew Lunn788a4d52014-02-04 18:33:12 +0100596 phy = NULL;
597
598 return phy;
599}
600EXPORT_SYMBOL_GPL(devm_phy_optional_get);
601
602/**
Kamil Debskib5d682f2014-03-06 12:16:47 +0100603 * devm_of_phy_get() - lookup and obtain a reference to a phy.
604 * @dev: device that requests this phy
605 * @np: node containing the phy
606 * @con_id: name of the phy from device's point of view
607 *
608 * Gets the phy using of_phy_get(), and associates a device with it using
609 * devres. On driver detach, release function is invoked on the devres data,
610 * then, devres data is freed.
611 */
612struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
613 const char *con_id)
614{
615 struct phy **ptr, *phy;
616
617 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
618 if (!ptr)
619 return ERR_PTR(-ENOMEM);
620
621 phy = of_phy_get(np, con_id);
622 if (!IS_ERR(phy)) {
623 *ptr = phy;
624 devres_add(dev, ptr);
625 } else {
626 devres_free(ptr);
627 }
628
629 return phy;
630}
631EXPORT_SYMBOL_GPL(devm_of_phy_get);
632
633/**
Arun Ramamurthy6be109b2015-04-22 16:04:11 -0700634 * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index.
635 * @dev: device that requests this phy
636 * @np: node containing the phy
637 * @index: index of the phy
638 *
639 * Gets the phy using _of_phy_get(), and associates a device with it using
640 * devres. On driver detach, release function is invoked on the devres data,
641 * then, devres data is freed.
642 *
643 */
644struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
645 int index)
646{
647 struct phy **ptr, *phy;
648
649 ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL);
650 if (!ptr)
651 return ERR_PTR(-ENOMEM);
652
653 phy = _of_phy_get(np, index);
654 if (!IS_ERR(phy)) {
655 *ptr = phy;
656 devres_add(dev, ptr);
657 } else {
658 devres_free(ptr);
659 }
660
661 return phy;
662}
663EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index);
664
665/**
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530666 * phy_create() - create a new phy
667 * @dev: device that is creating the new phy
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530668 * @node: device node of the phy
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530669 * @ops: function pointers for performing phy operations
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530670 *
671 * Called to create a phy using phy framework.
672 */
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530673struct phy *phy_create(struct device *dev, struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200674 const struct phy_ops *ops)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530675{
676 int ret;
677 int id;
678 struct phy *phy;
679
Dan Carpenter52797d22013-12-06 17:51:19 +0530680 if (WARN_ON(!dev))
681 return ERR_PTR(-EINVAL);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530682
683 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
Dan Carpenter52797d22013-12-06 17:51:19 +0530684 if (!phy)
685 return ERR_PTR(-ENOMEM);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530686
687 id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL);
688 if (id < 0) {
689 dev_err(dev, "unable to get id\n");
690 ret = id;
Dan Carpenter52797d22013-12-06 17:51:19 +0530691 goto free_phy;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530692 }
693
694 device_initialize(&phy->dev);
695 mutex_init(&phy->mutex);
696
697 phy->dev.class = phy_class;
698 phy->dev.parent = dev;
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530699 phy->dev.of_node = node ?: dev->of_node;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530700 phy->id = id;
701 phy->ops = ops;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530702
703 ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id);
704 if (ret)
Dan Carpenter52797d22013-12-06 17:51:19 +0530705 goto put_dev;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530706
Dmitry Torokhov87006dd2015-04-22 16:14:37 -0700707 /* phy-supply */
708 phy->pwr = regulator_get_optional(&phy->dev, "phy");
709 if (IS_ERR(phy->pwr)) {
710 ret = PTR_ERR(phy->pwr);
711 if (ret == -EPROBE_DEFER)
712 goto put_dev;
713
714 phy->pwr = NULL;
715 }
716
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530717 ret = device_add(&phy->dev);
718 if (ret)
Dan Carpenter52797d22013-12-06 17:51:19 +0530719 goto put_dev;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530720
721 if (pm_runtime_enabled(dev)) {
722 pm_runtime_enable(&phy->dev);
723 pm_runtime_no_callbacks(&phy->dev);
724 }
725
726 return phy;
727
Dan Carpenter52797d22013-12-06 17:51:19 +0530728put_dev:
Roger Quadrose73b49f2014-07-10 11:55:02 +0530729 put_device(&phy->dev); /* calls phy_release() which frees resources */
730 return ERR_PTR(ret);
731
Dan Carpenter52797d22013-12-06 17:51:19 +0530732free_phy:
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530733 kfree(phy);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530734 return ERR_PTR(ret);
735}
736EXPORT_SYMBOL_GPL(phy_create);
737
738/**
739 * devm_phy_create() - create a new phy
740 * @dev: device that is creating the new phy
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530741 * @node: device node of the phy
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530742 * @ops: function pointers for performing phy operations
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530743 *
744 * Creates a new PHY device adding it to the PHY class.
745 * While at that, it also associates the device with the phy using devres.
746 * On driver detach, release function is invoked on the devres data,
747 * then, devres data is freed.
748 */
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530749struct phy *devm_phy_create(struct device *dev, struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200750 const struct phy_ops *ops)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530751{
752 struct phy **ptr, *phy;
753
754 ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL);
755 if (!ptr)
756 return ERR_PTR(-ENOMEM);
757
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200758 phy = phy_create(dev, node, ops);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530759 if (!IS_ERR(phy)) {
760 *ptr = phy;
761 devres_add(dev, ptr);
762 } else {
763 devres_free(ptr);
764 }
765
766 return phy;
767}
768EXPORT_SYMBOL_GPL(devm_phy_create);
769
770/**
771 * phy_destroy() - destroy the phy
772 * @phy: the phy to be destroyed
773 *
774 * Called to destroy the phy.
775 */
776void phy_destroy(struct phy *phy)
777{
778 pm_runtime_disable(&phy->dev);
779 device_unregister(&phy->dev);
780}
781EXPORT_SYMBOL_GPL(phy_destroy);
782
783/**
784 * devm_phy_destroy() - destroy the PHY
785 * @dev: device that wants to release this phy
786 * @phy: the phy returned by devm_phy_get()
787 *
788 * destroys the devres associated with this phy and invokes phy_destroy
789 * to destroy the phy.
790 */
791void devm_phy_destroy(struct device *dev, struct phy *phy)
792{
793 int r;
794
795 r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy);
796 dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n");
797}
798EXPORT_SYMBOL_GPL(devm_phy_destroy);
799
800/**
801 * __of_phy_provider_register() - create/register phy provider with the framework
802 * @dev: struct device of the phy provider
803 * @owner: the module owner containing of_xlate
804 * @of_xlate: function pointer to obtain phy instance from phy provider
805 *
806 * Creates struct phy_provider from dev and of_xlate function pointer.
807 * This is used in the case of dt boot for finding the phy instance from
808 * phy provider.
809 */
810struct phy_provider *__of_phy_provider_register(struct device *dev,
811 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
812 struct of_phandle_args *args))
813{
814 struct phy_provider *phy_provider;
815
816 phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL);
817 if (!phy_provider)
818 return ERR_PTR(-ENOMEM);
819
820 phy_provider->dev = dev;
821 phy_provider->owner = owner;
822 phy_provider->of_xlate = of_xlate;
823
824 mutex_lock(&phy_provider_mutex);
825 list_add_tail(&phy_provider->list, &phy_provider_list);
826 mutex_unlock(&phy_provider_mutex);
827
828 return phy_provider;
829}
830EXPORT_SYMBOL_GPL(__of_phy_provider_register);
831
832/**
833 * __devm_of_phy_provider_register() - create/register phy provider with the
834 * framework
835 * @dev: struct device of the phy provider
836 * @owner: the module owner containing of_xlate
837 * @of_xlate: function pointer to obtain phy instance from phy provider
838 *
839 * Creates struct phy_provider from dev and of_xlate function pointer.
840 * This is used in the case of dt boot for finding the phy instance from
841 * phy provider. While at that, it also associates the device with the
842 * phy provider using devres. On driver detach, release function is invoked
843 * on the devres data, then, devres data is freed.
844 */
845struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
846 struct module *owner, struct phy * (*of_xlate)(struct device *dev,
847 struct of_phandle_args *args))
848{
849 struct phy_provider **ptr, *phy_provider;
850
851 ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL);
852 if (!ptr)
853 return ERR_PTR(-ENOMEM);
854
855 phy_provider = __of_phy_provider_register(dev, owner, of_xlate);
856 if (!IS_ERR(phy_provider)) {
857 *ptr = phy_provider;
858 devres_add(dev, ptr);
859 } else {
860 devres_free(ptr);
861 }
862
863 return phy_provider;
864}
865EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register);
866
867/**
868 * of_phy_provider_unregister() - unregister phy provider from the framework
869 * @phy_provider: phy provider returned by of_phy_provider_register()
870 *
871 * Removes the phy_provider created using of_phy_provider_register().
872 */
873void of_phy_provider_unregister(struct phy_provider *phy_provider)
874{
875 if (IS_ERR(phy_provider))
876 return;
877
878 mutex_lock(&phy_provider_mutex);
879 list_del(&phy_provider->list);
880 kfree(phy_provider);
881 mutex_unlock(&phy_provider_mutex);
882}
883EXPORT_SYMBOL_GPL(of_phy_provider_unregister);
884
885/**
886 * devm_of_phy_provider_unregister() - remove phy provider from the framework
887 * @dev: struct device of the phy provider
888 *
889 * destroys the devres associated with this phy provider and invokes
890 * of_phy_provider_unregister to unregister the phy provider.
891 */
892void devm_of_phy_provider_unregister(struct device *dev,
893 struct phy_provider *phy_provider) {
894 int r;
895
896 r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match,
897 phy_provider);
898 dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n");
899}
900EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister);
901
902/**
903 * phy_release() - release the phy
904 * @dev: the dev member within phy
905 *
906 * When the last reference to the device is removed, it is called
907 * from the embedded kobject as release method.
908 */
909static void phy_release(struct device *dev)
910{
911 struct phy *phy;
912
913 phy = to_phy(dev);
914 dev_vdbg(dev, "releasing '%s'\n", dev_name(dev));
Roger Quadros3be88122014-07-04 12:55:45 +0300915 regulator_put(phy->pwr);
Roger Quadrose73b49f2014-07-10 11:55:02 +0530916 ida_simple_remove(&phy_ida, phy->id);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530917 kfree(phy);
918}
919
920static int __init phy_core_init(void)
921{
922 phy_class = class_create(THIS_MODULE, "phy");
923 if (IS_ERR(phy_class)) {
924 pr_err("failed to create phy class --> %ld\n",
925 PTR_ERR(phy_class));
926 return PTR_ERR(phy_class);
927 }
928
929 phy_class->dev_release = phy_release;
930
931 return 0;
932}
933module_init(phy_core_init);
934
935static void __exit phy_core_exit(void)
936{
937 class_destroy(phy_class);
938}
939module_exit(phy_core_exit);
940
941MODULE_DESCRIPTION("Generic PHY Framework");
942MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
943MODULE_LICENSE("GPL v2");