MdeModulePkg/PiSmmCore: switch to MdePkg allocation granularity macros
[mirror_edk2.git] / MdeModulePkg / Core / Pei / Memory / MemoryServices.c
CommitLineData
615c6dd0 1/** @file\r
b1f6a7c6 2 EFI PEI Core memory services\r
3 \r
ab6fb25a 4Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
cd5ebaa0 5This program and the accompanying materials \r
192f6d4c 6are licensed and made available under the terms and conditions of the BSD License \r
7which accompanies this distribution. The full text of the license may be found at \r
8http://opensource.org/licenses/bsd-license.php \r
9 \r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
615c6dd0 13**/\r
192f6d4c 14\r
0d516397 15#include "PeiMain.h"\r
192f6d4c 16\r
b1f6a7c6 17/**\r
192f6d4c 18\r
19 Initialize the memory services.\r
20\r
82b8c8df 21 @param PrivateData Points to PeiCore's private instance data.\r
b1f6a7c6 22 @param SecCoreData Points to a data structure containing information about the PEI core's operating\r
5aae0aa7 23 environment, such as the size and location of temporary RAM, the stack location and\r
24 the BFV location.\r
b1f6a7c6 25 @param OldCoreData Pointer to the PEI Core data.\r
192f6d4c 26 NULL if being run in non-permament memory mode.\r
27\r
b1f6a7c6 28**/\r
29VOID\r
30InitializeMemoryServices (\r
31 IN PEI_CORE_INSTANCE *PrivateData,\r
32 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
33 IN PEI_CORE_INSTANCE *OldCoreData\r
34 )\r
192f6d4c 35{\r
58dcdada 36 \r
63b62331 37 PrivateData->SwitchStackSignal = FALSE;\r
192f6d4c 38\r
40f26b8f 39 //\r
40 // First entering PeiCore, following code will initialized some field\r
41 // in PeiCore's private data according to hand off data from sec core.\r
42 //\r
192f6d4c 43 if (OldCoreData == NULL) {\r
44\r
45 PrivateData->PeiMemoryInstalled = FALSE;\r
63b62331 46 PrivateData->HobList.Raw = SecCoreData->PeiTemporaryRamBase;\r
192f6d4c 47 \r
48 PeiCoreBuildHobHandoffInfoTable (\r
49 BOOT_WITH_FULL_CONFIGURATION,\r
63b62331 50 (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->PeiTemporaryRamBase,\r
5aae0aa7 51 (UINTN) SecCoreData->PeiTemporaryRamSize\r
192f6d4c 52 );\r
192f6d4c 53\r
54 //\r
4140a663 55 // Set Ps to point to ServiceTableShadow in Cache\r
192f6d4c 56 //\r
4140a663 57 PrivateData->Ps = &(PrivateData->ServiceTableShadow);\r
b0d803fe 58 }\r
59 \r
192f6d4c 60 return;\r
61}\r
62\r
b1f6a7c6 63/**\r
64\r
82b8c8df 65 This function registers the found memory configuration with the PEI Foundation.\r
b1f6a7c6 66\r
82b8c8df 67 The usage model is that the PEIM that discovers the permanent memory shall invoke this service.\r
68 This routine will hold discoveried memory information into PeiCore's private data,\r
69 and set SwitchStackSignal flag. After PEIM who discovery memory is dispatched,\r
70 PeiDispatcher will migrate temporary memory to permenement memory.\r
71 \r
d73d93c3 72 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
73 @param MemoryBegin Start of memory address.\r
74 @param MemoryLength Length of memory.\r
b1f6a7c6 75\r
76 @return EFI_SUCCESS Always success.\r
77\r
78**/\r
192f6d4c 79EFI_STATUS\r
80EFIAPI\r
81PeiInstallPeiMemory (\r
58dcdada 82 IN CONST EFI_PEI_SERVICES **PeiServices,\r
83 IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
84 IN UINT64 MemoryLength\r
192f6d4c 85 )\r
192f6d4c 86{\r
87 PEI_CORE_INSTANCE *PrivateData;\r
58dcdada 88\r
a3a15d21 89 DEBUG ((EFI_D_INFO, "PeiInstallPeiMemory MemoryBegin 0x%LX, MemoryLength 0x%LX\n", MemoryBegin, MemoryLength));\r
192f6d4c 90 PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
91\r
3152f167 92 //\r
93 // PEI_SERVICE.InstallPeiMemory should only be called one time during whole PEI phase.\r
94 // If it is invoked more than one time, ASSERT information is given for developer debugging in debug tip and\r
95 // simply return EFI_SUCESS in release tip to ignore it.\r
96 // \r
97 if (PrivateData->PeiMemoryInstalled) {\r
98 DEBUG ((EFI_D_ERROR, "ERROR: PeiInstallPeiMemory is called more than once!\n"));\r
305d3c8e 99 ASSERT (FALSE);\r
3152f167 100 return EFI_SUCCESS;\r
101 }\r
102 \r
58dcdada 103 PrivateData->PhysicalMemoryBegin = MemoryBegin;\r
104 PrivateData->PhysicalMemoryLength = MemoryLength;\r
105 PrivateData->FreePhysicalMemoryTop = MemoryBegin + MemoryLength;\r
106 \r
107 PrivateData->SwitchStackSignal = TRUE;\r
192f6d4c 108\r
109 return EFI_SUCCESS; \r
110}\r
111\r
b1f6a7c6 112/**\r
64ca6802 113 The purpose of the service is to publish an interface that allows \r
114 PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
b1f6a7c6 115\r
64ca6802 116 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
117 @param MemoryType The type of memory to allocate.\r
118 @param Pages The number of contiguous 4 KB pages to allocate.\r
119 @param Memory Pointer to a physical address. On output, the address is set to the base \r
120 of the page range that was allocated.\r
b1f6a7c6 121\r
64ca6802 122 @retval EFI_SUCCESS The memory range was successfully allocated.\r
123 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
124 @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
125 EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
ab6fb25a 126 EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
b1f6a7c6 127\r
128**/\r
192f6d4c 129EFI_STATUS\r
130EFIAPI\r
131PeiAllocatePages (\r
82b8c8df 132 IN CONST EFI_PEI_SERVICES **PeiServices,\r
133 IN EFI_MEMORY_TYPE MemoryType,\r
134 IN UINTN Pages,\r
135 OUT EFI_PHYSICAL_ADDRESS *Memory\r
192f6d4c 136 )\r
192f6d4c 137{\r
138 PEI_CORE_INSTANCE *PrivateData;\r
139 EFI_PEI_HOB_POINTERS Hob;\r
58dcdada 140 EFI_PHYSICAL_ADDRESS *FreeMemoryTop;\r
141 EFI_PHYSICAL_ADDRESS *FreeMemoryBottom;\r
62031991 142 UINTN RemainingPages;\r
192f6d4c 143\r
64ca6802 144 if ((MemoryType != EfiLoaderCode) &&\r
145 (MemoryType != EfiLoaderData) &&\r
146 (MemoryType != EfiRuntimeServicesCode) &&\r
147 (MemoryType != EfiRuntimeServicesData) &&\r
148 (MemoryType != EfiBootServicesCode) &&\r
149 (MemoryType != EfiBootServicesData) &&\r
150 (MemoryType != EfiACPIReclaimMemory) &&\r
ab6fb25a 151 (MemoryType != EfiReservedMemoryType) &&\r
64ca6802 152 (MemoryType != EfiACPIMemoryNVS)) {\r
153 return EFI_INVALID_PARAMETER;\r
154 }\r
155\r
192f6d4c 156 PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
58dcdada 157 Hob.Raw = PrivateData->HobList.Raw;\r
158 \r
192f6d4c 159 //\r
160 // Check if Hob already available\r
161 //\r
162 if (!PrivateData->PeiMemoryInstalled) {\r
58dcdada 163 //\r
3d4d0c34 164 // When PeiInstallMemory is called but temporary memory has *not* been moved to temporary memory,\r
5f300691 165 // the AllocatePage will depend on the field of PEI_CORE_INSTANCE structure.\r
58dcdada 166 //\r
167 if (!PrivateData->SwitchStackSignal) {\r
168 return EFI_NOT_AVAILABLE_YET;\r
169 } else {\r
170 FreeMemoryTop = &(PrivateData->FreePhysicalMemoryTop);\r
171 FreeMemoryBottom = &(PrivateData->PhysicalMemoryBegin);\r
172 }\r
173 } else {\r
174 FreeMemoryTop = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);\r
175 FreeMemoryBottom = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);\r
192f6d4c 176 }\r
177\r
192f6d4c 178 //\r
82b8c8df 179 // Check to see if on 4k boundary, If not aligned, make the allocation aligned.\r
192f6d4c 180 //\r
82b8c8df 181 *(FreeMemoryTop) -= *(FreeMemoryTop) & 0xFFF;\r
5e574a01 182\r
192f6d4c 183 //\r
5e574a01
SZ
184 // Verify that there is sufficient memory to satisfy the allocation.\r
185 // For page allocation, the overhead sizeof (EFI_HOB_MEMORY_ALLOCATION) needs to be considered.\r
192f6d4c 186 //\r
5e574a01
SZ
187 if ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom) < (UINTN) ALIGN_VALUE (sizeof (EFI_HOB_MEMORY_ALLOCATION), 8)) {\r
188 DEBUG ((EFI_D_ERROR, "AllocatePages failed: No space to build memory allocation hob.\n"));\r
189 return EFI_OUT_OF_RESOURCES;\r
190 }\r
191 RemainingPages = (UINTN)(*FreeMemoryTop - *FreeMemoryBottom - ALIGN_VALUE (sizeof (EFI_HOB_MEMORY_ALLOCATION), 8)) >> EFI_PAGE_SHIFT;\r
98a601b1 192 //\r
5e574a01 193 // The number of remaining pages needs to be greater than or equal to that of the request pages.\r
98a601b1 194 //\r
5e574a01 195 if (RemainingPages < Pages) {\r
62031991 196 DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%lx Pages is available.\n", (UINT64) Pages));\r
197 DEBUG ((EFI_D_ERROR, "There is only left 0x%lx pages memory resource to be allocated.\n", (UINT64) RemainingPages));\r
192f6d4c 198 return EFI_OUT_OF_RESOURCES;\r
199 } else {\r
200 //\r
201 // Update the PHIT to reflect the memory usage\r
202 //\r
58dcdada 203 *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;\r
192f6d4c 204\r
205 //\r
206 // Update the value for the caller\r
207 //\r
58dcdada 208 *Memory = *(FreeMemoryTop);\r
192f6d4c 209\r
210 //\r
211 // Create a memory allocation HOB.\r
212 //\r
213 BuildMemoryAllocationHob (\r
58dcdada 214 *(FreeMemoryTop),\r
0a7d0741 215 Pages * EFI_PAGE_SIZE,\r
192f6d4c 216 MemoryType\r
217 );\r
218\r
219 return EFI_SUCCESS;\r
220 }\r
221}\r
222\r
b1f6a7c6 223/**\r
224\r
6393d9c8 225 Pool allocation service. Before permanent memory is discoveried, the pool will\r
3d4d0c34 226 be allocated the heap in the temporary memory. Genenrally, the size of heap in temporary \r
82b8c8df 227 memory does not exceed to 64K, so the biggest pool size could be allocated is \r
228 64K.\r
b1f6a7c6 229\r
82b8c8df 230 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
231 @param Size Amount of memory required\r
232 @param Buffer Address of pointer to the buffer\r
b1f6a7c6 233\r
234 @retval EFI_SUCCESS The allocation was successful\r
235 @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement\r
236 to allocate the requested size.\r
237\r
238**/\r
192f6d4c 239EFI_STATUS\r
240EFIAPI\r
241PeiAllocatePool (\r
82b8c8df 242 IN CONST EFI_PEI_SERVICES **PeiServices,\r
243 IN UINTN Size,\r
244 OUT VOID **Buffer\r
192f6d4c 245 )\r
192f6d4c 246{\r
247 EFI_STATUS Status;\r
248 EFI_HOB_MEMORY_POOL *Hob;\r
249\r
82b8c8df 250 //\r
251 // If some "post-memory" PEIM wishes to allocate larger pool,\r
252 // it should use AllocatePages service instead.\r
253 //\r
254 \r
255 //\r
256 // Generally, the size of heap in temporary memory does not exceed to 64K,\r
e94728b3 257 // HobLength is multiples of 8 bytes, so the maxmium size of pool is 0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL)\r
82b8c8df 258 //\r
e94728b3 259 if (Size > (0xFFF8 - sizeof (EFI_HOB_MEMORY_POOL))) {\r
2e76dc7e 260 return EFI_OUT_OF_RESOURCES;\r
261 }\r
262 \r
82b8c8df 263 Status = PeiServicesCreateHob (\r
192f6d4c 264 EFI_HOB_TYPE_MEMORY_POOL,\r
265 (UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),\r
266 (VOID **)&Hob\r
267 );\r
772cba09 268 ASSERT_EFI_ERROR (Status);\r
192f6d4c 269 *Buffer = Hob+1; \r
270\r
192f6d4c 271 return Status;\r
272}\r