Remove unused Heartbeat component

Author: robtaylor

chipflow_lib/platforms/silicon.py

@@ -7,14 +7,12 @@
 import re
 import subprocess
 
-from dataclasses import dataclass
 from pprint import pformat
 from typing import TYPE_CHECKING, List, Generic
 
 from amaranth import Module, Signal, ClockDomain, ClockSignal, ResetSignal, unsigned
-from amaranth.lib import wiring, io, data
+from amaranth.lib import io, data
 from amaranth.lib.cdc import FFSynchronizer
-from amaranth.lib.wiring import Component, In
 from amaranth.back import rtlil  #type: ignore[reportAttributeAccessIssue]
 from amaranth.hdl import Fragment
 from amaranth.hdl._ir import PortDirection
@@ -31,44 +29,6 @@
 logger = logging.getLogger(__name__)
 
 
-def make_hashable(cls):
-    def __hash__(self):
-        return hash(id(self))
-
-    def __eq__(self, obj):
-        return id(self) == id(obj)
-
-    cls.__hash__ = __hash__
-    cls.__eq__ = __eq__
-    return cls
-
-
-HeartbeatSignature = wiring.Signature({"heartbeat_i": In(1)})
-
-
-@make_hashable
-@dataclass
-class Heartbeat(Component):
-    clock_domain: str = "sync"
-    counter_size: int = 23
-    name: str = "heartbeat"
-
-    def __init__(self, ports):
-        super().__init__(HeartbeatSignature)
-        self.ports = ports
-
-    def elaborate(self, platform):
-        m = Module()
-        # Heartbeat LED (to confirm clock/reset alive)
-        heartbeat_ctr = Signal(self.counter_size)
-        getattr(m.d, self.clock_domain).__iadd__(heartbeat_ctr.eq(heartbeat_ctr + 1))
-
-        heartbeat_buffer = io.Buffer(io.Direction.Output, self.ports.heartbeat)
-        m.submodules.heartbeat_buffer = heartbeat_buffer
-        m.d.comb += heartbeat_buffer.o.eq(heartbeat_ctr[-1])  # type: ignore
-        return m
-
-
 class SiliconPlatformPort(io.PortLike, Generic[Pin]):
     def __init__(self,
                  name: str,

tests/test_steps_silicon.py

@@ -739,40 +739,3 @@ def test_elaborate_no_heartbeat(self, mock_top_components, mock_platform_class):
 
         # Verify heartbeat was not requested
         platform.request.assert_not_called()
-
-    @mock.patch("chipflow_lib.platforms.silicon.io.Buffer")
-    @mock.patch("chipflow_lib.steps.silicon.Module")
-    @mock.patch("chipflow_lib.platforms.silicon.Heartbeat")
-    @mock.patch("chipflow_lib.steps.silicon.top_components")
-    def test_heartbeat(self, mock_top_components, mock_module, mock_heartbeat_class, mock_io_buffer):
-        """Test that Heartbeat class gets used properly when debug.heartbeat is True"""
-        # Import Heartbeat class to make sure it's loaded and used
-
-        # Create a mock Heartbeat instance
-        mock_heartbeat = mock.MagicMock()
-        mock_heartbeat_class.return_value = mock_heartbeat
-
-        # Create a mock platform with a heartbeat port
-        platform = mock.MagicMock()
-        platform.pinlock.port_map.ports = {}
-        platform.ports = {
-            "heartbeat": mock.MagicMock()
-        }
-        platform.request.return_value = platform.ports["heartbeat"]
-
-        # Create a mock for top_components
-        mock_top_components.return_value = {}
-
-        # Create and elaborate SiliconTop with heartbeat
-        config_obj = Config.model_validate(self.config)
-        top = SiliconTop(config_obj)
-        result = top.elaborate(platform)
-
-        # Verify platform.request was called with "heartbeat"
-        platform.request.assert_called_with("heartbeat")
-
-        # Use the result to ensure the module doesn't trigger UnusedElaboratable
-        self.assertIsNotNone(result)
-
-        # We don't need to test config_no_heartbeat in this test
-        # The test_elaborate_no_heartbeat already does that