Ug973 Vivado Release Notes Install License
Ug973 Vivado Release Notes Install License
of this document
Chapter 1
Release Notes
What's New
The What's New is available on the AMD website at AMD Vivado™ 2024.1 What's New.
Known Issues
Vivado Design Suite Tools Known Issues can be found at Answer Record 000036235.
Important Information
Vivado Design Suite Updates
• The format of the AMD IP configuration file has been changed from XML to JSON to improve
revision control capabilities and loading times.
• For information on the IP change log see the All IP Change Log Information. This Answer
Record contains a comprehensive list of IP change log information in a single location, which
allows you to see all IP changes without having to install the Vivado Design Suite.
• The Classic SoC Boot flow has been moved to limited access to ensure potential designs
match the solution capabilities – contact [email protected] to request access.
Licensing
The Vivado 2024.1 and beyond releases introduce the following changes in licensing that are
listed below:
• Flexera version for license management tool has been upgraded to 11.17.2.0.
• Anyone using floating license is required to upgrade licensing utilities to Flex 11.17.2.0. These
new licensing utilities are available on the AMD Downloads Website.
Note: Flex version upgrade does not affect valid license files, in other words, existing valid license files
work with the Vivado 2024.1 release after you upgrade the licensing utilities.
Installer
Installer Changes
The 2020.2 release introduced the new HLS product with support for both the AMD Vitis™
unified software platform and AMD Vivado™ tools. As part of this the overall folder structure
changes, whereby the Vitis_HLS folder is now at the same root location as the AMD Vivado™
and AMD Vitis™ tools. You will need to update any custom setup scripts from the previous
release.
Note: The End User License Agreement (EULA) and third party notices are selected based on the product
you have chosen to install.
• Source files names must start with a letter (A-Z, a-z) and must contain only alphanumeric
characters (A-Z, a-z, 0-9) and underscores (_).
• Output files names must start with a letter (A-Z, a-z) and must contain only alphanumeric
characters (A-Z, a-z, 0-9) and underscores (_).
• Project names must start with a letter (A-Z, a-z) and must contain only alphanumeric
characters (A-Z, a-z, 0-9) and underscores (_).
• Project directory names must start with a letter (A-Z, a-z) and should contain only
alphanumeric characters (A-Z, a-z, 0-9), tilde (~) and underscores (_).
CAUTION! The Windows operating system has a 260 character limit for path lengths which can affect the
Vivado tools. To avoid this issue, use the shortest possible names and directory locations when creating
projects, defining IP or managed IP projects, or creating block designs.
The following characters are not supported for project, file, or directory names:
• !#$%^&*()`;<>?,[]{}'"|
• tab (\t)
• return (\r)
• new line (\n)
• / or \ (As part of the directory or file name rather than as a path delimiter)
• @
Note: In the Vivado IDE, the @ character is not supported for new file or project names. The Vivado IDE
does allow an existing file on disk that uses the @ character to be added to a project. The Vivado IDE
can open a project that includes the @ character in the project name. Using the Tcl Console, you can
create a project with a name that contains the @ character.
IMPORTANT! Spaces in directory and file names are supported by the Windows operating system.
However, you should avoid using spaces to preserve portability of the project or files between the Windows
and Linux operating systems.
The Vivado Design Suite supports the use of forward slashes (/) as path delimiters for both
Windows and Linux platforms. Backslashes (\) are allowed as path delimiters on the Windows
platform only.
Any characters not explicitly mentioned above are not supported for project, file, or directory
names.
• Hardware, IP, and Platform Development: Creating the PL IP blocks for the hardware
platform, creating PL kernels, functional simulation, and evaluating the AMD Vivado™ timing,
resource use, and power closure. Also involves developing the hardware platform for system
integration. Topics in this document that apply to this design process include:
• What's New
• Supported Devices
• System Integration and Validation: Integrating and validating the system functional
performance, including timing, resource use, and power closure. Topics in this document that
apply to this design process include:
• What's New
• Supported Devices
• Board System Design: Designing a PCB through schematics and board layout. Also involves
power, thermal, and signal integrity considerations. Topics in this document that apply to this
design process include:
• What's New
• Supported Devices
Chapter 2
Note: Refer to PetaLinux Tools Documentation: Reference Guide (UG1144) for more information on
Installation Requirements for supported Operating Systems with PetaLinux.
Note: Refer to Vitis Model Composer Tutorial (UG1498) for Vitis Model Composer OS support details.
Supported Devices
The following sections list architecture support for commercial products in the AMD Vivado™
ML Editions tool versus all other Vivado ML Editions. For non-commercial support, all AMD
Automotive devices are supported in the Vivado ML Editions when available as production
devices in the tools.
Note: AMD Alveo™ and AMD Kria™ cards are included as part of the ML Standard Edition.
Note: Starting in Vivado 2016.x onward, a license is no longer required for Vivado ML Standard Edition.
• XCVH1522
• XCVH1542
• XCVH1582
• XCVH1742
• XCVH1782
Note: The AMD UltraScale+™ device is supported in AMD Vitis™ unified software platform and Vivado
platform board design flows.
Note: Some devices might have bitstream generation under license control. Contact your sales FAE for
access.
Note: The versions listed in the preceding table are the minimum required versions to use with the Vivado
tools. Previous versions are not tested.
Note: Contact simulation vendor to check if you need license for using advanced simulation features.
System Requirements
This section provides information on system memory requirements, cable installation, and other
requirements and recommendations.
The Microsoft Windows and Linux operating system (OS) architectures have limitations on the
maximum memory available to an AMD program. Users targeting the largest devices and most
complex designs might encounter this limitation. The Vivado Design Suite has optimized memory
and enabled support for applications to increase RAM memory available to AMD tools.
Note: The AMD Parallel Cable IV is no longer supported for debugging or programming.
RECOMMENDED: To install Platform Cable USB II, a system must have at least a USB 1.1 port. For
maximum performance, AMD recommends using Platform Cable USB II with a USB 2.0 port.
The cable is officially supported on the 64-bit versions of the following operating systems:
• Windows 10
• Windows 11
• Red Hat Linux Enterprise
• CentOS
• SUSE Linux Enterprise 12
• SUSE Linux Enterprise 15
For additional information regarding the AMD cables, see the Platform Cable USB II Data Sheet
(DS593).
Item Requirement
Directory permissions Write permissions must exist for all directories containing design files to be edited.
Monitor 16-bit color VGA with a minimum recommended resolution of 1024 by 768 pixels.
Item Requirement
Ports To program devices, you must have an available parallel or USB port appropriate for your AMD
programming cable. Specifications for ports are listed in the documentation for your cable.
Note: Installation of the cable driver software requires Windows 10. If you are not using one of
these operating systems, the cables might not work properly.
Note: X Servers/ Remote Desktop Servers, such as Exceed, ReflectionX, and XWin32, are not supported.
When design files are located on a network machine, other than the machine with the installed
software, the clock settings of both machines must be set the same. These times must be
synchronized on a regular basis for continued proper functioning of the software.
Chapter 3
Note: The step-by-step instructions below are for generating a floating certificate-based license as this
process contains a superset of all other certificate-based license generation flows.
1. Go to Product Licensing.
If prompted, sign in with your AMD credentials and confirm any necessary information to
continue.
• If you already have an AMD user account, enter your E-mail Address and password, and
then confirm your contact information is current.
• If you do not have an account, click the Create Account link and register.
• Provide the necessary info for Name and Address verification for the U.S Government
Export Approval form and click Next.
The Product Licensing page is displayed.
Note: This selection is not available if you are entitled to evaluation or free products only.
3. (Optional) Enter product voucher codes for design tools or IP product licenses purchased
with kits or for tools purchased from the AMD online store. If you have a product voucher
card, you can enter the voucher code on the card into the associated text field and click
Redeem Now.
Product vouchers for design tools and IP product licenses can be shipped with an AMD or
partner development board or design kit. This places the corresponding design tools or IP
product entitlement in the product entitlement table which you can use to generate a license
key.
4. (Optional) Add evaluation or No Charge IP product entitlements to the product entitlement
table.
To add Evaluation and No Charge IP to the list of product entitlements, click the Search Now
button in the Add Evaluation and No Charge IP Cores section of the page. This opens an IP
product finder tool.
• Evaluation
Note: Design tool evaluation is for 30 days and IP evaluations are for 120 days.
The Vivado Design Suite: 30-Day Evaluation License evaluation product entitlement
provides access to all the capabilities in the Vivado Design Tools. This product entitlement
is automatically included in your product licensing account.
Products with a status of Current are within their warranty period. Products with a status of
Expired have a warranty period end date that has passed. If seats are available, licenses can
be generated for either Current or Expired product entitlements.
6. Select the number of seats required for each product license.
This is for floating licenses only. All node-locked licenses are for one seat. The number of
seats available for a product entitlement is automatically maintained by the system. The
Requested Seats field is populated, by default, with zero, although you are allowed to enter
any number up to the full number of seats remaining on the product entitlement. A product is
removed from the product entitlement table once all seats are generated.
For design tools, available seats represents the number of seats available for licensing over
the total number of seats purchased. For IP, seats are managed according to the terms of the
site-wide license agreement.
7. Click the Generate License button corresponding with the type of license file you are
generating.
Note: Floating/server and node-locked/client licenses cannot be combined in the same license file.
Selecting an entitlement that contains only one license type causes the Generate button for the other
license type to become inactive.
A new window is displayed where you define the product and system that you are generating
the license for.
The Host ID value uniquely identifies the machine to which your design tools or IP is
licensed. You can choose a Host ID Type to be a MAC address, a hard drive serial number
or a dongle ID.
Note: Not all host ID types are supported for all operating systems. The easiest way to obtain your
host ID is to run Vivado License Manager on the machine that serves as the license host.
When you finish generating the licenses, you receive a confirmation message summarizing your
licensing activity.
TIP: If you do not receive your license by email, you can download it directly from the Product Licensing.
1. Save the license file (.lic) attached to the e-mail to a temporary directory on your local
system.
2. Run the Vivado License Manager:
• For Windows 11 or earlier: Select Start → All Programs → AMD Design Tools → Vivado
2024.1 → Manage AMD Licenses.
• For Linux: Type vlm in a command-line shell.
3. On the left hand pane of Vivado License Manager, expand Getting a License and select Load
License.
4. If you received a certificate license (.lic) file, click the Copy License button on the Load
License screen.
5. Browse to your license file (Xilinx.lic) and click Open.
This action copies the license file to the %APPDATA%\XilinxLicense (Windows) or
<Home>/.Xilinx directory of your computer where it will be automatically found by the
AMD tools.
6. Click OK.
Note: Restart the floating license server to ensure the new AMD licenses are enabled.
RECOMMENDED: AMD recommends you place this directory into your application search path
4. After the FLEXnet utilities are installed, run the following commands to start the floating
license server:
• For Linux, enter <Server Tool directory>/lnx64.o/lmgrd -c
<path_to_license>/<license file>.lic -l <path_to_license>/<log
filename>.log.
• For Windows, enter <Server Tool directory>/lmgrd.exe -c
<path_to_license>/<license_file>.lic -l <path_to_license>/
<log_filename>.log.
For Linux operating systems, licensing environment variables cannot be set using the Vivado License
Manager (VLM). The environment variable fields are read only, so they are grayed out and there are
no Set buttons. The environment variable must be set using the appropriate OS shell and commands.
Managing Licenses
Managing Licenses with the Vivado License Manager
The Vivado License Manager (VLM) is intended to assist with license generation for Certificate-
based licenses only. The Vivado License Manager is installed with the Vivado Edition and many
standalone tool installations. The following figure shows the VLM.
The typical tasks that Vivado License Manager is used for are:
• Obtaining A License: Choose from several license options and go to the AMD Product
Licensing Site to complete the license generation process.
• Viewing License Status: See which licenses are visible to the local machine. This is a useful
view for debugging licensing issues.
• Loading Licenses Onto a Local Machine: After a certificate license (.lic) file has been received,
it can be placed into the appropriate location on the machine. For step-by-step instructions,
see the Installing Your License key section for your license type below.
• Viewing and Setting (Windows) License Search Locations: Vivado tools look into several
default locations to try to find the authorization to run. If your license is located elsewhere on
the machine or on a floating license server, a path to that license must be specified.
Information regarding the licenses in your product licensing account are displayed in a split-
section view. To view detailed information about the licenses in the detail view in the bottom
table, click a row in the master view in the top table. The detail view table displays:
• Download ( ): Download your license file if it does not arrive through email.
• Delete ( ): Delete the license file. After a file is deleted the entitlement then becomes
available on the Create New License page and can be regenerated for another host ID.
• Download (View EULA): View the end user license agreement (IP only).
Modifying Licenses
To modify an existing certificated-based license, select the license file in the master view.
• Delete license files and place the entitlement back onto your account.
• Rehost or change node-locked or license server Host IDs.
• Add or remove seats to an existing license product entitlement.
• Add or remove product entitlements from a license key.
Delete Entire License File and Place Entitlement Back Onto Your Account
1. From the Manage Licenses Tab, select the license file you want to delete.
2. Click the Delete button ( ) located below and to the left of the license file details.
3. Click Accept button to accept the Affidavit of Destruction.
All license seats in the entire license file are deleted, and the entitlements are returned to your
account.
When you delete seats or remove products from your certificate-based license files, the
entitlement is essentially “put back” or reallocated into your licensing account. You will find that
the number of entitled seats in the Create New Licenses tab of your account is incremented by
the same number of seats you deleted previously from existing license files.
Before the reallocation of entitlement occurs, you must first agree to an Affidavit of Destruction.
This legal agreement is required to ensure the deactivated product entitlements are no longer
being used.
The number of allocation operations is recorded for each user. Administrators are allowed to
reallocate product entitlements five times per major release. End users are allowed to reallocate
product entitlements three times per major release.
1. From the Manage Licenses tab, select the license file to which you wish to add or remove
seats.
2. Click Modify License.
The Modify License screen appears.
3. Go to Product Selection.
4. Click Next twice.
If you removed seats, accept the Affidavit of Destruction.
Note: No Affidavit of Destruction is required for adding seats.
Modifying a key file uses the same input form as when the license key file was created,
except that additional product entitlements of the same license type (floating or node-locked)
are made available for adding to the license file.
• AMD order numbers are listed on the left panel of the screen.
• Order details populate on the right panel of the screen when you highlight a specific order.
• You might only select one order at a time.
• The order’s shipping address information is visible even when product is delivered
electronically.
Figure 3: Orders
Add Users
1. Select the Manage Users tab.
2. To add a user to your product licensing account, do the following:
a. Enter the corporate email address of the new user.
Note: The email address you provide must be the same email address the user supplied or supplies
when creating their AMD account. If not, you might not be properly recognized when logging in.
If added users have already logged into the Product Licensing Site, their name appears in
the user list. If they have never been to the site, the words Not Yet Registered appears in
the space for their name. After they register, their name is filled in.
b. To grant the new user customer account administrative privileges, select Add as a full
administrator.
c. To grant the new user the ability to generate Floating License, select Allow Floating
Licenses. This option does grant full administrative privileges.
If you check Allow Floating Licenses only, the restriction on node-locked keys is lifted, but
the others remain. You cannot check both boxes because it is not allowed. Full
administrators already have floating license generation capability.
In some instances, a customer account administrator might wish to have design team
members administer license key files for their own use. By leaving both Add as full
administrator and Allow Floating Licenses check boxes unchecked, you grant the user the
following restricted privileges:
• User can generate node-locked license keys only.
• User can view and modify only those license key files they generated for themselves.
• User cannot manage users.
Remove Users
1. Select the Manage Users tab.
2. To remove administrative or floating license generation privileges from a user, uncheck the
Administrator or Floating check box for that user.
3. To remove a user from a product licensing account, click the Delete button for that user.
Licensing Overview
Product Licensing Account Overview
When you purchase a design tool edition or IP product from AMD, you are purchasing a license
to use and receive updates for that product for one year. The license to use AMD design tools
and IP products is managed through the use of product entitlements. A product entitlement is
the determination of:
In addition to managing the product entitlements for your purchased design tools and IP, you can
also access product entitlements for No Charge or Evaluation products.
Generating a license from a product entitlement results in one or more license keys being
generated by the website. When installed, the license keys enable the use of the design tools and
IP that were purchased or are being evaluated. Your product entitlements and resulting license
key files are managed in a product licensing account on the AMD website.
Product licensing accounts are specific to the individual listed on the AMD Software Purchase
Order, who is either the end-user or administrator of the design tools. All purchases made can be
managed in the same product licensing account if a single administrator is named. A company
site can have multiple accounts managed by different administrators. The latter is helpful if a site
has multiple design teams working on differing projects with different budget pools.
Note: A license can be generated for a product entitlement that has expired; however, it only enables
product releases up to the subscription end date. Applying a product update made available after the
subscription end date of your license results in a licensing error the next time the tool is used.
Any LogiCORE IP and design tools entitlements you have purchased appear in your list of
entitled products when you log into the Product Licensing Site. Currently, all IP entitlements
generate certificate-based licenses. Licenses for Evaluation and No Charge IP are available on the
site in a separate area. Licenses for all your certificate-based design tools and IP can now be
generated in one pass. They are emailed to you in a single license file.
When a license key file is rehosted or is modified to delete seats or product entitlements, the
corresponding increment lines are regenerated or removed from the modified license key file.
An example of a typical customer account administrator is a CAD tools manager. Every product
licensing account must have at least one customer account administrator. A customer account
administrator can manage more than one product licensing account.
• Generating node-locked or floating licenses for AMD design tools and IP products.
• Adding and removing users from the product licensing account.
• Assigning administrative privileges to other users.
The original customer account administrator is the Ship To contact identified during the product
ordering process. That person receives an email with instructions on how to download and
license each purchased product. The customer account administrator must follow the link in the
email, to ensure access to the purchased products.
End User
Adding end users to a product licensing account allows an engineer or design team member the
flexibility to manage and generate license keys on their own. The end user can generate license
keys for node-locked products entitlements within the account, evaluation, and “no charge”
license keys for design tools and IP products. A customer account administrator can also
configure the end user account to allow an end user to generate floating licenses. An end user
cannot:
• View or generate floating license keys by default. This privilege can be assigned to them by
the customer account administrator.
• View the license keys generated by other users.
• Add or remove other users to or from the product licensing account.
No-Charge
• Generate a 30-day free evaluation license key that enables Vivado ML Enterprise Edition.
• Generate a 30-day free evaluation license that enables AMD Vitis™ HLS.
• Generate license keys for evaluation and no charge IP products.
Note: A customer who is already licensed for a full version of an AMD Design Tools product edition can
evaluate other AMD Design Tools product editions or IP. These product entitlements are made available in
the same product licensing account.
If you purchased products which use certificate-based licenses, follow the link included in your
order confirmation email. It provides direct access to an account containing your product
entitlements.
• To evaluate the Vivado Design Suite products, go to the Vivado ML Editions page.
• To evaluate IP products, go to Intellectual Property page and follow the Evaluate link on the IP
product page of interest.
The AMD Product Licensing site is an online service for licensing and administering evaluation
and full copies of AMD design tools and intellectual property (IP) products.
Using the AMD Product Licensing site, you can do the following:
It is important to keep your AMD User Account up to date. As you change companies, addresses,
or emails might change.
1. Go to https://www.xilinx.com.
2. Click Sign In.
3. Click Edit Profile.
4. Enter your new corporate email address in the Enter new Corporate email address box.
5. Click Update button for changes to take effect.
Certificate-Based Licensing
AMD enforces the AMD End-User License Agreement at runtime in the AMD design tools using
certificate-based licensing.
A certificate, commonly referred to as a “license file (.lic)” is issued from the AMD Product
Licensing Site. The certificate is matched to a given machine, server, or licensing dongle using
your entering host-id which uniquely identifies the machine. This license certificate must remain
present on the machine and in the license search path, because the Vivado tools need access to
this file to check for a valid license feature during runtime.
Note: Flex-ID Dongle licensing for AMD Software is supported only on Windows platforms.
• Node-Locked License: A node-locked license allows for the use of a single seat of a product
entitlement on a specific machine.
• Floating License: A floating license resides on a network server and enables applications to
check out a license when they are invoked. At any one time, the number of licenses for
simultaneous users is restricted to the number of license seats purchased.
• License Rehosting: The act of changing the host ID of a generated license due to machine
hardware changes, hard-drive failure or the moving of a license from one machine to another.
• License Deletion: The act of removing a license from a machine, and having the entitlement
placed back into the AMD Product Licensing Account.
• Affidavit of Destruction: Click-through agreement by which you certify that the license file
(.lic) for a rehosted or deleted license will be destroyed and no longer used.
Chapter 4
All Editions and download options are available on the AMD Downloads Website.
AMD introduced Vivado Lab Edition, which features a dedicated and streamlined environment
for programming and debugging devices in lab settings.
AMD introduced the Power Design Manager which is a standalone design tool used to estimate
the power requirements of Versal device and AMD Kria™ products. It supports the Xilinx Power
Estimator (XPE) file exchange format for importing data from Vivado and XPE.
For users wishing to install one of the full Vivado Editions, there are three choices.
• AMD Unified Installer for FPGAs & Adaptive SoCs 2024.1: Windows Self Extracting Web
Installer
• AMD Unified Installer for FPGAs & Adaptive SoCs 2024.1: Linux Self Extracting Web Installer
• Vivado ML 2024.1: All OS Installer Single-File Download
The AMD Unified Installer for FPGAs & Adaptive SoCs is available to download on the AMD
Downloads Website.
• To download the Vivado Lab Edition tools, select a version of Vivado from the list and
scroll to the Vivado Lab Solution section to download for Windows or Linux.
Related Information
Download Verification
After downloading the installation file, you can complete download verification to prove the
authenticity and integrity of the downloaded installation file with a fair degree of certainty. This
step is completely optional but highly recommended. You can skip this step and continue with
the installation.
• Authentication validates that downloaded file was created by the signee, in this case signee is
AMD Inc. In other words, it shows that downloaded file is not forged by a third party.
• Integrity validates that contents of downloaded file are not tampered by third party. In
summary, download verification allows users to validate if the downloaded file indeed is
prepared by AMD and if the contents of the downloaded file is altered or not.
The Digest, Signature, and Public Key options are provided on download page for the purpose of
download verification.
There are two ways to verify the authenticity and integrity of downloaded files. You can choose
one or both of the following methods to ensure the authenticity and integrity of downloaded
files.
For both of the above methods, before you can verify and authenticate the downloaded file, you
must download, import, and trust the public key.
3. Set the trust level to ultimate. This allows verification of the key signed by AMD.
a. First, enter the following command to list the public keys: gpg --list-keys
gpg --list-keys
/home/myuser/.gnupg/pubring.kbx
-------------------------------
pub rsa4096/0x85D4B4BB1D692FDB 2018-04-10 [SC]
Key fingerprint = 745F 4D5B 2402 441F 410F BD0D 85D4 B4BB 1D69
2FDB
b. To specify the key to edit, enter the following command: gpg --edit-key
0x85D4B4BB1D692FDB
gpg --edit-key 0x85D4B4BB1D692FDB
gpg (GnuPG) 2.1.15; Copyright (C) 2016 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
pub rsa4096/0x85D4B4BB1D692FDB
created: 2018-04-10 expires: never usage: SC
trust: unknown validity: unknown
sub rsa4096/0xE80A66CA2B176EF9
created: 2018-04-10 expires: never usage: S
sub rsa4096/0xF991913DFE468839
created: 2018-04-10 expires: never usage: E
sub rsa4096/0xC93822D0B9087126
created: 2018-04-10 expires: never usage: A
[ unknown] (1). Xilinx, Inc. (Xilinx Software signing key)
<[email protected]>
c. Enter the following command to set the trust level for the legitimate key: trust
gpg> trust
pub rsa4096/0x85D4B4BB1D692FDB
created: 2018-04-10 expires: never usage: SC
trust: unknown validity: unknown
sub rsa4096/0xE80A66CA2B176EF9
created: 2018-04-10 expires: never usage: S
sub rsa4096/0xF991913DFE468839
created: 2018-04-10 expires: never usage: E
sub rsa4096/0xC93822D0B9087126
created: 2018-04-10 expires: never usage: A
[ unknown] (1). Xilinx, Inc. (Xilinx Software signing key)
<[email protected]>
Please decide how far you trust this user to correctly verify other
users' keys
(by looking at passports, checking fingerprints from different
sources, etc.)
pub rsa4096/0x85D4B4BB1D692FDB
created: 2018-04-10 expires: never usage: SC
gpg> q
myuser@mymachine:$
Now that you have downloaded, imported, and trusted the AMD public key – you can ensure the
authenticity and integrity of the downloaded file by verifying the signature or verifying the
digest.
Note: You can pick one or both of methods to ensure the authenticity and integrity of downloaded file.
a. Run the following command to verify the signature that ensures that digest file is indeed
coming from AMD Inc.
gpg -v --verify
FPGAs_AdaptiveSoCs_Unified_20XX.Y_MMDD_HHMM_Lin64.bin.digests
5. After the authentication is done, verify the digest either by using hashing executable or
OpenSSL.
• To verify the digest using hashing executable – sha256, run the following command:
sha256sum -c
FPGAs_AdaptiveSoCs_Unified_20XX.Y_MMDD_HHMM_Lin64.bin.digests
Note: You can use other hashing executables as well such as md5sum, sha1sum, and sha512sum.
Output of the command is a computed hash value that you need to compare to the
contents of the digest file.
Installation Flow
Lab Edition, Full Product Download, or Web Installer
If you downloaded the Lab Edition or full product installation, decompress the file, and then run
xsetup (for Linux) or xsetup.exe (for Windows) to launch the installation.
RECOMMENDED: AMD recommends the use of 7-zip or WinZip (v.15.0 or newer) to decompress the
downloaded tar.gz file.
If you downloaded the lightweight installer, launch the downloaded file. You are prompted to log
in and use your regular AMD login credentials to continue with the installation process.
Note: On Linux the file is a .bin file and can be launched by running ./<name of the file>.bin.
Ensure that you have changed the file permissions to execute.
After entering your login credentials, you can select between a traditional web-based installation
or a full install image download.
• Download and Install Now: Allows you to select specific tools and device families on following
screens, downloads only the files required to install those selections, and then installs them
for you.
• Download Image (Install Separately): Requires you to select a download destination and to
choose whether you want a Windows only, Linux only, or an install that supports both
operating systems. You also have an option to either download the full installer or download
only selected products. There are no further options to choose with the Full Image selection,
and installation needs to be done separately by running the xsetup application from the
download directory.
Figure 6: AMD Unified Installer for FPGAs & Adaptive SoCs - Select Install Type
1. Check the links described in Important Information for any installation issues pertaining to
your system or configuration.
2. Ensure your system meets the requirements described in Chapter 2: Requirements and Setup.
3. Close all open programs.
1. Run the installation file, which opens the Unified 2024.1 Installer.
2. Click Next.
3. Enter your account credentials.
4. Select Download and Install Now, and then click Next.
5. Select a product to install.
6. Click Next.
7. Select the installation directory.
CAUTION! The installation directory path must not contain any spaces.
1. Provide the destination path (which does not have any other files) and choose the platform
for which the installer is desired. Zip archive can be selected to have a zip file of the same
installer.
2. Select the image contents.
• Full Image: Download the entire installer.
• Selected Product Only: Download only the files necessary for the selected tools/devices.
• For Windows clients, click the Start menu, and select Xilinx Design Tools → Vivado <version>
→ Add Design Tools or Devices.
• For Linux clients, select Vivado → Help → Add Design Tools or Devices.
If you have installed the Vivado ML Standard or ML Enterprise Edition, you are presented with
the option to upgrade the edition.
Based on the above selection, you are presented with all available tools and devices that can be
added to the current installation.
You can also add tools or devices from the AMD Information Center (XIC).
1. If you are using alternate proxy settings to the ones referred to, click the Change Proxy
Settings button to specify the settings.
2. Check whether your company firewall requires a proxy authentication with a user name and
password. If so, click the Change Proxy Settings button in the dialog box above.
• Disk Usage is optimized by default during the installation. Disk usage settings can be
modified in Preferences.
For Linux, because root or sudo access is required to install drivers, this option has been removed
from the Linux installer beginning in Vivado 2015.4. The general Vivado installer can now be run
on Linux without root or sudo privileges. To install cable drivers on Linux, there is now a script
that must be run as root or sudo post-installation.
Note:
./install_drivers
Note: Replace ${vivado_install_dir} with the location of your install directory. If%log_dir
% is not specified, a file named install_drivers_wrapper.log will be placed under
%VIVADO_INSTALL_DIR% ofyour Vivado install location.
Note: Set or replace %VIVADO_INSTALL_DIR% with the location of your install directory.
• To uninstall the products on a Linux client, run the following commands as root:
rm -f /etc/udev/rules.d/52-xilinx-digilent-usb.rules rm -f /etc/udev/
rules.d/52-xilinx-ftdi-usb.rules rm -f /etc/udev/rules.d/52-xilinx-
pcusb.rules
AMD Information Center and Documentation Navigator are not removed during uninstallation.
Both are intended to be standalone applications common to multiple versions of AMD tools.
If the applications are no longer required, they must be uninstalled separately through the
corresponding entry in the Start Menu program group, or for Windows, use the Uninstall or
change a program control panel option.
In Linux, Uninstalling the AMD Vivado™ Design Suite tool does not need any root privileges if
you have access to that path and there are not any instances of the tool open from that
installation.
In Windows, you will require Administrator privilege if you plan to uninstall using the command
line options. Uninstalling using XIC does not require any admin privilege.
Uninstall on Windows
To uninstall any AMD product, select the Uninstall item from that product’s Start Menu folder.
For instance, to uninstall Vivado Design Suite: Edition, select Start → All Programs → Xilinx
Design Tools → Uninstall 2024.1.
GUI Mode
You can use the following command line option to uninstall in GUI mode: <install_path>
\.xinstall\Vivado_2024.1\xsetup.exe -Uninstall
Batch/Silent Mode
You can use the following command line option to uninstall in Batch/Silent mode:
<install_path>\.xinstall\Vivado_2024.1\xsetup.exe -b Uninstall
XIC to Uninstall
You can uninstall the tool by launching XIC and using the respective Uninstall option under
Manage Installs tab, which will launch the Uninstaller in GUI mode.
Alternatively, you can also use the corresponding entry in the Uninstall or change a program
control panel option.
Uninstall on Linux
To uninstall any AMD product on a Linux client, select Applications → Xilinx Design Tools →
Uninstall 2024.1.
GUI Mode
You can use the following command line option to uninstall in GUI mode:
<install_path>/.xinstall/Vivado_2024.1/xsetup -Uninstall
Batch/Silent Mode
You can use the following command line option to uninstall in Batch/Silent mode:
<install_path>\.xinstall\Vivado_2024.1\xsetup.exe -b Uninstall
XIC to Uninstall
You can uninstall the tool by launching XIC and using the respective Uninstall option under
Manage Installs tab, which will launch the Uninstaller in GUI mode.
Network Installations
Installing to a network location provides a way for client machines to access the design tools by
pointing to it on the network drive. To run the design tools on the network, the client machines
must be set up correctly to ensure the environment variables, registry, and program groups all
point to the network. The following sections describe the procedure for network setups.
1. To run the design tools from a remotely installed location, run an X Windows display
manager, and include a DISPLAY environment variable.
2. Define DISPLAY as the name of your display.
DISPLAY is typically unix:0.0. For example, the following syntax allows you to run the tools
on the host named bigben and to display the graphics on the local monitor of the machine
called mynode.
setenv DISPLAY mynode:0.0
xhost = bigbenPC Clients
To work around this issue, either specify a UNC path (for example, \\network_loc\Xilinx\)
or define your target installation directory as \Xilinx under the network mount point (For
example: N:\Xilinx).
Note: You are not able to browse to the remote mapped drives using the AMD installer. You need to
manually type in your installation path which contains a mapped network drive.
RECOMMENDED: Generate this reference for each new release, so that new devices, tools, options, or
other changes will be accounted for in your options file.
To begin using batch mode, open a command shell, and change to the directory where you have
stored your extracted installer.
2. After you make a selection, you will be prompted with the location/file name for your
configuration file and the interactive mode exits. Below is a sample Vivado ML Enterprise
Edition configuration file:
Each option in the configuration file matches a corresponding option in the GUI. A value of 1
means that option is selected; a value of 0 means the option is unselected.
License Agreements
When using the command line, use the command-line switch, -a or --agree, to indicate your
agreement to each of the above. If one of the above is left out of the list, or the agree switch is
not specified, the installer exits with an error and does not install.
This is an example of the command line for a typical new installation using a configuration file.
If you want to use one of the AMD default edition configurations, you do not have to specify the
--config option, but because the destination directory is included in the configuration file, you
will be required to specify this on the command line.
The above command uses the default configuration options for the edition specified. To see the
default configuration options, use the –b ConfigGen mode as described above. The batch
mode of the installer can also uninstall and upgrade (add additional tools and devices). For the full
list of the options in the installer batch mode, run xsetup -h or xsetup --help.
Note: For Windows, open the command window with administrator privileges and run the xsetup.bat file,
found in the \bin directory, and not xsetup.exe.
First, you need to acquire an authentication token (stored in a text file) that is used by the web
installer to authenticate the user before downloading/installing the tool.
This authentication token needs to be acquired (generated) at least once and expires after 7 days.
You need to generate/acquire new token after it is expired.
• The web installer asks for an AMD Account user ID and password before generating the
authentication token.
./OtherDirectory/xsetup -b AuthTokenGen
This is a fresh install.
Running in batch mode...
Copyright (c) 1986 - 2024 AMD, Inc. All rights reserved.
INFO - Internet connection validated, can conect to internet.
INFO - In order to generate the authentication token please provide your
AMD account E-mail Address and password.
E-mail Address:[email protected]
Password:
INFO - Generating authentication token...
INFO - Saved authentication token file successfully, valid until
03/31/2024 11:10 AM
Example Command:
Updates:
Updates to your existing install can only be installed using a full image (SFD) or via the
notification in XIC. AMD does not support updates to existing installer via Web Installer.
In addition, XIC now includes a cockpit from which you can manage all of your AMD tool
installations. Update, check licenses or uninstall all from the new Manage Installs tab as shown in
the following figure.
Appendix A
The AMD Technical Information Portal is an online tool that provides robust search and
navigation for documentation using your web browser. To access the Technical Information
Portal, go to https://docs.amd.com.
Documentation Navigator
Documentation Navigator (DocNav) is an installed tool that provides access to AMD Adaptive
Computing documents, videos, and support resources, which you can filter and search to find
information. To open DocNav:
• From the AMD Vivado™ IDE, select Help → Documentation and Tutorials.
• On Windows, click the Start button and select Xilinx Design Tools → DocNav.
• At the Linux command prompt, enter docnav.
Note: For more information on DocNav, refer to the Documentation Navigator User Guide (UG968).
Design Hubs
AMD Design Hubs provide links to documentation organized by design tasks and other topics,
which you can use to learn key concepts and address frequently asked questions. To access the
Design Hubs:
Support Resources
For support resources such as Answers, Documentation, Downloads, and Forums, see Support.
References
These documents provide supplemental material useful with this guide:
Training Resources
AMD provides a variety of training courses and QuickTake videos to help you learn more about
the concepts presented in this document. Use these links to explore related training resources:
Revision History
The following table shows the revision history for this document.
Copyright
© Copyright 2012-2024 Advanced Micro Devices, Inc. AMD, the AMD Arrow logo, Alveo, Artix,
Kintex, Kria, Spartan, UltraScale, UltraScale+, Versal, Virtex, Vitis, Vivado, Zynq, and
combinations thereof are trademarks of Advanced Micro Devices, Inc. Other product names used
in this publication are for identification purposes only and may be trademarks of their respective
companies.