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

bus: fsl-mc: mc-sys: Supply missing function names in kernel-doc headers

Fixes the following W=1 kernel build warning(s):

drivers/bus/fsl-mc/mc-sys.c:20: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/bus/fsl-mc/mc-sys.c:151: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/bus/fsl-mc/mc-sys.c:197: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/bus/fsl-mc/mc-sys.c:237: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Stuart Yoder <stuyoder@gmail.com>
Reviewed-by: Laurentiu Tudor <laurentiu.tudor@nxp.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210617110500.15907-2-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
33c6527a 337c7563

+10 -9
+10 -9
drivers/bus/fsl-mc/mc-sys.c
··· 16 16 17 17 #include "fsl-mc-private.h" 18 18 19 - /** 19 + /* 20 20 * Timeout in milliseconds to wait for the completion of an MC command 21 21 */ 22 22 #define MC_CMD_COMPLETION_TIMEOUT_MS 500 ··· 148 148 } 149 149 150 150 /** 151 - * Waits for the completion of an MC command doing preemptible polling. 152 - * uslepp_range() is called between polling iterations. 153 - * 151 + * mc_polling_wait_preemptible() - Waits for the completion of an MC 152 + * command doing preemptible polling. 153 + * uslepp_range() is called between 154 + * polling iterations. 154 155 * @mc_io: MC I/O object to be used 155 156 * @cmd: command buffer to receive MC response 156 157 * @mc_status: MC command completion status ··· 195 194 } 196 195 197 196 /** 198 - * Waits for the completion of an MC command doing atomic polling. 199 - * udelay() is called between polling iterations. 200 - * 197 + * mc_polling_wait_atomic() - Waits for the completion of an MC command 198 + * doing atomic polling. udelay() is called 199 + * between polling iterations. 201 200 * @mc_io: MC I/O object to be used 202 201 * @cmd: command buffer to receive MC response 203 202 * @mc_status: MC command completion status ··· 235 234 } 236 235 237 236 /** 238 - * Sends a command to the MC device using the given MC I/O object 239 - * 237 + * mc_send_command() - Sends a command to the MC device using the given 238 + * MC I/O object 240 239 * @mc_io: MC I/O object to be used 241 240 * @cmd: command to be sent 242 241 *