Quick guide

This quick guide lists the commands needed to build xbtest xclbin and HW packages. More information is provided in other sections of the developer guide.

Definition

This document uses the following definitions:

  • <xbtest_catalog> represents the xbtest IP catalog directory (e.g. path/to/your/xbtest/src/hw/xbtest_catalog/).

  • <xbtest_build> represents the xbtest build source directory (e.g. path/to/your/xbtest/src/hw/build_source/xbtest_wizard_v6_0/).

  • <dev_platform> is provided with command line option --xpfm. For example: If path/to/xilinx_u55c_gen3x16_xdma_3_202210_1.xpfm is provided, then <dev_platform> is set with xilinx_u55c_gen3x16_xdma_3_202210_1. If path/to/hw.xsa is provided, then <dev_platform> is set with hw. If path/to/your/xilinx-u250-gen3x16-xdma-4.1-202210-1-dev-1-3512975.noarch.rpm is provided, then <dev_platform> is set with xilinx-u250-gen3x16-xdma-4.1-202210-1-dev-1-3512975.noarch.

  • <deploy_platform> is the deployment platform named <deploy_name>-<deploy_version> (e.g. xilinx-u55c-gen3x16-xdma-base-3).

  • <project_name> is provided with command line option --project_name.

  • <pkg_release> is the xbtest package release version provided with command line option --pkg_release (e.g. 1).

Get xbtest sources and packages

Get xbtest sources and packages (see xbtest sources):

$ git clone https://github.com/Xilinx/xbtest --branch 6.0 <xbtest_local_repo>

Set up your environment

Execute the following commands to set up the Vitis™ environment for building xbtest:

$ source <Vitis_Installation_Path>/Vitis/<Vitis_Version>/settings64.csh

See Environment setup for more details on setting up build environment and dependencies.

Move to the xclbin_generate directory

Change to the following working directory:

$ cd <xbtest_build>/xclbin_generate

Initialize xclbin_generate input products

Run the following command to generate the templates for required xclbin_generate input products:

$ python3 gen_xclbin.py --ip_catalog <xbtest_catalog> \
                        --xpfm path/to/platform.xpfm \
                        --init

Note

Add the option --use_lsf to run on LSF if needed. You can also enable –verbose for more detailed output.

See Workflows initialization for more details.

Get xclbin_generate input products templates

Get the generated templates of xclbin_generate input products:

$ cp -r ./output/<dev_platform>/init/u_ex/run/cfg_template \
        ./cfg/<dev_platform>

See Environment setup and workflows initialization for more details.

Generate power floorplan templates

From a DCP of your platform, generates templated of power CU floorplan configuration:

$ vivado -mode tcl \
         -source ../tcl/power/gen_dynamic_geometry.tcl \
         -tclargs ./output/<dev_platform>/init/u_ex/run/vpp_link/link/vivado/vpl/prj/prj.runs/impl_1/level0_wrapper_opt.dcp \
                  ./cfg/<dev_platform>/pwr_cfg \
                  <pblocks>

See Environment setup and workflows initialization for more details.

Customize xclbin_generate input products

You need to customize the following required xclbin_generate workflow inputs according to your requirements:

<xbtest_build>/xclbin_generate/cfg/<dev_platform>/wizard_cfg.json
<xbtest_build>/xclbin_generate/cfg/<dev_platform>/pwr_cfg/utilization.json

Optionally, you need can also to customize the following:

<xbtest_build>/xclbin_generate/cfg/<dev_platform>/pwr_cfg/invalid.json
<xbtest_build>/xclbin_generate/cfg/<dev_platform>/vpp_cfg/vpp.ini
<xbtest_build>/xclbin_generate/cfg/<dev_platform>/vpp_cfg/postsys_link.tcl
<xbtest_build>/xclbin_generate/cfg/<dev_platform>/vpp_cfg/place_design_pre.tcl
<xbtest_build>/xclbin_generate/cfg/<dev_platform>/vpp_cfg/route_design_pre.tcl

For more details, refer to

Generate xclbin

Use the following command to generate an xbtest xclbin based on your configuration provided using option --config_dir:

$ python3 gen_xclbin.py --ip_catalog <xbtest_catalog> \
                        --xpfm path/to/platform.xpfm \
                        --config_dir ./cfg/<dev_platform> \
                        --project_name <project_name>

Note

Add the option --use_lsf to run on LSF if needed.

Option --xpfm can specify a .xpfm or a .xsa file. It can be also be a .rpm package (if running on CentOS/Red Hat/SUSE) or a .deb package (if running on Ubuntu).

You can also enable –verbose for more detailed output.

See Build xclbin for more details.

Move to the rpm_generate directory

Change to the following working directory:

$ cd <xbtest_build>/rpm_generate/

Initialize rpm_generate input products

Create the following directories:

$ mkdir -p <xbtest_build>/rpm_generate/include/<deploy_platform>/dcps
$ mkdir -p <xbtest_build>/rpm_generate/include/<deploy_platform>/xclbin

Copy platform definition JSON file:

$ cp -r <xbtest_build>/xclbin_generate/output/<dev_platform>/<project_name>/u_ex/run/sw/xbtest_pfm_def_template.json \
        <xbtest_build>/rpm_generate/include/<deploy_platform>/xbtest_pfm_def.json

Copy xclbin:

$ cp <xbtest_build>/xclbin_generate/output/<dev_platform>/<project_name>/<project_name>.xclbin \
     <xbtest_build>/rpm_generate/include/<deploy_platform>/xclbin/xbtest_stress.xclbin

Copy final DCP. For example:

$ cp <xbtest_build>/xclbin_generate/output/<dev_platform>/<project_name>/u_ex/run/vpp_link/link/vivado/vpl/prj/prj.runs/impl_1/level0_wrapper_postroute_physopt.dcp \
     <xbtest_build>/rpm_generate/include/<deploy_platform>/dcps

Note

If optional post-route physical design optimization was not enabled, copy the routed DCP level0_wrapper_routed.dcp.

See Build RPM and DEB packages for more details.

Customize platform definition JSON file

While you complete your checklist, you will customize the platform definition JSON file <xbtest_build>/rpm_generate/include/<deploy_platform>/xbtest_pfm_def.json.

Generate RPM/DEB packages

Run the following command on CentOS/Red Hat/SUSE to generate RPM package and then on Ubuntu to generate DEB package.

$ python3 gen_rpm.py --deploy_name <deploy_name> \
                     --deploy_version <deploy_version> \
                     --include_dir <xbtest_build>/rpm_generate/include/<deploy_platform> \
                     --pkg_release <pkg_release>

For example, if you build the RPM/DEB on LSF, you can use the following commands:

  • For the RPM package:

    $ echo "#\!/bin/bash \
source path/to/opt/xilinx/xrt/setup.sh \
python3 gen_rpm.py --deploy_name <deploy_name> --deploy_version <deploy_version> --include_dir <xbtest_build>/rpm_generate/include/<deploy_platform> --pkg_release <pkg_release> \
" | tee -a ./build_rpm.sh
$ chmod a+x ./build_rpm.sh
$ bsub -I -R "select[ (osdistro=rhel || osdistro=centos) && (osver == ws8 || osver == cent8) ]" -q short "./build_rpm.sh"

  • For the DEB package:

    $ echo "#\!/bin/bash \
source path/to/opt/xilinx/xrt/setup.sh \
python3 gen_rpm.py --deploy_name <deploy_name> --deploy_version <deploy_version> --include_dir <xbtest_build>/rpm_generate/include/<deploy_platform> --pkg_release <pkg_release> \
" | tee -a ./build_deb.sh
$ chmod a+x ./build_deb.sh
$ bsub -I -R "select[(osdistro == ubuntu) && (ostype == ubuntu2004)]" -q short "./build_deb.sh"

Note

In the commands above, update according to you environment:

See Build RPM and DEB packages for more details.