Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolume2.h

/** @file\r
  The Firmware Volume Protocol provides file-level access to the firmware volume. \r
  Each firmware volume driver must produce an instance of the \r
  Firmware Volume Protocol if the firmware volume is to be visible to\r
  the system during the DXE phase. The Firmware Volume Protocol also provides\r
  mechanisms for determining and modifying some attributes of the firmware volume.\r
\r
  Copyright (c) 2006 - 2008, 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: PI\r
  Version 1.00.\r
\r
**/\r
\r
#ifndef __FIRMWARE_VOLUME2_H__\r
#define __FIRMWARE_VOLUME2_H__\r
\r
#define EFI_FIRMWARE_VOLUME2_PROTOCOL_GUID \\r
  { 0x220e73b6, 0x6bdb, 0x4413, { 0x84, 0x5, 0xb9, 0x74, 0xb1, 0x8, 0x61, 0x9a } }\r
\r
typedef struct _EFI_FIRMWARE_VOLUME2_PROTOCOL EFI_FIRMWARE_VOLUME2_PROTOCOL;\r
\r
\r
///\r
/// EFI_FV_ATTRIBUTES\r
///\r
typedef UINT64  EFI_FV_ATTRIBUTES;\r
\r
//\r
// EFI_FV_ATTRIBUTES bit definitions\r
//\r
// EFI_FV_ATTRIBUTES bit semantics\r
#define EFI_FV2_READ_DISABLE_CAP        0x0000000000000001ULL\r
#define EFI_FV2_READ_ENABLE_CAP         0x0000000000000002ULL\r
#define EFI_FV2_READ_STATUS             0x0000000000000004ULL\r
#define EFI_FV2_WRITE_DISABLE_CAP       0x0000000000000008ULL\r
#define EFI_FV2_WRITE_ENABLE_CAP        0x0000000000000010ULL\r
#define EFI_FV2_WRITE_STATUS            0x0000000000000020ULL\r
#define EFI_FV2_LOCK_CAP                0x0000000000000040ULL\r
#define EFI_FV2_LOCK_STATUS             0x0000000000000080ULL\r
#define EFI_FV2_WRITE_POLICY_RELIABLE   0x0000000000000100ULL\r
#define EFI_FV2_READ_LOCK_CAP           0x0000000000001000ULL\r
#define EFI_FV2_READ_LOCK_STATUS        0x0000000000002000ULL\r
#define EFI_FV2_WRITE_LOCK_CAP          0x0000000000004000ULL\r
#define EFI_FV2_WRITE_LOCK_STATUS       0x0000000000008000ULL\r
#define EFI_FV2_ALIGNMENT               0x00000000001F0000ULL\r
#define EFI_FV2_ALIGNMENT_1             0x0000000000000000ULL\r
#define EFI_FV2_ALIGNMENT_2             0x0000000000010000ULL\r
#define EFI_FV2_ALIGNMENT_4             0x0000000000020000ULL\r
#define EFI_FV2_ALIGNMENT_8             0x0000000000030000ULL\r
#define EFI_FV2_ALIGNMENT_16            0x0000000000040000ULL\r
#define EFI_FV2_ALIGNMENT_32            0x0000000000050000ULL\r
#define EFI_FV2_ALIGNMENT_64            0x0000000000060000ULL\r
#define EFI_FV2_ALIGNMENT_128           0x0000000000070000ULL\r
#define EFI_FV2_ALIGNMENT_256           0x0000000000080000ULL\r
#define EFI_FV2_ALIGNMENT_512           0x0000000000090000ULL\r
#define EFI_FV2_ALIGNMENT_1K            0x00000000000A0000ULL\r
#define EFI_FV2_ALIGNMENT_2K            0x00000000000B0000ULL\r
#define EFI_FV2_ALIGNMENT_4K            0x00000000000C0000ULL\r
#define EFI_FV2_ALIGNMENT_8K            0x00000000000D0000ULL\r
#define EFI_FV2_ALIGNMENT_16K           0x00000000000E0000ULL\r
#define EFI_FV2_ALIGNMENT_32K           0x00000000000F0000ULL\r
#define EFI_FV2_ALIGNMENT_64K           0x0000000000100000ULL\r
#define EFI_FV2_ALIGNMENT_128K          0x0000000000110000ULL\r
#define EFI_FV2_ALIGNMENT_256K          0x0000000000120000ULL\r
#define EFI_FV2_ALIGNMENT_512K          0x0000000000130000ULL\r
#define EFI_FV2_ALIGNMENT_1M            0x0000000000140000ULL\r
#define EFI_FV2_ALIGNMENT_2M            0x0000000000150000ULL\r
#define EFI_FV2_ALIGNMENT_4M            0x0000000000160000ULL\r
#define EFI_FV2_ALIGNMENT_8M            0x0000000000170000ULL\r
#define EFI_FV2_ALIGNMENT_16M           0x0000000000180000ULL\r
#define EFI_FV2_ALIGNMENT_32M           0x0000000000190000ULL\r
#define EFI_FV2_ALIGNMENT_64M           0x00000000001A0000ULL\r
#define EFI_FV2_ALIGNMENT_128M          0x00000000001B0000ULL\r
#define EFI_FV2_ALIGNMENT_256M          0x00000000001C0000ULL\r
#define EFI_FV2_ALIGNMENT_512M          0x00000000001D0000ULL\r
#define EFI_FV2_ALIGNMENT_1G            0x00000000001E0000ULL\r
#define EFI_FV2_ALIGNMENT_2G            0x00000000001F0000ULL\r
\r
/**\r
  \r
  Because of constraints imposed by the underlying firmware\r
  storage, an instance of the Firmware Volume Protocol may not\r
  be to able to support all possible variations of this\r
  architecture. These constraints and the current state of the\r
  firmware volume are exposed to the caller using the\r
  GetVolumeAttributes() function. GetVolumeAttributes() is\r
  callable only from TPL_NOTIFY and below. Behavior of\r
  GetVolumeAttributes() at any EFI_TPL above TPL_NOTIFY is\r
  undefined.\r
\r
  @param  This          Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  \r
  @param  FvAttributes  Pointer to an EFI_FV_ATTRIBUTES in which\r
                        the attributes and current settings are\r
                        returned.\r
\r
\r
  @retval EFI_SUCCESS   The firmware volume attributes were\r
                        returned.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_GET_ATTRIBUTES)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  OUT       EFI_FV_ATTRIBUTES             *FvAttributes\r
);\r
\r
\r
/**\r
  The SetVolumeAttributes() function is used to set configurable\r
  firmware volume attributes. Only EFI_FV_READ_STATUS,\r
  EFI_FV_WRITE_STATUS, and EFI_FV_LOCK_STATUS may be modified, and\r
   then only in accordance with the declared capabilities. All\r
  other bits of FvAttributes are ignored on input. On successful\r
  return, all bits of *FvAttributes are valid and it contains the\r
  completed EFI_FV_ATTRIBUTES for the volume. To modify an\r
  attribute, the corresponding status bit in the EFI_FV_ATTRIBUTES\r
  is set to the desired value on input. The EFI_FV_LOCK_STATUS bit\r
  does not affect the ability to read or write the firmware\r
  volume. Rather, once the EFI_FV_LOCK_STATUS bit is set, it\r
  prevents further modification to all the attribute bits.\r
  SetVolumeAttributes() is callable only from TPL_NOTIFY and\r
  below. Behavior of SetVolumeAttributes() at any EFI_TPL above\r
  TPL_NOTIFY is undefined.\r
\r
  @param  This          Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  \r
  @param  FvAttributes  On input, FvAttributes is a pointer to\r
                        an EFI_FV_ATTRIBUTES containing the\r
                        desired firmware volume settings. On\r
                        successful return, it contains the new\r
                        settings of the firmware volume. On\r
                        unsuccessful return, FvAttributes is not\r
                        modified and the firmware volume\r
                        settings are not changed.\r
  \r
  @retval EFI_SUCCESS           The requested firmware volume attributes\r
                                were set and the resulting\r
                                EFI_FV_ATTRIBUTES is returned in\r
                                FvAttributes.\r
\r
  @retval EFI_INVALID_PARAMETER FvAttributes:EFI_FV_READ_STATUS\r
                                is set to 1 on input, but the\r
                                device does not support enabling\r
                                reads\r
                                (FvAttributes:EFI_FV_READ_ENABLE\r
                                is clear on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
  @retval EFI_INVALID_PARAMETER FvAttributes:EFI_FV_READ_STATUS\r
                                is cleared to 0 on input, but\r
                                the device does not support\r
                                disabling reads\r
                                (FvAttributes:EFI_FV_READ_DISABL\r
                                is clear on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
  @retval EFI_INVALID_PARAMETER FvAttributes:EFI_FV_WRITE_STATUS\r
                                is set to 1 on input, but the\r
                                device does not support enabling\r
                                writes\r
                                (FvAttributes:EFI_FV_WRITE_ENABL\r
                                is clear on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
  @retval EFI_INVALID_PARAMETER FvAttributes:EFI_FV_WRITE_STATUS\r
                                is cleared to 0 on input, but\r
                                the device does not support\r
                                disabling writes\r
                                (FvAttributes:EFI_FV_WRITE_DISAB\r
                                is clear on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
  @retval EFI_INVALID_PARAMETER FvAttributes:EFI_FV_LOCK_STATUS\r
                                is set on input, but the device\r
                                does not support locking\r
                                (FvAttributes:EFI_FV_LOCK_CAP is\r
                                clear on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
  @retval EFI_ACCESS_DENIED     Device is locked and does not\r
                                allow attribute modification\r
                                (FvAttributes:EFI_FV_LOCK_STATUS\r
                                is set on return from\r
                                GetVolumeAttributes()). Actual\r
                                volume attributes are unchanged.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_SET_ATTRIBUTES)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN OUT    EFI_FV_ATTRIBUTES             *FvAttributes\r
);\r
\r
\r
/**\r
  ReadFile() is used to retrieve any file from a firmware volume\r
  during the DXE phase. The actual binary encoding of the file in\r
  the firmware volume media may be in any arbitrary format as long\r
  as it does the following: ?It is accessed using the Firmware\r
  Volume Protocol. ?The image that is returned follows the image\r
  format defined in Code Definitions: PI Firmware File Format.\r
  If the input value of Buffer==NULL, it indicates the caller is\r
  requesting only that the type, attributes, and size of the\r
  file be returned and that there is no output buffer. In this\r
  case, the following occurs:\r
  - BufferSize is returned with the size that is required to\r
    successfully complete the read.\r
  - The output parameters FoundType and *FileAttributes are\r
  returned with valid values.\r
  - The returned value of *AuthenticationStatus is undefined.\r
\r
  If the input value of Buffer!=NULL, the output buffer is\r
  specified by a double indirection of the Buffer parameter. The\r
  input value of *Buffer is used to determine if the output\r
  buffer is caller allocated or is dynamically allocated by\r
  ReadFile(). If the input value of *Buffer!=NULL, it indicates\r
  the output buffer is caller allocated. In this case, the input\r
   value of *BufferSize indicates the size of the\r
  caller-allocated output buffer. If the output buffer is not\r
  large enough to contain the entire requested output, it is\r
  filled up to the point that the output buffer is exhausted and\r
  EFI_WARN_BUFFER_TOO_SMALL is returned, and then BufferSize is\r
   returned with the size required to successfully complete the\r
  read. All other output parameters are returned with valid\r
  values. If the input value of *Buffer==NULL, it indicates the\r
  output buffer is to be allocated by ReadFile(). In this case,\r
  ReadFile() will allocate an appropriately sized buffer from\r
  boot services pool memory, which will be returned in Buffer.\r
  The size of the new buffer is returned in BufferSize and all\r
  other output parameters are returned with valid values.\r
  ReadFile() is callable only from TPL_NOTIFY and below.\r
  Behavior of ReadFile() at any EFI_TPL above TPL_NOTIFY is\r
  undefined.\r
\r
  @param  This                  Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
  \r
  @param  NameGuid              Pointer to an EFI_GUID, which is the file\r
                                name. All firmware file names are EFI_GUIDs.\r
                                A single firmware volume must not have two\r
                                valid files with the same file name\r
                                EFI_GUID.\r
  \r
  @param  Buffer                Pointer to a pointer to a buffer in which the\r
                                file contents are returned, not including the\r
                                file header.\r
\r
  @param  BufferSize            Pointer to a caller-allocated UINTN. It\r
                                indicates the size of the memory\r
                                represented by Buffer.\r
  \r
  @param  FoundType             Pointer to a caller-allocated EFI_FV_FILETYPE.\r
  \r
  @param  FileAttributes        Pointer to a  caller-allocated\r
                                EFI_FV_FILE_ATTRIBUTES.\r
  \r
  @param  AuthenticationStatus  Pointer to a caller-allocated\r
                                UINT32 in which the\r
                                authentication status is\r
                                returned.\r
  \r
  @retval EFI_SUCCESS                 The call completed successfully.\r
  \r
  @retval EFI_WARN_BUFFER_TOO_SMALL   The buffer is too small to\r
                                      contain the requested\r
                                      output. The buffer is\r
                                      filled and the output is\r
                                      truncated.\r
\r
  @retval EFI_OUT_OF_RESOURCES        An allocation failure occurred.\r
\r
  @retval EFI_NOT_FOUND               Name was not found in the firmware volume.\r
\r
  @retval EFI_DEVICE_ERROR            A hardware error occurred when\r
                                      attempting to access the firmware volume.\r
\r
  @retval EFI_ACCESS_DENIED           The firmware volume is configured to\r
                                      isallow reads.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_READ_FILE)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN CONST  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
\r
/**\r
  ReadSection() is used to retrieve a specific section from a file\r
  within a firmware volume. The section returned is determined\r
  using a depth-first, left-to-right search algorithm through all\r
  sections found in the specified file. See\r
   ????Firmware File Sections???? on page 9 for more details about\r
  sections. The output buffer is specified by a double indirection\r
  of the Buffer parameter. The input value of Buffer is used to\r
  determine if the output buffer is caller allocated or is\r
  dynamically allocated by ReadSection(). If the input value of\r
  Buffer!=NULL, it indicates that the output buffer is caller\r
  allocated. In this case, the input value of *BufferSize\r
  indicates the size of the caller-allocated output buffer. If\r
  the output buffer is not large enough to contain the entire\r
  requested output, it is filled up to the point that the output\r
  buffer is exhausted and EFI_WARN_BUFFER_TOO_SMALL is returned,\r
  and then BufferSize is returned with the size that is required\r
  to successfully complete the read. All other\r
  output parameters are returned with valid values. If the input\r
  value of *Buffer==NULL, it indicates the output buffer is to\r
  be allocated by ReadSection(). In this case, ReadSection()\r
  will allocate an appropriately sized buffer from boot services\r
  pool memory, which will be returned in *Buffer. The size of\r
  the new buffer is returned in *BufferSize and all other output\r
  parameters are returned with valid values. ReadSection() is\r
  callable only from TPL_NOTIFY and below. Behavior of\r
  ReadSection() at any EFI_TPL above TPL_NOTIFY is\r
  undefined.\r
\r
  @param  This                Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
 \r
  @param NameGuid             Pointer to an EFI_GUID, which indicates the\r
                              file name from which the requested section\r
                              will be read.\r
  \r
  @param SectionType          Indicates the section type to return.\r
                              SectionType in conjunction with\r
                              SectionInstance indicates which section to\r
                              return.\r
  \r
  @param SectionInstance      Indicates which instance of sections\r
                              with a type of SectionType to return.\r
                              SectionType in conjunction with\r
                              SectionInstance indicates which\r
                              section to return. SectionInstance is\r
                              zero based.\r
  \r
  @param Buffer               Pointer to a pointer to a buffer in which the\r
                              section contents are returned, not including\r
                              the section header.\r
  \r
  @param BufferSize           Pointer to a caller-allocated UINTN. It\r
                              indicates the size of the memory\r
                              represented by Buffer.\r
  \r
  @param AuthenticationStatus Pointer to a caller-allocated\r
                              UINT32 in which the authentication\r
                              status is returned.\r
  \r
  \r
  @retval EFI_SUCCESS   The call completed successfully.\r
  \r
  @retval EFI_WARN_BUFFER_TOO_SMALL   The caller-allocated\r
                                      buffer is too small to\r
                                      contain the requested\r
                                      output. The buffer is\r
                                      filled and the output is\r
                                      truncated.\r
  \r
  @retval EFI_OUT_OF_RESOURCES  An allocation failure occurred.\r
  \r
  @retval EFI_NOT_FOUND   The requested file was not found in\r
                          the firmware volume. EFI_NOT_FOUND The\r
                          requested section was not found in the\r
                          specified file.\r
  \r
  @retval EFI_DEVICE_ERROR  A hardware error occurred when\r
                            attempting to access the firmware\r
                            volume.\r
  \r
  @retval EFI_ACCESS_DENIED The firmware volume is configured to\r
                            disallow reads. EFI_PROTOCOL_ERROR\r
                            The requested section was not found,\r
                            but the file could not be fully\r
                            parsed because a required\r
                            GUIDED_SECTION_EXTRACTION_PROTOCOL\r
                            was not found. It is possible the\r
                            requested section exists within the\r
                            file and could be successfully\r
                            extracted once the required\r
                            GUIDED_SECTION_EXTRACTION_PROTOCOL\r
                            is published.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_READ_SECTION)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN CONST  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
//\r
// EFI_FV_WRITE_POLICY\r
//\r
typedef UINT32 EFI_FV_WRITE_POLICY;\r
#define EFI_FV_UNRELIABLE_WRITE   0x00000000\r
#define EFI_FV_RELIABLE_WRITE     0x00000001\r
\r
//\r
// EFI_FV_WRITE_FILE_DATA\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
} EFI_FV_WRITE_FILE_DATA;\r
\r
/**\r
  WriteFile() is used to write one or more files to a firmware\r
  volume. Each file to be written is described by an\r
  EFI_FV_WRITE_FILE_DATA structure. The caller must ensure that\r
  any required alignment for all files listed in the FileData\r
  array is compatible with the firmware volume. Firmware volume\r
  capabilities can be determined using the GetVolumeAttributes()\r
  call. Similarly, if the WritePolicy is set to\r
  EFI_FV_RELIABLE_WRITE, the caller must check the firmware volume\r
  capabilities to ensure EFI_FV_RELIABLE_WRITE is supported by the\r
  firmware volume. EFI_FV_UNRELIABLE_WRITE must always be\r
  supported. Writing a file with a size of zero\r
  (FileData[n].BufferSize == 0) deletes the file from the firmware\r
  volume if it exists. Deleting a file must be done one at a time.\r
  Deleting a file as part of a multiple file write is not allowed.\r
  Platform Initialization Specification VOLUME 3 Shared\r
  Architectural Elements 84 August 21, 2006 Version 1.0\r
  WriteFile() is callable only from TPL_NOTIFY and below.\r
  Behavior of WriteFile() at any EFI_TPL above TPL_NOTIFY is\r
  undefined. \r
\r
  @param This           Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
\r
  @param NumberOfFiles  Indicates the number of elements in the array pointed to by FileData\r
\r
  @param WritePolicy    Indicates the level of reliability for the\r
                        write in the event of a power failure or\r
                        other system failure during the write\r
                        operation.\r
 \r
  @param FileData       Pointer to an array of\r
                        EFI_FV_WRITE_FILE_DATA. Each element of\r
                        FileData[] represents a file to be written.\r
\r
\r
  @retval EFI_SUCCESS             The write completed successfully.\r
  \r
  @retval EFI_OUT_OF_RESOURCES    The firmware volume does not\r
                                  have enough free space to\r
                                  storefile(s).\r
  \r
  @retval EFI_DEVICE_ERROR        A hardware error occurred when\r
                                  attempting to access the firmware volume.\r
  \r
  @retval EFI_WRITE_PROTECTED     The firmware volume is\r
                                  configured to disallow writes.\r
  \r
  @retval EFI_NOT_FOUND           A delete was requested, but the\r
                                  requested file was not found in the\r
                                  firmware volume.\r
  \r
  @retval EFI_INVALID_PARAMETER   A delete was requested with a\r
                                  multiple file write.\r
  \r
  @retval EFI_INVALID_PARAMETER   An unsupported WritePolicy was\r
                                  requested.\r
\r
  @retval EFI_INVALID_PARAMETER   An unknown file type was\r
                                  specified.\r
\r
  @retval EFI_INVALID_PARAMETER   A file system specific error\r
                                  has occurred.\r
  \r
**/\r
typedef\r
EFI_STATUS \r
(EFIAPI * EFI_FV_WRITE_FILE)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN        UINT32                        NumberOfFiles,\r
  IN        EFI_FV_WRITE_POLICY           WritePolicy,\r
  IN        EFI_FV_WRITE_FILE_DATA        *FileData\r
);\r
\r
\r
/**\r
  GetNextFile() is the interface that is used to search a firmware\r
  volume for a particular file. It is called successively until\r
  the desired file is located or the function returns\r
   EFI_NOT_FOUND. To filter uninteresting files from the output,\r
  the type of file to search for may be specified in FileType. For\r
  example, if *FileType is EFI_FV_FILETYPE_DRIVER, only files of\r
  this type will be returned in the output. If *FileType is\r
  EFI_FV_FILETYPE_ALL, no filtering of file types is done. The Key\r
  parameter is used to indicate a starting point of the search. If\r
  the buffer *Key is completely initialized to zero, the search\r
  re-initialized and starts at the beginning. Subsequent calls to\r
  GetNextFile() must maintain the value of *Key returned by the\r
  immediately previous call. The actual contents of *Key are\r
  implementation specific and no semantic content is implied.\r
  GetNextFile() is callable only from TPL_NOTIFY and below.\r
  Behavior of GetNextFile() at any EFI_TPL above TPL_NOTIFY is\r
  undefined. \r
\r
  @param This       Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
\r
  @param Key        Pointer to a caller-allocated buffer that contains implementation-specific data that is\r
                    used to track where to begin the search for the next file. The size of the buffer must be\r
                    at least This->KeySize bytes long. To re-initialize the search and begin from the\r
                    beginning of the firmware volume, the entire buffer must be cleared to zero. Other\r
                    than clearing the buffer to initiate a new search, the caller must not modify the data in\r
                    the buffer between calls to GetNextFile().\r
\r
  @param FileType   Pointer to a caller-allocated\r
                    EFI_FV_FILETYPE. The GetNextFile() API can\r
                    filter its search for files based on the\r
                    value of the FileType input. A *FileType\r
                    input of EFI_FV_FILETYPE_ALL causes\r
                    GetNextFile() to search for files of all\r
                    types. If a file is found, the file's type\r
                    is returned in FileType. *FileType is not\r
                    modified if no file is found.\r
\r
  @param NameGuid   Pointer to a caller-allocated EFI_GUID. If a\r
                    matching file is found, the file's name is\r
                    returned in NameGuid. If no matching file is\r
                    found, *NameGuid is not modified.\r
\r
  @param Attributes Pointer to a caller-allocated\r
                    EFI_FV_FILE_ATTRIBUTES. If a matching file\r
                    is found, the file's attributes are returned\r
                    in Attributes. If no matching file is found,\r
                    Attributes is not modified. Type\r
                    EFI_FV_FILE_ATTRIBUTES is defined in\r
                    ReadFile().\r
\r
  @param Size       Pointer to a caller-allocated UINTN. If a\r
                    matching file is found, the file's size is\r
                    returned in *Size. If no matching file is found,\r
                    Size is not modified.\r
\r
  @retval EFI_SUCCESS       The output parameters are filled with data\r
                            obtained from the first matching file that\r
                            was found.\r
\r
  @retval FI_NOT_FOUND      No files of type FileType were found.\r
\r
\r
  @retval EFI_DEVICE_ERROR  A hardware error occurred when\r
                            attempting to access the firmware\r
                            volume.\r
\r
  @retval EFI_ACCESS_DENIED The firmware volume is configured to\r
                            disallow reads.\r
\r
   \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_GET_NEXT_FILE)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_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
  The GetInfo() function returns information of type\r
  InformationType for the requested firmware volume. If the volume\r
  does not support the requested information type, then\r
  EFI_UNSUPPORTED is returned. If the buffer is not large enough\r
  to hold the requested structure, EFI_BUFFER_TOO_SMALL is\r
  returned and the BufferSize is set to the size of buffer that is\r
  required to make the request. The information types defined by\r
  this specification are required information types that all file\r
  systems must support.\r
\r
  @param This             A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL\r
                          instance that is the file handle the requested\r
                          information is for.\r
  \r
  @param InformationType  The type identifier for the\r
                          information being requested.\r
  \r
  @param BufferSize       On input, the size of Buffer. On output,\r
                          the amount of data returned in Buffer. In\r
                          both cases, the size is measured in bytes.\r
  \r
  @param Buffer           A pointer to the data buffer to return. The\r
                          buffer's type is indicated by InformationType.\r
  \r
  \r
  @retval EFI_SUCCESS           The information was retrieved.\r
  \r
  @retval EFI_UNSUPPORTED       The InformationType is not known.\r
  \r
  @retval EFI_NO_MEDIA          The device has no medium.\r
  \r
  @retval EFI_DEVICE_ERROR      The device reported an error.\r
  \r
  @retval EFI_VOLUME_CORRUPTED  The file system structures are\r
                                corrupted.\r
  \r
  @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small to\r
                                read the current directory\r
                                entry. BufferSize has been\r
                                updated with the size needed to\r
                                complete the request.\r
\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_FV_GET_INFO)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN CONST  EFI_GUID                      *InformationType,\r
  IN OUT    UINTN                         *BufferSize,\r
  OUT       VOID                          *Buffer\r
);\r
\r
\r
/**\r
\r
  The SetInfo() function sets information of type InformationType\r
  on the requested firmware volume.\r
\r
\r
  @param This             A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL\r
                          instance that is the file handle the information\r
                          is for.\r
\r
  @param InformationType  The type identifier for the\r
                          information being set.\r
\r
  @param BufferSize       The size, in bytes, of Buffer.\r
\r
  @param Buffer           A pointer to the data buffer to write. The\r
                          buffer's type is indicated by InformationType.\r
\r
  @retval EFI_SUCCESS           The information was set.\r
\r
  @retval EFI_UNSUPPORTED       The InformationType is not known.\r
\r
  @retval EFI_NO_MEDIA          The device has no medium.\r
\r
  @retval EFI_DEVICE_ERROR      The device reported an error.\r
\r
  @retval EFI_VOLUME_CORRUPTED  The file system structures are\r
                                corrupted.\r
\r
\r
  @retval EFI_WRITE_PROTECTED   The media is read only.\r
\r
  @retval EFI_VOLUME_FULL       The volume is full.\r
\r
  @retval EFI_BAD_BUFFER_SIZE   BufferSize is smaller than the\r
                                size of the type indicated by\r
                                InformationType.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_FV_SET_INFO)(\r
  IN CONST  EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
  IN CONST  EFI_GUID                      *InformationType,\r
  IN        UINTN                         BufferSize,\r
  IN CONST  VOID                          *Buffer\r
);\r
\r
\r
/**\r
  @par Protocol Description:\r
  The Firmware Volume Protocol contains the file-level\r
  abstraction to the firmware volume as well as some firmware\r
  volume attribute reporting and configuration services. The\r
  Firmware Volume Protocol is the interface used by all parts of\r
  DXE that are not directly involved with managing the firmware\r
  volume itself. This abstraction allows many varied types of\r
  firmware volume implementations. A firmware volume may be a\r
  flash device or it may be a file in the UEFI system partition,\r
  for example. This level of firmware volume implementation\r
  detail is not visible to the consumers of the Firmware Volume\r
  Protocol.\r
\r
  @param  GetVolumeAttributes   Retrieves volume capabilities\r
                                and current settings. \r
\r
  @param  SetVolumeAttributes   Modifies the current settings of\r
                                the firmware volume.\r
\r
  @param  ReadFile              Reads an entire file from the firmware\r
                                volume. \r
\r
  @param  ReadSection           Reads a single section from a file into\r
                                a buffer.\r
\r
  @param  WriteFile             Writes an entire file into the firmware\r
                                volume. \r
\r
  @param  GetNextFile           Provides service to allow searching the\r
                                firmware volume.\r
\r
  @param  KeySize               Data field that indicates the size in bytes\r
                                of the Key input buffer for the\r
                                GetNextFile() API.\r
\r
  @param  ParentHandle          Handle of the parent firmware volume.\r
\r
  @param  GetInfo               Gets the requested file or volume\r
                                information. \r
\r
  @param  SetInfo               Sets the requested file information.\r
**/\r
struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r
  EFI_FV_GET_ATTRIBUTES   GetVolumeAttributes;\r
  EFI_FV_SET_ATTRIBUTES   SetVolumeAttributes;\r
  EFI_FV_READ_FILE        ReadFile;\r
  EFI_FV_READ_SECTION     ReadSection;\r
  EFI_FV_WRITE_FILE       WriteFile;\r
  EFI_FV_GET_NEXT_FILE    GetNextFile;\r
  UINT32                  KeySize;\r
  EFI_HANDLE              ParentHandle;\r
  EFI_FV_GET_INFO         GetInfo;\r
  EFI_FV_SET_INFO         SetInfo;\r
};\r
\r
\r
extern EFI_GUID gEfiFirmwareVolume2ProtocolGuid;\r
\r
#endif\r