Remove support for Raspberry Pi's internal UART peripherals (#585)

* feat: Remove raspberry feature * feat: Replace Interface types * feat: Remove interface mod * docs: Update changelog
esp-rs · Feb 16, 2024 · 0a5d5e6 · 0a5d5e6
1 parent fff36e4
commit 0a5d5e6
Show file tree

Hide file tree

Showing 19 changed files with 105 additions and 375 deletions.
diff --git a/.github/actions/package/action.yml b/.github/actions/package/action.yml
@@ -4,8 +4,6 @@ inputs:
     required: false
   github_token:
     required: true
-  features:
-    required: false
   target:
     required: true
   runs_on:
@@ -22,7 +20,7 @@ runs:
     - name: Build
       shell: bash
       run: |
-        cargo build --release --all --target ${{ inputs.target }} ${{ inputs.features }}
+        cargo build --release --all --target ${{ inputs.target }}
 
     - name: Compress (Unix)
       if: ${{ inputs.runs_on != 'windows-2022' }}

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,11 +43,9 @@ jobs:
           - os: "ubuntu-22.04"
             target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - os: "ubuntu-22.04"
             target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
     runs-on: ${{ matrix.platform.os }}
 
     steps:
@@ -59,7 +57,7 @@ jobs:
           arch: ${{ matrix.platform.arch }}
           target: ${{ matrix.platform.target }}
 
-      - run: cargo check ${{ matrix.platform.features }}
+      - run: cargo check
 
   check-lib:
     name: Check lib (${{ matrix.platform.target }})
@@ -71,10 +69,8 @@ jobs:
             arch: "x86_64"
           - target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
     runs-on: ubuntu-22.04
 
     steps:
@@ -86,7 +82,7 @@ jobs:
           arch: ${{ matrix.platform.arch }}
           target: ${{ matrix.platform.target }}
 
-      - run: cargo check -p espflash --lib --no-default-features ${{ matrix.platform.features }}
+      - run: cargo check -p espflash --lib --no-default-features
 
   msrv:
     name: Check MSRV (${{ matrix.platform.target }})
@@ -98,10 +94,8 @@ jobs:
             arch: "x86_64"
           - target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
     runs-on: ubuntu-22.04
 
     steps:
@@ -114,7 +108,7 @@ jobs:
           target: ${{ matrix.platform.target }}
           toolchain: "1.73"
 
-      - run: cargo check ${{ matrix.platform.features }}
+      - run: cargo check
 
   # --------------------------------------------------------------------------
   # Test
@@ -129,10 +123,8 @@ jobs:
             arch: "x86_64"
           - target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
     runs-on: ubuntu-22.04
 
     steps:
@@ -144,7 +136,7 @@ jobs:
           arch: ${{ matrix.platform.arch }}
           target: ${{ matrix.platform.target }}
 
-      - run: cargo test --lib ${{ matrix.platform.features }}
+      - run: cargo test --lib
 
   # --------------------------------------------------------------------------
   # Lint
@@ -159,10 +151,8 @@ jobs:
             arch: "x86_64"
           - target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
     runs-on: ubuntu-22.04
 
     steps:
@@ -175,7 +165,7 @@ jobs:
           target: ${{ matrix.platform.target }}
           components: clippy
 
-      - run: cargo clippy ${{ matrix.platform.features }} -- -D warnings -A clippy::too_many_arguments
+      - run: cargo clippy -- -D warnings -A clippy::too_many_arguments
 
   rustfmt:
     name: Rustfmt

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,11 +24,9 @@ jobs:
           - os: "ubuntu-20.04"
             target: "aarch64-unknown-linux-gnu"
             arch: "arm64"
-            features: "--features=raspberry"
           - os: "ubuntu-20.04"
             target: "armv7-unknown-linux-gnueabihf"
             arch: "armhf"
-            features: "--features=raspberry"
           # Windows
           - os: "windows-2022"
             target: "x86_64-pc-windows-msvc"
@@ -50,7 +48,6 @@ jobs:
         with:
           arch: ${{ matrix.platform.arch }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          features: ${{ matrix.platform.features }}
           target: ${{ matrix.platform.target }}
           runs_on: ${{ matrix.platform.os }}
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Remove support for the ESP8266 (#576)
 - Remove the direct boot image format (#577)
+- Remove support for Raspberry Pi's internal UART peripherals (#585)
 
 ## [2.1.0] - 2023-10-03
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cargo-espflash/README.md b/cargo-espflash/README.md
@@ -50,12 +50,6 @@ Alternatively, you can use [cargo-binstall] to download pre-compiled artifacts f
 cargo binstall cargo-espflash
 ```
 
-If you would like to flash from a Raspberry Pi using the built-in UART peripheral, you can enable the `raspberry` feature (note that this is not available if using [cargo-binstall]):
-
-```bash
-cargo install cargo-espflash --features=raspberry
-```
-
 By default, in Unix systems, we use the [`vendored-openssl` Cargo feature] which may require additional tools such as `perl` and `make`. To disable this feature, use:
 
 ```

diff --git a/cargo-espflash/src/main.rs b/cargo-espflash/src/main.rs
@@ -352,7 +352,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
         };
 
         monitor(
-            flasher.into_interface(),
+            flasher.into_serial(),
             Some(&elf_data),
             pid,
             args.flash_args.monitor_baud.unwrap_or(default_baud),

diff --git a/espflash/Cargo.toml b/espflash/Cargo.toml
@@ -47,7 +47,6 @@ md-5 = "0.10.6"
 miette = { version = "7.0.0", features = ["fancy"] }
 parse_int = { version = "0.6.0", optional = true }
 regex = { version = "1.10.3", optional = true }
-rppal = { version = "0.17.1", optional = true }
 serde = { version = "1.0.196", features = ["derive"] }
 serialport = { version = "4.3.0", optional = true }
 sha2 = "0.10.8"
@@ -85,4 +84,3 @@ cli = [
 ]
 serialport = ["dep:serialport"]
 
-raspberry = ["dep:rppal"]
diff --git a/espflash/README.md b/espflash/README.md
@@ -52,12 +52,6 @@ Alternatively, you can use [cargo-binstall] to download pre-compiled artifacts f
 cargo binstall espflash
 ```
 
-If you would like to flash from a Raspberry Pi using the built-in UART peripheral, you can enable the `raspberry` feature (note that this is not available if using [cargo-binstall]):
-
-```bash
-cargo install espflash --features=raspberry
-```
-
 [libuv]: https://libuv.org/
 [cargo-binstall]: https://github.com/cargo-bins/cargo-binstall
 [releases]: https://github.com/esp-rs/espflash/releases
@@ -129,12 +123,6 @@ or `cargo add espflash --no-default-features`
 
 We disable the `default-features` to opt-out the `cli` feature, which is enabled by default; you likely will not need any of these types or functions in your application so there’s no use pulling in the extra dependencies.
 
-Just like when using `espflash` as an application, you can enable the raspberry feature to allow your dependent application to use the Raspberry Pi’s built-in UART:
-
-```toml
-espflash = { version = "2.1", default-features = false, features = ["raspberry"] }
-```
-
 ## Configuration File
 
 The configuration file allows you to define various parameters for your application:

diff --git a/espflash/src/bin/espflash.rs b/espflash/src/bin/espflash.rs
@@ -287,7 +287,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
         };
 
         monitor(
-            flasher.into_interface(),
+            flasher.into_serial(),
             Some(&elf_data),
             pid,
             args.flash_args.monitor_baud.unwrap_or(default_baud),

diff --git a/espflash/src/cli/config.rs b/espflash/src/cli/config.rs
@@ -26,12 +26,6 @@ use crate::error::Error;
 pub struct Connection {
     /// Name of the serial port used for communication
     pub serial: Option<String>,
-    /// Data Transmit Ready pin
-    #[cfg(feature = "raspberry")]
-    pub dtr: Option<u8>,
-    /// Ready To Send pin
-    #[cfg(feature = "raspberry")]
-    pub rts: Option<u8>,
 }
 
 /// A configured, known USB device

diff --git a/espflash/src/cli/mod.rs b/espflash/src/cli/mod.rs
@@ -19,7 +19,7 @@ use esp_idf_part::{DataType, Partition, PartitionTable};
 use indicatif::{style::ProgressStyle, HumanCount, ProgressBar};
 use log::{debug, info, warn};
 use miette::{IntoDiagnostic, Result, WrapErr};
-use serialport::{SerialPortType, UsbPortInfo};
+use serialport::{FlowControl, SerialPortType, UsbPortInfo};
 
 use self::{
     config::Config,
@@ -34,7 +34,6 @@ use crate::{
         parse_partition_table, FlashData, FlashFrequency, FlashMode, FlashSize, Flasher,
         ProgressCallbacks,
     },
-    interface::Interface,
     targets::{Chip, XtalFrequency},
 };
 
@@ -68,14 +67,6 @@ pub struct ConnectArgs {
     /// Serial port connected to target device
     #[arg(short = 'p', long, env = "ESPFLASH_PORT")]
     pub port: Option<String>,
-    /// DTR pin to use for the internal UART hardware. Uses BCM numbering.
-    #[cfg(feature = "raspberry")]
-    #[cfg_attr(feature = "raspberry", clap(long))]
-    pub dtr: Option<u8>,
-    /// RTS pin to use for the internal UART hardware. Uses BCM numbering.
-    #[cfg(feature = "raspberry")]
-    #[cfg_attr(feature = "raspberry", clap(long))]
-    pub rts: Option<u8>,
 }
 
 /// Generate completions for the given shell
@@ -306,15 +297,10 @@ pub fn connect(
     info!("Serial port: '{}'", port_info.port_name);
     info!("Connecting...");
 
-    #[cfg(feature = "raspberry")]
-    let (dtr, rts) = (
-        args.dtr.or(config.connection.dtr),
-        args.rts.or(config.connection.rts),
-    );
-    #[cfg(not(feature = "raspberry"))]
-    let (dtr, rts) = (None, None);
-
-    let interface = Interface::new(&port_info, dtr, rts)
+    let serial_port = serialport::new(&port_info.port_name, 115_200)
+        .flow_control(FlowControl::None)
+        .open_native()
+        .map_err(Error::from)
         .wrap_err_with(|| format!("Failed to open serial port {}", port_info.port_name))?;
 
     // NOTE: since `get_serial_port_info` filters out all PCI Port and Bluetooth
@@ -335,7 +321,7 @@ pub fn connect(
     };
 
     Ok(Flasher::connect(
-        interface,
+        *Box::new(serial_port),
         port_info,
         args.baud.or(config.baudrate),
         !args.no_stub,
@@ -448,7 +434,7 @@ pub fn serial_monitor(args: MonitorArgs, config: &Config) -> Result<()> {
     };
 
     monitor(
-        flasher.into_interface(),
+        flasher.into_serial(),
         elf.as_deref(),
         pid,
         args.connect_args.baud.unwrap_or(default_baud),

diff --git a/espflash/src/cli/monitor/mod.rs b/espflash/src/cli/monitor/mod.rs
@@ -11,7 +11,7 @@
 //! in our monitor the output is displayed immediately upon reading.
 
 use std::{
-    io::{stdout, ErrorKind, Write},
+    io::{stdout, ErrorKind, Read, Write},
     time::Duration,
 };
 
@@ -21,12 +21,13 @@ use crossterm::{
 };
 use log::error;
 use miette::{IntoDiagnostic, Result};
+#[cfg(feature = "serialport")]
+use serialport::SerialPort;
 use strum::{Display, EnumIter, EnumString, VariantNames};
 
 use crate::{
     cli::monitor::parser::{InputParser, ResolvingPrinter},
-    connection::reset_after_flash,
-    interface::Interface,
+    connection::{reset_after_flash, Port},
 };
 
 pub mod parser;
@@ -63,9 +64,9 @@ impl Drop for RawModeGuard {
     }
 }
 
-/// Open a serial monitor on the given interface, using the given input parser.
+/// Open a serial monitor on the given serial port, using the given input parser.
 pub fn monitor(
-    mut serial: Interface,
+    mut serial: Port,
     elf: Option<&[u8]>,
     pid: u16,
     baud: u32,
@@ -78,12 +79,8 @@ pub fn monitor(
 
     // Explicitly set the baud rate when starting the serial monitor, to allow using
     // different rates for flashing.
+    serial.set_baud_rate(baud).into_diagnostic()?;
     serial
-        .serial_port_mut()
-        .set_baud_rate(baud)
-        .into_diagnostic()?;
-    serial
-        .serial_port_mut()
         .set_timeout(Duration::from_millis(5))
         .into_diagnostic()?;
 
@@ -100,7 +97,7 @@ pub fn monitor(
 
     let mut buff = [0; 1024];
     loop {
-        let read_count = match serial.serial_port_mut().read(&mut buff) {
+        let read_count = match serial.read(&mut buff) {
             Ok(count) => Ok(count),
             Err(e) if e.kind() == ErrorKind::TimedOut => Ok(0),
             Err(e) if e.kind() == ErrorKind::Interrupted => continue,
@@ -126,11 +123,8 @@ pub fn monitor(
                 }
 
                 if let Some(bytes) = handle_key_event(key) {
-                    serial
-                        .serial_port_mut()
-                        .write_all(&bytes)
-                        .into_diagnostic()?;
-                    serial.serial_port_mut().flush().into_diagnostic()?;
+                    serial.write_all(&bytes).into_diagnostic()?;
+                    serial.flush().into_diagnostic()?;
                 }
             }
         }