4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Firmware Volume Block protocol functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Consumes FV hobs and creates appropriate block protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The 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#define FVB_DEVICE_SIGNATURE SIGNATURE_32('_','F','V','B')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UEFI Specification define FV device path format if FV provide name guid in extension header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FwVolBlockInstance;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CR(a, EFI_FW_VOL_BLOCK_DEVICE, FwVolBlockInstance, FVB_DEVICE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves Volume attributes. No polarity translations are done.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Calling context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes output buffer which contains attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware volume attributes were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modifies the current settings of the firmware volume according to the input parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Calling context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes input buffer which contains attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware volume attributes were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The attributes requested are in conflict with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the capabilities as declared in the firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync volume header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EraseBlock() function erases one or more blocks as denoted by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable argument list. The entire parameter list of blocks must be verified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to erasing any blocks. If a block is requested that does not exist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within the associated firmware volume (it has a larger index than the last
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync block of the firmware volume), the EraseBlock() function must return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Calling context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... Starting LBA followed by Number of Lba to erase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a -1 to terminate the list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The erase request was successfully completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The block device is not functioning correctly
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and could not be written. The firmware device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may have been partially erased.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the LBAs listed in the variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync argument list do
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Read the specified number of bytes from the block to the input buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lba The starting logical block index to read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset Offset into the block at which to begin reading.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Pointer to a UINT32. At entry, *NumBytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the total size of the buffer. At exit,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *NumBytes contains the total number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync actually read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pinter to a caller-allocated buffer that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the destine for the read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware volume was read successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The read was attempted across an LBA boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Access denied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Writes the specified number of bytes from the input buffer to the block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lba The starting logical block index to write to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Offset Offset into the block at which to begin writing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Pointer to a UINT32. At entry, *NumBytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the total size of the buffer. At exit,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *NumBytes contains the total number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync actually written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pinter to a caller-allocated buffer that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the source for the write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware volume was written successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The write was attempted across an LBA boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, NumBytes contains the total number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes actually written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The firmware volume is in the WriteDisabled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The block device is malfunctioning and could not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get Fvb's base address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address Fvb device base address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully got Fvb's base address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the size in bytes of a specific block within a firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This Indicates the calling context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lba Indicates the block for which to return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BlockSize Pointer to a caller-allocated UINTN in which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the block is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfBlocks Pointer to a caller-allocated UINTN in which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of consecutive blocks starting with Lba
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. All blocks in this range have a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of BlockSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware volume base address is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The requested LBA is out of range.