Silence documentation build warnings by correcting kernel-doc
comments. In the case of pcs_{config,an_restart,link_up}, change the
declaration to a normal function since these only there for
documentation anyway.
./include/linux/phylink.h:74: warning: Function parameter or member
'poll_fixed_state' not described in 'phylink_config'
./include/linux/phylink.h:74: warning: Function parameter or member
'get_fixed_state' not described in 'phylink_config'
./include/linux/phylink.h:336: warning: Function parameter or member
'pcs_config' not described in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'config'
description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'mode'
description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'interface'
description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'advertising'
description in 'int'
./include/linux/phylink.h:345: warning: Function parameter or member
'pcs_an_restart' not described in 'void'
./include/linux/phylink.h:345: warning: Excess function parameter 'config'
description in 'void'
./include/linux/phylink.h:361: warning: Function parameter or member
'pcs_link_up' not described in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'config'
description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'mode'
description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'interface'
description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'speed'
description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'duplex'
description in 'void'
Signed-off-by: Colton Lewis <colton.w.le...@protonmail.com>
---
include/linux/phylink.h | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index cc5b452a184e..24c52d9f63d6 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -62,6 +62,8 @@ enum phylink_op_type {
* @dev: a pointer to a struct device associated with the MAC
* @type: operation type of PHYLINK instance
* @pcs_poll: MAC PCS cannot provide link change interrupt
+ * @poll_fixed_state: poll link state with @get_fixed_state
+ * @get_fixed_state: read link state into struct phylink_link_state
*/
struct phylink_config {
struct device *dev;
@@ -331,7 +333,7 @@ void pcs_get_state(struct phylink_config *config,
*
* For most 10GBASE-R, there is no advertisement.
*/
-int (*pcs_config)(struct phylink_config *config, unsigned int mode,
+int pcs_config(struct phylink_config *config, unsigned int mode,
phy_interface_t interface, const unsigned long *advertising);
/**
@@ -341,7 +343,7 @@ int (*pcs_config)(struct phylink_config *config, unsigned
int mode,
* When PCS ops are present, this overrides mac_an_restart() in &struct
* phylink_mac_ops.
*/
-void (*pcs_an_restart)(struct phylink_config *config);
+void pcs_an_restart(struct phylink_config *config);
/**
* pcs_link_up() - program the PCS for the resolved link configuration
@@ -356,7 +358,7 @@ void (*pcs_an_restart)(struct phylink_config *config);
* mode without in-band AN needs to be manually configured for the link
* and duplex setting. Otherwise, this should be a no-op.
*/
-void (*pcs_link_up)(struct phylink_config *config, unsigned int mode,
+void pcs_link_up(struct phylink_config *config, unsigned int mode,
phy_interface_t interface, int speed, int duplex);
#endif
--
2.26.2
