tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Randy Dunlap and committed by
Lee Jones 92601fb9 5671125a

+12 -5
+12 -5
include/linux/mfd/si476x-core.h
··· 77 77 * underlying "core" device which all the MFD cell-devices use. 78 78 * 79 79 * @client: Actual I2C client used to transfer commands to the chip. 80 + * @regmap: Regmap for accessing the device registers 80 81 * @chip_id: Last digit of the chip model(E.g. "1" for SI4761) 81 82 * @cells: MFD cell devices created by this driver. 82 83 * @cmd_lock: Mutex used to serialize all the requests to the core ··· 101 100 * @stc: Similar to @cts, but for the STC bit of the status value. 102 101 * @power_up_parameters: Parameters used as argument for POWER_UP 103 102 * command when the device is started. 104 - * @state: Current power state of the device. 105 - * @supplues: Structure containing handles to all power supplies used 103 + * @power_state: Current power state of the device. 104 + * @supplies: Structure containing handles to all power supplies used 106 105 * by the device (NULL ones are ignored). 107 106 * @gpio_reset: GPIO pin connectet to the RSTB pin of the chip. 108 107 * @pinmux: Chip's configurable pins configuration. 109 108 * @diversity_mode: Chips role when functioning in diversity mode. 109 + * @is_alive: Chip is initialized and active. 110 110 * @status_monitor: Polling worker used in polling use case scenarion 111 111 * (when IRQ is not avalible). 112 112 * @revision: Chip's running firmware revision number(Used for correct 113 113 * command set support). 114 + * @rds_fifo_depth: RDS FIFO size: 20 for IRQ mode or 5 for polling mode. 114 115 */ 115 116 116 117 struct si476x_core { ··· 169 166 /** 170 167 * si476x_core_lock() - lock the core device to get an exclusive access 171 168 * to it. 169 + * @core: Core device structure 172 170 */ 173 171 static inline void si476x_core_lock(struct si476x_core *core) 174 172 { ··· 179 175 /** 180 176 * si476x_core_unlock() - unlock the core device to relinquish an 181 177 * exclusive access to it. 178 + * @core: Core device structure 182 179 */ 183 180 static inline void si476x_core_unlock(struct si476x_core *core) 184 181 { ··· 251 246 * struct si476x_func_info - structure containing result of the 252 247 * FUNC_INFO command. 253 248 * 249 + * @firmware: Firmware version numbers. 254 250 * @firmware.major: Firmware major number. 255 251 * @firmware.minor[...]: Firmware minor numbers. 256 - * @patch_id: 252 + * @patch_id: Firmware patch level. 257 253 * @func: Mode tuner is working in. 258 254 */ 259 255 struct si476x_func_info { ··· 324 318 * @tp: Current channel's TP flag. 325 319 * @pty: Current channel's PTY code. 326 320 * @pi: Current channel's PI code. 327 - * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if 328 - * empty). 321 + * @rdsfifoused: Number of blocks remaining in the RDS FIFO (0 if empty). 322 + * @ble: 323 + * @rds: RDS data descriptor 329 324 */ 330 325 struct si476x_rds_status_report { 331 326 bool rdstpptyint, rdspiint, rdssyncint, rdsfifoint;