]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/Pi/PiFirmwareVolume.h
ArmPlatformPkg/PL111LcdArmVExpressLib: use write-combine mapping for VRAM
[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareVolume.h
... / ...
CommitLineData
1/** @file\r
2 The firmware volume related definitions in PI.\r
3\r
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13 @par Revision Reference:\r
14 PI Version 1.3\r
15\r
16**/\r
17\r
18#ifndef __PI_FIRMWAREVOLUME_H__\r
19#define __PI_FIRMWAREVOLUME_H__\r
20\r
21///\r
22/// EFI_FV_FILE_ATTRIBUTES\r
23///\r
24typedef UINT32 EFI_FV_FILE_ATTRIBUTES;\r
25\r
26//\r
27// Value of EFI_FV_FILE_ATTRIBUTES.\r
28//\r
29#define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F\r
30#define EFI_FV_FILE_ATTRIB_FIXED 0x00000100\r
31#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200\r
32\r
33///\r
34/// type of EFI FVB attribute\r
35///\r
36typedef UINT32 EFI_FVB_ATTRIBUTES_2;\r
37\r
38//\r
39// Attributes bit definitions\r
40//\r
41#define EFI_FVB2_READ_DISABLED_CAP 0x00000001\r
42#define EFI_FVB2_READ_ENABLED_CAP 0x00000002\r
43#define EFI_FVB2_READ_STATUS 0x00000004\r
44#define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008\r
45#define EFI_FVB2_WRITE_ENABLED_CAP 0x00000010\r
46#define EFI_FVB2_WRITE_STATUS 0x00000020\r
47#define EFI_FVB2_LOCK_CAP 0x00000040\r
48#define EFI_FVB2_LOCK_STATUS 0x00000080\r
49#define EFI_FVB2_STICKY_WRITE 0x00000200\r
50#define EFI_FVB2_MEMORY_MAPPED 0x00000400\r
51#define EFI_FVB2_ERASE_POLARITY 0x00000800\r
52#define EFI_FVB2_READ_LOCK_CAP 0x00001000\r
53#define EFI_FVB2_READ_LOCK_STATUS 0x00002000\r
54#define EFI_FVB2_WRITE_LOCK_CAP 0x00004000\r
55#define EFI_FVB2_WRITE_LOCK_STATUS 0x00008000\r
56#define EFI_FVB2_ALIGNMENT 0x001F0000\r
57#define EFI_FVB2_ALIGNMENT_1 0x00000000\r
58#define EFI_FVB2_ALIGNMENT_2 0x00010000\r
59#define EFI_FVB2_ALIGNMENT_4 0x00020000\r
60#define EFI_FVB2_ALIGNMENT_8 0x00030000\r
61#define EFI_FVB2_ALIGNMENT_16 0x00040000\r
62#define EFI_FVB2_ALIGNMENT_32 0x00050000\r
63#define EFI_FVB2_ALIGNMENT_64 0x00060000\r
64#define EFI_FVB2_ALIGNMENT_128 0x00070000\r
65#define EFI_FVB2_ALIGNMENT_256 0x00080000\r
66#define EFI_FVB2_ALIGNMENT_512 0x00090000\r
67#define EFI_FVB2_ALIGNMENT_1K 0x000A0000\r
68#define EFI_FVB2_ALIGNMENT_2K 0x000B0000\r
69#define EFI_FVB2_ALIGNMENT_4K 0x000C0000\r
70#define EFI_FVB2_ALIGNMENT_8K 0x000D0000\r
71#define EFI_FVB2_ALIGNMENT_16K 0x000E0000\r
72#define EFI_FVB2_ALIGNMENT_32K 0x000F0000\r
73#define EFI_FVB2_ALIGNMENT_64K 0x00100000\r
74#define EFI_FVB2_ALIGNMENT_128K 0x00110000\r
75#define EFI_FVB2_ALIGNMENT_256K 0x00120000\r
76#define EFI_FVB2_ALIGNMENT_512K 0x00130000\r
77#define EFI_FVB2_ALIGNMENT_1M 0x00140000\r
78#define EFI_FVB2_ALIGNMENT_2M 0x00150000\r
79#define EFI_FVB2_ALIGNMENT_4M 0x00160000\r
80#define EFI_FVB2_ALIGNMENT_8M 0x00170000\r
81#define EFI_FVB2_ALIGNMENT_16M 0x00180000\r
82#define EFI_FVB2_ALIGNMENT_32M 0x00190000\r
83#define EFI_FVB2_ALIGNMENT_64M 0x001A0000\r
84#define EFI_FVB2_ALIGNMENT_128M 0x001B0000\r
85#define EFI_FVB2_ALIGNMENT_256M 0x001C0000\r
86#define EFI_FVB2_ALIGNMENT_512M 0x001D0000\r
87#define EFI_FVB2_ALIGNMENT_1G 0x001E0000\r
88#define EFI_FVB2_ALIGNMENT_2G 0x001F0000\r
89#define EFI_FVB2_WEAK_ALIGNMENT 0x80000000\r
90\r
91typedef struct {\r
92 ///\r
93 /// The number of sequential blocks which are of the same size.\r
94 ///\r
95 UINT32 NumBlocks;\r
96 ///\r
97 /// The size of the blocks.\r
98 ///\r
99 UINT32 Length;\r
100} EFI_FV_BLOCK_MAP_ENTRY;\r
101\r
102///\r
103/// Describes the features and layout of the firmware volume.\r
104///\r
105typedef struct {\r
106 ///\r
107 /// The first 16 bytes are reserved to allow for the reset vector of\r
108 /// processors whose reset vector is at address 0.\r
109 ///\r
110 UINT8 ZeroVector[16];\r
111 ///\r
112 /// Declares the file system with which the firmware volume is formatted.\r
113 ///\r
114 EFI_GUID FileSystemGuid;\r
115 ///\r
116 /// Length in bytes of the complete firmware volume, including the header.\r
117 ///\r
118 UINT64 FvLength;\r
119 ///\r
120 /// Set to EFI_FVH_SIGNATURE\r
121 ///\r
122 UINT32 Signature;\r
123 ///\r
124 /// Declares capabilities and power-on defaults for the firmware volume.\r
125 ///\r
126 EFI_FVB_ATTRIBUTES_2 Attributes;\r
127 ///\r
128 /// Length in bytes of the complete firmware volume header.\r
129 ///\r
130 UINT16 HeaderLength;\r
131 ///\r
132 /// A 16-bit checksum of the firmware volume header. A valid header sums to zero.\r
133 ///\r
134 UINT16 Checksum;\r
135 ///\r
136 /// Offset, relative to the start of the header, of the extended header\r
137 /// (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is no extended header.\r
138 ///\r
139 UINT16 ExtHeaderOffset;\r
140 ///\r
141 /// This field must always be set to zero.\r
142 ///\r
143 UINT8 Reserved[1];\r
144 ///\r
145 /// Set to 2. Future versions of this specification may define new header fields and will\r
146 /// increment the Revision field accordingly.\r
147 ///\r
148 UINT8 Revision;\r
149 ///\r
150 /// An array of run-length encoded FvBlockMapEntry structures. The array is\r
151 /// terminated with an entry of {0,0}.\r
152 ///\r
153 EFI_FV_BLOCK_MAP_ENTRY BlockMap[1];\r
154} EFI_FIRMWARE_VOLUME_HEADER;\r
155\r
156#define EFI_FVH_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', 'H')\r
157\r
158///\r
159/// Firmware Volume Header Revision definition\r
160///\r
161#define EFI_FVH_REVISION 0x02\r
162\r
163///\r
164/// Extension header pointed by ExtHeaderOffset of volume header.\r
165///\r
166typedef struct {\r
167 ///\r
168 /// Firmware volume name.\r
169 ///\r
170 EFI_GUID FvName;\r
171 ///\r
172 /// Size of the rest of the extension header, including this structure.\r
173 ///\r
174 UINT32 ExtHeaderSize;\r
175} EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
176\r
177///\r
178/// Entry struture for describing FV extension header\r
179///\r
180typedef struct {\r
181 ///\r
182 /// Size of this header extension.\r
183 ///\r
184 UINT16 ExtEntrySize;\r
185 ///\r
186 /// Type of the header.\r
187 ///\r
188 UINT16 ExtEntryType;\r
189} EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
190\r
191#define EFI_FV_EXT_TYPE_OEM_TYPE 0x01\r
192///\r
193/// This extension header provides a mapping between a GUID and an OEM file type.\r
194///\r
195typedef struct {\r
196 ///\r
197 /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.\r
198 ///\r
199 EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
200 ///\r
201 /// A bit mask, one bit for each file type between 0xC0 (bit 0) and 0xDF (bit 31). If a bit\r
202 /// is '1', then the GUID entry exists in Types. If a bit is '0' then no GUID entry exists in Types.\r
203 ///\r
204 UINT32 TypeMask;\r
205 ///\r
206 /// An array of GUIDs, each GUID representing an OEM file type.\r
207 ///\r
208 /// EFI_GUID Types[1];\r
209 ///\r
210} EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;\r
211\r
212#define EFI_FV_EXT_TYPE_GUID_TYPE 0x0002\r
213\r
214///\r
215/// This extension header EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE provides a vendor specific\r
216/// GUID FormatType type which includes a length and a successive series of data bytes.\r
217///\r
218typedef struct {\r
219 ///\r
220 /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.\r
221 ///\r
222 EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
223 ///\r
224 /// Vendor-specific GUID.\r
225 ///\r
226 EFI_GUID FormatType;\r
227 ///\r
228 /// An arry of bytes of length Length.\r
229 ///\r
230 /// UINT8 Data[1];\r
231 ///\r
232} EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE;\r
233\r
234#endif\r