From 7dfff09be53b97f9b9b14f79a38bcaa78aac43af Mon Sep 17 00:00:00 2001
From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Thu, 23 Sep 2021 23:49:57 +0100
Subject: [PATCH] more comments

---
 src/soc/simple/test/test_runner.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/soc/simple/test/test_runner.py b/src/soc/simple/test/test_runner.py
index 99ca54c3..410e6fbb 100644
--- a/src/soc/simple/test/test_runner.py
+++ b/src/soc/simple/test/test_runner.py
@@ -292,6 +292,7 @@ class TestRunner(FHDLTestCase):
                              reg_wid=64)
 
         ###### SETUP PHASE #######
+        # StateRunner.setup_for_test()
 
         if self.run_hdl:
             #hard_reset = Signal(reset_less=True)
@@ -323,6 +324,7 @@ class TestRunner(FHDLTestCase):
         def process():
 
             ###### PREPARATION PHASE AT START OF RUNNING #######
+            # StateRunner.setup_during_test()
 
             if self.run_hdl:
                 # start in stopped
@@ -336,6 +338,7 @@ class TestRunner(FHDLTestCase):
                 with self.subTest(test.name):
 
                     ###### PREPARATION PHASE AT START OF TEST #######
+                    # StateRunner.prepare_for_test()
 
                     if self.run_hdl:
                         # set up bigendian (TODO: don't do this, use MSR)
@@ -360,6 +363,7 @@ class TestRunner(FHDLTestCase):
                     instructions = list(zip(gen, insncode))
 
                     ###### RUNNING OF EACH TEST #######
+                    # StateRunner.step_test()
 
                     # Run two tests (TODO, move these to functions)
                     # * first the Simulator, collate a batch of results
@@ -430,6 +434,7 @@ class TestRunner(FHDLTestCase):
                                     "number of instructions run not the same")
 
                 ###### END OF A TEST #######
+                # StateRunner.end_test()
 
                 if self.run_hdl:
                     # stop at end
@@ -463,6 +468,9 @@ class TestRunner(FHDLTestCase):
                     yield from set_dmi(dmi, DBGCore.CTRL, 1<<DBGCtrl.RESET)
                     yield
 
+        ###### END OF EVERYTHING (but none needs doing, still call fn) #######
+        # StateRunner.cleanup()
+
         styles = {
             'dec': {'base': 'dec'},
             'bin': {'base': 'bin'},
-- 
2.30.2