Merge pull request #601 from jannic/issue-599

Fix / document on-target tests
rp-rs · May 6, 2023 · b8d9124 · b8d9124
2 parents 06b98e0 + 8ac9115
commit b8d9124
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 125 deletions.
diff --git a/on-target-tests/Cargo.toml b/on-target-tests/Cargo.toml
@@ -24,10 +24,6 @@ harness = false
 name = "dma_spi_loopback_u16"
 harness = false
 
-[[test]]
-name = "dma_drop"
-harness = false
-
 [[test]]
 name = "dma_dyn"
 harness = false

diff --git a/on-target-tests/README.md b/on-target-tests/README.md
@@ -21,3 +21,15 @@ To run a specific test (to make developing tests faster)
 ```system
 CARGO_TARGET_THUMBV6M_NONE_EABI_RUNNER=probe-run cargo test --test my_new_test -- --chip rp2040
 ```
+
+## Prerequisites
+
+Some of the tests need connections between specific pins.
+
+Currently, the following connections are required:
+
+- Connect GPIO 4 to GPIO 7 (pins 6 and 10 an a Pico) for the SPI loopback tests
+
+If you add tests that need some hardware setup, make sure that they are
+compatible to the existing on-target tests, so all tests can be run with
+a single configuration.
diff --git a/on-target-tests/tests/dma_drop.rs b/on-target-tests/tests/dma_drop.rs
diff --git a/on-target-tests/tests/dma_spi_loopback_u16.rs b/on-target-tests/tests/dma_spi_loopback_u16.rs
@@ -1,3 +1,5 @@
+//! This test needs a connection between GPIO 4 and GPIO 7 (pins 6 and 10 an a Pico)
+
 #![no_std]
 #![no_main]
 #![cfg(test)]

diff --git a/on-target-tests/tests/dma_spi_loopback_u8.rs b/on-target-tests/tests/dma_spi_loopback_u8.rs
@@ -1,3 +1,5 @@
+//! This test needs a connection between GPIO 4 and GPIO 7 (pins 6 and 10 an a Pico)
+
 #![no_std]
 #![no_main]
 #![cfg(test)]