95 lines
2.3 KiB
ReStructuredText
95 lines
2.3 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
PeakRDL-busdecoder is a free and open-source control & status register (CSR) compiler.
|
|
This code generator translates your SystemRDL register description into
|
|
a synthesizable SystemVerilog RTL module that can be easily instantiated into
|
|
your hardware design.
|
|
|
|
* Generates fully synthesizable SystemVerilog RTL (IEEE 1800-2012)
|
|
* Options for many popular CPU interface protocols (AMBA APB, AXI4-Lite, and more)
|
|
* Configurable pipelining options for designs with fast clock rates.
|
|
* Broad support for SystemRDL 2.0 features
|
|
|
|
|
|
Quick Start
|
|
-----------
|
|
The easiest way to use PeakRDL-busdecoder is via the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_:
|
|
|
|
.. code-block:: bash
|
|
|
|
# Install PeakRDL-busdecoder along with the command-line tool
|
|
python3 -m pip install peakrdl-busdecoder[cli]
|
|
|
|
# Export!
|
|
peakrdl busdecoder atxmega_spi.rdl -o busdecoder/ --cpuif axi4-lite
|
|
|
|
|
|
Looking for VHDL?
|
|
-----------------
|
|
This project generates SystemVerilog RTL. If you prefer using VHDL, check out
|
|
the sister project which aims to be a feature-equivalent fork of
|
|
PeakRDL-busdecoder: `PeakRDL-busdecoder-VHDL <https://peakrdl-busdecoder-vhdl.readthedocs.io>`_
|
|
|
|
|
|
Links
|
|
-----
|
|
|
|
- `Source repository <https://github.com/SystemRDL/PeakRDL-busdecoder>`_
|
|
- `Release Notes <https://github.com/SystemRDL/PeakRDL-busdecoder/releases>`_
|
|
- `Issue tracker <https://github.com/SystemRDL/PeakRDL-busdecoder/issues>`_
|
|
- `PyPi <https://pypi.org/project/peakrdl-busdecoder>`_
|
|
- `SystemRDL Specification <http://accellera.org/downloads/standards/systemrdl>`_
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
self
|
|
architecture
|
|
hwif
|
|
configuring
|
|
limitations
|
|
faq
|
|
licensing
|
|
api
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: CPU Interfaces
|
|
|
|
cpuif/introduction
|
|
cpuif/apb
|
|
cpuif/axi4lite
|
|
cpuif/avalon
|
|
cpuif/passthrough
|
|
cpuif/internal_protocol
|
|
cpuif/customizing
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: SystemRDL Properties
|
|
|
|
props/field
|
|
props/reg
|
|
props/addrmap
|
|
props/signal
|
|
props/rhs_props
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Other SystemRDL Features
|
|
|
|
rdl_features/external
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:caption: Extended Properties
|
|
|
|
udps/intro
|
|
udps/read_buffering
|
|
udps/write_buffering
|
|
udps/extended_swacc
|
|
udps/signed
|
|
udps/fixedpoint
|