From: Lee Jones <lee.jones@linaro.org>
To: arnd@arndb.de, gregkh@linuxfoundation.org
Cc: Masayuki Ohtak <masa-korg@dsn.okisemi.com>,
Tomoya MORINAGA <tomoya-linux@dsn.okisemi.com>,
Lee Jones <lee.jones@linaro.org>,
linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH 13/20] misc: pch_phub: Provide descriptions for 'chip' argument
Date: Mon, 29 Jun 2020 15:04:35 +0100 [thread overview]
Message-ID: <20200629140442.1043957-14-lee.jones@linaro.org> (raw)
In-Reply-To: <20200629140442.1043957-1-lee.jones@linaro.org>
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>
---
drivers/misc/pch_phub.c | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/drivers/misc/pch_phub.c b/drivers/misc/pch_phub.c
index 60828af7506a3..95ba82a8625b0 100644
--- 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.
@@ -274,6 +275,7 @@ static void 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.
*/
@@ -288,6 +290,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.
*/
@@ -326,6 +329,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.
*/
@@ -342,6 +346,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.
*/
@@ -444,6 +449,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)
@@ -456,6 +462,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)
--
2.25.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-06-29 14:08 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-29 14:04 [PATCH 00/20] Fix a bunch more W=1 warnings in Misc Lee Jones
2020-06-29 14:04 ` [PATCH 01/20] misc: pti: Repair kerneldoc formatting issues Lee Jones
2020-06-29 14:04 ` [PATCH 02/20] misc: pti: Remove unparsable empty line in function header Lee Jones
2020-06-29 14:04 ` [PATCH 03/20] misc: habanalabs: firmware_if: Add missing 'fw_name' and 'dst' entries to " Lee Jones
2020-06-29 14:57 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 04/20] misc: habanalabs: pci: Fix a variety of kerneldoc issues Lee Jones
2020-06-29 14:58 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 05/20] misc: habanalabs: irq: Repair kerneldoc formatting issues Lee Jones
2020-06-29 14:59 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 06/20] misc: habanalabs: goya: Omit pointless check ensuring addr is >=0 Lee Jones
2020-06-29 15:00 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 07/20] misc: habanalabs: pci: Scrub documentation for non-present function argument Lee Jones
2020-06-29 15:00 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 08/20] misc: habanalabs: goya: goya_coresight: Remove set but unused variable 'val' Lee Jones
2020-06-29 15:01 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 09/20] misc: habanalabs: gaudi: Remove ill placed asterisk from kerneldoc header Lee Jones
2020-06-29 15:01 ` Oded Gabbay
2020-06-29 14:04 ` [PATCH 10/20] misc: habanalabs: gaudi: gaudi_security: Repair incorrectly named function arg Lee Jones
2020-06-29 15:02 ` Oded Gabbay
2020-06-29 16:23 ` [PATCH v2 " Lee Jones
2020-06-29 14:04 ` [PATCH 11/20] misc: enclosure: Fix some kerneldoc anomalies Lee Jones
2020-06-29 14:04 ` [PATCH 12/20] misc: lattice-ecp3-config: Remove set but clearly unused variable 'ret' Lee Jones
2020-06-29 14:04 ` Lee Jones [this message]
2020-06-29 14:04 ` [PATCH 14/20] misc: pch_phub: Remove superfluous descriptions to non-existent args 'offset_address' Lee Jones
2020-06-29 14:04 ` [PATCH 15/20] misc: enclosure: Update enclosure_remove_device() documentation to match reality Lee Jones
2020-06-29 14:04 ` [PATCH 16/20] misc: genwqe: card_base: Remove set but unused variable 'rc' Lee Jones
2020-06-30 7:17 ` haver
2020-06-30 7:42 ` Lee Jones
2020-06-30 8:03 ` haver
2020-06-30 8:12 ` Lee Jones
2020-06-29 14:04 ` [PATCH 17/20] misc: genwqe: card_base: Do not pass unused argument 'fatal_err' Lee Jones
2020-06-30 7:35 ` haver
2020-06-30 9:10 ` Lee Jones
2020-06-30 9:54 ` haver
2020-06-30 14:00 ` Lee Jones
2020-06-29 14:04 ` [PATCH 18/20] misc: genwqe: card_base: Whole host of kerneldoc fixes Lee Jones
2020-06-30 7:24 ` haver
2020-06-29 14:04 ` [PATCH 19/20] misc: genwqe: card_dev: " Lee Jones
2020-06-30 7:25 ` haver
2020-06-29 14:04 ` [PATCH 20/20] misc: genwqe: card_utils: Whole a plethora of documentation issues Lee Jones
2020-06-30 7:26 ` haver
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200629140442.1043957-14-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=arnd@arndb.de \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=masa-korg@dsn.okisemi.com \
--cc=tomoya-linux@dsn.okisemi.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).