From b5e9a0039a31180d5c08ec27ac2fbc2d3e2210cd Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Sat, 27 Apr 2019 23:42:54 +0100 Subject: [PATCH] update docstrings --- src/add/iocontrol.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/add/iocontrol.py b/src/add/iocontrol.py index a4450c80..3d82027e 100644 --- a/src/add/iocontrol.py +++ b/src/add/iocontrol.py @@ -56,6 +56,11 @@ Also has an extremely useful "connect" function that can be used to connect a chain of pipelines and present the exact same prev/next ready/valid/data API. + + Note: pipelines basically do not become pipelines as such until + handed to a derivative of ControlBase. ControlBase itself is *not* + strictly considered a pipeline class. Wishbone and AXI4 (master or + slave) could be derived from ControlBase, for example. """ from nmigen import Signal, Cat, Const, Mux, Module, Value, Elaboratable @@ -158,16 +163,16 @@ class PrevControl(Elaboratable): may be a multi-bit signal, where all bits are required to be asserted to indicate "valid". * ready_o: output to next stage indicating readiness to accept data - * data_i : an input - added by the user of this class + * data_i : an input - MUST be added by the USER of this class """ def __init__(self, i_width=1, stage_ctl=False): self.stage_ctl = stage_ctl self.valid_i = Signal(i_width, name="p_valid_i") # prev >>in self - self._ready_o = Signal(name="p_ready_o") # prev <