opencos-eda 0.2.43__tar.gz → 0.2.44__tar.gz

{opencos_eda-0.2.43/opencos_eda.egg-info → opencos_eda-0.2.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.43
+Version: 0.2.44
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/commands/export.py

@@ -37,7 +37,6 @@ class CommandExport(CommandDesign):
             self, tokens: list, process_all: bool = True, pwd: str = os.getcwd()
     ) -> list:
 
-        self.defines['OC_EXPORT'] = None
         unparsed = CommandDesign.process_tokens(
             self, tokens=tokens, process_all=process_all, pwd=pwd
         )

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/commands/flist.py

@@ -47,11 +47,14 @@ class CommandFList(CommandDesign):
             'no-quote-path'      : False,
             'build-script'       : "", # we don't want this to error either
 
-            'print-to-stdout': False, # do not save to file, print to stdout.
+            'print-to-stdout': False,
 
             # ex: eda flist --print-to-stdout --emit-rel-path --quiet <target>
             'emit-rel-path'  : False,
         })
+        self.args_help.update({
+            'print-to-stdout': "do not save file, print to stdout",
+        })
 
     def process_tokens(
             self, tokens: list , process_all: bool = True, pwd: str = os.getcwd()

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/deps_helpers.py

@@ -57,6 +57,8 @@ class Defaults:
         'with-tools',
         'with-args',
         'args',
+        'deps',
+        'reqs',
         'defines',
         'incdirs',
         'replace-config-tools',

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/eda.py

@@ -320,9 +320,10 @@ def process_tokens(tokens: list, original_args: list, config: dict, interactive=
     for value in unparsed:
         if value in config['DEFAULT_HANDLERS'].keys():
             command = value
-            if value in config['command_uses_no_tools']:
+            if not parsed.tool and value in config['command_tool_is_optional']:
+                # only do this if --tool was not set.
                 run_auto_tool_setup = False
-            unparsed.remove(value)
+            unparsed.remove(value) # remove command (flist, export, targets, etc)
             break
 
     if not interactive:
@@ -361,7 +362,7 @@ def process_tokens(tokens: list, original_args: list, config: dict, interactive=
     util.debug(f'{type(sco)=}')
     if not parsed.tool and \
        command not in config.get('command_determines_tool', []) and \
-       command not in config.get('command_uses_no_tools', []):
+       command not in config.get('command_tool_is_optional', []):
         use_tool = which_tool(command, config)
         util.info(f"--tool not specified, using default for {command=}: {use_tool}")
 

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/eda_base.py

@@ -686,6 +686,7 @@ class CommandDesign(Command):
         self.files_sv = []
         self.files_vhd = []
         self.files_cpp = []
+        self.files_sdc = []
         self.files_non_source = []
         self.files_caller_info = {}
         self.dep_shell_commands = [] # each list entry is a {}
@@ -760,7 +761,8 @@ class CommandDesign(Command):
                 self.files.pop(key)
                 self.files[new_key] = True
 
-        my_file_lists_list = [self.files_v, self.files_sv, self.files_vhd, self.files_cpp]
+        my_file_lists_list = [self.files_v, self.files_sv, self.files_vhd, self.files_cpp,
+                              self.files_sdc]
         for my_file_list in my_file_lists_list:
             for iter,value in enumerate(my_file_list):
                 if value and type(value) is str and value.startswith(self._work_dir_add_srcs_path_string):
@@ -1029,6 +1031,7 @@ class CommandDesign(Command):
         sv_file_ext_list = known_file_ext_dict.get('systemverilog', [])
         vhdl_file_ext_list = known_file_ext_dict.get('vhdl', [])
         cpp_file_ext_list = known_file_ext_dict.get('cpp', [])
+        sdc_file_ext_list = known_file_ext_dict.get('synth_constraints', [])
 
         if forced_extension:
             # If forced_extension='systemverilog', then use the first known extension for
@@ -1057,6 +1060,9 @@ class CommandDesign(Command):
         elif file_ext in cpp_file_ext_list:
             self.files_cpp.append(file_abspath)
             util.debug("Added C++ file %s as %s" % (filename, file_abspath))
+        elif file_ext in sdc_file_ext_list:
+            self.files_sdc.append(file_abspath)
+            util.debug("Added SDC file %s as %s" % (filename, file_abspath))
         else:
             # unknown file extension. In these cases we link the file to the working directory
             # so it is available (for example, a .mem file that is expected to exist with relative path)

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/eda_config.py

@@ -30,7 +30,7 @@ class Defaults:
         'vars',
         'file_extensions',
         'command_determines_tool',
-        'command_uses_no_tools',
+        'command_tool_is_optional',
         'tools',
         'auto_tools_order',
     ])

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/eda_config_defaults.yml

@@ -60,6 +60,9 @@ file_extensions:
     - .vhdl
   cpp:
     - .cpp
+  synth_constraints:
+    - .sdc
+    - .xdc
 
   inferred_top:
     # file extensions that we can infer "top" module from, if --top omitted.
@@ -72,8 +75,9 @@ command_determines_tool:
   # eda commands that will self-determine the tool to use
   - waves
 
-command_uses_no_tools:
-  # eda commands that do not use a tool at all, will skip auto_tools_order
+command_tool_is_optional:
+  # eda commands that may not need to use a tool at all, will skip auto_tools_order if --tool=None (default)
+  - flist
   - export
   - targets
 

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/export_helper.py

@@ -352,23 +352,25 @@ class ExportHelper:
             }
         }
 
-        if len(deps_file_args) > 0:
+
+        if deps_file_args:
             data[self.target]['args'] = deps_file_args.copy()
 
         if self.args.get('top', None):
             data[self.target]['top'] = self.args['top']
 
-        if len(self.cmd_design_obj.defines.keys()) > 0:
+        if self.cmd_design_obj.defines:
             data[self.target]['defines'] = self.cmd_design_obj.defines.copy()
             for define in _remove_DEPS_yml_defines:
                 # Remove defines keys for OC_ROOT and OC_SEED. Change OC_SEED to _ORIG_OC_SEED
                 if define in data[self.target]['defines']:
                     data[self.target]['defines'].pop(define)
 
-        if len(self.cmd_design_obj.files_non_source) > 0:
+        reqs_fullpath_list = self.included_files + self.cmd_design_obj.files_non_source
+        if reqs_fullpath_list:
             # Need to strip path information from non-source files:
             data[self.target]['reqs'] = list()
-            for fullpath in self.cmd_design_obj.files_non_source:
+            for fullpath in reqs_fullpath_list:
                 filename = os.path.split(fullpath)[1]
                 data[self.target]['reqs'].append(filename)
 

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/files.py

@@ -23,6 +23,7 @@ FORCE_PREFIX_DICT = {
     'v@': 'verilog',
     'vhdl@': 'vhdl',
     'cpp@': 'cpp',
+    'sdc@': 'synth_constraints',
 }
 
 ALL_FORCED_PREFIXES = set(list(FORCE_PREFIX_DICT.keys()))

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/tests/helpers.py

@@ -128,7 +128,7 @@ class Helpers:
         '''Changes directory to self.DEFAULT_DIR and removes eda.work, eda.export paths'''
         chdir_remove_work_dir('', self.DEFAULT_DIR)
 
-    def log_it(self, command_str:str, logfile=None, use_eda_wrap=True):
+    def log_it(self, command_str:str, logfile=None, use_eda_wrap=True) -> int:
         '''Replacement for calling eda.main or eda_wrap, when you want an internal logfile
 
         Usage:

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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_eda-0.2.43 → opencos_eda-0.2.44}/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}",

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/tools/yosys.py

@@ -46,7 +46,7 @@ class ToolYosys(Tool):
                 [self.sta_exe, '-version'], capture_output=True, check=False
             )
             util.debug(f'{self.yosys_exe} {sta_version_ret=}')
-            sta_ver = sta_version_ret.stdout.decode('utf-8').split()[0]
+            sta_ver = sta_version_ret.stdout.decode('utf-8', errors='replace').split()[0]
             if sta_ver:
                 self.sta_version = sta_ver
 
@@ -56,7 +56,7 @@ class ToolYosys(Tool):
         util.debug(f'{self.yosys_exe} {version_ret=}')
 
         # Yosys 0.48 (git sha1 aaa534749, clang++ 14.0.0-1ubuntu1.1 -fPIC -O3)
-        words = version_ret.stdout.decode('utf-8').split()
+        words = version_ret.stdout.decode('utf-8', errors='replace').split()
 
         if len(words) < 2:
             self.error(f'{self.yosys_exe} --version: returned unexpected str {version_ret=}')
@@ -93,16 +93,27 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
             'yosys-blackbox': [],                # list of modules that yosys will blackbox.
         })
         self.args_help.update({
-            'sta': 'After running Yosys, run "sta" with --liberty-file.' \
-            + ' sta can be installed via: https://github.com/The-OpenROAD-Project/OpenSTA',
-            'sdc-file': '.sdc file to use with --sta, if not present will use auto constraints',
-            'liberty-file': 'Single liberty file for synthesis and sta,' \
-            + ' for example: github/OpenSTA/examples/nangate45_slow.lib.gz',
+            'sta': (
+                'After running Yosys, run "sta" with --liberty-file.'
+                ' sta can be installed via: https://github.com/The-OpenROAD-Project/OpenSTA'
+            ),
+            'sdc-file': (
+                '.sdc file to use with --sta, if not present will use auto constraints.'
+                ' Note you can have .sdc files in "deps" of DEPS.yml targets.'
+            ),
+            'liberty-file': (
+                'Single liberty file for synthesis and sta,'
+                ' for example: github/OpenSTA/examples/nangate45_slow.lib.gz'
+            ),
             'yosys-synth': 'The synth command provided to Yosys, see: yosys help.',
-            'yosys-pre-synth': 'Yosys commands performed prior to running "synth"' \
-            + ' (or eda arg value for --yosys-synth)',
-            'yosys-blackbox': 'List of modules that yosys will blackbox, likely will need these' \
-            + ' in Verilog-2001 for yosys to read outside of slang and synth',
+            'yosys-pre-synth': (
+                'Yosys commands performed prior to running "synth"'
+                ' (or eda arg value for --yosys-synth)'
+            ),
+            'yosys-blackbox': (
+                'List of modules that yosys will blackbox, likely will need these'
+                ' in Verilog-2001 for yosys to read outside of slang and synth'
+            ),
         })
 
         self.yosys_out_dir = ''
@@ -193,6 +204,9 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
         # Need to create sta.f:
         if self.args['sdc-file']:
             sdc_path = self.args['sdc-file']
+        elif self.files_sdc:
+            # Use files from DEPS target or command line.
+            sdc_path = ''
         else:
             # Need to create sdc.f:
             sdc_path = 'sdc.f'
@@ -204,9 +218,14 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
                 'read_liberty ' + self.args['liberty-file'],
                 'read_verilog ' + self.yosys_v_path,
                 'link_design ' + self.args['top'],
-                'read_sdc ' + sdc_path,
-                'report_checks',
             ]
+            for _file in self.files_sdc:
+                lines.append('read_sdc ' + _file)
+            if sdc_path:
+                lines.append('read_sdc ' + sdc_path)
+
+            lines.append('report_checks')
+
             f.write('\n'.join(lines))
 
         return util.ShellCommandList(

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/opencos/util.py

@@ -33,11 +33,10 @@ args = {
     'errors' : 0,
 }
 
-
-def strip_all_quotes(s:str):
+def strip_all_quotes(s: str) -> str:
     return s.replace("'", '').replace('"', '')
 
-def strip_outer_quotes(s:str):
+def strip_outer_quotes(s: str) -> str:
     ret = str(s)
     while (ret.startswith("'") and ret.endswith("'")) or \
           (ret.startswith('"') and ret.endswith('"')):
@@ -732,7 +731,7 @@ def subprocess_run_background(work_dir, command_list, background=True, fake:bool
         stderr = ''
         with open(tee_fpath, 'w') as f:
             for line in iter(proc.stdout.readline, b''):
-                line = line.rstrip().decode("utf-8")
+                line = line.rstrip().decode("utf-8", errors="replace")
                 if not background:
                     print(line)
                 f.write(line + '\n')
@@ -749,8 +748,8 @@ def subprocess_run_background(work_dir, command_list, background=True, fake:bool
         stdout, stderr = proc.communicate()
         rc = proc.returncode
 
-        stdout = stdout.decode('utf-8') if stdout else ""
-        stderr = stderr.decode('utf-8') if stderr else ""
+        stdout = stdout.decode('utf-8', errors="replace") if stdout else ""
+        stderr = stderr.decode('utf-8', errors="replace") if stderr else ""
         debug(f"shell_run_background: {rc=}")
         if stdout:
             for lineno, line in enumerate(stdout.strip().split('\n')):

{opencos_eda-0.2.43 → opencos_eda-0.2.44/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.43
+Version: 0.2.44
 Summary: A simple Python package for wrapping RTL simuliatons and synthesis
 Author-email: Simon Sabato <simon@cognichip.ai>, Drew Ranck <drew@cognichip.ai>
 Project-URL: Homepage, https://github.com/cognichip/opencos

{opencos_eda-0.2.43 → opencos_eda-0.2.44}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.2.43"
+version = "0.2.44"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",