From a4f381947990af10615f9acb9a50632af4c622ff Mon Sep 17 00:00:00 2001
From: Brian <brian.luong@hotmail.ca>
Date: Mon, 13 Mar 2023 21:44:07 +0000
Subject: [PATCH 1/2] apio build parameter for top-lvl module

introducing option to specify top level module for build/yosys
---
 apio/commands/build.py          | 4 ++++
 apio/managers/arguments.py      | 3 +++
 apio/resources/ice40/SConstruct | 4 +++-
 3 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/apio/commands/build.py b/apio/commands/build.py
index 56440b0e..7bf25fc4 100644
--- a/apio/commands/build.py
+++ b/apio/commands/build.py
@@ -50,6 +50,8 @@
 @click.option(
     "--verbose-pnr", is_flag=True, help="Show the pnr output of the command."
 )
+@click.option("--top-module", type=str, metavar="top_module", help="Set the top level module (w/o .v ending) for build.",
+)
 def cli(
     ctx,
     board,
@@ -61,6 +63,7 @@ def cli(
     verbose,
     verbose_yosys,
     verbose_pnr,
+    top_module,
 ):
     """Synthesize the bitstream."""
 
@@ -84,6 +87,7 @@ def cli(
                 "yosys": verbose_yosys,
                 "pnr": verbose_pnr,
             },
+            "top-module": top_module,
         }
     )
 
diff --git a/apio/managers/arguments.py b/apio/managers/arguments.py
index cd9df368..b662ee02 100644
--- a/apio/managers/arguments.py
+++ b/apio/managers/arguments.py
@@ -33,6 +33,7 @@ def process_arguments(args, resources):  # noqa
         var_pack = args.get("pack")
         var_idcode = args.get("idcode")
         var_verbose = args.get("verbose")
+        var_topmodule = args.get("top-module")
     else:
         var_board = None
         var_arch = None
@@ -42,6 +43,7 @@ def process_arguments(args, resources):  # noqa
         var_pack = None
         var_idcode = None
         var_verbose = {}
+        var_topmodule= None
 
     if var_board:
         if isfile("apio.ini"):
@@ -249,6 +251,7 @@ def process_arguments(args, resources):  # noqa
             "verbose_all": var_verbose.get("all"),
             "verbose_yosys": var_verbose.get("yosys"),
             "verbose_pnr": var_verbose.get("pnr"),
+            "top_module": var_topmodule,
         }
     )
 
diff --git a/apio/resources/ice40/SConstruct b/apio/resources/ice40/SConstruct
index 29de9109..53bd9933 100644
--- a/apio/resources/ice40/SConstruct
+++ b/apio/resources/ice40/SConstruct
@@ -20,6 +20,7 @@ PROG = ARGUMENTS.get('prog', '')
 FPGA_SIZE = ARGUMENTS.get('fpga_size', '')
 FPGA_TYPE = ARGUMENTS.get('fpga_type', '')
 FPGA_PACK = ARGUMENTS.get('fpga_pack', '')
+YOSYS_TOP = ARGUMENTS.get('top_module', '')
 VERBOSE_ALL = ARGUMENTS.get('verbose_all', False)
 VERBOSE_YOSYS = ARGUMENTS.get('verbose_yosys', False)
 VERBOSE_PNR = ARGUMENTS.get('verbose_pnr', False)
@@ -166,7 +167,8 @@ except IndexError:
 
 # -- Define the Sintesizing Builder
 synth = Builder(
-    action='yosys -p \"synth_ice40 -json $TARGET\" {} $SOURCES'.format(
+    action='yosys -p \"synth_ice40 {0} -json $TARGET\" {1} $SOURCES'.format(
+        ('-top '+YOSYS_TOP) if YOSYS_TOP else '',
         '' if VERBOSE_ALL or VERBOSE_YOSYS else '-q'
     ),
     suffix='.json',

From 80f6221d9ff6826f16ec325c2cb2602c134118e5 Mon Sep 17 00:00:00 2001
From: Brian <brian.luong@hotmail.ca>
Date: Mon, 13 Mar 2023 21:57:41 +0000
Subject: [PATCH 2/2] adding documentation about apio build --top-module

---
 docs/source/user_guide/project_commands/cmd_build.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/source/user_guide/project_commands/cmd_build.rst b/docs/source/user_guide/project_commands/cmd_build.rst
index d05acfde..16626fa0 100644
--- a/docs/source/user_guide/project_commands/cmd_build.rst
+++ b/docs/source/user_guide/project_commands/cmd_build.rst
@@ -59,6 +59,11 @@ Show the yosys output of the command.
 
 Show the arachne output of the command.
 
+.. option::
+    --top-module
+
+Set the top level module name used for build. Otherwise Yosys will auto select. 
+
 .. note::
 
   All available boards, FPGAs, sizes, types and packs are showed in :ref:`cmd_boards`