opencos-eda 0.2.54__tar.gz → 0.2.55__tar.gz

{opencos_eda-0.2.54/opencos_eda.egg-info → opencos_eda-0.2.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.54
+Version: 0.2.55
 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
@@ -15,5 +15,5 @@ Requires-Dist: schema>=0.7.7
 Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
-Requires-Dist: cocotb>=2.0.0b1
+Requires-Dist: cocotb>=2.0
 Dynamic: license-file

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/commands/__init__.py

@@ -10,6 +10,7 @@ from .elab import CommandElab
 from .export import CommandExport
 from .flist import CommandFList
 from .multi import CommandMulti, CommandToolsMulti
+from .lint import CommandLint
 from .open import CommandOpen
 from .proj import CommandProj
 from .sim import CommandSim
@@ -28,6 +29,7 @@ __all__ = [
     'CommandExport',
     'CommandFList',
     'CommandMulti',
+    'CommandLint',
     'CommandOpen',
     'CommandProj',
     'CommandSim',

opencos_eda-0.2.55/opencos/commands/lint.py

@@ -0,0 +1,51 @@
+'''opencos.commands.lint - Base class command handler for: eda lint ...
+
+Intended to be overriden by Tool based classes (such as CommandLintVivado, etc)
+
+Note that many 'lint' command handlers that also can perform simulations, such
+as VerilatorLint, will instead inherit from VerilatorSim and simply perform a
+shortened sim as the lint, instead of inheriting CommandLint.
+
+Tools that don't support a 'sim' command will generally use CommandLint, such
+as CommandLintSlang.'''
+
+from opencos.commands.sim import CommandSim
+
+class CommandLint(CommandSim):
+    '''Base class command handler for: eda lint ...'''
+
+    command_name = 'lint'
+
+    def __init__(self, config: dict):
+        CommandSim.__init__(self, config=config)
+        # add args specific to this simulator
+        self.args['stop-after-compile'] = True
+        self.args['lint'] = True
+        self.args['verilate-args'] = []
+
+
+
+    def compile(self) -> None:
+        raise NotImplementedError
+
+    def elaborate(self) -> None:
+        raise NotImplementedError
+
+    def get_compile_command_lists(self, **kwargs) -> list:
+        ''' Returns a list of lists (list of command lists).'''
+        raise NotImplementedError
+
+    def get_elaborate_command_lists(self, **kwargs) -> list:
+        ''' Returns a list of lists (list of command lists).'''
+        raise NotImplementedError
+
+    # CommandSim methods that elab does not use:
+
+    def simulate(self):
+        pass
+
+    def get_simulate_command_lists(self, **kwargs) -> list:
+        return []
+
+    def get_post_simulate_command_lists(self, **kwargs) -> list:
+        return []

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/deps/deps_file.py

@@ -306,7 +306,9 @@ class DepsFile:
                 return False
 
             if not is_valid_target_name(target_node):
-                util.warning(f"In file {self.rel_deps_file}, {target_node} {VALID_TARGET_INFO_STR}")
+                util.warning(
+                    f"In file {self.rel_deps_file}, {target_node} {VALID_TARGET_INFO_STR}"
+                )
 
             if not caller_info:
                 # If we don't have caller_info, likely came from command line (or DEPS JSON data):

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/eda.py

@@ -23,7 +23,7 @@ from opencos import util, eda_config, eda_base
 from opencos.eda_base import Tool, which_tool, get_eda_exec
 from opencos.utils import vsim_helper, vscode_helper
 from opencos.utils.subprocess_helpers import subprocess_run_background
-from opencos.utils import status_constants
+from opencos.utils import status_constants, str_helpers
 
 # Configure util:
 util.progname = "EDA"
@@ -78,7 +78,7 @@ def get_all_commands_help_str(config: dict) -> str:
     return '\n'.join(all_commands_help)
 
 
-def usage(tokens: list, config: dict, command="") -> int:
+def usage(tokens: list, config: dict, command: str = "", tool: str = "") -> int:
     '''Returns an int shell return code, given remaining args (tokens list) and eda command.
 
     config is the config dict. Used to check valid commands in config['command_handler']
@@ -112,6 +112,9 @@ And <files|targets, ...> is one or more source file or DEPS markup file target,
 
     if command in config['command_handler'].keys():
         sco = config['command_handler'][command](config=config) # sub command object
+        sco_tool = getattr(sco, '_TOOL', '')
+        if tool and tool != sco_tool:
+            util.warning(f'{tool=} does not support {command=}')
         sco.help(tokens=tokens)
         return util.exit(0)
 
@@ -282,9 +285,15 @@ def tool_setup(tool: str, config: dict, quiet: bool = False, auto_setup: bool =
     if tool not in config['auto_tools_order'][0]:
         tools = list(config.get('auto_tools_order', [{}])[0].keys())
         cfg_yaml_fname = config.get('config-yml', None)
+        util.warning(f'Unknown tool: {tool}')
+        if tools:
+            util.info('Known tools:')
+            pretty_tools = str_helpers.pretty_list_columns_manual(data=tools)
+            for row in pretty_tools:
+                if row:
+                    util.info(row)
         util.error(f"Don't know how to run tool_setup({tool=}), is not in",
-                   f"config['auto_tools_order'] for {tools=}",
-                   f"from {cfg_yaml_fname}")
+                   f"config['auto_tools_order'] from {cfg_yaml_fname}")
         return
 
     if tool not in config['auto_tools_found']:
@@ -394,7 +403,9 @@ def process_tokens( # pylint: disable=too-many-branches,too-many-statements,too-
             for arg in unparsed:
                 if not arg.startswith('-'):
                     command = arg
-        return usage(tokens=unparsed, config=config, command=command)
+        if parsed.tool:
+            tool_setup(parsed.tool, config=config)
+        return usage(tokens=unparsed, config=config, command=command, tool=parsed.tool)
 
     if parsed.tool:
         tool_setup(parsed.tool, config=config)

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/eda_config_defaults.yml

@@ -7,6 +7,7 @@ DEFAULT_HANDLERS:
   # These commands (sim, elab, etc) require a tool, but have a default handler
   # base class:
   sim         : opencos.commands.CommandSim
+  lint        : opencos.commands.CommandLint
   elab        : opencos.commands.CommandElab
   synth       : opencos.commands.CommandSynth
   proj        : opencos.commands.CommandProj
@@ -29,7 +30,8 @@ DEFAULT_HANDLERS:
 
 DEFAULT_HANDLERS_HELP:
   sim:         Simulates a DEPS target.
-  elab:        Elaborates a DEPS target (lint, tool specific).
+  lint:        Syntax check, lint a DEPS target
+  elab:        Elaborates a DEPS target (lint + elab, tool specific).
   synth:       Synthesizes a DEPS target.
   flist:       Create dependency from a DEPS target.
   proj:        Create a project from a DEPS target for GUI sim/waves/debug.
@@ -362,11 +364,13 @@ auto_tools_order:
       requires_cmd:
         - slang --version
       handlers:
+        lint: opencos.tools.slang.CommandLintSlang
         elab: opencos.tools.slang.CommandElabSlang
 
     verilator:
       exe: verilator
       handlers:
+        lint: opencos.tools.verilator.VerilatorLint
         elab: opencos.tools.verilator.VerilatorElab
         sim: opencos.tools.verilator.VerilatorSim
 
@@ -382,6 +386,7 @@ auto_tools_order:
       requires_cmd:
         - surelog --version
       handlers:
+        lint: opencos.tools.surelog.CommandLintSurelog
         elab: opencos.tools.surelog.CommandElabSurelog
 
     invio:
@@ -391,6 +396,7 @@ auto_tools_order:
       requires_py:
         - invio
       handlers:
+        lint:  opencos.tools.invio.CommandLintInvio
         elab:  opencos.tools.invio.CommandElabInvio
 
     vaporview:
@@ -422,6 +428,7 @@ auto_tools_order:
     vivado:
       exe: vivado
       handlers:
+        lint:   opencos.tools.vivado.CommandLintVivado
         elab:   opencos.tools.vivado.CommandElabVivado
         sim:    opencos.tools.vivado.CommandSimVivado
         synth:  opencos.tools.vivado.CommandSynthVivado
@@ -469,6 +476,7 @@ auto_tools_order:
       exe: qrun
       requires_vsim_helper: True
       handlers:
+        lint: opencos.tools.questa.CommandLintQuesta
         elab: opencos.tools.questa.CommandElabQuesta
         sim: opencos.tools.questa.CommandSimQuesta
         flist: opencos.tools.questa.CommandFListQuesta
@@ -479,6 +487,7 @@ auto_tools_order:
         - which riviera  # Do not run it, make sure it's in PATH
       requires_vsim_helper: True
       handlers:
+        lint: opencos.tools.riviera.CommandLintRiviera
         elab: opencos.tools.riviera.CommandElabRiviera
         sim:  opencos.tools.riviera.CommandSimRiviera
 
@@ -486,6 +495,7 @@ auto_tools_order:
       exe: vsim
       requires_vsim_helper: True
       handlers:
+        lint: opencos.tools.modelsim_ase.CommandLintModelsimAse
         elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
         sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
 
@@ -493,6 +503,7 @@ auto_tools_order:
       exe: vsim
       requires_vsim_helper: True
       handlers:
+        lint: opencos.tools.questa_fse.CommandLintQuestaFse
         elab: opencos.tools.questa_fse.CommandElabQuestaFse
         sim:  opencos.tools.questa_fse.CommandSimQuestaFse
         flist: opencos.tools.questa_fse.CommandFListQuestaFse
@@ -500,6 +511,7 @@ auto_tools_order:
     iverilog:
       exe: iverilog
       handlers:
+        lint: opencos.tools.iverilog.CommandLintIverilog
         elab: opencos.tools.iverilog.CommandElabIverilog
         sim:  opencos.tools.iverilog.CommandSimIverilog
 

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tests/helpers.py

@@ -65,6 +65,11 @@ def eda_elab_wrap(*args):
     main_args = [x for x in list(args) if (x != 'elab' and '--seed' not in x)]
     return eda.main('elab', *main_args)
 
+def eda_lint_wrap(*args):
+    '''Calls eda.main for 'elab'.'''
+    main_args = [x for x in list(args) if (x != 'lint' and '--seed' not in x)]
+    return eda.main('lint', *main_args)
+
 def assert_sim_log_passes(
         filepath: str, want_str: str = 'TEST PASS',
         err_strs: list = ['Error', 'ERROR', 'TEST FAIL']

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tests/test_eda_elab.py

@@ -5,7 +5,7 @@ import pytest
 
 from opencos import eda_tool_helper
 from opencos.tests import helpers
-from opencos.tests.helpers import eda_wrap, eda_elab_wrap
+from opencos.tests.helpers import eda_wrap, eda_elab_wrap, eda_lint_wrap
 
 
 thispath = os.path.dirname(__file__)
@@ -29,6 +29,16 @@ list_of_elab_tools = [
     'invio_yosys',
 ]
 
+list_of_lint_tools = [
+    'slang',
+    'verilator',
+    'vivado',
+    'modelsim_ase'
+    'questa_fse',
+    'invio',
+    'surelog',
+]
+
 list_of_elab_tools_cant_sim = [
     'slang',
     'invio',
@@ -36,6 +46,11 @@ list_of_elab_tools_cant_sim = [
     'invio_yosys',
 ]
 
+list_of_commands = [
+    'elab',
+    'lint',
+]
+
 def skip_it(tool) -> bool:
     '''Returns True if this test should be skipped
 
@@ -44,27 +59,33 @@ def skip_it(tool) -> bool:
     '''
     return bool( tool not in tools_loaded )
 
+@pytest.mark.parametrize("command", list_of_commands)
 @pytest.mark.parametrize("tool", list_of_elab_tools)
 class Tests:
     '''Test tools from list_of_elab_tools for 'eda elab' and 'eda multi elab'.'''
 
-    def test_args_elab(self, tool):
+    def test_args_elab(self, command, tool):
         '''tests: eda elab --tool oclib_priarb'''
+        if command == 'lint' and tool not in list_of_lint_tools:
+            pytest.skip(f"lint skipped for {tool=} b/c it can't run lint")
         if skip_it(tool):
             pytest.skip(f"{tool=} skipped, {tools_loaded=}")
             return # skip/pass
         chdir_remove_work_dir('../../lib')
-        rc = eda_elab_wrap('--tool', tool, 'oclib_priarb')
+        if command == 'elab':
+            rc = eda_elab_wrap('--tool', tool, 'oclib_priarb')
+        else:
+            rc = eda_lint_wrap('--tool', tool, 'oclib_priarb')
         print(f'{rc=}')
         assert rc == 0
 
-    def test_args_multi_elab(self, tool):
+    def test_args_multi_elab(self, command, tool):
         '''tests: eda multi elab --tool oclib_*arb'''
         if skip_it(tool):
             pytest.skip(f"{tool=} skipped, {tools_loaded=}")
             return # skip/pass
         chdir_remove_work_dir('../../lib')
-        rc = eda_wrap('multi', 'elab', '--tool', tool, 'oclib_*arb')
+        rc = eda_wrap('multi', command, '--tool', tool, 'oclib_*arb')
         print(f'{rc=}')
         assert rc == 0
 

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/invio.py

@@ -38,6 +38,8 @@ class ToolInvio(Tool):
 class CommandElabInvio(CommandElab, ToolInvio):
     '''Command handler for: eda elab --tool=invio'''
 
+    command_name = 'elab'
+
     def __init__(self, config:dict):
         CommandElab.__init__(self, config)
         ToolInvio.__init__(self, config=self.config)
@@ -72,7 +74,7 @@ class CommandElabInvio(CommandElab, ToolInvio):
         '''Returns list of util.ShellCommandList, for slang we'll run this in elaborate()'''
         invio_blackbox_list = self.args.get('invio-blackbox', [])
         invio_dict = invio_helpers.get_invio_command_dict(
-            self, blackbox_list=invio_blackbox_list, sim_elab=True
+            self, blackbox_list=invio_blackbox_list,
         )
         return invio_dict['command_lists']
 
@@ -84,3 +86,8 @@ class CommandElabInvio(CommandElab, ToolInvio):
     def get_elaborate_command_lists(self, **kwargs) -> list:
         '''We only use 'compile' commands for invio elab, do not use elaborate commands'''
         return []
+
+class CommandLintInvio(CommandElabInvio):
+    '''Command handler for: eda lint --tool=invio'''
+
+    command_name = 'lint'

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/invio_helpers.py

@@ -34,6 +34,7 @@ def write_py_file(
         py_filename: str = 'run_invio.py',
         v_filename: str = '',
         blackbox_list: list = [],
+        sim_lint: bool = False,
         sim_elab: bool = False,
         **kwargs
 ) -> dict:
@@ -137,7 +138,15 @@ def write_py_file(
                                             tee_fpath = 'invio.log')]
     })
 
-    if sim_elab:
+    if sim_lint:
+        # lint (skip elaborate steps -- from eda.CommandLintInvio)
+        lines += [
+            'assert analyze()',
+            '',
+            'report_analyzed_files()',
+            'print_instance_hierarchy()',
+        ]
+    elif sim_elab:
         # elab (non-synthesis), runs the following (from eda.CommandElabInvio)
         lines += [
             'assert analyze()',
@@ -206,14 +215,23 @@ def write_py_file(
 
 
 
-def get_invio_command_dict(command_design_obj:object, v_filename='', py_filename='run_invio.py',
-                           blackbox_list=[], sim_elab:bool=False, **kwargs) -> dict:
+def get_invio_command_dict(
+        command_design_obj:object, v_filename='', py_filename='run_invio.py',
+        blackbox_list=[],
+        **kwargs
+) -> dict:
     '''Creates a .py file from an eda.CommandDesign. Returns a dict with
 
     information about what to run.'''
 
-    invio_dict = write_py_file( command_design_obj, v_filename=v_filename,
-                                py_filename=py_filename, blackbox_list=blackbox_list,
-                                sim_elab=sim_elab, **kwargs )
+    cmd_name = getattr(command_design_obj, 'command_name', '')
+    sim_lint = cmd_name == 'lint'
+    sim_elab = cmd_name == 'elab'
+
+    invio_dict = write_py_file(
+        command_design_obj, v_filename=v_filename,
+        py_filename=py_filename, blackbox_list=blackbox_list,
+        sim_elab=sim_elab, sim_lint=sim_lint, **kwargs
+    )
 
     return invio_dict

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/invio_yosys.py

@@ -59,7 +59,7 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
 
         # Generate run_invio.py:
         invio_dict = invio_helpers.get_invio_command_dict(
-            self, blackbox_list=invio_blackbox_list, sim_elab=False
+            self, blackbox_list=invio_blackbox_list,
         )
         # run run_invio.py:
         if not self.args.get('stop-before-compile', False):
@@ -146,9 +146,10 @@ class CommandSynthInvioYosys(CommonSynthYosys, ToolInvioYosys):
 class CommandElabInvioYosys(CommandSynthInvioYosys):
     '''Run invio + yosys as elab only (does not run the synthesis portion)'''
 
+    command_name = 'elab'
+
     def __init__(self, config):
         super().__init__(config)
-        self.command_name = 'elab'
         self.args.update({
             'stop-after-compile': True, # In the case of Invio/Yosys we run the Invio step
             'lint': True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/iverilog.py

@@ -164,6 +164,19 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
 class CommandElabIverilog(CommandSimIverilog):
     '''CommandElabIverilog is a command handler for: eda elab --tool=iverilog'''
 
+    command_name = 'elab'
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True
+
+
+class CommandLintIverilog(CommandSimIverilog):
+    '''CommandLintIverilog is a command handler for: eda lint --tool=iverilog'''
+
+    command_name = 'lint'
+
     def __init__(self, config:dict):
         super().__init__(config)
+        self.args['stop-after-compile'] = True
         self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/modelsim_ase.py

@@ -369,6 +369,19 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
 class CommandElabModelsimAse(CommandSimModelsimAse):
     '''CommandElabModelsimAse is a command handler for: eda elab --tool=modelsim_ase'''
 
+    command_name = 'elab'
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True
+
+
+class CommandLintModelsimAse(CommandSimModelsimAse):
+    '''CommandLintModelsimAse is a command handler for: eda lint --tool=modelsim_ase'''
+
+    command_name = 'lint'
+
     def __init__(self, config:dict):
         super().__init__(config)
+        self.args['stop-after-compile'] = True
         self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/quartus.py

@@ -150,6 +150,7 @@ class CommandSynthQuartus(CommandSynth, ToolQuartus):
         self.write_tcl_file(tcl_file=tcl_file)
 
         # execute Quartus synthesis
+        command_list_gui = [self.quartus_gui_exe, '-t', tcl_file]
         command_list = [
             self.quartus_exe, '-t', tcl_file
         ]
@@ -170,9 +171,27 @@ class CommandSynthQuartus(CommandSynth, ToolQuartus):
             typ='text', description='Quartus Synthesis Report'
         )
 
-        self.exec(self.args['work-dir'], command_list)
+        if self.args['gui'] and self.quartus_gui_exe:
+            self.exec(self.args['work-dir'], command_list_gui)
+        else:
+            self.exec(self.args['work-dir'], command_list)
+
+
+        saved_qpf_filename = self.args["top"] + '.qpf'
+        if not os.path.isfile(os.path.join(self.args['work-dir'], saved_qpf_filename)):
+            self.error('Saved project file does not exist:',
+                       os.path.join(self.args['work-dir'], saved_qpf_filename))
+
         util.info(f"Synthesis done, results are in: {self.args['work-dir']}")
 
+        # Note: in GUI mode, if you ran: quaruts -t build.tcl, it will exit on completion,
+        # so we'll re-open the project.
+        if self.args['gui'] and self.quartus_gui_exe:
+            self.exec(
+                work_dir=self.args['work-dir'],
+                command_list=[self.quartus_gui_exe, saved_qpf_filename]
+            )
+
     def write_tcl_file(self, tcl_file: str) -> None:  # pylint: disable=too-many-locals,too-many-branches
         '''Writes synthesis capable Quartus tcl file to filepath 'tcl_file'.'''
 
@@ -221,11 +240,27 @@ class CommandSynthQuartus(CommandSynth, ToolQuartus):
                 tcl_lines.append(f"set_global_assignment -name VERILOG_MACRO \"{key}={value}\"")
 
         # Add constraints
+        default_sdc = False
+        sdc_files = []
         if self.args['sdc']:
-            tcl_lines.append(f"set_global_assignment -name SDC_FILE \"{self.args['sdc']}\"")
+            sdc_files = [os.path.abspath(self.args['sdc'])]
         elif self.files_sdc:
-            for sdc_file in self.files_sdc:
-                tcl_lines.append(f"set_global_assignment -name SDC_FILE \"{sdc_file}\"")
+            # Use files from DEPS target or command line.
+            sdc_files = self.files_sdc
+        else:
+            default_sdc = True
+            sdc_file = self.args['top'] + '.sdc'
+            sdc_files = [sdc_file]
+
+        for f in sdc_files:
+            for attr in ('SDC_FILE', 'SYN_SDC_FILE', 'RTL_SDC_FILE'):
+                tcl_lines.extend([
+                    f"set_global_assignment -name {attr} \"{f}\""
+                ])
+        tcl_lines.append("set_global_assignment -name SYNTH_TIMING_DRIVEN_SYNTHESIS ON")
+
+        if default_sdc:
+            self.write_default_sdc(sdc_file=os.path.join(self.args['work-dir'], sdc_file))
 
         tcl_lines += [
             "# Run synthesis",
@@ -237,6 +272,25 @@ class CommandSynthQuartus(CommandSynth, ToolQuartus):
             ftcl.write('\n'.join(tcl_lines))
 
 
+    def write_default_sdc(self, sdc_file: str) -> None:
+        '''Writes a default SDC file to filepath 'sdc_file'.'''
+
+        sdc_lines = []
+        util.info("Creating default constraints: clock:",
+                  f"{self.args['clock-name']}, {self.args['clock-ns']} (ns),")
+
+        clock_name = self.args['clock-name']
+        period = self.args['clock-ns']
+
+        sdc_lines += [
+            ("create_clock -name {" + clock_name + "} -period {" + str(period) + "} [get_ports "
+             "{" + clock_name + "}]")
+        ]
+
+        with open( sdc_file, 'w', encoding='utf-8' ) as fsdc:
+            fsdc.write('\n'.join(sdc_lines))
+
+
 class CommandBuildQuartus(CommandBuild, ToolQuartus):
     '''CommandBuildQuartus is a command handler for: eda build --tool=quartus'''
 
@@ -371,7 +425,8 @@ class CommandBuildQuartus(CommandBuild, ToolQuartus):
         util.write_shell_command_file(dirpath=self.args['work-dir'], filename='run_quartus_gui.sh',
                                       command_lists=[
                                           command_list_gui,
-                                          ['quartus', saved_qpf_filename], # reopen when done.
+                                          # reopen when done.
+                                          [self.quartus_gui_exe, saved_qpf_filename],
                                       ], line_breaks=True)
 
         # Add artifact tracking for build
@@ -422,7 +477,7 @@ class CommandBuildQuartus(CommandBuild, ToolQuartus):
         if self.args['gui'] and self.quartus_gui_exe:
             self.exec(
                 work_dir=self.args['work-dir'],
-                command_list=['quartus', saved_qpf_filename]
+                command_list=[self.quartus_gui_exe, saved_qpf_filename]
             )
 
 

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/questa.py

@@ -267,7 +267,21 @@ class CommandFListQuesta(CommandFList, ToolQuesta):
 class CommandElabQuesta(CommandSimQuesta):
     '''Command handler for: eda elab --tool=questa'''
 
+    command_name = 'elab'
+
+    def __init__(self, config:dict):
+        CommandSimQuesta.__init__(self, config)
+        # add args specific to this simulator
+        self.args['stop-after-elaborate'] = True
+
+
+class CommandLintQuesta(CommandSimQuesta):
+    '''Command handler for: eda lint --tool=questa'''
+
+    command_name = 'lint'
+
     def __init__(self, config:dict):
         CommandSimQuesta.__init__(self, config)
         # add args specific to this simulator
+        self.args['stop-after-compile'] = True
         self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/questa_fse.py

@@ -56,8 +56,21 @@ class CommandSimQuestaFse(CommandSimModelsimAse):
 class CommandElabQuestaFse(CommandSimQuestaFse):
     '''CommandElabQuestaFse is a command handler for: eda elab --tool=questa_fse'''
 
+    command_name = 'elab'
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True
+
+
+class CommandLintQuestaFse(CommandSimQuestaFse):
+    '''CommandLintQuestaFse is a command handler for: eda lint --tool=questa_fse'''
+
+    command_name = 'lint'
+
     def __init__(self, config:dict):
         super().__init__(config)
+        self.args['stop-after-compile'] = True
         self.args['stop-after-elaborate'] = True
 
 

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/riviera.py

@@ -289,6 +289,19 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
 class CommandElabRiviera(CommandSimRiviera):
     '''CommandElabRiviera is a command handler for: eda elab --tool=riviera'''
 
+    command_name = 'elab'
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True
+
+
+class CommandLintRiviera(CommandSimRiviera):
+    '''CommandLintRiviera is a command handler for: eda lint --tool=riviera'''
+
+    command_name = 'lint'
+
     def __init__(self, config:dict):
         super().__init__(config)
+        self.args['stop-after-compile'] = True
         self.args['stop-after-elaborate'] = True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/slang.py

@@ -115,7 +115,7 @@ class CommandElabSlang(CommandElab, ToolSlang):
         pass
 
     def elaborate(self):
-        ''' elaborate() - following parent Commandsim's run() flow, runs slang_command_lists'''
+        ''' elaborate() - following parent CommandSim's run() flow, runs slang_command_lists'''
         if self.args['stop-before-compile'] or \
            self.args['stop-after-compile']:
             return
@@ -208,3 +208,14 @@ class CommandElabSlang(CommandElab, ToolSlang):
                         )
 
         return command_list
+
+
+class CommandLintSlang(CommandElabSlang):
+    '''CommandLintSlang is a command handler for: eda lint --tool=slang.'''
+
+    command_name = 'lint'
+
+    def __init__(self, config: dict):
+        super().__init__(config)
+        # keep stop-after-compile=False, allow's CommandElabSlang.elaborate() to run.
+        self.args['slang-args'] = ['--lint-only', '--ignore-unknown-modules']

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/surelog.py

@@ -63,6 +63,7 @@ class CommandElabSurelog(CommandElab, ToolSurelog):
         ToolSurelog.__init__(self, config=self.config)
         self.args.update({
             'surelog-top': '',
+            'surelog-args': [],
         })
 
         self.surelog_command_lists = []
@@ -98,6 +99,7 @@ class CommandElabSurelog(CommandElab, ToolSurelog):
             'compile-args',
             '-parse').split()
         command_list += config_compile_args
+        command_list += self.args['surelog-args']
 
         if util.args.get('debug', None) or \
            util.args.get('verbose', None):
@@ -139,3 +141,14 @@ class CommandElabSurelog(CommandElab, ToolSurelog):
             dirpath=self.args['work-dir'], filename='run_surelog.sh',
             command_lists=self.surelog_command_lists, line_breaks=True
         )
+
+
+class CommandLintSurelog(CommandElabSurelog):
+    '''CommandLintSurelog is a command handler for: eda lint --tool=surelog.'''
+    command_name = 'lint'
+
+    def __init__(self, config: dict):
+        super().__init__(config)
+        # keep stop-after-compile=False, allow's CommandElabSurelog.elaborate() to run.
+        # run the "compile" step only for surelog by setting -noelab:
+        self.args['surelog-args'] = ['-noelab']

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/verilator.py

@@ -499,8 +499,22 @@ class VerilatorSim(CommandSim, ToolVerilator):
 
 class VerilatorElab(VerilatorSim):
     '''VerilatorElab is a command handler for: eda elab --tool=verilator'''
+    command_name = 'elab'
 
     def __init__(self, config: dict):
         super().__init__(config)
         self.args['stop-after-elaborate'] = True
         self.args['lint-only'] = True
+
+
+class VerilatorLint(VerilatorSim):
+    '''VerilatorLint is a command handler for: eda lint --tool=verilator.
+
+    For practical reasons, this is identical to VerilatorElab with --stop-after-compile.'''
+    command_name = 'lint'
+
+    def __init__(self, config: dict):
+        super().__init__(config)
+        self.args['stop-after-compile'] = True
+        self.args['stop-after-elaborate'] = True
+        self.args['lint-only'] = True

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/vivado.py

@@ -347,12 +347,23 @@ class CommandSimVivado(CommandSim, ToolVivado):
 
 class CommandElabVivado(CommandSimVivado):
     '''CommandElabVivado is a command handler for: eda elab --tool=vivado, uses xvlog, xelab'''
+    command_name = 'elab'
     def __init__(self, config: dict):
         CommandSimVivado.__init__(self, config)
         # add args specific to this tool
         self.args['stop-after-elaborate'] = True
 
 
+class CommandLintVivado(CommandSimVivado):
+    '''CommandLintVivado is a command handler for: eda lint --tool=vivado, uses xvlog'''
+    command_name = 'lint'
+    def __init__(self, config: dict):
+        CommandSimVivado.__init__(self, config)
+        # add args specific to this tool
+        self.args['stop-after-compile'] = True
+        self.args['stop-after-elaborate'] = True
+
+
 class CommandSynthVivado(CommandSynth, ToolVivado):
     '''CommandSynthVivado is a command handler for: eda synth --tool=vivado'''
     def __init__(self, config: dict):

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/tools/yosys.py

@@ -219,6 +219,9 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
         if not self.args['sta-scriptfile']:
             return []
 
+        # Add URL info for OpenSTA source code:
+        self._add_opensta_info()
+
         ret_list = []
         for i,fpath in enumerate(self.args['sta-scriptfile']):
             if not os.path.isfile(fpath):
@@ -377,6 +380,9 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
         if not self.sta_exe:
             self.error(f'--sta is set, but "sta" was not found in PATH, see: {self._URL}')
 
+        # Add URL info for OpenSTA source code:
+        self._add_opensta_info()
+
         sta_command_list = util.ShellCommandList(
             [ self.sta_exe, '-no_init', '-exit', 'sta.f' ],
             tee_fpath = 'sta.log'
@@ -439,6 +445,15 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
             ]
             f.write('\n'.join(lines))
 
+    def _add_opensta_info(self) -> None:
+        '''Adds OpenSTA URL information to artifacts and logs'''
+
+        opensta_repo_url = 'https://github.com/The-OpenROAD-Project/OpenSTA'
+
+        # Log GPL3.0 license information
+        util.info(f'Using OpenSTA (see URL for license and source): {opensta_repo_url}')
+        if hasattr(self, 'sta_version') and self.sta_version:
+            util.info(f'OpenSTA version: {self.sta_version}')
 
     def _get_read_verilog_one_liner(self) -> str:
         '''Returns a string, intended to be used w/out Slang, for Verilog or simple

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/util.py

@@ -1,5 +1,7 @@
 '''opencos.util -- support global logging, argparser for printing (colors)'''
 
+# pylint: disable=too-many-lines
+
 import argparse
 import atexit
 import datetime
@@ -89,6 +91,7 @@ class ArtifactTypes(Enum):
     TCL = 5
     SHELL = 6
     BITSTREAM = 7
+    LICENSE = 8
 
 class Artifacts:
     '''Class to hold file artifacts, for logs generated by EDA, or other artifcats created
@@ -198,7 +201,10 @@ class Artifacts:
         # Update all file sizes:
         remove_keys = set()
         for key, entry in self.data.items():
-            if os.path.isfile(entry['name']):
+            if entry['type'] == 'license':
+                # License entries are metadata, not files - keep them as-is
+                entry['size'] = 0
+            elif os.path.isfile(entry['name']):
                 entry['size'] = os.path.getsize(entry['name'])
             else:
                 # file doesn't exist, remove it from artifacts.

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos/utils/str_helpers.py

@@ -7,14 +7,18 @@ import shlex
 import textwrap
 
 VALID_TARGET_INFO_STR = (
-    "should start with an underscore/letter, rest should be alpha-numeric, dashes, or underscores."
+    "should start with a . or underscore/letter, rest should be"
+    " ., alpha-numeric, dashes, or underscores."
 )
 
 def is_valid_target_name(s: str) -> bool:
-    '''Returns True if str starts with underscore/letter, rest  alphanum, dash, or underscores'''
-    if not s or not (s[0].isalpha() or s[0] == '_'):
+    '''Returns True if str starts with . or underscore/letter, rest alphanum, dash, dot,
+
+    or underscores. We allow '.' otherwise deps_file.py posts warnings about badly named
+    targets for files that are missing.'''
+    if not s or not (s[0].isalpha() or s[0] == '_' or s[0] == '.'):
         return False
-    return s.replace('_', '').replace('-', '').isalnum()
+    return s.replace('_', '').replace('-', '').replace('.', '').isalnum()
 
 def strip_all_quotes(s: str) -> str:
     '''Returns str with all ' and " removed'''

{opencos_eda-0.2.54 → opencos_eda-0.2.55/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.54
+Version: 0.2.55
 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
@@ -15,5 +15,5 @@ Requires-Dist: schema>=0.7.7
 Requires-Dist: toml>=0.10.2
 Requires-Dist: yamllint>=1.35.1
 Requires-Dist: PySerial>=3.5
-Requires-Dist: cocotb>=2.0.0b1
+Requires-Dist: cocotb>=2.0
 Dynamic: license-file

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos_eda.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ opencos/commands/elab.py
 opencos/commands/export.py
 opencos/commands/flist.py
 opencos/commands/lec.py
+opencos/commands/lint.py
 opencos/commands/multi.py
 opencos/commands/open.py
 opencos/commands/proj.py

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/opencos_eda.egg-info/requires.txt

@@ -6,4 +6,4 @@ schema>=0.7.7
 toml>=0.10.2
 yamllint>=1.35.1
 PySerial>=3.5
-cocotb>=2.0.0b1
+cocotb>=2.0

{opencos_eda-0.2.54 → opencos_eda-0.2.55}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.2.54"
+version = "0.2.55"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",
@@ -14,7 +14,7 @@ dependencies = [
   "yamllint >= 1.35.1",
   # opencos/oc_cli.py dependencies
   "PySerial >= 3.5",
-  "cocotb >= 2.0.0b1", # TODO: change to 2.0 when released as beta versions are considered less than the final release version
+  "cocotb >= 2.0",
 ]
 requires-python = ">= 3.8"
 authors = [