Use firmware.valid to Check Firmware Validity Before Upgrade (#57)

This takes into account FW versions that don't have this attribute. Gives feedback to the user if the image was found to be invalid.
tektronix · Jan 28, 2025 · a30188a · a30188a
1 parent e5a0f14
commit a30188a
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ### Changed
 
 - Reduce amount of default logging
+- Use new `firmware.valid` attribute to gate firmware update
 
 ### Added
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -39,7 +39,7 @@ serde_json = "1.0.114"
 thiserror = "2.0.3"
 tracing = { version = "0.1.40", features = ["async-await"] }
 tracing-subscriber = { version = "0.3.18", features = ["json"] }
-tsp-toolkit-kic-lib = { git = "https://github.com/tektronix/tsp-toolkit-kic-lib.git", tag = "v0.19.4" }
+tsp-toolkit-kic-lib = { git = "https://github.com/tektronix/tsp-toolkit-kic-lib.git", tag = "v0.19.5-0" }
 
 [workspace.lints.rust]
 warnings = "deny"

diff --git a/instrument-repl/src/repl.rs b/instrument-repl/src/repl.rs
@@ -22,7 +22,7 @@ use std::{
 };
 use tracing::{debug, error, info, instrument, trace, warn};
 
-use tsp_toolkit_kic_lib::instrument::Instrument;
+use tsp_toolkit_kic_lib::{instrument::Instrument, InstrumentError};
 
 use crate::{
     command::Request,
@@ -299,7 +299,7 @@ impl Repl {
                             if slot.is_some_and(|s| s > 0) {
                                 // Upgrading Module
                                 Self::println_flush(
-                                    &"Sending firmware file to mainframe. Please wait for module upgrade to complete (2-5 minutes)..."
+                                    &"Sending firmware file to mainframe. Please wait for module upgrade to complete (up to 10 minutes)..."
                                         .bright_yellow(),
                                 )?;
                             } else {
@@ -308,16 +308,26 @@ impl Repl {
                                         .bright_yellow(),
                                 )?;
                             }
-                            self.inst.flash_firmware(contents.as_ref(), slot)?;
-                            if slot.is_some_and(|s| s > 0) {
-                                // Upgrading Module
-                                Self::println_flush(&"Module upgrade complete.".bright_yellow())?;
-                            } else {
-                                Self::println_flush(
-                                    &"Firmware file download complete.".bright_yellow(),
-                                )?;
-                                // Upgrading Mainframe
-                                Self::println_flush(&"Close the terminal (.exit) and reconnect after the instrument has restarted.".bright_yellow())?;
+                            match self.inst.flash_firmware(contents.as_ref(), slot) {
+                                Ok(()) => {
+                                    if slot.is_some_and(|s| s > 0) {
+                                        // Upgrading Module
+                                        Self::println_flush(
+                                            &"Module upgrade complete.".bright_yellow(),
+                                        )?;
+                                    } else {
+                                        Self::println_flush(
+                                            &"Firmware file download complete.".bright_yellow(),
+                                        )?;
+                                        // Upgrading Mainframe
+                                        Self::println_flush(&"Close the terminal (.exit) and reconnect after the instrument has restarted.".bright_yellow())?;
+                                    }
+                                }
+                                Err(InstrumentError::FwUpgradeFailure(msg)) => {
+                                    error!("{msg}");
+                                    Self::println_flush(&msg.red())?;
+                                }
+                                Err(e) => return Err(e.into()),
                             }
                             // Flashing FW disables prompts before flashing but might
                             // lose runtime state, so we can't save the previous