From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Fri, 28 Jun 2019 07:43:21 +0000 (+0100)
Subject: add comments on parameters
X-Git-Tag: ls180-24jan2020~968
X-Git-Url: https://git.libre-soc.org/?p=ieee754fpu.git;a=commitdiff_plain;h=4d0caba0e95751f05690323fbe25fd0286cea40f

add comments on parameters
---

diff --git a/src/ieee754/fpcommon/denorm.py b/src/ieee754/fpcommon/denorm.py
index 7f45b6b7..559c5ae2 100644
--- a/src/ieee754/fpcommon/denorm.py
+++ b/src/ieee754/fpcommon/denorm.py
@@ -13,12 +13,17 @@ from ieee754.fpcommon.fpbase import FPState, FPNumBase
 class FPSCData:
 
     def __init__(self, width, id_wid, m_extra=True):
-        self.a = FPNumBaseRecord(width, m_extra)
-        self.b = FPNumBaseRecord(width, m_extra)
-        self.z = FPNumBaseRecord(width, False)
-        self.oz = Signal(width, reset_less=True)
-        self.out_do_z = Signal(reset_less=True)
-        self.mid = Signal(id_wid, reset_less=True)
+
+        # NOTE: difference between z and oz is that oz is created by
+        # special-cases module(s) and will propagate, along with its
+        # "bypass" signal out_do_z, through the pipeline, *disabling*
+        # all processing of all subsequent stages.
+        self.a = FPNumBaseRecord(width, m_extra)   # operand a
+        self.b = FPNumBaseRecord(width, m_extra)   # operand b
+        self.z = FPNumBaseRecord(width, False)     # denormed result 
+        self.oz = Signal(width, reset_less=True)   # "finished" (bypass) result
+        self.out_do_z = Signal(reset_less=True)    # "bypass" enabled
+        self.mid = Signal(id_wid, reset_less=True) # multiplexer ID
 
     def __iter__(self):
         yield from self.a