Data Structures
struct	LBA_CACHE

struct	FV_MEMMAP_DEVICE_PATH

struct	FV_PIWG_DEVICE_PATH

struct	EFI_FW_VOL_BLOCK_DEVICE

Macros
#define	FVB_DEVICE_SIGNATURE SIGNATURE_32('_','F','V','B')

#define	FVB_DEVICE_FROM_THIS(a) CR(a, EFI_FW_VOL_BLOCK_DEVICE, FwVolBlockInstance, FVB_DEVICE_SIGNATURE)

Functions
EFI_STATUS EFIAPI	FwVolBlockGetAttributes (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, OUT EFI_FVB_ATTRIBUTES_2 Attributes)

EFI_STATUS EFIAPI	FwVolBlockSetAttributes (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, IN CONST EFI_FVB_ATTRIBUTES_2 Attributes)

EFI_STATUS EFIAPI	FwVolBlockEraseBlock (IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,...)

EFI_STATUS EFIAPI	FwVolBlockReadBlock (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, IN CONST EFI_LBA Lba, IN CONST UINTN Offset, IN OUT UINTN NumBytes, IN OUT UINT8 *Buffer)

EFI_STATUS EFIAPI	FwVolBlockWriteBlock (IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, IN EFI_LBA Lba, IN UINTN Offset, IN OUT UINTN NumBytes, IN UINT8 *Buffer)

EFI_STATUS EFIAPI	FwVolBlockGetPhysicalAddress (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, OUT EFI_PHYSICAL_ADDRESS Address)

EFI_STATUS EFIAPI	FwVolBlockGetBlockSize (IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL This, IN CONST EFI_LBA Lba, IN OUT UINTN BlockSize, IN OUT UINTN *NumberOfBlocks)

Detailed Description

Firmware Volume Block protocol functions. Consumes FV hobs and creates appropriate block protocols.

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

Definition in file FwVolBlock.h.

Macro Definition Documentation

◆ FVB_DEVICE_FROM_THIS

#define FVB_DEVICE_FROM_THIS ( a ) CR(a, EFI_FW_VOL_BLOCK_DEVICE, FwVolBlockInstance, FVB_DEVICE_SIGNATURE)

Definition at line 45 of file FwVolBlock.h.

◆ FVB_DEVICE_SIGNATURE

#define FVB_DEVICE_SIGNATURE SIGNATURE_32('_','F','V','B')

Definition at line 13 of file FwVolBlock.h.

Function Documentation

◆ FwVolBlockEraseBlock()

EFI_STATUS EFIAPI FwVolBlockEraseBlock	(	IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
			...
	)

The EraseBlock() function erases one or more blocks as denoted by the variable argument list. The entire parameter list of blocks must be verified prior to erasing any blocks. If a block is requested that does not exist within the associated firmware volume (it has a larger index than the last block of the firmware volume), the EraseBlock() function must return EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.

Parameters

This	Calling context
...	Starting LBA followed by Number of Lba to erase. a -1 to terminate the list.

Return values

EFI_SUCCESS	The erase request was successfully completed.
EFI_ACCESS_DENIED	The firmware volume is in the WriteDisabled state.
EFI_DEVICE_ERROR	The block device is not functioning correctly and could not be written. The firmware device may have been partially erased.
EFI_INVALID_PARAMETER	One or more of the LBAs listed in the variable argument list do
EFI_UNSUPPORTED	Not supported.

Definition at line 158 of file FwVolBlock.c.

◆ FwVolBlockGetAttributes()

EFI_STATUS EFIAPI FwVolBlockGetAttributes	(	IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		OUT EFI_FVB_ATTRIBUTES_2 *	Attributes
	)

Retrieves Volume attributes. No polarity translations are done.

Parameters

This	Calling context
Attributes	output buffer which contains attributes

Return values

EFI_SUCCESS The firmware volume attributes were returned.

Definition at line 93 of file FwVolBlock.c.

◆ FwVolBlockGetBlockSize()

EFI_STATUS EFIAPI FwVolBlockGetBlockSize	(	IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		IN CONST EFI_LBA	Lba,
		IN OUT UINTN *	BlockSize,
		IN OUT UINTN *	NumberOfBlocks
	)

Retrieves the size in bytes of a specific block within a firmware volume.

Parameters

This	Indicates the calling context.
Lba	Indicates the block for which to return the size.
BlockSize	Pointer to a caller-allocated UINTN in which the size of the block is returned.
NumberOfBlocks	Pointer to a caller-allocated UINTN in which the number of consecutive blocks starting with Lba is returned. All blocks in this range have a size of BlockSize.

Return values

EFI_SUCCESS	The firmware volume base address is returned.
EFI_INVALID_PARAMETER	The requested LBA is out of range.

Definition at line 339 of file FwVolBlock.c.

◆ FwVolBlockGetPhysicalAddress()

EFI_STATUS EFIAPI FwVolBlockGetPhysicalAddress	(	IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		OUT EFI_PHYSICAL_ADDRESS *	Address
	)

Get Fvb's base address.

Parameters

This	Indicates the calling context.
Address	Fvb device base address.

Return values

EFI_SUCCESS	Successfully got Fvb's base address.
EFI_UNSUPPORTED	Not supported.

Definition at line 303 of file FwVolBlock.c.

◆ FwVolBlockReadBlock()

EFI_STATUS EFIAPI FwVolBlockReadBlock	(	IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		IN CONST EFI_LBA	Lba,
		IN CONST UINTN	Offset,
		IN OUT UINTN *	NumBytes,
		IN OUT UINT8 *	Buffer
	)

Read the specified number of bytes from the block to the input buffer.

Parameters

This	Indicates the calling context.
Lba	The starting logical block index to read.
Offset	Offset into the block at which to begin reading.
NumBytes	Pointer to a UINT32. At entry, *NumBytes contains the total size of the buffer. At exit, NumBytes contains the total number of bytes actually read.
Buffer	Pinter to a caller-allocated buffer that contains the destine for the read.

Return values

EFI_SUCCESS	The firmware volume was read successfully.
EFI_BAD_BUFFER_SIZE	The read was attempted across an LBA boundary.
EFI_ACCESS_DENIED	Access denied.
EFI_DEVICE_ERROR	The block device is malfunctioning and could not be read.

Definition at line 188 of file FwVolBlock.c.

◆ FwVolBlockSetAttributes()

EFI_STATUS EFIAPI FwVolBlockSetAttributes	(	IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		IN CONST EFI_FVB_ATTRIBUTES_2 *	Attributes
	)

Modifies the current settings of the firmware volume according to the input parameter.

Parameters

This	Calling context
Attributes	input buffer which contains attributes

Return values

EFI_SUCCESS	The firmware volume attributes were returned.
EFI_INVALID_PARAMETER	The attributes requested are in conflict with the capabilities as declared in the firmware volume header.
EFI_UNSUPPORTED	Not supported.

Definition at line 125 of file FwVolBlock.c.

◆ FwVolBlockWriteBlock()

EFI_STATUS EFIAPI FwVolBlockWriteBlock	(	IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *	This,
		IN EFI_LBA	Lba,
		IN UINTN	Offset,
		IN OUT UINTN *	NumBytes,
		IN UINT8 *	Buffer
	)

Writes the specified number of bytes from the input buffer to the block.

Parameters

This	Indicates the calling context.
Lba	The starting logical block index to write to.
Offset	Offset into the block at which to begin writing.
NumBytes	Pointer to a UINT32. At entry, *NumBytes contains the total size of the buffer. At exit, NumBytes contains the total number of bytes actually written.
Buffer	Pinter to a caller-allocated buffer that contains the source for the write.

Return values

EFI_SUCCESS	The firmware volume was written successfully.
EFI_BAD_BUFFER_SIZE	The write was attempted across an LBA boundary. On output, NumBytes contains the total number of bytes actually written.
EFI_ACCESS_DENIED	The firmware volume is in the WriteDisabled state.
EFI_DEVICE_ERROR	The block device is malfunctioning and could not be written.
EFI_UNSUPPORTED	Not supported.

Definition at line 280 of file FwVolBlock.c.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ FVB_DEVICE_FROM_THIS

◆ FVB_DEVICE_SIGNATURE

Function Documentation

◆ FwVolBlockEraseBlock()

◆ FwVolBlockGetAttributes()

◆ FwVolBlockGetBlockSize()

◆ FwVolBlockGetPhysicalAddress()

◆ FwVolBlockReadBlock()

◆ FwVolBlockSetAttributes()

◆ FwVolBlockWriteBlock()