From 2ba12ad1a7a98415846bd854c3328ae65ee20460 Mon Sep 17 00:00:00 2001
From: Nicholas Bishop <nbishop@nbishop.net>
Date: Sat, 2 Mar 2024 10:57:56 -0500
Subject: [PATCH] uefi_raw: Add firmware_storage module

This contains firmware storage types from the UEFI Platform Initialization
Specification. The firmware volume format is used, for example, for
`OVMF_VARS.fd`.
---
 uefi-raw/CHANGELOG.md            |  1 +
 uefi-raw/src/firmware_storage.rs | 99 ++++++++++++++++++++++++++++++++
 uefi-raw/src/lib.rs              |  1 +
 3 files changed, 101 insertions(+)
 create mode 100644 uefi-raw/src/firmware_storage.rs

diff --git a/uefi-raw/CHANGELOG.md b/uefi-raw/CHANGELOG.md
index a0a95d236..35092613b 100644
--- a/uefi-raw/CHANGELOG.md
+++ b/uefi-raw/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Added `ServiceBindingProtocol`, `Dhcp4Protocol`, `HttpProtocol`,
   `Ip4Config2Protocol`, `TlsConfigurationProtocol`, and related types.
 - Added `LoadFileProtocol` and `LoadFile2Protocol`.
+- Added `firmware_storage` module.
 
 # uefi-raw - 0.5.0 (2023-11-12)
 
diff --git a/uefi-raw/src/firmware_storage.rs b/uefi-raw/src/firmware_storage.rs
new file mode 100644
index 000000000..85dbe98a4
--- /dev/null
+++ b/uefi-raw/src/firmware_storage.rs
@@ -0,0 +1,99 @@
+//! Types related to firmware storage.
+
+use crate::Guid;
+use bitflags::bitflags;
+
+/// Corresponds to the C type `EFI_FIRMWARE_VOLUME_HEADER`.
+#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd)]
+#[repr(C)]
+pub struct FirmwareVolumeHeader {
+    pub zero_vector: [u8; 16],
+    pub file_system_guid: Guid,
+    pub fv_length: u64,
+    pub signature: [u8; 4],
+    pub attributes: FirmwareVolumeAttributes,
+    pub header_length: u16,
+    pub checksum: u16,
+    pub ext_header_offset: u16,
+    pub reserved: u8,
+    pub revision: u8,
+
+    /// Variable-length array of block maps, terminated with a zero-filled
+    /// entry.
+    pub block_map: [FirmwareVolumeBlockMap; 0],
+}
+
+impl FirmwareVolumeHeader {
+    pub const SIGNATURE: [u8; 4] = *b"_FVH";
+}
+
+/// Corresponds to the C type `EFI_FV_BLOCK_MAP`.
+#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
+#[repr(C)]
+pub struct FirmwareVolumeBlockMap {
+    pub num_blocks: u32,
+    pub length: u32,
+}
+
+bitflags! {
+    /// Corresponds to the C type `EFI_FVB_ATTRIBUTES_2`.
+    #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
+    #[repr(transparent)]
+    pub struct FirmwareVolumeAttributes: u32 {
+        const READ_DISABLED_CAP = 0x0000_0001;
+        const READ_ENABLED_CAP = 0x0000_0002;
+        const READ_STATUS = 0x0000_0004;
+
+        const WRITE_DISABLED_CAP = 0x0000_0008;
+        const WRITE_ENABLED_CAP = 0x0000_0010;
+        const WRITE_STATUS = 0x0000_0020;
+
+        const LOCK_CAP = 0x0000_0040;
+        const LOCK_STATUS = 0x0000_0080;
+
+        const STICKY_WRITE = 0x0000_0200;
+        const MEMORY_MAPPED = 0x0000_0400;
+        const ERASE_POLARITY = 0x0000_0800;
+
+        const READ_LOCK_CAP = 0x0000_1000;
+        const READ_LOCK_STATUS = 0x0000_2000;
+
+        const WRITE_LOCK_CAP = 0x0000_4000;
+        const WRITE_LOCK_STATUS = 0x0000_8000;
+
+        const ALIGNMENT = 0x001f_0000;
+        const WEAK_ALIGNMENT = 0x8000_0000;
+        const ALIGNMENT_1 = 0x0000_0000;
+        const ALIGNMENT_2 = 0x0001_0000;
+        const ALIGNMENT_4 = 0x0002_0000;
+        const ALIGNMENT_8 = 0x0003_0000;
+        const ALIGNMENT_16 = 0x0004_0000;
+        const ALIGNMENT_32 = 0x0005_0000;
+        const ALIGNMENT_64 = 0x0006_0000;
+        const ALIGNMENT_128 = 0x0007_0000;
+        const ALIGNMENT_256 = 0x0008_0000;
+        const ALIGNMENT_512 = 0x0008_0000;
+        const ALIGNMENT_1K = 0x000a_0000;
+        const ALIGNMENT_2K = 0x000b_0000;
+        const ALIGNMENT_4K = 0x000c_0000;
+        const ALIGNMENT_8K = 0x000d_0000;
+        const ALIGNMENT_16K = 0x000e_0000;
+        const ALIGNMENT_32K = 0x000f_0000;
+        const ALIGNMENT_64K = 0x0010_0000;
+        const ALIGNMENT_128K = 0x0011_0000;
+        const ALIGNMENT_256K = 0x0012_0000;
+        const ALIGNMENT_512K = 0x0013_0000;
+        const ALIGNMENT_1M = 0x0014_0000;
+        const ALIGNMENT_2M = 0x0015_0000;
+        const ALIGNMENT_4M = 0x0016_0000;
+        const ALIGNMENT_8M = 0x0017_0000;
+        const ALIGNMENT_16M = 0x0018_0000;
+        const ALIGNMENT_32M = 0x0019_0000;
+        const ALIGNMENT_64M = 0x001a_0000;
+        const ALIGNMENT_128M = 0x001b_0000;
+        const ALIGNMENT_256M = 0x001c_0000;
+        const ALIGNMENT_512M = 0x001d_0000;
+        const ALIGNMENT_1G = 0x001e_0000;
+        const ALIGNMENT_2G = 0x001f_0000;
+    }
+}
diff --git a/uefi-raw/src/lib.rs b/uefi-raw/src/lib.rs
index 0340d1068..003dd9584 100644
--- a/uefi-raw/src/lib.rs
+++ b/uefi-raw/src/lib.rs
@@ -19,6 +19,7 @@
 mod enums;
 
 pub mod capsule;
+pub mod firmware_storage;
 pub mod protocol;
 pub mod table;
 pub mod time;