]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - IntelFspPkg/FspSecCore/SecFsp.c
IntelFspPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFspPkg / FspSecCore / SecFsp.c
... / ...
CommitLineData
1/** @file\r
2\r
3 Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>\r
4 SPDX-License-Identifier: BSD-2-Clause-Patent\r
5\r
6**/\r
7\r
8#include "SecFsp.h"\r
9\r
10/**\r
11\r
12 Calculate the FSP IDT gate descriptor.\r
13\r
14 @param[in] IdtEntryTemplate IDT gate descriptor template.\r
15\r
16 @return FSP specific IDT gate descriptor.\r
17\r
18**/\r
19UINT64\r
20FspGetExceptionHandler(\r
21 IN UINT64 IdtEntryTemplate\r
22 )\r
23{\r
24 UINT32 Entry;\r
25 UINT64 ExceptionHandler;\r
26 IA32_IDT_GATE_DESCRIPTOR *IdtGateDescriptor;\r
27 FSP_INFO_HEADER *FspInfoHeader;\r
28\r
29 FspInfoHeader = (FSP_INFO_HEADER *)AsmGetFspInfoHeader();\r
30 ExceptionHandler = IdtEntryTemplate;\r
31 IdtGateDescriptor = (IA32_IDT_GATE_DESCRIPTOR *)&ExceptionHandler;\r
32 Entry = (IdtGateDescriptor->Bits.OffsetHigh << 16) | IdtGateDescriptor->Bits.OffsetLow;\r
33 Entry = FspInfoHeader->ImageBase + FspInfoHeader->ImageSize - (~Entry + 1);\r
34 IdtGateDescriptor->Bits.OffsetHigh = (UINT16)(Entry >> 16);\r
35 IdtGateDescriptor->Bits.OffsetLow = (UINT16)Entry;\r
36\r
37 return ExceptionHandler;\r
38}\r
39\r
40/**\r
41 This function gets the FSP UPD region offset in flash.\r
42\r
43 @return the offset of the UPD region.\r
44\r
45**/\r
46UINT32\r
47EFIAPI\r
48GetFspUpdRegionOffset (\r
49 VOID\r
50 )\r
51{\r
52 FSP_GLOBAL_DATA *FspData;\r
53 UINT32 *Offset;\r
54\r
55 FspData = GetFspGlobalDataPointer ();\r
56\r
57 //\r
58 // It is required to put PcdUpdRegionOffset at offset 0x000C\r
59 // for all FSPs.\r
60 // gPlatformFspPkgTokenSpaceGuid.PcdUpdRegionOffset | 0x000C | 0x12345678\r
61 //\r
62 Offset = (UINT32 *)(FspData->FspInfoHeader->ImageBase + \\r
63 FspData->FspInfoHeader->CfgRegionOffset + 0x0C);\r
64\r
65 return *Offset;\r
66}\r
67\r
68/**\r
69 This interface fills platform specific data.\r
70\r
71 @param[in,out] FspData Pointer to the FSP global data.\r
72\r
73**/\r
74VOID\r
75EFIAPI\r
76SecGetPlatformData (\r
77 IN OUT FSP_GLOBAL_DATA *FspData\r
78 )\r
79{\r
80 FSP_PLAT_DATA *FspPlatformData;\r
81 UINT32 TopOfCar;\r
82 UINT32 *StackPtr;\r
83 UINT32 DwordSize;\r
84\r
85 FspPlatformData = &FspData->PlatformData;\r
86\r
87 //\r
88 // The entries of platform information, together with the number of them,\r
89 // reside in the bottom of stack, left untouched by normal stack operation.\r
90 //\r
91 TopOfCar = PcdGet32 (PcdTemporaryRamBase) + PcdGet32 (PcdTemporaryRamSize);\r
92\r
93 FspPlatformData->DataPtr = NULL;\r
94 FspPlatformData->MicrocodeRegionBase = 0;\r
95 FspPlatformData->MicrocodeRegionSize = 0;\r
96 FspPlatformData->CodeRegionBase = 0;\r
97 FspPlatformData->CodeRegionSize = 0;\r
98\r
99 //\r
100 // Pointer to the size field\r
101 //\r
102 StackPtr = (UINT32 *)(TopOfCar - sizeof(UINT32));\r
103\r
104 while (*StackPtr != 0) {\r
105 if (*(StackPtr - 1) == FSP_MCUD_SIGNATURE) {\r
106 //\r
107 // This following data was pushed onto stack after TempRamInit API\r
108 //\r
109 DwordSize = 4;\r
110 StackPtr = StackPtr - 1 - DwordSize;\r
111 CopyMem (&(FspPlatformData->MicrocodeRegionBase), StackPtr, (DwordSize << 2));\r
112 StackPtr--;\r
113 } else if (*(StackPtr - 1) == FSP_PER0_SIGNATURE) {\r
114 //\r
115 // This is the performance data for InitTempMemory API entry/exit\r
116 //\r
117 DwordSize = 4;\r
118 StackPtr = StackPtr - 1 - DwordSize;\r
119 CopyMem (FspData->PerfData, StackPtr, (DwordSize << 2));\r
120 ((UINT8 *)(&FspData->PerfData[0]))[7] = FSP_PERF_ID_API_TMPRAMINIT_ENTRY;\r
121 ((UINT8 *)(&FspData->PerfData[1]))[7] = FSP_PERF_ID_API_TMPRAMINIT_EXIT;\r
122 StackPtr--;\r
123 } else {\r
124 StackPtr -= (*StackPtr);\r
125 }\r
126 }\r
127}\r
128\r
129/**\r
130\r
131 Initialize the FSP global data region.\r
132 It needs to be done as soon as possible after the stack is setup.\r
133\r
134 @param[in,out] PeiFspData Pointer of the FSP global data.\r
135 @param[in] BootLoaderStack BootLoader stack.\r
136 @param[in] ApiIdx The index of the FSP API.\r
137\r
138**/\r
139VOID\r
140FspGlobalDataInit (\r
141 IN OUT FSP_GLOBAL_DATA *PeiFspData,\r
142 IN UINT32 BootLoaderStack,\r
143 IN UINT8 ApiIdx\r
144 )\r
145{\r
146 VOID *UpdDataRgnPtr;\r
147 FSP_INIT_PARAMS *FspInitParams;\r
148 CHAR8 ImageId[9];\r
149 UINTN Idx;\r
150\r
151 //\r
152 // Init PCIE_BAR with value and set global FSP data pointer.\r
153 // PciExpress Base should have been programmed by platform already.\r
154 //\r
155 SetFspGlobalDataPointer (PeiFspData);\r
156 ZeroMem ((VOID *)PeiFspData, sizeof(FSP_GLOBAL_DATA));\r
157\r
158 PeiFspData->Signature = FSP_GLOBAL_DATA_SIGNATURE;\r
159 PeiFspData->CoreStack = BootLoaderStack;\r
160 PeiFspData->PerfIdx = 2;\r
161\r
162 SetFspMeasurePoint (FSP_PERF_ID_API_FSPINIT_ENTRY);\r
163\r
164 //\r
165 // Get FSP Header offset\r
166 // It may have multiple FVs, so look into the last one for FSP header\r
167 //\r
168 PeiFspData->FspInfoHeader = (FSP_INFO_HEADER *)AsmGetFspInfoHeader();\r
169 SecGetPlatformData (PeiFspData);\r
170\r
171 //\r
172 // Set API calling mode\r
173 //\r
174 SetFspApiCallingMode (ApiIdx == 1 ? 0 : 1);\r
175\r
176 //\r
177 // Initialize UPD pointer.\r
178 //\r
179 FspInitParams = (FSP_INIT_PARAMS *)GetFspApiParameter ();\r
180 UpdDataRgnPtr = ((FSP_INIT_RT_COMMON_BUFFER *)FspInitParams->RtBufferPtr)->UpdDataRgnPtr;\r
181 if (UpdDataRgnPtr == NULL) {\r
182 UpdDataRgnPtr = (VOID *)(PeiFspData->FspInfoHeader->ImageBase + GetFspUpdRegionOffset());\r
183 }\r
184 SetFspUpdDataPointer (UpdDataRgnPtr);\r
185\r
186 //\r
187 // Initialize serial port\r
188 // It might have been done in ProcessLibraryConstructorList(), however,\r
189 // the FSP global data is not initialized at that time. So do it again\r
190 // for safe.\r
191 //\r
192 SerialPortInitialize ();\r
193\r
194 //\r
195 // Ensure the golbal data pointer is valid\r
196 //\r
197 ASSERT (GetFspGlobalDataPointer () == PeiFspData);\r
198\r
199 for (Idx = 0; Idx < 8; Idx++) {\r
200 ImageId[Idx] = PeiFspData->FspInfoHeader->ImageId[Idx];\r
201 }\r
202 ImageId[Idx] = 0;\r
203\r
204 DEBUG ((DEBUG_INFO | DEBUG_INIT, "\n============= PEIM FSP v1.%x (%a v%x.%x.%x.%x) =============\n", \\r
205 PeiFspData->FspInfoHeader->HeaderRevision - 1, \\r
206 ImageId, \\r
207 (PeiFspData->FspInfoHeader->ImageRevision >> 24) & 0xff, \\r
208 (PeiFspData->FspInfoHeader->ImageRevision >> 16) & 0xff, \\r
209 (PeiFspData->FspInfoHeader->ImageRevision >> 8) & 0xff, \\r
210 (PeiFspData->FspInfoHeader->ImageRevision >> 0) & 0xff));\r
211\r
212}\r
213\r
214/**\r
215\r
216 Adjust the FSP data pointers after the stack is migrated to memory.\r
217\r
218 @param[in] OffsetGap The offset gap between the old stack and the new stack.\r
219\r
220**/\r
221VOID\r
222FspDataPointerFixUp (\r
223 IN UINT32 OffsetGap\r
224 )\r
225{\r
226 FSP_GLOBAL_DATA *NewFspData;\r
227\r
228 NewFspData = (FSP_GLOBAL_DATA *)((UINTN)GetFspGlobalDataPointer() + (UINTN)OffsetGap);\r
229 SetFspGlobalDataPointer (NewFspData);\r
230}\r
231\r
232/**\r
233 This function check the FSP API calling condition.\r
234\r
235 @param[in] ApiIdx Internal index of the FSP API.\r
236 @param[in] ApiParam Parameter of the FSP API.\r
237\r
238**/\r
239EFI_STATUS\r
240EFIAPI\r
241FspApiCallingCheck (\r
242 IN UINT32 ApiIdx,\r
243 IN VOID *ApiParam\r
244 )\r
245{\r
246 EFI_STATUS Status;\r
247 FSP_GLOBAL_DATA *FspData;\r
248 FSP_INIT_PARAMS *FspInitParams;\r
249 FSP_INIT_RT_COMMON_BUFFER *FspRtBuffer;\r
250\r
251 FspInitParams = (FSP_INIT_PARAMS *) ApiParam;\r
252 FspRtBuffer = ((FSP_INIT_RT_COMMON_BUFFER *)FspInitParams->RtBufferPtr);\r
253\r
254 Status = EFI_SUCCESS;\r
255 FspData = GetFspGlobalDataPointer ();\r
256 if (ApiIdx == 1) {\r
257 //\r
258 // FspInit check\r
259 //\r
260 if ((UINT32)FspData != 0xFFFFFFFF) {\r
261 Status = EFI_UNSUPPORTED;\r
262 } else if ((FspRtBuffer == NULL) || ((FspRtBuffer->BootLoaderTolumSize % EFI_PAGE_SIZE) != 0) || (EFI_ERROR(FspUpdSignatureCheck(ApiIdx, ApiParam)))) {\r
263 Status = EFI_INVALID_PARAMETER;\r
264 }\r
265 } else if (ApiIdx == 2) {\r
266 //\r
267 // NotifyPhase check\r
268 //\r
269 if ((FspData == NULL) || ((UINT32)FspData == 0xFFFFFFFF)) {\r
270 Status = EFI_UNSUPPORTED;\r
271 } else {\r
272 if (FspData->Signature != FSP_GLOBAL_DATA_SIGNATURE) {\r
273 Status = EFI_UNSUPPORTED;\r
274 }\r
275 }\r
276 } else if (ApiIdx == 3) {\r
277 //\r
278 // FspMemoryInit check\r
279 //\r
280 if ((UINT32)FspData != 0xFFFFFFFF) {\r
281 Status = EFI_UNSUPPORTED;\r
282 } else if ((FspRtBuffer == NULL) || ((FspRtBuffer->BootLoaderTolumSize % EFI_PAGE_SIZE) != 0) || (EFI_ERROR(FspUpdSignatureCheck(ApiIdx, ApiParam)))) {\r
283 Status = EFI_INVALID_PARAMETER;\r
284 }\r
285 } else if (ApiIdx == 4) {\r
286 //\r
287 // TempRamExit check\r
288 //\r
289 if ((FspData == NULL) || ((UINT32)FspData == 0xFFFFFFFF)) {\r
290 Status = EFI_UNSUPPORTED;\r
291 } else {\r
292 if (FspData->Signature != FSP_GLOBAL_DATA_SIGNATURE) {\r
293 Status = EFI_UNSUPPORTED;\r
294 }\r
295 }\r
296 } else if (ApiIdx == 5) {\r
297 //\r
298 // FspSiliconInit check\r
299 //\r
300 if ((FspData == NULL) || ((UINT32)FspData == 0xFFFFFFFF)) {\r
301 Status = EFI_UNSUPPORTED;\r
302 } else {\r
303 if (FspData->Signature != FSP_GLOBAL_DATA_SIGNATURE) {\r
304 Status = EFI_UNSUPPORTED;\r
305 } else if (EFI_ERROR(FspUpdSignatureCheck(ApiIdx, ApiParam))) {\r
306 Status = EFI_INVALID_PARAMETER;\r
307 }\r
308 }\r
309 } else {\r
310 Status = EFI_UNSUPPORTED;\r
311 }\r
312\r
313 return Status;\r
314}\r
315\r
316/**\r
317 This function gets the boot FV offset in FSP.\r
318 @return the boot firmware volumen offset inside FSP binary\r
319\r
320**/\r
321UINT32\r
322EFIAPI\r
323GetBootFirmwareVolumeOffset (\r
324 VOID\r
325 )\r
326{ \r
327 return PcdGet32 (PcdFspBootFirmwareVolumeBase) - PcdGet32 (PcdFspAreaBaseAddress);\r
328}\r