target/linux/bcm27xx/patches-5.10/950-0542-net-usb-r8152-Provide-missing-documentation-for-some.patch

   1 From 586f04ce6a391419ca3cc9cef6b6f38570cede88 Mon Sep 17 00:00:00 2001
   2 From: Lee Jones <lee.jones@linaro.org>
   3 Date: Mon, 2 Nov 2020 11:45:04 +0000
   4 Subject: [PATCH] net: usb: r8152: Provide missing documentation for
   5  some struct members
   6
   7 commit 34e653efb602e0651867fb5ab14369b555a61dcd upstream.
   8
   9 Fixes the following W=1 kernel build warning(s):
  10
  11  drivers/net/usb/r8152.c:934: warning: Function parameter or member 'blk_hdr' not described in 'fw_mac'
  12  drivers/net/usb/r8152.c:934: warning: Function parameter or member 'reserved' not described in 'fw_mac'
  13  drivers/net/usb/r8152.c:947: warning: Function parameter or member 'blk_hdr' not described in 'fw_phy_patch_key'
  14  drivers/net/usb/r8152.c:947: warning: Function parameter or member 'reserved' not described in 'fw_phy_patch_key'
  15  drivers/net/usb/r8152.c:986: warning: Function parameter or member 'blk_hdr' not described in 'fw_phy_nc'
  16  drivers/net/usb/r8152.c:986: warning: Function parameter or member 'mode_pre' not described in 'fw_phy_nc'
  17  drivers/net/usb/r8152.c:986: warning: Function parameter or member 'mode_post' not described in 'fw_phy_nc'
  18  drivers/net/usb/r8152.c:986: warning: Function parameter or member 'reserved' not described in 'fw_phy_nc'
  19
  20 Signed-off-by: Lee Jones <lee.jones@linaro.org>
  21 Acked-by: Hayes Wang <hayeswang@realtek.com>
  22 Link: https://lore.kernel.org/r/20201102114512.1062724-23-lee.jones@linaro.org
  23 Signed-off-by: Jakub Kicinski <kuba@kernel.org>
  24 ---
  25  drivers/net/usb/r8152.c | 6 ++++++
  26  1 file changed, 6 insertions(+)
  27
  28 --- a/drivers/net/usb/r8152.c
  29 +++ b/drivers/net/usb/r8152.c
  30 @@ -898,6 +898,7 @@ struct fw_header {
  31   * struct fw_mac - a firmware block used by RTL_FW_PLA and RTL_FW_USB.
  32   *     The layout of the firmware block is:
  33   *     <struct fw_mac> + <info> + <firmware data>.
  34 + * @blk_hdr: firmware descriptor (type, length)
  35   * @fw_offset: offset of the firmware binary data. The start address of
  36   *     the data would be the address of struct fw_mac + @fw_offset.
  37   * @fw_reg: the register to load the firmware. Depends on chip.
  38 @@ -911,6 +912,7 @@ struct fw_header {
  39   * @bp_num: the break point number which needs to be set for this firmware.
  40   *     Depends on the firmware.
  41   * @bp: break points. Depends on firmware.
  42 + * @reserved: reserved space (unused)
  43   * @fw_ver_reg: the register to store the fw version.
  44   * @fw_ver_data: the firmware version of the current type.
  45   * @info: additional information for debugging, and is followed by the
  46 @@ -936,8 +938,10 @@ struct fw_mac {
  47  /**
  48   * struct fw_phy_patch_key - a firmware block used by RTL_FW_PHY_START.
  49   *     This is used to set patch key when loading the firmware of PHY.
  50 + * @blk_hdr: firmware descriptor (type, length)
  51   * @key_reg: the register to write the patch key.
  52   * @key_data: patch key.
  53 + * @reserved: reserved space (unused)
  54   */
  55  struct fw_phy_patch_key {
  56         struct fw_block blk_hdr;
  57 @@ -950,6 +954,7 @@ struct fw_phy_patch_key {
  58   * struct fw_phy_nc - a firmware block used by RTL_FW_PHY_NC.
  59   *     The layout of the firmware block is:
  60   *     <struct fw_phy_nc> + <info> + <firmware data>.
  61 + * @blk_hdr: firmware descriptor (type, length)
  62   * @fw_offset: offset of the firmware binary data. The start address of
  63   *     the data would be the address of struct fw_phy_nc + @fw_offset.
  64   * @fw_reg: the register to load the firmware. Depends on chip.
  65 @@ -960,6 +965,7 @@ struct fw_phy_patch_key {
  66   * @mode_reg: the regitster of switching the mode.
  67   * @mod_pre: the mode needing to be set before loading the firmware.
  68   * @mod_post: the mode to be set when finishing to load the firmware.
  69 + * @reserved: reserved space (unused)
  70   * @bp_start: the start register of break points. Depends on chip.
  71   * @bp_num: the break point number which needs to be set for this firmware.
  72   *     Depends on the firmware.