Task: Firmware update via SFTP

.cargo/config.toml

@@ -3,33 +3,47 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 [alias]
-build-esp32   = "build --release --target xtensa-esp32-none-elf --features esp32"
-build-esp32c2 = "build --release --target riscv32imc-unknown-none-elf --features esp32c2"
-build-esp32c3 = "build --release --target riscv32imc-unknown-none-elf --features esp32c3"
+# No default features avoids selecting the default target (esp32c6) which would conflict with other target features.
+
+build-esp32 = "build --release --target xtensa-esp32-none-elf --no-default-features --features esp32 -Z build-std=core,alloc"
+build-esp32c2 = "build --release --target riscv32imc-unknown-none-elf --no-default-features --features esp32c2 "
+build-esp32c3 = "build --release --target riscv32imc-unknown-none-elf --no-default-features --features esp32c3 "
 # Available but not supported by esp-hal (yet).
-#build-esp32c5 = "build --release --target riscv32imac-unknown-none-elf --features esp32c5"
-build-esp32c6 = "build --release --target riscv32imac-unknown-none-elf --features esp32c6"
-build-esp32s2 = "build --profile esp32s2 --target xtensa-esp32s2-none-elf --features esp32s2"
-build-esp32s3 = "build --release --target xtensa-esp32s3-none-elf --features esp32s3"
-
-run-esp32   = "run --release --target xtensa-esp32-none-elf --features esp32"
-run-esp32c2 = "run --release --target riscv32imc-unknown-none-elf --features esp32c2"
-run-esp32c3 = "run --release --target riscv32imc-unknown-none-elf --features esp32c3"
+#build-esp32c5 = "build --release --target riscv32imac-unknown-none-elf --no-default-features --features esp32c5"
+build-esp32c6 = "build --release --target riscv32imac-unknown-none-elf --no-default-features --features esp32c6"
+# Debug build (too big for target and probe-rs doesn't work anyway)
+#build-esp32c6 = "build --target riscv32imac-unknown-none-elf --no-default-features --features esp32c6"
+build-esp32s2 = "build --profile esp32s2 --target xtensa-esp32s2-none-elf --no-default-features --features esp32s2 -Z build-std=core,alloc"
+build-esp32s3 = "build --release --target xtensa-esp32s3-none-elf --no-default-features --features esp32s3 -Z build-std=core,alloc"
+
+run-esp32 = "run --release --target xtensa-esp32-none-elf --no-default-features --features esp32 "
+run-esp32c2 = "run --release --target riscv32imc-unknown-none-elf --no-default-features --features esp32c2 "
+run-esp32c3 = "run --release --target riscv32imc-unknown-none-elf --no-default-features --features esp32c3 "
 # Available but not supported by esp-hal (yet).
-#run-esp32c5 = "run --release --target riscv32imac-unknown-none-elf --features esp32c5"
-run-esp32c6 = "run --release --target riscv32imac-unknown-none-elf --features esp32c6"
-run-esp32s2 = "run --profile esp32s2 --target xtensa-esp32s2-none-elf --features esp32s2"
-run-esp32s3 = "run --release --target xtensa-esp32s3-none-elf --features esp32s3"
+#run-esp32c5 = "run --release --target riscv32imac-unknown-none-elf --no-default-features --features esp32c5"
+run-esp32c6 = "run --release --target riscv32imac-unknown-none-elf --no-default-features --features esp32c6"
+
+# Debug build (too big for target and probe-rs doesn't work anyway)
+#run-esp32c6 = "run --target riscv32imac-unknown-none-elf --no-default-features --features esp32c6"
+run-esp32s2 = "run --profile esp32s2 --target xtensa-esp32s2-none-elf --no-default-features --features esp32s2 "
+run-esp32s3 = "run --release --target xtensa-esp32s3-none-elf --no-default-features --features esp32s3 "
+
+# Build ota-packer alias: I might need to modify it so when run it can run a build for target architecture, extract the binary from the elf image and then pack the ota file.
+ota-packer = "run --package ota --bin ota-packer --target x86_64-unknown-linux-gnu"
+
+# Test alias
+test-ota = "test --package ota --target x86_64-unknown-linux-gnu"
 
 [target.xtensa-esp32-none-elf]
 runner = "espflash flash --baud=921600 --monitor --chip esp32"
 rustflags = ["-C", "link-arg=-nostartfiles", '--cfg=feature="esp32"']
 [target.riscv32imc-unknown-none-elf]
 runner = "espflash flash --baud=921600 --monitor"
-rustflags = [ "-C", "force-frame-pointers"]
+rustflags = ["-C", "force-frame-pointers"]
 [target.riscv32imac-unknown-none-elf]
-runner = "espflash flash --baud=921600 --monitor"
-rustflags = [ "-C", "force-frame-pointers"]
+runner = "espflash flash --baud=921600 --partition-table partitions.csv --monitor"
+rustflags = ["-C", "force-frame-pointers"]
+
 [target.xtensa-esp32s2-none-elf]
 runner = "espflash flash --baud=921600 --monitor --chip esp32s2"
 rustflags = ["-C", "link-arg=-nostartfiles", '--cfg=feature="esp32s2"']
@@ -38,10 +52,23 @@ runner = "espflash flash --baud=921600 --monitor --chip esp32s3"
 rustflags = ["-C", "link-arg=-nostartfiles", '--cfg=feature="esp32s3"']
 
 
+# https://docs.espressif.com/projects/rust/esp-hal/1.0.0-beta.1/esp32c6/esp_hal/index.html#additional-configuration
 [env]
-ESP_LOG="INFO"
+ESP_LOG = "info"
+#ESP_HAL_CONFIG_PLACE_SWITCH_TABLES_IN_RAM=true
+#ESP_HAL_CONFIG_PLACE_ANON_IN_RAM=false
+#ESP_HAL_CONFIG_FLIP_LINK=false
+#ESP_HAL_CONFIG_STACK_GUARD_OFFSET=4096
+#ESP_HAL_CONFIG_STACK_GUARD_VALUE=3740121773
+#ESP_HAL_CONFIG_IMPL_CRITICAL_SECTION=true
 
+
+[build]
 target = "riscv32imac-unknown-none-elf"
+# target = "x86_64-unknown-linux-gnu"
 
 [unstable]
-build-std = ["core", "alloc"]
+build-std = []
+
+# build-std core and alloc has been moved as per alias parameter since 
+# `unstable` section MUST be global and cannot be definde per target.

.github/workflows/build.yml

@@ -4,9 +4,11 @@ on:
   push:
     branches:
       - main
+      - build-ota-packer
   pull_request:
-    branches:
+      branches:
       - main
+      - build-ota-packer
   workflow_dispatch:
 
 jobs:
@@ -20,7 +22,7 @@ jobs:
             # RISC-V devices:
             { soc: "esp32c2", toolchain: "stable" },
             { soc: "esp32c3", toolchain: "stable" },
-#            { soc: "esp32c5", toolchain: "stable" },
+##            { soc: "esp32c5", toolchain: "stable" },
             { soc: "esp32c6", toolchain: "stable" },
             # Xtensa devices:
             { soc: "esp32", toolchain: "esp" },
@@ -38,13 +40,13 @@ jobs:
         with:
           target: riscv32imc-unknown-none-elf,riscv32imac-unknown-none-elf
           toolchain: stable
-          components: rust-src
+          components: rust-src, clippy, rustfmt
       - name: Setup Rust toolchain for Xtensa
         if: ${{ contains(fromJson('["esp32", "esp32s2", "esp32s3"]'), matrix.device.soc) }}
         uses: esp-rs/xtensa-toolchain@v1.5
         with:
           ldproxy: false
-          version: 1.86.0.0
+          version: 1.88.0.0 # Bumped from 1.86.0
 
       - name: Build project
         run: cargo +${{ matrix.device.toolchain }} build-${{ matrix.device.soc }}
@@ -54,3 +56,20 @@ jobs:
         run: |
           cargo +${{ matrix.device.toolchain }} clippy --features ${{ matrix.device.soc }} --target riscv32imac-unknown-none-elf -- -D warnings
           cargo +${{ matrix.device.toolchain }} fmt -- --check
+
+  build-ota-packer:
+    name: Check OTA Packer
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Stable Rust Toolchain
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          target: riscv32imac-unknown-none-elf
+          # toolchain: nightly # Avoids issues with rust-src not available on stable
+          toolchain: stable # Avoids issues with rust-src not available on stable
+      - name: Build ota-packer
+        run: cargo build --package ota --bin ota-packer --target x86_64-unknown-linux-gnu

.gitignore

@@ -20,3 +20,6 @@ target/
 
 # VSCode workspace(s)
 *.code-workspace
+
+# Temporarily ignore book from this branch
+docs/book

.vscode/launch.json

@@ -37,6 +37,24 @@
                     "svdFile": "${workspaceFolder}/docs/svd/esp32c6.svd"
                 }
             ]
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests 'ota'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--package=ota",
+                    "--features=std",
+                    "--target=x86_64-unknown-linux-gnu",
+                    "--",
+                    "--nocapture",
+                    "--test-threads=1"
+                ]
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
         }
     ]
-}
+}

.vscode/settings.json

@@ -1,3 +1,11 @@
 {
-    "rust-analyzer.check.allTargets": false,
-}
+    "rust-analyzer.cargo.target": "riscv32imac-unknown-none-elf",
+    "rust-analyzer.cargo.noDefaultFeatures": true,
+    "rust-analyzer.cargo.features": [
+        "esp32c6"
+    ],
+    "rust-analyzer.cargo.extraArgs": [
+        "--release"
+    ],
+    "rust-analyzer.check.allTargets": false
+}