implement retaining FTPR modules

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

Author: orangecms

src/clean.rs

@@ -1,10 +1,12 @@
 use intel_fw::{
     ifd::{IFD, IfdError},
     me::ME,
+    part::part::ClearOptions,
 };
 use log::warn;
 
 pub struct Options {
+    pub keep_modules: bool,
     pub relocate: bool,
     pub disable_me: bool,
     pub disable_me_only: bool,
@@ -36,7 +38,10 @@ pub fn clean(
         }
     }
     let mut new_me = me.clone();
-    new_me.fpt_area.clean();
+    let opts = ClearOptions {
+        keep_modules: options.keep_modules,
+    };
+    new_me.fpt_area.clean(&opts);
     if options.relocate {
         if let Err(e) = new_me.fpt_area.relocate_partitions() {
             warn!("Could not relocate: {e}")

src/main.rs

@@ -184,6 +184,7 @@ fn main() {
                     return;
                 };
                 let opts = clean::Options {
+                    keep_modules,
                     relocate,
                     disable_me: soft_disable,
                     disable_me_only: soft_disable_only,

src/me.rs

@@ -15,6 +15,7 @@ use crate::dir::{
 use crate::part::gen2::Gen2Partition;
 use crate::part::{
     fpt::{FPT, MIN_FPT_SIZE},
+    part::ClearOptions,
     partitions::Partitions,
 };
 use crate::ver::Version;
@@ -50,12 +51,12 @@ pub struct FPTArea {
 
 impl FPTArea {
     /// Clear out fully removable partitions and adjust FPT
-    pub fn clean(&mut self) {
+    pub fn clean(&mut self, options: &ClearOptions) {
         let mut fpt = self.fpt.clone();
         fpt.clear();
         self.fpt = fpt;
         let mut parts = self.partitions.clone();
-        parts.clear();
+        parts.clear(options);
         self.partitions = parts;
         let debug = true;
         if debug {

src/part/gen2.rs

@@ -5,7 +5,10 @@ use crate::dir::gen2::{ALWAYS_RETAIN, Directory, LUT_HEADER_SIZE};
 use crate::dump48;
 use crate::part::{
     fpt::{FPT, FPTEntry, FTPR},
-    part::{DataPartition, Partition, UnknownOrMalformedPartition, dir_clean, strs_to_strings},
+    part::{
+        ClearOptions, DataPartition, Partition, UnknownOrMalformedPartition, dir_clean,
+        strs_to_strings,
+    },
 };
 
 #[derive(Serialize, Deserialize, Clone, Debug)]
@@ -122,7 +125,7 @@ pub fn parse(fpt: &FPT, data: &[u8], debug: bool) -> Vec<Gen2Partition> {
     parts
 }
 
-pub fn clean(parts: &Vec<Gen2Partition>) -> Vec<Gen2Partition> {
+pub fn clean(parts: &Vec<Gen2Partition>, options: &ClearOptions) -> Vec<Gen2Partition> {
     use log::info;
     let res = parts
         .iter()
@@ -138,7 +141,7 @@ pub fn clean(parts: &Vec<Gen2Partition>) -> Vec<Gen2Partition> {
         })
         .map(|p| {
             let mut p = p.clone();
-            if p.entry().name() == FTPR {
+            if p.entry().name() == FTPR && !options.keep_modules {
                 let offset = p.entry().offset();
                 info!("FTPR @ {offset:08x}");
                 // TODO: Extend with user-provided list

src/part/gen3.rs

@@ -7,7 +7,7 @@ use crate::dir::{
 use crate::dump48;
 use crate::part::{
     fpt::{DIR_PARTS, FPT, FPTEntry, FS_PARTS, FTPR, REMOVABLE_PARTS},
-    part::{Partition, UnknownOrMalformedPartition, dir_clean, strs_to_strings},
+    part::{ClearOptions, Partition, UnknownOrMalformedPartition, dir_clean, strs_to_strings},
 };
 
 #[derive(Serialize, Deserialize, Clone, Debug)]
@@ -148,7 +148,7 @@ pub fn parse(fpt: &FPT, data: &[u8], debug: bool) -> Vec<Gen3Partition> {
     parts
 }
 
-pub fn clean(parts: &Vec<Gen3Partition>) -> Vec<Gen3Partition> {
+pub fn clean(parts: &Vec<Gen3Partition>, options: &ClearOptions) -> Vec<Gen3Partition> {
     use log::info;
     // Step 1: Reduce down to the partitions to be kept, i.e., non-removable
     // ones.
@@ -166,6 +166,9 @@ pub fn clean(parts: &Vec<Gen3Partition>) -> Vec<Gen3Partition> {
         })
         .map(|p| p.clone())
         .collect::<Vec<Gen3Partition>>();
+    if options.keep_modules {
+        return reduced;
+    }
     // Step 2: Clean the FTPR directory, retaining non-removable modules.
     if let Some(p) = reduced.iter_mut().find(|p| p.entry().name() == FTPR) {
         let offset = p.entry().offset();

src/part/part.rs

@@ -59,6 +59,10 @@ pub fn strs_to_strings(strs: &[&str]) -> Vec<String> {
     Vec::from(strs).iter().map(|s| String::from(*s)).collect()
 }
 
+pub struct ClearOptions {
+    pub keep_modules: bool,
+}
+
 // Clear out removable ranges in the FTPR directory
 pub fn dir_clean(dir: &dyn Removables, retention_list: &Vec<String>, data: &mut Vec<u8>) {
     use log::info;

src/part/partitions.rs

@@ -5,6 +5,7 @@ use zerocopy::IntoBytes;
 
 use crate::EMPTY;
 use crate::dir::gen3::CPD_MAGIC_BYTES;
+use crate::part::part::ClearOptions;
 use crate::part::{
     fpt::{FPT, FPTEntry},
     gen2::{self, Gen2Partition},
@@ -116,14 +117,14 @@ impl Partitions {
 
     // TODO: retention list
     /// Clear out fully removable partitions, adjusting header and checksum
-    pub fn clear(&mut self) {
+    pub fn clear(&mut self, options: &ClearOptions) {
         let parts = match &self {
             Partitions::Gen2(parts) => {
-                let res = gen2::clean(&parts);
+                let res = gen2::clean(&parts, options);
                 Partitions::Gen2(res)
             }
             Partitions::Gen3(parts) => {
-                let res = gen3::clean(&parts);
+                let res = gen3::clean(&parts, options);
                 Partitions::Gen3(res)
             }
             Partitions::Unknown(p) => {