opencos-eda 0.2.55__tar.gz → 0.2.56__tar.gz

{opencos_eda-0.2.55/opencos_eda.egg-info → opencos_eda-0.2.56}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opencos-eda
-Version: 0.2.55
+Version: 0.2.56
 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.2.55 → opencos_eda-0.2.56}/opencos/commands/flist.py

@@ -10,6 +10,7 @@ import os
 from opencos import util
 from opencos.eda_base import CommandDesign
 from opencos.utils.str_helpers import strip_all_quotes
+from opencos.commands.sim import parameters_dict_get_command_list
 
 class CommandFList(CommandDesign):
     '''Base class command handler for: eda flist ...'''
@@ -22,6 +23,7 @@ class CommandFList(CommandDesign):
             'eda-dir'            : 'eda.flist', # user can specify eda-dir if files are generated.
             'out'                : "flist.out",
             'emit-define'        : True,
+            'emit-parameter'     : True,
             'emit-incdir'        : True,
             'emit-v'             : True,
             'emit-sv'            : True,
@@ -29,6 +31,7 @@ class CommandFList(CommandDesign):
             'emit-cpp'           : True,
             'emit-non-sources'   : True, # as comments, from DEPS 'reqs'
             'prefix-define'      : "+define+",
+            'prefix-parameter'   : "-G",
             'prefix-incdir'      : "+incdir+",
             'prefix-v'           : "",
             'prefix-sv'          : "",
@@ -179,6 +182,13 @@ class CommandFList(CommandDesign):
                     newline = prefix + qd1 + f"{d}{ed1}{value}" + qd2
                 print(newline, file=fo)
 
+        if self.args['emit-parameter']:
+            prefix = strip_all_quotes(self.args['prefix-parameter'])
+            for item in parameters_dict_get_command_list(
+                    params=self.parameters, arg_prefix=prefix
+            ):
+                print(item, file=fo)
+
         if self.args['emit-incdir']:
             prefix = strip_all_quotes(self.args['prefix-incdir'])
             for i in self.incdirs:

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/commands/sim.py

@@ -17,6 +17,33 @@ from opencos import util, export_helper
 from opencos.eda_base import CommandDesign, Tool
 from opencos.utils import status_constants
 
+from opencos.utils.str_helpers import sanitize_defines_for_sh, strip_outer_quotes
+
+def parameters_dict_get_command_list(params: dict, arg_prefix: str = '-G') -> list:
+    '''Given dict of parameters, returns a command list'''
+
+    ret_list = []
+    if ' ' in arg_prefix:
+        arg_list_prefix = arg_prefix.split()
+        arg_str_prefix = ''
+    else:
+        arg_list_prefix = []
+        arg_str_prefix = arg_prefix
+
+    for k,v in params.items():
+        if not isinstance(v, (int, str)):
+            util.warning(f'parameter {k} has value: {v}, parameters must be int/string types')
+
+        ret_list.extend(arg_list_prefix)
+        if isinstance(v, int):
+            ret_list.append(f'{arg_str_prefix}{k}={v}')
+        else: # string
+            v = strip_outer_quotes(v.strip('\n'))
+            v = '"' + v + '"'
+            ret_list.append(f'{arg_str_prefix}{k}={sanitize_defines_for_sh(v)}')
+    return ret_list
+
+
 class CommandSim(CommandDesign):
     '''Base class command handler for: eda sim ...'''
 
@@ -80,6 +107,10 @@ class CommandSim(CommandDesign):
 
         self.args['verilate-args'] = []
 
+    def process_parameters_get_list(self, arg_prefix: str = '-G') -> list:
+        '''Returns list (suitable command list for shell or for tool) from self.parameters'''
+        return parameters_dict_get_command_list(params=self.parameters, arg_prefix=arg_prefix)
+
     def process_plusarg(self, plusarg: str, pwd: str = os.getcwd()) -> None:
         '''Override for CommandDesign.process_plusarg(..)'''
         maybe_plusarg = CommandDesign.process_plusarg(self, plusarg, pwd)

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/deps/defaults.py

@@ -31,6 +31,7 @@ KNOWN_EDA_COMMANDS = set([
 SUPPORTED_TARGET_TABLE_KEYS = set([
     'args',
     'defines',
+    'parameters',
     'incdirs',
     'top',
     'deps',
@@ -52,6 +53,7 @@ SUPPORTED_TAG_KEYS = set([
     'deps',
     'reqs',
     'defines',
+    'parameters',
     'incdirs',
     'replace-config-tools',
     'additive-config-tools',

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/deps/deps_processor.py

@@ -91,6 +91,22 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                         v = v.replace('%SEED%', str(self.args.get('seed', 1)))
                 self.command_design_ref.process_plusarg(f'+define+{k}={v}')
 
+
+    def apply_parameters(self, parameters_dict: dict):
+        '''Given parameters_dict, applies them to our self.command_design_ref obj'''
+        if not isinstance(parameters_dict, dict):
+            self.error(f"{parameters_dict=} is not type dict, can't apply defines,",
+                       f"in {self.caller_info}")
+        for k,v in parameters_dict.items():
+            if v is None or v == '' or not isinstance(v, (int, str, bool)):
+                warning(f'parameter {k} has value: {v}, parameters must be bool/int/string types',
+                        f'from {self.caller_info}')
+            else:
+                self.command_design_ref.set_parameter(
+                    name=k, value=v, caller_info=self.caller_info
+                )
+
+
     def apply_incdirs(self, incdirs_list:list):
         '''Given incdirs_list, applies them to our self.command_design_ref obj'''
         if not isinstance(incdirs_list, (str, list)):
@@ -252,6 +268,8 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                 remaining_deps_list += self.process_tags()
             elif key == 'defines':
                 self.process_defines()
+            elif key == 'parameters':
+                self.process_parameters()
             elif key == 'incdirs':
                 self.process_incdirs()
             elif key == 'top':
@@ -426,6 +444,9 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                         # apply defines:
                         self.apply_defines(value.get('defines', {}))
 
+                    elif key == 'parameters':
+                        self.apply_parameters(value.get('parameters', {}))
+
                     elif key == 'incdirs':
                         # apply incdirs:
                         self.apply_incdirs(value.get('incdirs', []))
@@ -517,6 +538,22 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
 
         self.apply_defines(entry_defines)
 
+    def process_parameters(self):
+        '''Returns None, applies parameters (dict, if any) from self.deps_entry to
+        self.command_design_ref.'''
+
+        # Parameters:
+        # apply command specific parameters, with higher priority than the a
+        # deps_entry['sim']['parameters'] entry,
+        # do this with dict1.update(dict2):
+        entry_parameters = {}
+        entry_parameters.update(self.deps_entry.get('parameters', {}))
+        entry_parameters.update(self.entry_eda_command.get('parameters', {}))
+        assert isinstance(entry_parameters, dict), \
+            f'{entry_parameters=} for in {self.caller_info} must be a dict'
+
+        self.apply_parameters(entry_parameters)
+
     def process_incdirs(self) -> None:
         '''Returns None, applies incdirs (dict, if any) from self.deps_entry to
         self.command_design_ref.'''
@@ -700,7 +737,8 @@ class DepsProcessor: # pylint: disable=too-many-instance-attributes
                 deps_targets_to_resolve.append(command_tuple)
 
 
-            elif isinstance(dep, str) and any(dep.startswith(x) for x in ['+define+', '+incdir']):
+            elif isinstance(dep, str) and \
+                 any(dep.startswith(x) for x in ['+define+', '+incdir+']):
                 # 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:

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/deps_schema.py

@@ -11,6 +11,9 @@ my_target_name:
   defines:                           <---- defines, optional table
     USER_DEFINE_VALUE: 12
 
+  parameters:                        <---- parameters, optional table
+    USER_PARAM_VALUE: 12
+
   incdirs:                           <---- incdirs, optional array (or string)
     - ./
 
@@ -32,6 +35,9 @@ my_target_name:
   defines:                           <---- defines, optional table of (key: str Or null)
     USER_DEFINE_VALUE: 12
 
+  parameters:                        <---- parameters, optional table
+    USER_PARAM_VALUE: 12
+
   incdirs:                           <---- incdirs, optional array of strings
     - ./
 
@@ -55,6 +61,7 @@ METADATA:                            <---- (optional) unstructured table
 
 my_target_name:
   defines:                           <---- defines, optional table
+  parameters:                        <---- parameters, optional table
   incdirs:                           <---- incdirs, optional array (or string)
   top: tb                            <---- top, optional string
   deps:                              <---- TARGET_DEPS_CONTENTS schema
@@ -105,6 +112,8 @@ my_target_name:
                                            to the current target for this named eda command.
     defines:                         <---- optional table, defines to be applied to the current
                                            target for this named eda command.
+    parameters:                      <---- optional table, parameters to be applied to the current
+                                           target to for this named eda command.
     incdirs:                         <---- optional array (or string) incdirs to be applied to
                                            the current target for this named eda command.
   tags:                              <---- tags, optional table using TARGET_TAGS_TABLE schema.
@@ -204,6 +213,9 @@ TARGET_EDA_COMMAND_ENTRY_TABLE = {
     Optional('defines'): {
         Optional(str): Or(str, int, type(None)),
     },
+    Optional('parameters'): {
+        Optional(str): Or(str, int),
+    },
     Optional('incdirs'): ARRAY_OR_SPACE_SEPARATED_STRING,
 }
 
@@ -226,6 +238,9 @@ TARGET_TAGS_TABLE = {
         Optional('defines'): {
             Optional(str): Or(str, int, type(None)),
         },
+        Optional('parameters'): {
+            Optional(str): Or(str, int),
+        },
         Optional('incdirs'): ARRAY_OR_SPACE_SEPARATED_STRING,
         Optional('replace-config-tools'): dict,
         Optional('additive-config-tools'): dict,
@@ -244,6 +259,10 @@ TARGET_CONTENTS = Or(
         Optional('defines'): {
             Optional(str): Or(str, int, type(None)),
         },
+        # parameters: table of key-value
+        Optional('parameters'): {
+            Optional(str): Or(str, int),
+        },
         # incdirs: array
         Optional('incdirs'): ARRAY_OR_SPACE_SEPARATED_STRING,
         # top: string
@@ -302,6 +321,9 @@ FILE_SIMPLIFIED = Schema(
                     Optional('defines'): {
                         Optional(str): Or(type(None), str),
                     },
+                    Optional('parameters'): {
+                        Optional(str): str,
+                    },
                     Optional('incdirs'): [str],
                     Optional('top'): str,
                     Optional('deps'): [str],

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/eda_base.py

@@ -831,7 +831,33 @@ class Command: # pylint: disable=too-many-public-methods
                 lines.append(indent_me(f"  --{k:20} : string     : {vstr:12}{khelp}"))
             else:
                 lines.append(indent_me(f"  --{k:20} : <unknown>  : {vstr:12}{khelp}"))
+
+        lines.append('')
+        lines.append(indent_me((
+            "  -G<parameterName>=<value>      "
+            " Add parameter to top level, support bit/int/string types only."
+            " Example: -GDEPTH=8 (DEPTH treated as SV int/integer)."
+            " -GENABLE=1 (ENABLED treated as SV bit/int/integer)."
+            " -GName=eda (Name treated as SV string \"eda\")."
+        )))
+        lines.append(indent_me((
+            "  +define+<defineName>           "
+            " Add define w/out value to tool ahead of SV sources"
+            " Example: +define+SIM_SPEEDUP"
+        )))
+        lines.append(indent_me((
+            "  +define+<defineName>=<value>   "
+            " Add define w/ value to tool ahead of SV sources"
+            " Example: +define+TECH_LIB=2 +define+FULL_NAME=\"E D A\""
+        )))
+        lines.append(indent_me((
+            "  +incdir+<path>                 "
+            " Add path (absolute or relative) for include directories"
+            " for SystemVerilog `include \"<some-file>.svh\""
+            " Example: +incdir+../lib"
+        )))
         lines.append('')
+
         for line in lines:
             print(line)
 
@@ -922,6 +948,7 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
             ),
         })
         self.defines = {}
+        self.parameters = {}
         self.incdirs = []
         self.files = {}
         self.files_v = []
@@ -1086,10 +1113,72 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
         # TODO(drew): Use the helper method in util for this instead to peek in file contents?
         return os.path.splitext(os.path.basename(name))[0]
 
+    def set_parameter(
+            self, name: str, value, caller_info: str = '(CLI)',
+            wrap_str_double_quotes: bool = True
+    ) -> None:
+        '''Safe wrapper for setting a parameter (can only set once, from CLI or DEPS)'''
+
+        if name in self.parameters:
+            util.debug("Parameter not set because it is already modified",
+                       f"(via -G<Name>=<Value>): {name}={value}; orig value",
+                       f'{self.parameters[name]} from {caller_info}')
+        else:
+            if isinstance(value, bool):
+                value = int(value)
+            elif isinstance(value, str):
+                value = strip_outer_quotes(value.strip('\n'))
+                if wrap_str_double_quotes:
+                    value = '"' + value + '"'
+            self.parameters[name] = value
+            util.debug(f"Parameter (via -G<Name>=<Value>): {name}={value}",
+                       f'from {caller_info}')
+
+
+    def process_parameter_arg(
+            self, text: str, pwd: str = os.getcwd()
+    ) -> None:
+        '''Retuns None, parses -G<Name>=<Value> adds to internal self.parameters.'''
+
+        # Deal with raw CLI/bash/powershell argparser, strip all outer quotes.
+        text = strip_outer_quotes(text)
+        if not pwd:
+            pwd = ''
+
+        if not text.startswith('-G'):
+            self.error(f"Didn't understand -G parameter arg: '{text}'",
+                       error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
+            return
+
+        text = text[2:] # strip leading -G
+        m = re.match(r'^(\w+)$', text)
+        if m:
+            k = m.group(1)
+            util.warning(f"Parameter {k} has no value and will not be applied")
+            return
+        m = re.match(r'^(\w+)\=(\S+)$', text)
+        if not m:
+            m = re.match(r'^(\w+)\=(\"[^\"]*\")$', text)
+        if m:
+            k = m.group(1)
+            v = m.group(2)
+            # since this is coming from a CLI string, we have to guess at types,
+            # for int or bool (not str) and convert bool to int:
+            if not isinstance(v, (int, str)):
+                self.error(f"Didn't understand -G parameter arg: name={k} value={v}",
+                           f"value must be int/str type, from: '{text}'",
+                           error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
+                return
+            try:
+                v = int(v)
+            except ValueError:
+                pass
+            self.set_parameter(k, v)
+
 
     def process_plusarg( # pylint: disable=too-many-branches
             self, plusarg: str, pwd: str = os.getcwd()
-    ) -> None:
+    ) -> str:
         '''Retuns str, parses a +define+, +incdir+, +key=value str; adds to internal.
 
         Adds to self.defines, self.incdirs,
@@ -1112,7 +1201,7 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                 k = m.group(1)
                 self.defines[k] = None
                 util.debug(f"Defined {k}")
-                return None
+                return ''
             m = re.match(r'^(\w+)\=(\S+)$', plusarg)
             if not m:
                 m = re.match(r'^(\w+)\=(\"[^\"]*\")$', plusarg)
@@ -1126,10 +1215,10 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                         v = v.replace('%SEED%', str(self.args.get('seed', 1)))
                 self.defines[k] = v
                 util.debug(f"Defined {k}={v}")
-                return None
+                return ''
             self.error(f"Didn't understand +define+: '{plusarg}'",
                        error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
-            return None
+            return ''
 
         if plusarg.startswith('+incdir+'):
             plusarg = plusarg[len('+incdir+'):]
@@ -1139,16 +1228,16 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                 if incdir not in self.incdirs:
                     self.incdirs.append(os.path.abspath(incdir))
                     util.debug(f"Added include dir '{os.path.abspath(incdir)}'")
-                return None
+                return ''
             self.error(f"Didn't understand +incdir+: '{plusarg}'",
                        error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
-            return None
+            return ''
 
         # remaining plusargs as stored in self.args['unprocessed-plusargs'] (list)
         if plusarg.startswith('+'):
             if not self.config.get('bare_plusarg_supported', False):
                 self.error(f"bare plusarg(s) are not supported: {plusarg}'")
-                return None
+                return ''
             if plusarg not in self.args['unprocessed-plusargs']:
                 self.args['unprocessed-plusargs'].append(plusarg)
                 # For anything added to unprocessed-plusarg, we have to return it, to let
@@ -1157,7 +1246,7 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
 
         self.error(f"Didn't understand +plusarg: '{plusarg}'",
                    error_code=status_constants.EDA_COMMAND_OR_ARGS_ERROR)
-        return None
+        return ''
 
 
     def append_shell_commands(self, cmds : list) -> None:
@@ -1439,8 +1528,8 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
         unparsed = Command.process_tokens(self, tokens, process_all=False, pwd=pwd)
         util.debug(f'CommandDesign - after Command.process_tokens(..) {unparsed=}')
 
-        # deal with +define+ or +incdir+, consume it and remove from unparsed
-        # walk the list, remove all items after we're done.
+        # deal with +define+, +incdir+, +(plusargName)+, or -GParameterName=Value:
+        # consume it and remove from unparsed, walk the list, remove all items after we're done.
         remove_list = []
         for token in unparsed:
             # Since this is a raw argparser, we may have args that come from shlex.quote(token),
@@ -1454,6 +1543,15 @@ class CommandDesign(Command): # pylint: disable=too-many-instance-attributes
                 plusarg = strip_outer_quotes(token)
                 self.process_plusarg(plusarg, pwd=pwd)
                 remove_list.append(token)
+                continue
+
+            # Parameters in -G<word>=<something>
+            m = re.match(r"^\'?\-G\w+\=.+", token)
+            if m:
+                # Copy and strip all outer ' or " on the text:
+                param = strip_outer_quotes(token)
+                self.process_parameter_arg(param, pwd=pwd)
+                remove_list.append(token)
 
         for x in remove_list:
             unparsed.remove(x)

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/eda_config.py

@@ -305,7 +305,8 @@ def write_eda_config_and_args(
     fullpath = os.path.join(dirpath, filename)
     data = {}
     for x in ['command_name', 'config', 'target', 'args', 'modified_args', 'defines',
-              'incdirs', 'files_v', 'files_sv', 'files_vhd']:
+              'incdirs', 'files_v', 'files_sv', 'files_vhd', 'files_cpp', 'files_sdc',
+              'files_non_source']:
         # Use deep copy b/c otherwise these are references to opencos.eda.
         data[x] = copy.deepcopy(getattr(command_obj_ref, x, ''))
 

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/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_eda-0.2.55 → opencos_eda-0.2.56}/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_eda-0.2.55 → opencos_eda-0.2.56}/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_eda-0.2.55 → opencos_eda-0.2.56}/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_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/invio_helpers.py

@@ -61,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"]:',
@@ -138,18 +144,34 @@ def write_py_file(
                                             tee_fpath = 'invio.log')]
     })
 
+    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 += [
-            'assert analyze()',
-            '',
             '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()',
             '',
@@ -159,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()',

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/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,',

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/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.
 

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/quartus.py

@@ -19,6 +19,7 @@ from opencos.eda_base import Tool
 from opencos.commands import (
     CommandSynth, CommandBuild, CommandFList, CommandProj, CommandUpload, CommandOpen
 )
+from opencos.utils.str_helpers import sanitize_defines_for_sh, strip_outer_quotes
 
 class ToolQuartus(Tool):
     '''ToolQuartus used by opencos.eda for --tool=quartus'''
@@ -225,6 +226,18 @@ class CommandSynthQuartus(CommandSynth, ToolQuartus):
         for incdir in self.incdirs:
             tcl_lines.append(f"set_global_assignment -name SEARCH_PATH \"{incdir}\"")
 
+        # Parameters -->  set_parameter -name <Parameter_Name> <Value>
+        for k,v in self.parameters.items():
+            if not isinstance(v, (int, str)):
+                util.warning(f'parameter {k} has value: {v}, parameters must be int/string types')
+            if isinstance(v, int):
+                tcl_lines.append(f"set_parameter -name {k} {v}")
+            else:
+                v = strip_outer_quotes(v.strip('\n'))
+                v = '"' + v + '"'
+                tcl_lines.append(f"set_parameter -name {k} {sanitize_defines_for_sh(v)}")
+
+
         # Add all include directories as user libraries for better include resolution
         for incdir in self.incdirs:
             if os.path.exists(incdir):
@@ -307,7 +320,7 @@ class CommandBuildQuartus(CommandBuild, ToolQuartus):
             'flow-tcl-files': [],
         })
 
-    def do_it(self) -> None: # pylint: disable=too-many-branches,too-many-statements
+    def do_it(self) -> None: # pylint: disable=too-many-branches,too-many-statements,too-many-locals
         # add defines for this job
         self.set_tool_defines()
         self.write_eda_config_and_args()
@@ -340,15 +353,25 @@ class CommandBuildQuartus(CommandBuild, ToolQuartus):
         # create an eda.flist_input.f that we'll pass to flist:
         with open(os.path.join(self.args['work-dir'], 'eda.flist_input.f'),
                   'w', encoding='utf-8') as f:
+
+            # defines
+            for key,value in self.defines.items():
+                if value is None:
+                    f.write(f"+define+{key}\n")
+                else:
+                    f.write(shlex.quote(f"+define+{key}={value}") + "\n")
+
+            # incdirs:
+            for incdir in self.incdirs:
+                f.write(f'+incdir+{incdir}\n')
+
+            # files:
             f.write('\n'.join(self.files_v + self.files_sv + self.files_vhd + ['']))
+
+
         command_list.append('--input-file=eda.flist_input.f')
 
 
-        for key,value in self.defines.items():
-            if value is None:
-                command_list += [ f"+define+{key}" ]
-            else:
-                command_list += [ shlex.quote(f"+define+{key}={value}") ]
 
         # Write out a .sh command for debug
         command_list = util.ShellCommandList(command_list, tee_fpath='run_eda_flist.log')
@@ -487,6 +510,9 @@ class CommandFListQuartus(CommandFList, ToolQuartus):
     def __init__(self, config: dict):
         CommandFList.__init__(self, config=config)
         ToolQuartus.__init__(self, config=self.config)
+        self.args.update({
+            'emit-parameter': False
+        })
 
 
 class CommandProjQuartus(CommandProj, ToolQuartus):

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/riviera.py

@@ -74,6 +74,17 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
     # Note: many of these we follow the same flow as CommandSimModelsimAse:
     # do_it, prepare_compile, compile, elaborate, simulate
 
+    def compile(self):
+        '''Override for CommandSimModelsimAse.compile() so we can set our own must_strings'''
+        if self.args['stop-before-compile']:
+            # don't run anything, save everyting we've already run in _prep_compile()
+            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',
+                                         must_strings=['Compile success 0 Errors'],
+                                         use_must_strings=False)
+
     def get_compile_command_lists(self, **kwargs) -> list:
         # This will also set up a compile.
         vsim_command_list = [
@@ -128,7 +139,6 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
             if v is None:
                 vlog_dot_f_lines += [ f'+define+{k}' ]
             else:
-
                 # if the value v is a double-quoted string, such as v='"hi"', the
                 # entire +define+NAME="hi" needs to wrapped in double quotes with the
                 # value v double-quotes escaped: "+define+NAME=\"hi\""
@@ -170,11 +180,15 @@ class CommandSimRiviera(CommandSimModelsimAse, ToolRiviera):
 
         voptargs_str = ""
         if self.args['gui'] or self.args['waves'] or self.args['coverage']:
-            voptargs_str = self.tool_config.get('simulate-waves-args',
-                                                '+accb +accr +access +r+w')
+            voptargs_str += self.tool_config.get('simulate-waves-args',
+                                                 '+accb +accr +access +r+w')
         if self.args['coverage']:
             voptargs_str += self.tool_config.get('coverage-args', '')
 
+        # 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.
 

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/slang.py

@@ -143,6 +143,11 @@ class CommandElabSlang(CommandElab, ToolSlang):
                 # --define-macro {k}={v}
                 command_list.append( f'{k}={sanitize_defines_for_sh(v)}' )
 
+        # parameters
+        command_list.extend(
+            self.process_parameters_get_list(arg_prefix='-G ')
+        )
+
         # Because many elab target-name won't match the --top needed for
         # slang, we'll leave this to arg --slang-top:
         if self.args.get('slang-top', None):

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/slang_yosys.py

@@ -10,6 +10,8 @@ import os
 from opencos import util
 from opencos.tools.yosys import ToolYosys, CommonSynthYosys, CommandLecYosys
 
+from opencos.commands.sim import parameters_dict_get_command_list
+
 class ToolSlangYosys(ToolYosys):
     '''Uses slang.so in yosys plugins directory, called via yosys > plugin -i slang'''
     _TOOL = 'slang_yosys'
@@ -109,6 +111,13 @@ class CommandSynthSlangYosys(CommonSynthYosys, ToolSlangYosys):
         ]
 
         read_slang_cmd += self.get_yosys_read_verilog_defines_incdirs_files()
+
+        # For slang step, need to resolve parameters too. We do NOT do this on
+        # subsquent yosys read_verilog steps.
+        read_slang_cmd += parameters_dict_get_command_list(
+            params=self.parameters, arg_prefix='-G '
+        )
+
         read_slang_cmd.append(f'--top {self.args["top"]}')
         return ' '.join(read_slang_cmd)
 

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/surelog.py

@@ -109,6 +109,11 @@ class CommandElabSurelog(CommandElab, ToolSurelog):
         for value in self.incdirs:
             command_list.append('+incdir+' + value)
 
+        # parameters
+        command_list.extend(
+            self.process_parameters_get_list(arg_prefix='-P')
+        )
+
         # defines:
         for k,v in self.defines.items():
             if v is None:

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/verilator.py

@@ -244,6 +244,11 @@ class VerilatorSim(CommandSim, ToolVerilator):
                 # +define+{k}={v}, but also for SystemVerilog plusargs
                 verilate_command_list += [ f'+define+{k}={sanitize_defines_for_sh(v)}' ]
 
+        # parameters
+        verilate_command_list.extend(
+            self.process_parameters_get_list(arg_prefix='-G')
+        )
+
         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,',

{opencos_eda-0.2.55 → opencos_eda-0.2.56}/opencos/tools/vivado.py

@@ -22,6 +22,9 @@ from opencos.eda_base import Tool
 from opencos.commands import CommandSim, CommandSynth, CommandProj, CommandBuild, \
     CommandFList, CommandUpload, CommandOpen
 
+from opencos.commands import sim
+
+
 class ToolVivado(Tool):
     '''ToolVivado used by opencos.eda for --tool=vivado'''
 
@@ -214,6 +217,12 @@ class CommandSimVivado(CommandSim, ToolVivado):
             command_list[0] += ".bat"
         command_list += self.tool_config.get('elab-args',
                                              '-s snapshot -timescale 1ns/1ps --stats').split()
+
+        # parameters
+        command_list.extend(
+            self.process_parameters_get_list(arg_prefix='-generic_top ')
+        )
+
         if self.tool_config.get('elab-waves-args', ''):
             command_list += self.tool_config.get('elab-waves-args', '').split()
         elif self.args['gui'] and self.args['waves']:
@@ -412,6 +421,9 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
         defines = ""
         for key, value in self.defines.items():
             defines += (f"-verilog_define {key}" + (" " if value is None else f"={value} "))
+        parameters = ' '.join(
+            sim.parameters_dict_get_command_list(params=self.parameters, arg_prefix='-generic ')
+        )
         incdirs = ' '.join([f'-include_dirs {x}' for x in self.incdirs])
         flatten = ""
         if self.args['flatten-all']:
@@ -457,10 +469,10 @@ class CommandSynthVivado(CommandSynth, ToolVivado):
         tcl_lines += [
             "# FIRST PASS -- auto_detect_xpm",
             "synth_design -rtl -rtl_skip_ip -rtl_skip_constraints -no_timing_driven -no_iobuf " \
-            + f"-top {top} {incdirs} {defines} {v}",
+            + f"-top {top} {incdirs} {defines} {parameters} {v}",
             f"auto_detect_xpm {v} ",
             f"synth_design -no_iobuf -part {part} {flatten} -constrset constraints_1 " \
-            + f"-top {top} {incdirs} {defines} {v}",
+            + f"-top {top} {incdirs} {defines} {parameters} {v}",
             f"write_verilog -force {top}.vg {v}",
             f"report_utilization -file {top}.flat.util.rpt {v}",
             f"report_utilization -file {top}.hier.util.rpt {v} -hierarchical " \
@@ -753,6 +765,7 @@ class CommandFListVivado(CommandFList, ToolVivado):
         CommandFList.__init__(self, config=config)
         ToolVivado.__init__(self, config=self.config)
         self.args['all-sv'] = False
+        self.args['emit-parameter'] = False
 
 
 class CommandUploadVivado(CommandUpload, ToolVivado):

{opencos_eda-0.2.55 → opencos_eda-0.2.56/opencos_eda.egg-info}/PKG-INFO

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

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