\r
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
\r
- @param Attributes Pointer to EFI_FVB_ATTRIBUTES in which the\r
+ @param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the\r
attributes and current settings are\r
- returned. Type EFI_FVB_ATTRIBUTES is defined\r
+ returned. Type EFI_FVB_ATTRIBUTES_2 is defined\r
in EFI_FIRMWARE_VOLUME_HEADER.\r
\r
@retval EFI_SUCCESS The firmware volume attributes were\r
EFI_STATUS\r
(EFIAPI * EFI_FVB_GET_ATTRIBUTES)(\r
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r
- OUT EFI_FVB_ATTRIBUTES *Attributes\r
+ OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
);\r
\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
\r
@param Attributes On input, Attributes is a pointer to\r
- EFI_FVB_ATTRIBUTES that contains the\r
+ EFI_FVB_ATTRIBUTES_2 that contains the\r
desired firmware volume settings. On\r
successful return, it contains the new\r
settings of the firmware volume. Type\r
- EFI_FVB_ATTRIBUTES is defined in\r
+ EFI_FVB_ATTRIBUTES_2 is defined in\r
EFI_FIRMWARE_VOLUME_HEADER.\r
\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
EFI_STATUS\r
(EFIAPI * EFI_FVB_SET_ATTRIBUTES)(\r
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,\r
- IN OUT EFI_FVB_ATTRIBUTES *Attributes\r
+ IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes\r
);\r
\r
\r
\r
\r
/**\r
+ Reads the specified number of bytes into a buffer from the specified block.\r
+\r
The Read() function reads the requested number of bytes from the\r
requested block and stores them in the provided buffer.\r
Implementations should be mindful that the firmware volume\r
);\r
\r
/**\r
+ Writes the specified number of bytes from the input buffer to the block.\r
+\r
The Write() function writes the specified number of bytes from\r
the provided buffer to the specified block and offset. If the\r
firmware volume is sticky write, the caller must ensure that\r
function, or else the result will be unpredictable. This\r
unpredictability arises because, for a sticky-write firmware\r
volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
- state but it cannot flip it back again. In general, before\r
+ state but cannot flip it back again. In general, before\r
calling the Write() function, the caller should call the\r
- EraseBlocks() function first to erase the specified block to\r
+ EraseBlocks() function first to erase the block it intends to\r
write. A block erase cycle will transition bits from the\r
(NOT)EFI_FVB_ERASE_POLARITY state back to the\r
EFI_FVB_ERASE_POLARITY state. Implementations should be\r
\r
\r
\r
-//\r
-// EFI_LBA_LIST_TERMINATOR\r
-//\r
+///\r
+/// EFI_LBA_LIST_TERMINATOR\r
+///\r
#define EFI_LBA_LIST_TERMINATOR 0xFFFFFFFFFFFFFFFFULL\r
\r
\r
/**\r
- The EraseBlocks() function erases one or more blocks as denoted\r
+ Erases and initializes a firmware volume block.\r
+\r
+ The EraseBlocks() function erases one or more blocks, as denoted\r
by the variable argument list. The entire parameter list of\r
blocks must be verified before erasing any blocks. If a block is\r
requested that does not exist within the associated firmware\r
...\r
);\r
\r
-\r
-\r
-/**\r
- @par Protocol Description:\r
- The Firmware Volume Block Protocol is the low-level interface\r
- to a firmware volume. File-level access to a firmware volume\r
- should not be done using the Firmware Volume Block Protocol.\r
- Normal access to a firmware volume must use the Firmware\r
- Volume Protocol. Typically, only the file system driver that\r
- produces the Firmware Volume Protocol will bind to the\r
- Firmware Volume Block Protocol. The Firmware Volume Block\r
- Protocol provides the following:\r
- - Byte-level read/write functionality.\r
- - Block-level erase functionality.\r
- - It further exposes device-hardening features, such as may be\r
- equired to protect the firmware from unwanted overwriting\r
- and/or erasure.\r
- - It is useful to layer a file system driver on top of the\r
- Firmware Volume Block Protocol.\r
-\r
- This file system driver produces the Firmware Volume Protocol,\r
- which provides file-level access to a firmware volume. The\r
- Firmware Volume Protocol abstracts the file system that is\r
- used to format the firmware volume and the hardware\r
- device-hardening features that may be present.\r
-\r
-\r
- @param GetPhysicalAddress Retrieves the memory-mapped\r
- address of the firmware volume.\r
-\r
- @param GetBlockSize Retrieves the size for a specific block.\r
- Also returns the number of consecutive\r
- similarly sized blocks.\r
-\r
- @param Read Reads n bytes into a buffer from the firmware\r
- volume hardware.\r
-\r
- @param Write Writes n bytes from a buffer into the firmware\r
- volume hardware.\r
-\r
- @param EraseBlocks Erases specified block(s) and sets all\r
- values as indicated by the\r
- EFI_FVB_ERASE_POLARITY bit. See the\r
- EraseBlocks() function description. Type\r
- EFI_FVB_ERASE_POLARITY is defined in\r
- EFI_FIRMWARE_VOLUME_HEADER. ParentHandle\r
- Handle of the parent firmware volume.\r
- \r
- @param GetAttributes Retrieves the current volume attributes.\r
- \r
- @param SetAttributes Sets the current volume attributes.\r
-\r
-**/\r
+///\r
+/// The Firmware Volume Block Protocol is the low-level interface\r
+/// to a firmware volume. File-level access to a firmware volume\r
+/// should not be done using the Firmware Volume Block Protocol.\r
+/// Normal access to a firmware volume must use the Firmware\r
+/// Volume Protocol. Typically, only the file system driver that\r
+/// produces the Firmware Volume Protocol will bind to the\r
+/// Firmware Volume Block Protocol.\r
+///\r
struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {\r
EFI_FVB_GET_ATTRIBUTES GetAttributes;\r
EFI_FVB_SET_ATTRIBUTES SetAttributes;\r
EFI_FVB_READ Read;\r
EFI_FVB_WRITE Write;\r
EFI_FVB_ERASE_BLOCKS EraseBlocks;\r
+ ///\r
+ /// Handle of the parent firmware volume.\r
+ /// \r
EFI_HANDLE ParentHandle;\r
};\r
\r
projects / mirror_edk2.git / blobdiff