Added support for referencing a field in a UDP

Author: krcb197

src/peakrdl_python/lib/base.py

@@ -97,6 +97,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]:
         """

src/peakrdl_python/systemrdl_node_hashes.py

@@ -168,7 +168,12 @@ def __node_hash_components(node: Node,
             value_to_hash.append(desc)
 
     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)
+        # systemRDL supports UDPs that cross-reference other parts of the register model
+        if isinstance(udp_value, Node):
+            value_to_hash.append('.'.join(udp_value.get_path_segments()))
+        else:
+            value_to_hash.append(node.get_property(udp))
 
     return value_to_hash
 

src/peakrdl_python/templates/addrmap_tb.py.jinja

@@ -102,8 +102,10 @@ class {{fq_block_name}}_single_access({{top_node.inst_name}}_TestCase): # type:
                 } )
                     {% 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) %}
+                    {% elif isinstance(property_value, str) %}
             self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], "{{ property_value }}" )
+                    {% elif isinstance(property_value, systemrdlFieldNode) %}
+            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'],  self.dut.{{'.'.join(get_python_path_segments(property_value))}} )
                     {% else %}
             self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.udp['{{property_name}}'], {{ property_value }} )
                     {% endif %}

src/peakrdl_python/templates/addrmap_udp_property.py.jinja

@@ -27,6 +27,8 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
     '{{name}}' : {{ type(value).type_name + '_property_enumcls.' + value.name.upper() }} ,
     {% elif isinstance(value, str) %}
     '{{name}}' : "{{ value }}" ,
+    {% elif isinstance(value, systemrdlFieldNode) %}
+    '{{name}}' : self._traverse_from_fully_qualified_name({{ value.get_path_segments() }}) ,
     {% else %}
     '{{name}}' : {{ value }} ,
     {% endif %}

tests/testcases/udp_with_referencing.rdl

@@ -0,0 +1,31 @@
+/*
+Testcase the #292 bug
+with a UDP that cross-references another
+*/
+property field_pointer {
+    type = field;
+    component = field;
+};
+
+property register_pointer {
+    type = reg;
+    component = reg;
+};
+
+addrmap udp_with_referencing {
+    reg {
+        field {
+            hw = rw;
+            sw = rw;
+        } value;
+    } view;
+
+    reg {
+        field {
+            hw = rw;
+            sw = rw;
+        } value;
+    } pointer;
+
+    view.value->field_pointer = pointer.value;
+};