From e6d950bcb0b60b15316ee2dcbd66f858987ed015 Mon Sep 17 00:00:00 2001
From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Fri, 3 Nov 2023 11:07:57 +0100
Subject: [PATCH] gen/fhdl/verilog: Add module hierarchy generation after
 module definition.

Will give a better overview of the generated verilog and will also ease comparing changes/track regressions.
---
 litex/gen/fhdl/verilog.py | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/litex/gen/fhdl/verilog.py b/litex/gen/fhdl/verilog.py
index d6b9536bc..20d861505 100644
--- a/litex/gen/fhdl/verilog.py
+++ b/litex/gen/fhdl/verilog.py
@@ -25,7 +25,9 @@ from migen.fhdl.tools       import *
 from migen.fhdl.conv_output import ConvOutput
 from migen.fhdl.specials    import Memory
 
-from litex.gen.fhdl.namer import build_namespace
+from litex.gen import LiteXContext
+from litex.gen.fhdl.namer     import build_namespace
+from litex.gen.fhdl.hierarchy import LiteXHierarchyExplorer
 
 from litex.build.tools import get_litex_git_revision
 
@@ -82,6 +84,19 @@ def _generate_timescale(time_unit="1ns", time_precision="1ps"):
     r = f"`timescale {time_unit} / {time_precision}\n"
     return r
 
+# ------------------------------------------------------------------------------------------------ #
+#                                         HIERARCHY                                                #
+# ------------------------------------------------------------------------------------------------ #
+
+def _generate_hierarchy(top):
+    hierarchy = LiteXHierarchyExplorer(top=top, depth=None, with_colors=False).__repr__()
+    r = "/*\n"
+    for l in hierarchy.split("\n"):
+        r += l + "\n"
+        #r += "//" + l + "\n"
+    r += "*/\n"
+    return r
+
 # ------------------------------------------------------------------------------------------------ #
 #                                    RESERVED KEYWORDS                                             #
 # ------------------------------------------------------------------------------------------------ #
@@ -624,6 +639,10 @@ def convert(f, ios=set(), name="top", platform=None,
     verilog += _generate_separator("Module")
     verilog += _generate_module(f, ios, name, ns, attr_translate)
 
+    # Module Hierarchy.
+    verilog += _generate_separator("Hierarchy")
+    verilog += _generate_hierarchy(top=LiteXContext.top)
+
     # Module Signals.
     verilog += _generate_separator("Signals")
     verilog += _generate_signals(f, ios, name, ns, attr_translate, regs_init)