opencos-eda 0.2.43__py3-none-any.whl → 0.2.45__py3-none-any.whl

opencos/tests/test_eda.py

@@ -692,14 +692,22 @@ class TestDepsReqs:
         assert rc != 0
 
 
-@pytest.mark.skipif(not can_run_eda_sim(), reason='no tool found to handle command: sim')
-def test_deps_command_order():
+@pytest.mark.parametrize("command", ['sim', 'shell'])
+def test_deps_command_order(command):
     '''Test for various "commands" within a DEPS target. This test checks that command
     order is preserved in the top-to-bottom deps order, meaning that eda.py has to collect
     all commands deps order, and then execute them in that order.'''
 
     chdir_remove_work_dir('deps_files/command_order')
-    cmd_list = 'sim --stop-before-compile target_test'.split()
+    if command == 'sim' and not can_run_eda_sim():
+        pytest.skip(f'sim skipped, {can_run_eda_sim()=}')
+        return # skip/pass
+
+    if command == 'shell':
+        cmd_list = 'shell target_test'.split()
+    else:
+        cmd_list = 'sim --stop-before-compile target_test'.split()
+
     with open('eda.log', 'w', encoding='utf-8') as f:
         with redirect_stdout(f):
             with redirect_stderr(f):
@@ -730,14 +738,16 @@ def test_deps_command_order():
     # Added check, we redirected to create eda.log earlier to confirm the targets worked,
     # but as a general eda.py check, all shell commands should create their own
     # {target}__shell_0.log file:
-    work_dir = os.path.join(THISPATH, 'deps_files/command_order', 'eda.work', 'target_test.sim')
+    work_dir = os.path.join(
+        THISPATH, 'deps_files', 'command_order', 'eda.work', f'target_test.{command}'
+    )
     with open(os.path.join(work_dir, 'target_echo_hi__shell_0.log'), encoding='utf-8') as f:
         text = ''.join(f.readlines()).strip()
-        assert text == 'hi'
+        assert text in ['hi', '"hi"', '\\"hi\\"']
     # Added check, one of the targets uses a custom 'tee' file name, instead of the default log.
     with open(os.path.join(work_dir, 'custom_tee_echo_bye.log'), encoding='utf-8') as f:
         text = ''.join(f.readlines()).strip()
-        assert text == 'bye'
+        assert text in ['bye', '"bye"', '\\"bye\\"']
 
 
 @pytest.mark.skipif('verilator' not in tools_loaded, reason="requires verilator")
@@ -896,9 +906,9 @@ class TestDepsTags(Helpers):
         # b/c that should only apply in 'verilator' for this target.)
         exec_lines = self.get_log_lines_with('exec: ', logfile=logfile)
         assert len(exec_lines) == 3
-        assert 'xvlog ' in exec_lines[0]
-        assert 'xelab ' in exec_lines[1]
-        assert 'xsim ' in exec_lines[2]
+        assert 'xvlog' in exec_lines[0]
+        assert 'xelab' in exec_lines[1]
+        assert 'xsim' in exec_lines[2]
         assert not self.is_in_log('--lint-only', logfile=logfile)
 
 

opencos/tests/test_eda_synth.py

@@ -1,17 +1,20 @@
 '''pytests for: eda [multi|tools-multi] synth [args] <target(s)>'''
 
 import os
+import shutil
+
 import pytest
 
 from opencos import eda, eda_tool_helper
 from opencos.tests import helpers
+from opencos.tests.helpers import Helpers
 
 
-thispath = os.path.dirname(__file__)
+THISPATH = os.path.dirname(__file__)
 
 def chdir_remove_work_dir(relpath):
     '''Changes dir to relpath, removes the work directories (eda.work, eda.export*)'''
-    return helpers.chdir_remove_work_dir(thispath, relpath)
+    return helpers.chdir_remove_work_dir(THISPATH, relpath)
 
 # Figure out what tools the system has available, without calling eda.main(..)
 config, tools_loaded = eda_tool_helper.get_config_and_tools_loaded()
@@ -75,3 +78,61 @@ class Tests:
         rc = eda.main(*cmdlist)
         print(f'{rc=}')
         assert rc == 0
+
+
+def vivado_has_xpms() -> bool:
+    '''Returns True if Vivado is installed and has visibility to XPMs'''
+    if 'vivado' not in tools_loaded:
+        return False
+    vivado_exe = shutil.which('vivado')
+    vivado_bin_path, _ = os.path.split(vivado_exe)
+    vivado_base_path, _ = os.path.split(vivado_bin_path) # strip bin/vivado
+
+    return os.path.exists(os.path.join(vivado_base_path, 'data', 'ip', 'xpm'))
+
+
+@pytest.mark.skipif(
+    'slang_yosys' not in tools_loaded, reason="requires slang_yosys for synth"
+)
+class TestsSlangYosys(Helpers):
+    '''Tests that require tool=slang_yosys to be available'''
+
+    def test_sdc_file(self):
+        '''Test for 'eda synth' on oclib_fifo_with_sdc
+
+        This does not use the actual .sdc file, but it also shouldn't fail with
+        that file in the 'deps' list (CommandDesign should track it correctly)
+        '''
+        chdir_remove_work_dir('deps_files/test_sdc_files')
+        cmd_str = 'synth --tool=slang_yosys oclib_fifo_with_sdc'
+        rc = self.log_it(cmd_str, use_eda_wrap=False)
+        assert rc == 0
+
+@pytest.mark.skipif('vivado' not in tools_loaded, reason="requires vivado")
+@pytest.mark.skipif(not vivado_has_xpms(), reason="requires install to have XPMs")
+class TestsVivado(Helpers):
+    '''Tests that require tool=vivado with XPMs available for synthesis'''
+
+    def test_sdc_file(self):
+        '''Test for 'eda synth' on oclib_fifo_with_sdc
+
+        And check that the .sdc file was used and not the default generated .xdc
+        file
+        '''
+        chdir_remove_work_dir('deps_files/test_sdc_files')
+        cmd_str = 'synth --tool=vivado oclib_fifo_with_sdc'
+        rc = self.log_it(cmd_str, use_eda_wrap=False)
+        assert rc == 0
+
+        # apparently this doesn't get saved in the eda.log. That's not great,
+        # but we can check the <target>.synth.log file.
+        synth_log = os.path.join(
+            THISPATH, 'deps_files', 'test_sdc_files',
+            'eda.work', 'oclib_fifo_with_sdc.synth', 'oclib_fifo.synth.log'
+        )
+        sdc_lines = self.get_log_lines_with('.sdc', logfile=synth_log)
+        assert sdc_lines
+        for sdc_line in sdc_lines:
+            assert 'oclib_fifo_vivado.sdc' in sdc_line
+            assert 'test_sdc_files' in sdc_line
+            assert 'eda.work' not in sdc_line

opencos/tools/invio_yosys.py

@@ -51,7 +51,7 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
             'invio-blackbox': 'List of modules that invio will blackbox prior to yosys',
         })
 
-    def write_and_run_yosys_f_files(self, **kwargs) -> None:
+    def write_and_run_yosys_f_files(self) -> None:
 
         # Use helper module for Invio/Verific to save out Verilog-2001 from our
         # Verilog + SystemVerilog + VHDL file lists.
@@ -104,7 +104,7 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
         )
 
         # Optinally create and run a sta.f:
-        sta_command_list = self.create_sta_f() # [] or util.ShellCommandList
+        sta_command_lists = self.create_sta_f() # [] or [util.ShellCommandList]
 
         # We create a run_yosys.sh wrapping these scripts, but we do not run this one.
         util.write_shell_command_file(
@@ -122,8 +122,7 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
                 # Gives us bash commands with tee and pipstatus:
                 invio_command_list,
                 synth_command_list,
-                sta_command_list,
-            ],
+            ] + sta_command_lists,
         )
 
         # Do not run this if args['stop-before-compile'] is True
@@ -135,9 +134,10 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
         self.exec( work_dir=work_dir, command_list=synth_command_list,
                    tee_fpath=synth_command_list.tee_fpath )
 
-        if self.args['sta']:
-            self.exec(work_dir=self.full_work_dir, command_list=sta_command_list,
-                      tee_fpath=sta_command_list.tee_fpath)
+        for x in sta_command_lists:
+            if self.args['sta'] and x:
+                self.exec(work_dir=self.full_work_dir, command_list=x,
+                          tee_fpath=x.tee_fpath)
 
         if self.status == 0:
             util.info(f'yosys: wrote verilog to {self.yosys_v_path}')

opencos/tools/iverilog.py

@@ -37,7 +37,7 @@ class ToolIverilog(Tool):
         iverilog_version_ret = subprocess.run(
             [self.iverilog_exe, '-v'], capture_output=True, check=False
         )
-        lines = iverilog_version_ret.stdout.decode("utf-8").split('\n')
+        lines = iverilog_version_ret.stdout.decode("utf-8", errors="replace").split('\n')
         words = lines[0].split() # 'Icarus Verilog version 13.0 (devel) (s20221226-568-g62727e8b2)'
         version = words[3]
         util.debug(f'{iverilog_path=} {lines[0]=}')

opencos/tools/riviera.py

@@ -36,7 +36,7 @@ class ToolRiviera(ToolModelsimAse):
             capture_output=True,
             check=False
         )
-        stdout = version_ret.stdout.decode('utf-8').rstrip()
+        stdout = version_ret.stdout.decode('utf-8', errors='replace').rstrip()
 
         # Expect:
         #  Aldec, Inc. Riviera-PRO version 2025.04.139.9738 built for Linux64 on May 30, 2025

opencos/tools/slang.py

@@ -44,7 +44,7 @@ class ToolSlang(Tool):
             capture_output=True,
             check=False
         )
-        stdout = version_ret.stdout.decode('utf-8')
+        stdout = version_ret.stdout.decode('utf-8', errors='replace')
         util.debug(f'{path=} {version_ret=}')
         words = stdout.split() # slang version 8.0.6+b4a74b00
         if len(words) < 3:

opencos/tools/slang_yosys.py

@@ -8,7 +8,7 @@ Contains classes for ToolSlangYosys, CommandSynthSlangYosys
 import os
 
 from opencos import util
-from opencos.tools.yosys import ToolYosys, CommonSynthYosys
+from opencos.tools.yosys import ToolYosys, CommonSynthYosys, CommandLecYosys
 
 class ToolSlangYosys(ToolYosys):
     '''Uses slang.so in yosys plugins directory, called via yosys > plugin -i slang'''
@@ -37,7 +37,7 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         self.slang_out_dir = ''
         self.slang_v_path = ''
 
-    def write_and_run_yosys_f_files(self, **kwargs) -> None:
+    def write_and_run_yosys_f_files(self) -> None:
         '''
         1. Creates and runs: yosys.slang.f
            -- should create post_slang_ls.txt
@@ -54,7 +54,7 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         self.blackbox_list += self.args.get('synth-blackbox', [])
         util.debug(f'slang_yosys: {self.blackbox_list=}')
 
-        # create {work_dir} / yosys
+        # create {work_dir} / slang
         self.slang_out_dir = os.path.join(self.full_work_dir, 'slang')
         util.safe_mkdir(self.slang_out_dir)
 
@@ -62,13 +62,13 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
 
         # Run our created yosys.slang.f script
         # Note - this will always run, even if --stop-before-compile is set.
-        slang_command_list = self._create_yosys_slang_f() # util.ShellCommandList
+        slang_command_list = self._create_and_run_yosys_slang_f() # util.ShellCommandList
 
         # Create and run yosys.synth.f
         synth_command_list = self.create_yosys_synth_f() # util.ShellCommandList
 
         # Optinally create and run a sta.f:
-        sta_command_list = self.create_sta_f() # [] or util.ShellCommandList
+        sta_command_lists = self.create_sta_f() # [] or [util.ShellCommandList]
 
         # We create a run_yosys.sh wrapping these scripts, but we do not run this one.
         util.write_shell_command_file(
@@ -78,8 +78,7 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
                 # Gives us bash commands with tee and pipstatus:
                 slang_command_list,
                 synth_command_list,
-                sta_command_list,
-            ],
+            ] + sta_command_lists,
         )
 
         # Do not run this if args['stop-before-compile'] is True
@@ -92,9 +91,10 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         self.exec(work_dir=self.full_work_dir, command_list=synth_command_list,
                   tee_fpath=synth_command_list.tee_fpath)
 
-        if self.args['sta']:
-            self.exec(work_dir=self.full_work_dir, command_list=sta_command_list,
-                      tee_fpath=sta_command_list.tee_fpath)
+        for x in sta_command_lists:
+            if self.args['sta'] and x:
+                self.exec(work_dir=self.full_work_dir, command_list=x,
+                          tee_fpath=x.tee_fpath)
 
         if self.status == 0:
             util.info(f'yosys: wrote verilog to {self.yosys_v_path}')
@@ -108,36 +108,13 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
             '--best-effort-hierarchy',
         ]
 
-        for name,value in self.defines.items():
-            if not name:
-                continue
-            if name in ['SIMULATION']:
-                continue
-
-            if value is None:
-                read_slang_cmd.append(f'--define-macro {name}')
-            else:
-                read_slang_cmd.append(f'--define-macro {name}={value}')
-
-        # We must define SYNTHESIS for oclib_defines.vh to work correctly.
-        if 'SYNTHESIS' not in self.defines:
-            read_slang_cmd.append('--define-macro SYNTHESIS')
-
-        for path in self.incdirs:
-            read_slang_cmd.append(f'-I {path}')
-
-        for path in self.files_v:
-            read_slang_cmd.append(path)
-
-        for path in self.files_sv:
-            read_slang_cmd.append(path)
-
+        read_slang_cmd += self.get_yosys_read_verilog_defines_incdirs_files()
         read_slang_cmd.append(f'--top {self.args["top"]}')
         return ' '.join(read_slang_cmd)
 
 
-    def _create_yosys_slang_f(self) -> util.ShellCommandList:
-        '''Returns the util.ShellCommandList for: yosys --scriptfile yosys.slang.f'''
+    def _create_and_run_yosys_slang_f(self) -> util.ShellCommandList:
+        '''Runs, and Returns the util.ShellCommandList for: yosys --scriptfile yosys.slang.f'''
 
         script_slang_lines = [
             'plugin -i slang'
@@ -181,7 +158,7 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         )
         return slang_command_list
 
-    def _get_yosys_blackbox_list(self) -> list:
+    def get_yosys_blackbox_list(self) -> list:
         '''Based on the results in post_slang_ls.txt, create blackbox commands for
 
         yosys.synth.f script. Uses self.blackbox_list.
@@ -206,12 +183,14 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         return yosys_blackbox_list
 
     def create_yosys_synth_f(self) -> util.ShellCommandList:
+        '''Overriden from CommonSynthYosys'''
+
         # Create yosys.synth.f
         yosys_synth_f_path = os.path.join(self.full_work_dir, 'yosys.synth.f')
 
         # Based on the results in post_slang_ls.txt, create blackbox commands for
         # yosys.synth.f script.
-        yosys_blackbox_list = self._get_yosys_blackbox_list()
+        yosys_blackbox_list = self.get_yosys_blackbox_list()
 
         if self.args['liberty-file'] and not os.path.exists(self.args['liberty-file']):
             self.error(f'--liberty-file={self.args["liberty-file"]} file does not exist')
@@ -251,3 +230,15 @@ class CommandElabSlangYosys(CommandSynthSlangYosys): # pylint: disable=too-many-
             'stop-before-compile': True,
             'lint': True
         })
+
+class CommandLecSlangYosys(CommandLecYosys, ToolSlangYosys): # pylint: disable=too-many-ancestors
+    '''CommandHandler for: eda lec --tool=slang_yosys
+
+    All steps from CommandLecYosys are re-used, except that using ToolSlangYosys
+    instead of ToolYosys. This is necessary so the default --synth arg will
+    synthesize the two designs using slang_yosys for the tool instead of yosys.
+    '''
+
+    def __init__(self, config: dict):
+        CommandLecYosys.__init__(self, config)
+        ToolSlangYosys.__init__(self, config=self.config)

opencos/tools/surelog.py

@@ -33,7 +33,7 @@ class ToolSurelog(Tool):
         version_ret = subprocess.run(
             [self.surelog_exe, '--version'], capture_output=True, check=False
         )
-        stdout = version_ret.stdout.decode('utf-8')
+        stdout = version_ret.stdout.decode('utf-8', errors='replace')
         util.debug(f'{path=} {version_ret=}')
         words = stdout.split() # VERSION: 1.84 (first line)
         if len(words) < 2:

opencos/tools/tabbycad_yosys.py

@@ -36,7 +36,7 @@ class CommandSynthTabbyCadYosys(CommonSynthYosys, ToolTabbyCadYosys):
         ToolTabbyCadYosys.__init__(self, config=self.config)
 
 
-    def write_and_run_yosys_f_files(self, **kwargs) -> None:
+    def write_and_run_yosys_f_files(self) -> None:
         '''
         1. Creates and runs: yosys.verific.f
            -- should create post_verific_ls.txt

opencos/tools/verilator.py

@@ -49,7 +49,7 @@ class ToolVerilator(Tool):
             capture_output=True,
             check=False
         )
-        stdout = version_ret.stdout.decode('utf-8')
+        stdout = version_ret.stdout.decode('utf-8', errors='replace')
         util.debug(f'{path=} {version_ret=}')
         words = stdout.split() # 'Verilator 5.027 devel rev v5.026-92-g403a197e2
         if len(words) < 1:

opencos/tools/vivado.py

@@ -70,7 +70,7 @@ class ToolVivado(Tool):
         #try:
         #    # Get version from vivado -version, or xsim --version:
         #    vivado_ret = subprocess.run(['vivado', '-version'], capture_output=True)
-        #    lines = vivado_ret.stdout.decode('utf-8').split('\n')
+        #    lines = vivado_ret.stdout.decode('utf-8', errors='replace').split('\n')
         #    words = lines[0].split() # vivado v2024.2.1 (64-bit)
         #    version = words[1][1:] # 2024.2.1
         #    self._VERSION = version
@@ -388,9 +388,14 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
         self.exec(self.args['work-dir'], command_list)
 
 
-    def write_tcl_file(self, tcl_file: str) -> None:
+    def write_tcl_file( # pylint: disable=too-many-locals,too-many-branches
+            self, tcl_file: str
+    ) -> None:
         '''Writes synthesis capable Vivado tcl file to filepath 'tcl_file'.'''
 
+        # TODO(drew): This method needs to be broken up to avoid the pylint
+        # waivers.
+
         v = self.get_vivado_tcl_verbose_arg()
 
         defines = ""
@@ -416,9 +421,12 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
         part = self.args['part']
         top = self.args['top']
 
+        default_xdc = False
         if self.args['xdc'] != "":
-            default_xdc = False
             xdc_file = os.path.abspath(self.args['xdc'])
+        elif self.files_sdc:
+            # Use files from DEPS target or command line.
+            xdc_file = ''
         else:
             default_xdc = True
             xdc_file = os.path.abspath(os.path.join(self.args['work-dir'],
@@ -427,7 +435,17 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
 
         tcl_lines += [
             f"create_fileset -constrset constraints_1 {v}",
-            f"add_files -fileset constraints_1 {xdc_file} {v}",
+        ]
+        for _file in self.files_sdc:
+            # NOTE - sdc files cannot (yet) be attached to other modules.
+            tcl_lines += [
+                f"add_files -fileset constraints_1 {_file} {v}",
+            ]
+        if xdc_file:
+            tcl_lines += [
+                f"add_files -fileset constraints_1 {xdc_file} {v}",
+            ]
+        tcl_lines += [
             "# FIRST PASS -- auto_detect_xpm",
             "synth_design -rtl -rtl_skip_ip -rtl_skip_constraints -no_timing_driven -no_iobuf " \
             + f"-top {top} {incdirs} {defines} {v}",
@@ -631,10 +649,10 @@ class CommandBuildVivado(CommandBuild, ToolVivado):
         eda_path = eda_base.get_eda_exec('flist')
         command_list = [
             eda_path, 'flist',
-            '--tool', self.args['tool'],
+            '--tool=' + self.args['tool'],
             self.args['top-path'],
             '--force',
-            '--out', flist_file,
+            '--out=' + flist_file,
             #'--no-emit-incdir',
             #'--no-single-quote-define', # Needed to run in Command.exec( ... shell=False)
             '--no-quote-define',
@@ -644,11 +662,11 @@ class CommandBuildVivado(CommandBuild, ToolVivado):
             '--no-equal-define',
             '--bracket-quote-path',
             # on --prefix- items, use shlex.quote(str) so spaces work with subprocess shell=False:
-            '--prefix-incdir', shlex.quote("oc_set_project_incdir "),
-            '--prefix-define', shlex.quote("oc_set_project_define "),
-            '--prefix-sv', shlex.quote("add_files -norecurse "),
-            '--prefix-v', shlex.quote("add_files -norecurse "),
-            '--prefix-vhd', shlex.quote("add_files -norecurse "),
+            '--prefix-incdir=' + shlex.quote("oc_set_project_incdir "),
+            '--prefix-define=' + shlex.quote("oc_set_project_define "),
+            '--prefix-sv=' + shlex.quote("add_files -norecurse "),
+            '--prefix-v=' + shlex.quote("add_files -norecurse "),
+            '--prefix-vhd=' + shlex.quote("add_files -norecurse "),
         ]
         for key,value in self.defines.items():
             if value is None:
@@ -656,6 +674,7 @@ class CommandBuildVivado(CommandBuild, ToolVivado):
             else:
                 command_list += [ shlex.quote(f"+define+{key}={value}") ]
         cwd = util.getcwd()
+        util.debug(f"CommandBuildVivado: {cwd=}")
 
 
         # Write out a .sh command, but only for debug, it is not run.