1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
/** @file
Support FSP Wrapper MultiPhase process.
Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <Library/FspWrapperApiLib.h>
#include <Library/FspWrapperPlatformLib.h>
#include <FspEas.h>
#include <FspGlobalData.h>
#include <Ppi/ReadOnlyVariable2.h>
#include <Ppi/Variable.h>
#include <Library/PeiServicesLib.h>
#include <Library/FspWrapperPlatformMultiPhaseLib.h>
/**
Execute 32-bit FSP API entry code.
@param[in] Function The 32bit code entry to be executed.
@param[in] Param1 The first parameter to pass to 32bit code.
@param[in] Param2 The second parameter to pass to 32bit code.
@return EFI_STATUS.
**/
EFI_STATUS
Execute32BitCode (
IN UINT64 Function,
IN UINT64 Param1,
IN UINT64 Param2
);
/**
Execute 64-bit FSP API entry code.
@param[in] Function The 64bit code entry to be executed.
@param[in] Param1 The first parameter to pass to 64bit code.
@param[in] Param2 The second parameter to pass to 64bit code.
@return EFI_STATUS.
**/
EFI_STATUS
Execute64BitCode (
IN UINT64 Function,
IN UINT64 Param1,
IN UINT64 Param2
);
/**
Call FspsMultiPhase API.
@param[in] FspsMultiPhaseParams - Parameters for MultiPhase API.
@param[in] FspHobListPtr - Pointer to FSP HobList (valid after FSP-M completed)
@param[in] ComponentIndex - FSP Component which executing MultiPhase initialization.
@return EFI_UNSUPPORTED - the requested FspsMultiPhase API is not supported.
@return EFI_DEVICE_ERROR - the FSP header was not found.
@return EFI status returned by FspsMultiPhase API.
**/
EFI_STATUS
EFIAPI
CallFspMultiPhaseEntry (
IN VOID *FspMultiPhaseParams,
IN OUT VOID **FspHobListPtr,
IN UINT8 ComponentIndex
)
{
FSP_INFO_HEADER *FspHeader;
//
// FSP_MULTI_PHASE_INIT and FSP_MULTI_PHASE_SI_INIT API functions having same prototype.
//
UINTN FspMultiPhaseApiEntry;
UINTN FspMultiPhaseApiOffset;
EFI_STATUS Status;
BOOLEAN InterruptState;
if (ComponentIndex == FspMultiPhaseMemInitApiIndex) {
FspHeader = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspmBaseAddress));
if (FspHeader == NULL) {
return EFI_DEVICE_ERROR;
}
FspMultiPhaseApiOffset = FspHeader->FspMultiPhaseMemInitEntryOffset;
} else if (ComponentIndex == FspMultiPhaseSiInitApiIndex) {
FspHeader = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspsBaseAddress));
if (FspHeader == NULL) {
return EFI_DEVICE_ERROR;
}
FspMultiPhaseApiOffset = FspHeader->FspMultiPhaseSiInitEntryOffset;
}
if (FspMultiPhaseApiOffset == 0) {
return EFI_UNSUPPORTED;
}
FspMultiPhaseApiEntry = FspHeader->ImageBase + FspMultiPhaseApiOffset;
InterruptState = SaveAndDisableInterrupts ();
if ((FspHeader->ImageAttribute & BIT2) == 0) {
// BIT2: IMAGE_ATTRIBUTE_64BIT_MODE_SUPPORT
Status = Execute32BitCode ((UINTN)FspMultiPhaseApiEntry, (UINTN)FspMultiPhaseParams, (UINTN)NULL);
} else {
Status = Execute64BitCode ((UINTN)FspMultiPhaseApiEntry, (UINTN)FspMultiPhaseParams, (UINTN)NULL);
}
SetInterruptState (InterruptState);
DEBUG ((DEBUG_ERROR, "CallFspMultiPhaseEntry return Status %r \n", Status));
return Status;
}
/**
FSP Wrapper Variable Request Handler
@param[in] FspHobListPtr - Pointer to FSP HobList (valid after FSP-M completed)
@param[in] ComponentIndex - FSP Component which executing MultiPhase initialization.
@retval EFI_UNSUPPORTED FSP Wrapper cannot support the specific variable request
@retval EFI_STATUS Return FSP returned status
**/
EFI_STATUS
EFIAPI
FspWrapperVariableRequestHandler (
IN OUT VOID **FspHobListPtr,
IN UINT8 ComponentIndex
)
{
EFI_STATUS Status;
FSP_MULTI_PHASE_PARAMS FspMultiPhaseParams;
FSP_MULTI_PHASE_VARIABLE_REQUEST_INFO_PARAMS *FspVariableRequestParams;
EFI_PEI_READ_ONLY_VARIABLE2_PPI *ReadOnlyVariablePpi;
EDKII_PEI_VARIABLE_PPI *VariablePpi;
BOOLEAN WriteVariableSupport;
FSP_MULTI_PHASE_COMPLETE_VARIABLE_REQUEST_PARAMS CompleteVariableRequestParams;
WriteVariableSupport = TRUE;
Status = PeiServicesLocatePpi (
&gEdkiiPeiVariablePpiGuid,
0,
NULL,
(VOID **)&VariablePpi
);
if (EFI_ERROR (Status)) {
WriteVariableSupport = FALSE;
Status = PeiServicesLocatePpi (
&gEfiPeiReadOnlyVariable2PpiGuid,
0,
NULL,
(VOID **)&ReadOnlyVariablePpi
);
ASSERT_EFI_ERROR (Status);
if (EFI_ERROR (Status)) {
return EFI_UNSUPPORTED;
}
}
Status = FSP_STATUS_VARIABLE_REQUEST;
while (Status == FSP_STATUS_VARIABLE_REQUEST) {
//
// Get the variable request information from FSP.
//
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseGetVariableRequestInfo;
FspMultiPhaseParams.PhaseIndex = 0;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
ASSERT_EFI_ERROR (Status);
//
// FSP should output this pointer for variable request information.
//
FspVariableRequestParams = (FSP_MULTI_PHASE_VARIABLE_REQUEST_INFO_PARAMS *)FspMultiPhaseParams.MultiPhaseParamPtr;
switch (FspVariableRequestParams->VariableRequest) {
case EnumFspVariableRequestGetVariable:
if (WriteVariableSupport) {
Status = VariablePpi->GetVariable (
VariablePpi,
FspVariableRequestParams->VariableName,
FspVariableRequestParams->VariableGuid,
FspVariableRequestParams->Attributes,
(UINTN *)FspVariableRequestParams->DataSize,
FspVariableRequestParams->Data
);
} else {
Status = ReadOnlyVariablePpi->GetVariable (
ReadOnlyVariablePpi,
FspVariableRequestParams->VariableName,
FspVariableRequestParams->VariableGuid,
FspVariableRequestParams->Attributes,
(UINTN *)FspVariableRequestParams->DataSize,
FspVariableRequestParams->Data
);
}
CompleteVariableRequestParams.VariableRequestStatus = Status;
FspMultiPhaseParams.MultiPhaseParamPtr = (VOID *)&CompleteVariableRequestParams;
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseCompleteVariableRequest;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
break;
case EnumFspVariableRequestSetVariable:
if (WriteVariableSupport) {
Status = VariablePpi->SetVariable (
VariablePpi,
FspVariableRequestParams->VariableName,
FspVariableRequestParams->VariableGuid,
*FspVariableRequestParams->Attributes,
(UINTN)*FspVariableRequestParams->DataSize,
FspVariableRequestParams->Data
);
} else {
Status = EFI_UNSUPPORTED;
}
CompleteVariableRequestParams.VariableRequestStatus = Status;
FspMultiPhaseParams.MultiPhaseParamPtr = (VOID *)&CompleteVariableRequestParams;
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseCompleteVariableRequest;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
break;
case EnumFspVariableRequestGetNextVariableName:
if (WriteVariableSupport) {
Status = VariablePpi->GetNextVariableName (
VariablePpi,
(UINTN *)FspVariableRequestParams->VariableNameSize,
FspVariableRequestParams->VariableName,
FspVariableRequestParams->VariableGuid
);
} else {
Status = ReadOnlyVariablePpi->NextVariableName (
ReadOnlyVariablePpi,
(UINTN *)FspVariableRequestParams->VariableNameSize,
FspVariableRequestParams->VariableName,
FspVariableRequestParams->VariableGuid
);
}
CompleteVariableRequestParams.VariableRequestStatus = Status;
FspMultiPhaseParams.MultiPhaseParamPtr = (VOID *)&CompleteVariableRequestParams;
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseCompleteVariableRequest;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
break;
case EnumFspVariableRequestQueryVariableInfo:
if (WriteVariableSupport) {
Status = VariablePpi->QueryVariableInfo (
VariablePpi,
*FspVariableRequestParams->Attributes,
FspVariableRequestParams->MaximumVariableStorageSize,
FspVariableRequestParams->RemainingVariableStorageSize,
FspVariableRequestParams->MaximumVariableSize
);
} else {
Status = EFI_UNSUPPORTED;
}
CompleteVariableRequestParams.VariableRequestStatus = Status;
FspMultiPhaseParams.MultiPhaseParamPtr = (VOID *)&CompleteVariableRequestParams;
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseCompleteVariableRequest;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
break;
default:
DEBUG ((DEBUG_ERROR, "Unknown VariableRequest type!\n"));
Status = EFI_UNSUPPORTED;
break;
}
}
//
// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
//
if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
DEBUG ((DEBUG_INFO, "FspMultiPhaseApi-0x%x requested reset %r\n", ComponentIndex, Status));
CallFspWrapperResetSystem ((UINTN)Status);
}
return Status;
}
/**
FSP Wrapper MultiPhase Handler
@param[in] FspHobListPtr - Pointer to FSP HobList (valid after FSP-M completed)
@param[in] ComponentIndex - FSP Component which executing MultiPhase initialization.
@retval EFI_STATUS Always return EFI_SUCCESS
**/
EFI_STATUS
EFIAPI
FspWrapperMultiPhaseHandler (
IN OUT VOID **FspHobListPtr,
IN UINT8 ComponentIndex
)
{
EFI_STATUS Status;
FSP_MULTI_PHASE_PARAMS FspMultiPhaseParams;
FSP_MULTI_PHASE_GET_NUMBER_OF_PHASES_PARAMS FspMultiPhaseGetNumber;
UINT32 Index;
UINT32 NumOfPhases;
//
// Query FSP for the number of phases supported.
//
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseGetNumberOfPhases;
FspMultiPhaseParams.PhaseIndex = 0;
FspMultiPhaseParams.MultiPhaseParamPtr = (VOID *)&FspMultiPhaseGetNumber;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
if (Status == EFI_UNSUPPORTED) {
//
// MultiPhase API was not supported
//
return Status;
} else {
ASSERT_EFI_ERROR (Status);
}
NumOfPhases = FspMultiPhaseGetNumber.NumberOfPhases;
for (Index = 1; Index <= NumOfPhases; Index++) {
DEBUG ((DEBUG_ERROR, "MultiPhase Index/NumOfPhases = %d of %d\n", Index, NumOfPhases));
//
// Platform actions can be added in below function for each component and phase before returning control back to FSP.
//
FspWrapperPlatformMultiPhaseHandler (FspHobListPtr, ComponentIndex, Index);
FspMultiPhaseParams.MultiPhaseAction = EnumMultiPhaseExecutePhase;
FspMultiPhaseParams.PhaseIndex = Index;
FspMultiPhaseParams.MultiPhaseParamPtr = NULL;
Status = CallFspMultiPhaseEntry (&FspMultiPhaseParams, FspHobListPtr, ComponentIndex);
if (Status == FSP_STATUS_VARIABLE_REQUEST) {
//
// call to Variable request handler
//
FspWrapperVariableRequestHandler (FspHobListPtr, ComponentIndex);
}
//
// Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
//
if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
DEBUG ((DEBUG_INFO, "FspMultiPhaseApi-0x%x requested reset %r\n", ComponentIndex, Status));
CallFspWrapperResetSystem ((UINTN)Status);
}
ASSERT_EFI_ERROR (Status);
}
return EFI_SUCCESS;
}
|
