Merge pull request #1753 from seijikun/mr-hii-configrouting

uefi: Add bindings for the HII_CONFIG_ROUTING protocol

Author: phip1611

uefi-raw/CHANGELOG.md

@@ -20,6 +20,7 @@
   - `[u8; 32]`  --> `MacAddress`
   - `[u8; 4]`   --> `Ipv4Address`, `IpAddress`
   - `[u8; 16]`  --> `Ipv6Address`, `IpAddress`
+- Added `HiiConfigRoutingProtocol`.
 
 ## Changed
 - **Breaking:** The MSRV is now 1.85.1 and the crate uses the Rust 2024 edition.

uefi-raw/src/protocol/hii/config.rs

@@ -4,6 +4,7 @@
 
 use core::fmt::Debug;
 
+use crate::protocol::device_path::DevicePathProtocol;
 use crate::{Char16, Guid, Status, guid, newtype_enum};
 
 /// EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL
@@ -172,3 +173,50 @@ pub struct HiiConfigAccessProtocol {
 impl HiiConfigAccessProtocol {
     pub const GUID: Guid = guid!("330d4706-f2a0-4e4f-a369-b66fa8d54385");
 }
+
+/// EFI_HII_CONFIG_ROUTING_PROTOCOL
+#[derive(Debug)]
+#[repr(C)]
+pub struct HiiConfigRoutingProtocol {
+    pub extract_config: unsafe extern "efiapi" fn(
+        this: *const Self,
+        config_request: *const Char16,
+        progress: *mut *const Char16,
+        results: *mut *const Char16,
+    ) -> Status,
+    pub export_config:
+        unsafe extern "efiapi" fn(this: *const Self, results: *mut *const Char16) -> Status,
+    pub route_config: unsafe extern "efiapi" fn(
+        this: *const Self,
+        configuration: *const Char16,
+        progress: *mut *const Char16,
+    ) -> Status,
+    pub block_to_config: unsafe extern "efiapi" fn(
+        this: *const Self,
+        config_request: *const Char16,
+        block: *const u8,
+        block_size: usize,
+        config: *mut *const Char16,
+        progress: *mut *const Char16,
+    ) -> Status,
+    pub config_to_block: unsafe extern "efiapi" fn(
+        this: *const Self,
+        config_resp: *const Char16,
+        block: *mut *const u8,
+        block_size: *mut usize,
+        progress: *mut *const Char16,
+    ) -> Status,
+    pub get_alt_cfg: unsafe extern "efiapi" fn(
+        this: *const Self,
+        config_resp: *const Char16,
+        guid: *const Guid,
+        name: *const Char16,
+        device_path: *const DevicePathProtocol,
+        alt_cfg_id: *const Char16,
+        alt_cfg_resp: *mut *const Char16,
+    ) -> Status,
+}
+
+impl HiiConfigRoutingProtocol {
+    pub const GUID: Guid = guid!("587e72d7-cc50-4f79-8209-ca291fc1a10f");
+}

uefi/CHANGELOG.md

@@ -9,6 +9,8 @@
 - Added `proto::hii::config_str::ConfigurationString`.
 - Added `proto::acpi::AcpiTable`.
 - Added `proto::hii::database::HiiDatabase`.
+- Added `proto::hii::config_str::MultiConfigurationStringIter`.
+- Added `proto::hii::config_routing::HiiConfigRouting`.
 
 ## Changed
 - **Breaking:** `boot::stall` now take `core::time::Duration` instead of `usize`.

uefi/src/proto/hii/config_routing.rs

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! HII Configuration protocols.
+
+use core::ptr;
+
+use alloc::string::{String, ToString};
+use uefi_macros::unsafe_protocol;
+use uefi_raw::Char16;
+use uefi_raw::protocol::hii::config::HiiConfigRoutingProtocol;
+
+use crate::{CStr16, StatusExt};
+
+/// The HII Configuration Routing Protocol.
+///
+/// # UEFI Spec Description
+///
+/// The EFI HII Configuration Routing Protocol manages the movement of configuration
+/// data from drivers to configuration applications. It then serves as the single point
+/// to receive configuration information from configuration applications, routing the results
+/// to the appropriate drivers.
+#[derive(Debug)]
+#[repr(transparent)]
+#[unsafe_protocol(HiiConfigRoutingProtocol::GUID)]
+pub struct HiiConfigRouting(HiiConfigRoutingProtocol);
+impl HiiConfigRouting {
+    /// Request the current configuration for the entirety of the current HII database and
+    /// return the data as string in multi configuration string format.
+    ///
+    /// Use `super::config_str::MultiConfigurationStringIter` to parse the returned `String`.
+    pub fn export(&self) -> uefi::Result<String> {
+        unsafe {
+            let mut results: *const Char16 = ptr::null();
+            (self.0.export_config)(&self.0, &mut results)
+                .to_result_with_val(|| CStr16::from_ptr(results.cast()).to_string())
+        }
+    }
+}