]>
Commit | Line | Data |
---|---|---|
ff764963 KVA |
1 | /* |
2 | * phy-core.c -- Generic Phy framework. | |
3 | * | |
4 | * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com | |
5 | * | |
6 | * Author: Kishon Vijay Abraham I <kishon@ti.com> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License as published by the | |
10 | * Free Software Foundation; either version 2 of the License, or (at your | |
11 | * option) any later version. | |
12 | */ | |
13 | ||
14 | #include <linux/kernel.h> | |
15 | #include <linux/export.h> | |
16 | #include <linux/module.h> | |
17 | #include <linux/err.h> | |
18 | #include <linux/device.h> | |
19 | #include <linux/slab.h> | |
20 | #include <linux/of.h> | |
21 | #include <linux/phy/phy.h> | |
22 | #include <linux/idr.h> | |
23 | #include <linux/pm_runtime.h> | |
3be88125 | 24 | #include <linux/regulator/consumer.h> |
ff764963 KVA |
25 | |
26 | static struct class *phy_class; | |
27 | static DEFINE_MUTEX(phy_provider_mutex); | |
28 | static LIST_HEAD(phy_provider_list); | |
b7bc15b9 | 29 | static LIST_HEAD(phys); |
ff764963 KVA |
30 | static DEFINE_IDA(phy_ida); |
31 | ||
32 | static void devm_phy_release(struct device *dev, void *res) | |
33 | { | |
34 | struct phy *phy = *(struct phy **)res; | |
35 | ||
36 | phy_put(phy); | |
37 | } | |
38 | ||
39 | static 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 | ||
46 | static void devm_phy_consume(struct device *dev, void *res) | |
47 | { | |
48 | struct phy *phy = *(struct phy **)res; | |
49 | ||
50 | phy_destroy(phy); | |
51 | } | |
52 | ||
53 | static int devm_phy_match(struct device *dev, void *res, void *match_data) | |
54 | { | |
2f1bce48 TR |
55 | struct phy **phy = res; |
56 | ||
57 | return *phy == match_data; | |
ff764963 KVA |
58 | } |
59 | ||
b7bc15b9 HK |
60 | /** |
61 | * phy_create_lookup() - allocate and register PHY/device association | |
62 | * @phy: the phy of the association | |
63 | * @con_id: connection ID string on device | |
64 | * @dev_id: the device of the association | |
65 | * | |
66 | * Creates and registers phy_lookup entry. | |
67 | */ | |
68 | int 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 | } | |
89 | EXPORT_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 | */ | |
100 | void 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 | } | |
117 | EXPORT_SYMBOL_GPL(phy_remove_lookup); | |
118 | ||
119 | static 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; | |
b7bc15b9 HK |
123 | |
124 | mutex_lock(&phy_provider_mutex); | |
125 | list_for_each_entry(p, &phys, node) | |
126 | if (!strcmp(p->dev_id, dev_id) && !strcmp(p->con_id, con_id)) { | |
127 | pl = p; | |
128 | break; | |
129 | } | |
130 | mutex_unlock(&phy_provider_mutex); | |
131 | ||
dbc98635 | 132 | return pl ? pl->phy : ERR_PTR(-ENODEV); |
b7bc15b9 HK |
133 | } |
134 | ||
ff764963 KVA |
135 | static struct phy_provider *of_phy_provider_lookup(struct device_node *node) |
136 | { | |
137 | struct phy_provider *phy_provider; | |
2a4c3701 | 138 | struct device_node *child; |
ff764963 KVA |
139 | |
140 | list_for_each_entry(phy_provider, &phy_provider_list, list) { | |
141 | if (phy_provider->dev->of_node == node) | |
142 | return phy_provider; | |
2a4c3701 | 143 | |
1140f7c8 | 144 | for_each_child_of_node(phy_provider->children, child) |
2a4c3701 KVA |
145 | if (child == node) |
146 | return phy_provider; | |
ff764963 KVA |
147 | } |
148 | ||
149 | return ERR_PTR(-EPROBE_DEFER); | |
150 | } | |
151 | ||
152 | int phy_pm_runtime_get(struct phy *phy) | |
153 | { | |
cedb7f89 FB |
154 | int ret; |
155 | ||
ff764963 KVA |
156 | if (!pm_runtime_enabled(&phy->dev)) |
157 | return -ENOTSUPP; | |
158 | ||
cedb7f89 FB |
159 | ret = pm_runtime_get(&phy->dev); |
160 | if (ret < 0 && ret != -EINPROGRESS) | |
161 | pm_runtime_put_noidle(&phy->dev); | |
162 | ||
163 | return ret; | |
ff764963 KVA |
164 | } |
165 | EXPORT_SYMBOL_GPL(phy_pm_runtime_get); | |
166 | ||
167 | int phy_pm_runtime_get_sync(struct phy *phy) | |
168 | { | |
cedb7f89 FB |
169 | int ret; |
170 | ||
ff764963 KVA |
171 | if (!pm_runtime_enabled(&phy->dev)) |
172 | return -ENOTSUPP; | |
173 | ||
cedb7f89 FB |
174 | ret = pm_runtime_get_sync(&phy->dev); |
175 | if (ret < 0) | |
176 | pm_runtime_put_sync(&phy->dev); | |
177 | ||
178 | return ret; | |
ff764963 KVA |
179 | } |
180 | EXPORT_SYMBOL_GPL(phy_pm_runtime_get_sync); | |
181 | ||
182 | int 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 | } | |
189 | EXPORT_SYMBOL_GPL(phy_pm_runtime_put); | |
190 | ||
191 | int 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 | } | |
198 | EXPORT_SYMBOL_GPL(phy_pm_runtime_put_sync); | |
199 | ||
200 | void 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 | } | |
207 | EXPORT_SYMBOL_GPL(phy_pm_runtime_allow); | |
208 | ||
209 | void 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 | } | |
216 | EXPORT_SYMBOL_GPL(phy_pm_runtime_forbid); | |
217 | ||
218 | int phy_init(struct phy *phy) | |
219 | { | |
220 | int ret; | |
221 | ||
04c2faca AL |
222 | if (!phy) |
223 | return 0; | |
224 | ||
ff764963 KVA |
225 | ret = phy_pm_runtime_get_sync(phy); |
226 | if (ret < 0 && ret != -ENOTSUPP) | |
227 | return ret; | |
736b67a3 | 228 | ret = 0; /* Override possible ret == -ENOTSUPP */ |
ff764963 KVA |
229 | |
230 | mutex_lock(&phy->mutex); | |
637d378c | 231 | if (phy->init_count == 0 && phy->ops->init) { |
ff764963 KVA |
232 | ret = phy->ops->init(phy); |
233 | if (ret < 0) { | |
234 | dev_err(&phy->dev, "phy init failed --> %d\n", ret); | |
235 | goto out; | |
236 | } | |
237 | } | |
637d378c | 238 | ++phy->init_count; |
ff764963 KVA |
239 | |
240 | out: | |
241 | mutex_unlock(&phy->mutex); | |
242 | phy_pm_runtime_put(phy); | |
243 | return ret; | |
244 | } | |
245 | EXPORT_SYMBOL_GPL(phy_init); | |
246 | ||
247 | int phy_exit(struct phy *phy) | |
248 | { | |
249 | int ret; | |
250 | ||
04c2faca AL |
251 | if (!phy) |
252 | return 0; | |
253 | ||
ff764963 KVA |
254 | ret = phy_pm_runtime_get_sync(phy); |
255 | if (ret < 0 && ret != -ENOTSUPP) | |
256 | return ret; | |
736b67a3 | 257 | ret = 0; /* Override possible ret == -ENOTSUPP */ |
ff764963 KVA |
258 | |
259 | mutex_lock(&phy->mutex); | |
637d378c | 260 | if (phy->init_count == 1 && phy->ops->exit) { |
ff764963 KVA |
261 | ret = phy->ops->exit(phy); |
262 | if (ret < 0) { | |
263 | dev_err(&phy->dev, "phy exit failed --> %d\n", ret); | |
264 | goto out; | |
265 | } | |
266 | } | |
637d378c | 267 | --phy->init_count; |
ff764963 KVA |
268 | |
269 | out: | |
270 | mutex_unlock(&phy->mutex); | |
271 | phy_pm_runtime_put(phy); | |
272 | return ret; | |
273 | } | |
274 | EXPORT_SYMBOL_GPL(phy_exit); | |
275 | ||
276 | int phy_power_on(struct phy *phy) | |
277 | { | |
b82fcabe | 278 | int ret = 0; |
ff764963 | 279 | |
04c2faca | 280 | if (!phy) |
b82fcabe | 281 | goto out; |
04c2faca | 282 | |
3be88125 RQ |
283 | if (phy->pwr) { |
284 | ret = regulator_enable(phy->pwr); | |
285 | if (ret) | |
b82fcabe | 286 | goto out; |
3be88125 RQ |
287 | } |
288 | ||
ff764963 KVA |
289 | ret = phy_pm_runtime_get_sync(phy); |
290 | if (ret < 0 && ret != -ENOTSUPP) | |
b82fcabe SL |
291 | goto err_pm_sync; |
292 | ||
736b67a3 | 293 | ret = 0; /* Override possible ret == -ENOTSUPP */ |
ff764963 KVA |
294 | |
295 | mutex_lock(&phy->mutex); | |
637d378c | 296 | if (phy->power_count == 0 && phy->ops->power_on) { |
ff764963 KVA |
297 | ret = phy->ops->power_on(phy); |
298 | if (ret < 0) { | |
299 | dev_err(&phy->dev, "phy poweron failed --> %d\n", ret); | |
b82fcabe | 300 | goto err_pwr_on; |
ff764963 KVA |
301 | } |
302 | } | |
637d378c KVA |
303 | ++phy->power_count; |
304 | mutex_unlock(&phy->mutex); | |
305 | return 0; | |
ff764963 | 306 | |
b82fcabe | 307 | err_pwr_on: |
ff764963 | 308 | mutex_unlock(&phy->mutex); |
637d378c | 309 | phy_pm_runtime_put_sync(phy); |
b82fcabe | 310 | err_pm_sync: |
3be88125 RQ |
311 | if (phy->pwr) |
312 | regulator_disable(phy->pwr); | |
b82fcabe | 313 | out: |
ff764963 KVA |
314 | return ret; |
315 | } | |
316 | EXPORT_SYMBOL_GPL(phy_power_on); | |
317 | ||
318 | int phy_power_off(struct phy *phy) | |
319 | { | |
d18c9604 | 320 | int ret; |
ff764963 | 321 | |
04c2faca AL |
322 | if (!phy) |
323 | return 0; | |
324 | ||
ff764963 | 325 | mutex_lock(&phy->mutex); |
637d378c | 326 | if (phy->power_count == 1 && phy->ops->power_off) { |
ff764963 KVA |
327 | ret = phy->ops->power_off(phy); |
328 | if (ret < 0) { | |
329 | dev_err(&phy->dev, "phy poweroff failed --> %d\n", ret); | |
637d378c KVA |
330 | mutex_unlock(&phy->mutex); |
331 | return ret; | |
ff764963 KVA |
332 | } |
333 | } | |
637d378c | 334 | --phy->power_count; |
ff764963 KVA |
335 | mutex_unlock(&phy->mutex); |
336 | phy_pm_runtime_put(phy); | |
337 | ||
3be88125 RQ |
338 | if (phy->pwr) |
339 | regulator_disable(phy->pwr); | |
340 | ||
637d378c | 341 | return 0; |
ff764963 KVA |
342 | } |
343 | EXPORT_SYMBOL_GPL(phy_power_off); | |
344 | ||
300eb013 DL |
345 | int phy_set_mode(struct phy *phy, enum phy_mode mode) |
346 | { | |
347 | int ret; | |
348 | ||
349 | if (!phy || !phy->ops->set_mode) | |
350 | return 0; | |
351 | ||
352 | mutex_lock(&phy->mutex); | |
353 | ret = phy->ops->set_mode(phy, mode); | |
354 | mutex_unlock(&phy->mutex); | |
355 | ||
356 | return ret; | |
357 | } | |
358 | EXPORT_SYMBOL_GPL(phy_set_mode); | |
359 | ||
cac18ecb RL |
360 | int phy_reset(struct phy *phy) |
361 | { | |
362 | int ret; | |
363 | ||
364 | if (!phy || !phy->ops->reset) | |
365 | return 0; | |
366 | ||
367 | mutex_lock(&phy->mutex); | |
368 | ret = phy->ops->reset(phy); | |
369 | mutex_unlock(&phy->mutex); | |
370 | ||
371 | return ret; | |
372 | } | |
373 | EXPORT_SYMBOL_GPL(phy_reset); | |
374 | ||
36914111 AP |
375 | int phy_calibrate(struct phy *phy) |
376 | { | |
377 | int ret; | |
378 | ||
379 | if (!phy || !phy->ops->calibrate) | |
380 | return 0; | |
381 | ||
382 | mutex_lock(&phy->mutex); | |
383 | ret = phy->ops->calibrate(phy); | |
384 | mutex_unlock(&phy->mutex); | |
385 | ||
386 | return ret; | |
387 | } | |
388 | EXPORT_SYMBOL_GPL(phy_calibrate); | |
389 | ||
ff764963 | 390 | /** |
0b3f3b2c KD |
391 | * _of_phy_get() - lookup and obtain a reference to a phy by phandle |
392 | * @np: device_node for which to get the phy | |
ff764963 KVA |
393 | * @index: the index of the phy |
394 | * | |
395 | * Returns the phy associated with the given phandle value, | |
396 | * after getting a refcount to it or -ENODEV if there is no such phy or | |
397 | * -EPROBE_DEFER if there is a phandle to the phy, but the device is | |
398 | * not yet loaded. This function uses of_xlate call back function provided | |
399 | * while registering the phy_provider to find the phy instance. | |
400 | */ | |
0b3f3b2c | 401 | static struct phy *_of_phy_get(struct device_node *np, int index) |
ff764963 KVA |
402 | { |
403 | int ret; | |
404 | struct phy_provider *phy_provider; | |
405 | struct phy *phy = NULL; | |
406 | struct of_phandle_args args; | |
407 | ||
0b3f3b2c | 408 | ret = of_parse_phandle_with_args(np, "phys", "#phy-cells", |
ff764963 | 409 | index, &args); |
0b3f3b2c | 410 | if (ret) |
ff764963 | 411 | return ERR_PTR(-ENODEV); |
ff764963 KVA |
412 | |
413 | mutex_lock(&phy_provider_mutex); | |
414 | phy_provider = of_phy_provider_lookup(args.np); | |
415 | if (IS_ERR(phy_provider) || !try_module_get(phy_provider->owner)) { | |
416 | phy = ERR_PTR(-EPROBE_DEFER); | |
33f434d2 AL |
417 | goto out_unlock; |
418 | } | |
419 | ||
420 | if (!of_device_is_available(args.np)) { | |
421 | dev_warn(phy_provider->dev, "Requested PHY is disabled\n"); | |
422 | phy = ERR_PTR(-ENODEV); | |
423 | goto out_put_module; | |
ff764963 KVA |
424 | } |
425 | ||
426 | phy = phy_provider->of_xlate(phy_provider->dev, &args); | |
33f434d2 AL |
427 | |
428 | out_put_module: | |
ff764963 KVA |
429 | module_put(phy_provider->owner); |
430 | ||
33f434d2 | 431 | out_unlock: |
ff764963 KVA |
432 | mutex_unlock(&phy_provider_mutex); |
433 | of_node_put(args.np); | |
434 | ||
435 | return phy; | |
436 | } | |
437 | ||
0b3f3b2c KD |
438 | /** |
439 | * of_phy_get() - lookup and obtain a reference to a phy using a device_node. | |
440 | * @np: device_node for which to get the phy | |
441 | * @con_id: name of the phy from device's point of view | |
442 | * | |
443 | * Returns the phy driver, after getting a refcount to it; or | |
444 | * -ENODEV if there is no such phy. The caller is responsible for | |
445 | * calling phy_put() to release that count. | |
446 | */ | |
447 | struct phy *of_phy_get(struct device_node *np, const char *con_id) | |
448 | { | |
449 | struct phy *phy = NULL; | |
450 | int index = 0; | |
451 | ||
452 | if (con_id) | |
453 | index = of_property_match_string(np, "phy-names", con_id); | |
454 | ||
455 | phy = _of_phy_get(np, index); | |
456 | if (IS_ERR(phy)) | |
457 | return phy; | |
458 | ||
459 | if (!try_module_get(phy->ops->owner)) | |
460 | return ERR_PTR(-EPROBE_DEFER); | |
461 | ||
462 | get_device(&phy->dev); | |
463 | ||
464 | return phy; | |
465 | } | |
466 | EXPORT_SYMBOL_GPL(of_phy_get); | |
467 | ||
ff764963 KVA |
468 | /** |
469 | * phy_put() - release the PHY | |
470 | * @phy: the phy returned by phy_get() | |
471 | * | |
472 | * Releases a refcount the caller received from phy_get(). | |
473 | */ | |
474 | void phy_put(struct phy *phy) | |
475 | { | |
04c2faca | 476 | if (!phy || IS_ERR(phy)) |
ff764963 KVA |
477 | return; |
478 | ||
479 | module_put(phy->ops->owner); | |
480 | put_device(&phy->dev); | |
481 | } | |
482 | EXPORT_SYMBOL_GPL(phy_put); | |
483 | ||
484 | /** | |
485 | * devm_phy_put() - release the PHY | |
486 | * @dev: device that wants to release this phy | |
487 | * @phy: the phy returned by devm_phy_get() | |
488 | * | |
489 | * destroys the devres associated with this phy and invokes phy_put | |
490 | * to release the phy. | |
491 | */ | |
492 | void devm_phy_put(struct device *dev, struct phy *phy) | |
493 | { | |
494 | int r; | |
495 | ||
04c2faca AL |
496 | if (!phy) |
497 | return; | |
498 | ||
ff764963 KVA |
499 | r = devres_destroy(dev, devm_phy_release, devm_phy_match, phy); |
500 | dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n"); | |
501 | } | |
502 | EXPORT_SYMBOL_GPL(devm_phy_put); | |
503 | ||
504 | /** | |
505 | * of_phy_simple_xlate() - returns the phy instance from phy provider | |
506 | * @dev: the PHY provider device | |
507 | * @args: of_phandle_args (not used here) | |
508 | * | |
509 | * Intended to be used by phy provider for the common case where #phy-cells is | |
510 | * 0. For other cases where #phy-cells is greater than '0', the phy provider | |
511 | * should provide a custom of_xlate function that reads the *args* and returns | |
512 | * the appropriate phy. | |
513 | */ | |
514 | struct phy *of_phy_simple_xlate(struct device *dev, struct of_phandle_args | |
515 | *args) | |
516 | { | |
517 | struct phy *phy; | |
518 | struct class_dev_iter iter; | |
ff764963 KVA |
519 | |
520 | class_dev_iter_init(&iter, phy_class, NULL, NULL); | |
521 | while ((dev = class_dev_iter_next(&iter))) { | |
522 | phy = to_phy(dev); | |
491e0490 | 523 | if (args->np != phy->dev.of_node) |
ff764963 KVA |
524 | continue; |
525 | ||
526 | class_dev_iter_exit(&iter); | |
527 | return phy; | |
528 | } | |
529 | ||
530 | class_dev_iter_exit(&iter); | |
531 | return ERR_PTR(-ENODEV); | |
532 | } | |
533 | EXPORT_SYMBOL_GPL(of_phy_simple_xlate); | |
534 | ||
535 | /** | |
536 | * phy_get() - lookup and obtain a reference to a phy. | |
537 | * @dev: device that requests this phy | |
538 | * @string: the phy name as given in the dt data or the name of the controller | |
539 | * port for non-dt case | |
540 | * | |
541 | * Returns the phy driver, after getting a refcount to it; or | |
542 | * -ENODEV if there is no such phy. The caller is responsible for | |
543 | * calling phy_put() to release that count. | |
544 | */ | |
545 | struct phy *phy_get(struct device *dev, const char *string) | |
546 | { | |
547 | int index = 0; | |
d18c9604 | 548 | struct phy *phy; |
ff764963 KVA |
549 | |
550 | if (string == NULL) { | |
551 | dev_WARN(dev, "missing string\n"); | |
552 | return ERR_PTR(-EINVAL); | |
553 | } | |
554 | ||
555 | if (dev->of_node) { | |
556 | index = of_property_match_string(dev->of_node, "phy-names", | |
557 | string); | |
0b3f3b2c | 558 | phy = _of_phy_get(dev->of_node, index); |
ff764963 | 559 | } else { |
b7bc15b9 | 560 | phy = phy_find(dev, string); |
ff764963 | 561 | } |
f40037fd HG |
562 | if (IS_ERR(phy)) |
563 | return phy; | |
ff764963 KVA |
564 | |
565 | if (!try_module_get(phy->ops->owner)) | |
566 | return ERR_PTR(-EPROBE_DEFER); | |
567 | ||
568 | get_device(&phy->dev); | |
569 | ||
570 | return phy; | |
571 | } | |
572 | EXPORT_SYMBOL_GPL(phy_get); | |
573 | ||
788a4d56 AL |
574 | /** |
575 | * phy_optional_get() - lookup and obtain a reference to an optional phy. | |
576 | * @dev: device that requests this phy | |
577 | * @string: the phy name as given in the dt data or the name of the controller | |
578 | * port for non-dt case | |
579 | * | |
580 | * Returns the phy driver, after getting a refcount to it; or | |
581 | * NULL if there is no such phy. The caller is responsible for | |
582 | * calling phy_put() to release that count. | |
583 | */ | |
584 | struct phy *phy_optional_get(struct device *dev, const char *string) | |
585 | { | |
586 | struct phy *phy = phy_get(dev, string); | |
587 | ||
f83be4c3 | 588 | if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV)) |
788a4d56 AL |
589 | phy = NULL; |
590 | ||
591 | return phy; | |
592 | } | |
593 | EXPORT_SYMBOL_GPL(phy_optional_get); | |
594 | ||
ff764963 KVA |
595 | /** |
596 | * devm_phy_get() - lookup and obtain a reference to a phy. | |
597 | * @dev: device that requests this phy | |
598 | * @string: the phy name as given in the dt data or phy device name | |
599 | * for non-dt case | |
600 | * | |
601 | * Gets the phy using phy_get(), and associates a device with it using | |
602 | * devres. On driver detach, release function is invoked on the devres data, | |
603 | * then, devres data is freed. | |
604 | */ | |
605 | struct phy *devm_phy_get(struct device *dev, const char *string) | |
606 | { | |
607 | struct phy **ptr, *phy; | |
608 | ||
609 | ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL); | |
610 | if (!ptr) | |
611 | return ERR_PTR(-ENOMEM); | |
612 | ||
613 | phy = phy_get(dev, string); | |
614 | if (!IS_ERR(phy)) { | |
615 | *ptr = phy; | |
616 | devres_add(dev, ptr); | |
617 | } else { | |
618 | devres_free(ptr); | |
619 | } | |
620 | ||
621 | return phy; | |
622 | } | |
623 | EXPORT_SYMBOL_GPL(devm_phy_get); | |
624 | ||
788a4d56 AL |
625 | /** |
626 | * devm_phy_optional_get() - lookup and obtain a reference to an optional phy. | |
627 | * @dev: device that requests this phy | |
628 | * @string: the phy name as given in the dt data or phy device name | |
629 | * for non-dt case | |
630 | * | |
631 | * Gets the phy using phy_get(), and associates a device with it using | |
632 | * devres. On driver detach, release function is invoked on the devres | |
633 | * data, then, devres data is freed. This differs to devm_phy_get() in | |
634 | * that if the phy does not exist, it is not considered an error and | |
635 | * -ENODEV will not be returned. Instead the NULL phy is returned, | |
636 | * which can be passed to all other phy consumer calls. | |
637 | */ | |
638 | struct phy *devm_phy_optional_get(struct device *dev, const char *string) | |
639 | { | |
640 | struct phy *phy = devm_phy_get(dev, string); | |
641 | ||
f83be4c3 | 642 | if (IS_ERR(phy) && (PTR_ERR(phy) == -ENODEV)) |
788a4d56 AL |
643 | phy = NULL; |
644 | ||
645 | return phy; | |
646 | } | |
647 | EXPORT_SYMBOL_GPL(devm_phy_optional_get); | |
648 | ||
b5d682f4 KD |
649 | /** |
650 | * devm_of_phy_get() - lookup and obtain a reference to a phy. | |
651 | * @dev: device that requests this phy | |
652 | * @np: node containing the phy | |
653 | * @con_id: name of the phy from device's point of view | |
654 | * | |
655 | * Gets the phy using of_phy_get(), and associates a device with it using | |
656 | * devres. On driver detach, release function is invoked on the devres data, | |
657 | * then, devres data is freed. | |
658 | */ | |
659 | struct phy *devm_of_phy_get(struct device *dev, struct device_node *np, | |
660 | const char *con_id) | |
661 | { | |
662 | struct phy **ptr, *phy; | |
663 | ||
664 | ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL); | |
665 | if (!ptr) | |
666 | return ERR_PTR(-ENOMEM); | |
667 | ||
668 | phy = of_phy_get(np, con_id); | |
669 | if (!IS_ERR(phy)) { | |
670 | *ptr = phy; | |
671 | devres_add(dev, ptr); | |
672 | } else { | |
673 | devres_free(ptr); | |
674 | } | |
675 | ||
676 | return phy; | |
677 | } | |
678 | EXPORT_SYMBOL_GPL(devm_of_phy_get); | |
679 | ||
6be109b3 AR |
680 | /** |
681 | * devm_of_phy_get_by_index() - lookup and obtain a reference to a phy by index. | |
682 | * @dev: device that requests this phy | |
683 | * @np: node containing the phy | |
684 | * @index: index of the phy | |
685 | * | |
70874462 CY |
686 | * Gets the phy using _of_phy_get(), then gets a refcount to it, |
687 | * and associates a device with it using devres. On driver detach, | |
688 | * release function is invoked on the devres data, | |
6be109b3 AR |
689 | * then, devres data is freed. |
690 | * | |
691 | */ | |
692 | struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, | |
693 | int index) | |
694 | { | |
695 | struct phy **ptr, *phy; | |
696 | ||
697 | ptr = devres_alloc(devm_phy_release, sizeof(*ptr), GFP_KERNEL); | |
698 | if (!ptr) | |
699 | return ERR_PTR(-ENOMEM); | |
700 | ||
701 | phy = _of_phy_get(np, index); | |
70874462 | 702 | if (IS_ERR(phy)) { |
6be109b3 | 703 | devres_free(ptr); |
70874462 | 704 | return phy; |
6be109b3 AR |
705 | } |
706 | ||
70874462 CY |
707 | if (!try_module_get(phy->ops->owner)) { |
708 | devres_free(ptr); | |
709 | return ERR_PTR(-EPROBE_DEFER); | |
710 | } | |
711 | ||
712 | get_device(&phy->dev); | |
713 | ||
714 | *ptr = phy; | |
715 | devres_add(dev, ptr); | |
716 | ||
6be109b3 AR |
717 | return phy; |
718 | } | |
719 | EXPORT_SYMBOL_GPL(devm_of_phy_get_by_index); | |
720 | ||
ff764963 KVA |
721 | /** |
722 | * phy_create() - create a new phy | |
723 | * @dev: device that is creating the new phy | |
f0ed8176 | 724 | * @node: device node of the phy |
ff764963 | 725 | * @ops: function pointers for performing phy operations |
ff764963 KVA |
726 | * |
727 | * Called to create a phy using phy framework. | |
728 | */ | |
f0ed8176 | 729 | struct phy *phy_create(struct device *dev, struct device_node *node, |
dbc98635 | 730 | const struct phy_ops *ops) |
ff764963 KVA |
731 | { |
732 | int ret; | |
733 | int id; | |
734 | struct phy *phy; | |
735 | ||
52797d29 DC |
736 | if (WARN_ON(!dev)) |
737 | return ERR_PTR(-EINVAL); | |
ff764963 KVA |
738 | |
739 | phy = kzalloc(sizeof(*phy), GFP_KERNEL); | |
52797d29 DC |
740 | if (!phy) |
741 | return ERR_PTR(-ENOMEM); | |
ff764963 KVA |
742 | |
743 | id = ida_simple_get(&phy_ida, 0, 0, GFP_KERNEL); | |
744 | if (id < 0) { | |
745 | dev_err(dev, "unable to get id\n"); | |
746 | ret = id; | |
52797d29 | 747 | goto free_phy; |
ff764963 KVA |
748 | } |
749 | ||
750 | device_initialize(&phy->dev); | |
751 | mutex_init(&phy->mutex); | |
752 | ||
753 | phy->dev.class = phy_class; | |
754 | phy->dev.parent = dev; | |
f0ed8176 | 755 | phy->dev.of_node = node ?: dev->of_node; |
ff764963 KVA |
756 | phy->id = id; |
757 | phy->ops = ops; | |
ff764963 KVA |
758 | |
759 | ret = dev_set_name(&phy->dev, "phy-%s.%d", dev_name(dev), id); | |
760 | if (ret) | |
52797d29 | 761 | goto put_dev; |
ff764963 | 762 | |
87006dd6 DT |
763 | /* phy-supply */ |
764 | phy->pwr = regulator_get_optional(&phy->dev, "phy"); | |
765 | if (IS_ERR(phy->pwr)) { | |
766 | ret = PTR_ERR(phy->pwr); | |
767 | if (ret == -EPROBE_DEFER) | |
768 | goto put_dev; | |
769 | ||
770 | phy->pwr = NULL; | |
771 | } | |
772 | ||
ff764963 KVA |
773 | ret = device_add(&phy->dev); |
774 | if (ret) | |
52797d29 | 775 | goto put_dev; |
ff764963 KVA |
776 | |
777 | if (pm_runtime_enabled(dev)) { | |
778 | pm_runtime_enable(&phy->dev); | |
779 | pm_runtime_no_callbacks(&phy->dev); | |
780 | } | |
781 | ||
782 | return phy; | |
783 | ||
52797d29 | 784 | put_dev: |
e73b49f1 RQ |
785 | put_device(&phy->dev); /* calls phy_release() which frees resources */ |
786 | return ERR_PTR(ret); | |
787 | ||
52797d29 | 788 | free_phy: |
ff764963 | 789 | kfree(phy); |
ff764963 KVA |
790 | return ERR_PTR(ret); |
791 | } | |
792 | EXPORT_SYMBOL_GPL(phy_create); | |
793 | ||
794 | /** | |
795 | * devm_phy_create() - create a new phy | |
796 | * @dev: device that is creating the new phy | |
f0ed8176 | 797 | * @node: device node of the phy |
ff764963 | 798 | * @ops: function pointers for performing phy operations |
ff764963 KVA |
799 | * |
800 | * Creates a new PHY device adding it to the PHY class. | |
801 | * While at that, it also associates the device with the phy using devres. | |
802 | * On driver detach, release function is invoked on the devres data, | |
803 | * then, devres data is freed. | |
804 | */ | |
f0ed8176 | 805 | struct phy *devm_phy_create(struct device *dev, struct device_node *node, |
dbc98635 | 806 | const struct phy_ops *ops) |
ff764963 KVA |
807 | { |
808 | struct phy **ptr, *phy; | |
809 | ||
810 | ptr = devres_alloc(devm_phy_consume, sizeof(*ptr), GFP_KERNEL); | |
811 | if (!ptr) | |
812 | return ERR_PTR(-ENOMEM); | |
813 | ||
dbc98635 | 814 | phy = phy_create(dev, node, ops); |
ff764963 KVA |
815 | if (!IS_ERR(phy)) { |
816 | *ptr = phy; | |
817 | devres_add(dev, ptr); | |
818 | } else { | |
819 | devres_free(ptr); | |
820 | } | |
821 | ||
822 | return phy; | |
823 | } | |
824 | EXPORT_SYMBOL_GPL(devm_phy_create); | |
825 | ||
826 | /** | |
827 | * phy_destroy() - destroy the phy | |
828 | * @phy: the phy to be destroyed | |
829 | * | |
830 | * Called to destroy the phy. | |
831 | */ | |
832 | void phy_destroy(struct phy *phy) | |
833 | { | |
834 | pm_runtime_disable(&phy->dev); | |
835 | device_unregister(&phy->dev); | |
836 | } | |
837 | EXPORT_SYMBOL_GPL(phy_destroy); | |
838 | ||
839 | /** | |
840 | * devm_phy_destroy() - destroy the PHY | |
841 | * @dev: device that wants to release this phy | |
842 | * @phy: the phy returned by devm_phy_get() | |
843 | * | |
844 | * destroys the devres associated with this phy and invokes phy_destroy | |
845 | * to destroy the phy. | |
846 | */ | |
847 | void devm_phy_destroy(struct device *dev, struct phy *phy) | |
848 | { | |
849 | int r; | |
850 | ||
851 | r = devres_destroy(dev, devm_phy_consume, devm_phy_match, phy); | |
852 | dev_WARN_ONCE(dev, r, "couldn't find PHY resource\n"); | |
853 | } | |
854 | EXPORT_SYMBOL_GPL(devm_phy_destroy); | |
855 | ||
856 | /** | |
857 | * __of_phy_provider_register() - create/register phy provider with the framework | |
858 | * @dev: struct device of the phy provider | |
1140f7c8 | 859 | * @children: device node containing children (if different from dev->of_node) |
ff764963 KVA |
860 | * @owner: the module owner containing of_xlate |
861 | * @of_xlate: function pointer to obtain phy instance from phy provider | |
862 | * | |
863 | * Creates struct phy_provider from dev and of_xlate function pointer. | |
864 | * This is used in the case of dt boot for finding the phy instance from | |
865 | * phy provider. | |
1140f7c8 TR |
866 | * |
867 | * If the PHY provider doesn't nest children directly but uses a separate | |
868 | * child node to contain the individual children, the @children parameter | |
869 | * can be used to override the default. If NULL, the default (dev->of_node) | |
870 | * will be used. If non-NULL, the device node must be a child (or further | |
871 | * descendant) of dev->of_node. Otherwise an ERR_PTR()-encoded -EINVAL | |
872 | * error code is returned. | |
ff764963 KVA |
873 | */ |
874 | struct phy_provider *__of_phy_provider_register(struct device *dev, | |
1140f7c8 TR |
875 | struct device_node *children, struct module *owner, |
876 | struct phy * (*of_xlate)(struct device *dev, | |
877 | struct of_phandle_args *args)) | |
ff764963 KVA |
878 | { |
879 | struct phy_provider *phy_provider; | |
880 | ||
1140f7c8 TR |
881 | /* |
882 | * If specified, the device node containing the children must itself | |
883 | * be the provider's device node or a child (or further descendant) | |
884 | * thereof. | |
885 | */ | |
886 | if (children) { | |
887 | struct device_node *parent = of_node_get(children), *next; | |
888 | ||
889 | while (parent) { | |
890 | if (parent == dev->of_node) | |
891 | break; | |
892 | ||
893 | next = of_get_parent(parent); | |
894 | of_node_put(parent); | |
895 | parent = next; | |
896 | } | |
897 | ||
898 | if (!parent) | |
899 | return ERR_PTR(-EINVAL); | |
900 | ||
901 | of_node_put(parent); | |
902 | } else { | |
903 | children = dev->of_node; | |
904 | } | |
905 | ||
ff764963 KVA |
906 | phy_provider = kzalloc(sizeof(*phy_provider), GFP_KERNEL); |
907 | if (!phy_provider) | |
908 | return ERR_PTR(-ENOMEM); | |
909 | ||
910 | phy_provider->dev = dev; | |
1140f7c8 | 911 | phy_provider->children = of_node_get(children); |
ff764963 KVA |
912 | phy_provider->owner = owner; |
913 | phy_provider->of_xlate = of_xlate; | |
914 | ||
915 | mutex_lock(&phy_provider_mutex); | |
916 | list_add_tail(&phy_provider->list, &phy_provider_list); | |
917 | mutex_unlock(&phy_provider_mutex); | |
918 | ||
919 | return phy_provider; | |
920 | } | |
921 | EXPORT_SYMBOL_GPL(__of_phy_provider_register); | |
922 | ||
923 | /** | |
924 | * __devm_of_phy_provider_register() - create/register phy provider with the | |
925 | * framework | |
926 | * @dev: struct device of the phy provider | |
927 | * @owner: the module owner containing of_xlate | |
928 | * @of_xlate: function pointer to obtain phy instance from phy provider | |
929 | * | |
930 | * Creates struct phy_provider from dev and of_xlate function pointer. | |
931 | * This is used in the case of dt boot for finding the phy instance from | |
932 | * phy provider. While at that, it also associates the device with the | |
933 | * phy provider using devres. On driver detach, release function is invoked | |
934 | * on the devres data, then, devres data is freed. | |
935 | */ | |
936 | struct phy_provider *__devm_of_phy_provider_register(struct device *dev, | |
1140f7c8 TR |
937 | struct device_node *children, struct module *owner, |
938 | struct phy * (*of_xlate)(struct device *dev, | |
939 | struct of_phandle_args *args)) | |
ff764963 KVA |
940 | { |
941 | struct phy_provider **ptr, *phy_provider; | |
942 | ||
943 | ptr = devres_alloc(devm_phy_provider_release, sizeof(*ptr), GFP_KERNEL); | |
944 | if (!ptr) | |
945 | return ERR_PTR(-ENOMEM); | |
946 | ||
1140f7c8 TR |
947 | phy_provider = __of_phy_provider_register(dev, children, owner, |
948 | of_xlate); | |
ff764963 KVA |
949 | if (!IS_ERR(phy_provider)) { |
950 | *ptr = phy_provider; | |
951 | devres_add(dev, ptr); | |
952 | } else { | |
953 | devres_free(ptr); | |
954 | } | |
955 | ||
956 | return phy_provider; | |
957 | } | |
958 | EXPORT_SYMBOL_GPL(__devm_of_phy_provider_register); | |
959 | ||
960 | /** | |
961 | * of_phy_provider_unregister() - unregister phy provider from the framework | |
962 | * @phy_provider: phy provider returned by of_phy_provider_register() | |
963 | * | |
964 | * Removes the phy_provider created using of_phy_provider_register(). | |
965 | */ | |
966 | void of_phy_provider_unregister(struct phy_provider *phy_provider) | |
967 | { | |
968 | if (IS_ERR(phy_provider)) | |
969 | return; | |
970 | ||
971 | mutex_lock(&phy_provider_mutex); | |
972 | list_del(&phy_provider->list); | |
1140f7c8 | 973 | of_node_put(phy_provider->children); |
ff764963 KVA |
974 | kfree(phy_provider); |
975 | mutex_unlock(&phy_provider_mutex); | |
976 | } | |
977 | EXPORT_SYMBOL_GPL(of_phy_provider_unregister); | |
978 | ||
979 | /** | |
980 | * devm_of_phy_provider_unregister() - remove phy provider from the framework | |
981 | * @dev: struct device of the phy provider | |
982 | * | |
983 | * destroys the devres associated with this phy provider and invokes | |
984 | * of_phy_provider_unregister to unregister the phy provider. | |
985 | */ | |
986 | void devm_of_phy_provider_unregister(struct device *dev, | |
987 | struct phy_provider *phy_provider) { | |
988 | int r; | |
989 | ||
990 | r = devres_destroy(dev, devm_phy_provider_release, devm_phy_match, | |
991 | phy_provider); | |
992 | dev_WARN_ONCE(dev, r, "couldn't find PHY provider device resource\n"); | |
993 | } | |
994 | EXPORT_SYMBOL_GPL(devm_of_phy_provider_unregister); | |
995 | ||
996 | /** | |
997 | * phy_release() - release the phy | |
998 | * @dev: the dev member within phy | |
999 | * | |
1000 | * When the last reference to the device is removed, it is called | |
1001 | * from the embedded kobject as release method. | |
1002 | */ | |
1003 | static void phy_release(struct device *dev) | |
1004 | { | |
1005 | struct phy *phy; | |
1006 | ||
1007 | phy = to_phy(dev); | |
1008 | dev_vdbg(dev, "releasing '%s'\n", dev_name(dev)); | |
3be88125 | 1009 | regulator_put(phy->pwr); |
e73b49f1 | 1010 | ida_simple_remove(&phy_ida, phy->id); |
ff764963 KVA |
1011 | kfree(phy); |
1012 | } | |
1013 | ||
1014 | static int __init phy_core_init(void) | |
1015 | { | |
1016 | phy_class = class_create(THIS_MODULE, "phy"); | |
1017 | if (IS_ERR(phy_class)) { | |
1018 | pr_err("failed to create phy class --> %ld\n", | |
1019 | PTR_ERR(phy_class)); | |
1020 | return PTR_ERR(phy_class); | |
1021 | } | |
1022 | ||
1023 | phy_class->dev_release = phy_release; | |
1024 | ||
1025 | return 0; | |
1026 | } | |
1027 | module_init(phy_core_init); | |
1028 | ||
1029 | static void __exit phy_core_exit(void) | |
1030 | { | |
1031 | class_destroy(phy_class); | |
1032 | } | |
1033 | module_exit(phy_core_exit); | |
1034 | ||
1035 | MODULE_DESCRIPTION("Generic PHY Framework"); | |
1036 | MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>"); | |
1037 | MODULE_LICENSE("GPL v2"); |