From 0d15abe4d1d2ac02599ae40d787efe5ad78c5391 Mon Sep 17 00:00:00 2001
From: Fischer Moseley <42497969+fischermoseley@users.noreply.github.com>
Date: Sat, 3 Aug 2024 12:20:36 -0700
Subject: [PATCH] ethernet: update __init__ away from config dict

---
 src/manta/ethernet/__init__.py | 35 +++++++++++++++++++---------------
 src/manta/manta.py             |  2 +-
 test/test_config_export.py     | 10 ++++++----
 3 files changed, 27 insertions(+), 20 deletions(-)

diff --git a/src/manta/ethernet/__init__.py b/src/manta/ethernet/__init__.py
index 4a37467..74f0e4b 100644
--- a/src/manta/ethernet/__init__.py
+++ b/src/manta/ethernet/__init__.py
@@ -17,16 +17,13 @@ class EthernetInterface(Elaboratable):
     https://fischermoseley.github.io/manta/ethernet_interface/
     """
 
-    def __init__(self, config):
-        self._config = config
-        self._fpga_ip_addr = config.get("fpga_ip_addr")
-        self._host_ip_addr = config.get("host_ip_addr")
-        self._udp_port = config.get("udp_port")
-        self._phy = config.get("phy")
-
-        # Convert to float first because Python considers scientific notation
-        # to only represent floats, not ints.
-        self._clk_freq = int(float(config.get("clk_freq")))
+    def __init__(self, fpga_ip_addr, host_ip_addr, udp_port, phy, clk_freq, **kwargs):
+        self._fpga_ip_addr = fpga_ip_addr
+        self._host_ip_addr = host_ip_addr
+        self._udp_port = udp_port
+        self._phy = phy
+        self._clk_freq = clk_freq
+        self._additional_config = kwargs
         self._check_config()
 
         self.bus_i = Signal(InternalBus())
@@ -34,8 +31,9 @@ class EthernetInterface(Elaboratable):
 
         self._phy_io = self._define_phy_io()
 
+        clk_freq_rounded = round(self._clk_freq)
         self._dhcp_start = Signal()
-        self._dhcp_timer = Signal(range(self._clk_freq + 1), init=self._clk_freq)
+        self._dhcp_timer = Signal(range(clk_freq_rounded + 1), init=clk_freq_rounded)
 
         self._source_data = Signal(32)
         self._source_last = Signal()
@@ -84,7 +82,15 @@ class EthernetInterface(Elaboratable):
                 raise ValueError(f"Invalid byte in FPGA IP: {byte}")
 
     def to_config(self):
-        return self._config
+        config = {
+            "fpga_ip_addr": self._fpga_ip_addr,
+            "host_ip_addr": self._host_ip_addr,
+            "udp_port": self._udp_port,
+            "phy": self._phy,
+            "clk_freq": self._clk_freq,
+        }
+
+        return {**config, **self._additional_config}
 
     def get_top_level_ports(self):
         """
@@ -333,12 +339,11 @@ class EthernetInterface(Elaboratable):
         'ethernet' section of the Manta configuration file to LiteEth, after
         modifying it slightly.
         """
-        liteeth_config = self._config.copy()
+        liteeth_config = self.to_config()
 
         # Randomly assign a MAC address if one is not specified in the
         # configuration. This will choose a MAC address in the Locally
-        # Administered, Administratively Assigned group. For more information,
-        # please reference:
+        # Administered, Administratively Assigned group. Please reference:
         # https://en.wikipedia.org/wiki/MAC_address#Ranges_of_group_and_locally_administered_addresses
 
         if "mac_address" not in liteeth_config:
diff --git a/src/manta/manta.py b/src/manta/manta.py
index 8a0892f..7ead3c7 100644
--- a/src/manta/manta.py
+++ b/src/manta/manta.py
@@ -219,4 +219,4 @@ class Manta(Elaboratable):
         import yaml
 
         with open(path, "w") as f:
-            yaml.dump(config, f)
+            yaml.dump(config, f, default_flow_style=False)
diff --git a/test/test_config_export.py b/test/test_config_export.py
index 8d1c86a..6340ee9 100644
--- a/test/test_config_export.py
+++ b/test/test_config_export.py
@@ -109,8 +109,6 @@ def test_logic_analyzer_core_dump():
     with open(tf.name, "r") as f:
         data = yaml.safe_load(f)
 
-    print(tf.name)
-
     # Verify that exported YAML matches configuration
     expected = {
         "cores": {
@@ -168,8 +166,11 @@ def test_ethernet_interface_dump():
         fpga_ip_addr="192.168.0.101",
         host_ip_addr="192.168.0.100",
         udp_port=2000,
-        phy="",
-        clk_freq=0,
+        phy="LiteEthPHYRMII",
+        clk_freq=50e6,
+        refclk_freq=50e6,
+        vendor="xilinx",
+        toolchain="vivado",
     )
 
     # Create Temporary File
@@ -196,6 +197,7 @@ def test_ethernet_interface_dump():
             "refclk_freq": 50000000.0,
             "fpga_ip_addr": "192.168.0.101",
             "host_ip_addr": "192.168.0.100",
+            "udp_port": 2000,
         }
     }