Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.45 KB

README.md

File metadata and controls

35 lines (24 loc) · 2.45 KB

Documentation Status build Coverage Status PyPI - Python Version

PeakRDL-regblock-vhdl

Compile SystemRDL into a VHDL control/status register (CSR) block.

For the command line tool, see the PeakRDL project.

Documentation

See the PeakRDL-regblock-vhdl Documentation for more details

Relationship with PeakRDL-regblock

This is a direct VHDL translation of the SystemVerilog regblock generator PeakRDL-regblock. Updates from the upstream regblock implementation are converted to VHDL and merged into this repository.

Goals

  • Maintain feature parity with the upstream SystemVerilog implementation.
  • Keep the code structure as close as possible to upstream to allow merging future updates.
  • Keep the unit tests as close as possible to upstream. In most cases they are unchanged.
    • Tests are written in SystemVerilog and an auto-generated test adapter is used to instantiate the VHDL regblock under test.

Versioning

Version numbers track those in the upstream repository with an added segment. For example, the VHDL version 1.0.0.0 would indicate the first release matching the functionality of the upstream version 1.0.0. Version 1.0.0.1 would indicate a patch update unique to the VHDL port.

In some cases (such as git tags), a +vhdl metadata specifier is suffixed to help differentiate from the upstream versions.

Issue Reporting

If you encounter an issue or want to suggest a feature,

  1. Check if it is already reported in the upstream repository's issue tracker.
  2. Report it in the upstream repository unless you are sure it's unique to the VHDL port. If you are unsure, report it here and it may be moved upstream if deemed appropriate.
  3. The upstream fix will be merged into this VHDL port.