documentation on pipeline API

[ieee754fpu.git] / src / nmutil / singlepipe.py

diff --git a/src/nmutil/singlepipe.py b/src/nmutil/singlepipe.py
index 69a4efe515a8a760acb1e658538c6b7cfee99612..a526be7be4258df041ff7f3fa9e2caa34b06ca19 100644 (file)
--- a/src/nmutil/singlepipe.py
+++ b/src/nmutil/singlepipe.py
@@ -4,7 +4,16 @@
     * http://bugs.libre-riscv.org/show_bug.cgi?id=64
     * http://bugs.libre-riscv.org/show_bug.cgi?id=57
 
-    Important: see Stage API (stageapi.py) in combination with below
+    Important: see Stage API (stageapi.py) and IO Control API
+    (iocontrol.py) in combination with below.  This module
+    "combines" the Stage API with the IO Control API to create
+    the Pipeline API.
+
+    The one critically important key difference between StageAPI and
+    PipelineAPI:
+
+        * StageAPI: combinatorial (NO REGISTERS / LATCHES PERMITTED)
+        * PipelineAPI: synchronous (registers / latches MAY added on demand)
 
     RecordBasedStage:
     ----------------