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 #include <linux/regulator/consumer.h>
  22
  23 struct phy;
  24
  25 enum phy_mode {
  26         PHY_MODE_INVALID,
  27         PHY_MODE_USB_HOST,
  28         PHY_MODE_USB_DEVICE,
  29         PHY_MODE_USB_OTG,
  30 };
  31
  32 /**
  33  * struct phy_ops - set of function pointers for performing phy operations
  34  * @init: operation to be performed for initializing phy
  35  * @exit: operation to be performed while exiting
  36  * @power_on: powering on the phy
  37  * @power_off: powering off the phy
  38  * @set_mode: set the mode of the phy
  39  * @reset: resetting the phy
  40  * @owner: the module owner containing the ops
  41  */
  42 struct phy_ops {
  43         int     (*init)(struct phy *phy);
  44         int     (*exit)(struct phy *phy);
  45         int     (*power_on)(struct phy *phy);
  46         int     (*power_off)(struct phy *phy);
  47         int     (*set_mode)(struct phy *phy, enum phy_mode mode);
  48         int     (*reset)(struct phy *phy);
  49         struct module *owner;
  50 };
  51
  52 /**
  53  * struct phy_attrs - represents phy attributes
  54  * @bus_width: Data path width implemented by PHY
  55  */
  56 struct phy_attrs {
  57         u32                     bus_width;
  58 };
  59
  60 /**
  61  * struct phy - represents the phy device
  62  * @dev: phy device
  63  * @id: id of the phy device
  64  * @ops: function pointers for performing phy operations
  65  * @init_data: list of PHY consumers (non-dt only)
  66  * @mutex: mutex to protect phy_ops
  67  * @init_count: used to protect when the PHY is used by multiple consumers
  68  * @power_count: used to protect when the PHY is used by multiple consumers
  69  * @phy_attrs: used to specify PHY specific attributes
  70  */
  71 struct phy {
  72         struct device           dev;
  73         int                     id;
  74         const struct phy_ops    *ops;
  75         struct mutex            mutex;
  76         int                     init_count;
  77         int                     power_count;
  78         struct phy_attrs        attrs;
  79         struct regulator        *pwr;
  80 };
  81
  82 /**
  83  * struct phy_provider - represents the phy provider
  84  * @dev: phy provider device
  85  * @owner: the module owner having of_xlate
  86  * @of_xlate: function pointer to obtain phy instance from phy pointer
  87  * @list: to maintain a linked list of PHY providers
  88  */
  89 struct phy_provider {
  90         struct device           *dev;
  91         struct device_node      *children;
  92         struct module           *owner;
  93         struct list_head        list;
  94         struct phy * (*of_xlate)(struct device *dev,
  95                 struct of_phandle_args *args);
  96 };
  97
  98 struct phy_lookup {
  99         struct list_head node;
 100         const char *dev_id;
 101         const char *con_id;
 102         struct phy *phy;
 103 };
 104
 105 #define to_phy(a)       (container_of((a), struct phy, dev))
 106
 107 #define of_phy_provider_register(dev, xlate)    \
 108         __of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
 109
 110 #define devm_of_phy_provider_register(dev, xlate)       \
 111         __devm_of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate))
 112
 113 #define of_phy_provider_register_full(dev, children, xlate) \
 114         __of_phy_provider_register(dev, children, THIS_MODULE, xlate)
 115
 116 #define devm_of_phy_provider_register_full(dev, children, xlate) \
 117         __devm_of_phy_provider_register(dev, children, 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 int phy_set_mode(struct phy *phy, enum phy_mode mode);
 141 int phy_reset(struct phy *phy);
 142 static inline int phy_get_bus_width(struct phy *phy)
 143 {
 144         return phy->attrs.bus_width;
 145 }
 146 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
 147 {
 148         phy->attrs.bus_width = bus_width;
 149 }
 150 struct phy *phy_get(struct device *dev, const char *string);
 151 struct phy *phy_optional_get(struct device *dev, const char *string);
 152 struct phy *devm_phy_get(struct device *dev, const char *string);
 153 struct phy *devm_phy_optional_get(struct device *dev, const char *string);
 154 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np,
 155                             const char *con_id);
 156 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np,
 157                                      int index);
 158 void phy_put(struct phy *phy);
 159 void devm_phy_put(struct device *dev, struct phy *phy);
 160 struct phy *of_phy_get(struct device_node *np, const char *con_id);
 161 struct phy *of_phy_simple_xlate(struct device *dev,
 162         struct of_phandle_args *args);
 163 struct phy *phy_create(struct device *dev, struct device_node *node,
 164                        const struct phy_ops *ops);
 165 struct phy *devm_phy_create(struct device *dev, struct device_node *node,
 166                             const struct phy_ops *ops);
 167 void phy_destroy(struct phy *phy);
 168 void devm_phy_destroy(struct device *dev, struct phy *phy);
 169 struct phy_provider *__of_phy_provider_register(struct device *dev,
 170         struct device_node *children, struct module *owner,
 171         struct phy * (*of_xlate)(struct device *dev,
 172                                  struct of_phandle_args *args));
 173 struct phy_provider *__devm_of_phy_provider_register(struct device *dev,
 174         struct device_node *children, struct module *owner,
 175         struct phy * (*of_xlate)(struct device *dev,
 176                                  struct of_phandle_args *args));
 177 void of_phy_provider_unregister(struct phy_provider *phy_provider);
 178 void devm_of_phy_provider_unregister(struct device *dev,
 179         struct phy_provider *phy_provider);
 180 int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id);
 181 void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id);
 182 #else
 183 static inline int phy_pm_runtime_get(struct phy *phy)
 184 {
 185         if (!phy)
 186                 return 0;
 187         return -ENOSYS;
 188 }
 189
 190 static inline int phy_pm_runtime_get_sync(struct phy *phy)
 191 {
 192         if (!phy)
 193                 return 0;
 194         return -ENOSYS;
 195 }
 196
 197 static inline int phy_pm_runtime_put(struct phy *phy)
 198 {
 199         if (!phy)
 200                 return 0;
 201         return -ENOSYS;
 202 }
 203
 204 static inline int phy_pm_runtime_put_sync(struct phy *phy)
 205 {
 206         if (!phy)
 207                 return 0;
 208         return -ENOSYS;
 209 }
 210
 211 static inline void phy_pm_runtime_allow(struct phy *phy)
 212 {
 213         return;
 214 }
 215
 216 static inline void phy_pm_runtime_forbid(struct phy *phy)
 217 {
 218         return;
 219 }
 220
 221 static inline int phy_init(struct phy *phy)
 222 {
 223         if (!phy)
 224                 return 0;
 225         return -ENOSYS;
 226 }
 227
 228 static inline int phy_exit(struct phy *phy)
 229 {
 230         if (!phy)
 231                 return 0;
 232         return -ENOSYS;
 233 }
 234
 235 static inline int phy_power_on(struct phy *phy)
 236 {
 237         if (!phy)
 238                 return 0;
 239         return -ENOSYS;
 240 }
 241
 242 static inline int phy_power_off(struct phy *phy)
 243 {
 244         if (!phy)
 245                 return 0;
 246         return -ENOSYS;
 247 }
 248
 249 static inline int phy_set_mode(struct phy *phy, enum phy_mode mode)
 250 {
 251         if (!phy)
 252                 return 0;
 253         return -ENOSYS;
 254 }
 255
 256 static inline int phy_get_bus_width(struct phy *phy)
 257 {
 258         return -ENOSYS;
 259 }
 260
 261 static inline void phy_set_bus_width(struct phy *phy, int bus_width)
 262 {
 263         return;
 264 }
 265
 266 static inline struct phy *phy_get(struct device *dev, const char *string)
 267 {
 268         return ERR_PTR(-ENOSYS);
 269 }
 270
 271 static inline struct phy *phy_optional_get(struct device *dev,
 272                                            const char *string)
 273 {
 274         return ERR_PTR(-ENOSYS);
 275 }
 276
 277 static inline struct phy *devm_phy_get(struct device *dev, const char *string)
 278 {
 279         return ERR_PTR(-ENOSYS);
 280 }
 281
 282 static inline struct phy *devm_phy_optional_get(struct device *dev,
 283                                                 const char *string)
 284 {
 285         return ERR_PTR(-ENOSYS);
 286 }
 287
 288 static inline struct phy *devm_of_phy_get(struct device *dev,
 289                                           struct device_node *np,
 290                                           const char *con_id)
 291 {
 292         return ERR_PTR(-ENOSYS);
 293 }
 294
 295 static inline struct phy *devm_of_phy_get_by_index(struct device *dev,
 296                                                    struct device_node *np,
 297                                                    int index)
 298 {
 299         return ERR_PTR(-ENOSYS);
 300 }
 301
 302 static inline void phy_put(struct phy *phy)
 303 {
 304 }
 305
 306 static inline void devm_phy_put(struct device *dev, struct phy *phy)
 307 {
 308 }
 309
 310 static inline struct phy *of_phy_get(struct device_node *np, const char *con_id)
 311 {
 312         return ERR_PTR(-ENOSYS);
 313 }
 314
 315 static inline struct phy *of_phy_simple_xlate(struct device *dev,
 316         struct of_phandle_args *args)
 317 {
 318         return ERR_PTR(-ENOSYS);
 319 }
 320
 321 static inline struct phy *phy_create(struct device *dev,
 322                                      struct device_node *node,
 323                                      const struct phy_ops *ops)
 324 {
 325         return ERR_PTR(-ENOSYS);
 326 }
 327
 328 static inline struct phy *devm_phy_create(struct device *dev,
 329                                           struct device_node *node,
 330                                           const struct phy_ops *ops)
 331 {
 332         return ERR_PTR(-ENOSYS);
 333 }
 334
 335 static inline void phy_destroy(struct phy *phy)
 336 {
 337 }
 338
 339 static inline void devm_phy_destroy(struct device *dev, struct phy *phy)
 340 {
 341 }
 342
 343 static inline struct phy_provider *__of_phy_provider_register(
 344         struct device *dev, struct device_node *children, struct module *owner,
 345         struct phy * (*of_xlate)(struct device *dev,
 346                                  struct of_phandle_args *args))
 347 {
 348         return ERR_PTR(-ENOSYS);
 349 }
 350
 351 static inline struct phy_provider *__devm_of_phy_provider_register(struct device
 352         *dev, struct device_node *children, struct module *owner,
 353         struct phy * (*of_xlate)(struct device *dev,
 354                                  struct of_phandle_args *args))
 355 {
 356         return ERR_PTR(-ENOSYS);
 357 }
 358
 359 static inline void of_phy_provider_unregister(struct phy_provider *phy_provider)
 360 {
 361 }
 362
 363 static inline void devm_of_phy_provider_unregister(struct device *dev,
 364         struct phy_provider *phy_provider)
 365 {
 366 }
 367 static inline int
 368 phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id)
 369 {
 370         return 0;
 371 }
 372 static inline void phy_remove_lookup(struct phy *phy, const char *con_id,
 373                                      const char *dev_id) { }
 374 #endif
 375
 376 #endif /* __DRIVERS_PHY_H */