tpm: add retry logic
Subsystems (2)
James Bottomley
maintainerPATCH 1/1 tpm: add retry logic
TPM2 can return TPM2_RC_RETRY to any command and when it does we get unexpected failures inside the kernel that surprise users (this is mostly observed in the trusted key handling code). The UEFI 2.6 spec has advice on how to handle this:
The firmware SHALL not return TPM2_RC_RETRY prior to the completion of the call to ExitBootServices().
Implementer's Note: the implementation of this function should check the return value in the TPM response and, if it is TPM2_RC_RETRY, resend the command. The implementation may abort if a sufficient number of retries has been done.
So we follow that advice in our tpm_transmit() code using TPM2_DURATION_SHORT as the initial wait duration and TPM2_DURATION_LONG as the maximum wait time. This should fix all the in-kernel use cases and also means that user space TSS implementations don't have to have their own retry handling.
--- drivers/char/tpm/tpm-interface.c | 75 ++++++++++++++++++++++++++++++++-------- drivers/char/tpm/tpm.h | 1 + 2 files changed, 61 insertions(+), 15 deletions(-)
drivers/char/tpm/tpm-interface.c +60 -15
@@ -398,21 +398,10 @@ static void tpm_relinquish_locality(struct tpm_chip *chip) chip->locality =-1 ; } -/** -* tpm_transmit - Internal kernel interface to transmit TPM commands. -* -* @chip: TPM chip to use -* @space: tpm space -* @buf: TPM command buffer -* @bufsiz: length of the TPM command buffer -* @flags: tpm transmit flags - bitmap -* -* Return: -* 0 when the operation is successful. -* A negative number for system errors (errno). -*/ -ssize_t tpm_transmit (struct tpm_chip *chip,struct tpm_space *space, -u8 *buf,size_t bufsiz,unsigned int flags) +static ssize_t tpm_transmit_internal (struct tpm_chip *chip, +struct tpm_space *space, +u8 *buf,size_t bufsiz, +unsigned int flags) {struct tpm_output_header *header = (void *)buf;int rc;
@@ -550,6 +539,62 @@ ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space, }/** +* tpm_transmit - Internal kernel interface to transmit TPM commands. +* +* @chip: TPM chip to use +* @space: tpm space +* @buf: TPM command buffer +* @bufsiz: length of the TPM command buffer +* @flags: tpm transmit flags - bitmap +* +* A wrapper around tpm_transmit_internal that handles TPM2_RC_RETRY +* returns from the TPM and retransmits the command after a delay up +* to a maximum wait of TPM2_DURATION_LONG. +* +* Note: TPM1 never returns TPM2_RC_RETRY so the retry logic is TPM2 +* only +* +* Return: +* the length of the return when the operation is successful. +* A negative number for system errors (errno). +*/ +ssize_t tpm_transmit (struct tpm_chip *chip,struct tpm_space *space, +u8 *buf,size_t bufsiz,unsigned int flags) +{ +struct tpm_output_header *header = (struct tpm_output_header *)buf; +/* space for header and handles */ +u8 save[TPM_HEADER_SIZE +3 *sizeof (u32)]; +unsigned int delay_msec =TPM2_DURATION_SHORT ; +u32 rc =0 ; +ssize_t ret; +const size_t save_size =min (space ?sizeof (save):TPM_HEADER_SIZE , + bufsiz); + +/* +* Subtlety here: if we have a space, the handles will be +* transformed, so when we restore the header we also have to +* restore the handles. +*/ +memcpy (save, buf, save_size); + +for (;;) { + ret =tpm_transmit_internal (chip, space, buf, bufsiz, flags); +if (ret <0 ) +break ; + rc =be32_to_cpu (header->return_code); +if (rc !=TPM2_RC_RETRY ) +break ; + delay_msec *=2 ; +if (delay_msec >TPM2_DURATION_LONG ) { +dev_err (&chip->dev,"TPM is in retry loop\n" ); +break ; + } +tpm_msleep (delay_msec); +memcpy (buf, save, save_size); + } +return ret; +} +/** * tpm_transmit_cmd - send a tpm command to the device * The function extracts tpm out header return code *
drivers/char/tpm/tpm.h +1 -0
@@ -113,6 +113,7 @@ enum tpm2_return_codes {TPM2_RC_COMMAND_CODE =0x0143 ,TPM2_RC_TESTING =0x090A ,/* RC_WARN */ TPM2_RC_REFERENCE_H0 =0x0910 , + TPM2_RC_RETRY = 0x0922, }; enum tpm2_algorithms {
Signature · 1 line
2.12.3
Quoted 5 lines · James Bottomley
TPM2 can return
TPM2_RC_RETRYto any command and when it does we get unexpected failures inside the kernel that surprise users (this is mostly observed in the trusted key handling code). The UEFI 2.6 spec has advice on how to handle this:
Quoted 7 lines
The firmware SHALL not return
TPM2_RC_RETRYprior to the completion of the call toExitBootServices().Implementer's Note: the implementation of this function should check the return value in the TPM response and, if it is
TPM2_RC_RETRY, resend the command. The implementation may abort if a sufficient number of retries has been done.
When does TPM decide to send this code anyway? TCG specifications do not cover this too well, which makes the whole review process quite staggering.
"the TPM was not able to start the command" is essentially a tautology... I wonder who came up with such a bad description.
Quoted 8 lines
So we follow that advice in our
tpm_transmit()code usingTPM2_DURATION_SHORTas the initial wait duration andTPM2_DURATION_LONGas the maximum wait time. This should fix all the in-kernel use cases and also means that user space TSS implementations don't have to have their own retry handling.Signed-off-by James Bottomley <[email protected]>
Didn't look at this before responding to your previous email. This should be a separate commit before the self test change I guess.
Maybe we could:
1. Create a two patch patch set and check that it applies cleanly to my tree.
2.
Quoted 22 lines
--- drivers/char/tpm/tpm-interface.c | 75 ++++++++++++++++++++++++++++++++-------- drivers/char/tpm/tpm.h | 1 + 2 files changed, 61 insertions(+), 15 deletions(-)drivers/char/tpm/tpm-interface.c +0
-9@@ -398,21 +398,10 @@ static void tpm_relinquish_locality(struct tpm_chip *chip) chip->locality =-1 ; } -/** -* tpm_transmit - Internal kernel interface to transmit TPM commands. -* -* @chip: TPM chip to use -* @space: tpm space -* @buf: TPM command buffer -* @bufsiz: length of the TPM command buffer -* @flags: tpm transmit flags - bitmap -*
drivers/char/tpm/tpm-interface.c static void tpm_relinquish_locality(struct tpm_chip *chip) · line 404
Quoted 10 lines
drivers/char/tpm/tpm-interface.c +4
-6-* Return: -* 0 when the operation is successful. -* A negative number for system errors (errno). -*/ -ssize_t tpm_transmit (struct tpm_chip *chip,struct tpm_space *space, -u8 *buf,size_t bufsiz,unsigned int flags) +static ssize_t tpm_transmit_internal (struct tpm_chip *chip, +struct tpm_space *space, +u8 *buf,size_t bufsiz, +unsigned int flags)
I would name this as tpm_try_transmit() because that is what it exactly is given the existence of TPM_RC_RETRY. It is more exact and less abstract naming than tpm_transmit_internal() therefore a better naming.
/Jarkko
James Bottomley
maintainerQuoted 41 lines · Jarkko Sakkinen
Quoted 12 lines · James Bottomley
TPM2 can return
TPM2_RC_RETRYto any command and when it does we get
unexpected failures inside the kernel that surprise users (this is mostly observed in the trusted key handling code). The UEFI 2.6 spec
has advice on how to handle this:The firmware SHALL not return
TPM2_RC_RETRYprior to the
completion
of the call toExitBootServices().Quoted 7 lines
Implementer's Note: the implementation of this function should
check
the return value in the TPM response and, if it isTPM2_RC_RETRY,
resend the command. The implementation may abort if a
sufficient
number of retries has been done.When does TPM decide to send this code anyway? TCG specifications do not cover this too well, which makes the whole review process quite staggering.
"the TPM was not able to start the command" is essentially a tautology... I wonder who came up with such a bad description.
Quoted 9 lines
So we follow that advice in our
tpm_transmit()code usingTPM2_DURATION_SHORTas the initial wait duration andTPM2_DURATION_LONGas the maximum wait time. This should fix all the
in-kernel use cases and also means that user space TSS implementations
don't have to have their own retry handling.Quoted 3 lines
Signed-off-by James Bottomley <[email protected]om>
Cc: [email protected]
Quoted 8 lines
Didn't look at this before responding to your previous email. This should be a separate commit before the self test change I guess.
Maybe we could:
1. Create a two patch patch set and check that it applies cleanly to my tree.
2.
OK, I've built a two patch series on your tree with the original "tpm:
fix intermittent failure with self tests" patch removed and created a new version of it based on the working retry logic.
I'll send it as a proper two sequence patch set.
James
Quoted 51 lines · James Bottomley
Quoted 41 lines · Jarkko Sakkinen
Quoted 12 lines · James Bottomley
TPM2 can return
TPM2_RC_RETRYto any command and when it does we get
unexpected failures inside the kernel that surprise users (this is mostly observed in the trusted key handling code). The UEFI 2.6 spec
has advice on how to handle this:The firmware SHALL not return
TPM2_RC_RETRYprior to the
completion
of the call toExitBootServices().Quoted 7 lines
Implementer's Note: the implementation of this function should
check
the return value in the TPM response and, if it isTPM2_RC_RETRY,
resend the command. The implementation may abort if a
sufficient
number of retries has been done.When does TPM decide to send this code anyway? TCG specifications do not cover this too well, which makes the whole review process quite staggering.
"the TPM was not able to start the command" is essentially a tautology... I wonder who came up with such a bad description.
Quoted 9 lines
So we follow that advice in our
tpm_transmit()code usingTPM2_DURATION_SHORTas the initial wait duration andTPM2_DURATION_LONGas the maximum wait time. This should fix all the
in-kernel use cases and also means that user space TSS implementations
don't have to have their own retry handling.Quoted 3 lines
Signed-off-by James Bottomley <[email protected]om>
Cc: [email protected]Quoted 8 lines
Didn't look at this before responding to your previous email. This should be a separate commit before the self test change I guess.
Maybe we could:
1. Create a two patch patch set and check that it applies cleanly to my tree.
2.
Quoted 5 lines
OK, I've built a two patch series on your tree with the original "tpm:
fix intermittent failure with self tests" patch removed and created a new version of it based on the working retry logic.I'll send it as a proper two sequence patch set.
Awesome, thank you!
/Jarkko