Re: [edk2-devel] [PATCH v6 30/36] OvmfPkg/LoongArchVirt: Add NorFlashQemuLib

["maobibo" <maobibo@loongson.cn>]

On 2024/1/5 下午5:46, Chao Li wrote:
> Add NorFlashQemuLib for LoongArch, it is referenced from ArmVirtPkg.
> 
> BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=4584
> 
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Bibo Mao <maobibo@loongson.cn>
> Cc: Dongyan Qian <qiandongyan@loongson.cn>
> Signed-off-by: Chao Li <lichao@loongson.cn>
> Co-authored-by: Xianglai Li <lixianglai@loongson.cn>
> Co-authored-by: Bibo Mao <maobibo@loongson.cn>
> ---
>   .../Library/NorFlashQemuLib/NorFlashQemuLib.c | 140 ++++++++++++++++++
>   .../NorFlashQemuLib/NorFlashQemuLib.inf       |  43 ++++++
>   2 files changed, 183 insertions(+)
>   create mode 100644 OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.c
>   create mode 100644 OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.inf
> 
> diff --git a/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.c b/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.c
> new file mode 100644
> index 0000000000..ae9af09c4c
> --- /dev/null
> +++ b/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.c
> @@ -0,0 +1,140 @@
> +/** @file
> +
> +  Copyright (c) 2024 Loongson Technology Corporation Limited. All rights reserved.<BR>
> +
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <Library/BaseLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <Library/VirtNorFlashPlatformLib.h>
> +
> +#include <Protocol/FdtClient.h>
> +
> +#define QEMU_NOR_BLOCK_SIZE  SIZE_128KB
> +
> +EFI_STATUS
> +VirtNorFlashPlatformInitialization (
> +  VOID
> +  )
> +{
> +  return EFI_SUCCESS;
> +}
> +
> +STATIC VIRT_NOR_FLASH_DESCRIPTION  mNorFlashDevices;
> +
> +EFI_STATUS
> +VirtNorFlashPlatformGetDevices (
> +  OUT VIRT_NOR_FLASH_DESCRIPTION  **NorFlashDescriptions,
> +  OUT UINT32                      *Count
> +  )
> +{
> +  FDT_CLIENT_PROTOCOL  *FdtClient;
> +  INT32                Node;
> +  EFI_STATUS           Status;
> +  EFI_STATUS           FindNodeStatus;
> +  CONST UINT32         *Reg;
> +  UINT32               PropSize;
> +  UINT64               Base;
> +  UINT64               Size;
> +
> +  Status = gBS->LocateProtocol (
> +                  &gFdtClientProtocolGuid,
> +                  NULL,
> +                  (VOID **)&FdtClient
> +                  );
> +  ASSERT_EFI_ERROR (Status);
> +
> +  FindNodeStatus = FdtClient->FindCompatibleNode (
> +                                FdtClient,
> +                                "cfi-flash",
> +                                &Node
> +                                );
> +  ASSERT_EFI_ERROR (FindNodeStatus);
> +
> +  Status = FdtClient->GetNodeProperty (
> +                        FdtClient,
> +                        Node,
> +                        "reg",
> +                        (CONST VOID **)&Reg,
> +                        &PropSize
> +                        );
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "%a: GetNodeProperty () failed (Status == %r)\n",
> +      __func__,
> +      Status
> +      ));
> +    return Status;
> +  }
> +
> +  ASSERT ((PropSize % (4 * sizeof (UINT32))) == 0);
> +
> +  if (PropSize < (4 * sizeof (UINT32))) {
> +    DEBUG ((
> +      DEBUG_ERROR,
> +      "%a: reg node size(%d) is too small \n",
> +      __func__,
> +      PropSize
> +      ));
> +    return EFI_NOT_FOUND;
> +  }
> +
> +  Base = SwapBytes64 (ReadUnaligned64 ((VOID *)&Reg[0]));
> +  Size = SwapBytes64 (ReadUnaligned64 ((VOID *)&Reg[2]));
> +
> +  mNorFlashDevices.DeviceBaseAddress = (UINTN)Base;
> +  mNorFlashDevices.RegionBaseAddress = (UINTN)Base;
> +  mNorFlashDevices.Size              = (UINTN)Size;
> +  mNorFlashDevices.BlockSize         = QEMU_NOR_BLOCK_SIZE;
> +
> +  Status = PcdSet32S (PcdFlashNvStorageVariableBase, Base);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  /*
> +   * Base is the value of PcdFlashNvStorageVariableBase,
> +   * PcdFlashNvStorageFtwWorkingBase can be got by
> +   *   PcdFlashNvStorageVariableBase + PcdFlashNvStorageVariableSize
> +   */
> +  Base  += PcdGet32 (PcdFlashNvStorageVariableSize);
> +  Status = PcdSet32S (PcdFlashNvStorageFtwWorkingBase, Base);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  /*
> +   * Now,Base is the value of PcdFlashNvStorageFtwWorkingBase,
> +   * PcdFlashNvStorageFtwSpareBase can be got by
> +   *   PcdFlashNvStorageFtwWorkingBase + PcdFlashNvStorageFtwWorkingSize.
> +   */
> +  Base  += PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
> +  Status = PcdSet32S (PcdFlashNvStorageFtwSpareBase, Base);
> +  ASSERT_EFI_ERROR (Status);
> +
> +  //
> +  // UEFI takes ownership of the NOR flash, and exposes its functionality
> +  // through the UEFI Runtime Services GetVariable, SetVariable, etc. This
> +  // means we need to disable it in the device tree to prevent the OS from
> +  // attaching its device driver as well.
> +  // Note that this also hides other flash banks, but the only other flash
> +  // bank we expect to encounter is the one that carries the UEFI executable
> +  // code, which is not intended to be guest updatable, and is usually backed
> +  // in a readonly manner by QEMU anyway.
> +  //
> +  Status = FdtClient->SetNodeProperty (
> +                        FdtClient,
> +                        Node,
> +                        "status",
> +                        "disabled",
> +                        sizeof ("disabled")
> +                        );
> +  if (EFI_ERROR (Status)) {
> +    DEBUG ((DEBUG_WARN, "Failed to set NOR flash status to 'disabled'\n"));
> +  }
> +
> +  *NorFlashDescriptions = &mNorFlashDevices;
> +  *Count                = 1;
> +
> +  return EFI_SUCCESS;
> +}
> diff --git a/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.inf b/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.inf
> new file mode 100644
> index 0000000000..671684e738
> --- /dev/null
> +++ b/OvmfPkg/LoongArchVirt/Library/NorFlashQemuLib/NorFlashQemuLib.inf
> @@ -0,0 +1,43 @@
> +## @file
> +#
> +#  Copyright (c) 2024 Loongson Technology Corporation Limited. All rights reserved.<BR>
> +#
> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +##
> +
> +[Defines]
> +  INF_VERSION                    = 1.29
> +  BASE_NAME                      = NorFlashQemuLib
> +  FILE_GUID                      = E225C90F-6CB9-8AF3-095B-2668FC633A57
> +  MODULE_TYPE                    = DXE_DRIVER
> +  VERSION_STRING                 = 1.0
> +  LIBRARY_CLASS                  = VirtNorFlashPlatformLib
> +
> +[Sources]
> +  NorFlashQemuLib.c
> +
> +[Packages]
> +  EmbeddedPkg/EmbeddedPkg.dec
> +  MdePkg/MdePkg.dec
> +  MdeModulePkg/MdeModulePkg.dec
> +  OvmfPkg/OvmfPkg.dec
> +
> +[LibraryClasses]
> +  BaseLib
> +  DebugLib
> +  UefiBootServicesTableLib
> +
> +[Protocols]
> +  gFdtClientProtocolGuid          ## CONSUMES
> +
> +[Depex]
> +  gFdtClientProtocolGuid
> +
> +[Pcd]
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase
> +gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase
> 
Reviewed-by: Bibo Mao <maobibo@loongson.cn>



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#113501): https://edk2.groups.io/g/devel/message/113501
Mute This Topic: https://groups.io/mt/103540129/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-