Skip to main content
Ctrl+K

PeakRDL

  • Introduction
  • Gallery of Examples
  • SystemRDL Tutorial
  • Processing Input
  • Configuring PeakRDL
  • Licensing

Additional Exporter Docs

  • regblock
  • ip-xact

For Developers

  • Defining your own Exporter
  • Defining your own Importer
  • Plugin Descriptors
  • Configuration Schema
  • Repository
  • Show source
  • Open issue

Gallery of Examples

Contents

  • Generate syntesizable SystemVerilog RTL
  • Produce dynamic HTML documentation
  • Create a UVM Register Model
  • Convert to IP-XACT XML
  • Convert other formats to SystemRDL
  • Run your own custom command

Gallery of Examples#

These are all very simple examples of what you can do with PeakRDL but be aware that you can do far more powerful things.

For more details, see the individual command’s --help flag.

# For general help
peakrdl --help

# For help about a specific subcommand:
peakrdl <subcommand> --help

Generate syntesizable SystemVerilog RTL#

peakrdl regblock atxmega_spi.rdl -o regblock/ --cpuif apb3-flat

Input: atxmega_spi.rdl

Result: regblock/

For more details, see the full PeakRDL-regblock documentation.

Produce dynamic HTML documentation#

peakrdl html turboencabulator.rdl -o html_dir/

Input: turboencabulator.rdl

Result: HTML register reference

Create a UVM Register Model#

peakrdl uvm atxmega_spi.rdl -o atxmega_spi_uvm_pkg.sv

Input: atxmega_spi.rdl

Result: atxmega_uvm_pkg.sv

Convert to IP-XACT XML#

peakrdl ip-xact atxmega_spi.rdl -o atxmega_spi.xml

Input: atxmega_spi.rdl

Result: atxmega_spi.xml

For more details, see the full PeakRDL-ipxact documentation.

Convert other formats to SystemRDL#

# Convert IP-XACT to SystemRDL
peakrdl systemrdl atxmega_spi.xml -o atxmega_spi.rdl

Provided by PeakRDL-systemrdl.

Run your own custom command#

peakrdl YOUR-COMMAND-HERE atxmega_spi.rdl ...

PeakRDL can be extended with additional user-defined commands. See more details here: Defining your own Exporter

Or, check out the various community-contributed plugins already available.

previous

Introduction

next

SystemRDL Tutorial

Contents
  • Generate syntesizable SystemVerilog RTL
  • Produce dynamic HTML documentation
  • Create a UVM Register Model
  • Convert to IP-XACT XML
  • Convert other formats to SystemRDL
  • Run your own custom command

By Alex Mykyta

© Copyright 2023, Alex Mykyta.