2 Sample to provide FSP platform information related function.
4 Copyright (c) 2014, 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.
16 #include <Library/PcdLib.h>
19 Get current boot mode.
21 @note At this point, memory is ready, PeiServices are NOT available to use.
22 Platform can get some data from chipset register.
24 @return BootMode current boot mode.
32 return BOOT_WITH_FULL_CONFIGURATION
;
36 Get NVS buffer parameter.
38 @note At this point, memory is NOT ready, PeiServices are available to use.
40 @return NvsBuffer NVS buffer parameter.
54 @note At this point, memory is NOT ready, PeiServices are available to use.
56 @return UPD region size.
68 This function overrides the default configurations in the UPD data region.
70 @note At this point, memory is NOT ready, PeiServices are available to use.
72 @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture.
74 @return FspUpdRgnPtr A pointer to the UPD data region data strcture.
79 IN OUT VOID
*FspUpdRgnPtr
86 Get BootLoader Tolum size.
88 @note At this point, memory is NOT ready, PeiServices are available to use.
90 @return BootLoader Tolum size.
94 GetBootLoaderTolumSize (
102 Get TempRamExit parameter.
104 @note At this point, memory is ready, PeiServices are available to use.
106 @return TempRamExit parameter.
110 GetTempRamExitParam (
118 Get FspSiliconInit parameter.
120 @note At this point, memory is ready, PeiServices are available to use.
122 @return FspSiliconInit parameter.
126 GetFspSiliconInitParam (
134 Get S3 PEI memory information.
136 @note At this point, memory is ready, and PeiServices are available to use.
137 Platform can get some data from SMRAM directly.
139 @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase.
140 @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase.
142 @return If S3 PEI memory information is got successfully.
147 OUT UINT64
*S3PeiMemSize
,
148 OUT EFI_PHYSICAL_ADDRESS
*S3PeiMemBase
151 return EFI_UNSUPPORTED
;
155 Get stack information according to boot mode.
157 @note If BootMode is BOOT_ON_S3_RESUME or BOOT_ON_FLASH_UPDATE,
158 this stack should be in some reserved memory space.
160 @note If FspInitDone is TRUE, memory is ready, but no PeiServices there.
161 Platform can get some data from SMRAM directly.
162 @note If FspInitDone is FALSE, memory is NOT ready, but PeiServices are available to use.
163 Platform can get some data from variable via VariablePpi.
165 @param[in] BootMode Current boot mode.
166 @param[in] FspInitDone If FspInit is called.
167 @param[out] StackSize Stack size to be used in PEI phase.
168 @param[out] StackBase Stack base to be used in PEI phase.
170 @return If Stack information is got successfully.
176 IN BOOLEAN FspInitDone
,
177 OUT UINT64
*StackSize
,
178 OUT EFI_PHYSICAL_ADDRESS
*StackBase
181 *StackBase
= PcdGet32 (PcdTemporaryRamBase
);
182 *StackSize
= PcdGet32 (PcdTemporaryRamSize
);
184 if (BootMode
== BOOT_ON_S3_RESUME
) {
188 } else if (BootMode
== BOOT_ON_FLASH_UPDATE
) {