From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Thomas Richard <thomas.richard@bootlin.com>,
Lee Jones <lee@kernel.org>
Subject: [PATCH] mfd: si476x: fix kernel-doc warnings
Date: Mon, 23 Feb 2026 12:12:13 -0800 [thread overview]
Message-ID: <20260223201213.3092399-4-rdunlap@infradead.org> (raw)
In-Reply-To: <20260223201213.3092399-1-rdunlap@infradead.org>
Add kernel-doc entries for missing fields or correct some typos
in names to eliminate kernel-doc warnings:
Warning: include/linux/mfd/si476x-core.h:156 struct member 'regmap' not
described in 'si476x_core'
Warning: include/linux/mfd/si476x-core.h:156 struct member 'power_state'
not described in 'si476x_core'
Warning: include/linux/mfd/si476x-core.h:156 struct member 'supplies' not
described in 'si476x_core'
Warning: include/linux/mfd/si476x-core.h:156 struct member 'is_alive' not
described in 'si476x_core'
Warning: include/linux/mfd/si476x-core.h:156 struct member 'rds_fifo_depth'
not described in 'si476x_core'
Warning: include/linux/mfd/si476x-core.h:170 function parameter 'core' not
described in 'si476x_core_lock'
Warning: include/linux/mfd/si476x-core.h:179 function parameter 'core' not
described in 'si476x_core_unlock'
Warning: include/linux/mfd/si476x-core.h:259 struct member 'firmware' not
described in 'si476x_func_info'
Warning: include/linux/mfd/si476x-core.h:335 struct member 'rds' not
described in 'si476x_rds_status_report'
I don't know what the 'ble' field is so I didn't add a kernel-doc comment
for it:
Warning: include/linux/mfd/si476x-core.h:335 struct member 'ble' not
described in 'si476x_rds_status_report'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Lee Jones <lee@kernel.org>
include/linux/mfd/si476x-core.h | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
--- linux-next-20260220.orig/include/linux/mfd/si476x-core.h
+++ linux-next-20260220/include/linux/mfd/si476x-core.h
@@ -77,6 +77,7 @@ enum si476x_power_state {
* underlying "core" device which all the MFD cell-devices use.
*
* @client: Actual I2C client used to transfer commands to the chip.
+ * @regmap: Regmap for accessing the device registers
* @chip_id: Last digit of the chip model(E.g. "1" for SI4761)
* @cells: MFD cell devices created by this driver.
* @cmd_lock: Mutex used to serialize all the requests to the core
@@ -100,16 +101,18 @@ enum si476x_power_state {
* @stc: Similar to @cts, but for the STC bit of the status value.
* @power_up_parameters: Parameters used as argument for POWER_UP
* command when the device is started.
- * @state: Current power state of the device.
- * @supplues: Structure containing handles to all power supplies used
+ * @power_state: Current power state of the device.
+ * @supplies: Structure containing handles to all power supplies used
* by the device (NULL ones are ignored).
* @gpio_reset: GPIO pin connectet to the RSTB pin of the chip.
* @pinmux: Chip's configurable pins configuration.
* @diversity_mode: Chips role when functioning in diversity mode.
+ * @is_alive: Chip is initialized and active.
* @status_monitor: Polling worker used in polling use case scenarion
* (when IRQ is not avalible).
* @revision: Chip's running firmware revision number(Used for correct
* command set support).
+ * @rds_fifo_depth: RDS FIFO size: 20 for IRQ mode or 5 for polling mode.
*/
struct si476x_core {
@@ -166,6 +169,7 @@ static inline struct si476x_core *i2c_mf
/**
* si476x_core_lock() - lock the core device to get an exclusive access
* to it.
+ * @core: Core device structure
*/
static inline void si476x_core_lock(struct si476x_core *core)
{
@@ -175,6 +179,7 @@ static inline void si476x_core_lock(stru
/**
* si476x_core_unlock() - unlock the core device to relinquish an
* exclusive access to it.
+ * @core: Core device structure
*/
static inline void si476x_core_unlock(struct si476x_core *core)
{
@@ -246,9 +251,10 @@ static inline int si476x_to_v4l2(struct
* struct si476x_func_info - structure containing result of the
* FUNC_INFO command.
*
+ * @firmware: Firmware version numbers.
* @firmware.major: Firmware major number.
* @firmware.minor[...]: Firmware minor numbers.
- * @patch_id:
+ * @patch_id: Firmware patch level.
* @func: Mode tuner is working in.
*/
struct si476x_func_info {
@@ -318,8 +324,9 @@ enum si476x_smoothmetrics {
* @tp: Current channel's TP flag.
* @pty: Current channel's PTY code.
* @pi: Current channel's PI code.
- * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if
- * empty).
+ * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if empty).
+ * @ble:
+ * @rds: RDS data descriptor
*/
struct si476x_rds_status_report {
bool rdstpptyint, rdspiint, rdssyncint, rdsfifoint;
next prev parent reply other threads:[~2026-02-23 20:12 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-23 20:12 [PATCH] mfd: Congatec: fix kernel-doc struct member names Randy Dunlap
2026-02-23 20:12 ` [PATCH] mfd: Kontron PLD: " Randy Dunlap
2026-02-23 20:12 ` [PATCH] mfd: rsmu: remove a empty kernel-doc line Randy Dunlap
2026-03-06 13:46 ` Lee Jones
2026-02-23 20:12 ` Randy Dunlap [this message]
2026-03-06 12:58 ` [PATCH] mfd: Congatec: fix kernel-doc struct member names Lee Jones
2026-03-06 20:27 ` Randy Dunlap
2026-03-09 9:52 ` Lee Jones
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=20260223201213.3092399-4-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=lee@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=thomas.richard@bootlin.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
all inboxes | Powered by JetHome®