Skip to content

Release/2.0.0 #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
krcb197 merged 146 commits into from
Oct 25, 2025
Merged

Release/2.0.0 #223

krcb197 merged 146 commits into from
Oct 25, 2025

Conversation

@krcb197
Copy link
Owner

@krcb197 krcb197 commented Oct 11, 2025 •
edited
Loading

This release is a significant refactoring of the way the regmodel is generated. There were two goals:

  1. Ensure Python class definitions are only made once
  2. Split the model across multiple files to ensure each module is smaller in size

This works by:

  1. Computing a hash of the original system RDL component based on the attributes that peakrdl-python needs (many attributes are relevant to other tooling flow steps and don't affect the system rdl)
  2. Making definitions for each unique hash, into a series of incrementing files for:
    1. Registers
    2. Fields
    3. Field Enumerations
    4. Memories

Other changes in this release:

  1. There is a new top-level alias for the RegModel and Simulator, this makes it easier to use the generated packages without needing to know the top level names
  2. Restructured the traversal iterators to make them filters inside the library rather than individually generated in the code
  3. Refactored the internal way Arrays operated to use an immutable tuple rather than a dictionary, which also identified some bugs with slcing into arrays which are now fixed.
  4. Added support for filtering which UDPs to include with a RegEX
  5. Added check whether the library matches the version used for the generation of the code

krcb197 added 30 commits June 28, 2025 11:05
@krcb197
Optimise the process of making a bitmask (removing a nasty loop) and …
caf4337 
…add a test for it.
@krcb197
Remove separate storage of lsb0 and msb0 on the field in favour of re…
c561d2f 
…turning the inverse
@krcb197
Hash calculation added
8351995
@krcb197
Most of the work needed for registers and fields to be deduplicated
c44be31
@krcb197
Updated version number for 1st RC on 2.0.0
7c33e5f
@krcb197
Update the actions to run checks on release candidate branches
3f98fdf
@krcb197
Simplify calls into get_reg_writable_fields in the test bench
fb3f7c3
@krcb197
Simplify calls into get_reg_writable_fields in the test bench
80433e8
@krcb197
Remove wasteful messages
2f1ad80
@krcb197
Convert print to logging
19b7480
@krcb197
Optimisation to only make a field if needed otherwise use the baseclass
8fbba4a
@krcb197
Merge branch 'main' of https://github.com/krcb197/PeakRDL-python into…
896d929 
… 190-de-duplicate-field-definitions

# Conflicts:
#	src/peakrdl_python/__about__.py
#	src/peakrdl_python/exporter.py
#	src/peakrdl_python/templates/addrmap.py.jinja
#	src/peakrdl_python/templates/addrmap_register.py.jinja
#	src/peakrdl_python/templates/addrmap_tb.py.jinja
@krcb197
Support finalised for the register fields
38e2a8d
@krcb197
Added support for hashed regfile and addrmap
56840d5
@krcb197
Move the register accesswidth and width inside the class definition r…
a8208e8 
…ather than being a instance parameter. This reduces the auto-generated code size and also makes it consistent with the memory
@krcb197
Clean up linting issues
a4b3885
@krcb197
Added a check to catch the issue with arrays with matching hashes not…
a4af991 
… having the same type names
@krcb197
draft version of the deduplicated components
84c9959
@krcb197
Fix some linting errors
1cbc240
@krcb197
Fix a bug with the generation of encoded field names
1aa74a9
@krcb197
Fix a bug regfiles within regfiles
1d50d64
@krcb197
exclude signals inside node instances from hashes
241d658
@krcb197
Fix problem with the class names generated on the `get_child_by_syste…
c90626b 
…m_rdl_name` type hints
@krcb197
Fix type in doc string
3b5bbe2
@krcb197
Optimisation to minimise the number of times a has is recalculated
1f6d015
@krcb197
Include the has of an enum in the python class name to avoid issues w…
cdb2f3c 
…ith enums in XML files
@krcb197
Remove excessive newlines
3a7fd6e
@krcb197
Fix the optimised access demo due to the change in enum type naming
dea43d0
@krcb197
Improve the docstrings in all the example code
0abc545
@krcb197
Fix enum type naming change issues in the RAL and HAL examples
1e08613
krcb197 added 28 commits October 18, 2025 10:46
@krcb197
In order to address a bug that I have fixed before and de-risk the te…
662f4ca 
…st cases, move the code that changes the import based on whether `skip_lib_copy` is used to a common template macro
@krcb197
Fix bug with relative import of libraries caused by previous fix
803a793
@krcb197
Fix bug with relative import in the example.py
fc8861d
@krcb197
Consolidate the legacy modes into a single operation to reduce the nu…
c1e5526 
…mber of integration tests
@krcb197
Consolidate the legacy modes into a single operation to reduce the nu…
809e578 
…mber of integration tests
@krcb197
Support for generating tests with and without the library copy and up…
1321b04 
…dated the workflow to check
@krcb197
Fix bug in the command parameters for the actions
be7b112
@krcb197
Fix the action file
8e4668d
@krcb197
Another go at fixing the github actions
c9b110c
@krcb197
Merge pull request #224 from krcb197/206-option-remove-the-system-rdl…
cb978ae 
…-name-desc-doc-strings

Added an option to remove the systemRDL name and desc being included in the generated python docstring
@krcb197
Add a check to ensure that a bug with property enumerations not being…
842db6a 
… pulled in to the memories appears in the testing
@krcb197
Fix for the bug with enumerated UDP not having the enum type pulled t…
e3d54db 
…hrough to memory files
@krcb197
Changed the exporter to use a callback function to test if a UDP is n…
97de5c9 
…eeded or not
@krcb197
Updated the version number for this branch
cab7a72
@krcb197
Fix linting errors
00117fc
@krcb197
Implement, test and document the regex UDP mode
fc7f41a 
closes #219
@krcb197
Clean up the README.md
628087b
@krcb197
Add missing quotes to the REGEX parameter
fdf517d
@krcb197
Merge pull request #227 from krcb197/219-default-udp-inclusion
44db752 
Enhanced UDP Support
@krcb197
Updating version to allow release following messup
28134a5
@krcb197
Merge branch 'main' of https://github.com/krcb197/PeakRDL-python into…
dbe06db 
… release/2.0.0

# Conflicts:
#	.github/workflows/action.yaml
#	src/peakrdl_python/__about__.py
@krcb197
Add a mypy badge
54a6db9
@krcb197
Fix problem with dev not installing all of peakrdl
bdc0a6c
@krcb197
Fix problem with assertNotIsSubclass
253a320
@krcb197
Check library version check in the built code
c5785f9
@krcb197
Update version check function with depth parameter
f81613e
@krcb197
Fix working with copied library
ffbae89
@krcb197
Add missing endif
50fb475
@krcb197 krcb197 merged commit 4250ac8 into main Oct 25, 2025
43 checks passed
@krcb197 krcb197 deleted the release/2.0.0 branch October 25, 2025 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@krcb197