Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BenevisRdl
This repository will house PeakRdl plugins, named after Ben Nevis, the UK's tallest peak.
# BenevisRDL
This repository will house PeakRDL plugins, named after Ben Nevis, the UK's tallest peak.

## Installing dependencies
### Using uv on macOS and Linux
Expand All @@ -16,7 +16,7 @@ nix develop
```

## rdl2ot cli tool
A PeakRDL extension to generate Opentitan style source files from SystemRDL files.
A PeakRDL extension to generate OpenTitan register block SystemVerilog from SystemRDL files.

For more details, refer to [rdl2ot](./rdl2ot)

Expand All @@ -26,20 +26,20 @@ cd rdl2ot
pytest
```

### How to generate the Opentitan register interfaces from a RDL file
### How to generate the OpenTitan register interfaces from a RDL file
```sh
cd rdl2ot
python src/rdl2ot export-rtl tests/snapshots/lc_ctrl.rdl /tmp/
```

## Rdl-exporter
## rdlexporter
A library to generate SystemRDL files from the Hierarchical Register Model.

For more details, refer to [rdlexporter](./rdlexporter)

### How to run tests
```sh
cd rdl-exporter
cd rdlexporter
pytest
```

Expand Down
6 changes: 3 additions & 3 deletions rdl2ot/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# rdl2ot cli tool
A PeakRDL extension to generate Opentitan style source files from SystemRDL files.
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
### How to generate the OpenTitan register interfaces from a RDL file
```sh
rdl2ot export-rtl <input_rdl> <output_dir>
```
Expand All @@ -13,7 +13,7 @@ mkdir -p /tmp/lc_ctrl
rdl2ot export-rtl tests/snapshots/lc_ctrl.rdl /tmp/lc_ctrl/
```

## Using as a Peakrdl pluggin
## Using as a PeakRDL pluggin
### Installing
```sh
pip install peakrdl rdl2ot
Expand Down
4 changes: 2 additions & 2 deletions rdl2ot/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[project]
name = "rdl2ot"
version = "0.1.0"
description = "An extension of PeakRDL to generate Opentitan RTL."
description = "An extension of PeakRDL to generate OpenTitan RTL."
requires-python = ">=3.10"
keywords = ["SystemRDL", "Opentitan", "Codegen"]
keywords = ["SystemRDL", "OpenTitan", "Codegen"]
readme = "README.md"
dependencies = [
"click>=8.2.1",
Expand Down
6 changes: 3 additions & 3 deletions rdl2ot/src/rdl2ot/__peakrdl__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

"""Generates Opentitan regblock RTL."""
"""Generates OpenTitan regblock RTL."""

from pathlib import Path
from typing import TYPE_CHECKING
Expand All @@ -19,9 +19,9 @@


class Exporter(ExporterSubcommandPlugin):
"""Generates Opentitan regblock RTL."""
"""Generates OpenTitan regblock RTL."""

short_desc = "Generates Opentitan register block RTL."
short_desc = "Generates OpenTitan register block RTL."

def add_exporter_arguments(self, arg_group: "argparse.ArgumentParser") -> None:
"""No extra arguments."""
Expand Down
2 changes: 1 addition & 1 deletion rdl2ot/src/rdl2ot/rtl_exporter.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def run(root_node: node.AddrmapNode, out_dir: Path) -> None:


class OtInterfaceBuilder:
"""Opentitan Interface Builder."""
"""OpenTitan Interface Builder."""

num_regs: int = 0 # The number of registers of an interface
num_windows: int = 0 # The number of registers of an interface
Expand Down
2 changes: 1 addition & 1 deletion rdlexporter/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# rdl-exporter
# rdlexporter
A library to generate SystemRDL files from the Hierarchical Register Model.

How to use it:
Expand Down