/** @file\r
This file declares the Firmware Volume Protocol.\r
- \r
+\r
The Firmware Volume Protocol provides file-level access to the firmware volume.\r
Each firmware volume driver must produce an instance of the Firmware Volume\r
Protocol if the firmware volume is to be visible to the system. The Firmware\r
Volume Protocol also provides mechanisms for determining and modifying some\r
attributes of the firmware volume.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
Sets volume attributes\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param Attributes On input, Attributes is a pointer to an \r
- EFI_FV_ATTRIBUTES containing the desired firmware \r
- volume settings. On successful return, it contains \r
- the new settings of the firmware volume. On \r
- unsuccessful return, Attributes is not modified \r
+ @param Attributes On input, Attributes is a pointer to an\r
+ EFI_FV_ATTRIBUTES containing the desired firmware\r
+ volume settings. On successful return, it contains\r
+ the new settings of the firmware volume. On\r
+ unsuccessful return, Attributes is not modified\r
and the firmware volume settings are not changed.\r
\r
@retval EFI_INVALID_PARAMETER A bit in Attributes was invalid.\r
- @retval EFI_SUCCESS The requested firmware volume attributes were set \r
+ @retval EFI_SUCCESS The requested firmware volume attributes were set\r
and the resulting EFI_FV_ATTRIBUTES is returned in\r
Attributes.\r
- @retval EFI_ACCESS_DENIED The Device is locked and does not permit modification. \r
+ @retval EFI_ACCESS_DENIED The Device is locked and does not permit modification.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Read the requested file (NameGuid) or file information from the firmware volume \r
+ Read the requested file (NameGuid) or file information from the firmware volume\r
and returns data in Buffer.\r
\r
@param This The EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param NameGuid The pointer to EFI_GUID, which is the filename of \r
+ @param NameGuid The pointer to EFI_GUID, which is the filename of\r
the file to read.\r
@param Buffer The pointer to pointer to buffer in which contents of file are returned.\r
<br>\r
- If Buffer is NULL, only type, attributes, and size \r
+ If Buffer is NULL, only type, attributes, and size\r
are returned as there is no output buffer.\r
<br>\r
- If Buffer != NULL and *Buffer == NULL, the output \r
+ If Buffer != NULL and *Buffer == NULL, the output\r
buffer is allocated from BS pool by ReadFile.\r
<br>\r
- If Buffer != NULL and *Buffer != NULL, the output \r
- buffer has been allocated by the caller and is being \r
+ If Buffer != NULL and *Buffer != NULL, the output\r
+ buffer has been allocated by the caller and is being\r
passed in.\r
@param BufferSize On input: The buffer size. On output: The size\r
required to complete the read.\r
- @param FoundType The pointer to the type of the file whose data \r
+ @param FoundType The pointer to the type of the file whose data\r
is returned.\r
@param FileAttributes The pointer to attributes of the file whose data\r
is returned.\r
@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.\r
The buffer filled, and the output is truncated.\r
@retval EFI_NOT_FOUND NameGuid was not found in the firmware volume.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
access the firmware volume.\r
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.\r
@param NameGuid Filename identifying the file from which to read.\r
@param SectionType The section type to retrieve.\r
@param SectionInstance The instance of SectionType to retrieve.\r
- @param Buffer Pointer to pointer to buffer in which contents of \r
+ @param Buffer Pointer to pointer to buffer in which contents of\r
a file are returned.\r
<br>\r
If Buffer is NULL, only type, attributes, and size\r
are returned as there is no output buffer.\r
<br>\r
- If Buffer != NULL and *Buffer == NULL, the output \r
+ If Buffer != NULL and *Buffer == NULL, the output\r
buffer is allocated from BS pool by ReadFile.\r
<br>\r
- If Buffer != NULL and *Buffer != NULL, the output \r
- buffer has been allocated by the caller and is being \r
+ If Buffer != NULL and *Buffer != NULL, the output\r
+ buffer has been allocated by the caller and is being\r
passed in.\r
- @param BufferSize The pointer to the buffer size passed in, and on \r
+ @param BufferSize The pointer to the buffer size passed in, and on\r
output the size required to complete the read.\r
@param AuthenticationStatus The pointer to the authentication status of the data.\r
\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
+ @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 The name was not found in the firmware volume.\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
access the firmware volume.\r
@retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
\r
Write the supplied file (NameGuid) to the FV.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param NumberOfFiles Indicates the number of file records pointed to \r
+ @param NumberOfFiles Indicates the number of file records pointed to\r
by FileData.\r
- @param WritePolicy Indicates the level of reliability of the write \r
+ @param WritePolicy Indicates the level of reliability of the write\r
with respect to things like power failure events.\r
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA \r
- structures. Each element in the array indicates \r
+ @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA\r
+ structures. Each element in the array indicates\r
a file to write, and there are NumberOfFiles\r
elements in the input array.\r
\r
@retval EFI_SUCCESS The write completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free \r
+ @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free\r
space to store file(s).\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to \r
+ @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to\r
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 \r
+ @retval EFI_NOT_FOUND A delete was requested, but the requested file was\r
not 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
Given the input key, search for the next matching file in the volume.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param Key Pointer to a caller allocated buffer that contains \r
- an implementation-specific key that is used to track \r
+ @param Key Pointer to a caller allocated buffer that contains\r
+ an implementation-specific key that is used to track\r
where to begin searching on successive calls.\r
@param FileType The pointer to the file type to filter for.\r
@param NameGuid The pointer to Guid filename of the file found.\r
@param Attributes The pointer to Attributes of the file found.\r
@param Size The pointer to Size in bytes of the file found.\r
\r
- @retval EFI_SUCCESS The output parameters are filled with data obtained from \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
+ @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
projects / mirror_edk2.git / blobdiff