Add description for the parameter of SafeFreePool().

[mirror_edk2.git] / ArmPlatformPkg / Documentation / patches / BaseTools-GenFv-Calculate-Alignment-From-Fv-Offset.patch

diff --git a/BaseTools/Source/C/GenFv/GenFvInternalLib.c b/BaseTools/Source/C/GenFv/GenFvInternalLib.c
old mode 100644
new mode 100755
index 189dc43..af47709
--- a/BaseTools/Source/C/GenFv/GenFvInternalLib.c
+++ b/BaseTools/Source/C/GenFv/GenFvInternalLib.c
@@ -505,6 +505,7 @@ Returns:
 \r
 EFI_STATUS\r
 AddPadFile (\r
+  IN FV_INFO          *FvInfo,\r
   IN OUT MEMORY_FILE  *FvImage,\r
   IN UINT32           DataAlignment,\r
   IN VOID             *FvEnd,\r
@@ -536,6 +537,8 @@ Returns:
 {\r
   EFI_FFS_FILE_HEADER *PadFile;\r
   UINTN               PadFileSize;\r
+  UINTN               PadFileOffset;\r
+  UINTN               ExtHeaderSize;\r
 \r
   //\r
   // Verify input parameters.\r
@@ -558,32 +561,29 @@ Returns:
   // This is the earliest possible valid offset (current plus pad file header\r
   // plus the next file header)\r
   //\r
-  PadFileSize = (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage + (sizeof (EFI_FFS_FILE_HEADER) * 2);\r
+  // The padding is added into its own FFS file (which requires a header) added before the aligned file:\r
+  // | ... FV data before AlignedFile ... | Pad File FFS Header | Padding | AlignedFile FFS Header (+ ExtHeader) | AlignedData\r
 \r
   //\r
-  // Add whatever it takes to get to the next aligned address\r
+  // Calculate the Offset of the Pad File from the beginning of the FV file\r
   //\r
-  while ((PadFileSize % DataAlignment) != 0) {\r
-    PadFileSize++;\r
-  }\r
-  //\r
-  // Subtract the next file header size\r
-  //\r
-  PadFileSize -= sizeof (EFI_FFS_FILE_HEADER);\r
-\r
-  //\r
-  // Subtract the starting offset to get size\r
-  //\r
-  PadFileSize -= (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage;\r
+  PadFileOffset = (UINTN) FvImage->CurrentFilePointer - (UINTN) FvImage->FileImage;\r
   \r
   //\r
-  // Append extension header size\r
+  // Get the size of the extension header if exists\r
   //\r
   if (ExtHeader != NULL) {\r
-    PadFileSize = PadFileSize + ExtHeader->ExtHeaderSize;\r
+    ExtHeaderSize = ExtHeader->ExtHeaderSize;\r
+  } else {\r
+    ExtHeaderSize = 0;\r
   }\r
 \r
   //\r
+  // Calculate the Size of the Padding to ensure the alignment of the data of the Next file\r
+  //\r
+  PadFileSize = DataAlignment - ((FvInfo->BaseAddress + PadFileOffset + sizeof (EFI_FFS_FILE_HEADER) + ExtHeaderSize) & (DataAlignment - 1));\r
+\r
+  //\r
   // Verify that we have enough space for the file header\r
   //\r
   if (((UINTN) FvImage->CurrentFilePointer + PadFileSize) > (UINTN) FvEnd) {\r
@@ -1110,7 +1110,7 @@ Returns:
   //\r
   // Add pad file if necessary\r
   //\r
-  Status = AddPadFile (FvImage, 1 << CurrentFileAlignment, *VtfFileImage, NULL);\r
+  Status = AddPadFile (FvInfo, FvImage, 1 << CurrentFileAlignment, *VtfFileImage, NULL);\r
   if (EFI_ERROR (Status)) {\r
     Error (NULL, 0, 4002, "Resource", "FV space is full, could not add pad file for data alignment property.");\r
     free (FileBuffer);\r
@@ -2295,7 +2295,7 @@ Returns:
     //\r
     // Add FV Extended Header contents to the FV as a PAD file\r
     //\r
-    AddPadFile (&FvImageMemoryFile, 4, VtfFileImage, FvExtHeader);\r
+    AddPadFile (&mFvDataInfo, &FvImageMemoryFile, 4, VtfFileImage, FvExtHeader);\r
 \r
     //\r
     // Fv Extension header change update Fv Header Check sum\r