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

Author: SergioGasquez

.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' }}

.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

.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 }}
 

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
 

Cargo.lock

@@ -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:
 
 ```

cargo-espflash/README.md

@@ -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),

cargo-espflash/src/main.rs

@@ -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"]

espflash/Cargo.toml

@@ -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:

espflash/README.md

@@ -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),