Add (partial) safe protocol implementation for EFI_HII_DATABASE_PROTOCOL

This only grants access to the HII-database's raw buffer for now.

Author: seijikun

uefi/CHANGELOG.md

@@ -7,6 +7,7 @@
 - Added `proto::hii::config::ConfigKeywordHandler`.
 - Added `proto::hii::config::HiiConfigAccess`.
 - Added `proto::hii::config_str::ConfigurationString`.
+- Added `proto::hii::database::HiiDatabase`.
 
 ## Changed
 - **Breaking:** `boot::stall` now take `core::time::Duration` instead of `usize`.

uefi/src/proto/hii/database.rs

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! HII Database protocol.
+
+use alloc::vec::Vec;
+use uefi_macros::unsafe_protocol;
+use uefi_raw::Status;
+use uefi_raw::protocol::hii::database::HiiDatabaseProtocol;
+
+use crate::StatusExt;
+
+/// The HII Configuration Access Protocol.
+///
+/// # UEFI Spec Description
+///
+/// Database manager for HII-related data structures.
+#[derive(Debug)]
+#[repr(transparent)]
+#[unsafe_protocol(HiiDatabaseProtocol::GUID)]
+pub struct HiiDatabase(HiiDatabaseProtocol);
+
+impl HiiDatabase {
+    /// Export all package lists as raw byte buffer.
+    #[must_use]
+    pub fn export_all_raw(&self) -> crate::Result<Vec<u8>> {
+        // call the function with a buffer_size of 0 first, so it will fail with
+        // BUFFER_TOO_SMALL to tell us what size is required.
+        let mut buffer_size = 0;
+        unsafe {
+            let result = (self.0.export_package_lists)(
+                &self.0,
+                core::ptr::null_mut(),
+                &mut buffer_size,
+                core::ptr::null_mut(),
+            );
+            assert_eq!(result, Status::BUFFER_TOO_SMALL);
+        }
+
+        // allocate buffer with the requested size and call the method again
+        let mut buffer = Vec::with_capacity(buffer_size);
+        buffer.resize(buffer_size, 0u8);
+        unsafe {
+            (self.0.export_package_lists)(
+                &self.0,
+                core::ptr::null_mut(),
+                &mut buffer_size,
+                buffer.as_mut_ptr().cast(),
+            )
+            .to_result_with_val(|| buffer)
+        }
+    }
+}

uefi/src/proto/hii/mod.rs

@@ -5,3 +5,5 @@
 pub mod config;
 #[cfg(feature = "alloc")]
 pub mod config_str;
+#[cfg(feature = "alloc")]
+pub mod database;