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 synthesizable 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

Generate C headers for software

peakrdl c-header atxmega_spi.rdl -o atxmega_spi.h

# .. Or with bit-fields
peakrdl c-header atxmega_spi.rdl -o atxmega_spi_bf.h --bitfields ltoh

Input: atxmega_spi.rdl

Result: atxmega_spi.h & atxmega_spi_bf.h

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 Plugins already available.