Dennis/srdl2sv
1
0
Fork 0
mirror of https://github.com/Silicon1602/srdl2sv.git synced 2025-09-16 15:03:05 +00:00
Code Issues Projects Releases Wiki Activity

Add LICENSEs to srdl2sv

Browse Source 
The software itself is licensed under the copy-left GPL-3.0 license. All
RTL (i.e., templates and widgets) are licensed under the MIT license.
Therefore, the generated RTL will not be subject to the GPL-3.0 but to
the MIT license.
This commit is contained in:
Dennis Potter
2021-06-26 11:08:13 +02:00
parent baf08d2343
commit 6deb772196
3 changed files with 275 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -35,8 +35,10 @@ srdl2sv example_addrmap.rdl
## Help function
A comprehensive help function of the tool can be invoked by running `srdl2sv --help`.
```
usage: main.py [-h] [-o OUT_DIR] [-d SEARCH_PATHS [SEARCH_PATHS ...]] [-r] [-x] [-e] [--stream_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}] [--file_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}]
[--real_tabs] [--tab_width TAB_WIDTH]
usage: main.py [-h] [-b {amba3ahblite}] [-o OUT_DIR] [-d SEARCH_PATHS [SEARCH_PATHS ...]] [-r] [-x]
[-e] [--stream_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}]
[--file_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}] [--real_tabs]
[--tab_width TAB_WIDTH]
IN_RDL [IN_RDL ...]
SystemRDL 2 SystemVerilog compiler
@@ -46,23 +48,35 @@ positional arguments:
optional arguments:
-h, --help show this help message and exit
-b {amba3ahblite}, --bus {amba3ahblite}
Set the bus protocol that shall be used by software to ', communicate with the
registers. (default: amba3ahblite)
-o OUT_DIR, --out_dir OUT_DIR
Define output directory to dump files. If directory is non-existent, it will be created. (default: ./srdl2sv_out)
Define output directory to dump files. If directory is non-existent, it will
be created. (default: ./srdl2sv_out)
-d SEARCH_PATHS [SEARCH_PATHS ...], --search_paths SEARCH_PATHS [SEARCH_PATHS ...]
Point to one (or more) directories that will be searched for RDL files.
-r, --recursive_search
If set, the dependency directories will be searched recursively.
-x, --disable_sanity Disable sanity checks or components. This might speed up the compiler but is generally not recommended!
-e, --disable_enums Disable enumeration generation. This will prevent the compiler from generating packages and it will prevent it from using enums in the port list.
-x, --disable_sanity Disable sanity checks or components. This might speed up the compiler but is
generally not recommended!
-e, --disable_enums Disable enumeration generation. This will prevent the compiler from generating
packages and it will prevent it from using enums in the port list.
--stream_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}
Set verbosity level of output to shell. When set to 'NONE', nothing will be printed to the shell. (default: WARNING)
Set verbosity level of output to shell. When set to 'NONE', nothing will be
printed to the shell. (default: WARNING)
--file_log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}
Set verbosity level of output to log-file. When set to 'NONE', nothing will be printed to the shell. (default: INFO)
Set verbosity level of output to log-file. When set to 'NONE', nothing will be
printed to the shell. (default: INFO)
--real_tabs Use tabs, rather than spaces, for tabs
--tab_width TAB_WIDTH
Define how many tabs or spaces will be contained in one level of indentation. (default: 4)
Define how many tabs or spaces will be contained in one level of indentation.
(default: 4)
```
# 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](srdlsv/components/templates) and [srdlsv/components/widgets](srdlsv/components/widgets) are licensed under the [MIT](LICENSE.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.