| Message ID | 20240115192447.26481-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | tpm/tpm_ftpm_tee: fix all kernel-doc warnings | expand |
On Mon Jan 15, 2024 at 7:24 PM UTC, Randy Dunlap wrote: > Change @pdev to @dev in 2 places to match the function parameters. > Correct one function name in kernel-doc comment to match the function > implementation. > > This prevents these warnings: > > tpm_ftpm_tee.c:217: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_probe' > tpm_ftpm_tee.c:217: warning: Excess function parameter 'pdev' description in 'ftpm_tee_probe' > tpm_ftpm_tee.c:313: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_remove' > tpm_ftpm_tee.c:313: warning: Excess function parameter 'pdev' description in 'ftpm_tee_remove' > tpm_ftpm_tee.c:348: warning: expecting prototype for ftpm_tee_shutdown(). Prototype was for ftpm_plat_tee_shutdown() instead > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Thirupathaiah Annapureddy <thiruan@microsoft.com> > Cc: Peter Huewe <peterhuewe@gmx.de> > Cc: Jarkko Sakkinen <jarkko@kernel.org> > Cc: Jason Gunthorpe <jgg@ziepe.ca> > Cc: linux-integrity@vger.kernel.org > --- > drivers/char/tpm/tpm_ftpm_tee.c | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff -- a/drivers/char/tpm/tpm_ftpm_tee.c b/drivers/char/tpm/tpm_ftpm_tee.c > --- a/drivers/char/tpm/tpm_ftpm_tee.c > +++ b/drivers/char/tpm/tpm_ftpm_tee.c > @@ -208,7 +208,7 @@ static int ftpm_tee_match(struct tee_ioc > > /** > * ftpm_tee_probe() - initialize the fTPM > - * @pdev: the platform_device description. > + * @dev: the device description. > * > * Return: > * On success, 0. On failure, -errno. > @@ -304,7 +304,7 @@ static int ftpm_plat_tee_probe(struct pl > > /** > * ftpm_tee_remove() - remove the TPM device > - * @pdev: the platform_device description. > + * @dev: the device description. > * > * Return: > * 0 always. > @@ -341,7 +341,7 @@ static void ftpm_plat_tee_remove(struct > } > > /** > - * ftpm_tee_shutdown() - shutdown the TPM device > + * ftpm_plat_tee_shutdown() - shutdown the TPM device > * @pdev: the platform_device description. > */ > static void ftpm_plat_tee_shutdown(struct platform_device *pdev) Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org> BR, Jarkko
diff -- a/drivers/char/tpm/tpm_ftpm_tee.c b/drivers/char/tpm/tpm_ftpm_tee.c --- a/drivers/char/tpm/tpm_ftpm_tee.c +++ b/drivers/char/tpm/tpm_ftpm_tee.c @@ -208,7 +208,7 @@ static int ftpm_tee_match(struct tee_ioc /** * ftpm_tee_probe() - initialize the fTPM - * @pdev: the platform_device description. + * @dev: the device description. * * Return: * On success, 0. On failure, -errno. @@ -304,7 +304,7 @@ static int ftpm_plat_tee_probe(struct pl /** * ftpm_tee_remove() - remove the TPM device - * @pdev: the platform_device description. + * @dev: the device description. * * Return: * 0 always. @@ -341,7 +341,7 @@ static void ftpm_plat_tee_remove(struct } /** - * ftpm_tee_shutdown() - shutdown the TPM device + * ftpm_plat_tee_shutdown() - shutdown the TPM device * @pdev: the platform_device description. */ static void ftpm_plat_tee_shutdown(struct platform_device *pdev)
Change @pdev to @dev in 2 places to match the function parameters. Correct one function name in kernel-doc comment to match the function implementation. This prevents these warnings: tpm_ftpm_tee.c:217: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_probe' tpm_ftpm_tee.c:217: warning: Excess function parameter 'pdev' description in 'ftpm_tee_probe' tpm_ftpm_tee.c:313: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_remove' tpm_ftpm_tee.c:313: warning: Excess function parameter 'pdev' description in 'ftpm_tee_remove' tpm_ftpm_tee.c:348: warning: expecting prototype for ftpm_tee_shutdown(). Prototype was for ftpm_plat_tee_shutdown() instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Thirupathaiah Annapureddy <thiruan@microsoft.com> Cc: Peter Huewe <peterhuewe@gmx.de> Cc: Jarkko Sakkinen <jarkko@kernel.org> Cc: Jason Gunthorpe <jgg@ziepe.ca> Cc: linux-integrity@vger.kernel.org --- drivers/char/tpm/tpm_ftpm_tee.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)