From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sat, 29 Jun 2019 09:10:09 +0000 (+0100)
Subject: update comments
X-Git-Tag: ls180-24jan2020~959
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=9aed213b5982d3c158a334c294c6f15c14957643;p=ieee754fpu.git

update comments
---

diff --git a/src/ieee754/fpdiv/div0.py b/src/ieee754/fpdiv/div0.py
index 45a5f971..167edde6 100644
--- a/src/ieee754/fpdiv/div0.py
+++ b/src/ieee754/fpdiv/div0.py
@@ -60,9 +60,9 @@ class FPDivStage0Mod(Elaboratable):
         m = Module()
 
         # XXX TODO, actual DIV code here.  this class would be
-        # "step one" which takes the pre-normalised data and
+        # "step one" which takes the pre-normalised data (see ispec) and
         # *begins* the processing phase (enters the massive DIV
-        # pipeline chain)
+        # pipeline chain) - see ospec.
 
         # store intermediate tests (and zero-extended mantissas)
         am0 = Signal(len(self.i.a.m)+1, reset_less=True)
diff --git a/src/ieee754/fpdiv/div1.py b/src/ieee754/fpdiv/div1.py
index 52edde60..5ceff1fe 100644
--- a/src/ieee754/fpdiv/div1.py
+++ b/src/ieee754/fpdiv/div1.py
@@ -1,4 +1,4 @@
-"""IEEE754 Floating Point Divider 
+"""IEEE754 Floating Point Divider
 
 Relevant bugreport: http://bugs.libre-riscv.org/show_bug.cgi?id=99
 """
@@ -21,10 +21,10 @@ class FPDivStage1Mod(Elaboratable):
         self.o = self.ospec()
 
     def ispec(self):
-        return FPDivStage0Data(self.width, self.id_wid)
+        return FPDivStage0Data(self.width, self.id_wid) # Q/Rem (etc) in...
 
     def ospec(self):
-        return FPDivStage0Data(self.width, self.id_wid)
+        return FPDivStage0Data(self.width, self.id_wid) # ... Q/Rem (etc) out
 
     def process(self, i):
         return self.o
@@ -40,7 +40,8 @@ class FPDivStage1Mod(Elaboratable):
 
         # XXX TODO, actual DIV code here.  this class would be
         # "step two" and is the main "chain".  tons of these needed.
-        # here is where Q and R are used, TODO: those are in FPDivStage0Data.
+        # here is where Q and R are used, TODO: those need to be in
+        # FPDivStage0Data.
 
         # store intermediate tests (and zero-extended mantissas)
         am0 = Signal(len(self.i.a.m)+1, reset_less=True)
diff --git a/src/ieee754/fpdiv/div2.py b/src/ieee754/fpdiv/div2.py
index 051e8702..6b9be39c 100644
--- a/src/ieee754/fpdiv/div2.py
+++ b/src/ieee754/fpdiv/div2.py
@@ -22,10 +22,10 @@ class FPDivStage2Mod(FPState, Elaboratable):
         self.o = self.ospec()
 
     def ispec(self):
-        return FPDivStage0Data(self.width, self.id_wid)
+        return FPDivStage0Data(self.width, self.id_wid) # Q/Rem in...
 
     def ospec(self):
-        return FPAddStage1Data(self.width, self.id_wid)
+        return FPAddStage1Data(self.width, self.id_wid) # out to post-process
 
     def process(self, i):
         return self.o