Skip to content

Commit da59875

Browse files
Improve documentation of test_runner connections
Add a list of things that need to be connected for test_runner to pass and an annotated image of where to connect them.
1 parent e32eb27 commit da59875

File tree

2 files changed

+205
-0
lines changed

2 files changed

+205
-0
lines changed

doc/dev/img/test_runner-ext-conn.svg

Lines changed: 184 additions & 0 deletions
Loading

doc/dev/release-procedure.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,27 @@ cp sonata-vX.Y.bit.slot3.uf2 ../
6565
Run tests on simulation (note python3.11 or above required).
6666
FPGA testing is currently done in CI and requires quite a few add-ons to your board.
6767

68+
test_runner external connections:
69+
70+
- microSD card slot (SD1) -> microSD card with formatting & contents as specified by *sdcard_tests.hh*.
71+
- Loopback connections
72+
- mikroBUS (P7) MB10 "PWM" pin -> PMOD0 pin 1/IO1 (top-row, 6th from left)
73+
- mikroBUS (P6) MB3 "CIPO" pin -> mikroBUS (P6) MB4 "COPI" pin
74+
- mikroBUS (P7) MB8 "RX" pin -> mikroBUS (P7) MB7 "TX" pin
75+
- Arduino (P4) "D0" -> Arduino (P4) "D1"
76+
- Arduino (P4) "D8" -> Arduino (P4) "D9"
77+
- PMOD0 pin 8/IO6 (bottom-row, 5th from left) -> PMOD0 pin 10/IO8 (bottom-row, 3rd from left)
78+
- UART header (P12) TX0 -> UART header (P12) RXC
79+
- Raspberry Pi Header (P3) -> Raspberry Pi Sense HAT
80+
- qwiic1 (J7) -> Sparkfun AS6212 temperature sensor module
81+
- PMOD1 -> Digilent PmodSF3 SPI flash module
82+
- User USB -> USB type-A port of any USB Host
83+
- Main USB -> a USB port of your computer
84+
85+
![Annotated image showing where to make the specified external connections](img/test_runner-ext-conn.svg)
86+
87+
Run tests in Verilator sim.
88+
6889
```shell
6990
# Build the simulator
7091
fusesoc --cores-root=. run --target=sim --tool=verilator --setup --build lowrisc:sonata:system

0 commit comments

Comments
 (0)