]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | Defines data structure that is the volume header found at the beginning of\r | |
3 | all firmware volumes that are either memory mapped, or have an\r | |
4 | associated FirmwareVolumeBlock protocol.\r | |
5 | \r | |
6 | Copyright (c) 2006, Intel Corporation \r | |
7 | All rights reserved. This program and the accompanying materials \r | |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php \r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
14 | \r | |
15 | Module Name: FirmwareVolumeHeader.h\r | |
16 | \r | |
17 | @par Revision Reference:\r | |
18 | These definitions are from Firmware Volume Block Spec 0.9.\r | |
19 | \r | |
20 | **/\r | |
21 | \r | |
22 | #ifndef __EFI_FIRMWARE_VOLUME_HEADER_H__\r | |
23 | #define __EFI_FIRMWARE_VOLUME_HEADER_H__\r | |
24 | \r | |
25 | //\r | |
26 | // Firmware Volume Block Attributes definition\r | |
27 | //\r | |
28 | typedef UINT32 EFI_FVB_ATTRIBUTES;\r | |
29 | \r | |
30 | //\r | |
31 | // Firmware Volume Block Attributes bit definitions\r | |
32 | //\r | |
33 | #define EFI_FVB_READ_DISABLED_CAP 0x00000001\r | |
34 | #define EFI_FVB_READ_ENABLED_CAP 0x00000002\r | |
35 | #define EFI_FVB_READ_STATUS 0x00000004\r | |
36 | \r | |
37 | #define EFI_FVB_WRITE_DISABLED_CAP 0x00000008\r | |
38 | #define EFI_FVB_WRITE_ENABLED_CAP 0x00000010\r | |
39 | #define EFI_FVB_WRITE_STATUS 0x00000020\r | |
40 | \r | |
41 | #define EFI_FVB_LOCK_CAP 0x00000040\r | |
42 | #define EFI_FVB_LOCK_STATUS 0x00000080\r | |
43 | \r | |
44 | #define EFI_FVB_STICKY_WRITE 0x00000200\r | |
45 | #define EFI_FVB_MEMORY_MAPPED 0x00000400\r | |
46 | #define EFI_FVB_ERASE_POLARITY 0x00000800\r | |
47 | \r | |
48 | #define EFI_FVB_ALIGNMENT_CAP 0x00008000\r | |
49 | #define EFI_FVB_ALIGNMENT_2 0x00010000\r | |
50 | #define EFI_FVB_ALIGNMENT_4 0x00020000\r | |
51 | #define EFI_FVB_ALIGNMENT_8 0x00040000\r | |
52 | #define EFI_FVB_ALIGNMENT_16 0x00080000\r | |
53 | #define EFI_FVB_ALIGNMENT_32 0x00100000\r | |
54 | #define EFI_FVB_ALIGNMENT_64 0x00200000\r | |
55 | #define EFI_FVB_ALIGNMENT_128 0x00400000\r | |
56 | #define EFI_FVB_ALIGNMENT_256 0x00800000\r | |
57 | #define EFI_FVB_ALIGNMENT_512 0x01000000\r | |
58 | #define EFI_FVB_ALIGNMENT_1K 0x02000000\r | |
59 | #define EFI_FVB_ALIGNMENT_2K 0x04000000\r | |
60 | #define EFI_FVB_ALIGNMENT_4K 0x08000000\r | |
61 | #define EFI_FVB_ALIGNMENT_8K 0x10000000\r | |
62 | #define EFI_FVB_ALIGNMENT_16K 0x20000000\r | |
63 | #define EFI_FVB_ALIGNMENT_32K 0x40000000\r | |
64 | #define EFI_FVB_ALIGNMENT_64K 0x80000000\r | |
65 | \r | |
66 | #define EFI_FVB_CAPABILITIES (EFI_FVB_READ_DISABLED_CAP | \\r | |
67 | EFI_FVB_READ_ENABLED_CAP | \\r | |
68 | EFI_FVB_WRITE_DISABLED_CAP | \\r | |
69 | EFI_FVB_WRITE_ENABLED_CAP | \\r | |
70 | EFI_FVB_LOCK_CAP \\r | |
71 | )\r | |
72 | \r | |
5b664244 LG |
73 | #define EFI_TEST_FFS_ATTRIBUTES_BIT(FvbAttributes, TestAttributes, Bit) \\r |
74 | ( \\r | |
75 | (BOOLEAN) ( \\r | |
76 | (FvbAttributes & EFI_FVB_ERASE_POLARITY) ? (((~TestAttributes) & Bit) == Bit) : ((TestAttributes & Bit) == Bit) \\r | |
77 | ) \\r | |
78 | )\r | |
79 | \r | |
878ddf1f | 80 | #define EFI_FVB_STATUS (EFI_FVB_READ_STATUS | EFI_FVB_WRITE_STATUS | EFI_FVB_LOCK_STATUS)\r |
81 | \r | |
82 | ///\r | |
83 | /// Firmware Volume Header Revision definition\r | |
84 | ///\r | |
85 | #define EFI_FVH_REVISION 0x01\r | |
86 | \r | |
87 | ///\r | |
88 | /// Firmware Volume Header Signature definition\r | |
89 | ///\r | |
90 | #define EFI_FVH_SIGNATURE EFI_SIGNATURE_32 ('_', 'F', 'V', 'H')\r | |
91 | \r | |
92 | ///\r | |
93 | /// Firmware Volume Header Block Map Entry definition\r | |
94 | ///\r | |
95 | typedef struct {\r | |
96 | UINT32 NumBlocks;\r | |
97 | UINT32 BlockLength;\r | |
98 | } EFI_FV_BLOCK_MAP_ENTRY;\r | |
99 | \r | |
100 | ///\r | |
101 | /// Firmware Volume Header definition\r | |
102 | ///\r | |
103 | typedef struct {\r | |
104 | UINT8 ZeroVector[16];\r | |
105 | EFI_GUID FileSystemGuid;\r | |
106 | UINT64 FvLength;\r | |
107 | UINT32 Signature;\r | |
108 | EFI_FVB_ATTRIBUTES Attributes;\r | |
109 | UINT16 HeaderLength;\r | |
110 | UINT16 Checksum;\r | |
111 | UINT8 Reserved[3];\r | |
112 | UINT8 Revision;\r | |
113 | EFI_FV_BLOCK_MAP_ENTRY FvBlockMap[1];\r | |
114 | } EFI_FIRMWARE_VOLUME_HEADER;\r | |
115 | \r | |
116 | #endif\r |