SecurityPkg: Add TPM PTP detection in TPM12 device lib.

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

/** @file\r
  The module entry point for Tcg2 configuration module.\r
\r
Copyright (c) 2015, 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 "Tcg2ConfigImpl.h"\r
\r
extern TPM_INSTANCE_ID  mTpmInstanceId[TPM_DEVICE_MAX + 1];\r
\r
/**\r
  Update default PCR banks data.\r
\r
  @param[in]  HiiPackage        HII Package.\r
  @param[in]  HiiPackageSize    HII Package size.\r
  @param[in]  PCRBanks          PCR Banks data.\r
\r
**/\r
VOID\r
UpdateDefaultPCRBanks (\r
  IN VOID                           *HiiPackage,\r
  IN UINTN                          HiiPackageSize,\r
  IN UINT32                         PCRBanks\r
  )\r
{\r
  EFI_HII_PACKAGE_HEADER        *HiiPackageHeader;\r
  EFI_IFR_OP_HEADER             *IfrOpCodeHeader;\r
  EFI_IFR_CHECKBOX              *IfrCheckBox;\r
  EFI_IFR_DEFAULT               *IfrDefault;\r
\r
  HiiPackageHeader = (EFI_HII_PACKAGE_HEADER *)HiiPackage;\r
\r
  switch (HiiPackageHeader->Type) {\r
  case EFI_HII_PACKAGE_FORMS:\r
    IfrOpCodeHeader = (EFI_IFR_OP_HEADER *)(HiiPackageHeader + 1);\r
    while ((UINTN)IfrOpCodeHeader < (UINTN)HiiPackageHeader + HiiPackageHeader->Length) {\r
      switch (IfrOpCodeHeader->OpCode) {\r
      case EFI_IFR_CHECKBOX_OP:\r
        IfrCheckBox = (EFI_IFR_CHECKBOX *)IfrOpCodeHeader;\r
        if ((IfrCheckBox->Question.QuestionId >= KEY_TPM2_PCR_BANKS_REQUEST_0) && (IfrCheckBox->Question.QuestionId <= KEY_TPM2_PCR_BANKS_REQUEST_4)) {\r
          IfrDefault = (EFI_IFR_DEFAULT *)(IfrCheckBox + 1);\r
          ASSERT (IfrDefault->Header.OpCode == EFI_IFR_DEFAULT_OP);\r
          ASSERT (IfrDefault->Type == EFI_IFR_TYPE_BOOLEAN);\r
          IfrDefault->Value.b = (BOOLEAN)((PCRBanks >> (IfrCheckBox->Question.QuestionId - KEY_TPM2_PCR_BANKS_REQUEST_0)) & 0x1);\r
        }\r
        break;\r
      }\r
      IfrOpCodeHeader = (EFI_IFR_OP_HEADER *)((UINTN)IfrOpCodeHeader + IfrOpCodeHeader->Length);\r
    }\r
    break;\r
  }\r
  return ;\r
}\r
\r
/**\r
  The entry point for Tcg2 configuration driver.\r
\r
  @param[in]  ImageHandle        The image handle of the driver.\r
  @param[in]  SystemTable        The system table.\r
\r
  @retval EFI_ALREADY_STARTED    The driver already exists in system.\r
  @retval EFI_OUT_OF_RESOURCES   Fail to execute entry point due to lack of resources.\r
  @retval EFI_SUCCES             All the related protocols are installed on the driver.\r
  @retval Others                 Fail to install protocols as indicated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2ConfigDriverEntryPoint (\r
  IN EFI_HANDLE          ImageHandle,\r
  IN EFI_SYSTEM_TABLE    *SystemTable\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  TCG2_CONFIG_PRIVATE_DATA      *PrivateData;\r
  TCG2_CONFIGURATION            Tcg2Configuration;\r
  TCG2_DEVICE_DETECTION         Tcg2DeviceDetection;\r
  UINTN                         Index;\r
  UINTN                         DataSize;\r
  EDKII_VARIABLE_LOCK_PROTOCOL  *VariableLockProtocol;\r
  UINT32                        CurrentActivePCRBanks;\r
\r
  Status = gBS->OpenProtocol (\r
                  ImageHandle,\r
                  &gEfiCallerIdGuid,\r
                  NULL,\r
                  ImageHandle,\r
                  ImageHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
  \r
  //\r
  // Create a private data structure.\r
  //\r
  PrivateData = AllocateCopyPool (sizeof (TCG2_CONFIG_PRIVATE_DATA), &mTcg2ConfigPrivateDateTemplate);\r
  ASSERT (PrivateData != NULL);\r
  mTcg2ConfigPrivateDate = PrivateData;\r
  //\r
  // Install private GUID.\r
  //    \r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ImageHandle,\r
                  &gEfiCallerIdGuid,\r
                  PrivateData,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->LocateProtocol (&gEfiTcg2ProtocolGuid, NULL, (VOID **) &PrivateData->Tcg2Protocol);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  PrivateData->ProtocolCapability.Size = sizeof(PrivateData->ProtocolCapability);\r
  Status = PrivateData->Tcg2Protocol->GetCapability (\r
                                        PrivateData->Tcg2Protocol,\r
                                        &PrivateData->ProtocolCapability\r
                                        );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  DataSize = sizeof(Tcg2Configuration);\r
  Status = gRT->GetVariable (\r
                  TCG2_STORAGE_NAME,\r
                  &gTcg2ConfigFormSetGuid,\r
                  NULL,\r
                  &DataSize,\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
  // Set value for Tcg2CurrentActivePCRBanks\r
  // Search Tcg2ConfigBin[] and update default value there\r
  //\r
  Status = PrivateData->Tcg2Protocol->GetActivePcrBanks (PrivateData->Tcg2Protocol, &CurrentActivePCRBanks);\r
  ASSERT_EFI_ERROR (Status);\r
  PrivateData->PCRBanksDesired = CurrentActivePCRBanks;\r
  UpdateDefaultPCRBanks (Tcg2ConfigBin + sizeof(UINT32), ReadUnaligned32((UINT32 *)Tcg2ConfigBin) - sizeof(UINT32), CurrentActivePCRBanks);\r
\r
  //\r
  // Save to variable so platform driver can get it.\r
  //\r
  Status = gRT->SetVariable (\r
                  TCG2_STORAGE_NAME,\r
                  &gTcg2ConfigFormSetGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  sizeof(Tcg2Configuration),\r
                  &Tcg2Configuration\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "Tcg2ConfigDriver: Fail to set TCG2_STORAGE_NAME\n"));\r
  }\r
\r
  //\r
  // Sync data from PCD to variable, so that we do not need detect again in S3 phase.\r
  //\r
  Tcg2DeviceDetection.TpmDeviceDetected = TPM_DEVICE_NULL;\r
  for (Index = 0; Index < sizeof(mTpmInstanceId)/sizeof(mTpmInstanceId[0]); Index++) {\r
    if (CompareGuid (PcdGetPtr(PcdTpmInstanceGuid), &mTpmInstanceId[Index].TpmInstanceGuid)) {\r
      Tcg2DeviceDetection.TpmDeviceDetected = mTpmInstanceId[Index].TpmDevice;\r
      break;\r
    }\r
  }\r
\r
  PrivateData->TpmDeviceDetected = Tcg2DeviceDetection.TpmDeviceDetected;\r
\r
  //\r
  // Save to variable so platform driver can get it.\r
  //\r
  Status = gRT->SetVariable (\r
                  TCG2_DEVICE_DETECTION_NAME,\r
                  &gTcg2ConfigFormSetGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  sizeof(Tcg2DeviceDetection),\r
                  &Tcg2DeviceDetection\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "Tcg2ConfigDriver: Fail to set TCG2_DEVICE_DETECTION_NAME\n"));\r
    Status = gRT->SetVariable (\r
                    TCG2_DEVICE_DETECTION_NAME,\r
                    &gTcg2ConfigFormSetGuid,\r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                    0,\r
                    NULL\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // We should lock Tcg2DeviceDetection, because it contains information needed at S3.\r
  //\r
  Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **)&VariableLockProtocol);\r
  if (!EFI_ERROR (Status)) {\r
    Status = VariableLockProtocol->RequestToLock (\r
                                     VariableLockProtocol,\r
                                     TCG2_DEVICE_DETECTION_NAME,\r
                                     &gTcg2ConfigFormSetGuid\r
                                     );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  \r
  //\r
  // Install Tcg2 configuration form\r
  //\r
  Status = InstallTcg2ConfigForm (PrivateData);\r
  if (EFI_ERROR (Status)) {\r
    goto ErrorExit;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ErrorExit:\r
  if (PrivateData != NULL) {\r
    UninstallTcg2ConfigForm (PrivateData);\r
  }  \r
  \r
  return Status;\r
}\r
\r
/**\r
  Unload the Tcg2 configuration form.\r
\r
  @param[in]  ImageHandle         The driver's image handle.\r
\r
  @retval     EFI_SUCCESS         The Tcg2 configuration form is unloaded.\r
  @retval     Others              Failed to unload the form.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcg2ConfigDriverUnload (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  TCG2_CONFIG_PRIVATE_DATA    *PrivateData;\r
\r
  Status = gBS->HandleProtocol (\r
                  ImageHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &PrivateData\r
                  );  \r
  if (EFI_ERROR (Status)) {\r
    return Status;  \r
  }\r
  \r
  ASSERT (PrivateData->Signature == TCG2_CONFIG_PRIVATE_DATA_SIGNATURE);\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         &ImageHandle,\r
         &gEfiCallerIdGuid,\r
         PrivateData,\r
         NULL\r
         );\r
  \r
  UninstallTcg2ConfigForm (PrivateData);\r
\r
  return EFI_SUCCESS;\r
}\r