[PATCH v3] efi_loader: add EFI_TCG2_PROTOCOL.SubmitCommand

[Ilias Apalodimas]

On Thu, 4 Nov 2021 at 15:56, Masahisa Kojima <masahisa.kojima at linaro.org> wrote:
>
> This commit adds the EFI_TCG2_PROTOCOL.SubmitCommand
> required in the TCG PC Client PFP spec.
> SubmitCommand enables to send the raw command to the TPM device.
>
> To implement this api, tpm2_submit_command() is added
> into tpm-v2.c.
>
> Signed-off-by: Masahisa Kojima <masahisa.kojima at linaro.org>
> ---
> Changes in v3:
> - use ternary operation
> - update comment of the tpm2_submit_command() return value
>   to follow other function comment in tpm-v2.h
>
> Changes in v2:
> - return EFI_OUT_OF_RESOURCES if the recv buffer is small
> - remove unused argument of tpm2_submit_command()
>
>  include/tpm-v2.h          | 13 +++++++++++++
>  lib/efi_loader/efi_tcg2.c | 38 ++++++++++++++++++++++++++++++++------
>  lib/tpm-v2.c              |  6 ++++++
>  3 files changed, 51 insertions(+), 6 deletions(-)
>
> diff --git a/include/tpm-v2.h b/include/tpm-v2.h
> index e6b68769f3..ceff7d245e 100644
> --- a/include/tpm-v2.h
> +++ b/include/tpm-v2.h
> @@ -642,4 +642,17 @@ u32 tpm2_write_lock(struct udevice *dev, u32 index);
>   */
>  u32 tpm2_disable_platform_hierarchy(struct udevice *dev);
>
> +/**
> + * submit user specified data to the TPM and get response
> + *
> + * @dev                TPM device
> + * @sendbuf:   Buffer of the data to send
> + * @recvbuf:   Buffer to save the response to
> + * @recv_size: Pointer to the size of the response buffer
> + *
> + * @return code of the operation
> + */
> +u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf,
> +                       u8 *recvbuf, size_t *recv_size);
> +
>  #endif /* __TPM_V2_H */
> diff --git a/lib/efi_loader/efi_tcg2.c b/lib/efi_loader/efi_tcg2.c
> index ec20530b6b..a33505bd0b 100644
> --- a/lib/efi_loader/efi_tcg2.c
> +++ b/lib/efi_loader/efi_tcg2.c
> @@ -1033,13 +1033,39 @@ out:
>   * Return:     status code
>   */
>  static efi_status_t EFIAPI
> -efi_tcg2_submit_command(__maybe_unused struct efi_tcg2_protocol *this,
> -                       u32 __maybe_unused input_param_block_size,
> -                       u8 __maybe_unused *input_param_block,
> -                       u32 __maybe_unused output_param_block_size,
> -                       u8 __maybe_unused *output_param_block)
> +efi_tcg2_submit_command(struct efi_tcg2_protocol *this,
> +                       u32 input_param_block_size,
> +                       u8 *input_param_block,
> +                       u32 output_param_block_size,
> +                       u8 *output_param_block)
>  {
> -       return EFI_UNSUPPORTED;
> +       struct udevice *dev;
> +       efi_status_t ret;
> +       u32 rc;
> +       size_t resp_buf_size = output_param_block_size;
> +
> +       EFI_ENTRY("%p, %u, %p, %u, %p", this, input_param_block_size,
> +                 input_param_block, output_param_block_size, output_param_block);
> +
> +       if (!this || !input_param_block || !input_param_block_size) {
> +               ret = EFI_INVALID_PARAMETER;
> +               goto out;
> +       }
> +
> +       ret = platform_get_tpm2_device(&dev);
> +       if (ret != EFI_SUCCESS)
> +               goto out;
> +
> +       rc = tpm2_submit_command(dev, input_param_block,
> +                                output_param_block, &resp_buf_size);
> +       if (rc) {
> +               ret = (rc == -ENOSPC) ? EFI_OUT_OF_RESOURCES : EFI_DEVICE_ERROR;
> +
> +               goto out;
> +       }
> +
> +out:
> +       return EFI_EXIT(ret);
>  }
>
>  /**
> diff --git a/lib/tpm-v2.c b/lib/tpm-v2.c
> index 235f8c20d4..2e7b27bd6b 100644
> --- a/lib/tpm-v2.c
> +++ b/lib/tpm-v2.c
> @@ -659,3 +659,9 @@ u32 tpm2_disable_platform_hierarchy(struct udevice *dev)
>
>         return 0;
>  }
> +
> +u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf,
> +                       u8 *recvbuf, size_t *recv_size)
> +{
> +       return tpm_sendrecv_command(dev, sendbuf, recvbuf, recv_size);
> +}
> --
> 2.17.1
>

Reviewed-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>