Windows Setup and Build Instructions

These instructions will guide you through everything required for building and executing a program on the Ryzen AI NPU on Windows. The instructions were tested on a ASUS Vivobook Pro 15.

You will set up a Windows subsystem for Linux (WSL) Ubuntu install, which will be used for building NPU device code. For building the host (x86) code, you will use MS Visual Code Community.

  • Rely on WSL Ubuntu 22.04 LTS for Vitis tool install and to build and run our MLIR-AIE tools
  • Rely on MS Visual Studio 17 2022 to natively build the host code (aka test.cpp)

Prerequisites

MLIR-AIE tools: WSL Ubuntu 22.04

All steps in WSL Ubuntu terminal.

  1. Clone https://github.com/Xilinx/mlir-aie.git best under /home/username for speed (yourPathToBuildMLIR-AIE), with submodules: 
    git clone --recurse-submodules https://github.com/Xilinx/mlir-aie.git
  2. Prepare WSL2 with Ubuntu 22.04:
    • Install packages (after apt-get update): 
        sudo apt install \
  build-essential clang clang-14 lld lld-14 cmake \
  libboost-all-dev \
  python3-venv python3-pip \
  libxrender1 libxtst6 libxi6 \
  mingw-w64-tools
    • generate locales 
      apt-get install locales
locale-gen en_US.UTF-8

  3. Install Vitis under WSL Ubuntu from Xilinx Downloads and setup a AI Engine license:

    • Setup your environment in the following order for aietools and Vitis: 
      export PATH=$PATH:<Vitis_install_path>/Vitis/2023.2/aietools/bin:<Vitis_install_path>/Vitis/2023.2/bin
    • Get local license for AIE Engine tools from https://www.xilinx.com/getlicense providing your machine’s MAC address (ip -brief link show eth0)
    • copy license file (Xilinx.lic) to your preferred location (licenseFilePath) and update your setup configuration accordingly, for instance 
      export XILINXD_LICENSE_FILE=<licenseFilePath>/Xilinx.lic
ip link add vmnic0 type dummy
ip link set vmnic0 addr <yourMACaddress>

  4. Install or Build MLIR-AIE tools under WSL2:

    • Use quick setup script to install from whls: 
      source utils/quick_setup.sh
# NOTE: this will install mlir-aie in my_install/mlir_aie
# and llvm in my_install/mlir. Be sure to account for this
# using utils/env_setup.sh later on.
    • [Optional] Build from source following regular get started instructions https://xilinx.github.io/mlir-aie/Building.html
  5. After installing the updated RyzenAI driver (see next subsection), use the gendef tool (from the mingw-w64-tools package) to create a .def file with the symbols: 
     mkdir /mnt/c/Technical/xrtIPUfromDLL; cd /mnt/c/Technical/xrtIPUfromDLL
 cp /mnt/c/Windows/System32/AMD/xrt_coreutil.dll .
 gendef xrt_coreutil.dll

Prepare Host Side: Natively on Win11

All steps in Win11 (powershell where needed).

  1. Upgrade the IPU driver IPU driver to version 10.106.8.62 download here, following the instructions on setting up the driver.

  2. Install Microsoft Visual Studio 17 2022 Community Edition with package for C++ development.

  3. Install CMake on windows (https://cmake.org/download/)
    • Download and compile boost (current version 1.83).
    • Extract zip file into C:\Technical\thirdParty
    • Run bootstrap.bat and after that b2.exe

  4. Optional (only needed for vision examples): install opencv and add this install to your PATH environmental variable, for instance C:\Technical\thirdParty\opencv\build\x64\vc16\bin

  5. Clone https://github.com/Xilinx/XRT for instance under C:\Technical and git checkout 2023.2
  6. Create a .lib file from the .dll shipping with the driver
    • In wsl, generate a .def file (see above)
    • Start a x86 Native Tools Command Prompt (installed as part of VS17), go to the folder C:\Technical\xrtIPUfromDLL and run command: 
      lib /def:xrt_coreutil.def /machine:x64 /out:xrt_coreutil.lib
  7. Clone https://github.com/Xilinx/mlir-aie.git for instance under C:\Technical to be used to build designs (yourPathToDesignsWithMLIR-AIE)

Set up your environment

To make the compilation toolchain available for use in your WSL terminal, you will need to set some environment variables. We suggest you add the following to a file named setup.sh, so you can set up your environment easily by running source setup.sh.

setup.sh - Option A - Using Quick Setup

If you used the quick setup script (precompiled MLIR-AIE binaries), use this setup script.

# NOTE: if you did NOT exit the terminal you can skip this step.
cd <yourPathToDesignsWithMLIR-AIE>
source <yourPathToBuildMLIR-AIE>/ironenv/bin/activate
source yourVitisSetupScript (example shown above)
source <yourPathToBuildMLIR-AIE>/utils/env_setup.sh <yourPathToBuildMLIR-AIE>/my_install/mlir_aie <yourPathToBuildMLIR-AIE>/my_install/mlir

setup.sh - Option B - Built from Source

cd <yourPathToDesignsWithMLIR-AIE>
source <yourPathToBuildMLIR-AIE>/sandbox/bin/activate
source yourVitisSetupScript (example shown above)
source <yourPathToBuildMLIR-AIE>/utils/env_setup.sh <yourPathToBuildMLIR-AIE>/install <yourPathToBuildMLIR-AIE>/llvm/install

Build a Design

For your design of interest, for instance add_one_objFifo, 2 steps are needed: (i) build the AIE desgin in WSL and then (ii) build the host code in powershell.

Build device AIE part: WSL Ubuntu terminal

  1. Prepare your enviroment with the mlir-aie tools (built during Prerequisites part of this guide). See Set up your environment above.

  2. Goto the design of interest and run make.

Build and run host part: PowerShell

Note that your design of interest might need an adapted CMakelists.txt file. Also pay attention to accurately set the paths CMake parameters BOOST_ROOT, XRT_INC_DIR and XRT_LIB_DIR used in the CMakelists.txt, either in the file or as CMake command line parameters.

  1. Build: Goto the same design of interest folder where the AIE design just got build (see above) 
     mkdir buildMSVS
 cd buildMSVS
 cmake .. -G "Visual Studio 17 2022"
 cmake --build . --config Release
  2. Run (program arguments are just an example for add_one design) 
     cd Release
 .\<testName>.exe -x ..\..\build\final.xclbin -k MLIR_AIE -i ..\..\build\insts.txt -v 1