opencos-eda 0.2.48__py3-none-any.whl → 0.2.50__py3-none-any.whl

opencos/tools/modelsim_ase.py

@@ -1,6 +1,8 @@
 ''' opencos.tools.modelsim_ase - Used by opencos.eda for sim/elab commands w/ --tool=modelsim_ase.
 
 Contains classes for ToolModelsimAse, CommandSimModelsimAse, CommandElabModelsimAse.
+
+Note that this is for 32-bit Modelsim Student Edition. Consider using --tool=questa_fse instead.
 '''
 
 # pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
@@ -8,9 +10,9 @@ Contains classes for ToolModelsimAse, CommandSimModelsimAse, CommandElabModelsim
 import os
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.commands import CommandSim
 from opencos.tools.questa import ToolQuesta
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolModelsimAse(ToolQuesta):
     '''ToolModelsimAse used by opencos.eda for --tool=modelsim_ase'''
@@ -77,7 +79,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             command_lists = [['./pre_compile_dep_shell_commands.sh']] + vsim_command_lists
         )
 
-        util.write_eda_config_and_args(dirpath=self.args['work-dir'], command_obj_ref=self)
+        self.write_eda_config_and_args()
 
     def compile(self):
         if self.args['stop-before-compile']:
@@ -151,6 +153,9 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
                 ]):
             vlog_dot_f_lines += ['-suppress', str(waiver)]
 
+        if self.args['gui'] or self.args['waves']:
+            vlog_dot_f_lines += self.tool_config.get('compile-waves-args', '').split()
+
         vlog_dot_f_fname = filename
         vlog_dot_f_fpath = os.path.join(self.args['work-dir'], vlog_dot_f_fname)
 
@@ -203,6 +208,10 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         voptargs_str = ""
         if self.args['gui'] or self.args['waves']:
             voptargs_str = self.tool_config.get('simulate-waves-args', '+acc')
+            util.artifacts.add_extension(
+                search_paths=self.args['work-dir'], file_extension='wlf',
+                typ='waveform', description='Modelsim/Questa Waveform WLF (Wave Log Format) file'
+            )
 
         # TODO(drew): support self.args['sim_libary', 'elab-args', sim-args'] (3 lists)
         # to add to vsim_one_liner.
@@ -331,6 +340,19 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
         return ' '.join(vsim_suppress_list)
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'sim.log':
+            description = 'Modelsim/Questa Transcript log file'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class CommandElabModelsimAse(CommandSimModelsimAse):
     '''CommandElabModelsimAse is a command handler for: eda elab --tool=modelsim_ase'''
 

opencos/tools/questa.py

@@ -40,9 +40,11 @@ class ToolQuesta(Tool):
             self.error(f"{self._EXE} not in path, need to setup",
                        "(i.e. source /opt/intelFPGA_pro/23.4/settings64.sh")
             util.debug(f"{path=}")
-            if self._EXE.endswith('qrun') and 'modelsim_ase' in path:
-                util.warning(f"{self._EXE=} Questa path is for starter edition (modelsim_ase),",
-                             "consider using --tool modelsim_ase")
+            if self._EXE.endswith('qrun') and \
+               any(x in path for x in ('modelsim_ase', 'questa_fse')):
+                util.warning(f"{self._EXE=} Questa path is for starter edition",
+                             "(modelsim_ase, questa_fse), consider using --tool=modelsim_ase",
+                             "or --tool=questa_fse")
         else:
             self.sim_exe = path
             self.sim_exe_base_path, _ = os.path.split(path)

opencos/tools/questa_fse.py

@@ -0,0 +1,57 @@
+''' opencos.tools.questa_fse - Used by opencos.eda for sim/elab commands w/ --tool=questa_fse.
+
+Contains classes for CommandSimQuestaFse, CommandElabQuestaFse.
+'''
+
+# pylint: disable=R0801 # (duplicate code in derived classes, such as if-condition return.)
+# pylint: disable=too-many-ancestors
+
+import os
+
+from opencos.tools.modelsim_ase import CommandSimModelsimAse
+
+
+class CommandSimQuestaFse(CommandSimModelsimAse):
+    '''CommandSimQuestaFse is a command handler for: eda sim --tool=questa_fse
+
+    Note this inherits 99% from CommandSimModelSimAse for command handling
+    '''
+    _TOOL = 'questa_fse'
+    _EXE = 'vsim'
+
+    def __init__(self, config: dict):
+        # this will setup with self._TOOL = modelsim_ase, which is not ideal so
+        # we have to repait it later.
+        CommandSimModelsimAse.__init__(self, config=config)
+
+        # repairs: override self._TOOL, and run get_versions() again.
+        self._TOOL = 'questa_fse'
+
+        self.shell_command = os.path.join(self.sim_exe_base_path, 'vsim')
+        self.starter_edition = True
+        self.args.update({
+            'tool': self._TOOL, # override
+            'gui': False,
+        })
+
+
+    def set_tool_defines(self):
+        '''Override from questa.ToolQuesta'''
+        # Update any defines from config.tools.questa_fse:
+        self.defines.update(
+            self.tool_config.get(
+                'defines',
+                # defaults, if not set:
+                {
+                 'OC_TOOL_QUESTA_FSE': 1
+                }
+            )
+        )
+
+
+class CommandElabQuestaFse(CommandSimQuestaFse):
+    '''CommandElabQuestaFse is a command handler for: eda elab --tool=questa_fse'''
+
+    def __init__(self, config:dict):
+        super().__init__(config)
+        self.args['stop-after-elaborate'] = True

opencos/tools/riviera.py

@@ -11,8 +11,8 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.tools.modelsim_ase import ToolModelsimAse, CommandSimModelsimAse
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolRiviera(ToolModelsimAse):
     '''ToolRiviera used by opencos.eda for --tool=riviera'''

opencos/tools/slang.py

@@ -10,9 +10,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandElab
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
 class ToolSlang(Tool):
@@ -191,14 +191,20 @@ class CommandElabSlang(CommandElab, ToolSlang):
 
         return command_list
 
-    def _get_slang_json_args(self, command_exe:str) -> list:
+    def _get_slang_json_args(self, command_exe: str) -> list:
         command_list = []
 
-        if self.args.get('slang-json', False) and command_exe == 'slang':
+        _, command_exe_leaf = os.path.split(command_exe)
+        if self.args.get('slang-json', False) and command_exe_leaf == 'slang':
             for arg in self.all_json_args:
                 if arg not in command_list:
                     command_list.append(arg)
                     if arg == '--ast-json': # needs filename
                         command_list.append('slang.json')
+                        util.artifacts.add(
+                            name=os.path.join(self.args['work-dir'], 'slang.json'),
+                            typ='json',
+                            description='Abstract syntax tree from slang --ast-json'
+                        )
 
         return command_list

opencos/tools/surelog.py

@@ -7,9 +7,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandElab
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
 class ToolSurelog(Tool):

opencos/tools/verilator.py

@@ -10,9 +10,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandSim
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolVerilator(Tool):
     '''ToolVerilator used by opencos.eda for --tool=verilator'''
@@ -346,6 +346,16 @@ class VerilatorSim(CommandSim, ToolVerilator):
             util.info(f'--waves arg present, no $dumpfile found, adding SV file: {file_to_add}')
             self.add_file(file_to_add)
 
+        # register .vcd or .fst artifacts:
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='fst',
+            typ='waveform', description='Simulation Waveform FST (Fast Signal Trace) file'
+        )
+        util.artifacts.add_extension(
+            search_paths=self.args['work-dir'], file_extension='vcd',
+            typ='waveform', description='Simulation Waveform VCD (Value Change Dump) file'
+        )
+
 
     def _get_start_verilator_command_list(self, lint_only: bool = False) -> list:
 
@@ -447,6 +457,21 @@ class VerilatorSim(CommandSim, ToolVerilator):
         return verilate_args
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log or compile.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'sim.log':
+            description = 'Verilated executable log from stdout/stderr'
+        elif leafname == 'compile.log':
+            description = 'Verilator compile step log from verilator call'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class VerilatorElab(VerilatorSim):
     '''VerilatorElab is a command handler for: eda elab --tool=verilator'''
 

opencos/tools/vivado.py

@@ -63,29 +63,14 @@ class ToolVivado(Tool):
             util.info("environment for XILINX_VIVADO is not set or doesn't match the vivado path:",
                       f"XILINX_VIVADO={xilinx_vivado} EXE PATH={self.vivado_exe}")
 
-        version = None
-        # Note this is commented out b/c it's a bit slow, up to 1.0 second to
-        # run their tool just to query the version information.
-        # Do this if you need the extra minor version like 2024.2.1.
-        #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', errors='replace').split('\n')
-        #    words = lines[0].split() # vivado v2024.2.1 (64-bit)
-        #    version = words[1][1:] # 2024.2.1
-        #    self._VERSION = version
-        #except:
-        #    pass
-
-        if not version:
-            # Get version based on install path name:
-            util.debug(f"vivado path = {self.vivado_exe}")
-            m = re.search(r'(\d\d\d\d)\.(\d)', self.vivado_exe)
-            if m:
-                version = m.group(1) + '.' + m.group(2)
-                self._VERSION = version
-            else:
-                self.error("Vivado path doesn't specificy version, expecting (dddd.d)")
+        # Get version based on install path name. Calling vivado -verison is too slow.
+        util.debug(f"vivado path = {self.vivado_exe}")
+        m = re.search(r'(\d\d\d\d)\.(\d)', self.vivado_exe)
+        if m:
+            version = m.group(1) + '.' + m.group(2)
+            self._VERSION = version
+        else:
+            self.error("Vivado path doesn't specificy version, expecting (dddd.d)")
 
         if version:
             numbers_list = version.split('.')
@@ -182,7 +167,7 @@ class CommandSimVivado(CommandSim, ToolVivado):
                                           ['./simulate.sh'],
                                       ])
 
-        util.write_eda_config_and_args(dirpath=self.args['work-dir'], command_obj_ref=self)
+        self.write_eda_config_and_args()
 
     def compile(self):
         if self.args['stop-before-compile']:
@@ -260,6 +245,14 @@ class CommandSimVivado(CommandSim, ToolVivado):
     def get_simulate_command_lists(self, **kwargs) -> list:
         # create TCL
         tcl_name = os.path.abspath(os.path.join(self.args['work-dir'], self.args['tcl-file']))
+
+        if self.args['waves']:
+            util.artifacts.add_extension(
+                search_paths=self.args['work-dir'], file_extension='wdb',
+                typ='waveform', description='Vivado XSim Waveform WDB (Wave DataBase) file'
+            )
+
+
         with open( tcl_name, 'w', encoding='utf-8' ) as fo:
             if self.args['waves']:
                 if self.args['waves-start']:
@@ -345,6 +338,23 @@ class CommandSimVivado(CommandSim, ToolVivado):
             self.files_v.insert(0, glbl_v)
 
 
+    def artifacts_add(self, name: str, typ: str, description: str) -> None:
+        '''Override from Command.artifacts_add, so we can catch known file
+
+        names to make their typ/description better, such as CommandSim using
+        sim.log or compile.log
+        '''
+        _, leafname = os.path.split(name)
+        if leafname == 'xsim.log':
+            description = 'Vivado XSim simulation step (3/3) log from stdout/stderr'
+        elif leafname == 'xelab.log':
+            description = 'Vivado XSim elaboration step (2/3) log from stdout/stderr'
+        elif leafname == 'xvlog.log':
+            description = 'Vivado XSim compile step (1/3) log from stdout/stderr'
+
+        super().artifacts_add(name=name, typ=typ, description=description)
+
+
 class CommandElabVivado(CommandSimVivado):
     '''CommandElabVivado is a command handler for: eda elab --tool=vivado, uses xvlog, xelab'''
     def __init__(self, config: dict):
@@ -933,9 +943,6 @@ class CommandUploadVivado(CommandUpload, ToolVivado):
         util.info("Upload done")
 
 
-
-
-
 class CommandOpenVivado(CommandOpen, ToolVivado):
     '''CommandOpenVivado command handler class used by: eda open --tool vivado'''
     def __init__(self, config: dict):

opencos/tools/yosys.py

@@ -9,9 +9,10 @@ import os
 import shutil
 import subprocess
 
-from opencos import util
+from opencos import util, eda_config
 from opencos.eda_base import Tool, get_eda_exec
 from opencos.commands import CommandSynth, CommandLec
+from opencos.utils.markup_helpers import yaml_safe_load
 
 
 def get_commands_to_run_scriptfiles(
@@ -543,8 +544,8 @@ class CommandLecYosys(CommandLec, ToolYosys):
         '''Returns the top name given the design number that we synthesized'''
 
         work_dir = self.synth_work_dirs[design_num]
-        output_cfg_fpath = os.path.join(work_dir, util.EDA_OUTPUT_CONFIG_FNAME)
-        data = util.yaml_safe_load(output_cfg_fpath)
+        output_cfg_fpath = os.path.join(work_dir, eda_config.EDA_OUTPUT_CONFIG_FNAME)
+        data = yaml_safe_load(output_cfg_fpath)
         top = data.get('args', {}).get('top', '')
         if not top:
             self.error(f'"top" not found in synth run from {work_dir=} in',