Release/3.0.0

.github/workflows/action.yaml

@@ -134,26 +134,42 @@ jobs:
         run: |
 
           python -m generate_and_test --RDL_source_file tests/testcases/simulator_test.rdl --root_node simulator_test
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/simulator_test.rdl --root_node simulator_test --async
+          sleep 10
 
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_block_access
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_enum_type
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --copy_libraries
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --hashing_mode PYTHONHASH
+          sleep 10
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --hashing_mode SHA256
+          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
+          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
+          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
+          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
+          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_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
 
           python -m generate_and_test --RDL_source_file tests/testcases/reserved_elements.rdl --root_node reserved_elements --hide_regex "(?:[\w_\[\]]+\.)+RSVD"
+          sleep 10
 
           python -m generate_and_test --RDL_source_file tests/testcases/name_desc_all_levels.rdl --root_node name_desc_all_levels --skip_systemrdl_name_and_desc_properties
+          sleep 10
 
   peakrdl_integration:
     needs:
@@ -323,7 +339,6 @@ jobs:
       matrix:
         python-version: [3.9, "3.10", "3.11", "3.12", "3.13", "3.14"]
         lib_copy: [true, false]
-        hashing_mode: ["PYTHONHASH", "SHA256"]
 
     steps:
     - uses: actions/checkout@v4
@@ -349,12 +364,12 @@ jobs:
     - name: Generate testcases (lib_copy true)
       if: matrix.lib_copy == true
       run: |
-        python generate_testcases.py --copy_libraries --output testcase_output --hashing_mode ${{ matrix.hashing_mode }}
+        python generate_testcases.py --copy_libraries --output testcase_output
 
     - name: Generate testcases (lib_copy false)
       if: matrix.lib_copy == false
       run: |
-        python generate_testcases.py --output testcase_output --hashing_mode ${{ matrix.hashing_mode }}
+        python generate_testcases.py --output testcase_output
 
     - name: Static checks
       run: |

docs/conf.py

@@ -45,7 +45,16 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_url": "https://github.com/krcb197/PeakRDL-python",
+    "path_to_docs": "docs",
+    "use_download_button": False,
+    "use_source_button": True,
+    "use_repository_button": True,
+    "use_issues_button": True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/requirements.txt

@@ -1,3 +1,3 @@
 pygments-systemrdl
 peakrdl-python
-sphinx_rtd_theme
+sphinx-book-theme

generate_and_test.py

@@ -36,7 +36,7 @@
 
 #from coverage import Coverage
 
-#from peakrdl_ipxact import IPXACTImporter
+from peakrdl_ipxact import IPXACTImporter
 
 sys.path.append('src')
 from peakrdl_python import PythonExporter
@@ -46,6 +46,8 @@
 CommandLineParser = argparse.ArgumentParser(description='Test the framework')
 CommandLineParser.add_argument('--RDL_source_file', dest='root_RDL_file',
                                type=pathlib.Path, required=True)
+CommandLineParser.add_argument('--RDL_additional_file', dest='additional_file_RDL_file',
+                               type=pathlib.Path)
 CommandLineParser.add_argument('--root_node', dest='root_node',
                                type=str, required=True)
 CommandLineParser.add_argument('--output', dest='output_path',
@@ -195,13 +197,15 @@ def build_logging_cong(logfilepath:str):
         else:
             raise(RuntimeError('not a list'))
 
+    if CommandLineArgs.additional_file_RDL_file is not None:
+        rdlc.compile_file(CommandLineArgs.additional_file_RDL_file)
     rdlc.compile_file(CommandLineArgs.root_RDL_file)
     spec = rdlc.elaborate(top_def_name=CommandLineArgs.root_node).top
 
     node_list = []
     for node in spec.descendants(unroll=True):
         node_list.append(node)
-        print(node.inst_name)
+        # print(node.inst_name)
 
     # write out text file of all the nodes names, this can be used to debug regex issues
     if CommandLineArgs.full_inst_file is not None:

generate_testcases.py

@@ -49,16 +49,6 @@
                                     'and debugging as multiple copies of the libraries can cause'
                                     'confusion. Therefore by default this script does not copy '
                                     'them over.')
-CommandLineParser.add_argument('--hashing_mode',
-                               dest='hashing_mode',
-                               type=str,
-                               choices=[item.name for item in NodeHashingMethod],
-                               default='PYTHONHASH',
-                               help='The method used to generate the hash of the node, in order to '
-                                    'deduplicate the register model. Set this to `SHA256` if '
-                                    'the python names need to stay consistent one export to the '
-                                    'next. However, this mode is slower')
-
 
 def compile_rdl(infile: str,
                 incl_search_paths: Optional[List[str]] = None,
@@ -158,19 +148,22 @@ def generate(root: Node, outdir: str,
         options = {
             'asyncoutput': [True, False],
             'legacy': [True, False],
-            'skip_systemrdl_name_and_desc_in_docstring': [True, False]
+            'skip_systemrdl_name_and_desc_in_docstring': [True, False],
+            'hashing': list(NodeHashingMethod)
         }
 
-        for asyncoutput, legacy, skip_name_and_desc_in_docstring in product(
+        for asyncoutput, legacy, skip_name_and_desc_in_docstring, hashing_method in product(
                 options['asyncoutput'], options['legacy'],
-                options['skip_systemrdl_name_and_desc_in_docstring'] ):
+                options['skip_systemrdl_name_and_desc_in_docstring'],
+                options['hashing']):
 
             # test cases that use the extended widths an not be tested in the non-legacy modes
             if (testcase_name in ['extended_memories', 'extended_sizes_registers_array']) and \
                     (legacy is True):
                 continue
 
-            folder_parts = 'raw'
+            folder_parts = 'raw_'
+            folder_parts += hashing_method.name
             if asyncoutput:
                 folder_parts += '_async'
             if legacy:
@@ -184,7 +177,7 @@ def generate(root: Node, outdir: str,
                          legacy_enum_type=legacy,
                          copy_library=CommandLineArgs.copy_libraries,
                          skip_systemrdl_name_and_desc_in_docstring=skip_name_and_desc_in_docstring,
-                         hashing_mode=NodeHashingMethod[CommandLineArgs.hashing_mode])
+                         hashing_mode=hashing_method)
 
             module_fqfn = output_path / folder_parts / '__init__.py'
             with open(module_fqfn, 'w', encoding='utf-8') as fid:

pyproject.toml

@@ -63,7 +63,11 @@ dev = [
     "mypy",
     "pylint",
     "coverage",
-    "peakrdl"
+    "peakrdl",
+    # needed for the documentation build
+    "sphinx-book-theme",
+    "pygments-systemrdl"
+
 ]
 peakrdl = [
     "peakrdl"

src/peakrdl_python/__about__.py

@@ -3,8 +3,8 @@
 Copyright (C) 2021 - 2025
 
 This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as 
-published by the Free Software Foundation, either version 3 of 
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of
 the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
@@ -17,4 +17,4 @@
 
 Variables that describes the peakrdl-python Package
 """
-__version__ = "2.2.0"
+__version__ = "3.0.0rc8"

src/peakrdl_python/_deploy_package.py

@@ -154,8 +154,10 @@ class GeneratedPackage(PythonPackage):
     Args:
         include_tests (bool): include the tests package
     """
+    # pylint:disable=too-many-instance-attributes
     template_lib_package = PythonPackage(Path(__file__).parent / 'lib')
     template_sim_lib_package = PythonPackage(Path(__file__).parent / 'sim_lib')
+    template_lib_test_package = PythonPackage(Path(__file__).parent / 'lib_test')
 
     def __init__(self, path: str, package_name: str, include_tests: bool, include_libraries: bool):
         super().__init__(Path(path) / package_name)
@@ -169,6 +171,9 @@ def __init__(self, path: str, package_name: str, include_tests: bool, include_li
         self.reg_model = _GeneratedRegModelPackage(self.child_path('reg_model'))
 
         if include_tests:
+            if include_libraries:
+                self.lib_test = self.child_ref_package('lib_test',
+                                                       self.template_lib_test_package)
             self.tests = self.child_package('tests')
 
         if include_libraries:
@@ -200,4 +205,6 @@ def create_empty_package(self, cleanup: bool) -> None:
         if self._include_libraries:
             self.lib.create_empty_package(cleanup=cleanup)
             self.sim_lib.create_empty_package(cleanup=cleanup)
+            if self._include_tests:
+                self.lib_test.create_empty_package(cleanup=cleanup)
         self.sim.create_empty_package(cleanup=cleanup)

src/peakrdl_python/exporter.py

@@ -46,7 +46,8 @@
     get_memory_max_entry_value_hex_string, get_memory_width_bytes, \
     get_field_default_value, get_enum_values, get_properties_to_include, \
     HideNodeCallback, hide_based_on_property, \
-    full_slice_accessor, ShowUDPCallback
+    full_slice_accessor, ShowUDPCallback, \
+    node_iterator_entry
 from .unique_component_iterator import UniqueComponents
 from .unique_component_iterator import PeakRDLPythonUniqueRegisterComponents
 from .unique_component_iterator import PeakRDLPythonUniqueMemoryComponents
@@ -865,7 +866,8 @@ def is_reg_node(node: Node) -> TypeGuard[RegNode]:
                 'get_properties_to_include': get_properties_to_include,
                 'hide_node_func': hide_node_func,
                 'legacy_enum_type': legacy_enum_type,
-                'skip_systemrdl_name_and_desc_properties': skip_systemrdl_name_and_desc_properties
+                'skip_systemrdl_name_and_desc_properties': skip_systemrdl_name_and_desc_properties,
+                'node_iterator_entry': node_iterator_entry,
             }
 
             self.__stream_jinja_template(template_name="addrmap_tb.py.jinja",

src/peakrdl_python/lib/async_memory.py

@@ -377,6 +377,10 @@ async def _write(self, start_entry: int, data: Union[Array, list[int]]) -> None:
         if not isinstance(data, (list, Array)):
             raise TypeError(f'data should be an array.array got {type(data)}')
 
+        if (max(data) > self.max_entry_value) or (min(data) < 0):
+            raise ValueError('Data out of range for memory must be in the '
+                             f'range 0 to {self.max_entry_value}')
+
         if len(data) not in range(0, self.entries - start_entry + 1):
             raise ValueError(f'data length must be in range 0 to {self.entries - start_entry:d} '
                              f'but got {len(data):d}')

src/peakrdl_python/lib/async_register_and_field.py

@@ -346,8 +346,7 @@ def __init__(self, *,
     # pylint: enable=too-many-arguments, duplicate-code
 
     @asynccontextmanager
-    async def single_read_modify_write(self, verify: bool = False, skip_write: bool = False) -> \
-            AsyncGenerator[Self]:
+    async def single_read_modify_write(self, verify: bool = False) -> AsyncGenerator[Self]:
         """
         Context manager to allow multiple field reads/write to be done with a single set of
         field operations
@@ -361,11 +360,6 @@ async def single_read_modify_write(self, verify: bool = False, skip_write: bool
         if self.__in_read_context_manager:
             raise RuntimeError('using the `single_read_modify_write` context manager within the '
                                'single_read` is not permitted')
-
-        if skip_write is True:
-            warn('The `skip_write` argument will be removed in the future, use `single_read`'
-                 ' instead',
-                 DeprecationWarning, stacklevel=2)
         # pylint: enable=duplicate-code
 
         self.__register_state = await self.read()
@@ -379,15 +373,13 @@ async def single_read_modify_write(self, verify: bool = False, skip_write: bool
         finally:
             self.__in_read_write_context_manager = False
         # pylint: enable=duplicate-code
-        if not skip_write:
-            await self.write(self.__register_state, verify)
+        await self.write(self.__register_state, verify)
 
         # clear the register states at the end of the context manager
         self.__register_state = None
 
     @asynccontextmanager
-    async def single_read(self) -> \
-            AsyncGenerator[Self]:
+    async def single_read(self) -> AsyncGenerator[Self]:
         """
         Context manager to allow multiple field reads with a single register read
         """

src/peakrdl_python/lib/base_field.py

@@ -385,28 +385,6 @@ class _FieldReadOnlyFramework(Field[FieldType], ABC):
     """
     __slots__ : list[str] = []
 
-    def decode_read_value(self, value: int) -> FieldType:
-        """
-        extracts the field value from a register value, by applying the bit
-        mask and shift needed
-
-        Args:
-            value: value to decode, normally read from a register
-
-        Returns:
-            field value
-
-        Warning:
-            This method will be removed from a future version, if you have a compelling use
-            case for it please add a comment to the #184 ticket
-
-        """
-        # end users should not need access to the `decode_read_value` as the decoding is done
-        # for them, it felt like an anomaly that this was public, see #184
-        warnings.warn('decode_read_value will be made private in a future version',
-                      DeprecationWarning, stacklevel=2)
-        return self._decode_read_value(value=value)
-
     def _decode_read_value(self, value: int) -> FieldType:
         """
         extracts the field value from a register value, by applying the bit
@@ -476,29 +454,6 @@ def _write_value_checks(self, value: int) -> None:
             raise ValueError(f'value to be written to register must be less '
                              f'than or equal to {self.max_value:d}')
 
-
-    def encode_write_value(self, value: FieldType) -> int:
-        """
-        Check that a value is legal for the field and then encode it in preparation to be written
-        to the register
-
-        Args:
-            value: field value
-
-        Returns:
-            value which can be applied to the register to update the field
-
-        Warning:
-            This method will be removed from a future version, if you have a compelling use
-            case for it please add a comment to the #184 ticket
-
-        """
-        # end users should not need access to the `decode_read_value` as the decoding is done
-        # for them, it felt like an anomaly that this was public, see #184
-        warnings.warn('encode_write_value will be made private in a future version',
-                      DeprecationWarning, stacklevel=2)
-        return self._encode_write_value(value=value)
-
     def _encode_write_value(self, value: FieldType) -> int:
         """
         Check that a value is legal for the field and then encode it in preparation to be written

src/peakrdl_python/lib/memory.py

@@ -99,6 +99,20 @@ def width(self) -> int:
         """
         return self.__memwidth
 
+    @property
+    def max_entry_value(self) -> int:
+        """
+        maximum unsigned integer value that can be stored in a memory entry
+
+        For example:
+
+        * 8-bit memory width returns 0xFF (255)
+        * 16-bit memory width returns 0xFFFF (65535)
+        * 32-bit memory width returns 0xFFFF_FFFF (4294967295)
+
+        """
+        return (2 ** self.width) - 1
+
     @property
     def width_in_bytes(self) -> int:
         """
@@ -505,6 +519,10 @@ def _write(self, start_entry: int, data: Union[Array, list[int]]) -> None:
         if not isinstance(data, (Array, list)):
             raise TypeError(f'data should be an List or array.array got {type(data)}')
 
+        if (max(data) > self.max_entry_value) or (min(data) < 0):
+            raise ValueError('Data out of range for memory must be in the '
+                             f'range 0 to {self.max_entry_value}')
+
         if len(data) not in range(0, self.entries - start_entry + 1):
             raise ValueError(f'data length must be in range 0 to {self.entries - start_entry:d} '
                              f'but got {len(data):d}')