/** @file\r
- This file declares Firmware Volume protocol.\r
- The Firmware Volume Protocol provides file-level access to the firmware volume.E ach firmware\r
- volume driver must produce an instance of the Firmware Volume Protocol if the firmware volume\r
- is to be visible to the system.T he Firmware Volume Protocol also provides mechanisms for\r
- determining and modifying some attributes of the firmware volume.\r
+ This file declares the Firmware Volume Protocol.\r
\r
- Copyright (c) 2007, Intel Corporation\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 - 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
#ifndef _FIRMWARE_VOLUME_H_\r
#define _FIRMWARE_VOLUME_H_\r
\r
-#include <PiDxe.h>\r
\r
//\r
// Firmware Volume Protocol GUID definition\r
//\r
\r
/**\r
- Retrieves attributes, insures positive polarity of attribute bits, returns\r
+ Retrieves attributes, insures positive polarity of attribute bits, and returns\r
resulting attributes in output parameter\r
\r
- @param This Calling context\r
- @param Attributes output buffer which contains attributes\r
-\r
- @retval EFI_INVALID_PARAMETER\r
- @retval EFI_SUCCESS\r
+ @param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
+ @param Attributes Output buffer containing attributes\r
\r
+ @retval EFI_SUCCESS The firmware volume attributes were returned.\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Sets volume attributes\r
\r
- @param This Calling context\r
- @param Attributes Buffer which contains attributes\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
+ and the firmware volume settings are not changed.\r
\r
- @retval EFI_INVALID_PARAMETER\r
- @retval EFI_DEVICE_ERROR\r
- @retval EFI_SUCCESS\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
+ @retval EFI_ACCESS_DENIED The Device is locked and does not permit modification. \r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_SET_ATTRIBUTES)(\r
- IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
- IN OUT FRAMEWORK_EFI_FV_ATTRIBUTES *Attributes\r
+ IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
+ IN OUT FRAMEWORK_EFI_FV_ATTRIBUTES *Attributes\r
);\r
\r
/**\r
- Read the requested file (NameGuid) and returns data in Buffer.\r
+ Read the requested file (NameGuid) or file information from the firmware volume \r
+ and returns data in Buffer.\r
\r
- @param This Calling context\r
- @param NameGuid Filename identifying which file to read\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
<br>\r
If Buffer is NULL, only type, attributes, and size are returned as\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 Indicates the buffer size passed in, and on output the size\r
+ @param BufferSize On input: The buffer size. On output: The size\r
required to complete the read\r
- @param FoundType Indicates the type of the file who's data is returned\r
- @param FileAttributes Indicates the attributes of the file who's data is resturned\r
- @param AuthenticationStatus Indicates the authentication status of the data\r
-\r
- @retval EFI_SUCCESS\r
- @retval EFI_WARN_BUFFER_TOO_SMALL\r
- @retval EFI_NOT_FOUND\r
- @retval EFI_DEVICE_ERROR\r
- @retval EFI_ACCESS_DENIED\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
+ @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_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_ACCESS_DENIED The firmware volume is configured to disallow reads.\r
+ @retval EFI_OUT_OF_RESOURCES An allocation failure occurred.\r
\r
**/\r
typedef\r
/**\r
Read the requested section from the specified file and returns data in Buffer.\r
\r
- @param This Calling context\r
+ @param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
@param NameGuid Filename identifying the file from which to read\r
- @param SectionType Indicates what section type to retrieve\r
- @param SectionInstance Indicates which instance of SectionType to retrieve\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
<br>\r
If Buffer is NULL, only type, attributes, and size are returned as\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 Indicates the buffer size passed in, and on output the size\r
+ @param BufferSize Pointer to the buffer size passed in, and on output the size\r
required to complete the read\r
- @param AuthenticationStatus Indicates the authentication status of the data\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
/**\r
Write the supplied file (NameGuid) to the FV.\r
\r
- @param This Calling context\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
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
/**\r
Given the input key, search for the next matching file in the volume.\r
\r
- @param This Calling context\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 Indicates the file type to filter for\r
- @param NameGuid Guid filename of the file found\r
- @param Attributes Attributes of the file found\r
- @param Size 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
+ @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
+\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
OUT UINTN *Size\r
);\r
\r
-/**\r
- @par Protocol Description:\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
- @param GetVolumeAttributes\r
- Retrieves volume capabilities and current settings.\r
-\r
- @param SetVolumeAttributes\r
- Modifies the current settings of the firmware volume.\r
-\r
- @param ReadFile\r
- Reads an entire file from the firmware volume.\r
-\r
- @param ReadSection\r
- Reads a single section from a file into a buffer.\r
-\r
- @param WriteFile\r
- Writes an entire file into the firmware volume.\r
-\r
- @param GetNextFile\r
- Provides service to allow searching the firmware volume.\r
-\r
- @param KeySize\r
- Data field that indicates the size in bytes of the Key input buffer for\r
- the GetNextFile() API.\r
-\r
- @param ParentHandle\r
- Handle of the parent firmware volume.\r
-\r
-**/\r
+//\r
+// Protocol interface structure\r
+//\r
struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
+ ///\r
+ /// Retrieves volume capabilities and current settings.\r
+ ///\r
FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
+\r
+ ///\r
+ /// Modifies the current settings of the firmware volume.\r
+ ///\r
FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r
+\r
+ ///\r
+ /// Reads an entire file from the firmware volume.\r
+ ///\r
FRAMEWORK_EFI_FV_READ_FILE ReadFile;\r
+\r
+ ///\r
+ /// Reads a single section from a file into a buffer.\r
+ ///\r
FRAMEWORK_EFI_FV_READ_SECTION ReadSection;\r
+\r
+ ///\r
+ /// Writes an entire file into the firmware volume.\r
+ ///\r
FRAMEWORK_EFI_FV_WRITE_FILE WriteFile;\r
+\r
+ ///\r
+ /// Provides service to allow searching the firmware volume.\r
+ ///\r
FRAMEWORK_EFI_FV_GET_NEXT_FILE GetNextFile;\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
projects / mirror_edk2.git / blobdiff