Merge pull request #28 from Jim-Hodapp-Coaching/add_initial_test_infrastructure

Author: jhodapp

.gitignore

@@ -1,6 +1,7 @@
 # Generated by Cargo
 # will have compiled files and executables
 /target/
+/cross/target/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

Cargo.toml

@@ -1,45 +1,10 @@
-[package]
-authors = [
-    "Jim Hodapp",
-    "Caleb Bourg",
-    "Glyn Matthews"
+[workspace]
+members = [
+    "esp32-wroom-rp",
+    "host-tests",
 ]
-edition = "2021"
-readme = "README.md"
-name = "esp32-wroom-rp"
-version = "0.1.0"
-resolver = "2"
-description = "Rust-based Espressif ESP32-WROOM WiFi driver crate for RP2040 series microcontroller boards."
-
-[lib]
-name = "esp32_wroom_rp"
-
-[dependencies]
-cortex-m = "0.7"
-cortex-m-rt = "0.7"
-embedded-hal = { version = "=1.0.0-alpha.7" }
-eh-02 = { version = "0.2", package="embedded-hal"  }
-embedded-time = "0.12"
-
-defmt = "0.3"
-defmt-rtt = "0.3"
-heapless = "0.7.16"
-panic-probe = { version = "0.3", features = ["print-rtt"] }
 
-rp2040-hal = { version = "0.5", features=["rt", "eh1_0_alpha"] }
-rp2040-boot2 = { version = "0.2" }
-cortex-m-semihosting = "0.5"
-
-[features]
-default = [
-    "defmt-default",
-]
-defmt-default = []
-defmt-trace = []
-defmt-debug = []
-defmt-info = []
-defmt-warn = []
-defmt-error = []
+resolver = "2"
 
 # cargo build/run
 [profile.dev]
@@ -92,6 +57,3 @@ debug-assertions = false
 incremental = false
 lto = 'fat'
 opt-level = 3
-
-[[example]]
-name = "get_fw_version"

README.md

@@ -9,8 +9,9 @@ Future implementations will support the [ESP32-WROOM-DA](https://www.espressif.c
 
 ## Usage
 
-```
+```rust
 use esp32_wroom_rp::wifi;
+use embedded_hal::blocking::delay::DelayMs;
 
 let spi_miso = pins.gpio16.into_mode::<hal::gpio::FunctionSpi>();
 let spi_sclk = pins.gpio18.into_mode::<hal::gpio::FunctionSpi>();
@@ -122,12 +123,36 @@ The following table lists the pin name and pin number to properly wire between a
 - flip-link - this allows you to detect stack-overflows on the first core, which is the only supported target for now.
 
 ## Installation of development dependencies
-```
+```sh
 rustup target install thumbv6m-none-eabi
 cargo install flip-link
 cargo install probe-run
 ```
 
+## Building the crate and running the examples
+
+To build the esp32-wroom-rp crate:
+```sh
+cargo build
+```
+
+To build an example (e.g. get_fw_version):
+```sh
+cd cross
+cargo build --bin get_fw_version
+```
+
+To run an example (e.g. get_fw_version):
+```sh
+cd cross
+cargo run --bin get_fw_version
+```
+
+## Running the crate's unit tests
+```sh
+cargo test
+```
+
 ## Getting Involved
 
 This project launched in April, 2022). See the main page section [Getting Involved](https://github.com/Jim-Hodapp-Coaching#getting-involved) for more info on how to contribute to this project and the Rust Never Sleeps community.

.cargo/config renamed to cross/.cargo/config

@@ -0,0 +1,17 @@
+[workspace]
+members = [
+  "get_fw_version",
+  "join",
+]
+
+[profile.dev]
+codegen-units = 1
+incremental = false
+lto = 'fat'
+opt-level = 's'
+
+[profile.test]
+codegen-units = 1
+incremental = false
+lto = 'fat'
+opt-level = 's'

cross/Cargo.toml

@@ -0,0 +1,40 @@
+[package]
+authors = [
+    "Jim Hodapp",
+    "Caleb Bourg",
+    "Glyn Matthews"
+]
+edition = "2021"
+name = "get_fw_version"
+version = "0.1.0"
+description = "Example target application that gets the Nina firmware version with the Rust-based Espressif ESP32-WROOM WiFi driver crate for RP2040 series microcontroller boards."
+
+# makes `cargo check --all-targets` work
+[[bin]]
+name = "get_fw_version"
+bench = false
+doctest = false
+test = false
+
+[dependencies]
+defmt = "0.3.0"
+defmt-rtt = "0.3.0"
+cortex-m = "0.7"
+cortex-m-rt = "0.7"
+embedded-hal = { version = "0.2", features=["unproven"] }
+embedded-time = "0.12"
+esp32-wroom-rp = { path = "../../esp32-wroom-rp" }
+panic-probe = { version = "0.3.0", features = ["print-rtt"] }
+
+rp2040-hal = { version = "0.5", features=["rt", "eh1_0_alpha"] }
+rp2040-boot2 = { version = "0.2" }
+
+[features]
+default = ['defmt-default']
+# these features are required by defmt
+defmt-default = []
+defmt-trace = []
+defmt-debug = []
+defmt-info = []
+defmt-warn = []
+defmt-error = []

build.rs renamed to cross/build.rs

@@ -21,7 +21,7 @@ use panic_probe as _;
 // Alias for our HAL crate
 use rp2040_hal as hal;
 
-use eh_02::spi::MODE_0;
+use embedded_hal::spi::MODE_0;
 use embedded_time::fixed_point::FixedPoint;
 use embedded_time::rate::Extensions;
 use hal::clocks::Clock;
@@ -37,24 +37,6 @@ pub static BOOT2: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
 /// if your board has a different frequency
 const XTAL_FREQ_HZ: u32 = 12_000_000u32;
 
-// Until cortex_m implements the DelayUs trait needed for embedded-hal-1.0.0,
-// provide a wrapper around it
-pub struct DelayWrap(cortex_m::delay::Delay);
-
-impl embedded_hal::delay::blocking::DelayUs for DelayWrap {
-    type Error = core::convert::Infallible;
-
-    fn delay_us(&mut self, us: u32) -> Result<(), Self::Error> {
-        self.0.delay_us(us);
-        Ok(())
-    }
-
-    fn delay_ms(&mut self, ms: u32) -> Result<(), Self::Error> {
-        self.0.delay_ms(ms);
-        Ok(())
-    }
-}
-
 /// Entry point to our bare-metal application.
 ///
 /// The `#[entry]` macro ensures the Cortex-M start-up code calls this function
@@ -81,10 +63,10 @@ fn main() -> ! {
     .ok()
     .unwrap();
 
-    let mut delay = DelayWrap(cortex_m::delay::Delay::new(
+    let mut delay = cortex_m::delay::Delay::new(
         core.SYST,
         clocks.system_clock.freq().integer(),
-    ));
+    );
 
     // The single-cycle I/O block controls our GPIO pins
     let sio = hal::Sio::new(pac.SIO);

cross/get_fw_version/Cargo.toml

@@ -0,0 +1,40 @@
+[package]
+authors = [
+    "Jim Hodapp",
+    "Caleb Bourg",
+    "Glyn Matthews"
+]
+edition = "2021"
+name = "join"
+version = "0.1.0"
+description = "Example target application that joins/leaves an SSID with the Rust-based Espressif ESP32-WROOM WiFi driver crate for RP2040 series microcontroller boards."
+
+# makes `cargo check --all-targets` work
+[[bin]]
+name = "join"
+bench = false
+doctest = false
+test = false
+
+[dependencies]
+defmt = "0.3.0"
+defmt-rtt = "0.3.0"
+cortex-m = "0.7"
+cortex-m-rt = "0.7"
+embedded-hal = { version = "0.2", features=["unproven"] }
+embedded-time = "0.12"
+esp32-wroom-rp = { path = "../../esp32-wroom-rp" }
+panic-probe = { version = "0.3.0", features = ["print-rtt"] }
+
+rp2040-hal = { version = "0.5", features=["rt", "eh1_0_alpha"] }
+rp2040-boot2 = { version = "0.2" }
+
+[features]
+default = ['defmt-default']
+# these features are required by defmt
+defmt-default = []
+defmt-trace = []
+defmt-debug = []
+defmt-info = []
+defmt-warn = []
+defmt-error = []