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

ASoC: p1022_rdk: fix all kernel-doc warnings

Fix several kernel-doc warnings in p1022_rdk.c:

p1022_rdk.c:70: warning: cannot understand function prototype: 'struct machine_data '
p1022_rdk.c:90: warning: Function parameter or struct member 'card' not described in 'p1022_rdk_machine_probe'
p1022_rdk.c:90: warning: No description found for return value of 'p1022_rdk_machine_probe'
p1022_rdk.c:129: warning: Function parameter or struct member 'substream' not described in 'p1022_rdk_startup'
p1022_rdk.c:129: warning: No description found for return value of 'p1022_rdk_startup'
p1022_rdk.c:162: warning: Function parameter or struct member 'card' not described in 'p1022_rdk_machine_remove'
p1022_rdk.c:162: warning: No description found for return value of 'p1022_rdk_machine_remove'
p1022_rdk.c:187: warning: cannot understand function prototype: 'const struct snd_soc_ops p1022_rdk_ops = '
p1022_rdk.c:199: warning: Function parameter or struct member 'pdev' not described in 'p1022_rdk_probe'
p1022_rdk.c:199: warning: No description found for return value of 'p1022_rdk_probe'
p1022_rdk.c:349: warning: Function parameter or struct member 'pdev' not described in 'p1022_rdk_remove'
p1022_rdk.c:376: warning: No description found for return value of 'p1022_rdk_init'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: <linux-sound@vger.kernel.org>
Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Takashi Iwai <tiwai@suse.com>
Link: https://msgid.link/r/20240111045736.7500-1-rdunlap@infradead.org
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Randy Dunlap and committed by
Mark Brown
90050b8d 059870e5

+24 -9
+24 -9
sound/soc/fsl/p1022_rdk.c
··· 61 61 /* There's only one global utilities register */ 62 62 static phys_addr_t guts_phys; 63 63 64 - /** 64 + /* 65 65 * machine_data: machine-specific ASoC device data 66 66 * 67 67 * This structure contains data for a single sound platform device on an ··· 80 80 }; 81 81 82 82 /** 83 - * p1022_rdk_machine_probe: initialize the board 83 + * p1022_rdk_machine_probe - initialize the board 84 + * @card: ASoC card instance 84 85 * 85 86 * This function is used to initialize the board-specific hardware. 86 87 * 87 88 * Here we program the DMACR and PMUXCR registers. 89 + * 90 + * Returns: %0 on success or negative errno value on error 88 91 */ 89 92 static int p1022_rdk_machine_probe(struct snd_soc_card *card) 90 93 { ··· 122 119 } 123 120 124 121 /** 125 - * p1022_rdk_startup: program the board with various hardware parameters 122 + * p1022_rdk_startup - program the board with various hardware parameters 123 + * @substream: ASoC substream object 126 124 * 127 125 * This function takes board-specific information, like clock frequencies 128 126 * and serial data formats, and passes that information to the codec and 129 127 * transport drivers. 128 + * 129 + * Returns: %0 on success or negative errno value on error 130 130 */ 131 131 static int p1022_rdk_startup(struct snd_pcm_substream *substream) 132 132 { ··· 159 153 } 160 154 161 155 /** 162 - * p1022_rdk_machine_remove: Remove the sound device 156 + * p1022_rdk_machine_remove - Remove the sound device 157 + * @card: ASoC card instance 163 158 * 164 159 * This function is called to remove the sound device for one SSI. We 165 160 * de-program the DMACR and PMUXCR register. 161 + * 162 + * Returns: %0 on success or negative errno value on error 166 163 */ 167 164 static int p1022_rdk_machine_remove(struct snd_soc_card *card) 168 165 { ··· 190 181 return 0; 191 182 } 192 183 193 - /** 184 + /* 194 185 * p1022_rdk_ops: ASoC machine driver operations 195 186 */ 196 187 static const struct snd_soc_ops p1022_rdk_ops = { ··· 198 189 }; 199 190 200 191 /** 201 - * p1022_rdk_probe: platform probe function for the machine driver 192 + * p1022_rdk_probe - platform probe function for the machine driver 193 + * @pdev: platform device pointer 202 194 * 203 195 * Although this is a machine driver, the SSI node is the "master" node with 204 196 * respect to audio hardware connections. Therefore, we create a new ASoC 205 197 * device for each new SSI node that has a codec attached. 198 + * 199 + * Returns: %0 on success or negative errno value on error 206 200 */ 207 201 static int p1022_rdk_probe(struct platform_device *pdev) 208 202 { ··· 353 341 } 354 342 355 343 /** 356 - * p1022_rdk_remove: remove the platform device 344 + * p1022_rdk_remove - remove the platform device 345 + * @pdev: platform device pointer 357 346 * 358 347 * This function is called when the platform device is removed. 359 348 */ ··· 381 368 }; 382 369 383 370 /** 384 - * p1022_rdk_init: machine driver initialization. 371 + * p1022_rdk_init - machine driver initialization. 385 372 * 386 373 * This function is called when this module is loaded. 374 + * 375 + * Returns: %0 on success or negative errno value on error 387 376 */ 388 377 static int __init p1022_rdk_init(void) 389 378 { ··· 406 391 } 407 392 408 393 /** 409 - * p1022_rdk_exit: machine driver exit 394 + * p1022_rdk_exit - machine driver exit 410 395 * 411 396 * This function is called when this driver is unloaded. 412 397 */