From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Tue, 19 Nov 2019 15:37:05 +0000 (+0000)
Subject: documentation on pipeline API
X-Git-Tag: ls180-24jan2020~359
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5ebcdffe48002af2a6838ee2f19478c8d183d2d3;p=ieee754fpu.git

documentation on pipeline API
---

diff --git a/src/nmutil/singlepipe.py b/src/nmutil/singlepipe.py
index 69a4efe5..a526be7b 100644
--- 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:
     ----------------