Skip to content

Commit 92601fb

Browse files
rddunlaplag-linaro
authored andcommitted
mfd: si476x: Fix kernel-doc warnings
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> Link: https://patch.msgid.link/20260309214223.749088-5-rdunlap@infradead.org Signed-off-by: Lee Jones <lee@kernel.org>
1 parent 5671125 commit 92601fb

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

include/linux/mfd/si476x-core.h

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ enum si476x_power_state {
7777
* underlying "core" device which all the MFD cell-devices use.
7878
*
7979
* @client: Actual I2C client used to transfer commands to the chip.
80+
* @regmap: Regmap for accessing the device registers
8081
* @chip_id: Last digit of the chip model(E.g. "1" for SI4761)
8182
* @cells: MFD cell devices created by this driver.
8283
* @cmd_lock: Mutex used to serialize all the requests to the core
@@ -100,16 +101,18 @@ enum si476x_power_state {
100101
* @stc: Similar to @cts, but for the STC bit of the status value.
101102
* @power_up_parameters: Parameters used as argument for POWER_UP
102103
* command when the device is started.
103-
* @state: Current power state of the device.
104-
* @supplues: Structure containing handles to all power supplies used
104+
* @power_state: Current power state of the device.
105+
* @supplies: Structure containing handles to all power supplies used
105106
* by the device (NULL ones are ignored).
106107
* @gpio_reset: GPIO pin connectet to the RSTB pin of the chip.
107108
* @pinmux: Chip's configurable pins configuration.
108109
* @diversity_mode: Chips role when functioning in diversity mode.
110+
* @is_alive: Chip is initialized and active.
109111
* @status_monitor: Polling worker used in polling use case scenarion
110112
* (when IRQ is not avalible).
111113
* @revision: Chip's running firmware revision number(Used for correct
112114
* command set support).
115+
* @rds_fifo_depth: RDS FIFO size: 20 for IRQ mode or 5 for polling mode.
113116
*/
114117

115118
struct si476x_core {
@@ -166,6 +169,7 @@ static inline struct si476x_core *i2c_mfd_cell_to_core(struct device *dev)
166169
/**
167170
* si476x_core_lock() - lock the core device to get an exclusive access
168171
* to it.
172+
* @core: Core device structure
169173
*/
170174
static inline void si476x_core_lock(struct si476x_core *core)
171175
{
@@ -175,6 +179,7 @@ static inline void si476x_core_lock(struct si476x_core *core)
175179
/**
176180
* si476x_core_unlock() - unlock the core device to relinquish an
177181
* exclusive access to it.
182+
* @core: Core device structure
178183
*/
179184
static inline void si476x_core_unlock(struct si476x_core *core)
180185
{
@@ -246,9 +251,10 @@ static inline int si476x_to_v4l2(struct si476x_core *core, u16 freq)
246251
* struct si476x_func_info - structure containing result of the
247252
* FUNC_INFO command.
248253
*
254+
* @firmware: Firmware version numbers.
249255
* @firmware.major: Firmware major number.
250256
* @firmware.minor[...]: Firmware minor numbers.
251-
* @patch_id:
257+
* @patch_id: Firmware patch level.
252258
* @func: Mode tuner is working in.
253259
*/
254260
struct si476x_func_info {
@@ -318,8 +324,9 @@ enum si476x_smoothmetrics {
318324
* @tp: Current channel's TP flag.
319325
* @pty: Current channel's PTY code.
320326
* @pi: Current channel's PI code.
321-
* @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if
322-
* empty).
327+
* @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if empty).
328+
* @ble:
329+
* @rds: RDS data descriptor
323330
*/
324331
struct si476x_rds_status_report {
325332
bool rdstpptyint, rdspiint, rdssyncint, rdsfifoint;

0 commit comments

Comments
 (0)