2021-08-21 08:54:34 +00:00
|
|
|
From 586f04ce6a391419ca3cc9cef6b6f38570cede88 Mon Sep 17 00:00:00 2001
|
|
|
|
|
From: Lee Jones <lee.jones@linaro.org>
|
|
|
|
|
Date: Mon, 2 Nov 2020 11:45:04 +0000
|
|
|
|
|
Subject: [PATCH] net: usb: r8152: Provide missing documentation for
|
|
|
|
|
some struct members
|
|
|
|
|
|
|
|
|
|
commit 34e653efb602e0651867fb5ab14369b555a61dcd upstream.
|
|
|
|
|
|
|
|
|
|
Fixes the following W=1 kernel build warning(s):
|
|
|
|
|
|
|
|
|
|
drivers/net/usb/r8152.c:934: warning: Function parameter or member 'blk_hdr' not described in 'fw_mac'
|
|
|
|
|
drivers/net/usb/r8152.c:934: warning: Function parameter or member 'reserved' not described in 'fw_mac'
|
|
|
|
|
drivers/net/usb/r8152.c:947: warning: Function parameter or member 'blk_hdr' not described in 'fw_phy_patch_key'
|
|
|
|
|
drivers/net/usb/r8152.c:947: warning: Function parameter or member 'reserved' not described in 'fw_phy_patch_key'
|
|
|
|
|
drivers/net/usb/r8152.c:986: warning: Function parameter or member 'blk_hdr' not described in 'fw_phy_nc'
|
|
|
|
|
drivers/net/usb/r8152.c:986: warning: Function parameter or member 'mode_pre' not described in 'fw_phy_nc'
|
|
|
|
|
drivers/net/usb/r8152.c:986: warning: Function parameter or member 'mode_post' not described in 'fw_phy_nc'
|
|
|
|
|
drivers/net/usb/r8152.c:986: warning: Function parameter or member 'reserved' not described in 'fw_phy_nc'
|
|
|
|
|
|
|
|
|
|
Signed-off-by: Lee Jones <lee.jones@linaro.org>
|
|
|
|
|
Acked-by: Hayes Wang <hayeswang@realtek.com>
|
|
|
|
|
Link: https://lore.kernel.org/r/20201102114512.1062724-23-lee.jones@linaro.org
|
|
|
|
|
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
|
|
|
|
|
---
|
|
|
|
|
drivers/net/usb/r8152.c | 6 ++++++
|
|
|
|
|
1 file changed, 6 insertions(+)
|
|
|
|
|
|
|
|
|
|
--- a/drivers/net/usb/r8152.c
|
|
|
|
|
+++ b/drivers/net/usb/r8152.c
|
2021-11-02 21:05:27 +00:00
|
|
|
@@ -899,6 +899,7 @@ struct fw_header {
|
2021-08-21 08:54:34 +00:00
|
|
|
* struct fw_mac - a firmware block used by RTL_FW_PLA and RTL_FW_USB.
|
|
|
|
|
* The layout of the firmware block is:
|
|
|
|
|
* <struct fw_mac> + <info> + <firmware data>.
|
|
|
|
|
+ * @blk_hdr: firmware descriptor (type, length)
|
|
|
|
|
* @fw_offset: offset of the firmware binary data. The start address of
|
|
|
|
|
* the data would be the address of struct fw_mac + @fw_offset.
|
|
|
|
|
* @fw_reg: the register to load the firmware. Depends on chip.
|
2021-11-02 21:05:27 +00:00
|
|
|
@@ -912,6 +913,7 @@ struct fw_header {
|
2021-08-21 08:54:34 +00:00
|
|
|
* @bp_num: the break point number which needs to be set for this firmware.
|
|
|
|
|
* Depends on the firmware.
|
|
|
|
|
* @bp: break points. Depends on firmware.
|
|
|
|
|
+ * @reserved: reserved space (unused)
|
|
|
|
|
* @fw_ver_reg: the register to store the fw version.
|
|
|
|
|
* @fw_ver_data: the firmware version of the current type.
|
|
|
|
|
* @info: additional information for debugging, and is followed by the
|
2021-11-02 21:05:27 +00:00
|
|
|
@@ -937,8 +939,10 @@ struct fw_mac {
|
2021-08-21 08:54:34 +00:00
|
|
|
/**
|
|
|
|
|
* struct fw_phy_patch_key - a firmware block used by RTL_FW_PHY_START.
|
|
|
|
|
* This is used to set patch key when loading the firmware of PHY.
|
|
|
|
|
+ * @blk_hdr: firmware descriptor (type, length)
|
|
|
|
|
* @key_reg: the register to write the patch key.
|
|
|
|
|
* @key_data: patch key.
|
|
|
|
|
+ * @reserved: reserved space (unused)
|
|
|
|
|
*/
|
|
|
|
|
struct fw_phy_patch_key {
|
|
|
|
|
struct fw_block blk_hdr;
|
2021-11-02 21:05:27 +00:00
|
|
|
@@ -951,6 +955,7 @@ struct fw_phy_patch_key {
|
2021-08-21 08:54:34 +00:00
|
|
|
* struct fw_phy_nc - a firmware block used by RTL_FW_PHY_NC.
|
|
|
|
|
* The layout of the firmware block is:
|
|
|
|
|
* <struct fw_phy_nc> + <info> + <firmware data>.
|
|
|
|
|
+ * @blk_hdr: firmware descriptor (type, length)
|
|
|
|
|
* @fw_offset: offset of the firmware binary data. The start address of
|
|
|
|
|
* the data would be the address of struct fw_phy_nc + @fw_offset.
|
|
|
|
|
* @fw_reg: the register to load the firmware. Depends on chip.
|
2021-11-02 21:05:27 +00:00
|
|
|
@@ -961,6 +966,7 @@ struct fw_phy_patch_key {
|
2021-08-21 08:54:34 +00:00
|
|
|
* @mode_reg: the regitster of switching the mode.
|
|
|
|
|
* @mod_pre: the mode needing to be set before loading the firmware.
|
|
|
|
|
* @mod_post: the mode to be set when finishing to load the firmware.
|
|
|
|
|
+ * @reserved: reserved space (unused)
|
|
|
|
|
* @bp_start: the start register of break points. Depends on chip.
|
|
|
|
|
* @bp_num: the break point number which needs to be set for this firmware.
|
|
|
|
|
* Depends on the firmware.
|
