[mirror_edk2.git] / MdeModulePkg / Universal / FirmwareVolume / FaultTolerantWriteDxe / FtwLite.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. 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
Module Name:\r
\r
  FtwLite.h\r
\r
Abstract:\r
\r
  This is a simple fault tolerant write driver, based on PlatformFd library.\r
  And it only supports write BufferSize <= SpareAreaLength.\r
\r
  This boot service only protocol provides fault tolerant write capability for \r
  block devices.  The protocol has internal non-volatile intermediate storage \r
  of the data and private information. It should be able to recover \r
  automatically from a critical fault, such as power failure. \r
\r
--*/\r
\r
#ifndef _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
#define _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/PciRootBridgeIo.h>\r
#include <Guid/SystemNvDataGuid.h>\r
#include <Protocol/FaultTolerantWriteLite.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
\r
#include <Library/PcdLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
#include <Common/WorkingBlockHeader.h>\r
\r
#define EFI_D_FTW_LITE  EFI_D_ERROR\r
#define EFI_D_FTW_INFO  EFI_D_INFO\r
\r
//\r
// Flash erase polarity is 1\r
//\r
#define FTW_ERASE_POLARITY  1\r
\r
#define FTW_VALID_STATE     0\r
#define FTW_INVALID_STATE   1\r
\r
#define FTW_ERASED_BYTE     ((UINT8) (255))\r
#define FTW_POLARITY_REVERT ((UINT8) (255))\r
\r
typedef struct {\r
  UINT8         WriteAllocated : 1;\r
  UINT8         SpareCompleted : 1;\r
  UINT8         WriteCompleted : 1;\r
  UINT8         Reserved : 5;\r
#define WRITE_ALLOCATED 0x1\r
#define SPARE_COMPLETED 0x2\r
#define WRITE_COMPLETED 0x4\r
\r
  EFI_DEV_PATH  DevPath;\r
  EFI_LBA       Lba;\r
  UINTN         Offset;\r
  UINTN         NumBytes;\r
  //\r
  // UINTN           SpareAreaOffset;\r
  //\r
} EFI_FTW_LITE_RECORD;\r
\r
#define FTW_LITE_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('F', 'T', 'W', 'L')\r
\r
//\r
// MACRO for Block size.\r
// Flash Erasing will do in block granularity.\r
//\r
#ifdef FV_BLOCK_SIZE\r
#define FTW_BLOCK_SIZE  FV_BLOCK_SIZE\r
#else\r
#define FV_BLOCK_SIZE   0x10000\r
#define FTW_BLOCK_SIZE  FV_BLOCK_SIZE\r
#endif\r
//\r
// MACRO for FTW WORK SPACE Base & Size\r
//\r
#ifdef EFI_FTW_WORKING_OFFSET\r
#define FTW_WORK_SPACE_BASE EFI_FTW_WORKING_OFFSET\r
#else\r
#define FTW_WORK_SPACE_BASE 0x00E000\r
#endif\r
\r
#ifdef EFI_FTW_WORKING_LENGTH\r
#define FTW_WORK_SPACE_SIZE EFI_FTW_WORKING_LENGTH\r
#else\r
#define FTW_WORK_SPACE_SIZE 0x002000\r
#endif\r
//\r
// MACRO for FTW header and record\r
//\r
#define FTW_WORKING_QUEUE_SIZE  (FTW_WORK_SPACE_SIZE - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER))\r
#define FTW_LITE_RECORD_SIZE    (sizeof (EFI_FTW_LITE_RECORD))\r
#define WRITE_TOTAL_SIZE        FTW_LITE_RECORD_SIZE\r
\r
//\r
// EFI Fault tolerant protocol private data structure\r
//\r
typedef struct {\r
  UINTN                                   Signature;\r
  EFI_HANDLE                              Handle;\r
  EFI_FTW_LITE_PROTOCOL                   FtwLiteInstance;\r
  EFI_PHYSICAL_ADDRESS                    WorkSpaceAddress;\r
  UINTN                                   WorkSpaceLength;\r
  EFI_PHYSICAL_ADDRESS                    SpareAreaAddress;\r
  UINTN                                   SpareAreaLength;\r
  UINTN                                   NumberOfSpareBlock; // Number of the blocks in spare block\r
  UINTN                                   SizeOfSpareBlock;   // Block size in bytes of the blocks in spare block\r
  EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *FtwWorkSpaceHeader;\r
  EFI_FTW_LITE_RECORD                     *FtwLastRecord;\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL      *FtwFvBlock;        // FVB of working block\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL      *FtwBackupFvb;      // FVB of spare block\r
  EFI_LBA                                 FtwSpareLba;\r
  EFI_LBA                                 FtwWorkBlockLba;    // Start LBA of working block\r
  EFI_LBA                                 FtwWorkSpaceLba;    // Start LBA of working space\r
  UINTN                                   FtwWorkSpaceBase;   // Offset from LBA start addr\r
  UINTN                                   FtwWorkSpaceSize;\r
  UINT8                                   *FtwWorkSpace;\r
  //\r
  // Following a buffer of FtwWorkSpace[FTW_WORK_SPACE_SIZE],\r
  // Allocated with EFI_FTW_LITE_DEVICE.\r
  //\r
} EFI_FTW_LITE_DEVICE;\r
\r
#define FTW_LITE_CONTEXT_FROM_THIS(a) CR (a, EFI_FTW_LITE_DEVICE, FtwLiteInstance, FTW_LITE_DEVICE_SIGNATURE)\r
\r
//\r
// Driver entry point\r
//\r
EFI_STATUS\r
EFIAPI\r
InitializeFtwLite (\r
  IN EFI_HANDLE                 ImageHandle,\r
  IN EFI_SYSTEM_TABLE           *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
    This function is the entry point of the Fault Tolerant Write driver.\r
\r
Arguments:\r
    ImageHandle   - EFI_HANDLE: A handle for the image that is initializing \r
                    this driver\r
    SystemTable   - EFI_SYSTEM_TABLE: A pointer to the EFI system table\r
\r
Returns:\r
    EFI_SUCCESS           - FTW has finished the initialization\r
    EFI_ABORTED           - FTW initialization error\r
\r
--*/\r
;\r
\r
//\r
// Fault Tolerant Write Protocol API\r
//\r
EFI_STATUS\r
EFIAPI\r
FtwLiteWrite (\r
  IN EFI_FTW_LITE_PROTOCOL                 *This,\r
  IN EFI_HANDLE                            FvbHandle,\r
  IN EFI_LBA                               Lba,\r
  IN UINTN                                 Offset,\r
  IN UINTN                                 *NumBytes,\r
  IN VOID                                  *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
    Starts a target block update. This function will record data about write \r
    in fault tolerant storage and will complete the write in a recoverable \r
    manner, ensuring at all times that either the original contents or \r
    the modified contents are available.\r
\r
Arguments:\r
    This             - Calling context\r
    FvbHandle        - The handle of FVB protocol that provides services for \r
                       reading, writing, and erasing the target block.\r
    Lba              - The logical block address of the target block.  \r
    Offset           - The offset within the target block to place the data.\r
    NumBytes         - The number of bytes to write to the target block.\r
    Buffer           - The data to write.\r
\r
Returns:\r
    EFI_SUCCESS          - The function completed successfully\r
    EFI_BAD_BUFFER_SIZE  - The write would span a target block, which is not \r
                           a valid action.\r
    EFI_ACCESS_DENIED    - No writes have been allocated.\r
    EFI_NOT_FOUND        - Cannot find FVB by handle.\r
    EFI_OUT_OF_RESOURCES - Cannot allocate memory.\r
    EFI_ABORTED          - The function could not complete successfully.\r
\r
--*/\r
;\r
\r
//\r
// Internal functions\r
//\r
EFI_STATUS\r
FtwRestart (\r
  IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Restarts a previously interrupted write. The caller must provide the \r
    block protocol needed to complete the interrupted write.\r
\r
Arguments:\r
    FtwLiteDevice       - The private data of FTW_LITE driver\r
    FvbHandle           - The handle of FVB protocol that provides services for \r
                          reading, writing, and erasing the target block.\r
\r
Returns:\r
    EFI_SUCCESS         - The function completed successfully\r
    EFI_ACCESS_DENIED   - No pending writes exist\r
    EFI_NOT_FOUND       - FVB protocol not found by the handle\r
    EFI_ABORTED         - The function could not complete successfully\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwAbort (\r
  IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Aborts all previous allocated writes.\r
\r
Arguments:\r
    FtwLiteDevice    - The private data of FTW_LITE driver\r
\r
Returns:\r
    EFI_SUCCESS      - The function completed successfully\r
    EFI_ABORTED      - The function could not complete successfully.\r
    EFI_NOT_FOUND    - No allocated writes exist.\r
\r
--*/\r
;\r
\r
\r
EFI_STATUS\r
FtwWriteRecord (\r
  IN EFI_FTW_LITE_DEVICE                   *FtwLiteDevice,\r
  IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *Fvb\r
  )\r
/*++\r
\r
Routine Description:\r
    Write a record with fault tolerant mannaer.\r
    Since the content has already backuped in spare block, the write is \r
    guaranteed to be completed with fault tolerant manner.\r
\r
Arguments:\r
    FtwLiteDevice       - The private data of FTW_LITE driver\r
    Fvb                 - The FVB protocol that provides services for \r
                          reading, writing, and erasing the target block.\r
\r
Returns:\r
    EFI_SUCCESS         - The function completed successfully\r
    EFI_ABORTED         - The function could not complete successfully\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwEraseBlock (\r
  IN EFI_FTW_LITE_DEVICE              *FtwLiteDevice,\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
  EFI_LBA                             Lba\r
  )\r
/*++\r
\r
Routine Description:\r
    To Erase one block. The size is FTW_BLOCK_SIZE\r
\r
Arguments:\r
    FtwLiteDevice - Calling context\r
    FvBlock       - FVB Protocol interface\r
    Lba           - Lba of the firmware block\r
\r
Returns:\r
    EFI_SUCCESS   - Block LBA is Erased successfully\r
    Others        - Error occurs\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwEraseSpareBlock (\r
  IN EFI_FTW_LITE_DEVICE   *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Erase spare block.\r
\r
Arguments:\r
\r
  FtwLiteDevice - Calling context\r
\r
Returns:\r
\r
  Status code\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwGetFvbByHandle (\r
  IN EFI_HANDLE                           FvBlockHandle,\r
  OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvBlock\r
  )\r
/*++\r
\r
Routine Description:\r
    Retrive the proper FVB protocol interface by HANDLE.\r
\r
Arguments:\r
    FvBlockHandle       - The handle of FVB protocol that provides services for \r
                          reading, writing, and erasing the target block.\r
    FvBlock             - The interface of FVB protocol\r
\r
Returns:\r
    EFI_SUCCESS         - The function completed successfully\r
    EFI_ABORTED         - The function could not complete successfully\r
--*/\r
;\r
\r
EFI_STATUS\r
GetFvbByAddress (\r
  IN  EFI_PHYSICAL_ADDRESS               Address,\r
  OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Get firmware block by address.\r
\r
Arguments:\r
\r
  Address - Address specified the block\r
  FvBlock - The block caller wanted\r
\r
Returns:\r
\r
  Status code\r
\r
  EFI_NOT_FOUND - Block not found\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsInWorkingBlock (\r
  EFI_FTW_LITE_DEVICE                 *FtwLiteDevice,\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
  EFI_LBA                             Lba\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Is it in working block?\r
\r
Arguments:\r
\r
  FtwLiteDevice - Calling context\r
  FvBlock       - Fvb protocol instance\r
  Lba           - The block specified\r
\r
Returns:\r
\r
  In working block or not\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsBootBlock (\r
  EFI_FTW_LITE_DEVICE                 *FtwLiteDevice,\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
  EFI_LBA                             Lba\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Check whether the block is a boot block.\r
\r
Arguments:\r
\r
  FtwLiteDevice - Calling context\r
  FvBlock       - Fvb protocol instance\r
  Lba           - Lba value\r
\r
Returns:\r
\r
  Is a boot block or not\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FlushSpareBlockToTargetBlock (\r
  EFI_FTW_LITE_DEVICE                 *FtwLiteDevice,\r
  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
  EFI_LBA                             Lba\r
  )\r
/*++\r
\r
Routine Description:\r
    Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.\r
    Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
    FtwLiteDevice->FtwSpareLba.\r
    Target block is accessed by FvBlock protocol interface. LBA is Lba.\r
\r
Arguments:\r
    FtwLiteDevice  - The private data of FTW_LITE driver\r
    FvBlock        - FVB Protocol interface to access target block\r
    Lba            - Lba of the target block\r
\r
Returns:\r
    EFI_SUCCESS              - Spare block content is copied to target block\r
    EFI_INVALID_PARAMETER    - Input parameter error\r
    EFI_OUT_OF_RESOURCES     - Allocate memory error\r
    EFI_ABORTED              - The function could not complete successfully\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FlushSpareBlockToWorkingBlock (\r
  EFI_FTW_LITE_DEVICE                 *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.\r
    Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
    FtwLiteDevice->FtwSpareLba.\r
    Working block is accessed by FTW working FVB protocol interface. LBA is \r
    FtwLiteDevice->FtwWorkBlockLba.\r
\r
Arguments:\r
    FtwLiteDevice  - The private data of FTW_LITE driver\r
\r
Returns:\r
    EFI_SUCCESS              - Spare block content is copied to target block\r
    EFI_OUT_OF_RESOURCES     - Allocate memory error\r
    EFI_ABORTED              - The function could not complete successfully\r
\r
Notes:\r
    Since the working block header is important when FTW initializes, the \r
    state of the operation should be handled carefully. The Crc value is \r
    calculated without STATE element. \r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FlushSpareBlockToBootBlock (\r
  EFI_FTW_LITE_DEVICE                 *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.\r
    Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
    FtwLiteDevice->FtwSpareLba.\r
    Boot block is accessed by BootFvb protocol interface. LBA is 0.\r
\r
Arguments:\r
    FtwLiteDevice  - The private data of FTW_LITE driver\r
\r
Returns:\r
    EFI_SUCCESS              - Spare block content is copied to boot block\r
    EFI_INVALID_PARAMETER    - Input parameter error\r
    EFI_OUT_OF_RESOURCES     - Allocate memory error\r
    EFI_ABORTED              - The function could not complete successfully\r
\r
Notes:\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwUpdateFvState (\r
  IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
  IN EFI_LBA                             Lba,\r
  IN UINTN                               Offset,\r
  IN UINT8                               NewBit\r
  )\r
/*++\r
\r
Routine Description:\r
    Update a bit of state on a block device. The location of the bit is \r
    calculated by the (Lba, Offset, bit). Here bit is determined by the \r
    the name of a certain bit.\r
\r
Arguments:\r
    FvBlock    - FVB Protocol interface to access SrcBlock and DestBlock\r
    Lba        - Lba of a block\r
    Offset     - Offset on the Lba\r
    NewBit     - New value that will override the old value if it can be change\r
\r
Returns:\r
    EFI_SUCCESS   - A state bit has been updated successfully\r
    Others        - Access block device error.\r
\r
Notes:\r
    Assume all bits of State are inside the same BYTE. \r
\r
    EFI_ABORTED   - Read block fail\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwGetLastRecord (\r
  IN  EFI_FTW_LITE_DEVICE  *FtwLiteDevice,\r
  OUT EFI_FTW_LITE_RECORD  **FtwLastRecord\r
  )\r
/*++\r
\r
Routine Description:\r
    Get the last Write record pointer. \r
    The last record is the record whose 'complete' state hasn't been set.\r
    After all, this header may be a EMPTY header entry for next Allocate. \r
\r
Arguments:\r
    FtwLiteDevice   - Private data of this driver\r
    FtwLastRecord   - Pointer to retrieve the last write record\r
\r
Returns:\r
    EFI_SUCCESS     - Get the last write record successfully\r
    EFI_ABORTED     - The FTW work space is damaged\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsErasedFlashBuffer (\r
  IN BOOLEAN         Polarity,\r
  IN UINT8           *Buffer,\r
  IN UINTN           BufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Check whether a flash buffer is erased.\r
\r
Arguments:\r
\r
  Polarity    - All 1 or all 0\r
  Buffer      - Buffer to check\r
  BufferSize  - Size of the buffer\r
\r
Returns:\r
\r
  Erased or not.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
InitWorkSpaceHeader (\r
  IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r
  )\r
/*++\r
\r
Routine Description:\r
    Initialize a work space when there is no work space.\r
\r
Arguments:\r
    WorkingHeader - Pointer of working block header \r
\r
Returns:\r
    EFI_SUCCESS   - The function completed successfully\r
    EFI_ABORTED   - The function could not complete successfully.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
WorkSpaceRefresh (\r
  IN EFI_FTW_LITE_DEVICE  *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Read from working block to refresh the work space in memory.\r
\r
Arguments:\r
    FtwLiteDevice     - Point to private data of FTW driver\r
\r
Returns:\r
    EFI_SUCCESS   - The function completed successfully\r
    EFI_ABORTED   - The function could not complete successfully.\r
\r
--*/\r
;\r
\r
BOOLEAN\r
IsValidWorkSpace (\r
  IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r
  )\r
/*++\r
\r
Routine Description:\r
    Check to see if it is a valid work space.\r
\r
Arguments:\r
    WorkingHeader - Pointer of working block header \r
\r
Returns:\r
    EFI_SUCCESS   - The function completed successfully\r
    EFI_ABORTED   - The function could not complete successfully.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
CleanupWorkSpace (\r
  IN EFI_FTW_LITE_DEVICE  *FtwLiteDevice,\r
  IN OUT UINT8            *BlockBuffer,\r
  IN UINTN                BufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
    Reclaim the work space. Get rid of all the completed write records\r
    and write records in the Fault Tolerant work space.\r
\r
Arguments:\r
    FtwLiteDevice   - Point to private data of FTW driver\r
    FtwSpaceBuffer  - Buffer to contain the reclaimed clean data\r
    BufferSize      - Size of the FtwSpaceBuffer\r
\r
Returns:\r
    EFI_SUCCESS           - The function completed successfully\r
    EFI_BUFFER_TOO_SMALL  - The FtwSpaceBuffer is too small\r
    EFI_ABORTED           - The function could not complete successfully.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FtwReclaimWorkSpace (\r
  IN EFI_FTW_LITE_DEVICE  *FtwLiteDevice\r
  )\r
/*++\r
\r
Routine Description:\r
    Reclaim the work space on the working block.\r
\r
Arguments:\r
    FtwLiteDevice     - Point to private data of FTW driver\r
\r
Returns:\r
    EFI_SUCCESS           - The function completed successfully\r
    EFI_OUT_OF_RESOURCES  - Allocate memory error\r
    EFI_ABORTED           - The function could not complete successfully\r
\r
--*/\r
;\r
\r
#endif\r
Commit	Line	Data
d7dec593	1	/*++\r
	2	\r
	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	\r
	13	Module Name:\r
	14	\r
	15	FtwLite.h\r
	16	\r
	17	Abstract:\r
	18	\r
	19	This is a simple fault tolerant write driver, based on PlatformFd library.\r
	20	And it only supports write BufferSize <= SpareAreaLength.\r
	21	\r
	22	This boot service only protocol provides fault tolerant write capability for \r
	23	block devices. The protocol has internal non-volatile intermediate storage \r
	24	of the data and private information. It should be able to recover \r
	25	automatically from a critical fault, such as power failure. \r
	26	\r
	27	--*/\r
	28	\r
	29	#ifndef _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
	30	#define _EFI_FAULT_TOLERANT_WRITE_LITE_H_\r
	31	\r
ed7748fe	32	\r
d7dec593	33	#include <PiDxe.h>\r
ed7748fe	34	\r
d7dec593	35	#include <Protocol/PciRootBridgeIo.h>\r
	36	#include <Guid/SystemNvDataGuid.h>\r
	37	#include <Protocol/FaultTolerantWriteLite.h>\r
	38	#include <Protocol/FirmwareVolumeBlock.h>\r
ed7748fe	39	\r
d7dec593	40	#include <Library/PcdLib.h>\r
	41	#include <Library/DebugLib.h>\r
	42	#include <Library/UefiDriverEntryPoint.h>\r
	43	#include <Library/BaseMemoryLib.h>\r
	44	#include <Library/MemoryAllocationLib.h>\r
	45	#include <Library/UefiBootServicesTableLib.h>\r
	46	\r
	47	#include <Common/WorkingBlockHeader.h>\r
	48	\r
	49	#define EFI_D_FTW_LITE EFI_D_ERROR\r
	50	#define EFI_D_FTW_INFO EFI_D_INFO\r
	51	\r
	52	//\r
	53	// Flash erase polarity is 1\r
	54	//\r
	55	#define FTW_ERASE_POLARITY 1\r
	56	\r
	57	#define FTW_VALID_STATE 0\r
	58	#define FTW_INVALID_STATE 1\r
	59	\r
	60	#define FTW_ERASED_BYTE ((UINT8) (255))\r
	61	#define FTW_POLARITY_REVERT ((UINT8) (255))\r
	62	\r
	63	typedef struct {\r
	64	UINT8 WriteAllocated : 1;\r
	65	UINT8 SpareCompleted : 1;\r
	66	UINT8 WriteCompleted : 1;\r
	67	UINT8 Reserved : 5;\r
	68	#define WRITE_ALLOCATED 0x1\r
	69	#define SPARE_COMPLETED 0x2\r
	70	#define WRITE_COMPLETED 0x4\r
	71	\r
	72	EFI_DEV_PATH DevPath;\r
	73	EFI_LBA Lba;\r
	74	UINTN Offset;\r
	75	UINTN NumBytes;\r
	76	//\r
	77	// UINTN SpareAreaOffset;\r
	78	//\r
	79	} EFI_FTW_LITE_RECORD;\r
	80	\r
	81	#define FTW_LITE_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('F', 'T', 'W', 'L')\r
	82	\r
	83	//\r
	84	// MACRO for Block size.\r
	85	// Flash Erasing will do in block granularity.\r
	86	//\r
	87	#ifdef FV_BLOCK_SIZE\r
	88	#define FTW_BLOCK_SIZE FV_BLOCK_SIZE\r
	89	#else\r
	90	#define FV_BLOCK_SIZE 0x10000\r
	91	#define FTW_BLOCK_SIZE FV_BLOCK_SIZE\r
	92	#endif\r
	93	//\r
	94	// MACRO for FTW WORK SPACE Base & Size\r
	95	//\r
	96	#ifdef EFI_FTW_WORKING_OFFSET\r
	97	#define FTW_WORK_SPACE_BASE EFI_FTW_WORKING_OFFSET\r
	98	#else\r
	99	#define FTW_WORK_SPACE_BASE 0x00E000\r
	100	#endif\r
	101	\r
	102	#ifdef EFI_FTW_WORKING_LENGTH\r
	103	#define FTW_WORK_SPACE_SIZE EFI_FTW_WORKING_LENGTH\r
104	#else\r
105	#define FTW_WORK_SPACE_SIZE 0x002000\r
106	#endif\r
107	//\r
108	// MACRO for FTW header and record\r
109	//\r
110	#define FTW_WORKING_QUEUE_SIZE (FTW_WORK_SPACE_SIZE - sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER))\r
111	#define FTW_LITE_RECORD_SIZE (sizeof (EFI_FTW_LITE_RECORD))\r
112	#define WRITE_TOTAL_SIZE FTW_LITE_RECORD_SIZE\r
113	\r
114	//\r
115	// EFI Fault tolerant protocol private data structure\r
116	//\r
117	typedef struct {\r
118	UINTN Signature;\r
119	EFI_HANDLE Handle;\r
120	EFI_FTW_LITE_PROTOCOL FtwLiteInstance;\r
121	EFI_PHYSICAL_ADDRESS WorkSpaceAddress;\r
122	UINTN WorkSpaceLength;\r
123	EFI_PHYSICAL_ADDRESS SpareAreaAddress;\r
124	UINTN SpareAreaLength;\r
125	UINTN NumberOfSpareBlock; // Number of the blocks in spare block\r
126	UINTN SizeOfSpareBlock; // Block size in bytes of the blocks in spare block\r
127	EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *FtwWorkSpaceHeader;\r
128	EFI_FTW_LITE_RECORD *FtwLastRecord;\r
129	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwFvBlock; // FVB of working block\r
130	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FtwBackupFvb; // FVB of spare block\r
131	EFI_LBA FtwSpareLba;\r
132	EFI_LBA FtwWorkBlockLba; // Start LBA of working block\r
133	EFI_LBA FtwWorkSpaceLba; // Start LBA of working space\r
134	UINTN FtwWorkSpaceBase; // Offset from LBA start addr\r
135	UINTN FtwWorkSpaceSize;\r
136	UINT8 *FtwWorkSpace;\r
137	//\r
138	// Following a buffer of FtwWorkSpace[FTW_WORK_SPACE_SIZE],\r
139	// Allocated with EFI_FTW_LITE_DEVICE.\r
140	//\r
141	} EFI_FTW_LITE_DEVICE;\r
142	\r
143	#define FTW_LITE_CONTEXT_FROM_THIS(a) CR (a, EFI_FTW_LITE_DEVICE, FtwLiteInstance, FTW_LITE_DEVICE_SIGNATURE)\r
144	\r
145	//\r
146	// Driver entry point\r
147	//\r
148	EFI_STATUS\r
149	EFIAPI\r
150	InitializeFtwLite (\r
151	IN EFI_HANDLE ImageHandle,\r
152	IN EFI_SYSTEM_TABLE *SystemTable\r
153	)\r
154	/*++\r
155	\r
156	Routine Description:\r
157	This function is the entry point of the Fault Tolerant Write driver.\r
158	\r
159	Arguments:\r
160	ImageHandle - EFI_HANDLE: A handle for the image that is initializing \r
161	this driver\r
162	SystemTable - EFI_SYSTEM_TABLE: A pointer to the EFI system table\r
163	\r
164	Returns:\r
165	EFI_SUCCESS - FTW has finished the initialization\r
166	EFI_ABORTED - FTW initialization error\r
167	\r
168	--*/\r
169	;\r
170	\r
171	//\r
172	// Fault Tolerant Write Protocol API\r
173	//\r
174	EFI_STATUS\r
175	EFIAPI\r
176	FtwLiteWrite (\r
177	IN EFI_FTW_LITE_PROTOCOL *This,\r
178	IN EFI_HANDLE FvbHandle,\r
179	IN EFI_LBA Lba,\r
180	IN UINTN Offset,\r
181	IN UINTN *NumBytes,\r
182	IN VOID *Buffer\r
183	)\r
184	/*++\r
185	\r
186	Routine Description:\r
187	Starts a target block update. This function will record data about write \r
188	in fault tolerant storage and will complete the write in a recoverable \r
189	manner, ensuring at all times that either the original contents or \r
190	the modified contents are available.\r
191	\r
192	Arguments:\r
193	This - Calling context\r
194	FvbHandle - The handle of FVB protocol that provides services for \r
195	reading, writing, and erasing the target block.\r
196	Lba - The logical block address of the target block. \r
197	Offset - The offset within the target block to place the data.\r
198	NumBytes - The number of bytes to write to the target block.\r
199	Buffer - The data to write.\r
200	\r
201	Returns:\r
202	EFI_SUCCESS - The function completed successfully\r
203	EFI_BAD_BUFFER_SIZE - The write would span a target block, which is not \r
204	a valid action.\r
205	EFI_ACCESS_DENIED - No writes have been allocated.\r
206	EFI_NOT_FOUND - Cannot find FVB by handle.\r
207	EFI_OUT_OF_RESOURCES - Cannot allocate memory.\r
208	EFI_ABORTED - The function could not complete successfully.\r
209	\r
210	--*/\r
211	;\r
212	\r
213	//\r
214	// Internal functions\r
215	//\r
216	EFI_STATUS\r
217	FtwRestart (\r
218	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
219	)\r
220	/*++\r
221	\r
222	Routine Description:\r
223	Restarts a previously interrupted write. The caller must provide the \r
224	block protocol needed to complete the interrupted write.\r
225	\r
226	Arguments:\r
227	FtwLiteDevice - The private data of FTW_LITE driver\r
228	FvbHandle - The handle of FVB protocol that provides services for \r
229	reading, writing, and erasing the target block.\r
230	\r
231	Returns:\r
232	EFI_SUCCESS - The function completed successfully\r
233	EFI_ACCESS_DENIED - No pending writes exist\r
234	EFI_NOT_FOUND - FVB protocol not found by the handle\r
235	EFI_ABORTED - The function could not complete successfully\r
236	\r
237	--*/\r
238	;\r
239	\r
240	EFI_STATUS\r
241	FtwAbort (\r
242	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
243	)\r
244	/*++\r
245	\r
246	Routine Description:\r
247	Aborts all previous allocated writes.\r
248	\r
249	Arguments:\r
250	FtwLiteDevice - The private data of FTW_LITE driver\r
251	\r
252	Returns:\r
253	EFI_SUCCESS - The function completed successfully\r
254	EFI_ABORTED - The function could not complete successfully.\r
255	EFI_NOT_FOUND - No allocated writes exist.\r
256	\r
257	--*/\r
258	;\r
259	\r
260	\r
261	EFI_STATUS\r
262	FtwWriteRecord (\r
263	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
264	IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb\r
265	)\r
266	/*++\r
267	\r
268	Routine Description:\r
269	Write a record with fault tolerant mannaer.\r
270	Since the content has already backuped in spare block, the write is \r
271	guaranteed to be completed with fault tolerant manner.\r
272	\r
273	Arguments:\r
274	FtwLiteDevice - The private data of FTW_LITE driver\r
275	Fvb - The FVB protocol that provides services for \r
276	reading, writing, and erasing the target block.\r
277	\r
278	Returns:\r
279	EFI_SUCCESS - The function completed successfully\r
280	EFI_ABORTED - The function could not complete successfully\r
281	\r
282	--*/\r
283	;\r
284	\r
285	EFI_STATUS\r
286	FtwEraseBlock (\r
287	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
288	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r
289	EFI_LBA Lba\r
290	)\r
291	/*++\r
292	\r
293	Routine Description:\r
294	To Erase one block. The size is FTW_BLOCK_SIZE\r
295	\r
296	Arguments:\r
297	FtwLiteDevice - Calling context\r
298	FvBlock - FVB Protocol interface\r
299	Lba - Lba of the firmware block\r
300	\r
301	Returns:\r
302	EFI_SUCCESS - Block LBA is Erased successfully\r
303	Others - Error occurs\r
304	\r
305	--*/\r
306	;\r
307	\r
308	EFI_STATUS\r
309	FtwEraseSpareBlock (\r
310	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
311	)\r
312	/*++\r
313	\r
314	Routine Description:\r
315	\r
316	Erase spare block.\r
317	\r
318	Arguments:\r
319	\r
320	FtwLiteDevice - Calling context\r
321	\r
322	Returns:\r
323	\r
324	Status code\r
325	\r
326	--*/\r
327	;\r
328	\r
329	EFI_STATUS\r
330	FtwGetFvbByHandle (\r
331	IN EFI_HANDLE FvBlockHandle,\r
332	OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r
333	)\r
334	/*++\r
335	\r
336	Routine Description:\r
337	Retrive the proper FVB protocol interface by HANDLE.\r
338	\r
339	Arguments:\r
340	FvBlockHandle - The handle of FVB protocol that provides services for \r
341	reading, writing, and erasing the target block.\r
342	FvBlock - The interface of FVB protocol\r
343	\r
344	Returns:\r
345	EFI_SUCCESS - The function completed successfully\r
346	EFI_ABORTED - The function could not complete successfully\r
347	--*/\r
348	;\r
349	\r
350	EFI_STATUS\r
351	GetFvbByAddress (\r
352	IN EFI_PHYSICAL_ADDRESS Address,\r
353	OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r
354	)\r
355	/*++\r
356	\r
357	Routine Description:\r
358	\r
359	Get firmware block by address.\r
360	\r
361	Arguments:\r
362	\r
363	Address - Address specified the block\r
364	FvBlock - The block caller wanted\r
365	\r
366	Returns:\r
367	\r
368	Status code\r
369	\r
370	EFI_NOT_FOUND - Block not found\r
371	\r
372	--*/\r
373	;\r
374	\r
375	BOOLEAN\r
376	IsInWorkingBlock (\r
377	EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
378	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r
379	EFI_LBA Lba\r
380	)\r
381	/*++\r
382	\r
383	Routine Description:\r
384	\r
385	Is it in working block?\r
386	\r
387	Arguments:\r
388	\r
389	FtwLiteDevice - Calling context\r
390	FvBlock - Fvb protocol instance\r
391	Lba - The block specified\r
392	\r
393	Returns:\r
394	\r
395	In working block or not\r
396	\r
397	--*/\r
398	;\r
399	\r
400	BOOLEAN\r
401	IsBootBlock (\r
402	EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
403	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r
404	EFI_LBA Lba\r
405	)\r
406	/*++\r
407	\r
408	Routine Description:\r
409	\r
410	Check whether the block is a boot block.\r
411	\r
412	Arguments:\r
413	\r
414	FtwLiteDevice - Calling context\r
415	FvBlock - Fvb protocol instance\r
416	Lba - Lba value\r
417	\r
418	Returns:\r
419	\r
420	Is a boot block or not\r
421	\r
422	--*/\r
423	;\r
424	\r
425	EFI_STATUS\r
426	FlushSpareBlockToTargetBlock (\r
427	EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
428	EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r
429	EFI_LBA Lba\r
430	)\r
431	/*++\r
432	\r
433	Routine Description:\r
434	Copy the content of spare block to a target block. Size is FTW_BLOCK_SIZE.\r
435	Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
436	FtwLiteDevice->FtwSpareLba.\r
437	Target block is accessed by FvBlock protocol interface. LBA is Lba.\r
438	\r
439	Arguments:\r
440	FtwLiteDevice - The private data of FTW_LITE driver\r
441	FvBlock - FVB Protocol interface to access target block\r
442	Lba - Lba of the target block\r
443	\r
444	Returns:\r
445	EFI_SUCCESS - Spare block content is copied to target block\r
446	EFI_INVALID_PARAMETER - Input parameter error\r
447	EFI_OUT_OF_RESOURCES - Allocate memory error\r
448	EFI_ABORTED - The function could not complete successfully\r
449	\r
450	--*/\r
451	;\r
452	\r
453	EFI_STATUS\r
454	FlushSpareBlockToWorkingBlock (\r
455	EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
456	)\r
457	/*++\r
458	\r
459	Routine Description:\r
460	Copy the content of spare block to working block. Size is FTW_BLOCK_SIZE.\r
461	Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
462	FtwLiteDevice->FtwSpareLba.\r
463	Working block is accessed by FTW working FVB protocol interface. LBA is \r
464	FtwLiteDevice->FtwWorkBlockLba.\r
465	\r
466	Arguments:\r
467	FtwLiteDevice - The private data of FTW_LITE driver\r
468	\r
469	Returns:\r
470	EFI_SUCCESS - Spare block content is copied to target block\r
471	EFI_OUT_OF_RESOURCES - Allocate memory error\r
472	EFI_ABORTED - The function could not complete successfully\r
473	\r
474	Notes:\r
475	Since the working block header is important when FTW initializes, the \r
476	state of the operation should be handled carefully. The Crc value is \r
477	calculated without STATE element. \r
478	\r
479	--*/\r
480	;\r
481	\r
482	EFI_STATUS\r
483	FlushSpareBlockToBootBlock (\r
484	EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
485	)\r
486	/*++\r
487	\r
488	Routine Description:\r
489	Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.\r
490	Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
491	FtwLiteDevice->FtwSpareLba.\r
492	Boot block is accessed by BootFvb protocol interface. LBA is 0.\r
493	\r
494	Arguments:\r
495	FtwLiteDevice - The private data of FTW_LITE driver\r
496	\r
497	Returns:\r
498	EFI_SUCCESS - Spare block content is copied to boot block\r
499	EFI_INVALID_PARAMETER - Input parameter error\r
500	EFI_OUT_OF_RESOURCES - Allocate memory error\r
501	EFI_ABORTED - The function could not complete successfully\r
502	\r
503	Notes:\r
504	\r
505	--*/\r
506	;\r
507	\r
508	EFI_STATUS\r
509	FtwUpdateFvState (\r
510	IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvBlock,\r
511	IN EFI_LBA Lba,\r
512	IN UINTN Offset,\r
513	IN UINT8 NewBit\r
514	)\r
515	/*++\r
516	\r
517	Routine Description:\r
518	Update a bit of state on a block device. The location of the bit is \r
519	calculated by the (Lba, Offset, bit). Here bit is determined by the \r
520	the name of a certain bit.\r
521	\r
522	Arguments:\r
523	FvBlock - FVB Protocol interface to access SrcBlock and DestBlock\r
524	Lba - Lba of a block\r
525	Offset - Offset on the Lba\r
526	NewBit - New value that will override the old value if it can be change\r
527	\r
528	Returns:\r
529	EFI_SUCCESS - A state bit has been updated successfully\r
530	Others - Access block device error.\r
531	\r
532	Notes:\r
533	Assume all bits of State are inside the same BYTE. \r
534	\r
535	EFI_ABORTED - Read block fail\r
536	--*/\r
537	;\r
538	\r
539	EFI_STATUS\r
540	FtwGetLastRecord (\r
541	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
542	OUT EFI_FTW_LITE_RECORD **FtwLastRecord\r
543	)\r
544	/*++\r
545	\r
546	Routine Description:\r
547	Get the last Write record pointer. \r
548	The last record is the record whose 'complete' state hasn't been set.\r
549	After all, this header may be a EMPTY header entry for next Allocate. \r
550	\r
551	Arguments:\r
552	FtwLiteDevice - Private data of this driver\r
553	FtwLastRecord - Pointer to retrieve the last write record\r
554	\r
555	Returns:\r
556	EFI_SUCCESS - Get the last write record successfully\r
557	EFI_ABORTED - The FTW work space is damaged\r
558	\r
559	--*/\r
560	;\r
561	\r
562	BOOLEAN\r
563	IsErasedFlashBuffer (\r
564	IN BOOLEAN Polarity,\r
565	IN UINT8 *Buffer,\r
566	IN UINTN BufferSize\r
567	)\r
568	/*++\r
569	\r
570	Routine Description:\r
571	\r
572	Check whether a flash buffer is erased.\r
573	\r
574	Arguments:\r
575	\r
576	Polarity - All 1 or all 0\r
577	Buffer - Buffer to check\r
578	BufferSize - Size of the buffer\r
579	\r
580	Returns:\r
581	\r
582	Erased or not.\r
583	\r
584	--*/\r
585	;\r
586	\r
587	EFI_STATUS\r
588	InitWorkSpaceHeader (\r
589	IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r
590	)\r
591	/*++\r
592	\r
593	Routine Description:\r
594	Initialize a work space when there is no work space.\r
595	\r
596	Arguments:\r
597	WorkingHeader - Pointer of working block header \r
598	\r
599	Returns:\r
600	EFI_SUCCESS - The function completed successfully\r
601	EFI_ABORTED - The function could not complete successfully.\r
602	\r
603	--*/\r
604	;\r
605	\r
606	EFI_STATUS\r
607	WorkSpaceRefresh (\r
608	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
609	)\r
610	/*++\r
611	\r
612	Routine Description:\r
613	Read from working block to refresh the work space in memory.\r
614	\r
615	Arguments:\r
616	FtwLiteDevice - Point to private data of FTW driver\r
617	\r
618	Returns:\r
619	EFI_SUCCESS - The function completed successfully\r
620	EFI_ABORTED - The function could not complete successfully.\r
621	\r
622	--*/\r
623	;\r
624	\r
625	BOOLEAN\r
626	IsValidWorkSpace (\r
627	IN EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *WorkingHeader\r
628	)\r
629	/*++\r
630	\r
631	Routine Description:\r
632	Check to see if it is a valid work space.\r
633	\r
634	Arguments:\r
635	WorkingHeader - Pointer of working block header \r
636	\r
637	Returns:\r
638	EFI_SUCCESS - The function completed successfully\r
639	EFI_ABORTED - The function could not complete successfully.\r
640	\r
641	--*/\r
642	;\r
643	\r
644	EFI_STATUS\r
645	CleanupWorkSpace (\r
646	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice,\r
647	IN OUT UINT8 *BlockBuffer,\r
648	IN UINTN BufferSize\r
649	)\r
650	/*++\r
651	\r
652	Routine Description:\r
653	Reclaim the work space. Get rid of all the completed write records\r
654	and write records in the Fault Tolerant work space.\r
655	\r
656	Arguments:\r
657	FtwLiteDevice - Point to private data of FTW driver\r
658	FtwSpaceBuffer - Buffer to contain the reclaimed clean data\r
659	BufferSize - Size of the FtwSpaceBuffer\r
660	\r
661	Returns:\r
662	EFI_SUCCESS - The function completed successfully\r
663	EFI_BUFFER_TOO_SMALL - The FtwSpaceBuffer is too small\r
664	EFI_ABORTED - The function could not complete successfully.\r
665	\r
666	--*/\r
667	;\r
668	\r
669	EFI_STATUS\r
670	FtwReclaimWorkSpace (\r
671	IN EFI_FTW_LITE_DEVICE *FtwLiteDevice\r
672	)\r
673	/*++\r
674	\r
675	Routine Description:\r
676	Reclaim the work space on the working block.\r
677	\r
678	Arguments:\r
679	FtwLiteDevice - Point to private data of FTW driver\r
680	\r
681	Returns:\r
682	EFI_SUCCESS - The function completed successfully\r
683	EFI_OUT_OF_RESOURCES - Allocate memory error\r
684	EFI_ABORTED - The function could not complete successfully\r
685	\r
686	--*/\r
687	;\r
688	\r
689	#endif\r