opencos-eda 0.2.54__py3-none-any.whl → 0.2.56__py3-none-any.whl

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/export_helper.py

@@ -387,6 +387,13 @@ class ExportHelper:
         paths.
         '''
 
+        # We'll copy files_sv and files_v later, along with discovered included files,
+        # need to copy any others:
+        remaing_files_to_cp = []
+        for x in self.cmd_design_obj.files.keys():
+            if x not in self.cmd_design_obj.files_v + self.cmd_design_obj.files_sv:
+                remaing_files_to_cp.append(x)
+
         # Also sets our list of included files.
         self.included_files = get_list_sv_included_files(
             all_src_files=self.cmd_design_obj.files_sv + self.cmd_design_obj.files_v,
@@ -398,7 +405,8 @@ class ExportHelper:
 
         info(f"export_helper: {self.target=} included files {self.included_files=}")
 
-        for filename in self.cmd_design_obj.files_non_source:
+
+        for filename in remaing_files_to_cp:
             dst = os.path.join(self.out_dir, os.path.split(filename)[1])
             if not os.path.exists(dst):
                 shutil.copy(src=filename, dst=dst)
@@ -415,11 +423,13 @@ class ExportHelper:
 
         info(f'export_helper: Creating DEPS.yml for {self.target=} in {self.out_dir=}')
 
-        # Need to strip path information from our files_sv and files_v:
+        # Need to strip path information from our files_sv and files_v
+        # (and all source files: cpp, sdc, etc; but skip the non-source files):
         deps_files = []
-        for fullpath in self.cmd_design_obj.files_sv + self.cmd_design_obj.files_v:
-            filename = os.path.split(fullpath)[1]
-            deps_files.append(filename)
+        for fullpath in self.cmd_design_obj.files.keys():
+            if fullpath not in self.cmd_design_obj.files_non_source:
+                filename = os.path.split(fullpath)[1]
+                deps_files.append(filename)
 
 
         data = {

opencos/hw/oc_cli.py

@@ -2508,7 +2508,7 @@ name_tables = { 'OC_VENDOR' : {},
                }
 
 def parse_names():
-    name_tables.update(opencos_names.table) #update our global name_table from names.py
+    name_tables.update(opencos_names.NAMES) #update our global name_table from names.py
 
 def lookup_table_string(table, index):
     if isinstance(table, str) and table in name_tables:

opencos/names.py

@@ -13,11 +13,12 @@ just needs to set a couple of these statically.
 all values in this file are in hex.
 '''
 
-table = {
+NAMES = {
 
     'OC_VENDOR': {
         0: "None",
         1: "Xilinx",
+        2: "Altera",
     },
 
     'OC_BOARD': {
@@ -28,11 +29,13 @@ table = {
         4: "U55N",
         5: "U50C",
         6: "PYNQ-Z2",
+        7: "AG3C_DEVKIT",
     },
 
     'OC_LIBRARY': {
         0: "None",
         1: "Ultrascale+",
+        2: "Agilex3"
     },
 
     'PLL_TYPES': {

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/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/tests/test_eda_synth.py

@@ -8,6 +8,7 @@ import pytest
 from opencos import eda, eda_tool_helper
 from opencos.tests import helpers
 from opencos.tests.helpers import Helpers
+from opencos.utils.markup_helpers import yaml_safe_load
 
 
 THISPATH = os.path.dirname(__file__)
@@ -108,6 +109,17 @@ class TestsSlangYosys(Helpers):
         rc = self.log_it(cmd_str, use_eda_wrap=False)
         assert rc == 0
 
+        # Since vanilla yosys won't use the SDC file, let's at least confirm
+        # that EDA used it and tracked it:
+        eda_config_yml_path = os.path.join(
+            os.getcwd(), 'eda.work', 'oclib_fifo_with_sdc.synth', 'eda_output_config.yml'
+        )
+        data = yaml_safe_load(eda_config_yml_path)
+        assert 'files_sdc' in data
+        assert data['files_sdc']
+        assert data['files_sdc'][0].endswith('oclib_fifo_yosys.sdc')
+
+
 @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):

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/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:
@@ -60,6 +61,12 @@ def write_py_file(
         'from invio import init, define_macro, add_include_directory, \\',
         '    add_verilog_file, add_sv_file, elaborate, elaborate_pct, analyze, \\',
         '    print_instance_hierarchy, write_design, report_analyzed_files',
+    ]
+    if command_design_obj.parameters:
+        lines += [
+            'from invio import get_parameters, report_parameters, replace_expression_of_parameter'
+        ]
+    lines += [
         'import os, shutil',
         '',
         'for p in ["invio"]:',
@@ -137,10 +144,34 @@ def write_py_file(
                                             tee_fpath = 'invio.log')]
     })
 
-    if sim_elab:
+    lines += [
+        'assert analyze()',
+    ]
+
+    if command_design_obj.parameters:
+        lines += [
+            '',
+            f'new_parameters = {command_design_obj.parameters}',
+            'for x in get_parameters():',
+            '    name_parts = x.full_name.split("::")',
+            '    mod, pname = name_parts[-2], name_parts[-1]',
+            f'    if pname in new_parameters and mod == "{top}":',
+            '        new_value = str(new_parameters[pname]) # invio needs str type for all',
+            '        print(f"PARAMETER UPDATE: {mod}.{pname} ---> {new_value}")',
+            '        replace_expression_of_parameter(x, new_value)',
+            'report_parameters()',
+            '',
+        ]
+
+    if sim_lint:
+        # lint (skip elaborate steps -- from eda.CommandLintInvio)
+        lines += [
+            'report_analyzed_files()',
+            'print_instance_hierarchy()',
+        ]
+    elif sim_elab:
         # elab (non-synthesis), runs the following (from eda.CommandElabInvio)
         lines += [
-            'assert analyze()',
             f"assert elaborate('{top}', pct_elaboration=True, forceBlackbox={blackbox_list})",
             'assert elaborate_pct()',
             '',
@@ -150,7 +181,6 @@ def write_py_file(
     else:
         # synthesis-style elab (from eda.CommandElabInvioYosys)
         lines += [
-            'assert analyze()',
             f"assert elaborate('{top}', rtl_elaboration=True, forceBlackbox={blackbox_list})",
             '',
             'report_analyzed_files()',
@@ -206,14 +236,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/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/tools/iverilog.py

@@ -136,6 +136,11 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
                 # +define+{k}={v}, but also for SystemVerilog plusargs
                 command_list += [ '-D', f'{k}={sanitize_defines_for_sh(v)}' ]
 
+        # parameters
+        command_list.extend(
+            self.process_parameters_get_list(arg_prefix=f'-P{self.args["top"]}.')
+        )
+
         if not self.files_sv and not self.files_v:
             if not self.args['stop-before-compile']:
                 self.error(f'{self.target=} {self.files_sv=} and {self.files_v=} are empty,',
@@ -164,6 +169,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/tools/modelsim_ase.py

@@ -94,7 +94,8 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             return
         if self.args['stop-after-compile']:
             vsim_command_lists = self.get_compile_command_lists()
-            self.run_commands_check_logs(vsim_command_lists, log_filename='sim.log')
+            self.run_commands_check_logs(vsim_command_lists, log_filename='sim.log',
+                                         must_strings=['Errors: 0'], use_must_strings=False)
 
     def elaborate(self):
         if self.args['stop-before-compile']:
@@ -222,6 +223,10 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
                 typ='waveform', description='Modelsim/Questa Waveform WLF (Wave Log Format) file'
             )
 
+        # parameters
+        if self.parameters:
+            voptargs_str += ' ' + ' '.join(self.process_parameters_get_list(arg_prefix='-G'))
+
         # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
         # to add to vsim_one_liner.
 
@@ -369,6 +374,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