• All
  • Silicon Devices
  • Boards and Kits
  • Intellectual Property
  • Support
    • Documentation
    • Knowledge Base
    • Community Forums
  • Partners
  • Videos
  • Press
  • Applications
  • Products
  • Developers
  • Support
  • About
  • All
  • Silicon Devices
  • Boards and Kits
  • Intellectual Property
  • Support
    • Documentation
    • Knowledge Base
    • Community Forums
  • Partners
  • Videos
  • Press
xbtest - User guide
6.0

Documentation hub

  • Home
  • User guide
  • Developer guide
  • Checklist

Introduction

  • Overview
    • Architecture overview
    • Hardware overview
    • Platform specific libraries overview
    • Software overview
  • Installation
    • Dependencies
    • Install xbtest
      • Step 1: Identify your OS and deployment platform
        • Step 1.1: Identify your system architecture
        • Step 1.2: Identify your OS release
        • Step 1.3: Identify your deployment platform
      • Step 2: Get compatible archives
      • Step 3: Install software packages
      • Step 4: Install platform specific library package
    • Installed content
    • Removal
    • Install xbtest to another location
  • Download

Usage

  • Set up xbtest
  • Use cases
    • Multiple tests / cards
    • Single test
  • Identifying a deployment platform
  • Test specific set up
    • Host memory set up
    • P2P tests set up
  • Command line options
    • Command line options definition
      • -v: Display version
      • -h: Display help
      • -d: Select card
      • -g: Display guide
      • -j: Select test JSON
      • -c: Select pre-canned test
      • -T: Select P2P target card
      • -N: Select P2P NVMe path
      • -D: Select card configuration JSON
      • -l: Select logging directory
      • -L: Disable logging directory
      • -m: Display message information
      • -F: Disable dynamic display
      • -f: Force an operation
      • -b: Select verbosity
      • -t: Select timestamp
      • -x & -e: Select xclbin and platform definition JSON
      • -X & -E: Select P2P target xclbin and platform definition JSON
    • Command line options examples
      • Running single test on a single card
      • Running multiple tests on a single card
      • Same tests on multiple cards
      • Running different tests on different cards
    • Card configuration JSON file
      • Card configuration JSON definition
      • Card configuration JSON examples
  • Result
    • Display modes
      • Multi tests display
      • Single test display
      • Disable dynamic display
    • Understanding xbtest messages
    • Result directory
      • Multi tests result directory
        • Card status CSV output file
      • Single test result directory
    • Result visualisation
      • Vitis analyzer
        • Profile summary
  • Test JSON file structure
    • Test environment members
    • Test JSON file example

Pre-canned tests

  • Pre-canned tests description
    • Overview
    • verify
    • dma
    • p2p_card
    • p2p_nvme
    • memory
    • memory_host (Slave bridge)
    • power
    • GT
      • gt_mac
      • switch
      • gt_mac_lpbk
      • gt_mac_port_to_port
      • gt_prbs
    • stress

Test cases

  • Overview
  • Verify
    • Compute units verification
    • Test JSON file verification
  • DMA
    • Test parameters
    • Main test steps
    • Low DMA bandwidth troubleshooting
    • DMA test JSON members
      • Definition
      • Basic examples
      • test_sequence
      • check_bw
      • stop_on_error
      • hi_thresh_wr, hi_thresh_rd
      • lo_thresh_wr, lo_thresh_rd
      • total_size
    • Output files
      • dma_detail.csv output file
      • dma_result.csv output file
  • P2P CARD
    • Test parameters
    • Main test steps
    • P2P CARD test JSON members
      • Definition
      • Basic examples
      • test_sequence
      • check_bw
      • stop_on_error
      • hi_thresh_wr, hi_thresh_rd
      • lo_thresh_wr, lo_thresh_rd
      • total_size
    • Output files
      • p2p_card_detail.csv output file
      • p2p_card_result.csv output file
  • P2P NVME
    • Test parameters
    • Main test steps
    • P2P NVME test JSON members
      • Definition
      • Basic Examples
      • test_sequence
      • check_bw
      • stop_on_error
      • hi_thresh_wr, hi_thresh_rd
      • lo_thresh_wr, lo_thresh_rd
      • total_size
    • Output files
      • p2p_nvme_detail.csv output file
      • p2p_nvme_result.csv output file
  • Memory
    • Test parameters
    • Main test steps
    • Measurements
      • Burst time
      • Bandwidth
      • Latency
      • Bandwidth and latency check conditions
    • Memory CU types
    • Write and read ranges/blocks
    • Test modes
    • AXI bursts
    • Maximum number of outstanding transactions
      • Maximum number of outstanding writes
      • Maximum number of outstanding reads
    • AXI ID threads
    • Quality of Service (QoS) - Rate control
    • Memory Test JSON Members
      • Target memories on the card
      • Target memory on the host
      • Single-channel override
      • Multi-channel override
      • Definition
      • test_sequence
        • Override test_sequence
      • check_bw
      • hi_thresh_alt_wr_bw, hi_thresh_alt_rd_bw, hi_thresh_only_wr_bw, hi_thresh_only_rd_bw, hi_thresh_simul_wr_bw, hi_thresh_simul_rd_bw
      • lo_thresh_alt_wr_bw, lo_thresh_alt_rd_bw, lo_thresh_only_wr_bw, lo_thresh_only_rd_bw, lo_thresh_simul_wr_bw, lo_thresh_simul_rd_bw
      • check_latency
      • hi_thresh_alt_wr_lat, hi_thresh_alt_rd_lat, hi_thresh_only_wr_lat, hi_thresh_only_rd_lat, hi_thresh_simul_wr_lat, hi_thresh_simul_rd_lat
      • lo_thresh_alt_wr_lat, lo_thresh_alt_rd_lat, lo_thresh_only_wr_lat, lo_thresh_only_rd_lat, lo_thresh_simul_wr_lat, lo_thresh_simul_rd_lat
      • disable_prewrite
      • disable_memory
      • single_axi_thread
    • Output files
      • Results CSV output files
      • Detail CSV output files
      • Multi-channel Summary CSV output files
      • Power CSV output files
  • Power
    • Test parameters
    • Main test steps
    • Power and temperature limits
    • Power budget and calibration
      • Toggle rate step requirement
      • Actual power available
      • Components present on the card
      • Tests running
    • Power test JSON members
      • Example
      • Definition
      • test_sequence
      • disable_reg, disable_dsp, disable_bram, disable_uram, disable_aie
      • disable_toggle_ramp
    • Output files
  • GT
    • GT MAC
      • GT test set up
        • Switch set up
        • Source MAC address
        • Destination MAC address - Lane mapping
        • Lane enabling
        • GT MAC CU to GT MAC CU connection
      • GT settings
      • Main test steps
        • Test parameters
      • Status
        • Matching TX RX
        • MAC_STAT status registers description
      • GT MAC test JSON members
        • Electrical/optical loopback example
        • Switch example
        • GT MAC to GT MAC connection example
        • Definition
        • test_sequence
        • tx_mapping
        • disable_lane
        • source_addr
        • dest_addr
        • utilisation
        • traffic_type
        • packet_cfg
        • match_tx_rx
        • mac_to_mac_connection
        • GT settings test JSON members
      • Output files
    • GT PRBS
      • GT test set up
      • GT settings
      • Main test steps
        • Test parameters
      • Status
      • GT PRBS test JSON members
        • Electrical/optical loopback example
        • Definition
        • test_sequence
        • disable_ref_prbs
        • GT settings test JSON members
      • Output file
    • GT LPBK
      • GT test set up
      • GT settings
      • Main test steps
        • Test parameters
      • Status
      • GT LPBK test JSON members
        • Example
        • Definition
        • test_sequence
        • GT settings test JSON members
      • Output file

Tasks

  • Overview
  • Device management
    • Sensor source definition
    • Device management test JSON members
      • Definition
      • sensor
        • type
        • id
        • warning_threshold
        • error_threshold
        • abort_threshold
      • use_output_file
      • watchdog_duration
    • Output files

Platform definition

  • Platform definition
    • Platform definition JSON file
    • xclbin metadata
    • XRT device APIs metadata

Other versions

  • 5.0
  • 4.0
xbtest - User guide
  • »
  • Index

Index

Symbols | C

Symbols

  • -b
    • command line option
  • -c
    • command line option
  • -D
    • command line option
  • -d
    • command line option
  • -E
    • command line option
  • -e
    • command line option
  • -F
    • command line option
  • -f
    • command line option
  • -g
    • command line option
  • -h
    • command line option
  • -j
    • command line option
  • -L
    • command line option
  • -l
    • command line option
  • -m
    • command line option
  • -N
    • command line option
  • -T
    • command line option
  • -t
    • command line option
  • -v
    • command line option
  • -X
    • command line option
  • -x
    • command line option

C

  • command line option
    • -b
    • -c
    • -d
    • -D
    • -e
    • -E
    • -F
    • -f
    • -g
    • -h
    • -j
    • -l
    • -L
    • -m
    • -N
    • -T
    • -t
    • -v
    • -x
    • -X

Last updated on October 26, 2022.


  • Connect on LinkedIn
  • Follow us on Twitter
  • Connect on Facebook
  • Watch us on YouTube
  • Subscribe to Newsletter
© 2018-2022, Xilinx, Inc.
  • Privacy
  • Legal
  • Contact