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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
/** @file
FCE is a tool which enables developers to retrieve and change HII configuration ("Setup")
data in Firmware Device files (".fd" files).
Copyright (c) 2011-2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _FCE_H_
#define _FCE_H_ 1
//#define NDEBUG
#include "Common.h"
#include "IfrParse.h"
#include "VariableCommon.h"
#include "BinaryParse.h"
#include "BinaryCreate.h"
///
/// Utility global variables
///
#define UTILITY_MAJOR_VERSION 0
#define UTILITY_MINOR_VERSION 34
#define UTILITY_NAME "FCE"
#define SUCCESS 0
#define FAIL 1
#define VR_FAIL 2
#define MAX_INPUT_ALLOCATE_SIZE 256
///
/// The type of file input and operations
///
typedef enum {
INFD,
OUTFD,
OUTTXT,
SETUPTXT
} FILETYPE;
typedef enum {
NONE,
READ,
UPDATE,
UPDATE_REMOVE,
UPDATE_IGNORE,
VERIFY,
UPDATEQ
} OPERATION_TYPE;
typedef struct _GUID_SEC_TOOL_ENTRY {
EFI_GUID Guid;
CHAR8* Name;
CHAR8* Path;
struct _GUID_SEC_TOOL_ENTRY *Next;
} GUID_SEC_TOOL_ENTRY;
///
/// The tag for use in identifying UNICODE files.
/// If the file is UNICODE, the first 16 bits of the file will equal this value.
///
enum {
BigUnicodeFileTag = 0xFEFF,
LittleUnicodeFileTag = 0xFFFE
};
typedef enum {
ASCII,
BIG_UCS2,
LITTLE_UCS2
} FILE_TYPE;
/**
Exchange the data between Efi variable and the data of VarList when the
variable use the authenticated variable header
If VarToList is TRUE, copy the efi variable data to the VarList; Otherwise,
update the data from varlist to efi variable.
@param VarToList The flag to control the direction of exchange.
@param StorageListHead Decide which variale list be updated
@retval EFI_SUCCESS Get the address successfully.
@retval EFI_OUT_OF_RESOURCES No available in the EFI variable zone.
@retval EFI_INVALID_PARAMETER Invalid variable name.
**/
EFI_STATUS
SynAuthEfiVariable (
IN BOOLEAN VarToList,
IN LIST_ENTRY *StorageListHead
);
/**
Remove the variable from Efi variable
Found the variable with the same name in StorageListHead and remove it.
@param StorageListHead Decide which variale list be removed.
@retval EFI_SUCCESS Remove the variables successfully.
**/
EFI_STATUS
RemoveAuthEfiVariable (
IN LIST_ENTRY *StorageListHead
);
/**
Exchange the data between Efi variable and the data of VarList when the
variable use the time stamp authenticated variable header
If VarToList is TRUE, copy the efi variable data to the VarList; Otherwise,
update the data from varlist to efi variable.
@param VarToList The flag to control the direction of exchange.
@param StorageListHead Decide which variale list be updated
@retval EFI_SUCCESS Get the address successfully.
@retval EFI_OUT_OF_RESOURCES No available in the EFI variable zone.
@retval EFI_INVALID_PARAMETER Invalid variable name.
**/
EFI_STATUS
SynAuthEfiVariableBasedTime (
IN BOOLEAN VarToList,
IN LIST_ENTRY *StorageListHead
);
/**
Remove the variable from Efi variable
Found the variable with the same name in StorageListHead and remove it.
@param StorageListHead Decide which variale list be removed.
@retval EFI_SUCCESS Remove the variables successfully.
**/
EFI_STATUS
RemoveAuthEfiVariableBasedTime (
IN LIST_ENTRY *StorageListHead
);
/**
Exchange the data between Efi variable and the data of VarList when the
variable use the authenticated variable header
If VarToList is TRUE, copy the efi variable data to the VarList; Otherwise,
update the data from varlist to efi variable.
@param VarToList The flag to control the direction of exchange.
@param StorageListHead Decide which variale list be updated
@retval EFI_SUCCESS Get the address successfully.
@retval EFI_OUT_OF_RESOURCES No available in the EFI variable zone.
**/
EFI_STATUS
SynEfiVariable (
IN BOOLEAN VarToList,
IN LIST_ENTRY *StorageListHead
);
/**
Remove the variable from Efi variable
Found the variable with the same name in StorageListHead and remove it.
@param StorageListHead Decide which variale list be removed.
@retval EFI_SUCCESS Remove the variables successfully.
**/
EFI_STATUS
RemoveNormalEfiVariable (
IN LIST_ENTRY *StorageListHead
);
/**
Read all defaultId and platformId from binary.
@param Binary The pointer to the bianry
@param Storage The pointer to the Storage
**/
VOID
ReadDefaultAndPlatformIdFromBfv (
IN UINT8 *Binary,
IN FORMSET_STORAGE *Storage
);
/**
Store all defaultId and platformId to binary.
@param Binary The pointer to the bianry
@param Storage The pointer to the Storage
@retval Length Return the length of the header
**/
UINT32
WriteDefaultAndPlatformId (
IN UINT8 *Binary,
IN FORMSET_STORAGE *Storage
);
/**
Store all defaultId and platformId to binary.
@param Binary The pointer to the bianry
@param Storage The pointer to the Storage
@retval Length Return the length of the header
**/
UINT32
WriteNvStoreDefaultAndPlatformId (
IN UINT8 *Binary,
IN FORMSET_STORAGE *Storage
);
/**
Copy variable to binary in multi-platform mode
@param Storage The pointer to a storage in storage list.
@param StorageBeginning The pointer to the beginning of storage under specifed platformId and defaultId
@param Index The number of the storage. If the Index is 0, record the variable header to
the binary. Or else, only record the storage.
@return length The length of storage
**/
UINT32
CopyVariableToBinary (
IN FORMSET_STORAGE *Storage,
IN OUT UINT8 *StorageBeginning,
IN UINT32 Index
);
/**
Copy variable to binary in multi-platform mode
@param Storage The pointer to a storage in storage list.
@param StorageBeginning The pointer to the beginning of storage under specifed platformId and defaultId
@param Index The number of the storage. If the Index is 0, record the variable header to
the binary. Or else, only record the storage.
@return length The length of storage
**/
UINT32
CopyVariableToNvStoreBinary (
IN FORMSET_STORAGE *Storage,
IN OUT UINT8 *StorageBeginning,
IN UINT32 Index
);
/**
Read variable to storage list in multi-platform mode
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param StorageListEntry The pointer to the storage list.
@return length The length of storage
**/
UINT32
ReadNvStoreVariableToList (
IN UINT8 *Binary,
IN LIST_ENTRY *StorageListEntry
);
/**
Read variable to storage list in multi-platform mode
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param StorageListEntry The pointer to the storage list.
@return length The length of storage
**/
UINT32
ReadVariableToList (
IN UINT8 *Binary,
IN LIST_ENTRY *StorageListEntry
);
/**
Check whether exists the valid normal variables in NvStorage or not.
@retval TRUE If existed, return TRUE.
@retval FALSE Others
**/
BOOLEAN
ExistNormalEfiVarOrNot (
IN LIST_ENTRY *StorageListHead
);
/**
Fix the size of variable header.
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param Length The length of binary.
**/
VOID
FixVariableHeaderSize (
IN UINT8 *BinaryBeginning,
IN UINT32 Length
);
/**
Fix the size of variable header.
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param Length The length of binary.
**/
VOID
FixNvStoreVariableHeaderSize (
IN UINT8 *BinaryBeginning,
IN UINT32 Length
);
/**
Copy time-based authenticated variable to binary in multi-platform mode
@param Storage The pointer to a storage in storage list.
@param StorageBeginning The pointer to the beginning of storage under specifed platformId and defaultId
@param Index The number of the storage. If the Index is 0, record the variable header to
the binary. Or else, only record the storage.
@return length The length of storage
**/
UINT32
CopyTimeBasedVariableToBinary (
IN FORMSET_STORAGE *Storage,
IN OUT UINT8 *StorageBeginning,
IN UINT32 Index
);
/**
Read time-based authenticated variable to storage list in multi-platform mode
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param StorageListEntry The pointer to the storage list.
@return length The length of storage
**/
UINT32
ReadTimeBasedVariableToList (
IN UINT8 *Binary,
IN LIST_ENTRY *StorageListEntry
);
/**
Check whether exists the valid time-based variables in NvStorage or not.
@retval TRUE If existed, return TRUE.
@retval FALSE Others
**/
BOOLEAN
ExistTimeBasedEfiVarOrNot (
IN LIST_ENTRY *StorageListHead
);
/**
Fix the size of time-based variable header.
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param Length The length of binary.
**/
VOID
FixBasedTimeVariableHeaderSize (
IN UINT8 *BinaryBeginning,
IN UINT32 Length
);
/**
Copy Monotonic-Based authenticated variable to binary in multi-platform mode
@param Storage The pointer to a storage in storage list.
@param StorageBeginning The pointer to the beginning of storage under specifed platformId and defaultId
@param Index The number of the storage. If the Index is 0, record the variable header to
the binary. Or else, only record the storage.
@return length The length of storage
**/
UINT32
CopyMonotonicBasedVariableToBinary (
IN FORMSET_STORAGE *Storage,
IN OUT UINT8 *StorageBeginning,
IN UINT32 Index
);
/**
Read Monotonic-based authenticated variable to storage list in multi-platform mode
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param StorageListEntry The pointer to the storage list.
@return length The length of storage
**/
UINT32
ReadMonotonicBasedVariableToList (
IN UINT8 *Binary,
IN LIST_ENTRY *StorageListEntry
);
/**
Check whether exists the valid MonotonicBased variables in NvStorage or not.
@retval TRUE If existed, return TRUE.
@retval FALSE Others
**/
BOOLEAN
ExistMonotonicBasedEfiVarOrNot (
IN LIST_ENTRY *StorageListHead
);
/**
Fix the size of montonic variable header.
@param Binary The pointer to the header of storage under specifed platformId and defaultId
@param Length The length of binary.
**/
VOID
FixMontonicVariableHeaderSize (
IN UINT8 *BinaryBeginning,
IN UINT32 Length
);
/**
FCE application entry point
@param argc The number of input parameters.
@param *argv[] The array pointer to the parameters.
@retval 0 The application exited normally.
@retval 1 An error occurred.
@retval 2 An error about check occurred.
**/
int
main (
int argc,
char *argv[]
);
#endif
|
