include/linux/phy/phy.h

   1 /*
   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>
  21
  22 struct phy;
  23
  24 /**
  25  * struct phy_ops - set of function pointers for performing phy operations
  26  * @init: operation to be performed for initializing phy
  27  * @exit: operation to be performed while exiting
  28  * @power_on: powering on the phy
  29  * @power_off: powering off the phy
  30  * @owner: the module owner containing the ops
  31  */
  32 struct phy_ops {
  33         int     (*init)(struct phy *phy);
  34         int     (*exit)(struct phy *phy);
  35         int     (*power_on)(struct phy *phy);
  36         int     (*power_off)(struct phy *phy);
  37         struct module *owner;
  38 };
  39
  40 /**
  41  * struct phy_attrs - represents phy attributes
  42  * @bus_width: Data path width implemented by PHY
  43  */
  44 struct phy_attrs {
  45         u32                     bus_width;
  46 };
  47
  48 /**
  49  * struct phy - represents the phy device
  50  * @dev: phy device
  51  * @id: id of the phy device
  52  * @ops: function pointers for performing phy operations
  53  * @init_data: list of PHY consumers (non-dt only)
  54  * @mutex: mutex to protect phy_ops
  55  * @init_count: used to protect when the PHY is used by multiple consumers
  56  * @power_count: used to protect when the PHY is used by multiple consumers
  57  * @phy_attrs: used to specify PHY specific attributes
  58  */
  59 struct phy {
  60         struct device           dev;
  61         int                     id;
  62         const struct phy_ops    *ops;
  63         struct phy_init_data    *init_data;
  64         struct mutex            mutex;
  65         int                     init_count;
  66         int                     power_count;
  67         struct phy_attrs        attrs;
  68 };
  69
  70 /**
  71  * struct phy_provider - represents the phy provider
  72  * @dev: phy provider device
  73  * @owner: the module owner having of_xlate
  74  * @of_xlate: function pointer to obtain phy instance from phy pointer
  75  * @list: to maintain a linked list of PHY providers
  76  */
  77 struct phy_provider {
  78         struct device           *dev;
  79         struct module           *owner;
  80         struct list_head        list;
  81         struct phy * (*of_xlate)(struct device *dev,
  82                 struct of_phandle_args *args);
  83 };
  84
  85 /**
  86  * struct phy_consumer - represents the phy consumer
  87  * @dev_name: the device name of the controller that will use this PHY device
  88  * @port: name given to the consumer port
  89  */
  90 struct phy_consumer {
  91         const char *dev_name;
  92         const char *port;
  93 };
  94
  95 /**
  96  * struct phy_init_data - contains the list of PHY consumers
  97  * @num_consumers: number of consumers for this PHY device
  98  * @consumers: list of PHY consumers
  99  */
 100 struct phy_init_data {
 101         unsigned int num_consumers;
 102         struct phy_consumer *consumers;
 103 };
 104
 105 #define PHY_CONSUMER(_dev_name, _port)                          \
 106 {                                                               \
 107         .dev_name       = _dev_name,                            \
 108         .port           = _port,                                \
 109 }
 110
 111 #define to_phy(dev)     (container_of((dev), struct phy, dev))
 112
 113 #define of_phy_provider_register(dev, xlate)    \
 114         __of_phy_provider_register((dev), THIS_MODULE, (xlate))
 115
 116 #define devm_of_phy_provider_register(dev, xlate)       \
 117         __devm_of_phy_provider_register((dev), THIS_MODULE, (xlate))
 118
 119 static inline void phy_set_drvdata(struct phy *phy, void *data)
 120 {
 121         dev_set_drvdata(&phy->dev, data);
 122 }
 123
 124 static inline void *phy_get_drvdata(struct phy *phy)
 125 {
 126         return dev_get_drvdata(&phy->dev);
 127 }
 128
 129 #if IS_ENABLED(CONFIG_GENERIC_PHY)
 130 int phy_pm_runtime_get(struct phy *phy);
 131 int phy_pm_runtime_get_sync(struct phy *phy);
 132 int phy_pm_runtime_put(struct phy *phy);
 133 int phy_pm_runtime_put_sync(struct phy *phy);
 134 void phy_pm_runtime_allow(struct phy *phy);
 135 void phy_pm_runtime_forbid(struct phy *phy);
 136 int phy_init(struct phy *phy);
 137 int phy_exit(struct phy *phy);
 138 int phy_power_on(struct phy *phy);
 139 int phy_power_off(struct phy *phy);
 140 static inline int phy_get_bus_width(struct phy *phy)
 141 {
 142         return phy->attrs.bus_width;
 143 }
 144 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
 145 {
 146         phy->attrs.bus_width = bus_width;
 147 }
 148 struct phy *phy_get(struct device *dev, const char *string);
 149 struct phy *devm_phy_get(struct device *dev, const char *string);
 150 void phy_put(struct phy *phy);
 151 void devm_phy_put(struct device *dev, struct phy *phy);
 152 struct phy *of_phy_simple_xlate(struct device *dev,
 153         struct of_phandle_args *args);
 154 struct phy *phy_create(struct device *dev, const struct phy_ops *ops,
 155         struct phy_init_data *init_data);
 156 struct phy *devm_phy_create(struct device *dev,
 157         const struct phy_ops *ops, struct phy_init_data *init_data);
 158 void phy_destroy(struct phy *phy);
 159 void devm_phy_destroy(struct device *dev, struct phy *phy);
 160 struct phy_provider *__of_phy_provider_register(struct device *dev,
 161         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 162         struct of_phandle_args *args));
 163 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 164         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 165         struct of_phandle_args *args));
 166 void of_phy_provider_unregister(struct phy_provider *phy_provider);
 167 void devm_of_phy_provider_unregister(struct device *dev,
 168         struct phy_provider *phy_provider);
 169 #else
 170 static inline int phy_pm_runtime_get(struct phy *phy)
 171 {
 172         return -ENOSYS;
 173 }
 174
 175 static inline int phy_pm_runtime_get_sync(struct phy *phy)
 176 {
 177         return -ENOSYS;
 178 }
 179
 180 static inline int phy_pm_runtime_put(struct phy *phy)
 181 {
 182         return -ENOSYS;
 183 }
 184
 185 static inline int phy_pm_runtime_put_sync(struct phy *phy)
 186 {
 187         return -ENOSYS;
 188 }
 189
 190 static inline void phy_pm_runtime_allow(struct phy *phy)
 191 {
 192         return;
 193 }
 194
 195 static inline void phy_pm_runtime_forbid(struct phy *phy)
 196 {
 197         return;
 198 }
 199
 200 static inline int phy_init(struct phy *phy)
 201 {
 202         return -ENOSYS;
 203 }
 204
 205 static inline int phy_exit(struct phy *phy)
 206 {
 207         return -ENOSYS;
 208 }
 209
 210 static inline int phy_power_on(struct phy *phy)
 211 {
 212         return -ENOSYS;
 213 }
 214
 215 static inline int phy_power_off(struct phy *phy)
 216 {
 217         return -ENOSYS;
 218 }
 219
 220 static inline int phy_get_bus_width(struct phy *phy)
 221 {
 222         return -ENOSYS;
 223 }
 224
 225 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
 226 {
 227         return;
 228 }
 229
 230 static inline struct phy *phy_get(struct device *dev, const char *string)
 231 {
 232         return ERR_PTR(-ENOSYS);
 233 }
 234
 235 static inline struct phy *devm_phy_get(struct device *dev, const char *string)
 236 {
 237         return ERR_PTR(-ENOSYS);
 238 }
 239
 240 static inline void phy_put(struct phy *phy)
 241 {
 242 }
 243
 244 static inline void devm_phy_put(struct device *dev, struct phy *phy)
 245 {
 246 }
 247
 248 static inline struct phy *of_phy_simple_xlate(struct device *dev,
 249         struct of_phandle_args *args)
 250 {
 251         return ERR_PTR(-ENOSYS);
 252 }
 253
 254 static inline struct phy *phy_create(struct device *dev,
 255         const struct phy_ops *ops, struct phy_init_data *init_data)
 256 {
 257         return ERR_PTR(-ENOSYS);
 258 }
 259
 260 static inline struct phy *devm_phy_create(struct device *dev,
 261         const struct phy_ops *ops, struct phy_init_data *init_data)
 262 {
 263         return ERR_PTR(-ENOSYS);
 264 }
 265
 266 static inline void phy_destroy(struct phy *phy)
 267 {
 268 }
 269
 270 static inline void devm_phy_destroy(struct device *dev, struct phy *phy)
 271 {
 272 }
 273
 274 static inline struct phy_provider *__of_phy_provider_register(
 275         struct device *dev, struct module *owner, struct phy * (*of_xlate)(
 276         struct device *dev, struct of_phandle_args *args))
 277 {
 278         return ERR_PTR(-ENOSYS);
 279 }
 280
 281 static inline struct phy_provider *__devm_of_phy_provider_register(struct device
 282         *dev, struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 283         struct of_phandle_args *args))
 284 {
 285         return ERR_PTR(-ENOSYS);
 286 }
 287
 288 static inline void of_phy_provider_unregister(struct phy_provider *phy_provider)
 289 {
 290 }
 291
 292 static inline void devm_of_phy_provider_unregister(struct device *dev,
 293         struct phy_provider *phy_provider)
 294 {
 295 }
 296 #endif
 297
 298 #endif /* __DRIVERS_PHY_H */