From bcba8197f29e88aa0855aad51fd1279fa49b5c42 Mon Sep 17 00:00:00 2001
From: John McMaster <johndmcmaster@gmail.com>
Date: Fri, 22 Dec 2017 15:52:40 -0800
Subject: [PATCH] Document MUXF8 Vivado compatibility issue

Signed-off-by: John McMaster <johndmcmaster@gmail.com>
---
 README.md                          | 6 ++++++
 fuzzers/012-clbn5ffmux/generate.sh | 1 +
 fuzzers/015-clbnffmux/generate.sh  | 1 +
 fuzzers/016-clbnoutmux/generate.sh | 1 +
 4 files changed, 9 insertions(+)

diff --git a/README.md b/README.md
index aabfa73c..b2d6ec48 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,12 @@ bit-stream format of Xilinx 7-series FPGAs.
 
 # Quickstart Guide
 
+Install Vivado 2017.2 (2017.3 has a known compatibility issue, see
+https://github.com/SymbiFlow/prjxray/issues/14). Then source the settings
+script, ie
+
+    source /opt/Xilinx/Vivado/2017.2/settings64.sh
+
 Pull submodules:
 
     git submodule update --init --recursive
diff --git a/fuzzers/012-clbn5ffmux/generate.sh b/fuzzers/012-clbn5ffmux/generate.sh
index 54774bf8..8bfd1d47 100644
--- a/fuzzers/012-clbn5ffmux/generate.sh
+++ b/fuzzers/012-clbn5ffmux/generate.sh
@@ -1,6 +1,7 @@
 #!/bin/bash
 
 set -ex
+if [ $(vivado -h |grep Vivado |cut -d\  -f 2) != "v2017.2" ] ; then echo "FIXME: requires Vivado 2017.2. See https://github.com/SymbiFlow/prjxray/issues/14"; exit 1; fi
 
 source ${XRAY_GENHEADER}
 
diff --git a/fuzzers/015-clbnffmux/generate.sh b/fuzzers/015-clbnffmux/generate.sh
index 54774bf8..8bfd1d47 100644
--- a/fuzzers/015-clbnffmux/generate.sh
+++ b/fuzzers/015-clbnffmux/generate.sh
@@ -1,6 +1,7 @@
 #!/bin/bash
 
 set -ex
+if [ $(vivado -h |grep Vivado |cut -d\  -f 2) != "v2017.2" ] ; then echo "FIXME: requires Vivado 2017.2. See https://github.com/SymbiFlow/prjxray/issues/14"; exit 1; fi
 
 source ${XRAY_GENHEADER}
 
diff --git a/fuzzers/016-clbnoutmux/generate.sh b/fuzzers/016-clbnoutmux/generate.sh
index 54774bf8..8bfd1d47 100644
--- a/fuzzers/016-clbnoutmux/generate.sh
+++ b/fuzzers/016-clbnoutmux/generate.sh
@@ -1,6 +1,7 @@
 #!/bin/bash
 
 set -ex
+if [ $(vivado -h |grep Vivado |cut -d\  -f 2) != "v2017.2" ] ; then echo "FIXME: requires Vivado 2017.2. See https://github.com/SymbiFlow/prjxray/issues/14"; exit 1; fi
 
 source ${XRAY_GENHEADER}