Ota partition support (#3354)

* Add basic OTA functionality

* Return Result from Ota::new

* Restructured

* Enable `ota` by default

* Include metadata to let tooling know we need an ota-data partition

* More docs

* CHANGELOG.md

* Make OSX happy to run tests

* Another try

* OSX...

* OSX, again

* Add tests

* Prefer ROM CRC function

* Unconditionally include the "ota" feature

* Renaming and docs

* de-noise tests

* De-duplicate

* Address more review comments

* Review comments and Clippy

Author: bjoernQ

.github/workflows/ci.yml

@@ -182,4 +182,4 @@ jobs:
       - run: cd esp-config && cargo test --features build
 
       # Run tests in esp-bootloader-esp-idf
-      - run: cd esp-bootloader-esp-idf && cargo test
+      - run: cd esp-bootloader-esp-idf && cargo test --features=std

esp-bootloader-esp-idf/CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support reading partition tables and conveniently read/write partition content (#3316)
 
+- OTA-DATA partition support (#3354)
+
 ### Changed
 
 ### Fixed

esp-bootloader-esp-idf/Cargo.toml

@@ -19,9 +19,11 @@ document-features = "0.2.11"
 esp-config = { version = "0.3.0", path = "../esp-config" }
 embedded-storage = "0.3.1"
 log = { version = "0.4.26", optional = true }
-md-5 = { version = "0.10.6", default-features = false, optional = true }
 strum = { version = "0.27.1", default-features = false, features = ["derive"] }
 
+crc = { version = "3.0.0", optional = true }
+md-5 = { version = "0.10.6", default-features = false, optional = true }
+
 [build-dependencies]
 chrono = { version = "0.4.20", default-features = false, features = ["clock"] }
 esp-config = { version = "0.3.0", path = "../esp-config", features = ["build"] }
@@ -37,3 +39,6 @@ log = ["dep:log"]
 
 ## Enable support for `defmt`
 defmt = ["dep:defmt"]
+
+# Replace ROM functions with pure Rust implementations, needed for tests.
+std = ["dep:crc"]

esp-bootloader-esp-idf/src/lib.rs

@@ -26,8 +26,28 @@
 // MUST be the first module
 mod fmt;
 
+#[cfg(not(feature = "std"))]
+mod rom;
+#[cfg(not(feature = "std"))]
+pub(crate) use rom as crypto;
+
+#[cfg(feature = "std")]
+mod non_rom;
+#[cfg(feature = "std")]
+pub(crate) use non_rom as crypto;
+
 pub mod partitions;
 
+pub mod ota;
+
+// We run tests on the host which happens to be MacOS machines and mach-o
+// doesn't like `link-sections` this way
+#[cfg(not(target_os = "macos"))]
+#[link_section = ".espressif.metadata"]
+#[used]
+#[export_name = "bootloader.NAME"]
+static OTA_FEATURE: [u8; 7] = *b"ESP-IDF";
+
 /// ESP-IDF compatible application descriptor
 ///
 /// This gets populated by the [esp_app_desc] macro.

esp-bootloader-esp-idf/src/non_rom.rs

@@ -0,0 +1,30 @@
+use crc::{Algorithm, Crc};
+
+static ALGO_CRC32_NORMAL: Algorithm<u32> = Algorithm {
+    width: 32,
+    poly: 0x04c11db7,
+    init: 0,
+    refin: true,
+    refout: true,
+    xorout: 0xffffffff,
+    check: 0,
+    residue: 0,
+};
+
+pub struct Crc32 {
+    algo: Crc<u32>,
+}
+
+impl Crc32 {
+    pub fn new() -> Self {
+        Self {
+            algo: Crc::<u32>::new(&ALGO_CRC32_NORMAL),
+        }
+    }
+
+    pub fn crc(&self, data: &[u8]) -> u32 {
+        let mut digest = self.algo.digest();
+        digest.update(&data);
+        digest.finalize()
+    }
+}