fix: TBF parsing + logging

Signed-off-by: George Cosma <[email protected]>

Author: George Cosma

tbf-parser/Cargo.toml

@@ -6,7 +6,8 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+log = "0.4.27"
 
 [features]
 default = []
-std = []
+std = []

tbf-parser/src/parse.rs

@@ -153,6 +153,13 @@ pub fn parse_tbf_header(
                         .get(0..4)
                         .ok_or(types::TbfParseError::NotEnoughFlash)?
                         .try_into()?;
+
+                    log::debug!(
+                        "TLV Entry: type {:?}, length {}",
+                        tlv_header.tipe,
+                        tlv_header.length
+                    );
+
                     remaining = remaining
                         .get(4..)
                         .ok_or(types::TbfParseError::NotEnoughFlash)?;

tockloader-cli/src/cli.rs

@@ -31,6 +31,12 @@ fn get_subcommands() -> Vec<Command> {
         Command::new("listen")
             .about("Open a terminal to receive UART data")
             .args(get_channel_args())
+            .args([
+                // TODO(george-cosma): Change default to pconsole when new format is implemented and adopted into tock
+                arg!(--protocol <PROTOCOL> "Choose between legacy and pconsole protocol")
+                    .default_value("legacy")
+                    .value_parser(["legacy", "pconsole"]),
+            ])
             .arg_required_else_help(false),
         Command::new("list")
             .about("List and inspect probes")
@@ -75,10 +81,6 @@ fn get_channel_args() -> Vec<clap::Arg> {
         .collect::<Vec<_>>();
 
     vec![
-        // TODO(george-cosma): Change default to pconsole when new format is implemented and adopted into tock
-        arg!(--protocol <PROTOCOL> "Choose between legacy and pconsole protocol")
-            .default_value("legacy")
-            .value_parser(["legacy", "pconsole"]),
         arg!(--serial "Use the serial bootloader to flash")
             .action(clap::ArgAction::SetTrue)
             .conflicts_with_all(probe_args_ids.clone().collect::<Vec<_>>()),

tockloader-cli/src/main.rs

@@ -72,11 +72,16 @@ fn get_board_settings(user_options: &ArgMatches) -> BoardSettings {
 }
 
 fn using_serial(user_options: &ArgMatches) -> bool {
-    // TODO: refactor this in the future
-    *user_options.get_one::<bool>("serial").unwrap_or(&false)
-        || user_options
-            .get_one::<String>("protocol")
-            .is_some_and(|p| p == "legacy")
+    let serial_flag = *user_options.get_one::<bool>("serial").unwrap_or(&false);
+    if serial_flag {
+        return true;
+    }
+
+    let is_listen_command = user_options
+        .try_get_one::<String>("protocol")
+        .is_ok_and(|option| option.is_some_and(|val| val == "legacy"));
+
+    is_listen_command
 }
 
 fn get_known_board(user_options: &ArgMatches) -> Option<Box<dyn KnownBoard>> {
@@ -147,12 +152,13 @@ async fn main() -> Result<()> {
         "info" => log::LevelFilter::Info,
         "debug" => log::LevelFilter::Debug,
         "trace" => log::LevelFilter::Trace,
-        level => panic!("Unknown log level: {}", level),
+        level => panic!("Unknown log level: {level}"),
     };
 
     builder.filter_level(log::LevelFilter::Off);
     builder.filter_module("tockloader-lib", cli_level);
     builder.filter_module("tockloader", cli_level);
+    builder.filter_module("tbf_parser", cli_level);
 
     builder.init();
 

tockloader-lib/src/attributes/app_attributes.rs

@@ -98,9 +98,14 @@ impl AppAttributes {
                 _ => return Ok(apps_details),
             };
 
+            log::debug!(
+                "App #{apps_counter}: TBF version {tbf_version}, header size {header_size}, total size {total_size}",
+            );
+
             let mut header_data = vec![0u8; header_size as usize];
 
             board_core.read(appaddr, &mut header_data)?;
+            log::debug!("App #{apps_counter}: Header data: {header_data:?}");
             let header = parse_tbf_header(&header_data, tbf_version)
                 .map_err(TockError::InvalidAppTbfHeader)?;
 
@@ -118,7 +123,7 @@ impl AppAttributes {
             let mut footer_number = 0;
 
             // Try to parse footers until we reach the end of the application.
-            loop {
+            while footer_offset < total_size {
                 // We don't know the size of the current footer, so we read the
                 // remaining bytes in the application (`footer_offset -
                 // binary_end_offset`) , even if we overread.
@@ -135,10 +140,6 @@ impl AppAttributes {
                 footer_number += 1;
                 // we add 4 because that is the size of TL part of the TLV header (2 bytes type + 2 bytes length)
                 footer_offset += footer_info.1 + 4;
-
-                if footer_offset == total_size {
-                    break;
-                }
             }
 
             let details: AppAttributes = AppAttributes::new(header, footers);
@@ -207,6 +208,10 @@ impl AppAttributes {
                 _ => break,
             };
 
+            log::debug!(
+                "App #{apps_counter}: TBF version {tbf_version}, header size {header_size}, total size {total_size}",
+            );
+
             let mut pkt = (appaddr as u32).to_le_bytes().to_vec();
             let length = (header_size).to_le_bytes().to_vec();
             for i in length {
@@ -224,6 +229,7 @@ impl AppAttributes {
             )
             .await?;
 
+            log::debug!("App #{apps_counter}: Header data: {header_data:?}");
             let header = parse_tbf_header(&header_data, tbf_version)
                 .map_err(TockError::InvalidAppTbfHeader)?;
             let binary_end_offset = header.get_binary_end();
@@ -234,7 +240,7 @@ impl AppAttributes {
             let mut footer_number = 0;
 
             // Try to parse footers until we reach the end of the application.
-            loop {
+            while footer_offset < total_size {
                 // We don't know the size of the current footer, so we read the
                 // remaining bytes in the application (`footer_offset -
                 // binary_end_offset`) , even if we overread.
@@ -265,10 +271,6 @@ impl AppAttributes {
                 footer_number += 1;
                 // we add 4 because that is the size of TL part of the TLV header (2 bytes type + 2 bytes length)
                 footer_offset += footer_info.1 + 4;
-
-                if footer_offset == total_size {
-                    break;
-                }
             }
 
             let details: AppAttributes = AppAttributes::new(header, footers);