peakrdl-python 1.1.0__tar.gz → 1.2.0rc1__tar.gz

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/.github/workflows/action.yaml

@@ -120,6 +120,8 @@ jobs:
           python -m pip uninstall peakrdl-python -y
           # peakrdl-ipxact is needed for some of the test cases so is imported by the
           # generate_and_test script
+          
+          PYTHONPATH=/src
 
 
           # retrieve the example code from the systemRDL compiler
@@ -132,6 +134,8 @@ jobs:
           python -m generate_and_test --RDL_source_file tests/testcases/simulator_test.rdl --root_node simulator_test --async
 
           python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map
+          python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_block_access
+          python -m generate_and_test --RDL_source_file tests/testcases/accelera-generic_example.rdl --root_node some_register_map --legacy_enum_type
 
           python -m generate_and_test --RDL_source_file tests/testcases/user_defined_properties.rdl --root_node user_defined_properties --udp bool_property_to_include
           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
@@ -182,10 +186,16 @@ jobs:
           peakrdl python tests/testcases/hidden_property.rdl -o peakrdl_out/raw_async/ --async
           peakrdl python tests/testcases/hidden_property.rdl -o peakrdl_out/raw_async/show_hidden/ --show_hidden --async
           python -m unittest discover -s peakrdl_out/raw_async
-          peakrdl python tests/testcases/basic.rdl -o peakrdl_out/raw_legacy/ --legacy_block_access
-          python -m unittest discover -s peakrdl_out/raw_legacy
+          peakrdl python tests/testcases/basic.rdl -o peakrdl_out/raw_legacy_block/ --legacy_block_access
+          python -m unittest discover -s peakrdl_out/raw_legacy_block
 
           peakrdl python tests/testcases/basic.rdl -o peakrdl_out/no_test/ --skip_test_case_generation
+          
+          peakrdl python tests/testcases/basic.rdl -o peakrdl_out/no_lib/ --skip_library_copy
+          python -m unittest discover -s peakrdl_out/no_lib
+          
+          peakrdl python tests/testcases/enum_example.rdl -o peakrdl_out/raw_legacy_enum/ --legacy_enum_type
+          python -m unittest discover -s peakrdl_out/raw_legacy_enum
 
           # test a TOMl file that passes in overridden templates
           peakrdl python tests/testcases/basic.rdl -o peakrdl_out/simple_user_template/ --peakrdl-cfg tests/alternative_templates_toml/peakrdl.toml
@@ -193,9 +203,6 @@ jobs:
           peakrdl python tests/testcases/basic.rdl -o peakrdl_out/dynamic_user_template/ --peakrdl-cfg tests/alternative_templates_dynamic_toml/peakrdl.toml
           python tests/alternative_templates_dynamic_toml/header_check.py --generated_package_location peakrdl_out/dynamic_user_template/ --top_name basic
 
-
-
-
       - name: Check Examples
         run: |
 

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: peakrdl-python
-Version: 1.1.0
+Version: 1.2.0rc1
 Summary: Generate Python Register Access Layer (RAL) from SystemRDL
 Author: Keith Brady
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -713,6 +713,7 @@ Requires-Dist: peakrdl; extra == "peakrdl"
 Provides-Extra: unit-test
 Requires-Dist: peakrdl; extra == "unit-test"
 Requires-Dist: tomli; python_version < "3.11" and extra == "unit-test"
+Dynamic: license-file
 
 ![CI](https://github.com/krcb197/PeakRDL-python/actions/workflows/action.yaml/badge.svg)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peakrdl-python.svg)](https://pypi.org/project/peakrdl-python)
@@ -736,4 +737,12 @@ 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
+
+Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
+metadata from the systemRDL to propogate through to the generated code. This may break advanced 
+usage of the python enumerations. User are encouraged to use the new feature, however, if there 
+are problems with the old enumeation types (based on `IntEnum`) can be used, see 
+_Legacy Enumeration Types_ in the documentation
+
 

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/README.md

@@ -20,4 +20,12 @@ 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
+
+Version 1.2 introduced a new way to define the enumerations for the field encoding. This allows 
+metadata from the systemRDL to propogate through to the generated code. This may break advanced 
+usage of the python enumerations. User are encouraged to use the new feature, however, if there 
+are problems with the old enumeation types (based on `IntEnum`) can be used, see 
+_Legacy Enumeration Types_ in the documentation
+
 

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/docs/api_components.rst

@@ -67,27 +67,27 @@ Memories
 Registers
 =========
 
-.. autoclass:: peakrdl_python.lib.register.RegReadOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.RegReadOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.register.RegWriteOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.RegWriteOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.register.RegReadWrite
+.. autoclass:: peakrdl_python.lib.register_and_field.RegReadWrite
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.register.RegReadOnlyArray
+.. autoclass:: peakrdl_python.lib.register_and_field.RegReadOnlyArray
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.register.RegWriteOnlyArray
+.. autoclass:: peakrdl_python.lib.register_and_field.RegWriteOnlyArray
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.register.RegReadWriteArray
+.. autoclass:: peakrdl_python.lib.register_and_field.RegReadWriteArray
     :members:
     :inherited-members:
 
@@ -95,26 +95,26 @@ Register Fields
 ^^^^^^^^^^^^^^^
 A register will always have fields within it
 
-.. autoclass:: peakrdl_python.lib.fields.FieldReadOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldReadOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.fields.FieldWriteOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldWriteOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.fields.FieldReadWrite
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldReadWrite
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.fields.FieldEnumReadOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldEnumReadOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.fields.FieldEnumWriteOnly
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldEnumWriteOnly
     :members:
     :inherited-members:
 
-.. autoclass:: peakrdl_python.lib.fields.FieldEnumReadWrite
+.. autoclass:: peakrdl_python.lib.register_and_field.FieldEnumReadWrite
     :members:
     :inherited-members:

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/docs/generated_package.rst

@@ -20,9 +20,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
-- ``lib`` - This is a package of base classes used by the register access layer
 - ``test_<root_name>.py`` - This is a set of autogenerated unittests to verify the register access layer
-
+- ``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`)
+- ``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`)
 
 Running the Unit Tests
 ======================
@@ -134,6 +134,19 @@ Legacy Block Callback and Block Access
       * ``NormalCallbackSetLegacy`` for standard python function callbacks
       * ``AsyncCallbackSetLegacy`` for async python function callbacks, these are called from the library using ``await``
 
+Legacy Enumeration Types
+------------------------
+
+.. versionchanged:: 1.2.0
+
+   Previous versions of PeakRDL Python used `IntEnum` for the the field encoding. This had a
+   limitation that the metadata from the system RDL code, notably the ``name`` and ``desc``
+   property could not be included. A new data type for the enumerations was introduced in
+   version 1.2.0.
+
+   There was a small risk this may impact some users code, in the case of advanced usage of the
+   enumeration. The old behaviour can be brought back using the ``legacy_enum_type`` build option.
+
 
 Using the Register Access Layer
 ===============================
@@ -549,3 +562,14 @@ fully described by the systemRDL.
              design. It does not simulate the hardware, it is intended as a simple tool for
              development and testing of the python wrappers or code that uses them.
 
+.. _skipping-lib-copy:
+
+Skipping the Library Copy
+=========================
+
+In some cases it may be desirable to skip the copy of the library from the generated pacakge.
+This may be useful in development of PeakRDL-python. It can also be used to avoid distributing
+licensed code.
+
+.. warning:: If the libraries are not distributed with the package, it is very important to
+             ensure users download the matching version of the PeakRDL-python package to use it

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/example/tranversing_address_map/dumping_register_state_to_json_file.py

@@ -7,7 +7,7 @@ from chip_with_registers.sim.chip_with_registers import chip_with_registers_simu
 from chip_with_registers.lib import NormalCallbackSet, RegReadOnly, RegReadWrite, \
     MemoryReadOnly, MemoryReadWrite, RegFile, AddressMap, RegReadOnlyArray, RegReadWriteArray, \
     AddressMapArray, RegFileArray, MemoryReadOnlyArray, MemoryReadWriteArray
-
+from chip_with_registers.lib import RegisterFieldJSONEncoder
 
 class RegisterDumper:
 
@@ -40,7 +40,7 @@ class RegisterDumper:
 
         """
         with open(filename, encoding='utf-8', mode='w') as fp:
-            json.dump(self.registers, fp, indent=4)
+            json.dump(self.registers, fp, indent=4, cls=RegisterFieldJSONEncoder)
 
     @staticmethod
     def _process_registers(node: Union[MemoryReadOnly, MemoryReadWrite, RegFile, AddressMap]):

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/example/tranversing_address_map/reg_dump.json

@@ -3,48 +3,48 @@
         {
             "single_reg": {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             },
             "reg_array": [
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 }
             ]
         },
         {
             "single_reg": {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             },
             "reg_array": [
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 },
                 {
                     "first_field": 0,
-                    "second_field": 0
+                    "second_field": "VALUE1"
                 }
             ]
         }
@@ -52,24 +52,24 @@
     "single_regfile": {
         "single_reg": {
             "first_field": 0,
-            "second_field": 0
+            "second_field": "VALUE1"
         },
         "reg_array": [
             {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             },
             {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             },
             {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             },
             {
                 "first_field": 0,
-                "second_field": 0
+                "second_field": "VALUE1"
             }
         ]
     }

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/generate_and_test.py

@@ -23,7 +23,6 @@ the peakrdl command line tool. However, when developing and debugging it is conv
 peakrdl and call the exporter directly.
 """
 
-import os
 import time
 import argparse
 import pathlib
@@ -67,14 +66,14 @@ CommandLineParser.add_argument('--suppress_cleanup', action='store_true', dest='
                                     'files found in the directory where the package will be'
                                     ' generated. This is normally useful if the user is '
                                     'generating over the top of an existing package and prevents '
-                                    'problems when the strucutre of the register map changes. '
+                                    'problems when the structure of the register map changes. '
                                     'However, if additional python files are added by the user '
                                     '(not recommended) this cleanup will need to be suppressed '
                                     'and managed by the user')
 CommandLineParser.add_argument('--copy_libraries', action='store_true', dest='copy_libraries',
                                help='by default peakrdl python copies all the libraries over'
                                     'to the generated package along with the generated code. '
-                                    'However, that is potententially problematic when developing'
+                                    'However, that is potentiality problematic when developing'
                                     'and debugging as multiple copies of the libraries can cause'
                                     'confusion. Therefore by default this script does not copy '
                                     'them over.')
@@ -92,6 +91,11 @@ CommandLineParser.add_argument('--full_inst_file', dest='full_inst_file',
                                type=pathlib.Path, required=False,
                                help='export a text file with a list of the all qualified instance'
                                     'names in the systemRDL')
+CommandLineParser.add_argument('--legacy_enum_type', action='store_true',
+                               dest='legacy_enum_type',
+                               help='peakrdl python has ways to define field encoding as enums a '
+                                    'a new method and an old method based on IntEnum. Setting '
+                                    'this to true will restore the old behaviour')
 
 
 def build_logging_cong(logfilepath:str):
@@ -185,7 +189,8 @@ if __name__ == '__main__':
                     skip_library_copy=not CommandLineArgs.copy_libraries,
                     legacy_block_access=CommandLineArgs.legacy_block_access,
                     user_defined_properties_to_include=CommandLineArgs.udp,
-                    hidden_inst_name_regex=CommandLineArgs.hide_regex)
+                    hidden_inst_name_regex=CommandLineArgs.hide_regex,
+                    legacy_enum_type=CommandLineArgs.legacy_enum_type)
     print(f'generation time {time.time() - start_time}s')
 
     if not CommandLineArgs.export_only:
@@ -210,7 +215,7 @@ if __name__ == '__main__':
             peakrdl_python_package = __import__('generate_and_test_output.' + CommandLineArgs.root_node + '.lib',
                                                 globals(), locals(), ['CallbackSet'], 0)
         else:
-            peakrdl_python_package = __import__('src.peakrdl_python.lib',
+            peakrdl_python_package = __import__('peakrdl_python.lib',
                                                 globals(), locals(), ['CallbackSet'], 0)
 
         if CommandLineArgs.asyncoutput is True:

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/generate_testcases.py

@@ -20,7 +20,6 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 script to generate all the test cases from the test set
 """
 
-import sys
 import os
 
 from glob import glob
@@ -77,7 +76,8 @@ def compile_rdl(infile: str,
 def generate(root: Node, outdir: str,
              asyncoutput: bool = False,
              skip_test_case_generation: bool = False,
-             legacy_block_access: bool = True) -> List[str]:
+             legacy_block_access: bool = True,
+             legacy_enum_type: bool = True) -> List[str]:
     """
     Generate a PeakRDL output package from compiled systemRDL
 
@@ -88,6 +88,8 @@ def generate(root: Node, outdir: str,
                 clean it up. This can slow down large jobs or mask problems
         legacy_block_access: If set to True the code build a register model the legacy array block
                              access as opposed to the newer list based
+        legacy_enum_type: If set to True the code with build with the old style IntEnum rather than
+                          the new style SystemRDLEnum
 
     Returns:
         List of strings with the module names generated
@@ -97,7 +99,8 @@ def generate(root: Node, outdir: str,
     modules = PythonExporter().export(root, outdir, # type: ignore[no-untyped-call]
                                       asyncoutput=asyncoutput,
                                       skip_test_case_generation=skip_test_case_generation,
-                                      legacy_block_access=legacy_block_access)
+                                      legacy_block_access=legacy_block_access,
+                                      legacy_enum_type=legacy_enum_type)
 
     return modules
 
@@ -131,21 +134,25 @@ if __name__ == '__main__':
             root = compile_rdl(rdl_file)
 
         for build_options, folder_name in \
-                [({'asyncoutput': True, 'legacy':False}, 'raw_async'),
-                 ({'asyncoutput': False, 'legacy':False}, 'raw'),
-                 ({'asyncoutput': True, 'legacy': True}, 'raw_async_legacy'),
-                 ({'asyncoutput': False, 'legacy': True}, 'raw_legacy')
+                [({'asyncoutput': True, 'legacy_block':False, 'legacy_enum': False}, 'raw_async'),
+                 ({'asyncoutput': False, 'legacy_block':False, 'legacy_enum': False}, 'raw'),
+                 ({'asyncoutput': True, 'legacy_block': True, 'legacy_enum': False}, 'raw_async_legacy_block'),
+                 ({'asyncoutput': False, 'legacy_block': True, 'legacy_enum': False}, 'raw_legacy_block'),
+                 ({'asyncoutput': True, 'legacy_block': False, 'legacy_enum': True}, 'raw_async_legacy_enum'),
+                 ({'asyncoutput': False, 'legacy_block': False, 'legacy_enum': True}, 'raw_legacy_enum'),
+                 ({'asyncoutput': True, 'legacy_block': True, 'legacy_enum': True}, 'raw_async_legacy_block_legacy_enum'),
+                 ({'asyncoutput': False, 'legacy_block': True, 'legacy_enum': True}, 'raw_legacy_block_legacy_enum')
                  ]:
 
             # 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 \
-                    (build_options['legacy'] is True):
+                    (build_options['legacy_block'] is True):
                 continue
 
             _ = generate(root, str(output_path / folder_name),
                          asyncoutput=build_options['asyncoutput'],
-                         legacy_block_access=build_options['legacy']
-                         )
+                         legacy_block_access=build_options['legacy_block'],
+                         legacy_enum_type=build_options['legacy_enum'])
 
             module_fqfn = output_path / folder_name / '__init__.py'
             with open(module_fqfn, 'w', encoding='utf-8') as fid:
@@ -153,4 +160,4 @@ if __name__ == '__main__':
 
         print("\n-----------------------------------------------------------------\n")
 
-    print("\tALL TESTS COMPLETED\n")
+    print("\tALL TESTS COMPLETED\n")

{peakrdl_python-1.1.0 → peakrdl_python-1.2.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__ = "1.1.0"
+__version__ = "1.2.0rc1"

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/__peakrdl__.py

@@ -86,6 +86,13 @@ class Exporter(ExporterSubcommandPlugin):
         arg_group.add_argument('--hide_regex', dest='hide_regex', type=str,
                                help='A regex that will cause any matching fully qualified node to '
                                     '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')
 
     def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None:
         """
@@ -117,5 +124,7 @@ class Exporter(ExporterSubcommandPlugin):
             legacy_block_access=options.legacy_block_access,
             show_hidden=options.show_hidden,
             user_defined_properties_to_include=options.udp,
-            hidden_inst_name_regex=options.hide_regex
+            hidden_inst_name_regex=options.hide_regex,
+            skip_library_copy=options.skip_library_copy,
+            legacy_enum_type=options.legacy_enum_type
         )

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/exporter.py

@@ -300,7 +300,8 @@ class PythonExporter:
                            asyncoutput: bool,
                            legacy_block_access: bool,
                            udp_to_include: Optional[list[str]],
-                           hide_node_func: HideNodeCallback) -> None:
+                           hide_node_func: HideNodeCallback,
+                           legacy_enum_type: bool) -> None:
 
         context = {
             'print': print,
@@ -350,7 +351,8 @@ class PythonExporter:
             'dependent_property_enum':
                 self._get_dependent_property_enum(node=top_block,
                                                   udp_to_include=udp_to_include),
-            'hide_node_func': hide_node_func
+            'hide_node_func': hide_node_func,
+            'legacy_enum_type': legacy_enum_type
         }
         if legacy_block_access is True:
             context['get_array_typecode'] = get_array_typecode
@@ -457,7 +459,9 @@ class PythonExporter:
                        asyncoutput: bool,
                        legacy_block_access: bool,
                        udp_to_include: Optional[list[str]],
-                       hide_node_func: HideNodeCallback) -> None:
+                       hide_node_func: HideNodeCallback,
+                       legacy_enum_type: bool
+                       ) -> None:
         """
 
         Args:
@@ -540,7 +544,8 @@ class PythonExporter:
                 'dependent_property_enum':
                     self._get_dependent_property_enum(node=top_block,
                                                       udp_to_include=udp_to_include),
-                'hide_node_func': hide_node_func
+                'hide_node_func': hide_node_func,
+                'legacy_enum_type': legacy_enum_type
             }
 
             self.__stream_jinja_template(template_name="addrmap_tb.py.jinja",
@@ -570,7 +575,7 @@ class PythonExporter:
                     raise RuntimeError('It is not permitted to expose a property name used to'
                                        ' build the peakrdl-python wrappers: ' + reserved_name)
 
-    # pylint: disable-next=too-many-arguments
+    # pylint: disable-next=too-many-arguments,too-many-locals
     def export(self, node: Union[RootNode, AddrmapNode], path: str, *,
                asyncoutput: bool = False,
                skip_test_case_generation: bool = False,
@@ -579,7 +584,8 @@ class PythonExporter:
                legacy_block_access: bool = True,
                show_hidden: bool = False,
                user_defined_properties_to_include: Optional[list[str]] = None,
-               hidden_inst_name_regex: Optional[str] = None) -> str:
+               hidden_inst_name_regex: Optional[str] = None,
+               legacy_enum_type: bool = True) -> str:
         """
         Generated Python Code and Testbench
 
@@ -594,8 +600,10 @@ class PythonExporter:
                                                     operations
             skip_library_copy (bool): skip copy the libraries to the generated package, this is
                                       useful to turn off when developing peakrdl python to avoid
-                                      editing the wrong copy of the library. However, it is not
-                                      recommended in end user cases
+                                      editing the wrong copy of the library. It also avoids the
+                                      GPL code being part of the package for distribution,
+                                      However, this means the end-user is responsible for
+                                      installing the libraries.
             legacy_block_access (bool): version 0.8 changed the block access methods from using
                                         arrays to to lists. This allows memory widths of other
                                         than 8, 16, 32, 64 to be supported which are legal in
@@ -613,6 +621,9 @@ class PythonExporter:
             hidden_inst_name_regex (str) : 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 (bool): 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.
 
 
         Returns:
@@ -668,7 +679,8 @@ class PythonExporter:
                                 skip_lib_copy=skip_library_copy,
                                 legacy_block_access=legacy_block_access,
                                 udp_to_include=user_defined_properties_to_include,
-                                hide_node_func=hide_node_func)
+                                hide_node_func=hide_node_func,
+                                legacy_enum_type=legacy_enum_type)
 
         self.__export_simulator(top_block=top_block, package=package, asyncoutput=asyncoutput,
                                 skip_lib_copy=skip_library_copy,
@@ -688,7 +700,8 @@ class PythonExporter:
                                 skip_lib_copy=skip_library_copy,
                                 legacy_block_access=legacy_block_access,
                                 udp_to_include=user_defined_properties_to_include,
-                                hide_node_func=hide_node_func)
+                                hide_node_func=hide_node_func,
+                                legacy_enum_type=legacy_enum_type)
 
         return top_block.inst_name
 

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/lib/__init__.py

@@ -76,6 +76,8 @@ from .register_and_field import FieldEnumReadOnly
 from .register_and_field import FieldEnumWriteOnly
 from .register_and_field import FieldEnumReadWrite
 from .base_field import FieldEnum
+from .field_encoding import SystemRDLEnum, SystemRDLEnumEntry
+from .field_encoding import RegisterFieldJSONEncoder
 
 from .async_register_and_field import FieldAsyncReadOnly
 from .async_register_and_field import FieldAsyncWriteOnly

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/lib/async_memory.py

@@ -70,7 +70,6 @@ class AsyncMemory(BaseMemory, ABC):
         Initialise the class
 
         Args:
-            callbacks: set of callback to be used for accessing the hardware or simulator
             address: address of the register
             width: width of the register in bits
             logger_handle: name to be used logging messages associate with thisobject

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/lib/async_register_and_field.py

@@ -116,7 +116,6 @@ class RegAsyncReadOnly(AsyncReg, ABC):
     class for an async read only register
 
     Args:
-        callbacks: set of callback to be used for accessing the hardware or simulator
         address: address of the register
         width: width of the register in bits
         accesswidth: minimum access width of the register in bits

{peakrdl_python-1.1.0 → peakrdl_python-1.2.0rc1}/src/peakrdl_python/lib/base.py

@@ -118,6 +118,20 @@ class Base(ABC):
         """
         return {}
 
+    @property
+    def rdl_name(self) -> Optional[str]:
+        """
+        The systemRDL name property for the item
+        """
+        return None
+
+    @property
+    def rdl_desc(self) -> Optional[str]:
+        """
+        The systemRDL desc property for the item
+        """
+        return None
+
 
 class Node(Base, ABC):
     """