diff options
Diffstat (limited to 'Documentation/phy.txt')
-rw-r--r-- | Documentation/phy.txt | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/phy.txt b/Documentation/phy.txt index 371361c69a4b..b388c5af9e72 100644 --- a/Documentation/phy.txt +++ b/Documentation/phy.txt | |||
@@ -76,6 +76,8 @@ struct phy *phy_get(struct device *dev, const char *string); | |||
76 | struct phy *phy_optional_get(struct device *dev, const char *string); | 76 | struct phy *phy_optional_get(struct device *dev, const char *string); |
77 | struct phy *devm_phy_get(struct device *dev, const char *string); | 77 | struct phy *devm_phy_get(struct device *dev, const char *string); |
78 | struct phy *devm_phy_optional_get(struct device *dev, const char *string); | 78 | struct phy *devm_phy_optional_get(struct device *dev, const char *string); |
79 | struct phy *devm_of_phy_get_by_index(struct device *dev, struct device_node *np, | ||
80 | int index); | ||
79 | 81 | ||
80 | phy_get, phy_optional_get, devm_phy_get and devm_phy_optional_get can | 82 | phy_get, phy_optional_get, devm_phy_get and devm_phy_optional_get can |
81 | be used to get the PHY. In the case of dt boot, the string arguments | 83 | be used to get the PHY. In the case of dt boot, the string arguments |
@@ -86,7 +88,10 @@ successful PHY get. On driver detach, release function is invoked on | |||
86 | the the devres data and devres data is freed. phy_optional_get and | 88 | the the devres data and devres data is freed. phy_optional_get and |
87 | devm_phy_optional_get should be used when the phy is optional. These | 89 | devm_phy_optional_get should be used when the phy is optional. These |
88 | two functions will never return -ENODEV, but instead returns NULL when | 90 | two functions will never return -ENODEV, but instead returns NULL when |
89 | the phy cannot be found. | 91 | the phy cannot be found.Some generic drivers, such as ehci, may use multiple |
92 | phys and for such drivers referencing phy(s) by name(s) does not make sense. In | ||
93 | this case, devm_of_phy_get_by_index can be used to get a phy reference based on | ||
94 | the index. | ||
90 | 95 | ||
91 | It should be noted that NULL is a valid phy reference. All phy | 96 | It should be noted that NULL is a valid phy reference. All phy |
92 | consumer calls on the NULL phy become NOPs. That is the release calls, | 97 | consumer calls on the NULL phy become NOPs. That is the release calls, |