uefi_raw/
firmware_storage.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3//! Types related to firmware storage.
4
5use crate::Guid;
6use bitflags::bitflags;
7
8/// Corresponds to the C type `EFI_FIRMWARE_VOLUME_HEADER`.
9#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd)]
10#[repr(C)]
11pub struct FirmwareVolumeHeader {
12    pub zero_vector: [u8; 16],
13    pub file_system_guid: Guid,
14    pub fv_length: u64,
15    pub signature: [u8; 4],
16    pub attributes: FirmwareVolumeAttributes,
17    pub header_length: u16,
18    pub checksum: u16,
19    pub ext_header_offset: u16,
20    pub reserved: u8,
21    pub revision: u8,
22
23    /// Variable-length array of block maps, terminated with a zero-filled
24    /// entry.
25    pub block_map: [FirmwareVolumeBlockMap; 0],
26}
27
28impl FirmwareVolumeHeader {
29    pub const SIGNATURE: [u8; 4] = *b"_FVH";
30}
31
32/// Corresponds to the C type `EFI_FV_BLOCK_MAP`.
33#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
34#[repr(C)]
35pub struct FirmwareVolumeBlockMap {
36    pub num_blocks: u32,
37    pub length: u32,
38}
39
40bitflags! {
41    /// Corresponds to the C type `EFI_FVB_ATTRIBUTES_2`.
42    #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
43    #[repr(transparent)]
44    pub struct FirmwareVolumeAttributes: u32 {
45        const READ_DISABLED_CAP = 0x0000_0001;
46        const READ_ENABLED_CAP = 0x0000_0002;
47        const READ_STATUS = 0x0000_0004;
48
49        const WRITE_DISABLED_CAP = 0x0000_0008;
50        const WRITE_ENABLED_CAP = 0x0000_0010;
51        const WRITE_STATUS = 0x0000_0020;
52
53        const LOCK_CAP = 0x0000_0040;
54        const LOCK_STATUS = 0x0000_0080;
55
56        const STICKY_WRITE = 0x0000_0200;
57        const MEMORY_MAPPED = 0x0000_0400;
58        const ERASE_POLARITY = 0x0000_0800;
59
60        const READ_LOCK_CAP = 0x0000_1000;
61        const READ_LOCK_STATUS = 0x0000_2000;
62
63        const WRITE_LOCK_CAP = 0x0000_4000;
64        const WRITE_LOCK_STATUS = 0x0000_8000;
65
66        const ALIGNMENT = 0x001f_0000;
67        const WEAK_ALIGNMENT = 0x8000_0000;
68        const ALIGNMENT_1 = 0x0000_0000;
69        const ALIGNMENT_2 = 0x0001_0000;
70        const ALIGNMENT_4 = 0x0002_0000;
71        const ALIGNMENT_8 = 0x0003_0000;
72        const ALIGNMENT_16 = 0x0004_0000;
73        const ALIGNMENT_32 = 0x0005_0000;
74        const ALIGNMENT_64 = 0x0006_0000;
75        const ALIGNMENT_128 = 0x0007_0000;
76        const ALIGNMENT_256 = 0x0008_0000;
77        const ALIGNMENT_512 = 0x0008_0000;
78        const ALIGNMENT_1K = 0x000a_0000;
79        const ALIGNMENT_2K = 0x000b_0000;
80        const ALIGNMENT_4K = 0x000c_0000;
81        const ALIGNMENT_8K = 0x000d_0000;
82        const ALIGNMENT_16K = 0x000e_0000;
83        const ALIGNMENT_32K = 0x000f_0000;
84        const ALIGNMENT_64K = 0x0010_0000;
85        const ALIGNMENT_128K = 0x0011_0000;
86        const ALIGNMENT_256K = 0x0012_0000;
87        const ALIGNMENT_512K = 0x0013_0000;
88        const ALIGNMENT_1M = 0x0014_0000;
89        const ALIGNMENT_2M = 0x0015_0000;
90        const ALIGNMENT_4M = 0x0016_0000;
91        const ALIGNMENT_8M = 0x0017_0000;
92        const ALIGNMENT_16M = 0x0018_0000;
93        const ALIGNMENT_32M = 0x0019_0000;
94        const ALIGNMENT_64M = 0x001a_0000;
95        const ALIGNMENT_128M = 0x001b_0000;
96        const ALIGNMENT_256M = 0x001c_0000;
97        const ALIGNMENT_512M = 0x001d_0000;
98        const ALIGNMENT_1G = 0x001e_0000;
99        const ALIGNMENT_2G = 0x001f_0000;
100    }
101}
uefi_raw/firmware_storage.rs

uefi_raw/
firmware_storage.rs
