Dennis/srdl2sv
1
0
Fork 0
mirror of https://github.com/Silicon1602/srdl2sv.git synced 2024-12-21 14:38:40 +00:00
Code Issues Projects Releases Wiki Activity

Add information on HTML/UVM/IP-XACT tools and add more limitations

Browse Source
This commit is contained in:
Dennis Potter 2021-11-07 12:00:47 -08:00
parent 8fd5a202e8
commit 4cb00dc38f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -14,6 +14,9 @@
# Introduction
srdl2sv is a [SystemRDL 2.0](https://www.accellera.org/images/downloads/standards/systemrdl/SystemRDL_2.0_Jan2018.pdf) to (synthesizable) [SystemVerilog](https://ieeexplore.ieee.org/document/8299595/versions) compiler. The tool is based on based on [SystemRDL/systemrdl-compiler](https://github.com/SystemRDL/systemrdl-compiler).
This tool does not generate any documentation, UVM files, or IP_XACT XML. To create those files, one can use [PeakRDL-html](https://github.com/SystemRDL/PeakRDL-html), [PeakRDL-uvm](https://github.com/SystemRDL/PeakRDL-uvm), or [PeakRDL-ipxact](https://github.com/SystemRDL/PeakRDL-ipxact), respectively. Since All these tools are based on the systemrdl-compiler that is also at the base of srdl2sv it is possible to generate a wrapper that uses the same instance tree for all 4 tools.
## Not production ready
Warning: This software is still under development and not yet ready for use in production. Many SystemRDL features are implemented but srdl2sv is still under active development and almost all tests are yet to be written.
# Getting started
@ -173,10 +176,12 @@ optional arguments:
Report bugs via https://github.com/Silicon1602/srdl2sv/issues
```
# Contributing
# License
The source code of srdl2sv (i.e., the actual RTL generator) is licensed under the [GPLv3](LICENSE). All templates in [srdlsv/components/templates](https://github.com/Silicon1602/srdl2sv/tree/develop/srdl2sv/components/templates) and [srdlsv/components/widgets](https://github.com/Silicon1602/srdl2sv/tree/develop/srdl2sv/components/templates) are licensed under the MIT license. Therefore, all RTL that is generated by srdl2sv is also licensed under the MIT license.
# Limitations
- [Any limitations to the systemrdl-compiler](https://systemrdl-compiler.readthedocs.io/en/latest/known_issues.html) also apply to the SystemRDL2SystemVerilog compiler.
- Depth of a hierarchy is limited to 26 levels.
- Keyword `msb0` is currently not supported
- Keyword `paritycheck` is currently not supported
- Bridge addrmaps are currently not supported