guid-create: Build from crates.io on non-UEFI

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

Cargo.lock

@@ -34,14 +34,14 @@ spin = { version = "0.9.8" }
 no-std-compat = { version = "0.4.1", features = [ "alloc" ] }
 hidapi = { version = "2.6.3", features = [ "windows-native" ], optional = true }
 rusb = { version = "0.9.4", optional = true }
-guid-create = { git = "https://github.com/FrameworkComputer/guid-create", branch = "no-rand", default-features = false }
 
 [target.'cfg(target_os = "uefi")'.dependencies]
 uefi = { version = "0.20", features = ["alloc"] }
 uefi-services = "0.17"
 plain = "0.2.3"
 redox_hwio = { git = "https://github.com/FrameworkComputer/rust-hwio", branch = "freebsd", default-features = false }
 smbios-lib = { git = "https://github.com/FrameworkComputer/smbios-lib.git", branch = "no-std", default-features = false }
+guid-create-no-std = { package = "guid-create", git = "https://github.com/FrameworkComputer/guid-create", branch = "no_std", default-features = false }
 
 [target.'cfg(windows)'.dependencies]
 wmi = "0.15.0"
@@ -51,6 +51,7 @@ clap = { version = "4.5", features = ["derive", "cargo"] }
 clap-num = { version = "1.2.0" }
 clap-verbosity-flag = { version = "2.2.1" }
 windows-version = "0.1.4"
+guid-create = "0.4.1"
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2.155"
@@ -61,6 +62,7 @@ env_logger = "0.11"
 clap = { version = "4.5", features = ["derive", "cargo"] }
 clap-num = { version = "1.2.0" }
 clap-verbosity-flag = { version = "2.2.1" }
+guid-create = "0.4.1"
 
 [target.'cfg(windows)'.dependencies.windows]
 version = "0.59.0"

framework_lib/Cargo.toml

@@ -10,8 +10,8 @@
 
 use std::prelude::v1::*;
 
+use crate::guid::CGuid;
 use core::prelude::rust_2021::derive;
-use guid_create::Guid;
 #[cfg(not(feature = "uefi"))]
 use std::fs::File;
 #[cfg(not(feature = "uefi"))]
@@ -21,7 +21,7 @@ use std::io::prelude::*;
 #[repr(C)]
 pub struct EfiCapsuleHeader {
     /// A GUID that defines the contents of a capsule.
-    pub capsule_guid: Guid,
+    pub capsule_guid: CGuid,
 
     /// The size of the capsule header. This may be larger than the size of
     /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
@@ -205,14 +205,14 @@ mod tests {
         let data = fs::read(capsule_path).unwrap();
         let cap = parse_capsule_header(&data).unwrap();
         let expected_header = EfiCapsuleHeader {
-            capsule_guid: Guid::from(esrt::WINUX_GUID),
+            capsule_guid: CGuid::from(esrt::WINUX_GUID),
             header_size: 28,
             flags: 65536,
             capsule_image_size: 676898,
         };
         assert_eq!(cap, expected_header);
 
-        assert_eq!(cap.capsule_guid, Guid::from(esrt::WINUX_GUID));
+        assert_eq!(cap.capsule_guid, CGuid::from(esrt::WINUX_GUID));
         let ux_header = parse_ux_header(&data);
         assert_eq!(
             ux_header,

framework_lib/src/capsule.rs

@@ -3,11 +3,15 @@
 //! Can be easily re-used from any OS or UEFI shell.
 //! We have implemented both in the `framework_tool` and `framework_uefi` crates.
 
+use crate::guid::CGuid;
 use alloc::format;
 use alloc::string::String;
 use alloc::string::ToString;
 use alloc::vec::Vec;
-use guid_create::{Guid, GUID};
+#[cfg(not(feature = "uefi"))]
+use guid_create::GUID;
+#[cfg(feature = "uefi")]
+use guid_create_no_std::GUID;
 use log::Level;
 use num_traits::FromPrimitive;
 
@@ -1270,7 +1274,7 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
             println!("  Size:       {:>20} B", data.len());
             println!("  Size:       {:>20} KB", data.len() / 1024);
             if let Some(header) = analyze_capsule(&data) {
-                if header.capsule_guid == Guid::from(esrt::WINUX_GUID) {
+                if header.capsule_guid == CGuid::from(esrt::WINUX_GUID) {
                     let ux_header = capsule::parse_ux_header(&data);
                     if let Some(dump_path) = &args.dump {
                         // TODO: Better error handling, rather than just panicking

framework_lib/src/commandline/mod.rs

@@ -14,8 +14,12 @@
 use log::{debug, error, info, trace};
 use std::prelude::v1::*;
 
+use crate::guid::CGuid;
 use core::prelude::v1::derive;
-use guid_create::{Guid, GUID};
+#[cfg(not(feature = "uefi"))]
+use guid_create::GUID;
+#[cfg(feature = "uefi")]
+use guid_create_no_std::GUID;
 
 #[cfg(target_os = "linux")]
 use std::fs;
@@ -193,7 +197,7 @@ pub enum FrameworkGuidKind {
     Unknown,
 }
 
-pub fn match_guid_kind(guid: &Guid) -> FrameworkGuidKind {
+pub fn match_guid_kind(guid: &CGuid) -> FrameworkGuidKind {
     match GUID::from(*guid) {
         TGL_BIOS_GUID => FrameworkGuidKind::TglBios,
         ADL_BIOS_GUID => FrameworkGuidKind::AdlBios,
@@ -292,7 +296,7 @@ impl UpdateStatus {
 // TODO: Decode into proper Rust types
 #[derive(Clone)]
 pub struct EsrtResourceEntry {
-    pub fw_class: Guid,
+    pub fw_class: CGuid,
     pub fw_type: u32, // ResourceType
     pub fw_version: u32,
     pub lowest_supported_fw_version: u32,
@@ -364,7 +368,7 @@ fn esrt_from_sysfs(dir: &Path) -> io::Result<Esrt> {
                 let last_attempt_version = fs::read_to_string(path.join("last_attempt_version"))?;
                 let last_attempt_status = fs::read_to_string(path.join("last_attempt_status"))?;
                 let esrt = EsrtResourceEntry {
-                    fw_class: Guid::from(
+                    fw_class: CGuid::from(
                         GUID::parse(fw_class.trim()).expect("Kernel provided wrong value"),
                     ),
                     fw_type: fw_type
@@ -436,7 +440,7 @@ pub fn get_esrt() -> Option<Esrt> {
                 let ver_str = caps.get(2).unwrap().as_str().to_string();
 
                 let guid = GUID::parse(guid_str.trim()).expect("Kernel provided wrong value");
-                let guid_kind = match_guid_kind(&Guid::from(guid));
+                let guid_kind = match_guid_kind(&CGuid::from(guid));
                 let ver = u32::from_str_radix(&ver_str, 16).unwrap();
                 debug!("ESRT Entry {}", i);
                 debug!("  Name:    {:?}", guid_kind);
@@ -456,7 +460,7 @@ pub fn get_esrt() -> Option<Esrt> {
                 // TODO: The missing fields are present in Device Manager
                 // So there must be a way to get at them
                 let esrt = EsrtResourceEntry {
-                    fw_class: Guid::from(guid),
+                    fw_class: CGuid::from(guid),
                     fw_type,
                     fw_version: ver,
                     // TODO: Not exposed by windows
@@ -543,7 +547,7 @@ pub fn get_esrt() -> Option<Esrt> {
     for table in config_tables {
         // TODO: Why aren't they the same type?
         //debug!("Table: {:?}", table);
-        let table_guid: Guid = unsafe { std::mem::transmute(table.guid) };
+        let table_guid: CGuid = unsafe { std::mem::transmute(table.guid) };
         let table_guid = GUID::from(table_guid);
         match table_guid {
             SYSTEM_RESOURCE_TABLE_GUID => unsafe {

framework_lib/src/esrt/mod.rs

@@ -0,0 +1,56 @@
+use alloc::fmt;
+
+#[cfg(not(feature = "uefi"))]
+use guid_create::GUID;
+#[cfg(feature = "uefi")]
+use guid_create_no_std::GUID;
+
+// Until https://github.com/kurtlawrence/guid-create/pull/20 is merged
+
+impl From<CGuid> for GUID {
+    fn from(item: CGuid) -> Self {
+        GUID::build_from_components(item.a, item.b, item.c, &item.d)
+    }
+}
+
+impl From<GUID> for CGuid {
+    fn from(item: GUID) -> Self {
+        CGuid {
+            a: item.data1(),
+            b: item.data2(),
+            c: item.data3(),
+            d: item.data4(),
+        }
+    }
+}
+
+impl fmt::Display for CGuid {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(
+            f,
+            "{:08X}-{:04X}-{:04X}-{:04X}-{:08X}{:04X}",
+            self.a,
+            self.b,
+            self.c,
+            u16::from_be_bytes(self.d[0..2].try_into().unwrap()),
+            u32::from_be_bytes(self.d[2..6].try_into().unwrap()),
+            u16::from_be_bytes(self.d[6..8].try_into().unwrap()),
+        )
+    }
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Default, Hash)]
+#[repr(C)]
+pub struct CGuid {
+    /// The low field of the timestamp.
+    a: u32,
+    /// The middle field of the timestamp.
+    b: u16,
+    /// The high field of the timestamp multiplexed with the version number.
+    c: u16,
+    /// Contains, in this order:
+    /// - The high field of the clock sequence multiplexed with the variant.
+    /// - The low field of the clock sequence.
+    /// - The spatially unique node identifier.
+    d: [u8; 8],
+}

framework_lib/src/guid.rs

@@ -38,6 +38,7 @@ pub mod commandline;
 pub mod csme;
 pub mod ec_binary;
 pub mod esrt;
+pub mod guid;
 mod os_specific;
 pub mod power;
 pub mod smbios;