Initial Commit - Forked from PeakRDL-regblock @ a440cc19769069be831d267505da4f3789a26695

docs/configuring.rst

@@ -0,0 +1,45 @@
+.. _peakrdl_cfg:
+
+Configuring PeakRDL-regblock
+============================
+
+If using the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_,
+some aspects of the ``regblock`` command have additional configuration options
+available via the PeakRDL TOML file.
+
+All regblock-specific options are defined under the ``[regblock]`` 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
+
+        [regblock]
+        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
+
+        [regblock]
+        default_reset = "arst"