peakrdl-python 3.0.0rc8__tar.gz → 3.1.0rc1__tar.gz

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/.github/workflows/action.yaml

@@ -27,9 +27,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -52,9 +52,9 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -77,10 +77,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -107,10 +107,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -183,10 +183,10 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -306,7 +306,7 @@ jobs:
         python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Install dependencies
         run: |
@@ -341,10 +341,10 @@ jobs:
         lib_copy: [true, false]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -390,10 +390,10 @@ jobs:
         python-version: [3.9, "3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -433,9 +433,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -470,9 +470,9 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         name: Install Python
         with:
           python-version: "3.13"

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 3.0.0rc8
+Version: 3.1.0rc1
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:              GNU LESSER GENERAL PUBLIC LICENSE
@@ -286,9 +286,9 @@ assumes that peakrdl has been installed.
 To make use of the RAL with real hardware or a different simulation, the callbacks will need to be 
 connected to the appropriate access function in order to perform an address space reads and writes 
 
-# Upgrading from previous versions (some important changes)
+# Some important changes
 
-## Upgrading from pre 0.9.0
+## 0.9.0
 
 In order to address a major limitation of peakrdl-python that prevented it from implementing the
 full systemRDL specification, a breaking API change was needed for handling blocks:
@@ -299,7 +299,7 @@ Users are encouraged to upgrade in order to avoid this limitation. However, ther
 to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
 documentation
 
-## Upgrading from pre 1.2.0
+## 1.2.0
 
 Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
 metadata from the systemRDL to propagate through to the generated code. This may break advanced 
@@ -307,7 +307,7 @@ usage of the python enumerations. User are encouraged to use the new feature, ho
 are problems with the old enumeration types (based on `IntEnum`) can be used, see 
 _Legacy Enumeration Types_ in the documentation
 
-## Upgrading from pre 2.0.0
+## 2.0.0
 
 Version 2.0.0 introduced a significant change to the process for building the register model python
 code. This change was intended to reduce the size of the generated code by only generating 
@@ -325,4 +325,20 @@ changing each time it was regenerated, version 2.1.0 introduces a option to eith
   of large register models but will be consistent, therefore is useful if the resultant code is being
   checked into a version control system (such as GIT) and the differences are being reviewed
 
+## 3.0.0
+
+Version 3.0.0 has included a significant refactoring of the generated test cases, moving functions out
+of the templates (generated code) in favour of an enhanced test library. On some cases, this 
+reduced the size of the test case generated code by 90%, significantly improved the time to generate
+the code and also improved the time to run the tests by a 30% reduction.
+
+In preparation for the removal of some legacy features from the early versions in release 4.0.0, 
+the following options were changed:
+- Version 1.2 introduced a new custom enumeration type (rather than using `IntEnum`) in order to allow
+  the content to `name` and `desc` systemRDL properties in be accessible. Until version 3.0.0 the new
+  type was not the default, it now is. The old enumeration types can still be used by setting `legacy_enum_type`.
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so the a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour is no longer the default but can be turned on using the `legacy_block_access`
+
 

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/README.md

@@ -75,9 +75,9 @@ assumes that peakrdl has been installed.
 To make use of the RAL with real hardware or a different simulation, the callbacks will need to be 
 connected to the appropriate access function in order to perform an address space reads and writes 
 
-# Upgrading from previous versions (some important changes)
+# Some important changes
 
-## Upgrading from pre 0.9.0
+## 0.9.0
 
 In order to address a major limitation of peakrdl-python that prevented it from implementing the
 full systemRDL specification, a breaking API change was needed for handling blocks:
@@ -88,7 +88,7 @@ Users are encouraged to upgrade in order to avoid this limitation. However, ther
 to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
 documentation
 
-## Upgrading from pre 1.2.0
+## 1.2.0
 
 Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
 metadata from the systemRDL to propagate through to the generated code. This may break advanced 
@@ -96,7 +96,7 @@ usage of the python enumerations. User are encouraged to use the new feature, ho
 are problems with the old enumeration types (based on `IntEnum`) can be used, see 
 _Legacy Enumeration Types_ in the documentation
 
-## Upgrading from pre 2.0.0
+## 2.0.0
 
 Version 2.0.0 introduced a significant change to the process for building the register model python
 code. This change was intended to reduce the size of the generated code by only generating 
@@ -114,4 +114,20 @@ changing each time it was regenerated, version 2.1.0 introduces a option to eith
   of large register models but will be consistent, therefore is useful if the resultant code is being
   checked into a version control system (such as GIT) and the differences are being reviewed
 
+## 3.0.0
+
+Version 3.0.0 has included a significant refactoring of the generated test cases, moving functions out
+of the templates (generated code) in favour of an enhanced test library. On some cases, this 
+reduced the size of the test case generated code by 90%, significantly improved the time to generate
+the code and also improved the time to run the tests by a 30% reduction.
+
+In preparation for the removal of some legacy features from the early versions in release 4.0.0, 
+the following options were changed:
+- Version 1.2 introduced a new custom enumeration type (rather than using `IntEnum`) in order to allow
+  the content to `name` and `desc` systemRDL properties in be accessible. Until version 3.0.0 the new
+  type was not the default, it now is. The old enumeration types can still be used by setting `legacy_enum_type`.
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so the a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour is no longer the default but can be turned on using the `legacy_block_access`
+
 

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/docs/generated_package.rst

@@ -9,6 +9,7 @@ will be based on the top level address map name with the package was generated
 
 | ``<root_name>``
 | ├── ``lib``
+| ├── ``lib_test``
 | ├── ``sim_lib``
 | ├── ``reg_model``
 | │ └── ``<root_name>.py``
@@ -20,8 +21,9 @@ will be based on the top level address map name with the package was generated
 In the folder structure above:
 
 - ``<root_name>.py`` - This is the register access layer code for the design
-- ``test_<root_name>.py`` - This is a set of autogenerated unittests to verify the register access layer
+- ``test_<root_name>.py`` - This is a set of autogenerated unittests to verify the register access layer (The unit test generation can be skipped, see ``skip_test_case_generation``)
 - ``lib`` - This is a package of base classes used by the register access layer (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
+- ``lib_test`` - This is a package of base classes autogenerated unit tests (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
 - ``sim_lib`` - This is a package of base classes used by the register access layer simulator (The copy of this can be skipped, see :ref:`skipping-lib-copy`)
 
 .. versionchanged:: 2.0.0
@@ -30,6 +32,11 @@ In the folder structure above:
     than building the whole register model in a single python module. This helps avoid
     excessively large files which helps speed up the generation and loading time.
 
+.. versionchanged:: 3.0.0
+
+    The auto-generated unit tests were changed in version 3.0.0 to split to make use
+    of a test library, which significantly reduced the size of the generated code.
+
 Top Level Classes
 -----------------
 
@@ -74,8 +81,10 @@ Callbacks
 =========
 
 The Register Access Layer will typically interfaced to a driver that
-allows accesses the chip. However, it can also be interfaced to a simulation
-of the device.
+allows accesses the chip.
+
+.. tip:: The simulator generated with the register model can be used as an alternative to
+         a hardware connection
 
 In order to operate the register access layer typically requires the following:
 

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/generate_and_test.py

@@ -222,6 +222,7 @@ if __name__ == '__main__':
         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=

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/src/peakrdl_python/__about__.py

@@ -17,4 +17,4 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "3.0.0rc8"
+__version__ = "3.1.0rc1"

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/src/peakrdl_python/lib/base.py

@@ -97,6 +97,35 @@ class Base(ABC):
         """
         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]:
         """

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/src/peakrdl_python/lib/base_field.py

@@ -404,7 +404,7 @@ class _FieldReadOnlyFramework(Field[FieldType], ABC):
                              'than or equal to 0')
 
         if value > self.__parent_register.max_value:
-            raise ValueError(f'value to bede coded must be less than or equal '
+            raise ValueError(f'value to be decoded must be less than or equal '
                              f'to {self.__parent_register.max_value:d}')
 
         if self.msb0 is False:

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/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
 

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/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 %}

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/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 %}

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/src/peakrdl_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 3.0.0rc8
+Version: 3.1.0rc1
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:              GNU LESSER GENERAL PUBLIC LICENSE
@@ -286,9 +286,9 @@ assumes that peakrdl has been installed.
 To make use of the RAL with real hardware or a different simulation, the callbacks will need to be 
 connected to the appropriate access function in order to perform an address space reads and writes 
 
-# Upgrading from previous versions (some important changes)
+# Some important changes
 
-## Upgrading from pre 0.9.0
+## 0.9.0
 
 In order to address a major limitation of peakrdl-python that prevented it from implementing the
 full systemRDL specification, a breaking API change was needed for handling blocks:
@@ -299,7 +299,7 @@ Users are encouraged to upgrade in order to avoid this limitation. However, ther
 to support users with existing designs, see: _Legacy Block Callback and Block Access_ in the 
 documentation
 
-## Upgrading from pre 1.2.0
+## 1.2.0
 
 Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
 metadata from the systemRDL to propagate through to the generated code. This may break advanced 
@@ -307,7 +307,7 @@ usage of the python enumerations. User are encouraged to use the new feature, ho
 are problems with the old enumeration types (based on `IntEnum`) can be used, see 
 _Legacy Enumeration Types_ in the documentation
 
-## Upgrading from pre 2.0.0
+## 2.0.0
 
 Version 2.0.0 introduced a significant change to the process for building the register model python
 code. This change was intended to reduce the size of the generated code by only generating 
@@ -325,4 +325,20 @@ changing each time it was regenerated, version 2.1.0 introduces a option to eith
   of large register models but will be consistent, therefore is useful if the resultant code is being
   checked into a version control system (such as GIT) and the differences are being reviewed
 
+## 3.0.0
+
+Version 3.0.0 has included a significant refactoring of the generated test cases, moving functions out
+of the templates (generated code) in favour of an enhanced test library. On some cases, this 
+reduced the size of the test case generated code by 90%, significantly improved the time to generate
+the code and also improved the time to run the tests by a 30% reduction.
+
+In preparation for the removal of some legacy features from the early versions in release 4.0.0, 
+the following options were changed:
+- Version 1.2 introduced a new custom enumeration type (rather than using `IntEnum`) in order to allow
+  the content to `name` and `desc` systemRDL properties in be accessible. Until version 3.0.0 the new
+  type was not the default, it now is. The old enumeration types can still be used by setting `legacy_enum_type`.
+- The first versions of PeakRDL Python used the built-in `Array` type for accessing blocks of data efficiently.
+  This had some restrictions, so the a new methodology based on the `list` type was introduced in version 0.9.
+  The old array based behaviour is no longer the default but can be turned on using the `legacy_block_access`
+
 

{peakrdl_python-3.0.0rc8 → peakrdl_python-3.1.0rc1}/src/peakrdl_python.egg-info/SOURCES.txt

@@ -172,6 +172,7 @@ tests/testcases/simulator_test.rdl
 tests/testcases/sizes_registers.rdl
 tests/testcases/sizes_registers_array.rdl
 tests/testcases/sparse_enum_issue_200.rdl
+tests/testcases/udp_with_referencing.rdl
 tests/testcases/user_defined_properties.rdl
 tests/testcases/write_only_enum_with_undefined_reset.rdl
 tests/unit_tests/__init__.py

peakrdl_python-3.1.0rc1/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;
+};