FmdDevicePkg/FmpDxe: Support Fmp Capsule Dependency.

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2421

Capsule Dependency is an incremental change of Fmp Capsule Update. The
capsule format is extended to include a set of binary encoded dependency
expression. The dependency expression is signed together with the Fmp
payload and evaluated before update is applied.
This feature is defined in UEFI Spec 2.8.

The dependency evaluation has two steps:
1. Validate platform existing Fmp images' version satisfy the dependency
expression in capsule image.
2. Validate the capsule image version satisfy all the platform existing
Fmp image's dependency expression.
If the dependency expression evaluates to FALSE, then the capsule update
fails and last attempt status is set to
LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES.

The dependency saving and getting is FmpDeviceLib implementation scope.
The parameter "Image" of FmpDeviceSetImage and FmpDeviceGetImage function
is extended to contain the dependency. The layout:
  +--------------------------+
  |   Dependency Op-codes    |
  +--------------------------+
  |    Fmp Payload Image     |
  +--------------------------+
1. FmpDeviceSetImage is responsible for retrieving the dependency from the
parameter "Image" and saving it to a protected storage.
2. FmpDeviceGetImage is responsible for retrieving the dependency from the
storage where FmpDeviceSetImage saves dependency and combining it with the
Fmp Payload Image into one buffer which is returned to the caller. This
dependency will be populated into EFI_FIRMWARE_IMAGE_DESCRIPTOR and used
for dependency evaluation.
3. FmpDeviceGetAttributes must set the bit IMAGE_ATTRIBUTE_DEPENDENCY to
indicate the Fmp device supports Fmp Capsule Dependency feature.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Wei6 Xu <wei6.xu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/FmpDevicePkg/FmpDxe/Dependency.c b/FmpDevicePkg/FmpDxe/Dependency.c
new file mode 100644 (file)
index 0000000..b63a36b
--- /dev/null
+++ b/FmpDevicePkg/FmpDxe/Dependency.c
@@ -0,0 +1,679 @@
+/** @file\r
+  Supports Capsule Dependency Expression.\r
+\r
+  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
+\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+#include "FmpDxe.h"\r
+#include "Dependency.h"\r
+\r
+//\r
+// Define the initial size of the dependency expression evaluation stack\r
+//\r
+#define DEPEX_STACK_SIZE_INCREMENT  0x1000\r
+\r
+//\r
+// Type of stack element\r
+//\r
+typedef enum {\r
+  BooleanType,\r
+  VersionType\r
+} ELEMENT_TYPE;\r
+\r
+//\r
+// Value of stack element\r
+//\r
+typedef union {\r
+  BOOLEAN   Boolean;\r
+  UINT32    Version;\r
+} ELEMENT_VALUE;\r
+\r
+//\r
+// Stack element used to evaluate dependency expressions\r
+//\r
+typedef struct {\r
+  ELEMENT_VALUE Value;\r
+  ELEMENT_TYPE  Type;\r
+} DEPEX_ELEMENT;\r
+\r
+//\r
+// Global variable used to support dependency evaluation\r
+//\r
+UINTN                          mNumberOfFmpInstance = 0;\r
+EFI_FIRMWARE_IMAGE_DESCRIPTOR  **mFmpImageInfoBuf   = NULL;\r
+\r
+//\r
+// Indicates the status of dependency check, default value is DEPENDENCIES_SATISFIED.\r
+//\r
+UINT8  mDependenciesCheckStatus = DEPENDENCIES_SATISFIED;\r
+\r
+//\r
+// Global stack used to evaluate dependency expressions\r
+//\r
+DEPEX_ELEMENT  *mDepexEvaluationStack        = NULL;\r
+DEPEX_ELEMENT  *mDepexEvaluationStackEnd     = NULL;\r
+DEPEX_ELEMENT  *mDepexEvaluationStackPointer = NULL;\r
+\r
+/**\r
+  Grow size of the Depex stack\r
+\r
+  @retval EFI_SUCCESS           Stack successfully growed.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough system memory to grow the stack.\r
+\r
+**/\r
+EFI_STATUS\r
+GrowDepexStack (\r
+  VOID\r
+  )\r
+{\r
+  DEPEX_ELEMENT  *NewStack;\r
+  UINTN          Size;\r
+\r
+  Size = DEPEX_STACK_SIZE_INCREMENT;\r
+  if (mDepexEvaluationStack != NULL) {\r
+    Size = Size + (mDepexEvaluationStackEnd - mDepexEvaluationStack);\r
+  }\r
+\r
+  NewStack = AllocatePool (Size * sizeof (DEPEX_ELEMENT));\r
+  if (NewStack == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  if (mDepexEvaluationStack != NULL) {\r
+    //\r
+    // Copy to Old Stack to the New Stack\r
+    //\r
+    CopyMem (\r
+      NewStack,\r
+      mDepexEvaluationStack,\r
+      (mDepexEvaluationStackEnd - mDepexEvaluationStack) * sizeof (DEPEX_ELEMENT)\r
+      );\r
+\r
+    //\r
+    // Free The Old Stack\r
+    //\r
+    FreePool (mDepexEvaluationStack);\r
+  }\r
+\r
+  //\r
+  // Make the Stack pointer point to the old data in the new stack\r
+  //\r
+  mDepexEvaluationStackPointer = NewStack + (mDepexEvaluationStackPointer - mDepexEvaluationStack);\r
+  mDepexEvaluationStack        = NewStack;\r
+  mDepexEvaluationStackEnd     = NewStack + Size;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Push an element onto the Stack.\r
+\r
+  @param[in]  Value                  Value to push.\r
+  @param[in]  Type                   Element Type\r
+\r
+  @retval EFI_SUCCESS            The value was pushed onto the stack.\r
+  @retval EFI_OUT_OF_RESOURCES   There is not enough system memory to grow the stack.\r
+  @retval EFI_INVALID_PARAMETER  Wrong stack element type.\r
+\r
+**/\r
+EFI_STATUS\r
+Push (\r
+  IN UINT32   Value,\r
+  IN UINTN    Type\r
+  )\r
+{\r
+  EFI_STATUS      Status;\r
+  DEPEX_ELEMENT   Element;\r
+\r
+  //\r
+  // Check Type\r
+  //\r
+  if (Type != BooleanType && Type != VersionType) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Check for a stack overflow condition\r
+  //\r
+  if (mDepexEvaluationStackPointer == mDepexEvaluationStackEnd) {\r
+    //\r
+    // Grow the stack\r
+    //\r
+    Status = GrowDepexStack ();\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+  }\r
+\r
+  Element.Value.Version = Value;\r
+  Element.Type = Type;\r
+\r
+  //\r
+  // Push the item onto the stack\r
+  //\r
+  *mDepexEvaluationStackPointer = Element;\r
+  mDepexEvaluationStackPointer++;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+\r
+/**\r
+  Pop an element from the stack.\r
+\r
+  @param[in]  Value                  Element to pop.\r
+  @param[in]  Type                   Type of element.\r
+\r
+  @retval EFI_SUCCESS            The value was popped onto the stack.\r
+  @retval EFI_ACCESS_DENIED      The pop operation underflowed the stack.\r
+  @retval EFI_INVALID_PARAMETER  Type is mismatched.\r
+\r
+**/\r
+EFI_STATUS\r
+Pop (\r
+  OUT DEPEX_ELEMENT  *Element,\r
+  IN  ELEMENT_TYPE   Type\r
+  )\r
+{\r
+  //\r
+  // Check for a stack underflow condition\r
+  //\r
+  if (mDepexEvaluationStackPointer == mDepexEvaluationStack) {\r
+    return EFI_ACCESS_DENIED;\r
+  }\r
+\r
+  //\r
+  // Pop the item off the stack\r
+  //\r
+  mDepexEvaluationStackPointer--;\r
+  *Element = *mDepexEvaluationStackPointer;\r
+  if ((*Element).Type != Type) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Evaluate the dependencies.\r
+\r
+  @param[in]   Dependencies        Dependency expressions.\r
+  @param[in]   DependenciesSize    Size of Dependency expressions.\r
+\r
+  @retval TRUE           Dependency expressions evaluate to TRUE.\r
+  @retval FALSE          Dependency expressions evaluate to FALSE.\r
+\r
+**/\r
+BOOLEAN\r
+EvaluateDependencies (\r
+  IN  CONST EFI_FIRMWARE_IMAGE_DEP *     Dependencies,\r
+  IN  CONST UINTN                        DependenciesSize\r
+  )\r
+{\r
+  EFI_STATUS                        Status;\r
+  UINT8                             *Iterator;\r
+  UINT8                             Index;\r
+  DEPEX_ELEMENT                     Element1;\r
+  DEPEX_ELEMENT                     Element2;\r
+  GUID                              ImageTypeId;\r
+  UINT32                            Version;\r
+\r
+  if (Dependencies == NULL || DependenciesSize == 0) {\r
+    return FALSE;\r
+  }\r
+\r
+  //\r
+  // Clean out memory leaks in Depex Boolean stack. Leaks are only caused by\r
+  // incorrectly formed DEPEX expressions\r
+  //\r
+  mDepexEvaluationStackPointer = mDepexEvaluationStack;\r
+\r
+  Iterator = (UINT8 *) Dependencies->Dependencies;\r
+  while (Iterator < (UINT8 *) Dependencies->Dependencies + DependenciesSize) {\r
+    switch (*Iterator)\r
+    {\r
+    case EFI_FMP_DEP_PUSH_GUID:\r
+      if (Iterator + sizeof (EFI_GUID) >= (UINT8 *) Dependencies->Dependencies + DependenciesSize) {\r
+        Status = EFI_INVALID_PARAMETER;\r
+        goto Error;\r
+      }\r
+\r
+      CopyGuid (&ImageTypeId, (EFI_GUID *) (Iterator + 1));\r
+      Iterator = Iterator + sizeof (EFI_GUID);\r
+\r
+      for (Index = 0; Index < mNumberOfFmpInstance; Index ++){\r
+        if (mFmpImageInfoBuf[Index] == NULL) {\r
+          continue;\r
+        }\r
+        if(CompareGuid (&mFmpImageInfoBuf[Index]->ImageTypeId, &ImageTypeId)){\r
+          Status = Push (mFmpImageInfoBuf[Index]->Version, VersionType);\r
+          if (EFI_ERROR (Status)) {\r
+            goto Error;\r
+          }\r
+          break;\r
+        }\r
+      }\r
+      if (Index == mNumberOfFmpInstance) {\r
+        Status = EFI_NOT_FOUND;\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_PUSH_VERSION:\r
+      if (Iterator + sizeof (UINT32) >= (UINT8 *) Dependencies->Dependencies + DependenciesSize ) {\r
+        Status = EFI_INVALID_PARAMETER;\r
+        goto Error;\r
+      }\r
+\r
+      Version = *(UINT32 *) (Iterator + 1);\r
+      Status = Push (Version, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Iterator = Iterator + sizeof (UINT32);\r
+      break;\r
+    case EFI_FMP_DEP_VERSION_STR:\r
+      Iterator += AsciiStrnLenS ((CHAR8 *) Iterator, DependenciesSize - (Iterator - Dependencies->Dependencies));\r
+      break;\r
+    case EFI_FMP_DEP_AND:\r
+      Status = Pop (&Element1, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Push (Element1.Value.Boolean & Element2.Value.Boolean, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_OR:\r
+      Status = Pop (&Element1, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop(&Element2, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Push (Element1.Value.Boolean | Element2.Value.Boolean, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_NOT:\r
+      Status = Pop (&Element1, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Push (!(Element1.Value.Boolean), BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_TRUE:\r
+      Status = Push (TRUE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_FALSE:\r
+      Status = Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_EQ:\r
+      Status = Pop (&Element1, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = (Element1.Value.Version == Element2.Value.Version) ? Push (TRUE, BooleanType) : Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_GT:\r
+      Status = Pop (&Element1, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = (Element1.Value.Version >  Element2.Value.Version) ? Push (TRUE, BooleanType) : Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_GTE:\r
+      Status = Pop (&Element1, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = (Element1.Value.Version >= Element2.Value.Version) ? Push (TRUE, BooleanType) : Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_LT:\r
+      Status = Pop (&Element1, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = (Element1.Value.Version <  Element2.Value.Version) ? Push (TRUE, BooleanType) : Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_LTE:\r
+      Status = Pop (&Element1, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = Pop (&Element2, VersionType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      Status = (Element1.Value.Version <= Element2.Value.Version) ? Push (TRUE, BooleanType) : Push (FALSE, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      break;\r
+    case EFI_FMP_DEP_END:\r
+      Status = Pop (&Element1, BooleanType);\r
+      if (EFI_ERROR (Status)) {\r
+        goto Error;\r
+      }\r
+      return Element1.Value.Boolean;\r
+    default:\r
+      Status = EFI_INVALID_PARAMETER;\r
+      goto Error;\r
+    }\r
+    Iterator++;\r
+  }\r
+\r
+Error:\r
+\r
+  DEBUG ((DEBUG_ERROR, "FmpDxe(%s): EvaluateDependencies() - RESULT = FALSE (Status = %r)\n", mImageIdName, Status));\r
+  return FALSE;\r
+}\r
+\r
+/**\r
+  Validate the dependency expression and output its size.\r
+\r
+  @param[in]   ImageDepex      Pointer to the EFI_FIRMWARE_IMAGE_DEP.\r
+  @param[in]   MaxDepexSize    Max size of the dependency.\r
+  @param[out]  DepexSize       Size of dependency.\r
+\r
+  @retval TRUE           The capsule is valid.\r
+  @retval FALSE          The capsule is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+ValidateImageDepex (\r
+  IN  EFI_FIRMWARE_IMAGE_DEP             *ImageDepex,\r
+  IN  CONST UINTN                        MaxDepexSize,\r
+  OUT UINT32                             *DepexSize\r
+  )\r
+{\r
+  UINT8  *Depex;\r
+\r
+  *DepexSize = 0;\r
+  Depex = ImageDepex->Dependencies;\r
+  while (Depex < ImageDepex->Dependencies + MaxDepexSize) {\r
+    switch (*Depex)\r
+    {\r
+    case EFI_FMP_DEP_PUSH_GUID:\r
+      Depex += sizeof (EFI_GUID) + 1;\r
+      break;\r
+    case EFI_FMP_DEP_PUSH_VERSION:\r
+      Depex += sizeof (UINT32) + 1;\r
+      break;\r
+    case EFI_FMP_DEP_VERSION_STR:\r
+      Depex += AsciiStrnLenS ((CHAR8 *) Depex, ImageDepex->Dependencies + MaxDepexSize - Depex) + 1;\r
+      break;\r
+    case EFI_FMP_DEP_AND:\r
+    case EFI_FMP_DEP_OR:\r
+    case EFI_FMP_DEP_NOT:\r
+    case EFI_FMP_DEP_TRUE:\r
+    case EFI_FMP_DEP_FALSE:\r
+    case EFI_FMP_DEP_EQ:\r
+    case EFI_FMP_DEP_GT:\r
+    case EFI_FMP_DEP_GTE:\r
+    case EFI_FMP_DEP_LT:\r
+    case EFI_FMP_DEP_LTE:\r
+      Depex += 1;\r
+      break;\r
+    case EFI_FMP_DEP_END:\r
+      Depex += 1;\r
+      *DepexSize = (UINT32)(Depex - ImageDepex->Dependencies);\r
+      return TRUE;\r
+    default:\r
+      return FALSE;\r
+    }\r
+  }\r
+\r
+  return FALSE;\r
+}\r
+\r
+\r
+/**\r
+  Get the size of dependencies. Assume the dependencies is validated before\r
+  calling this function.\r
+\r
+  @param[in]   Dependencies    Pointer to the EFI_FIRMWARE_IMAGE_DEP.\r
+\r
+  @retval  The size of dependencies.\r
+\r
+**/\r
+UINTN\r
+GetDepexSize (\r
+  IN CONST EFI_FIRMWARE_IMAGE_DEP  *Dependencies\r
+  )\r
+{\r
+  UINTN Index;\r
+\r
+  if (Dependencies == NULL) {\r
+    return 0;\r
+  }\r
+\r
+  Index = 0;\r
+  while (Dependencies->Dependencies[Index] != EFI_FMP_DEP_END) {\r
+    Index ++;\r
+  }\r
+\r
+  return Index + 1;\r
+}\r
+\r
+/**\r
+  Check dependency for firmware update.\r
+\r
+  @param[in]   ImageTypeId         Image Type Id.\r
+  @param[in]   Version             New version.\r
+  @param[in]   Dependencies        The dependencies.\r
+  @param[in]   DependenciesSize    Size of the dependencies\r
+  @param[out]  IsSatisfied         Indicate the dependencies is satisfied or not.\r
+\r
+  @retval  EFI_SUCCESS             Dependency Evaluation is successful.\r
+  @retval  Others                  Dependency Evaluation fails with unexpected error.\r
+\r
+**/\r
+EFI_STATUS\r
+EvaluateImageDependencies (\r
+  IN CONST EFI_GUID                ImageTypeId,\r
+  IN CONST UINT32                  Version,\r
+  IN CONST EFI_FIRMWARE_IMAGE_DEP  *Dependencies,\r
+  IN CONST UINT32                  DependenciesSize,\r
+  OUT BOOLEAN                      *IsSatisfied\r
+  )\r
+{\r
+  EFI_STATUS                        Status;\r
+  EFI_HANDLE                        *HandleBuffer;\r
+  UINTN                             Index;\r
+  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *Fmp;\r
+  UINTN                             ImageInfoSize;\r
+  UINT32                            FmpImageInfoDescriptorVer;\r
+  UINT8                             FmpImageInfoCount;\r
+  UINTN                             DescriptorSize;\r
+  UINT32                            PackageVersion;\r
+  CHAR16                            *PackageVersionName;\r
+  UINTN                             DepexSize;\r
+\r
+  *IsSatisfied       = TRUE;\r
+  PackageVersionName = NULL;\r
+\r
+  //\r
+  // Get ImageDescriptors of all FMP instances, and archive them for depex evaluation.\r
+  //\r
+  Status = gBS->LocateHandleBuffer (\r
+                ByProtocol,\r
+                &gEfiFirmwareManagementProtocolGuid,\r
+                NULL,\r
+                &mNumberOfFmpInstance,\r
+                &HandleBuffer\r
+                );\r
+  if (EFI_ERROR (Status)) {\r
+    return EFI_ABORTED;\r
+  }\r
+\r
+  mFmpImageInfoBuf = AllocatePool (sizeof(EFI_FIRMWARE_IMAGE_DESCRIPTOR *) * mNumberOfFmpInstance);\r
+  if (mFmpImageInfoBuf == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  for (Index = 0; Index < mNumberOfFmpInstance; Index ++) {\r
+    Status = gBS->HandleProtocol (\r
+                    HandleBuffer[Index],\r
+                    &gEfiFirmwareManagementProtocolGuid,\r
+                    (VOID **) &Fmp\r
+                    );\r
+    if (EFI_ERROR(Status)) {\r
+      continue;\r
+    }\r
+\r
+    ImageInfoSize = 0;\r
+    Status = Fmp->GetImageInfo (\r
+                    Fmp,\r
+                    &ImageInfoSize,\r
+                    NULL,\r
+                    NULL,\r
+                    NULL,\r
+                    NULL,\r
+                    NULL,\r
+                    NULL\r
+                    );\r
+    if (Status != EFI_BUFFER_TOO_SMALL) {\r
+      continue;\r
+    }\r
+\r
+    mFmpImageInfoBuf[Index] = AllocateZeroPool (ImageInfoSize);\r
+    if (mFmpImageInfoBuf[Index] == NULL) {\r
+      continue;\r
+    }\r
+\r
+    Status = Fmp->GetImageInfo (\r
+                    Fmp,\r
+                    &ImageInfoSize,               // ImageInfoSize\r
+                    mFmpImageInfoBuf[Index],      // ImageInfo\r
+                    &FmpImageInfoDescriptorVer,   // DescriptorVersion\r
+                    &FmpImageInfoCount,           // DescriptorCount\r
+                    &DescriptorSize,              // DescriptorSize\r
+                    &PackageVersion,              // PackageVersion\r
+                    &PackageVersionName           // PackageVersionName\r
+                    );\r
+    if (EFI_ERROR(Status)) {\r
+      FreePool (mFmpImageInfoBuf[Index]);\r
+      mFmpImageInfoBuf[Index] = NULL;\r
+      continue;\r
+    }\r
+\r
+    if (PackageVersionName != NULL) {\r
+      FreePool (PackageVersionName);\r
+      PackageVersionName = NULL;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Step 1 - Evaluate firmware image's depex, against the version of other Fmp instances.\r
+  //\r
+  if (Dependencies != NULL) {\r
+    *IsSatisfied = EvaluateDependencies (Dependencies, DependenciesSize);\r
+  }\r
+\r
+  if (!*IsSatisfied) {\r
+    goto cleanup;\r
+  }\r
+\r
+  //\r
+  // Step 2 - Evaluate the depex of all other Fmp instances, against the new version in\r
+  // the firmware image.\r
+  //\r
+\r
+  //\r
+  // Update the new version to mFmpImageInfoBuf.\r
+  //\r
+  for (Index = 0; Index < mNumberOfFmpInstance; Index ++) {\r
+    if (mFmpImageInfoBuf[Index] != NULL) {\r
+      if (CompareGuid (&ImageTypeId, &mFmpImageInfoBuf[Index]->ImageTypeId)) {\r
+        mFmpImageInfoBuf[Index]->Version = Version;\r
+        break;\r
+      }\r
+    }\r
+  }\r
+\r
+  //\r
+  // Evaluate the Dependencies one by one.\r
+  //\r
+  for (Index = 0; Index < mNumberOfFmpInstance; Index ++) {\r
+    if (mFmpImageInfoBuf[Index] != NULL) {\r
+      //\r
+      // Skip the Fmp instance to be "SetImage".\r
+      //\r
+      if (CompareGuid (&ImageTypeId, &mFmpImageInfoBuf[Index]->ImageTypeId)) {\r
+        continue;\r
+      }\r
+      if ((mFmpImageInfoBuf[Index]->AttributesSupported & IMAGE_ATTRIBUTE_DEPENDENCY) &&\r
+           mFmpImageInfoBuf[Index]->Dependencies != NULL) {\r
+        //\r
+        // Get the size of depex.\r
+        // Assume that the dependencies in EFI_FIRMWARE_IMAGE_DESCRIPTOR is validated when PopulateDescriptor().\r
+        //\r
+        DepexSize = GetDepexSize (mFmpImageInfoBuf[Index]->Dependencies);\r
+        if (DepexSize > 0) {\r
+          *IsSatisfied = EvaluateDependencies (mFmpImageInfoBuf[Index]->Dependencies, DepexSize);\r
+          if (!*IsSatisfied) {\r
+            break;\r
+          }\r
+        }\r
+      }\r
+    }\r
+  }\r
+\r
+cleanup:\r
+  if (mFmpImageInfoBuf != NULL) {\r
+    for (Index = 0; Index < mNumberOfFmpInstance; Index ++) {\r
+      if (mFmpImageInfoBuf[Index] != NULL) {\r
+        FreePool (mFmpImageInfoBuf[Index]);\r
+      }\r
+    }\r
+    FreePool (mFmpImageInfoBuf);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r

diff --git a/FmpDevicePkg/FmpDxe/Dependency.h b/FmpDevicePkg/FmpDxe/Dependency.h
new file mode 100644 (file)
index 0000000..a2aaace
--- /dev/null
+++ b/FmpDevicePkg/FmpDxe/Dependency.h
@@ -0,0 +1,63 @@
+/** @file\r
+  Fmp Capsule Dependency support functions for Firmware Management Protocol based\r
+  firmware updates.\r
+\r
+  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
+\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef __DEPENDENCY_H__\r
+#define __DEPENDENCY_H__\r
+\r
+#include <Library/UefiLib.h>\r
+#include <Protocol/FirmwareManagement.h>\r
+\r
+#define DEPENDENCIES_SATISFIED    0\r
+#define DEPENDENCIES_UNSATISFIED  1\r
+#define DEPENDENCIES_INVALID      2\r
+\r
+extern UINT8  mDependenciesCheckStatus;\r
+\r
+/**\r
+  Validate the dependency expression and output its size.\r
+\r
+  @param[in]   ImageDepex      Pointer to the EFI_FIRMWARE_IMAGE_DEP.\r
+  @param[in]   MaxDepexSize    Max size of the dependency.\r
+  @param[out]  DepexSize       Size of dependency.\r
+\r
+  @retval TRUE           The capsule is valid.\r
+  @retval FALSE          The capsule is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+ValidateImageDepex (\r
+  IN  EFI_FIRMWARE_IMAGE_DEP             *ImageDepex,\r
+  IN  CONST UINTN                        MaxDepexSize,\r
+  OUT UINT32                             *DepexSize\r
+  );\r
+\r
+/**\r
+  Check dependency for firmware update.\r
+\r
+  @param[in]   ImageTypeId         Image Type Id.\r
+  @param[in]   Version             New version.\r
+  @param[in]   Dependencies        The dependencies.\r
+  @param[in]   DepexSize           Size of the dependencies\r
+  @param[out]  IsSatisfied         Indicate the dependencies is satisfied or not.\r
+\r
+  @retval  EFI_SUCCESS             Dependency Evaluation is successful.\r
+  @retval  Others                  Dependency Evaluation fails with unexpected error.\r
+\r
+**/\r
+EFI_STATUS\r
+EvaluateImageDependencies (\r
+  IN CONST EFI_GUID                ImageTypeId,\r
+  IN CONST UINT32                  Version,\r
+  IN CONST EFI_FIRMWARE_IMAGE_DEP  *Dependencies,\r
+  IN CONST UINT32                  DependenciesSize,\r
+  OUT BOOLEAN                      *IsSatisfied\r
+  );\r
+\r
+#endif\r

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c b/FmpDevicePkg/FmpDxe/FmpDxe.c
index fe465af11ed96437e140cc84e1d766472aa95f2c..aa92331966c0ae9285573f9650882da5ae19faf8 100644 (file)
--- a/FmpDevicePkg/FmpDxe/FmpDxe.c
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
@@ -4,7 +4,7 @@
   information provided through PCDs and libraries.\r
 \r
   Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
-  Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
@@ -12,6 +12,7 @@
 \r
 #include "FmpDxe.h"\r
 #include "VariableSupport.h"\r
+#include "Dependency.h"\r
 \r
 ///\r
 /// FILE_GUID from FmpDxe.inf.  When FmpDxe.inf is used in a platform, the\r
@@ -275,6 +276,13 @@ PopulateDescriptor (
   )\r
 {\r
   EFI_STATUS  Status;\r
+  VOID        *Image;\r
+  UINTN       ImageSize;\r
+  BOOLEAN     IsDepexValid;\r
+  UINT32      DepexSize;\r
+\r
+  Image     = NULL;\r
+  ImageSize = 0;\r
 \r
   if (Private->DescriptorPopulated) {\r
     return;\r
@@ -378,7 +386,47 @@ PopulateDescriptor (
   Private->Descriptor.LastAttemptVersion = GetLastAttemptVersionFromVariable (Private);\r
   Private->Descriptor.LastAttemptStatus  = GetLastAttemptStatusFromVariable (Private);\r
 \r
+  //\r
+  // Get the dependency from the FmpDeviceLib and populate it to the descriptor.\r
+  //\r
+  Private->Descriptor.Dependencies = NULL;\r
+\r
+  //\r
+  // Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY\r
+  //\r
+  if (Private->Descriptor.AttributesSupported & IMAGE_ATTRIBUTE_DEPENDENCY) {\r
+    //\r
+    // The parameter "Image" of FmpDeviceGetImage() is extended to contain the dependency.\r
+    // Get the dependency from the Image.\r
+    //\r
+    ImageSize = Private->Descriptor.Size;\r
+    Image = AllocatePool (ImageSize);\r
+    if (Image != NULL) {\r
+      Status = FmpDeviceGetImage (Image, &ImageSize);\r
+      if (Status == EFI_BUFFER_TOO_SMALL) {\r
+        FreePool (Image);\r
+        Image = AllocatePool (ImageSize);\r
+        if (Image != NULL) {\r
+          Status = FmpDeviceGetImage (Image, &ImageSize);\r
+        }\r
+      }\r
+    }\r
+    if (!EFI_ERROR (Status) && Image != NULL) {\r
+      IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP *) Image, ImageSize, &DepexSize);\r
+      if (IsDepexValid == TRUE) {\r
+        Private->Descriptor.Dependencies = AllocatePool (DepexSize);\r
+        if (Private->Descriptor.Dependencies != NULL) {\r
+          CopyMem (Private->Descriptor.Dependencies->Dependencies, Image, DepexSize);\r
+        }\r
+      }\r
+    }\r
+  }\r
+\r
   Private->DescriptorPopulated = TRUE;\r
+\r
+  if (Image != NULL) {\r
+    FreePool (Image);\r
+  }\r
 }\r
 \r
 /**\r
@@ -540,12 +588,17 @@ GetTheImage (
   EFI_STATUS                        Status;\r
   FIRMWARE_MANAGEMENT_PRIVATE_DATA  *Private;\r
   UINTN                             Size;\r
+  UINT8                             *ImageBuffer;\r
+  UINTN                             ImageBufferSize;\r
+  UINT32                            DepexSize;\r
 \r
   if (!FeaturePcdGet (PcdFmpDeviceStorageAccessEnable)) {\r
     return EFI_UNSUPPORTED;\r
   }\r
 \r
-  Status = EFI_SUCCESS;\r
+  Status          = EFI_SUCCESS;\r
+  ImageBuffer     = NULL;\r
+  DepexSize       = 0;\r
 \r
   //\r
   // Retrieve the private context structure\r
@@ -575,8 +628,45 @@ GetTheImage (
   if (EFI_ERROR (Status)) {\r
     Size = 0;\r
   }\r
-  if (*ImageSize < Size) {\r
-    *ImageSize = Size;\r
+\r
+  //\r
+  // The parameter "Image" of FmpDeviceGetImage() is extended to contain the dependency.\r
+  // Get the Fmp Payload from the Image.\r
+  //\r
+  ImageBufferSize = Size;\r
+  ImageBuffer = AllocatePool (ImageBufferSize);\r
+  if (ImageBuffer == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImage() - AllocatePool fails.\n", mImageIdName));\r
+    Status = EFI_NOT_FOUND;\r
+    goto cleanup;\r
+  }\r
+  Status = FmpDeviceGetImage (ImageBuffer, &ImageBufferSize);\r
+  if (Status == EFI_BUFFER_TOO_SMALL) {\r
+    FreePool (ImageBuffer);\r
+    ImageBuffer = AllocatePool (ImageBufferSize);\r
+    if (ImageBuffer == NULL) {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImage() - AllocatePool fails.\n", mImageIdName));\r
+      Status = EFI_NOT_FOUND;\r
+      goto cleanup;\r
+    }\r
+    Status = FmpDeviceGetImage (ImageBuffer, &ImageBufferSize);\r
+  }\r
+  if (EFI_ERROR (Status)) {\r
+    goto cleanup;\r
+  }\r
+\r
+  //\r
+  // Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY\r
+  //\r
+  if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {\r
+    //\r
+    // Validate the dependency to get its size.\r
+    //\r
+    ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP *) ImageBuffer, ImageBufferSize, &DepexSize);\r
+  }\r
+\r
+  if (*ImageSize < ImageBufferSize - DepexSize) {\r
+    *ImageSize = ImageBufferSize - DepexSize;\r
     DEBUG ((DEBUG_VERBOSE, "FmpDxe(%s): GetImage() - ImageSize is to small.\n", mImageIdName));\r
     Status = EFI_BUFFER_TOO_SMALL;\r
     goto cleanup;\r
@@ -588,8 +678,17 @@ GetTheImage (
     goto cleanup;\r
   }\r
 \r
-  Status = FmpDeviceGetImage (Image, ImageSize);\r
+  //\r
+  // Image is after the dependency expression.\r
+  //\r
+  *ImageSize = ImageBufferSize - DepexSize;\r
+  CopyMem (Image, ImageBuffer + DepexSize, *ImageSize);\r
+  Status = EFI_SUCCESS;\r
+\r
 cleanup:\r
+  if (ImageBuffer != NULL) {\r
+    FreePool (ImageBuffer);\r
+  }\r
 \r
   return Status;\r
 }\r
@@ -710,6 +809,10 @@ CheckTheImage (
   UINTN                             PublicKeyDataLength;\r
   UINT8                             *PublicKeyDataXdr;\r
   UINT8                             *PublicKeyDataXdrEnd;\r
+  EFI_FIRMWARE_IMAGE_DEP            *Dependencies;\r
+  UINT32                            DependenciesSize;\r
+  BOOLEAN                           IsDepexValid;\r
+  BOOLEAN                           IsDepexSatisfied;\r
 \r
   Status           = EFI_SUCCESS;\r
   RawSize          = 0;\r
@@ -718,6 +821,8 @@ CheckTheImage (
   Version          = 0;\r
   FmpHeaderSize    = 0;\r
   AllHeaderSize    = 0;\r
+  Dependencies     = NULL;\r
+  DependenciesSize = 0;\r
 \r
   if (!FeaturePcdGet (PcdFmpDeviceStorageAccessEnable)) {\r
     return EFI_UNSUPPORTED;\r
@@ -842,10 +947,33 @@ CheckTheImage (
   }\r
   Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);\r
   if (EFI_ERROR (Status)) {\r
-    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpPayloadHeaderVersion failed %r.\n", mImageIdName, Status));\r
-    *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
-    Status = EFI_SUCCESS;\r
-    goto cleanup;\r
+    //\r
+    // Check if there is dependency expression\r
+    //\r
+    IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP*) FmpPayloadHeader, FmpPayloadSize, &DependenciesSize);\r
+    if (IsDepexValid && (DependenciesSize < FmpPayloadSize)) {\r
+      //\r
+      // Fmp payload is after dependency expression\r
+      //\r
+      Dependencies = (EFI_FIRMWARE_IMAGE_DEP*) FmpPayloadHeader;\r
+      FmpPayloadHeader = (UINT8 *) Dependencies + DependenciesSize;\r
+      FmpPayloadSize = FmpPayloadSize - DependenciesSize;\r
+      Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);\r
+      if (EFI_ERROR (Status)) {\r
+        DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpPayloadHeaderVersion failed %r.\n", mImageIdName, Status));\r
+        *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
+        Status = EFI_SUCCESS;\r
+        goto cleanup;\r
+      }\r
+    } else {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency is invalid.\n", mImageIdName));\r
+      mDependenciesCheckStatus = DEPENDENCIES_INVALID;\r
+      *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
+      Status = EFI_SUCCESS;\r
+      goto cleanup;\r
+    }\r
+  } else {\r
+    DEBUG ((DEBUG_WARN, "FmpDxe(%s): CheckTheImage() - No dependency associated in image.\n", mImageIdName));\r
   }\r
 \r
   //\r
@@ -862,6 +990,22 @@ CheckTheImage (
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Evaluate dependency expression\r
+  //\r
+  Status = EvaluateImageDependencies (Private->Descriptor.ImageTypeId, Version, Dependencies, DependenciesSize, &IsDepexSatisfied);\r
+  if (!IsDepexSatisfied || EFI_ERROR (Status)) {\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency check failed %r.\n", mImageIdName, Status));\r
+    } else {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency is not satisfied.\n", mImageIdName));\r
+    }\r
+    mDependenciesCheckStatus = DEPENDENCIES_UNSATISFIED;\r
+    *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
+    Status = EFI_SUCCESS;\r
+    goto cleanup;\r
+  }\r
+\r
   //\r
   // Get the FmpHeaderSize so we can determine the real payload size\r
   //\r
@@ -877,7 +1021,7 @@ CheckTheImage (
   // Call FmpDevice Lib Check Image on the\r
   // Raw payload.  So all headers need stripped off\r
   //\r
-  AllHeaderSize = GetAllHeaderSize ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, FmpHeaderSize );\r
+  AllHeaderSize = GetAllHeaderSize ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, FmpHeaderSize + DependenciesSize);\r
   if (AllHeaderSize == 0) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetAllHeaderSize failed.\n", mImageIdName));\r
     Status = EFI_ABORTED;\r
@@ -967,6 +1111,11 @@ SetTheImage (
   UINT32                            LastAttemptStatus;\r
   UINT32                            Version;\r
   UINT32                            LowestSupportedVersion;\r
+  EFI_FIRMWARE_IMAGE_DEP            *Dependencies;\r
+  UINT32                            DependenciesSize;\r
+  BOOLEAN                           IsDepexValid;\r
+  UINT8                             *ImageBuffer;\r
+  UINTN                             ImageBufferSize;\r
 \r
   Status             = EFI_SUCCESS;\r
   Updateable         = 0;\r
@@ -975,8 +1124,12 @@ SetTheImage (
   FmpHeader          = NULL;\r
   FmpPayloadSize     = 0;\r
   AllHeaderSize      = 0;\r
-  IncomingFwVersion = 0;\r
+  IncomingFwVersion  = 0;\r
   LastAttemptStatus  = LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL;\r
+  Dependencies       = NULL;\r
+  DependenciesSize   = 0;\r
+  ImageBuffer        = NULL;\r
+  ImageBufferSize    = 0;\r
 \r
   if (!FeaturePcdGet (PcdFmpDeviceStorageAccessEnable)) {\r
     return EFI_UNSUPPORTED;\r
@@ -1008,6 +1161,11 @@ SetTheImage (
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Set check status to satisfied before CheckTheImage()\r
+  //\r
+  mDependenciesCheckStatus = DEPENDENCIES_SATISFIED;\r
+\r
   //\r
   // Call check image to verify the image\r
   //\r
@@ -1031,6 +1189,21 @@ SetTheImage (
     goto cleanup;\r
   }\r
   Status = GetFmpPayloadHeaderVersion (FmpHeader, FmpPayloadSize, &IncomingFwVersion);\r
+  if (EFI_ERROR (Status)) {\r
+    //\r
+    // Check if there is dependency expression\r
+    //\r
+    IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP*) FmpHeader, FmpPayloadSize, &DependenciesSize);\r
+    if (IsDepexValid && (DependenciesSize < FmpPayloadSize)) {\r
+      //\r
+      // Fmp payload is after dependency expression\r
+      //\r
+      Dependencies = (EFI_FIRMWARE_IMAGE_DEP*) FmpHeader;\r
+      FmpHeader = (UINT8 *) FmpHeader + DependenciesSize;\r
+      FmpPayloadSize = FmpPayloadSize - DependenciesSize;\r
+      Status = GetFmpPayloadHeaderVersion (FmpHeader, FmpPayloadSize, &IncomingFwVersion);\r
+    }\r
+  }\r
   if (!EFI_ERROR (Status)) {\r
     //\r
     // Set to actual value\r
@@ -1045,6 +1218,11 @@ SetTheImage (
       "FmpDxe(%s): SetTheImage() - Check The Image returned that the Image was not valid for update.  Updatable value = 0x%X.\n",\r
       mImageIdName, Updateable)\r
       );\r
+    if (mDependenciesCheckStatus == DEPENDENCIES_UNSATISFIED) {\r
+      LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES;\r
+    } else if (mDependenciesCheckStatus == DEPENDENCIES_INVALID) {\r
+      LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT;\r
+    }\r
     Status = EFI_ABORTED;\r
     goto cleanup;\r
   }\r
@@ -1138,13 +1316,41 @@ SetTheImage (
     goto cleanup;\r
   }\r
 \r
-  AllHeaderSize = GetAllHeaderSize ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, FmpHeaderSize );\r
+  AllHeaderSize = GetAllHeaderSize ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, FmpHeaderSize + DependenciesSize);\r
   if (AllHeaderSize == 0) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetAllHeaderSize failed.\n", mImageIdName));\r
     Status = EFI_ABORTED;\r
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY\r
+  //\r
+  if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {\r
+    //\r
+    // To support saving dependency, extend param "Image" of FmpDeviceSetImage() to\r
+    // contain the dependency inside. FmpDeviceSetImage() is responsible for saving\r
+    // the dependency which can be used for future dependency check.\r
+    //\r
+    ImageBufferSize = DependenciesSize + ImageSize - AllHeaderSize;\r
+    ImageBuffer = AllocatePool (ImageBufferSize);\r
+    if (ImageBuffer == NULL) {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - AllocatePool failed.\n", mImageIdName));\r
+      Status = EFI_ABORTED;\r
+      goto cleanup;\r
+    }\r
+    CopyMem (ImageBuffer, Dependencies->Dependencies, DependenciesSize);\r
+    CopyMem (ImageBuffer + DependenciesSize, (UINT8 *)Image + AllHeaderSize, ImageBufferSize - DependenciesSize);\r
+  } else {\r
+    ImageBufferSize = ImageSize - AllHeaderSize;\r
+    ImageBuffer = AllocateCopyPool(ImageBufferSize, (UINT8 *)Image + AllHeaderSize);\r
+    if (ImageBuffer == NULL) {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - AllocatePool failed.\n", mImageIdName));\r
+      Status = EFI_ABORTED;\r
+      goto cleanup;\r
+    }\r
+  }\r
+\r
   //\r
   // Indicate that control is handed off to FmpDeviceLib\r
   //\r
@@ -1154,8 +1360,8 @@ SetTheImage (
   //Copy the requested image to the firmware using the FmpDeviceLib\r
   //\r
   Status = FmpDeviceSetImage (\r
-             (((UINT8 *)Image) + AllHeaderSize),\r
-             ImageSize - AllHeaderSize,\r
+             ImageBuffer,\r
+             ImageBufferSize,\r
              VendorCode,\r
              FmpDxeProgress,\r
              IncomingFwVersion,\r
@@ -1192,6 +1398,10 @@ SetTheImage (
   LastAttemptStatus = LAST_ATTEMPT_STATUS_SUCCESS;\r
 \r
 cleanup:\r
+  if (ImageBuffer != NULL) {\r
+    FreePool (ImageBuffer);\r
+  }\r
+\r
   mProgressFunc = NULL;\r
   SetLastAttemptStatusInVariable (Private, LastAttemptStatus);\r
 \r

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.inf b/FmpDevicePkg/FmpDxe/FmpDxe.inf
index bec73aa8fbc9c8bf64b0a950436e3bcb7783cdb5..97b6518fa1ff3aea7450e86f0998dcaf16dc456e 100644 (file)
--- a/FmpDevicePkg/FmpDxe/FmpDxe.inf
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.inf
@@ -4,7 +4,7 @@
 #  information provided through PCDs and libraries.\r
 #\r
 #  Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
-#  Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 ##\r
@@ -28,6 +28,8 @@
 [Sources]\r
   FmpDxe.c\r
   FmpDxe.h\r
+  Dependency.c\r
+  Dependency.h\r
   DetectTestKey.c\r
   VariableSupport.h\r
   VariableSupport.c\r

diff --git a/FmpDevicePkg/FmpDxe/FmpDxeLib.inf b/FmpDevicePkg/FmpDxe/FmpDxeLib.inf
index edc0cd66c10427ceeeb7eeefaff503faf23b351a..de005b6892b141477d4546f8efff266c77889b8c 100644 (file)
--- a/FmpDevicePkg/FmpDxe/FmpDxeLib.inf
+++ b/FmpDevicePkg/FmpDxe/FmpDxeLib.inf
@@ -4,7 +4,7 @@
 #  information provided through PCDs and libraries.\r
 #\r
 #  Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r
-#  Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 ##\r
@@ -29,6 +29,8 @@
 [Sources]\r
   FmpDxe.c\r
   FmpDxe.h\r
+  Dependency.c\r
+  Dependency.h\r
   DetectTestKey.c\r
   VariableSupport.h\r
   VariableSupport.c\r