opencos-eda 0.3.13__tar.gz → 0.3.14__tar.gz

{opencos_eda-0.3.13/opencos_eda.egg-info → opencos_eda-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.13
+Version: 0.3.14
 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.3.13 → opencos_eda-0.3.14}/opencos/commands/sim.py

@@ -14,6 +14,8 @@ Note that CommandSim is also a base class for opencos.commands.elab.CommandElab.
 import os
 import shlex
 
+from pathlib import Path
+
 from opencos import util, export_helper
 from opencos.eda_base import CommandDesign, Tool
 from opencos.utils import status_constants
@@ -84,6 +86,7 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
     error_on_no_files_or_targets = True
     error_on_missing_top = True
     tool_config = {} # Children with Tool parent classes will set on Tool constructor.
+    library_map_supported = False
 
     command_name = 'sim'
 
@@ -114,6 +117,8 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
             'verilate-args': [],
             'ext-defines-sv-fname': '',
             'license-queue': False,
+            'library-map': [],
+            'add-top-library': [],
         })
         self.args_help.update({
             'pre-sim-tcl': (
@@ -168,6 +173,17 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
             'license-queue': (
                 'Set to enable env vars LICENSE_QUEUE=1 which has effects on certain simulators'
             ),
+            'library-map': (
+                'list arg (can set multiple) with values LibName:Path, only supported'
+                ' by certain simulation tools.'
+                ' The Path search is relative to the tool exe, one level above the tool exe,'
+                ' or can be absolute path.'
+            ),
+            'add-top-library': (
+                'Add additional top levels, for example if you added the "unisim" library'
+                ' you may need to --add-top-library=unisim.glbl for it to work with Xilinx'
+                ' based projects that require "glbl" to be present at simulation $root scope.'
+            ),
 
         })
 
@@ -175,6 +191,9 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
             'uvm-version': { 'choices': ['1.2'] },
         })
 
+        # only used if self.library_map_supported=True:
+        self.library_map = {} # lib-name: path-to.lib dict from self.args['library-map']
+
 
 
     def process_parameters_get_list(
@@ -425,7 +444,7 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
             cmds2 = self.get_simulate_command_lists()
             cmds3 = self.get_post_simulate_command_lists()
         '''
-        return
+        self.update_library_map()
 
 
     def check_logs_for_errors( # pylint: disable=dangerous-default-value,too-many-locals,too-many-branches
@@ -686,3 +705,54 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
 
         if 'LICENSE_QUEUE' not in os.environ:
             os.environ['LICENSE_QUEUE'] = '1'
+
+    def update_library_map(self, base_search_paths: list | None = None) -> None:
+        '''
+        Returns None, uses self.args['library-map'] to update:
+
+        - self.library_map (dict)
+        - self.args['sim-library']
+        '''
+        if not self.args['library-map']:
+            return
+
+        if not self.library_map_supported:
+            tool = self.config.get('tool', None)
+            util.warning(f'Command: sim, --tool={tool}, args for --library-map are not supported:',
+                         f'{self.args["library-map"]}')
+            return
+
+        for libmap in self.args['library-map']:
+            parts = libmap.split(':')
+            lib_name = parts[0]
+            lib_path = Path(':'.join(parts[1:]))
+            lib_abs_path = None
+
+            if not lib_name or not lib_path:
+                util.warning(f'library-map={libmap} could not parse {lib_name=} or {lib_path=}')
+                continue
+
+            if lib_name in self.library_map:
+                util.warning(
+                    f'We have already mapped "{lib_name}" to {self.library_map[lib_name]}'
+                )
+
+            # We have to go looking for lib_path though
+            search_files = [lib_path]
+            if base_search_paths and isinstance(base_search_paths, list):
+                for x in base_search_paths:
+                    search_files.append(Path(x) / lib_path)
+            for x in search_files:
+                if x.exists():
+                    lib_abs_path = x.resolve()
+                    util.info(f'library-map={libmap} found "{lib_name}" in: {lib_abs_path}')
+                    break
+                util.debug(f'library-map={libmap} searching for "{lib_name}" in: {x}')
+
+
+            if lib_abs_path:
+                self.library_map[lib_name] = lib_abs_path
+                if lib_name not in self.args['sim-library']:
+                    self.args['sim-library'].append(lib_name)
+            else:
+                util.warning(f'library-map={libmap}, for "{lib_name}" could not find {lib_path=}')

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/eda_config_defaults.yml

@@ -412,7 +412,8 @@ tools:
       -acdb -acdb_cov sbfectapm
     simulate-coverage-tcl:
       - acdb save
-      - acdb report -db work.acdb -txt -o cov.txt
+      - acdb report -i work.acdb -txt -o cov.txt
+      - acdb report -i work.acdb -txt -o covg.txt -show covergroups
 
 
   modelsim_ase:

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/iverilog.py

@@ -70,6 +70,7 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
     # We do not override CommandSim.do_it()
     def prepare_compile(self):
         self.set_tool_defines()
+        self.update_library_map()
 
         self.iverilog_command_lists = self.get_compile_command_lists()
         self.iverilog_exec_command_lists  = self.get_simulate_command_lists()

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/questa_common.py

@@ -150,6 +150,7 @@ class CommonSimQuesta(CommandSim, ToolQuesta):
 
     def prepare_compile(self):
         self.set_tool_defines()
+        self.update_library_map()
         self.write_vlog_dot_f()
         self.write_vsim_dot_do(dot_do_to_write='all')
 
@@ -388,6 +389,10 @@ class CommonSimQuesta(CommandSim, ToolQuesta):
                 + f" -sv_seed {self.args['seed']} {sim_plusargs_str} {vsim_suppress_list_str}" \
                 + f" {voptargs_str} {vsim_ext_args} work.{self.args['top']}"
 
+        # If there are additional top level libs, we wont' add them to the vopt step, add
+        # to vsim only (after work.TOP):
+        for l in self.args['add-top-library']:
+            vsim_one_liner += f' {l}'
 
         vsim_one_liner = vsim_one_liner.replace('\n', ' ')
 

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/riviera.py

@@ -9,6 +9,8 @@ Contains classes for ToolRiviera, CommandSimRiviera, CommandElabRiviera.
 import os
 import subprocess
 
+from pathlib import Path
+
 from opencos import util
 from opencos.commands import CommandFList
 from opencos.files import safe_shutil_which
@@ -65,6 +67,8 @@ class ToolRiviera(ToolQuesta):
 class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
     '''CommandSimRiviera is a command handler for: eda sim --tool=riviera'''
 
+    library_map_supported = True
+
     def __init__(self, config: dict):
         CommonSimQuesta.__init__(self, config=config)
 
@@ -190,6 +194,9 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
                 '-dbg'
             ])
 
+        # Note, in Riviera we have to put sim libs in vsim call (with -L) and in vlog (with -l)
+        vlog_dot_f_lines.extend([f'-l {x}' for x in self.args['sim-library']])
+
         for value in self.incdirs:
             vlog_dot_f_lines += [ f"+incdir+{value}" ]
 
@@ -278,7 +285,10 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
                 )
             )
 
-        vsim_libs = ' '.join([f'-l {x}' for x in self.args['sim-library']])
+        # Note, in Riviera we have to put sim libs in vsim call (with -L) and in vlog (with -l)
+        # we previously updated self.args['sim-library'] with self.update_library_map()
+        vmap_lines_str = self.get_vmap_lines_str()
+        vsim_libs = ' '.join([f'-L {x}' for x in self.args['sim-library']])
 
         vsim_one_liner = (
             "vsim"
@@ -286,11 +296,16 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
             f" {voptargs_str} {vsim_ext_args} {vsim_libs} work.{self.args['top']}"
         )
 
+
+        for l in self.args['add-top-library']:
+            vsim_one_liner += f' {l}'
+
         vsim_one_liner = vsim_one_liner.replace('\n', ' ') # needs to be a one-liner
 
         vsim_vlogonly_dot_do_lines = [
             "if {[file exists work]} { vdel -all work; }",
             "vlib work;",
+            vmap_lines_str,
             "if {[catch {vlog -f vlog.f} result]} {",
             "    echo \"Caught $result \";",
             "    if {[batch_mode]} {",
@@ -306,6 +321,7 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
             "if {[file exists work]} { vdel -all work; }",
             "vlib work;",
             "set qc 30;",
+            vmap_lines_str,
             "if {[catch {vlog -f vlog.f} result]} {",
             "    echo \"Caught $result \";",
             "    if {[batch_mode]} {",
@@ -327,6 +343,7 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
             "if {[file exists work]} { vdel -all work; }",
             "vlib work;",
             "set qc 30;",
+            vmap_lines_str,
             "if {[catch {vlog -f vlog.f} result]} {",
             "    echo \"Caught $result \";",
             "    if {[batch_mode]} {",
@@ -407,6 +424,38 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
 
         return ' '.join(vsim_suppress_list)
 
+    def update_library_map(self, base_search_paths: list | None = None) -> None:
+        '''Override from sim::CommandSim
+
+        We add some common places to look relative to the Riviera install paths
+        '''
+        bsp = []
+        if isinstance(base_search_paths, list):
+            bsp += base_search_paths
+        bsp += [
+            Path(self.sim_exe_base_path),
+            Path(self.sim_exe_base_path) / '..',
+            Path(self.sim_exe_base_path) / '..' / 'vlib',
+        ]
+        super().update_library_map(base_search_paths=bsp)
+
+    def get_vmap_lines_str(self) -> str:
+        '''Returns an empty str, or single str in the form:
+
+        vmap -global LibraryName  AbsolutePathToDotLibFile
+        vmap -global LibraryName2 AbsolutePathToAnotherDotLibFile
+        ...
+        uses self.args['library-map'], updates self.args['sim-library']
+        '''
+        if not self.library_map:
+            return ''
+
+        lines = []
+        for lib_name, lib_file_path in self.library_map.items():
+            lines.append(f'vmap -global {lib_name} {lib_file_path}')
+
+        return '\n'.join(lines)
+
 
 class CommandElabRiviera(CommandSimRiviera):
     '''CommandElabRiviera is a command handler for: eda elab --tool=riviera'''

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/verilator.py

@@ -147,6 +147,7 @@ class VerilatorSim(CommandSim, ToolVerilator):
     # We do not override CommandSim.do_it()
     def prepare_compile(self):
         self.set_tool_defines()
+        self.update_library_map()
 
         # If there are C++ files here, then we will run Verilator in --cc mode:
         if self.files_cpp:
@@ -249,6 +250,10 @@ class VerilatorSim(CommandSim, ToolVerilator):
             '-top', self.args['top'],
         ]
 
+        if self.args['add-top-library']:
+            util.warning('--add-top-library: currently not supported in eda --tool=verilator:',
+                         f'{self.args["add-top-library"]}')
+
         if not lint_only:
             verilate_command_list += [
                 '-o', 'sim.exe',

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/vivado.py

@@ -39,7 +39,10 @@ class ToolVivado(Tool):
         })
         self.args_help.update({
             'part': 'Device used for commands: synth, build.',
-            'add-glbl-v': '(for simulation) add glbl.v to filelist',
+            'add-glbl-v': (
+                '(for simulation) add glbl.v to filelist, "glbl" to sim libraries, and "glbl"'
+                ' as an additional top level hier.'
+            ),
         })
 
 
@@ -124,6 +127,8 @@ class CommandSimVivado(CommandSim, ToolVivado):
     Note that we attempt to run a generated .tcl script within vivado, that will perform the
     3-step compile/elaborate/simulate steps'''
 
+    library_map_supported = True
+
     def __init__(self, config: dict):
         CommandSim.__init__(self, config)
         ToolVivado.__init__(self, config=self.config)
@@ -139,7 +144,16 @@ class CommandSimVivado(CommandSim, ToolVivado):
             'gui':        'Run Vivado XSim in GUI mode',
             'tcl-file':   'name of TCL file to be created for XSim',
             'fpga':       'FPGA device name, can be used for various Xilinx IP or XCIs',
-            'add-glbl-v': 'Use the glbl.v in xvlog for this version of Vivado',
+            'add-glbl-v': (
+                'Use the glbl.v in xvlog, xelab for this version of Vivado. Adds glbl.v to'
+                ' filelist(s), and add "glbl" as an additional top level hier to xelab.'
+            ),
+            'library-map': (
+                'list arg (can set multiple) with values LibName:Path, for example:'
+                ' --library-map=unisim:path/to/custom_lib_name.lib'
+                ' The Path search is relative to the tool exe, one level above the tool exe,'
+                ' or can be absolute path.'
+            )
         })
 
         self.sim_libraries = self.tool_config.get('sim-libraries', [])
@@ -165,6 +179,7 @@ class CommandSimVivado(CommandSim, ToolVivado):
 
     def prepare_compile(self):
         self.set_tool_defines()
+        self.update_library_map()
 
         # Don't use the return values, these will set values in self.vivado_tcl:
         self.get_compile_command_lists()
@@ -321,11 +336,13 @@ class CommandSimVivado(CommandSim, ToolVivado):
             command_list += ['-debug', 'wave']
         if util.args['verbose']:
             command_list += ['-v', '2']
-        if self.args['sim-library'] or self.args['add-glbl-v']:
+        if self.args['sim-library']:
             self.sim_libraries += self.args['sim-library'] # Add any command line libraries
-            for x in self.sim_libraries:
-                command_list += ['-L', x]
-            command_list += ['glbl']
+        for x in self.sim_libraries:
+            command_list += ['-L', x]
+        if self.args['add-top-library']:
+            command_list += self.args['add-top-library'] # list
+
         command_list += self.args['elab-args']
 
         # For Windows compatibility, we have some issues with command/Powershell passing args
@@ -447,6 +464,10 @@ class CommandSimVivado(CommandSim, ToolVivado):
         command_list += self.tool_config.get('compile-args', '').split()
         if util.args['verbose']:
             command_list += ['-v', '2']
+
+        # If there were any external .lib files from --library-map args, add those now:
+        command_list.extend(self._get_xvlog_library_map_list())
+
         for value in self.incdirs:
             command_list.append('-i')
             command_list.append(Path(value).as_posix())
@@ -491,13 +512,28 @@ class CommandSimVivado(CommandSim, ToolVivado):
         glbl_v = self.vivado_base_path.replace(
             'bin', os.path.join('data', 'verilog', 'src', 'glbl.v')
         )
-        if any(x.endswith('glbl.v') for x in self.files_v):
+        if any(x and os.path.split(x)[1] == 'glbl.v' for x in self.files_v):
             util.warning(f'--add-glbl-v: Not adding {glbl_v=} b/c glbl.v already in',
                          f'{self.files_v=}')
         elif not os.path.exists(glbl_v):
             self.error(f"Could not find file {glbl_v=}")
         else:
             self.files_v.insert(0, glbl_v)
+            # add to self.args['add-top-library']
+            if 'glbl' not in self.args['add-top-library']:
+                self.args['add-top-library'].append('glbl')
+
+    def _get_xvlog_library_map_list(self) -> list:
+        '''Returns list of lines used in vlog step for --library-map args
+
+        Note that Vivado does not do library name re-mapping, the name comes
+        from the .lib file internals.
+        '''
+
+        lines = []
+        for _, lib_file_path in self.library_map.items():
+            lines.append(f'-libmap {lib_file_path}')
+        return lines
 
 
     def artifacts_add(self, name: str, typ: str, description: str) -> None:

{opencos_eda-0.3.13 → opencos_eda-0.3.14}/opencos/tools/yosys.py

@@ -22,7 +22,7 @@ def get_commands_to_run_scriptfiles(
 
     list of yoysys script(s)'''
 
-    if script_fnames_list:
+    if not script_fnames_list:
         return []
 
     yosys_cmdlists = []
@@ -142,7 +142,12 @@ class CommonSynthYosys(CommandSynth, ToolYosys):
             'yosys-scriptfile': (
                 'Instead of using a built-in flow from eda, use your own scripts that are called'
                 ' via: yosys --scriptfile <this-arg>. You can set multiple args for multiple'
-                ' scriptfile (appends)'
+                ' scriptfile (appends). NOTE: the default for eda is to run in a work-dir such as'
+                ' ./eda.work/<target>.synth/, which means you may want to use absolute paths for'
+                ' source files (.sv, etc) in your custom scriptfile, or use ../.. to get back to '
+                ' the current directory. If you want to run in place and avoid'
+                ' ./eda.work/<target>.synth/ you can use arg --work-dir=. or to run in place from'
+                ' the DEPS target directory, use --work-dir-use-target-dir'
             ),
             'sta-scriptfile': (
                 'Instead of using a built-in flow from eda, use your own script that is called'

{opencos_eda-0.3.13 → opencos_eda-0.3.14/opencos_eda.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.13
+Version: 0.3.14
 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.3.13 → opencos_eda-0.3.14}/pyproject.toml

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