Xilinx Design Tools: Installation and Licensing Guide
Xilinx Design Tools: Installation and Licensing Guide
Installation and
Licensing Guide
Vivado Design Suite and ISE
Design Suite
Revision History
The following table shows the revision history for this document.
Chapter 2: WebTalk
WebTalk Participation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Setting WebTalk Install Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Setting WebTalk User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Checking WebTalk Install and User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Types of Data Collected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Transmission of Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
For information on what is new, known issues, and technical support for the Xilinx Design
Tools, see the Xilinx Design Tools: Release Notes Guide (UG631).
This chapter describes how to download and install the Xilinx Design Tools.
Most files in the Xilinx Download Center are downloaded using the Akamai download
manager. For the optimum download experience:
section be downloaded prior to running the installer. See Important Information area of the web
page section for more details.
Note: For 14.x, the installers under the Xilinx Design Tools heading also contain the standalone
selections for the Software Development Kit and Lab Tools. Depending on your use case, you
may not need to download these separate installation programs if you are downloading the
Xilinx Design Tools installers.
4. Enter your User ID and Password to log into your Xilinx account.
Note: If you do not have a Xilinx account, you must create one in order to download products.
Most files in the Xilinx Download Center are packaged using TAR methods. You will need
to use software from a third party provider to unpack them. Consult your IT department
for assistance. Commonly used tools for TAR files are 7-ZIP, GNU built-in tools, WinZIP,
and WinRar. These tools are licensed solely by each respective developer, and not by
Xilinx. Xilinx hereby disclaims any warranties, express or implied, including warranties of
merchantability, fitness for a particular purpose, or non infringement with respect to
these suggested software tools.
• If EDK is installed, make sure the installation is in a directory structure that does not
contain spaces.
Note: The Xilinx Design Tools installers do not set global environment variables, such as XILINX,
on Windows. To find out if this affects the way you run Xilinx design tools, see “Platform-Specific
Installation Instructions.”
• If you downloaded an installation file, decompress that file and run xsetup.exe.
• If you downloaded the installation file in multiple parts, decompress the file with the .tar
extension and run xsetup.exe. You should not decompress any other files
• If you received a Xilinx Design Tools DVD, load the DVD. If the auto-run feature of your
DVD drive is enabled, the setup program should start automatically. If it does not,
browse to the DVD in Windows Explorer and run xsetup.exe.
Linux Installation
The method of starting the installation depends on how you have obtained the installation
program. See Downloading the Xilinx Design Tools for details on your options.
• If you have downloaded an installation file, decompress that file and run the xsetup
program contained therein.
• If you downloaded the installation file in multiple parts, decompress the file with the .tar
extension and run xsetup. You should not decompress any other files.
• If you have ordered and received a Xilinx Design Tools DVD, load the DVD. Click the
setup file in your file manager, or browse to the root of your DVD drive and type
./xsetup.
Installation Flow
The following section describes important screens you will encounter during the installation
process.
Note: For each of the following installation steps, click on the text of any item with a check box next
to it to obtain more information. Information is displayed in the “Description” area near the bottom
of the screen.
This screen lists all the required additional installation files to complete the installation.
Users will need to point the tool to a location that contains these files. All the required files
should be in the same directory. Once the correct files have been identified, the installer
will check the integrity of these files to ensure archives are not corrupt. This process might
take a few minutes to complete.
X-Ref Target - Figure 1-1
Figure 1-1: Xilinx Design Tools Installation - Select Download Location Directory
Figure 1-2: Xilinx Design Tools Installation - Select Xilinx Products Screen
Note: The ISE WebPACK™ tool product installer installs both ChipScope Pro analyzer and the
Embedded Development Kit. Although installed, these applications will require a separate license to
run.
Figure 1-3: Xilinx Design Tools Installation - Xilinx Modules and Devices
Note: WebTalk is always enabled when using the WebPACK™ tool. If you install an Edition product,
the installer allows you to deselect Enable WebTalk. However, if a WebPACK tool license is used to
process the design, Enable WebTalk is ignored. Please click on the Enable WebTalk item, in the
installer, and read the description box for full details.
on the type of product you are installing. Any Editors or WebPACK tool installation creates
a directory named \ISE_DS. Lab tool standalone installations create \LabTools. SDK
standalone installations create \SDK. This ensures Edition and Standalone tools can coexist
properly on your hard drive.
X-Ref Target - Figure 1-4
Near the end of the installation, the Xilinx License Configuration Manager opens by default.
Follow the instructions in the Manager to obtain or locate a license file.
Note: EDK tools require the Cygwin tools distributed by RedHat. A copy of these tools is distributed
with the EDK installation.
Linux Clients
When installation is complete, the installation program creates an environment variables
file.
To set your environment variables manually or from within your setup script, Xilinx
recommends you copy the settings from the appropriate file for your operating system, as
listed above. Xilinx environment variables settings are specific to each operating system
platform.
1. Install the Xilinx Design Tools first. This installation contains the installer files for the
USB FLEXid dongle driver.
2. Run FLEXId_Dongle_Driver_Installer.exe from <Xilinx Installation
Directory>\14.3\ISE_DS\ISE\bin\nt.
3. On the Select Options screen, be sure only FLEXid 9 Drivers is checked.
After installation, you will need to reboot to ensure the dongle operates correctly.
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.
Linux Clients
Each user must source settings32.(c)sh or settings64.(c)sh (whichever is
appropriate for your operating system) from the $XILINX area in which the design tools are
installed. This points the Xilinx environment variable, path, and LD_LIBRARY_PATH to the
installed location.
To run the design tools from a remotely installed location, run an X Windows display
manager, and include a DISPLAY environment variable. 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:
To work around this issue, define your target installation directory as "\Xilinx" under the
network mount point (For example: “N:\Xilinx”).
Windows 7 default security levels won’t allow you to select remote mapped drives as an
Administrator. In order to install Xilinx Design Tools on remote mapped drives, you need to
change your account control settings using the steps below:
1. Open the Windows Control Panel, from the Windows Start menu, and select ‘User
Accounts’. If your Control Panel Uses ‘Category View’, you will need to click ‘User
Accounts’ on two successive screens
2. Click on ‘Change User Account Control settings’ and allow the program to make
changes
3. Click and slider the slider-bar down to the second to lowest setting (as seen in the below
figure). Click OK.
Xilinx recommends you revisit this procedure to restore your settings to their previous state
after installation.
Note: You will not be able to browse to remote mapped drives using the Xilinx installer. You will
need to manually type in your installation path which contains a mapped network drive.
XilinxNotify
The XilinxNotify tool is the preferred method of obtaining updates. It provides the following
features:
° Automatic periodic checks at ISE Project Navigator and Vivado startup time.
° Select Start > All Programs > Xilinx Design Tools > ISE Design Tools 14.3 > Accessories >
Check for Updates.
Note: To perform an update installation, you must have write permissions for the $XILINX
installation directory.
Download Center
Quarterly releases for all platforms are regularly made available on the Download Center at:
http://www.xilinx.com/support/download/index.htm
To uninstall any Xilinx product, select the Uninstall item from that product’s Start Menu
folder. For instance, to uninstall the ISE WebPACK design tools or an ISE Design Suite:
Edition, select Start > All Programs > Xilinx Design Tools > ISE Design Suite 14.3 > Accessories >
Uninstall.
Depending on what you have installed, you may also need to uninstall some ancillary
applications, such as WinPcap 4.0 (optional component of DSP Tools).
Before uninstalling, make sure you have moved any project files you want to keep outside
your Xilinx installation directory structure, or they will be deleted.
Uninstalling on Linux
To uninstall the Xilinx Design Suite product, you need to remove the Xilinx installation
directory from the shell.
WebTalk
The WebTalk feature helps Xilinx understand how you use Xilinx® FPGA devices, software,
and IP. The information collected and transmitted by WebTalk allows Xilinx to improve the
features most important to you as part of our ongoing effort to provide products that meet
your current and future needs. When enabled, WebTalk provides information on your use of
the synthesis and implementation flow in the Xilinx Design Tools.
WebTalk Participation
Your participation in WebTalk is voluntary except in the following cases:
In these cases, WebTalk data collection and transmission always occurs, regardless of your
preference settings. For all other cases, data is not collected or transmitted if you disable
WebTalk.
The table below summarizes WebTalk behavior for data transmission to Xilinx from your
post-route design, based on your Xilinx license, WebTalk install preference, and user
preference settings.
Table 2-1: WebTalk Behavior for Bitstream Generation or Route Design Flow
WebTalk Data
Design Flow License WebTalk Install WebTalk User Transmission to
Preference Preference
Xilinx
Bitstream
WebPACK Yes
Generation/ Route Ignored Ignored
(or pre-release software) (Send)
Design
Bitstream
Yes
Generation/ Route Logic Edition Enabled Enabled
(Send)
Design
Table 2-1: WebTalk Behavior for Bitstream Generation or Route Design Flow
Note: For Vivado™ Design Suite, WebTalk currently transmits data after Route Design for all devices.
For ISE® Design Suite, Webtalk transmits data after PAR for devices which bitstream generation is
not enabled and after bitstream generation for devices that support bitstream generation.
• Windows 7:
%APPDATA%\Xilinx\Common\<version>\webtalk
where:
%APPDATA% is:
C:\Users\<user>\AppData\Roaming
• Linux:
%APPDATA%/.Xilinx/Common/<version>/webtalk
where:
%APPDATA% is:
/home/<user>
Note: For the ISE Design Suite flow, you can enable or disable WebTalk user options from the Project
Navigator or by using the XWebTalk command line utility. For more information, go to the ISE
WebTalk page available from the Xilinx website.
config_webtalk -info
• Software version
• Platform information (for example, operating system, speed and number of processors,
and main memory)
• Unique project ID
• Authorization code
• Date of generation
• Targeted device and family information
For more information on the type of data that is collected, see the ISE WebTalk page
available from the Xilinx website. To see the specific WebTalk data collected for your design,
open the usage_statistics_webtalk.xml file in the project directory. You can also
open the usage_statistics_webtalk.xml file for easy viewing of the data
transmitted to Xilinx.
Transmission of Data
WebTalk is invoked after bitstream or route design compilation. WebTalk bundles the collected
data in an usage_statistics_webtalk.xml file and sends this file to Xilinx by https
(hypertext transfer protocol secure) post. Every new compilation for a given design overwrites the
previous usage_statistics_webtalk.xml file. WebTalk also writes an HTML file equivalent
usage_statistics_webtalk.html file for easy viewing of the data transmitted to Xilinx.
WebTalk also writes to the vivado.log (or runme.log) file that contains additional
information about whether the file was successfully transmitted to Xilinx.
For information on the licensing of the Vivado Design Suite and the generation of ISE® and
Vivado™ Design Edition licenses, see the Xilinx Design Tools: Release Notes Guide (UG631).
• If you purchased products, follow the link included in your order confirmation email. It
will provide direct access to an account containing your product entitlements.
• To evaluate the ISE Design Suite products, go to http://www.xilinx.com/ise_eval.
• To evaluate IP products, go to http://www.xilinx.com/ipcenter and follow the Evaluate
link on the IP product page of interest.
• To access the Product Licensing Site directly, go to http://www.xilinx.com/getlicense.
You must first register or enter your registration information.
You must first sign in. If you already have a Xilinx user account, enter your user ID and
password, and then confirm your contact information is current. If you do not have an
account, click the Create Account button.
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. Full and No
Charge licenses have a subscription period of one year. Design tools evaluations are for 30
days, and IP evaluations are for 120 days.
Activating 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 Xilinx website.
Product licensing accounts are specific to the individual listed on the Xilinx 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 key can be generated for a product entitlement that has expired; however, it will only
enable product releases up to the subscription end date. Applying a product update made available
after the subscription end date of your license results in an error.
• Generating node-locked or floating licenses for Xilinx design tools and IP products.
• Adding and removing users from the product licensing account.
• Assigning administrative privileges to other users.
• Ordering product DVDs (if desired).
The original customer account administrator is the Ship To contact identified during the
product ordering process. That person will receive 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 may
generate license keys for node-locked products entitlements within the account as well as
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 may 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.
Evaluation User
Evaluation users can:
• Generate a 30-day free evaluation license key for the Xilinx Design Tools: System
Edition
• Generate license keys for evaluation and no charge IP products
• Generate a WebPACK™ tool license for the Xilinx Design Tools
• Request a Xilinx Design Tools DVD with one of the following Shipping Options:
° Overnight
Note: A customer who is already licensed for a full version of a Xilinx Design Tools product edition
can evaluate other Xilinx Design Tools product editions or IP. These product entitlements are made
available in the same product licensing account.
All user types can download products electronically and request a Xilinx Design Tools DVD.
Selecting Products
To begin the license generation process for products you have purchased or want to
evaluate:
The type of product entitlements available are Full (purchased), No Charge, or Evaluation.
Full and No Charge licenses have a subscription period of one year. Design tools evaluation
is for 30 days. IP evaluations are for 120 days.
Floating and node-locked licenses cannot be combined in the same license key file.
Note: 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. A node-locked license allows for the use of a single seat
of a product entitlement on a specific machine.
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.
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.
The Xilinx Design Tools: System Edition evaluation product entitlement provides access to
all the capabilities in the Xilinx Design Tools tool set. This product entitlement is
automatically included in your product licensing account.
Product vouchers for design tools and IP product licenses may be shipped with a Xilinx or
partner development board or design kit. If you have a product voucher card, you may enter
the voucher code on the card into the associated text field and click Redeem Now. This
places the corresponding design tools or IP product entitlement in the product entitlement
table which you can use to generate a license key.
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.
Generating a License
Click the Generate License button corresponding to the type of license key file you are
generating (floating or node-locked). The license generation form shown below appears.
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 the full number of seats
remaining on the product entitlement. A product is removed from the product
entitlement table if all seats have been activated.
System information is pre-populated in the option menu if you arrived at the Product
Licensing Site from a link within the Xilinx License Configuration Manager (XLCM).
A redundant server configuration provides a fail over for the license manager software.
As long as two of the three servers are running, the license manager can continue to run.
If you do not have pre-populated system information, or if you want to add a different
host, select the Add a host option.
X-Ref Target - Figure 3-8
The host ID value uniquely identifies the machine to which your design tools or IP is
licensed. You may choose a host ID type to be a MAC address, a hard drive serial
number, a dongle ID, or a Solaris host ID.
Note: Not all host ID types are supported for all operating systems. The easiest way to obtain
your host ID is to run the XLCM on the machine that will serve as the license host.
3. Add a comment.
Adding a comment to the license key file makes it easier for an administrator to track
the allocation of design tools and IP product entitlements among users.
4. Click Next.
Third-Party Licenses
A complete copy of the third-party licenses is located at:
<install_directory>/common/licenses/unified_3rd_party_eula.txt
You will also receive a license generation confirmation email. This message contains the
generated license key file as an attachment. Add ‘xilinx.notification@entitlenow.com’ as a
trusted sender in your email address book.
If you do not receive your license by email, you can download it directly from the Xilinx Licensing
Site. See the Managing License Key Files section for details
Use the Manage Licenses page, to perform the actions described below.
• Download - If your license file does not arrive via email you may download the license
file here.
• Email - The license file may be emailed to you or another user.
• View - Gives you the ability to view the actual license file.
• Delete - Delete the license file. Once a file is deleted it will then become available on
the Create New License page and may be regenerated for another host ID.
• View the end user license agreement (IP only).
Delete an entire license file and place entitlement back into your account
1. From the Manage Licenses Tab (see Figure 3-11), select the license file you wish to
delete.
2. Click the Trash Can icon located below and to the left of the license file details.
3. Click the Accept button to accept the Affidavit of Destruction.
Note: This will delete all license seats in the entire license key file and return the entitlements to
your account.
Rehost or change the license server host for a license key file
1. From the Manage Licenses Tab (see Figure 3-11), select the license file you wish to
rehost.
2. Click the Modify License button. The Modify License screen appears.
3. Go to System Information.
4. Change or add new Host ID and/or Host Name by using the drop-down list and text entry
boxes respectively.
5. Click the Next button twice and then click the Accept button to accept the Affidavit of
Destruction.
2. Click the Modify License button. The Modify License screen appears.
3. Go to Product Selection.
4. For floating licenses, you will be able to change the Requested Seats field and add seats up to
the total number of seats available in your entitlement.
5. Click Next twice. 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 additional product entitlements of the same license type (floating or node-locked)
are made available for licensing.
If, during any of the modification steps, you receive a message that you have exceeded your
number of rehost attempts, email cs_1@xilinx.com to request additional rehost options.
• Rehosting or changing the license server host for a license key file.
• Deactivating or removing seats from an existing licensed product entitlement.
• Deactivating or deleting product entitlements from a license key file.
The license generation facility allows the reallocation of the deactivated seats or product
entitlements by making the corresponding seats or product entitlements available for
activation in the product entitlements table on the Create License page.
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.
When a license key file is rehosted or is modified to deactivate (delete) seats or product
entitlements, the corresponding increment lines are regenerated or removed from the
modified license key file.
Legacy Licensing
If you wish to obtain a license for Releases 10.1 or earlier, click the Legacy Licensing tab.
10.1 Version
1. The 10.1 Version is not automatically available on the Legacy Licensing page. Contact
Xilinx customer service via cs_1@xilinx.com to request access to this version.
2. Once the 10.1 entitlement is available in your product table, select the tools you would
like to register and click the Register button located underneath the product table.
3. A 25 character alpha numeric code will be displayed next to the Unified Registration
Code field, along with the code creation date.
4. Once you obtain your registration ID, go to the Xilinx download center and click on the
version you desire.
5. During the download process you will be prompted to insert your registration ID to
complete the download process.
Adding Users
To add a user to your product licensing account:
Note: The email address you provide must be the same email address the user supplied or supplies
when creating their Xilinx account. If not, the user may not be properly recognized when logging in.
If a user has already logged into the Product Licensing Site, their name appears in the user
list. If the user has never been to the site, the words Not Yet Registered appears in the space
for their name. Once the user has signed in, their name is filled in.
In some instances, a customer account administrator may 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, the user is granted the
following restricted 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 since it is not allowed. Full administrators
already have floating license generation capability.
Removing Users
To remove administrative or floating license generation privileges from a user, uncheck the
Administrator or Floating check box for that user.
To remove a user from a product licensing account, click the Trash Can icon for that user.
1. Save the license file attached to the e-mail to a temporary directory on your local
system.
2. Run the Xilinx License Configuration Manager:
° For Windows: Select Start > All Programs > Xilinx Design Tools 14.3 >Accessories >
Manage Xilinx Licenses.
3. Click Copy License at the top of the Manage Xilinx Licenses tab.
4. Browse to your license file (Xilinx.lic) and click Open.
5. This copies the license file to the C:\.Xilinx (Windows) or <Home>/.Xilinx
directory of your computer where it will be automatically found by the Xilinx tools.
6. When the Copy License operation is complete, the table on the Manage Xilinx Licenses
tab is updated with licensing information from the license file.
7. Click Close to exit the Xilinx License Configuration Manager.
Note: Restart the floating license server to enable the Xilinx licenses.
http://www.xilinx.com/download/index.htm
2. Unzip these utilities into a destination directory. Xilinx recommends you place this
directory into your application search path.
3. Once the FLEXnet utilities are installed, run the following commands to start the floating
license server:
° Linux
- <Server Tool directory>/bin/lin/lmgrd -c <path_to_license>/Xilinx.lic -l
<path_to_license>/log1.log
- <Server Tool directory> bin/lin64/lmgrd -c <path_to_license>/Xilinx.lic -l
<path_to_license>/log1.log
° Windows
- < Server Tool directory>\bin\nt\lmgrd -c <path_to_license>\Xilinx.lic –l
<path_to_license>\log1.log
- < Server Tool directory>\bin\nt64\lmgrd -c <path_to_license>\Xilinx.lic –l
<path_to_license>\log1.log