git: b67aeb0b070d - stable/13 - e1000: add function parameter descriptions
Kevin Bowling
kbowling at FreeBSD.org
Fri Sep 24 01:35:09 UTC 2021
The branch stable/13 has been updated by kbowling (ports committer):
URL: https://cgit.FreeBSD.org/src/commit/?id=b67aeb0b070d6559e7d1c060494958c640916e44
commit b67aeb0b070d6559e7d1c060494958c640916e44
Author: Guinan Sun <guinanx.sun at intel.com>
AuthorDate: 2020-07-06 08:12:02 +0000
Commit: Kevin Bowling <kbowling at FreeBSD.org>
CommitDate: 2021-09-24 01:20:16 +0000
e1000: add function parameter descriptions
Add function parameter descriptions to address gcc 7 warnings.
Signed-off-by: Todd Fujinaka <todd.fujinaka at intel.com>
Signed-off-by: Guinan Sun <guinanx.sun at intel.com>
Reviewed-by: Wei Zhao <wei.zhao1 at intel.com>
Approved by: imp
Obtained from: DPDK (1bf35d435c9764e83be76042fa6489dd127b6c40)
MFC after: 1 week
(cherry picked from commit 5b426b3e8cbd5abdb3a57ff49cd27c36cac03427)
---
sys/dev/e1000/e1000_82575.c | 11 +++++------
sys/dev/e1000/e1000_mac.c | 8 ++++++++
sys/dev/e1000/e1000_mbx.c | 4 ++++
sys/dev/e1000/e1000_nvm.c | 7 +++++++
sys/dev/e1000/e1000_phy.c | 6 ++++++
5 files changed, 30 insertions(+), 6 deletions(-)
diff --git a/sys/dev/e1000/e1000_82575.c b/sys/dev/e1000/e1000_82575.c
index 27e564d7841b..296a72542914 100644
--- a/sys/dev/e1000/e1000_82575.c
+++ b/sys/dev/e1000/e1000_82575.c
@@ -2702,7 +2702,7 @@ out:
/**
* __e1000_access_emi_reg - 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
**/
@@ -2929,8 +2929,8 @@ out:
/**
* e1000_set_eee_i350 - Enable/disable EEE support
* @hw: pointer to the HW structure
- * @adv1g: boolean flag enabling 1G EEE advertisement
- * @adv100m: boolean flag enabling 100M EEE advertisement
+ * @adv1G: boolean flag enabling 1G EEE advertisement
+ * @adv100M: boolean flag enabling 100M EEE advertisement
*
* Enable/disable EEE based on setting in dev_spec structure.
*
@@ -2984,8 +2984,8 @@ out:
/**
* e1000_set_eee_i354 - Enable/disable EEE support
* @hw: pointer to the HW structure
- * @adv1g: boolean flag enabling 1G EEE advertisement
- * @adv100m: boolean flag enabling 100M EEE advertisement
+ * @adv1G: boolean flag enabling 1G EEE advertisement
+ * @adv100M: boolean flag enabling 100M EEE advertisement
*
* Enable/disable EEE legacy mode based on setting in dev_spec structure.
*
@@ -3641,7 +3641,6 @@ static s32 e1000_set_i2c_data(struct e1000_hw *hw, u32 *i2cctl, bool data)
/**
* e1000_get_i2c_data - Reads the I2C SDA data bit
- * @hw: pointer to hardware structure
* @i2cctl: Current value of I2CCTL register
*
* Returns the I2C data bit value
diff --git a/sys/dev/e1000/e1000_mac.c b/sys/dev/e1000/e1000_mac.c
index 11fbcb62142f..bda2ad65e3dc 100644
--- a/sys/dev/e1000/e1000_mac.c
+++ b/sys/dev/e1000/e1000_mac.c
@@ -105,6 +105,8 @@ void e1000_null_mac_generic(struct e1000_hw E1000_UNUSEDARG *hw)
/**
* e1000_null_link_info - No-op function, return 0
* @hw: pointer to the HW structure
+ * @s: dummy variable
+ * @d: dummy variable
**/
s32 e1000_null_link_info(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG *s, u16 E1000_UNUSEDARG *d)
@@ -126,6 +128,8 @@ bool e1000_null_mng_mode(struct e1000_hw E1000_UNUSEDARG *hw)
/**
* e1000_null_update_mc - No-op function, return void
* @hw: pointer to the HW structure
+ * @h: dummy variable
+ * @a: dummy variable
**/
void e1000_null_update_mc(struct e1000_hw E1000_UNUSEDARG *hw,
u8 E1000_UNUSEDARG *h, u32 E1000_UNUSEDARG a)
@@ -137,6 +141,8 @@ void e1000_null_update_mc(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_write_vfta - No-op function, return void
* @hw: pointer to the HW structure
+ * @a: dummy variable
+ * @b: dummy variable
**/
void e1000_null_write_vfta(struct e1000_hw E1000_UNUSEDARG *hw,
u32 E1000_UNUSEDARG a, u32 E1000_UNUSEDARG b)
@@ -148,6 +154,8 @@ void e1000_null_write_vfta(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_rar_set - No-op function, return 0
* @hw: pointer to the HW structure
+ * @h: dummy variable
+ * @a: dummy variable
**/
int e1000_null_rar_set(struct e1000_hw E1000_UNUSEDARG *hw,
u8 E1000_UNUSEDARG *h, u32 E1000_UNUSEDARG a)
diff --git a/sys/dev/e1000/e1000_mbx.c b/sys/dev/e1000/e1000_mbx.c
index da31185c3476..3fc3811757f7 100644
--- a/sys/dev/e1000/e1000_mbx.c
+++ b/sys/dev/e1000/e1000_mbx.c
@@ -38,6 +38,7 @@
/**
* e1000_null_mbx_check_for_flag - No-op function, return 0
* @hw: pointer to the HW structure
+ * @mbx_id: id of mailbox to read
**/
static s32 e1000_null_mbx_check_for_flag(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG mbx_id)
@@ -50,6 +51,9 @@ static s32 e1000_null_mbx_check_for_flag(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_mbx_transact - No-op function, return 0
* @hw: pointer to the HW structure
+ * @msg: The message buffer
+ * @size: Length of buffer
+ * @mbx_id: id of mailbox to read
**/
static s32 e1000_null_mbx_transact(struct e1000_hw E1000_UNUSEDARG *hw,
u32 E1000_UNUSEDARG *msg,
diff --git a/sys/dev/e1000/e1000_nvm.c b/sys/dev/e1000/e1000_nvm.c
index f46444cf38b9..46c00e1d64b3 100644
--- a/sys/dev/e1000/e1000_nvm.c
+++ b/sys/dev/e1000/e1000_nvm.c
@@ -63,6 +63,9 @@ void e1000_init_nvm_ops_generic(struct e1000_hw *hw)
/**
* e1000_null_nvm_read - No-op function, return 0
* @hw: pointer to the HW structure
+ * @a: dummy variable
+ * @b: dummy variable
+ * @c: dummy variable
**/
s32 e1000_null_read_nvm(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG a, u16 E1000_UNUSEDARG b,
@@ -85,6 +88,7 @@ void e1000_null_nvm_generic(struct e1000_hw E1000_UNUSEDARG *hw)
/**
* e1000_null_led_default - No-op function, return 0
* @hw: pointer to the HW structure
+ * @data: dummy variable
**/
s32 e1000_null_led_default(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG *data)
@@ -96,6 +100,9 @@ s32 e1000_null_led_default(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_write_nvm - No-op function, return 0
* @hw: pointer to the HW structure
+ * @a: dummy variable
+ * @b: dummy variable
+ * @c: dummy variable
**/
s32 e1000_null_write_nvm(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG a, u16 E1000_UNUSEDARG b,
diff --git a/sys/dev/e1000/e1000_phy.c b/sys/dev/e1000/e1000_phy.c
index d22bcb7149c1..d73e3a10ae13 100644
--- a/sys/dev/e1000/e1000_phy.c
+++ b/sys/dev/e1000/e1000_phy.c
@@ -104,6 +104,7 @@ void e1000_init_phy_ops_generic(struct e1000_hw *hw)
/**
* e1000_null_set_page - No-op function, return 0
* @hw: pointer to the HW structure
+ * @data: dummy variable
**/
s32 e1000_null_set_page(struct e1000_hw E1000_UNUSEDARG *hw,
u16 E1000_UNUSEDARG data)
@@ -115,6 +116,8 @@ s32 e1000_null_set_page(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_read_reg - No-op function, return 0
* @hw: pointer to the HW structure
+ * @offset: dummy variable
+ * @data: dummy variable
**/
s32 e1000_null_read_reg(struct e1000_hw E1000_UNUSEDARG *hw,
u32 E1000_UNUSEDARG offset, u16 E1000_UNUSEDARG *data)
@@ -136,6 +139,7 @@ void e1000_null_phy_generic(struct e1000_hw E1000_UNUSEDARG *hw)
/**
* e1000_null_lplu_state - No-op function, return 0
* @hw: pointer to the HW structure
+ * @active: dummy variable
**/
s32 e1000_null_lplu_state(struct e1000_hw E1000_UNUSEDARG *hw,
bool E1000_UNUSEDARG active)
@@ -147,6 +151,8 @@ s32 e1000_null_lplu_state(struct e1000_hw E1000_UNUSEDARG *hw,
/**
* e1000_null_write_reg - No-op function, return 0
* @hw: pointer to the HW structure
+ * @offset: dummy variable
+ * @data: dummy variable
**/
s32 e1000_null_write_reg(struct e1000_hw E1000_UNUSEDARG *hw,
u32 E1000_UNUSEDARG offset, u16 E1000_UNUSEDARG data)
More information about the dev-commits-src-all
mailing list