feat: fabric name (#627)

* feat: better fabric name

* chore: add test

* chore: clean to simple test

Author: KelvinChung2000

fabulous/fabric_generator/gen_fabric/gen_fabric.py

@@ -34,7 +34,7 @@ def generateFabric(writer: CodeGenerator, fabric: Fabric) -> None:
     # we first scan all tiles if those have IOs that have to go to top
     # the order of this scan is later maintained when instantiating the actual tiles
     # header
-    fabricName = "eFPGA"
+    fabricName = fabric.name
     writer.addHeader(fabricName)
     writer.addParameterStart(indentLevel=1)
     writer.addParameter(

fabulous/fabric_generator/gen_fabric/gen_top_wrapper.py

@@ -192,10 +192,10 @@ def split_port(p: str) -> tuple[tuple[int, int], tuple[int, ...], str]:
             )
         if not (basePath / "eFPGA_Config.vhdl").exists():
             raise FileExistsError("Config.vhdl not found in the 'Fabric' directory.")
-        if not (basePath / "eFPGA.vhdl").exists():
+        if not (basePath / f"{fabric.name}.vhdl").exists():
             raise FileExistsError(
-                "eFPGA.vhdl not found in the 'Fabric' directory, "
-                "need to generate the eFPGA first."
+                f"{fabric.name}.vhdl not found in the 'Fabric' directory, "
+                f"need to generate the {fabric.name} first."
             )
         if not (basePath / "BlockRAM_1KB.vhdl").exists():
             raise FileExistsError(
@@ -204,7 +204,7 @@ def split_port(p: str) -> tuple[tuple[int, int], tuple[int, ...], str]:
         writer.addComponentDeclarationForFile(f"{basePath}/Frame_Data_Reg.vhdl")
         writer.addComponentDeclarationForFile(f"{basePath}/Frame_Select.vhdl")
         writer.addComponentDeclarationForFile(f"{basePath}/eFPGA_Config.vhdl")
-        writer.addComponentDeclarationForFile(f"{basePath}/eFPGA.vhdl")
+        writer.addComponentDeclarationForFile(f"{basePath}/{fabric.name}.vhdl")
         writer.addComponentDeclarationForFile(f"{basePath}/BlockRAM_1KB.vhdl")
 
     writer.addLogicStart()

fabulous/fabulous_cli/fabulous_cli.py

@@ -469,7 +469,7 @@ def do_load_fabric(self, args: argparse.Namespace) -> None:
             raise ValueError
 
         proj_dir = get_context().proj_dir
-        if (proj_dir / "eFPGA_geometry.csv").exists():
+        if (proj_dir / f"{self.fabulousAPI.fabric.name}_geometry.csv").exists():
             self.enable_category(CMD_GUI)
 
         self.enable_category(CMD_FABRIC_FLOW)

tests/fabric_gen_test/fabric_test/__init__.py

@@ -0,0 +1,27 @@
+"""Tests for fabric generation with custom fabric names."""
+
+import pytest
+from pytest_mock import MockerFixture
+
+from fabulous.fabric_definition.define import ConfigBitMode
+from fabulous.fabric_definition.fabric import Fabric
+from fabulous.fabric_generator.code_generator.code_generator import CodeGenerator
+from fabulous.fabric_generator.gen_fabric.gen_fabric import generateFabric
+
+
+def test_generate_fabric_uses_fabric_name(mocker: MockerFixture) -> None:
+    """generateFabric should use fabric.name as the module name."""
+    fabric = mocker.create_autospec(Fabric)
+    fabric.name = "test_fabric"
+    fabric.tile = []
+    fabric.configBitMode = ConfigBitMode.FLIPFLOP_CHAIN
+    fabric.maxFramesPerCol = 20
+    fabric.frameBitsPerRow = 32
+    fabric.numberOfRows = 0
+    fabric.numberOfColumns = 0
+
+    writer = mocker.create_autospec(CodeGenerator)
+
+    generateFabric(writer, fabric)
+
+    writer.addHeader.assert_called_once_with("test_fabric")