[PATCH] tpm: Fix the description error of the help information in Kconfig

[PATCH] tpm: Fix the description error of the help information in Kconfig

[Tianjia Zhang]

Obviously, the TPM version number in the help message is wrong, which
will cause confusion. This patch fixes it.

Signed-off-by: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>
---
 drivers/char/tpm/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
index 58b4c573d176..8eedb3e704f3 100644
--- a/drivers/char/tpm/Kconfig
+++ b/drivers/char/tpm/Kconfig
@@ -62,7 +62,7 @@ config TCG_TIS_SPI
 	help
 	  If you have a TPM security chip which is connected to a regular,
 	  non-tcg SPI master (i.e. most embedded platforms) that is compliant with the
-	  TCG TIS 1.3 TPM specification (TPM1.2) or the TCG PTP FIFO
+	  TCG TIS 1.3 TPM specification (TPM1.3) or the TCG PTP FIFO
 	  specification (TPM2.0) say Yes and it will be accessible from
 	  within Linux. To compile this driver as a module, choose  M here;
 	  the module will be called tpm_tis_spi.
-- 
2.17.1

Re: [PATCH] tpm: Fix the description error of the help information in Kconfig

[Arnd Bergmann]

On Mon, Jul 27, 2020 at 4:54 AM Tianjia Zhang
<tianjia.zhang@linux.alibaba.com> wrote:
>
> Obviously, the TPM version number in the help message is wrong, which
> will cause confusion. This patch fixes it.

How is this "obvious"? I tried finding the specification and could not
see anything
to back up TIS 1.3 being only supported with TPM 1.3, or the existence of a
TPM 1.3 specification at all.

Please consider that not everyone reading this patch description is deeply
familiar with the details and explain exactly what the mistake is.

> Signed-off-by: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>

In a bug fix, try to always add a 'FIxes' tag such as 'Fixes: 0edbfea537d1
("tpm/tpm_tis_spi: Add support for spi phy")', and Cc everyone that was
involved in the original patch that introduced a bug so they can Ack or
Nak it.

      Arnd

>  drivers/char/tpm/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
> index 58b4c573d176..8eedb3e704f3 100644
> --- a/drivers/char/tpm/Kconfig
> +++ b/drivers/char/tpm/Kconfig
> @@ -62,7 +62,7 @@ config TCG_TIS_SPI
>         help
>           If you have a TPM security chip which is connected to a regular,
>           non-tcg SPI master (i.e. most embedded platforms) that is compliant with the
> -         TCG TIS 1.3 TPM specification (TPM1.2) or the TCG PTP FIFO
> +         TCG TIS 1.3 TPM specification (TPM1.3) or the TCG PTP FIFO
>           specification (TPM2.0) say Yes and it will be accessible from
>           within Linux. To compile this driver as a module, choose  M here;
>           the module will be called tpm_tis_spi.
> --
> 2.17.1
>

Re: [PATCH] tpm: Fix the description error of the help information in Kconfig

[Tianjia Zhang]

Thanks for your advice, I have submitted a v2 patch.

Thanks,
Tianjia

On 2020/7/27 15:10, Arnd Bergmann wrote:
> On Mon, Jul 27, 2020 at 4:54 AM Tianjia Zhang
> <tianjia.zhang@linux.alibaba.com> wrote:
>>
>> Obviously, the TPM version number in the help message is wrong, which
>> will cause confusion. This patch fixes it.
> 
> How is this "obvious"? I tried finding the specification and could not
> see anything
> to back up TIS 1.3 being only supported with TPM 1.3, or the existence of a
> TPM 1.3 specification at all.
> 
> Please consider that not everyone reading this patch description is deeply
> familiar with the details and explain exactly what the mistake is.
> 
>> Signed-off-by: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>
> 
> In a bug fix, try to always add a 'FIxes' tag such as 'Fixes: 0edbfea537d1
> ("tpm/tpm_tis_spi: Add support for spi phy")', and Cc everyone that was
> involved in the original patch that introduced a bug so they can Ack or
> Nak it.
> 
>        Arnd
> 
>>   drivers/char/tpm/Kconfig | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
>> index 58b4c573d176..8eedb3e704f3 100644
>> --- a/drivers/char/tpm/Kconfig
>> +++ b/drivers/char/tpm/Kconfig
>> @@ -62,7 +62,7 @@ config TCG_TIS_SPI
>>          help
>>            If you have a TPM security chip which is connected to a regular,
>>            non-tcg SPI master (i.e. most embedded platforms) that is compliant with the
>> -         TCG TIS 1.3 TPM specification (TPM1.2) or the TCG PTP FIFO
>> +         TCG TIS 1.3 TPM specification (TPM1.3) or the TCG PTP FIFO
>>            specification (TPM2.0) say Yes and it will be accessible from
>>            within Linux. To compile this driver as a module, choose  M here;
>>            the module will be called tpm_tis_spi.
>> --
>> 2.17.1
>>

RE: [PATCH] tpm: Fix the description error of the help information in Kconfig

[Peter.Huewe]

Hi,
On 2020/7/27 15:10, Arnd Bergmann wrote:
> On Mon, Jul 27, 2020 at 4:54 AM Tianjia Zhang 
> <tianjia.zhang@linux.alibaba.com> wrote:
>>
>> Obviously, the TPM version number in the help message is wrong, which 
>> will cause confusion. This patch fixes it.
> 
> How is this "obvious"? I tried finding the specification and could not 
> see anything to back up TIS 1.3 being only supported with TPM 1.3, or 
> the existence of a TPM 1.3 specification at all.
> 
There is no TPM 1.3.

There is a TIS Specification 1.3 which applies to TPM1.2 
These are different specs, with different version numbers.
So the fix is incorrect.

Thanks,
Peter

Re: [PATCH] tpm: Fix the description error of the help information in Kconfig

[Tianjia Zhang]

On 2020/7/27 16:33, Peter.Huewe@infineon.com wrote:
> Hi,
> On 2020/7/27 15:10, Arnd Bergmann wrote:
>> On Mon, Jul 27, 2020 at 4:54 AM Tianjia Zhang
>> <tianjia.zhang@linux.alibaba.com> wrote:
>>>
>>> Obviously, the TPM version number in the help message is wrong, which
>>> will cause confusion. This patch fixes it.
>>
>> How is this "obvious"? I tried finding the specification and could not
>> see anything to back up TIS 1.3 being only supported with TPM 1.3, or
>> the existence of a TPM 1.3 specification at all.
>>
> There is no TPM 1.3.
> 
> There is a TIS Specification 1.3 which applies to TPM1.2
> These are different specs, with different version numbers.
> So the fix is incorrect.
> 
> Thanks,
> Peter
> 

You are right, I was careless, thanks for your reply.

Thanks and best,
Tianjia