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