From 3837e91c58d4b626a91895b68b32cb59679787e8 Mon Sep 17 00:00:00 2001
From: Star Zeng <star.zeng@intel.com>
Date: Mon, 16 Sep 2013 01:50:44 +0000
Subject: [PATCH] MdeModulePkg: Add support for weakly aligned FVs.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14671 6f19259b-4bc3-4df7-8a09-765794883524
---
 MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c | 67 +++++++++++--------
 MdeModulePkg/Core/Dxe/FwVolBlock/FwVolBlock.c | 31 ++++++---
 MdeModulePkg/Core/Pei/FwVol/FwVol.c           | 45 +++++++------
 MdePkg/Include/Pi/PiFirmwareVolume.h          |  6 +-
 4 files changed, 87 insertions(+), 62 deletions(-)

diff --git a/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c b/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c
index 75d6267f61..a70e2e45d5 100644
--- a/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c
+++ b/MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c
@@ -1036,39 +1036,48 @@ CoreProcessFvImageFile (
     //
     FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) Buffer;
     //
-    // Get FvHeader alignment
+    // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume
+    // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from
+    // its initial linked location and maintain its alignment.
     //
-    FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);
-    //
-    // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value. 
-    //
-    if (FvAlignment < 8) {
-      FvAlignment = 8;
+    if ((FvHeader->Attributes & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {
+      //
+      // Get FvHeader alignment
+      //
+      FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);
+      //
+      // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.
+      //
+      if (FvAlignment < 8) {
+        FvAlignment = 8;
+      }
+      //
+      // Allocate the aligned buffer for the FvImage.
+      //
+      AlignedBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), (UINTN) FvAlignment);
+      if (AlignedBuffer == NULL) {
+        FreePool (Buffer);
+        return EFI_OUT_OF_RESOURCES;
+      } else {
+        //
+        // Move FvImage into the aligned buffer and release the original buffer.
+        //
+        CopyMem (AlignedBuffer, Buffer, BufferSize);
+        FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) AlignedBuffer;
+        CoreFreePool (Buffer);
+        Buffer = NULL;
+      }
     }
     //
-    // Allocate the aligned buffer for the FvImage.
+    // Produce a FVB protocol for the file
     //
-    AlignedBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), (UINTN) FvAlignment);
-    if (AlignedBuffer == NULL) {
-      Status = EFI_OUT_OF_RESOURCES;
-    } else {
-      //
-      // Move FvImage into the aligned buffer and release the original buffer.
-      //
-      CopyMem (AlignedBuffer, Buffer, BufferSize);
-      CoreFreePool (Buffer);
-      Buffer = NULL;
-      //
-      // Produce a FVB protocol for the file
-      //
-      Status = ProduceFVBProtocolOnBuffer (
-                (EFI_PHYSICAL_ADDRESS) (UINTN) AlignedBuffer,
-                (UINT64)BufferSize,
-                FvHandle,
-                AuthenticationStatus,
-                NULL
-                );
-    }
+    Status = ProduceFVBProtocolOnBuffer (
+              (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,
+              (UINT64)BufferSize,
+              FvHandle,
+              AuthenticationStatus,
+              NULL
+              );
   }
 
   if (EFI_ERROR (Status)) {
diff --git a/MdeModulePkg/Core/Dxe/FwVolBlock/FwVolBlock.c b/MdeModulePkg/Core/Dxe/FwVolBlock/FwVolBlock.c
index 523738d52d..27a7f43fe5 100644
--- a/MdeModulePkg/Core/Dxe/FwVolBlock/FwVolBlock.c
+++ b/MdeModulePkg/Core/Dxe/FwVolBlock/FwVolBlock.c
@@ -474,22 +474,31 @@ ProduceFVBProtocolOnBuffer (
   if (FwVolHeader->Signature != EFI_FVH_SIGNATURE) {
     return EFI_VOLUME_CORRUPTED;
   }
+
   //
-  // Get FvHeader alignment
+  // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume
+  // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from
+  // its initial linked location and maintain its alignment.
   //
-  FvAlignment = 1 << ((FwVolHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);
-  //
-  // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value. 
-  //
-  if (FvAlignment < 8) {
-    FvAlignment = 8;
-  }
-  if ((UINTN)BaseAddress % FvAlignment != 0) {
+  if ((FwVolHeader->Attributes & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {
     //
-    // FvImage buffer is not at its required alignment.
+    // Get FvHeader alignment
     //
-    return EFI_VOLUME_CORRUPTED;
+    FvAlignment = 1 << ((FwVolHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);
+    //
+    // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.
+    //
+    if (FvAlignment < 8) {
+      FvAlignment = 8;
+    }
+    if ((UINTN)BaseAddress % FvAlignment != 0) {
+      //
+      // FvImage buffer is not at its required alignment.
+      //
+      return EFI_VOLUME_CORRUPTED;
+    }
   }
+
   //
   // Allocate EFI_FW_VOL_BLOCK_DEVICE
   //
diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
index af8f821ebb..e505c707b0 100644
--- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c
+++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c
@@ -1,7 +1,7 @@
 /** @file
   Pei Core Firmware File System service routines.
   
-Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2013, 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        
@@ -226,7 +226,7 @@ FindFileEx (
   IN  CONST EFI_GUID                 *FileName,   OPTIONAL
   IN        EFI_FV_FILETYPE          SearchType,
   IN OUT    EFI_PEI_FILE_HANDLE      *FileHandle,
-  IN OUT    EFI_PEI_FV_HANDLE        *AprioriFile  OPTIONAL
+  IN OUT    EFI_PEI_FILE_HANDLE      *AprioriFile  OPTIONAL
   )
 {
   EFI_FIRMWARE_VOLUME_HEADER            *FwVolHeader;
@@ -1112,26 +1112,33 @@ ProcessFvFile (
   }
 
   //
-  // FvAlignment must be more than 8 bytes required by FvHeader structure.
+  // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume
+  // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from
+  // its initial linked location and maintain its alignment.
   //
-  FvAlignment = 1 << ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_ALIGNMENT) >> 16);
-  if (FvAlignment < 8) {
-    FvAlignment = 8;
-  }
-  
-  //
-  // Check FvImage
-  //
-  if ((UINTN) FvHeader % FvAlignment != 0) {
-    FvLength    = ReadUnaligned64 (&FvHeader->FvLength);
-    NewFvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvLength), FvAlignment);
-    if (NewFvBuffer == NULL) {
-      return EFI_OUT_OF_RESOURCES;
+  if ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {
+    //
+    // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.
+    //
+    FvAlignment = 1 << ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_ALIGNMENT) >> 16);
+    if (FvAlignment < 8) {
+      FvAlignment = 8;
+    }
+
+    //
+    // Check FvImage
+    //
+    if ((UINTN) FvHeader % FvAlignment != 0) {
+      FvLength    = ReadUnaligned64 (&FvHeader->FvLength);
+      NewFvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvLength), FvAlignment);
+      if (NewFvBuffer == NULL) {
+        return EFI_OUT_OF_RESOURCES;
+      }
+      CopyMem (NewFvBuffer, FvHeader, (UINTN) FvLength);
+      FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) NewFvBuffer;
     }
-    CopyMem (NewFvBuffer, FvHeader, (UINTN) FvLength);
-    FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*) NewFvBuffer;
   }
-  
+
   Status = ParentFvPpi->GetVolumeInfo (ParentFvPpi, ParentFvHandle, &ParentFvImageInfo);
   ASSERT_EFI_ERROR (Status);
   
diff --git a/MdePkg/Include/Pi/PiFirmwareVolume.h b/MdePkg/Include/Pi/PiFirmwareVolume.h
index f589c20dd9..7aa2e5e016 100644
--- a/MdePkg/Include/Pi/PiFirmwareVolume.h
+++ b/MdePkg/Include/Pi/PiFirmwareVolume.h
@@ -1,7 +1,7 @@
 /** @file
   The firmware volume related definitions in PI.
 
-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006 - 2013, 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        
@@ -11,7 +11,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
 
   @par Revision Reference:
-  PI Version 1.2C
+  PI Version 1.3
 
 **/
 
@@ -86,7 +86,7 @@ typedef UINT32  EFI_FVB_ATTRIBUTES_2;
 #define EFI_FVB2_ALIGNMENT_512M     0x001D0000
 #define EFI_FVB2_ALIGNMENT_1G       0x001E0000
 #define EFI_FVB2_ALIGNMENT_2G       0x001F0000
-
+#define EFI_FVB2_WEAK_ALIGNMENT     0x80000000
 
 typedef struct {
   ///