Commit f5721c7a authored Jul 01, 2020 by Lee Jones Committed by Greg Kroah-Hartman Jul 01, 2020

misc: genwqe: card_base: Provide documentation for genwqe_recover_card()'s args

genwqe_recover_card()'s function arguments were missing from its
kerneldoc header. Provide descriptions for 'cd' and 'fatal_err'.

Fixes the following kernel build W=1 warning:

drivers/misc/genwqe/card_base.c:588: warning: Function parameter or member 'cd' not described in 'genwqe_recover_card'
drivers/misc/genwqe/card_base.c:588: warning: Function parameter or member 'fatal_err' not described in 'genwqe_recover_card'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Reviewed-by: Frank Haverkamp <haver@linux.ibm.com>
Link: https://lore.kernel.org/r/20200701085853.164358-18-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent f33e92e5

drivers/misc/genwqe/card_base.c

+2 −0

Original line number	Diff line number	Diff line
		@@ -569,6 +569,8 @@ static int genwqe_stop(struct genwqe_dev *cd)

		/**
		* genwqe_recover_card() - Try to recover the card if it is possible
		* @cd: GenWQE device information
		* @fatal_err: Indicate whether to attempt soft reset
		*
		* If fatal_err is set no register access is possible anymore. It is
		* likely that genwqe_start fails in that situation. Proper error