Headsail - Virtual Platform

Directories

Directory	Description
.github	Runnable specs for CI runs
doc	Auxiliary documentation
examples	C and Rust code to run on device
scripts	Renode & Shell scripts to run the virtual platform
vp	The virtual platform

Software testing requirements

1. Renode 1.14, the high-level hardware simulator https://github.com/renode/renode
2. Rust https://rustup.rs/, MSRV 1.81
3. Codegen backend for target cores
   • HPC
     • rustup target add riscv64imac-unknown-none-elf
   • SysCtrl (VP)
     • rustup target add riscv32im-unknown-none-elf
   • SysCtrl (ASIC)
     • rustup target add riscv32imc-unknown-none-elf
4. (optional) Install just, the command runner https://github.com/casey/just

Run UART example (VP)

cd examples/headsail-bsp
cargo run --example uart0 -Fvp -Fhpc-rt -Fpanic-apb-uart0 --target riscv64imac-unknown-none-elf

or if you're a just user:

just run uart0

Run DLA example

cd examples/hpc/hello-dla
cargo run --example dla

Run Robot Tests

You'll need to have built the binaries prior to running Robot Tests.

renode-test scripts/robot/hello_dla.robot

Run an arbitrary ELF on Headsail (VP)

./scripts/run_on_hpc.sh $bin
./scripts/run_on_sysctrl.sh $bin

Run an example on ASIC using both SysCtrl & HPC

I've set up a relatively convenient build using OpenOCD scripts & Justfiles.

1. To boot HPC, you will need to be connected on SysCtrl via OpenOCD.

   cd examples/headsail-bsp/openocd
   openocd -f sysctrl.cfg

2. On another terminal, use a just to run a bootloader to initialize HPC (remember to press 'c' to make the program run):

   cd examples/sysctrl/hello-sysctrl
   just asic init_hpc

3. Then disconnect OpenOCD from SysCtrl, and disconnect and re-connect the JTAG_TRST jumper cable.

4. Connect to HPC via OpenOCD (on the first terminal):

   openocd -f hpc.cfg

   Connection to HPC sometimes fails once before succeeding, so if at first you don't succeed, try again!

5. On a third terminal, run a program on HPC

   cd examples/hpc/hello-dla
   just asic apb_uart0

   GDB might report "load failed" but you might be able to just 'c' it. It seems to work most of the time ":D"

You can replace the final step with any GDB command of the general form:

riscv64-unknown-elf-gdb -x connect-and-load.gdb your_binary_here

connect-and-load.gdb scripts are sprinkled all over the place.