]>
git.proxmox.com Git - mirror_edk2.git/blob - IntelFsp2Pkg/Include/Library/FspCommonLib.h
3 Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
4 This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php.
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 #ifndef _FSP_COMMON_LIB_H_
15 #define _FSP_COMMON_LIB_H_
17 #include <FspGlobalData.h>
18 #include <FspMeasurePointId.h>
21 This function sets the FSP global data pointer.
23 @param[in] FspData Fsp global data pointer.
28 SetFspGlobalDataPointer (
29 IN FSP_GLOBAL_DATA
*FspData
33 This function gets the FSP global data pointer.
38 GetFspGlobalDataPointer (
43 This function gets back the FSP API first parameter passed by the bootlaoder.
45 @retval ApiParameter FSP API first parameter passed by the bootlaoder.
54 This function gets back the FSP API second parameter passed by the bootlaoder.
56 @retval ApiParameter FSP API second parameter passed by the bootlaoder.
65 This function sets the FSP API parameter in the stack.
67 @param[in] Value New parameter value.
77 This function set the API status code returned to the BootLoader.
79 @param[in] ReturnStatus Status code to return.
84 SetFspApiReturnStatus (
85 IN UINT32 ReturnStatus
89 This function sets the context switching stack to a new stack frame.
91 @param[in] NewStackTop New core stack to be set.
96 SetFspCoreStackPointer (
101 This function sets the platform specific data pointer.
103 @param[in] PlatformData Fsp platform specific data pointer.
108 SetFspPlatformDataPointer (
109 IN VOID
*PlatformData
113 This function gets the platform specific data pointer.
115 @param[in] PlatformData Fsp platform specific data pointer.
120 GetFspPlatformDataPointer (
125 This function sets the UPD data pointer.
127 @param[in] UpdDataPtr UPD data pointer.
131 SetFspUpdDataPointer (
136 This function gets the UPD data pointer.
138 @return UpdDataPtr UPD data pointer.
142 GetFspUpdDataPointer (
147 This function sets the memory init UPD data pointer.
149 @param[in] MemoryInitUpdPtr memory init UPD data pointer.
153 SetFspMemoryInitUpdDataPointer (
154 IN VOID
*MemoryInitUpdPtr
158 This function gets the memory init UPD data pointer.
160 @return memory init UPD data pointer.
164 GetFspMemoryInitUpdDataPointer (
169 This function sets the silicon init UPD data pointer.
171 @param[in] SiliconInitUpdPtr silicon init UPD data pointer.
175 SetFspSiliconInitUpdDataPointer (
176 IN VOID
*SiliconInitUpdPtr
180 This function gets the silicon init UPD data pointer.
182 @return silicon init UPD data pointer.
186 GetFspSiliconInitUpdDataPointer (
191 Set FSP measurement point timestamp.
193 @param[in] Id Measurement point ID.
195 @return performance timestamp.
204 This function gets the FSP info header pointer.
206 @retval FspInfoHeader FSP info header pointer
215 This function sets the FSP info header pointer.
217 @param[in] FspInfoHeader FSP info header pointer
222 FSP_INFO_HEADER
*FspInfoHeader
226 This function gets the FSP info header pointer from the API context.
228 @retval FspInfoHeader FSP info header pointer
232 GetFspInfoHeaderFromApiContext (
237 This function gets the CfgRegion data pointer.
239 @return CfgRegion data pointer.
243 GetFspCfgRegionDataPointer (
248 This function gets FSP API calling mode.
250 @retval API calling mode
254 GetFspApiCallingIndex (
259 This function sets FSP API calling mode.
261 @param[in] Index API calling index
265 SetFspApiCallingIndex (
270 This function gets FSP Phase StatusCode.
282 This function sets FSP Phase StatusCode.
284 @param[in] Mode Phase StatusCode
293 This function gets FSP CAR base.
303 This function gets FSP CAR size.
313 This function updates the return status of the FSP API with requested reset type and returns to Boot Loader.
315 @param[in] FspResetType Reset type that needs to returned as API return status
320 FspApiReturnStatusReset (
321 IN UINT32 FspResetType