MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolume2.h

diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h
index 62218d71497e675f553ef1edbbc86f4fa3abb16a..e54364b94248b572e159a27245308ab3f970ef7d 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareVolume2.h
+++ b/MdePkg/Include/Protocol/FirmwareVolume2.h
@@ -5,8 +5,8 @@
   the system during the DXE phase. The Firmware Volume Protocol also provides\r
   mechanisms for determining and modifying some attributes of the firmware volume.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -295,7 +295,7 @@ EFI_STATUS
                                       attempting to access the firmware volume.\r
 \r
   @retval EFI_ACCESS_DENIED           The firmware volume is configured to\r
-                                      isallow reads.\r
+                                      disallow reads.\r
 \r
 **/\r
 typedef\r
@@ -418,9 +418,9 @@ EFI_STATUS
   OUT       UINT32                        *AuthenticationStatus\r
 );\r
 \r
-//\r
-// EFI_FV_WRITE_POLICY\r
-//\r
+///\r
+/// EFI_FV_WRITE_POLICY, two policies (unreliable write and reliable write) are defined.\r
+///\r
 typedef UINT32 EFI_FV_WRITE_POLICY;\r
 #define EFI_FV_UNRELIABLE_WRITE   0x00000000\r
 #define EFI_FV_RELIABLE_WRITE     0x00000001\r
@@ -429,10 +429,25 @@ typedef UINT32 EFI_FV_WRITE_POLICY;
 // EFI_FV_WRITE_FILE_DATA\r
 //\r
 typedef struct {\r
+  ///\r
+  /// Pointer to a GUID, which is the file name to be written.\r
+  ///\r
   EFI_GUID                *NameGuid;\r
+  ///\r
+  /// Indicates the type of file to be written.\r
+  ///\r
   EFI_FV_FILETYPE         Type;\r
+  ///\r
+  /// Indicates the attributes for the file to be written.\r
+  ///\r
   EFI_FV_FILE_ATTRIBUTES  FileAttributes;\r
+  ///\r
+  /// Pointer to a buffer containing the file to be written.\r
+  ///\r
   VOID                    *Buffer;\r
+  ///\r
+  /// Indicates the size of the file image contained in Buffer.\r
+  ///\r
   UINT32                  BufferSize;\r
 } EFI_FV_WRITE_FILE_DATA;\r
 \r
@@ -513,8 +528,8 @@ EFI_STATUS
 \r
 \r
 /**\r
-       Retrieves information about the next file in the firmware volume store \r
-       that matches the search criteria.\r
+  Retrieves information about the next file in the firmware volume store \r
+  that matches the search criteria.\r
 \r
   GetNextFile() is the interface that is used to search a firmware\r
   volume for a particular file. It is called successively until\r
@@ -705,20 +720,19 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The Firmware Volume Protocol contains the file-level\r
-  abstraction to the firmware volume as well as some firmware\r
-  volume attribute reporting and configuration services. The\r
-  Firmware Volume Protocol is the interface used by all parts of\r
-  DXE that are not directly involved with managing the firmware\r
-  volume itself. This abstraction allows many varied types of\r
-  firmware volume implementations. A firmware volume may be a\r
-  flash device or it may be a file in the UEFI system partition,\r
-  for example. This level of firmware volume implementation\r
-  detail is not visible to the consumers of the Firmware Volume\r
-  Protocol.\r
-**/\r
+///\r
+/// The Firmware Volume Protocol contains the file-level\r
+/// abstraction to the firmware volume as well as some firmware\r
+/// volume attribute reporting and configuration services. The\r
+/// Firmware Volume Protocol is the interface used by all parts of\r
+/// DXE that are not directly involved with managing the firmware\r
+/// volume itself. This abstraction allows many varied types of\r
+/// firmware volume implementations. A firmware volume may be a\r
+/// flash device or it may be a file in the UEFI system partition,\r
+/// for example. This level of firmware volume implementation\r
+/// detail is not visible to the consumers of the Firmware Volume\r
+/// Protocol.\r
+///\r
 struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r
   EFI_FV_GET_ATTRIBUTES   GetVolumeAttributes;\r
   EFI_FV_SET_ATTRIBUTES   SetVolumeAttributes;\r