Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkFirmwareVolumeBlock.h

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
index 8ad5b1f1e229f5d495c8bfe79b48d24da8ff0d88..939914429c6f98a424e96d6a4eb6393011e2e045 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFirmwareVolumeBlock.h
@@ -1,7 +1,7 @@
 /** @file\r
   This file provides control over block-oriented firmware devices.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -18,16 +18,18 @@
 #ifndef __FRAMEWORK_FIRMWARE_VOLUME_BLOCK_H__\r
 #define __FRAMEWORK_FIRMWARE_VOLUME_BLOCK_H__\r
 \r
+#define FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL_GUID \\r
+{ 0xDE28BC59, 0x6228, 0x41BD, {0xBD, 0xF6, 0xA3, 0xB9, 0xAD,0xB5, 0x8D, 0xA1 } }\r
 \r
 typedef struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL;\r
 ///\r
-/// type of EFI FVB attribute per Frameowrk spec\r
+/// type of EFI FVB attribute per Framework spec\r
 /// \r
 typedef UINT32  EFI_FVB_ATTRIBUTES;\r
 \r
 /**\r
   The GetAttributes() function retrieves the attributes and\r
-  current settings of the block. Status Codes Returned\r
+  current settings of the block. \r
 \r
   @param This       Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.\r
 \r
@@ -228,10 +230,8 @@ EFI_STATUS
   \r
   @param Offset   Offset into the block at which to begin writing.\r
   \r
-  @param NumBytes Pointer to a UINTN. At entry, *NumBytes\r
-                  contains the total size of the buffer. At\r
-                  exit, *NumBytes contains the total number of\r
-                  bytes actually written.\r
+  @param NumBytes Pointer to a UINTN. Input: the total size of the buffer.\r
+                  Output: the total number of bytes actually written.\r
   \r
   @param Buffer   Pointer to a caller-allocated buffer that\r
                   contains the source for the write.\r
@@ -291,7 +291,7 @@ EFI_STATUS
   @param This   Indicates the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL\r
                 instance.\r
 \r
-  @param ...    The variable argument list is a list of tuples.\r
+  @param ...    A list of tuples.\r
                 Each tuple describes a range of LBAs to erase\r
                 and consists of the following:\r
                 - An EFI_LBA that indicates the starting LBA\r
@@ -348,6 +348,6 @@ struct _FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {
   EFI_HANDLE                    ParentHandle;\r
 };\r
 \r
-\r
+extern EFI_GUID gFramerworkEfiFirmwareVolumeBlockProtocolGuid;\r
 \r
 #endif\r