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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
|
/** @file
Library that implements the helper functions to parse and pack a Transfer
List as specified by the A-profile Firmware Handoff Specification.
Copyright (c) 2022 - 2025, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Reference(s):
- https://github.com/FirmwareHandoff/firmware_handoff
**/
#include <Base.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <libtl/include/transfer_list.h>
#include <Library/ArmTransferListLib.h>
#include <Library/HobLib.h>
typedef struct transfer_list_header LIBTL_TRANSFER_LIST_HEADER;
typedef struct transfer_list_entry LIBTL_TRANSFER_LIST_ENTRY;
STATIC_ASSERT (
sizeof (TRANSFER_LIST_HEADER) == sizeof (LIBTL_TRANSFER_LIST_HEADER),
"TRANSFER_LIST_HEADER size mismatch"
);
STATIC_ASSERT (
sizeof (TRANSFER_ENTRY_HEADER) == sizeof (LIBTL_TRANSFER_LIST_ENTRY),
"TRANSFER_ENTRY_HEADER size mismatch"
);
STATIC_ASSERT (
OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog) == sizeof (UINT32),
"TRANSFER_LIST_EVENTLOG layout mismatch"
);
//
// TransferListCheckHeader() casts the libtl operation value directly to
// TRANSFER_LIST_OPS, so verify both enum definitions stay numerically aligned.
//
STATIC_ASSERT (
(UINT32)TL_OPS_NON == (UINT32)TRANSFER_LIST_OPS_INVALID,
"TL_OPS_NON mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_ALL == (UINT32)TRANSFER_LIST_OPS_ALL,
"TL_OPS_ALL mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_RO == (UINT32)TRANSFER_LIST_OPS_RO,
"TL_OPS_RO mismatch"
);
STATIC_ASSERT (
(UINT32)TL_OPS_CUS == (UINT32)TRANSFER_LIST_OPS_CUSTOM,
"TL_OPS_CUS mismatch"
);
/**
Convert a libtl transfer entry address to the public transfer entry type.
libtl marks the entry structure as packed for layout, while the transfer list
format keeps entries 8-byte aligned.
@param[in] Entry libtl entry address, or NULL.
@return Transfer entry header address, or NULL.
**/
STATIC
TRANSFER_ENTRY_HEADER *
LibtlEntryToTransferEntryHeader (
IN VOID *Entry
)
{
ASSERT ((Entry == NULL) || (((UINTN)Entry & (TRANSFER_LIST_ALIGNMENT - 1)) == 0));
return (TRANSFER_ENTRY_HEADER *)Entry;
}
/**
Get the TransferList from HOB list.
@param[out] TransferList TransferList
@retval EFI_SUCCESS TransferList is found.
@retval EFI_INVALID_PARAMETER TransferList is NULL.
@retval EFI_NOT_FOUND TransferList is not found.
**/
EFI_STATUS
EFIAPI
TransferListGetFromHobList (
OUT TRANSFER_LIST_HEADER **TransferList
)
{
VOID *HobList;
EFI_HOB_GUID_TYPE *GuidHob;
UINTN *GuidHobData;
if (TransferList == NULL) {
return EFI_INVALID_PARAMETER;
}
*TransferList = NULL;
HobList = GetHobList ();
if (HobList == NULL) {
return EFI_NOT_FOUND;
}
GuidHob = GetNextGuidHob (&gArmTransferListHobGuid, HobList);
if (GuidHob == NULL) {
return EFI_NOT_FOUND;
}
GuidHobData = GET_GUID_HOB_DATA (GuidHob);
*TransferList = (TRANSFER_LIST_HEADER *)(*GuidHobData);
return EFI_SUCCESS;
}
/**
This function verifies the checksum of the Transfer List.
@param [in] TransferListHeader Pointer to the Transfer List Header
@retval FALSE Invalid Checksum
@retval TRUE Valid Checksum
**/
BOOLEAN
EFIAPI
TransferListVerifyChecksum (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return transfer_list_verify_checksum ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
}
/**
Check the Transfer List header and return an operation mode.
This function forwards to transfer_list_check_header() (libtl) and converts
the returned libtl operation code into the TRANSFER_LIST_OPS enum.
@param[in] TransferListHeader Pointer to the Transfer List header.
@retval TRANSFER_LIST_OPS_ALL Header is valid and usable (read/write).
@retval TRANSFER_LIST_OPS_RO Header is valid but only supports read-only
operations.
@retval TRANSFER_LIST_OPS_CUSTOM Header is valid but requires custom handling
due to a version mismatch.
@retval TRANSFER_LIST_OPS_INVALID Header is invalid or unsupported.
**/
TRANSFER_LIST_OPS
EFIAPI
TransferListCheckHeader (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return (TRANSFER_LIST_OPS)transfer_list_check_header ((CONST LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
}
/**
Return the first Transfer Entry Node in the Transfer List.
@param [in] TransferListHeader TransferListHeader
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetFirstEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_next ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, NULL)
);
}
/**
Return the next Transfer Entry Node in the Transfer List from
last Transfer Entry Node.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] CurrentEntry Pointer to the Current Transfer Entry.
If this is NULL, the first Transfer Entry
is returned.
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetNextEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN TRANSFER_ENTRY_HEADER *CurrentEntry
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_next (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)CurrentEntry
)
);
}
/**
Return the first Transfer Entry Node in the Transfer List
matched with given tag-id.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindFirstEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_find ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, TagId)
);
}
/**
Return the Next Transfer Entry Node in the Transfer List
matched with given tag-id from last Transfer Entry Node.
@param [in] TransferListHeader Pointer to the Transfer List Header.
@param [in] CurrentEntry Pointer to the Current Transfer Entry.
If this is NULL, the first Transfer Entry
is returned.
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindNextEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN TRANSFER_ENTRY_HEADER *CurrentEntry,
IN UINT32 TagId
)
{
TRANSFER_ENTRY_HEADER *Entry;
if (CurrentEntry == NULL) {
return TransferListFindFirstEntry (TransferListHeader, TagId);
} else {
Entry = TransferListGetNextEntry (TransferListHeader, CurrentEntry);
}
while ((Entry != NULL) && ((Entry->TagId & TRANSFER_LIST_TAGID_MASK) != (TagId & TRANSFER_LIST_TAGID_MASK))) {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
}
return Entry;
}
/**
Return the data in Transfer Entry.
@param [in] TransferEntry Pointer to a Transfer Entry Header
@return Pointer to the Data of Transfer Entry Node if successful otherwise NULL
**/
VOID *
EFIAPI
TransferListGetEntryData (
IN TRANSFER_ENTRY_HEADER *TransferEntry
)
{
if ((TransferEntry == NULL) || (TransferEntry->DataSize == 0)) {
return NULL;
}
return transfer_list_entry_data ((LIBTL_TRANSFER_LIST_ENTRY *)TransferEntry);
}
/**
Find a Transfer Entry Node in the Transfer List matched with the given tag-id.
@param [in] TransferListHeader Pointer to the Transfer List Header
@param [in] TagId Tag id
@return Pointer to the Transfer Entry Node if successful otherwise NULL
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindEntry (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
TRANSFER_ENTRY_HEADER *Entry;
Entry = NULL;
do {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
} while ((Entry != NULL) && ((Entry->TagId & TRANSFER_LIST_TAGID_MASK) != (TagId & TRANSFER_LIST_TAGID_MASK)));
return Entry;
}
/**
Get TPM event log from the Transfer List.
@param [in] TransferListHeader Pointer to the Transfer List Header
@param [out] EventLog Pointer to the event log in TransferList
@param [out] EventLogSize Size of Event log
@param [out] EventLogFlags Flags for Event log
@return EFI_SUCCESS
@return EFI_NOT_FOUND No Event log in TransferListHeader
@return EFI_INVALID_PARAMETER Invalid parameters
**/
EFI_STATUS
EFIAPI
TransferListGetEventLog (
IN TRANSFER_LIST_HEADER *TransferListHeader,
OUT VOID **EventLog,
OUT UINTN *EventLogSize,
OUT UINT32 *EventLogFlags OPTIONAL
)
{
TRANSFER_ENTRY_HEADER *Entry;
TRANSFER_LIST_EVENTLOG *EntryData;
if ((TransferListHeader == NULL) || (EventLog == NULL) || (EventLogSize == NULL)) {
return EFI_INVALID_PARAMETER;
}
*EventLog = NULL;
*EventLogSize = 0;
Entry = TransferListFindFirstEntry (TransferListHeader, TRANSFER_ENTRY_TAG_ID_TPM_EVENT_LOG);
if ((Entry == NULL) || (Entry->DataSize == 0) ||
((Entry->DataSize - OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog)) == 0))
{
return EFI_NOT_FOUND;
}
EntryData = TransferListGetEntryData (Entry);
if (EventLogFlags != NULL) {
*EventLogFlags = EntryData->Flags;
}
*EventLogSize = Entry->DataSize - OFFSET_OF (TRANSFER_LIST_EVENTLOG, EventLog);
*EventLog = (VOID *)&EntryData->EventLog;
return EFI_SUCCESS;
}
/**
Dump the transfer list to the debug output.
@param [in] TransferListHeader Pointer to the Transfer List Header
**/
VOID
EFIAPI
TransferListDump (
IN TRANSFER_LIST_HEADER *TransferListHeader
)
{
TRANSFER_ENTRY_HEADER *Entry;
UINTN Idx;
Entry = NULL;
Idx = 0;
if (TransferListHeader == NULL) {
return;
}
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Dump transfer list:\n"));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "signature 0x%x\n", TransferListHeader->Signature));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "checksum 0x%x\n", TransferListHeader->Checksum));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "version 0x%x\n", TransferListHeader->Version));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "hdr_size 0x%x\n", TransferListHeader->HeaderSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "alignment 0x%x\n", TransferListHeader->Alignment));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "used_size 0x%x\n", TransferListHeader->UsedSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "total_size 0x%x\n", TransferListHeader->TotalSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "flags 0x%x\n", TransferListHeader->Flags));
while (TRUE) {
Entry = TransferListGetNextEntry (TransferListHeader, Entry);
if (Entry == NULL) {
break;
}
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Entry %d:\n", Idx++));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "tag_id 0x%x\n", Entry->TagId));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "hdr_size 0x%x\n", Entry->HeaderSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "data_size 0x%x\n", Entry->DataSize));
DEBUG ((DEBUG_INFO | DEBUG_LOAD, "data_addr 0x%lx\n", (UINTN)TransferListGetEntryData (Entry)));
}
}
/**
Ensure a valid Transfer List exists at the specified buffer; initialize
if the buffer does not have a valid TL header.
@param[in,out] TransferListBase Base address of the buffer/region.
@param[in] TransferListCapacity Total capacity (bytes) of the buffer.
@return Pointer to the Transfer List header on success; NULL on failure.
**/
TRANSFER_LIST_HEADER *
EFIAPI
TransferListEnsure (
IN OUT VOID *TransferListBase,
IN UINTN TransferListCapacity
)
{
return (TRANSFER_LIST_HEADER *)transfer_list_ensure (TransferListBase, (size_t)TransferListCapacity);
}
/**
Relocate an existing Transfer List to a new buffer with the given capacity.
Useful when the Transfer List must grow beyond its current region (e.g., when
backed by a fixed flash window).
@param[in] TransferListHeader Pointer to the current Transfer List header.
@param[out] DestinationBase Destination buffer address.
@param[in] DestinationCapacity Capacity in bytes of the destination buffer.
@return Pointer to the relocated Transfer List header; NULL on failure.
**/
TRANSFER_LIST_HEADER *
EFIAPI
TransferListRelocate (
IN TRANSFER_LIST_HEADER *TransferListHeader,
OUT VOID *DestinationBase,
IN UINTN DestinationCapacity
)
{
return (TRANSFER_LIST_HEADER *)transfer_list_relocate (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
DestinationBase,
(size_t)DestinationCapacity
);
}
/**
Append a new Transfer Entry.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full (up to 24-bit) tag identifier.
@param[in] DataSize Payload size in bytes.
@param[in] Data Optional source buffer (may be NULL).
@retval NULL Append failed (e.g., insufficient capacity).
@retval non-NULL Pointer to the newly added entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListAdd (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
IN UINT32 DataSize,
IN CONST VOID *Data OPTIONAL
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_add (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
Data
)
);
}
/**
Resize an existing Transfer Entry payload.
On growth, subsequent entries may be moved to make room. On shrink, space is
reclaimed. Call TransferListUpdateChecksum() after modifications.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in,out] Entry Entry to resize.
@param[in] NewDataSize New payload size in bytes.
@retval TRUE Resize succeeded; Entry remains valid.
@retval FALSE Resize failed (e.g., insufficient capacity).
**/
BOOLEAN
EFIAPI
TransferListSetDataSize (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN OUT TRANSFER_ENTRY_HEADER *Entry,
IN UINT32 NewDataSize
)
{
return transfer_list_set_data_size (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry,
NewDataSize
) ? TRUE : FALSE;
}
/**
Remove a Transfer Entry.
After removal, the Transfer List is compacted as required by the underlying
implementation. Call TransferListUpdateChecksum() if not done automatically.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in,out] Entry Entry to remove.
@retval TRUE Entry removed.
@retval FALSE Removal failed.
**/
BOOLEAN
EFIAPI
TransferListRemove (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN OUT TRANSFER_ENTRY_HEADER *Entry
)
{
return transfer_list_rem (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry
) ? TRUE : FALSE;
}
/**
Optional reverse iterator: return the previous entry.
@param[in] TransferListHeader TL header.
@param[in] CurrentEntry Current entry.
@retval NULL No previous entry.
@retval non-NULL Previous entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListGetPrevEntry (
TRANSFER_LIST_HEADER *TransferListHeader,
TRANSFER_ENTRY_HEADER *CurrentEntry
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_prev (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)CurrentEntry
)
);
}
/**
Find the first Transfer Entry whose full TagId (up to 24 bits) matches.
This is a thin wrapper over the underlying implementation. It returns the
first matching entry, or NULL if no match exists.
@param[in] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to match.
@retval NULL No matching entry or TransferListHeader is NULL.
@retval non-NULL Pointer to the first matching entry.
**/
TRANSFER_ENTRY_HEADER *
EFIAPI
TransferListFindEntryByTag (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId
)
{
return LibtlEntryToTransferEntryHeader (
transfer_list_find ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader, TagId)
);
}
/**
Read the first entry matching the full TagId (up to 24-bit).
@param[in] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to match.
@param[out] EntryOut On success, receives the entry pointer.
@param[out] EntryDataOut Optional; receives pointer to entry data.
@param[out] EntryDataSizeOut Optional; receives data size in bytes.
@retval EFI_SUCCESS Match found and output parameters set.
@retval EFI_NOT_FOUND No entry with TagId.
@retval EFI_INVALID_PARAMETER TransferListHeader or EntryOut is NULL.
**/
EFI_STATUS
EFIAPI
TransferListReadEntryByTag (
IN TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
OUT TRANSFER_ENTRY_HEADER **EntryOut,
OUT VOID **EntryDataOut OPTIONAL,
OUT UINT32 *EntryDataSizeOut OPTIONAL
)
{
TRANSFER_ENTRY_HEADER *Entry;
if ((TransferListHeader == NULL) || (EntryOut == NULL)) {
return EFI_INVALID_PARAMETER;
}
Entry = TransferListFindEntryByTag (TransferListHeader, TagId);
if (Entry == NULL) {
return EFI_NOT_FOUND;
}
*EntryOut = Entry;
if (EntryDataOut != NULL) {
*EntryDataOut = TransferListGetEntryData (Entry);
}
if (EntryDataSizeOut != NULL) {
*EntryDataSizeOut = Entry->DataSize;
}
return EFI_SUCCESS;
}
/**
Update (or create) an entry by TagId.
If an entry with TagId exists, it is resized if needed and the payload is
overwritten with Data (if Data is not NULL). If no entry exists and
CreateIfMissing is TRUE, a new entry is appended (aligned to Alignment if
non-zero). The Transfer List checksum is updated on success.
@param[in,out] TransferListHeader Pointer to the Transfer List header.
@param[in] TagId Full tag identifier to update.
@param[in] Data Source buffer (may be NULL to only resize).
@param[in] DataSize Size of Data in bytes.
@param[in] CreateIfMissing If TRUE, create the entry when missing.
@param[in] AlignmentLog2 Optional power-of-two alignment (0 to use default).
@retval EFI_SUCCESS Entry updated or created.
@retval EFI_NOT_FOUND Entry not found and CreateIfMissing is FALSE.
@retval EFI_BUFFER_TOO_SMALL Not enough capacity to add/resize.
@retval EFI_INVALID_PARAMETER TransferListHeader is NULL.
**/
EFI_STATUS
EFIAPI
TransferListUpdateEntryByTag (
IN OUT TRANSFER_LIST_HEADER *TransferListHeader,
IN UINT32 TagId,
IN CONST VOID *Data OPTIONAL,
IN UINT32 DataSize,
IN BOOLEAN CreateIfMissing,
IN UINT8 AlignmentLog2
)
{
TRANSFER_ENTRY_HEADER *Entry;
VOID *EntryData;
if (TransferListHeader == NULL) {
return EFI_INVALID_PARAMETER;
}
Entry = TransferListFindEntryByTag (TransferListHeader, TagId);
if (Entry == NULL) {
if (!CreateIfMissing) {
return EFI_NOT_FOUND;
}
if (AlignmentLog2 != 0) {
Entry = LibtlEntryToTransferEntryHeader (
transfer_list_add_with_align (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
NULL,
AlignmentLog2
)
);
} else {
Entry = LibtlEntryToTransferEntryHeader (
transfer_list_add (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
TagId,
DataSize,
NULL
)
);
}
if (Entry == NULL) {
return EFI_BUFFER_TOO_SMALL;
}
} else if (Entry->DataSize != DataSize) {
if (!(transfer_list_set_data_size (
(LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader,
(LIBTL_TRANSFER_LIST_ENTRY *)Entry,
DataSize
))
)
{
return EFI_BUFFER_TOO_SMALL;
}
}
if ((Data != NULL) && (DataSize != 0)) {
EntryData = transfer_list_entry_data ((LIBTL_TRANSFER_LIST_ENTRY *)Entry);
CopyMem (EntryData, Data, DataSize);
}
transfer_list_update_checksum ((LIBTL_TRANSFER_LIST_HEADER *)TransferListHeader);
return EFI_SUCCESS;
}
|