Re: [PATCH edk2-platforms v3 05/27] Silicon/SynQuacer: add MemoryInitPeiLib implementation

[Leif Lindholm <leif.lindholm@linaro.org>]

On Tue, Oct 31, 2017 at 10:51:56AM +0000, Ard Biesheuvel wrote:
> Implement MemoryInitPeiLib based on the newly added DramInfo
> PPI, which retrieves the DRAM information from lower level
> firmware.
> 
> Note that the firmware volumes in SPI NOR are mapped with
> different attributes: the FV containing the PEI modules that
> may execute in place is mapped as uncached memory, given that
> it requires executable permissions. The FV containing the
> compressed DXE modules is mapped with device attributes for
> performance (!), and copied into DRAM by the platform PEIM
> once permanent memory is installed.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

> ---
>  Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.c   | 186 ++++++++++++++++++++
>  Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.inf |  67 +++++++
>  2 files changed, 253 insertions(+)
> 
> diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.c b/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.c
> new file mode 100644
> index 000000000000..e9a266f0997a
> --- /dev/null
> +++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.c
> @@ -0,0 +1,186 @@
> +/** @file
> +*
> +*  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
> +*  Copyright (c) 2017, Linaro, Ltd. All rights reserved.
> +*
> +*  This program and the accompanying materials
> +*  are licensed and made available under the terms and conditions of the BSD License
> +*  which accompanies this distribution.  The full text of the license may be found at
> +*  http://opensource.org/licenses/bsd-license.php
> +*
> +*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +*
> +**/
> +
> +#include <PiPei.h>
> +
> +#include <Library/ArmLib.h>
> +#include <Library/ArmMmuLib.h>
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/HobLib.h>
> +#include <Library/MemoryAllocationLib.h>
> +#include <Library/PeiServicesLib.h>
> +
> +#include <Platform/MemoryMap.h>
> +#include <Platform/Pcie.h>
> +
> +#include <Ppi/DramInfo.h>
> +
> +#define ARM_MEMORY_REGION(Base, Size) \
> +  { (Base), (Base), (Size), ARM_MEMORY_REGION_ATTRIBUTE_WRITE_BACK }
> +
> +#define ARM_UNCACHED_REGION(Base, Size) \
> +  { (Base), (Base), (Size), ARM_MEMORY_REGION_ATTRIBUTE_UNCACHED_UNBUFFERED }
> +
> +#define ARM_DEVICE_REGION(Base, Size) \
> +  { (Base), (Base), (Size), ARM_MEMORY_REGION_ATTRIBUTE_DEVICE }
> +
> +VOID
> +BuildMemoryTypeInformationHob (
> +  VOID
> +  );
> +
> +STATIC CONST EFI_RESOURCE_ATTRIBUTE_TYPE mDramResourceAttributes =
> +  EFI_RESOURCE_ATTRIBUTE_PRESENT |
> +  EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
> +  EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |
> +  EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |
> +  EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE |
> +  EFI_RESOURCE_ATTRIBUTE_TESTED;
> +
> +STATIC CONST ARM_MEMORY_REGION_DESCRIPTOR mVirtualMemoryTable[] = {
> +  // Memory mapped SPI NOR flash
> +  // Mapped with device attributes for performance (!)
> +  ARM_DEVICE_REGION (FixedPcdGet64 (PcdFdBaseAddress),
> +                     FixedPcdGet32 (PcdFdSize)),
> +
> +  // Memory mapped SPI NOR flash - XIP region
> +  // Sub-region of the preceding one - supersede with normal-nc attributes
> +  ARM_UNCACHED_REGION (FixedPcdGet64 (PcdFvBaseAddress),
> +                       FixedPcdGet32 (PcdFvSize)),
> +
> +  // SynQuacer OnChip peripherals
> +  ARM_DEVICE_REGION (SYNQUACER_PERIPHERALS_BASE,
> +                     SYNQUACER_PERIPHERALS_SZ),
> +
> +  // SynQuacer OnChip non-secure SRAM
> +  ARM_UNCACHED_REGION (SYNQUACER_NON_SECURE_SRAM_BASE,
> +                       SYNQUACER_NON_SECURE_SRAM_SZ),
> +
> +  // SynQuacer GIC-500
> +  ARM_DEVICE_REGION (SYNQUACER_GIC500_DIST_BASE, SYNQUACER_GIC500_DIST_SIZE),
> +  ARM_DEVICE_REGION (SYNQUACER_GIC500_RDIST_BASE, SYNQUACER_GIC500_RDIST_SIZE),
> +
> +  // SynQuacer eMMC(SDH30)
> +  ARM_DEVICE_REGION (SYNQUACER_EMMC_BASE, SYNQUACER_EMMC_BASE_SZ),
> +
> +  // SynQuacer EEPROM - could point to NOR flash as well
> +  ARM_DEVICE_REGION (FixedPcdGet32 (PcdNetsecEepromBase),
> +                     SYNQUACER_EEPROM_BASE_SZ),
> +
> +  // SynQuacer NETSEC
> +  ARM_DEVICE_REGION (SYNQUACER_NETSEC_BASE, SYNQUACER_NETSEC_BASE_SZ),
> +
> +  // PCIe control registers
> +  ARM_DEVICE_REGION (SYNQUACER_PCIE_BASE, SYNQUACER_PCIE_SIZE),
> +
> +  // PCIe config space
> +  ARM_DEVICE_REGION (SYNQUACER_PCI_SEG0_CONFIG_BASE,
> +                     SYNQUACER_PCI_SEG0_CONFIG_SIZE),
> +  ARM_DEVICE_REGION (SYNQUACER_PCI_SEG1_CONFIG_BASE,
> +                     SYNQUACER_PCI_SEG1_CONFIG_SIZE),
> +
> +  // PCIe I/O space
> +  ARM_DEVICE_REGION (SYNQUACER_PCI_SEG0_PORTIO_MEMBASE,
> +                     SYNQUACER_PCI_SEG0_PORTIO_MEMSIZE),
> +  ARM_DEVICE_REGION (SYNQUACER_PCI_SEG1_PORTIO_MEMBASE,
> +                     SYNQUACER_PCI_SEG1_PORTIO_MEMSIZE),
> +};
> +
> +STATIC
> +EFI_STATUS
> +DeclareDram (
> +  OUT ARM_MEMORY_REGION_DESCRIPTOR    **VirtualMemoryTable
> +  )
> +{
> +  SYNQUACER_DRAM_INFO_PPI       *DramInfo;
> +  EFI_STATUS                    Status;
> +  UINTN                         Idx;
> +  UINTN                         RegionCount;
> +  UINT64                        Base;
> +  UINT64                        Size;
> +  ARM_MEMORY_REGION_DESCRIPTOR  *DramDescriptor;
> +
> +  Status = PeiServicesLocatePpi (&gSynQuacerDramInfoPpiGuid, 0, NULL,
> +             (VOID **)&DramInfo);
> +  if (EFI_ERROR (Status)) {
> +    return Status;
> +  }
> +
> +  Status = DramInfo->GetRegionCount (&RegionCount);
> +  if (EFI_ERROR (Status)) {
> +    return Status;
> +  }
> +
> +  *VirtualMemoryTable = AllocatePool (sizeof (mVirtualMemoryTable) +
> +                                      (RegionCount + 1) *
> +                                      sizeof (ARM_MEMORY_REGION_DESCRIPTOR));
> +  if (*VirtualMemoryTable == NULL) {
> +    return EFI_OUT_OF_RESOURCES;
> +  }
> +  CopyMem (*VirtualMemoryTable, mVirtualMemoryTable,
> +    sizeof (mVirtualMemoryTable));
> +
> +  DramDescriptor = *VirtualMemoryTable + ARRAY_SIZE (mVirtualMemoryTable);
> +
> +  for (Idx = 0; Idx < RegionCount; Idx++, DramDescriptor++) {
> +    Status = DramInfo->GetRegion (Idx, &Base, &Size);
> +    ASSERT_EFI_ERROR (Status);
> +
> +    BuildResourceDescriptorHob (EFI_RESOURCE_SYSTEM_MEMORY,
> +      mDramResourceAttributes, Base, Size);
> +
> +    DramDescriptor->PhysicalBase = Base;
> +    DramDescriptor->VirtualBase  = Base;
> +    DramDescriptor->Length       = Size;
> +    DramDescriptor->Attributes   = ARM_MEMORY_REGION_ATTRIBUTE_WRITE_BACK;
> +  }
> +
> +  DramDescriptor->PhysicalBase = 0;
> +  DramDescriptor->VirtualBase  = 0;
> +  DramDescriptor->Length       = 0;
> +  DramDescriptor->Attributes   = 0;
> +
> +  return EFI_SUCCESS;
> +}
> +
> +EFI_STATUS
> +EFIAPI
> +MemoryPeim (
> +  IN EFI_PHYSICAL_ADDRESS       UefiMemoryBase,
> +  IN UINT64                     UefiMemorySize
> +  )
> +{
> +  EFI_STATUS                    Status;
> +  ARM_MEMORY_REGION_DESCRIPTOR  *VirtualMemoryTable;
> +
> +  Status = DeclareDram (&VirtualMemoryTable);
> +  ASSERT_EFI_ERROR (Status);
> +  if (EFI_ERROR (Status)) {
> +    return Status;
> +  }
> +
> +  Status = ArmConfigureMmu (VirtualMemoryTable, NULL, NULL);
> +  ASSERT_EFI_ERROR (Status);
> +  if (EFI_ERROR (Status)) {
> +    return Status;
> +  }
> +
> +  if (FeaturePcdGet (PcdPrePiProduceMemoryTypeInformationHob)) {
> +    // Optional feature that helps prevent EFI memory map fragmentation.
> +    BuildMemoryTypeInformationHob ();
> +  }
> +  return EFI_SUCCESS;
> +}
> diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.inf b/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.inf
> new file mode 100644
> index 000000000000..06cad772a1c0
> --- /dev/null
> +++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerMemoryInitPeiLib/SynQuacerMemoryInitPeiLib.inf
> @@ -0,0 +1,67 @@
> +#/** @file
> +#
> +#  Copyright (c) 2011-2014, ARM Ltd. All rights reserved.<BR>
> +#  Copyright (c) 2017, Linaro, Ltd. All rights reserved.<BR>
> +#
> +#  This program and the accompanying materials
> +#  are licensed and made available under the terms and conditions of the BSD License
> +#  which accompanies this distribution.  The full text of the license may be found at
> +#  http://opensource.org/licenses/bsd-license.php
> +#
> +#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +#
> +#**/
> +
> +[Defines]
> +  INF_VERSION                    = 0x00010019
> +  BASE_NAME                      = SynQuacerMemoryInitPeiLib
> +  FILE_GUID                      = c69d3ce7-098c-4fcd-afb4-15fb05a39308
> +  MODULE_TYPE                    = BASE
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = MemoryInitPeiLib|SEC PEIM
> +
> +[Sources]
> +  SynQuacerMemoryInitPeiLib.c
> +
> +[Packages]
> +  ArmPkg/ArmPkg.dec
> +  EmbeddedPkg/EmbeddedPkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  MdePkg/MdePkg.dec
> +  Silicon/Socionext/SynQuacer/SynQuacer.dec
> +
> +[LibraryClasses]
> +  ArmLib
> +  ArmMmuLib
> +  BaseMemoryLib
> +  DebugLib
> +  MemoryAllocationLib
> +  PeiServicesLib
> +
> +[FeaturePcd]
> +  gEmbeddedTokenSpaceGuid.PcdPrePiProduceMemoryTypeInformationHob
> +
> +[FixedPcd]
> +  gArmTokenSpaceGuid.PcdFdBaseAddress
> +  gArmTokenSpaceGuid.PcdFdSize
> +  gArmTokenSpaceGuid.PcdFvBaseAddress
> +  gArmTokenSpaceGuid.PcdFvSize
> +  gArmTokenSpaceGuid.PcdGicDistributorBase
> +  gArmTokenSpaceGuid.PcdGicRedistributorsBase
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase
> +  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize
> +  gSynQuacerTokenSpaceGuid.PcdNetsecEepromBase
> +
> +[Pcd]
> +  gArmTokenSpaceGuid.PcdSystemMemoryBase
> +
> +[Ppis]
> +  gSynQuacerDramInfoPpiGuid             ## CONSUMES
> +
> +[Depex]
> +  gSynQuacerDramInfoPpiGuid
> -- 
> 2.11.0
>