[PATCH net-next 0/3] Fix some kernel-doc warnings for e1000/e1000e

[PATCH net-next 0/3] Fix some kernel-doc warnings for e1000/e1000e

[Wang Hai]

Wang Hai (3):
  e1000e: Fix some kernel-doc warnings in ich8lan.c
  e1000e: Fix some kernel-doc warnings in netdev.c
  e1000: Fix a bunch of kerneldoc parameter issues in e1000_hw.c

 drivers/net/ethernet/intel/e1000/e1000_hw.c | 7 +------
 drivers/net/ethernet/intel/e1000e/ich8lan.c | 4 ++--
 drivers/net/ethernet/intel/e1000e/netdev.c  | 6 ++----
 3 files changed, 5 insertions(+), 12 deletions(-)

-- 
2.17.1

[PATCH net-next 1/3] e1000e: Fix some kernel-doc warnings in ich8lan.c

[Wang Hai]

Fixes the following W=1 kernel build warning(s):

drivers/net/ethernet/intel/e1000e/ich8lan.c:2277: warning: Excess function parameter 'enable' description in 'e1000_configure_k1_ich8lan'
drivers/net/ethernet/intel/e1000e/ich8lan.c:754: warning: Excess function parameter 'addr' description in '__e1000_access_emi_reg_locked'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/e1000e/ich8lan.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/net/ethernet/intel/e1000e/ich8lan.c b/drivers/net/ethernet/intel/e1000e/ich8lan.c
index b2f2fcfdf732..3182de6ead0f 100644
--- a/drivers/net/ethernet/intel/e1000e/ich8lan.c
+++ b/drivers/net/ethernet/intel/e1000e/ich8lan.c
@@ -743,7 +743,7 @@ static s32 e1000_init_mac_params_ich8lan(struct e1000_hw *hw)
 /**
  *  __e1000_access_emi_reg_locked - Read/write EMI register
  *  @hw: pointer to the HW structure
- *  @addr: EMI address to program
+ *  @address: EMI address to program
  *  @data: pointer to value to read/write from/to the EMI address
  *  @read: boolean flag to indicate read or write
  *
@@ -2266,7 +2266,7 @@ static s32 e1000_k1_gig_workaround_hv(struct e1000_hw *hw, bool link)
 /**
  *  e1000_configure_k1_ich8lan - Configure K1 power state
  *  @hw: pointer to the HW structure
- *  @enable: K1 state to configure
+ *  @k1_enable: K1 state to configure
  *
  *  Configure the K1 power state based on the provided parameter.
  *  Assumes semaphore already acquired.
-- 
2.17.1

[PATCH net-next 2/3] e1000e: Fix some kernel-doc warnings in netdev.c

[Wang Hai]

Fixes the following W=1 kernel build warning(s):

drivers/net/ethernet/intel/e1000e/netdev.c:2525: warning: Excess function parameter 'adapter' description in 'e1000_update_itr'
drivers/net/ethernet/intel/e1000e/netdev.c:609: warning: Excess function parameter 'csum' description in 'e1000_rx_checksum'
drivers/net/ethernet/intel/e1000e/netdev.c:609: warning: Excess function parameter 'sk_buff' description in 'e1000_rx_checksum'
drivers/net/ethernet/intel/e1000e/netdev.c:6191: warning: Excess function parameter 'ifreq' description in 'e1000e_hwtstamp_set'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/e1000e/netdev.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/net/ethernet/intel/e1000e/netdev.c b/drivers/net/ethernet/intel/e1000e/netdev.c
index 664e8ccc88d2..4c5c4e8a14ba 100644
--- a/drivers/net/ethernet/intel/e1000e/netdev.c
+++ b/drivers/net/ethernet/intel/e1000e/netdev.c
@@ -601,8 +601,7 @@ static void e1000_receive_skb(struct e1000_adapter *adapter,
  * e1000_rx_checksum - Receive Checksum Offload
  * @adapter: board private structure
  * @status_err: receive descriptor status and error fields
- * @csum: receive descriptor csum field
- * @sk_buff: socket buffer with received data
+ * @skb: socket buffer with received data
  **/
 static void e1000_rx_checksum(struct e1000_adapter *adapter, u32 status_err,
 			      struct sk_buff *skb)
@@ -2507,7 +2506,6 @@ void e1000e_free_rx_resources(struct e1000_ring *rx_ring)
 
 /**
  * e1000_update_itr - update the dynamic ITR value based on statistics
- * @adapter: pointer to adapter
  * @itr_setting: current adapter->itr
  * @packets: the number of packets during this measurement interval
  * @bytes: the number of bytes during this measurement interval
@@ -6174,7 +6172,7 @@ static int e1000_mii_ioctl(struct net_device *netdev, struct ifreq *ifr,
 /**
  * e1000e_hwtstamp_ioctl - control hardware time stamping
  * @netdev: network interface device structure
- * @ifreq: interface request
+ * @ifr: interface request
  *
  * Outgoing time stamping can be enabled and disabled. Play nice and
  * disable it when requested, although it shouldn't cause any overhead
-- 
2.17.1

[PATCH net-next 3/3] e1000: Fix a bunch of kerneldoc parameter issues in e1000_hw.c

[Wang Hai]

Fix W=1 compile warnings (invalid kerneldoc):

drivers/net/ethernet/intel/e1000/e1000_hw.c:1907: warning: Excess function parameter 'mii_reg' description in 'e1000_config_mac_to_phy'
drivers/net/ethernet/intel/e1000/e1000_hw.c:2930: warning: Excess function parameter 'data' description in 'e1000_write_phy_reg'
drivers/net/ethernet/intel/e1000/e1000_hw.c:4788: warning: Excess function parameter 'tx_packets' description in 'e1000_update_adaptive'
drivers/net/ethernet/intel/e1000/e1000_hw.c:4788: warning: Excess function parameter 'total_collisions' description in 'e1000_update_adaptive'
drivers/net/ethernet/intel/e1000/e1000_hw.c:5079: warning: Excess function parameter 'downshift' description in 'e1000_check_downshift'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/e1000/e1000_hw.c | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/drivers/net/ethernet/intel/e1000/e1000_hw.c b/drivers/net/ethernet/intel/e1000/e1000_hw.c
index 4e7a0810eaeb..9cc5553b5287 100644
--- a/drivers/net/ethernet/intel/e1000/e1000_hw.c
+++ b/drivers/net/ethernet/intel/e1000/e1000_hw.c
@@ -1897,7 +1897,6 @@ void e1000_config_collision_dist(struct e1000_hw *hw)
 /**
  * e1000_config_mac_to_phy - sync phy and mac settings
  * @hw: Struct containing variables accessed by shared code
- * @mii_reg: data to write to the MII control register
  *
  * Sets MAC speed and duplex settings to reflect the those in the PHY
  * The contents of the PHY register containing the needed information need to
@@ -2922,7 +2921,7 @@ static s32 e1000_read_phy_reg_ex(struct e1000_hw *hw, u32 reg_addr,
  *
  * @hw: Struct containing variables accessed by shared code
  * @reg_addr: address of the PHY register to write
- * @data: data to write to the PHY
+ * @phy_data: data to write to the PHY
  *
  * Writes a value to a PHY register
  */
@@ -4778,8 +4777,6 @@ void e1000_reset_adaptive(struct e1000_hw *hw)
 /**
  * e1000_update_adaptive - update adaptive IFS
  * @hw: Struct containing variables accessed by shared code
- * @tx_packets: Number of transmits since last callback
- * @total_collisions: Number of collisions since last callback
  *
  * Called during the callback/watchdog routine to update IFS value based on
  * the ratio of transmits to collisions.
@@ -5064,8 +5061,6 @@ static s32 e1000_check_polarity(struct e1000_hw *hw,
 /**
  * e1000_check_downshift - Check if Downshift occurred
  * @hw: Struct containing variables accessed by shared code
- * @downshift: output parameter : 0 - No Downshift occurred.
- *                                1 - Downshift occurred.
  *
  * returns: - E1000_ERR_XXX
  *            E1000_SUCCESS
-- 
2.17.1

Re: [PATCH net-next 0/3] Fix some kernel-doc warnings for e1000/e1000e

[Jakub Kicinski]

On Thu, 10 Sep 2020 23:04:26 +0800 Wang Hai wrote:
> Wang Hai (3):
>   e1000e: Fix some kernel-doc warnings in ich8lan.c
>   e1000e: Fix some kernel-doc warnings in netdev.c
>   e1000: Fix a bunch of kerneldoc parameter issues in e1000_hw.c

You should put some text here but I can confirm this set removes 17
warnings.

Re: [PATCH net-next 0/3] Fix some kernel-doc warnings for e1000/e1000e

[Jakub Kicinski]

On Thu, 10 Sep 2020 12:38:00 -0700 Jakub Kicinski wrote:
> On Thu, 10 Sep 2020 23:04:26 +0800 Wang Hai wrote:
> > Wang Hai (3):
> >   e1000e: Fix some kernel-doc warnings in ich8lan.c
> >   e1000e: Fix some kernel-doc warnings in netdev.c
> >   e1000: Fix a bunch of kerneldoc parameter issues in e1000_hw.c  
> 
> You should put some text here but I can confirm this set removes 17
> warnings.

Reviewed-by: Jakub Kicinski <kuba@kernel.org>

Re: [PATCH net-next 0/3] Fix some kernel-doc warnings for e1000/e1000e

[wanghai (M)]

在 2020/9/11 3:38, Jakub Kicinski 写道:
> On Thu, 10 Sep 2020 12:38:00 -0700 Jakub Kicinski wrote:
>> On Thu, 10 Sep 2020 23:04:26 +0800 Wang Hai wrote:
>>> Wang Hai (3):
>>>    e1000e: Fix some kernel-doc warnings in ich8lan.c
>>>    e1000e: Fix some kernel-doc warnings in netdev.c
>>>    e1000: Fix a bunch of kerneldoc parameter issues in e1000_hw.c
>> You should put some text here but I can confirm this set removes 17
>> warnings.
> Reviewed-by: Jakub Kicinski <kuba@kernel.org>
> .
Thans for your review, I'll add some description next time