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

/** @file\r
  This file declares the Firmware Volume Protocol.\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, 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
\r
  @par Revision Reference:\r
  This protocol is defined in Firmware Volume specification.\r
  Version 0.9\r
\r
**/\r
\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
#define EFI_FIRMWARE_VOLUME_PROTOCOL_GUID \\r
  { \\r
    0x389F751F, 0x1838, 0x4388, {0x83, 0x90, 0xCD, 0x81, 0x54, 0xBD, 0x27, 0xF8 } \\r
  }\r
\r
#define FV_DEVICE_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', '_')\r
\r
typedef struct _EFI_FIRMWARE_VOLUME_PROTOCOL  EFI_FIRMWARE_VOLUME_PROTOCOL;\r
\r
//\r
// FRAMEWORK_EFI_FV_ATTRIBUTES bit definitions\r
//\r
typedef UINT64  FRAMEWORK_EFI_FV_ATTRIBUTES;\r
\r
//\r
// ************************************************************\r
// FRAMEWORK_EFI_FV_ATTRIBUTES bit definitions\r
// ************************************************************\r
//\r
#define EFI_FV_READ_DISABLE_CAP       0x0000000000000001ULL\r
#define EFI_FV_READ_ENABLE_CAP        0x0000000000000002ULL\r
#define EFI_FV_READ_STATUS            0x0000000000000004ULL\r
\r
#define EFI_FV_WRITE_DISABLE_CAP      0x0000000000000008ULL\r
#define EFI_FV_WRITE_ENABLE_CAP       0x0000000000000010ULL\r
#define EFI_FV_WRITE_STATUS           0x0000000000000020ULL\r
\r
#define EFI_FV_LOCK_CAP               0x0000000000000040ULL\r
#define EFI_FV_LOCK_STATUS            0x0000000000000080ULL\r
#define EFI_FV_WRITE_POLICY_RELIABLE  0x0000000000000100ULL\r
\r
#define EFI_FV_ALIGNMENT_CAP          0x0000000000008000ULL\r
#define EFI_FV_ALIGNMENT_2            0x0000000000010000ULL\r
#define EFI_FV_ALIGNMENT_4            0x0000000000020000ULL\r
#define EFI_FV_ALIGNMENT_8            0x0000000000040000ULL\r
#define EFI_FV_ALIGNMENT_16           0x0000000000080000ULL\r
#define EFI_FV_ALIGNMENT_32           0x0000000000100000ULL\r
#define EFI_FV_ALIGNMENT_64           0x0000000000200000ULL\r
#define EFI_FV_ALIGNMENT_128          0x0000000000400000ULL\r
#define EFI_FV_ALIGNMENT_256          0x0000000000800000ULL\r
#define EFI_FV_ALIGNMENT_512          0x0000000001000000ULL\r
#define EFI_FV_ALIGNMENT_1K           0x0000000002000000ULL\r
#define EFI_FV_ALIGNMENT_2K           0x0000000004000000ULL\r
#define EFI_FV_ALIGNMENT_4K           0x0000000008000000ULL\r
#define EFI_FV_ALIGNMENT_8K           0x0000000010000000ULL\r
#define EFI_FV_ALIGNMENT_16K          0x0000000020000000ULL\r
#define EFI_FV_ALIGNMENT_32K          0x0000000040000000ULL\r
#define EFI_FV_ALIGNMENT_64K          0x0000000080000000ULL\r
\r
//\r
// Protocol API definitions\r
//\r
\r
/**\r
  Retrieves attributes, insures positive polarity of attribute bits, returns\r
  resulting attributes in output parameter\r
\r
  @param  This                  Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
  @param  Attributes            output buffer which contains attributes\r
\r
  @retval EFI_SUCCESS           The firmware volume attributes were returned.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_GET_ATTRIBUTES)(\r
  IN  EFI_FIRMWARE_VOLUME_PROTOCOL            *This,\r
  OUT FRAMEWORK_EFI_FV_ATTRIBUTES             *Attributes\r
  );\r
\r
/**\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.O n 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
                                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
  );\r
\r
/**\r
  Read the requested file (NameGuid) or file information from the firmware volume \r
  and returns data in Buffer.\r
\r
  @param  This                  Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
  @param  NameGuid              pointer to EFI_GUID which is the filename identifying which 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
                                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
                                <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
                                required to complete the read\r
  @param  FoundType             pointer to type of the file who's data is returned\r
  @param  FileAttributes        pointer to attributes of the file who's data is resturned\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 int he 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 volumen is configured to disallow reads.\r
  @retval EFI_OUT_OF_RESOURCES      An allocation failure occurred.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_READ_FILE)(\r
  IN EFI_FIRMWARE_VOLUME_PROTOCOL   *This,\r
  IN EFI_GUID                       *NameGuid,\r
  IN OUT VOID                       **Buffer,\r
  IN OUT UINTN                      *BufferSize,\r
  OUT EFI_FV_FILETYPE               *FoundType,\r
  OUT EFI_FV_FILE_ATTRIBUTES        *FileAttributes,\r
  OUT UINT32                        *AuthenticationStatus\r
  );\r
\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           Indicates what section type to retrieve\r
  @param  SectionInstance       Indicates which 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
                                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
                                <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
\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
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_READ_SECTION)(\r
  IN EFI_FIRMWARE_VOLUME_PROTOCOL   *This,\r
  IN EFI_GUID                       *NameGuid,\r
  IN EFI_SECTION_TYPE               SectionType,\r
  IN UINTN                          SectionInstance,\r
  IN OUT VOID                       **Buffer,\r
  IN OUT UINTN                      *BufferSize,\r
  OUT UINT32                        *AuthenticationStatus\r
  );\r
\r
typedef UINT32  FRAMEWORK_EFI_FV_WRITE_POLICY;\r
\r
#define FRAMEWORK_EFI_FV_UNRELIABLE_WRITE 0x00000000\r
#define FRAMEWORK_EFI_FV_RELIABLE_WRITE   0x00000001\r
\r
typedef struct {\r
  EFI_GUID                *NameGuid;\r
  EFI_FV_FILETYPE         Type;\r
  EFI_FV_FILE_ATTRIBUTES  FileAttributes;\r
  VOID                    *Buffer;\r
  UINT32                  BufferSize;\r
} FRAMEWORK_EFI_FV_WRITE_FILE_DATA;\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
\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
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_WRITE_FILE)(\r
  IN EFI_FIRMWARE_VOLUME_PROTOCOL             *This,\r
  IN UINT32                                   NumberOfFiles,\r
  IN FRAMEWORK_EFI_FV_WRITE_POLICY            WritePolicy,\r
  IN FRAMEWORK_EFI_FV_WRITE_FILE_DATA         *FileData\r
  );\r
\r
/**\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
\r
  @retval EFI_SUCCESS\r
  @retval EFI_NOT_FOUND\r
  @retval EFI_DEVICE_ERROR\r
  @retval EFI_ACCESS_DENIED\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_FV_GET_NEXT_FILE)(\r
  IN EFI_FIRMWARE_VOLUME_PROTOCOL   *This,\r
  IN OUT VOID                       *Key,\r
  IN OUT EFI_FV_FILETYPE            *FileType,\r
  OUT EFI_GUID                      *NameGuid,\r
  OUT EFI_FV_FILE_ATTRIBUTES        *Attributes,\r
  OUT UINTN                         *Size\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
/// 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
  FRAMEWORK_EFI_FV_READ_FILE      ReadFile;\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
  FRAMEWORK_EFI_FV_WRITE_FILE     WriteFile;\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
  EFI_HANDLE            ParentHandle;\r
};\r
\r
extern EFI_GUID gEfiFirmwareVolumeProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
79964ac8	1	/** @file\r
38db7507	2	This file declares the Firmware Volume Protocol.\r
8411f1c0	3	\r
38db7507	4	The Firmware Volume Protocol provides file-level access to the firmware volume.\r
	5	Each firmware volume driver must produce an instance of the Firmware Volume\r
	6	Protocol if the firmware volume is to be visible to the system. The Firmware\r
	7	Volume Protocol also provides mechanisms for determining and modifying some\r
	8	attributes of the firmware volume.\r
	9	\r
79964ac8	10	Copyright (c) 2007, Intel Corporation\r
	11	All rights reserved. This program and the accompanying materials\r
	12	are licensed and made available under the terms and conditions of the BSD License\r
	13	which accompanies this distribution. The full text of the license may be found at\r
	14	http://opensource.org/licenses/bsd-license.php\r
	15	\r
	16	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	17	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	18	\r
79964ac8	19	@par Revision Reference:\r
	20	This protocol is defined in Firmware Volume specification.\r
	21	Version 0.9\r
	22	\r
	23	**/\r
	24	\r
	25	#ifndef _FIRMWARE_VOLUME_H_\r
	26	#define _FIRMWARE_VOLUME_H_\r
	27	\r
b80fbe85	28	#include <PiDxe.h>\r
79964ac8	29	\r
	30	//\r
	31	// Firmware Volume Protocol GUID definition\r
	32	//\r
	33	#define EFI_FIRMWARE_VOLUME_PROTOCOL_GUID \\r
	34	{ \\r
	35	0x389F751F, 0x1838, 0x4388, {0x83, 0x90, 0xCD, 0x81, 0x54, 0xBD, 0x27, 0xF8 } \\r
	36	}\r
	37	\r
e89ec8f6	38	#define FV_DEVICE_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', '_')\r
79964ac8	39	\r
	40	typedef struct _EFI_FIRMWARE_VOLUME_PROTOCOL EFI_FIRMWARE_VOLUME_PROTOCOL;\r
	41	\r
	42	//\r
3d02e416	43	// FRAMEWORK_EFI_FV_ATTRIBUTES bit definitions\r
79964ac8	44	//\r
3d02e416	45	typedef UINT64 FRAMEWORK_EFI_FV_ATTRIBUTES;\r
79964ac8	46	\r
	47	//\r
	48	// ************************************************************\r
3d02e416	49	// FRAMEWORK_EFI_FV_ATTRIBUTES bit definitions\r
79964ac8	50	// ************************************************************\r
	51	//\r
	52	#define EFI_FV_READ_DISABLE_CAP 0x0000000000000001ULL\r
	53	#define EFI_FV_READ_ENABLE_CAP 0x0000000000000002ULL\r
	54	#define EFI_FV_READ_STATUS 0x0000000000000004ULL\r
	55	\r
	56	#define EFI_FV_WRITE_DISABLE_CAP 0x0000000000000008ULL\r
	57	#define EFI_FV_WRITE_ENABLE_CAP 0x0000000000000010ULL\r
	58	#define EFI_FV_WRITE_STATUS 0x0000000000000020ULL\r
	59	\r
	60	#define EFI_FV_LOCK_CAP 0x0000000000000040ULL\r
	61	#define EFI_FV_LOCK_STATUS 0x0000000000000080ULL\r
	62	#define EFI_FV_WRITE_POLICY_RELIABLE 0x0000000000000100ULL\r
	63	\r
	64	#define EFI_FV_ALIGNMENT_CAP 0x0000000000008000ULL\r
	65	#define EFI_FV_ALIGNMENT_2 0x0000000000010000ULL\r
	66	#define EFI_FV_ALIGNMENT_4 0x0000000000020000ULL\r
	67	#define EFI_FV_ALIGNMENT_8 0x0000000000040000ULL\r
	68	#define EFI_FV_ALIGNMENT_16 0x0000000000080000ULL\r
	69	#define EFI_FV_ALIGNMENT_32 0x0000000000100000ULL\r
	70	#define EFI_FV_ALIGNMENT_64 0x0000000000200000ULL\r
	71	#define EFI_FV_ALIGNMENT_128 0x0000000000400000ULL\r
	72	#define EFI_FV_ALIGNMENT_256 0x0000000000800000ULL\r
	73	#define EFI_FV_ALIGNMENT_512 0x0000000001000000ULL\r
	74	#define EFI_FV_ALIGNMENT_1K 0x0000000002000000ULL\r
	75	#define EFI_FV_ALIGNMENT_2K 0x0000000004000000ULL\r
	76	#define EFI_FV_ALIGNMENT_4K 0x0000000008000000ULL\r
	77	#define EFI_FV_ALIGNMENT_8K 0x0000000010000000ULL\r
	78	#define EFI_FV_ALIGNMENT_16K 0x0000000020000000ULL\r
	79	#define EFI_FV_ALIGNMENT_32K 0x0000000040000000ULL\r
	80	#define EFI_FV_ALIGNMENT_64K 0x0000000080000000ULL\r
	81	\r
	82	//\r
	83	// Protocol API definitions\r
	84	//\r
	85	\r
	86	/**\r
	87	Retrieves attributes, insures positive polarity of attribute bits, returns\r
	88	resulting attributes in output parameter\r
	89	\r
38db7507	90	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
79964ac8	91	@param Attributes output buffer which contains attributes\r
79964ac8	92	\r
38db7507	93	@retval EFI_SUCCESS The firmware volume attributes were returned.\r
79964ac8	94	**/\r
	95	typedef\r
	96	EFI_STATUS\r
69686d56	97	(EFIAPI *FRAMEWORK_EFI_FV_GET_ATTRIBUTES)(\r
3d02e416	98	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
3d02e416	99	OUT FRAMEWORK_EFI_FV_ATTRIBUTES *Attributes\r
79964ac8	100	);\r
	101	\r
	102	/**\r
	103	Sets volume attributes\r
	104	\r
38db7507	105	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
	106	@param Attributes On input, Attributes is a pointer to an \r
	107	EFI_FV_ATTRIBUTES containing the desired firmware \r
	108	volume settings.O n successful return, it contains \r
	109	the new settings of the firmware volume. On \r
	110	unsuccessful return, Attributes is not modified \r
	111	and the firmware volume settings are not changed.\r
79964ac8	112	\r
38db7507	113	@retval EFI_INVALID_PARAMETER A bit in Attributes was invalid\r
	114	@retval EFI_SUCCESS The requested firmware volume attributes were set \r
	115	and the resulting EFI_FV_ATTRIBUTES is returned in\r
	116	Attributes.\r
	117	@retval EFI_ACCESS_DENIED the Device is locked and does not permit modification. \r
79964ac8	118	\r
	119	**/\r
	120	typedef\r
	121	EFI_STATUS\r
69686d56	122	(EFIAPI *FRAMEWORK_EFI_FV_SET_ATTRIBUTES)(\r
38db7507	123	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
38db7507	124	IN OUT FRAMEWORK_EFI_FV_ATTRIBUTES *Attributes\r
79964ac8	125	);\r
79964ac8	126	\r
79964ac8	127	/**\r
38db7507	128	Read the requested file (NameGuid) or file information from the firmware volume \r
38db7507	129	and returns data in Buffer.\r
79964ac8	130	\r
38db7507	131	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
38db7507	132	@param NameGuid pointer to EFI_GUID which is the filename identifying which file to read\r
79964ac8	133	@param Buffer Pointer to pointer to buffer in which contents of file are returned.\r
	134	<br>\r
	135	If Buffer is NULL, only type, attributes, and size are returned as\r
	136	there is no output buffer.\r
	137	<br>\r
	138	If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
	139	from BS pool by ReadFile\r
	140	<br>\r
	141	If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
	142	allocated by the caller and is being passed in.\r
	143	@param BufferSize Indicates the buffer size passed in, and on output the size\r
	144	required to complete the read\r
38db7507	145	@param FoundType pointer to type of the file who's data is returned\r
	146	@param FileAttributes pointer to attributes of the file who's data is resturned\r
	147	@param AuthenticationStatus pointer to authentication status of the data\r
	148	\r
	149	@retval EFI_SUCCESS The call completed successfully\r
	150	@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.\r
	151	The buffer is filled and the output is truncated.\r
	152	@retval EFI_NOT_FOUND NameGuid was not found int he firmware volume.\r
	153	@retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.\r
	154	@retval EFI_ACCESS_DENIED The firmware volumen is configured to disallow reads.\r
	155	@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.\r
79964ac8	156	\r
	157	**/\r
	158	typedef\r
	159	EFI_STATUS\r
69686d56	160	(EFIAPI *FRAMEWORK_EFI_FV_READ_FILE)(\r
79964ac8	161	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
	162	IN EFI_GUID *NameGuid,\r
	163	IN OUT VOID **Buffer,\r
	164	IN OUT UINTN *BufferSize,\r
	165	OUT EFI_FV_FILETYPE *FoundType,\r
	166	OUT EFI_FV_FILE_ATTRIBUTES *FileAttributes,\r
	167	OUT UINT32 *AuthenticationStatus\r
	168	);\r
	169	\r
	170	/**\r
	171	Read the requested section from the specified file and returns data in Buffer.\r
	172	\r
38db7507	173	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
79964ac8	174	@param NameGuid Filename identifying the file from which to read\r
	175	@param SectionType Indicates what section type to retrieve\r
	176	@param SectionInstance Indicates which instance of SectionType to retrieve\r
	177	@param Buffer Pointer to pointer to buffer in which contents of file are returned.\r
	178	<br>\r
	179	If Buffer is NULL, only type, attributes, and size are returned as\r
	180	there is no output buffer.\r
	181	<br>\r
	182	If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
	183	from BS pool by ReadFile\r
	184	<br>\r
	185	If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
	186	allocated by the caller and is being passed in.\r
38db7507	187	@param BufferSize pointer to the buffer size passed in, and on output the size\r
79964ac8	188	required to complete the read\r
38db7507	189	@param AuthenticationStatus pointer to the authentication status of the data\r
79964ac8	190	\r
	191	@retval EFI_SUCCESS\r
	192	@retval EFI_WARN_BUFFER_TOO_SMALL\r
	193	@retval EFI_OUT_OF_RESOURCES\r
	194	@retval EFI_NOT_FOUND\r
	195	@retval EFI_DEVICE_ERROR\r
	196	@retval EFI_ACCESS_DENIED\r
	197	\r
	198	**/\r
	199	typedef\r
	200	EFI_STATUS\r
69686d56	201	(EFIAPI *FRAMEWORK_EFI_FV_READ_SECTION)(\r
79964ac8	202	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
	203	IN EFI_GUID *NameGuid,\r
	204	IN EFI_SECTION_TYPE SectionType,\r
	205	IN UINTN SectionInstance,\r
	206	IN OUT VOID **Buffer,\r
	207	IN OUT UINTN *BufferSize,\r
	208	OUT UINT32 *AuthenticationStatus\r
	209	);\r
	210	\r
3d02e416	211	typedef UINT32 FRAMEWORK_EFI_FV_WRITE_POLICY;\r
79964ac8	212	\r
3d02e416	213	#define FRAMEWORK_EFI_FV_UNRELIABLE_WRITE 0x00000000\r
3d02e416	214	#define FRAMEWORK_EFI_FV_RELIABLE_WRITE 0x00000001\r
79964ac8	215	\r
	216	typedef struct {\r
	217	EFI_GUID *NameGuid;\r
	218	EFI_FV_FILETYPE Type;\r
	219	EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
	220	VOID *Buffer;\r
	221	UINT32 BufferSize;\r
3d02e416	222	} FRAMEWORK_EFI_FV_WRITE_FILE_DATA;\r
79964ac8	223	\r
	224	/**\r
	225	Write the supplied file (NameGuid) to the FV.\r
	226	\r
38db7507	227	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
79964ac8	228	@param NumberOfFiles Indicates the number of file records pointed to by FileData\r
	229	@param WritePolicy Indicates the level of reliability of the write with respect to\r
	230	things like power failure events.\r
	231	@param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each\r
	232	element in the array indicates a file to write, and there are\r
	233	NumberOfFiles elements in the input array.\r
	234	\r
	235	@retval EFI_SUCCESS\r
	236	@retval EFI_OUT_OF_RESOURCES\r
	237	@retval EFI_DEVICE_ERROR\r
	238	@retval EFI_WRITE_PROTECTED\r
	239	@retval EFI_NOT_FOUND\r
	240	@retval EFI_INVALID_PARAMETER\r
	241	\r
	242	**/\r
	243	typedef\r
	244	EFI_STATUS\r
69686d56	245	(EFIAPI *FRAMEWORK_EFI_FV_WRITE_FILE)(\r
3d02e416	246	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
	247	IN UINT32 NumberOfFiles,\r
	248	IN FRAMEWORK_EFI_FV_WRITE_POLICY WritePolicy,\r
	249	IN FRAMEWORK_EFI_FV_WRITE_FILE_DATA *FileData\r
79964ac8	250	);\r
	251	\r
	252	/**\r
	253	Given the input key, search for the next matching file in the volume.\r
	254	\r
38db7507	255	@param This Indicates the EFI_FIRMWARE_VOLUME_PROTOCOL instance.\r
79964ac8	256	@param Key Pointer to a caller allocated buffer that contains an implementation\r
	257	specific key that is used to track where to begin searching on\r
	258	successive calls.\r
38db7507	259	@param FileType pointer to the file type to filter for\r
	260	@param NameGuid pointer to Guid filename of the file found\r
	261	@param Attributes pointer to Attributes of the file found\r
	262	@param Size pointer to Size in bytes of the file found\r
79964ac8	263	\r
	264	@retval EFI_SUCCESS\r
	265	@retval EFI_NOT_FOUND\r
	266	@retval EFI_DEVICE_ERROR\r
	267	@retval EFI_ACCESS_DENIED\r
	268	\r
	269	**/\r
	270	typedef\r
	271	EFI_STATUS\r
69686d56	272	(EFIAPI *FRAMEWORK_EFI_FV_GET_NEXT_FILE)(\r
79964ac8	273	IN EFI_FIRMWARE_VOLUME_PROTOCOL *This,\r
	274	IN OUT VOID *Key,\r
	275	IN OUT EFI_FV_FILETYPE *FileType,\r
	276	OUT EFI_GUID *NameGuid,\r
	277	OUT EFI_FV_FILE_ATTRIBUTES *Attributes,\r
	278	OUT UINTN *Size\r
	279	);\r
	280	\r
38db7507	281	//\r
	282	// Protocol interface structure\r
	283	//\r
79964ac8	284	struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
38db7507	285	///\r
	286	/// Retrieves volume capabilities and current settings.\r
	287	///\r
3d02e416	288	FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
38db7507	289	///\r
	290	/// Modifies the current settings of the firmware volume.\r
	291	///\r
3d02e416	292	FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r
38db7507	293	///\r
	294	/// Reads an entire file from the firmware volume.\r
	295	///\r
3d02e416	296	FRAMEWORK_EFI_FV_READ_FILE ReadFile;\r
38db7507	297	///\r
	298	/// Reads a single section from a file into a buffer.\r
	299	///\r
3d02e416	300	FRAMEWORK_EFI_FV_READ_SECTION ReadSection;\r
38db7507	301	///\r
	302	/// Writes an entire file into the firmware volume.\r
	303	///\r
3d02e416	304	FRAMEWORK_EFI_FV_WRITE_FILE WriteFile;\r
38db7507	305	///\r
	306	/// Provides service to allow searching the firmware volume.\r
	307	///\r
3d02e416	308	FRAMEWORK_EFI_FV_GET_NEXT_FILE GetNextFile;\r
38db7507	309	///\r
	310	/// Data field that indicates the size in bytes of the Key input buffer for\r
	311	/// the GetNextFile() API.\r
	312	///\r
	313	UINT32 KeySize;\r
	314	///\r
	315	/// Handle of the parent firmware volume.\r
	316	///\r
79964ac8	317	EFI_HANDLE ParentHandle;\r
	318	};\r
	319	\r
	320	extern EFI_GUID gEfiFirmwareVolumeProtocolGuid;\r
	321	\r
	322	#endif\r