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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.14
+Version: 0.3.16
 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.14 → opencos_eda-0.3.16}/docs/DEPS.md

@@ -9,6 +9,9 @@ METADATA: # <table> unstructured data, any UPPERCASE first level key is not cons
 
 target-spec:
 
+  description: # <str> optional description
+  info:        # <str> optional description
+
   args: # <array or | separated str>
     - --waves
     - --sim_plusargs="+info=500"
@@ -56,6 +59,8 @@ target-spec:
                               # to compile order list.
       - peakrdl:              # <string>     ## peakrdl command to generate CSRs
 
+  files: # <Identical to "deps", will append to any deps.>
+
   reqs: # <array or | space separated string>
     - some_file.mem           # <string> aka, a non-source file required for this target.
                               # This file is checked for existence prior to invoking the tool involved, for example,
@@ -100,6 +105,7 @@ target-spec:
       args: <array or | space separated string> # args to be applied if this target is used, with a matching
                                           # tool in 'with-tools'.
       deps: <array or | space separated string, applied with tag>
+      files: <identical to deps, will append to deps>
       defines: <table, applied with tag>
       plusargs: <table, applied with tag>
       parameters: <table, applied with tag>

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/_version.py

@@ -2,6 +2,8 @@
 
 import sys
 
+# pylint: disable=invalid-name
+
 NAME = 'opencos-eda'
 
 # Use standard library metadata module starting Python 3.8
@@ -19,4 +21,4 @@ else:
     ver = "unknown" # Or raise an error, or handle differently
 
 
-VERSION = ver # pylint: disable=invalid-name
+VERSION = ver

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/_waves_pkg.sv

@@ -26,27 +26,25 @@ package _waves_pkg;
       automatic string trace_str_value = "";
       void'($value$plusargs("trace=%s", trace_str_value));
       if (trace_str_value.tolower() == "vcd") begin
-        $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace=%s",
-                 $realtime, trace_str_value);
+        $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace=vcd", $realtime);
         $dumpfile("dump.vcd");
         $dumpvars();
-        return 1;
+      end else begin
+        $display("%t %m: Starting tracing to ./dump.fst", $realtime);
+        $dumpfile("dump.fst");
+        $dumpvars();
       end
     end
 
-    $display("%t %m: Starting tracing to ./dump.fst", $realtime);
-    $dumpfile("dump.fst");
-    $dumpvars();
     return 1;
 
   endfunction : init_trace
 
-`elsif RIVIERA
+`elsif IVERILOG
 
   bit        trace_en_init = 0;
   bit        trace_en      = init_trace();
 
-  // Note: must be non-automatic function for --tool=riviera
   function bit init_trace();
 
     if (trace_en_init) // only do this once.
@@ -55,26 +53,59 @@ package _waves_pkg;
     trace_en_init = 1;
 
     if ($test$plusargs("trace") != 0) begin
-      automatic string trace_str_value = "";
+      $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace present", $realtime);
+      $dumpfile("dump.vcd");
+      $dumpvars();
+      return 1;
+    end
+
+  endfunction : init_trace
+
+`endif
+`endif
+`endif
+
+endpackage : _waves_pkg
+
+//
+// For RIVIERA (and SIMULATION, and not disabled):
+// - it will not run system calls from a package function, unless that package was
+//   used by the testbench
+// - so we have to
+//   - create a side module _waves_module. Fortunately the $dumpvars() in riviera
+//     dumps all module hier, not just that from _waves_module.
+//   - We will have to include work._waves_module in the vsim call (in riviera.py)
+//
+
+// TODO(drew): please test this on a file that doesn't involve ocsim_pkg.sv
+
+`ifdef SIMULATION
+`ifndef _WAVES_PKG_DISABLE_DUMPFILE // hook to disable this if user chooses
+`ifdef RIVIERA
+
+module _waves_module;
+
+  string trace_str_value = "";
+
+  initial begin
+
+    if ($test$plusargs("trace") != 0) begin
       void'($value$plusargs("trace=%s", trace_str_value));
       if (trace_str_value.tolower() == "vcd") begin
-        $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace=%s",
-                 $realtime, trace_str_value);
+        $display("%t %m: Starting tracing to ./dump.vcd, plusarg +trace=vcd", $realtime);
         $dumpfile("dump.vcd");
         $dumpvars();
-        return 1;
+      end else begin
+        $display("%t %m: Starting tracing to ./dump.fst", $realtime);
+        $dumpfile("dump.fst");
+        $dumpvars();
       end
     end
 
-    $display("%t %m: Starting tracing to ./dump.fst", $realtime);
-    $dumpfile("dump.fst");
-    $dumpvars();
-    return 1;
+  end
 
-  endfunction : init_trace
+endmodule : _waves_module
 
 `endif
 `endif
 `endif
-
-endpackage : _waves_pkg

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/commands/shell.py

@@ -9,7 +9,7 @@ Not intended to be overriden by Tool based classes.'''
 #   These also share a lot with CommandSim.* methods, so consider refactoring to share code,
 #   for example, CommandShell.do_export could move to CommandDesign, and derived classes
 #   set the allow-listed args to pass to export.
-# pylint: disable=too-many-arguments,too-many-positional-arguments
+# pylint: disable=too-many-arguments
 
 import os
 

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/commands/sim.py

@@ -9,7 +9,7 @@ Note that CommandSim is also a base class for opencos.commands.elab.CommandElab.
 # pylint: disable=R0801
 
 # TODO(drew): clean up CommandSim.check_logs_for_errors and CommandSim.run_commands_check_logs
-# pylint: disable=too-many-arguments,too-many-positional-arguments
+# pylint: disable=too-many-arguments
 
 import os
 import shlex
@@ -22,6 +22,9 @@ from opencos.utils import status_constants
 
 from opencos.utils.str_helpers import strip_outer_quotes
 
+THISPATH = os.path.dirname(__file__)
+WAVES_PKG_SV_FNAME = str((Path(THISPATH) / '..' / '_waves_pkg.sv').resolve())
+
 def parameters_dict_get_command_list(
         params: dict, arg_prefix: str = '-G',
         hier_delimiter: str = '.',
@@ -638,8 +641,7 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
                         break
 
         if not found_dumpfile:
-            thispath = os.path.dirname(__file__)
-            file_to_add = os.path.join(thispath, '..', '_waves_pkg.sv')
+            file_to_add = WAVES_PKG_SV_FNAME
             util.info(f'--waves arg present, no $dumpfile found, adding SV file: {file_to_add}')
             self.add_file(file_to_add)
 
@@ -706,7 +708,9 @@ 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:
+    def update_library_map( # pylint: disable=dangerous-default-value
+            self, base_search_paths: list = []
+    ) -> None:
         '''
         Returns None, uses self.args['library-map'] to update:
 
@@ -739,7 +743,7 @@ class CommandSim(CommandDesign): # pylint: disable=too-many-public-methods
 
             # We have to go looking for lib_path though
             search_files = [lib_path]
-            if base_search_paths and isinstance(base_search_paths, list):
+            if base_search_paths:
                 for x in base_search_paths:
                     search_files.append(Path(x) / lib_path)
             for x in search_files:

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/commands/upload.py

@@ -123,7 +123,7 @@ class CommandUpload(Command):
     def get_list_bitfiles(self, display: bool = True) -> list:
         '''Returns a list of bit files (ending with self.SUPPORTED_BIT_EXT)'''
 
-        bitfiles: list[Path] = []
+        bitfiles = [] # list[Path]
 
         targets, files = self.get_targets_or_files_from_unparsed_args()
         targets.extend(files)
@@ -136,7 +136,7 @@ class CommandUpload(Command):
                     if os.path.isfile(fullpath) and fullpath not in bitfiles:
                         bitfiles.append(fullpath)
 
-        matched: list[Path] = []
+        matched = [] # list[Path]
         for cand in bitfiles:
             debug(f"Looking for {cand=} in {targets=}")
             passing = all(re.search(t, str(cand)) for t in targets)

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/deps/defaults.py

@@ -29,6 +29,8 @@ KNOWN_EDA_COMMANDS = set([
 ])
 
 SUPPORTED_TARGET_TABLE_KEYS = set([
+    'description', # optional text, for DEPS.json enjoyers
+    'info', # same as 'description'
     'args',
     'defines',
     'parameters',
@@ -36,6 +38,7 @@ SUPPORTED_TARGET_TABLE_KEYS = set([
     'plusargs',
     'top',
     'deps',
+    'files', # identical to 'deps', will append to deps
     'reqs',
     'multi',
     'tags',
@@ -52,6 +55,7 @@ SUPPORTED_TAG_KEYS = set([
     'with-args',
     'args',
     'deps',
+    'files', # identical to 'deps', will append to deps
     'reqs',
     'defines',
     'parameters',

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/deps/deps_file.py

@@ -172,6 +172,10 @@ def deps_target_get_deps_list(
         deps = entry.get(default_key, [])
         deps = dep_str2list(deps)
 
+        # Support for 'files' also, append to return value under 'deps'
+        if default_key == 'deps' and 'files' in entry:
+            deps += dep_str2list(entry.get('files', []))
+
     # Strip commented out list entries, strip blank strings, preserve non-strings
     ret = []
     for dep in deps:
@@ -204,11 +208,15 @@ def deps_list_target_sanitize(
         ret = {default_key: entry}
 
     if ret is not None:
-        if entry_fix_deps_key and 'deps' in ret:
+        if entry_fix_deps_key and (('deps' in ret) or
+                                   ('files' in ret)):
             ret['deps'] = deps_target_get_deps_list(
                 entry=ret, default_key='deps', deps_file=deps_file,
-                entry_must_have_default_key=True
+                entry_must_have_default_key=False
             )
+            if 'files' in ret:
+                # was already appeneded to 'deps' in the ret dict
+                del ret['files']
     else:
         assert False, f"Can't convert to list {entry=} {default_key=} {target_node=} {deps_file=}"
 

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/deps/deps_processor.py

@@ -4,8 +4,11 @@ a DEPS markup files targets (applying deps, reqs, commands, tags, incdirs, defin
 CommandDesign ref object
 '''
 
+# pylint: disable=too-many-lines
+
 import argparse
 import copy
+import glob
 import os
 
 from opencos import files
@@ -418,7 +421,8 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                 self.process_commands()
             elif key == 'reqs':
                 self.process_reqs()
-            elif key == 'deps':
+            elif key == 'deps' or \
+                 (key == 'files' and 'deps' not in self.deps_entry):
                 remaining_deps_list += self.process_deps_return_discovered_deps()
 
             if self.command_design_ref.tool_changed_respawn:
@@ -613,7 +617,8 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                                                               deps_file=self.deps_file)
                         self.apply_reqs(reqs_list)
 
-                    elif key == 'deps':
+                    elif key == 'deps' or \
+                         (key == 'files' and 'deps' not in tags_dict_to_apply):
 
                         # apply deps (includes commands, stray +define+ +incdir+)
                         # treat the same way we treat self.process_deps_return_discovered_deps
@@ -861,6 +866,7 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
         '''Returns list of deps targets to continue processing,
 
         -- iterates through 'deps' for this target (self.deps_entry['deps'])
+           -- note this will also append 'files' if that table key + list/str exists.
         -- applies to self.command_design_ref
         '''
 
@@ -872,7 +878,9 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
         )
         return self.get_remaining_and_apply_deps(deps)
 
-    def get_remaining_and_apply_deps(self, deps:list) -> list:
+    def get_remaining_and_apply_deps(
+            self, deps: list
+    ) -> list:
         '''Given a list of deps, process what is supported in a "deps:" table in DEPS
         markup file.'''
 
@@ -880,66 +888,98 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
 
         # Process deps (list)
         for dep in deps:
+            deps_targets_to_resolve.extend(
+                self._get_remaining_and_apply_single_dep(dep)
+            )
+        return deps_targets_to_resolve
+
 
-            typ = type(dep)
-            if typ not in SUPPORTED_DEP_KEYS_BY_TYPE:
-                self.error(f'{self.target_node=} {dep=} in {self.deps_file=}:' \
-                           + f'has unsupported {type(dep)=} {SUPPORTED_DEP_KEYS_BY_TYPE=}')
-
-            for supported_values in SUPPORTED_DEP_KEYS_BY_TYPE.values():
-                if '*' in supported_values:
-                    continue
-                if typ in [dict,list] and any(k not in supported_values for k in dep):
-                    self.error(
-                        f'{self.target_node=} {dep=} in {self.deps_file=}: has dict-key or',
-                        f'list-item not in {SUPPORTED_DEP_KEYS_BY_TYPE[typ]=}'
-                    )
-
-            # In-line commands in the deps list, in case the results need to be in strict file
-            # order for other deps
-            if isinstance(dep, dict) and 'commands' in dep:
-
-                commands = dep['commands']
-                debug(f"Got commands {dep=} for in {self.caller_info}, {commands=}")
-
-                assert isinstance(commands, list), \
-                    f'dep commands must be a list: {dep=} in {self.caller_info}'
-
-                # For this, we need to get the returned commands (to keep strict order w/ other
-                # deps)
-                command_tuple = self.get_commands( commands=commands, dep=dep )
-                # TODO(drew): it might be cleaner to return a dict instead of list, b/c those
-                # are also ordered and we can pass type information, something like:
-                deps_targets_to_resolve.append(command_tuple)
-
-
-            elif isinstance(dep, str) and \
-                 any(dep.startswith(x) for x in ['+define+', '+incdir+']) and \
-                 self.is_command_design:
-                # Note: we still support +define+ and +incdir in the deps list.
-                # check for compile-time Verilog style plusarg, which are supported under targets
-                # These are not run-time Verilog style plusargs comsumable from within the .sv:
-                debug(f"Got plusarg (define, incdir) {dep=} for {self.caller_info}")
-                self.command_design_ref.process_plusarg(plusarg=dep, pwd=self.target_path)
+    def _get_remaining_and_apply_single_dep( # pylint: disable=too-many-branches
+            self, dep: str
+    ) -> list:
+        '''Given a single dep, process is and return targets/files that need resolving'''
 
+        deps_targets_to_resolve = []
+        typ = type(dep)
+        if typ not in SUPPORTED_DEP_KEYS_BY_TYPE:
+            self.error(f'{self.target_node=} {dep=} in {self.deps_file=}:' \
+                       + f'has unsupported {type(dep)=} {SUPPORTED_DEP_KEYS_BY_TYPE=}')
+
+        for supported_values in SUPPORTED_DEP_KEYS_BY_TYPE.values():
+            if '*' in supported_values:
+                continue
+            if typ in [dict,list] and any(k not in supported_values for k in dep):
+                self.error(
+                    f'{self.target_node=} {dep=} in {self.deps_file=}: has dict-key or',
+                    f'list-item not in {SUPPORTED_DEP_KEYS_BY_TYPE[typ]=}'
+                )
+
+        # In-line commands in the deps list, in case the results need to be in strict file
+        # order for other deps
+        if isinstance(dep, dict) and 'commands' in dep:
+
+            commands = dep['commands']
+            debug(f"Got commands {dep=} for in {self.caller_info}, {commands=}")
+
+            assert isinstance(commands, list), \
+                f'dep commands must be a list: {dep=} in {self.caller_info}'
+
+            # For this, we need to get the returned commands (to keep strict order w/ other
+            # deps)
+            command_tuple = self.get_commands( commands=commands, dep=dep )
+            # TODO(drew): it might be cleaner to return a dict instead of list, b/c those
+            # are also ordered and we can pass type information, something like:
+            deps_targets_to_resolve.append(command_tuple)
+
+
+        elif isinstance(dep, str) and \
+             any(dep.startswith(x) for x in ['+define+', '+incdir+']) and \
+             self.is_command_design:
+            # Note: we still support +define+ and +incdir in the deps list.
+            # check for compile-time Verilog style plusarg, which are supported under targets
+            # These are not run-time Verilog style plusargs comsumable from within the .sv:
+            debug(f"Got plusarg (define, incdir) {dep=} for {self.caller_info}")
+            self.command_design_ref.process_plusarg(plusarg=dep, pwd=self.target_path)
+
+        else:
+            # If we made it this far, dep better be a str type.
+            assert isinstance(dep, str), f'{dep=} {type(dep)=} must be str'
+            dep_path = self.correct_a_deps_target(target=dep, deps_dir=self.target_path)
+            debug(f"Got dep {dep_path=} for in {self.caller_info}")
+
+            if self.is_command_design and \
+               dep_path in self.command_design_ref.targets_dict or \
+               dep_path in deps_targets_to_resolve:
+                debug(f" - already processed ({dep_path}), skipping")
             else:
-                # If we made it this far, dep better be a str type.
-                assert isinstance(dep, str), f'{dep=} {type(dep)=} must be str'
-                dep_path = self.correct_a_deps_target(target=dep, deps_dir=self.target_path)
-                debug(f"Got dep {dep_path=} for in {self.caller_info}")
-
-                if self.is_command_design and \
-                   dep_path in self.command_design_ref.targets_dict or \
-                   dep_path in deps_targets_to_resolve:
-                    debug(" - already processed, skipping")
-                else:
+                # This is where we support files/deps file wildcards via glob syntax.
+                # If glob found none, we fall back to a single-file or target
+                glob_added_from_dep_path = False
+                if any(x in dep_path for x in ('*', '?', '[')):
+                    try:
+                        glob_list = glob.glob(dep_path)
+                        for fpath in glob_list:
+                            file_exists, _, _ = files.get_source_file(fpath)
+                            if file_exists:
+                                debug(f" - raw file ({fpath}), from glob ({dep_path}) adding",
+                                      "to return list...")
+                                deps_targets_to_resolve.append(fpath) # append
+                                glob_added_from_dep_path = True
+                        if glob_list and not glob_added_from_dep_path:
+                            self.error(f'No files were expanded from glob: {dep_path} in',
+                                       f'{self.caller_info}')
+                    except Exception as e:
+                        self.error(f'Unable to add files via glob {dep_path}, in',
+                                   f'{self.caller_info}exception {e}')
+
+                if not glob_added_from_dep_path:
                     file_exists, _, _ = files.get_source_file(dep_path)
                     if file_exists:
-                        debug(" - raw file, adding to return list...")
+                        debug(f" - raw file ({dep_path}), adding to return list...")
                         deps_targets_to_resolve.append(dep_path) # append, keeping file order.
                     else:
-                        debug(" - a target (not a file) needing to be resolved, adding to return",
-                              "list...")
+                        debug(f" - a target non-file ({dep_path}) needs to be resolved,",
+                              "adding to return list...")
                         deps_targets_to_resolve.append(dep_path) # append, keeping file order.
 
         # We return the list of deps or files that still need to be resolved
@@ -947,12 +987,6 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
         # items in this list are either:
         #  -- string (dep or file)
         #  -- tuple (unprocessed commands, in form: (shell_commands_list, work_dir_add_srcs_list))
-        # TODO(drew): it might be cleaner to return a dict instead of list, b/c those are also
-        # ordered and we can pass type information, something like:
-        #  { dep1: 'file',
-        #    dep2: 'target',
-        #    dep3: 'command_tuple',
-        #  }
         return deps_targets_to_resolve
 
 

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/deps_schema.py

@@ -264,6 +264,9 @@ TARGET_TAGS_TABLE = {
 TARGET_CONTENTS = Or(
     ARRAY_OR_SPACE_SEPARATED_STRING,
     {
+        # description, info: str
+        Optional('description'): Or(str, type(None)),
+        Optional('info'): Or(str, type(None)),
         # args: array
         Optional('args'): ARRAY_OR_SPACE_SEPARATED_STRING,
         # commands: array
@@ -285,7 +288,9 @@ TARGET_CONTENTS = Or(
         # top: string
         Optional('top'): str,
         # deps: array
+        # AND/OR files: array
         Optional('deps'): TARGET_DEPS_CONTENTS,
+        Optional('files'): TARGET_DEPS_CONTENTS,
         # reqs: array
         Optional('reqs'): ARRAY_OR_SPACE_SEPARATED_STRING,
         # multi: table
@@ -334,6 +339,8 @@ FILE_SIMPLIFIED = Schema(
             Optional('METADATA'): dict,
             Optional(str): Or( # User named target contents
                 {
+                    Optional('description'): str,
+                    Optional('info'): str,
                     Optional('args'): [str],
                     Optional('defines'): {
                         Optional(str): Or(type(None), int, str),
@@ -347,6 +354,7 @@ FILE_SIMPLIFIED = Schema(
                     Optional('incdirs'): [str],
                     Optional('top'): str,
                     Optional('deps'): [str],
+                    Optional('files'): [str],
                     Optional('reqs'): [str],
                 }
             )

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/eda.py

@@ -801,6 +801,7 @@ def main(*args):
         # And show python version:
         util.info(f'python: version {sys.version_info.major}.{sys.version_info.minor}.'
                   f'{sys.version_info.micro}')
+        util.info(f'eda from: {__file__}')
 
     # Handle --config-yml= arg
     config, unparsed = eda_config.get_eda_config(unparsed)

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/eda_tool_helper.py

@@ -111,8 +111,8 @@ def get_handler_tool_version(tool: str, eda_command: str, config: dict) -> str:
 
 
 
-def get_handler_info_with_versions( # pylint: disable=too-many-branches
-        config: dict | None = None,
+def get_handler_info_with_versions( # pylint: disable=too-many-branches,dangerous-default-value
+        config: dict = {},
         include_commands: bool = True,
         sort: bool = True
 ) -> str:
@@ -202,8 +202,8 @@ def get_handler_info_with_versions( # pylint: disable=too-many-branches
     return info
 
 
-def pretty_info_handler_tools(
-        info: dict | None = None, config: dict | None = None, command: str | None = ''
+def pretty_info_handler_tools( # pylint: disable=dangerous-default-value
+        info: dict = {}, config: dict = {}, command: str = ''
 ) -> None:
     '''Pretty print (via util.info) the result from get_handler_info_with_versions()
 

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

@@ -151,6 +151,7 @@ class CommonSimQuesta(CommandSim, ToolQuesta):
     def prepare_compile(self):
         self.set_tool_defines()
         self.update_library_map()
+        self.add_waves_pkg_file()
         self.write_vlog_dot_f()
         self.write_vsim_dot_do(dot_do_to_write='all')
 

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

@@ -14,6 +14,7 @@ from pathlib import Path
 from opencos import util
 from opencos.commands import CommandFList
 from opencos.files import safe_shutil_which
+from opencos.commands.sim import WAVES_PKG_SV_FNAME
 from opencos.tools.questa_common import ToolQuesta, CommonSimQuesta
 from opencos.utils.str_helpers import sanitize_defines_for_sh
 from opencos.utils import status_constants
@@ -101,8 +102,10 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
                 ' tcl steps are (from tool config in --config-yml):   '
             ) + '; '.join(self.tool_config.get('simulate-coverage-tcl', [])),
             'uvm': (
-                'Attempts to support UVM. Adds to vlog: -l uvm +incdir+PATH for the PATH to'
-                ' uvm_macros.svh for the installed version of Riviera used.'
+                'Attempts to support UVM. For Riviera, this adds "-uvmver NUMBER -dbg" to vlog.f.'
+                ' You can choose your uvmver using eda arg --uvm-version=NUMBER.'
+                ' Also adds +access +r to vopt/vsim. There is no -l or -L library modifications,'
+                ' we rely on Riviera to handle this internally based on running: vlog -uvm'
             ),
             'license-queue': (
                 'Set to enable env vars (if unset) LICENSE_QUEUE=1, ALDEC_LICENSE_QUEUE=1,'
@@ -127,8 +130,6 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
     def compile(self):
         '''Override for CommandSimModelsimAse.compile() so we can set our own must_strings'''
 
-        self.add_waves_pkg_file()
-
         if self.args['stop-before-compile']:
             # don't run anything, save everyting we've already run in _prep_compile()
             return
@@ -240,7 +241,7 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
 
 
 
-    def write_vsim_dot_do( # pylint: disable=too-many-branches,too-many-locals
+    def write_vsim_dot_do( # pylint: disable=too-many-branches,too-many-locals,too-many-statements
             self, dot_do_to_write: list
     ) -> None:
         '''Writes files(s) based on dot_do_to_write(list of str)
@@ -296,6 +297,10 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
             f" {voptargs_str} {vsim_ext_args} {vsim_libs} work.{self.args['top']}"
         )
 
+        if self.args['waves'] and WAVES_PKG_SV_FNAME in self.files:
+            # kind of a hack, but add _waves_module (from _waves_pkg.sv) if that file
+            # was in our files list.
+            vsim_one_liner += ' work._waves_module'
 
         for l in self.args['add-top-library']:
             vsim_one_liner += f' {l}'
@@ -424,14 +429,14 @@ class CommandSimRiviera(CommonSimQuesta, ToolRiviera):
 
         return ' '.join(vsim_suppress_list)
 
-    def update_library_map(self, base_search_paths: list | None = None) -> None:
+    def update_library_map( # pylint: disable=dangerous-default-value
+            self, base_search_paths: list = []
+    ) -> 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 = [] + base_search_paths
         bsp += [
             Path(self.sim_exe_base_path),
             Path(self.sim_exe_base_path) / '..',

{opencos_eda-0.3.14 → opencos_eda-0.3.16}/opencos/util.py

@@ -20,6 +20,7 @@ from importlib import import_module
 from dotenv import load_dotenv
 from supports_color import supportsColor
 
+import opencos
 from opencos.files import safe_shutil_which
 from opencos.utils import status_constants
 from opencos.utils.str_helpers import strip_ansi_color
@@ -359,7 +360,10 @@ def get_argparser() -> argparse.ArgumentParser:
     #    boolean actions:
     bool_action_kwargs = get_argparse_bool_action_kwargs()
 
-    parser.add_argument('--version', default=False, action='store_true')
+    parser.add_argument('--version', default=False, action='store_true',
+                        help=('Shows our version:'
+                              f' {opencos.__version__} ({opencos.__pyproject_name__})')
+                        )
     parser.add_argument('--color', **bool_action_kwargs, default=bool(supportsColor.stdout),
                         help='Use shell colors for info/warning/error messaging')
     parser.add_argument('--emoji', **bool_action_kwargs, default=args['emoji'],

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

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

@@ -2,7 +2,7 @@
 
 [project]
 name = "opencos-eda"
-version = "0.3.14"
+version = "0.3.16"
 dependencies = [
   # opencos/eda.py dependencies
   "mergedeep >= 1.3.4",
@@ -46,16 +46,39 @@ docs = [
 [project.urls]
 Homepage = "https://github.com/cognichip/opencos"
 
+#
+# UV suggestions
+#
+
+# This is supposed to prevent 'uv sync' from making the project editable,
+# but uv is stupid and ignores this. We'll have to remember to use
+#   uv sync --no-editable --upgrade
+# If you want editable mode (discouraged by authors!) use:
+#   uv sync --editable
+#   (and/or)
+#   uv pip install -e .
+# Note if you run locally in the repo-root,
+[tool.uv]
+package = true
+
+#
+# setuptools stuff
+#
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
 [tool.setuptools]
 # Only include these packages
 packages = [
-    "opencos",
-    "opencos.commands",
-    "opencos.deps",
-    "opencos.hw",
-    "opencos.tools",
-    "opencos.utils",
-    "opencos.docs", # mapped from ./docs
+  "opencos",
+  "opencos.commands",
+  "opencos.deps",
+  "opencos.hw",
+  "opencos.tools",
+  "opencos.utils",
+  "opencos.docs", # mapped from ./docs
 ]
 
 [tool.setuptools.package-dir]
@@ -65,13 +88,17 @@ packages = [
 [tool.setuptools.package-data]
 # Only include certain data
 "*" = [
-    "*.py",
-    "eda_config*.yml",
-    "_waves*pkg.sv",
-    "eda_deps_bash_completion.bash",
+  "*.py",
+  "eda_config*.yml",
+  "_waves*pkg.sv",
+  "eda_deps_bash_completion.bash",
 ]
 "opencos.docs" = ["*.md"]
 
+#
+# Executable scripts:
+#
+
 [project.scripts]
 eda = "opencos.eda:main_cli"
 oc_cli = "opencos.hw.oc_cli:main"
@@ -83,8 +110,3 @@ eda_deps_schema = "opencos.deps_schema:main"
 eda_deps_sanitize = "opencos.eda_deps_sanitize:main"
 # For showing instructions on bash (tab) autocomplete
 eda_show_autocomplete = "opencos.eda:main_show_autocomplete_instructions"
-
-
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"