Add the 'housenka' tape-sampling loop accelerator

skoolkid · Sep 24, 2023 · 2fd7269 · 2fd7269
1 parent c80ec34
commit 2fd7269
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 4 deletions.
diff --git a/skoolkit/loadsample.py b/skoolkit/loadsample.py
@@ -553,6 +553,27 @@ def __init__(self, name, code, offset, in_time, loop_time, loop_r_inc, ear_mask,
         0     # Zero flag is reset upon edge detection by AND $40
     ),
 
+    'housenka': Accelerator(
+        'housenka',
+        [
+            0x04,       # LD_SAMPLE INC B          [4]
+            0xC8,       #           RET Z          [11/5]
+            0x3E, 0xFE, #           LD A,$FE       [7]
+            0xDB, 0xFE, #           IN A,($FE)     [11]
+            0x1F,       #           RRA            [4]
+            0xD0,       #           RET NC         [11/5]
+            0xA9,       #           XOR C          [4]
+            0xE6, 0x20, #           AND $20        [7]
+            0x28, 0xF3, #           JR Z,LD_SAMPLE [12/7]
+        ],
+        0,    # Offset of INC B instruction from start of loop
+        16,   # 16 T-states from INC B until IN A,($FE)
+        59,   # 59 T-states per loop iteration
+        9,    # R register increment per loop iteration
+        0x20, # EAR mask
+        0     # Zero flag is reset upon edge detection by AND $20
+    ),
+
     'microprose': Accelerator(
         'microprose',
         [

diff --git a/sphinx/source/changelog.rst b/sphinx/source/changelog.rst
@@ -18,8 +18,8 @@ Changelog
 * The output snapshot argument of :ref:`tap2sna.py` is now optional
 * Added support to :ref:`tap2sna.py <tap2sna-conf>` for register pairs
   (``r[bc]``, ``r[de]`` etc.) in the ``TraceLine`` configuration parameter
-* Added the ``ernieware`` tape-sampling loop
-  :ref:`accelerator <tap2sna-accelerators>`
+* Added the ``ernieware`` and ``housenka`` tape-sampling loop
+  :ref:`accelerators <tap2sna-accelerators>`
 * Added support to :ref:`trace.py` for executing machine code in 128K snapshots
 * Added support to :ref:`trace.py <trace-conf>` for reading configuration
   from `skoolkit.ini`

diff --git a/sphinx/source/commands.rst b/sphinx/source/commands.rst
@@ -1478,6 +1478,7 @@ loop accelerators are:
 * ``gargoyle2`` (various games created or published by Gargoyle Games)
 * ``gremlin`` (various games published by Gremlin Graphics)
 * ``gremlin2`` (Super Cars)
+* ``housenka`` (Housenka)
 * ``microprose`` (F-15 Strike Eagle)
 * ``microsphere`` (Back to Skool, Contact Sam Cruise, Skool Daze, Sky Ranger)
 * ``micro-style`` (Xenophobe)
@@ -1603,7 +1604,7 @@ Configuration parameters may also be set on the command line by using the
 |         | SZX snapshots; added the ``fe`` hardware state attribute; added   |
 |         | support for register pairs (``r[bc]``, ``r[de]`` etc.) in the     |
 |         | ``TraceLine`` configuration parameter; added the ``ernieware``    |
-|         | tape-sampling loop accelerator                                    |
+|         | and ``housenka`` tape-sampling loop accelerators                  |
 +---------+-------------------------------------------------------------------+
 | 8.10    | Configuration is read from `skoolkit.ini` if present; added the   |
 |         | ``--ini``, ``--show-config`` and ``--tape-analysis`` options;     |

diff --git a/sphinx/source/man/tap2sna.py.rst b/sphinx/source/man/tap2sna.py.rst
@@ -203,6 +203,7 @@ loop accelerators are:
 |  ``gargoyle2`` (various games created or published by Gargoyle Games)
 |  ``gremlin`` (various games published by Gremlin Graphics)
 |  ``gremlin2`` (Super Cars)
+|  ``housenka`` (Housenka)
 |  ``microprose`` (F-15 Strike Eagle)
 |  ``microsphere`` (Back to Skool, Contact Sam Cruise, Skool Daze, Sky Ranger)
 |  ``micro-style`` (Xenophobe)

diff --git a/tests/test_tap2sna.py b/tests/test_tap2sna.py
@@ -2152,7 +2152,7 @@ def test_sim_load_config_parameter_default_values(self):
         output, error = self.run_tap2sna(tapfile)
         self.assertEqual(error, '')
         self.assertIsNone(kbtracer)
-        self.assertEqual(len(load_tracer.accelerators_in), 44)
+        self.assertEqual(len(load_tracer.accelerators_in), 45)
         self.assertTrue(load_tracer.pause)
         self.assertEqual(load_tracer.first_edge, 0)
         self.assertEqual(load_tracer.polarity, 0)