[PATCH 1/2 v3] tpm: add a function that performs selftest + startup

[Ilias Apalodimas]

Hi Simon, 
On Sat, Jan 28, 2023 at 03:01:22PM -0700, Simon Glass wrote:
> Hi Ilias,
> 
> On Thu, 26 Jan 2023 at 01:18, Ilias Apalodimas
> <ilias.apalodimas at linaro.org> wrote:
> >
> > As described in [0] if a command requires use of an untested algorithm
> > or functional module, the TPM performs the test and then completes the
> > command actions.
> >
> > Since we don't check for TPM_RC_NEEDS_TEST (which is the return code of
> > the TPM in that case) and even if we would, it would complicate our TPM
> > code for no apparent reason,  add a wrapper function that performs both
> > the selftest and the startup sequence of the TPM.
> >
> > It's worth noting that this is implemented on TPMv2.0.  The code for
> > 1.2 would look similar,  but I don't have a device available to test.
> >
> > [0]
> > https://trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-1-Architecture-01.07-2014-03-13.pdf
> > §12.3 Self-test modes
> >
> > Signed-off-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>
> > ---
> > Changes since v2:
> > - add tpm_init() to auto start
> >
> > Changes since v1:
> > - Remove a superfluous if statement
> > - Move function comments to the header file
> >  include/tpm-v2.h  | 19 +++++++++++++++++++
> >  include/tpm_api.h |  8 ++++++++
> >  lib/tpm-v2.c      | 24 ++++++++++++++++++++++++
> >  lib/tpm_api.c     |  8 ++++++++
> >  4 files changed, 59 insertions(+)
> 
> I think this is a good idea, but it should be implemented at the API
> level. Please see below.

It is implemented at the API level.  I could try testing this in QEMU using
swtpm, but the driver I added for mmio is TPMv2 only.  So I don't really feel
comfortable adding support for a device I can't test.  If someone has a
tpm1.2 and is willing to test it, I can modify the patch accordingly.

> 
> >
> > diff --git a/include/tpm-v2.h b/include/tpm-v2.h
> > index 737e57551d73..1c644f0048f6 100644
> > --- a/include/tpm-v2.h
> > +++ b/include/tpm-v2.h
> > @@ -688,4 +688,23 @@ u32 tpm2_report_state(struct udevice *dev, uint vendor_cmd, uint vendor_subcmd,
> >  u32 tpm2_enable_nvcommits(struct udevice *dev, uint vendor_cmd,
> >                           uint vendor_subcmd);
> >
> > +/**
> > + * tpm2_auto_start() - start up the TPM and perform selftests.
> > + *                     If a testable function has not been tested and is
> > + *                     requested the TPM2  will return TPM_RC_NEEDS_TEST.
> > + *
> > + *
> > + *
> 
> drop extra lines

Sure

> 
> > + * @param dev          TPM device
> > + * Return: TPM2_RC_TESTING, if TPM2 self-test has been received and the tests are
> 
> 80 cols

Sure

> 
> > + *         not complete.
> > + *         TPM2_RC_SUCCESS, if testing of all functions is complete without
> > + *         functional failures.

[...]

> > +        */
> > +       rc = tpm_init(dev);
> > +       if (rc && rc != -EBUSY)
> 
> Does that work, with rc being unsigned?


Yes integer promotion is fine here.  As long as we don't try to do anything
silly e.g start doing math on the result or compare it against bigger types
this is fine.  
There was a patch from Sughosh in the past that you rejected and it was
converting enough of the TPM API return calls to int.  I think the reason
the API works with u32, is that the spec return codes from the device
itself are described as u32.  But that shouldn't affect the internal U-Boot
API.  I can send a patch afterwards moving the U-Boot TPM API functions and
return int.

> 
> > +               return rc;
> > +       rc = tpm2_self_test(dev, TPMI_YES);
> 
> Can we call tpm_self_test_full() ? If not, please update the API as needed.
> 
> > +
> > +       if (rc == TPM2_RC_INITIALIZE) {
> > +               rc = tpm2_startup(dev, TPM2_SU_CLEAR);
> 
> Should call tpm_startup()


Same logic applies to both of these.  Yes that makes sense to use the top
level API but only if we add support for 1.2 as well.  Otherwise the only
thing this is going to create is circular dependencies between the v2 code
and the API library.

> 
> > +               if (rc)
> > +                       return rc;
> > +
> > +               rc = tpm2_self_test(dev, TPMI_YES);
> 
> Again, tpm_self_test_full(). We are trying to provide a TPM API that
> covers v1 and v2, to the extent possible.

See above.

> 
> > +       }
> > +
> > +       return rc;
> > +}
> > +
> 
> Also please add a test for this to test/dm/tpm.c

sure

> 
> >  u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw,
> >                const ssize_t pw_sz)
> >  {
> > diff --git a/lib/tpm_api.c b/lib/tpm_api.c
> > index 7e8df8795ef3..5b2c11a277cc 100644
> > --- a/lib/tpm_api.c
> > +++ b/lib/tpm_api.c
> > @@ -35,6 +35,14 @@ u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode)
> >         }
> >  }
> >
> > +u32 tpm_auto_start(struct udevice *dev)
> > +{
> > +       if (tpm_is_v2(dev))
> > +               return tpm2_auto_start(dev);
> 
> Hopefully all the code from above can move here.

Repeating myself here, but I don't want to add untested code.  So I really
prefer the patch as is, until someone verifies the 1.2 init sequence for
me.

Regards
/Ilias