]>
git.proxmox.com Git - mirror_edk2.git/blob - IntelFspWrapperPkg/Include/Library/FspPlatformInfoLib.h
2 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.
15 #ifndef __FSP_PLATFORM_INFO_LIB_H__
16 #define __FSP_PLATFORM_INFO_LIB_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.
33 Get NVS buffer parameter.
35 @note At this point, memory is NOT ready, PeiServices are available to use.
37 @return NvsBuffer NVS buffer parameter.
48 @note At this point, memory is NOT ready, PeiServices are available to use.
50 @return UPD region size.
59 This function overrides the default configurations in the UPD data region.
61 @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture.
63 @return FspUpdRgnPtr A pointer to the UPD data region data strcture.
68 IN OUT VOID
*FspUpdRgnPtr
72 Get BootLoader Tolum size.
74 @note At this point, memory is NOT ready, PeiServices are available to use.
76 @return BootLoader Tolum size.
80 GetBootLoaderTolumSize (
85 Get TempRamExit parameter.
87 @note At this point, memory is ready, PeiServices are available to use.
89 @return TempRamExit parameter.
98 Get FspSiliconInit parameter.
100 @note At this point, memory is ready, PeiServices are available to use.
102 @return FspSiliconInit parameter.
106 GetFspSiliconInitParam (
111 Get S3 PEI memory information.
113 @note At this point, memory is ready, and PeiServices are available to use.
114 Platform can get some data from SMRAM directly.
116 @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase.
117 @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase.
119 @return If S3 PEI memory information is got successfully.
124 OUT UINT64
*S3PeiMemSize
,
125 OUT EFI_PHYSICAL_ADDRESS
*S3PeiMemBase
129 Get stack information according to boot mode.
131 @note If BootMode is BOOT_ON_S3_RESUME or BOOT_ON_FLASH_UPDATE,
132 this stack should be in some reserved memory space.
134 @note If FspInitDone is TRUE, memory is ready, but no PeiServices there.
135 Platform can get some data from SMRAM directly.
136 @note If FspInitDone is FALSE, memory is NOT ready, but PeiServices are available to use.
137 Platform can get some data from variable via VariablePpi.
139 @param[in] BootMode Current boot mode.
140 @param[in] FspInitDone If FspInit is called.
141 @param[out] StackSize Stack size to be used in PEI phase.
142 @param[out] StackBase Stack base to be used in PEI phase.
144 @return If Stack information is got successfully.
150 IN BOOLEAN FspInitDone
,
151 OUT UINT64
*StackSize
,
152 OUT EFI_PHYSICAL_ADDRESS
*StackBase