Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Andrew Lunn <andrew@lunn.ch>
To: David Miller <davem@davemloft.net>
Cc: netdev <netdev@vger.kernel.org>,
	Florian Fainelli <f.fainelli@gmail.com>,
	Heiner Kallweit <hkallweit1@gmail.com>,
	Andrew Lunn <andrew@lunn.ch>
Subject: [PATCH net-next 3/5] net: phy: Fixup kernel doc
Date: Sun, 20 Sep 2020 19:17:01 +0200	[thread overview]
Message-ID: <20200920171703.3692328-4-andrew@lunn.ch> (raw)
In-Reply-To: <20200920171703.3692328-1-andrew@lunn.ch>

Add missing parameter documentation, or fixup wrong parameter names.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
 include/linux/mdio.h | 3 ++-
 include/linux/phy.h  | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/mdio.h b/include/linux/mdio.h
index 3a88b699b758..dbd69b3d170b 100644
--- a/include/linux/mdio.h
+++ b/include/linux/mdio.h
@@ -306,7 +306,7 @@ static inline u32 linkmode_adv_to_mii_10gbt_adv_t(unsigned long *advertising)
 /**
  * mii_10gbt_stat_mod_linkmode_lpa_t
  * @advertising: target the linkmode advertisement settings
- * @adv: value of the C45 10GBASE-T AN STATUS register
+ * @lpa: value of the C45 10GBASE-T AN STATUS register
  *
  * A small helper function that translates C45 10GBASE-T AN STATUS register bits
  * to linkmode advertisement settings. Other bits in advertising aren't changed.
@@ -371,6 +371,7 @@ struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr);
 
 /**
  * mdio_module_driver() - Helper macro for registering mdio drivers
+ * @_mdio_driver: driver to register
  *
  * Helper macro for MDIO drivers which do not do anything special in module
  * init/exit. Each module may only use this macro once, and calling it
diff --git a/include/linux/phy.h b/include/linux/phy.h
index 3a09d2bf69ea..4901b2637059 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -1566,8 +1566,9 @@ static inline int mdiobus_register_board_info(const struct mdio_board_info *i,
 
 
 /**
- * module_phy_driver() - Helper macro for registering PHY drivers
+ * phy_module_driver() - Helper macro for registering PHY drivers
  * @__phy_drivers: array of PHY drivers to register
+ * @__count: Numbers of members in array
  *
  * Helper macro for PHY drivers which do not do anything special in module
  * init/exit. Each module may only use this macro once, and calling it
-- 
2.28.0


  parent reply	other threads:[~2020-09-20 17:17 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-20 17:16 [PATCH net-next 0/5] PHY subsystem " Andrew Lunn
2020-09-20 17:16 ` [PATCH net-next 1/5] net: netdevice.h: Document proto_down_reason Andrew Lunn
2020-09-20 21:07   ` Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 2/5] net: netdevice.h: Document xdp_state Andrew Lunn
2020-09-20 17:17 ` Andrew Lunn [this message]
2020-09-20 21:07   ` [PATCH net-next 3/5] net: phy: Fixup kernel doc Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 4/5] net: phy: Document core PHY structures Andrew Lunn
2020-09-20 21:29   ` Florian Fainelli
2020-09-20 17:17 ` [PATCH net-next 5/5] net: mdio: Add kerneldoc for main data structures and some functions Andrew Lunn
2020-09-20 21:11   ` Florian Fainelli
2020-09-20 17:44 ` [PATCH net-next 0/5] PHY subsystem kernel doc Randy Dunlap
2020-09-21 21:45 ` David Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200920171703.3692328-4-andrew@lunn.ch \
    --to=andrew@lunn.ch \
    --cc=davem@davemloft.net \
    --cc=f.fainelli@gmail.com \
    --cc=hkallweit1@gmail.com \
    --cc=netdev@vger.kernel.org \
    --subject='Re: [PATCH net-next 3/5] net: phy: Fixup kernel doc' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).