-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
+/** @file\r
+ EFI PEI Core memory services\r
+ \r
+Copyright (c) 2006 - 2015, 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
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
-Module Name:\r
+**/\r
\r
- MemoryServices.c\r
+#include "PeiMain.h"\r
\r
-Abstract:\r
+/**\r
\r
- EFI PEI Core memory services\r
-\r
---*/\r
+ Initialize the memory services.\r
\r
-#include <PeiMain.h>\r
+ @param PrivateData Points to PeiCore's private instance data.\r
+ @param SecCoreData Points to a data structure containing information about the PEI core's operating\r
+ environment, such as the size and location of temporary RAM, the stack location and\r
+ the BFV location.\r
+ @param OldCoreData Pointer to the PEI Core data.\r
+ NULL if being run in non-permament memory mode.\r
\r
+**/\r
VOID\r
InitializeMemoryServices (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Initialize the memory services.\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- SecCoreData - Points to a data structure containing information about the PEI core's operating\r
- environment, such as the size and location of temporary RAM, the stack location and\r
- the BFV location.\r
-\r
- OldCoreData - Pointer to the PEI Core data.\r
- NULL if being run in non-permament memory mode.\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
- PrivateData->SwitchStackSignal = FALSE;\r
+ \r
+ PrivateData->SwitchStackSignal = FALSE;\r
\r
+ //\r
+ // First entering PeiCore, following code will initialized some field\r
+ // in PeiCore's private data according to hand off data from sec core.\r
+ //\r
if (OldCoreData == NULL) {\r
\r
PrivateData->PeiMemoryInstalled = FALSE;\r
-\r
- PrivateData->BottomOfCarHeap = SecCoreData->PeiTemporaryRamBase; \r
- PrivateData->TopOfCarHeap = (VOID *)((UINTN)(PrivateData->BottomOfCarHeap) + SecCoreData->PeiTemporaryRamSize);\r
- \r
- DEBUG_CODE_BEGIN ();\r
- PrivateData->SizeOfCacheAsRam = SecCoreData->PeiTemporaryRamSize + SecCoreData->StackSize;\r
- PrivateData->MaxTopOfCarHeap = (VOID *) ((UINTN) PrivateData->BottomOfCarHeap + (UINTN) PrivateData->SizeOfCacheAsRam);\r
- PrivateData->StackBase = (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->StackBase;\r
- PrivateData->StackSize = (UINT64) SecCoreData->StackSize;\r
- DEBUG_CODE_END ();\r
-\r
- PrivateData->HobList.Raw = PrivateData->BottomOfCarHeap;\r
+ PrivateData->HobList.Raw = SecCoreData->PeiTemporaryRamBase;\r
\r
PeiCoreBuildHobHandoffInfoTable (\r
BOOT_WITH_FULL_CONFIGURATION,\r
- (EFI_PHYSICAL_ADDRESS) (UINTN) PrivateData->BottomOfCarHeap,\r
+ (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->PeiTemporaryRamBase,\r
(UINTN) SecCoreData->PeiTemporaryRamSize\r
);\r
\r
//\r
- // Set PS to point to ServiceTableShadow in Cache\r
+ // Set Ps to point to ServiceTableShadow in Cache\r
//\r
- PrivateData->PS = &(PrivateData->ServiceTableShadow);\r
+ PrivateData->Ps = &(PrivateData->ServiceTableShadow);\r
}\r
\r
return;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-PeiInstallPeiMemory (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
- IN UINT64 MemoryLength\r
- )\r
-/*++\r
+/**\r
\r
-Routine Description:\r
+ This function registers the found memory configuration with the PEI Foundation.\r
\r
- Install the permanent memory is now available.\r
- Creates HOB (PHIT and Stack).\r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
- MemoryBegin - Start of memory address.\r
- MemoryLength - Length of memory.\r
+ The usage model is that the PEIM that discovers the permanent memory shall invoke this service.\r
+ This routine will hold discoveried memory information into PeiCore's private data,\r
+ and set SwitchStackSignal flag. After PEIM who discovery memory is dispatched,\r
+ PeiDispatcher will migrate temporary memory to permenement memory.\r
+ \r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param MemoryBegin Start of memory address.\r
+ @param MemoryLength Length of memory.\r
\r
-Returns:\r
+ @return EFI_SUCCESS Always success.\r
\r
- Status - EFI_SUCCESS\r
- \r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiInstallPeiMemory (\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
+ IN UINT64 MemoryLength\r
+ )\r
{\r
PEI_CORE_INSTANCE *PrivateData;\r
- EFI_HOB_HANDOFF_INFO_TABLE *OldHandOffHob;\r
- EFI_HOB_HANDOFF_INFO_TABLE *NewHandOffHob;\r
- UINT64 PeiStackSize;\r
- UINT64 EfiFreeMemorySize;\r
- EFI_PHYSICAL_ADDRESS PhysicalAddressOfOldHob;\r
- \r
- PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
\r
- PrivateData->SwitchStackSignal = TRUE;\r
- PrivateData->PeiMemoryInstalled = TRUE;\r
+ DEBUG ((EFI_D_INFO, "PeiInstallPeiMemory MemoryBegin 0x%LX, MemoryLength 0x%LX\n", MemoryBegin, MemoryLength));\r
+ PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
\r
- PrivateData->StackBase = MemoryBegin;\r
- \r
- PeiStackSize = RShiftU64 (MemoryLength, 1);\r
- if (PEI_STACK_SIZE > PeiStackSize) {\r
- PrivateData->StackSize = PeiStackSize;\r
- } else {\r
- PrivateData->StackSize = PEI_STACK_SIZE;\r
+ //\r
+ // PEI_SERVICE.InstallPeiMemory should only be called one time during whole PEI phase.\r
+ // If it is invoked more than one time, ASSERT information is given for developer debugging in debug tip and\r
+ // simply return EFI_SUCESS in release tip to ignore it.\r
+ // \r
+ if (PrivateData->PeiMemoryInstalled) {\r
+ DEBUG ((EFI_D_ERROR, "ERROR: PeiInstallPeiMemory is called more than once!\n"));\r
+ ASSERT (FALSE);\r
+ return EFI_SUCCESS;\r
}\r
-\r
- OldHandOffHob = PrivateData->HobList.HandoffInformationTable;\r
-\r
- PrivateData->HobList.Raw = (VOID *)((UINTN)(MemoryBegin + PrivateData->StackSize));\r
- NewHandOffHob = PrivateData->HobList.HandoffInformationTable;\r
- PhysicalAddressOfOldHob = (EFI_PHYSICAL_ADDRESS) (UINTN) OldHandOffHob;\r
-\r
- EfiFreeMemorySize = OldHandOffHob->EfiFreeMemoryBottom - PhysicalAddressOfOldHob;\r
- \r
- DEBUG ((EFI_D_INFO, "HOBLIST address before memory init = 0x%08x\n", OldHandOffHob));\r
- DEBUG ((EFI_D_INFO, "HOBLIST address after memory init = 0x%08x\n", NewHandOffHob));\r
-\r
- CopyMem (\r
- NewHandOffHob,\r
- OldHandOffHob,\r
- (UINTN)EfiFreeMemorySize\r
- );\r
-\r
- NewHandOffHob->EfiMemoryTop = MemoryBegin + MemoryLength;\r
- NewHandOffHob->EfiFreeMemoryTop = NewHandOffHob->EfiMemoryTop;\r
- NewHandOffHob->EfiMemoryBottom = MemoryBegin;\r
- \r
- NewHandOffHob->EfiFreeMemoryBottom = (UINTN)NewHandOffHob + EfiFreeMemorySize; \r
- \r
- NewHandOffHob->EfiEndOfHobList = (UINTN)NewHandOffHob +\r
- (OldHandOffHob->EfiEndOfHobList -\r
- PhysicalAddressOfOldHob);\r
-\r
- ConvertPpiPointers (PeiServices, OldHandOffHob, NewHandOffHob);\r
-\r
- BuildStackHob (PrivateData->StackBase, PrivateData->StackSize);\r
\r
+ PrivateData->PhysicalMemoryBegin = MemoryBegin;\r
+ PrivateData->PhysicalMemoryLength = MemoryLength;\r
+ PrivateData->FreePhysicalMemoryTop = MemoryBegin + MemoryLength;\r
+ \r
+ PrivateData->SwitchStackSignal = TRUE;\r
\r
return EFI_SUCCESS; \r
}\r
\r
+/**\r
+ The purpose of the service is to publish an interface that allows \r
+ PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
+\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param MemoryType The type of memory to allocate.\r
+ @param Pages The number of contiguous 4 KB pages to allocate.\r
+ @param Memory Pointer to a physical address. On output, the address is set to the base \r
+ of the page range that was allocated.\r
+\r
+ @retval EFI_SUCCESS The memory range was successfully allocated.\r
+ @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
+ @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
+ EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
+ EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePages (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_MEMORY_TYPE MemoryType,\r
- IN UINTN Pages,\r
- OUT EFI_PHYSICAL_ADDRESS *Memory\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_MEMORY_TYPE MemoryType,\r
+ IN UINTN Pages,\r
+ OUT EFI_PHYSICAL_ADDRESS *Memory\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Memory allocation service on permanent memory, \r
- not usable prior to the memory installation.\r
-\r
-Arguments:\r
+{\r
+ PEI_CORE_INSTANCE *PrivateData;\r
+ EFI_PEI_HOB_POINTERS Hob;\r
+ EFI_PHYSICAL_ADDRESS *FreeMemoryTop;\r
+ EFI_PHYSICAL_ADDRESS *FreeMemoryBottom;\r
+ UINTN RemainingPages;\r
+ UINTN Granularity;\r
+ UINTN Padding;\r
+\r
+ if ((MemoryType != EfiLoaderCode) &&\r
+ (MemoryType != EfiLoaderData) &&\r
+ (MemoryType != EfiRuntimeServicesCode) &&\r
+ (MemoryType != EfiRuntimeServicesData) &&\r
+ (MemoryType != EfiBootServicesCode) &&\r
+ (MemoryType != EfiBootServicesData) &&\r
+ (MemoryType != EfiACPIReclaimMemory) &&\r
+ (MemoryType != EfiReservedMemoryType) &&\r
+ (MemoryType != EfiACPIMemoryNVS)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
\r
- PeiServices - The PEI core services table.\r
- MemoryType - Type of memory to allocate.\r
- Pages - Number of pages to allocate.\r
- Memory - Pointer of memory allocated.\r
+ Granularity = DEFAULT_PAGE_ALLOCATION_GRANULARITY;\r
\r
-Returns:\r
+ if (RUNTIME_PAGE_ALLOCATION_GRANULARITY > DEFAULT_PAGE_ALLOCATION_GRANULARITY &&\r
+ (MemoryType == EfiACPIReclaimMemory ||\r
+ MemoryType == EfiACPIMemoryNVS ||\r
+ MemoryType == EfiRuntimeServicesCode ||\r
+ MemoryType == EfiRuntimeServicesData)) {\r
\r
- Status - EFI_SUCCESS The allocation was successful\r
- EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported.\r
- EFI_NOT_AVAILABLE_YET Called with permanent memory not available\r
- EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement\r
- to allocate the number of pages.\r
+ Granularity = RUNTIME_PAGE_ALLOCATION_GRANULARITY;\r
\r
---*/\r
-{\r
- PEI_CORE_INSTANCE *PrivateData;\r
- EFI_PEI_HOB_POINTERS Hob;\r
- EFI_PHYSICAL_ADDRESS Offset;\r
+ DEBUG ((DEBUG_INFO, "AllocatePages: aligning allocation to %d KB\n",\r
+ Granularity / SIZE_1KB));\r
+ }\r
\r
PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
-\r
+ Hob.Raw = PrivateData->HobList.Raw;\r
+ \r
//\r
// Check if Hob already available\r
//\r
if (!PrivateData->PeiMemoryInstalled) {\r
- return EFI_NOT_AVAILABLE_YET;\r
+ //\r
+ // When PeiInstallMemory is called but temporary memory has *not* been moved to temporary memory,\r
+ // the AllocatePage will depend on the field of PEI_CORE_INSTANCE structure.\r
+ //\r
+ if (!PrivateData->SwitchStackSignal) {\r
+ return EFI_NOT_AVAILABLE_YET;\r
+ } else {\r
+ FreeMemoryTop = &(PrivateData->FreePhysicalMemoryTop);\r
+ FreeMemoryBottom = &(PrivateData->PhysicalMemoryBegin);\r
+ }\r
+ } else {\r
+ FreeMemoryTop = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);\r
+ FreeMemoryBottom = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);\r
}\r
\r
- Hob.Raw = PrivateData->HobList.Raw;\r
-\r
//\r
- // Check to see if on 4k boundary\r
+ // Check to see if on correct boundary for the memory type.\r
+ // If not aligned, make the allocation aligned.\r
//\r
- Offset = Hob.HandoffInformationTable->EfiFreeMemoryTop & 0xFFF;\r
+ Padding = *(FreeMemoryTop) & (Granularity - 1);\r
+ if ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom) < Padding) {\r
+ DEBUG ((DEBUG_ERROR, "AllocatePages failed: Out of space after padding.\n"));\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ *(FreeMemoryTop) -= Padding;\r
+ if (Padding >= EFI_PAGE_SIZE) {\r
+ //\r
+ // Create a memory allocation HOB to cover\r
+ // the pages that we will lose to rounding\r
+ //\r
+ BuildMemoryAllocationHob (\r
+ *(FreeMemoryTop),\r
+ Padding & ~(UINTN)EFI_PAGE_MASK,\r
+ EfiConventionalMemory\r
+ );\r
+ }\r
\r
//\r
- // If not aligned, make the allocation aligned.\r
+ // Verify that there is sufficient memory to satisfy the allocation.\r
+ // For page allocation, the overhead sizeof (EFI_HOB_MEMORY_ALLOCATION) needs to be considered.\r
//\r
- if (Offset != 0) {\r
- Hob.HandoffInformationTable->EfiFreeMemoryTop -= Offset;\r
+ if ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom) < (UINTN) ALIGN_VALUE (sizeof (EFI_HOB_MEMORY_ALLOCATION), 8)) {\r
+ DEBUG ((EFI_D_ERROR, "AllocatePages failed: No space to build memory allocation hob.\n"));\r
+ return EFI_OUT_OF_RESOURCES;\r
}\r
-\r
+ RemainingPages = (UINTN)(*FreeMemoryTop - *FreeMemoryBottom - ALIGN_VALUE (sizeof (EFI_HOB_MEMORY_ALLOCATION), 8)) >> EFI_PAGE_SHIFT;\r
//\r
- // Verify that there is sufficient memory to satisfy the allocation\r
+ // The number of remaining pages needs to be greater than or equal to that of the request pages.\r
//\r
- if (Hob.HandoffInformationTable->EfiFreeMemoryTop - ((Pages * EFI_PAGE_SIZE) + sizeof (EFI_HOB_MEMORY_ALLOCATION)) < \r
- Hob.HandoffInformationTable->EfiFreeMemoryBottom) {\r
- DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%x Pages is available.\n", Pages));\r
- DEBUG ((EFI_D_ERROR, "There is only left 0x%x pages memory resource to be allocated.\n", \\r
- EFI_SIZE_TO_PAGES ((UINTN) (Hob.HandoffInformationTable->EfiFreeMemoryTop - Hob.HandoffInformationTable->EfiFreeMemoryBottom))));\r
+ Pages = ALIGN_VALUE (Pages, EFI_SIZE_TO_PAGES (Granularity));\r
+ if (RemainingPages < Pages) {\r
+ DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%lx Pages is available.\n", (UINT64) Pages));\r
+ DEBUG ((EFI_D_ERROR, "There is only left 0x%lx pages memory resource to be allocated.\n", (UINT64) RemainingPages));\r
return EFI_OUT_OF_RESOURCES;\r
} else {\r
//\r
// Update the PHIT to reflect the memory usage\r
//\r
- Hob.HandoffInformationTable->EfiFreeMemoryTop -= Pages * EFI_PAGE_SIZE;\r
+ *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;\r
\r
//\r
// Update the value for the caller\r
//\r
- *Memory = Hob.HandoffInformationTable->EfiFreeMemoryTop;\r
+ *Memory = *(FreeMemoryTop);\r
\r
//\r
// Create a memory allocation HOB.\r
//\r
BuildMemoryAllocationHob (\r
- Hob.HandoffInformationTable->EfiFreeMemoryTop,\r
- Pages * EFI_PAGE_SIZE + Offset,\r
+ *(FreeMemoryTop),\r
+ Pages * EFI_PAGE_SIZE,\r
MemoryType\r
);\r
\r
}\r
}\r
\r
+/**\r
+\r
+ Pool allocation service. Before permanent memory is discoveried, the pool will\r
+ be allocated the heap in the temporary memory. Genenrally, the size of heap in temporary \r
+ memory does not exceed to 64K, so the biggest pool size could be allocated is \r
+ 64K.\r
\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Size Amount of memory required\r
+ @param Buffer Address of pointer to the buffer\r
+\r
+ @retval EFI_SUCCESS The allocation was successful\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement\r
+ to allocate the requested size.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePool (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN UINTN Size,\r
- OUT VOID **Buffer\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN UINTN Size,\r
+ OUT VOID **Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Memory allocation service on the CAR. \r
-\r
-Arguments:\r
-\r
- PeiServices - The PEI core services table.\r
-\r
- Size - Amount of memory required\r
-\r
- Buffer - Address of pointer to the buffer\r
-\r
-Returns:\r
-\r
- Status - EFI_SUCCESS The allocation was successful\r
- EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement\r
- to allocate the requested size.\r
- \r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_HOB_MEMORY_POOL *Hob;\r
\r
- //\r
- // If some "post-memory" PEIM wishes to allocate larger pool,\r
- // it should use AllocatePages service instead.\r
- //\r
- ASSERT (Size < 0x10000 - sizeof (EFI_HOB_MEMORY_POOL));\r
- Status = PeiServicesCreateHob (\r
+ //\r
+ // If some "post-memory" PEIM wishes to allocate larger pool,\r
+ // it should use AllocatePages service instead.\r
+ //\r
+ \r
+ //\r
+ // Generally, the size of heap in temporary memory does not exceed to 64K,\r
+ // HobLength is multiples of 8 bytes, so the maxmium size of pool is 0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL)\r
+ //\r
+ if (Size > (0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL))) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ \r
+ Status = PeiServicesCreateHob (\r
EFI_HOB_TYPE_MEMORY_POOL,\r
(UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),\r
(VOID **)&Hob\r
);\r
+ ASSERT_EFI_ERROR (Status);\r
*Buffer = Hob+1; \r
\r
-\r
return Status;\r
}\r
projects / mirror_edk2.git / blobdiff