Fix baudrate (#885)

* fix: Only change baud if neccesary

* feat: Only change baudrate if required

* docs: Udpate changelog

* test: Add high baudrate test

* feat: Increase timeout

Author: SergioGasquez

.github/workflows/hil.yml

@@ -103,7 +103,7 @@ jobs:
         run: timeout 10 bash espflash/tests/scripts/board-info.sh
 
       - name: flash test
-        run: timeout 60 bash espflash/tests/scripts/flash.sh ${{ matrix.board.mcu }}
+        run: timeout 80 bash espflash/tests/scripts/flash.sh ${{ matrix.board.mcu }}
 
       - name: monitor test
         run: timeout 10 bash espflash/tests/scripts/monitor.sh
@@ -116,7 +116,7 @@ jobs:
           timeout 90 bash espflash/tests/scripts/save-image_write-bin.sh ${{ matrix.board.mcu }}
 
       - name: erase-region test
-        run: timeout 15 bash espflash/tests/scripts/erase-region.sh
+        run: timeout 30 bash espflash/tests/scripts/erase-region.sh
 
       - name: hold-in-reset test
         run: timeout 10 bash espflash/tests/scripts/hold-in-reset.sh

CHANGELOG.md

@@ -50,10 +50,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated bootloaders with `release/v5.4` ones from IDF (#857)
 - Refactor image formatting to allow supporting more image formats in a backward compatible way (#877)
 - Avoid having ESP-IDF format assumptions in the codebase (#877)
-- Automatically migrate `espflash@3` configuration files to the new format (#883)
-- `Flasher` now takes the `Connection` in new, instead of constructing the connection inside `Flasher::connect` (#882)
+- `Flasher` now takes the `Connection` in new, instead of constructing the connection inside `Flasher::connect` (#882, #885)
 - `detect_chip` has moved to the `Connection` struct (#882)
 - `Flasher::into_serial` has been replaced by `Flasher::into_connection` (#882)
+- Automatically migrate `espflash@3` configuration files to the new format (#883)
 
 ### Fixed
 

espflash/src/cli/mod.rs

@@ -453,6 +453,7 @@ pub fn connect(
         !no_verify,
         !no_skip,
         args.chip,
+        args.baud.or(config.project_config.baudrate),
     )?)
 }
 

espflash/src/connection/mod.rs

@@ -398,9 +398,9 @@ impl Connection {
         Ok(())
     }
 
-    /// Get the current baud rate of the serial port.
-    pub fn baud(&self) -> u32 {
-        self.baud
+    // Get the current baud rate of the serial port.
+    pub fn baud(&self) -> Result<u32, Error> {
+        Ok(self.serial.baud_rate()?)
     }
 
     /// Run a command with a timeout defined by the command type.

espflash/src/flasher/mod.rs

@@ -648,6 +648,7 @@ impl Flasher {
         verify: bool,
         skip: bool,
         chip: Option<Chip>,
+        baud: Option<u32>,
     ) -> Result<Self, Error> {
         // The connection should already be established with the device using the
         // default baud rate of 115,200 and timeout of 3 seconds.
@@ -706,9 +707,11 @@ impl Flasher {
 
         // Now that we have established a connection and detected the chip and flash
         // size, we can set the baud rate of the connection to the configured value.
-        if flasher.connection.baud() > 115_200 {
-            warn!("Setting baud rate higher than 115,200 can cause issues");
-            flasher.change_baud(flasher.connection.baud())?;
+        if let Some(baud) = baud {
+            if baud > 115_200 {
+                warn!("Setting baud rate higher than 115,200 can cause issues");
+                flasher.change_baud(baud)?;
+            }
         }
 
         Ok(flasher)
@@ -1132,7 +1135,7 @@ impl Flasher {
         debug!("Change baud to: {}", baud);
 
         let prior_baud = match self.use_stub {
-            true => self.connection.baud(),
+            true => self.connection.baud()?,
             false => 0,
         };
 

espflash/src/targets/esp32.rs

@@ -149,7 +149,7 @@ impl Target for Esp32 {
     #[cfg(feature = "serialport")]
     fn crystal_freq(&self, connection: &mut Connection) -> Result<XtalFrequency, Error> {
         let uart_div = connection.read_reg(UART_CLKDIV_REG)? & UART_CLKDIV_MASK;
-        let est_xtal = (connection.baud() * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
+        let est_xtal = (connection.baud()? * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
         let norm_xtal = if est_xtal > 33 {
             XtalFrequency::_40Mhz
         } else {

espflash/src/targets/esp32c2.rs

@@ -76,7 +76,7 @@ impl Target for Esp32c2 {
     #[cfg(feature = "serialport")]
     fn crystal_freq(&self, connection: &mut Connection) -> Result<XtalFrequency, Error> {
         let uart_div = connection.read_reg(UART_CLKDIV_REG)? & UART_CLKDIV_MASK;
-        let est_xtal = (connection.baud() * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
+        let est_xtal = (connection.baud()? * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
         let norm_xtal = if est_xtal > 33 {
             XtalFrequency::_40Mhz
         } else {

espflash/src/targets/esp32c5.rs

@@ -78,7 +78,7 @@ impl Target for Esp32c5 {
     #[cfg(feature = "serialport")]
     fn crystal_freq(&self, connection: &mut Connection) -> Result<XtalFrequency, Error> {
         let uart_div = connection.read_reg(UART_CLKDIV_REG)? & UART_CLKDIV_MASK;
-        let est_xtal = (connection.baud() * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
+        let est_xtal = (connection.baud()? * uart_div) / 1_000_000 / XTAL_CLK_DIVIDER;
         let norm_xtal = if est_xtal > 45 {
             XtalFrequency::_48Mhz
         } else {

espflash/tests/scripts/flash.sh

@@ -53,3 +53,15 @@ if ! echo "$result" | grep -q "Hello world!"; then
     echo "Monitoring failed!"
     exit 1
 fi
+
+# Test with a higher baud rate
+result=$(timeout 15s espflash flash --no-skip --monitor --non-interactive --baud 921600 $app 2>&1 | tr -d '\0')
+echo "$result"
+if [[ ! $result =~ "Flashing has completed!" ]]; then
+    echo "Flashing failed!"
+    exit 1
+fi
+if ! echo "$result" | grep -q "Hello world!"; then
+    echo "Monitoring failed!"
+    exit 1
+fi