SecurityPkg: Fix spelling errors

[mirror_edk2.git] / SecurityPkg / Library / Tpm2DeviceLibDTpm / Tpm2InstanceLibDTpm.c

/** @file\r
  This library is TPM2 DTPM instance.\r
  It can be registered to Tpm2 Device router, to be active TPM2 engine,\r
  based on platform setting.\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/Tpm2DeviceLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Guid/TpmInstance.h>\r
\r
/**\r
  Return PTP interface type.\r
\r
  @param[in] Register                Pointer to PTP register.\r
\r
  @return PTP interface type.\r
**/\r
TPM2_PTP_INTERFACE_TYPE\r
Tpm2GetPtpInterface (\r
  IN VOID *Register\r
  );\r
\r
/**\r
  Return PTP CRB interface IdleByPass state.\r
\r
  @param[in] Register                Pointer to PTP register.\r
\r
  @return PTP CRB interface IdleByPass state.\r
**/\r
UINT8\r
Tpm2GetIdleByPass (\r
  IN VOID *Register\r
  );\r
\r
/**\r
  Dump PTP register information.\r
\r
  @param[in] Register                Pointer to PTP register.\r
**/\r
VOID\r
DumpPtpInfo (\r
  IN VOID *Register\r
  );\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
DTpm2SubmitCommand (\r
  IN UINT32            InputParameterBlockSize,\r
  IN UINT8             *InputParameterBlock,\r
  IN OUT UINT32        *OutputParameterBlockSize,\r
  IN UINT8             *OutputParameterBlock\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
DTpm2RequestUseTpm (\r
  VOID\r
  );\r
\r
TPM2_DEVICE_INTERFACE  mDTpm2InternalTpm2Device = {\r
  TPM_DEVICE_INTERFACE_TPM20_DTPM,\r
  DTpm2SubmitCommand,\r
  DTpm2RequestUseTpm,\r
};\r
\r
/**\r
  The function register DTPM2.0 instance and caches current active TPM interface type.\r
\r
  @retval EFI_SUCCESS   DTPM2.0 instance is registered, or system does not support register DTPM2.0 instance\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2InstanceLibDTpmConstructor (\r
  VOID\r
  )\r
{\r
  EFI_STATUS               Status;\r
  TPM2_PTP_INTERFACE_TYPE  PtpInterface;\r
  UINT8                    IdleByPass;\r
\r
  Status = Tpm2RegisterTpm2DeviceLib (&mDTpm2InternalTpm2Device);\r
  if ((Status == EFI_SUCCESS) || (Status == EFI_UNSUPPORTED)) {\r
    //\r
    // Unsupported means platform policy does not need this instance enabled.\r
    //\r
    if (Status == EFI_SUCCESS) {\r
      //\r
      // Cache current active TpmInterfaceType only when needed\r
      //\r
      if (PcdGet8(PcdActiveTpmInterfaceType) == 0xFF) {\r
        PtpInterface = Tpm2GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
        PcdSet8S(PcdActiveTpmInterfaceType, PtpInterface);\r
      }\r
\r
      if (PcdGet8(PcdActiveTpmInterfaceType) == Tpm2PtpInterfaceCrb && PcdGet8(PcdCRBIdleByPass) == 0xFF) {\r
        IdleByPass = Tpm2GetIdleByPass((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
        PcdSet8S(PcdCRBIdleByPass, IdleByPass);\r
      }\r
\r
      DumpPtpInfo ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
    }\r
    return EFI_SUCCESS;\r
  }\r
  return Status;\r
}\r