src/ieee754/fpmul/specialcases.py

   1 # IEEE Floating Point Multiplier
   2
   3 from nmigen import Module, Signal, Cat, Const, Elaboratable
   4 from nmigen.cli import main, verilog
   5 from math import log
   6
   7 from ieee754.fpcommon.fpbase import FPNumDecode
   8 from nmutil.singlepipe import SimpleHandshake, StageChain
   9
  10 from ieee754.fpcommon.fpbase import FPState, FPID
  11 from ieee754.fpcommon.getop import FPADDBaseData
  12 from ieee754.fpcommon.denorm import (FPSCData, FPAddDeNormMod)
  13
  14
  15 class FPMulSpecialCasesMod(Elaboratable):
  16     """ special cases: NaNs, infs, zeros, denormalised
  17         see "Special Operations"
  18         https://steve.hollasch.net/cgindex/coding/ieeefloat.html
  19     """
  20
  21     def __init__(self, width, id_wid):
  22         self.width = width
  23         self.id_wid = id_wid
  24         self.i = self.ispec()
  25         self.o = self.ospec()
  26
  27     def ispec(self):
  28         return FPADDBaseData(self.width, self.id_wid)
  29
  30     def ospec(self):
  31         return FPSCData(self.width, self.id_wid, False)
  32
  33     def setup(self, m, i):
  34         """ links module to inputs and outputs
  35         """
  36         m.submodules.specialcases = self
  37         m.d.comb += self.i.eq(i)
  38
  39     def process(self, i):
  40         return self.o
  41
  42     def elaborate(self, platform):
  43         m = Module()
  44
  45         m.submodules.sc_out_z = self.o.z
  46
  47         # decode: XXX really should move to separate stage
  48         a1 = FPNumDecode(None, self.width, False)
  49         b1 = FPNumDecode(None, self.width, False)
  50         m.submodules.sc_decode_a = a1
  51         m.submodules.sc_decode_b = b1
  52         m.d.comb += [a1.v.eq(self.i.a),
  53                      b1.v.eq(self.i.b),
  54                      self.o.a.eq(a1),
  55                      self.o.b.eq(b1)
  56                     ]
  57
  58         obz = Signal(reset_less=True)
  59         m.d.comb += obz.eq(a1.is_zero | b1.is_zero)
  60
  61         sabx = Signal(reset_less=True)   # sign a xor b (sabx, get it?)
  62         m.d.comb += sabx.eq(a1.s ^ b1.s)
  63
  64         abnan = Signal(reset_less=True)
  65         m.d.comb += abnan.eq(a1.is_nan | b1.is_nan)
  66
  67         # if a is NaN or b is NaN return NaN
  68         with m.If(abnan):
  69             m.d.comb += self.o.out_do_z.eq(1)
  70             m.d.comb += self.o.z.nan(1)
  71
  72         # if a is inf return inf (or NaN)
  73         with m.Elif(a1.is_inf):
  74             m.d.comb += self.o.out_do_z.eq(1)
  75             m.d.comb += self.o.z.inf(sabx)
  76             # b is zero return NaN
  77             with m.If(b1.is_zero):
  78                 m.d.comb += self.o.z.nan(1)
  79
  80         # if b is inf return inf (or NaN)
  81         with m.Elif(b1.is_inf):
  82             m.d.comb += self.o.out_do_z.eq(1)
  83             m.d.comb += self.o.z.inf(sabx)
  84             # a is zero return NaN
  85             with m.If(a1.is_zero):
  86                 m.d.comb += self.o.z.nan(1)
  87
  88         # if a is zero or b zero return signed-a/b
  89         with m.Elif(obz):
  90             m.d.comb += self.o.out_do_z.eq(1)
  91             m.d.comb += self.o.z.zero(sabx)
  92
  93         # Denormalised Number checks next, so pass a/b data through
  94         with m.Else():
  95             m.d.comb += self.o.out_do_z.eq(0)
  96
  97         m.d.comb += self.o.oz.eq(self.o.z.v)
  98         m.d.comb += self.o.mid.eq(self.i.mid)
  99
 100         return m
 101
 102
 103 class FPMulSpecialCases(FPState):
 104     """ special cases: NaNs, infs, zeros, denormalised
 105         NOTE: some of these are unique to add.  see "Special Operations"
 106         https://steve.hollasch.net/cgindex/coding/ieeefloat.html
 107     """
 108
 109     def __init__(self, width, id_wid):
 110         FPState.__init__(self, "special_cases")
 111         self.mod = FPMulSpecialCasesMod(width)
 112         self.out_z = self.mod.ospec()
 113         self.out_do_z = Signal(reset_less=True)
 114
 115     def setup(self, m, i):
 116         """ links module to inputs and outputs
 117         """
 118         self.mod.setup(m, i, self.out_do_z)
 119         m.d.sync += self.out_z.v.eq(self.mod.out_z.v) # only take the output
 120         m.d.sync += self.out_z.mid.eq(self.mod.o.mid)  # (and mid)
 121
 122     def action(self, m):
 123         self.idsync(m)
 124         with m.If(self.out_do_z):
 125             m.next = "put_z"
 126         with m.Else():
 127             m.next = "denormalise"
 128
 129
 130 class FPMulSpecialCasesDeNorm(FPState, SimpleHandshake):
 131     """ special cases: NaNs, infs, zeros, denormalised
 132     """
 133
 134     def __init__(self, width, id_wid):
 135         FPState.__init__(self, "special_cases")
 136         self.width = width
 137         self.id_wid = id_wid
 138         SimpleHandshake.__init__(self, self) # pipe is its own stage
 139         self.out = self.ospec()
 140
 141     def ispec(self):
 142         return FPADDBaseData(self.width, self.id_wid) # SpecialCases ispec
 143
 144     def ospec(self):
 145         return FPSCData(self.width, self.id_wid, False) # DeNorm ospec
 146
 147     def setup(self, m, i):
 148         """ links module to inputs and outputs
 149         """
 150         smod = FPMulSpecialCasesMod(self.width, self.id_wid)
 151         dmod = FPAddDeNormMod(self.width, self.id_wid, False)
 152
 153         chain = StageChain([smod, dmod])
 154         chain.setup(m, i)
 155
 156         # only needed for break-out (early-out)
 157         # self.out_do_z = smod.o.out_do_z
 158
 159         self.o = dmod.o
 160
 161     def process(self, i):
 162         return self.o
 163
 164     def action(self, m):
 165         # for break-out (early-out)
 166         #with m.If(self.out_do_z):
 167         #    m.next = "put_z"
 168         #with m.Else():
 169             m.d.sync += self.out.eq(self.process(None))
 170             m.next = "align"
 171
 172