]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | \r | |
3 | Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>\r | |
4 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
5 | \r | |
6 | **/\r | |
7 | \r | |
8 | #ifndef _FSP_COMMON_LIB_H_\r | |
9 | #define _FSP_COMMON_LIB_H_\r | |
10 | \r | |
11 | #include <FspGlobalData.h>\r | |
12 | #include <FspMeasurePointId.h>\r | |
13 | \r | |
14 | /**\r | |
15 | This function sets the FSP global data pointer.\r | |
16 | \r | |
17 | @param[in] FspData Fsp global data pointer.\r | |
18 | \r | |
19 | **/\r | |
20 | VOID\r | |
21 | EFIAPI\r | |
22 | SetFspGlobalDataPointer (\r | |
23 | IN FSP_GLOBAL_DATA *FspData\r | |
24 | );\r | |
25 | \r | |
26 | /**\r | |
27 | This function gets the FSP global data pointer.\r | |
28 | \r | |
29 | **/\r | |
30 | FSP_GLOBAL_DATA *\r | |
31 | EFIAPI\r | |
32 | GetFspGlobalDataPointer (\r | |
33 | VOID\r | |
34 | );\r | |
35 | \r | |
36 | /**\r | |
37 | This function gets back the FSP API first parameter passed by the bootloader.\r | |
38 | \r | |
39 | @retval ApiParameter FSP API first parameter passed by the bootloader.\r | |
40 | **/\r | |
41 | UINT32\r | |
42 | EFIAPI\r | |
43 | GetFspApiParameter (\r | |
44 | VOID\r | |
45 | );\r | |
46 | \r | |
47 | /**\r | |
48 | This function gets back the FSP API second parameter passed by the bootloader.\r | |
49 | \r | |
50 | @retval ApiParameter FSP API second parameter passed by the bootloader.\r | |
51 | **/\r | |
52 | UINT32\r | |
53 | EFIAPI\r | |
54 | GetFspApiParameter2 (\r | |
55 | VOID\r | |
56 | );\r | |
57 | \r | |
58 | /**\r | |
59 | This function returns the FSP entry stack pointer from address of the first API parameter.\r | |
60 | \r | |
61 | @retval FSP entry stack pointer.\r | |
62 | **/\r | |
63 | VOID*\r | |
64 | EFIAPI\r | |
65 | GetFspEntryStack (\r | |
66 | VOID\r | |
67 | );\r | |
68 | \r | |
69 | /**\r | |
70 | This function sets the FSP API parameter in the stack.\r | |
71 | \r | |
72 | @param[in] Value New parameter value.\r | |
73 | \r | |
74 | **/\r | |
75 | VOID\r | |
76 | EFIAPI\r | |
77 | SetFspApiParameter (\r | |
78 | IN UINT32 Value\r | |
79 | );\r | |
80 | \r | |
81 | /**\r | |
82 | This function set the API status code returned to the BootLoader.\r | |
83 | \r | |
84 | @param[in] ReturnStatus Status code to return.\r | |
85 | \r | |
86 | **/\r | |
87 | VOID\r | |
88 | EFIAPI\r | |
89 | SetFspApiReturnStatus (\r | |
90 | IN UINT32 ReturnStatus\r | |
91 | );\r | |
92 | \r | |
93 | /**\r | |
94 | This function sets the context switching stack to a new stack frame.\r | |
95 | \r | |
96 | @param[in] NewStackTop New core stack to be set.\r | |
97 | \r | |
98 | **/\r | |
99 | VOID\r | |
100 | EFIAPI\r | |
101 | SetFspCoreStackPointer (\r | |
102 | IN VOID *NewStackTop\r | |
103 | );\r | |
104 | \r | |
105 | /**\r | |
106 | This function sets the platform specific data pointer.\r | |
107 | \r | |
108 | @param[in] PlatformData Fsp platform specific data pointer.\r | |
109 | \r | |
110 | **/\r | |
111 | VOID\r | |
112 | EFIAPI\r | |
113 | SetFspPlatformDataPointer (\r | |
114 | IN VOID *PlatformData\r | |
115 | );\r | |
116 | \r | |
117 | /**\r | |
118 | This function gets the platform specific data pointer.\r | |
119 | \r | |
120 | @param[in] PlatformData Fsp platform specific data pointer.\r | |
121 | \r | |
122 | **/\r | |
123 | VOID *\r | |
124 | EFIAPI\r | |
125 | GetFspPlatformDataPointer (\r | |
126 | VOID\r | |
127 | );\r | |
128 | \r | |
129 | /**\r | |
130 | This function sets the UPD data pointer.\r | |
131 | \r | |
132 | @param[in] UpdDataPtr UPD data pointer.\r | |
133 | **/\r | |
134 | VOID\r | |
135 | EFIAPI\r | |
136 | SetFspUpdDataPointer (\r | |
137 | IN VOID *UpdDataPtr\r | |
138 | );\r | |
139 | \r | |
140 | /**\r | |
141 | This function gets the UPD data pointer.\r | |
142 | \r | |
143 | @return UpdDataPtr UPD data pointer.\r | |
144 | **/\r | |
145 | VOID *\r | |
146 | EFIAPI\r | |
147 | GetFspUpdDataPointer (\r | |
148 | VOID\r | |
149 | );\r | |
150 | \r | |
151 | /**\r | |
152 | This function sets the memory init UPD data pointer.\r | |
153 | \r | |
154 | @param[in] MemoryInitUpdPtr memory init UPD data pointer.\r | |
155 | **/\r | |
156 | VOID\r | |
157 | EFIAPI\r | |
158 | SetFspMemoryInitUpdDataPointer (\r | |
159 | IN VOID *MemoryInitUpdPtr\r | |
160 | );\r | |
161 | \r | |
162 | /**\r | |
163 | This function gets the memory init UPD data pointer.\r | |
164 | \r | |
165 | @return memory init UPD data pointer.\r | |
166 | **/\r | |
167 | VOID *\r | |
168 | EFIAPI\r | |
169 | GetFspMemoryInitUpdDataPointer (\r | |
170 | VOID\r | |
171 | );\r | |
172 | \r | |
173 | /**\r | |
174 | This function sets the silicon init UPD data pointer.\r | |
175 | \r | |
176 | @param[in] SiliconInitUpdPtr silicon init UPD data pointer.\r | |
177 | **/\r | |
178 | VOID\r | |
179 | EFIAPI\r | |
180 | SetFspSiliconInitUpdDataPointer (\r | |
181 | IN VOID *SiliconInitUpdPtr\r | |
182 | );\r | |
183 | \r | |
184 | /**\r | |
185 | This function gets the silicon init UPD data pointer.\r | |
186 | \r | |
187 | @return silicon init UPD data pointer.\r | |
188 | **/\r | |
189 | VOID *\r | |
190 | EFIAPI\r | |
191 | GetFspSiliconInitUpdDataPointer (\r | |
192 | VOID\r | |
193 | );\r | |
194 | \r | |
195 | /**\r | |
196 | Set FSP measurement point timestamp.\r | |
197 | \r | |
198 | @param[in] Id Measurement point ID.\r | |
199 | \r | |
200 | @return performance timestamp.\r | |
201 | **/\r | |
202 | UINT64\r | |
203 | EFIAPI\r | |
204 | SetFspMeasurePoint (\r | |
205 | IN UINT8 Id\r | |
206 | );\r | |
207 | \r | |
208 | /**\r | |
209 | This function gets the FSP info header pointer.\r | |
210 | \r | |
211 | @retval FspInfoHeader FSP info header pointer\r | |
212 | **/\r | |
213 | FSP_INFO_HEADER *\r | |
214 | EFIAPI\r | |
215 | GetFspInfoHeader (\r | |
216 | VOID\r | |
217 | );\r | |
218 | \r | |
219 | /**\r | |
220 | This function sets the FSP info header pointer.\r | |
221 | \r | |
222 | @param[in] FspInfoHeader FSP info header pointer\r | |
223 | **/\r | |
224 | VOID\r | |
225 | EFIAPI\r | |
226 | SetFspInfoHeader (\r | |
227 | FSP_INFO_HEADER *FspInfoHeader\r | |
228 | );\r | |
229 | \r | |
230 | /**\r | |
231 | This function gets the FSP info header pointer from the API context.\r | |
232 | \r | |
233 | @retval FspInfoHeader FSP info header pointer\r | |
234 | **/\r | |
235 | FSP_INFO_HEADER *\r | |
236 | EFIAPI\r | |
237 | GetFspInfoHeaderFromApiContext (\r | |
238 | VOID\r | |
239 | );\r | |
240 | \r | |
241 | /**\r | |
242 | This function gets the CfgRegion data pointer.\r | |
243 | \r | |
244 | @return CfgRegion data pointer.\r | |
245 | **/\r | |
246 | VOID *\r | |
247 | EFIAPI\r | |
248 | GetFspCfgRegionDataPointer (\r | |
249 | VOID\r | |
250 | );\r | |
251 | \r | |
252 | /**\r | |
253 | This function gets FSP API calling mode.\r | |
254 | \r | |
255 | @retval API calling mode\r | |
256 | **/\r | |
257 | UINT8\r | |
258 | EFIAPI\r | |
259 | GetFspApiCallingIndex (\r | |
260 | VOID\r | |
261 | );\r | |
262 | \r | |
263 | /**\r | |
264 | This function sets FSP API calling mode.\r | |
265 | \r | |
266 | @param[in] Index API calling index\r | |
267 | **/\r | |
268 | VOID\r | |
269 | EFIAPI\r | |
270 | SetFspApiCallingIndex (\r | |
271 | UINT8 Index\r | |
272 | );\r | |
273 | \r | |
274 | /**\r | |
275 | This function gets FSP Phase StatusCode.\r | |
276 | \r | |
277 | @retval StatusCode\r | |
278 | **/\r | |
279 | UINT32\r | |
280 | EFIAPI\r | |
281 | GetPhaseStatusCode (\r | |
282 | VOID\r | |
283 | );\r | |
284 | \r | |
285 | \r | |
286 | /**\r | |
287 | This function sets FSP Phase StatusCode.\r | |
288 | \r | |
289 | @param[in] Mode Phase StatusCode\r | |
290 | **/\r | |
291 | VOID\r | |
292 | EFIAPI\r | |
293 | SetPhaseStatusCode (\r | |
294 | UINT32 StatusCode\r | |
295 | );\r | |
296 | \r | |
297 | /**\r | |
298 | This function updates the return status of the FSP API with requested reset type and returns to Boot Loader.\r | |
299 | \r | |
300 | @param[in] FspResetType Reset type that needs to returned as API return status\r | |
301 | \r | |
302 | **/\r | |
303 | VOID\r | |
304 | EFIAPI\r | |
305 | FspApiReturnStatusReset (\r | |
306 | IN UINT32 FspResetType\r | |
307 | );\r | |
308 | #endif\r |