The internal header file includes the common header files, defines\r
internal structure and functions used by FtwLite module.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\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
#include <PiDxe.h>\r
\r
#include <Guid/SystemNvDataGuid.h>\r
+#include <Guid/ZeroGuid.h>\r
#include <Protocol/FaultTolerantWrite.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
#include <Protocol/SwapAddressRange.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/ReportStatusCodeLib.h>\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
-//\r
-// EFI Fault tolerant block update write queue entry\r
-//\r
-typedef struct {\r
- UINT8 HeaderAllocated : 1;\r
- UINT8 WritesAllocated : 1;\r
- UINT8 Complete : 1;\r
#define HEADER_ALLOCATED 0x1\r
#define WRITES_ALLOCATED 0x2\r
#define WRITES_COMPLETED 0x4\r
- UINT8 Reserved : 5;\r
- EFI_GUID CallerId;\r
- UINTN NumberOfWrites;\r
- UINTN PrivateDataSize;\r
-} EFI_FAULT_TOLERANT_WRITE_HEADER;\r
\r
-//\r
-// EFI Fault tolerant block update write queue record\r
-//\r
-typedef struct {\r
- UINT8 BootBlockUpdate : 1;\r
- UINT8 SpareComplete : 1;\r
- UINT8 DestinationComplete : 1;\r
#define BOOT_BLOCK_UPDATE 0x1\r
#define SPARE_COMPLETED 0x2\r
#define DEST_COMPLETED 0x4\r
- UINT8 Reserved : 5;\r
- EFI_LBA Lba;\r
- UINTN Offset;\r
- UINTN Length;\r
- EFI_PHYSICAL_ADDRESS FvBaseAddress;\r
- //\r
- // UINT8 PrivateData[PrivateDataSize]\r
- //\r
-} EFI_FAULT_TOLERANT_WRITE_RECORD;\r
-\r
\r
-#define RECORD_SIZE(PrivateDataSize) (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + PrivateDataSize)\r
-\r
-#define RECORD_TOTAL_SIZE(NumberOfWrites, PrivateDataSize) \\r
- ((NumberOfWrites) * (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + PrivateDataSize))\r
-\r
-#define WRITE_TOTAL_SIZE(NumberOfWrites, PrivateDataSize) \\r
- ( \\r
- sizeof (EFI_FAULT_TOLERANT_WRITE_HEADER) + (NumberOfWrites) * \\r
- (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + PrivateDataSize) \\r
- )\r
\r
#define FTW_DEVICE_SIGNATURE SIGNATURE_32 ('F', 'T', 'W', 'D')\r
\r
OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock\r
);\r
\r
+/**\r
+ Retrive the proper Swap Address Range protocol interface.\r
+\r
+ @param[out] SarProtocol The interface of SAR protocol\r
+\r
+ @retval EFI_SUCCESS The SAR protocol instance was found and returned in SarProtocol.\r
+ @retval EFI_NOT_FOUND The SAR protocol instance was not found.\r
+ @retval EFI_INVALID_PARAMETER SarProtocol is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+FtwGetSarProtocol (\r
+ OUT VOID **SarProtocol\r
+ );\r
+ \r
+/**\r
+ Function returns an array of handles that support the FVB protocol\r
+ in a buffer allocated from pool. \r
+\r
+ @param[out] NumberHandles The number of handles returned in Buffer.\r
+ @param[out] Buffer A pointer to the buffer to return the requested\r
+ array of handles that support FVB protocol.\r
+\r
+ @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of\r
+ handles in Buffer was returned in NumberHandles.\r
+ @retval EFI_NOT_FOUND No FVB handle was found.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r
+ @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+GetFvbCountAndBuffer (\r
+ OUT UINTN *NumberHandles,\r
+ OUT EFI_HANDLE **Buffer\r
+ );\r
+\r
+\r
+/**\r
+ Allocate private data for FTW driver and initialize it.\r
+\r
+ @param[out] FtwData Pointer to the FTW device structure\r
+\r
+ @retval EFI_SUCCESS Initialize the FTW device successfully.\r
+ @retval EFI_OUT_OF_RESOURCES Allocate memory error\r
+ @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist\r
+\r
+**/\r
+EFI_STATUS\r
+InitFtwDevice (\r
+ OUT EFI_FTW_DEVICE **FtwData \r
+ );\r
+\r
+\r
+/**\r
+ Initialization for Fault Tolerant Write is done in this handler.\r
+\r
+ @param[in, out] FtwDevice Pointer to the FTW device structure\r
+\r
+ @retval EFI_SUCCESS Initialize the FTW protocol successfully.\r
+ @retval EFI_NOT_FOUND No proper FVB protocol was found.\r
+ \r
+**/\r
+EFI_STATUS\r
+InitFtwProtocol (\r
+ IN OUT EFI_FTW_DEVICE *FtwDevice\r
+ );\r
+\r
+/**\r
+ Initialize a local work space header.\r
+\r
+ Since Signature and WriteQueueSize have been known, Crc can be calculated out,\r
+ then the work space header will be fixed.\r
+**/\r
+VOID\r
+InitializeLocalWorkSpaceHeader (\r
+ VOID\r
+ );\r
+ \r
#endif\r