refactor: rewrite env logger, remove redundant logs

Signed-off-by: addrian-77 <lunguadrian30@gmail.com>

Author: addrian-77

tockloader-cli/Cargo.toml

@@ -27,3 +27,4 @@ inquire = "0.7.5"
 tockloader-lib = { path = "../tockloader-lib/" }
 anyhow = "1.0.89"
 env_logger = "0.11.8"
+log = "0.4.27"

tockloader-cli/src/cli.rs

@@ -18,6 +18,9 @@ pub fn make_cli() -> Command {
             arg!(--"log-level" <LEVEL>)
                 .required(false)
                 .value_parser(["error", "warn", "info", "debug", "trace"])
+                .default_value("info")
+                .num_args(0..=1)
+                .default_missing_value("info")
                 .global(true),
         )
     // Note: arg_require_else_help will trigger the help command if no argument/subcommand is given.

tockloader-cli/src/main.rs

@@ -133,20 +133,28 @@ async fn main() -> Result<()> {
     let user_level = matches
         .get_one::<String>("log-level")
         .map(String::as_str)
-        .unwrap_or("info");
-
-    let filter = format!(
-        "tockloader=trace,\
-        tockloader_lib={user_level},\
-        probe_rs=warn,\
-        nusb=warn,\
-        tracing=warn,\
-        tracing_span=warn"
+        .unwrap();
+
+    let mut builder = env_logger::Builder::new();
+
+    builder.filter_module(
+        "tockloader_lib",
+        match user_level {
+            "error" => log::LevelFilter::Error,
+            "warn" => log::LevelFilter::Warn,
+            "info" => log::LevelFilter::Info,
+            "debug" => log::LevelFilter::Debug,
+            "trace" => log::LevelFilter::Trace,
+            _ => log::LevelFilter::Info,
+        },
     );
+    builder.filter_module("tockloader", log::LevelFilter::Trace);
+    builder.filter_module("probe_rs", log::LevelFilter::Warn);
+    builder.filter_module("nusb", log::LevelFilter::Warn);
+    builder.filter_module("tracing", log::LevelFilter::Warn);
+    builder.filter_module("tracing_span", log::LevelFilter::Warn);
 
-    std::env::set_var("RUST_LOG", &filter);
-
-    env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
+    builder.init();
 
     match matches.subcommand() {
         Some(("listen", sub_matches)) => {

tockloader-lib/src/attributes/app_attributes.rs

@@ -12,8 +12,6 @@ use tokio_serial::SerialStream;
 use crate::bootloader_serial::{issue_command, Command, Response};
 use crate::errors::TockloaderError;
 
-use log::info;
-
 /// This structure contains all relevant information about a tock application.
 ///
 /// All data is stored either within [TbfHeader]s, or [TbfFooter]s.
@@ -80,8 +78,6 @@ impl AppAttributes {
                 .read(appaddr, &mut appdata)
                 .map_err(TockloaderError::ProbeRsReadError)?;
 
-            info!("Read board_core");
-
             let tbf_version: u16;
             let header_size: u16;
             let total_size: u32;
@@ -100,12 +96,8 @@ impl AppAttributes {
                     tbf_version = data.0;
                     header_size = data.1;
                     total_size = data.2;
-                    info!("Obtained tbf header");
-                }
-                _ => {
-                    info!("Buffer is too short!");
-                    return Ok(apps_details);
                 }
+                _ => return Ok(apps_details),
             };
 
             let mut header_data = vec![0u8; header_size as usize];
@@ -154,7 +146,6 @@ impl AppAttributes {
                     break;
                 }
             }
-            info!("Obtained header and footer");
 
             let details: AppAttributes = AppAttributes::new(header, footers);
 
@@ -199,7 +190,7 @@ impl AppAttributes {
             // Read the first 8 bytes, which is the length of a TLV header.
             let (_, appdata) =
                 issue_command(port, Command::ReadRange, pkt, true, 8, Response::ReadRange).await?;
-            info!("Issued pkt and obtained appdata");
+
             let tbf_version: u16;
             let header_size: u16;
             let total_size: u32;
@@ -241,7 +232,6 @@ impl AppAttributes {
 
             let header = parse_tbf_header(&header_data, tbf_version)
                 .map_err(TockloaderError::ParsingError)?;
-            info!("Obtained header");
             let binary_end_offset = header.get_binary_end();
 
             let mut footers: Vec<TbfFooter> = vec![];
@@ -286,7 +276,7 @@ impl AppAttributes {
                     break;
                 }
             }
-            info!("Obtained footer");
+
             let details: AppAttributes = AppAttributes::new(header, footers);
 
             apps_details.insert(apps_counter, details);

tockloader-lib/src/attributes/decode.rs

@@ -1,7 +1,6 @@
 // Licensed under the Apache License, Version 2.0 or the MIT License.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 // Copyright OXIDOS AUTOMOTIVE 2024.
-use log::info;
 
 /// Attributes are key-value pairs that describe hardware configuration, stored
 /// in a fixed 64-byte format:
@@ -44,7 +43,6 @@ pub(crate) fn decode_attribute(step: &[u8]) -> Option<DecodedAttribute> {
     for n in decoder_key {
         key.push(n.expect("Error getting key for attributes."));
     }
-    info!("Decoded raw key");
     key = key.trim_end_matches('\0').to_string();
     let vlen = step[8];
 
@@ -59,7 +57,6 @@ pub(crate) fn decode_attribute(step: &[u8]) -> Option<DecodedAttribute> {
     for n in decoder_value {
         value.push(n.expect("Error getting key for attributes."));
     }
-    info!("Decoded raw value");
     value = value.trim_end_matches('\0').to_string();
     Some(DecodedAttribute::new(key, value))
 }
@@ -79,6 +76,5 @@ pub(crate) fn bytes_to_string(raw: &[u8]) -> String {
     for n in decoder {
         string.push(n.expect("Error getting key for attributes."));
     }
-    info!("Turned whole byte sequence into a string");
     string
 }

tockloader-lib/src/attributes/system_attributes.rs

@@ -11,8 +11,6 @@ use crate::errors::TockloaderError;
 
 use super::decode::{bytes_to_string, decode_attribute};
 
-// use log::info;
-// TODO: add actual logs here
 /// This structure contains all relevant information about board that is stored
 /// in the bootloader ROM.
 ///

tockloader-lib/src/bootloader_serial.rs

@@ -11,7 +11,6 @@ use std::time::Duration;
 use tokio::io::{AsyncReadExt, AsyncWriteExt};
 use tokio_serial::{SerialPort, SerialStream};
 
-use log::{error, info};
 // Tell the bootloader to reset its buffer to handle a new command
 pub const SYNC_MESSAGE: [u8; 3] = [0x00, 0xFC, 0x05];
 
@@ -115,7 +114,6 @@ pub async fn toggle_bootloader_entry_dtr_rts(
     port.write_request_to_send(false)
         .map_err(TockloaderError::SerialInitializationError)?;
 
-    info!("Terminal is ready");
     Ok(())
 }
 
@@ -137,11 +135,9 @@ pub async fn ping_bootloader_and_wait_for_response(
             read_bytes += port.read_buf(&mut ret).await?;
         }
         if ret[1] == Response::Pong as u8 {
-            info!("Bootloader responded to ping");
             return Ok(Response::from(ret[1]));
         }
     }
-    error!("Bootloader sent unexpected response");
     Ok(Response::from(ret[1]))
 }
 
@@ -171,20 +167,17 @@ pub async fn issue_command(
     message.push(command as u8);
 
     // If there should be a sync/reset message, prepend the outgoing message with it
-    info!("Message generated");
     if sync {
         message.insert(0, SYNC_MESSAGE[0]);
         message.insert(1, SYNC_MESSAGE[1]);
         message.insert(2, SYNC_MESSAGE[2]);
     }
-    info!("Inserted sync message");
 
     // Write the command message
     let mut bytes_written = 0;
     while bytes_written != message.len() {
         bytes_written += port.write_buf(&mut &message[bytes_written..]).await?;
     }
-    info!("Wrote command");
 
     // Response has a two byte header, then response_len bytes
     let bytes_to_read = 2 + response_len;