SecurityPkg: Clean up source files

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

/** @file\r
  This library is TPM2 DTPM device lib.\r
  Choosing this library means platform uses and only uses DTPM device as TPM2 engine.\r
\r
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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
/**\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
  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
/**\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
  return DTpm2SubmitCommand (\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
  return DTpm2RequestUseTpm ();\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
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  The function caches current active TPM interface type.\r
\r
  @retval EFI_SUCCESS   DTPM2.0 instance is registered, or system dose not surpport registr DTPM2.0 instance\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2DeviceLibConstructor (\r
  VOID\r
  )\r
{\r
  TPM2_PTP_INTERFACE_TYPE  PtpInterface;\r
  UINT8                    IdleByPass;\r
\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
  return EFI_SUCCESS;\r
}\r