|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL |
Macros | |
| #define | EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL_GUID { 0x8f644fa9, 0xe850, 0x4db1, {0x9c, 0xe2, 0xb, 0x44, 0x69, 0x8e, 0x8d, 0xa4 } } |
| #define | EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL_GUID { 0x8f644fa9, 0xe850, 0x4db1, {0x9c, 0xe2, 0xb, 0x44, 0x69, 0x8e, 0x8d, 0xa4 } } |
| #define | EFI_LBA_LIST_TERMINATOR 0xFFFFFFFFFFFFFFFFULL |
Variables | |
| EFI_GUID | gEfiFirmwareVolumeBlockProtocolGuid |
| EFI_GUID | gEfiFirmwareVolumeBlock2ProtocolGuid |
This file provides control over block-oriented firmware devices.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL_GUID { 0x8f644fa9, 0xe850, 0x4db1, {0x9c, 0xe2, 0xb, 0x44, 0x69, 0x8e, 0x8d, 0xa4 } } |
| #define EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL_GUID { 0x8f644fa9, 0xe850, 0x4db1, {0x9c, 0xe2, 0xb, 0x44, 0x69, 0x8e, 0x8d, 0xa4 } } |
| #define EFI_LBA_LIST_TERMINATOR 0xFFFFFFFFFFFFFFFFULL |
EFI_LBA_LIST_TERMINATOR
| typedef EFI_STATUS(EFIAPI * EFI_FVB_ERASE_BLOCKS)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,...) |
Erases and initializes a firmware volume block.
The EraseBlocks() function erases one or more blocks as denoted by the variable argument list. The entire parameter list of blocks must be verified before 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 EraseBlocks() function must return the status code EFI_INVALID_PARAMETER without modifying the contents of the firmware volume. Implementations should be mindful that the firmware volume might be in the WriteDisabled state. If it is in this state, the EraseBlocks() function must return the status code EFI_ACCESS_DENIED without modifying the contents of the firmware volume. All calls to EraseBlocks() must be fully flushed to the hardware before the EraseBlocks() service returns.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| ... | The variable argument list is a list of tuples. Each tuple describes a range of LBAs to erase and consists of the following:
|
The list is terminated with an EFI_LBA_LIST_TERMINATOR. For example, the following indicates that two ranges of blocks (5-7 and 10-11) are to be erased: EraseBlocks (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
| EFI_SUCCESS | The erase request 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 not exist in the firmware volume. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_GET_ATTRIBUTES)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This, OUT EFI_FVB_ATTRIBUTES_2 *Attributes) |
The GetAttributes() function retrieves the attributes and current settings of the block.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| Attributes | Pointer to EFI_FVB_ATTRIBUTES_2 in which the attributes and current settings are returned. Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER. |
| EFI_SUCCESS | The firmware volume attributes were returned. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_GET_BLOCK_SIZE)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This, IN EFI_LBA Lba, OUT UINTN *BlockSize, OUT UINTN *NumberOfBlocks) |
The GetBlockSize() function retrieves the size of the requested block. It also returns the number of additional blocks with the identical size. The GetBlockSize() function is used to retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| 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. |
| EFI_SUCCESS | The firmware volume base address was returned. |
| EFI_INVALID_PARAMETER | The requested LBA is out of range. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_GET_PHYSICAL_ADDRESS)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This, OUT EFI_PHYSICAL_ADDRESS *Address) |
The GetPhysicalAddress() function retrieves the base address of a memory-mapped firmware volume. This function should be called only for memory-mapped firmware volumes.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| Address | Pointer to a caller-allocated EFI_PHYSICAL_ADDRESS that, on successful return from GetPhysicalAddress(), contains the base address of the firmware volume. |
| EFI_SUCCESS | The firmware volume base address was returned. |
| EFI_UNSUPPORTED | The firmware volume is not memory mapped. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_READ)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This, IN EFI_LBA Lba, IN UINTN Offset, IN OUT UINTN *NumBytes, IN OUT UINT8 *Buffer) |
Reads the specified number of bytes into a buffer from the specified block.
The Read() function reads the requested number of bytes from the requested block and stores them in the provided buffer. Implementations should be mindful that the firmware volume might be in the ReadDisabled state. If it is in this state, the Read() function must return the status code EFI_ACCESS_DENIED without modifying the contents of the buffer. The Read() function must also prevent spanning block boundaries. If a read is requested that would span a block boundary, the read must read up to the boundary but not beyond. The output parameter NumBytes must be set to correctly indicate the number of bytes actually read. The caller must be aware that a read may be partially completed.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| Lba | The starting logical block index from which to read. |
| Offset | Offset into the block at which to begin reading. |
| NumBytes | Pointer to a UINTN. At entry, *NumBytes contains the total size of the buffer. At exit, *NumBytes contains the total number of bytes read. |
| Buffer | Pointer to a caller-allocated buffer that will be used to hold the data that is read. |
| EFI_SUCCESS | The firmware volume was read successfully, and contents are in Buffer. |
| EFI_BAD_BUFFER_SIZE | Read attempted across an LBA boundary. On output, NumBytes contains the total number of bytes returned in Buffer. |
| EFI_ACCESS_DENIED | The firmware volume is in the ReadDisabled state. |
| EFI_DEVICE_ERROR | The block device is not functioning correctly and could not be read. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_SET_ATTRIBUTES)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This, IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes) |
The SetAttributes() function sets configurable firmware volume attributes and returns the new settings of the firmware volume.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| Attributes | On input, Attributes is a pointer to EFI_FVB_ATTRIBUTES_2 that contains the desired firmware volume settings. On successful return, it contains the new settings of the firmware volume. Type EFI_FVB_ATTRIBUTES_2 is defined in EFI_FIRMWARE_VOLUME_HEADER. |
| 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. |
| typedef EFI_STATUS(EFIAPI * EFI_FVB_WRITE)(IN CONST EFI_FIRMWARE_VOLUME_BLOCK2_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.
The Write() function writes the specified number of bytes from the provided buffer to the specified block and offset. If the firmware volume is sticky write, the caller must ensure that all the bits of the specified range to write are in the EFI_FVB_ERASE_POLARITY state before calling the Write() function, or else the result will be unpredictable. This unpredictability arises because, for a sticky-write firmware volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY state but cannot flip it back again. Before calling the Write() function, it is recommended for the caller to first call the EraseBlocks() function to erase the specified block to write. A block erase cycle will transition bits from the (NOT)EFI_FVB_ERASE_POLARITY state back to the EFI_FVB_ERASE_POLARITY state. Implementations should be mindful that the firmware volume might be in the WriteDisabled state. If it is in this state, the Write() function must return the status code EFI_ACCESS_DENIED without modifying the contents of the firmware volume. The Write() function must also prevent spanning block boundaries. If a write is requested that spans a block boundary, the write must store up to the boundary but not beyond. The output parameter NumBytes must be set to correctly indicate the number of bytes actually written. The caller must be aware that a write may be partially completed. All writes, partial or otherwise, must be fully flushed to the hardware before the Write() service returns.
| This | Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance. |
| Lba | The starting logical block index to write to. |
| Offset | Offset into the block at which to begin writing. |
| NumBytes | The pointer to a UINTN. At entry, *NumBytes contains the total size of the buffer. At exit, *NumBytes contains the total number of bytes actually written. |
| Buffer | The pointer to a caller-allocated buffer that contains the source for the write. |
| 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_GUID gEfiFirmwareVolumeBlock2ProtocolGuid |
| EFI_GUID gEfiFirmwareVolumeBlockProtocolGuid |
1.8.6 
