End User Guide
This is a condensed version of what is provided in https://github.com/OpenCAPI/oc-accel. Assuming all tools are already installed, which is the case.
Compiling a bitfile on hal-fpga-x86
ssh into hal-fhga-x86 with -X to enable X forwarding. This also implies your client can receive X forwarding.
source /opt/xilinx/Vitis/2019.2/settings64.sh git clone https://github.com/OpenCAPI/ocse.git git clone https://github.com/OpenCAPI/oc-accel.git cd oc-accel make snap_config ## this uses an opensource Kconfig menu
When a SNAP Config GUI shows up, select 3 items:
- Card Type (OpenCAPI3.0: AlphaData 9H3-35 (incl. VU35P with HBM) (under development))
- Action Type (HLS HelloWorld 1024b (Action to Host I/F =1024b))
- (~/ocse) OCSE_ROOT: Path to OpenCAPI Simulation Engine Root
Do not forget to save the configuration into config file and then exit.
Check file snap_env.sh script to make sure it has "export OCSE_ROOT=~/ocse".
make sim ## (or make sim_tmux if no xterm available) # in the terminal that appears, run echo "Hello world_1024. This is my first CAPI SNAP experience. It's real fun." > /tmp/t1 snap_helloworld_1024 -i /tmp/t1 -o /tmp/t2 cat /tmp/t2
You should see "HELLO WORLD_1024. THIS IS MY FIRST CAPI SNAP EXPERIENCE. IT'S REAL FUN."
This concludes the software simulation test.
To compile bitfile for FPGA
cd ~/oc-accel make image
This will take an hour+ and eventually will produce an image in ~/oc-accel/hardware/build/Images/. Copy this image to the corresponding location on hal-fpga server, if the location already exists (see next section).
# scp ~/oc-accel/hardware/build/Images/F <userid>@hal-fpga.ncsa.illinois.edu:~/oc-accel/hardware/build/Images/.
Executing on hal-fpga
ssh into hal-fpga.
git clone https://github.com/OpenCAPI/oc-accel.git cd oc-accel
At this point, scp compiled image from hal-fpga-x86:
mkdir -p hardware/build/Images scp <userid>@hal-fpga-x86.ncsa.illinois.edu:~/oc-accel/hardware/build/Images/* ~/oc-accel/hardware/build/Images/. make clean all
And finally load bitfile and run the example:
# check the exact name of the bitfile, e.g., sudo oc-flash-script hardware/build/Images/oc_2023_0202_1645_25G_hls_helloworld_1024_noSDRAM_OC-AD9H335_1.bin ./actions/hls_helloworld_1024/tests/hw_test.sh
the card is not flushed for the first time with the appropriate OpenCAPI bitfile, therefore oc-flash-script fails. This is still need to be fixed.