From e044843924508c5027d3ecc0f255c0d131e9b320 Mon Sep 17 00:00:00 2001
From: Peter McGoron <code@mcgoron.com>
Date: Sat, 29 Oct 2022 22:24:51 -0400
Subject: [PATCH] documentation and license

---
 arty_test/README.md   | 13 +++++++++++
 arty_test/hardtest.py | 50 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 arty_test/README.md
 create mode 100644 arty_test/hardtest.py

diff --git a/arty_test/README.md b/arty_test/README.md
new file mode 100644
index 0000000..a703e75
--- /dev/null
+++ b/arty_test/README.md
@@ -0,0 +1,13 @@
+This test requires LiteX 2022.08. You will need to define `DEBUG` in the `boothmul.v`
+file for the logic analyzer to work correctly.
+
+Run `python3 soc.py` to build the design. Afterwards, load the design. Then run
+
+    litex_server --uart --uart-port /dev/ttyUSB1
+
+afterwards run
+
+    python3 hardtest.py
+
+This will generate two .vcd files, which you can check to verify that the multiplier
+is working.
diff --git a/arty_test/hardtest.py b/arty_test/hardtest.py
new file mode 100644
index 0000000..7161734
--- /dev/null
+++ b/arty_test/hardtest.py
@@ -0,0 +1,50 @@
+# This file is licensed under the BSD 2 Clause License.
+# (c) Peter McGoron 2022
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from litex import RemoteClient
+from time import sleep
+from litescope import LiteScopeAnalyzerDriver
+
+wb = RemoteClient()
+wb.open()
+
+def run_test(a1, a2, out):
+	wb.regs.multiplier_arm.write(0)
+	wb.regs.multiplier_const_in.write(a1)
+	wb.regs.multiplier_inval.write(a2)
+
+	analyzer = LiteScopeAnalyzerDriver(wb.regs, "analyzer", debug=True)
+	analyzer.configure_group(0)
+	analyzer.configure_subsampler(1)
+	analyzer.add_rising_edge_trigger("testplatform_arm_storage")
+	analyzer.run()
+
+	wb.regs.multiplier_arm.write(1)
+	analyzer.wait_done()
+	analyzer.upload()
+	analyzer.save(out)
+
+run_test(0x4, 0x4, "booth1.vcd")
+run_test(0xFF, 0xFF, "booth2.vcd")
+
+wb.close()