Metadata-Version: 2.4
Name: rdl2ot
Version: 0.3.0
Summary: An extension of PeakRDL to generate OpenTitan RTL.
Project-URL: Homepage, https://github.com/lowrisc/benevisrdl
Project-URL: Issues, https://github.com/lowrisc/benevisrdl/issues
Project-URL: Documentation, https://github.com/lowrisc/benevisrdl
Author: lowRISC contributors
Keywords: Codegen,OpenTitan,SystemRDL
Requires-Python: >=3.10
Requires-Dist: click>=8.3.0
Requires-Dist: jinja2>=3.1.6
Requires-Dist: systemrdl-compiler>=1.29
Description-Content-Type: text/markdown

# rdl2ot cli tool
<!--
# SPDX-FileCopyrightText: lowRISC contributors.
# SPDX-License-Identifier: Apache-2.0
-->

A PeakRDL extension to generate OpenTitan register block SystemVerilog from SystemRDL files.

## Using as a standalone tool
### How to generate the OpenTitan register interfaces from a RDL file
```sh
rdl2ot export-rtl <input_rdl> <output_dir>
```

Example:
```sh
mkdir -p /tmp/lc_ctrl
rdl2ot export-rtl tests/snapshots/lc_ctrl.rdl /tmp/lc_ctrl/
```

## Using as a PeakRDL pluggin 
### Installing
```sh
pip install peakrdl rdl2ot
```
### Running
```sh
mkdir -p /tmp/lc_ctrl
peakrdl rdl2ot tests/snapshots/lc_ctrl.rdl -o /tmp/lc_ctrl/
```

## Contributing
### How to run tests
```sh
cd rdl2ot
pytest
```

