rewrite fpadd specialcases to use Mux instead of m.IF/Elif/Elif/Elif
[ieee754fpu.git] / src / ieee754 / fpadd / specialcases.py
index 9846eabc40cdcec38a30d892b199168f5fad899e..656ace3ceced434ee50a16740bd299db8e5bc8ec 100644 (file)
@@ -2,19 +2,19 @@
 # Copyright (C) Jonathan P Dawson 2013
 # 2013-12-12
 
-from nmigen import Module, Signal, Cat, Const
+from nmigen import Module, Signal, Cat, Const, Mux
 from nmigen.cli import main, verilog
 from math import log
 
-from ieee754.fpcommon.modbase import FPModBase, FPModBaseChain
+from nmutil.pipemodbase import PipeModBase, PipeModBaseChain
 from ieee754.fpcommon.fpbase import FPNumDecode
 
 from ieee754.fpcommon.fpbase import FPNumBaseRecord
-from ieee754.fpcommon.getop import FPADDBaseData
+from ieee754.fpcommon.basedata import FPBaseData
 from ieee754.fpcommon.denorm import (FPSCData, FPAddDeNormMod)
 
 
-class FPAddSpecialCasesMod(FPModBase):
+class FPAddSpecialCasesMod(PipeModBase):
     """ special cases: NaNs, infs, zeros, denormalised
         NOTE: some of these are unique to add.  see "Special Operations"
         https://steve.hollasch.net/cgindex/coding/ieeefloat.html
@@ -24,7 +24,7 @@ class FPAddSpecialCasesMod(FPModBase):
         super().__init__(pspec, "specialcases")
 
     def ispec(self):
-        return FPADDBaseData(self.pspec)
+        return FPBaseData(self.pspec)
 
     def ospec(self):
         return FPSCData(self.pspec, True)
@@ -49,87 +49,80 @@ class FPAddSpecialCasesMod(FPModBase):
         s_nomatch = Signal(reset_less=True)
         m_match = Signal(reset_less=True)
         e_match = Signal(reset_less=True)
-        aeqmb = Signal(reset_less=True)
-        abz = Signal(reset_less=True)
-        abnan = Signal(reset_less=True)
+        absa = Signal(reset_less=True) # a1.s & b1.s
+        t_aeqmb = Signal(reset_less=True)
+        t_a1inf = Signal(reset_less=True)
+        t_b1inf = Signal(reset_less=True)
+        t_a1zero = Signal(reset_less=True)
+        t_b1zero = Signal(reset_less=True)
+        t_abz = Signal(reset_less=True)
+        t_abnan = Signal(reset_less=True)
         bexp128s = Signal(reset_less=True)
+        t_special = Signal(reset_less=True)
 
         comb += s_nomatch.eq(a1.s != b1.s)
         comb += m_match.eq(a1.m == b1.m)
         comb += e_match.eq(a1.e == b1.e)
-        comb += aeqmb.eq(s_nomatch & m_match & e_match)
-        comb += abz.eq(a1.is_zero & b1.is_zero)
-        comb += abnan.eq(a1.is_nan | b1.is_nan)
+
+        # logic-chain (matches comments, below) gives an if-elif-elif-elif...
+        comb += t_abnan.eq(a1.is_nan | b1.is_nan)
+        comb += t_a1inf.eq(a1.is_inf)
+        comb += t_b1inf.eq(b1.is_inf)
+        comb += t_abz.eq(a1.is_zero & b1.is_zero)
+        comb += t_a1zero.eq(a1.is_zero)
+        comb += t_b1zero.eq(b1.is_zero)
+        comb += t_aeqmb.eq(s_nomatch & m_match & e_match)
+        comb += t_special.eq(Cat(t_aeqmb, t_b1zero, t_a1zero, t_abz,
+                                     t_b1inf, t_a1inf, t_abnan).bool())
+
+        comb += absa.eq(a1.s & b1.s)
         comb += bexp128s.eq(b1.exp_128 & s_nomatch)
 
-        # default bypass
-        comb += self.o.out_do_z.eq(1)
+        # prepare inf/zero/nans
+        z_zero = FPNumBaseRecord(width, False, name="z_zero")
+        z_nan = FPNumBaseRecord(width, False, name="z_nan")
+        z_infa = FPNumBaseRecord(width, False, name="z_infa")
+        z_infb = FPNumBaseRecord(width, False, name="z_infb")
+        comb += z_zero.zero(0)
+        comb += z_nan.nan(0)
+        comb += z_infa.inf(a1.s)
+        comb += z_infb.inf(b1.s)
+
+        # any special-cases it's a "special".
+        comb += self.o.out_do_z.eq(t_special)
 
+        # this is the logic-decision-making for special-cases:
         # if a is NaN or b is NaN return NaN
-        with m.If(abnan):
-            comb += self.o.z.nan(0)
-
-        # XXX WEIRDNESS for FP16 non-canonical NaN handling
-        # under review
-
-        ## if a is zero and b is NaN return -b
-        #with m.If(a.is_zero & (a.s==0) & b.is_nan):
-        #    comb += self.o.out_do_z.eq(1)
-        #    comb += z.create(b.s, b.e, Cat(b.m[3:-2], ~b.m[0]))
-
-        ## if b is zero and a is NaN return -a
-        #with m.Elif(b.is_zero & (b.s==0) & a.is_nan):
-        #    comb += self.o.out_do_z.eq(1)
-        #    comb += z.create(a.s, a.e, Cat(a.m[3:-2], ~a.m[0]))
-
-        ## if a is -zero and b is NaN return -b
-        #with m.Elif(a.is_zero & (a.s==1) & b.is_nan):
-        #    comb += self.o.out_do_z.eq(1)
-        #    comb += z.create(a.s & b.s, b.e, Cat(b.m[3:-2], 1))
-
-        ## if b is -zero and a is NaN return -a
-        #with m.Elif(b.is_zero & (b.s==1) & a.is_nan):
-        #    comb += self.o.out_do_z.eq(1)
-        #    comb += z.create(a.s & b.s, a.e, Cat(a.m[3:-2], 1))
-
-        # if a is inf return inf (or NaN)
-        with m.Elif(a1.is_inf):
-            comb += self.o.z.inf(a1.s)
-            # if a is inf and signs don't match return NaN
-            with m.If(bexp128s):
-                comb += self.o.z.nan(0)
-
-        # if b is inf return inf
-        with m.Elif(b1.is_inf):
-            comb += self.o.z.inf(b1.s)
-
-        # if a is zero and b zero return signed-a/b
-        with m.Elif(abz):
-            comb += self.o.z.create(a1.s & b1.s, b1.e, b1.m[3:-1])
-
-        # if a is zero return b
-        with m.Elif(a1.is_zero):
-            comb += self.o.z.create(b1.s, b1.e, b1.m[3:-1])
-
-        # if b is zero return a
-        with m.Elif(b1.is_zero):
-            comb += self.o.z.create(a1.s, a1.e, a1.m[3:-1])
-
-        # if a equal to -b return zero (+ve zero)
-        with m.Elif(aeqmb):
-            comb += self.o.z.zero(0)
-
-        # Denormalised Number checks next, so pass a/b data through
-        with m.Else():
-            comb += self.o.out_do_z.eq(0)
-
-        comb += self.o.oz.eq(self.o.z.v)
+        # elif a is inf return inf (or NaN)
+        #   if a is inf and signs don't match return NaN
+        #   else return inf(a)
+        # elif b is inf return inf(b)
+        # elif a is zero and b zero return signed-a/b
+        # elif a is zero return b
+        # elif b is zero return a
+        # elif a equal to -b return zero (+ve zero)
+
+        # XXX *sigh* there are better ways to do this...
+        # one of them: use a priority-picker!
+        # in reverse-order, accumulate Muxing
+
+        oz = 0
+        oz = Mux(t_aeqmb, z_zero.v, oz)
+        oz = Mux(t_b1zero, a1.v, oz)
+        oz = Mux(t_a1zero, b1.v, oz)
+        oz = Mux(t_abz, Cat(self.i.b[:-1], absa), oz)
+        oz = Mux(t_b1inf, z_infb.v, oz)
+        oz = Mux(t_a1inf, Mux(bexp128s, z_nan.v, z_infa.v), oz)
+        oz = Mux(t_abnan, z_nan.v, oz)
+
+        comb += self.o.oz.eq(oz)
+
         comb += self.o.ctx.eq(self.i.ctx)
 
         return m
 
 
-class FPAddSpecialCasesDeNorm(FPModBaseChain):
+class FPAddSpecialCasesDeNorm(PipeModBaseChain):
     """ special cases chain
     """