Add binaries for models, generate README.md from README.md.in

README.md

@@ -2,7 +2,12 @@
 
 System76 Open Source Firmware
 
-- [Applications](./apps)
+## Contents
-- [Libraries](./libs)
+- [Applications](./apps/)
-- [Models](./models)
+- [coreboot README](./coreboot/)
-- [Tools](./tools)
+- [edk2](./edk2/)
+- [edk2-platforms](./edk2-platforms/)
+- [Libraries](./libs/)
+- [Models](./models/)
+- [scripts](./scripts/)
+- [Tools](./tools/)

README.md.in

@@ -0,0 +1,3 @@
+# firmware-open
+
+System76 Open Source Firmware

apps/README.md

@@ -1,3 +1,5 @@
 # Applications
-- [System76 Firmware Setup](https://github.com/system76/firmware-setup.git)
+
-- [System76 Firmware Update](https://github.com/system76/firmware-update.git)
+## Contents
+- [System76 Firmware Setup](./firmware-setup/)
+- [System76 Firmware Update](./firmware-update/)

apps/README.md.in

@@ -0,0 +1 @@
+# Applications

libs/README.md

@@ -1,6 +1,10 @@
 # Libraries
-- [coreboot-table](https://gitlab.redox-os.org/redox-os/coreboot-table.git)
+
-- [ecflash](https://github.com/system76/ecflash.git)
+## Contents
-- [intelflash](https://gitlab.redox-os.org/redox-os/intelflash.git)
+- [coreboot-table](./coreboot-table/)
-- [intel-spi](https://github.com/system76/intel-spi.git)
+- [ecflash](./ecflash/)
-- [uefi_std](https://gitlab.redox-os.org/redox-os/uefi_std.git)
+- [intelflash](./intelflash/)
+- [intel-spi](./intel-spi/)
+- [uefi](./uefi/)
+- [uefi_alloc](./uefi_alloc/)
+- [uefi_std](./uefi_std/)

libs/README.md.in

@@ -0,0 +1 @@
+# Libraries

models/README.md

@@ -1,6 +1,8 @@
 # Models
-- [System76 Darter Pro (darp5)](./darp5)
+
-- [System76 Galago Pro (galp2)](./galp2)
+## Contents
-- [System76 Galago Pro (galp3-b)](./galp3-b)
+- [System76 Darter Pro (darp5)](./darp5/)
-- [System76 Galago Pro (galp3-c)](./galp3-c)
+- [System76 Galago Pro (galp2)](./galp2/)
-- [System76 Galago Pro (galp3)](./galp3)
+- [System76 Galago Pro (galp3)](./galp3/)
+- [System76 Galago Pro (galp3-b)](./galp3-b/)
+- [System76 Galago Pro (galp3-c)](./galp3-c/)

models/README.md.in

@@ -0,0 +1 @@
+# Models

models/darp5/README.md

@@ -1,3 +1,15 @@
 # System76 Darter Pro (darp5)
 
 https://system76.com/guides/darp5
+
+## Contents
+- [EC](./ec.rom)
+  - Size: 128 KB
+  - Model: N150ZU
+  - Version: 1.07.04
+- [FD](./fd.rom)
+  - Size: 4 KB
+  - HAP: false
+- [ME](./me.rom)
+  - Size: 6140 KB
+  - Version: 12.0.8.1123

models/darp5/README.md.in

@@ -0,0 +1,3 @@
+# System76 Darter Pro (darp5)
+
+https://system76.com/guides/darp5

models/galp2/README.md

@@ -1,3 +1,15 @@
 # System76 Galago Pro (galp2)
 
 https://system76.com/guides/galp2
+
+## Contents
+- [EC](./ec.rom)
+  - Size: 128 KB
+  - Model: N130BU
+  - Version: 1.05.06
+- [FD](./fd.rom)
+  - Size: 4 KB
+  - HAP: false
+- [ME](./me.rom)
+  - Size: 2044 KB
+  - Version: 11.8.50.3434

models/galp2/README.md.in

@@ -0,0 +1,3 @@
+# System76 Galago Pro (galp2)
+
+https://system76.com/guides/galp2

models/galp3-b/README.md

@@ -1,3 +1,15 @@
 # System76 Galago Pro (galp3-b)
 
 https://system76.com/guides/galp3
+
+## Contents
+- [EC](./ec.rom)
+  - Size: 128 KB
+  - Model: N140WU
+  - Version: 1.07.03
+- [FD](./fd.rom)
+  - Size: 4 KB
+  - HAP: false
+- [ME](./me.rom)
+  - Size: 2044 KB
+  - Version: 11.8.50.3434

models/galp3-b/README.md.in

@@ -0,0 +1,3 @@
+# System76 Galago Pro (galp3-b)
+
+https://system76.com/guides/galp3

models/galp3-c/README.md

@@ -1,3 +1,15 @@
 # System76 Galago Pro (galp3-c)
 
 https://system76.com/guides/galp3
+
+## Contents
+- [EC](./ec.rom)
+  - Size: 128 KB
+  - Model: N130ZU
+  - Version: 1.07.02
+- [FD](./fd.rom)
+  - Size: 4 KB
+  - HAP: false
+- [ME](./me.rom)
+  - Size: 6140 KB
+  - Version: 12.0.8.1123

models/galp3-c/README.md.in

@@ -0,0 +1,3 @@
+# System76 Galago Pro (galp3-c)
+
+https://system76.com/guides/galp3

models/galp3/README.md

@@ -1,3 +1,15 @@
 # System76 Galago Pro (galp3)
 
 https://system76.com/guides/galp3
+
+## Contents
+- [EC](./ec.rom)
+  - Size: 128 KB
+  - Model: N130WU
+  - Version: 1.05.03MI1
+- [FD](./fd.rom)
+  - Size: 4 KB
+  - HAP: false
+- [ME](./me.rom)
+  - Size: 2044 KB
+  - Version: 11.8.50.3399

models/galp3/README.md.in

@@ -0,0 +1,3 @@
+# System76 Galago Pro (galp3)
+
+https://system76.com/guides/galp3

readmes.sh

@@ -1,35 +0,0 @@
-#!/usr/bin/env bash
-
-READMES=(
-    "apps Applications"
-    "libs Libraries"
-    "models Models"
-    "tools Tools"
-)
-
-function recursive_readme {
-    pushd "$1" > /dev/null
-    echo -e "\x1B[1m$1\x1B[0m"
-    echo "# $2" > README.md
-    for readme in */README.md
-    do
-        # Get first line, removing the trailing pounds and spaces
-        description="$(head -n 1 "$readme" | sed -e 's/^[#[:space:]]*//')"
-        # Get submodule, if applicable
-        dir="$(dirname "$readme")"
-        submodule="$(git submodule status "$dir" | cut -d ' ' -f 3)"
-        if [ "$submodule" == "$dir" ]
-        then
-            origin="$(git -C "$dir" remote get-url origin)"
-            echo "- [$description]($origin)" >> README.md
-        else
-            echo "- [$description](./$dir)" >> README.md
-        fi
-    done
-    popd > /dev/null
-}
-
-for readme in "${READMES[@]}"
-do
-    recursive_readme $readme
-done

scripts/models.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -e
+
+cargo build --manifest-path "scripts/modeltool/Cargo.toml" --release
+
+MODELTOOL="$(realpath "scripts/modeltool/target/release/modeltool")"
+
+for dir in models/*/
+do
+    pushd "$dir" > /dev/null
+    model="$(basename "$dir")"
+    echo -e "\x1B[1m$model\x1B[0m"
+    cp README.md.in README.md
+    echo "## Firmware Versions" >> README.md
+    "$MODELTOOL" . | tee -a README.md
+    popd > /dev/null
+done

scripts/modeltool/.gitignore

@@ -0,0 +1 @@
+target

scripts/modeltool/Cargo.lock

@@ -0,0 +1,44 @@
+[[package]]
+name = "bitflags"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "modeltool"
+version = "0.1.0"
+dependencies = [
+ "redox_intelflash 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "system76_ecflash 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "plain"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "redox_intelflash"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "plain 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)",
+ "redox_uefi 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "redox_uefi"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "system76_ecflash"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[metadata]
+"checksum bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "228047a76f468627ca71776ecdebd732a3423081fcf5125585bcd7c49886ce12"
+"checksum plain 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "b4596b6d070b27117e987119b4dac604f3c58cfb0b191112e24771b2faeac1a6"
+"checksum redox_intelflash 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "49e6f45d8c070090589005869e0b776f52c735f9b5411fca369229135fa1dbd8"
+"checksum redox_uefi 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "dafc50645c27c55ca19d27645a6d91e2a8cbc7aabb2ed024ce914512c75e1217"
+"checksum system76_ecflash 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d2a81b23cd826ce944029420978cce3be94363188ed87ff8cc0778f80adac547"

scripts/modeltool/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "modeltool"
+version = "0.1.0"
+authors = ["Jeremy Soller <jeremy@system76.com>"]
+edition = "2018"
+
+[dependencies]
+redox_intelflash = "0.1.0"
+system76_ecflash = "0.1.0"

scripts/modeltool/src/main.rs

@@ -0,0 +1,86 @@
+use ecflash::{Ec, EcFile};
+use intelflash::{Me, Rom};
+use std::{env, fs, process};
+use std::path::Path;
+
+fn ec(path: &Path) {
+    println!("- [EC]({})", path.display());
+    match fs::read(path) {
+        Ok(data) => {
+            println!("  - Size: {} KB", data.len() / 1024);
+            {
+                let mut ec = EcFile::new(data);
+                println!("  - Model: {}", ec.project());
+                println!("  - Version: {}", ec.version());
+            }
+        },
+        Err(err) => {
+            println!("  - *Read Error: {}*", err);
+        }
+    }
+}
+
+fn fd(path: &Path) {
+    println!("- [FD]({})", path.display());
+    match fs::read(path) {
+        Ok(data) => {
+            println!("  - Size: {} KB", data.len() / 1024);
+            match Rom::new(&data) {
+                Ok(rom) => {
+                    match rom.high_assurance_platform() {
+                        Ok(hap) => {
+                            println!("  - HAP: {}", hap);
+                        },
+                        Err(err) => {
+                            println!("  - *HAP Error: {}*", err);
+                        }
+                    }
+                },
+                Err(err) => {
+                    println!("  - *Parse Error: {}*", err);
+                }
+            }
+        },
+        Err(err) => {
+            println!("  - *Read Error: {}*", err);
+        }
+    }
+}
+
+fn me(path: &Path) {
+    println!("- [ME]({})", path.display());
+    match fs::read(path) {
+        Ok(data) => {
+            println!("  - Size: {} KB", data.len() / 1024);
+            match Me::new(&data) {
+                Ok(me) => {
+                    if let Some(version) = me.version() {
+                        println!("  - Version: {}", version);
+                    }
+                },
+                Err(err) => {
+                    println!("  - *Parse Error: {}*", err);
+                }
+            }
+        },
+        Err(err) => {
+            println!("  - *Read Error: {}*", err);
+        }
+    }
+}
+
+fn main() {
+    let args: Vec<String> = env::args().skip(1).collect();
+    if args.is_empty() {
+        println!("modeltool [model directory]...");
+        process::exit(1);
+    }
+
+    for arg in args {
+        let path = Path::new(&arg);
+
+        ec(&path.join("ec.rom"));
+        fd(&path.join("fd.rom"));
+        me(&path.join("me.rom"));
+    }
+}

scripts/readmes.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+
+README_DIRS=(
+    apps
+    libs
+    models
+    tools
+    .
+)
+
+set -e
+
+cargo build --manifest-path "scripts/modeltool/Cargo.toml" --release
+
+MODELTOOL="$(realpath "scripts/modeltool/target/release/modeltool")"
+
+function readme_model {
+    echo -e "\x1B[1m$1\x1B[0m" >&2
+
+    pushd "$1" > /dev/null
+        cp README.md.in README.md
+
+        echo >> README.md
+        echo "## Contents" >> README.md
+        "$MODELTOOL" . >> README.md
+    popd > /dev/null
+}
+
+for dir in models/*/
+do
+    readme_model "${dir%/}"
+done
+
+function readme_line {
+    echo -e "  \x1B[1m$1\x1B[0m" >&2
+
+    if [ -f "$1/README.md" ]
+    then
+        # Get first line, removing the trailing pounds and spaces
+        description="$(head -n 1 "$1/README.md" | sed -e 's/^[#[:space:]]*//')"
+    else
+        # Use the directory name as the description
+        description="$(basename "$1")"
+    fi
+
+    submodule="$(git submodule status "$1" 2> /dev/null | cut -d ' ' -f 3 || true)"
+    if [ "$submodule" == "$dir" ]
+    then
+        # Link to submodule URL
+        origin="$(git -C "$dir" remote get-url origin)"
+        echo "- [$description]($origin)"
+    else
+        # Link to directory
+        echo "- [$description](./$dir)"
+    fi
+}
+
+function readme_dir {
+    echo -e "\x1B[1m$1\x1B[0m" >&2
+
+    pushd "$1" > /dev/null
+        cp README.md.in README.md
+
+        echo >> README.md
+        echo "## Contents" >> README.md
+        for dir in */
+        do
+            readme_line "${dir%/}" >> README.md
+        done
+    popd > /dev/null
+}
+
+for dir in "${README_DIRS[@]}"
+do
+    readme_dir "$dir"
+done

tools/README.md

@@ -1,6 +1,8 @@
 # Tools
-- [coreboot-collector](https://github.com/system76/coreboot-collector.git)
+
-- [ME Analyzer](https://github.com/platomav/MEAnalyzer.git)
+## Contents
-- [UEFITool](https://github.com/LongSoft/UEFITool.git)
+- [coreboot-collector](./coreboot-collector/)
-- [Intel ME 11.x Firmware Images Unpacker](https://github.com/ptresearch/unME11.git)
+- [ME Analyzer](./MEAnalyzer/)
-- [Intel ME 12.x Firmware Images Unpacker](https://github.com/ptresearch/unME12.git)
+- [UEFITool](./UEFITool/)
+- [Intel ME 11.x Firmware Images Unpacker](./unME11/)
+- [Intel ME 12.x Firmware Images Unpacker](./unME12/)

tools/README.md.in

@@ -0,0 +1 @@
+# Tools