From: Leif Lindholm <leif.lindholm@linaro.org>
To: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: edk2-devel@lists.01.org, daniel.thompson@linaro.org,
masami.hiramatsu@linaro.org
Subject: Re: [PATCH edk2-platforms v2 15/23] Silicon/SynQuacer: implement PlatformFlashAccessLib
Date: Thu, 26 Oct 2017 22:22:59 +0100 [thread overview]
Message-ID: <20171026212259.kkxy6y2rocbkq3rp@bivouac.eciton.net> (raw)
In-Reply-To: <20171025175947.22798-16-ard.biesheuvel@linaro.org>
On Wed, Oct 25, 2017 at 06:59:39PM +0100, Ard Biesheuvel wrote:
> In order to support capsule update, implement PlatformFlashAccessLib that
> exposes write access to the UEFI NOR partition.
>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> ---
> Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c | 250 ++++++++++++++++++++
> Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.inf | 38 +++
> 2 files changed, 288 insertions(+)
>
> diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c
> new file mode 100644
> index 000000000000..cb4e1eece436
> --- /dev/null
> +++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.c
> @@ -0,0 +1,250 @@
> +/** @file
> + Platform flash device access library NULL instance.
!NULL!
> +
> + Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
Linaro?
If you fold those in:
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
> + This program and the accompanying materials
> + 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
> + http://opensource.org/licenses/bsd-license.php
> +
> + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +
> +**/
> +
> +#include <PiDxe.h>
> +
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/DxeServicesTableLib.h>
> +#include <Library/MemoryAllocationLib.h>
> +#include <Library/PlatformFlashAccessLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +
> +#include <Protocol/FirmwareVolumeBlock.h>
> +
> +/**
> + Gets firmware volume block handle by given address.
> +
> + This function gets firmware volume block handle whose
> + address range contains the parameter Address.
> +
> + @param[in] Address Address which should be contained
> + by returned FVB handle.
> + @param[out] FvbHandle Pointer to FVB handle for output.
> +
> + @retval EFI_SUCCESS FVB handle successfully returned.
> + @retval EFI_NOT_FOUND Failed to find FVB handle by address.
> +
> +**/
> +STATIC
> +EFI_STATUS
> +GetFvbByAddress (
> + IN EFI_PHYSICAL_ADDRESS Address,
> + OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **OutFvb,
> + OUT EFI_PHYSICAL_ADDRESS *FvbBaseAddress
> + )
> +{
> + EFI_STATUS Status;
> + EFI_HANDLE *HandleBuffer;
> + UINTN HandleCount;
> + UINTN Index;
> + EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
> + EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
> + EFI_FVB_ATTRIBUTES_2 Attributes;
> +
> + //
> + // Locate all handles with Firmware Volume Block protocol
> + //
> + Status = gBS->LocateHandleBuffer (
> + ByProtocol,
> + &gEfiFirmwareVolumeBlockProtocolGuid,
> + NULL,
> + &HandleCount,
> + &HandleBuffer
> + );
> + if (EFI_ERROR (Status)) {
> + return EFI_NOT_FOUND;
> + }
> + //
> + // Traverse all the handles, searching for the one containing parameter Address
> + //
> + for (Index = 0; Index < HandleCount; Index += 1) {
> + Status = gBS->HandleProtocol (
> + HandleBuffer[Index],
> + &gEfiFirmwareVolumeBlockProtocolGuid,
> + (VOID **) &Fvb
> + );
> + if (EFI_ERROR (Status)) {
> + Status = EFI_NOT_FOUND;
> + break;
> + }
> + //
> + // Checks if the address range of this handle contains parameter Address
> + //
> + Status = Fvb->GetPhysicalAddress (Fvb, FvbBaseAddress);
> + if (EFI_ERROR (Status)) {
> + continue;
> + }
> +
> + //
> + // Check if this FVB is writable: DXE core produces FVB protocols for
> + // firmware volumes as well.
> + //
> + Status = Fvb->GetAttributes (Fvb, &Attributes);
> + if (EFI_ERROR (Status) || !(Attributes & EFI_FVB2_WRITE_STATUS)) {
> + DEBUG ((DEBUG_INFO,
> + "%a: ignoring read-only FVB protocol implementation\n",
> + __FUNCTION__));
> + continue;
> + }
> +
> + FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) *FvbBaseAddress);
> + if ((Address >= *FvbBaseAddress) && (Address <= (*FvbBaseAddress + FwVolHeader->FvLength))) {
> + *OutFvb = Fvb;
> + Status = EFI_SUCCESS;
> + break;
> + }
> +
> + Status = EFI_NOT_FOUND;
> + }
> +
> + FreePool (HandleBuffer);
> + return Status;
> +}
> +
> +/**
> + 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
> + )
> +{
> + EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
> + EFI_STATUS Status;
> + UINTN BlockSize;
> + UINTN NumberOfBlocks;
> + EFI_LBA Lba;
> + EFI_PHYSICAL_ADDRESS FvbBaseAddress;
> + UINTN NumBytes;
> +
> + if (FlashAddressType != FlashAddressTypeAbsoluteAddress) {
> + DEBUG ((DEBUG_ERROR, "%a: only FlashAddressTypeAbsoluteAddress supported\n",
> + __FUNCTION__));
> +
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + if (FirmwareType != PlatformFirmwareTypeSystemFirmware) {
> + DEBUG ((DEBUG_ERROR,
> + "%a: only PlatformFirmwareTypeSystemFirmware supported\n",
> + __FUNCTION__));
> +
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + //
> + // Locate the gEfiFirmwareVolumeBlockProtocolGuid implementation
> + // that covers the system firmware
> + //
> + Fvb = NULL;
> + Status = GetFvbByAddress (FlashAddress, &Fvb, &FvbBaseAddress);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_ERROR,
> + "%a: failed to locate FVB handle for address 0x%llx - %r\n",
> + __FUNCTION__, FlashAddress, Status));
> + return Status;
> + }
> +
> + Status = Fvb->GetBlockSize(Fvb, 0, &BlockSize, &NumberOfBlocks);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_ERROR, "%a: failed to get FVB blocksize - %r\n",
> + __FUNCTION__, Status));
> + return Status;
> + }
> +
> + if ((Length % BlockSize) != 0) {
> + DEBUG ((DEBUG_ERROR,
> + "%a: Length 0x%lx is not a multiple of the blocksize 0x%lx\n",
> + __FUNCTION__, Length, BlockSize));
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + Lba = (FlashAddress - FvbBaseAddress) / BlockSize;
> + if (Lba > NumberOfBlocks - 1) {
> + DEBUG ((DEBUG_ERROR,
> + "%a: flash device with non-uniform blocksize not supported\n",
> + __FUNCTION__));
> + return EFI_UNSUPPORTED;
> + }
> +
> + //
> + // Remap the region as device rather than uncached.
> + //
> + Status = gDS->AddMemorySpace (EfiGcdMemoryTypeMemoryMappedIo,
> + FlashAddress, Length, EFI_MEMORY_UC);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_WARN, "%a: gDS->AddMemorySpace () failed - %r\n",
> + __FUNCTION__, Status));
> + }
> +
> + Status = gDS->SetMemorySpaceAttributes (FlashAddress, Length, EFI_MEMORY_UC);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_ERROR, "%a: gDS->SetMemorySpaceAttributes () failed - %r\n",
> + __FUNCTION__, Status));
> + return Status;
> + }
> +
> + //
> + // Erase the region
> + //
> + DEBUG ((DEBUG_INFO, "%a: erasing 0x%llx bytes at address %llx (LBA 0x%lx)\n",
> + __FUNCTION__, Length, FlashAddress, Lba));
> +
> + Status = Fvb->EraseBlocks (Fvb, Lba, Length / BlockSize,
> + EFI_LBA_LIST_TERMINATOR);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_ERROR, "%a: Fvb->EraseBlocks () failed - %r\n",
> + __FUNCTION__, Status));
> + return Status;
> + }
> +
> + while (Length > 0) {
> + //
> + // Write the new data
> + //
> + DEBUG ((DEBUG_INFO, "%a: writing 0x%llx bytes at LBA 0x%lx\n",
> + __FUNCTION__, BlockSize, Lba));
> +
> + NumBytes = BlockSize;
> + Status = Fvb->Write (Fvb, Lba, 0, &NumBytes, Buffer);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((DEBUG_ERROR,
> + "%a: write of LBA 0x%lx failed - %r (NumBytes == 0x%lx)\n",
> + __FUNCTION__, Lba, Status, NumBytes));
> + }
> +
> + Buffer += BlockSize;
> + Length -= BlockSize;
> + Lba++;
> + }
> +
> + return EFI_SUCCESS;
> +}
> diff --git a/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.inf b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.inf
> new file mode 100644
> index 000000000000..33f4795ddcf9
> --- /dev/null
> +++ b/Silicon/Socionext/SynQuacer/Library/SynQuacerPlatformFlashAccessLib/SynQuacerPlatformFlashAccessLib.inf
> @@ -0,0 +1,38 @@
> +## @file
> +# Platform flash device access library.
> +#
> +# Copyright (c) 2017, Linaro, Ltd. All rights reserved.<BR>
> +# This program and the accompanying materials
> +# 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
> +# http://opensource.org/licenses/bsd-license.php
> +#
> +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +#
> +##
> +
> +[Defines]
> + INF_VERSION = 0x00010019
> + BASE_NAME = SynQuacerPlatformFlashAccessLib
> + FILE_GUID = b4e7f39f-ab67-4318-b1ad-c1e211304f0b
> + MODULE_TYPE = BASE
> + VERSION_STRING = 1.0
> + LIBRARY_CLASS = PlatformFlashAccessLib|DXE_DRIVER
> +
> +[Sources]
> + SynQuacerPlatformFlashAccessLib.c
> +
> +[Packages]
> + MdePkg/MdePkg.dec
> + SignedCapsulePkg/SignedCapsulePkg.dec
> +
> +[Protocols]
> + gEfiFirmwareVolumeBlockProtocolGuid
> +
> +[LibraryClasses]
> + BaseMemoryLib
> + DebugLib
> + DxeServicesTableLib
> + UefiBootServicesTableLib
> +
> --
> 2.11.0
>
next prev parent reply other threads:[~2017-10-26 21:19 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-25 17:59 [PATCH edk2-platforms v2 00/23] add support for Socionext Synquacer Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 01/23] Silicon/SynQuacer: add package with platform headers Ard Biesheuvel
2017-10-26 14:39 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 02/23] Silicon/Socionext: add driver for NETSEC network controller Ard Biesheuvel
2017-10-26 14:49 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 03/23] Silicon/SynQuacer: add MemoryInitPeiLib implementation Ard Biesheuvel
2017-10-26 14:56 ` Leif Lindholm
2017-10-26 14:57 ` Ard Biesheuvel
2017-10-26 15:05 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 04/23] Platform: add support for Socionext SynQuacer eval board Ard Biesheuvel
2017-10-26 15:02 ` Leif Lindholm
2017-10-26 15:14 ` Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 05/23] Silicon/SynQuacer: implement PciSegmentLib to support dual RCs Ard Biesheuvel
2017-10-26 15:06 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 06/23] Silicon/SynQuacer: implement PciHostBridgeLib support Ard Biesheuvel
2017-10-26 15:10 ` Leif Lindholm
2017-10-26 15:12 ` Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 07/23] Silicon/SynQuacer: implement EFI_CPU_IO2_PROTOCOL Ard Biesheuvel
2017-10-26 15:13 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 08/23] Platform/SynQuacerEvalBoard: add PCI support Ard Biesheuvel
2017-10-26 15:38 ` Leif Lindholm
2017-10-26 15:41 ` Ard Biesheuvel
2017-10-26 21:49 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 09/23] Platform/SynQuacerEvalBoard: add NETSEC driver Ard Biesheuvel
2017-10-26 15:39 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 10/23] Silicon/SynQuacer: add ACPI support Ard Biesheuvel
2017-10-26 17:13 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 11/23] Silicon/SynQuacer: add device tree support for eval board Ard Biesheuvel
2017-10-26 17:15 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 12/23] Silicon/SynQuacer: add NorFlashPlatformLib implementation Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 13/23] Silicon/Socionext: add driver for SPI NOR flash Ard Biesheuvel
2017-10-26 21:19 ` Leif Lindholm
2017-10-28 14:16 ` Ard Biesheuvel
2017-10-28 21:31 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 14/23] Platform/SynQuacer: incorporate NOR flash and variable drivers Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 15/23] Silicon/SynQuacer: implement PlatformFlashAccessLib Ard Biesheuvel
2017-10-26 21:22 ` Leif Lindholm [this message]
2017-10-25 17:59 ` [PATCH edk2-platforms v2 16/23] SynQuacer/SynQuacerMemoryInitPeiLib: add capsule support Ard Biesheuvel
2017-10-26 21:27 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 17/23] Socionext/SynQuacerEvalBoard: wire up basic " Ard Biesheuvel
2017-10-26 21:28 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 18/23] Socionext/SynQuacerEvalBoard: switch to execute in place Ard Biesheuvel
2017-10-26 21:30 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 19/23] Platform/SynQuacerEvalBoard: add signed capsule update support Ard Biesheuvel
2017-10-26 21:33 ` Leif Lindholm
2017-10-28 13:48 ` Ard Biesheuvel
2017-10-25 17:59 ` [PATCH edk2-platforms v2 20/23] Silicon/SynQuacer/AcpiTables: hide PCI domain #0 Ard Biesheuvel
2017-10-26 21:34 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 21/23] Silicon/SynQuacerPciHostBridgeLib: add workaround to support 32-bit only cards Ard Biesheuvel
2017-10-26 21:35 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 22/23] Platform/Socionext: add support for Socionext Developer Box rev 0.1 Ard Biesheuvel
2017-10-26 21:46 ` Leif Lindholm
2017-10-25 17:59 ` [PATCH edk2-platforms v2 23/23] Platform/DeveloperBox: add ConsolePrefDxe driver Ard Biesheuvel
2017-10-26 21:46 ` Leif Lindholm
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=20171026212259.kkxy6y2rocbkq3rp@bivouac.eciton.net \
--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