ArmPlatformPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPlatformPkg / MemoryInitPei / MemoryInitPeim.c

/** @file\r
*\r
*  Copyright (c) 2011, ARM Limited. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <PiPei.h>\r
\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Ppi/MasterBootMode.h>\r
#include <Ppi/BootInRecoveryMode.h>\r
#include <Guid/MemoryTypeInformation.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/ArmPlatformLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
\r
EFI_STATUS\r
EFIAPI\r
MemoryPeim (\r
  IN EFI_PHYSICAL_ADDRESS               UefiMemoryBase,\r
  IN UINT64                             UefiMemorySize\r
  );\r
\r
// May want to put this into a library so you only need the PCD settings if you are using the feature?\r
VOID\r
BuildMemoryTypeInformationHob (\r
  VOID\r
  )\r
{\r
  EFI_MEMORY_TYPE_INFORMATION   Info[10];\r
\r
  Info[0].Type          = EfiACPIReclaimMemory;\r
  Info[0].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiACPIReclaimMemory);\r
  Info[1].Type          = EfiACPIMemoryNVS;\r
  Info[1].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiACPIMemoryNVS);\r
  Info[2].Type          = EfiReservedMemoryType;\r
  Info[2].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiReservedMemoryType);\r
  Info[3].Type          = EfiRuntimeServicesData;\r
  Info[3].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiRuntimeServicesData);\r
  Info[4].Type          = EfiRuntimeServicesCode;\r
  Info[4].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiRuntimeServicesCode);\r
  Info[5].Type          = EfiBootServicesCode;\r
  Info[5].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiBootServicesCode);\r
  Info[6].Type          = EfiBootServicesData;\r
  Info[6].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiBootServicesData);\r
  Info[7].Type          = EfiLoaderCode;\r
  Info[7].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiLoaderCode);\r
  Info[8].Type          = EfiLoaderData;\r
  Info[8].NumberOfPages = PcdGet32 (PcdMemoryTypeEfiLoaderData);\r
\r
  // Terminator for the list\r
  Info[9].Type          = EfiMaxMemoryType;\r
  Info[9].NumberOfPages = 0;\r
\r
  BuildGuidDataHob (&gEfiMemoryTypeInformationGuid, &Info, sizeof (Info));\r
}\r
\r
/*++\r
\r
Routine Description:\r
\r
\r
\r
Arguments:\r
\r
  FileHandle  - Handle of the file being invoked.\r
  PeiServices - Describes the list of possible PEI Services.\r
\r
Returns:\r
\r
  Status -  EFI_SUCCESS if the boot mode could be set\r
\r
--*/\r
EFI_STATUS\r
EFIAPI\r
InitializeMemory (\r
  IN       EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  UINTN                                 SystemMemoryBase;\r
  UINT64                                SystemMemoryTop;\r
  UINTN                                 FdBase;\r
  UINTN                                 FdTop;\r
  UINTN                                 UefiMemoryBase;\r
\r
  DEBUG ((EFI_D_LOAD | EFI_D_INFO, "Memory Init PEIM Loaded\n"));\r
\r
  // Ensure PcdSystemMemorySize has been set\r
  ASSERT (PcdGet64 (PcdSystemMemorySize) != 0);\r
  ASSERT (PcdGet64 (PcdSystemMemoryBase) < (UINT64)MAX_ALLOC_ADDRESS);\r
\r
  SystemMemoryBase = (UINTN)PcdGet64 (PcdSystemMemoryBase);\r
  SystemMemoryTop = SystemMemoryBase + PcdGet64 (PcdSystemMemorySize);\r
  if (SystemMemoryTop - 1 > MAX_ALLOC_ADDRESS) {\r
    SystemMemoryTop = (UINT64)MAX_ALLOC_ADDRESS + 1;\r
  }\r
  FdBase = (UINTN)PcdGet64 (PcdFdBaseAddress);\r
  FdTop = FdBase + (UINTN)PcdGet32 (PcdFdSize);\r
\r
  //\r
  // Declare the UEFI memory to PEI\r
  //\r
\r
  // In case the firmware has been shadowed in the System Memory\r
  if ((FdBase >= SystemMemoryBase) && (FdTop <= SystemMemoryTop)) {\r
    // Check if there is enough space between the top of the system memory and the top of the\r
    // firmware to place the UEFI memory (for PEI & DXE phases)\r
    if (SystemMemoryTop - FdTop >= FixedPcdGet32 (PcdSystemMemoryUefiRegionSize)) {\r
      UefiMemoryBase = SystemMemoryTop - FixedPcdGet32 (PcdSystemMemoryUefiRegionSize);\r
    } else {\r
      // Check there is enough space for the UEFI memory\r
      ASSERT (SystemMemoryBase + FixedPcdGet32 (PcdSystemMemoryUefiRegionSize) <= FdBase);\r
\r
      UefiMemoryBase = FdBase - FixedPcdGet32 (PcdSystemMemoryUefiRegionSize);\r
    }\r
  } else {\r
    // Check the Firmware does not overlapped with the system memory\r
    ASSERT ((FdBase < SystemMemoryBase) || (FdBase >= SystemMemoryTop));\r
    ASSERT ((FdTop <= SystemMemoryBase) || (FdTop > SystemMemoryTop));\r
\r
    UefiMemoryBase = SystemMemoryTop - FixedPcdGet32 (PcdSystemMemoryUefiRegionSize);\r
  }\r
\r
  Status = PeiServicesInstallPeiMemory (UefiMemoryBase, FixedPcdGet32 (PcdSystemMemoryUefiRegionSize));\r
  ASSERT_EFI_ERROR (Status);\r
\r
  // Initialize MMU and Memory HOBs (Resource Descriptor HOBs)\r
  Status = MemoryPeim (UefiMemoryBase, FixedPcdGet32 (PcdSystemMemoryUefiRegionSize));\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r