--- /dev/null
+/** @file\r
+ Sample to provide FSP hob process related function.\r
+\r
+ Copyright (c) 2014, 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 <PiPei.h>\r
+\r
+#include <Library/PeiServicesLib.h>\r
+#include <Library/PeiServicesTablePointerLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/HobLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/FspPlatformInfoLib.h>\r
+\r
+#include <Guid/GuidHobFspEas.h>\r
+#include <Guid/MemoryTypeInformation.h>\r
+#include <Ppi/Capsule.h>\r
+\r
+//\r
+// Additional pages are used by DXE memory manager.\r
+// It should be consistent between RetrieveRequiredMemorySize() and GetPeiMemSize()\r
+//\r
+#define PEI_ADDITIONAL_MEMORY_SIZE (16 * EFI_PAGE_SIZE)\r
+\r
+/**\r
+ Get the mem size in memory type infromation table.\r
+\r
+ @param[in] PeiServices PEI Services table.\r
+\r
+ @return the mem size in memory type infromation table.\r
+**/\r
+UINT64\r
+GetMemorySizeInMemoryTypeInformation (\r
+ IN EFI_PEI_SERVICES **PeiServices\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_PEI_HOB_POINTERS Hob;\r
+ EFI_MEMORY_TYPE_INFORMATION *MemoryData;\r
+ UINT8 Index;\r
+ UINTN TempPageNum;\r
+\r
+ MemoryData = NULL;\r
+ Status = (*PeiServices)->GetHobList ((CONST EFI_PEI_SERVICES**)PeiServices, (VOID **) &Hob.Raw);\r
+ while (!END_OF_HOB_LIST (Hob)) {\r
+ if (Hob.Header->HobType == EFI_HOB_TYPE_GUID_EXTENSION &&\r
+ CompareGuid (&Hob.Guid->Name, &gEfiMemoryTypeInformationGuid)) {\r
+ MemoryData = (EFI_MEMORY_TYPE_INFORMATION *) (Hob.Raw + sizeof (EFI_HOB_GENERIC_HEADER) + sizeof (EFI_GUID));\r
+ break;\r
+ }\r
+\r
+ Hob.Raw = GET_NEXT_HOB (Hob);\r
+ }\r
+\r
+ if (MemoryData == NULL) {\r
+ return 0;\r
+ }\r
+\r
+ TempPageNum = 0;\r
+ for (Index = 0; MemoryData[Index].Type != EfiMaxMemoryType; Index++) {\r
+ //\r
+ // Accumulate default memory size requirements\r
+ //\r
+ TempPageNum += MemoryData[Index].NumberOfPages;\r
+ }\r
+\r
+ return TempPageNum * EFI_PAGE_SIZE;\r
+}\r
+\r
+/**\r
+ Get the mem size need to be reserved in PEI phase.\r
+\r
+ @param[in] PeiServices PEI Services table.\r
+\r
+ @return the mem size need to be reserved in PEI phase.\r
+**/\r
+UINT64\r
+RetrieveRequiredMemorySize (\r
+ IN EFI_PEI_SERVICES **PeiServices\r
+ )\r
+{\r
+ UINT64 Size;\r
+\r
+ Size = GetMemorySizeInMemoryTypeInformation (PeiServices);\r
+ return Size + PEI_ADDITIONAL_MEMORY_SIZE;\r
+}\r
+\r
+/**\r
+ Get the mem size need to be consumed and reserved in PEI phase.\r
+\r
+ @param[in] PeiServices PEI Services table.\r
+ @param[in] BootMode Current boot mode.\r
+\r
+ @return the mem size need to be consumed and reserved in PEI phase.\r
+**/\r
+UINT64\r
+GetPeiMemSize (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN UINT32 BootMode\r
+ )\r
+{\r
+ UINT64 Size;\r
+ UINT64 MinSize;\r
+\r
+ if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
+ return PcdGet32 (PcdPeiRecoveryMinMemSize);\r
+ }\r
+\r
+ Size = GetMemorySizeInMemoryTypeInformation (PeiServices);\r
+\r
+ if (BootMode == BOOT_ON_FLASH_UPDATE) {\r
+ //\r
+ // Maybe more size when in CapsuleUpdate phase ?\r
+ //\r
+ MinSize = PcdGet32 (PcdPeiMinMemSize);\r
+ } else {\r
+ MinSize = PcdGet32 (PcdPeiMinMemSize);\r
+ }\r
+\r
+ return MinSize + Size + PEI_ADDITIONAL_MEMORY_SIZE;\r
+}\r
+\r
+/**\r
+ BIOS process FspBobList.\r
+\r
+ @param[in] FspHobList Pointer to the HOB data structure produced by FSP.\r
+\r
+ @return If platform process the FSP hob list successfully.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FspHobProcess (\r
+ IN VOID *FspHobList\r
+ )\r
+{\r
+ EFI_PEI_HOB_POINTERS Hob;\r
+ UINT64 LowMemorySize;\r
+ UINT64 FspMemorySize;\r
+ EFI_PHYSICAL_ADDRESS FspMemoryBase;\r
+ UINT64 PeiMemSize;\r
+ EFI_PHYSICAL_ADDRESS PeiMemBase;\r
+ UINT64 S3PeiMemSize;\r
+ EFI_PHYSICAL_ADDRESS S3PeiMemBase;\r
+ BOOLEAN FoundFspMemHob;\r
+ EFI_STATUS Status;\r
+ EFI_BOOT_MODE BootMode;\r
+ PEI_CAPSULE_PPI *Capsule;\r
+ VOID *CapsuleBuffer;\r
+ UINTN CapsuleBufferLength;\r
+ UINT64 RequiredMemSize;\r
+ EFI_PEI_SERVICES **PeiServices;\r
+\r
+ PeiServices = (EFI_PEI_SERVICES **)GetPeiServicesTablePointer ();\r
+\r
+ PeiServicesGetBootMode (&BootMode);\r
+\r
+ PeiMemBase = 0;\r
+ LowMemorySize = 0;\r
+ FspMemorySize = 0;\r
+ FspMemoryBase = 0;\r
+ FoundFspMemHob = FALSE;\r
+\r
+ //\r
+ // Parse the hob list from fsp\r
+ // Report all the resource hob except the memory between 1M and 4G\r
+ //\r
+ Hob.Raw = (UINT8 *)(UINTN)FspHobList;\r
+ DEBUG((DEBUG_INFO, "FspHobList - 0x%x\n", FspHobList));\r
+\r
+ while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, Hob.Raw)) != NULL) {\r
+ DEBUG((DEBUG_INFO, "\nResourceType: 0x%x\n", Hob.ResourceDescriptor->ResourceType));\r
+ if ((Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY) ||\r
+ (Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_MEMORY_RESERVED)) {\r
+ DEBUG((DEBUG_INFO, "ResourceAttribute: 0x%x\n", Hob.ResourceDescriptor->ResourceAttribute));\r
+ DEBUG((DEBUG_INFO, "PhysicalStart: 0x%x\n", Hob.ResourceDescriptor->PhysicalStart));\r
+ DEBUG((DEBUG_INFO, "ResourceLength: 0x%x\n", Hob.ResourceDescriptor->ResourceLength));\r
+ DEBUG((DEBUG_INFO, "Owner: %g\n\n", &Hob.ResourceDescriptor->Owner));\r
+ }\r
+\r
+ if ((Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_SYSTEM_MEMORY) // Found the low memory length below 4G\r
+ && (Hob.ResourceDescriptor->PhysicalStart >= BASE_1MB)\r
+ && (Hob.ResourceDescriptor->PhysicalStart + Hob.ResourceDescriptor->ResourceLength <= BASE_4GB)) {\r
+ LowMemorySize += Hob.ResourceDescriptor->ResourceLength;\r
+ Hob.Raw = GET_NEXT_HOB (Hob);\r
+ continue;\r
+ }\r
+\r
+ if ((Hob.ResourceDescriptor->ResourceType == EFI_RESOURCE_MEMORY_RESERVED) // Found the low memory length below 4G\r
+ && (Hob.ResourceDescriptor->PhysicalStart >= BASE_1MB)\r
+ && (Hob.ResourceDescriptor->PhysicalStart + Hob.ResourceDescriptor->ResourceLength <= BASE_4GB)\r
+ && (CompareGuid (&Hob.ResourceDescriptor->Owner, &gFspReservedMemoryResourceHobGuid))) {\r
+ FoundFspMemHob = TRUE;\r
+ FspMemoryBase = Hob.ResourceDescriptor->PhysicalStart;\r
+ FspMemorySize = Hob.ResourceDescriptor->ResourceLength;\r
+ DEBUG((DEBUG_INFO, "Find fsp mem hob, base 0x%x, len 0x%x\n", FspMemoryBase, FspMemorySize));\r
+ }\r
+\r
+ //\r
+ // Report the resource hob\r
+ //\r
+ BuildResourceDescriptorHob (\r
+ Hob.ResourceDescriptor->ResourceType,\r
+ Hob.ResourceDescriptor->ResourceAttribute,\r
+ Hob.ResourceDescriptor->PhysicalStart,\r
+ Hob.ResourceDescriptor->ResourceLength\r
+ );\r
+\r
+ Hob.Raw = GET_NEXT_HOB (Hob);\r
+ }\r
+\r
+ if (!FoundFspMemHob) {\r
+ DEBUG((DEBUG_INFO, "Didn't find the fsp used memory information.\n"));\r
+ //ASSERT(FALSE);\r
+ }\r
+\r
+ DEBUG((DEBUG_INFO, "LowMemorySize: 0x%x.\n", LowMemorySize));\r
+ DEBUG((DEBUG_INFO, "FspMemoryBase: 0x%x.\n", FspMemoryBase));\r
+ DEBUG((DEBUG_INFO, "FspMemorySize: 0x%x.\n", FspMemorySize));\r
+\r
+ if (BootMode == BOOT_ON_S3_RESUME) {\r
+ BuildResourceDescriptorHob (\r
+ EFI_RESOURCE_SYSTEM_MEMORY,\r
+ (\r
+ 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
+ BASE_1MB,\r
+ LowMemorySize\r
+ );\r
+\r
+ Status = GetS3MemoryInfo (&S3PeiMemBase, &S3PeiMemSize);\r
+ ASSERT_EFI_ERROR (Status);\r
+ DEBUG((DEBUG_INFO, "S3 memory %Xh - %Xh bytes\n", S3PeiMemBase, S3PeiMemSize));\r
+\r
+ //\r
+ // Make sure Stack and PeiMemory are not overlap - JYAO1\r
+ //\r
+\r
+ Status = PeiServicesInstallPeiMemory (\r
+ S3PeiMemBase,\r
+ S3PeiMemSize\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ } else {\r
+ PeiMemSize = GetPeiMemSize (PeiServices, BootMode);\r
+ DEBUG((DEBUG_INFO, "PEI memory size = %Xh bytes\n", PeiMemSize));\r
+\r
+ //\r
+ // Capsule mode\r
+ //\r
+ Capsule = NULL;\r
+ CapsuleBuffer = NULL;\r
+ CapsuleBufferLength = 0;\r
+ if (BootMode == BOOT_ON_FLASH_UPDATE) {\r
+ Status = PeiServicesLocatePpi (\r
+ &gPeiCapsulePpiGuid,\r
+ 0,\r
+ NULL,\r
+ (VOID **) &Capsule\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ if (Status == EFI_SUCCESS) {\r
+ //\r
+ // Make sure Stack and CapsuleBuffer are not overlap - JYAO1\r
+ //\r
+ CapsuleBuffer = (VOID *)(UINTN)BASE_1MB;\r
+ CapsuleBufferLength = (UINTN)(LowMemorySize - PeiMemSize);\r
+ //\r
+ // Call the Capsule PPI Coalesce function to coalesce the capsule data.\r
+ //\r
+ Status = Capsule->Coalesce (PeiServices, &CapsuleBuffer, &CapsuleBufferLength);\r
+ }\r
+ }\r
+\r
+ RequiredMemSize = RetrieveRequiredMemorySize (PeiServices);\r
+ DEBUG((DEBUG_INFO, "Required memory size = %Xh bytes\n", RequiredMemSize));\r
+\r
+ //\r
+ // Report the main memory\r
+ //\r
+ BuildResourceDescriptorHob (\r
+ EFI_RESOURCE_SYSTEM_MEMORY,\r
+ (\r
+ 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
+ BASE_1MB,\r
+ LowMemorySize\r
+ );\r
+\r
+ //\r
+ // Make sure Stack and CapsuleBuffer are not overlap - JYAO1\r
+ //\r
+\r
+ //\r
+ // Install efi memory\r
+ //\r
+ PeiMemBase = BASE_1MB + LowMemorySize - PeiMemSize;\r
+ Status = PeiServicesInstallPeiMemory (\r
+ PeiMemBase,\r
+ PeiMemSize - RequiredMemSize\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ if (Capsule != NULL) {\r
+ Status = Capsule->CreateState (PeiServices, CapsuleBuffer, CapsuleBufferLength);\r
+ }\r
+ }\r
+\r
+ //\r
+ // NV Storage Hob\r
+ //\r
+\r
+ return EFI_SUCCESS;\r
+}\r
projects / mirror_edk2.git / blobdiff