peakrdl-python 3.0.0rc1__tar.gz → 3.0.0rc3__tar.gz

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/.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: |

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 3.0.0rc1
+Version: 3.0.0rc3
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:                     GNU GENERAL PUBLIC LICENSE

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/generate_testcases.py

@@ -49,16 +49,6 @@ CommandLineParser.add_argument('--copy_libraries', action='store_true', dest='co
                                     '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 @@ if __name__ == '__main__':
         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 @@ if __name__ == '__main__':
                          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:

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/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.0rc1"
+__version__ = "3.0.0rc3"

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/src/peakrdl_python/lib/async_register_and_field.py

@@ -346,8 +346,7 @@ class RegAsyncReadWrite(RegAsyncReadOnly, RegAsyncWriteOnly, ABC):
     # 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 @@ class RegAsyncReadWrite(RegAsyncReadOnly, RegAsyncWriteOnly, ABC):
         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 @@ class RegAsyncReadWrite(RegAsyncReadOnly, RegAsyncWriteOnly, ABC):
         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
         """

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/src/peakrdl_python/lib/register_and_field.py

@@ -26,7 +26,6 @@ from abc import ABC, abstractmethod
 from contextlib import contextmanager
 from array import array as Array
 import sys
-from warnings import warn
 
 from .sections import AddressMap, RegFile
 from .utility_functions import get_array_typecode
@@ -409,7 +408,7 @@ class RegArray(BaseRegArray[RegArrayElementType], ABC):
         field operations
 
         Args:
-            verify (bool): very the write with a read afterwards
+            verify (bool): verify the write with a read afterwards
             skip_write (bool): skip the write back at the end
         """
         self.__register_address_array = \
@@ -667,26 +666,19 @@ class RegReadWrite(RegReadOnly, RegWriteOnly, ABC):
     # pylint: enable=too-many-arguments, duplicate-code
 
     @contextmanager
-    def single_read_modify_write(self, verify: bool = False, skip_write: bool = False) -> \
-            Generator[Self]:
+    def single_read_modify_write(self, verify: bool = False) -> Generator[Self]:
         """
         Context manager to allow multiple field reads/write to be done with a single set of
         field operations
 
         Args:
-            verify (bool): very the write with a read afterwards
-            skip_write (bool): skip the write back at the end
+            verify (bool): verify the write with a read afterwards
 
         """
         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)
-
         self.__register_state = self.read()
         self.__in_read_write_context_manager = True
         try:
@@ -695,16 +687,13 @@ class RegReadWrite(RegReadOnly, RegWriteOnly, ABC):
             # need to make sure the state flag is cleared even if an exception occurs within
             # the context
             self.__in_read_write_context_manager = False
-
-        if not skip_write:
-            self.write(self.__register_state, verify)
+        self.write(self.__register_state, verify)
 
         # clear the register states at the end of the context manager
         self.__register_state = None
 
     @contextmanager
-    def single_read(self) -> \
-            Generator[Self]:
+    def single_read(self) -> Generator[Self]:
         """
         Context manager to allow multiple field reads with a single register read
         """
@@ -837,8 +826,7 @@ class RegReadOnlyArray(RegArray[RegReadOnly], ABC):
     # pylint: enable=too-many-arguments,duplicate-code
 
     @contextmanager
-    def single_read(self) -> \
-            Generator[Self]:
+    def single_read(self) -> Generator[Self]:
         """
         Context manager to allow multiple field reads/write to be done with a single set of
         field operations
@@ -889,8 +877,7 @@ class RegWriteOnlyArray(RegArray[RegWriteOnly], ABC):
     # pylint: enable=too-many-arguments,duplicate-code
 
     @contextmanager
-    def single_write(self) -> \
-            Generator[Self]:
+    def single_write(self) -> Generator[Self]:
         """
         Context manager to allow multiple field reads/write to be done with a single set of
         field operations

{peakrdl_python-3.0.0rc1 → peakrdl_python-3.0.0rc3}/src/peakrdl_python/lib_test/_common_base_test_class.py

@@ -19,20 +19,30 @@ This package is intended to distributed as part of automatically generated code
 Python tool. It provide the base class common to both the async and non-async versions
 """
 import unittest
-from abc import ABC
+from abc import ABC, abstractmethod
 from typing import Union, Optional
 
 from ..lib import FieldReadWrite, FieldReadOnly, FieldWriteOnly
 from ..lib import FieldEnumReadWrite, FieldEnumReadOnly, FieldEnumWriteOnly
 from ..lib import FieldAsyncReadOnly, FieldAsyncWriteOnly, FieldAsyncReadWrite
 from ..lib import FieldEnumAsyncReadOnly, FieldEnumAsyncWriteOnly, FieldEnumAsyncReadWrite
+from ..lib.base_register import BaseReg
+from .utilities import get_field_bitmask_int, get_field_inv_bitmask
+from ..sim_lib.simulator import BaseSimulator
 
 class CommonTestBase(unittest.TestCase, ABC):
     """
-    Base Test class for the autogenerated register test to be used for for the async and
+    Base Test class for the autogenerated register test to be used for the async and
     non-async cases
     """
 
+    @property
+    @abstractmethod
+    def simulator_instance(self) -> BaseSimulator:
+        """
+        Simulator configured for the DUT
+        """
+
     # pylint:disable-next=too-many-arguments
     def _single_field_property_test(self, *,
                                     fut: Union[FieldReadWrite,
@@ -51,18 +61,17 @@ class CommonTestBase(unittest.TestCase, ABC):
                                     msb: int,
                                     low: int,
                                     high: int,
-                                    bitmask: int,
-                                    inverse_bitmask: int,
-                                    max_value: int,
                                     is_volatile: bool,
                                     default: Optional[int]) -> None:
         self.assertEqual(fut.lsb, lsb)
         self.assertEqual(fut.msb, msb)
         self.assertEqual(fut.low, low)
         self.assertEqual(fut.high, high)
-        self.assertEqual(fut.bitmask, bitmask)
-        self.assertEqual(fut.inverse_bitmask, inverse_bitmask)
-        self.assertEqual(fut.max_value, max_value)
+        self.assertEqual(fut.bitmask, get_field_bitmask_int(fut))
+        self.assertEqual(fut.inverse_bitmask, get_field_inv_bitmask(fut))
+        width = (fut.high - fut.low) + 1
+        self.assertEqual(fut.width, width)
+        self.assertEqual(fut.max_value, (2**width) - 1)
         self.assertEqual(fut.is_volatile, is_volatile)
 
         if default is None:
@@ -86,3 +95,15 @@ class CommonTestBase(unittest.TestCase, ABC):
                     self.assertIsNone(fut.default)
             else:
                 self.assertEqual(fut.default, default)
+
+    def _single_register_property_test(self, *,
+                                       rut: BaseReg,
+                                       address: int,
+                                       width: int,
+                                       accesswidth: Optional[int]) -> None:
+        self.assertEqual(rut.address, address)
+        self.assertEqual(rut.width, width)
+        if accesswidth is not None:
+            self.assertEqual(rut.accesswidth, accesswidth)
+        else:
+            self.assertEqual(rut.accesswidth, width)