tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

QuarkPlatformPkg/PlatformFlashAccessLib: Add progress API 

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

Add PerformFlashWriteWithProgress() to the PlatformFlashAccessLib.
This allows the platform to inform the user of progress when a
firmware storage device is being updated with a new firmware
image.

Cc: Kelly Steele <kelly.steele@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
This commit is contained in:
Michael D Kinney 2018-03-16 19:17:45 -07:00
parent 5274d681fe
commit 99758ffd11
1 changed files with 70 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
QuarkPlatformPkg/Feature/Capsule/Library/PlatformFlashAccessLib/PlatformFlashAccessLibDxe.c
View File

@ -1,7 +1,7 @@
/** @file /** @file
Platform Flash Access library. Platform Flash Access library.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR> Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -112,13 +112,29 @@ FlashFdErase (
} }
/** /**
Perform flash write opreation. Perform flash write operation with progress indicator. The start and end
completion percentage values are passed into this function. If the requested
flash write operation is broken up, then completion percentage between the
start and end values may be passed to the provided Progress function. The
caller of this function is required to call the Progress function for the
start and end completion percentage values. This allows the Progress,
StartPercentage, and EndPercentage parameters to be ignored if the requested
flash write operation can not be broken up
@param[in] FirmwareType The type of firmware. @param[in] FirmwareType The type of firmware.
@param[in] FlashAddress The address of flash device to be accessed. @param[in] FlashAddress The address of flash device to be accessed.
@param[in] FlashAddressType The type of flash device address. @param[in] FlashAddressType The type of flash device address.
@param[in] Buffer The pointer to the data buffer. @param[in] Buffer The pointer to the data buffer.
@param[in] Length The length of data buffer in bytes. @param[in] Length The length of data buffer in bytes.
@param[in] Progress A function used report the progress of the
firmware update. This is an optional parameter
that may be NULL.
@param[in] StartPercentage The start completion percentage value that may
be used to report progress during the flash
write operation.
@param[in] EndPercentage The end completion percentage value that may
be used to report progress during the flash
write operation.
@retval EFI_SUCCESS The operation returns successfully. @retval EFI_SUCCESS The operation returns successfully.
@retval EFI_WRITE_PROTECTED The flash device is read only. @retval EFI_WRITE_PROTECTED The flash device is read only.
@ -127,12 +143,15 @@ FlashFdErase (
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PerformFlashWrite ( PerformFlashWriteWithProgress (
IN PLATFORM_FIRMWARE_TYPE FirmwareType, IN PLATFORM_FIRMWARE_TYPE FirmwareType,
IN EFI_PHYSICAL_ADDRESS FlashAddress, IN EFI_PHYSICAL_ADDRESS FlashAddress,
IN FLASH_ADDRESS_TYPE FlashAddressType, IN FLASH_ADDRESS_TYPE FlashAddressType,
IN VOID *Buffer, IN VOID *Buffer,
IN UINTN Length IN UINTN Length,
IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress, OPTIONAL
IN UINTN StartPercentage,
IN UINTN EndPercentage
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
@ -150,6 +169,10 @@ PerformFlashWrite (
// //
SectorNum = Length / SPI_ERASE_SECTOR_SIZE; SectorNum = Length / SPI_ERASE_SECTOR_SIZE;
for (Index = 0; Index < SectorNum; Index++){ for (Index = 0; Index < SectorNum; Index++){
if (Progress != NULL) {
Progress (StartPercentage + ((Index * (EndPercentage - StartPercentage)) / SectorNum));
}
if (CompareMem( if (CompareMem(
(UINT8 *)(UINTN)(FlashAddress + mInternalFdAddress) + Index * SPI_ERASE_SECTOR_SIZE, (UINT8 *)(UINTN)(FlashAddress + mInternalFdAddress) + Index * SPI_ERASE_SECTOR_SIZE,
(UINT8 *)Buffer + Index * SPI_ERASE_SECTOR_SIZE, (UINT8 *)Buffer + Index * SPI_ERASE_SECTOR_SIZE,
@ -175,10 +198,49 @@ PerformFlashWrite (
break; break;
} }
} }
if (Progress != NULL) {
Progress (EndPercentage);
}
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/**
Perform flash write operation.
@param[in] FirmwareType The type of firmware.
@param[in] FlashAddress The address of flash device to be accessed.
@param[in] FlashAddressType The type of flash device address.
@param[in] Buffer The pointer to the data buffer.
@param[in] Length The length of data buffer in bytes.
@retval EFI_SUCCESS The operation returns successfully.
@retval EFI_WRITE_PROTECTED The flash device is read only.
@retval EFI_UNSUPPORTED The flash device access is unsupported.
@retval EFI_INVALID_PARAMETER The input parameter is not valid.
**/
EFI_STATUS
EFIAPI
PerformFlashWrite (
IN PLATFORM_FIRMWARE_TYPE FirmwareType,
IN EFI_PHYSICAL_ADDRESS FlashAddress,
IN FLASH_ADDRESS_TYPE FlashAddressType,
IN VOID *Buffer,
IN UINTN Length
)
{
return PerformFlashWriteWithProgress (
FirmwareType,
FlashAddress,
FlashAddressType,
Buffer,
Length,
NULL,
0,
0
);
}
/** /**
Platform Flash Access Lib Constructor. Platform Flash Access Lib Constructor.