From: Ard Biesheuvel <ard.biesheuvel@linaro.org>
To: "Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: "edk2-devel@lists.01.org" <edk2-devel@lists.01.org>,
Leif Lindholm <leif.lindholm@linaro.org>
Subject: Re: [edk2-platforms Patch V2 3/6] SynQuacer/PlatformFlashAccessLib: Add progress API
Date: Thu, 12 Apr 2018 08:17:57 +0200 [thread overview]
Message-ID: <CAKv+Gu8SEAMBc4jp_95-kOKbxYLNiQEqdYXFXOkM=2xWm36QCg@mail.gmail.com> (raw)
In-Reply-To: <20180412010131.21848-4-michael.d.kinney@intel.com>
On 12 April 2018 at 03:01, Kinney, Michael D <michael.d.kinney@intel.com> wrote:
> 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: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
IIUC, this is the bare minimum to get it building again, and we'll
need to replace the existing progress indicator implementation with
calls into the generic on, right? That's fine, but it would be useful
to mention this in the commit log.
> ---
> .../SynQuacerPlatformFlashAccessLib.c | 78 +++++++++++++++++++---
> 1 file changed, 67 insertions(+), 11 deletions(-)
>
> diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c
> index fbb8f1f9e4..4cf8318a93 100644
> --- a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c
> +++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c
> @@ -2,6 +2,7 @@
> Platform flash device access library for Socionext SynQuacer
>
> Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>
> + Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
>
> This program and the accompanying materials
> are licensed and made available under the terms and conditions of the BSD License
> @@ -117,13 +118,29 @@ GetFvbByAddress (
> }
>
> /**
> - Perform flash write operation.
> + 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] 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.
> + @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_WRITE_PROTECTED The flash device is read only.
> @@ -132,12 +149,15 @@ GetFvbByAddress (
> **/
> 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
> +PerformFlashWriteWithProgress (
> + IN PLATFORM_FIRMWARE_TYPE FirmwareType,
> + IN EFI_PHYSICAL_ADDRESS FlashAddress,
> + IN FLASH_ADDRESS_TYPE FlashAddressType,
> + IN VOID *Buffer,
> + IN UINTN Length,
> + IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress, OPTIONAL
> + IN UINTN StartPercentage,
> + IN UINTN EndPercentage
> )
> {
> EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
> @@ -150,7 +170,7 @@ PerformFlashWrite (
> EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Black;
> EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION White;
> UINTN Resolution;
> - UINTN Progress;
> + UINTN CurrentProgress;
> BOOLEAN HaveBootGraphics;
>
> Black.Raw = 0x00000000;
> @@ -228,7 +248,7 @@ PerformFlashWrite (
>
> if (HaveBootGraphics) {
> Resolution = (BlockSize * 100) / Length + 1;
> - Progress = 0;
> + CurrentProgress = 0;
>
> Status = BootLogoUpdateProgress (White.Pixel, Black.Pixel,
> L"Updating firmware - please wait", Black.Pixel, 100, 0);
> @@ -268,8 +288,8 @@ PerformFlashWrite (
> if (HaveBootGraphics) {
> Status = BootLogoUpdateProgress (White.Pixel, Black.Pixel,
> L"Updating firmware - please wait", White.Pixel,
> - Progress + Resolution, Progress);
> - Progress += Resolution;
> + CurrentProgress + Resolution, CurrentProgress);
> + CurrentProgress += Resolution;
> } else {
> Print (L".");
> }
> @@ -284,3 +304,39 @@ PerformFlashWrite (
>
> 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
> + );
> +}
> --
> 2.14.2.windows.3
>
next prev parent reply other threads:[~2018-04-12 6:17 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-12 1:01 [edk2-platforms Patch V2 0/6] Add DisplayUpdateProgressLib for capsules Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 1/6] Styx/PlatformFlashAccessLib: Add progress API Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 2/6] Hisilicon/PlatformFlashAccessLib: " Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 3/6] SynQuacer/PlatformFlashAccessLib: " Kinney, Michael D
2018-04-12 6:17 ` Ard Biesheuvel [this message]
2018-04-12 6:54 ` Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 4/6] AMD/OverdriveBoard: Add DisplayUpdateProgressLib mapping Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 5/6] Socionext/DeveloperBox: " Kinney, Michael D
2018-04-12 1:01 ` [edk2-platforms Patch V2 6/6] Socionext/SynQuacerEvalBoard: " Kinney, Michael D
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAKv+Gu8SEAMBc4jp_95-kOKbxYLNiQEqdYXFXOkM=2xWm36QCg@mail.gmail.com' \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox