Something went wrong. Try again.
(I'm so sorry!) Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575/* SPDX-License-Identifier: GPL-2.0-or-later *//* * phy.h -- generic phy header file * * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com * * Author: Kishon Vijay Abraham I <kishon@ti.com> */
#ifndef __DRIVERS_PHY_H#define __DRIVERS_PHY_H
#include <linux/err.h>#include <linux/of.h>#include <linux/device.h>#include <linux/pm_runtime.h>#include <linux/regulator/consumer.h>
#include <linux/phy/phy-dp.h>#include <linux/phy/phy-hdmi.h>#include <linux/phy/phy-lvds.h>#include <linux/phy/phy-mipi-dphy.h>
struct phy;
enum phy_mode { PHY_MODE_INVALID, PHY_MODE_USB_HOST, PHY_MODE_USB_HOST_LS, PHY_MODE_USB_HOST_FS, PHY_MODE_USB_HOST_HS, PHY_MODE_USB_HOST_SS, PHY_MODE_USB_DEVICE, PHY_MODE_USB_DEVICE_LS, PHY_MODE_USB_DEVICE_FS, PHY_MODE_USB_DEVICE_HS, PHY_MODE_USB_DEVICE_SS, PHY_MODE_USB_OTG, PHY_MODE_UFS_HS_A, PHY_MODE_UFS_HS_B, PHY_MODE_PCIE, PHY_MODE_ETHERNET, PHY_MODE_MIPI_DPHY, PHY_MODE_SATA, PHY_MODE_LVDS, PHY_MODE_DP, PHY_MODE_HDMI,};
enum phy_media { PHY_MEDIA_DEFAULT, PHY_MEDIA_SR, PHY_MEDIA_DAC,};
enum phy_ufs_state { PHY_UFS_HIBERN8_ENTER, PHY_UFS_HIBERN8_EXIT,};
union phy_notify { enum phy_ufs_state ufs_state;};
/** * union phy_configure_opts - Opaque generic phy configuration * * @mipi_dphy: Configuration set applicable for phys supporting * the MIPI_DPHY phy mode. * @dp: Configuration set applicable for phys supporting * the DisplayPort protocol. * @lvds: Configuration set applicable for phys supporting * the LVDS phy mode. * @hdmi: Configuration set applicable for phys supporting * the HDMI phy mode. */union phy_configure_opts { struct phy_configure_opts_mipi_dphy mipi_dphy; struct phy_configure_opts_dp dp; struct phy_configure_opts_lvds lvds; struct phy_configure_opts_hdmi hdmi;};
/** * struct phy_ops - set of function pointers for performing phy operations * @init: operation to be performed for initializing phy * @exit: operation to be performed while exiting * @power_on: powering on the phy * @power_off: powering off the phy * @set_mode: set the mode of the phy * @set_media: set the media type of the phy (optional) * @set_speed: set the speed of the phy (optional) * @reset: resetting the phy * @calibrate: calibrate the phy * @notify_phystate: notify and configure the phy for a particular state * @release: ops to be performed while the consumer relinquishes the PHY * @owner: the module owner containing the ops */struct phy_ops { int (*init)(struct phy *phy); int (*exit)(struct phy *phy); int (*power_on)(struct phy *phy); int (*power_off)(struct phy *phy); int (*set_mode)(struct phy *phy, enum phy_mode mode, int submode); int (*set_media)(struct phy *phy, enum phy_media media); int (*set_speed)(struct phy *phy, int speed);
/** * @configure: * * Optional. * * Used to change the PHY parameters. phy_init() must have * been called on the phy. * * Returns: 0 if successful, an negative error code otherwise */ int (*configure)(struct phy *phy, union phy_configure_opts *opts);
/** * @validate: * * Optional. * * Used to check that the current set of parameters can be * handled by the phy. Implementations are free to tune the * parameters passed as arguments if needed by some * implementation detail or constraints. It must not change * any actual configuration of the PHY, so calling it as many * times as deemed fit by the consumer must have no side * effect. * * Returns: 0 if the configuration can be applied, an negative * error code otherwise */ int (*validate)(struct phy *phy, enum phy_mode mode, int submode, union phy_configure_opts *opts); int (*reset)(struct phy *phy); int (*calibrate)(struct phy *phy);
/* notify phy connect status change */ int (*connect)(struct phy *phy, int port); int (*disconnect)(struct phy *phy, int port);
int (*notify_phystate)(struct phy *phy, union phy_notify state); void (*release)(struct phy *phy); struct module *owner;};
/** * struct phy_attrs - represents phy attributes * @bus_width: Data path width implemented by PHY * @max_link_rate: Maximum link rate supported by PHY (units to be decided by producer and consumer) * @mode: PHY mode */struct phy_attrs { u32 bus_width; u32 max_link_rate; enum phy_mode mode;};
/** * struct phy - represents the phy device * @dev: phy device * @id: id of the phy device * @ops: function pointers for performing phy operations * @mutex: mutex to protect phy_ops * @lockdep_key: lockdep information for this mutex * @init_count: used to protect when the PHY is used by multiple consumers * @power_count: used to protect when the PHY is used by multiple consumers * @attrs: used to specify PHY specific attributes * @pwr: power regulator associated with the phy * @debugfs: debugfs directory */struct phy { struct device dev; int id; const struct phy_ops *ops; struct mutex mutex; struct lock_class_key lockdep_key; int init_count; int power_count; struct phy_attrs attrs; struct regulator *pwr; struct dentry *debugfs;};
/** * struct phy_provider - represents the phy provider * @dev: phy provider device * @children: can be used to override the default (dev->of_node) child node * @owner: the module owner having of_xlate * @list: to maintain a linked list of PHY providers * @of_xlate: function pointer to obtain phy instance from phy pointer */struct phy_provider { struct device *dev; struct device_node *children; struct module *owner; struct list_head list; struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args);};
/** * struct phy_lookup - PHY association in list of phys managed by the phy driver * @node: list node * @dev_id: the device of the association * @con_id: connection ID string on device * @phy: the phy of the association */struct phy_lookup { struct list_head node; const char *dev_id; const char *con_id; struct phy *phy;};
#define to_phy(a) (container_of((a), struct phy, dev))
#define of_phy_provider_register(dev, xlate) \ __of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
#define devm_of_phy_provider_register(dev, xlate) \ __devm_of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
#define of_phy_provider_register_full(dev, children, xlate) \ __of_phy_provider_register(dev, children, THIS_MODULE, xlate)
#define devm_of_phy_provider_register_full(dev, children, xlate) \ __devm_of_phy_provider_register(dev, children, THIS_MODULE, xlate)
static inline void phy_set_drvdata(struct phy *phy, void *data){ dev_set_drvdata(&phy->dev, data);}
static inline void *phy_get_drvdata(struct phy *phy){ return dev_get_drvdata(&phy->dev);}
#if IS_ENABLED(CONFIG_GENERIC_PHY)int phy_pm_runtime_get(struct phy *phy);int phy_pm_runtime_get_sync(struct phy *phy);void phy_pm_runtime_put(struct phy *phy);int phy_pm_runtime_put_sync(struct phy *phy);int phy_init(struct phy *phy);int phy_exit(struct phy *phy);int phy_power_on(struct phy *phy);int phy_power_off(struct phy *phy);int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode);#define phy_set_mode(phy, mode) \ phy_set_mode_ext(phy, mode, 0)int phy_set_media(struct phy *phy, enum phy_media media);int phy_set_speed(struct phy *phy, int speed);int phy_configure(struct phy *phy, union phy_configure_opts *opts);int phy_validate(struct phy *phy, enum phy_mode mode, int submode, union phy_configure_opts *opts);
static inline enum phy_mode phy_get_mode(struct phy *phy){ return phy->attrs.mode;}int phy_reset(struct phy *phy);int phy_calibrate(struct phy *phy);int phy_notify_connect(struct phy *phy, int port);int phy_notify_disconnect(struct phy *phy, int port);int phy_notify_state(struct phy *phy, union phy_notify state);static inline int phy_get_bus_width(struct phy *phy){ return phy->attrs.bus_width;}static inline void phy_set_bus_width(struct phy *phy, int bus_width){ phy->attrs.bus_width = bus_width;}struct phy *phy_get(struct device *dev, const char *string);struct phy *devm_phy_get(struct device *dev, const char *string);struct phy *devm_phy_optional_get(struct device *dev, const char *string);struct phy *devm_of_phy_get(struct device *dev, struct device_node *np, const char *con_id);struct phy *devm_of_phy_optional_get(struct device *dev, struct device_node *np, const char *con_id);struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, int index);void of_phy_put(struct phy *phy);void phy_put(struct device *dev, struct phy *phy);void devm_phy_put(struct device *dev, struct phy *phy);struct phy *of_phy_get(struct device_node *np, const char *con_id);struct phy *of_phy_simple_xlate(struct device *dev, const struct of_phandle_args *args);struct phy *phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops);struct phy *devm_phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops);void phy_destroy(struct phy *phy);void devm_phy_destroy(struct device *dev, struct phy *phy);struct phy_provider *__of_phy_provider_register(struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args));struct phy_provider *__devm_of_phy_provider_register(struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args));void of_phy_provider_unregister(struct phy_provider *phy_provider);void devm_of_phy_provider_unregister(struct device *dev, struct phy_provider *phy_provider);int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id);void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id);#elsestatic inline int phy_pm_runtime_get(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_pm_runtime_get_sync(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline void phy_pm_runtime_put(struct phy *phy){}
static inline int phy_pm_runtime_put_sync(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_init(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_exit(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_power_on(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_power_off(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode){ if (!phy) return 0; return -ENOSYS;}
#define phy_set_mode(phy, mode) \ phy_set_mode_ext(phy, mode, 0)
static inline int phy_set_media(struct phy *phy, enum phy_media media){ if (!phy) return 0; return -ENODEV;}
static inline int phy_set_speed(struct phy *phy, int speed){ if (!phy) return 0; return -ENODEV;}
static inline enum phy_mode phy_get_mode(struct phy *phy){ return PHY_MODE_INVALID;}
static inline int phy_reset(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_calibrate(struct phy *phy){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_notify_connect(struct phy *phy, int index){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_notify_disconnect(struct phy *phy, int index){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_notify_state(struct phy *phy, union phy_notify state){ if (!phy) return 0; return -ENOSYS;}
static inline int phy_configure(struct phy *phy, union phy_configure_opts *opts){ if (!phy) return 0;
return -ENOSYS;}
static inline int phy_validate(struct phy *phy, enum phy_mode mode, int submode, union phy_configure_opts *opts){ if (!phy) return 0;
return -ENOSYS;}
static inline int phy_get_bus_width(struct phy *phy){ return -ENOSYS;}
static inline void phy_set_bus_width(struct phy *phy, int bus_width){ return;}
static inline struct phy *phy_get(struct device *dev, const char *string){ return ERR_PTR(-ENOSYS);}
static inline struct phy *devm_phy_get(struct device *dev, const char *string){ return ERR_PTR(-ENOSYS);}
static inline struct phy *devm_phy_optional_get(struct device *dev, const char *string){ return NULL;}
static inline struct phy *devm_of_phy_get(struct device *dev, struct device_node *np, const char *con_id){ return ERR_PTR(-ENOSYS);}
static inline struct phy *devm_of_phy_optional_get(struct device *dev, struct device_node *np, const char *con_id){ return NULL;}
static inline struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, int index){ return ERR_PTR(-ENOSYS);}
static inline void of_phy_put(struct phy *phy){}
static inline void phy_put(struct device *dev, struct phy *phy){}
static inline void devm_phy_put(struct device *dev, struct phy *phy){}
static inline struct phy *of_phy_get(struct device_node *np, const char *con_id){ return ERR_PTR(-ENOSYS);}
static inline struct phy *of_phy_simple_xlate(struct device *dev, const struct of_phandle_args *args){ return ERR_PTR(-ENOSYS);}
static inline struct phy *phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops){ return ERR_PTR(-ENOSYS);}
static inline struct phy *devm_phy_create(struct device *dev, struct device_node *node, const struct phy_ops *ops){ return ERR_PTR(-ENOSYS);}
static inline void phy_destroy(struct phy *phy){}
static inline void devm_phy_destroy(struct device *dev, struct phy *phy){}
static inline struct phy_provider *__of_phy_provider_register( struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args)){ return ERR_PTR(-ENOSYS);}
static inline struct phy_provider *__devm_of_phy_provider_register(struct device *dev, struct device_node *children, struct module *owner, struct phy * (*of_xlate)(struct device *dev, const struct of_phandle_args *args)){ return ERR_PTR(-ENOSYS);}
static inline void of_phy_provider_unregister(struct phy_provider *phy_provider){}
static inline void devm_of_phy_provider_unregister(struct device *dev, struct phy_provider *phy_provider){}static inline intphy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id){ return 0;}static inline void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id) { }#endif
#endif /* __DRIVERS_PHY_H */