Skip to content

Commit

Permalink
tests: drivers: gpio_basic_api: add README
Browse files Browse the repository at this point in the history
Successful execution of this test requires a board-specific overlay to
identify the test pins, and that the test pins be shorted together.
Document this requirement.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
  • Loading branch information
pabigot authored and jhedberg committed Feb 12, 2020
1 parent 47cf5d2 commit 461b20a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions tests/drivers/gpio/gpio_basic_api/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
GPIO 2-Pin Test
###############

This application tests the GPIO subsystem using a hardware configuration
where two GPIOs are directly wired together. The test pins are
identified through a test-specific devicetree binding in the `dts/`
subdirectory, implemented for specific boards by overlay files in the
`boards/` directory.

For some boards `src/main.c` may also need to be extended to configure
the selected pins for use as GPIOs.

Only boards for which an overlay is present can pass this test. Boards
without an overlay, or for which the required wiring is not provided,
will fail with an error like this:

Validate device GPIO_0
Check GPIO_0 output 2 connected to input 3
FATAL output pin not wired to input pin? (out high => in low)

No special build options are required to make use of the overlay.

0 comments on commit 461b20a

Please sign in to comment.