First fix-ups for Ubuntu 16.04

- document urjtag build (jtag in Ubuntu 16.04 is broken)
- add environment sanity wrappers for acroread,awk,firefox to ensure
  proper operation of vivado under Ubuntu 16.04

tools/README.md

@@ -4,6 +4,7 @@ This directory tree contains **many tools** and is organized in
 | --------- | ------- |
 | [asm-11](asm-11) | environment for `asm-11` assembler |
 | [bin](bin)       | support scripts and tools |
+| [bin_xilinx_wrapper](bin_xilinx_wrapper) | wrappers for Xilinx environments |
 | [dox](dox)       | configuration files for Doxygen |
 | [fx2](fx2)       | firmware for Cypress FX2 USB interface |
 | [make](make)     | make includes |

tools/bin/xtwi

@@ -1,7 +1,7 @@
 #!/bin/bash
-# $Id: xtwi 830 2016-12-26 20:25:49Z mueller $
+# $Id: xtwi 862 2017-04-01 12:44:51Z mueller $
 #
-# Copyright 2013-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
+# Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
 # License disclaimer see License.txt in $RETROBASE directory
 #
 # Xilinx Tool Wrapper script for ISE:
@@ -10,6 +10,7 @@
 #
 #  Revision History:
 # Date         Rev Version  Comment
+# 2017-04-01   862   1.2.1  add usr_local/bin and bin_xilinx_wrapper to PATH
 # 2016-08-28   804   1.2    BUGFIX: add ":." to PATH even under BARE_PATH
 # 2016-02-21   735   1.1    use BARE_PATH ect to provide clean environment
 # 2013-10-12   539   1.0    Initial version
@@ -34,11 +35,12 @@ then
   fi
 
   # provide clean environment when BARE_PATH ect defined
-  #   add only $RETROBASE/tools/bin and '.' to path
-  #   '.' is needed to start ISim tb's, which usually are in cwd
+  #   add prepend $HOME/usr_local/bin to path
+  #   add append $RETROBASE/tools/bin and '.' to path
+  #   '.' is needed to start tb's, which usually are in cwd
   if [ -n "$BARE_PATH" ]
   then
-    export PATH=$BARE_PATH:$RETROBASE/tools/bin:.
+    export PATH=$HOME/usr_local/bin:$BARE_PATH:$RETROBASE/tools/bin:.
     unset LD_LIBRARY_PATH
     if [ -n "$BARE_LD_LIBRARY_PATH" ]
     then
@@ -46,6 +48,9 @@ then
     fi 
   fi
 
+  # add bin_xilinx_wrapper to path (for firefox ect interceptors)
+  export PATH=$RETROBASE/tools/bin_xilinx_wrapper:$PATH
+
   # check whether 32 or 64 bit system (uname -m gives 'i686' or 'x86_64')
   if [ `uname -m` = "x86_64" ]
   then

tools/bin/xtwv

@@ -1,7 +1,7 @@
 #!/bin/bash
-# $Id: xtwv 830 2016-12-26 20:25:49Z mueller $
+# $Id: xtwv 862 2017-04-01 12:44:51Z mueller $
 #
-# Copyright 2013-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
+# Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
 # License disclaimer see License.txt in $RETROBASE directory
 #
 # Xilinx Tool Wrapper script for Vivado
@@ -10,6 +10,7 @@
 #
 #  Revision History:
 # Date         Rev Version  Comment
+# 2017-04-01   862   1.1.1  add usr_local/bin and bin_xilinx_wrapper to PATH
 # 2016-02-21   735   1.1    use BARE_PATH ect to provide clean environment
 # 2014-04-18   554   1.0.1  fake XILINX_VIVADO, 2014.1 doesn't define it anymore
 # 2013-10-12   539   1.0    Initial version (cloned from xtwi)
@@ -33,10 +34,12 @@ then
   fi
 
   # provide clean environment when BARE_PATH ect defined
-  #   add only $RETROBASE/tools/bin to path
+  #   add prepend $HOME/usr_local/bin to path
+  #   add append $RETROBASE/tools/bin and '.' to path
+  #   '.' is needed to start tb's, which usually are in cwd
   if [ -n "$BARE_PATH" ]
   then
-    export PATH=$BARE_PATH:$RETROBASE/tools/bin
+    export PATH=$HOME/usr_local/bin:$BARE_PATH:$RETROBASE/tools/bin:.
     unset LD_LIBRARY_PATH
     if [ -n "$BARE_LD_LIBRARY_PATH" ]
     then
@@ -44,6 +47,9 @@ then
     fi 
   fi
 
+  # add bin_xilinx_wrapper to path (for firefox ect interceptors)
+  export PATH=$RETROBASE/tools/bin_xilinx_wrapper:$PATH
+  
   # check whether 32 or 64 bit system (uname -m gives 'i686' or 'x86_64')
   if [ `uname -m` = "x86_64" ]
   then

tools/bin_xilinx_wrapper/README.md

@@ -0,0 +1,13 @@
+This directory contains wrappers for general system tools called from within
+Xilinx IDE (ISE or Vivado). The wrappers reset the environment used inside the
+IDE to a very basic default environment with
+
+    unset LD_LIBRARY_PATH
+    export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+
+and finally execute the chosen tool via `exec` like
+
+    exec firefox "$@"
+
+This ensures that these tools work properly and don't fail due to conflicting
+library versions.

tools/bin_xilinx_wrapper/acroread

@@ -0,0 +1,9 @@
+#!/bin/bash
+#
+# wrapper for the acroread command used in Xilinx ISE/Vivado
+# it cleans up the environment, and redirects to ocular
+# following a suggestion of Clifford Wolf
+#
+unset LD_LIBRARY_PATH
+export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+exec okular "$@"

tools/bin_xilinx_wrapper/awk

@@ -0,0 +1,8 @@
+#!/bin/bash
+#
+# wrapper for the awk command used in Xilinx Vivado
+# it cleans up the environment
+#
+unset LD_LIBRARY_PATH
+export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+exec awk "$@"

tools/bin_xilinx_wrapper/firefox

@@ -0,0 +1,9 @@
+#!/bin/bash
+#
+# wrapper for the firefox command used in Xilinx ISE/Vivado
+# it cleans up the environment
+# following a suggestion of Clifford Wolf
+#
+unset LD_LIBRARY_PATH
+export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+exec firefox "$@"