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