SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Library / Tpm2DeviceLibRouter / Tpm2DeviceLibRouterDxe.c

/** @file\r
  This library is TPM2 device router. Platform can register multi TPM2 instance to it\r
  via PcdTpmInstanceGuid. Platform need make choice that which one will be final one.\r
  At most one TPM2 instance can be finally registered, and other will return unsupported.\r
\r
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/Tpm2DeviceLib.h>\r
\r
TPM2_DEVICE_INTERFACE  mInternalTpm2DeviceInterface;\r
\r
/**\r
  This service enables the sending of commands to the TPM2.\r
\r
  @param[in]      InputParameterBlockSize  Size of the TPM2 input parameter block.\r
  @param[in]      InputParameterBlock      Pointer to the TPM2 input parameter block.\r
  @param[in,out]  OutputParameterBlockSize Size of the TPM2 output parameter block.\r
  @param[in]      OutputParameterBlock     Pointer to the TPM2 output parameter block.\r
\r
  @retval EFI_SUCCESS            The command byte stream was successfully sent to the device and a response was successfully received.\r
  @retval EFI_DEVICE_ERROR       The command was not successfully sent to the device or a response was not successfully received from the device.\r
  @retval EFI_BUFFER_TOO_SMALL   The output parameter block is too small.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2SubmitCommand (\r
  IN UINT32            InputParameterBlockSize,\r
  IN UINT8             *InputParameterBlock,\r
  IN OUT UINT32        *OutputParameterBlockSize,\r
  IN UINT8             *OutputParameterBlock\r
  )\r
{\r
  if (mInternalTpm2DeviceInterface.Tpm2SubmitCommand == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  return mInternalTpm2DeviceInterface.Tpm2SubmitCommand (\r
                                        InputParameterBlockSize,\r
                                        InputParameterBlock,\r
                                        OutputParameterBlockSize,\r
                                        OutputParameterBlock\r
                                        );\r
}\r
\r
/**\r
  This service requests use TPM2.\r
\r
  @retval EFI_SUCCESS      Get the control of TPM2 chip.\r
  @retval EFI_NOT_FOUND    TPM2 not found.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2RequestUseTpm (\r
  VOID\r
  )\r
{\r
  if (mInternalTpm2DeviceInterface.Tpm2RequestUseTpm == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  return mInternalTpm2DeviceInterface.Tpm2RequestUseTpm ();\r
}\r
\r
/**\r
  This service register TPM2 device.\r
\r
  @param Tpm2Device  TPM2 device\r
\r
  @retval EFI_SUCCESS          This TPM2 device is registered successfully.\r
  @retval EFI_UNSUPPORTED      System does not support register this TPM2 device.\r
  @retval EFI_ALREADY_STARTED  System already register this TPM2 device.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2RegisterTpm2DeviceLib (\r
  IN TPM2_DEVICE_INTERFACE   *Tpm2Device\r
  )\r
{\r
  if (!CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &Tpm2Device->ProviderGuid)){\r
    DEBUG ((DEBUG_WARN, "WARNING: Tpm2RegisterTpm2DeviceLib - does not support %g registration\n", &Tpm2Device->ProviderGuid));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  CopyMem (&mInternalTpm2DeviceInterface, Tpm2Device, sizeof(mInternalTpm2DeviceInterface));\r
  return EFI_SUCCESS;\r
}\r