[mirror_edk2.git] / ArmPlatformPkg / Drivers / NorFlashDxe / NorFlashDxe.h

/** @file  NorFlashDxe.h\r
\r
  Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __NOR_FLASH_DXE_H__\r
#define __NOR_FLASH_DXE_H__\r
\r
\r
#include <Base.h>\r
#include <PiDxe.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/DiskIo.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/NorFlashPlatformLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
\r
#define NOR_FLASH_ERASE_RETRY                     10\r
\r
// Device access macros\r
// These are necessary because we use 2 x 16bit parts to make up 32bit data\r
\r
#define HIGH_16_BITS                              0xFFFF0000\r
#define LOW_16_BITS                               0x0000FFFF\r
#define LOW_8_BITS                                0x000000FF\r
\r
#define FOLD_32BIT_INTO_16BIT(value)              ( ( value >> 16 ) | ( value & LOW_16_BITS ) )\r
\r
#define GET_LOW_BYTE(value)                       ( value & LOW_8_BITS )\r
#define GET_HIGH_BYTE(value)                      ( GET_LOW_BYTE( value >> 16 ) )\r
\r
// Each command must be sent simultaneously to both chips,\r
// i.e. at the lower 16 bits AND at the higher 16 bits\r
#define CREATE_NOR_ADDRESS(BaseAddr,OffsetAddr)   ((BaseAddr) + ((OffsetAddr) << 2))\r
#define CREATE_DUAL_CMD(Cmd)                      ( ( Cmd << 16) | ( Cmd & LOW_16_BITS) )\r
#define SEND_NOR_COMMAND(BaseAddr,Offset,Cmd) MmioWrite32 (CREATE_NOR_ADDRESS(BaseAddr,Offset), CREATE_DUAL_CMD(Cmd))\r
#define GET_NOR_BLOCK_ADDRESS(BaseAddr,Lba,LbaSize)( BaseAddr + (UINTN)((Lba) * LbaSize) )\r
\r
// Status Register Bits\r
#define P30_SR_BIT_WRITE                          (BIT7 << 16 | BIT7)\r
#define P30_SR_BIT_ERASE_SUSPEND                  (BIT6 << 16 | BIT6)\r
#define P30_SR_BIT_ERASE                          (BIT5 << 16 | BIT5)\r
#define P30_SR_BIT_PROGRAM                        (BIT4 << 16 | BIT4)\r
#define P30_SR_BIT_VPP                            (BIT3 << 16 | BIT3)\r
#define P30_SR_BIT_PROGRAM_SUSPEND                (BIT2 << 16 | BIT2)\r
#define P30_SR_BIT_BLOCK_LOCKED                   (BIT1 << 16 | BIT1)\r
#define P30_SR_BIT_BEFP                           (BIT0 << 16 | BIT0)\r
\r
// Device Commands for Intel StrataFlash(R) Embedded Memory (P30) Family\r
\r
// On chip buffer size for buffered programming operations\r
// There are 2 chips, each chip can buffer up to 32 (16-bit)words, and each word is 2 bytes.\r
// Therefore the total size of the buffer is 2 x 32 x 2 = 128 bytes\r
#define P30_MAX_BUFFER_SIZE_IN_BYTES              ((UINTN)128)\r
#define P30_MAX_BUFFER_SIZE_IN_WORDS              (P30_MAX_BUFFER_SIZE_IN_BYTES/((UINTN)4))\r
#define MAX_BUFFERED_PROG_ITERATIONS              10000000\r
#define BOUNDARY_OF_32_WORDS                      0x7F\r
\r
// CFI Addresses\r
#define P30_CFI_ADDR_QUERY_UNIQUE_QRY             0x10\r
#define P30_CFI_ADDR_VENDOR_ID                    0x13\r
\r
// CFI Data\r
#define CFI_QRY                                   0x00595251\r
\r
// READ Commands\r
#define P30_CMD_READ_DEVICE_ID                    0x0090\r
#define P30_CMD_READ_STATUS_REGISTER              0x0070\r
#define P30_CMD_CLEAR_STATUS_REGISTER             0x0050\r
#define P30_CMD_READ_ARRAY                        0x00FF\r
#define P30_CMD_READ_CFI_QUERY                    0x0098\r
\r
// WRITE Commands\r
#define P30_CMD_WORD_PROGRAM_SETUP                0x0040\r
#define P30_CMD_ALTERNATE_WORD_PROGRAM_SETUP      0x0010\r
#define P30_CMD_BUFFERED_PROGRAM_SETUP            0x00E8\r
#define P30_CMD_BUFFERED_PROGRAM_CONFIRM          0x00D0\r
#define P30_CMD_BEFP_SETUP                        0x0080\r
#define P30_CMD_BEFP_CONFIRM                      0x00D0\r
\r
// ERASE Commands\r
#define P30_CMD_BLOCK_ERASE_SETUP                 0x0020\r
#define P30_CMD_BLOCK_ERASE_CONFIRM               0x00D0\r
\r
// SUSPEND Commands\r
#define P30_CMD_PROGRAM_OR_ERASE_SUSPEND          0x00B0\r
#define P30_CMD_SUSPEND_RESUME                    0x00D0\r
\r
// BLOCK LOCKING / UNLOCKING Commands\r
#define P30_CMD_LOCK_BLOCK_SETUP                  0x0060\r
#define P30_CMD_LOCK_BLOCK                        0x0001\r
#define P30_CMD_UNLOCK_BLOCK                      0x00D0\r
#define P30_CMD_LOCK_DOWN_BLOCK                   0x002F\r
\r
// PROTECTION Commands\r
#define P30_CMD_PROGRAM_PROTECTION_REGISTER_SETUP 0x00C0\r
\r
// CONFIGURATION Commands\r
#define P30_CMD_READ_CONFIGURATION_REGISTER_SETUP 0x0060\r
#define P30_CMD_READ_CONFIGURATION_REGISTER       0x0003\r
\r
#define NOR_FLASH_SIGNATURE                       SIGNATURE_32('n', 'o', 'r', '0')\r
#define INSTANCE_FROM_FVB_THIS(a)                 CR(a, NOR_FLASH_INSTANCE, FvbProtocol, NOR_FLASH_SIGNATURE)\r
#define INSTANCE_FROM_BLKIO_THIS(a)               CR(a, NOR_FLASH_INSTANCE, BlockIoProtocol, NOR_FLASH_SIGNATURE)\r
#define INSTANCE_FROM_DISKIO_THIS(a)              CR(a, NOR_FLASH_INSTANCE, DiskIoProtocol, NOR_FLASH_SIGNATURE)\r
\r
typedef struct _NOR_FLASH_INSTANCE                NOR_FLASH_INSTANCE;\r
\r
#pragma pack (1)\r
typedef struct {\r
  VENDOR_DEVICE_PATH                  Vendor;\r
  UINT8                               Index;\r
  EFI_DEVICE_PATH_PROTOCOL            End;\r
} NOR_FLASH_DEVICE_PATH;\r
#pragma pack ()\r
\r
struct _NOR_FLASH_INSTANCE {\r
  UINT32                              Signature;\r
  EFI_HANDLE                          Handle;\r
\r
  UINTN                               DeviceBaseAddress;\r
  UINTN                               RegionBaseAddress;\r
  UINTN                               Size;\r
  EFI_LBA                             StartLba;\r
\r
  EFI_BLOCK_IO_PROTOCOL               BlockIoProtocol;\r
  EFI_BLOCK_IO_MEDIA                  Media;\r
  EFI_DISK_IO_PROTOCOL                DiskIoProtocol;\r
\r
  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL FvbProtocol;\r
  VOID*                               ShadowBuffer;\r
\r
  NOR_FLASH_DEVICE_PATH               DevicePath;\r
};\r
\r
EFI_STATUS\r
NorFlashReadCfiData (\r
  IN  UINTN                   DeviceBaseAddress,\r
  IN  UINTN                   CFI_Offset,\r
  IN  UINT32                  NumberOfBytes,\r
  OUT UINT32                  *Data\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteBuffer (\r
  IN NOR_FLASH_INSTANCE     *Instance,\r
  IN UINTN                  TargetAddress,\r
  IN UINTN                  BufferSizeInBytes,\r
  IN UINT32                 *Buffer\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.Reset\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoReset (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This,\r
  IN BOOLEAN                  ExtendedVerification\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.ReadBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoReadBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  UINT32                  MediaId,\r
  IN  EFI_LBA                 Lba,\r
  IN  UINTN                   BufferSizeInBytes,\r
  OUT VOID                    *Buffer\r
);\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.WriteBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoWriteBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  UINT32                  MediaId,\r
  IN  EFI_LBA                 Lba,\r
  IN  UINTN                   BufferSizeInBytes,\r
  IN  VOID                    *Buffer\r
);\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.FlushBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoFlushBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This\r
);\r
\r
//\r
// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.ReadDisk\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashDiskIoReadDisk (\r
  IN EFI_DISK_IO_PROTOCOL         *This,\r
  IN UINT32                       MediaId,\r
  IN UINT64                       Offset,\r
  IN UINTN                        BufferSize,\r
  OUT VOID                        *Buffer\r
  );\r
\r
//\r
// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.WriteDisk\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashDiskIoWriteDisk (\r
  IN EFI_DISK_IO_PROTOCOL         *This,\r
  IN UINT32                       MediaId,\r
  IN UINT64                       Offset,\r
  IN UINTN                        BufferSize,\r
  IN VOID                         *Buffer\r
  );\r
\r
//\r
// NorFlashFvbDxe.c\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
NorFlashFvbInitialize (\r
  IN NOR_FLASH_INSTANCE*                            Instance\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetAttributes(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  OUT       EFI_FVB_ATTRIBUTES_2                    *Attributes\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbSetAttributes(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  IN OUT    EFI_FVB_ATTRIBUTES_2                    *Attributes\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetPhysicalAddress(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  OUT       EFI_PHYSICAL_ADDRESS                    *Address\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetBlockSize(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  IN        EFI_LBA                                 Lba,\r
  OUT       UINTN                                   *BlockSize,\r
  OUT       UINTN                                   *NumberOfBlocks\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbRead(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  IN        EFI_LBA                                 Lba,\r
  IN        UINTN                                   Offset,\r
  IN OUT    UINTN                                   *NumBytes,\r
  IN OUT    UINT8                                   *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbWrite(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  IN        EFI_LBA                                 Lba,\r
  IN        UINTN                                   Offset,\r
  IN OUT    UINTN                                   *NumBytes,\r
  IN        UINT8                                   *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbEraseBlocks(\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL     *This,\r
  ...\r
  );\r
\r
//\r
// NorFlashDxe.c\r
//\r
\r
EFI_STATUS\r
NorFlashUnlockAndEraseSingleBlock (\r
  IN NOR_FLASH_INSTANCE     *Instance,\r
  IN UINTN                  BlockAddress\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteSingleBlock (\r
  IN        NOR_FLASH_INSTANCE   *Instance,\r
  IN        EFI_LBA               Lba,\r
  IN        UINTN                 Offset,\r
  IN OUT    UINTN                *NumBytes,\r
  IN        UINT8                *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteBlocks (\r
  IN  NOR_FLASH_INSTANCE *Instance,\r
  IN  EFI_LBA           Lba,\r
  IN  UINTN             BufferSizeInBytes,\r
  IN  VOID              *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashReadBlocks (\r
  IN NOR_FLASH_INSTANCE   *Instance,\r
  IN EFI_LBA              Lba,\r
  IN UINTN                BufferSizeInBytes,\r
  OUT VOID                *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashRead (\r
  IN NOR_FLASH_INSTANCE   *Instance,\r
  IN EFI_LBA              Lba,\r
  IN UINTN                Offset,\r
  IN UINTN                BufferSizeInBytes,\r
  OUT VOID                *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashWrite (\r
  IN        NOR_FLASH_INSTANCE   *Instance,\r
  IN        EFI_LBA               Lba,\r
  IN        UINTN                 Offset,\r
  IN OUT    UINTN                *NumBytes,\r
  IN        UINT8                *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashReset (\r
  IN  NOR_FLASH_INSTANCE *Instance\r
  );\r
\r
#endif /* __NOR_FLASH_DXE_H__ */\r
Commit	Line	Data
	1	/** @file NorFlashDxe.h\r
	2	\r
	3	Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>\r
	4	\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef __NOR_FLASH_DXE_H__\r
	16	#define __NOR_FLASH_DXE_H__\r
	17	\r
	18	\r
	19	#include <Base.h>\r
	20	#include <PiDxe.h>\r
	21	\r
	22	#include <Guid/EventGroup.h>\r
	23	\r
	24	#include <Protocol/BlockIo.h>\r
	25	#include <Protocol/DiskIo.h>\r
	26	#include <Protocol/FirmwareVolumeBlock.h>\r
	27	\r
	28	#include <Library/DebugLib.h>\r
	29	#include <Library/IoLib.h>\r
	30	#include <Library/NorFlashPlatformLib.h>\r
	31	#include <Library/UefiLib.h>\r
	32	#include <Library/UefiRuntimeLib.h>\r
	33	\r
	34	#define NOR_FLASH_ERASE_RETRY 10\r
	35	\r
	36	// Device access macros\r
	37	// These are necessary because we use 2 x 16bit parts to make up 32bit data\r
	38	\r
	39	#define HIGH_16_BITS 0xFFFF0000\r
	40	#define LOW_16_BITS 0x0000FFFF\r
	41	#define LOW_8_BITS 0x000000FF\r
	42	\r
	43	#define FOLD_32BIT_INTO_16BIT(value) ( ( value >> 16 ) \| ( value & LOW_16_BITS ) )\r
	44	\r
	45	#define GET_LOW_BYTE(value) ( value & LOW_8_BITS )\r
	46	#define GET_HIGH_BYTE(value) ( GET_LOW_BYTE( value >> 16 ) )\r
	47	\r
	48	// Each command must be sent simultaneously to both chips,\r
	49	// i.e. at the lower 16 bits AND at the higher 16 bits\r
	50	#define CREATE_NOR_ADDRESS(BaseAddr,OffsetAddr) ((BaseAddr) + ((OffsetAddr) << 2))\r
	51	#define CREATE_DUAL_CMD(Cmd) ( ( Cmd << 16) \| ( Cmd & LOW_16_BITS) )\r
	52	#define SEND_NOR_COMMAND(BaseAddr,Offset,Cmd) MmioWrite32 (CREATE_NOR_ADDRESS(BaseAddr,Offset), CREATE_DUAL_CMD(Cmd))\r
	53	#define GET_NOR_BLOCK_ADDRESS(BaseAddr,Lba,LbaSize)( BaseAddr + (UINTN)((Lba) * LbaSize) )\r
	54	\r
	55	// Status Register Bits\r
	56	#define P30_SR_BIT_WRITE (BIT7 << 16 \| BIT7)\r
	57	#define P30_SR_BIT_ERASE_SUSPEND (BIT6 << 16 \| BIT6)\r
	58	#define P30_SR_BIT_ERASE (BIT5 << 16 \| BIT5)\r
	59	#define P30_SR_BIT_PROGRAM (BIT4 << 16 \| BIT4)\r
	60	#define P30_SR_BIT_VPP (BIT3 << 16 \| BIT3)\r
	61	#define P30_SR_BIT_PROGRAM_SUSPEND (BIT2 << 16 \| BIT2)\r
	62	#define P30_SR_BIT_BLOCK_LOCKED (BIT1 << 16 \| BIT1)\r
	63	#define P30_SR_BIT_BEFP (BIT0 << 16 \| BIT0)\r
	64	\r
	65	// Device Commands for Intel StrataFlash(R) Embedded Memory (P30) Family\r
	66	\r
	67	// On chip buffer size for buffered programming operations\r
	68	// There are 2 chips, each chip can buffer up to 32 (16-bit)words, and each word is 2 bytes.\r
	69	// Therefore the total size of the buffer is 2 x 32 x 2 = 128 bytes\r
	70	#define P30_MAX_BUFFER_SIZE_IN_BYTES ((UINTN)128)\r
	71	#define P30_MAX_BUFFER_SIZE_IN_WORDS (P30_MAX_BUFFER_SIZE_IN_BYTES/((UINTN)4))\r
	72	#define MAX_BUFFERED_PROG_ITERATIONS 10000000\r
	73	#define BOUNDARY_OF_32_WORDS 0x7F\r
	74	\r
	75	// CFI Addresses\r
	76	#define P30_CFI_ADDR_QUERY_UNIQUE_QRY 0x10\r
	77	#define P30_CFI_ADDR_VENDOR_ID 0x13\r
	78	\r
	79	// CFI Data\r
	80	#define CFI_QRY 0x00595251\r
	81	\r
	82	// READ Commands\r
	83	#define P30_CMD_READ_DEVICE_ID 0x0090\r
	84	#define P30_CMD_READ_STATUS_REGISTER 0x0070\r
	85	#define P30_CMD_CLEAR_STATUS_REGISTER 0x0050\r
	86	#define P30_CMD_READ_ARRAY 0x00FF\r
	87	#define P30_CMD_READ_CFI_QUERY 0x0098\r
	88	\r
	89	// WRITE Commands\r
	90	#define P30_CMD_WORD_PROGRAM_SETUP 0x0040\r
	91	#define P30_CMD_ALTERNATE_WORD_PROGRAM_SETUP 0x0010\r
	92	#define P30_CMD_BUFFERED_PROGRAM_SETUP 0x00E8\r
	93	#define P30_CMD_BUFFERED_PROGRAM_CONFIRM 0x00D0\r
	94	#define P30_CMD_BEFP_SETUP 0x0080\r
	95	#define P30_CMD_BEFP_CONFIRM 0x00D0\r
	96	\r
	97	// ERASE Commands\r
	98	#define P30_CMD_BLOCK_ERASE_SETUP 0x0020\r
	99	#define P30_CMD_BLOCK_ERASE_CONFIRM 0x00D0\r
	100	\r
	101	// SUSPEND Commands\r
	102	#define P30_CMD_PROGRAM_OR_ERASE_SUSPEND 0x00B0\r
	103	#define P30_CMD_SUSPEND_RESUME 0x00D0\r
	104	\r
	105	// BLOCK LOCKING / UNLOCKING Commands\r
	106	#define P30_CMD_LOCK_BLOCK_SETUP 0x0060\r
	107	#define P30_CMD_LOCK_BLOCK 0x0001\r
	108	#define P30_CMD_UNLOCK_BLOCK 0x00D0\r
	109	#define P30_CMD_LOCK_DOWN_BLOCK 0x002F\r
	110	\r
	111	// PROTECTION Commands\r
	112	#define P30_CMD_PROGRAM_PROTECTION_REGISTER_SETUP 0x00C0\r
	113	\r
	114	// CONFIGURATION Commands\r
	115	#define P30_CMD_READ_CONFIGURATION_REGISTER_SETUP 0x0060\r
	116	#define P30_CMD_READ_CONFIGURATION_REGISTER 0x0003\r
	117	\r
	118	#define NOR_FLASH_SIGNATURE SIGNATURE_32('n', 'o', 'r', '0')\r
	119	#define INSTANCE_FROM_FVB_THIS(a) CR(a, NOR_FLASH_INSTANCE, FvbProtocol, NOR_FLASH_SIGNATURE)\r
	120	#define INSTANCE_FROM_BLKIO_THIS(a) CR(a, NOR_FLASH_INSTANCE, BlockIoProtocol, NOR_FLASH_SIGNATURE)\r
	121	#define INSTANCE_FROM_DISKIO_THIS(a) CR(a, NOR_FLASH_INSTANCE, DiskIoProtocol, NOR_FLASH_SIGNATURE)\r
	122	\r
	123	typedef struct _NOR_FLASH_INSTANCE NOR_FLASH_INSTANCE;\r
	124	\r
	125	#pragma pack (1)\r
	126	typedef struct {\r
	127	VENDOR_DEVICE_PATH Vendor;\r
	128	UINT8 Index;\r
	129	EFI_DEVICE_PATH_PROTOCOL End;\r
	130	} NOR_FLASH_DEVICE_PATH;\r
	131	#pragma pack ()\r
	132	\r
	133	struct _NOR_FLASH_INSTANCE {\r
	134	UINT32 Signature;\r
	135	EFI_HANDLE Handle;\r
	136	\r
	137	UINTN DeviceBaseAddress;\r
	138	UINTN RegionBaseAddress;\r
	139	UINTN Size;\r
	140	EFI_LBA StartLba;\r
	141	\r
	142	EFI_BLOCK_IO_PROTOCOL BlockIoProtocol;\r
	143	EFI_BLOCK_IO_MEDIA Media;\r
	144	EFI_DISK_IO_PROTOCOL DiskIoProtocol;\r
	145	\r
	146	EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL FvbProtocol;\r
	147	VOID* ShadowBuffer;\r
	148	\r
	149	NOR_FLASH_DEVICE_PATH DevicePath;\r
	150	};\r
	151	\r
	152	EFI_STATUS\r
	153	NorFlashReadCfiData (\r
	154	IN UINTN DeviceBaseAddress,\r
	155	IN UINTN CFI_Offset,\r
	156	IN UINT32 NumberOfBytes,\r
	157	OUT UINT32 *Data\r
	158	);\r
	159	\r
	160	EFI_STATUS\r
	161	NorFlashWriteBuffer (\r
	162	IN NOR_FLASH_INSTANCE *Instance,\r
	163	IN UINTN TargetAddress,\r
	164	IN UINTN BufferSizeInBytes,\r
	165	IN UINT32 *Buffer\r
	166	);\r
	167	\r
	168	//\r
	169	// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.Reset\r
	170	//\r
	171	EFI_STATUS\r
	172	EFIAPI\r
	173	NorFlashBlockIoReset (\r
	174	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	175	IN BOOLEAN ExtendedVerification\r
	176	);\r
	177	\r
	178	//\r
	179	// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.ReadBlocks\r
	180	//\r
	181	EFI_STATUS\r
	182	EFIAPI\r
	183	NorFlashBlockIoReadBlocks (\r
	184	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	185	IN UINT32 MediaId,\r
	186	IN EFI_LBA Lba,\r
	187	IN UINTN BufferSizeInBytes,\r
	188	OUT VOID *Buffer\r
	189	);\r
	190	\r
	191	//\r
	192	// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.WriteBlocks\r
	193	//\r
	194	EFI_STATUS\r
	195	EFIAPI\r
	196	NorFlashBlockIoWriteBlocks (\r
	197	IN EFI_BLOCK_IO_PROTOCOL *This,\r
	198	IN UINT32 MediaId,\r
	199	IN EFI_LBA Lba,\r
	200	IN UINTN BufferSizeInBytes,\r
	201	IN VOID *Buffer\r
	202	);\r
	203	\r
	204	//\r
	205	// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.FlushBlocks\r
	206	//\r
	207	EFI_STATUS\r
	208	EFIAPI\r
	209	NorFlashBlockIoFlushBlocks (\r
	210	IN EFI_BLOCK_IO_PROTOCOL *This\r
	211	);\r
	212	\r
	213	//\r
	214	// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.ReadDisk\r
	215	//\r
	216	EFI_STATUS\r
	217	EFIAPI\r
	218	NorFlashDiskIoReadDisk (\r
	219	IN EFI_DISK_IO_PROTOCOL *This,\r
	220	IN UINT32 MediaId,\r
	221	IN UINT64 Offset,\r
	222	IN UINTN BufferSize,\r
	223	OUT VOID *Buffer\r
	224	);\r
	225	\r
	226	//\r
	227	// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.WriteDisk\r
	228	//\r
	229	EFI_STATUS\r
	230	EFIAPI\r
	231	NorFlashDiskIoWriteDisk (\r
	232	IN EFI_DISK_IO_PROTOCOL *This,\r
	233	IN UINT32 MediaId,\r
	234	IN UINT64 Offset,\r
	235	IN UINTN BufferSize,\r
	236	IN VOID *Buffer\r
	237	);\r
	238	\r
	239	//\r
	240	// NorFlashFvbDxe.c\r
	241	//\r
	242	\r
	243	EFI_STATUS\r
	244	EFIAPI\r
	245	NorFlashFvbInitialize (\r
	246	IN NOR_FLASH_INSTANCE* Instance\r
	247	);\r
	248	\r
	249	EFI_STATUS\r
	250	EFIAPI\r
	251	FvbGetAttributes(\r
	252	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	253	OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
	254	);\r
	255	\r
	256	EFI_STATUS\r
	257	EFIAPI\r
	258	FvbSetAttributes(\r
	259	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	260	IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
	261	);\r
	262	\r
	263	EFI_STATUS\r
	264	EFIAPI\r
	265	FvbGetPhysicalAddress(\r
	266	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	267	OUT EFI_PHYSICAL_ADDRESS *Address\r
	268	);\r
	269	\r
	270	EFI_STATUS\r
	271	EFIAPI\r
	272	FvbGetBlockSize(\r
	273	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	274	IN EFI_LBA Lba,\r
	275	OUT UINTN *BlockSize,\r
	276	OUT UINTN *NumberOfBlocks\r
	277	);\r
	278	\r
	279	EFI_STATUS\r
	280	EFIAPI\r
	281	FvbRead(\r
	282	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	283	IN EFI_LBA Lba,\r
	284	IN UINTN Offset,\r
	285	IN OUT UINTN *NumBytes,\r
	286	IN OUT UINT8 *Buffer\r
	287	);\r
	288	\r
	289	EFI_STATUS\r
	290	EFIAPI\r
	291	FvbWrite(\r
	292	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	293	IN EFI_LBA Lba,\r
	294	IN UINTN Offset,\r
	295	IN OUT UINTN *NumBytes,\r
	296	IN UINT8 *Buffer\r
	297	);\r
	298	\r
	299	EFI_STATUS\r
	300	EFIAPI\r
	301	FvbEraseBlocks(\r
	302	IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
	303	...\r
	304	);\r
	305	\r
	306	//\r
	307	// NorFlashDxe.c\r
	308	//\r
	309	\r
	310	EFI_STATUS\r
	311	NorFlashUnlockAndEraseSingleBlock (\r
	312	IN NOR_FLASH_INSTANCE *Instance,\r
	313	IN UINTN BlockAddress\r
	314	);\r
	315	\r
	316	EFI_STATUS\r
	317	NorFlashWriteSingleBlock (\r
	318	IN NOR_FLASH_INSTANCE *Instance,\r
	319	IN EFI_LBA Lba,\r
	320	IN UINTN Offset,\r
	321	IN OUT UINTN *NumBytes,\r
	322	IN UINT8 *Buffer\r
	323	);\r
	324	\r
	325	EFI_STATUS\r
	326	NorFlashWriteBlocks (\r
	327	IN NOR_FLASH_INSTANCE *Instance,\r
	328	IN EFI_LBA Lba,\r
	329	IN UINTN BufferSizeInBytes,\r
	330	IN VOID *Buffer\r
	331	);\r
	332	\r
	333	EFI_STATUS\r
	334	NorFlashReadBlocks (\r
	335	IN NOR_FLASH_INSTANCE *Instance,\r
	336	IN EFI_LBA Lba,\r
	337	IN UINTN BufferSizeInBytes,\r
	338	OUT VOID *Buffer\r
	339	);\r
	340	\r
	341	EFI_STATUS\r
	342	NorFlashRead (\r
	343	IN NOR_FLASH_INSTANCE *Instance,\r
	344	IN EFI_LBA Lba,\r
	345	IN UINTN Offset,\r
	346	IN UINTN BufferSizeInBytes,\r
	347	OUT VOID *Buffer\r
	348	);\r
	349	\r
	350	EFI_STATUS\r
	351	NorFlashWrite (\r
	352	IN NOR_FLASH_INSTANCE *Instance,\r
	353	IN EFI_LBA Lba,\r
	354	IN UINTN Offset,\r
	355	IN OUT UINTN *NumBytes,\r
	356	IN UINT8 *Buffer\r
	357	);\r
	358	\r
	359	EFI_STATUS\r
	360	NorFlashReset (\r
	361	IN NOR_FLASH_INSTANCE *Instance\r
	362	);\r
	363	\r
	364	#endif /* __NOR_FLASH_DXE_H__ */\r