humility ibc black-box should skip empty events (#434)

Author: citrus-it

Cargo.lock

@@ -17,7 +17,7 @@ name = "humility"
 #
 # Be sure to check in and push all of the files that change.  Happy versioning!
 #
-version = "0.10.34"
+version = "0.10.35"
 authors = ["Bryan Cantrill <[email protected]>"]
 edition = "2018"
 license = "MPL-2.0"

Cargo.toml

@@ -211,29 +211,40 @@ impl<'a> IbcHandler<'a> {
                 Err(e) => bail!("Failed to read event {i}: {e}"),
             }
         }
+        let mut base_timestamp: u32 = 0;
         for i in 0..=newest_fault_event_index {
             let e = events[i as usize];
             println!("{}", "FAULT EVENT".red());
             println!("  EVENT_INDEX:        {i}");
-            self.print_event(e, verbose, vout_mode);
+            self.print_event(e, verbose, vout_mode, &mut base_timestamp);
         }
         for i in 24..=newest_lifecycle_event_index {
             let e = events[i as usize];
             println!("{}", "LIFECYCLE EVENT".green());
             println!("  EVENT_INDEX:        {i}");
-            self.print_event(e, verbose, vout_mode);
+            self.print_event(e, verbose, vout_mode, &mut base_timestamp);
         }
 
         Ok(())
     }
 
-    fn print_event(&self, e: IbcEvent, verbose: bool, vout_mode: u8) {
-        println!(
-            "  TIMESTAMP           {:#010x} = {}",
-            e.timestamp.get(),
-            Self::format_time(e.timestamp.get())
-        );
-        println!("  EVENT_ID            {:#06x}", e.event_id.get());
+    fn print_event(
+        &self,
+        e: IbcEvent,
+        verbose: bool,
+        vout_mode: u8,
+        base_timestamp: &mut u32,
+    ) {
+        // In that case that a log contains no entries, the newest event index
+        // reported will be the lowest slot for the log type, which will be
+        // empty. Reading an empty event will return 0xFF in all bytes.
+        if e.timestamp.get() == u32::MAX
+            && e.event_id.get() == u16::MAX
+            && e.status_word.get() == u16::MAX
+        {
+            println!("  EMPTY");
+            return;
+        }
 
         // Decoding is extracted from revision A and B of the datasheet, which
         // contain non-overlapping sets of decoding information.  They don't
@@ -250,6 +261,30 @@ impl<'a> IbcHandler<'a> {
         //   28710-FGB 100 378 Rev A (Application Note 326), May 2023
 
         let status_word = e.status_word.get();
+
+        // When a BOOT_EVENT or TIME_ERASE_EVENT is seen, record the timestamp
+        // so that the times for following events can be displayed relative to
+        // this.
+        if e.status_word.get() == 1 && (e.status_mfr == 0 || e.status_mfr == 6)
+        {
+            *base_timestamp = e.timestamp.get();
+        }
+
+        if *base_timestamp != 0 && *base_timestamp <= e.timestamp.get() {
+            println!(
+                "  TIMESTAMP           {:#010x} = +{}",
+                e.timestamp.get(),
+                Self::format_time(e.timestamp.get() - *base_timestamp)
+            );
+        } else {
+            println!(
+                "  TIMESTAMP           {:#010x} = {}",
+                e.timestamp.get(),
+                Self::format_time(e.timestamp.get())
+            );
+        }
+        println!("  EVENT_ID            {:#06x}", e.event_id.get());
+
         println!("  STATUS_WORD         {:#06x}", status_word);
         for (bit, name) in [
             (0, "System event"),

cmd/ibc/src/lib.rs

@@ -13,7 +13,7 @@ For more information try --help
 
 ```
 $ humility --chip this-can-be-anything -V
-humility 0.10.34
+humility 0.10.35
 
 ```
 
@@ -28,7 +28,7 @@ For more information try --help
 
 ```
 $ humility -c apx432 -V
-humility 0.10.34
+humility 0.10.35
 
 ```
 

tests/cmd/chip.trycmd

@@ -2,14 +2,14 @@ Long version flag:
 
 ```
 $ humility --version
-humility 0.10.34
+humility 0.10.35
 
 ```
 
 Short version flag:
 
 ```
 $ humility -V
-humility 0.10.34
+humility 0.10.35
 
 ```