From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail05.groups.io (mail05.groups.io [45.79.224.7]) by spool.mail.gandi.net (Postfix) with ESMTPS id 725E8740041 for ; Tue, 23 Apr 2024 14:56:04 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=+QEcqR1qQRJ6B7twcQYnPbwE2AwlTdnxgMl2QPFEWwA=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Resent-Date:Resent-From:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20240206; t=1713884163; v=1; b=MWBr1T03XtYW7UCmx4T1Sek4M1AoGfuMMFcz0xFzNd8hpDj3rxMlvXXThi+qADj72n1H7Ywz 7TBaQkxf1TMtZqZvcgqX3QWugWrAcJgRj17J6breU0NMa3MltSKZK9u7Qm0Re77wW2Z1YM2neeH DhoH0mV59+zJvcX/x7OuOSHGnuo3cwKu3rkx5JPs6SbJqPsYKhRc5VZICd+7/qlV49ug6Zm3REU pDYXnsOUti/gDdkT3XETVPp+lPv7/x0vcLQxzsb/Ey2NEgaoNWajDnvndGrE1hmIm5DBEGIPv2Z EM2/OQLPhn+S9pmdoNq9MOg6OwVZlNPBcJNHqrbrkiN4w== X-Received: by 127.0.0.2 with SMTP id MpROYY7687511xFPeTqkyXp5; Tue, 23 Apr 2024 07:56:03 -0700 X-Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web10.12022.1713851821503033821 for ; Mon, 22 Apr 2024 22:57:01 -0700 X-Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 48DA9339; Mon, 22 Apr 2024 22:57:29 -0700 (PDT) X-Received: from usa.arm.com (a077434.arm.com [10.162.46.143]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 8F1A73F7BD; Mon, 22 Apr 2024 22:56:59 -0700 (PDT) From: "Sahil Kaushal" To: devel@edk2.groups.io Cc: Ard Biesheuvel , =?UTF-8?q?Leif=20Lindholm=20=C2=A0?= , Sami Mujawar , =?UTF-8?q?sahil=20=C2=A0?= Subject: [edk2-devel] [PATCH RESEND edk2-platforms][PATCH V2 05/14] Platform/ARM: Create NorFlashDeviceLib library interface for flash specific functions Date: Tue, 23 Apr 2024 11:26:29 +0530 Message-Id: <20240423055638.1271531-6-Sahil.Kaushal@arm.com> In-Reply-To: <20240423055638.1271531-1-Sahil.Kaushal@arm.com> References: <20240423055638.1271531-1-Sahil.Kaushal@arm.com> MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Resent-Date: Tue, 23 Apr 2024 07:55:50 -0700 Resent-From: sahil.kaushal@arm.com Reply-To: devel@edk2.groups.io,sahil.kaushal@arm.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: 4Gy6b9B2BR1g5nClWgPtqeM1x7686176AA= Content-Transfer-Encoding: quoted-printable X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20240206 header.b=MWBr1T03; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=arm.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 45.79.224.7 as permitted sender) smtp.mailfrom=bounce@groups.io From: sahil NorFlashDeviceLib can be used to provide implementations of different NOR Flash to NorFlashDxe, i.e. NorFlashDxe links with NorFlashDeviceLib and the platforms can specify their respective NorFlashDeviceLib instances. This patch splits NorFlash.h and moves out the function prototypes and macros that are expected by NorFlashDxe to be implemented by any Nor Flash implementation to NorFlashDeviceLib.h file. Signed-off-by: sahil --- Platform/ARM/ARM.dec | 1 + Platform/ARM/Drivers/NorFlashDxe/NorFlash.h | 143 +----------------- Platform/ARM/Drivers/NorFlashDxe/NorFlashCommon.h | 1 + Platform/ARM/Include/Library/NorFlashDeviceLib.h | 156 ++++++++++++++++++= ++ 4 files changed, 159 insertions(+), 142 deletions(-) diff --git a/Platform/ARM/ARM.dec b/Platform/ARM/ARM.dec index be7e6dc83fde..86d1fcb4878e 100644 --- a/Platform/ARM/ARM.dec +++ b/Platform/ARM/ARM.dec @@ -17,6 +17,7 @@ =0D [LibraryClasses]=0D BdsLib|Include/Library/BdsLib.h=0D + NorFlashDeviceLib|Include/Library/NorFlashDeviceLib.h=0D NorFlashPlatformLib|Include/Library/NorFlashPlatformLib.h=0D =0D [Guids]=0D diff --git a/Platform/ARM/Drivers/NorFlashDxe/NorFlash.h b/Platform/ARM/Dri= vers/NorFlashDxe/NorFlash.h index bd5c6a949cf0..6cb1f64b9875 100644 --- a/Platform/ARM/Drivers/NorFlashDxe/NorFlash.h +++ b/Platform/ARM/Drivers/NorFlashDxe/NorFlash.h @@ -20,6 +20,7 @@ =0D #include =0D #include =0D +#include =0D =0D #define NOR_FLASH_ERASE_RETRY 10=0D =0D @@ -40,7 +41,6 @@ #define CREATE_NOR_ADDRESS(BaseAddr, OffsetAddr) ((BaseAddr) + ((Off= setAddr) << 2))=0D #define CREATE_DUAL_CMD(Cmd) ( ( Cmd << 16) | ( = Cmd & LOW_16_BITS) )=0D #define SEND_NOR_COMMAND(BaseAddr, Offset, Cmd) MmioWrite32 (CREATE= _NOR_ADDRESS(BaseAddr,Offset), CREATE_DUAL_CMD(Cmd))=0D -#define GET_NOR_BLOCK_ADDRESS(BaseAddr, Lba, LbaSize) ( BaseAddr + (UINTN= )((Lba) * LbaSize) )=0D =0D // Status Register Bits=0D #define P30_SR_BIT_WRITE (BIT7 << 16 | BIT7)=0D @@ -105,145 +105,4 @@ #define P30_CMD_READ_CONFIGURATION_REGISTER_SETUP 0x0060=0D #define P30_CMD_READ_CONFIGURATION_REGISTER 0x0003=0D =0D -typedef struct _NOR_FLASH_INSTANCE NOR_FLASH_INSTANCE;=0D -=0D -#pragma pack (1)=0D -typedef struct {=0D - VENDOR_DEVICE_PATH Vendor;=0D - UINT8 Index;=0D - EFI_DEVICE_PATH_PROTOCOL End;=0D -} NOR_FLASH_DEVICE_PATH;=0D -#pragma pack ()=0D -=0D -struct _NOR_FLASH_INSTANCE {=0D - UINT32 Signature;=0D - EFI_HANDLE Handle;=0D -=0D - UINTN DeviceBaseAddress;=0D - UINTN RegionBaseAddress;=0D - UINTN Size;=0D - EFI_LBA StartLba;=0D -=0D - EFI_BLOCK_IO_PROTOCOL BlockIoProtocol;=0D - EFI_BLOCK_IO_MEDIA Media;=0D - EFI_DISK_IO_PROTOCOL DiskIoProtocol;=0D -=0D - EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL FvbProtocol;=0D - VOID *ShadowBuffer;=0D -=0D - NOR_FLASH_DEVICE_PATH DevicePath;=0D -};=0D -=0D -EFI_STATUS=0D -NorFlashReadCfiData (=0D - IN UINTN DeviceBaseAddress,=0D - IN UINTN CFI_Offset,=0D - IN UINT32 NumberOfBytes,=0D - OUT UINT32 *Data=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashWriteBuffer (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN UINTN TargetAddress,=0D - IN UINTN BufferSizeInBytes,=0D - IN UINT32 *Buffer=0D - );=0D -=0D -//=0D -// NorFlash.c=0D -//=0D -EFI_STATUS=0D -NorFlashWriteSingleBlock (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINTN Offset,=0D - IN OUT UINTN *NumBytes,=0D - IN UINT8 *Buffer=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashWriteBlocks (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINTN BufferSizeInBytes,=0D - IN VOID *Buffer=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashReadBlocks (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINTN BufferSizeInBytes,=0D - OUT VOID *Buffer=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashRead (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINTN Offset,=0D - IN UINTN BufferSizeInBytes,=0D - OUT VOID *Buffer=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashWrite (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINTN Offset,=0D - IN OUT UINTN *NumBytes,=0D - IN UINT8 *Buffer=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashReset (=0D - IN NOR_FLASH_INSTANCE *Instance=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashEraseSingleBlock (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN UINTN BlockAddress=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashUnlockSingleBlockIfNecessary (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN UINTN BlockAddress=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashWriteSingleWord (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN UINTN WordAddress,=0D - IN UINT32 WriteData=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashWriteFullBlock (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN EFI_LBA Lba,=0D - IN UINT32 *DataBuffer,=0D - IN UINT32 BlockSizeInWords=0D - );=0D -=0D -EFI_STATUS=0D -NorFlashUnlockAndEraseSingleBlock (=0D - IN NOR_FLASH_INSTANCE *Instance,=0D - IN UINTN BlockAddress=0D - );=0D -=0D -VOID=0D -EFIAPI=0D -NorFlashLock (=0D - IN EFI_TPL *OriginalTPL=0D - );=0D -=0D -VOID=0D -EFIAPI=0D -NorFlashUnlock (=0D - IN EFI_TPL OriginalTPL=0D - );=0D -=0D #endif /* __NOR_FLASH_H__ */=0D diff --git a/Platform/ARM/Drivers/NorFlashDxe/NorFlashCommon.h b/Platform/A= RM/Drivers/NorFlashDxe/NorFlashCommon.h index c0a3b5861532..7fcb949843e8 100644 --- a/Platform/ARM/Drivers/NorFlashDxe/NorFlashCommon.h +++ b/Platform/ARM/Drivers/NorFlashDxe/NorFlashCommon.h @@ -19,6 +19,7 @@ #include =0D =0D #include =0D +#include =0D #include =0D #include =0D #include =0D diff --git a/Platform/ARM/Include/Library/NorFlashDeviceLib.h b/Platform/AR= M/Include/Library/NorFlashDeviceLib.h new file mode 100644 index 000000000000..e5017130a091 --- /dev/null +++ b/Platform/ARM/Include/Library/NorFlashDeviceLib.h @@ -0,0 +1,156 @@ +/** @file NorFlashDeviceLib.h=0D +=0D + Copyright (c) 2011 - 2024, Arm Limited. All rights reserved.
=0D +=0D + SPDX-License-Identifier: BSD-2-Clause-Patent=0D +=0D +**/=0D +=0D +#ifndef NOR_FLASH_DEVICE_LIB_H_=0D +#define NOR_FLASH_DEVICE_LIB_H_=0D +=0D +#include =0D +#include =0D +#include =0D +=0D +typedef struct _NOR_FLASH_INSTANCE NOR_FLASH_INSTANCE;=0D +=0D +#define GET_NOR_BLOCK_ADDRESS(BaseAddr, Lba, LbaSize) ( BaseAddr + (UINTN= )((Lba) * LbaSize) )=0D +=0D +#pragma pack (1)=0D +typedef struct {=0D + VENDOR_DEVICE_PATH Vendor;=0D + UINT8 Index;=0D + EFI_DEVICE_PATH_PROTOCOL End;=0D +} NOR_FLASH_DEVICE_PATH;=0D +#pragma pack ()=0D +=0D +struct _NOR_FLASH_INSTANCE {=0D + UINT32 Signature;=0D + EFI_HANDLE Handle;=0D +=0D + UINTN DeviceBaseAddress;=0D + UINTN RegionBaseAddress;=0D + UINTN Size;=0D + EFI_LBA StartLba;=0D +=0D + EFI_BLOCK_IO_PROTOCOL BlockIoProtocol;=0D + EFI_BLOCK_IO_MEDIA Media;=0D + EFI_DISK_IO_PROTOCOL DiskIoProtocol;=0D +=0D + EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL FvbProtocol;=0D + VOID *ShadowBuffer;=0D +=0D + NOR_FLASH_DEVICE_PATH DevicePath;=0D +};=0D +=0D +EFI_STATUS=0D +NorFlashReadCfiData (=0D + IN UINTN DeviceBaseAddress,=0D + IN UINTN CFI_Offset,=0D + IN UINT32 NumberOfBytes,=0D + OUT UINT32 *Data=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWriteBuffer (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN UINTN TargetAddress,=0D + IN UINTN BufferSizeInBytes,=0D + IN UINT32 *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWriteFullBlock (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINT32 *DataBuffer,=0D + IN UINT32 BlockSizeInWords=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashUnlockAndEraseSingleBlock (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN UINTN BlockAddress=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWriteSingleBlock (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINTN Offset,=0D + IN OUT UINTN *NumBytes,=0D + IN UINT8 *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWriteBlocks (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINTN BufferSizeInBytes,=0D + IN VOID *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashReadBlocks (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINTN BufferSizeInBytes,=0D + OUT VOID *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashRead (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINTN Offset,=0D + IN UINTN BufferSizeInBytes,=0D + OUT VOID *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWrite (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN EFI_LBA Lba,=0D + IN UINTN Offset,=0D + IN OUT UINTN *NumBytes,=0D + IN UINT8 *Buffer=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashReset (=0D + IN NOR_FLASH_INSTANCE *Instance=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashEraseSingleBlock (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN UINTN BlockAddress=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashUnlockSingleBlockIfNecessary (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN UINTN BlockAddress=0D + );=0D +=0D +EFI_STATUS=0D +NorFlashWriteSingleWord (=0D + IN NOR_FLASH_INSTANCE *Instance,=0D + IN UINTN WordAddress,=0D + IN UINT32 WriteData=0D + );=0D +=0D +VOID=0D +EFIAPI=0D +NorFlashLock (=0D + IN EFI_TPL *OriginalTPL=0D + );=0D +=0D +VOID=0D +EFIAPI=0D +NorFlashUnlock (=0D + IN EFI_TPL OriginalTPL=0D + );=0D +=0D +#endif /* NOR_FLASH_DEVICE_LIB_H_ */=0D --=20 2.25.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#118155): https://edk2.groups.io/g/devel/message/118155 Mute This Topic: https://groups.io/mt/105690940/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-