4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Fault Tolerant Write protocol provides boot-time service for fault tolerant
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync write capability for block devices. The protocol provides for non-volatile
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync storage of the intermediate data and private information a caller would need to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync recover from a critical fault, such as a power failure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x3ebd9e82, 0x2c78, 0x4de6, {0x97, 0x86, 0x8d, 0x4b, 0xfc, 0xb7, 0xc8, 0x81 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Forward reference for pure ANSI compatability
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the size of the largest block that can be updated in a fault-tolerant manner.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates a pointer to the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BlockSize A pointer to a caller-allocated UINTN that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated to indicate the size of the largest block
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that can be updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_FAULT_TOLERANT_WRITE_GET_MAX_BLOCK_SIZE)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates space for the protocol to maintain information about writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Since writes must be completed in a fault-tolerant manner and multiple
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync writes require more resources to be successful, this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enables the protocol to ensure that enough space exists to track
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information about upcoming writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallerId The GUID identifying the write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PrivateDataSize The size of the caller's private data that must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync recorded for each write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfWrites The number of fault tolerant block writes that will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync need to occur.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Not all allocated writes have been completed. All
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync writes must be completed or aborted before another
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync fault tolerant write can occur.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starts a target block update. This records information about the write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in fault tolerant storage, and will complete the write in a recoverable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manner, ensuring at all times that either the original contents or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the modified contents are available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lba The logical block address of the target block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset The offset within the target block to place the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The number of bytes to write to the target block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PrivateData A pointer to private data that the caller requires
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to complete any pending writes in the event of a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvBlockHandle The handle of FVB protocol that provides services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for reading, writing, and erasing the target block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The data to write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a valid action.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED No writes have been allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The last write has not been completed. Restart()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be called to complete it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Restarts a previously interrupted write. The caller must provide the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync block protocol needed to complete the interrupted write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvBlockProtocol The handle of FVB protocol that provides services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for reading, writing, and erasing the target block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED No pending writes exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Aborts all previously allocated writes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No allocated writes exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starts a target block update. This function records information about the write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in fault-tolerant storage and completes the write in a recoverable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manner, ensuring at all times that either the original contents or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the modified contents are available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates a pointer to the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallerId The GUID identifying the last write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lba The logical block address of the last write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset The offset within the block of the last write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The length of the last write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PrivateDataSize On input, the size of the PrivateData buffer. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output, the size of the private data stored for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PrivateData A pointer to a buffer. The function will copy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PrivateDataSize bytes from the private data stored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for this write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Complete A Boolean value with TRUE indicating that the write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The function could not complete successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No allocated writes exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Protocol declaration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FAULT_TOLERANT_WRITE_GET_MAX_BLOCK_SIZE GetMaxBlockSize;