Revision History - Revision History - 2020.2 English - UG1393

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)
Document ID
UG1393
Release Date
2021-03-22
Version
2020.2 English

Getting Started with Vitis Revision History

The following table shows the revision history for Getting Started with Vitis.
Section Revision Summary
03/22/2021 Version 2020.2
OpenCL Installable Client Driver Loader Updated installation information for RHEL/CentOS.
12/15/2020 Version 2020.2
Installing Xilinx Runtime and Platforms Minor update.
11/23/2020 Version 2020.2
Vitis Software Platform Release Notes Updated section and subsections.
Installation Updated section and subsections.
Accelerated Flow Application Development Using the Vitis Software Platform Minor update.
Execution Model Minor update.
Data Center Application Acceleration Development Flow Added.
Embedded Processor Application Acceleration Development Flow Added.
Tutorials and Examples Updated link.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Installation Requirements Updated operating system requirements.
06/03/2020 Version 2020.1
General updates Updated figures and tool commands.

Developing Applications Revision History

The following table shows the revision history for Developing Applications.
Section Revision Summary
03/22/2021 Version 2020.2
Entire section No changes to this section.
12/15/2020 Version 2020.2
Entire section No updates to this section.
11/23/2020 Version 2020.2
Kernel Properties Minor update.
Kernel Execution Modes Added table.
Kernel Interfaces Minor update.
Host Application Minor update.
Setting Kernel Arguments Minor update.
Buffer Allocation on the Device Minor update.
Buffer Creation and Data Transfer Updated section.
Letting XRT Allocate Buffers Updated section.
Using Host Pointer Buffers Minor update.
Allocating Page-Aligned Host Memory Minor update.
Kernel Execution Minor update.
Summary Minor update.
Memory Interface Width Considerations Minor update.
Reading and Writing by Burst Minor update.
Requirements of an RTL Kernel Minor update.
Kernel Interface Requirements Updated table.
Kernel Controls Updated section.
Interrupt Updated section.
RTL Kernel Development Flow Updated section.
Package the RTL Code as a Vivado IP Updated section.
Creating the XO File from the RTL Kernel Updated section.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Package the RTL Code as a Vivado IP Updated instructions.
06/03/2020 Version 2020.1
Memory Interface Width Considerations Added information for supporting the automatic widening of interfaces.
Process Execution Modes Added details on types of process execution modes.
Streaming Interfaces Added information on types of streaming interfaces available.
C/C++ Kernels Added details for Vitis HLS.
Package the RTL Code as a Vivado IP Added requirements and instructions for packaging IP.
Streaming Data between the Host and Kernel (H2K) Updated clCreateStream API flow.
Streaming Data Transfers Added details for Vitis™ HLS.
Entire section Updated figures and tool commands.

Building and Running the Application Revision History

The following table shows the revision history for Building and Running the Application.
Section Revision Summary
03/22/2021 Version 2020.2
Mapping Kernel Ports to Memory Updated section.
HBM Configuration and Use Added this section.
PLRAM Configuration and Use Added this section.
Using the -vivado and -advanced Options Added information about disabling global buffer insertion during placement.
RTL Simulator Support Updated Vivado properties for all simulators.
Using I/O Traffic Generators Updated information about running traffic generators.
12/15/2020 Version 2020.2
Running Emulation on an Embedded Processor Platform Updated section.
11/23/2020 Version 2020.2
Software Emulation Updated section.
Hardware Emulation Updated section.
System Hardware Target Minor update.
Building the Host Program Minor update.
Compiling and Linking for x86 Minor update.
Compiling and Linking for Arm Minor update.
Compiling Kernels with the Vitis Compiler Updated argument naming.
Linking the Kernels Updated argument naming.
Mapping Kernel Ports to Memory Added Using Slave-Bridge to Connect to Host Memory section.
Managing Vivado Synthesis and Implementation Results Split/updated subsections and moved out of Linking. the Kernels
Packaging the System Updated section and subsections.
Output Directories of the v++ Command Updated section.
Running Emulation Split into subsections and added new topics.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.
06/03/2020 Version 2020.1
Compiling Kernels with the Vitis HLS Updated to Vitis HLS.
Packaging the System Added chapter.
Entire section Updated figures and tool commands.

Profiling, Optimizing, and Debugging the Application Revision History

The following table shows the revision history for Profiling, Optimizing, and Debugging the Application.
Section Revision Summary
03/22/2021 Version 2020.2
Entire section No changes to this section.
12/15/2020 Version 2020.2
Entire section No updates to this section.
11/23/2020 Version 2020.2
Profiling the Application Minor update.
Baselining Functionality and Performance Minor update.
Enabling Profiling in Your Application Minor update.
Custom Profiling of the Host Application Added subtopics.
Guidance Added tip note.
Opening the System Estimate Report Minor update.
HLS Report Minor update.
Profile Summary Report Minor update.
Generating and Opening the Profile Summary Report Updated section.
Interpreting the Profile Summary Updated section.
Generating and Opening the Application Timeline Updated section.
Interpreting the Application Timeline Updated Read and Write descriptions.
Enabling Low Overhead Profiling Updated section.
Waveform View and Live Waveform Viewer Minor update.
Generating and Opening the Waveform Reports Minor update.
Host Optimization Minor update.
Reducing Overhead of Kernel Enqueing Minor update.
Optimizing Data Movement Updated section.
Overlapping Data Transfers with Kernel Computation Updated event figures.
Buffer Memory Segmentation Minor update.
Multiple In-Order Command Queues Updated figure.
Single Out-of-Order Command Queue Minor update.
Optimizing Kernel Computation Updated section.
Assigning DDR Bank in Host Code Added important note.
Using Burst Data Transfers Minor update.
Optimizing Computational Parallelism Minor update.
Debug Techniques for Hardware Emulation Added.
Enabling Kernels for Debugging with Chipscope Updated section.
System ILA Removed section.
Debugging with ChipScope Minor update.
Kernel Hangs Due to AXI Violations Minor update.
Hardware Debug for Embedded Processors Minor update.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.
06/03/2020 Version 2020.1
Emulation Debug for Embedded Processors Added information emulation debug in embedded processors.
Hardware Debug for Embedded Processors Added information hardware debug in embedded processors.
Enabling Profiling in Your Application Added section.
Guidance Added more information about the types of guidance available.
HLS Report Updated for Vitis HLS.
Profile Summary Report Added more information about generating and interpreting the profile summary report.
Enabling Low Overhead Profiling Added section.
Enabling Kernels for Debugging with Chipscope Added information about the AXI Protocol Checker.
Debugging on Embedded Processor Platforms Added section.
General updates Updated figures and tool commands.

Vitis Environment Reference Materials Revision History

The following table shows the revision history for Vitis Environment Reference Materials.
Section Revision Summary
03/22/2021 Version 2020.2
--clock Options Updated Important notice.
--profile Options Added --profile.trace_memory.
--vivado Options In --vivado.prop option description, changed fanout_opt option to no_bufg_opt.
12/15/2020 Version 2020.2
--advanced Options Updated table
--hls Options Minor updates
flash Added xbmgmt flash --scan description.
partition Added partition command description.
11/23/2020 Version 2020.2
Vitis Compiler General Options Added advanced, clock, connectivity, hls, linkhook, package, profile, reuse_bit, and vivado options. Added package description.
--advanced Options Updated table.
--clock Options Updated section.
--debug Options Added.
--hls Options Updated section.
--linkhook Options Updated section.
--package Options Minor updates.
--profile Options Added.
--vivado Options Updated section.
kernelinfo Utility Minor updates.
launch_emulator Utility Updated section.
package_xo Command Updated section.
platforminfo Utility Added force and code update.
RTL Kernel XML File Title and table update.
xbutil Utility Added tip.
p2p Minor updates.
query Fixed Firewall description.
status Minor updates.
xbmgmt Utility Added tip.
config Minor updates.
flash Minor updates.
partition Added table.
xrt.ini File Minor updates.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Vitis Compiler General Options Updated the details of the following commands:
  • --custom_script
  • --export_script
  • --advanced.param
06/03/2020 Version 2020.1
Vitis Compiler Command Updated for Vitis HLS.
Vitis Compiler General Options Made significant updates to the following options:
  • --custom_script
  • --dk
  • --from_step
  • --no_ip_cache
  • --remote_ip_cache
  • --reuse_impl
  • --to_step
  • --trace_memory
--advanced Options Made significant updates to the following options:
  • --advanced.param
  • --advanced.prop
--clock Options Added new options:
  • --clock.defaultTolerance
  • --clock.tolerance
--connectivity Options Updated --connectivity.sc option
--linkhook Options Added new section.
--package Options Added new section.
--vivado Options Made significant updates to the --vivado.prop option.
launch_emulator Utility Added new section.
manage_ipcache Utility Added new section.
platforminfo Utility Added platforminfo example for embedded processors.
xbutil Utility

Added additional information about the xbutil utility.

Made significant updates to all commands in this section.
xbmgmt Utility Added additional information about the xbmgmt utility.

Made significant updates to all commands in this section.
xclbinutil Utility Made significant updates to the following sections:
xrt.ini File Added the following new keys:
  • Runtime group: ert_polling, exclusive_cu_context
  • Debug group: continuous_trace, continuous_trace_interval_ms, lop_trace, power_profile
  • Emulation group: debug_mode (replaces launch_waveform), user_pre_sim_script, user_post_sim_script, xtlm_aximm_log, xtlm_axis_log, timeout_scale
HLS Pragmas Added new pragmas to table.
Note: Starting in the 2020.1 release, all pragma descriptions are located in Vitis HLS Flow .

Using the Vitis Analyzer Revision History

The following table shows the revision history for Using the Vitis Analyzer.
Section Revision Summary
03/22/2021 Version 2020.2
Entire section No changes to this section.
12/15/2020 Version 2020.2
Entire section No updates to this section.
11/23/2020 Version 2020.2
Using the Vitis Analyzer Added Versal AI Engine description.
Working with Reports Minor updates.
Vitis Analyzer GUI and Window Manager Updated section.
Platform and System Diagrams Minor updates.
AI Engine Graphs and Arrays Added.
Configuring the Vitis Analyzer Updated section.
Setting Guidance Thresholds Added.
Creating an Archive File Minor updates.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.
06/03/2020 Version 2020.1
Vitis Analyzer GUI and Window Manager Updated information about the Vitis Analyzer Workspace.

Added new sections:
Platform and System Diagrams Added new chapter.
Creating an Archive File Added new chapter.
General updates Updated figures and tool commands.

Using the Vitis IDE Revision History

The following table shows the revision history for Using the Vitis IDE.
Section Revision Summary
03/22/2021 Version 2020.2
Entire section No changes to this section.
12/15/2020 Version 2020.2
Managing Platforms and Repositories Updated additional tab descriptions.
Adding Sources Minor update.
Building the System Added tip note.
Vitis Run and Debug Configuration Settings Minor update.
11/23/2020 Version 2020.2
Create an Application Project Updated section.
Understanding the Vitis IDE Minor update.
Adding Sources Minor update.
Working in the Project Editor View Updated section.
Working in the Assistant View Updated section.
Output Directories from the Vitis IDE Updated section.
Configuring the Vitis IDE Updated section and subsections.
Generate RTL Kernel Updated section.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.
06/03/2020 Version 2020.1
Getting Started with Examples Added information working with and using Vitis libraries.
Vitis Command Options Added the -debug command.
Create an Application Project Updated with new information for IDE changes and steps in flow.
Vitis IDE Debug Flow Added new sections:
General updates Updated figures and tool commands.

Using Vitis Embedded Platforms Revision History

The following table shows the revision history for Using Vitis Embedded Platforms.
Section Revision Summary
03/22/2021 Version 2020.2
Platform Creation Basics Section rewritten.
Adding Hardware Interfaces Added content to General Requirements.
12/15/2020 Version 2020.2
Adding Hardware Interfaces Minor updates.
11/23/2020 Version 2020.2
Platform Naming Convention Minor updates.
Software Package Management in PetaLinux rootfs Updated link.
Adding Hardware Interfaces Updated section.
Enabling Hardware Emulation for Extensible XSA Added.
08/20/2020 Version 2020.1
Creating Embedded Platforms in Vitis Added.
06/24/2020 Version 2020.1
Entire section Rewrite for this version.

Migrating to a New Target Platform Revision History

The following table shows the revision history for Migrating to a New Target Platform.
Section Revision Summary
03/22/2021 Version 2020.2
Entire section No changes to this section.
12/15/2020 Version 2020.2
Entire section No updates to this section.
11/23/2020 Version 2020.2
Entire section No updates to this section.
08/20/2020 Version 2020.1
Entire section No updates to this section.
06/24/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.
06/03/2020 Version 2020.1
Entire section Editorial updates only. No technical content updates.