7675df016c3052d58eee58446f367ef0cbff03bb
[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareVolume.h
1 /** @file
2 The firmware volume related definitions in PI.
3
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 @par Revision Reference:
14 Version 1.0.
15
16 **/
17
18 #ifndef __PI_FIRMWAREVOLUME_H__
19 #define __PI_FIRMWAREVOLUME_H__
20
21 //
22 // EFI_FV_FILE_ATTRIBUTES
23 //
24 typedef UINT32 EFI_FV_FILE_ATTRIBUTES;
25
26 //
27 // Value of EFI_FV_FILE_ATTRIBUTES.
28 //
29 #define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F
30 #define EFI_FV_FILE_ATTRIB_FIXED 0x00000100
31 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200
32
33 typedef UINT32 EFI_FVB_ATTRIBUTES;
34
35 //
36 // Attributes bit definitions
37 //
38 #define EFI_FVB2_READ_DISABLED_CAP 0x00000001
39 #define EFI_FVB2_READ_ENABLED_CAP 0x00000002
40 #define EFI_FVB2_READ_STATUS 0x00000004
41 #define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008
42 #define EFI_FVB2_WRITE_ENABLED_CAP 0x00000010
43 #define EFI_FVB2_WRITE_STATUS 0x00000020
44 #define EFI_FVB2_LOCK_CAP 0x00000040
45 #define EFI_FVB2_LOCK_STATUS 0x00000080
46 #define EFI_FVB2_STICKY_WRITE 0x00000200
47 #define EFI_FVB2_MEMORY_MAPPED 0x00000400
48 #define EFI_FVB2_ERASE_POLARITY 0x00000800
49 #define EFI_FVB2_READ_LOCK_CAP 0x00001000
50 #define EFI_FVB2_READ_LOCK_STATUS 0x00002000
51 #define EFI_FVB2_WRITE_LOCK_CAP 0x00004000
52 #define EFI_FVB2_WRITE_LOCK_STATUS 0x00008000
53 #define EFI_FVB2_ALIGNMENT 0x001F0000
54 #define EFI_FVB2_ALIGNMENT_1 0x00000000
55 #define EFI_FVB2_ALIGNMENT_2 0x00010000
56 #define EFI_FVB2_ALIGNMENT_4 0x00020000
57 #define EFI_FVB2_ALIGNMENT_8 0x00030000
58 #define EFI_FVB2_ALIGNMENT_16 0x00040000
59 #define EFI_FVB2_ALIGNMENT_32 0x00050000
60 #define EFI_FVB2_ALIGNMENT_64 0x00060000
61 #define EFI_FVB2_ALIGNMENT_128 0x00070000
62 #define EFI_FVB2_ALIGNMENT_256 0x00080000
63 #define EFI_FVB2_ALIGNMENT_512 0x00090000
64 #define EFI_FVB2_ALIGNMENT_1K 0x000A0000
65 #define EFI_FVB2_ALIGNMENT_2K 0x000B0000
66 #define EFI_FVB2_ALIGNMENT_4K 0x000C0000
67 #define EFI_FVB2_ALIGNMENT_8K 0x000D0000
68 #define EFI_FVB2_ALIGNMENT_16K 0x000E0000
69 #define EFI_FVB2_ALIGNMENT_32K 0x000F0000
70 #define EFI_FVB2_ALIGNMENT_64K 0x00100000
71 #define EFI_FVB2_ALIGNMENT_128K 0x00110000
72 #define EFI_FVB2_ALIGNMENT_256K 0x00120000
73 #define EFI_FVB2_ALIGNMNET_512K 0x00130000
74 #define EFI_FVB2_ALIGNMENT_1M 0x00140000
75 #define EFI_FVB2_ALIGNMENT_2M 0x00150000
76 #define EFI_FVB2_ALIGNMENT_4M 0x00160000
77 #define EFI_FVB2_ALIGNMENT_8M 0x00170000
78 #define EFI_FVB2_ALIGNMENT_16M 0x00180000
79 #define EFI_FVB2_ALIGNMENT_32M 0x00190000
80 #define EFI_FVB2_ALIGNMENT_64M 0x001A0000
81 #define EFI_FVB2_ALIGNMENT_128M 0x001B0000
82 #define EFI_FVB2_ALIGNMENT_256M 0x001C0000
83 #define EFI_FVB2_ALIGNMENT_512M 0x001D0000
84 #define EFI_FVB2_ALIGNMENT_1G 0x001E0000
85 #define EFI_FVB2_ALIGNMENT_2G 0x001F0000
86
87
88 typedef struct {
89 UINT32 NumBlocks;
90 UINT32 Length;
91 } EFI_FV_BLOCK_MAP_ENTRY;
92
93 //
94 // Describes the features and layout of the firmware volume.
95 //
96 typedef struct {
97 UINT8 ZeroVector[16];
98 EFI_GUID FileSystemGuid;
99 UINT64 FvLength;
100 UINT32 Signature;
101 EFI_FVB_ATTRIBUTES Attributes;
102 UINT16 HeaderLength;
103 UINT16 Checksum;
104 UINT16 ExtHeaderOffset;
105 UINT8 Reserved[1];
106 UINT8 Revision;
107 EFI_FV_BLOCK_MAP_ENTRY BlockMap[1];
108 } EFI_FIRMWARE_VOLUME_HEADER;
109
110 #define EFI_FVH_SIGNATURE EFI_SIGNATURE_32 ('_', 'F', 'V', 'H')
111
112 ///
113 /// Firmware Volume Header Revision definition
114 ///
115 #define EFI_FVH_REVISION 0x02
116
117 //
118 // Extension header pointed by ExtHeaderOffset of volume header.
119 //
120 typedef struct {
121 EFI_GUID FvName;
122 UINT32 ExtHeaderSize;
123 } EFI_FIRMWARE_VOLUME_EXT_HEADER;
124
125 typedef struct {
126 UINT16 ExtEntrySize;
127 UINT16 ExtEntryType;
128 } EFI_FIRMWARE_VOLUME_EXT_ENTRY;
129
130 #define EFI_FV_EXT_TYPE_OEM_TYPE 0x01
131 typedef struct {
132 EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;
133 UINT32 TypeMask;
134
135 //
136 // Array of GUIDs.
137 // Each GUID represents an OEM file type.
138 //
139 EFI_GUID Types[1];
140 } EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;
141
142
143 #endif