| 7854d05f |
1 | /** @file\r |
| f22f941e |
2 | Defines the data structure that is the volume header found at the beginning of\r |
| 7854d05f |
3 | all firmware volumes that are either memory mapped or have an\r |
| 4 | associated FirmwareVolumeBlock protocol.\r |
| 5 | \r |
| 1c2f052d |
6 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 22a69a5e |
7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 7854d05f |
8 | \r |
| 9 | @par Revision Reference:\r |
| f22f941e |
10 | These definitions are from the Firmware Volume Block Spec 0.9.\r |
| 7854d05f |
11 | \r |
| 12 | **/\r |
| 13 | \r |
| 14 | #ifndef __EFI_FIRMWARE_VOLUME_HEADER_H__\r |
| 15 | #define __EFI_FIRMWARE_VOLUME_HEADER_H__\r |
| 16 | \r |
| 17 | ///\r |
| f22f941e |
18 | /// Firmware Volume Block Attributes bit definitions.\r |
| 7854d05f |
19 | ///@{\r |
| 20 | #define EFI_FVB_READ_DISABLED_CAP 0x00000001\r |
| 21 | #define EFI_FVB_READ_ENABLED_CAP 0x00000002\r |
| 22 | #define EFI_FVB_READ_STATUS 0x00000004\r |
| 23 | \r |
| 24 | #define EFI_FVB_WRITE_DISABLED_CAP 0x00000008\r |
| 25 | #define EFI_FVB_WRITE_ENABLED_CAP 0x00000010\r |
| 26 | #define EFI_FVB_WRITE_STATUS 0x00000020\r |
| 27 | \r |
| 28 | #define EFI_FVB_LOCK_CAP 0x00000040\r |
| 29 | #define EFI_FVB_LOCK_STATUS 0x00000080\r |
| 30 | \r |
| 31 | #define EFI_FVB_STICKY_WRITE 0x00000200\r |
| 32 | #define EFI_FVB_MEMORY_MAPPED 0x00000400\r |
| 33 | #define EFI_FVB_ERASE_POLARITY 0x00000800\r |
| 34 | \r |
| 35 | #define EFI_FVB_ALIGNMENT_CAP 0x00008000\r |
| 36 | #define EFI_FVB_ALIGNMENT_2 0x00010000\r |
| 37 | #define EFI_FVB_ALIGNMENT_4 0x00020000\r |
| 38 | #define EFI_FVB_ALIGNMENT_8 0x00040000\r |
| 39 | #define EFI_FVB_ALIGNMENT_16 0x00080000\r |
| 40 | #define EFI_FVB_ALIGNMENT_32 0x00100000\r |
| 41 | #define EFI_FVB_ALIGNMENT_64 0x00200000\r |
| 42 | #define EFI_FVB_ALIGNMENT_128 0x00400000\r |
| 43 | #define EFI_FVB_ALIGNMENT_256 0x00800000\r |
| 44 | #define EFI_FVB_ALIGNMENT_512 0x01000000\r |
| 45 | #define EFI_FVB_ALIGNMENT_1K 0x02000000\r |
| 46 | #define EFI_FVB_ALIGNMENT_2K 0x04000000\r |
| 47 | #define EFI_FVB_ALIGNMENT_4K 0x08000000\r |
| 48 | #define EFI_FVB_ALIGNMENT_8K 0x10000000\r |
| 49 | #define EFI_FVB_ALIGNMENT_16K 0x20000000\r |
| 50 | #define EFI_FVB_ALIGNMENT_32K 0x40000000\r |
| 51 | #define EFI_FVB_ALIGNMENT_64K 0x80000000\r |
| 52 | ///@}\r |
| 53 | \r |
| 54 | /// This is a simple macro defined as the set of all FV Block Attributes signifying capabilities.\r |
| 55 | #define EFI_FVB_CAPABILITIES ( EFI_FVB_READ_DISABLED_CAP | \\r |
| 56 | EFI_FVB_READ_ENABLED_CAP | \\r |
| 57 | EFI_FVB_WRITE_DISABLED_CAP | \\r |
| 58 | EFI_FVB_WRITE_ENABLED_CAP | \\r |
| 59 | EFI_FVB_LOCK_CAP \\r |
| 60 | )\r |
| 61 | \r |
| f22f941e |
62 | /** A parameterized macro defining a boolean expression that tests the state of a particular bit.\r |
| 7854d05f |
63 | *\r |
| f22f941e |
64 | * @param FvbAttributes Indicates a test for CLEAR if EFI_FVB_ERASE_POLARITY is 1, else test for SET.\r |
| 7854d05f |
65 | *\r |
| 66 | * @param TestAttributes The set of bits to test.\r |
| 67 | *\r |
| 68 | * @param Bit A value indicating the bit(s) to test.\r |
| 69 | * If multiple bits are set, the logical OR of their tests is the expression's value.\r |
| 70 | **/\r |
| 71 | #define EFI_TEST_FFS_ATTRIBUTES_BIT( FvbAttributes, TestAttributes, Bit) \\r |
| 72 | ((BOOLEAN) \\r |
| 73 | ((FvbAttributes & EFI_FVB_ERASE_POLARITY) ? (((~TestAttributes) & Bit) == Bit) : ((TestAttributes & Bit) == Bit)) \\r |
| 74 | )\r |
| 75 | \r |
| f22f941e |
76 | /// A simple macro defined as the set of all FV Block Attribute bits that indicate status.\r |
| 7854d05f |
77 | #define EFI_FVB_STATUS (EFI_FVB_READ_STATUS | EFI_FVB_WRITE_STATUS | EFI_FVB_LOCK_STATUS)\r |
| 78 | \r |
| 79 | #endif /* __EFI_FIRMWARE_VOLUME_HEADER_H__ */\r |
projects / mirror_edk2.git / blame