opencos-eda 0.3.14__py3-none-any.whl → 0.3.15__py3-none-any.whl

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/_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/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/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/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_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/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/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
@@ -127,8 +128,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 +239,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 +295,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 +427,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.dist-info → opencos_eda-0.3.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.3.14
+Version: 0.3.15
 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.dist-info → opencos_eda-0.3.15.dist-info}/RECORD

@@ -1,6 +1,6 @@
 opencos/__init__.py,sha256=RwJA9oc1uUlvNX7v5zoqwjnSRNq2NZwRlHqtS-ICJkI,122
-opencos/_version.py,sha256=KaWIjS0c08g-C0fgYY1kXwSPqhOFxaq5pYEeoZhOR_I,617
-opencos/_waves_pkg.sv,sha256=TL5YT9lT-fn2FD54MbVVZROmZ7vtW3ScA_rM2eRzKmU,2068
+opencos/_version.py,sha256=FLlmTepF7P0hC-506fgEvv3NSxGxtWgeR7g2UkNK7PI,618
+opencos/_waves_pkg.sv,sha256=yWojzRYVIqV2H5xa5e0v34LgK4oLMu3k9_N8EYXy2f0,2852
 opencos/deps_schema.py,sha256=wKRMuFzOIapwpCPFGvWGM8Mcwdh9yngHOiDRMmvUaIg,17394
 opencos/eda.py,sha256=2vJLMYMW9muWieNaOJz-U5EIVchmVyhTfmEcnZwQtvg,37382
 opencos/eda_base.py,sha256=-nguHrrYVb8a853HEMfFrOoXlsEEeRnDdFR66nTwX0s,124332
@@ -10,7 +10,7 @@ opencos/eda_config_reduced.yml,sha256=BOKGfe-OmVIF0SKhTTglPIzfAoGuCZ8n-f2KpoLF8d
 opencos/eda_deps_bash_completion.bash,sha256=o1yZvGUQSbN-AYq95sDTzMFw7gNHCUSlv9tASEHnACA,2763
 opencos/eda_deps_sanitize.py,sha256=SQjvrte9Hv9JesRY0wljvbdC6pAmLCikI-Wdzzy-D04,1939
 opencos/eda_extract_targets.py,sha256=POlxZfqf2dNH2nc1CEw5B_53vSHAicSTkpU9_-2_6Zw,2851
-opencos/eda_tool_helper.py,sha256=NoVUvUeqvM18Svx1Oy4R8xM4Numq_YZneKyHSDnMMnY,8546
+opencos/eda_tool_helper.py,sha256=7KY-E7wnWCNRHXeekDg1tFivcZw86-MsrmXiw7Fc6h0,8578
 opencos/export_helper.py,sha256=zDkvsUS6FVrpXl1UTy53QG3CuhYp5FFplI9rRzAE2g8,25395
 opencos/export_json_convert.py,sha256=tSIMbLFtc_Fo66EhFovMii1v_qJYyFZJrPNnoPdW7L0,4182
 opencos/files.py,sha256=-vHrddbFrwxEHU47VzeyLOU93q8XSXAmPiopClfV-bs,2296
@@ -29,12 +29,12 @@ opencos/commands/lint.py,sha256=piPb0l0zE3sAtNJkFQ-oNpuHxnaV_RNXkXtEj_9mwGs,1594
 opencos/commands/multi.py,sha256=urm-IDllnMZWScH7e6Pg4ukHGHILBd4NbPlPmHU3vsw,27624
 opencos/commands/open.py,sha256=XckvKUNwvc5KHbYGV-eQ2i0WG4X-yckroDaMC610MB4,804
 opencos/commands/proj.py,sha256=cExW9ZZkw6nkpVyNfeQzJADzmPtbYgBgWml82tqO6jY,1158
-opencos/commands/shell.py,sha256=upHpFs8Gdtzi-boVXwsC-QzEsnvtoZNMAu4oN10kdxw,7801
-opencos/commands/sim.py,sha256=mpy1vOEeAfMfGmc_Q1ukWddgAmkXzShdVGKKdMLjvXs,31548
+opencos/commands/shell.py,sha256=WPKS27fTr0MG4Gqz_RzSwv4n8AINuQ_ntSmJtHeat_I,7771
+opencos/commands/sim.py,sha256=-dBxyHWMlUeLllsyhHa82jYKcLWxZA9qntS_vbeV3V0,31569
 opencos/commands/sweep.py,sha256=62XmDHT-prdxJNy-6MbK6wEGJm1YC9caOaJapoekQ8s,9325
 opencos/commands/synth.py,sha256=Qs6FP9Ge_gp9TH3EFzVXKFlrrqrMwIbr38VYVlZvmeA,4557
 opencos/commands/targets.py,sha256=_jRNhm2Fqj0fmMvTw6Ba39DCsRHf_r_uZCy_R064kpA,1472
-opencos/commands/upload.py,sha256=D5ln2gXsRHbPkOcy8S9jcwv-x6N4SK3m49urr1CLKo0,7915
+opencos/commands/upload.py,sha256=OGMI4By0942jL9LK7xBy5_WjvVzRbAr_RB3rS5fNobI,7917
 opencos/commands/waves.py,sha256=LYF1UcxkHFYYtYoebnh9iE_on80PbbmzIpaSk-XtZcI,9232
 opencos/deps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opencos/deps/defaults.py,sha256=Z6mIVJEV0zQ9rC-HkQFMBFAkixjqKS1TATPSc27wOeA,1502
@@ -65,10 +65,10 @@ opencos/tools/iverilog.py,sha256=aehXQV22U7MIaH8XuEI9ApWztsez0NaW960_Z01oZWc,678
 opencos/tools/modelsim_ase.py,sha256=NEzAXJtiVWkKb3N-O3PYxSnnFmrq8LNrqjxFNBwzfKI,2254
 opencos/tools/quartus.py,sha256=gtswIhpnHjUTmw5g1BRxhjB6tofXEsx-I6IySjwyF94,32303
 opencos/tools/questa.py,sha256=QP0JCt8rWf0-snncNP0_Pi6oRY6_Z9Hwix1IYlRdGEc,2057
-opencos/tools/questa_common.py,sha256=4K5OoFlCCZcPTQDW8pYvMDJm3WpIJ6yxLnx5akRtIuU,21897
+opencos/tools/questa_common.py,sha256=JYF4MrAcELurcA-t3Hzjb9KKtzHBEEYmXWKWAt8Gi0c,21931
 opencos/tools/questa_fe.py,sha256=yYNlUnA2pQ8-gELLajnvJgqg6ZXb6F26YRmyvrlNFOA,2155
 opencos/tools/questa_fse.py,sha256=CjOAn1Ik-3Hd-vyUH_WyTTJxH2yPfhNEfXbedCir7J4,2116
-opencos/tools/riviera.py,sha256=kRBG1ypS7TH1bA0_Hw7-q5sH7xS7X__rizUgAJgCfgg,19269
+opencos/tools/riviera.py,sha256=SsBOQ-xQQeBr_jPKI50bGzFHXKQeAa7WX3Ql6AC-3wE,19535
 opencos/tools/slang.py,sha256=MxRwu4laSbv7oa3lO-BKg4McL7KAckSA003sL-9sY3U,9682
 opencos/tools/slang_yosys.py,sha256=z8gUcNSGDl5S6Ufxdx54WWe5v73w0UydErBKFWBR6ZI,10154
 opencos/tools/surelog.py,sha256=QaXS1EWI2b1TqBoekpXndoHxS6t2e8SD-I2Ryi-gHGs,6666
@@ -84,10 +84,10 @@ opencos/utils/str_helpers.py,sha256=ctl0Zh0h0JW7OlReeSdGxB9wODQYzmMO-9-h55rSRv0,
 opencos/utils/subprocess_helpers.py,sha256=Wqqs8FKm3XIjmD9GUYM-HWVJH7TxWJJA37A07J4fQ4w,6619
 opencos/utils/vscode_helper.py,sha256=8epyEeYfXONwiSoc5KZjUfKc8vgLryct8yckJYie88U,1398
 opencos/utils/vsim_helper.py,sha256=-TJK4Dh8LZ4DCM8GrS9Wka4HE_WMGG_aKwTZtKBrEOE,2994
-opencos_eda-0.3.14.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-opencos_eda-0.3.14.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
-opencos_eda-0.3.14.dist-info/METADATA,sha256=2oqD3XW6Dlmwk9LQhx_-F7Z20ZI7AlQ3GW7v3wWarjQ,1165
-opencos_eda-0.3.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-opencos_eda-0.3.14.dist-info/entry_points.txt,sha256=QOlMZnQeqqwOzIaeKBcY_WlMR3idmOAEbGFh2dXlqJw,290
-opencos_eda-0.3.14.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
-opencos_eda-0.3.14.dist-info/RECORD,,
+opencos_eda-0.3.15.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+opencos_eda-0.3.15.dist-info/licenses/LICENSE.spdx,sha256=8gn1610RMP6eFgT3Hm6q9VKXt0RvdTItL_oxMo72jII,189
+opencos_eda-0.3.15.dist-info/METADATA,sha256=eMegaTVGReQYdwr58zGGkc8fmhuJywlujQ1wawgA4dA,1165
+opencos_eda-0.3.15.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+opencos_eda-0.3.15.dist-info/entry_points.txt,sha256=QOlMZnQeqqwOzIaeKBcY_WlMR3idmOAEbGFh2dXlqJw,290
+opencos_eda-0.3.15.dist-info/top_level.txt,sha256=J4JDP-LpRyJqPNeh9bSjx6yrLz2Mk0h6un6YLmtqql4,8
+opencos_eda-0.3.15.dist-info/RECORD,,

{opencos_eda-0.3.14.dist-info → opencos_eda-0.3.15.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any