Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,17 @@ To run the CLI via `cargo` directly, remember to add arguments after an extra
`--`; i.e., to print the general help, invoke `cargo run --relase -- -h`, or,
for a subcommand, e.g. `cargo run --relase -- me clean -h`.

## Milestones

- [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand
- mimic the `me_cleaner` CLI, using similar+same arguments and switches for
compatibility
- [x] port the logic to Rust, using `me_cleaner`-edited images as test fixtures
- NOTE: committing the test fixtures would be big and a potential license
issue; instead, add notes on how to reproduce them, via public vendor
images and extraction utilities (e.g. from Lenovo)
- [x] step 1: port core logic to produce the same output as `me_cleaner` for
Lenovo ThinkPad X230 + X270
- [x] step 2: full feature parity with `me_cleaner`
- [x] expand the documentation
- [x] higher-level view on Intel platform boot flows
- [x] how the Intel data structures work, in prose
- [x] adding support for more platforms and variants
- [ ] work out a reusable library, i.e., a Rust crate for <https://crates.io/>
- [x] turn all `unwrap()`s into `Option`/`Result`; add lint rule
- [ ] add bounds checks
- [ ] publish the crate
## TODOs

- [ ] sync up; <https://github.com/corna/me_cleaner> has another patch that
coreboot is missing, doing rework and adding ME Gen 1 support
- [ ] [IFWI](https://github.com/platform-system-interface/intel_fw/issues/80)
format support

## Funding

The [initial work](milestones.md#initial_work) has been sponsored through the
first [Open Call by the Open Source Firmware Foundation](https://www.osfw.foundation/funding/small-scale-high-impact-firmware-contributions-2025/). We highly appreciate
their support that made a first release of this project possible.

![Open Source Firmware Foundation Logo](docs/osff_logo_400.png)
Binary file added docs/osff_logo_400.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions milestones.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Milestones

## Initial work

- [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand
- mimic the `me_cleaner` CLI, using similar+same arguments and switches for
compatibility
- [x] port the logic to Rust, using `me_cleaner`-edited images as test fixtures
- NOTE: committing the test fixtures would be big and a potential license
issue; instead, add notes on how to reproduce them, via public vendor
images and extraction utilities (e.g. from Lenovo)
- [x] step 1: port core logic to produce the same output as `me_cleaner` for
Lenovo ThinkPad X230 + X270
- [x] step 2: full feature parity with `me_cleaner`
- [x] expand the documentation
- [x] higher-level view on Intel platform boot flows
- [x] how the Intel data structures work, in prose
- [x] adding support for more platforms and variants
- [x] work out a reusable library, i.e., a Rust crate for <https://crates.io/>
- [x] turn all `unwrap()`s into `Option`/`Result`; add lint rule
- [x] add bounds checks
- [x] publish the crate