Skip to content

Improve documentation of test_runner connections #397

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.

Sign up for GitHub

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

Merged
elliotb-lowrisc merged 1 commit into from
Apr 4, 2025
Merged

Improve documentation of test_runner connections #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
184 changes: 184 additions & 0 deletions doc/dev/img/test_runner-ext-conn.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions doc/dev/release-procedure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,27 @@ cp sonata-vX.Y.bit.slot3.uf2 ../
Run tests on simulation (note python3.11 or above required).
FPGA testing is currently done in CI and requires quite a few add-ons to your board.

test_runner external connections:

- microSD card slot (SD1) -> microSD card with formatting & contents as specified by *sdcard_tests.hh*.
- Loopback connections
- mikroBUS (P7) MB10 "PWM" pin -> PMOD0 pin 1/IO1 (top-row, 6th from left)
- mikroBUS (P6) MB3 "CIPO" pin -> mikroBUS (P6) MB4 "COPI" pin
- mikroBUS (P7) MB8 "RX" pin -> mikroBUS (P7) MB7 "TX" pin
- Arduino (P4) "D0" -> Arduino (P4) "D1"
- Arduino (P4) "D8" -> Arduino (P4) "D9"
- PMOD0 pin 8/IO6 (bottom-row, 5th from left) -> PMOD0 pin 10/IO8 (bottom-row, 3rd from left)
- UART header (P12) TX0 -> UART header (P12) RXC
- Raspberry Pi Header (P3) -> Raspberry Pi Sense HAT
- qwiic1 (J7) -> Sparkfun AS6212 temperature sensor module
- PMOD1 -> Digilent PmodSF3 SPI flash module
- User USB -> USB type-A port of any USB Host
- Main USB -> a USB port of your computer

![Annotated image showing where to make the specified external connections](img/test_runner-ext-conn.svg)

Run tests in Verilator sim.

```shell
# Build the simulator
fusesoc --cores-root=. run --target=sim --tool=verilator --setup --build lowrisc:sonata:system
Expand Down
Loading