ThunderScope/Docs/LiteX.md

3.5 KiB

LiteX Build and Setup Guide

Gateware

The FPGA gateware for the Thunderscope is supported by the ThunderScope Litex Repo.

Build

  1. Install Vivado, Python3, and LiteX.

  2. Ensure Vivado is in your current path

  3. Clone the thunderscope_litex repo and follow the instruction in the README.md to build the gateware and generate the software driver.

  4. ./thunderscope.py --variant=<variant> --driver --build

Available Variants:

Label Description
a200t Trenz A200T Module
a100t Trenz A100T Module
a50t Custom Module

Flash

  1. Connect the JTAG debugger to the Thunderscope

  2. ./thunderscope.py --variant=<variant> --flash

LitePCIe Driver

Linux

The Linux driver for the LiteX build is generated by the litex gateware project.

$ cd software/kernel
$ make
$ sudo ./init.sh

Windows

The Windows driver for the LiteX build is available from the LitePCIe Windows Driver Repo

  1. Install the prerequisites as described in the driver project's README, including either the Windows WDK and KMDF or the EWDK command line tools.

  2. After building the litex gateware, copy the csr and soc header files from the Linux driver to the Windows driver

> cp ./thunderscope_litex/software/kernel/csr.h ./litepcie_driver_win/litepciedrv/public_h/csr.h
> cp ./thunderscope_litex/software/kernel/soc.h ./litepcie_driver_win/litepciedrv/public_h/soc.h
  1. Build the LitePCIe Driver project by opening the .vcxproj file in Visual Studio, Or launching the EWDK build environment.
> C:\EWDK\LaunchBuildEnv.cmd
> msbuild litepciedrv.vcxproj /p:Configuration=Release /p:Platform=x64

The Driver file is found in the litepciedrv/x64/Release/litepciedrv folder.

  1. To install the driver, verify your PC is in TESTSIGNING mode. In an administrator command prompt, run the command Bcdedit.exe -set TESTSIGNING ON and reboot the system.

    When Windows is in TESTSIGNING mode, ensure the Thunderscope is connected to the PC. Open the Device Manager and locate the Thunderscope in the "Multifunction Devices" category. Right-Click the Thunderscope device and select "Update Driver". Tell Windows to manualy install the driver from the litepciedrv build folder noted above.

TsLitex Library

The libtslitex library provides control over the Thunderscope input channels and Sample DMA. Clone the libtslitex Repo.

Libtslitex uses the CMake build environment.

  1. Create a build folder
> mkdir build && cd build
  1. Configure CMake
> cmake ..
  1. Build with CMake
> cmake --build . --config=Release
  1. There is a test application built to build/artifacts/example/Release/ and the libraries are found in the build/Release folder

TS.NET

Management of Data buffers and data triggering is provided by the TS.NET project.

  1. Clone the TS.NET Repo

  2. Build the TS.NET.Engine project using the included build script.

> cd build-scripts
> powershell -ExecutionPolicy Bypass -File "TS.NET.Engine (win-x64).ps1"
  1. Copy the tslitex library file into the TS.NET.Engine build directory
> cp libtslitex/build/Release/tslitex.dll TS.NET/builds/win-x64/TS.NET.Engine/0.1.0/tslitex.dll
  1. Change the configured HardwareDriver in the thunderscope.yaml file to LiteX
HardwareDriver: LiteX

You should now be able to run TS.NET.Engine and connect to the Thunderscope.