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 *phy_optional_get(struct device *dev, const char *string);
 150 struct phy *devm_phy_get(struct device *dev, const char *string);
 151 struct phy *devm_phy_optional_get(struct device *dev, const char *string);
 152 void phy_put(struct phy *phy);
 153 void devm_phy_put(struct device *dev, struct phy *phy);
 154 struct phy *of_phy_simple_xlate(struct device *dev,
 155         struct of_phandle_args *args);
 156 struct phy *phy_create(struct device *dev, struct device_node *node,
 157                        const struct phy_ops *ops,
 158                        struct phy_init_data *init_data);
 159 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
 160         const struct phy_ops *ops, struct phy_init_data *init_data);
 161 void phy_destroy(struct phy *phy);
 162 void devm_phy_destroy(struct device *dev, struct phy *phy);
 163 struct phy_provider *__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 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 167         struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 168         struct of_phandle_args *args));
 169 void of_phy_provider_unregister(struct phy_provider *phy_provider);
 170 void devm_of_phy_provider_unregister(struct device *dev,
 171         struct phy_provider *phy_provider);
 172 #else
 173 static inline int phy_pm_runtime_get(struct phy *phy)
 174 {
 175         return -ENOSYS;
 176 }
 177
 178 static inline int phy_pm_runtime_get_sync(struct phy *phy)
 179 {
 180         return -ENOSYS;
 181 }
 182
 183 static inline int phy_pm_runtime_put(struct phy *phy)
 184 {
 185         return -ENOSYS;
 186 }
 187
 188 static inline int phy_pm_runtime_put_sync(struct phy *phy)
 189 {
 190         return -ENOSYS;
 191 }
 192
 193 static inline void phy_pm_runtime_allow(struct phy *phy)
 194 {
 195         return;
 196 }
 197
 198 static inline void phy_pm_runtime_forbid(struct phy *phy)
 199 {
 200         return;
 201 }
 202
 203 static inline int phy_init(struct phy *phy)
 204 {
 205         return -ENOSYS;
 206 }
 207
 208 static inline int phy_exit(struct phy *phy)
 209 {
 210         return -ENOSYS;
 211 }
 212
 213 static inline int phy_power_on(struct phy *phy)
 214 {
 215         return -ENOSYS;
 216 }
 217
 218 static inline int phy_power_off(struct phy *phy)
 219 {
 220         return -ENOSYS;
 221 }
 222
 223 static inline int phy_get_bus_width(struct phy *phy)
 224 {
 225         return -ENOSYS;
 226 }
 227
 228 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
 229 {
 230         return;
 231 }
 232
 233 static inline struct phy *phy_get(struct device *dev, const char *string)
 234 {
 235         return ERR_PTR(-ENOSYS);
 236 }
 237
 238 static inline struct phy *phy_optional_get(struct device *dev,
 239                                            const char *string)
 240 {
 241         return ERR_PTR(-ENOSYS);
 242 }
 243
 244 static inline struct phy *devm_phy_get(struct device *dev, const char *string)
 245 {
 246         return ERR_PTR(-ENOSYS);
 247 }
 248
 249 static inline struct phy *devm_phy_optional_get(struct device *dev,
 250                                                 const char *string)
 251 {
 252         return ERR_PTR(-ENOSYS);
 253 }
 254
 255 static inline void phy_put(struct phy *phy)
 256 {
 257 }
 258
 259 static inline void devm_phy_put(struct device *dev, struct phy *phy)
 260 {
 261 }
 262
 263 static inline struct phy *of_phy_simple_xlate(struct device *dev,
 264         struct of_phandle_args *args)
 265 {
 266         return ERR_PTR(-ENOSYS);
 267 }
 268
 269 static inline struct phy *phy_create(struct device *dev,
 270                                      struct device_node *node,
 271                                      const struct phy_ops *ops,
 272                                      struct phy_init_data *init_data)
 273 {
 274         return ERR_PTR(-ENOSYS);
 275 }
 276
 277 static inline struct phy *devm_phy_create(struct device *dev,
 278                                           struct device_node *node,
 279                                           const struct phy_ops *ops,
 280                                           struct phy_init_data *init_data)
 281 {
 282         return ERR_PTR(-ENOSYS);
 283 }
 284
 285 static inline void phy_destroy(struct phy *phy)
 286 {
 287 }
 288
 289 static inline void devm_phy_destroy(struct device *dev, struct phy *phy)
 290 {
 291 }
 292
 293 static inline struct phy_provider *__of_phy_provider_register(
 294         struct device *dev, struct module *owner, struct phy * (*of_xlate)(
 295         struct device *dev, struct of_phandle_args *args))
 296 {
 297         return ERR_PTR(-ENOSYS);
 298 }
 299
 300 static inline struct phy_provider *__devm_of_phy_provider_register(struct device
 301         *dev, struct module *owner, struct phy * (*of_xlate)(struct device *dev,
 302         struct of_phandle_args *args))
 303 {
 304         return ERR_PTR(-ENOSYS);
 305 }
 306
 307 static inline void of_phy_provider_unregister(struct phy_provider *phy_provider)
 308 {
 309 }
 310
 311 static inline void devm_of_phy_provider_unregister(struct device *dev,
 312         struct phy_provider *phy_provider)
 313 {
 314 }
 315 #endif
 316
 317 #endif /* __DRIVERS_PHY_H */