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
|
/** @file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "S3NvramSave.h"
#include <Protocol/Decompress.h>
#include <Library/CompressLib.h>
#include <Protocol/VariableLock.h>
/**
This function will retrieve the S3 data from HOBs produced by MRC
and will save it to NVRAM if the data is absent or different from
the previously saved data.
@param VOID
@retval VOID
**/
VOID
SaveS3StructToNvram (
VOID
)
{
EFI_STATUS Status;
UINTN BufferSize;
UINTN CurrentHobSize;
UINTN S3ChunkSize;
CHAR16 EfiMemoryConfigVariable[] = L"MemoryConfig0";
EFI_HOB_GUID_TYPE *GuidHob = NULL;
VOID *HobData = NULL;
VOID *VariableData = NULL;
UINTN CompressedDataSize;
UINT32 ScratchSize;
VOID *CompressedData = NULL;
VOID *Scratch = NULL;
EFI_DECOMPRESS_PROTOCOL *Decompress = NULL;
VOID *CompressedVariableData = NULL;
UINTN CompressedBufferSize;
EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock = NULL;
//
// Get first S3 data HOB
//
GuidHob = GetFirstGuidHob (&gEfiMemoryConfigDataHobGuid);
Status = gBS->LocateProtocol (&gEfiDecompressProtocolGuid, NULL, (VOID **) &Decompress);
DEBUG((DEBUG_INFO, "[SaveMemoryConfigEntryPoint] Locate Decompress protocol - %r\n", Status));
if(EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return;
}
Status = gBS->LocateProtocol(&gEdkiiVariableLockProtocolGuid, NULL, (VOID **)&VariableLock);
DEBUG((DEBUG_INFO, "[SaveMemoryConfigEntryPoint] Locate Variable Lock protocol - %r\n", Status));
ASSERT_EFI_ERROR(Status);
while (TRUE) {
if (GuidHob == NULL) {
break;
}
HobData = GET_GUID_HOB_DATA(GuidHob);
CurrentHobSize = GET_GUID_HOB_DATA_SIZE (GuidHob);
DEBUG((EFI_D_INFO, " Current Hob Size(bytes) is: %d\n", CurrentHobSize));
//
// Use the HOB data to save Memory Configuration Data
//
BufferSize = CurrentHobSize;
Status = gBS->AllocatePool (
EfiBootServicesData,
BufferSize,
(VOID**)&VariableData
);
ASSERT (VariableData != NULL);
S3ChunkSize = MAX_HOB_ENTRY_SIZE / 8;
DEBUG((EFI_D_INFO, " S3ChunkSize Hob Size(bytes): %d\n", S3ChunkSize));
while (CurrentHobSize) {
if (S3ChunkSize > CurrentHobSize) {
S3ChunkSize = CurrentHobSize;
}
BufferSize = S3ChunkSize;
CompressedDataSize = 0;
ScratchSize = 0;
Status = gRT->GetVariable (
EfiMemoryConfigVariable,
&gEfiMemoryConfigDataGuid,
NULL,
&CompressedDataSize,
NULL
);
if(Status == EFI_BUFFER_TOO_SMALL) {
Status = gBS->AllocatePool (
EfiBootServicesData,
CompressedDataSize,
(VOID**)&CompressedData
);
ASSERT (Status == EFI_SUCCESS);
}
if(!EFI_ERROR (Status))
{
Status = gRT->GetVariable (
EfiMemoryConfigVariable,
&gEfiMemoryConfigDataGuid,
NULL,
&CompressedDataSize,
CompressedData
);
if (!EFI_ERROR (Status)) {
Status = Decompress->GetInfo (
Decompress,
CompressedData,
(UINT32)CompressedDataSize,
(UINT32*)&BufferSize,
&ScratchSize
);
}
if (!EFI_ERROR (Status)) {
Status = gBS->AllocatePool (
EfiBootServicesData,
ScratchSize,
(VOID**)&Scratch
);
}
if (!EFI_ERROR (Status)) {
Status = Decompress->Decompress (
Decompress,
CompressedData,
(UINT32)CompressedDataSize,
VariableData,
(UINT32)BufferSize,
Scratch,
ScratchSize
);
}
if (EFI_ERROR (Status)) {
DEBUG((EFI_D_ERROR, "Getting variables error: 0x%x\n", Status));
ASSERT (Status == EFI_SUCCESS);
}
if(Scratch != NULL) {
gBS->FreePool (Scratch);
Scratch = NULL;
}
}
if(CompressedData != NULL) {
gBS->FreePool (CompressedData);
CompressedData = NULL;
}
if ( (EFI_ERROR(Status)) || (CompareMem (HobData, VariableData, S3ChunkSize) != 0) ) {
Status = gBS->AllocatePool (
EfiBootServicesData,
BufferSize,
(VOID**)&CompressedVariableData
);
ASSERT (CompressedVariableData != NULL);
if (Status == EFI_SUCCESS) {
CompressedBufferSize = BufferSize;
Status = Compress(HobData, S3ChunkSize, CompressedVariableData, &CompressedBufferSize);
if (Status == EFI_BUFFER_TOO_SMALL){
gBS->FreePool(CompressedVariableData);
Status = gBS->AllocatePool(
EfiBootServicesData,
CompressedBufferSize,
(VOID**)&CompressedVariableData
);
ASSERT (CompressedVariableData != NULL);
Status = Compress(HobData, S3ChunkSize, CompressedVariableData, &CompressedBufferSize);
}
if(Status == EFI_SUCCESS) {
Status = gRT->SetVariable (
EfiMemoryConfigVariable,
&gEfiMemoryConfigDataGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
CompressedBufferSize,
CompressedVariableData
);
}
if(CompressedVariableData != NULL) {
gBS->FreePool(CompressedVariableData);
CompressedVariableData = NULL;
}
}
if (EFI_ERROR (Status)) {
DEBUG((EFI_D_ERROR, "Set variable error. Status: 0x%x\n", Status));
ASSERT_EFI_ERROR (Status);
}
}
//
// Lock the Memory Config Variable
//
Status = VariableLock->RequestToLock(VariableLock, EfiMemoryConfigVariable, &gEfiMemoryConfigDataGuid);
ASSERT_EFI_ERROR(Status);
HobData = (UINT8 *) (HobData) + S3ChunkSize;
CurrentHobSize -= S3ChunkSize;
EfiMemoryConfigVariable[12]++; // Increment number in the string
}
//
// Get next S3 Config data hob, if none left, results NULL
//
GuidHob = GET_NEXT_HOB (GuidHob); // Increment to next HOB
GuidHob = GetNextGuidHob (&gEfiMemoryConfigDataHobGuid, GuidHob); // Now search for next MemConfig HOB
if(VariableData != NULL) {
gBS->FreePool(VariableData);
VariableData = NULL;
}
}
return;
}
EFI_STATUS
EFIAPI
S3NvramSaveEntry (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/**
This is the main entry point of the S3 NVRAM Save module.
@param ImageHandle - Handle for the image of this driver.
@param SystemTable - Pointer to the EFI System Table.
@retval EFI_SUCCESS - Module launched successfully.
**/
{
EFI_STATUS Status = EFI_SUCCESS;
//
// Save the s3 strututre from MRC into NVRAM if needed
//
SaveS3StructToNvram();
return Status;
}
|
