Correct description for return status code of PEI service AllocatePages(), according...
[mirror_edk2.git] / MdeModulePkg / Core / Pei / Memory / MemoryServices.c
CommitLineData
615c6dd0 1/** @file\r
b1f6a7c6 2 EFI PEI Core memory services\r
3 \r
2e76dc7e 4Copyright (c) 2006 - 2010, Intel Corporation \r
192f6d4c 5All rights reserved. This program and the accompanying materials \r
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
99 ASSERT (PrivateData->PeiMemoryInstalled);\r
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
113\r
114 Memory allocation service on permanent memory,\r
115 not usable prior to the memory installation.\r
116\r
117\r
d73d93c3 118 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
119 @param MemoryType Type of memory to allocate.\r
120 @param Pages Number of pages to allocate.\r
121 @param Memory Pointer of memory allocated.\r
b1f6a7c6 122\r
123 @retval EFI_SUCCESS The allocation was successful\r
b1f6a7c6 124 @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available\r
125 @retval EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement\r
126 to allocate the number of pages.\r
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
144 PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r
58dcdada 145 Hob.Raw = PrivateData->HobList.Raw;\r
146 \r
192f6d4c 147 //\r
148 // Check if Hob already available\r
149 //\r
150 if (!PrivateData->PeiMemoryInstalled) {\r
58dcdada 151 //\r
3d4d0c34 152 // When PeiInstallMemory is called but temporary memory has *not* been moved to temporary memory,\r
5f300691 153 // the AllocatePage will depend on the field of PEI_CORE_INSTANCE structure.\r
58dcdada 154 //\r
155 if (!PrivateData->SwitchStackSignal) {\r
156 return EFI_NOT_AVAILABLE_YET;\r
157 } else {\r
158 FreeMemoryTop = &(PrivateData->FreePhysicalMemoryTop);\r
159 FreeMemoryBottom = &(PrivateData->PhysicalMemoryBegin);\r
160 }\r
161 } else {\r
162 FreeMemoryTop = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);\r
163 FreeMemoryBottom = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);\r
192f6d4c 164 }\r
165\r
192f6d4c 166 //\r
82b8c8df 167 // Check to see if on 4k boundary, If not aligned, make the allocation aligned.\r
192f6d4c 168 //\r
82b8c8df 169 *(FreeMemoryTop) -= *(FreeMemoryTop) & 0xFFF;\r
58dcdada 170 \r
192f6d4c 171 //\r
172 // Verify that there is sufficient memory to satisfy the allocation\r
173 //\r
62031991 174 RemainingPages = EFI_SIZE_TO_PAGES ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom));\r
98a601b1 175 //\r
176 // For page allocation, the overhead sizeof (EFI_HOB_MEMORY_ALLOCATION) needs one extra page.\r
177 // So the number of remaining pages needs to be greater than that of the request pages.\r
178 //\r
179 if (RemainingPages <= Pages) {\r
62031991 180 DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%lx Pages is available.\n", (UINT64) Pages));\r
181 DEBUG ((EFI_D_ERROR, "There is only left 0x%lx pages memory resource to be allocated.\n", (UINT64) RemainingPages));\r
192f6d4c 182 return EFI_OUT_OF_RESOURCES;\r
183 } else {\r
184 //\r
185 // Update the PHIT to reflect the memory usage\r
186 //\r
58dcdada 187 *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;\r
192f6d4c 188\r
189 //\r
190 // Update the value for the caller\r
191 //\r
58dcdada 192 *Memory = *(FreeMemoryTop);\r
192f6d4c 193\r
194 //\r
195 // Create a memory allocation HOB.\r
196 //\r
197 BuildMemoryAllocationHob (\r
58dcdada 198 *(FreeMemoryTop),\r
0a7d0741 199 Pages * EFI_PAGE_SIZE,\r
192f6d4c 200 MemoryType\r
201 );\r
202\r
203 return EFI_SUCCESS;\r
204 }\r
205}\r
206\r
b1f6a7c6 207/**\r
208\r
82b8c8df 209 Pool allocation service. Before permenent memory is discoveried, the pool will \r
3d4d0c34 210 be allocated the heap in the temporary memory. Genenrally, the size of heap in temporary \r
82b8c8df 211 memory does not exceed to 64K, so the biggest pool size could be allocated is \r
212 64K.\r
b1f6a7c6 213\r
82b8c8df 214 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
215 @param Size Amount of memory required\r
216 @param Buffer Address of pointer to the buffer\r
b1f6a7c6 217\r
218 @retval EFI_SUCCESS The allocation was successful\r
219 @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement\r
220 to allocate the requested size.\r
221\r
222**/\r
192f6d4c 223EFI_STATUS\r
224EFIAPI\r
225PeiAllocatePool (\r
82b8c8df 226 IN CONST EFI_PEI_SERVICES **PeiServices,\r
227 IN UINTN Size,\r
228 OUT VOID **Buffer\r
192f6d4c 229 )\r
192f6d4c 230{\r
231 EFI_STATUS Status;\r
232 EFI_HOB_MEMORY_POOL *Hob;\r
233\r
82b8c8df 234 //\r
235 // If some "post-memory" PEIM wishes to allocate larger pool,\r
236 // it should use AllocatePages service instead.\r
237 //\r
238 \r
239 //\r
240 // Generally, the size of heap in temporary memory does not exceed to 64K,\r
241 // so the maxmium size of pool is 0x10000 - sizeof (EFI_HOB_MEMORY_POOL)\r
242 //\r
2e76dc7e 243 if (Size >= (0x10000 - sizeof (EFI_HOB_MEMORY_POOL))) {\r
244 return EFI_OUT_OF_RESOURCES;\r
245 }\r
246 \r
82b8c8df 247 Status = PeiServicesCreateHob (\r
192f6d4c 248 EFI_HOB_TYPE_MEMORY_POOL,\r
249 (UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),\r
250 (VOID **)&Hob\r
251 );\r
252 *Buffer = Hob+1; \r
253\r
192f6d4c 254 return Status;\r
255}\r