SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Tcg / Tcg2Config / TpmDetection.c

/** @file\r
  TPM1.2/dTPM2.0 auto detection.\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <PiPei.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/Tpm12DeviceLib.h>\r
#include <Library/Tpm12CommandLib.h>\r
#include <IndustryStandard/Tpm12.h>\r
\r
#include "Tcg2ConfigNvData.h"\r
\r
/**\r
  This routine check both SetupVariable and real TPM device, and return final TpmDevice configuration.\r
\r
  @param  SetupTpmDevice  TpmDevice configuration in setup driver\r
\r
  @return TpmDevice configuration\r
**/\r
UINT8\r
DetectTpmDevice (\r
  IN UINT8 SetupTpmDevice\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_BOOT_MODE                     BootMode;\r
  TCG2_DEVICE_DETECTION             Tcg2DeviceDetection;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI   *VariablePpi;\r
  UINTN                             Size;\r
\r
  Status = PeiServicesGetBootMode (&BootMode);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // In S3, we rely on normal boot Detection, because we save to ReadOnly Variable in normal boot.\r
  //\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    DEBUG ((EFI_D_INFO, "DetectTpmDevice: S3 mode\n"));\r
\r
    Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Size = sizeof(TCG2_DEVICE_DETECTION);\r
    ZeroMem (&Tcg2DeviceDetection, sizeof(Tcg2DeviceDetection));\r
    Status = VariablePpi->GetVariable (\r
                            VariablePpi,\r
                            TCG2_DEVICE_DETECTION_NAME,\r
                            &gTcg2ConfigFormSetGuid,\r
                            NULL,\r
                            &Size,\r
                            &Tcg2DeviceDetection\r
                            );\r
    if (!EFI_ERROR (Status) &&\r
        (Tcg2DeviceDetection.TpmDeviceDetected >= TPM_DEVICE_MIN) &&\r
        (Tcg2DeviceDetection.TpmDeviceDetected <= TPM_DEVICE_MAX)) {\r
      DEBUG ((EFI_D_ERROR, "TpmDevice from DeviceDetection: %x\n", Tcg2DeviceDetection.TpmDeviceDetected));\r
      return Tcg2DeviceDetection.TpmDeviceDetected;\r
    }\r
  }\r
\r
  DEBUG ((EFI_D_INFO, "DetectTpmDevice:\n"));\r
\r
  // dTPM available and not disabled by setup\r
  // We need check if it is TPM1.2 or TPM2.0\r
  // So try TPM1.2 command at first\r
\r
  Status = Tpm12RequestUseTpm ();\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // dTPM not available\r
    //\r
    return TPM_DEVICE_NULL;\r
  }\r
\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    Status = Tpm12Startup (TPM_ST_STATE);\r
  } else {\r
    Status = Tpm12Startup (TPM_ST_CLEAR);\r
  }\r
  if (EFI_ERROR (Status)) {\r
    return TPM_DEVICE_2_0_DTPM;\r
  }\r
\r
  // NO initialization needed again.\r
  Status = PcdSet8S (PcdTpmInitializationPolicy, 0);\r
  ASSERT_EFI_ERROR (Status);\r
  return TPM_DEVICE_1_2;\r
}\r