sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FmpDevicePkg/FmpDxe: Use new Fmp dependency libraries

Browse Source 
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2696

Remove the orginal Fmp Capsule Dependency implement, and use new
FmpDependencyLib, FmpDependencyCheckLib and FmpDependencyDeviceLib
APIs instead.
A platform can perform the dependency check in a platform specific
manner by implementing its own FmpDependencyCheckLib.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Signed-off-by: Wei6 Xu <wei6.xu@intel.com>
Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Wei6 Xu
2020-05-12 13:33:54 +08:00
committed by mergify[bot]
parent ba86bb2c4d
commit 0f30087b9a
6 changed files with 64 additions and 948 deletions
Download Patch File Download Diff File Expand all files Collapse all files

256
FmpDevicePkg/FmpDxe/FmpDxe.c
View File

@@ -12,7 +12,6 @@
#include "FmpDxe.h"
#include "VariableSupport.h"
#include "Dependency.h"
///
/// FILE_GUID from FmpDxe.inf. When FmpDxe.inf is used in a platform, the
@@ -81,7 +80,8 @@ const FIRMWARE_MANAGEMENT_PRIVATE_DATA mFirmwareManagementPrivateDataTemplate =
NULL, // LsvVariableName
NULL, // LastAttemptStatusVariableName
NULL, // LastAttemptVersionVariableName
NULL // FmpStateVariableName
NULL, // FmpStateVariableName
TRUE // DependenciesSatisfied
};
///
@@ -276,13 +276,7 @@ PopulateDescriptor (
)
{
EFI_STATUS Status;
VOID *Image;
UINTN ImageSize;
BOOLEAN IsDepexValid;
UINT32 DepexSize;
Image = NULL;
ImageSize = 0;
UINT32 DependenciesSize;
if (Private->DescriptorPopulated) {
return;
@@ -387,46 +381,18 @@ PopulateDescriptor (
Private->Descriptor.LastAttemptStatus = GetLastAttemptStatusFromVariable (Private);
//
// Get the dependency from the FmpDeviceLib and populate it to the descriptor.
// Get the dependency from the FmpDependencyDeviceLib.
//
Private->Descriptor.Dependencies = NULL;
//
// Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY
//
if (Private->Descriptor.AttributesSupported & IMAGE_ATTRIBUTE_DEPENDENCY) {
//
// The parameter "Image" of FmpDeviceGetImage() is extended to contain the dependency.
// Get the dependency from the Image.
//
ImageSize = Private->Descriptor.Size;
Image = AllocatePool (ImageSize);
if (Image != NULL) {
Status = FmpDeviceGetImage (Image, &ImageSize);
if (Status == EFI_BUFFER_TOO_SMALL) {
FreePool (Image);
Image = AllocatePool (ImageSize);
if (Image != NULL) {
Status = FmpDeviceGetImage (Image, &ImageSize);
}
}
}
if (!EFI_ERROR (Status) && Image != NULL) {
IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP *) Image, ImageSize, &DepexSize);
if (IsDepexValid) {
Private->Descriptor.Dependencies = AllocatePool (DepexSize);
if (Private->Descriptor.Dependencies != NULL) {
CopyMem (Private->Descriptor.Dependencies->Dependencies, Image, DepexSize);
}
}
}
if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {
Private->Descriptor.Dependencies = GetFmpDependency (&DependenciesSize);
}
Private->DescriptorPopulated = TRUE;
if (Image != NULL) {
FreePool (Image);
}
}
/**
@@ -588,17 +554,12 @@ GetTheImage (
EFI_STATUS Status;
FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private;
UINTN Size;
UINT8 *ImageBuffer;
UINTN ImageBufferSize;
UINT32 DepexSize;
if (!FeaturePcdGet (PcdFmpDeviceStorageAccessEnable)) {
return EFI_UNSUPPORTED;
}
Status = EFI_SUCCESS;
ImageBuffer = NULL;
DepexSize = 0;
Status = EFI_SUCCESS;
//
// Retrieve the private context structure
@@ -628,45 +589,8 @@ GetTheImage (
if (EFI_ERROR (Status)) {
Size = 0;
}
//
// The parameter "Image" of FmpDeviceGetImage() is extended to contain the dependency.
// Get the Fmp Payload from the Image.
//
ImageBufferSize = Size;
ImageBuffer = AllocatePool (ImageBufferSize);
if (ImageBuffer == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImage() - AllocatePool fails.\n", mImageIdName));
Status = EFI_NOT_FOUND;
goto cleanup;
}
Status = FmpDeviceGetImage (ImageBuffer, &ImageBufferSize);
if (Status == EFI_BUFFER_TOO_SMALL) {
FreePool (ImageBuffer);
ImageBuffer = AllocatePool (ImageBufferSize);
if (ImageBuffer == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImage() - AllocatePool fails.\n", mImageIdName));
Status = EFI_NOT_FOUND;
goto cleanup;
}
Status = FmpDeviceGetImage (ImageBuffer, &ImageBufferSize);
}
if (EFI_ERROR (Status)) {
goto cleanup;
}
//
// Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY
//
if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {
//
// Validate the dependency to get its size.
//
ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP *) ImageBuffer, ImageBufferSize, &DepexSize);
}
if (*ImageSize < ImageBufferSize - DepexSize) {
*ImageSize = ImageBufferSize - DepexSize;
if (*ImageSize < Size) {
*ImageSize = Size;
DEBUG ((DEBUG_VERBOSE, "FmpDxe(%s): GetImage() - ImageSize is to small.\n", mImageIdName));
Status = EFI_BUFFER_TOO_SMALL;
goto cleanup;
@@ -678,17 +602,8 @@ GetTheImage (
goto cleanup;
}
//
// Image is after the dependency expression.
//
*ImageSize = ImageBufferSize - DepexSize;
CopyMem (Image, ImageBuffer + DepexSize, *ImageSize);
Status = EFI_SUCCESS;
Status = FmpDeviceGetImage (Image, ImageSize);
cleanup:
if (ImageBuffer != NULL) {
FreePool (ImageBuffer);
}
return Status;
}
@@ -697,8 +612,9 @@ cleanup:
Helper function to safely retrieve the FMP header from
within an EFI_FIRMWARE_IMAGE_AUTHENTICATION structure.
@param[in] Image Pointer to the image.
@param[in] ImageSize Size of the image.
@param[in] Image Pointer to the image.
@param[in] ImageSize Size of the image.
@param[in] AdditionalHeaderSize Size of any headers that cannot be calculated by this function.
@param[out] PayloadSize
@retval !NULL Valid pointer to the header.
@@ -709,22 +625,23 @@ VOID *
GetFmpHeader (
IN CONST EFI_FIRMWARE_IMAGE_AUTHENTICATION *Image,
IN CONST UINTN ImageSize,
IN CONST UINTN AdditionalHeaderSize,
OUT UINTN *PayloadSize
)
{
//
// Check to make sure that operation can be safely performed.
//
if (((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) < (UINTN)Image || \
((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) >= (UINTN)Image + ImageSize) {
if (((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) + AdditionalHeaderSize < (UINTN)Image || \
((UINTN)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength) + AdditionalHeaderSize >= (UINTN)Image + ImageSize) {
//
// Pointer overflow. Invalid image.
//
return NULL;
}
*PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength);
return (VOID *)((UINT8 *)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength);
*PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength + AdditionalHeaderSize);
return (VOID *)((UINT8 *)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength + AdditionalHeaderSize);
}
/**
@@ -811,8 +728,6 @@ CheckTheImage (
UINT8 *PublicKeyDataXdrEnd;
EFI_FIRMWARE_IMAGE_DEP *Dependencies;
UINT32 DependenciesSize;
BOOLEAN IsDepexValid;
BOOLEAN IsDepexSatisfied;
Status = EFI_SUCCESS;
RawSize = 0;
@@ -850,6 +765,11 @@ CheckTheImage (
//
*ImageUpdatable = IMAGE_UPDATABLE_VALID;
//
// Set to satisfied and then if dependency evaluates to false it will update this flag.
//
Private->DependenciesSatisfied = TRUE;
if (Image == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckImage() - Image Pointer Parameter is NULL.\n", mImageIdName));
//
@@ -935,11 +855,15 @@ CheckTheImage (
goto cleanup;
}
//
// Get the dependency from Image.
//
Dependencies = GetImageDependency ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &DependenciesSize);
//
// Check the FmpPayloadHeader
//
FmpPayloadHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &FmpPayloadSize );
FmpPayloadHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, DependenciesSize, &FmpPayloadSize );
if (FmpPayloadHeader == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpHeader failed.\n", mImageIdName));
Status = EFI_ABORTED;
@@ -947,33 +871,10 @@ CheckTheImage (
}
Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);
if (EFI_ERROR (Status)) {
//
// Check if there is dependency expression
//
IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP*) FmpPayloadHeader, FmpPayloadSize, &DependenciesSize);
if (IsDepexValid && (DependenciesSize < FmpPayloadSize)) {
//
// Fmp payload is after dependency expression
//
Dependencies = (EFI_FIRMWARE_IMAGE_DEP*) FmpPayloadHeader;
FmpPayloadHeader = (UINT8 *) Dependencies + DependenciesSize;
FmpPayloadSize = FmpPayloadSize - DependenciesSize;
Status = GetFmpPayloadHeaderVersion (FmpPayloadHeader, FmpPayloadSize, &Version);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpPayloadHeaderVersion failed %r.\n", mImageIdName, Status));
*ImageUpdatable = IMAGE_UPDATABLE_INVALID;
Status = EFI_SUCCESS;
goto cleanup;
}
} else {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency is invalid.\n", mImageIdName));
mDependenciesCheckStatus = DEPENDENCIES_INVALID;
*ImageUpdatable = IMAGE_UPDATABLE_INVALID;
Status = EFI_SUCCESS;
goto cleanup;
}
} else {
DEBUG ((DEBUG_WARN, "FmpDxe(%s): CheckTheImage() - No dependency associated in image.\n", mImageIdName));
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - GetFmpPayloadHeaderVersion failed %r.\n", mImageIdName, Status));
*ImageUpdatable = IMAGE_UPDATABLE_INVALID;
Status = EFI_SUCCESS;
goto cleanup;
}
//
@@ -993,14 +894,9 @@ CheckTheImage (
//
// Evaluate dependency expression
//
Status = EvaluateImageDependencies (Private->Descriptor.ImageTypeId, Version, Dependencies, DependenciesSize, &IsDepexSatisfied);
if (!IsDepexSatisfied || EFI_ERROR (Status)) {
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency check failed %r.\n", mImageIdName, Status));
} else {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency is not satisfied.\n", mImageIdName));
}
mDependenciesCheckStatus = DEPENDENCIES_UNSATISFIED;
Private->DependenciesSatisfied = CheckFmpDependency (Private->Descriptor.ImageTypeId, Version, Dependencies, DependenciesSize);
if (!Private->DependenciesSatisfied) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckTheImage() - Dependency check failed.\n", mImageIdName));
*ImageUpdatable = IMAGE_UPDATABLE_INVALID;
Status = EFI_SUCCESS;
goto cleanup;
@@ -1113,9 +1009,6 @@ SetTheImage (
UINT32 LowestSupportedVersion;
EFI_FIRMWARE_IMAGE_DEP *Dependencies;
UINT32 DependenciesSize;
BOOLEAN IsDepexValid;
UINT8 *ImageBuffer;
UINTN ImageBufferSize;
Status = EFI_SUCCESS;
Updateable = 0;
@@ -1128,8 +1021,6 @@ SetTheImage (
LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL;
Dependencies = NULL;
DependenciesSize = 0;
ImageBuffer = NULL;
ImageBufferSize = 0;
if (!FeaturePcdGet (PcdFmpDeviceStorageAccessEnable)) {
return EFI_UNSUPPORTED;
@@ -1161,11 +1052,6 @@ SetTheImage (
goto cleanup;
}
//
// Set check status to satisfied before CheckTheImage()
//
mDependenciesCheckStatus = DEPENDENCIES_SATISFIED;
//
// Call check image to verify the image
//
@@ -1178,32 +1064,22 @@ SetTheImage (
goto cleanup;
}
//
// Get the dependency from Image.
//
Dependencies = GetImageDependency ((EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &DependenciesSize);
//
// No functional error in CheckTheImage. Attempt to get the Version to
// support better error reporting.
//
FmpHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, &FmpPayloadSize );
FmpHeader = GetFmpHeader ( (EFI_FIRMWARE_IMAGE_AUTHENTICATION *)Image, ImageSize, DependenciesSize, &FmpPayloadSize );
if (FmpHeader == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - GetFmpHeader failed.\n", mImageIdName));
Status = EFI_ABORTED;
goto cleanup;
}
Status = GetFmpPayloadHeaderVersion (FmpHeader, FmpPayloadSize, &IncomingFwVersion);
if (EFI_ERROR (Status)) {
//
// Check if there is dependency expression
//
IsDepexValid = ValidateImageDepex ((EFI_FIRMWARE_IMAGE_DEP*) FmpHeader, FmpPayloadSize, &DependenciesSize);
if (IsDepexValid && (DependenciesSize < FmpPayloadSize)) {
//
// Fmp payload is after dependency expression
//
Dependencies = (EFI_FIRMWARE_IMAGE_DEP*) FmpHeader;
FmpHeader = (UINT8 *) FmpHeader + DependenciesSize;
FmpPayloadSize = FmpPayloadSize - DependenciesSize;
Status = GetFmpPayloadHeaderVersion (FmpHeader, FmpPayloadSize, &IncomingFwVersion);
}
}
if (!EFI_ERROR (Status)) {
//
// Set to actual value
@@ -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",
mImageIdName, Updateable)
);
if (mDependenciesCheckStatus == DEPENDENCIES_UNSATISFIED) {
if (Private->DependenciesSatisfied == FALSE) {
LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES;
} else if (mDependenciesCheckStatus == DEPENDENCIES_INVALID) {
LastAttemptStatus = LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT;
}
Status = EFI_ABORTED;
goto cleanup;
@@ -1323,34 +1197,6 @@ SetTheImage (
goto cleanup;
}
//
// Check the attribute IMAGE_ATTRIBUTE_DEPENDENCY
//
if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {
//
// To support saving dependency, extend param "Image" of FmpDeviceSetImage() to
// contain the dependency inside. FmpDeviceSetImage() is responsible for saving
// the dependency which can be used for future dependency check.
//
ImageBufferSize = DependenciesSize + ImageSize - AllHeaderSize;
ImageBuffer = AllocatePool (ImageBufferSize);
if (ImageBuffer == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - AllocatePool failed.\n", mImageIdName));
Status = EFI_ABORTED;
goto cleanup;
}
CopyMem (ImageBuffer, Dependencies->Dependencies, DependenciesSize);
CopyMem (ImageBuffer + DependenciesSize, (UINT8 *)Image + AllHeaderSize, ImageBufferSize - DependenciesSize);
} else {
ImageBufferSize = ImageSize - AllHeaderSize;
ImageBuffer = AllocateCopyPool(ImageBufferSize, (UINT8 *)Image + AllHeaderSize);
if (ImageBuffer == NULL) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - AllocatePool failed.\n", mImageIdName));
Status = EFI_ABORTED;
goto cleanup;
}
}
//
// Indicate that control is handed off to FmpDeviceLib
//
@@ -1360,8 +1206,8 @@ SetTheImage (
//Copy the requested image to the firmware using the FmpDeviceLib
//
Status = FmpDeviceSetImage (
ImageBuffer,
ImageBufferSize,
(((UINT8 *)Image) + AllHeaderSize),
ImageSize - AllHeaderSize,
VendorCode,
FmpDxeProgress,
IncomingFwVersion,
@@ -1372,6 +1218,16 @@ SetTheImage (
goto cleanup;
}
//
// Store the dependency
//
if (Private->Descriptor.AttributesSetting & IMAGE_ATTRIBUTE_DEPENDENCY) {
Status = SaveFmpDependency (Dependencies, DependenciesSize);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() SaveFmpDependency from FmpDependencyCheckLib failed. (%r)\n", mImageIdName, Status));
}
Status = EFI_SUCCESS;
}
//
// Finished the update without error
@@ -1398,10 +1254,6 @@ SetTheImage (
LastAttemptStatus = LAST_ATTEMPT_STATUS_SUCCESS;
cleanup:
if (ImageBuffer != NULL) {
FreePool (ImageBuffer);
}
mProgressFunc = NULL;
SetLastAttemptStatusInVariable (Private, LastAttemptStatus);