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 <[email protected]> 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_HOST_LS, 29 PHY_MODE_USB_HOST_FS, 30 PHY_MODE_USB_HOST_HS, 31 PHY_MODE_USB_HOST_SS, 32 PHY_MODE_USB_DEVICE, 33 PHY_MODE_USB_DEVICE_LS, 34 PHY_MODE_USB_DEVICE_FS, 35 PHY_MODE_USB_DEVICE_HS, 36 PHY_MODE_USB_DEVICE_SS, 37 PHY_MODE_USB_OTG, 38 PHY_MODE_UFS_HS_A, 39 PHY_MODE_UFS_HS_B, 40 PHY_MODE_PCIE, 41 PHY_MODE_ETHERNET, 42 }; 43 44 /** 45 * struct phy_ops - set of function pointers for performing phy operations 46 * @init: operation to be performed for initializing phy 47 * @exit: operation to be performed while exiting 48 * @power_on: powering on the phy 49 * @power_off: powering off the phy 50 * @set_mode: set the mode of the phy 51 * @reset: resetting the phy 52 * @calibrate: calibrate the phy 53 * @owner: the module owner containing the ops 54 */ 55 struct phy_ops { 56 int (*init)(struct phy *phy); 57 int (*exit)(struct phy *phy); 58 int (*power_on)(struct phy *phy); 59 int (*power_off)(struct phy *phy); 60 int (*set_mode)(struct phy *phy, enum phy_mode mode, int submode); 61 int (*reset)(struct phy *phy); 62 int (*calibrate)(struct phy *phy); 63 struct module *owner; 64 }; 65 66 /** 67 * struct phy_attrs - represents phy attributes 68 * @bus_width: Data path width implemented by PHY 69 */ 70 struct phy_attrs { 71 u32 bus_width; 72 enum phy_mode mode; 73 }; 74 75 /** 76 * struct phy - represents the phy device 77 * @dev: phy device 78 * @id: id of the phy device 79 * @ops: function pointers for performing phy operations 80 * @init_data: list of PHY consumers (non-dt only) 81 * @mutex: mutex to protect phy_ops 82 * @init_count: used to protect when the PHY is used by multiple consumers 83 * @power_count: used to protect when the PHY is used by multiple consumers 84 * @attrs: used to specify PHY specific attributes 85 * @pwr: power regulator associated with the phy 86 */ 87 struct phy { 88 struct device dev; 89 int id; 90 const struct phy_ops *ops; 91 struct mutex mutex; 92 int init_count; 93 int power_count; 94 struct phy_attrs attrs; 95 struct regulator *pwr; 96 }; 97 98 /** 99 * struct phy_provider - represents the phy provider 100 * @dev: phy provider device 101 * @children: can be used to override the default (dev->of_node) child node 102 * @owner: the module owner having of_xlate 103 * @list: to maintain a linked list of PHY providers 104 * @of_xlate: function pointer to obtain phy instance from phy pointer 105 */ 106 struct phy_provider { 107 struct device *dev; 108 struct device_node *children; 109 struct module *owner; 110 struct list_head list; 111 struct phy * (*of_xlate)(struct device *dev, 112 struct of_phandle_args *args); 113 }; 114 115 /** 116 * struct phy_lookup - PHY association in list of phys managed by the phy driver 117 * @node: list node 118 * @dev_id: the device of the association 119 * @con_id: connection ID string on device 120 * @phy: the phy of the association 121 */ 122 struct phy_lookup { 123 struct list_head node; 124 const char *dev_id; 125 const char *con_id; 126 struct phy *phy; 127 }; 128 129 #define to_phy(a) (container_of((a), struct phy, dev)) 130 131 #define of_phy_provider_register(dev, xlate) \ 132 __of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate)) 133 134 #define devm_of_phy_provider_register(dev, xlate) \ 135 __devm_of_phy_provider_register((dev), NULL, THIS_MODULE, (xlate)) 136 137 #define of_phy_provider_register_full(dev, children, xlate) \ 138 __of_phy_provider_register(dev, children, THIS_MODULE, xlate) 139 140 #define devm_of_phy_provider_register_full(dev, children, xlate) \ 141 __devm_of_phy_provider_register(dev, children, THIS_MODULE, xlate) 142 143 static inline void phy_set_drvdata(struct phy *phy, void *data) 144 { 145 dev_set_drvdata(&phy->dev, data); 146 } 147 148 static inline void *phy_get_drvdata(struct phy *phy) 149 { 150 return dev_get_drvdata(&phy->dev); 151 } 152 153 #if IS_ENABLED(CONFIG_GENERIC_PHY) 154 int phy_pm_runtime_get(struct phy *phy); 155 int phy_pm_runtime_get_sync(struct phy *phy); 156 int phy_pm_runtime_put(struct phy *phy); 157 int phy_pm_runtime_put_sync(struct phy *phy); 158 void phy_pm_runtime_allow(struct phy *phy); 159 void phy_pm_runtime_forbid(struct phy *phy); 160 int phy_init(struct phy *phy); 161 int phy_exit(struct phy *phy); 162 int phy_power_on(struct phy *phy); 163 int phy_power_off(struct phy *phy); 164 int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, int submode); 165 #define phy_set_mode(phy, mode) \ 166 phy_set_mode_ext(phy, mode, 0) 167 168 static inline enum phy_mode phy_get_mode(struct phy *phy) 169 { 170 return phy->attrs.mode; 171 } 172 int phy_reset(struct phy *phy); 173 int phy_calibrate(struct phy *phy); 174 static inline int phy_get_bus_width(struct phy *phy) 175 { 176 return phy->attrs.bus_width; 177 } 178 static inline void phy_set_bus_width(struct phy *phy, int bus_width) 179 { 180 phy->attrs.bus_width = bus_width; 181 } 182 struct phy *phy_get(struct device *dev, const char *string); 183 struct phy *phy_optional_get(struct device *dev, const char *string); 184 struct phy *devm_phy_get(struct device *dev, const char *string); 185 struct phy *devm_phy_optional_get(struct device *dev, const char *string); 186 struct phy *devm_of_phy_get(struct device *dev, struct device_node *np, 187 const char *con_id); 188 struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, 189 int index); 190 void phy_put(struct phy *phy); 191 void devm_phy_put(struct device *dev, struct phy *phy); 192 struct phy *of_phy_get(struct device_node *np, const char *con_id); 193 struct phy *of_phy_simple_xlate(struct device *dev, 194 struct of_phandle_args *args); 195 struct phy *phy_create(struct device *dev, struct device_node *node, 196 const struct phy_ops *ops); 197 struct phy *devm_phy_create(struct device *dev, struct device_node *node, 198 const struct phy_ops *ops); 199 void phy_destroy(struct phy *phy); 200 void devm_phy_destroy(struct device *dev, struct phy *phy); 201 struct phy_provider *__of_phy_provider_register(struct device *dev, 202 struct device_node *children, struct module *owner, 203 struct phy * (*of_xlate)(struct device *dev, 204 struct of_phandle_args *args)); 205 struct phy_provider *__devm_of_phy_provider_register(struct device *dev, 206 struct device_node *children, struct module *owner, 207 struct phy * (*of_xlate)(struct device *dev, 208 struct of_phandle_args *args)); 209 void of_phy_provider_unregister(struct phy_provider *phy_provider); 210 void devm_of_phy_provider_unregister(struct device *dev, 211 struct phy_provider *phy_provider); 212 int phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id); 213 void phy_remove_lookup(struct phy *phy, const char *con_id, const char *dev_id); 214 #else 215 static inline int phy_pm_runtime_get(struct phy *phy) 216 { 217 if (!phy) 218 return 0; 219 return -ENOSYS; 220 } 221 222 static inline int phy_pm_runtime_get_sync(struct phy *phy) 223 { 224 if (!phy) 225 return 0; 226 return -ENOSYS; 227 } 228 229 static inline int phy_pm_runtime_put(struct phy *phy) 230 { 231 if (!phy) 232 return 0; 233 return -ENOSYS; 234 } 235 236 static inline int phy_pm_runtime_put_sync(struct phy *phy) 237 { 238 if (!phy) 239 return 0; 240 return -ENOSYS; 241 } 242 243 static inline void phy_pm_runtime_allow(struct phy *phy) 244 { 245 return; 246 } 247 248 static inline void phy_pm_runtime_forbid(struct phy *phy) 249 { 250 return; 251 } 252 253 static inline int phy_init(struct phy *phy) 254 { 255 if (!phy) 256 return 0; 257 return -ENOSYS; 258 } 259 260 static inline int phy_exit(struct phy *phy) 261 { 262 if (!phy) 263 return 0; 264 return -ENOSYS; 265 } 266 267 static inline int phy_power_on(struct phy *phy) 268 { 269 if (!phy) 270 return 0; 271 return -ENOSYS; 272 } 273 274 static inline int phy_power_off(struct phy *phy) 275 { 276 if (!phy) 277 return 0; 278 return -ENOSYS; 279 } 280 281 static inline int phy_set_mode_ext(struct phy *phy, enum phy_mode mode, 282 int submode) 283 { 284 if (!phy) 285 return 0; 286 return -ENOSYS; 287 } 288 289 #define phy_set_mode(phy, mode) \ 290 phy_set_mode_ext(phy, mode, 0) 291 292 static inline enum phy_mode phy_get_mode(struct phy *phy) 293 { 294 return PHY_MODE_INVALID; 295 } 296 297 static inline int phy_reset(struct phy *phy) 298 { 299 if (!phy) 300 return 0; 301 return -ENOSYS; 302 } 303 304 static inline int phy_calibrate(struct phy *phy) 305 { 306 if (!phy) 307 return 0; 308 return -ENOSYS; 309 } 310 311 static inline int phy_get_bus_width(struct phy *phy) 312 { 313 return -ENOSYS; 314 } 315 316 static inline void phy_set_bus_width(struct phy *phy, int bus_width) 317 { 318 return; 319 } 320 321 static inline struct phy *phy_get(struct device *dev, const char *string) 322 { 323 return ERR_PTR(-ENOSYS); 324 } 325 326 static inline struct phy *phy_optional_get(struct device *dev, 327 const char *string) 328 { 329 return ERR_PTR(-ENOSYS); 330 } 331 332 static inline struct phy *devm_phy_get(struct device *dev, const char *string) 333 { 334 return ERR_PTR(-ENOSYS); 335 } 336 337 static inline struct phy *devm_phy_optional_get(struct device *dev, 338 const char *string) 339 { 340 return NULL; 341 } 342 343 static inline struct phy *devm_of_phy_get(struct device *dev, 344 struct device_node *np, 345 const char *con_id) 346 { 347 return ERR_PTR(-ENOSYS); 348 } 349 350 static inline struct phy *devm_of_phy_get_by_index(struct device *dev, 351 struct device_node *np, 352 int index) 353 { 354 return ERR_PTR(-ENOSYS); 355 } 356 357 static inline void phy_put(struct phy *phy) 358 { 359 } 360 361 static inline void devm_phy_put(struct device *dev, struct phy *phy) 362 { 363 } 364 365 static inline struct phy *of_phy_get(struct device_node *np, const char *con_id) 366 { 367 return ERR_PTR(-ENOSYS); 368 } 369 370 static inline struct phy *of_phy_simple_xlate(struct device *dev, 371 struct of_phandle_args *args) 372 { 373 return ERR_PTR(-ENOSYS); 374 } 375 376 static inline struct phy *phy_create(struct device *dev, 377 struct device_node *node, 378 const struct phy_ops *ops) 379 { 380 return ERR_PTR(-ENOSYS); 381 } 382 383 static inline struct phy *devm_phy_create(struct device *dev, 384 struct device_node *node, 385 const struct phy_ops *ops) 386 { 387 return ERR_PTR(-ENOSYS); 388 } 389 390 static inline void phy_destroy(struct phy *phy) 391 { 392 } 393 394 static inline void devm_phy_destroy(struct device *dev, struct phy *phy) 395 { 396 } 397 398 static inline struct phy_provider *__of_phy_provider_register( 399 struct device *dev, struct device_node *children, struct module *owner, 400 struct phy * (*of_xlate)(struct device *dev, 401 struct of_phandle_args *args)) 402 { 403 return ERR_PTR(-ENOSYS); 404 } 405 406 static inline struct phy_provider *__devm_of_phy_provider_register(struct device 407 *dev, struct device_node *children, struct module *owner, 408 struct phy * (*of_xlate)(struct device *dev, 409 struct of_phandle_args *args)) 410 { 411 return ERR_PTR(-ENOSYS); 412 } 413 414 static inline void of_phy_provider_unregister(struct phy_provider *phy_provider) 415 { 416 } 417 418 static inline void devm_of_phy_provider_unregister(struct device *dev, 419 struct phy_provider *phy_provider) 420 { 421 } 422 static inline int 423 phy_create_lookup(struct phy *phy, const char *con_id, const char *dev_id) 424 { 425 return 0; 426 } 427 static inline void phy_remove_lookup(struct phy *phy, const char *con_id, 428 const char *dev_id) { } 429 #endif 430 431 #endif /* __DRIVERS_PHY_H */ 432