Notes on building and testing the GDDR6 SGRAM driver

[Araneidae]

I am hoping that other users can make use of the firmware I have developed here, but I know that it is not really ready for general use. I will try and put a detailed description here of how to set things up to build and exercise the test application test-gddr6_ip, and I would be grateful if anyone trying to do this would add their comments to this discussion. I'll try and update the instructions as appropriate.

Setting up to build

First of all you will need to set define two directories, one for the three repositories listed in the readme, and one for build artifacts. I'll write $src for the directory in which files will be checked out and $build for the build directory.

1. Start by checking out:

   $ git clone -C $src https://github.com/DiamondLightSource/fpga-common/ 
   $ git clone -C $src https://github.com/DiamondLightSource/IFC_1412
   $ git clone -C $src https://github.com/DiamondLightSource/AmcPciDev 

2. Next the CONFIG file in $src/IFC_1412 must be modified:
   • Point BUILD_TOP at a directory under $build
   • Point VIVADO at the path to your Vivado install
   • Set FPGA_COMMON to $src/fpga-common (you'll want to write out $src in full)
3. Set your working directory to $src/IFC_1412
4. Now you should be able to build the IP wrapper for the driver:

   make -C gddr6

   With luck this will take a couple of minutes and will place the appropriate IP definitions somewhere under $BUILD_TOP.
5. Unless you're using the same version of Vivado as I was you will need to edit the file test-gddr6_ip/bd/interconnect.tcl so that the Block Design can be loaded. The simplest workaround is to comment out the return 1 line on line 30 of this file.
6. Now perform the build:

   make -C test-gddr6_ip

   This might take up to 15 minutes.

Inspecting the build

At this point we either have a failed or a successful build. Now try running:

make -C test-gddr6_ip runvivado &

Unless the build failed early this should open the project. If all is well implementation should have completed and you can check for timing.

With this small design I expect building to take no more than 15 minutes and to complete with worst slack no more than 150ps.

If anyone gets this far, please let me know. Next time we'll look at running the result.