]> git.proxmox.com Git - mirror_edk2.git/blobdiff - FmpDevicePkg/FmpDxe/FmpDxe.c
FmpDevicePkg/FmpDxe: Use new Fmp dependency libraries
[mirror_edk2.git] / FmpDevicePkg / FmpDxe / FmpDxe.c
index 5b523291e4d7e60fd0b666ea0e44b6470df29d82..58841774fee023ece7ce9549d9fe0ccaa780aa68 100644 (file)
@@ -12,7 +12,6 @@
 \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
@@ -81,7 +80,8 @@ const FIRMWARE_MANAGEMENT_PRIVATE_DATA  mFirmwareManagementPrivateDataTemplate =
   NULL,                                        // LsvVariableName\r
   NULL,                                        // LastAttemptStatusVariableName\r
   NULL,                                        // LastAttemptVersionVariableName\r
-  NULL                                         // FmpStateVariableName\r
+  NULL,                                        // FmpStateVariableName\r
+  TRUE                                         // DependenciesSatisfied\r
 };\r
 \r
 ///\r
@@ -276,13 +276,7 @@ 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
+  UINT32      DependenciesSize;\r
 \r
   if (Private->DescriptorPopulated) {\r
     return;\r
@@ -387,46 +381,18 @@ PopulateDescriptor (
   Private->Descriptor.LastAttemptStatus  = GetLastAttemptStatusFromVariable (Private);\r
 \r
   //\r
-  // Get the dependency from the FmpDeviceLib and populate it to the descriptor.\r
+  // Get the dependency from the FmpDependencyDeviceLib.\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) {\r
-        Private->Descriptor.Dependencies = AllocatePool (DepexSize);\r
-        if (Private->Descriptor.Dependencies != NULL) {\r
-          CopyMem (Private->Descriptor.Dependencies->Dependencies, Image, DepexSize);\r
-        }\r
-      }\r
-    }\r
+  if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {\r
+    Private->Descriptor.Dependencies = GetFmpDependency (&DependenciesSize);\r
   }\r
 \r
   Private->DescriptorPopulated = TRUE;\r
-\r
-  if (Image != NULL) {\r
-    FreePool (Image);\r
-  }\r
 }\r
 \r
 /**\r
@@ -588,17 +554,12 @@ 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
-  ImageBuffer     = NULL;\r
-  DepexSize       = 0;\r
+  Status = EFI_SUCCESS;\r
 \r
   //\r
   // Retrieve the private context structure\r
@@ -628,45 +589,8 @@ GetTheImage (
   if (EFI_ERROR (Status)) {\r
     Size = 0;\r
   }\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
+  if (*ImageSize < Size) {\r
+    *ImageSize = Size;\r
     DEBUG ((DEBUG_VERBOSE, "FmpDxe(%s): GetImage() - ImageSize is to small.\n", mImageIdName));\r
     Status = EFI_BUFFER_TOO_SMALL;\r
     goto cleanup;\r
@@ -678,17 +602,8 @@ GetTheImage (
     goto cleanup;\r
   }\r
 \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
+  Status = FmpDeviceGetImage (Image, ImageSize);\r
 cleanup:\r
-  if (ImageBuffer != NULL) {\r
-    FreePool (ImageBuffer);\r
-  }\r
 \r
   return Status;\r
 }\r
@@ -697,8 +612,9 @@ cleanup:
   Helper function to safely retrieve the FMP header from\r
   within an EFI_FIRMWARE_IMAGE_AUTHENTICATION structure.\r
 \r
-  @param[in]   Image        Pointer to the image.\r
-  @param[in]   ImageSize    Size of the image.\r
+  @param[in]   Image                 Pointer to the image.\r
+  @param[in]   ImageSize             Size of the image.\r
+  @param[in]   AdditionalHeaderSize  Size of any headers that cannot be calculated by this function.\r
   @param[out]  PayloadSize\r
 \r
   @retval  !NULL  Valid pointer to the header.\r
@@ -709,22 +625,23 @@ VOID *
 GetFmpHeader (\r
   IN  CONST EFI_FIRMWARE_IMAGE_AUTHENTICATION  *Image,\r
   IN  CONST UINTN                              ImageSize,\r
+  IN  CONST UINTN                              AdditionalHeaderSize,\r
   OUT UINTN                                    *PayloadSize\r
   )\r
 {\r
   //\r
   // Check to make sure that operation can be safely performed.\r
   //\r
-  if (((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) < (UINTN)Image || \\r
-      ((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) >= (UINTN)Image + ImageSize) {\r
+  if (((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) + AdditionalHeaderSize < (UINTN)Image || \\r
+      ((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) + AdditionalHeaderSize >= (UINTN)Image + ImageSize) {\r
     //\r
     // Pointer overflow. Invalid image.\r
     //\r
     return NULL;\r
   }\r
 \r
-  *PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength);\r
-  return (VOID *)((UINT8 *)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength);\r
+  *PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength + AdditionalHeaderSize);\r
+  return (VOID *)((UINT8 *)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength  + AdditionalHeaderSize);\r
 }\r
 \r
 /**\r
@@ -811,8 +728,6 @@ CheckTheImage (
   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
@@ -850,6 +765,11 @@ CheckTheImage (
   //\r
   *ImageUpdatable = IMAGE_UPDATABLE_VALID;\r
 \r
+  //\r
+  // Set to satisfied and then if dependency evaluates to false it will update this flag.\r
+  //\r
+  Private->DependenciesSatisfied = TRUE;\r
+\r
   if (Image == NULL) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckImage() - Image Pointer Parameter is NULL.\n", mImageIdName));\r
     //\r
@@ -935,11 +855,15 @@ CheckTheImage (
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Get the dependency from Image.\r
+  //\r
+  Dependencies = GetImageDependency ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &DependenciesSize);\r
 \r
   //\r
   // Check the FmpPayloadHeader\r
   //\r
-  FmpPayloadHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &FmpPayloadSize );\r
+  FmpPayloadHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, DependenciesSize, &FmpPayloadSize );\r
   if (FmpPayloadHeader == NULL) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpHeader failed.\n", mImageIdName));\r
     Status = EFI_ABORTED;\r
@@ -947,33 +871,10 @@ CheckTheImage (
   }\r
   Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);\r
   if (EFI_ERROR (Status)) {\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
+    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
 \r
   //\r
@@ -993,14 +894,9 @@ CheckTheImage (
   //\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
+  Private->DependenciesSatisfied = CheckFmpDependency (Private->Descriptor.ImageTypeId, Version, Dependencies, DependenciesSize);\r
+  if (!Private->DependenciesSatisfied) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency check failed.\n", mImageIdName));\r
     *ImageUpdatable = IMAGE_UPDATABLE_INVALID;\r
     Status = EFI_SUCCESS;\r
     goto cleanup;\r
@@ -1113,9 +1009,6 @@ SetTheImage (
   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
@@ -1128,8 +1021,6 @@ SetTheImage (
   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
@@ -1161,11 +1052,6 @@ 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
@@ -1178,32 +1064,22 @@ SetTheImage (
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Get the dependency from Image.\r
+  //\r
+  Dependencies = GetImageDependency ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &DependenciesSize);\r
+\r
   //\r
   // No functional error in CheckTheImage.  Attempt to get the Version to\r
   // support better error reporting.\r
   //\r
-  FmpHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &FmpPayloadSize );\r
+  FmpHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, DependenciesSize, &FmpPayloadSize );\r
   if (FmpHeader == NULL) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetFmpHeader failed.\n", mImageIdName));\r
     Status = EFI_ABORTED;\r
     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
@@ -1218,10 +1094,8 @@ 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
+    if (Private->DependenciesSatisfied == FALSE) {\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
@@ -1323,34 +1197,6 @@ SetTheImage (
     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
@@ -1360,8 +1206,8 @@ SetTheImage (
   //Copy the requested image to the firmware using the FmpDeviceLib\r
   //\r
   Status = FmpDeviceSetImage (\r
-             ImageBuffer,\r
-             ImageBufferSize,\r
+             (((UINT8 *)Image) + AllHeaderSize),\r
+             ImageSize - AllHeaderSize,\r
              VendorCode,\r
              FmpDxeProgress,\r
              IncomingFwVersion,\r
@@ -1372,6 +1218,16 @@ SetTheImage (
     goto cleanup;\r
   }\r
 \r
+  //\r
+  // Store the dependency\r
+  //\r
+  if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {\r
+    Status = SaveFmpDependency (Dependencies, DependenciesSize);\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() SaveFmpDependency from FmpDependencyCheckLib failed. (%r)\n", mImageIdName, Status));\r
+    }\r
+    Status = EFI_SUCCESS;\r
+  }\r
 \r
   //\r
   // Finished the update without error\r
@@ -1398,10 +1254,6 @@ 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