From 2d3ec2f323a5ee06f8911ce7fd1fab3163d02c81 Mon Sep 17 00:00:00 2001
From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 8 Apr 2019 03:42:48 +0100
Subject: [PATCH] rename BufferedPipeline2 to SimpleHandshake

---
 src/add/singlepipe.py    | 15 ++++++---------
 src/add/test_buf_pipe.py |  6 +++---
 2 files changed, 9 insertions(+), 12 deletions(-)

diff --git a/src/add/singlepipe.py b/src/add/singlepipe.py
index c10b34e9..6cbc30b7 100644
--- a/src/add/singlepipe.py
+++ b/src/add/singlepipe.py
@@ -149,12 +149,10 @@
 
     it's quite a complex state machine!
 
-    BufferedPipeline2
-    -----------------
+    SimpleHandshake
+    ---------------
 
-    Synchronised pipeline
-
-    Based on:
+    Synchronised pipeline, Based on:
     https://github.com/ZipCPU/dbgbus/blob/master/hexbus/rtl/hbdeword.v
 """
 
@@ -641,10 +639,9 @@ class BufferedPipeline(ControlBase):
         return self.m
 
 
-class BufferedPipeline2(ControlBase):
-    """ buffered pipeline stage.  data and strobe signals travel in sync.
-        if ever the input is ready and the output is not, processed data
-        is shunted in a temporary register.
+class SimpleHandshake(ControlBase):
+    """ simple handshake control.  data and strobe signals travel in sync.
+        implements the protocol used by Wishbone and AXI4.
 
         Argument: stage.  see Stage API above
 
diff --git a/src/add/test_buf_pipe.py b/src/add/test_buf_pipe.py
index d81e7f10..adb20cbe 100644
--- a/src/add/test_buf_pipe.py
+++ b/src/add/test_buf_pipe.py
@@ -25,7 +25,7 @@ from example_buf_pipe import ExampleStageCls
 from example_buf_pipe import PrevControl, NextControl, BufferedPipeline
 from example_buf_pipe import StageChain, ControlBase, StageCls
 from singlepipe import UnbufferedPipeline2
-from singlepipe import BufferedPipeline2
+from singlepipe import SimpleHandshake
 
 from random import randint, seed
 
@@ -669,11 +669,11 @@ class ExampleUnBufDelayedPipe(BufferedPipeline):
 # Test 15
 ######################################################################
 
-class ExampleBufModeAdd1Pipe(BufferedPipeline2):
+class ExampleBufModeAdd1Pipe(SimpleHandshake):
 
     def __init__(self):
         stage = ExampleStageCls()
-        BufferedPipeline2.__init__(self, stage)
+        SimpleHandshake.__init__(self, stage)
 
 
 ######################################################################
-- 
2.30.2