Allow building library with uefi support and without

Using `uefi` feature.
Going all the way to supporting `no_std` is more difficult and not
needed for me right now.

Tested:

- Build and run Linux command
  - `cargo build -p framework_tool && sudo target/debug/framework_tool -t`
  - `cargo build -p framework_tool && sudo target/debug/framework_tool -v`
- Build just the library
  - `cargo build -p framework_lib
- Run library tests
  - `cargo test -p framework_lib
- Run clippy
  - `cargo clippy -p framework_lib -p framework_tool`

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

Author: JohnAZoidberg

.github/workflows/ci.yml

@@ -12,16 +12,11 @@ jobs:
     - name: Setup Rust toolchain
       run: rustup show
 
-    - name: Build without optional features
+    - name: Build defaeult features
       uses: actions-rs/cargo@v1
       with:
         command: build
-
-    - name: Build with all features enabled
-      uses: actions-rs/cargo@v1
-      with:
-        command: build
-        args: --all-features
+        args: -p framework_lib -p framework_tool
 
   test:
     name: Test Suite
@@ -37,6 +32,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
+          args: -p framework_lib
 
   lints:
     name: Lints
@@ -57,4 +53,4 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
         command: clippy
-        args: -- -D warnings
+        args: -p framework_lib -p framework_tool -- -D warnings

.gitignore

@@ -1 +1,2 @@
 target/
+build/

Cargo.lock

@@ -3,6 +3,8 @@
 members = [
     # Linux and Windows tool to inspect and customize the system
     "framework_tool",
+    # UEFI tool to inspect and customize the system
+    "framework_uefi",
     # Catchall library that we'll probably want to split up further
     "framework_lib",
 ]

Cargo.toml

@@ -3,10 +3,10 @@ name = "framework_lib"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [features]
-default = []
+default = ["std", "linux_pio", "cros_ec_driver", "raw_pio" ]
+std = ["dep:regex", "dep:num", "dep:num-derive", "dep:num-traits", "dep:clap"]
+uefi = ["dep:redox_uefi_std"]
 # EC communication via Port I/O on Linux
 linux_pio = ["dep:libc"]
 # EC communication via raw Port I/O (e.g. UEFI or other ring 0 code)
@@ -15,18 +15,19 @@ raw_pio = []
 cros_ec_driver = ["dep:nix"]
 
 [dependencies]
-regex = "1.6.0" # TODO: Can update to 1.7.0
+regex = { version = "1.6.0", optional = true } # TODO: Can update to 1.7.0
 # TODO: This doesn't work on:
 # - Windows
 # - Linux when SecureBoot (Lockdown) is enabled
 # Need to use the driver in those cases
-redox_hwio = "0.1.6"
+redox_hwio = { version = "0.1.5", default_features = false }
 libc = { version = "0.2.137", optional = true }
-clap = { version = "4.0", features = ["derive"] }
+clap = { version = "4.0", features = ["derive"], optional = true }
 nix = { version = "0.25.0", optional = true }
-num = "0.4"
-num-derive = "0.3"
-num-traits = "0.2"
+num = { version = "0.4", optional = true }
+num-derive = { version = "0.3", optional = true }
+num-traits = { version = "0.2", optional = true }
+redox_uefi_std = { version = "0.1.8", optional = true }
 
 [dependencies.windows]
 optional = true

framework_lib/Cargo.toml

@@ -1,20 +1,26 @@
 use crate::util;
 
+#[cfg(not(feature = "uefi"))]
 use num_derive::FromPrimitive;
 #[cfg(feature = "cros_ec_driver")]
 mod cros_ec;
 mod portio;
 //mod windows;
 
+#[cfg(feature = "uefi")]
+use core::prelude::rust_2021::derive;
+
 /// Total size of EC memory mapped region
 const EC_MEMMAP_SIZE: u16 = 255;
 
 /// Command to read data from EC memory map
+#[cfg(feature = "cros_ec_driver")]
 const EC_CMD_READ_MEMMAP: u16 = 0x0007;
 
 /// Response codes returned by commands
-#[derive(FromPrimitive, Debug)]
-enum EcResponseStatus {
+#[cfg_attr(not(feature = "uefi"), derive(FromPrimitive))]
+#[derive(Debug)]
+pub enum EcResponseStatus {
     Success = 0,
     InvalidCommand = 1,
     Error = 2,

framework_lib/src/chromium_ec/mod.rs

@@ -3,6 +3,13 @@ const CROS_EC_IMAGE_DATA_COOKIE2: u32 = 0xceaabbdd;
 // Absolute offset of the version struct inside the entire EC binary
 const EC_VERSION_OFFSET: usize = 0x1158;
 
+#[cfg(not(feature = "uefi"))]
+#[cfg(feature = "std")]
+use regex;
+
+#[cfg(feature = "uefi")]
+use core::prelude::rust_2021::derive;
+
 #[derive(Clone, Copy, Debug)]
 #[repr(C, packed)]
 struct _ImageVersionData {
@@ -46,6 +53,27 @@ pub fn print_ec_version(ver: &ImageVersionData) {
     println!("  Size:       {:>20} KB", ver.size / 1024);
 }
 
+#[cfg(feature = "uefi")]
+fn parse_ec_version(data: &_ImageVersionData) -> Option<ImageVersionData> {
+    let version = std::str::from_utf8(&data.version)
+        .ok()?
+        .trim_end_matches(char::from(0));
+
+    // TODO: regex crate does not support no_std
+
+    Some(ImageVersionData {
+        version: version.to_string(),
+        size: data.size,
+        rollback_version: data.rollback_version,
+        platform: "".to_string(),
+        major: 0,
+        minor: 0,
+        patch: 0,
+        commit: "".to_string(),
+    })
+}
+
+#[cfg(not(feature = "uefi"))]
 fn parse_ec_version(data: &_ImageVersionData) -> Option<ImageVersionData> {
     let version = std::str::from_utf8(&data.version)
         .ok()?

framework_lib/src/ec_binary.rs

@@ -1,4 +1,17 @@
+#![cfg_attr(feature = "uefi", no_std)]
+#![feature(prelude_import)]
+
+#[cfg(feature = "uefi")]
+#[macro_use]
+extern crate uefi_std as std;
+
+#[cfg(feature = "uefi")]
+#[allow(unused_imports)]
+#[prelude_import]
+use std::prelude::*;
+
 pub mod chromium_ec;
+#[cfg(not(feature = "uefi"))]
 pub mod commandline;
 pub mod ec_binary;
 mod os_specific;

framework_lib/src/lib.rs

@@ -1,11 +1,19 @@
+#[cfg(not(feature = "uefi"))]
 use std::{thread, time};
 
 //#[cfg(target_os = "linux")]
 //#[cfg(target_os = "windows")]
+#[cfg(not(feature = "uefi"))]
 pub fn sleep(micros: u64) {
     let ten_millis = time::Duration::from_micros(micros);
     thread::sleep(ten_millis);
     // TODO: If UEFI
     //let uefi = std::system_table();
     //let _ = (uefi.BootServices.Stall)(1000);
 }
+
+#[cfg(feature = "uefi")]
+pub fn sleep(_micros: u64) {
+    // TODO: Implement something for UEFI
+    let _foo: Vec<u8> = vec![];
+}

framework_lib/src/os_specific.rs

@@ -3,7 +3,6 @@ name = "framework_tool"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-framework_lib = { path = "../framework_lib" }
+[dependencies.framework_lib]
+path = "../framework_lib"
+features = ["std", "linux_pio", "raw_pio", "cros_ec_driver"]

framework_tool/Cargo.toml

@@ -0,0 +1,18 @@
+TARGET?=x86_64-unknown-uefi
+BUILD=build/$(TARGET)
+
+SRC_DIR=.
+
+
+$(BUILD)/boot.efi:  $(SRC_DIR)/Cargo.toml $(SRC_DIR)/src/* #$(SRC_DIR)/src/*/*
+	mkdir -p $(BUILD)
+	cargo rustc \
+		-Z build-std=core,alloc \
+		-Z build-std-features=compiler-builtins-mem \
+		--target $(TARGET) \
+		--bin uefi \
+		--release \
+		-- \
+		-C soft-float \
+		--emit link=$@
+

framework_tool/Makefile

@@ -0,0 +1,35 @@
+#![no_std]
+#![no_main]
+#![feature(prelude_import)]
+#![feature(try_trait_v2)]
+#![feature(control_flow_enum)]
+#![allow(clippy::collapsible_if)]
+#![allow(clippy::many_single_char_names)]
+#![allow(clippy::missing_safety_doc)]
+#![allow(dead_code)]
+#![allow(unused_variables)]
+
+extern crate alloc;
+#[macro_use]
+extern crate uefi_std as std;
+
+#[allow(unused_imports)]
+#[prelude_import]
+use std::prelude::*;
+
+use core::ops::{ControlFlow, Try};
+use core::ptr;
+use std::uefi;
+use std::uefi::reset::ResetType;
+use std::uefi::status::{Result, Status};
+
+#[no_mangle]
+pub extern "C" fn main() -> Status {
+    let uefi = std::system_table();
+
+    //cli_flags();
+
+    // If I don't return 1, we crash(?). Or I think it tries other boot options and they fail.
+    // But if I return 1, then we land in UEFI shell and we can run the command manually.
+    Status(1)
+}

framework_tool/src/uefi_main.rs

@@ -0,0 +1,19 @@
+[package]
+name = "framework_uefi"
+version = "0.1.0"
+edition = "2021"
+
+[[bin]]
+name = "uefi"
+path = "src/main.rs"
+
+[profile.release]
+lto = true
+
+[dependencies]
+redox_uefi_std = "0.1.8"
+
+[dependencies.framework_lib]
+path = "../framework_lib"
+features = ["uefi"]
+default-features = false