diff options
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h')
| -rw-r--r-- | IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h | 132 |
1 files changed, 72 insertions, 60 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h index 8e6f450..8291e28 100644 --- a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h +++ b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h @@ -7,18 +7,18 @@ Volume Protocol also provides mechanisms for determining and modifying some
attributes of the firmware volume.
- Copyright (c) 2007 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference:
This protocol is defined in Firmware Volume specification.
- Version 0.9
+ Version 0.9.
**/
@@ -84,10 +84,10 @@ typedef UINT64 FRAMEWORK_EFI_FV_ATTRIBUTES; /**
Retrieves attributes, insures positive polarity of attribute bits, and returns
- resulting attributes in output parameter
+ resulting attributes in an output parameter.
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.
- @param Attributes Output buffer containing attributes
+ @param Attributes Output buffer containing attributes.
@retval EFI_SUCCESS The firmware volume attributes were returned.
**/
@@ -109,7 +109,7 @@ EFI_STATUS unsuccessful return, Attributes is not modified
and the firmware volume settings are not changed.
- @retval EFI_INVALID_PARAMETER A bit in Attributes was invalid
+ @retval EFI_INVALID_PARAMETER A bit in Attributes was invalid.
@retval EFI_SUCCESS The requested firmware volume attributes were set
and the resulting EFI_FV_ATTRIBUTES is returned in
Attributes.
@@ -128,28 +128,33 @@ EFI_STATUS and returns data in Buffer.
@param This The EFI_FIRMWARE_VOLUME_PROTOCOL instance.
- @param NameGuid Pointer to EFI_GUID, which is the filename of the file to read
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ @param NameGuid The pointer to EFI_GUID, which is the filename of
+ the file to read.
+ @param Buffer The pointer to pointer to buffer in which contents of file are returned.
<br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
+ If Buffer is NULL, only type, attributes, and size
+ are returned as there is no output buffer.
<br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
+ If Buffer != NULL and *Buffer == NULL, the output
+ buffer is allocated from BS pool by ReadFile.
<br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
+ If Buffer != NULL and *Buffer != NULL, the output
+ buffer has been allocated by the caller and is being
+ passed in.
@param BufferSize On input: The buffer size. On output: The size
- required to complete the read
- @param FoundType Pointer to type of the file whose data is returned
- @param FileAttributes Pointer to attributes of the file whose data is returned
- @param AuthenticationStatus Pointer to authentication status of the data
-
- @retval EFI_SUCCESS The call completed successfully
+ required to complete the read.
+ @param FoundType The pointer to the type of the file whose data
+ is returned.
+ @param FileAttributes The pointer to attributes of the file whose data
+ is returned.
+ @param AuthenticationStatus The pointer to the authentication status of the data.
+
+ @retval EFI_SUCCESS The call completed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.
- The buffer is filled and the output is truncated.
+ The buffer filled, and the output is truncated.
@retval EFI_NOT_FOUND NameGuid was not found in the firmware volume.
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to
+ access the firmware volume.
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.
@@ -170,29 +175,32 @@ EFI_STATUS Read the requested section from the specified file and returns data in Buffer.
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.
- @param NameGuid Filename identifying the file from which to read
- @param SectionType The section type to retrieve
- @param SectionInstance The instance of SectionType to retrieve
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ @param NameGuid Filename identifying the file from which to read.
+ @param SectionType The section type to retrieve.
+ @param SectionInstance The instance of SectionType to retrieve.
+ @param Buffer Pointer to pointer to buffer in which contents of
+ a file are returned.
<br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
+ If Buffer is NULL, only type, attributes, and size
+ are returned as there is no output buffer.
<br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
+ If Buffer != NULL and *Buffer == NULL, the output
+ buffer is allocated from BS pool by ReadFile.
<br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
- @param BufferSize Pointer to the buffer size passed in, and on output the size
- required to complete the read
- @param AuthenticationStatus Pointer to the authentication status of the data
+ If Buffer != NULL and *Buffer != NULL, the output
+ buffer has been allocated by the caller and is being
+ passed in.
+ @param BufferSize The pointer to the buffer size passed in, and on
+ output the size required to complete the read.
+ @param AuthenticationStatus The pointer to the authentication status of the data.
@retval EFI_SUCCESS The call completed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.
The buffer is filled and the output is truncated.
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.
- @retval EFI_NOT_FOUND Name was not found in the firmware volume.
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.
+ @retval EFI_NOT_FOUND The name was not found in the firmware volume.
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to
+ access the firmware volume.
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.
**/
@@ -225,19 +233,23 @@ typedef struct { Write the supplied file (NameGuid) to the FV.
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.
- @param NumberOfFiles Indicates the number of file records pointed to by FileData
- @param WritePolicy Indicates the level of reliability of the write with respect to
- things like power failure events.
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each
- element in the array indicates a file to write, and there are
- NumberOfFiles elements in the input array.
+ @param NumberOfFiles Indicates the number of file records pointed to
+ by FileData.
+ @param WritePolicy Indicates the level of reliability of the write
+ with respect to things like power failure events.
+ @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA
+ structures. Each element in the array indicates
+ a file to write, and there are NumberOfFiles
+ elements in the input array.
@retval EFI_SUCCESS The write completed successfully.
- @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free space to store file(s).
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.
+ @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free
+ space to store file(s).
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to
+ access the firmware volume.
@retval EFI_WRITE_PROTECTED The firmware volume is configured to disallow writes.
- @retval EFI_NOT_FOUND A delete was requested, but the requested file was not
- found in the firmware volume.
+ @retval EFI_NOT_FOUND A delete was requested, but the requested file was
+ not found in the firmware volume.
@retval EFI_INVALID_PARAMETER A delete was requested with a multiple file write.
An unsupported WritePolicy was requested.
An unknown file type was specified.
@@ -256,13 +268,13 @@ EFI_STATUS Given the input key, search for the next matching file in the volume.
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.
- @param Key Pointer to a caller allocated buffer that contains an implementation
- specific key that is used to track where to begin searching on
- successive calls.
- @param FileType Pointer to the file type to filter for
- @param NameGuid Pointer to Guid filename of the file found
- @param Attributes Pointer to Attributes of the file found
- @param Size Pointer to Size in bytes of the file found
+ @param Key Pointer to a caller allocated buffer that contains
+ an implementation-specific key that is used to track
+ where to begin searching on successive calls.
+ @param FileType The pointer to the file type to filter for.
+ @param NameGuid The pointer to Guid filename of the file found.
+ @param Attributes The pointer to Attributes of the file found.
+ @param Size The pointer to Size in bytes of the file found.
@retval EFI_SUCCESS The output parameters are filled with data obtained from
the first matching file that was found.
|