misc: pch_phub: Provide descriptions for 'chip' argument

For some reason (probably copy 'n' paste) kerneldoc descriptions
were missing for all instances of 'chip'.  Providing them squashes
the following W=1 kernel build warnings:

 drivers/misc/pch_phub.c:145: warning: Function parameter or member 'chip' not described in 'pch_phub_read_modify_write_reg'
 drivers/misc/pch_phub.c:282: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom'
 drivers/misc/pch_phub.c:296: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom'
 drivers/misc/pch_phub.c:334: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom_val'
 drivers/misc/pch_phub.c:350: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom_val'
 drivers/misc/pch_phub.c:450: warning: Function parameter or member 'chip' not described in 'pch_phub_read_gbe_mac_addr'
 drivers/misc/pch_phub.c:462: warning: Function parameter or member 'chip' not described in 'pch_phub_write_gbe_mac_addr'

Cc: Masayuki Ohtak <masa-korg@dsn.okisemi.com>
Cc: Tomoya MORINAGA <tomoya-linux@dsn.okisemi.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701085853.164358-14-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/misc/pch_phub.c b/drivers/misc/pch_phub.c
index 9321d42..6fe24e5 100644 (file)
--- a/drivers/misc/pch_phub.c
+++ b/drivers/misc/pch_phub.c
@@ -135,6 +135,7 @@ static DEFINE_MUTEX(pch_phub_mutex);
 
 /**
  * pch_phub_read_modify_write_reg() - Reading modifying and writing register
+ * @chip:              Pointer to the PHUB register structure
  * @reg_addr_offset:   Register offset address value.
  * @data:              Writing value.
  * @mask:              Mask value.
@@ -272,6 +273,7 @@ static void __maybe_unused pch_phub_restore_reg_conf(struct pci_dev *pdev)
 
 /**
  * pch_phub_read_serial_rom() - Reading Serial ROM
+ * @chip:              Pointer to the PHUB register structure
  * @offset_address:    Serial ROM offset address to read.
  * @data:              Read buffer for specified Serial ROM value.
  */
@@ -286,6 +288,7 @@ static void pch_phub_read_serial_rom(struct pch_phub_reg *chip,
 
 /**
  * pch_phub_write_serial_rom() - Writing Serial ROM
+ * @chip:              Pointer to the PHUB register structure
  * @offset_address:    Serial ROM offset address.
  * @data:              Serial ROM value to write.
  */
@@ -324,6 +327,7 @@ static int pch_phub_write_serial_rom(struct pch_phub_reg *chip,
 
 /**
  * pch_phub_read_serial_rom_val() - Read Serial ROM value
+ * @chip:              Pointer to the PHUB register structure
  * @offset_address:    Serial ROM address offset value.
  * @data:              Serial ROM value to read.
  */
@@ -340,6 +344,7 @@ static void pch_phub_read_serial_rom_val(struct pch_phub_reg *chip,
 
 /**
  * pch_phub_write_serial_rom_val() - writing Serial ROM value
+ * @chip:              Pointer to the PHUB register structure
  * @offset_address:    Serial ROM address offset value.
  * @data:              Serial ROM value.
  */
@@ -442,6 +447,7 @@ static int pch_phub_gbe_serial_rom_conf_mp(struct pch_phub_reg *chip)
 /**
  * pch_phub_read_gbe_mac_addr() - Read Gigabit Ethernet MAC address
  * @offset_address:    Gigabit Ethernet MAC address offset value.
+ * @chip:              Pointer to the PHUB register structure
  * @data:              Buffer of the Gigabit Ethernet MAC address value.
  */
 static void pch_phub_read_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data)
@@ -454,6 +460,7 @@ static void pch_phub_read_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data)
 /**
  * pch_phub_write_gbe_mac_addr() - Write MAC address
  * @offset_address:    Gigabit Ethernet MAC address offset value.
+ * @chip:              Pointer to the PHUB register structure
  * @data:              Gigabit Ethernet MAC address value.
  */
 static int pch_phub_write_gbe_mac_addr(struct pch_phub_reg *chip, u8 *data)