Add --dump-gpu-descriptor-file

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

EXAMPLES_ADVANCED.md

@@ -87,6 +87,11 @@ It's intended for advanced users who build their own expansion bay module.
 The I2C address of the EEPROM is hardcoded to 0x50.
 
 ```
+# Dump current descriptor (e.g. for backup)
+> framework_tool --dump-gpu-descriptor-file foo.bin
+Dumping to foo.bin
+Wrote 153 bytes to foo.bin
+
 # Update just the serial number
 > framework_tool --flash_gpu_descriptor GPU FRAKMQCP41500ASSY1
 > framework_tool --flash_gpu_descriptor 13 FRAKMQCP41500ASSY1

framework_lib/src/chromium_ec/mod.rs

@@ -1254,6 +1254,16 @@ impl CrosEc {
         Ok(())
     }
 
+    pub fn read_gpu_descriptor(&self) -> EcResult<Vec<u8>> {
+        let header = self.read_gpu_desc_header()?;
+        if header.magic != [0x32, 0xAC, 0x00, 0x00] {
+            return Err(EcError::DeviceError(
+                "Invalid descriptor hdr magic".to_string(),
+            ));
+        }
+        self.read_ec_gpu_chunk(0x00, header.descriptor_length as u16)
+    }
+
     pub fn read_gpu_desc_header(&self) -> EcResult<GpuCfgDescriptor> {
         let bytes =
             self.read_ec_gpu_chunk(0x00, core::mem::size_of::<GpuCfgDescriptor>() as u16)?;

framework_lib/src/commandline/clap_std.rs

@@ -274,6 +274,10 @@ struct ClapCli {
     /// File to write to the gpu EEPROM
     #[arg(long)]
     flash_gpu_descriptor_file: Option<std::path::PathBuf>,
+
+    /// File to dump the gpu EEPROM to
+    #[arg(long)]
+    dump_gpu_descriptor_file: Option<std::path::PathBuf>,
 }
 
 /// Parse a list of commandline arguments and return the struct
@@ -464,6 +468,9 @@ pub fn parse(args: &[String]) -> Cli {
         flash_gpu_descriptor_file: args
             .flash_gpu_descriptor_file
             .map(|x| x.into_os_string().into_string().unwrap()),
+        dump_gpu_descriptor_file: args
+            .dump_gpu_descriptor_file
+            .map(|x| x.into_os_string().into_string().unwrap()),
         raw_command: vec![],
     }
 }

framework_lib/src/commandline/mod.rs

@@ -202,6 +202,7 @@ pub struct Cli {
     pub info: bool,
     pub flash_gpu_descriptor: Option<(u8, String)>,
     pub flash_gpu_descriptor_file: Option<String>,
+    pub dump_gpu_descriptor_file: Option<String>,
     // UEFI only
     pub allupdate: bool,
     pub paginate: bool,
@@ -680,6 +681,24 @@ fn dump_ec_flash(ec: &CrosEc, dump_path: &str) {
     }
 }
 
+fn dump_dgpu_eeprom(ec: &CrosEc, dump_path: &str) {
+    let flash_bin = ec.read_gpu_descriptor().unwrap();
+
+    #[cfg(not(feature = "uefi"))]
+    {
+        let mut file = fs::File::create(dump_path).unwrap();
+        file.write_all(&flash_bin).unwrap();
+    }
+    #[cfg(feature = "uefi")]
+    {
+        let ret = crate::uefi::fs::shell_write_file(dump_path, &flash_bin);
+        if ret.is_err() {
+            println!("Failed to dump EC FW image.");
+        }
+    }
+    println!("Wrote {} bytes to {}", flash_bin.len(), dump_path);
+}
+
 fn compare_version(device: Option<HardwareDeviceType>, version: String, ec: &CrosEc) -> i32 {
     println!("Target Version {:?}", version);
 
@@ -1270,6 +1289,9 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
         } else {
             println!("Unsupported on this platform");
         }
+    } else if let Some(dump_path) = &args.dump_gpu_descriptor_file {
+        println!("Dumping to {}", dump_path);
+        dump_dgpu_eeprom(&ec, dump_path);
     }
 
     0

framework_lib/src/commandline/uefi.rs

@@ -117,6 +117,7 @@ pub fn parse(args: &[String]) -> Cli {
         help: false,
         flash_gpu_descriptor: None,
         flash_gpu_descriptor_file: None,
+        dump_gpu_descriptor_file: None,
         allupdate: false,
         info: false,
         raw_command: vec![],
@@ -773,6 +774,14 @@ pub fn parse(args: &[String]) -> Cli {
                 None
             };
             found_an_option = true;
+        } else if arg == "--dump-gpu-descriptor-file" {
+            cli.dump_gpu_descriptor_file = if args.len() > i + 1 {
+                Some(args[i + 1].clone())
+            } else {
+                println!("Need to provide a value for --dump_gpu_descriptor_file. PATH");
+                None
+            };
+            found_an_option = true;
         }
     }