6489f49873
* Initial plan * Update documentation to use correct repository name PeakRDL-BusDecoder Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> * Update CONTRIBUTING.md and GitHub templates with correct repository name Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> * Update author to arnavsacheti and clarify bus decoder purpose in documentation Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> * Update author to 'Arnav Sacheti' and revise UDP documentation to reflect no current UDP support Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com>
46 lines
1.1 KiB
ReStructuredText
46 lines
1.1 KiB
ReStructuredText
.. _peakrdl_cfg:
|
|
|
|
Configuring PeakRDL-BusDecoder
|
|
============================
|
|
|
|
If using the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_,
|
|
some aspects of the ``busdecoder`` command have additional configuration options
|
|
available via the PeakRDL TOML file.
|
|
|
|
All busdecoder-specific options are defined under the ``[busdecoder]`` TOML heading.
|
|
|
|
.. data:: cpuifs
|
|
|
|
Mapping of additional CPU Interface implementation classes to load.
|
|
The mapping's key indicates the cpuif's name.
|
|
The value is a string that describes the import path and cpuif class to
|
|
load.
|
|
|
|
For example:
|
|
|
|
.. code-block:: toml
|
|
|
|
[busdecoder]
|
|
cpuifs.my-cpuif-name = "my_cpuif_module:MyCPUInterfaceClass"
|
|
|
|
|
|
.. data:: default_reset
|
|
|
|
Choose the default style of reset signal if not explicitly
|
|
specified by the SystemRDL design. If unspecified, the default reset
|
|
is active-high and synchronous.
|
|
|
|
Choice of:
|
|
|
|
* ``rst`` (default)
|
|
* ``rst_n``
|
|
* ``arst``
|
|
* ``arst_n``
|
|
|
|
For example:
|
|
|
|
.. code-block:: toml
|
|
|
|
[busdecoder]
|
|
default_reset = "arst"
|