aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/phy
diff options
context:
space:
mode:
authorDov Levenglick <levengeek@gmail.com>2018-02-02 11:34:50 -0500
committerKishon Vijay Abraham I <kishon@ti.com>2018-03-08 03:26:24 -0500
commitbecaf17a58473e358e056ada2642e895aae93b0e (patch)
tree8631abffb370e9ce8fa2f7d7924162ad65ae4e44 /include/linux/phy
parent95cc6e7217963bdd58f5ff737a574bea1c6f170b (diff)
phy: fix structure documentation
Add missing documentation of structure members and modify the order of documentation to match that of the structure declaration. Signed-off-by: Dov Levenglick <dov.levenglick@gmail.com> Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>
Diffstat (limited to 'include/linux/phy')
-rw-r--r--include/linux/phy/phy.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/include/linux/phy/phy.h b/include/linux/phy/phy.h
index 485469e6fa7f..c9d14eeee7f5 100644
--- a/include/linux/phy/phy.h
+++ b/include/linux/phy/phy.h
@@ -81,7 +81,8 @@ struct phy_attrs {
81 * @mutex: mutex to protect phy_ops 81 * @mutex: mutex to protect phy_ops
82 * @init_count: used to protect when the PHY is used by multiple consumers 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 83 * @power_count: used to protect when the PHY is used by multiple consumers
84 * @phy_attrs: used to specify PHY specific attributes 84 * @attrs: used to specify PHY specific attributes
85 * @pwr: power regulator associated with the phy
85 */ 86 */
86struct phy { 87struct phy {
87 struct device dev; 88 struct device dev;
@@ -97,9 +98,10 @@ struct phy {
97/** 98/**
98 * struct phy_provider - represents the phy provider 99 * struct phy_provider - represents the phy provider
99 * @dev: phy provider device 100 * @dev: phy provider device
101 * @children: can be used to override the default (dev->of_node) child node
100 * @owner: the module owner having of_xlate 102 * @owner: the module owner having of_xlate
101 * @of_xlate: function pointer to obtain phy instance from phy pointer
102 * @list: to maintain a linked list of PHY providers 103 * @list: to maintain a linked list of PHY providers
104 * @of_xlate: function pointer to obtain phy instance from phy pointer
103 */ 105 */
104struct phy_provider { 106struct phy_provider {
105 struct device *dev; 107 struct device *dev;
@@ -110,6 +112,13 @@ struct phy_provider {
110 struct of_phandle_args *args); 112 struct of_phandle_args *args);
111}; 113};
112 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 */
113struct phy_lookup { 122struct phy_lookup {
114 struct list_head node; 123 struct list_head node;
115 const char *dev_id; 124 const char *dev_id;