MdeModulePkg/CapsuleLib: Add CapsuleTarget support.

UEFI spec requires CapsuleTarget to be a device path associated
with FMP producer.

Cc: Feng Tian <feng.tian@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Chao Zhang <chao.b.zhang@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Chao Zhang <chao.b.zhang@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

3 files changed, 40 insertions, 9 deletions

diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
index af08886d02..2bb6ac887f 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleLib.c
@@ -100,6 +100,7 @@ RecordCapsuleStatusVariable (
   @param[in] CapsuleStatus  The capsule process stauts

   @param[in] PayloadIndex   FMP payload index

   @param[in] ImageHeader    FMP image header

+  @param[in] FmpDevicePath  DevicePath associated with the FMP producer

 

   @retval EFI_SUCCESS          The capsule status variable is recorded.

   @retval EFI_OUT_OF_RESOURCES No resource to record the capsule status variable.

@@ -109,7 +110,8 @@ RecordFmpCapsuleStatusVariable (
   IN EFI_CAPSULE_HEADER                            *CapsuleHeader,

   IN EFI_STATUS                                    CapsuleStatus,

   IN UINTN                                         PayloadIndex,

-  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader

+  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader,

+  IN EFI_DEVICE_PATH_PROTOCOL                      *FmpDevicePath OPTIONAL

   );

 

 /**

@@ -818,6 +820,7 @@ ProcessFmpCapsuleImage (
   UINTN                                         Index2;

   MEMMAP_DEVICE_PATH                            MemMapNode;

   EFI_DEVICE_PATH_PROTOCOL                      *DriverDevicePath;

+  EFI_DEVICE_PATH_PROTOCOL                      *FmpDevicePath;

   ESRT_MANAGEMENT_PROTOCOL                      *EsrtProtocol;

   EFI_SYSTEM_RESOURCE_ENTRY                     EsrtEntry;

   VOID                                          *VendorCode;

@@ -941,6 +944,13 @@ ProcessFmpCapsuleImage (
         continue;

       }

 

+      FmpDevicePath = NULL;

+      gBS->HandleProtocol(

+             HandleBuffer[Index1],

+             &gEfiDevicePathProtocolGuid,

+             (VOID **)&FmpDevicePath

+             );

+

       ImageInfoSize = 0;

       Status = Fmp->GetImageInfo (

                       Fmp,

@@ -1060,7 +1070,8 @@ ProcessFmpCapsuleImage (
               CapsuleHeader,                                 // CapsuleGuid

               Status,                                        // CapsuleStatus

               Index - FmpCapsuleHeader->EmbeddedDriverCount, // PayloadIndex

-              ImageHeader                                    // ImageHeader

+              ImageHeader,                                   // ImageHeader

+              FmpDevicePath                                  // FmpDevicePath

               );

             if (StatusRet != EFI_SUCCESS) {

               StatusRet = Status;

diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c
index d34eb25a6e..61ede5cfa9 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLib.c
@@ -30,6 +30,7 @@
 #include <Library/HobLib.h>

 #include <Library/PrintLib.h>

 #include <Library/ReportStatusCodeLib.h>

+#include <Library/DevicePathLib.h>

 #include <Library/CapsuleLib.h>

 

 #include <IndustryStandard/WindowsUxCapsule.h>

@@ -280,6 +281,7 @@ RecordCapsuleStatusVariable (
   @param[in] CapsuleStatus  The capsule process stauts

   @param[in] PayloadIndex   FMP payload index

   @param[in] ImageHeader    FMP image header

+  @param[in] FmpDevicePath  DevicePath associated with the FMP producer

 

   @retval EFI_SUCCESS          The capsule status variable is recorded.

   @retval EFI_OUT_OF_RESOURCES No resource to record the capsule status variable.

@@ -289,26 +291,37 @@ RecordFmpCapsuleStatusVariable (
   IN EFI_CAPSULE_HEADER                            *CapsuleHeader,

   IN EFI_STATUS                                    CapsuleStatus,

   IN UINTN                                         PayloadIndex,

-  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader

+  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader,

+  IN EFI_DEVICE_PATH_PROTOCOL                      *FmpDevicePath OPTIONAL

   )

 {

   EFI_CAPSULE_RESULT_VARIABLE_HEADER  *CapsuleResultVariableHeader;

   EFI_CAPSULE_RESULT_VARIABLE_FMP     *CapsuleResultVariableFmp;

   EFI_STATUS                          Status;

   UINT8                               *CapsuleResultVariable;

-  UINT32                              CapsuleResultVariableSize;

+  UINTN                               CapsuleResultVariableSize;

+  CHAR16                              *DevicePathStr;

+  UINTN                               DevicePathStrSize;

 

-  CapsuleResultVariable     = NULL;

+  DevicePathStr = NULL;

+  if (FmpDevicePath != NULL) {

+    DevicePathStr = ConvertDevicePathToText (FmpDevicePath, FALSE, FALSE);

+  }

+  if (DevicePathStr != NULL) {

+    DevicePathStrSize = StrSize(DevicePathStr);

+  } else {

+    DevicePathStrSize = sizeof(CHAR16);

+  }

   //

-  // Allocate zero CHAR16 for CapsuleFileName and CapsuleTarget.

+  // Allocate zero CHAR16 for CapsuleFileName.

   //

-  CapsuleResultVariableSize = sizeof(EFI_CAPSULE_RESULT_VARIABLE_HEADER) + sizeof(EFI_CAPSULE_RESULT_VARIABLE_FMP) + sizeof(CHAR16) * 2;

+  CapsuleResultVariableSize = sizeof(EFI_CAPSULE_RESULT_VARIABLE_HEADER) + sizeof(EFI_CAPSULE_RESULT_VARIABLE_FMP) + sizeof(CHAR16) + DevicePathStrSize;

   CapsuleResultVariable     = AllocateZeroPool (CapsuleResultVariableSize);

   if (CapsuleResultVariable == NULL) {

     return EFI_OUT_OF_RESOURCES;

   }

   CapsuleResultVariableHeader = (VOID *)CapsuleResultVariable;

-  CapsuleResultVariableHeader->VariableTotalSize = CapsuleResultVariableSize;

+  CapsuleResultVariableHeader->VariableTotalSize = (UINT32)CapsuleResultVariableSize;

   CapsuleResultVariableHeader->Reserved = 0;

   CopyGuid(&CapsuleResultVariableHeader->CapsuleGuid, &CapsuleHeader->CapsuleGuid);

   ZeroMem(&CapsuleResultVariableHeader->CapsuleProcessed, sizeof(CapsuleResultVariableHeader->CapsuleProcessed));

@@ -320,6 +333,11 @@ RecordFmpCapsuleStatusVariable (
   CapsuleResultVariableFmp->PayloadIndex = (UINT8)PayloadIndex;

   CapsuleResultVariableFmp->UpdateImageIndex = ImageHeader->UpdateImageIndex;

   CopyGuid (&CapsuleResultVariableFmp->UpdateImageTypeId, &ImageHeader->UpdateImageTypeId);

+  if (DevicePathStr != NULL) {

+    CopyMem ((UINT8 *)CapsuleResultVariableFmp + sizeof(EFI_CAPSULE_RESULT_VARIABLE_FMP) + sizeof(CHAR16), DevicePathStr, DevicePathStrSize);

+    FreePool (DevicePathStr);

+    DevicePathStr = NULL;

+  }

 

   //

   // Save Local Cache

diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLibNull.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLibNull.c
index bf550e51ee..6ab198d0f1 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLibNull.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleReportLibNull.c
@@ -64,6 +64,7 @@ RecordCapsuleStatusVariable (
   @param[in] CapsuleStatus  The capsule process stauts

   @param[in] PayloadIndex   FMP payload index

   @param[in] ImageHeader    FMP image header

+  @param[in] FmpDevicePath  DevicePath associated with the FMP producer

 

   @retval EFI_SUCCESS          The capsule status variable is recorded.

   @retval EFI_OUT_OF_RESOURCES No resource to record the capsule status variable.

@@ -73,7 +74,8 @@ RecordFmpCapsuleStatusVariable (
   IN EFI_CAPSULE_HEADER                            *CapsuleHeader,

   IN EFI_STATUS                                    CapsuleStatus,

   IN UINTN                                         PayloadIndex,

-  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader

+  IN EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER  *ImageHeader,

+  IN EFI_DEVICE_PATH_PROTOCOL                      *FmpDevicePath OPTIONAL

   )

 {

   return EFI_UNSUPPORTED;