Nt32Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Nt32Pkg / WinNtAutoScanPei / WinNtAutoScan.c

/**@file\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
  WinNtAutoscan.c\r
\r
Abstract:\r
  This PEIM to abstract memory auto-scan in a Windows NT environment.\r
\r
Revision History\r
\r
**/\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiPei.h>\r
#include <WinNtPeim.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Ppi/NtAutoscan.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
\r
#include <Guid/MemoryTypeInformation.h>\r
\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
\r
EFI_MEMORY_TYPE_INFORMATION mDefaultMemoryTypeInformation[] = {\r
  { EfiReservedMemoryType,  0x0004 },\r
  { EfiRuntimeServicesCode, 0x0040 },\r
  { EfiRuntimeServicesData, 0x0040 },\r
  { EfiBootServicesCode,    0x0300 },\r
  { EfiBootServicesData,    0x1000 },\r
  { EfiMaxMemoryType,       0      }\r
};\r
\r
/**\r
   Validate variable data for the MemoryTypeInformation. \r
\r
   @param MemoryData       Variable data.\r
   @param MemoryDataSize   Variable data length.\r
   \r
   @return TRUE            The variable data is valid.\r
   @return FALSE           The variable data is invalid.\r
\r
**/\r
BOOLEAN\r
ValidateMemoryTypeInfoVariable (\r
  IN EFI_MEMORY_TYPE_INFORMATION      *MemoryData,\r
  IN UINTN                            MemoryDataSize\r
  )\r
{\r
  UINTN                       Count;\r
  UINTN                       Index;\r
\r
  // Check the input parameter.\r
  if (MemoryData == NULL) {\r
    return FALSE;\r
  }\r
\r
  // Get Count\r
  Count = MemoryDataSize / sizeof (*MemoryData);\r
\r
  // Check Size\r
  if (Count * sizeof(*MemoryData) != MemoryDataSize) {\r
    return FALSE;\r
  }\r
\r
  // Check last entry type filed.\r
  if (MemoryData[Count - 1].Type != EfiMaxMemoryType) {\r
    return FALSE;\r
  }\r
\r
  // Check the type filed.\r
  for (Index = 0; Index < Count - 1; Index++) {\r
    if (MemoryData[Index].Type >= EfiMaxMemoryType) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PeimInitializeWinNtAutoScan (\r
  IN       EFI_PEI_FILE_HANDLE       FileHandle,\r
  IN CONST EFI_PEI_SERVICES          **PeiServices\r
  )\r
/*++\r
\r
Routine Description:\r
  Perform a call-back into the SEC simulator to get a memory value\r
\r
Arguments:\r
  FfsHeader   - General purpose data available to every PEIM\r
  PeiServices - General purpose services available to every PEIM.\r
    \r
Returns:\r
  None\r
\r
--*/\r
{\r
  EFI_STATUS                  Status;\r
  EFI_PEI_PPI_DESCRIPTOR      *PpiDescriptor;\r
  PEI_NT_AUTOSCAN_PPI         *PeiNtService;\r
  UINT64                      MemorySize;\r
  EFI_PHYSICAL_ADDRESS        MemoryBase;\r
  UINTN                       Index;\r
  EFI_RESOURCE_ATTRIBUTE_TYPE Attributes;\r
  EFI_PEI_READ_ONLY_VARIABLE2_PPI       *Variable;\r
  UINTN                                 DataSize;\r
  EFI_MEMORY_TYPE_INFORMATION           MemoryData [EfiMaxMemoryType + 1];\r
\r
\r
  DEBUG ((EFI_D_ERROR, "NT 32 Autoscan PEIM Loaded\n"));\r
\r
  //\r
  // Get the PEI NT Autoscan PPI\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gPeiNtAutoScanPpiGuid, // GUID\r
             0,                      // INSTANCE\r
             &PpiDescriptor,         // EFI_PEI_PPI_DESCRIPTOR\r
             (VOID**)&PeiNtService           // PPI\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Index = 0;\r
  do {\r
    Status = PeiNtService->NtAutoScan (Index, &MemoryBase, &MemorySize);\r
    if (!EFI_ERROR (Status)) {\r
      Attributes =\r
        (\r
          EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
          EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
          EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
          EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |\r
          EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |\r
          EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE\r
        );\r
\r
      if (Index == 0) {\r
        //\r
        // Register the memory with the PEI Core\r
        //\r
        Status = PeiServicesInstallPeiMemory (MemoryBase, MemorySize);\r
        ASSERT_EFI_ERROR (Status);\r
\r
        Attributes |= EFI_RESOURCE_ATTRIBUTE_TESTED;\r
      }\r
      \r
      BuildResourceDescriptorHob (\r
        EFI_RESOURCE_SYSTEM_MEMORY,\r
        Attributes,\r
        MemoryBase,\r
        MemorySize\r
        );\r
    }\r
    Index++;\r
  } while (!EFI_ERROR (Status));\r
\r
  //\r
  // Build the CPU hob with 52-bit addressing and 16-bits of IO space.\r
  //\r
  BuildCpuHob (52, 16);\r
\r
  //\r
  // Build GUIDed Hob that contains the Memory Type Information array\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiReadOnlyVariable2PpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&Variable\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  DataSize = sizeof (MemoryData);\r
  Status = Variable->GetVariable (\r
                       Variable,\r
                       EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
                       &gEfiMemoryTypeInformationGuid,\r
                       NULL,\r
                       &DataSize,\r
                       &MemoryData\r
                       );\r
  if (EFI_ERROR (Status) || !ValidateMemoryTypeInfoVariable(MemoryData, DataSize)) {\r
    //\r
    // Create Memory Type Information HOB\r
    //\r
    BuildGuidDataHob (\r
      &gEfiMemoryTypeInformationGuid,\r
      mDefaultMemoryTypeInformation,\r
      sizeof(mDefaultMemoryTypeInformation)\r
      );\r
  } else {\r
    //\r
    // Create Memory Type Information HOB\r
    //\r
    BuildGuidDataHob (\r
      &gEfiMemoryTypeInformationGuid,\r
      MemoryData,\r
      DataSize\r
      );\r
  }\r
\r
  return Status;\r
}\r