tpm: cr50: fix kernel-doc warning and spelling

Message ID 20231222061916.9552-1-rdunlap@infradead.org
State New
Headers
Series tpm: cr50: fix kernel-doc warning and spelling |

Commit Message

Randy Dunlap Dec. 22, 2023, 6:19 a.m. UTC
  Fix kernel-doc notation to prevent a warning:
tpm_tis_i2c_cr50.c:681: warning: Excess function parameter 'id' description in 'tpm_cr50_i2c_probe'

and fix a spelling error reported by codespell.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
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_tis_i2c_cr50.c |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
  

Comments

Jarkko Sakkinen Jan. 3, 2024, 1:43 p.m. UTC | #1
On Fri Dec 22, 2023 at 8:19 AM EET, Randy Dunlap wrote:
> Fix kernel-doc notation to prevent a warning:
> tpm_tis_i2c_cr50.c:681: warning: Excess function parameter 'id' description in 'tpm_cr50_i2c_probe'
>
> and fix a spelling error reported by codespell.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> 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_tis_i2c_cr50.c |    3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff -- a/drivers/char/tpm/tpm_tis_i2c_cr50.c b/drivers/char/tpm/tpm_tis_i2c_cr50.c
> --- a/drivers/char/tpm/tpm_tis_i2c_cr50.c
> +++ b/drivers/char/tpm/tpm_tis_i2c_cr50.c
> @@ -235,7 +235,7 @@ out:
>   * @len:	Number of bytes to write.
>   *
>   * The provided address is prepended to the data in 'buffer', the
> - * cobined address+data is sent to the TPM, then wait for TPM to
> + * combined address+data is sent to the TPM, then wait for TPM to
>   * indicate it is done writing.
>   *
>   * Return:
> @@ -671,7 +671,6 @@ MODULE_DEVICE_TABLE(of, of_cr50_i2c_matc
>  /**
>   * tpm_cr50_i2c_probe() - Driver probe function.
>   * @client:	I2C client information.
> - * @id:		I2C device id.
>   *
>   * Return:
>   * - 0:		Success.


Reviewed-by: Jarkko Sakkinen <jarkko.sakkinen@kernel.org>

BR, Jarkko
  

Patch

diff -- a/drivers/char/tpm/tpm_tis_i2c_cr50.c b/drivers/char/tpm/tpm_tis_i2c_cr50.c
--- a/drivers/char/tpm/tpm_tis_i2c_cr50.c
+++ b/drivers/char/tpm/tpm_tis_i2c_cr50.c
@@ -235,7 +235,7 @@  out:
  * @len:	Number of bytes to write.
  *
  * The provided address is prepended to the data in 'buffer', the
- * cobined address+data is sent to the TPM, then wait for TPM to
+ * combined address+data is sent to the TPM, then wait for TPM to
  * indicate it is done writing.
  *
  * Return:
@@ -671,7 +671,6 @@  MODULE_DEVICE_TABLE(of, of_cr50_i2c_matc
 /**
  * tpm_cr50_i2c_probe() - Driver probe function.
  * @client:	I2C client information.
- * @id:		I2C device id.
  *
  * Return:
  * - 0:		Success.