1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * phy.h -- generic phy header file
5 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
7 * Author: Kishon Vijay Abraham I <kishon@ti.com>
10 #ifndef __DRIVERS_PHY_H
11 #define __DRIVERS_PHY_H
13 #include <linux/err.h>
15 #include <linux/device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/regulator/consumer.h>
19 #include <linux/phy/phy-dp.h>
20 #include <linux/phy/phy-lvds.h>
21 #include <linux/phy/phy-mipi-dphy.h>
33 PHY_MODE_USB_DEVICE_LS,
34 PHY_MODE_USB_DEVICE_FS,
35 PHY_MODE_USB_DEVICE_HS,
36 PHY_MODE_USB_DEVICE_SS,
55 * union phy_configure_opts - Opaque generic phy configuration
57 * @mipi_dphy: Configuration set applicable for phys supporting
58 * the MIPI_DPHY phy mode.
59 * @dp: Configuration set applicable for phys supporting
60 * the DisplayPort protocol.
61 * @lvds: Configuration set applicable for phys supporting
64 union phy_configure_opts {
65 struct phy_configure_opts_mipi_dphy mipi_dphy;
66 struct phy_configure_opts_dp dp;
67 struct phy_configure_opts_lvds lvds;
71 * struct phy_ops - set of function pointers for performing phy operations
72 * @init: operation to be performed for initializing phy
73 * @exit: operation to be performed while exiting
74 * @power_on: powering on the phy
75 * @power_off: powering off the phy
76 * @set_mode: set the mode of the phy
77 * @set_media: set the media type of the phy (optional)
78 * @set_speed: set the speed of the phy (optional)
79 * @reset: resetting the phy
80 * @calibrate: calibrate the phy
81 * @release: ops to be performed while the consumer relinquishes the PHY
82 * @owner: the module owner containing the ops
85 int (*init)(struct phy *phy);
86 int (*exit)(struct phy *phy);
87 int (*power_on)(struct phy *phy);
88 int (*power_off)(struct phy *phy);
89 int (*set_mode)(struct phy *phy, enum phy_mode mode, int submode);
90 int (*set_media)(struct phy *phy, enum phy_media media);
91 int (*set_speed)(struct phy *phy, int speed);
98 * Used to change the PHY parameters. phy_init() must have
99 * been called on the phy.
101 * Returns: 0 if successful, an negative error code otherwise
103 int (*configure)(struct phy *phy, union phy_configure_opts *opts);
110 * Used to check that the current set of parameters can be
111 * handled by the phy. Implementations are free to tune the
112 * parameters passed as arguments if needed by some
113 * implementation detail or constraints. It must not change
114 * any actual configuration of the PHY, so calling it as many
115 * times as deemed fit by the consumer must have no side
118 * Returns: 0 if the configuration can be applied, an negative
119 * error code otherwise
121 int (*validate)(struct phy *phy, enum phy_mode mode, int submode,
122 union phy_configure_opts *opts);
123 int (*reset)(struct phy *phy);
124 int (*calibrate)(struct phy *phy);
126 /* notify phy connect status change */
127 int (*connect)(struct phy *phy, int port);
128 int (*disconnect)(struct phy *phy, int port);
130 void (*release)(struct phy *phy);
131 struct module *owner;
135 * struct phy_attrs - represents phy attributes
136 * @bus_width: Data path width implemented by PHY
137 * @max_link_rate: Maximum link rate supported by PHY (units to be decided by producer and consumer)
147 * struct phy - represents the phy device
149 * @id: id of the phy device
150 * @ops: function pointers for performing phy operations
151 * @mutex: mutex to protect phy_ops
152 * @init_count: used to protect when the PHY is used by multiple consumers
153 * @power_count: used to protect when the PHY is used by multiple consumers
154 * @attrs: used to specify PHY specific attributes
155 * @pwr: power regulator associated with the phy
156 * @debugfs: debugfs directory
161 const struct phy_ops *ops;
165 struct phy_attrs attrs;
166 struct regulator *pwr;
167 struct dentry *debugfs;
171 * struct phy_provider - represents the phy provider
172 * @dev: phy provider device
173 * @children: can be used to override the default (dev->of_node) child node
174 * @owner: the module owner having of_xlate
175 * @list: to maintain a linked list of PHY providers
176 * @of_xlate: function pointer to obtain phy instance from phy pointer
178 struct phy_provider {
180 struct device_node *children;
181 struct module *owner;
182 struct list_head list;
183 struct phy * (*of_xlate)(struct device *dev,
184 const struct of_phandle_args *args);
188 * struct phy_lookup - PHY association in list of phys managed by the phy driver
190 * @dev_id: the device of the association
191 * @con_id: connection ID string on device
192 * @phy: the phy of the association
195 struct list_head node;
201 #define to_phy(a) (container_of((a), struct phy, dev))
203 #define of_phy_provider_register(dev, xlate) \
204 __of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
206 #define devm_of_phy_provider_register(dev, xlate) \
207 __devm_of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
209 #define of_phy_provider_register_full(dev, children, xlate) \
210 __of_phy_provider_register(dev, children, THIS_MODULE, xlate)
212 #define devm_of_phy_provider_register_full(dev, children, xlate) \
213 __devm_of_phy_provider_register(dev, children, THIS_MODULE, xlate)
215 static inline void phy_set_drvdata(struct phy *phy, void *data)
217 dev_set_drvdata(&phy->dev, data);
220 static inline void *phy_get_drvdata(struct phy *phy)
222 return dev_get_drvdata(&phy->dev);
225 #if IS_ENABLED(CONFIG_GENERIC_PHY)
226 int phy_pm_runtime_get(struct phy *phy);
227 int phy_pm_runtime_get_sync(struct phy *phy);
228 int phy_pm_runtime_put(struct phy *phy);
229 int phy_pm_runtime_put_sync(struct phy *phy);
230 void phy_pm_runtime_allow(struct phy *phy);
231 void phy_pm_runtime_forbid(struct phy *phy);
232 int phy_init(struct phy *phy);
233 int phy_exit(struct phy *phy);
234 int phy_power_on(struct phy *phy);
235 int phy_power_off(struct phy *phy);
236 int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode);
237 #define phy_set_mode(phy, mode) \
238 phy_set_mode_ext(phy, mode, 0)
239 int phy_set_media(struct phy *phy, enum phy_media media);
240 int phy_set_speed(struct phy *phy, int speed);
241 int phy_configure(struct phy *phy, union phy_configure_opts *opts);
242 int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
243 union phy_configure_opts *opts);
245 static inline enum phy_mode phy_get_mode(struct phy *phy)
247 return phy->attrs.mode;
249 int phy_reset(struct phy *phy);
250 int phy_calibrate(struct phy *phy);
251 int phy_notify_connect(struct phy *phy, int port);
252 int phy_notify_disconnect(struct phy *phy, int port);
253 static inline int phy_get_bus_width(struct phy *phy)
255 return phy->attrs.bus_width;
257 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
259 phy->attrs.bus_width = bus_width;
261 struct phy *phy_get(struct device *dev, const char *string);
262 struct phy *devm_phy_get(struct device *dev, const char *string);
263 struct phy *devm_phy_optional_get(struct device *dev, const char *string);
264 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
266 struct phy *devm_of_phy_optional_get(struct device *dev, struct device_node *np,
268 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
270 void of_phy_put(struct phy *phy);
271 void phy_put(struct device *dev, struct phy *phy);
272 void devm_phy_put(struct device *dev, struct phy *phy);
273 struct phy *of_phy_get(struct device_node *np, const char *con_id);
274 struct phy *of_phy_simple_xlate(struct device *dev,
275 const struct of_phandle_args *args);
276 struct phy *phy_create(struct device *dev, struct device_node *node,
277 const struct phy_ops *ops);
278 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
279 const struct phy_ops *ops);
280 void phy_destroy(struct phy *phy);
281 void devm_phy_destroy(struct device *dev, struct phy *phy);
282 struct phy_provider *__of_phy_provider_register(struct device *dev,
283 struct device_node *children, struct module *owner,
284 struct phy * (*of_xlate)(struct device *dev,
285 const struct of_phandle_args *args));
286 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
287 struct device_node *children, struct module *owner,
288 struct phy * (*of_xlate)(struct device *dev,
289 const struct of_phandle_args *args));
290 void of_phy_provider_unregister(struct phy_provider *phy_provider);
291 void devm_of_phy_provider_unregister(struct device *dev,
292 struct phy_provider *phy_provider);
293 int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id);
294 void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id);
296 static inline int phy_pm_runtime_get(struct phy *phy)
303 static inline int phy_pm_runtime_get_sync(struct phy *phy)
310 static inline int phy_pm_runtime_put(struct phy *phy)
317 static inline int phy_pm_runtime_put_sync(struct phy *phy)
324 static inline void phy_pm_runtime_allow(struct phy *phy)
329 static inline void phy_pm_runtime_forbid(struct phy *phy)
334 static inline int phy_init(struct phy *phy)
341 static inline int phy_exit(struct phy *phy)
348 static inline int phy_power_on(struct phy *phy)
355 static inline int phy_power_off(struct phy *phy)
362 static inline int phy_set_mode_ext(struct phy *phy, enum phy_mode mode,
370 #define phy_set_mode(phy, mode) \
371 phy_set_mode_ext(phy, mode, 0)
373 static inline int phy_set_media(struct phy *phy, enum phy_media media)
380 static inline int phy_set_speed(struct phy *phy, int speed)
387 static inline enum phy_mode phy_get_mode(struct phy *phy)
389 return PHY_MODE_INVALID;
392 static inline int phy_reset(struct phy *phy)
399 static inline int phy_calibrate(struct phy *phy)
406 static inline int phy_notify_connect(struct phy *phy, int index)
413 static inline int phy_notify_disconnect(struct phy *phy, int index)
420 static inline int phy_configure(struct phy *phy,
421 union phy_configure_opts *opts)
429 static inline int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
430 union phy_configure_opts *opts)
438 static inline int phy_get_bus_width(struct phy *phy)
443 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
448 static inline struct phy *phy_get(struct device *dev, const char *string)
450 return ERR_PTR(-ENOSYS);
453 static inline struct phy *devm_phy_get(struct device *dev, const char *string)
455 return ERR_PTR(-ENOSYS);
458 static inline struct phy *devm_phy_optional_get(struct device *dev,
464 static inline struct phy *devm_of_phy_get(struct device *dev,
465 struct device_node *np,
468 return ERR_PTR(-ENOSYS);
471 static inline struct phy *devm_of_phy_optional_get(struct device *dev,
472 struct device_node *np,
478 static inline struct phy *devm_of_phy_get_by_index(struct device *dev,
479 struct device_node *np,
482 return ERR_PTR(-ENOSYS);
485 static inline void of_phy_put(struct phy *phy)
489 static inline void phy_put(struct device *dev, struct phy *phy)
493 static inline void devm_phy_put(struct device *dev, struct phy *phy)
497 static inline struct phy *of_phy_get(struct device_node *np, const char *con_id)
499 return ERR_PTR(-ENOSYS);
502 static inline struct phy *of_phy_simple_xlate(struct device *dev,
503 const struct of_phandle_args *args)
505 return ERR_PTR(-ENOSYS);
508 static inline struct phy *phy_create(struct device *dev,
509 struct device_node *node,
510 const struct phy_ops *ops)
512 return ERR_PTR(-ENOSYS);
515 static inline struct phy *devm_phy_create(struct device *dev,
516 struct device_node *node,
517 const struct phy_ops *ops)
519 return ERR_PTR(-ENOSYS);
522 static inline void phy_destroy(struct phy *phy)
526 static inline void devm_phy_destroy(struct device *dev, struct phy *phy)
530 static inline struct phy_provider *__of_phy_provider_register(
531 struct device *dev, struct device_node *children, struct module *owner,
532 struct phy * (*of_xlate)(struct device *dev,
533 const struct of_phandle_args *args))
535 return ERR_PTR(-ENOSYS);
538 static inline struct phy_provider *__devm_of_phy_provider_register(struct device
539 *dev, struct device_node *children, struct module *owner,
540 struct phy * (*of_xlate)(struct device *dev,
541 const struct of_phandle_args *args))
543 return ERR_PTR(-ENOSYS);
546 static inline void of_phy_provider_unregister(struct phy_provider *phy_provider)
550 static inline void devm_of_phy_provider_unregister(struct device *dev,
551 struct phy_provider *phy_provider)
555 phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
559 static inline void phy_remove_lookup(struct phy *phy, const char *con_id,
560 const char *dev_id) { }
563 #endif /* __DRIVERS_PHY_H */