+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r
-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
-Module Name:\r
-\r
- FirmwareVolume.h\r
-\r
-Abstract:\r
-\r
- Firmware Volume protocol as defined in the Tiano Firmware Volume\r
- specification.\r
-\r
---*/\r
-\r
-#ifndef _FW_VOL_H_\r
-#define _FW_VOL_H_\r
-\r
-//\r
-// Statements that include other files\r
-//\r
-#include "EfiFirmwareVolumeHeader.h"\r
-#include "EfiFirmwareFileSystem.h"\r
-#include "EfiFirmwareVolume.h"\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
-\r
-//\r
-// ************************************************************\r
-// EFI_FV_ATTRIBUTES bit definitions\r
-// ************************************************************\r
-//\r
-#define EFI_FV_READ_DISABLE_CAP 0x0000000000000001\r
-#define EFI_FV_READ_ENABLE_CAP 0x0000000000000002\r
-#define EFI_FV_READ_STATUS 0x0000000000000004\r
-\r
-#define EFI_FV_WRITE_DISABLE_CAP 0x0000000000000008\r
-#define EFI_FV_WRITE_ENABLE_CAP 0x0000000000000010\r
-#define EFI_FV_WRITE_STATUS 0x0000000000000020\r
-\r
-#define EFI_FV_LOCK_CAP 0x0000000000000040\r
-#define EFI_FV_LOCK_STATUS 0x0000000000000080\r
-#define EFI_FV_WRITE_POLICY_RELIABLE 0x0000000000000100\r
-\r
-#define EFI_FV_ALIGNMENT_CAP 0x0000000000008000\r
-#define EFI_FV_ALIGNMENT_2 0x0000000000010000\r
-#define EFI_FV_ALIGNMENT_4 0x0000000000020000\r
-#define EFI_FV_ALIGNMENT_8 0x0000000000040000\r
-#define EFI_FV_ALIGNMENT_16 0x0000000000080000\r
-#define EFI_FV_ALIGNMENT_32 0x0000000000100000\r
-#define EFI_FV_ALIGNMENT_64 0x0000000000200000\r
-#define EFI_FV_ALIGNMENT_128 0x0000000000400000\r
-#define EFI_FV_ALIGNMENT_256 0x0000000000800000\r
-#define EFI_FV_ALIGNMENT_512 0x0000000001000000\r
-#define EFI_FV_ALIGNMENT_1K 0x0000000002000000\r
-#define EFI_FV_ALIGNMENT_2K 0x0000000004000000\r
-#define EFI_FV_ALIGNMENT_4K 0x0000000008000000\r
-#define EFI_FV_ALIGNMENT_8K 0x0000000010000000\r
-#define EFI_FV_ALIGNMENT_16K 0x0000000020000000\r
-#define EFI_FV_ALIGNMENT_32K 0x0000000040000000\r
-#define EFI_FV_ALIGNMENT_64K 0x0000000080000000\r
-\r
-//\r
-// Protocol API definitions\r
-//\r
-//\r
-// Forward declaration of protocol data structure\r
-//\r
-typedef struct _EFI_FIRMWARE_VOLUME_PROTOCOL EFI_FIRMWARE_VOLUME_PROTOCOL;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FV_GET_ATTRIBUTES) (\r
- IN EFI_FIRMWARE_VOLUME_PROTOCOL * This,\r
- OUT EFI_FV_ATTRIBUTES * Attributes\r
- );\r
-\r
-/*++\r
-\r
-Routine Description:\r
- Retrieves attributes, insures positive polarity of attribute bits, returns\r
- resulting attributes in output parameter\r
-\r
-Arguments:\r
- This - Calling context\r
- Attributes - output buffer which contains attributes\r
-\r
-Returns:\r
- EFI_INVALID_PARAMETER\r
- EFI_SUCCESS\r
-\r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FV_SET_ATTRIBUTES) (\r
- IN EFI_FIRMWARE_VOLUME_PROTOCOL * This,\r
- IN OUT EFI_FV_ATTRIBUTES * Attributes\r
- );\r
-\r
-/*++\r
-\r
-Routine Description:\r
- Sets volume attributes\r
-\r
-Arguments:\r
- This Calling context\r
- Attributes Buffer which contains attributes\r
-\r
-Returns:\r
- EFI_INVALID_PARAMETER\r
- EFI_DEVICE_ERROR\r
- EFI_SUCCESS\r
-\r
---*/\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *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
-\r
-Routine Description:\r
- Read the requested file (NameGuid) and returns data in Buffer.\r
-\r
-Arguments:\r
- This - Calling context\r
- NameGuid - Filename identifying which file to read \r
- Buffer - Pointer to pointer to buffer in which contents of file are returned.\r
- \r
- If Buffer is NULL, only type, attributes, and size are returned as\r
- there is no output buffer.\r
- \r
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
- from BS pool by ReadFile\r
- \r
- If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
- allocated by the caller and is being passed in.\r
- \r
- BufferSize - Indicates the buffer size passed in, and on output the size\r
- required to complete the read\r
- FoundType - Indicates the type of the file who's data is returned\r
- FileAttributes - Indicates the attributes of the file who's data is resturned\r
- AuthenticationStatus - Indicates the authentication status of the data\r
-\r
-Returns:\r
- EFI_SUCCESS\r
- EFI_WARN_BUFFER_TOO_SMALL\r
- EFI_NOT_FOUND\r
- EFI_DEVICE_ERROR\r
- EFI_ACCESS_DENIED\r
- \r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *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
-/*++\r
-\r
-Routine Description:\r
- Read the requested section from the specified file and returns data in Buffer.\r
-\r
-Arguments:\r
- This - Calling context\r
- NameGuid - Filename identifying the file from which to read \r
- SectionType - Indicates what section type to retrieve\r
- SectionInstance - Indicates which instance of SectionType to retrieve\r
- Buffer - Pointer to pointer to buffer in which contents of file are returned.\r
- \r
- If Buffer is NULL, only type, attributes, and size are returned as\r
- there is no output buffer.\r
- \r
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
- from BS pool by ReadFile\r
- \r
- If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
- allocated by the caller and is being passed in.\r
- \r
- BufferSize - Indicates the buffer size passed in, and on output the size\r
- required to complete the read\r
- AuthenticationStatus - Indicates the authentication status of the data\r
-\r
-Returns:\r
- EFI_SUCCESS\r
- EFI_WARN_BUFFER_TOO_SMALL\r
- EFI_OUT_OF_RESOURCES\r
- EFI_NOT_FOUND\r
- EFI_DEVICE_ERROR\r
- EFI_ACCESS_DENIED\r
- \r
---*/\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *FV_WRITE_FILE) (\r
- IN EFI_FIRMWARE_VOLUME_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
-Routine Description:\r
- Write the supplied file (NameGuid) to the FV.\r
-\r
-Arguments:\r
- This - Calling context\r
- NumberOfFiles - Indicates the number of file records pointed to by FileData\r
- WritePolicy - Indicates the level of reliability of the write with respect to\r
- things like power failure events.\r
- 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
-Returns:\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES\r
- EFI_DEVICE_ERROR\r
- EFI_WRITE_PROTECTED\r
- EFI_NOT_FOUND\r
- EFI_INVALID_PARAMETER\r
- \r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *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
-\r
-Routine Description:\r
- Given the input key, search for the next matching file in the volume.\r
-\r
-Arguments:\r
- This - Calling context\r
- 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
- FileType - Indicates the file type to filter for\r
- NameGuid - Guid filename of the file found\r
- Attributes - Attributes of the file found\r
- Size - Size in bytes of the file found\r
-\r
-Returns:\r
- EFI_SUCCESS\r
- EFI_NOT_FOUND\r
- EFI_DEVICE_ERROR\r
- EFI_ACCESS_DENIED\r
-\r
---*/\r
-struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
- FV_GET_ATTRIBUTES GetVolumeAttributes;\r
- FV_SET_ATTRIBUTES SetVolumeAttributes;\r
- FV_READ_FILE ReadFile;\r
- FV_READ_SECTION ReadSection;\r
- FV_WRITE_FILE WriteFile;\r
- FV_GET_NEXT_FILE GetNextFile;\r
- UINT32 KeySize;\r
- EFI_HANDLE ParentHandle;\r
-};\r
-\r
-extern EFI_GUID gEfiFirmwareVolumeProtocolGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff