implement clean command

Signed-off-by: Daniel Maslowski <info@orangecms.org>

Author: orangecms

src/clean.rs

@@ -1,7 +1,106 @@
-enum Module {
-    ROMP,
-    BUP,
-    RBE,
-    Kernel,
-    Syslib,
+use log::info;
+
+use intel_fw::EMPTY;
+use intel_fw::Removables;
+use intel_fw::dir::gen2::{self, Directory as Gen2Directory};
+use intel_fw::dir::gen3::{self, CodePartitionDirectory};
+use intel_fw::fpt::{FTPR, REMOVABLE_PARTS};
+use intel_fw::me::{Directories, ME};
+
+fn fpt_clean(me: &ME, data: &mut [u8]) {
+    let mut clean_fpt = me.fpt.clone();
+    clean_fpt.clear();
+    for (i, v) in clean_fpt.to_vec().iter().enumerate() {
+        data[me.base + i] = *v;
+    }
+}
+
+fn gen2clean(me: &ME, dirs: &Vec<Gen2Directory>, data: &mut [u8]) {
+    // TODO: Extend with user-provided list
+    let retention_list = Vec::from(gen2::ALWAYS_RETAIN)
+        .iter()
+        .map(|s| String::from(*s))
+        .collect();
+    // Clear out removable ranges in the FTPR directory
+    for d in dirs {
+        if d.name == FTPR {
+            let dir_offset = me.base + d.offset;
+            info!("FTPR @ {dir_offset:08x}");
+            for r in d.removables(&retention_list) {
+                let offset = dir_offset + r.start;
+                let size = r.end - r.start;
+                info!("Freeing {size:8} bytes @ {offset:08x}");
+                for o in r {
+                    data[dir_offset + o] = EMPTY;
+                }
+            }
+        }
+    }
+    // Clear out fully removable partitions
+    for e in &me.fpt.entries {
+        match e {
+            // We dealt with the removable ranges in FTPR above.
+            e if e.name().as_str() == FTPR => {
+                info!("Retain {e}");
+            }
+            e if e.offset == 0xffff_ffff => {
+                info!("Ignore {e} due to Invalid offset");
+            }
+            e => {
+                let offset = me.base + e.offset as usize;
+                let size = e.size as usize;
+                let end = offset + size;
+                info!("Remove {e}");
+                for o in offset..end {
+                    data[o] = EMPTY;
+                }
+            }
+        }
+    }
+}
+
+fn gen3clean(me: &ME, dirs: &Vec<CodePartitionDirectory>, data: &mut [u8]) {
+    // TODO: Extend with user-provided list
+    let retention_list = Vec::from(gen3::ALWAYS_RETAIN)
+        .iter()
+        .map(|s| String::from(*s))
+        .collect();
+    // Clear out removable FTPR entries
+    for d in dirs {
+        if d.name == FTPR {
+            let dir_offset = me.base + d.offset;
+            info!("FTPR @ {dir_offset:08x}");
+            for r in d.removables(&retention_list) {
+                let offset = dir_offset + r.start;
+                let size = r.end - r.start;
+                info!("Freeing {size:8} bytes @ {offset:08x}");
+                for o in r {
+                    data[dir_offset + o] = EMPTY;
+                }
+            }
+        }
+    }
+    // Clear out fully removable partitions
+    for e in &me.fpt.entries {
+        match e.name().as_str() {
+            n if REMOVABLE_PARTS.contains(&n) => {
+                let offset = me.base + e.offset as usize;
+                let end = offset + e.size as usize;
+                for o in offset..end {
+                    data[o] = EMPTY;
+                }
+            }
+            _ => {} //
+        }
+    }
+}
+
+pub fn clean(me: &ME, data: &mut [u8]) -> Result<Vec<u8>, ()> {
+    fpt_clean(me, data);
+    match &me.dirs {
+        Directories::Gen2(dirs) => gen2clean(&me, &dirs, data),
+        Directories::Gen3(dirs) => gen3clean(&me, &dirs, data),
+        _ => return Err(()),
+    };
+    Ok(data.to_vec())
 }

src/main.rs

@@ -9,9 +9,10 @@
 //! image in its entirety. This tool brings together all publicly known details.
 
 use std::fs;
+use std::io::Write;
 
 use clap::{Parser, Subcommand, ValueEnum};
-use log::{debug, info};
+use log::{debug, error, info};
 
 mod clean;
 mod show;
@@ -163,15 +164,34 @@ fn main() {
                 if let Some(me_file) = extract_me {
                     info!("Dump ME region to {me_file}");
                 }
-                if let Some(out_file) = output {
+                if let Some(out_file) = &output {
                     info!("Output will be written to: {out_file}");
                 }
                 info!("Reading {file_name}...");
-                let data = fs::read(file_name).unwrap();
+                let mut data = fs::read(file_name).unwrap();
                 let fw = Firmware::parse(&data, debug);
                 show::show(&fw, verbose);
                 println!();
-                todo!("clean");
+
+                let Some(me_res) = fw.me else {
+                    return;
+                };
+                let Ok(me) = me_res else {
+                    return;
+                };
+                match clean::clean(&me, &mut data) {
+                    Ok(data) => {
+                        if let Some(out_file) = output {
+                            let mut file = fs::File::create(out_file).unwrap();
+                            file.write_all(&data).unwrap();
+                        } else {
+                            error!("Clean operation failed");
+                        }
+                    }
+                    Err(_) => {
+                        error!("Clean operation failed");
+                    }
+                }
             }
             MeCommand::Scan { file_name } => {
                 let data = fs::read(file_name).unwrap();