SecurityPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  The module entry point for Tcg2 configuration module.\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
\r
#include <Guid/TpmInstance.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Ppi/TpmInitialized.h>\r
#include <Protocol/Tcg2Protocol.h>\r
\r
#include "Tcg2ConfigNvData.h"\r
\r
TPM_INSTANCE_ID  mTpmInstanceId[] = TPM_INSTANCE_ID_LIST;\r
\r
CONST EFI_PEI_PPI_DESCRIPTOR gTpmSelectedPpi = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiTpmDeviceSelectedGuid,\r
  NULL\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  mTpmInitializationDonePpiList = {\r
  EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
  &gPeiTpmInitializationDonePpiGuid,\r
  NULL\r
};\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
/**\r
  The entry point for Tcg2 configuration driver.\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCES             Convert variable to PCD successfully.\r
  @retval Others                 Fail to convert variable to PCD.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2ConfigPeimEntryPoint (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  UINTN                           Size;\r
  EFI_STATUS                      Status;\r
  EFI_STATUS                      Status2;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariablePpi;\r
  TCG2_CONFIGURATION              Tcg2Configuration;\r
  UINTN                           Index;\r
  UINT8                           TpmDevice;\r
\r
  Status = PeiServicesLocatePpi (&gEfiPeiReadOnlyVariable2PpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Size = sizeof(Tcg2Configuration);\r
  Status = VariablePpi->GetVariable (\r
                          VariablePpi,\r
                          TCG2_STORAGE_NAME,\r
                          &gTcg2ConfigFormSetGuid,\r
                          NULL,\r
                          &Size,\r
                          &Tcg2Configuration\r
                          );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Variable not ready, set default value\r
    //\r
    Tcg2Configuration.TpmDevice           = TPM_DEVICE_DEFAULT;\r
  }\r
\r
  //\r
  // Validation\r
  //\r
  if ((Tcg2Configuration.TpmDevice > TPM_DEVICE_MAX) || (Tcg2Configuration.TpmDevice < TPM_DEVICE_MIN)) {\r
    Tcg2Configuration.TpmDevice = TPM_DEVICE_DEFAULT;\r
  }\r
\r
  //\r
  // Although we have SetupVariable info, we still need detect TPM device manually.\r
  //\r
  DEBUG ((EFI_D_INFO, "Tcg2Configuration.TpmDevice from Setup: %x\n", Tcg2Configuration.TpmDevice));\r
\r
  if (PcdGetBool (PcdTpmAutoDetection)) {\r
    TpmDevice = DetectTpmDevice (Tcg2Configuration.TpmDevice);\r
    DEBUG ((EFI_D_INFO, "TpmDevice final: %x\n", TpmDevice));\r
    if (TpmDevice != TPM_DEVICE_NULL) {\r
      Tcg2Configuration.TpmDevice = TpmDevice;\r
    }\r
  } else {\r
    TpmDevice = Tcg2Configuration.TpmDevice;\r
  }\r
\r
  //\r
  // Convert variable to PCD.\r
  // This is work-around because there is no gurantee DynamicHiiPcd can return correct value in DXE phase.\r
  // Using DynamicPcd instead.\r
  //\r
  // NOTE: Tcg2Configuration variable contains the desired TpmDevice type,\r
  // while PcdTpmInstanceGuid PCD contains the real detected TpmDevice type\r
  //\r
  for (Index = 0; Index < sizeof(mTpmInstanceId)/sizeof(mTpmInstanceId[0]); Index++) {\r
    if (TpmDevice == mTpmInstanceId[Index].TpmDevice) {\r
      Size = sizeof(mTpmInstanceId[Index].TpmInstanceGuid);\r
      Status = PcdSetPtrS (PcdTpmInstanceGuid, &Size, &mTpmInstanceId[Index].TpmInstanceGuid);\r
      ASSERT_EFI_ERROR (Status);\r
      DEBUG ((EFI_D_INFO, "TpmDevice PCD: %g\n", &mTpmInstanceId[Index].TpmInstanceGuid));\r
      break;\r
    }\r
  }\r
\r
  //\r
  // Selection done\r
  //\r
  Status = PeiServicesInstallPpi (&gTpmSelectedPpi);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Even if no TPM is selected or detected, we still need intall TpmInitializationDonePpi.\r
  // Because TcgPei or Tcg2Pei will not run, but we still need a way to notify other driver.\r
  // Other driver can know TPM initialization state by TpmInitializedPpi.\r
  //\r
  if (CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &gEfiTpmDeviceInstanceNoneGuid)) {\r
    Status2 = PeiServicesInstallPpi (&mTpmInitializationDonePpiList);\r
    ASSERT_EFI_ERROR (Status2);\r
  }\r
\r
  return Status;\r
}\r