From a3a5ffd45b2d39beabc5eab7d217fc22435ee3f1 Mon Sep 17 00:00:00 2001
From: Tim 'mithro' Ansell <me@mith.ro>
Date: Fri, 22 Mar 2019 16:43:54 -0700
Subject: [PATCH] minitests/roi_harness: Updating README.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
---
 minitests/roi_harness/README.md | 91 ++++++++++++++++++++++++++++++++-
 1 file changed, 90 insertions(+), 1 deletion(-)

diff --git a/minitests/roi_harness/README.md b/minitests/roi_harness/README.md
index 35d41112..4c0841cd 100644
--- a/minitests/roi_harness/README.md
+++ b/minitests/roi_harness/README.md
@@ -2,7 +2,96 @@
 
 ## Purpose
 
-Creates an ROI with clk, inputs, and outputs to use as a partial reconfiguration test harness
+Creates an harness bitstream which maps peripherals into a region of interest
+which can be reconfigured.
+
+The currently supported boards are;
+
+ * Artix 7 boards;
+  - [Basys 3](https://github.com/SymbiFlow/prjxray-db/tree/master/artix7/harness#basys-3)
+  - [Arty A7-35T](https://github.com/SymbiFlow/prjxray-db/tree/master/artix7/harness#arty-a7-35t)
+
+ * Zynq boards;
+  - [Zybo Z7-10](https://github.com/SymbiFlow/prjxray-db/tree/master/zynq7/harness#zybo-z7-10)
+
+The following configurations are supported;
+
+ * SWBUT - Harness which maps a board's switches, buttons and LEDs into the
+   region of interest (plus clock).
+
+
+ * PMOD - Harness which maps a board's PMOD connectors into the region of
+   interest (plus a clock).
+
+ * UART - Harness which maps a board's UART
+
+
+"ARTY-A7-SWBUT"
+        # 4 switches then 4 buttons
+        A8 C11 C10 A10  D9 C9 B9 B8
+        # 4 LEDs then 4 RGB LEDs (green only)
+        H5 J5 T9 T10  F6 J4 J2 H6
+
+        # clock
+	E3
+
+"ARTY-A7-PMOD"
+        # CLK on Pmod JA
+	G13 B11 A11 D12  D13 B18 A18 K16
+        # DIN on Pmod JB
+        E15 E16 D15 C15  J17 J18 K15 J15
+        # DOUT on Pmod JC
+	U12 V12 V10 V11  U14 V14 T13 U13
+
+"ARTY-A7-UART"
+        # RST button and UART_RX
+        C2 A9
+        # LD7 and UART_TX
+        T10 D10
+        # 100 MHz CLK onboard
+        E3
+
+"BASYS3-SWBUT"
+        # Slide switch pins
+        V17 V16 W16 W17 W15 V15 W14 W13 V2 T3 T2 R3 W2 U1 T1 R2
+	# LEDs pins
+        U16 E19 U19 V19 W18 U15 U14 V14 V13 V3 W3 U3 P3 N3 P1 L1
+
+        # UART
+        B18 # ins
+        A18 # outs
+
+        # 100 MHz CLK onboard
+        W5
+
+"ZYBOZ7-SWBUT"
+        # J15 - UART_RX - JE3
+        # G15 - SW0
+        # K18 - BTN0
+        # K19 - BTN1
+        J15  G15  K18 K19
+
+        # H15 - UART_TX - JE4
+        # E17 - ETH PHY reset (active low, keep high for 125 MHz clock)
+        # M14 - LD0
+        # G14 - LD2
+        # M15 - LD1
+        # D18 - LD3
+
+        # 125 MHz CLK onboard
+        K17
+
+# Quickstart
+
+```
+source settings/artix7.sh
+cd minitests/roi_harness
+source arty-swbut.sh
+make clean
+make copy
+```
+
+# How it works
 
 Basic idea:
 - LOC LUTs in the ROI to terminate input and output routing