Difference between revisions of "Xilinx ISE WebPACK"

From ArchWiki
Jump to: navigation, search
(More detailed installation guide, post-installation tweaks and fixes, cleanup of old (broken) links)
(Digilent USB-JTAG Drivers: Update dead external links to digilent downloads)
 
(41 intermediate revisions by 21 users not shown)
Line 1: Line 1:
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Mathematics and science]]
 
[[Category:Mathematics and science]]
 +
[[ja:Xilinx ISE WebPACK]]
 +
{{Style|See in particular [[Help:Style#Command line text]].}}
 +
 
The Xilinx ISE WebPACK is a complete FPGA/CPLD programmable logic design suite providing:
 
The Xilinx ISE WebPACK is a complete FPGA/CPLD programmable logic design suite providing:
 
* Specification of programmable logic via schematic capture or Verilog/VHDL
 
* Specification of programmable logic via schematic capture or Verilog/VHDL
Line 12: Line 15:
  
 
=== Dependencies ===
 
=== Dependencies ===
If you plan to develop software for an embedded ARM core (e.g. for Xilinx Zynq SoC devices), you will want to install the GCC cross-compiler bundled included with the Xilinx Embedded Development Kit (EDK). This compiler requires two packages from the [[multilib]] repository: {{Pkg|lib32-glibc}} and {{Pkg|lib32-ncurses}}.
+
If you plan to develop software for an embedded ARM core (e.g. for Xilinx Zynq SoC devices), you will want to install the GCC cross-compiler bundled included with the Xilinx Embedded Development Kit (EDK). This compiler requires the {{Pkg|glibc}} and {{Pkg|ncurses}} packages. For i686 installations, these will most likely be already present.
  
If you are running the 32-bit version of Arch Linux, these dependencies will already be present in your system.
+
If you are on a 64-bit Arch installation, you need to install {{Pkg|lib32-glibc}} from the [[multilib]] repository. Since the {{Pkg|lib32-ncurses}} is now version 6, the [https://gist.githubusercontent.com/strayArch/cbfbb87a4d0f41f8c5ba/raw/fa063cee8c28e4174e81c670204b18b110337505/ncurses5-PKGBUILD ncurses pkgbuild] must be installed manually --- {{ic|makepkg -s}} and {{ic|pacman -U *xz}}. {{Note| the required gpg can be fetched via {{ic|gpg --keyserver http://pgp.mit.edu/ --search 0x702353e0f7e48edb}}}}
  
 
=== Default Shell ===
 
=== Default Shell ===
During the installation, the Mentor CodeSourcery toolchains for embedded processors will be installed along the Xilinx tools. This installation silently fails when the default shell is set to "dash". Make sure {{ic|/bin/sh}} points to {{ic|/usr/bin/bash}}.
+
During the installation, the Mentor CodeSourcery toolchains for embedded processors can be installed along with the Xilinx tools. This installation silently fails when the default shell is set to "dash". Make sure {{ic|/usr/bin/sh}} points to {{ic|/usr/bin/bash}}.
  
 
This can be checked by running this command:
 
This can be checked by running this command:
  $ ls -l /bin/sh
+
  $ ls -l /usr/bin/sh
  
 
If the output looks like this:
 
If the output looks like this:
  {{ic|lrwxrwxrwx 1 root root 15 13 Mar 06:47 /bin/sh -> ../usr/bin/bash}}
+
  {{ic|lrwxrwxrwx 1 root root 15 13 Mar 06:47 /usr/bin/sh -> bash}}
then {{ic|/bin/sh}} already points to {{ic|/usr/bin/bash}} (the default in Arch Linux).
+
then {{ic|/usr/bin/sh}} already points to {{ic|/usr/bin/bash}} (the default in Arch Linux).
  
 
If not, run the following commands as root:
 
If not, run the following commands as root:
  $ rm /bin/sh
+
  $ rm /usr/bin/sh
  $ ln -s /usr/bin/bash /bin/sh
+
  $ ln -s bash /usr/bin/sh
  
 
== Installation ==
 
== Installation ==
{{Note|The installation is last known to work with Linux kernel 3.8.4 and Xilinx ISE 14.4, requiring the dynamic library fix described below.}}
+
{{Note|The installation is last known to work with Xilinx ISE 14.7, requiring the dynamic library fix described below.}}
  
The ISE WebPACK Linux version can be downloaded from [http://www.xilinx.com/support/download/index.htm the official download page]. It requires registration and licensing agreement, but there is no charge, i.e. it's free as in "free beer", but not free as in "free speech".
+
The ISE Design Tools can be downloaded from [http://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/design-tools.html the official download page]. It requires registration and licensing agreement, but there is no charge, i.e. it's free as in "free beer", but not free as in "free speech".
  
You will want to download both the "Vivado and ISE Design Suites - 2012.4" and the " Device Pack - 14.4 (2012.4) Product Update" tarballs.
+
Once the tarballs has been downloaded, unpack it:
 +
$ tar -xvf Xilinx_ISE_DS_Lin_14.7_1015_1.tar
  
Once the tarballs are downloaded, unpack them:
+
The ISE design tools installer is a Qt application. If you are running the KDE desktop environment, the installer may try to load the "Oxygen" widget theme, which will fail due to the older Qt framework bundled with the Xilinx ISE design tools. You need to remove the {{ic|QT_PLUGIN_PATH}} environment variable before executing the installer:
  $ tar -xvf Xilinx_ISE_DS_14.4_P.49d.3.0.tar
+
  $ unset QT_PLUGIN_PATH
$ tar -xvf Xilinx_2012.4.1_Device_Pack.tar
+
  
First, install the Vivado and ISE Design Suites.
+
Then, install the ISE Design Tools:
  $ cd Xilinx_ISE_DS_14.4_P.49d.3.0/
+
  $ cd Xilinx_ISE_DS_Lin_14.7_1015_1
 
  $ ./xsetup
 
  $ ./xsetup
  
Then, follow the instructions to install the ISE. By default, the whole application is installed to {{ic|/opt/Xilinx/}}, so make sure the user running the installer has permissions to write to this directory.
+
Follow the instructions to install the ISE. By default, the whole application is installed to {{ic|/opt/Xilinx/}}, so make sure the user running the installer has permissions to write to this directory.
  
 
During installation, uncheck the "Install Cable Drivers" option. Leaving it checked will cause errors during the installation.
 
During installation, uncheck the "Install Cable Drivers" option. Leaving it checked will cause errors during the installation.
  
Then, install the Device Pack on top:
+
=== Launching the ISE design tools ===
$ cd Xilinx_2012.4.1_Device_Pack
+
$ ./xsetup
+
 
+
 
The ISE design tools include a shell script that modifies the environment variables (mostly PATH and LD_LIBRARY_PATH). This script must be sourced before starting the ISE tools:
 
The ISE design tools include a shell script that modifies the environment variables (mostly PATH and LD_LIBRARY_PATH). This script must be sourced before starting the ISE tools:
  $ source /opt/Xilinx/14.4/ISE_DS/settings64.sh
+
  $ source /opt/Xilinx/14.7/ISE_DS/settings64.sh
 
or, for a 32-bit installation:
 
or, for a 32-bit installation:
  $ source /opt/Xilinx/14.4/ISE_DS/settings32.sh
+
  $ source /opt/Xilinx/14.7/ISE_DS/settings32.sh
  
 
Then, the ISE design tools will be found in your PATH and can be started by typing their name in the terminal (e.g. {{ic|ise}}, {{ic|planAhead}}, {{ic|xsdk}}, ...)
 
Then, the ISE design tools will be found in your PATH and can be started by typing their name in the terminal (e.g. {{ic|ise}}, {{ic|planAhead}}, {{ic|xsdk}}, ...)
 +
 +
==== Launching via desktop icons ====
 +
You can also create files at /usr/share/applications/
 +
 +
ise.desktop:
 +
#!/usr/bin/env xdg-open
 +
[Desktop Entry]
 +
Version=1.0
 +
Type=Application
 +
Name=Xilinx ISE
 +
Exec=sh -c "unset LANG && unset QT_PLUGIN_PATH && source /opt/Xilinx/14.7/ISE_DS/settings64.sh && ise"
 +
Icon=/opt/Xilinx/14.7/ISE_DS/ISE/data/images/pn-ise.png
 +
Categories=Development;
 +
Comment=Xilinx ISE
 +
StartupWMClass=_pn
 +
 +
After that you can copy this files to Desktop folder on your home and launch ISE tools from desktop
  
 
=== License Installation ===
 
=== License Installation ===
 
After requesting a WebPACK license from Xilinx using their [http://www.xilinx.com/getlicense/ Licensing Site], you will be e-mailed a license file. This file can be imported with the Xilinx License Manager (run {{ic|xlcm -manage}} from the terminal).
 
After requesting a WebPACK license from Xilinx using their [http://www.xilinx.com/getlicense/ Licensing Site], you will be e-mailed a license file. This file can be imported with the Xilinx License Manager (run {{ic|xlcm -manage}} from the terminal).
  
Another way to import the license is to simply copy it to the {{ic|~/.Xilinx}} directory.
+
Another way to import the license is to simply copy it to the {{ic|~/.Xilinx}} or {{ic|/opt/Xilinx/14.7/ISE_DS/ISE/coregen/core_licenses}} directory.
  
 
=== Node-Locked Licenses ===
 
=== Node-Locked Licenses ===
Arch Linux by default uses systemd's [[Network_Configuration#Device_names|Predictable Network Interface Names]]. This means that your system will most likely not have its network interfaces named "eth0", "eth1" and so forth.
+
Arch Linux by default uses systemd's [[Network configuration#Device_names|Predictable Network Interface Names]]. This means that your system will most likely not have its network interfaces named "eth0", "eth1" and so forth.
 +
 
 +
However, the Xilinx License Manager looks for these names to find out the system's MAC addresses, which are used for node-locked licenses. If you require node-locked licenses, unfortunately you have to disable this feature to re-gain the kernel naming scheme for network interfaces and fix the name of NIC that you obtained your license.
 +
The code below will be your help:
  
However, the Xilinx License Manager looks for these names to find out the system's MAC addresses, which are used for node-locked licenses. If you require node-locked licenses, you might have to disable this feature to re-gain the kernel naming scheme for network interfaces. The [http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames systemd wiki] describes how to do this.
+
# echo 'SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="xx:xx:xx:xx:xx:xx", NAME="eth1"' > /etc/udev/rules.d/10-net-naming.rules
 +
 
 +
For more specific, refer to the page [http://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames systemd wiki] describes how to work and what you have other(formal) ways.
  
 
== Post-Installation Fixes and Tweaks ==
 
== Post-Installation Fixes and Tweaks ==
After installation, a few manual fixes are required to work around problems caused by running the Xilinx tools on a Linux distribution that is not officially supported by Xilinx. Most of these fixes are taken from [http://zedboard.org/content/ise-142-bug-reports this forum post.]
+
After installation, a few manual fixes are required to work around problems caused by running the Xilinx tools on a Linux distribution that is not officially supported by Xilinx. Some of these fixes are taken from [http://zedboard.org/content/ise-142-bug-reports this forum post.]
  
 
=== Dynamic Library Fix (libstdc++.so) ===
 
=== Dynamic Library Fix (libstdc++.so) ===
The ISim simulator will not work out of the box because the proprietary libraries included with ISE are too old for Arch's constantly up-to-date software. To fix this issue, replace them with symlinks to the native system versions:
+
The ISE tools supply an outdated version of the libstdc++.so library, which may cause segfaults when using the Xilinx Microprocessor Debugger and prevents the usage of the oxygen-gtk theme. This outdated version is located in two directories within the installation tree: {{ic|/opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/}} and {{ic|/opt/Xilinx/14.7/ISE_DS/common/lib/lin64}}. To use Arch's newer version of libstdc++, rename or delete the original files and replace them with symlinks:
  # cd /opt/Xilinx/14.4/ISE_DS/ISE/lib/lin64/
+
  cd /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/
  # mv libstdc++.so libstdc++.so-orig
+
  mv libstdc++.so libstdc++.so-orig
  # mv libstdc++.so.6 libstdc++.so.6-orig
+
  mv libstdc++.so.6 libstdc++.so.6-orig
  # mv libstdc++.so.6.0.8 libstdc++.so.6.0.8-orig
+
  mv libstdc++.so.6.0.8 libstdc++.so.6.0.8-orig
  # ln -s /usr/lib/libstdc++.so
+
  ln -s /usr/lib/libstdc++.so
  # ln -s libstdc++.so libstdc++.so.6
+
  ln -s libstdc++.so libstdc++.so.6
  # ln -s libstdc++.so libstdc++.so.6.0.8
+
  ln -s libstdc++.so libstdc++.so.6.0.8
  
=== Digilent USB-JTAG Drivers ===
+
Then, repeat this process in the {{ic|/opt/Xilinx/14.7/ISE_DS/common/lib/lin64}} directory.
To use Digilent Adept USB-JTAG adapters (e.g. the onboard JTAG adapter on the [http://www.zedboard.org ZedBoard]) from within the Xilinx design tools, you need to install the Digilent [http://www.digilentinc.com/Products/Detail.cfm?Prod=ADEPT2 Adept Runtime] and [http://www.digilentinc.com/Products/Detail.cfm?Prod=DIGILENT-PLUGIN Plugin].
+
  
To install the Digilent Adept Runtime, it is recommended to build and install {{AUR|adept-runtime-xilinx}} and its dependencies {{AUR|libftd2xx-digilent}} and {{AUR|usbdrv}} from the [[Arch User Repository]].
+
=== Digilent USB-JTAG Drivers ===
 +
To use Digilent Adept USB-JTAG adapters (e.g. the onboard JTAG adapter on the [http://www.zedboard.org ZedBoard]) from within the Xilinx design tools, you need to install the Digilent [http://store.digilentinc.com/digilent-adept-2-download-only/ Adept Runtime] and [http://store.digilentinc.com/digilent-plugin-for-xilinx-tools-download-only/ Plugin].  
  
'''WARNING''': At the time of writing, the Xilinx installation contains a newer (pre-release?) version of the Digilent Adept Runtime and Plugin than the Digilent website (above links). Because of this, the packaging tools will not be able to automatically download the sources. Instead, you will have to create the tarball yourself from within the Xilinx installation directory:
+
Make sure you have installed {{AUR|fxload}}  from the [[Arch User Repository]] .
  
$ cd </path/to/PKGBUILD>
+
To install the Digilent Adept Runtime, it is recommended to install {{AUR|digilent.adept.runtime}} from the [[Arch User Repository]].
$ tar -cvzf digilent.adept.runtime_2.10.4-x86_64.tar.gz \
+
      -C /opt/xilinx/14.4/ISE_DS/ISE/bin/lin64/digilent/ \
+
      digilent.adept.runtime_2.10.4-x86_64
+
  
Then, run {{ic|makepkg}} to build the package.
+
In addition, installing {{AUR|digilent.adept.utilities}} may do good to configuring your board.
  
 
To install the Digilent plugin, you have to copy two files to the ISE plugin directory. Run the following commands as root:
 
To install the Digilent plugin, you have to copy two files to the ISE plugin directory. Run the following commands as root:
  $ mkdir -p /opt/Xilinx/14.4/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
+
  $ mkdir -p /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
  $ cd /opt/Xilinx/14.4/ISE_DS/ISE/bin/lin64/digilent/libCseDigilent_2.4.4-x86_64/lin64/14.1/libCseDigilent
+
  $ cd /opt/Xilinx/14.7/ISE_DS/ISE/bin/lin64/digilent/libCseDigilent_2.4.4-x86_64/lin64/14.1/libCseDigilent
  $ cp libCseDigilent.{so,xml} /opt/Xilinx/14.4/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
+
  $ cp libCseDigilent.{so,xml} /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
  $ chmod -x /opt/Xilinx/14.4/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent/libCseDigilent.xml
+
  $ chmod -x /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent/libCseDigilent.xml
 +
 
 +
 
  
 
Finally, add every user that should have access to the Digilent USB-JTAG adapter to the "uucp" group.
 
Finally, add every user that should have access to the Digilent USB-JTAG adapter to the "uucp" group.
  
You may have to add the USB Vendor/Product IDs of your JTAG adapter to the udev rules in {{ic|/etc/udev/rules.d/20-digilent.rules}}.
+
To grant access to the usb driver for normal users you may have to add the USB Vendor/Product IDs of your JTAG adapter which can be found with
 +
$ lsusb | grep Xilinx
 +
to the udev rules in {{ic|/etc/udev/rules.d/20-digilent.rules}}:
 +
SUBSYSTEM=="usb", ATTRS{idVendor}=="xxxx", ATTRS{idProduct}=="xxxx", GROUP="users", MODE="666"
  
=== Locale Issues ===
+
If it still doesn't work, you can make further reading in [http://www.george-smart.co.uk/wiki/Xilinx_JTAG_Linux Xilinx_JTAG_Linux]. The magic git repo there may be help.
PlanAhead doesn't like locales using other literals than '.' as the decimal point (e.g. German, which uses ','). Run the following command before launching PlanAhead:
+
$ unset LANG
+
  
=== Web Browser doesn't launch from within XSDK ===
+
=== Xilinx Platform Cable USB-JTAG Drivers ===
XSDK tries to launch the browser from within the environment modified by the Xilinx settings script (e.g. {{ic|/opt/Xilinx/14.4/ISE_DS/settings64.sh}}), which modifies the library search path (by exporting the LD_LIBRARY_PATH variable).
+
  
This causes the dynamic linker trying to link the browser against the libraries shipped with the Xilinx design tools, which are too old for Arch's constant up-to-date system.
+
{{Accuracy|Building as root is dangerous!}}
  
To solve this issue, we need to execute the browser without this environment variable set. Create a script in {{ic|/opt/Xilinx/14.4/ISE_DS/ISE/bin/lin64/<name of your preferred browser>}} with the following contents:
+
Make sure you have installed {{AUR|fxload}} from the [[Arch User Repository]] .
 +
We need to build driver from source (git and some make stuff need to be installed, make will say what programs or libraries are missed):
  
{{bc|<nowiki>
+
$ cd /opt/Xilinx
#!/bin/bash
+
$ sudo git clone git://git.zerfleddert.de/usb-driver
unset LD_LIBRARY_PATH
+
$ cd usb-driver/
exec /usr/bin/<your preferred browser> "$@"
+
$ sudo make
</nowiki>}}
+
  
Then, make the script executable:
+
If you using 32-bit version of ISE on 64-bit system, pass "lib32" to make:
$ chmod +x /opt/Xilinx/14.4/ISE_DS/ISE/bin/lin64/<name of your preferred browser>
+
  
=== GNU make ===
+
  $ sudo make lib32
XSDK looks for the {{ic|gmake}} executable, which is not present in Arch Linux by default. Create a symlink somewhere in your path, e.g.
+
  $ ln -s /usr/bin/make /home/<user>/bin/gmake
+
  
Make sure this directory is in your PATH variable.
+
And install driver (replace 14.7 to your version):
  
=== Segmentation faults in XMD ===
+
$ ./setup_pcusb /opt/Xilinx/14.7/ISE_DS/ISE/
When used with Digilent USB-JTAG adapters, XMD (the Xilinx Microprocessor Debugger) might cause segmentation faults. These happen in libdpcomm.so.2, which is the Digilent Adept driver. A possible solution is described [http://forums.xilinx.com/t5/Installation-and-Licensing/Ubuntu-11-10-and-impact-chipscope-etc/td-p/188486/page/2 here].
+
  
To permanently solve this issue, rename the xmd binary (as root):
+
When performing this command, the udev rules file will be created. You can reload udev rules to apply changes immidiately:
$ cd /opt/Xilinx/14.4/ISE_DS/EDK/bin/lin64
+
$ mv xmd xmd-xilinx
+
$ mv unwrapped/xmd unwrapped/xmd-xilinx
+
  
Then, create a script in its place with the following contents:
+
$ sudo udevadm control --reload-rules
{{bc|<nowiki>
+
#!/bin/bash
+
LD_PRELOAD=libdpcomm.so.2 /opt/Xilinx/14.4/ISE_DS/EDK/bin/lin64/xmd-xilinx "$@"
+
</nowiki>}}
+
  
Finally, make the script executable:
+
If driver installed correctly and udev rule works, STATUS led should turn on (green or red depending on voltage presence on VREF PIN)
$ chmod +x /opt/Xilinx/14.4/ISE_DS/EDK/bin/lin64/xmd
+
  
=== Hardcoded "touch" symlink in PlanAhead ===
+
=== Locale Issues ===
PlanAhead apparently looks for the "touch" executable only in "/bin/touch", which causes the synthesis to never finish. Create the symlink by running the following command as root:
+
PlanAhead doesn't like locales using other literals than '.' as the decimal point (e.g. German, which uses ','). Run the following command before launching PlanAhead:
 +
$ unset LANG
  
  $ ln -s /usr/bin/touch /bin/touch
+
=== Segmentation Fault on PlanAhead ===
 +
When launching PlanAhead to generate a .ucf file, a segmentation fault may occur. The issue seems unrelated to the previous topic. The ISE console will show
 +
"/opt/Xilinx/14.7/ISE_DS/PlanAhead/bin/rdiArgs.sh: line 64: 14275 Segmentation fault      $RDI_PROG $*"
 +
The problem seems to come from the bundled JRE as described [http://forums.xilinx.com/t5/Installation-and-Licensing/RHEL5-64-bit-ISE-13-1-PlanAhead-launch-from-w-in-ISE-fails/td-p/148624/page/2 here]. To fix the issue, symlink the OpenJDK libjvm.so into the Xilinx's installation directory.
 +
# cd /opt/Xilinx/14.7/ISE_DS/PlanAhead/tps/lnx64/jre/lib/amd64/server
 +
# mv libjvm.so{,-orig}
 +
# ln -s /usr/lib/jvm/java-7-openjdk/jre/lib/amd64/server/libjvm.so
 +
 
 +
=== GNU make ===
 +
XSDK looks for the {{ic|gmake}} executable, which is not present in Arch Linux by default. Create a symlink somewhere in your path, e.g.
 +
  $ ln -s /usr/bin/make /home/<user>/bin/gmake
 +
 
 +
Make sure this directory is in your PATH variable.
  
 
=== Running Xilinx tools from within KDE ===
 
=== Running Xilinx tools from within KDE ===
KDE by default defines the QT_PLUGIN_PATH shell variable. Some of the Xilinx software (ISE, Impact, XPS) are Qt applications, which means that they will search for Qt plugins in the locations defined by this shell variable.
+
KDE by default defines the QT_PLUGIN_PATH shell variable. Some of the Xilinx ISE tools (ISE, Impact, XPS) are Qt applications, which means that they will search for Qt plugins in the locations defined by this shell variable.
  
 
Because the Xilinx tools are compiled against and ship with an older version of the Qt framework which cannot use these plugins, they will crash when launched with this environment variable present.
 
Because the Xilinx tools are compiled against and ship with an older version of the Qt framework which cannot use these plugins, they will crash when launched with this environment variable present.
Line 164: Line 186:
 
  $ unset QT_PLUGIN_PATH
 
  $ unset QT_PLUGIN_PATH
  
== Xilinx Cable Drivers ==
+
=== CORE Generator fails to generate core ===
 
+
In some cases, the CORE Generator will fails to generate a core and output something like this to its console:
{{Box|Warning:|The information in this section might be outdated.|#DF0000|#FFDFDF}}
+
 
+
However once I reached the point of trying to download a design to a target device I ran into some trouble. Installing the cable drivers for talking to the target interface cable yielded errors.
+
 
+
I downloaded the standalone driver installation utility from: ftp://ftp.xilinx.com/pub/utilities/fpga/install_drivers.tar.gz
+
 
+
This download yields a file named install_drivers.tar.gz
+
 
+
$ tar xzf install_drivers.tar.gz
+
yields a directory named install_drivers/. When I attempted to build the drivers from this file I encountered the following errors:
+
'''linux_wrappers.c:48:31: error: linux/ioctl32.h: No such file or directory'''
+
and
+
'''linux_wrappers.c:1398: error: ‘struct scatterlist’ has no member named ‘page’'''
+
 
+
Reading in the Gentoo HOWTO's listed above led me to download the latest Jungo source code, which is the core of the Xilinx linux USB support. I modified the link after reading that the latest Jungo driver was 9.20. I got WinDriver 9.20 from: http://www.jungo.com/st/download/WD920LN.tgz
+
 
+
$ tar xzf WD920LN.tgz
+
yields a directory named WinDriver/ Within this directory you'll find:
+
$ ls WinDriver/redist/
+
configure*      linux_wrappers.c  makefile.in      wdreg*            wdusb_linux.c    windrvr_gcc_v3.a
+
linux_common.h  linux_wrappers.h  setup_inst_dir*  wdusb_interface.h  windrvr_gcc_v2.a  windrvr_gcc_v3_regparm.a
+
 
+
These are the same core files also found in:
+
$ ls install_drivers/linux_drivers/windriver32/windrvr/
+
config.cache    LINUX.2.6.24-ARCH.i386/  makefile        wdusb_interface.h  windrvr_gcc_v3_regparm.a
+
config.log      linux_common.h          makefile.in      wdusb_linux.c
+
config.status*  linux_wrappers.c        setup_inst_dir*  windrvr_gcc_v2.a
+
configure*      linux_wrappers.h        wdreg*          windrvr_gcc_v3.a
+
 
+
So I copied the 9.20 WinDriver files over those found in the install_drivers/ subdirectory:
+
$ cp -p WinDriver/redist/* install_drivers/linux_drivers/windriver32/windrvr/
+
 
+
This update to the Jungo driver eliminated the error: linux/ioctl32.h: No such file or directory, but the error: ‘struct scatterlist’ has no member named ‘page’ was still persisting.
+
 
+
After research regarding changes to scatterlist.h lead to these discussions: http://kerneltrap.org/Linux/SG_Chaining_Merged
+
 
+
Which describe changes in scatter/gather lists that were implemented in kernel 2.6.23 in Oct 2007.
+
 
+
I implemented the following:
+
$ cd install_drivers/linux_drivers/windriver32/windrvr/
+
 
+
and apply the patch indicated below to linux_wrappers.c:
+
 
+
124a125,127
+
> /* added to fix scatterlist without page compile bug -jea 2008-05-09 */
+
> // #include <linux/scatterlist.h>
+
>
+
1791c1794
+
<    sgl[0].page = pages[0];
+
---
+
>    sgl[0].page_link = (unsigned long)pages[0];
+
1798c1801
+
<            sgl[i].page = pages[i];
+
---
+
>            sgl[i].page_link = (unsigned long)pages[i];
+
1823c1826
+
<        void *va = page_address(sgl[i].page) + sgl[i].offset;
+
---
+
>        void *va = page_address((struct page *)sgl[i].page_link) + sgl[i].offset;
+
1954,1956c1957,1959
+
<        if (!PageReserved(sgl[i].page))
+
<            SetPageDirty(sgl[i].page);
+
<        page_cache_release(sgl[i].page);
+
---
+
>        if (!PageReserved((struct page *)sgl[i].page_link))
+
>            SetPageDirty((struct page *)sgl[i].page_link);
+
>        page_cache_release((struct page *)sgl[i].page_link);
+
 
+
or, viewed as a unified patch:
+
 
+
--- before/install_drivers/linux_drivers/windriver32/windrvr/linux_wrappers.c  2008-02-19 09:58:43.000000000  -0800
+
+++ after/install_drivers/linux_drivers/windriver32/windrvr/linux_wrappers.c    2008-05-15 20:02:23.000000000  -0700
+
@@ -122,6 +122,9 @@
+
      static struct pci_dev *pci_root_dev;
+
  #endif
+
 
+
+/* added to fix scatterlist without page compile bug -jea 2008-05-09 */
+
+// #include <linux/scatterlist.h>
+
+
+
  typedef struct
+
  {
+
      struct page **pages;
+
@@ -1788,14 +1791,14 @@
+
 
+
      memset (sgl, 0, sizeof(struct scatterlist) * page_count);
+
      sgl[0].offset = ((unsigned long)buf) & (~PAGE_MASK);
+
-    sgl[0].page = pages[0];
+
+    sgl[0].page_link = (unsigned long)pages[0];
+
      if (page_count > 1)
+
      {
+
          sgl[0].length = PAGE_SIZE - sgl[0].offset;
+
          size -= sgl[0].length;
+
          for (i=1; i < page_count ; i++, size -= PAGE_SIZE)
+
          {
+
-            sgl[i].page = pages[i];
+
+            sgl[i].page_link = (unsigned long)pages[i];
+
              sgl[i].length = size < PAGE_SIZE ? size : PAGE_SIZE;
+
          }
+
      }
+
@@ -1820,7 +1823,7 @@
+
      for (i=0; i<*dma_sglen; i++)
+
      {
+
  #if defined(_CONFIG_SWIOTLB)
+
-        void *va = page_address(sgl[i].page) + sgl[i].offset;
+
+        void *va = page_address((struct page *)sgl[i].page_link) + sgl[i].offset;
+
          dma_addr_t dma_addr = virt_to_phys(va);
+
 
+
          if (dma_addr & ~mask)
+
@@ -1951,9 +1954,9 @@
+
  #if defined(_CONFIG_SWIOTLB)
+
          pci_unmap_single(dev_handle, sg_dma_address(&sgl[i]), sg_dma_len(&sgl[i]), (int)dma_direction);
+
  #endif
+
-        if (!PageReserved(sgl[i].page))
+
-            SetPageDirty(sgl[i].page);
+
-        page_cache_release(sgl[i].page);
+
+        if (!PageReserved((struct page *)sgl[i].page_link))
+
+            SetPageDirty((struct page *)sgl[i].page_link);
+
+        page_cache_release((struct page *)sgl[i].page_link);
+
      }
+
      vfree(sgl);
+
  #elif defined(LINUX_24)
+
 
+
This corrected the compile errors in the Jungo USB driver and produced the windrvr6.ko kernel module. However there was still a nagging error in the compilation of install_drivers/linux_drivers/xpc4drvr2_6/xpc4drvr/
+
 
+
scripts/Makefile.build:46: *** CFLAGS was changed in "/home/johnea/src/before/install_drivers/linux_drivers/xpc4drvr2_6/xpc4drvr/Makefile". Fix it to use EXTRA_CFLAGS.  Stop.
+
make[1]: *** [_module_/home/johnea/src/before/install_drivers/linux_drivers/xpc4drvr2_6/xpc4drvr] Error 2
+
make[1]: Leaving directory `/usr/src/linux-2.6.24-ARCH'
+
make: *** [default] Error 2
+
 
+
which was corrected by the following brutal hack to the Makefile:
+
 
+
diff before/install_drivers/linux_drivers/xpc4drvr2_6/xpc4drvr/Makefile  \
+
      after/install_drivers/linux_drivers/xpc4drvr2_6/xpc4drvr/Makefile
+
 
+
25c25
+
< ifeq ($(GET_USER_SIZE_SYM),0)
+
---
+
> #ifeq ($(GET_USER_SIZE_SYM),)
+
27c27
+
< endif
+
---
+
> #endif
+
 
+
This corrected all compilation errors, but the xpc4drvr.ko still yielded the following error in /var/log/everything.log whenever it was attempted to be loaded:
+
xpc4drvr: Unknown symbol get_user_size
+
 
+
However this did allow compilation of the entire driver tree and the install script was able to successfully install the drivers via:
+
cd install_drivers/
+
./install_drivers
+
 
+
There is also a udev rule entry that will make the driver accessible to all users after each reboot. (Which I haven't yet applied)
+
 
+
So after this brief modification, I am able to successfully run ISE on Arch Linux (kernel26 2.6.24) with full USB cable support.
+
 
+
There is a GPL'd libusb based driver mentioned in the Gentoo HOWTO: http://www.rmdir.de/~michael/xilinx/ that I was particularly interested in using. However while the source built without error, I continued to receive runtime errors when attempting to run it in ISE.
+
 
+
I never attempted to use the Xup driver.
+
 
+
There were quite a few pertinent facts along the way that I'm failing to capture here. Such as the fact that I discovered the same directory:
+
install_drivers/
+
 
+
in the base install of the entire ISE package under:
+
/opt/Xilinx/10.1/common/bin/lin/install_script/install_drivers/
+
 
+
I would expect that this procedure could be applied directly to that without the additional step of downloading the install_drivers.tar.gz but I haven't tried this.
+
 
+
Additionally, as a housekeeping note, the commands above expect all files to be downloaded and untared in the same working directory.
+
 
+
All in all this is the crux of what was necessary for me to get the USB support running on Arch.
+
 
+
Sorry for the somewhat fragmented description, but hopefully this allows others to get this great tool for linux users running on the post 2.6.23 kernels.
+
 
+
Happy Hardware Hacking!!!
+
 
+
=== Update 2010-08-02 ===
+
 
+
Comments in the forum thread announcing this wiki entry make reference to the page:
+
 
+
http://rmdir.de/~michael/xilinx/
+
 
+
This is the upstream source for non-proprietary Xilinx USB drivers using libusb. This is now the Xilinx recommended linux usb interface and is shipped with new versions of Xilinx ISE WebPack.
+
  
Per a note on the rmdir.de website, newer versions of udev no longer support the older syntax of the /etc/udev/rules.d/xusbdfwu.rules file:
+
ERROR:sim - Unable to evaluate Tcl file:
<pre>
+
    /opt/Xilinx/14.7/ISE_DS/ISE/coregen/ip/xilinx/primary/com/xilinx/ip/clk_wiz_v3_6/generate/run_legacy_tcl_flow.tcl
* 2010-03-15: If you are using newer udev-versions (like the version included in Debian Squeeze and Ubuntu 9.10), then the file /etc/udev/rules.d/xusbdfwu.rules is incompatible with this udev version. The effect of this is that the cable-firmware gets never loaded and the cable led never lights up.
+
ERROR:sim - Failed executing Tcl generator.
  
To fix this, run the following command as root:
+
If that happens, make sure you don't have _JAVA_OPTIONS set in your environment. If you normally run coregen with
sed -i -e 's/TEMPNODE/tempnode/' -e 's/SYSFS/ATTRS/g' -e 's/BUS/SUBSYSTEMS/' /etc/udev/rules.d/xusbdfwu.rules
+
You may have to reboot for this change to take effect.
+
</pre>
+
  
I didn't require a reboot for this patch to take affect while running:
+
$ source /opt/Xilinx/14.7/ISE_DS/settings64.sh && coregen
<pre>
+
[root@vhost pcusb]# pacman -Q udev
+
udev 151-3
+
[root@vhost pcusb]# pacman -Q kernel26
+
kernel26 2.6.33.4-1
+
</pre>
+
In both the x86_64 host and the i686 chroot.
+
  
android
+
you need to prepend that with an "unset _JAVA_OPTIONS":
  
== Links ==
+
$ unset _JAVA_OPTIONS && source /opt/Xilinx/14.7/ISE_DS/settings64.sh && coregen
* http://www.itee.uq.edu.au/~listarch/microblaze-uclinux/archive/2007/03/msg00101.html
+
* http://groups.google.com/group/comp.arch.fpga/msg/2dfa36541174a4f2
+
* http://groups.google.com/group/comp.arch.fpga/browse_thread/thread/24884c2d0e90b97f
+
* http://groups.google.com/group/comp.arch.fpga/browse_thread/thread/f149e5b6028e2c70/066766d9510e407a#066766d9510e407a
+

Latest revision as of 07:27, 25 March 2016

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: See in particular Help:Style#Command line text. (Discuss in Talk:Xilinx ISE WebPACK#)

The Xilinx ISE WebPACK is a complete FPGA/CPLD programmable logic design suite providing:

  • Specification of programmable logic via schematic capture or Verilog/VHDL
  • Synthesis and Place & Route of specified logic for various Xilinx FPGAs and CPLDs
  • Functional (Behavioral) and Timing (post-Place & Route) simulation
  • Download of configuration data into target device via communications cable

While Arch Linux is not one of the officially supported distributions, many features are known to work on Arch Linux.

Prerequisites

Dependencies

If you plan to develop software for an embedded ARM core (e.g. for Xilinx Zynq SoC devices), you will want to install the GCC cross-compiler bundled included with the Xilinx Embedded Development Kit (EDK). This compiler requires the glibc and ncurses packages. For i686 installations, these will most likely be already present.

If you are on a 64-bit Arch installation, you need to install lib32-glibc from the multilib repository. Since the lib32-ncurses is now version 6, the ncurses pkgbuild must be installed manually --- makepkg -s and pacman -U *xz.
Note: the required gpg can be fetched via gpg --keyserver http://pgp.mit.edu/ --search 0x702353e0f7e48edb

Default Shell

During the installation, the Mentor CodeSourcery toolchains for embedded processors can be installed along with the Xilinx tools. This installation silently fails when the default shell is set to "dash". Make sure /usr/bin/sh points to /usr/bin/bash.

This can be checked by running this command:

$ ls -l /usr/bin/sh

If the output looks like this:

lrwxrwxrwx 1 root root 15 13 Mar 06:47 /usr/bin/sh -> bash

then /usr/bin/sh already points to /usr/bin/bash (the default in Arch Linux).

If not, run the following commands as root:

$ rm /usr/bin/sh
$ ln -s bash /usr/bin/sh

Installation

Note: The installation is last known to work with Xilinx ISE 14.7, requiring the dynamic library fix described below.

The ISE Design Tools can be downloaded from the official download page. It requires registration and licensing agreement, but there is no charge, i.e. it's free as in "free beer", but not free as in "free speech".

Once the tarballs has been downloaded, unpack it:

$ tar -xvf Xilinx_ISE_DS_Lin_14.7_1015_1.tar

The ISE design tools installer is a Qt application. If you are running the KDE desktop environment, the installer may try to load the "Oxygen" widget theme, which will fail due to the older Qt framework bundled with the Xilinx ISE design tools. You need to remove the QT_PLUGIN_PATH environment variable before executing the installer:

$ unset QT_PLUGIN_PATH

Then, install the ISE Design Tools:

$ cd Xilinx_ISE_DS_Lin_14.7_1015_1
$ ./xsetup

Follow the instructions to install the ISE. By default, the whole application is installed to /opt/Xilinx/, so make sure the user running the installer has permissions to write to this directory.

During installation, uncheck the "Install Cable Drivers" option. Leaving it checked will cause errors during the installation.

Launching the ISE design tools

The ISE design tools include a shell script that modifies the environment variables (mostly PATH and LD_LIBRARY_PATH). This script must be sourced before starting the ISE tools:

$ source /opt/Xilinx/14.7/ISE_DS/settings64.sh

or, for a 32-bit installation:

$ source /opt/Xilinx/14.7/ISE_DS/settings32.sh

Then, the ISE design tools will be found in your PATH and can be started by typing their name in the terminal (e.g. ise, planAhead, xsdk, ...)

Launching via desktop icons

You can also create files at /usr/share/applications/

ise.desktop:

#!/usr/bin/env xdg-open
[Desktop Entry]
Version=1.0
Type=Application
Name=Xilinx ISE
Exec=sh -c "unset LANG && unset QT_PLUGIN_PATH && source /opt/Xilinx/14.7/ISE_DS/settings64.sh && ise"
Icon=/opt/Xilinx/14.7/ISE_DS/ISE/data/images/pn-ise.png
Categories=Development;
Comment=Xilinx ISE
StartupWMClass=_pn

After that you can copy this files to Desktop folder on your home and launch ISE tools from desktop

License Installation

After requesting a WebPACK license from Xilinx using their Licensing Site, you will be e-mailed a license file. This file can be imported with the Xilinx License Manager (run xlcm -manage from the terminal).

Another way to import the license is to simply copy it to the ~/.Xilinx or /opt/Xilinx/14.7/ISE_DS/ISE/coregen/core_licenses directory.

Node-Locked Licenses

Arch Linux by default uses systemd's Predictable Network Interface Names. This means that your system will most likely not have its network interfaces named "eth0", "eth1" and so forth.

However, the Xilinx License Manager looks for these names to find out the system's MAC addresses, which are used for node-locked licenses. If you require node-locked licenses, unfortunately you have to disable this feature to re-gain the kernel naming scheme for network interfaces and fix the name of NIC that you obtained your license. The code below will be your help:

# echo 'SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="xx:xx:xx:xx:xx:xx", NAME="eth1"' > /etc/udev/rules.d/10-net-naming.rules

For more specific, refer to the page systemd wiki describes how to work and what you have other(formal) ways.

Post-Installation Fixes and Tweaks

After installation, a few manual fixes are required to work around problems caused by running the Xilinx tools on a Linux distribution that is not officially supported by Xilinx. Some of these fixes are taken from this forum post.

Dynamic Library Fix (libstdc++.so)

The ISE tools supply an outdated version of the libstdc++.so library, which may cause segfaults when using the Xilinx Microprocessor Debugger and prevents the usage of the oxygen-gtk theme. This outdated version is located in two directories within the installation tree: /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/ and /opt/Xilinx/14.7/ISE_DS/common/lib/lin64. To use Arch's newer version of libstdc++, rename or delete the original files and replace them with symlinks:

cd /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/
mv libstdc++.so libstdc++.so-orig
mv libstdc++.so.6 libstdc++.so.6-orig
mv libstdc++.so.6.0.8 libstdc++.so.6.0.8-orig
ln -s /usr/lib/libstdc++.so
ln -s libstdc++.so libstdc++.so.6
ln -s libstdc++.so libstdc++.so.6.0.8

Then, repeat this process in the /opt/Xilinx/14.7/ISE_DS/common/lib/lin64 directory.

Digilent USB-JTAG Drivers

To use Digilent Adept USB-JTAG adapters (e.g. the onboard JTAG adapter on the ZedBoard) from within the Xilinx design tools, you need to install the Digilent Adept Runtime and Plugin.

Make sure you have installed fxloadAUR from the Arch User Repository .

To install the Digilent Adept Runtime, it is recommended to install digilent.adept.runtimeAUR from the Arch User Repository.

In addition, installing digilent.adept.utilitiesAUR may do good to configuring your board.

To install the Digilent plugin, you have to copy two files to the ISE plugin directory. Run the following commands as root:

$ mkdir -p /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
$ cd /opt/Xilinx/14.7/ISE_DS/ISE/bin/lin64/digilent/libCseDigilent_2.4.4-x86_64/lin64/14.1/libCseDigilent
$ cp libCseDigilent.{so,xml} /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent
$ chmod -x /opt/Xilinx/14.7/ISE_DS/ISE/lib/lin64/plugins/Digilent/libCseDigilent/libCseDigilent.xml


Finally, add every user that should have access to the Digilent USB-JTAG adapter to the "uucp" group.

To grant access to the usb driver for normal users you may have to add the USB Vendor/Product IDs of your JTAG adapter which can be found with

$ lsusb | grep Xilinx

to the udev rules in /etc/udev/rules.d/20-digilent.rules:

SUBSYSTEM=="usb", ATTRS{idVendor}=="xxxx", ATTRS{idProduct}=="xxxx", GROUP="users", MODE="666"

If it still doesn't work, you can make further reading in Xilinx_JTAG_Linux. The magic git repo there may be help.

Xilinx Platform Cable USB-JTAG Drivers

Tango-inaccurate.pngThe factual accuracy of this article or section is disputed.Tango-inaccurate.png

Reason: Building as root is dangerous! (Discuss in Talk:Xilinx ISE WebPACK#)

Make sure you have installed fxloadAUR from the Arch User Repository . We need to build driver from source (git and some make stuff need to be installed, make will say what programs or libraries are missed):

$ cd /opt/Xilinx
$ sudo git clone git://git.zerfleddert.de/usb-driver
$ cd usb-driver/
$ sudo make

If you using 32-bit version of ISE on 64-bit system, pass "lib32" to make:

$ sudo make lib32

And install driver (replace 14.7 to your version):

$ ./setup_pcusb /opt/Xilinx/14.7/ISE_DS/ISE/

When performing this command, the udev rules file will be created. You can reload udev rules to apply changes immidiately:

$ sudo udevadm control --reload-rules

If driver installed correctly and udev rule works, STATUS led should turn on (green or red depending on voltage presence on VREF PIN)

Locale Issues

PlanAhead doesn't like locales using other literals than '.' as the decimal point (e.g. German, which uses ','). Run the following command before launching PlanAhead:

$ unset LANG

Segmentation Fault on PlanAhead

When launching PlanAhead to generate a .ucf file, a segmentation fault may occur. The issue seems unrelated to the previous topic. The ISE console will show

"/opt/Xilinx/14.7/ISE_DS/PlanAhead/bin/rdiArgs.sh: line 64: 14275 Segmentation fault      $RDI_PROG $*"

The problem seems to come from the bundled JRE as described here. To fix the issue, symlink the OpenJDK libjvm.so into the Xilinx's installation directory.

# cd /opt/Xilinx/14.7/ISE_DS/PlanAhead/tps/lnx64/jre/lib/amd64/server
# mv libjvm.so{,-orig}
# ln -s /usr/lib/jvm/java-7-openjdk/jre/lib/amd64/server/libjvm.so

GNU make

XSDK looks for the gmake executable, which is not present in Arch Linux by default. Create a symlink somewhere in your path, e.g.

$ ln -s /usr/bin/make /home/<user>/bin/gmake

Make sure this directory is in your PATH variable.

Running Xilinx tools from within KDE

KDE by default defines the QT_PLUGIN_PATH shell variable. Some of the Xilinx ISE tools (ISE, Impact, XPS) are Qt applications, which means that they will search for Qt plugins in the locations defined by this shell variable.

Because the Xilinx tools are compiled against and ship with an older version of the Qt framework which cannot use these plugins, they will crash when launched with this environment variable present.

To fix this issue, run the following command before launching the tools:

$ unset QT_PLUGIN_PATH

CORE Generator fails to generate core

In some cases, the CORE Generator will fails to generate a core and output something like this to its console:

ERROR:sim - Unable to evaluate Tcl file:
   /opt/Xilinx/14.7/ISE_DS/ISE/coregen/ip/xilinx/primary/com/xilinx/ip/clk_wiz_v3_6/generate/run_legacy_tcl_flow.tcl
ERROR:sim - Failed executing Tcl generator.

If that happens, make sure you don't have _JAVA_OPTIONS set in your environment. If you normally run coregen with

$ source /opt/Xilinx/14.7/ISE_DS/settings64.sh && coregen

you need to prepend that with an "unset _JAVA_OPTIONS":

$ unset _JAVA_OPTIONS && source /opt/Xilinx/14.7/ISE_DS/settings64.sh && coregen