BaseTools/tools_def: use separate PP definition for DTC

[mirror_edk2.git] / UefiCpuPkg / SecCore / SecBist.c

/** @file\r
  Get SEC platform information(2) PPI and reinstall it.\r
\r
  Copyright (c) 2006 - 2016, 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 "SecMain.h"\r
\r
EFI_SEC_PLATFORM_INFORMATION_PPI mSecPlatformInformation = {\r
  SecPlatformInformationBist\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR mPeiSecPlatformInformation = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiSecPlatformInformationPpiGuid,\r
  &mSecPlatformInformation\r
};\r
\r
EFI_SEC_PLATFORM_INFORMATION2_PPI mSecPlatformInformation2 = {\r
  SecPlatformInformation2Bist\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR mPeiSecPlatformInformation2 = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiSecPlatformInformation2PpiGuid,\r
  &mSecPlatformInformation2\r
};\r
\r
/**\r
  Worker function to parse CPU BIST information from Guided HOB.\r
\r
  @param[in, out] StructureSize     Pointer to the variable describing size of the input buffer.\r
  @param[in, out] StructureBuffer   Pointer to the buffer save CPU BIST information.\r
\r
  @retval EFI_SUCCESS           The data was successfully returned.\r
  @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.\r
\r
**/\r
EFI_STATUS\r
GetBistFromHob (\r
  IN OUT UINT64           *StructureSize,\r
  IN OUT VOID             *StructureBuffer\r
  )\r
{\r
  EFI_HOB_GUID_TYPE       *GuidHob;\r
  VOID                    *DataInHob;\r
  UINTN                   DataSize;\r
\r
  GuidHob = GetFirstGuidHob (&gEfiCallerIdGuid);\r
  if (GuidHob == NULL) {\r
    *StructureSize = 0;\r
    return EFI_SUCCESS;\r
  }\r
\r
  DataInHob = GET_GUID_HOB_DATA (GuidHob);\r
  DataSize  = GET_GUID_HOB_DATA_SIZE (GuidHob);\r
\r
  //\r
  // return the information from BistHob\r
  //\r
  if ((*StructureSize) < (UINT64) DataSize) {\r
    *StructureSize = (UINT64) DataSize;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *StructureSize = (UINT64) DataSize;\r
  CopyMem (StructureBuffer, DataInHob, DataSize);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Implementation of the PlatformInformation service in EFI_SEC_PLATFORM_INFORMATION_PPI.\r
\r
  @param[in]      PeiServices                Pointer to the PEI Services Table.\r
  @param[in, out] StructureSize              Pointer to the variable describing size of the input buffer.\r
  @param[out]     PlatformInformationRecord  Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
\r
  @retval EFI_SUCCESS                    The data was successfully returned.\r
  @retval EFI_BUFFER_TOO_SMALL           The buffer was too small.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SecPlatformInformationBist (\r
  IN CONST EFI_PEI_SERVICES                  **PeiServices,\r
  IN OUT UINT64                              *StructureSize,\r
     OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord\r
  )\r
{\r
  return GetBistFromHob (StructureSize, PlatformInformationRecord);\r
}\r
\r
/**\r
  Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.\r
\r
  @param[in]      PeiServices                The pointer to the PEI Services Table.\r
  @param[in, out] StructureSize              The pointer to the variable describing size of the input buffer.\r
  @param[out]     PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.\r
\r
  @retval EFI_SUCCESS                    The data was successfully returned.\r
  @retval EFI_BUFFER_TOO_SMALL           The buffer was too small. The current buffer size needed to\r
                                         hold the record is returned in StructureSize.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SecPlatformInformation2Bist (\r
  IN CONST EFI_PEI_SERVICES                   **PeiServices,\r
  IN OUT UINT64                               *StructureSize,\r
     OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2 *PlatformInformationRecord2\r
  )\r
{\r
  return GetBistFromHob (StructureSize, PlatformInformationRecord2);\r
}\r
\r
/**\r
  Worker function to get CPUs' BIST by calling SecPlatformInformationPpi\r
  or SecPlatformInformation2Ppi.\r
\r
  @param[in]  PeiServices         Pointer to PEI Services Table\r
  @param[in]  Guid                PPI Guid\r
  @param[out] PpiDescriptor       Return a pointer to instance of the\r
                                  EFI_PEI_PPI_DESCRIPTOR\r
  @param[out] BistInformationData Pointer to BIST information data\r
  @param[out] BistInformationSize Return the size in bytes of BIST information\r
\r
  @retval EFI_SUCCESS         Retrieve of the BIST data successfully\r
  @retval EFI_NOT_FOUND       No sec platform information(2) ppi export\r
  @retval EFI_DEVICE_ERROR    Failed to get CPU Information\r
\r
**/\r
EFI_STATUS\r
GetBistInfoFromPpi (\r
  IN CONST EFI_PEI_SERVICES     **PeiServices,\r
  IN CONST EFI_GUID             *Guid,\r
     OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
     OUT VOID                   **BistInformationData,\r
     OUT UINT64                 *BistInformationSize OPTIONAL\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  EFI_SEC_PLATFORM_INFORMATION2_PPI     *SecPlatformInformation2Ppi;\r
  EFI_SEC_PLATFORM_INFORMATION_RECORD2  *SecPlatformInformation2;\r
  UINT64                                InformationSize;\r
\r
  Status = PeiServicesLocatePpi (\r
             Guid,                                // GUID\r
             0,                                   // INSTANCE\r
             PpiDescriptor,                       // EFI_PEI_PPI_DESCRIPTOR\r
             (VOID **)&SecPlatformInformation2Ppi // PPI\r
             );\r
  if (Status == EFI_NOT_FOUND) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (Status == EFI_SUCCESS) {\r
    //\r
    // Get the size of the sec platform information2(BSP/APs' BIST data)\r
    //\r
    InformationSize         = 0;\r
    SecPlatformInformation2 = NULL;\r
    Status = SecPlatformInformation2Ppi->PlatformInformation2 (\r
                                           PeiServices,\r
                                           &InformationSize,\r
                                           SecPlatformInformation2\r
                                           );\r
    if (Status == EFI_BUFFER_TOO_SMALL) {\r
      Status = PeiServicesAllocatePool (\r
                 (UINTN) InformationSize,\r
                 (VOID **) &SecPlatformInformation2\r
                 );\r
      if (Status == EFI_SUCCESS) {\r
        //\r
        // Retrieve BIST data\r
        //\r
        Status = SecPlatformInformation2Ppi->PlatformInformation2 (\r
                                               PeiServices,\r
                                               &InformationSize,\r
                                               SecPlatformInformation2\r
                                               );\r
        if (Status == EFI_SUCCESS) {\r
          *BistInformationData = SecPlatformInformation2;\r
          if (BistInformationSize != NULL) {\r
            *BistInformationSize = InformationSize;\r
          }\r
          return EFI_SUCCESS;\r
        }\r
      }\r
    }\r
  }\r
\r
  return EFI_DEVICE_ERROR;\r
}\r
\r
/**\r
  Get CPUs' BIST by calling SecPlatformInformationPpi/SecPlatformInformation2Ppi.\r
\r
**/\r
VOID\r
RepublishSecPlatformInformationPpi (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  CONST EFI_PEI_SERVICES                **PeiServices;\r
  UINT64                                BistInformationSize;\r
  VOID                                  *BistInformationData;\r
  EFI_PEI_PPI_DESCRIPTOR                *SecInformationDescriptor;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  Status = GetBistInfoFromPpi (\r
             PeiServices,\r
             &gEfiSecPlatformInformation2PpiGuid,\r
             &SecInformationDescriptor,\r
             &BistInformationData,\r
             &BistInformationSize\r
             );\r
  if (Status == EFI_SUCCESS) {\r
    BuildGuidDataHob (\r
      &gEfiCallerIdGuid,\r
      BistInformationData,\r
      (UINTN) BistInformationSize\r
      );\r
    //\r
    // The old SecPlatformInformation2 data is on temporary memory.\r
    // After memory discovered, we should never get it from temporary memory,\r
    // or the data will be crashed. So, we reinstall SecPlatformInformation2 PPI here.\r
    //\r
    Status = PeiServicesReInstallPpi (\r
               SecInformationDescriptor,\r
               &mPeiSecPlatformInformation2\r
               );\r
  } if (Status == EFI_NOT_FOUND) {\r
    Status = GetBistInfoFromPpi (\r
               PeiServices,\r
               &gEfiSecPlatformInformationPpiGuid,\r
               &SecInformationDescriptor,\r
               &BistInformationData,\r
               &BistInformationSize\r
               );\r
    if (Status == EFI_SUCCESS) {\r
      BuildGuidDataHob (\r
        &gEfiCallerIdGuid,\r
        BistInformationData,\r
        (UINTN) BistInformationSize\r
        );\r
      //\r
      // The old SecPlatformInformation data is on temporary memory.\r
      // After memory discovered, we should never get it from temporary memory,\r
      // or the data will be crashed. So, we reinstall SecPlatformInformation PPI here.\r
      //\r
      Status = PeiServicesReInstallPpi (\r
                 SecInformationDescriptor,\r
                 &mPeiSecPlatformInformation\r
                 );\r
    } else if (Status == EFI_NOT_FOUND) {\r
      return;\r
    }\r
  }\r
\r
  ASSERT_EFI_ERROR(Status);\r
}\r