#include "FaultTolerantWrite.h"

Functions
EFI_STATUS EFIAPI	FtwGetMaxBlockSize (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL This, OUT UINTN BlockSize)

EFI_STATUS EFIAPI	FtwAllocate (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL This, IN EFI_GUID CallerId, IN UINTN PrivateDataSize, IN UINTN NumberOfWrites)

EFI_STATUS	FtwWriteRecord (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL This, IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL Fvb, IN UINTN BlockSize)

EFI_STATUS EFIAPI	FtwWrite (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL This, IN EFI_LBA Lba, IN UINTN Offset, IN UINTN Length, IN VOID PrivateData, IN EFI_HANDLE FvBlockHandle, IN VOID *Buffer)

EFI_STATUS EFIAPI	FtwRestart (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *This, IN EFI_HANDLE FvBlockHandle)

EFI_STATUS EFIAPI	FtwAbort (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *This)

EFI_STATUS EFIAPI	FtwGetLastWrite (IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL This, OUT EFI_GUID CallerId, OUT EFI_LBA Lba, OUT UINTN Offset, OUT UINTN Length, IN OUT UINTN PrivateDataSize, OUT VOID PrivateData, OUT BOOLEAN Complete)

Detailed Description

These are the common Fault Tolerant Write (FTW) functions that are shared by DXE FTW driver and SMM FTW driver.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FaultTolerantWrite.c.

Function Documentation

◆ FtwAbort()

EFI_STATUS EFIAPI FtwAbort ( IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL * This )

Aborts all previous allocated writes.

Parameters

This	The pointer to this protocol instance.

Return values

EFI_SUCCESS	The function completed successfully
EFI_ABORTED	The function could not complete successfully.
EFI_NOT_FOUND	No allocated writes exist.

Definition at line 750 of file FaultTolerantWrite.c.

◆ FtwAllocate()

EFI_STATUS EFIAPI FtwAllocate	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		IN EFI_GUID *	CallerId,
		IN UINTN	PrivateDataSize,
		IN UINTN	NumberOfWrites
	)

Allocates space for the protocol to maintain information about writes. Since writes must be completed in a fault tolerant manner and multiple updates will require more resources to be successful, this function enables the protocol to ensure that enough space exists to track information about the upcoming writes.

All writes must be completed or aborted before another fault tolerant write can occur.

Parameters

This	The pointer to this protocol instance.
CallerId	The GUID identifying the write.
PrivateDataSize	The size of the caller's private data that must be recorded for each write.
NumberOfWrites	The number of fault tolerant block writes that will need to occur.

Returns: EFI_SUCCESS The function completed successfully

Return values

EFI_ABORTED	The function could not complete successfully.
EFI_ACCESS_DENIED	All allocated writes have not been completed.

Definition at line 71 of file FaultTolerantWrite.c.

◆ FtwGetLastWrite()

EFI_STATUS EFIAPI FtwGetLastWrite	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		OUT EFI_GUID *	CallerId,
		OUT EFI_LBA *	Lba,
		OUT UINTN *	Offset,
		OUT UINTN *	Length,
		IN OUT UINTN *	PrivateDataSize,
		OUT VOID *	PrivateData,
		OUT BOOLEAN *	Complete
	)

Starts a target block update. This records information about the write in fault tolerant storage and will complete the write in a recoverable manner, ensuring at all times that either the original contents or the modified contents are available.

Parameters

This	The pointer to this protocol instance.
CallerId	The GUID identifying the last write.
Lba	The logical block address of the last write.
Offset	The offset within the block of the last write.
Length	The length of the last write.
PrivateDataSize	bytes from the private data stored for this write.
PrivateData	A pointer to a buffer. The function will copy
Complete	A Boolean value with TRUE indicating that the write was completed.

Return values

EFI_SUCCESS	The function completed successfully
EFI_ABORTED	The function could not complete successfully
EFI_NOT_FOUND	No allocated writes exist
EFI_BUFFER_TOO_SMALL	Input buffer is not larget enough

Definition at line 819 of file FaultTolerantWrite.c.

◆ FtwGetMaxBlockSize()

EFI_STATUS EFIAPI FtwGetMaxBlockSize	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		OUT UINTN *	BlockSize
	)

Query the largest block that may be updated in a fault tolerant manner.

Parameters

This	The pointer to this protocol instance.
BlockSize	A pointer to a caller allocated UINTN that is updated to indicate the size of the largest block that can be updated.

Returns: EFI_SUCCESS The function completed successfully

Definition at line 30 of file FaultTolerantWrite.c.

◆ FtwRestart()

EFI_STATUS EFIAPI FtwRestart	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		IN EFI_HANDLE	FvBlockHandle
	)

Restarts a previously interrupted write. The caller must provide the block protocol needed to complete the interrupted write.

Parameters

This	The pointer to this protocol instance.
FvBlockHandle	The handle of FVB protocol that provides services for reading, writing, and erasing the target block.

Return values

EFI_SUCCESS	The function completed successfully
EFI_ACCESS_DENIED	No pending writes exist
EFI_NOT_FOUND	FVB protocol not found by the handle
EFI_ABORTED	The function could not complete successfully

Definition at line 657 of file FaultTolerantWrite.c.

◆ FtwWrite()

EFI_STATUS EFIAPI FtwWrite	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		IN EFI_LBA	Lba,
		IN UINTN	Offset,
		IN UINTN	Length,
		IN VOID *	PrivateData,
		IN EFI_HANDLE	FvBlockHandle,
		IN VOID *	Buffer
	)

Starts a target block update. This function will record data about write in fault tolerant storage and will complete the write in a recoverable manner, ensuring at all times that either the original contents or the modified contents are available.

Parameters

This	The pointer to this protocol instance.
Lba	The logical block address of the target block.
Offset	The offset within the target block to place the data.
Length	The number of bytes to write to the target block.
PrivateData	A pointer to private data that the caller requires to complete any pending writes in the event of a fault.
FvBlockHandle	The handle of FVB protocol that provides services for reading, writing, and erasing the target block.
Buffer	The data to write.

Return values

EFI_SUCCESS	The function completed successfully
EFI_ABORTED	The function could not complete successfully.
EFI_BAD_BUFFER_SIZE	The input data can't fit within the spare block. Offset + *NumBytes > SpareAreaLength.
EFI_ACCESS_DENIED	No writes have been allocated.
EFI_OUT_OF_RESOURCES	Cannot allocate enough memory resource.
EFI_NOT_FOUND	Cannot find FVB protocol by handle.

Definition at line 313 of file FaultTolerantWrite.c.

◆ FtwWriteRecord()

EFI_STATUS FtwWriteRecord	(	IN EFI_FAULT_TOLERANT_WRITE_PROTOCOL *	This,
		IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	Fvb,
		IN UINTN	BlockSize
	)

Write a record with fault tolerant manner. Since the content has already backuped in spare block, the write is guaranteed to be completed with fault tolerant manner.

Parameters

This	The pointer to this protocol instance.
Fvb	The FVB protocol that provides services for reading, writing, and erasing the target block.
BlockSize	The size of the block.

Return values

EFI_SUCCESS	The function completed successfully
EFI_ABORTED	The function could not complete successfully

Definition at line 186 of file FaultTolerantWrite.c.

Functions

Detailed Description

Function Documentation

◆ FtwAbort()

◆ FtwAllocate()

◆ FtwGetLastWrite()

◆ FtwGetMaxBlockSize()

◆ FtwRestart()

◆ FtwWrite()

◆ FtwWriteRecord()