\r
This is a simple fault tolerant write driver.\r
\r
- This boot service protocol only 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
+ This boot service protocol only 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
- The implementation uses an FTW (Fault Tolerant Write) Work Space. \r
+ The implementation uses an FTW (Fault Tolerant Write) Work Space.\r
This work space is a memory copy of the work space on the Working Block,\r
the size of the work space is the FTW_WORK_SPACE_SIZE bytes.\r
- \r
+\r
The work space stores each write record as EFI_FTW_RECORD structure.\r
The spare block stores the write buffer before write to the target block.\r
- \r
+\r
The write record has three states to specify the different phase of write operation.\r
1) WRITE_ALLOCATED is that the record is allocated in write space.\r
The information of write operation is stored in write record structure.\r
Final copy the data from the spare block to the target block.\r
\r
To make this drive work well, the following conditions must be satisfied:\r
- 1. The write NumBytes data must be fit within Spare area. \r
+ 1. The write NumBytes data must be fit within Spare area.\r
Offset + NumBytes <= SpareAreaLength\r
2. The whole flash range has the same block size.\r
3. Working block is an area which contains working space in its last block and has the same size as spare block.\r
- 4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on. \r
+ 4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on.\r
5. Spare area must be in the single one Firmware Volume Block range which FVB protocol is produced on.\r
- 6. Any write data area (SpareAreaLength Area) which the data will be written into must be \r
+ 6. Any write data area (SpareAreaLength Area) which the data will be written into must be\r
in the single one Firmware Volume Block range which FVB protocol is produced on.\r
7. If write data area (such as Variable range) is enlarged, the spare area range must be enlarged.\r
The spare area must be enough large to store the write data before write them into the target range.\r
If one of them is not satisfied, FtwWrite may fail.\r
Usually, Spare area only takes one block. That's SpareAreaLength = BlockSize, NumberOfSpareBlock = 1.\r
\r
-Copyright (c) 2006 - 2010, 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
-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
+Copyright (c) 2006 - 2018, 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
+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
+#include <Library/UefiBootServicesTableLib.h>\r
#include "FaultTolerantWrite.h"\r
EFI_EVENT mFvbRegistration = NULL;\r
\r
\r
/**\r
- Retrive the FVB protocol interface by HANDLE.\r
+ Retrieve the FVB protocol interface by HANDLE.\r
\r
@param[in] FvBlockHandle The handle of FVB protocol that provides services for\r
reading, writing, and erasing the target block.\r
@retval EFI_SUCCESS The interface information for the specified protocol was returned.\r
@retval EFI_UNSUPPORTED The device does not support the FVB protocol.\r
@retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.\r
- \r
+\r
**/\r
EFI_STATUS\r
FtwGetFvbByHandle (\r
}\r
\r
/**\r
- Retrive the Swap Address Range protocol interface.\r
+ Retrieve the Swap Address Range protocol interface.\r
\r
@param[out] SarProtocol The interface of SAR protocol\r
\r
// Locate Swap Address Range protocol\r
//\r
Status = gBS->LocateProtocol (\r
- &gEfiSwapAddressRangeProtocolGuid, \r
- NULL, \r
+ &gEfiSwapAddressRangeProtocolGuid,\r
+ NULL,\r
SarProtocol\r
);\r
return Status;\r
\r
/**\r
Function returns an array of handles that support the FVB protocol\r
- in a buffer allocated from pool. \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
@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
**/\r
EFI_STATUS\r
GetFvbCountAndBuffer (\r
EFI_FTW_DEVICE *FtwDevice;\r
\r
//\r
- // Just return to avoid install SMM FaultTolerantWriteProtocol again\r
- // if Fault Tolerant Write protocol had been installed.\r
- // \r
+ // Just return to avoid installing FaultTolerantWriteProtocol again\r
+ // if Fault Tolerant Write protocol has been installed.\r
+ //\r
Status = gBS->LocateProtocol (\r
- &gEfiFaultTolerantWriteProtocolGuid, \r
- NULL, \r
+ &gEfiFaultTolerantWriteProtocolGuid,\r
+ NULL,\r
(VOID **) &FtwProtocol\r
);\r
if (!EFI_ERROR (Status)) {\r
Status = InitFtwProtocol (FtwDevice);\r
if (EFI_ERROR(Status)) {\r
return ;\r
- } \r
- \r
+ }\r
+\r
//\r
// Install protocol interface\r
//\r
&FtwDevice->FtwInstance\r
);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
Status = gBS->CloseEvent (Event);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
return;\r
}\r
\r
@retval EFI_SUCCESS The initialization finished 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
**/\r
EFI_STATUS\r
EFIAPI\r
EFI_STATUS Status;\r
EFI_FTW_DEVICE *FtwDevice;\r
\r
+ FtwDevice = NULL;\r
+\r
//\r
// Allocate private data structure for FTW protocol and do some initialization\r
//\r
\r
//\r
// Register FvbNotificationEvent () notify function.\r
- // \r
+ //\r
EfiCreateProtocolNotifyEvent (\r
&gEfiFirmwareVolumeBlockProtocolGuid,\r
TPL_CALLBACK,\r
(VOID *)FtwDevice,\r
&mFvbRegistration\r
);\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
+\r
+/**\r
+ Internal implementation of CRC32. Depending on the execution context\r
+ (traditional SMM or DXE vs standalone MM), this function is implemented\r
+ via a call to the CalculateCrc32 () boot service, or via a library\r
+ call.\r
+\r
+ If Buffer is NULL, then ASSERT().\r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
+\r
+ @param[in] Buffer A pointer to the buffer on which the 32-bit CRC is to be computed.\r
+ @param[in] Length The number of bytes in the buffer Data.\r
+\r
+ @retval Crc32 The 32-bit CRC was computed for the data buffer.\r
+\r
+**/\r
+UINT32\r
+FtwCalculateCrc32 (\r
+ IN VOID *Buffer,\r
+ IN UINTN Length\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINT32 ReturnValue;\r
+\r
+ Status = gBS->CalculateCrc32 (Buffer, Length, &ReturnValue);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return ReturnValue;\r
+}\r
projects / mirror_edk2.git / blobdiff