Volume Protocol also provides mechanisms for determining and modifying some\r
attributes of the firmware volume.\r
\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
- 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
+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
+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
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
This protocol is defined in Firmware Volume specification.\r
- Version 0.9\r
+ Version 0.9.\r
\r
**/\r
\r
\r
/**\r
Retrieves attributes, insures positive polarity of attribute bits, and returns\r
- resulting attributes in output parameter\r
+ resulting attributes in an output parameter.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param Attributes Output buffer containing attributes\r
+ @param Attributes Output buffer containing attributes.\r
\r
@retval EFI_SUCCESS The firmware volume attributes were returned.\r
**/\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_INVALID_PARAMETER A bit in Attributes was invalid.\r
@retval EFI_SUCCESS The requested firmware volume attributes were set \r
and the resulting EFI_FV_ATTRIBUTES is returned in\r
Attributes.\r
and returns data in Buffer.\r
\r
@param This The EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
- @param NameGuid Pointer to EFI_GUID, which is the filename of the file to read\r
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.\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 are returned as\r
- there is no output buffer.\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 buffer is allocated\r
- from BS pool by ReadFile\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 buffer has been\r
- allocated by the caller and is being passed in.\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 Pointer to type of the file whose data is returned\r
- @param FileAttributes Pointer to attributes of the file whose data is returned\r
- @param AuthenticationStatus Pointer to authentication status of the data\r
-\r
- @retval EFI_SUCCESS The call completed successfully\r
+ required to complete the read.\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
+ @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
- The buffer is filled and the output is truncated.\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 access the firmware volume.\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
\r
Read the requested section from the specified file and returns data in Buffer.\r
\r
@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\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 file are returned.\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
+ a file are returned.\r
<br>\r
- If Buffer is NULL, only type, attributes, and size are returned as\r
- there is no output buffer.\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 buffer is allocated\r
- from BS pool by ReadFile\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 buffer has been\r
- allocated by the caller and is being passed in.\r
- @param BufferSize Pointer to the buffer size passed in, and on output the size\r
- required to complete the read\r
- @param AuthenticationStatus Pointer to the authentication status of the data\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
+ 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
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_NOT_FOUND The name was not found in the firmware volume.\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
**/\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 by FileData\r
- @param WritePolicy Indicates the level of reliability of the write with respect to\r
- things like power failure events.\r
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each\r
- element in the array indicates a file to write, and there are\r
- NumberOfFiles elements in the input array.\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
+ 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
+ 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 space to store file(s).\r
- @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.\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
+ 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_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
An unknown file type was specified.\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 an implementation\r
- specific key that is used to track where to begin searching on\r
- successive calls.\r
- @param FileType Pointer to the file type to filter for\r
- @param NameGuid Pointer to Guid filename of the file found\r
- @param Attributes Pointer to Attributes of the file found\r
- @param Size Pointer to Size in bytes of the file found\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
the first matching file that was found.\r
projects / mirror_edk2.git / blobdiff