SDSoC Environment Installation

The installation of the SDSoC™ tool suite includes the following:

  • SDSoC environment, including an Eclipse/CDT-based GUI, high-level system compiler, and Arm® GNU toolchain 8.2.0
  • Vivado® System Edition, with the High-Level Synthesis (HLS) tool, and the Xilinx® Software Development Kit (SDK)

The SDSoC environment uses the same GNU Arm toolchain included with the Xilinx SDK, which also provides additional tools used by the SDSoC environment. The SDSoC environment setup script sets PATH variables to use this toolchain.

More information about the SDSoC installation:

  • The provided toolchains contain 32-bit executables, requiring your Linux host OS installation to include 32-bit compatibility libraries.
  • RHEL 6 and 7 64-bit x86 Linux installations might not include the 32-bit compatibility libraries, and might need to be added separately. For more information, see [RHEL6] 32-bit libraries are not installed on 64-bit OS by default.
  • On RHEL, 32-bit compatibility libraries can be installed by a superuser with root access privileges running the yum install glibc.i686 command.
  • On Ubuntu, 32-bit compatibility libraries can be installed by a superuser with root access privileges running the following commands.

    sudo dpkg --add-architecture i386
    sudo apt-get update
    sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386
    sudo apt-get install g++-multilib
    sudo apt-get install libgtk2.0-0:i386 dpkg-dev:i386
    sudo ln -s /usr/bin/make /usr/bin/gmake
  • The version of the toolchain can be displayed by running the arm-linux-gnueabihf-g++ -v command. After setting up the SDSoC environment, the last line of the output printed in the shell window should be:
    gcc version 8.2.0 (GCC)

Prepare to Install the Tools

You must perform these actions prior to installation.
TIP: To reduce installation time, disable anti-virus software.
  1. Ensure your system meets the system requirements, as described in previous topics:
  2. Close all open programs.

Download the Installation File

  1. Go to the Xilinx Downloads Website.
  2. Click an installation file to download it.
    This is a free evaluation version of the design suite that delivers instant access to some basic features and functionality at no cost. For more information, see Vivado Design Suite Evaluation and WebPACK.
    Web Installer
    The web installer is the recommended installation method, because it reduces download time and saves significant disk space.

    When you use the web installer, you choose the design tools, device families, and installation options at the time of installation. The only files that are downloaded and installed are files necessary to support those options.

    This method also mitigates issues such as network outages by resuming installation from where it stopped, instead of starting over.

    Single File Download (SFD)
    The SFD installation download is an image containing all devices and tool options that can be used for installation at a later time. This option is useful for installing all files on a network drive, or for providing maximum flexibility to users when they install the environment.

Run the Installation File

Use the installation file you downloaded to install the SDSoC development environment.
  1. Run the installation file, which opens the SDx™ IDE installer.
  2. Click Next.
  3. Enter your account credentials.
  4. Select Download and Install Now, and then click Next.
  5. Read and accept the license agreements.
    • To indicate that you accept the Xilinx Inc. End User License Agreement, click I Agree.
    • To indicate that you understand and accept the WebTalk Terms and Conditions, click I Agree.
    • To indicate that you accept the Third Party Software End User License Agreement, click I Agree.
  6. After accepting all license agreements, click Next.
  7. Customize the installation by selecting and clearing options in the tree.

    To add to this installation later, click Vivado > Help > Add Design Tools or Devices.

  8. Click Next.
  9. Select the installation directory.
    The installation directory path must not contain any spaces.
  10. (Optional) Select shortcut and file association options.
  11. Click Next.

    An Installation Summary window is displayed, describing the following information:

    • Devices
    • Design tools
    • Installation options
    • Installation locations
    • Download locations
    • Disk space requirements
  12. After reviewing the installation summary, click Install.

Install With the Single File Download

If you downloaded the full product installation, decompress the file, and then run xsetup (for Linux) or xsetup.exe (for Windows) to launch the installation.

Note: On Windows, you can use 7-zip or WinZip (v.15.0 or newer) to decompress the downloaded tar.gz file.

Configuring Batch Mode Installation Flow

The installer can run in an unattended batch process. To run the installer unattended, you must do one of the following.

  • Specify a standard edition and installation location
  • Include a configuration file that provides the installer with the install location and the tools, devices, and options you want to install
Note: 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.

For Windows, open the command window with administrator privileges, and run xsetup.bat, found in the \bin directory, and not xsetup.exe with the options below.

Generate a Configuration File

  1. Run xsetup -b ConfigGen.

    This will put you in an interactive mode where you will see the following menu:

    1. SDx Development Environments
    Please choose: 

    Type 1, and then press Enter.

  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 configuration file:
    Edition=SDx Development Environments
    # Path where Xilinx software will be installed.
    # Choose the Products/Devices the you would like to install.
    Modules=Built-in Platforms and associated devices for SDSoC:1,Zynq UltraScale+ MPSoC:1,Virtex UltraScale+ HBM ES:0,Zynq-7000:1,Kintex UltraScale+ ES:0,Kintex UltraScale+:1,ARM Cortex-A53:1,Spartan-7:1,ARM Cortex-A9:1,ARM Cortex R5:1,Virtex UltraScale+ ES:0,System Generator for DSP:0,Artix-7:1,Built-in Platforms and associated devices for SDAccel:1,DocNav:1,Kintex-7:1,Virtex UltraScale+:1,Model Composer:0,Zynq UltraScale+ RFSoC ES:0,Kintex UltraScale:1,Engineering Sample Devices for Custom Platforms:0,Virtex UltraScale:1,Zynq UltraScale+ MPSoC ES:0,MicroBlaze:1,Virtex-7:1
    # Choose the post install scripts you'd like to run as part of the finalization step. Please note that some of these scripts may require user interaction during runtime.
    InstallOptions=Acquire or Manage a License Key:0,Enable WebTalk for SDK to send usage statistics to Xilinx:1,Enable WebTalk for Vivado to send usage statistics to Xilinx (Always enabled for WebPACK license):1
    ## Shortcuts and File associations ##
    # Choose whether Start menu/Application menu shortcuts will be created or not.
    # Choose the name of the Start menu/Application menu shortcut. This setting will be ignored if you choose NOT to create shortcuts.
    ProgramGroupFolder=Xilinx Design Tools
    # Choose whether shortcuts will be created for All users or just the Current user. Shortcuts can be created for all users only if you run the installer as administrator.
    # Choose whether shortcuts will be created on the desktop or not.
    # Choose whether file associations will be created or not.

    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.

    Note: In this configuration file, by default, there are no devices selected for installation (that is, all devices have a value of 0). To install a device, you must change the value to 1.

Running the Installer

After editing your configuration file to reflect your installation preferences, you can run the installer. During the command line installation, you must indicate your acceptance of the Xilinx End-User License Agreement and Third Party End-User License Agreement, and confirm you understand the WebTalk Terms and Conditions.

WebTalk Terms and Conditions

The WebTalk Terms and Conditions, which you must agree to when running the installer, is below:

By indicating I Agree, I also confirm that I have read Section 13 of the terms and conditions above concerning WebTalk and have been afforded the opportunity to read the WebTalk FAQ posted at I understand that I am able to disable WebTalk later if certain criteria described in Section 13(c) apply. If they don't apply, I can disable WebTalk by uninstalling the Software or using the Software on a machine not connected to the Internet. If I fail to satisfy the applicable criteria or if I fail to take the applicable steps to prevent such transmission of information, I agree to allow Xilinx to collect the information described in Section 13(a) for the purposes described in Section 13(b).

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.

Batch Mode Installation

This is an example of the command line for a typical new installation using a configuration file.
xsetup --agree XilinxEULA,3rdPartyEULA,WebTalkTerms 
--batch Install --config install_config.txt
If you want to use one of the Xilinx default edition configurations, you do not have to specify the --config option, but since the destination directory is included in the configuration file, you will be required to specify this on the command line.
xsetup --agree 3rdPartyEULA,WebTalkTerms,XilinxEULA 
--batch Install --edition "SDx Development Environments" --location "/home/Xilinx"

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.

Resolve Internet Connection Issues

The installer connects to the Internet through the system proxy settings in Windows. These settings can be found in Control Panel > Network and Internet > Internet Options. For Linux users, the installer uses Firefox browser proxy settings (when explicitly set) to determine connectivity.

Figure: Internet Connectivity Message Example

If there are connectivity issues, verify the following:

  1. If you are using alternate proxy settings to the ones referred to, select the Manual Proxy Configuration option to specify the settings.
  2. Check whether your company firewall requires a proxy authentication with a user name and password. If so, select the Manual Proxy Configuration option in the dialog box above.
  3. For Linux users, if either the Use System settings or the Auto detect settings option is selected in the Firefox browser, then you must manually set the proxy in the installer.

Setting Up the Environment to Run SDSoC

To set up the environment to run the SDx tools, source the file below so that the elements of the SDSoC development environment are in the path, and other variables that are required for the development environment are also set up.


C Shell:

source <SDX_INSTALL_DIR>/SDx/2019.1/settings64.csh


source <SDX_INSTALL_DIR>/SDx/2019.1/


C:> <SDX_INSTALL_DIR>\SDx\2019.1\settings64.bat