ShellParams: Add protocol

Useful to get the shell arguments for a commandline application.

Signed-off-by: Daniel Schaefer <[email protected]>

Author: JohnAZoidberg

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Added `core::error::Error` implementations to all error types.
 - `SystemTable::exit_boot_services` now takes one param `memory_type` to ensure
   the memory type of memory map.
+- Added the `ShellParams` protocol
 
 ### Removed
 - `BootServices::memmove` and `BootServices::set_mem` have been removed, use

uefi-raw/src/protocol/mod.rs

@@ -12,3 +12,4 @@ pub mod driver;
 pub mod loaded_image;
 pub mod memory_protection;
 pub mod rng;
+pub mod shell_params;

uefi-raw/src/protocol/shell_params.rs

@@ -0,0 +1,23 @@
+use crate::{guid, Char16, Guid};
+use core::ffi::c_void;
+
+pub type ShellFileHandle = *const c_void;
+
+#[derive(Debug)]
+#[repr(C)]
+pub struct ShellParametersProtocol {
+    /// Pointer to a list of arguments.
+    pub argv: *const *const Char16,
+    /// Number of arguments.
+    pub argc: usize,
+    /// Handle of the standard input.
+    pub std_in: ShellFileHandle,
+    /// Handle of the standard output.
+    pub std_out: ShellFileHandle,
+    /// Handle of the standard error output.
+    pub std_err: ShellFileHandle,
+}
+
+impl ShellParametersProtocol {
+    pub const GUID: Guid = guid!("752f3136-4e16-4fdc-a22a-e5f46812f4ca");
+}

uefi/src/proto/mod.rs

@@ -76,6 +76,7 @@ pub mod network;
 pub mod pi;
 pub mod rng;
 pub mod security;
+pub mod shell_params;
 pub mod shim;
 pub mod string;
 pub mod tcg;

uefi/src/proto/shell_params.rs

@@ -0,0 +1,40 @@
+//! `ShellParams` protocol
+
+use crate::proto::unsafe_protocol;
+use crate::{data_types, Char16};
+use core::slice::from_raw_parts;
+use uefi_raw::protocol::shell_params::ShellParametersProtocol;
+
+use crate::CStr16;
+
+/// The ShellParameters protocol.
+#[derive(Debug)]
+#[repr(transparent)]
+#[unsafe_protocol(ShellParametersProtocol::GUID)]
+pub struct ShellParameters(ShellParametersProtocol);
+
+impl ShellParameters {
+    /// Get the number of shell parameter arguments
+    #[must_use]
+    pub fn args_len(&self) -> usize {
+        self.0.argc
+    }
+
+    /// Get an iterator of the shell parameter arguments
+    pub fn args(&self) -> impl Iterator<Item = &CStr16> {
+        self.args_slice()
+            .iter()
+            .map(|x| unsafe { CStr16::from_ptr(*x) })
+    }
+
+    /// Get a slice of the args, as Char16 pointers
+    #[must_use]
+    fn args_slice(&self) -> &[*const Char16] {
+        unsafe {
+            from_raw_parts(
+                self.0.argv.cast::<*const data_types::chars::Char16>(),
+                self.0.argc,
+            )
+        }
+    }
+}