OSDN Git Service

phy: fix structure documentation
authorDov Levenglick <levengeek@gmail.com>
Fri, 2 Feb 2018 16:34:50 +0000 (18:34 +0200)
committerKishon Vijay Abraham I <kishon@ti.com>
Thu, 8 Mar 2018 08:26:24 +0000 (13:56 +0530)
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>
include/linux/phy/phy.h

index 485469e..c9d14ee 100644 (file)
@@ -81,7 +81,8 @@ struct phy_attrs {
  * @mutex: mutex to protect phy_ops
  * @init_count: used to protect when the PHY is used by multiple consumers
  * @power_count: used to protect when the PHY is used by multiple consumers
- * @phy_attrs: used to specify PHY specific attributes
+ * @attrs: used to specify PHY specific attributes
+ * @pwr: power regulator associated with the phy
  */
 struct phy {
        struct device           dev;
@@ -97,9 +98,10 @@ struct phy {
 /**
  * struct phy_provider - represents the phy provider
  * @dev: phy provider device
+ * @children: can be used to override the default (dev->of_node) child node
  * @owner: the module owner having of_xlate
- * @of_xlate: function pointer to obtain phy instance from phy pointer
  * @list: to maintain a linked list of PHY providers
+ * @of_xlate: function pointer to obtain phy instance from phy pointer
  */
 struct phy_provider {
        struct device           *dev;
@@ -110,6 +112,13 @@ struct phy_provider {
                struct of_phandle_args *args);
 };
 
+/**
+ * struct phy_lookup - PHY association in list of phys managed by the phy driver
+ * @node: list node
+ * @dev_id: the device of the association
+ * @con_id: connection ID string on device
+ * @phy: the phy of the association
+ */
 struct phy_lookup {
        struct list_head node;
        const char *dev_id;