Merge pull request #296 from krcb197/release/3.1.0

Release 3.1.0

Author: krcb197

.github/workflows/action.yaml

@@ -161,7 +161,8 @@ jobs:
           sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp bool_property_to_include enum_property_to_include int_property_to_include str_property_to_include struct_property_to_include double_layer_struct_property_to_include
           sleep 10
-          
+          python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp bool_property_to_include enum_property_to_include int_property_to_include str_property_to_include struct_property_to_include double_layer_struct_property_to_include int_array_property_to_include str_array_property_to_include enum_array_property_to_include
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp_regex "bool_property_to_include|enum_property_to_include|int_property_to_include|str_property_to_include|struct_property_to_include|double_layer_struct_property_to_include"
           sleep 10
 

generate_and_test.py

@@ -222,6 +222,7 @@ def build_logging_cong(logfilepath:str):
         skip_library_copy=not CommandLineArgs.copy_libraries,
         legacy_block_access=CommandLineArgs.legacy_block_access,
         user_defined_properties_to_include=CommandLineArgs.udp,
+        user_defined_properties_to_include_regex=CommandLineArgs.udp_regex,
         hidden_inst_name_regex=CommandLineArgs.hide_regex,
         legacy_enum_type=CommandLineArgs.legacy_enum_type,
         skip_systemrdl_name_and_desc_properties=

src/peakrdl_python/__about__.py

@@ -17,4 +17,4 @@
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "3.0.0"
+__version__ = "3.1.0"

src/peakrdl_python/exporter.py

@@ -243,6 +243,7 @@ def visible_nonsignal_node(node: Node) -> int:
             'asyncoutput': asyncoutput,
             'isinstance': isinstance,
             'str': str,
+            'list': list,
             'uses_enum': uses_enum(top_block),
             'get_fully_qualified_type_name': partial(
                 unique_component_walker.python_class_name,
@@ -414,14 +415,18 @@ def init_line_entry(module_name: str,
 
                 context = {
                     'top_node': top_block,
-                    'systemrdlRegNode': RegNode,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlSignalNode': SignalNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list': list,
                     'asyncoutput': asyncoutput,
                     'unique_registers': unique_register_subset,
                     'unique_property_enums':
@@ -511,14 +516,18 @@ def init_line_entry(module_name:str,
 
                 context = {
                     'top_node': top_block,
-                    'systemrdlMemNode': MemNode,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlSignalNode': SignalNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list' : list,
                     'asyncoutput': asyncoutput,
                     'unique_memories': unique_memory_subset,
                     'unique_property_enums':
@@ -584,11 +593,16 @@ def __export_reg_model_fields(self, *,
                 context = {
                     'top_node': top_block,
                     'systemrdlFieldNode': FieldNode,
+                    'systemrdlRegNode': RegNode,
+                    'systemrdlRegfileNode': RegfileNode,
+                    'systemrdlAddrmapNode': AddrmapNode,
+                    'systemrdlMemNode': MemNode,
                     'systemrdlUserStruct': UserStruct,
                     'systemrdlUserEnum': UserEnum,
                     'isinstance': isinstance,
                     'type': type,
                     'str': str,
+                    'list': list,
                     'asyncoutput': asyncoutput,
                     'unique_fields': unique_fields_subset,
                     'unique_property_enums':
@@ -845,6 +859,7 @@ def is_reg_node(node: Node) -> TypeGuard[RegNode]:
                 'isinstance': isinstance,
                 'type': type,
                 'str': str,
+                'list': list,
                 'full_slice_accessor': full_slice_accessor,
                 'get_python_path_segments': get_python_path_segments,
                 'safe_node_name': safe_node_name,
@@ -1167,7 +1182,7 @@ def _get_dependent_property_enum( unique_components: UniqueComponents) -> \
         """
         enum_needed: list[UserEnumMeta] = []
 
-        def walk_property_struct_node(value: Any) -> None:
+        def walk_property_subnode(value: Any) -> None:
             if isinstance(value, UserEnum) and type(value) not in enum_needed:
                 enum_type = type(value)
                 if not isinstance(enum_type, UserEnumMeta):
@@ -1176,19 +1191,15 @@ def walk_property_struct_node(value: Any) -> None:
 
             if isinstance(value, UserStruct):
                 for sub_value in value.members.values():
-                    walk_property_struct_node(sub_value)
+                    walk_property_subnode(sub_value)
+
+            if isinstance(value, list):
+                for sub_value in value:
+                    walk_property_subnode(sub_value)
 
         for node in unique_components.nodes.values():
             for node_property_name in node.properties_to_include:
                 node_property = node.instance.get_property(node_property_name)
-                if isinstance(node_property, UserEnum) and type(node_property) not in enum_needed:
-                    enum_type = type(node_property)
-                    if not isinstance(enum_type, UserEnumMeta):
-                        raise TypeError(f'enum type should be UserEnumMeta, got {type(enum_type)}')
-                    enum_needed.append(enum_type)
-
-                if isinstance(node_property, UserStruct):
-                    for sub_value in node_property.members.values():
-                        walk_property_struct_node(sub_value)
+                walk_property_subnode(node_property)
 
         return enum_needed

src/peakrdl_python/lib/base.py

@@ -26,12 +26,15 @@
 from itertools import product
 from enum import IntEnum, Enum, auto
 import math
+import re
 
 from .callbacks import CallbackSet, CallbackSetLegacy
 
 UDPStruct = dict[str, 'UDPType']
 UDPType = Union[str, int, bool, IntEnum, UDPStruct]
 
+array_instance_re = re.compile(r'(?P<root_name>[A-Za-z_0-9]*)\[(?P<index>\d+)\]')
+
 class Base(ABC):
     """
     base class of for all types
@@ -97,6 +100,35 @@ def udp(self) -> UDPStruct:
         """
         return {}
 
+    def _traverse_from_fully_qualified_name(self, fully_qualified_name: list[str]) -> 'Base':
+        """
+        This method allows another node in the structure to located based on a list of string
+        which represented the systemRDL path.
+
+        This function is intended for use with UDPs which reference other UDPs
+        """
+
+        # 1) location the root node by walking backwards up the tree until the parent is
+        #    found
+        def locate_root(node: 'Base') -> 'Base':
+            if node.parent is None:
+                return node
+            return locate_root(node.parent)
+        root_node = locate_root(self)
+        # 2) check the 1st entry in the list matches the name of the root
+        if root_node.inst_name != fully_qualified_name[0]:
+            raise RuntimeError('root node name mismatch')
+        # 3) start walking down the tree matching the nodes
+        walking_node = root_node
+        for node_name in fully_qualified_name[1:]:
+            if not isinstance(walking_node, Node):
+                # the current node being traversed must be a Node type i.e. not a field
+                raise RuntimeError('node traversal has failed as type:{type(walking_node)} was'
+                                   ' unexpectedly encountered')
+            walking_node = walking_node.get_child_by_system_rdl_name(node_name)
+
+        return walking_node
+
     @property
     def rdl_name(self) -> Optional[str]:
         """
@@ -200,6 +232,18 @@ def get_child_by_system_rdl_name(self, name: Any) -> Any:
         """
         if not isinstance(name, str):
             raise TypeError(f'name must be a string got {type(name)}')
+
+        # check if an array style child pointer
+        array_name_match = array_instance_re.match(name)
+        if array_name_match:
+            root_name = array_name_match.group("root_name")
+            index = int(array_name_match.group("index"))
+            child_array = getattr(self, self.systemrdl_python_child_name_map[root_name])
+            if not isinstance(child_array, NodeArray):
+                raise ValueError('attempting to use array indexing into a non-array '
+                                 f'node: {root_name} of type:{type(child_array)}')
+            return child_array[index]
+
         return getattr(self, self.systemrdl_python_child_name_map[name])
 
     @property

src/peakrdl_python/systemrdl_node_hashes.py

@@ -143,7 +143,7 @@ def __node_hash_components(node: Node,
                            udp_include_func: ShowUDPCallback,
                            include_name_and_desc: bool = True) -> list[Any]:
 
-    value_to_hash = []
+    value_to_hash:list[Any] = []
 
     if isinstance(node, FieldNode):
         value_to_hash.append('Field')
@@ -167,8 +167,18 @@ def __node_hash_components(node: Node,
         if desc is not None:
             value_to_hash.append(desc)
 
+    def udp_replace_for_hashing(item: Any) -> None:
+        if isinstance(item, list):
+            for child_udp_value in item:
+                udp_replace_for_hashing(child_udp_value)
+        elif isinstance(item, Node):
+            value_to_hash.append('.'.join(item.get_path_segments()))
+        else:
+            value_to_hash.append(item)
+
     for udp in get_properties_to_include(node, udp_include_func):
-        value_to_hash.append(node.get_property(udp))
+        udp_value = node.get_property(udp)
+        udp_replace_for_hashing(udp_value)
 
     return value_to_hash
 

src/peakrdl_python/templates/addrmap_tb.py.jinja

@@ -79,6 +79,7 @@ from ._{{top_node.inst_name}}_test_base import __name__ as base_name
 from ._{{top_node.inst_name}}_test_base import random_enum_reg_value
 
 {% from 'addrmap_udp_property.py.jinja' import udp_property_dict_entry with context %}
+{% from 'addrmap_udp_property.py.jinja' import udp_property_entry with context %}
 
 class {{fq_block_name}}_single_access({{top_node.inst_name}}_TestCase): # type: ignore[valid-type,misc]
 
@@ -96,16 +97,10 @@ class {{fq_block_name}}_single_access({{top_node.inst_name}}_TestCase): # type:
             {% else %}
                 {% for property_name in property_list %}
                 {% set property_value = node.get_property(property_name) %}
-                    {% if isinstance(property_value, systemrdlUserStruct) %}
-            self.assertDictEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], {    # type: ignore[arg-type]
-            {% for sub_name, sub_value in property_value.members.items() %} {{udp_property_dict_entry(sub_name, sub_value)}} {% endfor %}
-                } )
-                    {% elif isinstance(property_value, systemrdlUserEnum) %}
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], {{ type(property_value).type_name }}_property_enumcls.{{ property_value.name.upper() }} )
-                     {% elif isinstance(property_value, str) %}
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], "{{ property_value }}" )
+                    {% if isinstance(property_value, list) %}
+            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], [{% for sub_property_value in property_value %}{{ udp_property_entry(sub_property_value, true) }},{% endfor %}] )
                     {% else %}
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], {{ property_value }} )
+            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], {{ udp_property_entry(property_value, true) }} )
                     {% endif %}
                 {% endfor %}
             {% endif %}

src/peakrdl_python/templates/addrmap_udp_property.py.jinja

@@ -16,20 +16,34 @@ You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 #}
 
-{%- macro udp_property_dict_entry(name, value) %}
-    {% if isinstance(value, systemrdlUserStruct) %}
-    '{{name}}' : {
-        {% for sub_name, sub_value in value.members.items() %}
-        {{udp_property_dict_entry(sub_name, sub_value)|indent(4)}}
-        {% endfor %}
-                },
-    {% elif isinstance(value, systemrdlUserEnum) %}
-    '{{name}}' : {{ type(value).type_name + '_property_enumcls.' + value.name.upper() }} ,
-    {% elif isinstance(value, str) %}
-    '{{name}}' : "{{ value }}" ,
-    {% else %}
-    '{{name}}' : {{ value }} ,
-    {% endif %}
+{%- macro udp_property_entry(value, full_qual_resolution) %}
+    {%- if isinstance(value, systemrdlUserStruct) -%}
+    {
+        {%- for sub_name, sub_value in value.members.items() %}
+        {{udp_property_dict_entry(sub_name, sub_value, full_qual_resolution)|indent(4)}}
+        {%- endfor %}
+    }
+    {%- elif isinstance(value, systemrdlUserEnum) -%}
+    {{ type(value).type_name + '_property_enumcls.' + value.name.upper() }}
+    {%- elif isinstance(value, str) -%}
+    "{{ value }}"
+    {%- elif isinstance(value, (systemrdlFieldNode, systemrdlRegNode, systemrdlRegfileNode, systemrdlAddrmapNode, systemrdlMemNode)) -%}
+        {%- if full_qual_resolution -%}
+    self.dut.{{'.'.join(get_python_path_segments(value))}}
+        {%- else -%}
+    self._traverse_from_fully_qualified_name({{ value.get_path_segments() }})
+        {%- endif -%}
+    {%- else -%}
+    {{ value }}
+    {%- endif -%}
+{%- endmacro %}
+
+{%- macro udp_property_dict_entry(name, value, full_qual_resolution) %}
+    {%- if isinstance(value, list) -%}
+    '{{name}}' : [ {% for sub_value in value %}{{udp_property_entry(sub_value, full_qual_resolution)}}, {% endfor %}],
+    {%- else -%}
+    '{{name}}' : {{ udp_property_entry(value, full_qual_resolution) }},
+    {%- endif %}
 {% endmacro %}
 
 {%- macro udp_property(node) %}
@@ -39,9 +53,9 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
     @property
     def udp(self) -> UDPStruct:
         return {
-            {% for property_name in property_list %}
-            {{udp_property_dict_entry(property_name, node.instance.get_property(property_name))}}
-            {% endfor %}
+            {% for property_name in property_list -%}
+            {{udp_property_dict_entry(property_name, node.instance.get_property(property_name), false)|indent(4)}}
+            {%- endfor %}
                }
 
     {% endif %}