Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tests: drivers: gpio_basic_api: add README #22639

Merged
merged 1 commit into from
Feb 12, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.