2 Sample to provide FSP hob process related function.
4 Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/PeiServicesLib.h>
18 #include <Library/PeiServicesTablePointerLib.h>
19 #include <Library/BaseLib.h>
20 #include <Library/DebugLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/HobLib.h>
23 #include <Library/PcdLib.h>
24 #include <Library/FspPlatformInfoLib.h>
26 #include <Guid/GuidHobFspEas.h>
27 #include <Guid/MemoryTypeInformation.h>
28 #include <Guid/PcdDataBaseHobGuid.h>
29 #include <Ppi/Capsule.h>
32 // Additional pages are used by DXE memory manager.
33 // It should be consistent between RetrieveRequiredMemorySize() and GetPeiMemSize()
35 #define PEI_ADDITIONAL_MEMORY_SIZE (16 * EFI_PAGE_SIZE)
38 Get the mem size in memory type infromation table.
40 @param[in] PeiServices PEI Services table.
42 @return the mem size in memory type infromation table.
45 GetMemorySizeInMemoryTypeInformation (
46 IN EFI_PEI_SERVICES
**PeiServices
49 EFI_PEI_HOB_POINTERS Hob
;
50 EFI_MEMORY_TYPE_INFORMATION
*MemoryData
;
55 (*PeiServices
)->GetHobList ((CONST EFI_PEI_SERVICES
**)PeiServices
, (VOID
**) &Hob
.Raw
);
56 while (!END_OF_HOB_LIST (Hob
)) {
57 if (Hob
.Header
->HobType
== EFI_HOB_TYPE_GUID_EXTENSION
&&
58 CompareGuid (&Hob
.Guid
->Name
, &gEfiMemoryTypeInformationGuid
)) {
59 MemoryData
= (EFI_MEMORY_TYPE_INFORMATION
*) (Hob
.Raw
+ sizeof (EFI_HOB_GENERIC_HEADER
) + sizeof (EFI_GUID
));
63 Hob
.Raw
= GET_NEXT_HOB (Hob
);
66 if (MemoryData
== NULL
) {
71 for (Index
= 0; MemoryData
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
73 // Accumulate default memory size requirements
75 TempPageNum
+= MemoryData
[Index
].NumberOfPages
;
78 return TempPageNum
* EFI_PAGE_SIZE
;
82 Get the mem size need to be reserved in PEI phase.
84 @param[in] PeiServices PEI Services table.
86 @return the mem size need to be reserved in PEI phase.
89 RetrieveRequiredMemorySize (
90 IN EFI_PEI_SERVICES
**PeiServices
95 Size
= GetMemorySizeInMemoryTypeInformation (PeiServices
);
96 return Size
+ PEI_ADDITIONAL_MEMORY_SIZE
;
100 Get the mem size need to be consumed and reserved in PEI phase.
102 @param[in] PeiServices PEI Services table.
103 @param[in] BootMode Current boot mode.
105 @return the mem size need to be consumed and reserved in PEI phase.
109 IN EFI_PEI_SERVICES
**PeiServices
,
116 if (BootMode
== BOOT_IN_RECOVERY_MODE
) {
117 return PcdGet32 (PcdPeiRecoveryMinMemSize
);
120 Size
= GetMemorySizeInMemoryTypeInformation (PeiServices
);
122 if (BootMode
== BOOT_ON_FLASH_UPDATE
) {
124 // Maybe more size when in CapsuleUpdate phase ?
126 MinSize
= PcdGet32 (PcdPeiMinMemSize
);
128 MinSize
= PcdGet32 (PcdPeiMinMemSize
);
131 return MinSize
+ Size
+ PEI_ADDITIONAL_MEMORY_SIZE
;
135 BIOS process FspBobList for Memory Resource Descriptor.
137 @param[in] FspHobList Pointer to the HOB data structure produced by FSP.
139 @return If platform process the FSP hob list successfully.
143 FspHobProcessForMemoryResource (
147 EFI_PEI_HOB_POINTERS Hob
;
148 UINT64 LowMemorySize
;
149 UINT64 FspMemorySize
;
150 EFI_PHYSICAL_ADDRESS FspMemoryBase
;
152 EFI_PHYSICAL_ADDRESS PeiMemBase
;
154 EFI_PHYSICAL_ADDRESS S3PeiMemBase
;
155 BOOLEAN FoundFspMemHob
;
157 EFI_BOOT_MODE BootMode
;
158 EFI_PEI_CAPSULE_PPI
*Capsule
;
160 UINTN CapsuleBufferLength
;
161 UINT64 RequiredMemSize
;
162 EFI_PEI_SERVICES
**PeiServices
;
164 PeiServices
= (EFI_PEI_SERVICES
**)GetPeiServicesTablePointer ();
166 PeiServicesGetBootMode (&BootMode
);
172 FoundFspMemHob
= FALSE
;
175 // Parse the hob list from fsp
176 // Report all the resource hob except the memory between 1M and 4G
178 Hob
.Raw
= (UINT8
*)(UINTN
)FspHobList
;
179 DEBUG((DEBUG_INFO
, "FspHobList - 0x%x\n", FspHobList
));
181 while ((Hob
.Raw
= GetNextHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR
, Hob
.Raw
)) != NULL
) {
182 DEBUG((DEBUG_INFO
, "\nResourceType: 0x%x\n", Hob
.ResourceDescriptor
->ResourceType
));
183 if ((Hob
.ResourceDescriptor
->ResourceType
== EFI_RESOURCE_SYSTEM_MEMORY
) ||
184 (Hob
.ResourceDescriptor
->ResourceType
== EFI_RESOURCE_MEMORY_RESERVED
)) {
185 DEBUG((DEBUG_INFO
, "ResourceAttribute: 0x%x\n", Hob
.ResourceDescriptor
->ResourceAttribute
));
186 DEBUG((DEBUG_INFO
, "PhysicalStart: 0x%x\n", Hob
.ResourceDescriptor
->PhysicalStart
));
187 DEBUG((DEBUG_INFO
, "ResourceLength: 0x%x\n", Hob
.ResourceDescriptor
->ResourceLength
));
188 DEBUG((DEBUG_INFO
, "Owner: %g\n\n", &Hob
.ResourceDescriptor
->Owner
));
191 if ((Hob
.ResourceDescriptor
->ResourceType
== EFI_RESOURCE_SYSTEM_MEMORY
) // Found the low memory length below 4G
192 && (Hob
.ResourceDescriptor
->PhysicalStart
>= BASE_1MB
)
193 && (Hob
.ResourceDescriptor
->PhysicalStart
+ Hob
.ResourceDescriptor
->ResourceLength
<= BASE_4GB
)) {
194 LowMemorySize
+= Hob
.ResourceDescriptor
->ResourceLength
;
195 Hob
.Raw
= GET_NEXT_HOB (Hob
);
199 if ((Hob
.ResourceDescriptor
->ResourceType
== EFI_RESOURCE_MEMORY_RESERVED
) // Found the low memory length below 4G
200 && (Hob
.ResourceDescriptor
->PhysicalStart
>= BASE_1MB
)
201 && (Hob
.ResourceDescriptor
->PhysicalStart
+ Hob
.ResourceDescriptor
->ResourceLength
<= BASE_4GB
)
202 && (CompareGuid (&Hob
.ResourceDescriptor
->Owner
, &gFspReservedMemoryResourceHobGuid
))) {
203 FoundFspMemHob
= TRUE
;
204 FspMemoryBase
= Hob
.ResourceDescriptor
->PhysicalStart
;
205 FspMemorySize
= Hob
.ResourceDescriptor
->ResourceLength
;
206 DEBUG((DEBUG_INFO
, "Find fsp mem hob, base 0x%x, len 0x%x\n", FspMemoryBase
, FspMemorySize
));
210 // Report the resource hob
212 BuildResourceDescriptorHob (
213 Hob
.ResourceDescriptor
->ResourceType
,
214 Hob
.ResourceDescriptor
->ResourceAttribute
,
215 Hob
.ResourceDescriptor
->PhysicalStart
,
216 Hob
.ResourceDescriptor
->ResourceLength
219 Hob
.Raw
= GET_NEXT_HOB (Hob
);
222 if (!FoundFspMemHob
) {
223 DEBUG((DEBUG_INFO
, "Didn't find the fsp used memory information.\n"));
227 DEBUG((DEBUG_INFO
, "LowMemorySize: 0x%x.\n", LowMemorySize
));
228 DEBUG((DEBUG_INFO
, "FspMemoryBase: 0x%x.\n", FspMemoryBase
));
229 DEBUG((DEBUG_INFO
, "FspMemorySize: 0x%x.\n", FspMemorySize
));
231 if (BootMode
== BOOT_ON_S3_RESUME
) {
232 BuildResourceDescriptorHob (
233 EFI_RESOURCE_SYSTEM_MEMORY
,
235 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
236 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
|
237 // EFI_RESOURCE_ATTRIBUTE_TESTED |
238 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE
|
239 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE
|
240 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE
|
241 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE
249 Status
= GetS3MemoryInfo (&S3PeiMemSize
, &S3PeiMemBase
);
250 ASSERT_EFI_ERROR (Status
);
251 DEBUG((DEBUG_INFO
, "S3 memory %Xh - %Xh bytes\n", S3PeiMemBase
, S3PeiMemSize
));
254 // Make sure Stack and PeiMemory are not overlap
257 Status
= PeiServicesInstallPeiMemory (
261 ASSERT_EFI_ERROR (Status
);
263 PeiMemSize
= GetPeiMemSize (PeiServices
, BootMode
);
264 DEBUG((DEBUG_INFO
, "PEI memory size = %Xh bytes\n", PeiMemSize
));
270 CapsuleBuffer
= NULL
;
271 CapsuleBufferLength
= 0;
272 if (BootMode
== BOOT_ON_FLASH_UPDATE
) {
273 Status
= PeiServicesLocatePpi (
274 &gEfiPeiCapsulePpiGuid
,
279 ASSERT_EFI_ERROR (Status
);
281 if (Status
== EFI_SUCCESS
) {
283 // Make sure Stack and CapsuleBuffer are not overlap
285 CapsuleBuffer
= (VOID
*)(UINTN
)BASE_1MB
;
286 CapsuleBufferLength
= (UINTN
)(LowMemorySize
- PeiMemSize
);
288 // Call the Capsule PPI Coalesce function to coalesce the capsule data.
290 Status
= Capsule
->Coalesce (PeiServices
, &CapsuleBuffer
, &CapsuleBufferLength
);
294 RequiredMemSize
= RetrieveRequiredMemorySize (PeiServices
);
295 DEBUG((DEBUG_INFO
, "Required memory size = %Xh bytes\n", RequiredMemSize
));
298 // Report the main memory
300 BuildResourceDescriptorHob (
301 EFI_RESOURCE_SYSTEM_MEMORY
,
303 EFI_RESOURCE_ATTRIBUTE_PRESENT
|
304 EFI_RESOURCE_ATTRIBUTE_INITIALIZED
|
305 EFI_RESOURCE_ATTRIBUTE_TESTED
|
306 EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE
|
307 EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE
|
308 EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE
|
309 EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE
316 // Make sure Stack and CapsuleBuffer are not overlap
320 // Install efi memory
322 PeiMemBase
= BASE_1MB
+ LowMemorySize
- PeiMemSize
;
323 Status
= PeiServicesInstallPeiMemory (
325 PeiMemSize
- RequiredMemSize
327 ASSERT_EFI_ERROR (Status
);
329 if (Capsule
!= NULL
) {
330 Status
= Capsule
->CreateState (PeiServices
, CapsuleBuffer
, CapsuleBufferLength
);
340 @param[in] FspHobList Pointer to the HOB data structure produced by FSP.
348 EFI_PEI_HOB_POINTERS FspHob
;
350 FspHob
.Raw
= FspHobList
;
353 // Add all the HOBs from FSP binary to FSP wrapper
355 while (!END_OF_HOB_LIST (FspHob
)) {
356 if (FspHob
.Header
->HobType
== EFI_HOB_TYPE_GUID_EXTENSION
) {
358 // Skip FSP binary creates PcdDataBaseHobGuid
360 if (!CompareGuid(&FspHob
.Guid
->Name
, &gPcdDataBaseHobGuid
)) {
363 GET_GUID_HOB_DATA(FspHob
),
364 GET_GUID_HOB_DATA_SIZE(FspHob
)
368 FspHob
.Raw
= GET_NEXT_HOB (FspHob
);
373 BIOS process FspBobList for other data (not Memory Resource Descriptor).
375 @param[in] FspHobList Pointer to the HOB data structure produced by FSP.
377 @return If platform process the FSP hob list successfully.
381 FspHobProcessForOtherData (
385 ProcessFspHobList (FspHobList
);
391 BIOS process FspBobList.
393 @param[in] FspHobList Pointer to the HOB data structure produced by FSP.
395 @return If platform process the FSP hob list successfully.
405 Status
= FspHobProcessForMemoryResource (FspHobList
);
406 if (EFI_ERROR (Status
)) {
409 Status
= FspHobProcessForOtherData (FspHobList
);