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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
|
/** @file
Implements functions to pad firmware file.
Copyright (c) 2006 - 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 which 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 "FwVolDriver.h"
/**
Calculate the checksum for a PAD file.
@param PadFileHeader The Pad File to be caculeted the checksum.
**/
VOID
SetPadFileChecksum (
IN EFI_FFS_FILE_HEADER *PadFileHeader
)
{
if ((PadFileHeader->Attributes & FFS_ATTRIB_CHECKSUM) != 0) {
if (IS_FFS_FILE2 (PadFileHeader)) {
//
// Calculate checksum of Pad File Data
//
PadFileHeader->IntegrityCheck.Checksum.File =
CalculateCheckSum8 ((UINT8 *) PadFileHeader + sizeof (EFI_FFS_FILE_HEADER2), FFS_FILE2_SIZE (PadFileHeader) - sizeof (EFI_FFS_FILE_HEADER2));
} else {
//
// Calculate checksum of Pad File Data
//
PadFileHeader->IntegrityCheck.Checksum.File =
CalculateCheckSum8 ((UINT8 *) PadFileHeader + sizeof (EFI_FFS_FILE_HEADER), FFS_FILE_SIZE (PadFileHeader) - sizeof (EFI_FFS_FILE_HEADER));
}
} else {
PadFileHeader->IntegrityCheck.Checksum.File = FFS_FIXED_CHECKSUM;
}
return ;
}
/**
Create a PAD File in the Free Space.
@param FvDevice Firmware Volume Device.
@param FreeSpaceEntry Indicating in which Free Space(Cache) the Pad file will be inserted.
@param Size Pad file Size, not include the header.
@param PadFileEntry The Ffs File Entry that points to this Pad File.
@retval EFI_SUCCESS Successfully create a PAD file.
@retval EFI_OUT_OF_RESOURCES No enough free space to create a PAD file.
@retval EFI_INVALID_PARAMETER Size is not 8 byte alignment.
@retval EFI_DEVICE_ERROR Free space is not erased.
**/
EFI_STATUS
FvCreatePadFileInFreeSpace (
IN FV_DEVICE *FvDevice,
IN FREE_SPACE_ENTRY *FreeSpaceEntry,
IN UINTN Size,
OUT FFS_FILE_LIST_ENTRY **PadFileEntry
)
{
EFI_STATUS Status;
EFI_FFS_FILE_HEADER *PadFileHeader;
UINTN Offset;
UINTN NumBytesWritten;
UINTN StateOffset;
UINT8 *StartPos;
FFS_FILE_LIST_ENTRY *FfsFileEntry;
UINTN HeaderSize;
UINTN FileSize;
HeaderSize = sizeof (EFI_FFS_FILE_HEADER);
FileSize = Size + HeaderSize;
if (FileSize > 0x00FFFFFF) {
HeaderSize = sizeof (EFI_FFS_FILE_HEADER2);
FileSize = Size + HeaderSize;
}
if (FreeSpaceEntry->Length < FileSize) {
return EFI_OUT_OF_RESOURCES;
}
if ((Size & 0x07) != 0) {
return EFI_INVALID_PARAMETER;
}
StartPos = FreeSpaceEntry->StartingAddress;
//
// First double check the space
//
if (!IsBufferErased (
FvDevice->ErasePolarity,
StartPos,
FileSize
)) {
return EFI_DEVICE_ERROR;
}
PadFileHeader = (EFI_FFS_FILE_HEADER *) StartPos;
//
// Create File Step 1
//
SetFileState (EFI_FILE_HEADER_CONSTRUCTION, PadFileHeader);
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
StateOffset = Offset + (UINT8 *) &PadFileHeader->State - (UINT8 *) PadFileHeader;
NumBytesWritten = sizeof (EFI_FFS_FILE_STATE);
Status = FvcWrite (
FvDevice,
StateOffset,
&NumBytesWritten,
&PadFileHeader->State
);
if (EFI_ERROR (Status)) {
SetFileState (EFI_FILE_HEADER_CONSTRUCTION, PadFileHeader);
return Status;
}
//
// Update Free Space Entry, since header is allocated
//
FreeSpaceEntry->Length -= HeaderSize;
FreeSpaceEntry->StartingAddress += HeaderSize;
//
// Fill File Name Guid, here we assign a NULL-GUID to Pad files
//
ZeroMem (&PadFileHeader->Name, sizeof (EFI_GUID));
//
// Fill File Type, checksum(0), Attributes(0), Size
//
PadFileHeader->Type = EFI_FV_FILETYPE_FFS_PAD;
PadFileHeader->Attributes = 0;
if ((FileSize) > 0x00FFFFFF) {
((EFI_FFS_FILE_HEADER2 *) PadFileHeader)->ExtendedSize = (UINT32) FileSize;
*(UINT32 *) PadFileHeader->Size &= 0xFF000000;
PadFileHeader->Attributes |= FFS_ATTRIB_LARGE_FILE;
} else {
*(UINT32 *) PadFileHeader->Size &= 0xFF000000;
*(UINT32 *) PadFileHeader->Size |= FileSize;
}
SetHeaderChecksum (PadFileHeader);
SetPadFileChecksum (PadFileHeader);
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
NumBytesWritten = HeaderSize;
Status = FvcWrite (
FvDevice,
Offset,
&NumBytesWritten,
(UINT8 *) PadFileHeader
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Step 2, then Mark header valid, since no data write,
// mark the data valid at the same time.
//
SetFileState (EFI_FILE_HEADER_VALID, PadFileHeader);
SetFileState (EFI_FILE_DATA_VALID, PadFileHeader);
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
StateOffset = Offset + (UINT8 *) &PadFileHeader->State - (UINT8 *) PadFileHeader;
NumBytesWritten = sizeof (EFI_FFS_FILE_STATE);
Status = FvcWrite (
FvDevice,
StateOffset,
&NumBytesWritten,
&PadFileHeader->State
);
if (EFI_ERROR (Status)) {
SetFileState (EFI_FILE_HEADER_VALID, PadFileHeader);
SetFileState (EFI_FILE_DATA_VALID, PadFileHeader);
return Status;
}
//
// Update Free Space Entry, since header is allocated
//
FreeSpaceEntry->Length -= Size;
FreeSpaceEntry->StartingAddress += Size;
//
// If successfully, insert an FfsFileEntry at the end of ffs file list
//
FfsFileEntry = AllocateZeroPool (sizeof (FFS_FILE_LIST_ENTRY));
ASSERT (FfsFileEntry != NULL);
FfsFileEntry->FfsHeader = (UINT8 *) (UINTN) StartPos;
InsertTailList (&FvDevice->FfsFileListHeader, &FfsFileEntry->Link);
*PadFileEntry = FfsFileEntry;
FvDevice->CurrentFfsFile = FfsFileEntry;
return EFI_SUCCESS;
}
/**
Fill pad file header within firmware cache.
@param PadFileHeader The start of the Pad File Buffer.
@param PadFileLength The length of the pad file including the header.
**/
VOID
FvFillPadFile (
IN EFI_FFS_FILE_HEADER *PadFileHeader,
IN UINTN PadFileLength
)
{
//
// Fill File Name Guid, here we assign a NULL-GUID to Pad files
//
ZeroMem (&PadFileHeader->Name, sizeof (EFI_GUID));
//
// Fill File Type, checksum(0), Attributes(0), Size
//
PadFileHeader->Type = EFI_FV_FILETYPE_FFS_PAD;
PadFileHeader->Attributes = 0;
if (PadFileLength > 0x00FFFFFF) {
((EFI_FFS_FILE_HEADER2 *) PadFileHeader)->ExtendedSize = (UINT32) PadFileLength;
*(UINT32 *) PadFileHeader->Size &= 0xFF000000;
PadFileHeader->Attributes |= FFS_ATTRIB_LARGE_FILE;
} else {
*(UINT32 *) PadFileHeader->Size &= 0xFF000000;
*(UINT32 *) PadFileHeader->Size |= PadFileLength;
}
SetHeaderChecksum (PadFileHeader);
SetPadFileChecksum (PadFileHeader);
//
// Set File State to 0x00000111
//
SetFileState (EFI_FILE_HEADER_CONSTRUCTION, PadFileHeader);
SetFileState (EFI_FILE_HEADER_VALID, PadFileHeader);
SetFileState (EFI_FILE_DATA_VALID, PadFileHeader);
return ;
}
/**
Create entire FFS file.
@param FileHeader Starting Address of a Buffer that hold the FFS File image.
@param FfsFileBuffer The source buffer that contains the File Data.
@param BufferSize The length of FfsFileBuffer.
@param ActualFileSize Size of FFS file.
@param FileName The Guid of Ffs File.
@param FileType The type of the written Ffs File.
@param FileAttributes The attributes of the written Ffs File.
@retval EFI_INVALID_PARAMETER File type is not valid.
@retval EFI_SUCCESS FFS file is successfully created.
**/
EFI_STATUS
FvFillFfsFile (
OUT EFI_FFS_FILE_HEADER *FileHeader,
IN UINT8 *FfsFileBuffer,
IN UINTN BufferSize,
IN UINTN ActualFileSize,
IN EFI_GUID *FileName,
IN EFI_FV_FILETYPE FileType,
IN EFI_FV_FILE_ATTRIBUTES FileAttributes
)
{
EFI_FFS_FILE_ATTRIBUTES TmpFileAttribute;
EFI_FFS_FILE_HEADER *TmpFileHeader;
//
// File Type value 0x0E~0xE0 are reserved
//
if ((FileType > EFI_FV_FILETYPE_SMM_CORE) && (FileType < 0xE0)) {
return EFI_INVALID_PARAMETER;
}
TmpFileHeader = (EFI_FFS_FILE_HEADER *) FfsFileBuffer;
//
// First fill all fields ready in FfsFileBuffer
//
CopyGuid (&TmpFileHeader->Name, FileName);
TmpFileHeader->Type = FileType;
//
// Convert the FileAttributes to FFSFileAttributes
//
FvFileAttrib2FfsFileAttrib (FileAttributes, &TmpFileAttribute);
TmpFileHeader->Attributes = TmpFileAttribute;
if (ActualFileSize > 0x00FFFFFF) {
((EFI_FFS_FILE_HEADER2 *) FileHeader)->ExtendedSize = (UINT32) ActualFileSize;
*(UINT32 *) FileHeader->Size &= 0xFF000000;
FileHeader->Attributes |= FFS_ATTRIB_LARGE_FILE;
} else {
*(UINT32 *) FileHeader->Size &= 0xFF000000;
*(UINT32 *) FileHeader->Size |= ActualFileSize;
}
SetHeaderChecksum (TmpFileHeader);
SetFileChecksum (TmpFileHeader, ActualFileSize);
SetFileState (EFI_FILE_HEADER_CONSTRUCTION, TmpFileHeader);
SetFileState (EFI_FILE_HEADER_VALID, TmpFileHeader);
SetFileState (EFI_FILE_DATA_VALID, TmpFileHeader);
//
// Copy data from FfsFileBuffer to FileHeader(cache)
//
CopyMem (FileHeader, FfsFileBuffer, BufferSize);
return EFI_SUCCESS;
}
/**
Fill some other extra space using 0xFF(Erase Value).
@param ErasePolarity Fv erase value.
@param FileHeader Point to the start of FFS File.
@param ExtraLength The pading length.
**/
VOID
FvAdjustFfsFile (
IN UINT8 ErasePolarity,
IN EFI_FFS_FILE_HEADER *FileHeader,
IN UINTN ExtraLength
)
{
UINT8 *Ptr;
UINT8 PadingByte;
if (IS_FFS_FILE2 (FileHeader)) {
Ptr = (UINT8 *) FileHeader + FFS_FILE2_SIZE (FileHeader);
} else {
Ptr = (UINT8 *) FileHeader + FFS_FILE_SIZE (FileHeader);
}
if (ErasePolarity == 0) {
PadingByte = 0;
} else {
PadingByte = 0xFF;
}
//
// Fill the non-used space with Padding Byte
//
SetMem (Ptr, ExtraLength, PadingByte);
return ;
}
/**
Free File List entry pointed by FileListHead.
@param FileListHeader FileListEntry Header.
**/
VOID
FreeFileList (
IN LIST_ENTRY *FileListHead
)
{
FFS_FILE_LIST_ENTRY *FfsFileEntry;
LIST_ENTRY *NextEntry;
FfsFileEntry = (FFS_FILE_LIST_ENTRY *) (FileListHead->ForwardLink);
//
// Loop the whole list entry to free resources
//
while (&FfsFileEntry->Link != FileListHead) {
NextEntry = (&FfsFileEntry->Link)->ForwardLink;
FreePool (FfsFileEntry);
FfsFileEntry = (FFS_FILE_LIST_ENTRY *) NextEntry;
}
return ;
}
/**
Create a new file within a PAD file area.
@param FvDevice Firmware Volume Device.
@param FfsFileBuffer A buffer that holds an FFS file,(it contains a File Header which is in init state).
@param BufferSize The size of FfsFileBuffer.
@param ActualFileSize The actual file length, it may not be multiples of 8.
@param FileName The FFS File Name.
@param FileType The FFS File Type.
@param FileAttributes The Attributes of the FFS File to be created.
@retval EFI_SUCCESS Successfully create a new file within the found PAD file area.
@retval EFI_OUT_OF_RESOURCES No suitable PAD file is found.
@retval other errors New file is created failed.
**/
EFI_STATUS
FvCreateNewFileInsidePadFile (
IN FV_DEVICE *FvDevice,
IN UINT8 *FfsFileBuffer,
IN UINTN BufferSize,
IN UINTN ActualFileSize,
IN EFI_GUID *FileName,
IN EFI_FV_FILETYPE FileType,
IN EFI_FV_FILE_ATTRIBUTES FileAttributes
)
{
UINTN RequiredAlignment;
FFS_FILE_LIST_ENTRY *PadFileEntry;
EFI_STATUS Status;
UINTN PadAreaLength;
UINTN PadSize;
EFI_FFS_FILE_HEADER *FileHeader;
EFI_FFS_FILE_HEADER *OldPadFileHeader;
EFI_FFS_FILE_HEADER *PadFileHeader;
EFI_FFS_FILE_HEADER *TailPadFileHeader;
UINTN StateOffset;
UINTN Offset;
UINTN NumBytesWritten;
UINT8 *StartPos;
LIST_ENTRY NewFileList;
FFS_FILE_LIST_ENTRY *NewFileListEntry;
FFS_FILE_LIST_ENTRY *FfsEntry;
FFS_FILE_LIST_ENTRY *NextFfsEntry;
//
// First get the required alignment from the File Attributes
//
RequiredAlignment = GetRequiredAlignment (FileAttributes);
//
// Find a suitable PAD File
//
Status = FvLocatePadFile (
FvDevice,
BufferSize,
RequiredAlignment,
&PadSize,
&PadFileEntry
);
if (EFI_ERROR (Status)) {
return EFI_OUT_OF_RESOURCES;
}
OldPadFileHeader = (EFI_FFS_FILE_HEADER *) PadFileEntry->FfsHeader;
//
// Step 1: Update Pad File Header
//
SetFileState (EFI_FILE_MARKED_FOR_UPDATE, OldPadFileHeader);
StartPos = PadFileEntry->FfsHeader;
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
StateOffset = Offset + (UINT8 *) &OldPadFileHeader->State - (UINT8 *) OldPadFileHeader;
NumBytesWritten = sizeof (EFI_FFS_FILE_STATE);
Status = FvcWrite (
FvDevice,
StateOffset,
&NumBytesWritten,
&OldPadFileHeader->State
);
if (EFI_ERROR (Status)) {
SetFileState (EFI_FILE_HEADER_CONSTRUCTION, OldPadFileHeader);
return Status;
}
//
// Step 2: Update Pad area
//
InitializeListHead (&NewFileList);
if (IS_FFS_FILE2 (OldPadFileHeader)) {
PadAreaLength = FFS_FILE2_SIZE (OldPadFileHeader) - sizeof (EFI_FFS_FILE_HEADER);
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER2));
} else {
PadAreaLength = FFS_FILE_SIZE (OldPadFileHeader) - sizeof (EFI_FFS_FILE_HEADER);
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER));
}
if (PadSize != 0) {
//
// Insert a PAD file before to achieve required alignment
//
FvFillPadFile (PadFileHeader, PadSize);
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
ASSERT (NewFileListEntry != NULL);
NewFileListEntry->FfsHeader = (UINT8 *) PadFileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
}
FileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) PadFileHeader + PadSize);
Status = FvFillFfsFile (
FileHeader,
FfsFileBuffer,
BufferSize,
ActualFileSize,
FileName,
FileType,
FileAttributes
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
return Status;
}
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
ASSERT (NewFileListEntry != NULL);
NewFileListEntry->FfsHeader = (UINT8 *) FileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
FvDevice->CurrentFfsFile = NewFileListEntry;
if (PadAreaLength > (BufferSize + PadSize)) {
if ((PadAreaLength - BufferSize - PadSize) >= sizeof (EFI_FFS_FILE_HEADER)) {
//
// we can insert another PAD file
//
TailPadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FileHeader + BufferSize);
FvFillPadFile (TailPadFileHeader, PadAreaLength - BufferSize - PadSize);
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
ASSERT (NewFileListEntry != NULL);
NewFileListEntry->FfsHeader = (UINT8 *) TailPadFileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
} else {
//
// because left size cannot hold another PAD file header,
// adjust the writing file size (just in cache)
//
FvAdjustFfsFile (
FvDevice->ErasePolarity,
FileHeader,
PadAreaLength - BufferSize - PadSize
);
}
}
//
// Start writing to FV
//
if (IS_FFS_FILE2 (OldPadFileHeader)) {
StartPos = (UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER2);
} else {
StartPos = (UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER);
}
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
NumBytesWritten = PadAreaLength;
Status = FvcWrite (
FvDevice,
Offset,
&NumBytesWritten,
StartPos
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return Status;
}
//
// Step 3: Mark Pad file header as EFI_FILE_HEADER_INVALID
//
SetFileState (EFI_FILE_HEADER_INVALID, OldPadFileHeader);
StartPos = PadFileEntry->FfsHeader;
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
StateOffset = Offset + (UINT8 *) &OldPadFileHeader->State - (UINT8 *) OldPadFileHeader;
NumBytesWritten = sizeof (EFI_FFS_FILE_STATE);
Status = FvcWrite (
FvDevice,
StateOffset,
&NumBytesWritten,
&OldPadFileHeader->State
);
if (EFI_ERROR (Status)) {
SetFileState (EFI_FILE_HEADER_INVALID, OldPadFileHeader);
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return Status;
}
//
// If all successfully, update FFS_FILE_LIST
//
//
// Delete old pad file entry
//
FfsEntry = (FFS_FILE_LIST_ENTRY *) PadFileEntry->Link.BackLink;
NextFfsEntry = (FFS_FILE_LIST_ENTRY *) PadFileEntry->Link.ForwardLink;
FreePool (PadFileEntry);
FfsEntry->Link.ForwardLink = NewFileList.ForwardLink;
(NewFileList.ForwardLink)->BackLink = &FfsEntry->Link;
NextFfsEntry->Link.BackLink = NewFileList.BackLink;
(NewFileList.BackLink)->ForwardLink = &NextFfsEntry->Link;
return EFI_SUCCESS;
}
/**
Free all FfsBuffer.
@param NumOfFiles Number of FfsBuffer.
@param FfsBuffer An array of pointer to an FFS File Buffer
**/
VOID
FreeFfsBuffer (
IN UINTN NumOfFiles,
IN UINT8 **FfsBuffer
)
{
UINTN Index;
for (Index = 0; Index < NumOfFiles; Index++) {
if (FfsBuffer[Index] != NULL) {
FreePool (FfsBuffer[Index]);
}
}
}
/**
Create multiple files within a PAD File area.
@param FvDevice Firmware Volume Device.
@param PadFileEntry The pad file entry to be written in.
@param NumOfFiles Total File number to be written.
@param BufferSize The array of buffer size of each FfsBuffer.
@param ActualFileSize The array of actual file size.
@param PadSize The array of leading pad file size for each FFS File
@param FfsBuffer The array of Ffs Buffer pointer.
@param FileData The array of EFI_FV_WRITE_FILE_DATA structure,
used to get name, attributes, type, etc.
@retval EFI_SUCCESS Add the input multiple files into PAD file area.
@retval EFI_OUT_OF_RESOURCES No enough memory is allocated.
@retval other error Files can't be added into PAD file area.
**/
EFI_STATUS
FvCreateMultipleFilesInsidePadFile (
IN FV_DEVICE *FvDevice,
IN FFS_FILE_LIST_ENTRY *PadFileEntry,
IN UINTN NumOfFiles,
IN UINTN *BufferSize,
IN UINTN *ActualFileSize,
IN UINTN *PadSize,
IN UINT8 **FfsBuffer,
IN EFI_FV_WRITE_FILE_DATA *FileData
)
{
EFI_STATUS Status;
EFI_FFS_FILE_HEADER *OldPadFileHeader;
UINTN Index;
EFI_FFS_FILE_HEADER *PadFileHeader;
EFI_FFS_FILE_HEADER *FileHeader;
EFI_FFS_FILE_HEADER *TailPadFileHeader;
UINTN TotalSize;
UINTN PadAreaLength;
LIST_ENTRY NewFileList;
FFS_FILE_LIST_ENTRY *NewFileListEntry;
UINTN Offset;
UINTN NumBytesWritten;
UINT8 *StartPos;
FFS_FILE_LIST_ENTRY *FfsEntry;
FFS_FILE_LIST_ENTRY *NextFfsEntry;
InitializeListHead (&NewFileList);
NewFileListEntry = NULL;
OldPadFileHeader = (EFI_FFS_FILE_HEADER *) PadFileEntry->FfsHeader;
if (IS_FFS_FILE2 (OldPadFileHeader)) {
PadAreaLength = FFS_FILE2_SIZE (OldPadFileHeader) - sizeof (EFI_FFS_FILE_HEADER2);
} else {
PadAreaLength = FFS_FILE_SIZE (OldPadFileHeader) - sizeof (EFI_FFS_FILE_HEADER);
}
Status = UpdateHeaderBit (
FvDevice,
OldPadFileHeader,
EFI_FILE_MARKED_FOR_UPDATE
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Update PAD area
//
TotalSize = 0;
if (IS_FFS_FILE2 (OldPadFileHeader)) {
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER2));
} else {
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER));
}
FileHeader = PadFileHeader;
for (Index = 0; Index < NumOfFiles; Index++) {
if (PadSize[Index] != 0) {
FvFillPadFile (PadFileHeader, PadSize[Index]);
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
if (NewFileListEntry == NULL) {
FreeFileList (&NewFileList);
return EFI_OUT_OF_RESOURCES;
}
NewFileListEntry->FfsHeader = (UINT8 *) PadFileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
}
FileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) PadFileHeader + PadSize[Index]);
Status = FvFillFfsFile (
FileHeader,
FfsBuffer[Index],
BufferSize[Index],
ActualFileSize[Index],
FileData[Index].NameGuid,
FileData[Index].Type,
FileData[Index].FileAttributes
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
return Status;
}
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
if (NewFileListEntry == NULL) {
FreeFileList (&NewFileList);
return EFI_OUT_OF_RESOURCES;
}
NewFileListEntry->FfsHeader = (UINT8 *) FileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FileHeader + BufferSize[Index]);
TotalSize += PadSize[Index];
TotalSize += BufferSize[Index];
}
FvDevice->CurrentFfsFile = NewFileListEntry;
//
// Maybe we need a tail pad file
//
if (PadAreaLength > TotalSize) {
if ((PadAreaLength - TotalSize) >= sizeof (EFI_FFS_FILE_HEADER)) {
//
// we can insert another PAD file
//
TailPadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FileHeader + BufferSize[NumOfFiles - 1]);
FvFillPadFile (TailPadFileHeader, PadAreaLength - TotalSize);
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
if (NewFileListEntry == NULL) {
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return EFI_OUT_OF_RESOURCES;
}
NewFileListEntry->FfsHeader = (UINT8 *) TailPadFileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
} else {
//
// because left size cannot hold another PAD file header,
// adjust the writing file size (just in cache)
//
FvAdjustFfsFile (
FvDevice->ErasePolarity,
FileHeader,
PadAreaLength - TotalSize
);
}
}
//
// Start writing to FV
//
if (IS_FFS_FILE2 (OldPadFileHeader)) {
StartPos = (UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER2);
} else {
StartPos = (UINT8 *) OldPadFileHeader + sizeof (EFI_FFS_FILE_HEADER);
}
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
NumBytesWritten = PadAreaLength;
Status = FvcWrite (
FvDevice,
Offset,
&NumBytesWritten,
StartPos
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return Status;
}
Status = UpdateHeaderBit (
FvDevice,
OldPadFileHeader,
EFI_FILE_HEADER_INVALID
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return Status;
}
//
// Update File List Link
//
//
// First delete old pad file entry
//
FfsEntry = (FFS_FILE_LIST_ENTRY *) PadFileEntry->Link.BackLink;
NextFfsEntry = (FFS_FILE_LIST_ENTRY *) PadFileEntry->Link.ForwardLink;
FreePool (PadFileEntry);
FfsEntry->Link.ForwardLink = NewFileList.ForwardLink;
(NewFileList.ForwardLink)->BackLink = &FfsEntry->Link;
NextFfsEntry->Link.BackLink = NewFileList.BackLink;
(NewFileList.BackLink)->ForwardLink = &NextFfsEntry->Link;
return EFI_SUCCESS;
}
/**
Create multiple files within the Free Space.
@param FvDevice Firmware Volume Device.
@param FreeSpaceEntry Indicating in which Free Space(Cache) the multiple files will be inserted.
@param NumOfFiles Total File number to be written.
@param BufferSize The array of buffer size of each FfsBuffer.
@param ActualFileSize The array of actual file size.
@param PadSize The array of leading pad file size for each FFS File
@param FfsBuffer The array of Ffs Buffer pointer.
@param FileData The array of EFI_FV_WRITE_FILE_DATA structure,
used to get name, attributes, type, etc.
@retval EFI_SUCCESS Add the input multiple files into PAD file area.
@retval EFI_OUT_OF_RESOURCES No enough memory is allocated.
@retval other error Files can't be added into PAD file area.
**/
EFI_STATUS
FvCreateMultipleFilesInsideFreeSpace (
IN FV_DEVICE *FvDevice,
IN FREE_SPACE_ENTRY *FreeSpaceEntry,
IN UINTN NumOfFiles,
IN UINTN *BufferSize,
IN UINTN *ActualFileSize,
IN UINTN *PadSize,
IN UINT8 **FfsBuffer,
IN EFI_FV_WRITE_FILE_DATA *FileData
)
{
EFI_STATUS Status;
UINTN Index;
EFI_FFS_FILE_HEADER *PadFileHeader;
EFI_FFS_FILE_HEADER *FileHeader;
UINTN TotalSize;
LIST_ENTRY NewFileList;
FFS_FILE_LIST_ENTRY *NewFileListEntry;
UINTN Offset;
UINTN NumBytesWritten;
UINT8 *StartPos;
InitializeListHead (&NewFileList);
NewFileListEntry = NULL;
TotalSize = 0;
StartPos = FreeSpaceEntry->StartingAddress;
PadFileHeader = (EFI_FFS_FILE_HEADER *) StartPos;
FileHeader = PadFileHeader;
for (Index = 0; Index < NumOfFiles; Index++) {
if (PadSize[Index] != 0) {
FvFillPadFile (PadFileHeader, PadSize[Index]);
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
if (NewFileListEntry == NULL) {
FreeFileList (&NewFileList);
return EFI_OUT_OF_RESOURCES;
}
NewFileListEntry->FfsHeader = (UINT8 *) PadFileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
}
FileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) PadFileHeader + PadSize[Index]);
Status = FvFillFfsFile (
FileHeader,
FfsBuffer[Index],
BufferSize[Index],
ActualFileSize[Index],
FileData[Index].NameGuid,
FileData[Index].Type,
FileData[Index].FileAttributes
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
return Status;
}
NewFileListEntry = AllocatePool (sizeof (FFS_FILE_LIST_ENTRY));
if (NewFileListEntry == NULL) {
FreeFileList (&NewFileList);
return EFI_OUT_OF_RESOURCES;
}
NewFileListEntry->FfsHeader = (UINT8 *) FileHeader;
InsertTailList (&NewFileList, &NewFileListEntry->Link);
PadFileHeader = (EFI_FFS_FILE_HEADER *) ((UINT8 *) FileHeader + BufferSize[Index]);
TotalSize += PadSize[Index];
TotalSize += BufferSize[Index];
}
if (FreeSpaceEntry->Length < TotalSize) {
FreeFileList (&NewFileList);
return EFI_OUT_OF_RESOURCES;
}
FvDevice->CurrentFfsFile = NewFileListEntry;
//
// Start writing to FV
//
Offset = (UINTN) (StartPos - FvDevice->CachedFv);
NumBytesWritten = TotalSize;
Status = FvcWrite (
FvDevice,
Offset,
&NumBytesWritten,
StartPos
);
if (EFI_ERROR (Status)) {
FreeFileList (&NewFileList);
FvDevice->CurrentFfsFile = NULL;
return Status;
}
FreeSpaceEntry->Length -= TotalSize;
FreeSpaceEntry->StartingAddress += TotalSize;
NewFileListEntry = (FFS_FILE_LIST_ENTRY *) (NewFileList.ForwardLink);
while (NewFileListEntry != (FFS_FILE_LIST_ENTRY *) &NewFileList) {
InsertTailList (&FvDevice->FfsFileListHeader, &NewFileListEntry->Link);
NewFileListEntry = (FFS_FILE_LIST_ENTRY *) (NewFileListEntry->Link.ForwardLink);
}
return EFI_SUCCESS;
}
/**
Write multiple files into FV in reliable method.
@param FvDevice Firmware Volume Device.
@param NumOfFiles Total File number to be written.
@param FileData The array of EFI_FV_WRITE_FILE_DATA structure,
used to get name, attributes, type, etc
@param FileOperation The array of operation for each file.
@retval EFI_SUCCESS Files are added into FV.
@retval EFI_OUT_OF_RESOURCES No enough free PAD files to add the input files.
@retval EFI_INVALID_PARAMETER File number is less than or equal to 1.
@retval EFI_UNSUPPORTED File number exceeds the supported max numbers of files.
**/
EFI_STATUS
FvCreateMultipleFiles (
IN FV_DEVICE *FvDevice,
IN UINTN NumOfFiles,
IN EFI_FV_WRITE_FILE_DATA *FileData,
IN BOOLEAN *FileOperation
)
{
EFI_STATUS Status;
UINT8 *FfsBuffer[MAX_FILES];
UINTN Index1;
UINTN Index2;
UINTN BufferSize[MAX_FILES];
UINTN ActualFileSize[MAX_FILES];
UINTN RequiredAlignment[MAX_FILES];
UINTN PadSize[MAX_FILES];
FFS_FILE_LIST_ENTRY *PadFileEntry;
UINTN TotalSizeNeeded;
FREE_SPACE_ENTRY *FreeSpaceEntry;
EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;
UINTN Key;
EFI_GUID FileNameGuid;
EFI_FV_FILETYPE OldFileType;
EFI_FV_FILE_ATTRIBUTES OldFileAttributes;
UINTN OldFileSize;
FFS_FILE_LIST_ENTRY *OldFfsFileEntry[MAX_FILES];
EFI_FFS_FILE_HEADER *OldFileHeader[MAX_FILES];
BOOLEAN IsCreateFile;
UINTN HeaderSize;
//
// To use this function, we must ensure that the NumOfFiles is great
// than 1
//
if (NumOfFiles <= 1) {
return EFI_INVALID_PARAMETER;
}
if (NumOfFiles > MAX_FILES) {
return EFI_UNSUPPORTED;
}
Fv = &FvDevice->Fv;
SetMem (FfsBuffer, NumOfFiles, 0);
SetMem (RequiredAlignment, NumOfFiles, 8);
SetMem (PadSize, NumOfFiles, 0);
ZeroMem (OldFfsFileEntry, sizeof (OldFfsFileEntry));
ZeroMem (OldFileHeader, sizeof (OldFileHeader));
//
// Adjust file size
//
for (Index1 = 0; Index1 < NumOfFiles; Index1++) {
HeaderSize = sizeof (EFI_FFS_FILE_HEADER);
ActualFileSize[Index1] = FileData[Index1].BufferSize + HeaderSize;
if (ActualFileSize[Index1] > 0x00FFFFFF) {
HeaderSize = sizeof (EFI_FFS_FILE_HEADER2);
ActualFileSize[Index1] = FileData[Index1].BufferSize + HeaderSize;
}
BufferSize[Index1] = ActualFileSize[Index1];
if (BufferSize[Index1] == HeaderSize) {
//
// clear file attributes, zero-length file does not have any attributes
//
FileData[Index1].FileAttributes = 0;
}
while ((BufferSize[Index1] & 0x07) != 0) {
BufferSize[Index1]++;
}
FfsBuffer[Index1] = AllocateZeroPool (BufferSize[Index1]);
//
// Copy File Data into FileBuffer
//
CopyMem (
FfsBuffer[Index1] + HeaderSize,
FileData[Index1].Buffer,
FileData[Index1].BufferSize
);
if (FvDevice->ErasePolarity == 1) {
for (Index2 = 0; Index2 < HeaderSize; Index2++) {
FfsBuffer[Index1][Index2] = (UINT8)~FfsBuffer[Index1][Index2];
}
}
if ((FileData[Index1].FileAttributes & EFI_FV_FILE_ATTRIB_ALIGNMENT) != 0) {
RequiredAlignment[Index1] = GetRequiredAlignment (FileData[Index1].FileAttributes);
}
//
// If update file, mark the original file header to
// EFI_FILE_MARKED_FOR_UPDATE
//
IsCreateFile = FileOperation[Index1];
if (!IsCreateFile) {
Key = 0;
do {
OldFileType = 0;
Status = Fv->GetNextFile (
Fv,
&Key,
&OldFileType,
&FileNameGuid,
&OldFileAttributes,
&OldFileSize
);
if (EFI_ERROR (Status)) {
FreeFfsBuffer (NumOfFiles, FfsBuffer);
return Status;
}
} while (!CompareGuid (&FileNameGuid, FileData[Index1].NameGuid));
//
// Get FfsFileEntry from the search key
//
OldFfsFileEntry[Index1] = (FFS_FILE_LIST_ENTRY *) Key;
OldFileHeader[Index1] = (EFI_FFS_FILE_HEADER *) OldFfsFileEntry[Index1]->FfsHeader;
Status = UpdateHeaderBit (
FvDevice,
OldFileHeader[Index1],
EFI_FILE_MARKED_FOR_UPDATE
);
if (EFI_ERROR (Status)) {
FreeFfsBuffer (NumOfFiles, FfsBuffer);
return Status;
}
}
}
//
// First to search a suitable pad file that can hold so
// many files
//
Status = FvSearchSuitablePadFile (
FvDevice,
NumOfFiles,
BufferSize,
RequiredAlignment,
PadSize,
&TotalSizeNeeded,
&PadFileEntry
);
if (Status == EFI_NOT_FOUND) {
//
// Try to find a free space that can hold these files
//
Status = FvSearchSuitableFreeSpace (
FvDevice,
NumOfFiles,
BufferSize,
RequiredAlignment,
PadSize,
&TotalSizeNeeded,
&FreeSpaceEntry
);
if (EFI_ERROR (Status)) {
FreeFfsBuffer (NumOfFiles, FfsBuffer);
return EFI_OUT_OF_RESOURCES;
}
Status = FvCreateMultipleFilesInsideFreeSpace (
FvDevice,
FreeSpaceEntry,
NumOfFiles,
BufferSize,
ActualFileSize,
PadSize,
FfsBuffer,
FileData
);
} else {
//
// Create multiple files inside such a pad file
// to achieve lock-step update
//
Status = FvCreateMultipleFilesInsidePadFile (
FvDevice,
PadFileEntry,
NumOfFiles,
BufferSize,
ActualFileSize,
PadSize,
FfsBuffer,
FileData
);
}
FreeFfsBuffer (NumOfFiles, FfsBuffer);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Delete those updated files
//
for (Index1 = 0; Index1 < NumOfFiles; Index1++) {
IsCreateFile = FileOperation[Index1];
if (!IsCreateFile && OldFfsFileEntry[Index1] != NULL) {
(OldFfsFileEntry[Index1]->Link.BackLink)->ForwardLink = OldFfsFileEntry[Index1]->Link.ForwardLink;
(OldFfsFileEntry[Index1]->Link.ForwardLink)->BackLink = OldFfsFileEntry[Index1]->Link.BackLink;
FreePool (OldFfsFileEntry[Index1]);
}
}
//
// Set those files' state to EFI_FILE_DELETED
//
for (Index1 = 0; Index1 < NumOfFiles; Index1++) {
IsCreateFile = FileOperation[Index1];
if (!IsCreateFile && OldFileHeader[Index1] != NULL) {
Status = UpdateHeaderBit (FvDevice, OldFileHeader[Index1], EFI_FILE_DELETED);
if (EFI_ERROR (Status)) {
return Status;
}
}
}
return EFI_SUCCESS;
}
|