[PATCH v3] tpm: fix kdoc for tpm2_flush_context_cmd()

[PATCH v3] tpm: fix kdoc for tpm2_flush_context_cmd()

[Tomas Winkler]

kdoc for tpm2_flush_context_cmd() was off.

Fixes: 9aa36b399a50 ("tpm: export tpm2_flush_context_cmd")'
Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
V2: drop 'commit' from Fixes:
V3: Align arguments with tab.
 drivers/char/tpm/tpm2-cmd.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/char/tpm/tpm2-cmd.c b/drivers/char/tpm/tpm2-cmd.c
index ae86fb0218ab..a6bec13afa69 100644
--- a/drivers/char/tpm/tpm2-cmd.c
+++ b/drivers/char/tpm/tpm2-cmd.c
@@ -342,11 +342,10 @@ int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
 
 /**
  * tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
- * @chip: TPM chip to use
- * @payload: the key data in clear and encrypted form
- * @options: authentication values and other options
+ * @chip:	TPM chip to use
+ * @handle:	context handle
+ * @flags:	tpm transmit flags - bitmap
  *
- * Return: same as with tpm_transmit_cmd
  */
 void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
 			    unsigned int flags)
-- 
2.14.5

[PATCH] tpm: tpm_ibmvtpm: fix kdoc warnings

[Tomas Winkler]

Remove redundant lines in the kdoc:

Fixes kdoc warnings:

drivers/char/tpm/tpm_ibmvtpm.c:42: warning: Cannot understand  *
 on line 42 - I thought it was a doc line
drivers/char/tpm/tpm_ibmvtpm.c:57: warning: Cannot understand  *
 on line 57 - I thought it was a doc line

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
 drivers/char/tpm/tpm_ibmvtpm.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/char/tpm/tpm_ibmvtpm.c b/drivers/char/tpm/tpm_ibmvtpm.c
index 25f6e2665385..07b5a487d0c8 100644
--- a/drivers/char/tpm/tpm_ibmvtpm.c
+++ b/drivers/char/tpm/tpm_ibmvtpm.c
@@ -39,8 +39,7 @@ static const struct vio_device_id tpm_ibmvtpm_device_table[] = {
 MODULE_DEVICE_TABLE(vio, tpm_ibmvtpm_device_table);
 
 /**
- *
- * ibmvtpm_send_crq_word - Send a CRQ request
+ * ibmvtpm_send_crq_word() - Send a CRQ request
  * @vdev:	vio device struct
  * @w1:		pre-constructed first word of tpm crq (second word is reserved)
  *
@@ -54,8 +53,7 @@ static int ibmvtpm_send_crq_word(struct vio_dev *vdev, u64 w1)
 }
 
 /**
- *
- * ibmvtpm_send_crq - Send a CRQ request
+ * ibmvtpm_send_crq() - Send a CRQ request
  *
  * @vdev:	vio device struct
  * @valid:	Valid field
-- 
2.14.5

Re: [PATCH] tpm: tpm_ibmvtpm: fix kdoc warnings

[Jarkko Sakkinen]

On Fri, 26 Oct 2018, Tomas Winkler wrote:
> Remove redundant lines in the kdoc:
>
> Fixes kdoc warnings:
>
> drivers/char/tpm/tpm_ibmvtpm.c:42: warning: Cannot understand  *
> on line 42 - I thought it was a doc line
> drivers/char/tpm/tpm_ibmvtpm.c:57: warning: Cannot understand  *
> on line 57 - I thought it was a doc line
>
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
> ---
> drivers/char/tpm/tpm_ibmvtpm.c | 6 ++----
> 1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/char/tpm/tpm_ibmvtpm.c b/drivers/char/tpm/tpm_ibmvtpm.c
> index 25f6e2665385..07b5a487d0c8 100644
> --- a/drivers/char/tpm/tpm_ibmvtpm.c
> +++ b/drivers/char/tpm/tpm_ibmvtpm.c
> @@ -39,8 +39,7 @@ static const struct vio_device_id tpm_ibmvtpm_device_table[] = {
> MODULE_DEVICE_TABLE(vio, tpm_ibmvtpm_device_table);
>
> /**
> - *
> - * ibmvtpm_send_crq_word - Send a CRQ request
> + * ibmvtpm_send_crq_word() - Send a CRQ request
>  * @vdev:	vio device struct
>  * @w1:		pre-constructed first word of tpm crq (second word is reserved)
>  *
> @@ -54,8 +53,7 @@ static int ibmvtpm_send_crq_word(struct vio_dev *vdev, u64 w1)
> }
>
> /**
> - *
> - * ibmvtpm_send_crq - Send a CRQ request
> + * ibmvtpm_send_crq() - Send a CRQ request
>  *
>  * @vdev:	vio device struct
>  * @valid:	Valid field
> -- 
> 2.14.5
>
>

Reviewed-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>

/Jarkko

Re: [PATCH v3] tpm: fix kdoc for tpm2_flush_context_cmd()

[Jarkko Sakkinen]

On Fri, 26 Oct 2018, Tomas Winkler wrote:
> kdoc for tpm2_flush_context_cmd() was off.
>
> Fixes: 9aa36b399a50 ("tpm: export tpm2_flush_context_cmd")'
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
> ---
> V2: drop 'commit' from Fixes:
> V3: Align arguments with tab.
> drivers/char/tpm/tpm2-cmd.c | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/char/tpm/tpm2-cmd.c b/drivers/char/tpm/tpm2-cmd.c
> index ae86fb0218ab..a6bec13afa69 100644
> --- a/drivers/char/tpm/tpm2-cmd.c
> +++ b/drivers/char/tpm/tpm2-cmd.c
> @@ -342,11 +342,10 @@ int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
>
> /**
>  * tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
> - * @chip: TPM chip to use
> - * @payload: the key data in clear and encrypted form
> - * @options: authentication values and other options
> + * @chip:	TPM chip to use
> + * @handle:	context handle
> + * @flags:	tpm transmit flags - bitmap
>  *
> - * Return: same as with tpm_transmit_cmd
>  */
> void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
> 			    unsigned int flags)
> -- 
> 2.14.5
>
>

Great, thank you.

Reviewed-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>

/Jarkko