From f731b36c9b9918cc952779a2e07f9bc36ea4ba6c Mon Sep 17 00:00:00 2001
From: Gwenhael Goavec-Merou <gwenhael.goavec-merou@trabucayre.com>
Date: Sat, 9 Nov 2024 07:55:18 +0100
Subject: [PATCH] build/vhd2v_converter.py: allows users to pass a list of
 libraries files to compile before convert HDL.

---
 litex/build/vhd2v_converter.py | 41 ++++++++++++++++++++++++++++++----
 1 file changed, 37 insertions(+), 4 deletions(-)

diff --git a/litex/build/vhd2v_converter.py b/litex/build/vhd2v_converter.py
index 83326a730f..1fb2bd647c 100644
--- a/litex/build/vhd2v_converter.py
+++ b/litex/build/vhd2v_converter.py
@@ -43,13 +43,16 @@ class VHD2VConverter(Module):
         force use of GHDL even if the platform supports VHDL
     _ghdl_opts: str
         options to pass to ghdl
+    _libraries: list of str or tuple
+        list of libraries (library_name, library_path) to compile before conversion.
     """
     def __init__(self, platform, top_entity, build_dir,
         work_package  = None,
         force_convert = False,
         add_instance  = False,
         params        = dict(),
-        files         = list()):
+        files         = list(),
+        libraries     = list()):
         """
         constructor (see class attributes)
         """
@@ -62,12 +65,15 @@ def __init__(self, platform, top_entity, build_dir,
         self._force_convert = force_convert
         self._add_instance  = add_instance
         self._work_package  = work_package
+        self._libraries     = list()
 
         self._ghdl_opts     = ["--std=08", "--no-formal"]
 
         if work_package is not None:
             self._ghdl_opts.append(f"--work={self._work_package}")
 
+        self.add_libraries(libraries)
+
     def add_source(self, filename):
         """
         append the source list with the path + name of a file
@@ -90,6 +96,24 @@ def add_sources(self, path, *filenames):
         """
         self._sources += [os.path.join(path, f) for f in filenames]
 
+    def add_libraries(self, libraries=[]):
+        """
+        append the library list with a list of tuple (work, file).
+        Parameters
+        ==========
+        libraries: list of str or tuple
+            when str a vhdl library full path, when tuple the work package name
+            and the vhdl libary path
+        """
+        for lib in libraries:
+            # when lib is a str -> convert to a tupple based on lib name
+            if type(lib) == str:
+                work_pkg = os.path.splitext(os.path.basename(lib))[0]
+                lib      = (work_pkg, lib)
+            elif type(lib) != tuple:
+                raise OSError(f"{lib} must a string or a set")
+            self._libraries.append(lib)
+
     def do_finalize(self):
         """
         - convert vhdl to verilog when toolchain can't deal with VHDL or
@@ -106,6 +130,18 @@ def do_finalize(self):
             for file in self._sources:
                 self._platform.add_source(file, library=self._work_package)
         else: # platform is only able to synthesis verilog -> convert vhdl to verilog
+            import subprocess
+            from litex.build import tools
+
+            # First: compile external libraries (if requested)
+            for lib in self._libraries:
+                (work_pkg, filename) = lib
+                cmd = ["ghdl", "-a", "--std=08", f"--work={work_pkg}", filename]
+                print(cmd)
+                s   = subprocess.run(cmd)
+                if s.returncode:
+                    raise OSError(f"Unable to compile {filename}, please check your GHDL install.")
+
             # check if more than one core is instanciated
             # if so -> append with _X
             # FIXME: better solution ?
@@ -132,9 +168,6 @@ def do_finalize(self):
             cmd += self._sources
             cmd += ["-e", self._top_entity]
 
-            import subprocess
-            from litex.build import tools
-
             with open(verilog_out, 'w') as output:
                 s = subprocess.run(cmd, stdout=output)
                 if s.returncode: