Change FRAMEWORK_EFI_HII_CALLBACK_PACKET back to EFI_HII_CALLBACK_PACKET to match...

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

diff --git a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
index 98f2909b188812050c46c1c1796dd2aa1dcf7ae6..c2a7246ca28df7fb2098703ba280b406ebaf98e9 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
+++ b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
@@ -7,7 +7,7 @@
   Volume Protocol also provides mechanisms for determining and modifying some\r
   attributes of the firmware volume.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -188,12 +188,13 @@ EFI_STATUS
                                 required to complete the read\r
   @param  AuthenticationStatus  pointer to the authentication status of the data\r
 \r
-  @retval EFI_SUCCESS\r
-  @retval EFI_WARN_BUFFER_TOO_SMALL\r
-  @retval EFI_OUT_OF_RESOURCES\r
-  @retval EFI_NOT_FOUND\r
-  @retval EFI_DEVICE_ERROR\r
-  @retval EFI_ACCESS_DENIED\r
+  @retval EFI_SUCCESS                The call completed successfully.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL  The buffer is too small to contain the requested output. \r
+                                     The buffer is filled and the output is truncated.\r
+  @retval EFI_OUT_OF_RESOURCES       An allocation failure occurred.\r
+  @retval EFI_NOT_FOUND              Name was not found in the firmware volume.\r
+  @retval EFI_DEVICE_ERROR           A hardware error occurred when attempting to access the firmware volume.\r
+  @retval EFI_ACCESS_DENIED          The firmware volume is configured to disallow reads.\r
 \r
 **/\r
 typedef\r
@@ -232,13 +233,16 @@ typedef struct {
                                 element in the array indicates a file to write, and there are\r
                                 NumberOfFiles elements in the input array.\r
 \r
-  @retval EFI_SUCCESS\r
-  @retval EFI_OUT_OF_RESOURCES\r
-  @retval EFI_DEVICE_ERROR\r
-  @retval EFI_WRITE_PROTECTED\r
-  @retval EFI_NOT_FOUND\r
-  @retval EFI_INVALID_PARAMETER\r
-\r
+  @retval EFI_SUCCESS           The write completed successfully.\r
+  @retval EFI_OUT_OF_RESOURCES  The firmware volume does not have enough free space to store file(s).\r
+  @retval EFI_DEVICE_ERROR      A hardware error occurred when attempting to access the firmware volume.\r
+  @retval EFI_WRITE_PROTECTED   The firmware volume is configured to disallow writes.\r
+  @retval EFI_NOT_FOUND         A delete was requested, but the requested file was not \r
+                                found in the firmware volume.\r
+  @retval EFI_INVALID_PARAMETER A delete was requested with a multiple file write.\r
+                                An unsupported WritePolicy was requested.\r
+                                An unknown file type was specified.\r
+                                A file system specific error has occurred.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -261,10 +265,12 @@ EFI_STATUS
   @param  Attributes            pointer to Attributes of the file found\r
   @param  Size                  pointer to Size in bytes of the file found\r
 \r
-  @retval EFI_SUCCESS\r
-  @retval EFI_NOT_FOUND\r
-  @retval EFI_DEVICE_ERROR\r
-  @retval EFI_ACCESS_DENIED\r
+  @retval EFI_SUCCESS           The output parameters are filled with data obtained from \r
+                                the first matching file that was found.\r
+  @retval EFI_NOT_FOUND         No files of type FileType were found.\r
+  @retval EFI_DEVICE_ERROR      A hardware error occurred when attempting to access \r
+                                the firmware volume.\r
+  @retval EFI_ACCESS_DENIED     The firmware volume is configured to disallow reads.\r
 \r
 **/\r
 typedef\r
@@ -282,38 +288,45 @@ EFI_STATUS
 // Protocol interface structure\r
 //\r
 struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
-///\r
-/// Retrieves volume capabilities and current settings.\r
-///\r
+  ///\r
+  /// Retrieves volume capabilities and current settings.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
-///\r
-/// Modifies the current settings of the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Modifies the current settings of the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r
-///\r
-/// Reads an entire file from the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Reads an entire file from the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_FILE      ReadFile;\r
-///\r
-/// Reads a single section from a file into a buffer.\r
-///\r
+\r
+  ///\r
+  /// Reads a single section from a file into a buffer.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_SECTION   ReadSection;\r
-///\r
-/// Writes an entire file into the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Writes an entire file into the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_WRITE_FILE     WriteFile;\r
-///\r
-/// Provides service to allow searching the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Provides service to allow searching the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_NEXT_FILE  GetNextFile;\r
-///\r
-///  Data field that indicates the size in bytes of the Key input buffer for\r
-///  the GetNextFile() API.\r
-///\r
-UINT32                KeySize;\r
-///\r
-///  Handle of the parent firmware volume.\r
-///\r
+\r
+  ///\r
+  ///  Data field that indicates the size in bytes of the Key input buffer for\r
+  ///  the GetNextFile() API.\r
+  ///\r
+  UINT32                KeySize;\r
+\r
+  ///\r
+  ///  Handle of the parent firmware volume.\r
+  ///\r
   EFI_HANDLE            ParentHandle;\r
 };\r
 \r