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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
|
/** @file
Copyright (c) 2024, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- Platform Security Firmware Update for the A-profile Specification 1.0
(https://developer.arm.com/documentation/den0118/latest)
@par Glossary:
- FW - Firmware
- FWU - Firmware Update
- FWS - Firmware Storage
- PSA - Platform Security update for the A-profile specification
- IFD - Image File Data
- IF - Image File
- IMG - Image
- MM - Management Mode
- PROP - Property
- Bkup, Bkp - Backup
**/
#ifndef FWS_METADATA_H_
#define FWS_METADATA_H_
#include <IndustryStandard/PsaMmFwUpdate.h>
#include "DiskGpt.h"
#define FWU_NUMBER_OF_BANKS FixedPcdGet32 (PcdFwuNumberOfBanks)
#define FWU_METADATA_PARTITION_NAME L"FWU-Metadata"
#define FWU_BKUP_METADATA_PARTITION_NAME L"Bkup-FWU-Metadata"
#define FWS_METADATA_FORMAT_V2 2
typedef struct FwsMetadata FWS_METADATA;
/** Enum value used in FWS_METADATA_SET_ACCEPT_STATE.
*/
typedef enum {
FwsImageUnAcceptReq, /// Set Image state as Unaccepted.
FwsImageAcceptReq, /// Set Image state as Accepted
FwsImageWriteUnAcceptReq, /// Set Image state as Unaccepted when starting write.
FwsAcceptReqMax,
} FWS_ACCEPT_REQ;
/**
Initialize and Load Firmware Update Store Metadata.
@param [in] GptHandle GptHandle
@param [out] FwsMetadata Firmware Update Store Metadata.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval EFI_OUT_OF_RESOURCES
@retval EFI_ABORTED Metadata is invalid.
@retval Others Failed to get metadata from gpt partition.
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_INIT_METADATA)(
IN GPT_PARTITION_HANDLE *GptHandle,
OUT FWS_METADATA **FwsMetadata
);
/**
Cleanup Loaded Firmware Update Store Metadata.
@param [in] FwsMetadata Firmware Update Store Metadata.
**/
typedef VOID (EFIAPI *FWS_METADATA_EXIT_METADATA)(
IN FWS_METADATA *FwsMetadata
);
/**
Get the number of banks.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] NumBanks Number of banks.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_NUM_BANKS)(
IN FWS_METADATA *FwsMetadata,
OUT UINT8 *NumBanks
);
/**
Get the number of images per bank.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] NumImages Number of images per bank.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_NUM_IMAGES)(
IN FWS_METADATA *FwsMetadata,
OUT UINT16 *NumImages
);
/**
Check trial state.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] TrialRunState If true, current is in the trial state.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_CHECK_TRIAL_RUN_STATE)(
IN FWS_METADATA *FwsMetadata,
OUT BOOLEAN *TrialRunState
);
/**
Get all image type guids.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] ImageTypeGuids Image type guid array.
@param [in,out] Size Byte size of @ImageTypeGuids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval EFI_BUFFER_TOO_SMALL Size of @ImageTypeGuids is too small to
contain all image type guids manged by
firmware update store.
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_IMAGE_TYPE_GUIDS)(
IN FWS_METADATA *FwsMetadata,
OUT EFI_GUID *ImageTypeGuids,
IN OUT UINT32 *Size
);
/**
Get location guid of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [out] LocationGuid Location Guids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_LOCATION_GUID)(
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
OUT EFI_GUID *LocationGuid
);
/**
Get image guid of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index.
@param [out] ImageGuid Image Guids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_IMAGE_GUID)(
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
OUT EFI_GUID *ImageGuid
);
/**
Get accept state of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index
@param [out] AcceptState If true, @ImageTypeGuid in the @BankIdx
is accepted.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_GET_ACCEPT_STATE)(
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
OUT BOOLEAN *AcceptState
);
/**
Set accept state of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index
@param [in] AcceptReq Type of request.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_SET_ACCEPT_STATE)(
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
IN FWS_ACCEPT_REQ AcceptReq
);
/**
Update bank state.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] BankIdx Bank Index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_UPDATE_BANK_STATE)(
IN FWS_METADATA *FwsMetadata,
IN UINT32 BankIdx
);
/**
Rollback metadata from @BackupIdx's one to @@TargetIdx's one
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] BackupIdx Backup Bank Index
@param [in] TargetIdx Target Bank Index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
typedef EFI_STATUS (EFIAPI *FWS_METADATA_ROLLBACK)(
IN FWS_METADATA *FwsMetadata,
IN UINT32 BackupIdx,
IN UINT32 TargetIdx
);
/** Firmware update storage metadata operation to handle metadata.
*/
typedef struct FwsMetadataOps {
/// Init firmware update storage metadata.
FWS_METADATA_INIT_METADATA InitMetadata;
/// Cleanup firmware update storage metadata.
FWS_METADATA_EXIT_METADATA ExitMetadata;
/// Get Number of banks.
FWS_METADATA_GET_NUM_BANKS GetNumBanks;
/// Get Number of images per bank.
FWS_METADATA_GET_NUM_IMAGES GetNumImages;
/// Check whether trial state or not.
FWS_METADATA_CHECK_TRIAL_RUN_STATE CheckTrialRunState;
/// Get all image type guids managed by firmware update storage.
FWS_METADATA_GET_IMAGE_TYPE_GUIDS GetImageTypeGuids;
/// Get location guid.
FWS_METADATA_GET_LOCATION_GUID GetLocationGuid;
/// Get image guid.
FWS_METADATA_GET_IMAGE_GUID GetImageGuid;
/// Get accept state.
FWS_METADATA_GET_ACCEPT_STATE GetAcceptState;
/// Set accept state.
FWS_METADATA_SET_ACCEPT_STATE SetAcceptState;
/// Update bank state.
FWS_METADATA_UPDATE_BANK_STATE UpdateBankState;
/// Rollback firmware update storage metadata.
FWS_METADATA_ROLLBACK RollBack;
} FWS_METADATA_OPS;
typedef struct FwsMetadata {
/// Gpt Handle
GPT_PARTITION_HANDLE *GptHandle;
/// active Metadata Lba.
EFI_LBA ActiveLba;
/// Backup Metadata Lba.
EFI_LBA BackupLba;
/// Firmware Store Metadata
VOID *Metadata;
/// Firmware Store Metadata Size
UINT32 MetadataSize;
/// Metadata operation
FWS_METADATA_OPS *FwsMetadataOps;
} FWS_METADATA;
/// Firmware update storage metadata version 2 operation.
extern FWS_METADATA_OPS gFwsMetadataV2Ops;
/**
Matching function used to find out Firmware Update Metadata GPT partition.
@param [in] PartitionEntry GPT partition.
@param [in] Data Partition Name.
@retval TRUE Found.
@retval FALSE Not found.
**/
BOOLEAN
MatchedMetaDataPartition (
IN CONST EFI_PARTITION_ENTRY *PartitionEntry,
IN CONST VOID *Data
);
/**
Check CRC32 of the FWU metadata against the CRC32 value
present in the FWU metadata.
@param [in] FwsMetadata Firmware Update Store Metadata.
@retval EFI_SUCCESS The CRC is valid.
@retval EFI_CRC_ERROR The CRC is invalid.
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataCrcCheck (
IN FWS_METADATA *FwsMetadata
);
/**
Save FWU metadata structure to GPT partition.
@param [in] FwsMetadata Firmware Update Store Metadata.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval Others Failed to write metadata to GPT partition.
**/
EFI_STATUS
EFIAPI
FwsMetadataSave (
IN FWS_METADATA *FwsMetadata
);
/**
Get active bank index.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] ActiveIndex Active bank index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetActiveIndex (
IN FWS_METADATA *FwsMetadata,
UINT32 *ActiveIndex
);
/**
Set active bank index.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ActiveIndex Active bank index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataSetActiveIndex (
IN FWS_METADATA *FwsMetadata,
UINT32 ActiveIndex
);
/**
Get previous active bank index.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] PreviousActiveIndex Previous Active bank index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetPreviousActiveIndex (
IN FWS_METADATA *FwsMetadata,
UINT32 *PreviousActiveIndex
);
/**
Set previous active bank index.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] PreviousActiveIndex Previous Active bank index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataSetPreviousActiveIndex (
IN FWS_METADATA *FwsMetadata,
UINT32 PreviousActiveIndex
);
/**
Initialize and Load Firmware Update Store Metadata.
@param [in] GptHandle GptHandle
@param [out] FwsMetadata Firmware Update Store Metadata.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval EFI_OUT_OF_RESOURCES
@retval EFI_ABORTED Metadata is invalid.
@retval Others Failed to get metadata from gpt partition.
**/
EFI_STATUS
EFIAPI
FwsMetadataInit (
IN GPT_PARTITION_HANDLE *GptHandle,
OUT FWS_METADATA **FwsMetadata
);
/**
Cleanup Loaded Firmware Update Store Metadata.
@param [in] FwsMetadata Firmware Update Store Metadata.
**/
VOID
EFIAPI
FwsMetadataExit (
IN FWS_METADATA *FwsMetadata
);
/**
Get the number of banks.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] NumBanks Number of banks.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetNumBanks (
IN FWS_METADATA *FwsMetadata,
OUT UINT8 *NumBanks
);
/**
Get the number of images per bank.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] NumImages Number of images per bank.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetNumImages (
IN FWS_METADATA *FwsMetadata,
OUT UINT16 *NumImages
);
/**
Check trial state.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] TrialRunState If true, current is in the trial state.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataCheckTrialRunState (
IN FWS_METADATA *FwsMetadata,
OUT BOOLEAN *TrialRunState
);
/**
Get all image type guids.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [out] ImageTypeGuids Image type guid array.
@param [in,out] Size Byte size of @ImageTypeGuids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
@retval EFI_BUFFER_TOO_SMALL Size of @ImageTypeGuids is too small to
contain all image type guids manged by
firmware update store.
**/
EFI_STATUS
EFIAPI
FwsMetadataGetImageTypeGuids (
IN FWS_METADATA *FwsMetadata,
OUT EFI_GUID *ImageTypeGuids,
IN OUT UINT32 *Size
);
/**
Get location guid of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [out] LocationGuid Location Guids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetLocationGuid (
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
OUT EFI_GUID *LocationGuid
);
/**
Get image guid of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index.
@param [out] ImageGuid Image Guids.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetImageGuid (
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
OUT EFI_GUID *ImageGuid
);
/**
Get accept state of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index
@param [out] AcceptState If true, @ImageTypeGuid in the @BankIdx
is accepted.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataGetAcceptState (
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
OUT BOOLEAN *AcceptState
);
/**
Set accept state of image type guid.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] ImageTypeGuid Image type guid.
@param [in] BankIdx Bank Index
@param [in] AcceptReq Type of request.
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataSetAcceptState (
IN FWS_METADATA *FwsMetadata,
IN CONST EFI_GUID *ImageTypeGuid,
IN UINT32 BankIdx,
IN FWS_ACCEPT_REQ AcceptReq
);
/**
Update bank state.
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] BankIdx Bank Index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataUpdateBankState (
IN FWS_METADATA *FwsMetadata,
IN UINT32 BankIdx
);
/**
Rollback metadata from @BackupIdx's one to @@TargetIdx's one
@param [in] FwsMetadata Firmware Update Store Metadata.
@param [in] BackupIdx Backup Bank Index
@param [in] TargetIdx Target Bank Index
@retval EFI_SUCCESS
@retval EFI_INVALID_PARAMETER
**/
EFI_STATUS
EFIAPI
FwsMetadataRollBack (
IN FWS_METADATA *FwsMetadata,
IN UINT32 BackupIdx,
IN UINT32 TargetIdx
);
#endif
|
