Maintainers.txt: Add new reviewer for UefiPayloadPkg

[mirror_edk2.git] / UefiPayloadPkg / UefiPayloadEntry / UefiPayloadEntry.c

/** @file\r
\r
  Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UefiPayloadEntry.h"\r
\r
STATIC UINT32  mTopOfLowerUsableDram = 0;\r
\r
/**\r
   Callback function to build resource descriptor HOB\r
\r
   This function build a HOB based on the memory map entry info.\r
   It creates only EFI_RESOURCE_MEMORY_MAPPED_IO and EFI_RESOURCE_MEMORY_RESERVED\r
   resources.\r
\r
   @param MemoryMapEntry         Memory map entry info got from bootloader.\r
   @param Params                 A pointer to ACPI_BOARD_INFO.\r
\r
  @retval EFI_SUCCESS            Successfully build a HOB.\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter provided.\r
**/\r
EFI_STATUS\r
MemInfoCallbackMmio (\r
  IN MEMORY_MAP_ENTRY  *MemoryMapEntry,\r
  IN VOID              *Params\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS         Base;\r
  EFI_RESOURCE_TYPE            Type;\r
  UINT64                       Size;\r
  EFI_RESOURCE_ATTRIBUTE_TYPE  Attribue;\r
  ACPI_BOARD_INFO              *AcpiBoardInfo;\r
\r
  AcpiBoardInfo = (ACPI_BOARD_INFO *)Params;\r
  if (AcpiBoardInfo == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Skip types already handled in MemInfoCallback\r
  //\r
  if ((MemoryMapEntry->Type == E820_RAM) || (MemoryMapEntry->Type == E820_ACPI)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (MemoryMapEntry->Base == AcpiBoardInfo->PcieBaseAddress) {\r
    //\r
    // MMCONF is always MMIO\r
    //\r
    Type = EFI_RESOURCE_MEMORY_MAPPED_IO;\r
  } else if (MemoryMapEntry->Base < mTopOfLowerUsableDram) {\r
    //\r
    // It's in DRAM and thus must be reserved\r
    //\r
    Type = EFI_RESOURCE_MEMORY_RESERVED;\r
  } else if ((MemoryMapEntry->Base < 0x100000000ULL) && (MemoryMapEntry->Base >= mTopOfLowerUsableDram)) {\r
    //\r
    // It's not in DRAM, must be MMIO\r
    //\r
    Type = EFI_RESOURCE_MEMORY_MAPPED_IO;\r
  } else {\r
    Type = EFI_RESOURCE_MEMORY_RESERVED;\r
  }\r
\r
  Base = MemoryMapEntry->Base;\r
  Size = MemoryMapEntry->Size;\r
\r
  Attribue = EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
             EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
             EFI_RESOURCE_ATTRIBUTE_TESTED |\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
  BuildResourceDescriptorHob (Type, Attribue, (EFI_PHYSICAL_ADDRESS)Base, Size);\r
  DEBUG ((DEBUG_INFO, "buildhob: base = 0x%lx, size = 0x%lx, type = 0x%x\n", Base, Size, Type));\r
\r
  if ((MemoryMapEntry->Type == E820_UNUSABLE) ||\r
      (MemoryMapEntry->Type == E820_DISABLED))\r
  {\r
    BuildMemoryAllocationHob (Base, Size, EfiUnusableMemory);\r
  } else if (MemoryMapEntry->Type == E820_PMEM) {\r
    BuildMemoryAllocationHob (Base, Size, EfiPersistentMemory);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
   Callback function to find TOLUD (Top of Lower Usable DRAM)\r
\r
   Estimate where TOLUD (Top of Lower Usable DRAM) resides. The exact position\r
   would require platform specific code.\r
\r
   @param MemoryMapEntry         Memory map entry info got from bootloader.\r
   @param Params                 Not used for now.\r
\r
  @retval EFI_SUCCESS            Successfully updated mTopOfLowerUsableDram.\r
**/\r
EFI_STATUS\r
FindToludCallback (\r
  IN MEMORY_MAP_ENTRY  *MemoryMapEntry,\r
  IN VOID              *Params\r
  )\r
{\r
  //\r
  // This code assumes that the memory map on this x86 machine below 4GiB is continous\r
  // until TOLUD. In addition it assumes that the bootloader provided memory tables have\r
  // no "holes" and thus the first memory range not covered by e820 marks the end of\r
  // usable DRAM. In addition it's assumed that every reserved memory region touching\r
  // usable RAM is also covering DRAM, everything else that is marked reserved thus must be\r
  // MMIO not detectable by bootloader/OS\r
  //\r
\r
  //\r
  // Skip memory types not RAM or reserved\r
  //\r
  if ((MemoryMapEntry->Type == E820_UNUSABLE) || (MemoryMapEntry->Type == E820_DISABLED) ||\r
      (MemoryMapEntry->Type == E820_PMEM))\r
  {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Skip resources above 4GiB\r
  //\r
  if ((MemoryMapEntry->Base + MemoryMapEntry->Size) > 0x100000000ULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if ((MemoryMapEntry->Type == E820_RAM) || (MemoryMapEntry->Type == E820_ACPI) ||\r
      (MemoryMapEntry->Type == E820_NVS))\r
  {\r
    //\r
    // It's usable DRAM. Update TOLUD.\r
    //\r
    if (mTopOfLowerUsableDram < (MemoryMapEntry->Base + MemoryMapEntry->Size)) {\r
      mTopOfLowerUsableDram = (UINT32)(MemoryMapEntry->Base + MemoryMapEntry->Size);\r
    }\r
  } else {\r
    //\r
    // It might be 'reserved DRAM' or 'MMIO'.\r
    //\r
    // If it touches usable DRAM at Base assume it's DRAM as well,\r
    // as it could be bootloader installed tables, TSEG, GTT, ...\r
    //\r
    if (mTopOfLowerUsableDram == MemoryMapEntry->Base) {\r
      mTopOfLowerUsableDram = (UINT32)(MemoryMapEntry->Base + MemoryMapEntry->Size);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
   Callback function to build resource descriptor HOB\r
\r
   This function build a HOB based on the memory map entry info.\r
   Only add EFI_RESOURCE_SYSTEM_MEMORY.\r
\r
   @param MemoryMapEntry         Memory map entry info got from bootloader.\r
   @param Params                 Not used for now.\r
\r
  @retval RETURN_SUCCESS        Successfully build a HOB.\r
**/\r
EFI_STATUS\r
MemInfoCallback (\r
  IN MEMORY_MAP_ENTRY  *MemoryMapEntry,\r
  IN VOID              *Params\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS         Base;\r
  EFI_RESOURCE_TYPE            Type;\r
  UINT64                       Size;\r
  EFI_RESOURCE_ATTRIBUTE_TYPE  Attribue;\r
\r
  //\r
  // Skip everything not known to be usable DRAM.\r
  // It will be added later.\r
  //\r
  if ((MemoryMapEntry->Type != E820_RAM) && (MemoryMapEntry->Type != E820_ACPI) &&\r
      (MemoryMapEntry->Type != E820_NVS))\r
  {\r
    return RETURN_SUCCESS;\r
  }\r
\r
  Type = EFI_RESOURCE_SYSTEM_MEMORY;\r
  Base = MemoryMapEntry->Base;\r
  Size = MemoryMapEntry->Size;\r
\r
  Attribue = EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
             EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
             EFI_RESOURCE_ATTRIBUTE_TESTED |\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
  BuildResourceDescriptorHob (Type, Attribue, (EFI_PHYSICAL_ADDRESS)Base, Size);\r
  DEBUG ((DEBUG_INFO, "buildhob: base = 0x%lx, size = 0x%lx, type = 0x%x\n", Base, Size, Type));\r
\r
  if (MemoryMapEntry->Type == E820_ACPI) {\r
    BuildMemoryAllocationHob (Base, Size, EfiACPIReclaimMemory);\r
  } else if (MemoryMapEntry->Type == E820_NVS) {\r
    BuildMemoryAllocationHob (Base, Size, EfiACPIMemoryNVS);\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  It will build HOBs based on information from bootloaders.\r
\r
  @retval EFI_SUCCESS        If it completed successfully.\r
  @retval Others             If it failed to build required HOBs.\r
**/\r
EFI_STATUS\r
BuildHobFromBl (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  ACPI_BOARD_INFO                   *AcpiBoardInfo;\r
  EFI_PEI_GRAPHICS_INFO_HOB         GfxInfo;\r
  EFI_PEI_GRAPHICS_INFO_HOB         *NewGfxInfo;\r
  EFI_PEI_GRAPHICS_DEVICE_INFO_HOB  GfxDeviceInfo;\r
  EFI_PEI_GRAPHICS_DEVICE_INFO_HOB  *NewGfxDeviceInfo;\r
  UNIVERSAL_PAYLOAD_SMBIOS_TABLE    *SmBiosTableHob;\r
  UNIVERSAL_PAYLOAD_ACPI_TABLE      *AcpiTableHob;\r
\r
  //\r
  // First find TOLUD\r
  //\r
  DEBUG ((DEBUG_INFO, "Guessing Top of Lower Usable DRAM:\n"));\r
  Status = ParseMemoryInfo (FindToludCallback, NULL);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "Assuming TOLUD = 0x%x\n", mTopOfLowerUsableDram));\r
\r
  //\r
  // Parse memory info and build memory HOBs for Usable RAM\r
  //\r
  DEBUG ((DEBUG_INFO, "Building ResourceDescriptorHobs for usable memory:\n"));\r
  Status = ParseMemoryInfo (MemInfoCallback, NULL);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Create guid hob for frame buffer information\r
  //\r
  Status = ParseGfxInfo (&GfxInfo);\r
  if (!EFI_ERROR (Status)) {\r
    NewGfxInfo = BuildGuidHob (&gEfiGraphicsInfoHobGuid, sizeof (GfxInfo));\r
    ASSERT (NewGfxInfo != NULL);\r
    CopyMem (NewGfxInfo, &GfxInfo, sizeof (GfxInfo));\r
    DEBUG ((DEBUG_INFO, "Created graphics info hob\n"));\r
  }\r
\r
  Status = ParseGfxDeviceInfo (&GfxDeviceInfo);\r
  if (!EFI_ERROR (Status)) {\r
    NewGfxDeviceInfo = BuildGuidHob (&gEfiGraphicsDeviceInfoHobGuid, sizeof (GfxDeviceInfo));\r
    ASSERT (NewGfxDeviceInfo != NULL);\r
    CopyMem (NewGfxDeviceInfo, &GfxDeviceInfo, sizeof (GfxDeviceInfo));\r
    DEBUG ((DEBUG_INFO, "Created graphics device info hob\n"));\r
  }\r
\r
  //\r
  // Creat SmBios table Hob\r
  //\r
  SmBiosTableHob = BuildGuidHob (&gUniversalPayloadSmbiosTableGuid, sizeof (UNIVERSAL_PAYLOAD_SMBIOS_TABLE));\r
  ASSERT (SmBiosTableHob != NULL);\r
  SmBiosTableHob->Header.Revision = UNIVERSAL_PAYLOAD_SMBIOS_TABLE_REVISION;\r
  SmBiosTableHob->Header.Length   = sizeof (UNIVERSAL_PAYLOAD_SMBIOS_TABLE);\r
  DEBUG ((DEBUG_INFO, "Create smbios table gUniversalPayloadSmbiosTableGuid guid hob\n"));\r
  Status = ParseSmbiosTable (SmBiosTableHob);\r
  if (!EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "Detected Smbios Table at 0x%lx\n", SmBiosTableHob->SmBiosEntryPoint));\r
  }\r
\r
  //\r
  // Creat ACPI table Hob\r
  //\r
  AcpiTableHob = BuildGuidHob (&gUniversalPayloadAcpiTableGuid, sizeof (UNIVERSAL_PAYLOAD_ACPI_TABLE));\r
  ASSERT (AcpiTableHob != NULL);\r
  AcpiTableHob->Header.Revision = UNIVERSAL_PAYLOAD_ACPI_TABLE_REVISION;\r
  AcpiTableHob->Header.Length   = sizeof (UNIVERSAL_PAYLOAD_ACPI_TABLE);\r
  DEBUG ((DEBUG_INFO, "Create ACPI table gUniversalPayloadAcpiTableGuid guid hob\n"));\r
  Status = ParseAcpiTableInfo (AcpiTableHob);\r
  if (!EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "Detected ACPI Table at 0x%lx\n", AcpiTableHob->Rsdp));\r
  }\r
\r
  //\r
  // Create guid hob for acpi board information\r
  //\r
  AcpiBoardInfo = BuildHobFromAcpi (AcpiTableHob->Rsdp);\r
  ASSERT (AcpiBoardInfo != NULL);\r
\r
  //\r
  // Parse memory info and build memory HOBs for reserved DRAM and MMIO\r
  //\r
  DEBUG ((DEBUG_INFO, "Building ResourceDescriptorHobs for reserved memory:\n"));\r
  Status = ParseMemoryInfo (MemInfoCallbackMmio, AcpiBoardInfo);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Parse the misc info provided by bootloader\r
  //\r
  Status = ParseMiscInfo ();\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_WARN, "Error when parsing misc info, Status = %r\n", Status));\r
  }\r
\r
  //\r
  // Parse platform specific information.\r
  //\r
  Status = ParsePlatformInfo ();\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Error when parsing platform info, Status = %r\n", Status));\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function will build some generic HOBs that doesn't depend on information from bootloaders.\r
\r
**/\r
VOID\r
BuildGenericHob (\r
  VOID\r
  )\r
{\r
  UINT32                       RegEax;\r
  UINT8                        PhysicalAddressBits;\r
  EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute;\r
\r
  // The UEFI payload FV\r
  BuildMemoryAllocationHob (PcdGet32 (PcdPayloadFdMemBase), PcdGet32 (PcdPayloadFdMemSize), EfiBootServicesData);\r
\r
  //\r
  // Build CPU memory space and IO space hob\r
  //\r
  AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
  if (RegEax >= 0x80000008) {\r
    AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
    PhysicalAddressBits = (UINT8)RegEax;\r
  } else {\r
    PhysicalAddressBits = 36;\r
  }\r
\r
  BuildCpuHob (PhysicalAddressBits, 16);\r
\r
  //\r
  // Report Local APIC range, cause sbl HOB to be NULL, comment now\r
  //\r
  ResourceAttribute = (\r
                       EFI_RESOURCE_ATTRIBUTE_PRESENT |\r
                       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |\r
                       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |\r
                       EFI_RESOURCE_ATTRIBUTE_TESTED\r
                       );\r
  BuildResourceDescriptorHob (EFI_RESOURCE_MEMORY_MAPPED_IO, ResourceAttribute, 0xFEC80000, SIZE_512KB);\r
  BuildMemoryAllocationHob (0xFEC80000, SIZE_512KB, EfiMemoryMappedIO);\r
}\r
\r
/**\r
  Entry point to the C language phase of UEFI payload.\r
\r
  @param[in]   BootloaderParameter    The starting address of bootloader parameter block.\r
\r
  @retval      It will not return if SUCCESS, and return error when passing bootloader parameter.\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN UINTN  BootloaderParameter\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  PHYSICAL_ADDRESS                    DxeCoreEntryPoint;\r
  UINTN                               MemBase;\r
  UINTN                               HobMemBase;\r
  UINTN                               HobMemTop;\r
  EFI_PEI_HOB_POINTERS                Hob;\r
  SERIAL_PORT_INFO                    SerialPortInfo;\r
  UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO  *UniversalSerialPort;\r
\r
  Status = PcdSet64S (PcdBootloaderParameter, BootloaderParameter);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  // Initialize floating point operating environment to be compliant with UEFI spec.\r
  InitializeFloatingPointUnits ();\r
\r
  // HOB region is used for HOB and memory allocation for this module\r
  MemBase    = PcdGet32 (PcdPayloadFdMemBase);\r
  HobMemBase = ALIGN_VALUE (MemBase + PcdGet32 (PcdPayloadFdMemSize), SIZE_1MB);\r
  HobMemTop  = HobMemBase + FixedPcdGet32 (PcdSystemMemoryUefiRegionSize);\r
\r
  HobConstructor ((VOID *)MemBase, (VOID *)HobMemTop, (VOID *)HobMemBase, (VOID *)HobMemTop);\r
\r
  //\r
  // Build serial port info\r
  //\r
  Status = ParseSerialInfo (&SerialPortInfo);\r
  if (!EFI_ERROR (Status)) {\r
    UniversalSerialPort = BuildGuidHob (&gUniversalPayloadSerialPortInfoGuid, sizeof (UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO));\r
    ASSERT (UniversalSerialPort != NULL);\r
    UniversalSerialPort->Header.Revision = UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_REVISION;\r
    UniversalSerialPort->Header.Length   = sizeof (UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO);\r
    UniversalSerialPort->UseMmio         = (SerialPortInfo.Type == 1) ? FALSE : TRUE;\r
    UniversalSerialPort->RegisterBase    = SerialPortInfo.BaseAddr;\r
    UniversalSerialPort->BaudRate        = SerialPortInfo.Baud;\r
    UniversalSerialPort->RegisterStride  = (UINT8)SerialPortInfo.RegWidth;\r
  }\r
\r
  // The library constructors might depend on serial port, so call it after serial port hob\r
  ProcessLibraryConstructorList ();\r
  DEBUG ((DEBUG_INFO, "sizeof(UINTN) = 0x%x\n", sizeof (UINTN)));\r
\r
  // Build HOB based on information from Bootloader\r
  Status = BuildHobFromBl ();\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "BuildHobFromBl Status = %r\n", Status));\r
    return Status;\r
  }\r
\r
  // Build other HOBs required by DXE\r
  BuildGenericHob ();\r
\r
  // Load the DXE Core\r
  Status = LoadDxeCore (&DxeCoreEntryPoint);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  DEBUG ((DEBUG_INFO, "DxeCoreEntryPoint = 0x%lx\n", DxeCoreEntryPoint));\r
\r
  //\r
  // Mask off all legacy 8259 interrupt sources\r
  //\r
  IoWrite8 (LEGACY_8259_MASK_REGISTER_MASTER, 0xFF);\r
  IoWrite8 (LEGACY_8259_MASK_REGISTER_SLAVE, 0xFF);\r
\r
  Hob.HandoffInformationTable = (EFI_HOB_HANDOFF_INFO_TABLE *)GetFirstHob (EFI_HOB_TYPE_HANDOFF);\r
  HandOffToDxeCore (DxeCoreEntryPoint, Hob);\r
\r
  // Should not get here\r
  CpuDeadLoop ();\r
  return EFI_SUCCESS;\r
}\r