]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/FirmwareVolumeBlock.h
Update ScsiIo protocol and ScsiPassThruExt protocol guid value to UEFI 2.1
[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolumeBlock.h
index 0eaf31a1ed0ee3ff11896660ca7904bb1abcaff0..ab996778d7c1e0c13cc79521c194de9ebd991013 100644 (file)
@@ -139,6 +139,8 @@ EFI_STATUS
 \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
@@ -194,6 +196,8 @@ EFI_STATUS
 );\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
@@ -263,13 +267,15 @@ EFI_STATUS
 \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
+  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
@@ -322,8 +328,6 @@ EFI_STATUS
   ...\r
 );\r
 \r
-\r
-\r
 /**\r
   @par Protocol Description:\r
   The Firmware Volume Block Protocol is the low-level interface\r
@@ -347,33 +351,6 @@ EFI_STATUS
   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
 struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {\r
   EFI_FVB_GET_ATTRIBUTES        GetAttributes;\r
@@ -383,6 +360,9 @@ struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {
   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