OBI: Fix missing intf definition. Adjust coding style. #157

2025-10-13 23:32:18 -07:00
parent aa9a21046d
commit f782c656ca
6 changed files with 133 additions and 73 deletions
--- a/docs/cpuif/obi.rst
+++ b/docs/cpuif/obi.rst
@@ -0,0 +1,18 @@
+Open Bus Interface (OBI)
+========================
+
+Implements the register block using an `OBI <https://github.com/openhwgroup/obi>`_
+CPU interface.
+
+The OBI interface comes in two i/o port flavors:
+
+SystemVerilog Interface
+    * Command line: ``--cpuif obi``
+    * Interface Definition: :download:`obi_intf.sv <../../hdl-src/obi_intf.sv>`
+    * Class: :class:`peakrdl_regblock.cpuif.obi.OBI_Cpuif`
+
+Flattened inputs/outputs
+    Flattens the interface into discrete input and output ports.
+
+    * Command line: ``--cpuif obi-flat``
+    * Class: :class:`peakrdl_regblock.cpuif.obi.OBI_Cpuif_flattened`
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -62,6 +62,7 @@ Links
    cpuif/apb
    cpuif/axi4lite
    cpuif/avalon
+    cpuif/obi
    cpuif/passthrough
    cpuif/internal_protocol
    cpuif/customizing