uefi: Begin safe EFI_USB_IO_PROTOCOL bindings

Add the UsbIo wrapper and implement methods for the informative functions
provided by the protocol.

Author: JarlEvanson

uefi/src/proto/mod.rs

@@ -31,6 +31,7 @@ pub mod shell_params;
 pub mod shim;
 pub mod string;
 pub mod tcg;
+pub mod usb;
 
 mod boot_policy;
 

uefi/src/proto/usb/io.rs

@@ -0,0 +1,87 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! USB I/O protocol.
+
+use uefi_macros::unsafe_protocol;
+use uefi_raw::protocol::usb::io::UsbIoProtocol;
+
+use crate::data_types::PoolString;
+use crate::{Char16, Result, StatusExt};
+
+pub use uefi_raw::protocol::usb::io::{
+    ConfigDescriptor, DeviceDescriptor, EndpointDescriptor, InterfaceDescriptor,
+};
+
+/// USB I/O protocol.
+#[derive(Debug)]
+#[repr(transparent)]
+#[unsafe_protocol(UsbIoProtocol::GUID)]
+pub struct UsbIo(UsbIoProtocol);
+
+impl UsbIo {
+    /// Returns information about USB devices, including the device's class, subclass, and number
+    /// of configurations.
+    pub fn device_descriptor(&mut self) -> Result<DeviceDescriptor> {
+        let mut device_descriptor = unsafe { core::mem::zeroed() };
+
+        unsafe { (self.0.get_device_descriptor)(&mut self.0, &mut device_descriptor) }
+            .to_result_with_val(|| device_descriptor)
+    }
+
+    /// Returns information about the active configuration of the USB device.
+    pub fn config_descriptor(&mut self) -> Result<ConfigDescriptor> {
+        let mut config_descriptor = unsafe { core::mem::zeroed() };
+
+        unsafe { (self.0.get_config_descriptor)(&mut self.0, &mut config_descriptor) }
+            .to_result_with_val(|| config_descriptor)
+    }
+
+    /// Returns information about the interface of the USB device.
+    pub fn interface_descriptor(&mut self) -> Result<InterfaceDescriptor> {
+        let mut interface_descriptor = unsafe { core::mem::zeroed() };
+
+        unsafe { (self.0.get_interface_descriptor)(&mut self.0, &mut interface_descriptor) }
+            .to_result_with_val(|| interface_descriptor)
+    }
+
+    /// Returns information about the interface of the USB device.
+    pub fn endpoint_descriptor(&mut self, endpoint: u8) -> Result<EndpointDescriptor> {
+        let mut endpoint_descriptor = unsafe { core::mem::zeroed() };
+
+        unsafe { (self.0.get_endpoint_descriptor)(&mut self.0, endpoint, &mut endpoint_descriptor) }
+            .to_result_with_val(|| endpoint_descriptor)
+    }
+
+    /// Returns the string associated with `string_id` in the language associated with `lang_id`.
+    pub fn string_descriptor(&mut self, lang_id: u16, string_id: u8) -> Result<PoolString> {
+        let mut string_ptr = core::ptr::null_mut();
+
+        unsafe { (self.0.get_string_descriptor)(&mut self.0, lang_id, string_id, &mut string_ptr) }
+            .to_result()?;
+        unsafe { PoolString::new(string_ptr.cast::<Char16>()) }
+    }
+
+    /// Returns all of the language ID codes that the USB device supports.
+    pub fn supported_languages(&mut self) -> Result<&[u16]> {
+        let mut lang_id_table_ptr = core::ptr::null_mut();
+        let mut lang_id_table_size = 0;
+
+        unsafe {
+            (self.0.get_supported_languages)(
+                &mut self.0,
+                &mut lang_id_table_ptr,
+                &mut lang_id_table_size,
+            )
+        }
+        .to_result_with_val(|| unsafe {
+            core::slice::from_raw_parts(lang_id_table_ptr, usize::from(lang_id_table_size))
+        })
+    }
+
+    /// Resets and reconfigures the USB controller.
+    ///
+    /// This function should work for all USB devices except USB Hub Controllers.
+    pub fn port_reset(&mut self) -> Result {
+        unsafe { (self.0.port_reset)(&mut self.0) }.to_result()
+    }
+}

uefi/src/proto/usb/mod.rs

@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! USB I/O protocols.
+//!
+//! These protocols can be used to interact with and configure USB devices.
+
+pub mod io;