peakrdl-python 3.1.3__py3-none-any.whl → 4.0.0rc2__py3-none-any.whl

peakrdl_python/__about__.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as
@@ -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.1.3"
+__version__ = "4.0.0rc2"

peakrdl_python/__init__.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 

peakrdl_python/__peakrdl__.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 
@@ -77,11 +77,6 @@ class Exporter(ExporterSubcommandPlugin):
                                     'However, if additional python files are added by the user '
                                     '(not recommended) this cleanup will need to be suppressed '
                                     'and managed by the user')
-        arg_group.add_argument('--legacy_block_access', action='store_true',
-                               dest='legacy_block_access',
-                               help='peakrdl python has two methods to hold blocks of data, the '
-                                    'legacy mode based on array.array or the new mode using '
-                                    'lists. This option will be removed in version 4.0')
         arg_group.add_argument('--show_hidden', action='store_true',
                                dest='show_hidden',
                                help='show addrmap, regfile, memory, register and fields that '
@@ -97,12 +92,6 @@ class Exporter(ExporterSubcommandPlugin):
                                     'be hidden')
         arg_group.add_argument('--skip_library_copy', action='store_true',
                                help='skip the copy of the library code into the generated package')
-        arg_group.add_argument('--legacy_enum_type', action='store_true',
-                               dest='legacy_enum_type',
-                               help='peakrdl python has two ways to define field encoding as '
-                                     'enums new method and an old method based on IntEnum. '
-                                     'Setting this to true will restore the old behaviour.'
-                                     ' This option will be removed in version 4.0')
         arg_group.add_argument('--skip_systemrdl_name_and_desc_properties', action='store_true',
                                dest='skip_systemrdl_name_and_desc_properties',
                                help='peakrdl python includes the system RDL name and desc '
@@ -184,13 +173,11 @@ class Exporter(ExporterSubcommandPlugin):
             asyncoutput=options.is_async,
             skip_test_case_generation=options.skip_test_case_generation,
             delete_existing_package_content=not options.suppress_cleanup,
-            legacy_block_access=options.legacy_block_access,
             show_hidden=options.show_hidden,
             user_defined_properties_to_include=options.udp,
             user_defined_properties_to_include_regex=options.udp_regex,
             hidden_inst_name_regex=options.hide_regex,
             skip_library_copy=options.skip_library_copy,
-            legacy_enum_type=options.legacy_enum_type,
             skip_systemrdl_name_and_desc_properties=
                 options.skip_systemrdl_name_and_desc_properties,
             skip_systemrdl_name_and_desc_in_docstring=

peakrdl_python/_deploy_package.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 

peakrdl_python/_node_walkers.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 

peakrdl_python/class_names.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 

peakrdl_python/compiler_udp.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 

peakrdl_python/exporter.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 
@@ -55,8 +55,6 @@ from .unique_component_iterator import PeakRDLPythonUniqueFieldEnum
 from .class_names import get_field_get_base_class_name
 from .systemrdl_node_hashes import NodeHashingMethod
 
-from .lib import get_array_typecode
-
 from .safe_name_utility import get_python_path_segments, safe_node_name
 
 from ._node_walkers import AddressMaps, OwnedbyAddressMap
@@ -191,10 +189,8 @@ class PythonExporter:
                            package: GeneratedPackage,
                            skip_lib_copy: bool,
                            asyncoutput: bool,
-                           legacy_block_access: bool,
                            udp_include_func: ShowUDPCallback,
                            hide_node_func: HideNodeCallback,
-                           legacy_enum_type: bool,
                            skip_systemrdl_name_and_desc_properties: bool,
                            skip_systemrdl_name_and_desc_in_docstring: bool,
                            register_class_per_generated_file: int,
@@ -258,17 +254,13 @@ class PythonExporter:
             'raise_template_error': self._raise_template_error,
             'safe_node_name': safe_node_name,
             'skip_lib_copy': skip_lib_copy,
-            'legacy_block_access': legacy_block_access,
             'get_properties_to_include': get_properties_to_include,
             'unique_property_enums':
                 self._get_dependent_property_enum(unique_component_walker),
             'hide_node_func': hide_node_func,
             'visible_nonsignal_node' : visible_nonsignal_node,
-            'legacy_enum_type': legacy_enum_type,
             'skip_systemrdl_name_and_desc_properties': skip_systemrdl_name_and_desc_properties,
         }
-        if legacy_block_access is True:
-            context['get_array_typecode'] = get_array_typecode
 
         module_name = top_block.inst_name
         self.__stream_jinja_template(template_name="addrmap.py.jinja",
@@ -289,9 +281,7 @@ class PythonExporter:
                 package=package,
                 skip_lib_copy=skip_lib_copy,
                 asyncoutput=asyncoutput,
-                legacy_block_access=legacy_block_access,
                 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_in_docstring=
                    skip_systemrdl_name_and_desc_in_docstring,
@@ -305,9 +295,7 @@ class PythonExporter:
             package=package,
             skip_lib_copy=skip_lib_copy,
             asyncoutput=asyncoutput,
-            legacy_block_access=legacy_block_access,
             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_in_docstring=skip_systemrdl_name_and_desc_in_docstring,
             unique_component_walker=unique_component_walker,
@@ -320,7 +308,6 @@ class PythonExporter:
             package=package,
             skip_lib_copy=skip_lib_copy,
             asyncoutput=asyncoutput,
-            legacy_enum_type=legacy_enum_type,
             skip_systemrdl_name_and_desc_properties=skip_systemrdl_name_and_desc_properties,
             skip_systemrdl_name_and_desc_in_docstring=skip_systemrdl_name_and_desc_in_docstring,
             unique_component_walker=unique_component_walker,
@@ -332,7 +319,6 @@ class PythonExporter:
                 top_block=top_block,
                 package=package,
                 skip_lib_copy=skip_lib_copy,
-                legacy_enum_type=legacy_enum_type,
                 skip_systemrdl_name_and_desc_properties=skip_systemrdl_name_and_desc_properties,
                 unique_component_walker=unique_component_walker,
                 enum_field_class_per_generated_file=enum_field_class_per_generated_file)
@@ -342,8 +328,7 @@ class PythonExporter:
             'top_node': top_block,
             'unique_property_enums':
                 self._get_dependent_property_enum(unique_component_walker),
-            'skip_lib_copy': skip_lib_copy,
-            'legacy_enum_type': legacy_enum_type,
+            'skip_lib_copy': skip_lib_copy
         }
 
         self.__stream_jinja_template(template_name="property_enums.py.jinja",
@@ -357,9 +342,7 @@ class PythonExporter:
                                      package: GeneratedPackage,
                                      skip_lib_copy: bool,
                                      asyncoutput: bool,
-                                     legacy_block_access: bool,
                                      hide_node_func: HideNodeCallback,
-                                     legacy_enum_type: bool,
                                      skip_systemrdl_name_and_desc_properties: bool,
                                      skip_systemrdl_name_and_desc_in_docstring: bool,
                                      unique_component_walker: UniqueComponents,
@@ -440,8 +423,6 @@ class PythonExporter:
                     'get_field_default_value': get_field_default_value,
                     'skip_lib_copy': skip_lib_copy,
                     'uses_enum': uses_enum(top_block),
-                    'legacy_enum_type': legacy_enum_type,
-                    'legacy_block_access': legacy_block_access,
                     'skip_systemrdl_name_and_desc_properties':
                         skip_systemrdl_name_and_desc_properties,
                     'raise_template_error': self._raise_template_error,
@@ -467,9 +448,7 @@ class PythonExporter:
                                     package: GeneratedPackage,
                                     skip_lib_copy: bool,
                                     asyncoutput: bool,
-                                    legacy_block_access: bool,
                                     hide_node_func: HideNodeCallback,
-                                    legacy_enum_type: bool,
                                     skip_systemrdl_name_and_desc_properties: bool,
                                     skip_systemrdl_name_and_desc_in_docstring: bool,
                                     unique_component_walker: UniqueComponents,
@@ -541,8 +520,6 @@ class PythonExporter:
                     'get_field_default_value': get_field_default_value,
                     'skip_lib_copy': skip_lib_copy,
                     'uses_enum': uses_enum(top_block),
-                    'legacy_enum_type': legacy_enum_type,
-                    'legacy_block_access': legacy_block_access,
                     'skip_systemrdl_name_and_desc_properties':
                         skip_systemrdl_name_and_desc_properties,
                     'raise_template_error': self._raise_template_error,
@@ -567,7 +544,6 @@ class PythonExporter:
                                   package: GeneratedPackage,
                                   skip_lib_copy: bool,
                                   asyncoutput: bool,
-                                  legacy_enum_type: bool,
                                   skip_systemrdl_name_and_desc_properties: bool,
                                   skip_systemrdl_name_and_desc_in_docstring: bool,
                                   unique_component_walker: UniqueComponents,
@@ -612,7 +588,6 @@ class PythonExporter:
                                                skip_systemrdl_name_and_desc_in_docstring),
                     'skip_lib_copy': skip_lib_copy,
                     'uses_enum': uses_enum(top_block),
-                    'legacy_enum_type': legacy_enum_type,
                     'skip_systemrdl_name_and_desc_properties':
                         skip_systemrdl_name_and_desc_properties,
                     'raise_template_error': self._raise_template_error,
@@ -632,7 +607,6 @@ class PythonExporter:
                                        top_block: AddrmapNode,
                                        package: GeneratedPackage,
                                        skip_lib_copy: bool,
-                                       legacy_enum_type: bool,
                                        skip_systemrdl_name_and_desc_properties: bool,
                                        unique_component_walker: UniqueComponents,
                                        enum_field_class_per_generated_file: int) -> None:
@@ -658,7 +632,6 @@ class PythonExporter:
                     'top_node': top_block,
                     'unique_enums': unique_enums_subset,
                     'skip_lib_copy': skip_lib_copy,
-                    'legacy_enum_type': legacy_enum_type,
                     'skip_systemrdl_name_and_desc_properties':
                         skip_systemrdl_name_and_desc_properties
                 }
@@ -677,8 +650,7 @@ class PythonExporter:
                            top_block: AddrmapNode,
                            package: GeneratedPackage,
                            skip_lib_copy: bool,
-                           asyncoutput: bool,
-                           legacy_block_access: bool) -> None:
+                           asyncoutput: bool) -> None:
 
         # as a result of issue 202, where two registers existed at that same address,
         # rather than iterating through the registers within the Jinja template
@@ -711,7 +683,6 @@ class PythonExporter:
             'isinstance': isinstance,
             'asyncoutput': asyncoutput,
             'skip_lib_copy': skip_lib_copy,
-            'legacy_block_access': legacy_block_access,
             'list': list,
             'simulator_field_definition': simulator_field_definition,
         }
@@ -733,8 +704,7 @@ class PythonExporter:
                          top_block: AddrmapNode,
                          package: GeneratedPackage,
                          skip_lib_copy: bool,
-                         asyncoutput: bool,
-                         legacy_block_access: bool) -> None:
+                         asyncoutput: bool) -> None:
 
         context = {
             'top_node': top_block,
@@ -742,8 +712,7 @@ class PythonExporter:
             'systemrdlMemNode': MemNode,
             'isinstance': isinstance,
             'asyncoutput': asyncoutput,
-            'skip_lib_copy': skip_lib_copy,
-            'legacy_block_access': legacy_block_access,
+            'skip_lib_copy': skip_lib_copy
         }
 
         self.__stream_jinja_template(template_name="example.py.jinja",
@@ -756,16 +725,12 @@ class PythonExporter:
                             top_block: AddrmapNode,
                             package: GeneratedPackage,
                             skip_lib_copy: bool,
-                            asyncoutput: bool,
-                            legacy_block_access: bool,
-                            legacy_enum_type: bool) -> None:
+                            asyncoutput: bool) -> None:
 
         context = {
             'top_node': top_block,
             'asyncoutput': asyncoutput,
-            'skip_lib_copy': skip_lib_copy,
-            'legacy_block_access': legacy_block_access,
-            'legacy_enum_type': legacy_enum_type
+            'skip_lib_copy': skip_lib_copy
         }
 
         self.__stream_jinja_template(template_name="baseclass_tb.py.jinja",
@@ -784,10 +749,8 @@ class PythonExporter:
                        package: GeneratedPackage,
                        skip_lib_copy: bool,
                        asyncoutput: bool,
-                       legacy_block_access: bool,
                        udp_include_func: ShowUDPCallback,
                        hide_node_func: HideNodeCallback,
-                       legacy_enum_type: bool,
                        skip_systemrdl_name_and_desc_properties: bool,
                        ) -> None:
 
@@ -877,12 +840,9 @@ class PythonExporter:
                 'asyncoutput': asyncoutput,
                 'uses_enum': uses_enum(block),
                 'skip_lib_copy': skip_lib_copy,
-                'get_array_typecode': get_array_typecode,
-                'legacy_block_access': legacy_block_access,
                 'udp_include_func': udp_include_func,
                 '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,
                 'node_iterator_entry': node_iterator_entry,
             }
@@ -968,12 +928,10 @@ class PythonExporter:
                skip_test_case_generation: bool = False,
                delete_existing_package_content: bool = True,
                skip_library_copy: bool = False,
-               legacy_block_access: bool = False,
                show_hidden: bool = False,
                user_defined_properties_to_include: Optional[list[str]] = None,
                user_defined_properties_to_include_regex: Optional[str] = None,
                hidden_inst_name_regex: Optional[str] = None,
-               legacy_enum_type: bool = False,
                skip_systemrdl_name_and_desc_properties: bool = False,
                skip_systemrdl_name_and_desc_in_docstring: bool = False,
                register_class_per_generated_file: int =
@@ -1004,12 +962,6 @@ class PythonExporter:
                                potential licensing implications of package distribution,
                                However, this means the end-user is responsible for
                                installing the libraries.
-            legacy_block_access: version 0.8 changed the block access methods from using
-                                 arrays to lists. This allows memory widths of other
-                                 than 8, 16, 32, 64 to be supported which are legal in
-                                 systemRDL. The legacy mode with Arrays is still in
-                                 the tool and will be turned on by default for a few
-                                 releases.
             show_hidden: By default any item (Address Map, Regfile, Register, Memory or
                          Field) with the systemRDL User Defined Property (UDP)
                          ``python_hide`` set to true will not be included in the generated
@@ -1025,10 +977,6 @@ class PythonExporter:
             hidden_inst_name_regex: A regular expression which will hide any fully
                                     qualified instance name that matches, set to None to
                                     for this to have no effect
-            legacy_enum_type: version 1.2 introduced a new Enum type that allows system
-                              rdl ``name`` and ``desc`` properties on field encoding
-                              to be included. The legacy mode uses python IntEnum.
-                              .. version-deprecated:: 3.0
             skip_systemrdl_name_and_desc_properties (bool) : version 1.2 introduced new properties
                                                              that include the systemRDL name and
                                                              desc as properties of the built
@@ -1071,17 +1019,6 @@ class PythonExporter:
         Returns:
             modules that have been exported:
         """
-        if legacy_enum_type:
-            warnings.warn('legacy_enum_type is deprecated and '
-                          'will be removed from a future version please try the new mode',
-                          category=DeprecationWarning)
-
-        if legacy_block_access:
-            warnings.warn('legacy_block_access is deprecated and '
-                          'will be removed from a future version please try the new mode',
-                          category=DeprecationWarning)
-
-
         # If it is the root node, skip to top addrmap
         if isinstance(node, RootNode):
             top_block = node.top
@@ -1122,10 +1059,8 @@ class PythonExporter:
         self.__export_reg_model(
             top_block=top_block, package=package, asyncoutput=asyncoutput,
             skip_lib_copy=skip_library_copy,
-            legacy_block_access=legacy_block_access,
             udp_include_func=udp_include_func,
             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_in_docstring=skip_systemrdl_name_and_desc_in_docstring,
             register_class_per_generated_file=register_class_per_generated_file,
@@ -1136,27 +1071,21 @@ class PythonExporter:
         )
 
         self.__export_simulator(top_block=top_block, package=package, asyncoutput=asyncoutput,
-                                skip_lib_copy=skip_library_copy,
-                                legacy_block_access=legacy_block_access)
+                                skip_lib_copy=skip_library_copy)
 
         self.__export_example(top_block=top_block, package=package, asyncoutput=asyncoutput,
-                              skip_lib_copy=skip_library_copy,
-                              legacy_block_access=legacy_block_access)
+                              skip_lib_copy=skip_library_copy)
 
         if not skip_test_case_generation:
             # export the baseclasses for the tests
             self.__export_base_tests(top_block=top_block, package=package, asyncoutput=asyncoutput,
-                                     skip_lib_copy=skip_library_copy,
-                                     legacy_block_access=legacy_block_access,
-                                     legacy_enum_type=legacy_enum_type)
+                                     skip_lib_copy=skip_library_copy)
             # export the tests themselves, these are broken down to one file per addressmap
             self.__export_tests(
                 top_block=top_block, package=package, asyncoutput=asyncoutput,
                 skip_lib_copy=skip_library_copy,
-                legacy_block_access=legacy_block_access,
                 udp_include_func=udp_include_func,
                 hide_node_func=hide_node_func,
-                legacy_enum_type=legacy_enum_type,
                 skip_systemrdl_name_and_desc_properties=skip_systemrdl_name_and_desc_properties)
 
         return top_block.inst_name

peakrdl_python/lib/__init__.py

@@ -1,6 +1,6 @@
 """
 peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
-Copyright (C) 2021 - 2025
+Copyright (C) 2021 - 2026
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as 
@@ -23,8 +23,8 @@ from .callbacks import ReadCallback
 from .callbacks import ReadBlockCallback
 from .callbacks import WriteCallback
 from .callbacks import WriteBlockCallback
-from .callbacks import NormalCallbackSet, NormalCallbackSetLegacy
-from .callbacks import AsyncCallbackSet, AsyncCallbackSetLegacy
+from .callbacks import NormalCallbackSet
+from .callbacks import AsyncCallbackSet
 from .callbacks import CallbackSet
 
 from .sections import AddressMap
@@ -86,34 +86,28 @@ from .async_register_and_field import FieldEnumAsyncReadOnly
 from .async_register_and_field import FieldEnumAsyncWriteOnly
 from .async_register_and_field import FieldEnumAsyncReadWrite
 
-from .memory import MemoryReadOnly, MemoryReadOnlyLegacy
-from .memory import MemoryWriteOnly, MemoryWriteOnlyLegacy
-from .memory import MemoryReadWrite, MemoryReadWriteLegacy
+from .memory import MemoryReadOnly
+from .memory import MemoryWriteOnly
+from .memory import MemoryReadWrite
 from .memory import MemoryReadOnlyArray
 from .memory import MemoryWriteOnlyArray
 from .memory import MemoryReadWriteArray
-from .memory import MemoryReadOnlyLegacyArray
-from .memory import MemoryWriteOnlyLegacyArray
-from .memory import MemoryReadWriteLegacyArray
-from .async_memory import MemoryAsyncReadOnly, MemoryAsyncReadOnlyLegacy
-from .async_memory import MemoryAsyncWriteOnly, MemoryAsyncWriteOnlyLegacy
-from .async_memory import MemoryAsyncReadWrite, MemoryAsyncReadWriteLegacy
+
+from .async_memory import MemoryAsyncReadOnly
+from .async_memory import MemoryAsyncWriteOnly
+from .async_memory import MemoryAsyncReadWrite
 from .async_memory import MemoryAsyncReadOnlyArray
 from .async_memory import MemoryAsyncWriteOnlyArray
 from .async_memory import MemoryAsyncReadWriteArray
-from .async_memory import MemoryAsyncReadOnlyLegacyArray
-from .async_memory import MemoryAsyncWriteOnlyLegacyArray
-from .async_memory import MemoryAsyncReadWriteLegacyArray
-from .memory import ReadableMemory, ReadableMemoryLegacy
-from .memory import WritableMemory, WritableMemoryLegacy
+from .memory import ReadableMemory
+from .memory import WritableMemory
 from .memory import Memory
-from .async_memory import ReadableAsyncMemory, ReadableAsyncMemoryLegacy
-from .async_memory import WritableAsyncMemory, WritableAsyncMemoryLegacy
+from .async_memory import ReadableAsyncMemory
+from .async_memory import WritableAsyncMemory
 from .async_memory import AsyncMemory
 from .memory import MemoryArray
 from .async_memory import AsyncMemoryArray
 
-from .utility_functions import get_array_typecode
 from .utility_functions import UnsupportedWidthError
 from .base import Node
 from .base import NodeArray