blob: a810f2a18842e51c996b6216e73178141ecb6962 [file] [log] [blame]
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +05301/*
2 * phy.h -- generic phy header file
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
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 */
13
14#ifndef __DRIVERS_PHY_H
15#define __DRIVERS_PHY_H
16
17#include <linux/err.h>
18#include <linux/of.h>
19#include <linux/device.h>
20#include <linux/pm_runtime.h>
Roger Quadros3be88122014-07-04 12:55:45 +030021#include <linux/regulator/consumer.h>
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053022
23struct phy;
24
25/**
26 * struct phy_ops - set of function pointers for performing phy operations
27 * @init: operation to be performed for initializing phy
28 * @exit: operation to be performed while exiting
29 * @power_on: powering on the phy
30 * @power_off: powering off the phy
31 * @owner: the module owner containing the ops
32 */
33struct phy_ops {
34 int (*init)(struct phy *phy);
35 int (*exit)(struct phy *phy);
36 int (*power_on)(struct phy *phy);
37 int (*power_off)(struct phy *phy);
38 struct module *owner;
39};
40
41/**
Matt Porter8feed342013-12-19 09:23:02 -050042 * struct phy_attrs - represents phy attributes
43 * @bus_width: Data path width implemented by PHY
44 */
45struct phy_attrs {
46 u32 bus_width;
47};
48
49/**
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053050 * struct phy - represents the phy device
51 * @dev: phy device
52 * @id: id of the phy device
53 * @ops: function pointers for performing phy operations
54 * @init_data: list of PHY consumers (non-dt only)
55 * @mutex: mutex to protect phy_ops
56 * @init_count: used to protect when the PHY is used by multiple consumers
57 * @power_count: used to protect when the PHY is used by multiple consumers
Matt Porter8feed342013-12-19 09:23:02 -050058 * @phy_attrs: used to specify PHY specific attributes
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053059 */
60struct phy {
61 struct device dev;
62 int id;
63 const struct phy_ops *ops;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053064 struct mutex mutex;
65 int init_count;
66 int power_count;
Matt Porter8feed342013-12-19 09:23:02 -050067 struct phy_attrs attrs;
Roger Quadros3be88122014-07-04 12:55:45 +030068 struct regulator *pwr;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053069};
70
71/**
72 * struct phy_provider - represents the phy provider
73 * @dev: phy provider device
74 * @owner: the module owner having of_xlate
75 * @of_xlate: function pointer to obtain phy instance from phy pointer
76 * @list: to maintain a linked list of PHY providers
77 */
78struct phy_provider {
79 struct device *dev;
Thierry Reding1140f7c2016-04-05 17:17:34 +020080 struct device_node *children;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053081 struct module *owner;
82 struct list_head list;
83 struct phy * (*of_xlate)(struct device *dev,
84 struct of_phandle_args *args);
85};
86
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +020087struct phy_lookup {
88 struct list_head node;
89 const char *dev_id;
90 const char *con_id;
91 struct phy *phy;
92};
93
Heikki Krogerusd4510572014-11-19 17:28:17 +020094#define to_phy(a) (container_of((a), struct phy, dev))
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053095
96#define of_phy_provider_register(dev, xlate) \
Thierry Reding1140f7c2016-04-05 17:17:34 +020097 __of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +053098
99#define devm_of_phy_provider_register(dev, xlate) \
Thierry Reding1140f7c2016-04-05 17:17:34 +0200100 __devm_of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
101
102#define of_phy_provider_register_full(dev, children, xlate) \
103 __of_phy_provider_register(dev, children, THIS_MODULE, xlate)
104
105#define devm_of_phy_provider_register_full(dev, children, xlate) \
106 __devm_of_phy_provider_register(dev, children, THIS_MODULE, xlate)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530107
108static inline void phy_set_drvdata(struct phy *phy, void *data)
109{
110 dev_set_drvdata(&phy->dev, data);
111}
112
113static inline void *phy_get_drvdata(struct phy *phy)
114{
115 return dev_get_drvdata(&phy->dev);
116}
117
118#if IS_ENABLED(CONFIG_GENERIC_PHY)
119int phy_pm_runtime_get(struct phy *phy);
120int phy_pm_runtime_get_sync(struct phy *phy);
121int phy_pm_runtime_put(struct phy *phy);
122int phy_pm_runtime_put_sync(struct phy *phy);
123void phy_pm_runtime_allow(struct phy *phy);
124void phy_pm_runtime_forbid(struct phy *phy);
125int phy_init(struct phy *phy);
126int phy_exit(struct phy *phy);
127int phy_power_on(struct phy *phy);
128int phy_power_off(struct phy *phy);
Matt Porter8feed342013-12-19 09:23:02 -0500129static inline int phy_get_bus_width(struct phy *phy)
130{
131 return phy->attrs.bus_width;
132}
133static inline void phy_set_bus_width(struct phy *phy, int bus_width)
134{
135 phy->attrs.bus_width = bus_width;
136}
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530137struct phy *phy_get(struct device *dev, const char *string);
Andrew Lunn788a4d52014-02-04 18:33:12 +0100138struct phy *phy_optional_get(struct device *dev, const char *string);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530139struct phy *devm_phy_get(struct device *dev, const char *string);
Andrew Lunn788a4d52014-02-04 18:33:12 +0100140struct phy *devm_phy_optional_get(struct device *dev, const char *string);
Kamil Debskib5d682f2014-03-06 12:16:47 +0100141struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
142 const char *con_id);
Arun Ramamurthy6be109b2015-04-22 16:04:11 -0700143struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
144 int index);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530145void phy_put(struct phy *phy);
146void devm_phy_put(struct device *dev, struct phy *phy);
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100147struct phy *of_phy_get(struct device_node *np, const char *con_id);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530148struct phy *of_phy_simple_xlate(struct device *dev,
149 struct of_phandle_args *args);
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530150struct phy *phy_create(struct device *dev, struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200151 const struct phy_ops *ops);
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530152struct phy *devm_phy_create(struct device *dev, struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200153 const struct phy_ops *ops);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530154void phy_destroy(struct phy *phy);
155void devm_phy_destroy(struct device *dev, struct phy *phy);
156struct phy_provider *__of_phy_provider_register(struct device *dev,
Thierry Reding1140f7c2016-04-05 17:17:34 +0200157 struct device_node *children, struct module *owner,
158 struct phy * (*of_xlate)(struct device *dev,
159 struct of_phandle_args *args));
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530160struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
Thierry Reding1140f7c2016-04-05 17:17:34 +0200161 struct device_node *children, struct module *owner,
162 struct phy * (*of_xlate)(struct device *dev,
163 struct of_phandle_args *args));
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530164void of_phy_provider_unregister(struct phy_provider *phy_provider);
165void devm_of_phy_provider_unregister(struct device *dev,
166 struct phy_provider *phy_provider);
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +0200167int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id);
168void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id);
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530169#else
170static inline int phy_pm_runtime_get(struct phy *phy)
171{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530172 if (!phy)
173 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530174 return -ENOSYS;
175}
176
177static inline int phy_pm_runtime_get_sync(struct phy *phy)
178{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530179 if (!phy)
180 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530181 return -ENOSYS;
182}
183
184static inline int phy_pm_runtime_put(struct phy *phy)
185{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530186 if (!phy)
187 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530188 return -ENOSYS;
189}
190
191static inline int phy_pm_runtime_put_sync(struct phy *phy)
192{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530193 if (!phy)
194 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530195 return -ENOSYS;
196}
197
198static inline void phy_pm_runtime_allow(struct phy *phy)
199{
200 return;
201}
202
203static inline void phy_pm_runtime_forbid(struct phy *phy)
204{
205 return;
206}
207
208static inline int phy_init(struct phy *phy)
209{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530210 if (!phy)
211 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530212 return -ENOSYS;
213}
214
215static inline int phy_exit(struct phy *phy)
216{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530217 if (!phy)
218 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530219 return -ENOSYS;
220}
221
222static inline int phy_power_on(struct phy *phy)
223{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530224 if (!phy)
225 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530226 return -ENOSYS;
227}
228
229static inline int phy_power_off(struct phy *phy)
230{
Grygorii Strashko2b977892014-04-19 08:51:44 +0530231 if (!phy)
232 return 0;
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530233 return -ENOSYS;
234}
235
Matt Porter8feed342013-12-19 09:23:02 -0500236static inline int phy_get_bus_width(struct phy *phy)
237{
238 return -ENOSYS;
239}
240
241static inline void phy_set_bus_width(struct phy *phy, int bus_width)
242{
243 return;
244}
245
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530246static inline struct phy *phy_get(struct device *dev, const char *string)
247{
248 return ERR_PTR(-ENOSYS);
249}
250
Andrew Lunn788a4d52014-02-04 18:33:12 +0100251static inline struct phy *phy_optional_get(struct device *dev,
252 const char *string)
253{
254 return ERR_PTR(-ENOSYS);
255}
256
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530257static inline struct phy *devm_phy_get(struct device *dev, const char *string)
258{
259 return ERR_PTR(-ENOSYS);
260}
261
Andrew Lunn788a4d52014-02-04 18:33:12 +0100262static inline struct phy *devm_phy_optional_get(struct device *dev,
263 const char *string)
264{
265 return ERR_PTR(-ENOSYS);
266}
267
Kamil Debskib5d682f2014-03-06 12:16:47 +0100268static inline struct phy *devm_of_phy_get(struct device *dev,
269 struct device_node *np,
270 const char *con_id)
271{
272 return ERR_PTR(-ENOSYS);
273}
274
Arun Ramamurthy6be109b2015-04-22 16:04:11 -0700275static inline struct phy *devm_of_phy_get_by_index(struct device *dev,
276 struct device_node *np,
277 int index)
278{
279 return ERR_PTR(-ENOSYS);
280}
281
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530282static inline void phy_put(struct phy *phy)
283{
284}
285
286static inline void devm_phy_put(struct device *dev, struct phy *phy)
287{
288}
289
Kamil Debski0b3f3b22014-03-06 12:16:46 +0100290static inline struct phy *of_phy_get(struct device_node *np, const char *con_id)
291{
292 return ERR_PTR(-ENOSYS);
293}
294
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530295static inline struct phy *of_phy_simple_xlate(struct device *dev,
296 struct of_phandle_args *args)
297{
298 return ERR_PTR(-ENOSYS);
299}
300
301static inline struct phy *phy_create(struct device *dev,
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530302 struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200303 const struct phy_ops *ops)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530304{
305 return ERR_PTR(-ENOSYS);
306}
307
308static inline struct phy *devm_phy_create(struct device *dev,
Kishon Vijay Abraham If0ed8172014-07-14 15:55:02 +0530309 struct device_node *node,
Heikki Krogerusdbc98632014-11-19 17:28:21 +0200310 const struct phy_ops *ops)
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530311{
312 return ERR_PTR(-ENOSYS);
313}
314
315static inline void phy_destroy(struct phy *phy)
316{
317}
318
319static inline void devm_phy_destroy(struct device *dev, struct phy *phy)
320{
321}
322
323static inline struct phy_provider *__of_phy_provider_register(
Thierry Reding1140f7c2016-04-05 17:17:34 +0200324 struct device *dev, struct device_node *children, struct module *owner,
325 struct phy * (*of_xlate)(struct device *dev,
326 struct of_phandle_args *args))
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530327{
328 return ERR_PTR(-ENOSYS);
329}
330
331static inline struct phy_provider *__devm_of_phy_provider_register(struct device
Thierry Reding1140f7c2016-04-05 17:17:34 +0200332 *dev, struct device_node *children, struct module *owner,
333 struct phy * (*of_xlate)(struct device *dev,
334 struct of_phandle_args *args))
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530335{
336 return ERR_PTR(-ENOSYS);
337}
338
339static inline void of_phy_provider_unregister(struct phy_provider *phy_provider)
340{
341}
342
343static inline void devm_of_phy_provider_unregister(struct device *dev,
344 struct phy_provider *phy_provider)
345{
346}
Heikki Krogerusb7bc15b2014-11-19 17:28:18 +0200347static inline int
348phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
349{
350 return 0;
351}
352static inline void phy_remove_lookup(struct phy *phy, const char *con_id,
353 const char *dev_id) { }
Kishon Vijay Abraham Iff764962013-09-27 11:53:25 +0530354#endif
355
356#endif /* __DRIVERS_PHY_H */