9a3f330c59b5cd3c51d03cc30a86ea15b230df8d
[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / FirmwareVolumeHeader.h
1 /** @file
2 Defines data structure that is the volume header found at the beginning of
3 all firmware volumes that are either memory mapped, or have an
4 associated FirmwareVolumeBlock protocol.
5
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 Module Name: FirmwareVolumeHeader.h
16
17 @par Revision Reference:
18 These definitions are from Firmware Volume Block Spec 0.9.
19
20 **/
21
22 #ifndef __EFI_FIRMWARE_VOLUME_HEADER_H__
23 #define __EFI_FIRMWARE_VOLUME_HEADER_H__
24
25 #include <FrameworkPei.h>
26
27 //
28 // Firmware Volume Block Attributes bit definitions
29 //
30 #define EFI_FVB_READ_DISABLED_CAP 0x00000001
31 #define EFI_FVB_READ_ENABLED_CAP 0x00000002
32 #define EFI_FVB_READ_STATUS 0x00000004
33
34 #define EFI_FVB_WRITE_DISABLED_CAP 0x00000008
35 #define EFI_FVB_WRITE_ENABLED_CAP 0x00000010
36 #define EFI_FVB_WRITE_STATUS 0x00000020
37
38 #define EFI_FVB_LOCK_CAP 0x00000040
39 #define EFI_FVB_LOCK_STATUS 0x00000080
40
41 #define EFI_FVB_STICKY_WRITE 0x00000200
42 #define EFI_FVB_MEMORY_MAPPED 0x00000400
43 #define EFI_FVB_ERASE_POLARITY 0x00000800
44
45 #define EFI_FVB_ALIGNMENT_CAP 0x00008000
46 #define EFI_FVB_ALIGNMENT_2 0x00010000
47 #define EFI_FVB_ALIGNMENT_4 0x00020000
48 #define EFI_FVB_ALIGNMENT_8 0x00040000
49 #define EFI_FVB_ALIGNMENT_16 0x00080000
50 #define EFI_FVB_ALIGNMENT_32 0x00100000
51 #define EFI_FVB_ALIGNMENT_64 0x00200000
52 #define EFI_FVB_ALIGNMENT_128 0x00400000
53 #define EFI_FVB_ALIGNMENT_256 0x00800000
54 #define EFI_FVB_ALIGNMENT_512 0x01000000
55 #define EFI_FVB_ALIGNMENT_1K 0x02000000
56 #define EFI_FVB_ALIGNMENT_2K 0x04000000
57 #define EFI_FVB_ALIGNMENT_4K 0x08000000
58 #define EFI_FVB_ALIGNMENT_8K 0x10000000
59 #define EFI_FVB_ALIGNMENT_16K 0x20000000
60 #define EFI_FVB_ALIGNMENT_32K 0x40000000
61 #define EFI_FVB_ALIGNMENT_64K 0x80000000
62
63 #define EFI_FVB_CAPABILITIES (EFI_FVB_READ_DISABLED_CAP | \
64 EFI_FVB_READ_ENABLED_CAP | \
65 EFI_FVB_WRITE_DISABLED_CAP | \
66 EFI_FVB_WRITE_ENABLED_CAP | \
67 EFI_FVB_LOCK_CAP \
68 )
69
70 #define EFI_TEST_FFS_ATTRIBUTES_BIT(FvbAttributes, TestAttributes, Bit) \
71 ( \
72 (BOOLEAN) ( \
73 (FvbAttributes & EFI_FVB_ERASE_POLARITY) ? (((~TestAttributes) & Bit) == Bit) : ((TestAttributes & Bit) == Bit) \
74 ) \
75 )
76
77 #define EFI_FVB_STATUS (EFI_FVB_READ_STATUS | EFI_FVB_WRITE_STATUS | EFI_FVB_LOCK_STATUS)
78
79 #endif