1 # IEEE Floating Point Adder (Single Precision)
2 # Copyright (C) Jonathan P Dawson 2013
5 from nmigen
import Module
, Signal
, Cat
, Mux
, Array
, Const
6 from nmigen
.lib
.coding
import PriorityEncoder
7 from nmigen
.cli
import main
, verilog
10 from fpbase
import FPNumIn
, FPNumOut
, FPOp
, Overflow
, FPBase
, FPNumBase
11 from fpbase
import MultiShiftRMerge
, Trigger
12 #from fpbase import FPNumShiftMultiRight
15 class FPState(FPBase
):
16 def __init__(self
, state_from
):
17 self
.state_from
= state_from
19 def set_inputs(self
, inputs
):
21 for k
,v
in inputs
.items():
24 def set_outputs(self
, outputs
):
25 self
.outputs
= outputs
26 for k
,v
in outputs
.items():
30 class FPGetSyncOpsMod
:
31 def __init__(self
, width
, num_ops
=2):
33 self
.num_ops
= num_ops
36 for i
in range(num_ops
):
37 inops
.append(Signal(width
, reset_less
=True))
38 outops
.append(Signal(width
, reset_less
=True))
41 self
.stb
= Signal(num_ops
)
43 self
.ready
= Signal(reset_less
=True)
44 self
.out_decode
= Signal(reset_less
=True)
46 def elaborate(self
, platform
):
48 m
.d
.comb
+= self
.ready
.eq(self
.stb
== Const(-1, (self
.num_ops
, False)))
49 m
.d
.comb
+= self
.out_decode
.eq(self
.ack
& self
.ready
)
50 with m
.If(self
.out_decode
):
51 for i
in range(self
.num_ops
):
53 self
.out_op
[i
].eq(self
.in_op
[i
]),
58 return self
.in_op
+ self
.out_op
+ [self
.stb
, self
.ack
]
62 def __init__(self
, width
, num_ops
):
63 Trigger
.__init
__(self
)
65 self
.num_ops
= num_ops
68 for i
in range(num_ops
):
69 res
.append(Signal(width
))
74 for i
in range(self
.num_ops
):
82 def __init__(self
, width
, num_ops
=2, num_rows
=4):
84 self
.num_ops
= num_ops
85 self
.num_rows
= num_rows
86 self
.mmax
= int(log(self
.num_rows
) / log(2))
88 self
.mid
= Signal(self
.mmax
, reset_less
=True) # multiplex id
89 for i
in range(num_rows
):
90 self
.rs
.append(FPGetSyncOpsMod(width
, num_ops
))
91 self
.rs
= Array(self
.rs
)
93 self
.out_op
= FPOps(width
, num_ops
)
95 def elaborate(self
, platform
):
98 pe
= PriorityEncoder(self
.num_rows
)
99 m
.submodules
.selector
= pe
100 m
.submodules
.out_op
= self
.out_op
101 m
.submodules
+= self
.rs
103 # connect priority encoder
105 for i
in range(self
.num_rows
):
106 in_ready
.append(self
.rs
[i
].ready
)
107 m
.d
.comb
+= pe
.i
.eq(Cat(*in_ready
))
109 active
= Signal(reset_less
=True)
110 out_en
= Signal(reset_less
=True)
111 m
.d
.comb
+= active
.eq(~pe
.n
) # encoder active
112 m
.d
.comb
+= out_en
.eq(active
& self
.out_op
.trigger
)
114 # encoder active: ack relevant input, record MID, pass output
117 m
.d
.sync
+= self
.mid
.eq(pe
.o
)
118 m
.d
.sync
+= rs
.ack
.eq(0)
119 m
.d
.sync
+= self
.out_op
.stb
.eq(0)
120 for j
in range(self
.num_ops
):
121 m
.d
.sync
+= self
.out_op
.v
[j
].eq(rs
.out_op
[j
])
123 m
.d
.sync
+= self
.out_op
.stb
.eq(1)
124 # acks all default to zero
125 for i
in range(self
.num_rows
):
126 m
.d
.sync
+= self
.rs
[i
].ack
.eq(1)
132 for i
in range(self
.num_rows
):
134 res
+= inop
.in_op
+ [inop
.stb
]
135 return self
.out_op
.ports() + res
+ [self
.mid
]
139 def __init__(self
, width
):
140 self
.in_op
= FPOp(width
)
141 self
.out_op
= Signal(width
)
142 self
.out_decode
= Signal(reset_less
=True)
144 def elaborate(self
, platform
):
146 m
.d
.comb
+= self
.out_decode
.eq((self
.in_op
.ack
) & (self
.in_op
.stb
))
147 m
.submodules
.get_op_in
= self
.in_op
148 #m.submodules.get_op_out = self.out_op
149 with m
.If(self
.out_decode
):
151 self
.out_op
.eq(self
.in_op
.v
),
156 class FPGetOp(FPState
):
160 def __init__(self
, in_state
, out_state
, in_op
, width
):
161 FPState
.__init
__(self
, in_state
)
162 self
.out_state
= out_state
163 self
.mod
= FPGetOpMod(width
)
165 self
.out_op
= Signal(width
)
166 self
.out_decode
= Signal(reset_less
=True)
168 def setup(self
, m
, in_op
):
169 """ links module to inputs and outputs
171 setattr(m
.submodules
, self
.state_from
, self
.mod
)
172 m
.d
.comb
+= self
.mod
.in_op
.eq(in_op
)
173 #m.d.comb += self.out_op.eq(self.mod.out_op)
174 m
.d
.comb
+= self
.out_decode
.eq(self
.mod
.out_decode
)
177 with m
.If(self
.out_decode
):
178 m
.next
= self
.out_state
180 self
.in_op
.ack
.eq(0),
181 self
.out_op
.eq(self
.mod
.out_op
)
184 m
.d
.sync
+= self
.in_op
.ack
.eq(1)
187 class FPGet2OpMod(Trigger
):
188 def __init__(self
, width
):
189 Trigger
.__init
__(self
)
190 self
.in_op1
= Signal(width
, reset_less
=True)
191 self
.in_op2
= Signal(width
, reset_less
=True)
192 self
.out_op1
= FPNumIn(None, width
)
193 self
.out_op2
= FPNumIn(None, width
)
195 def elaborate(self
, platform
):
196 m
= Trigger
.elaborate(self
, platform
)
197 #m.submodules.get_op_in = self.in_op
198 m
.submodules
.get_op1_out
= self
.out_op1
199 m
.submodules
.get_op2_out
= self
.out_op2
200 with m
.If(self
.trigger
):
202 self
.out_op1
.decode(self
.in_op1
),
203 self
.out_op2
.decode(self
.in_op2
),
208 class FPGet2Op(FPState
):
212 def __init__(self
, in_state
, out_state
, in_op1
, in_op2
, width
):
213 FPState
.__init
__(self
, in_state
)
214 self
.out_state
= out_state
215 self
.mod
= FPGet2OpMod(width
)
218 self
.out_op1
= FPNumIn(None, width
)
219 self
.out_op2
= FPNumIn(None, width
)
220 self
.in_stb
= Signal(reset_less
=True)
221 self
.out_ack
= Signal(reset_less
=True)
222 self
.out_decode
= Signal(reset_less
=True)
224 def setup(self
, m
, in_op1
, in_op2
, in_stb
, in_ack
):
225 """ links module to inputs and outputs
227 m
.submodules
.get_ops
= self
.mod
228 m
.d
.comb
+= self
.mod
.in_op1
.eq(in_op1
)
229 m
.d
.comb
+= self
.mod
.in_op2
.eq(in_op2
)
230 m
.d
.comb
+= self
.mod
.stb
.eq(in_stb
)
231 m
.d
.comb
+= self
.out_ack
.eq(self
.mod
.ack
)
232 m
.d
.comb
+= self
.out_decode
.eq(self
.mod
.trigger
)
233 m
.d
.comb
+= in_ack
.eq(self
.mod
.ack
)
236 with m
.If(self
.out_decode
):
237 m
.next
= self
.out_state
240 #self.out_op1.v.eq(self.mod.out_op1.v),
241 #self.out_op2.v.eq(self.mod.out_op2.v),
242 self
.out_op1
.eq(self
.mod
.out_op1
),
243 self
.out_op2
.eq(self
.mod
.out_op2
)
246 m
.d
.sync
+= self
.mod
.ack
.eq(1)
250 def __init__(self
, width
, m_extra
=True):
251 self
.a
= FPNumBase(width
, m_extra
)
252 self
.b
= FPNumBase(width
, m_extra
)
255 return [self
.a
.eq(i
.a
), self
.b
.eq(i
.b
)]
258 class FPAddSpecialCasesMod
:
259 """ special cases: NaNs, infs, zeros, denormalised
260 NOTE: some of these are unique to add. see "Special Operations"
261 https://steve.hollasch.net/cgindex/coding/ieeefloat.html
264 def __init__(self
, width
):
266 self
.i
= self
.ispec()
267 self
.out_z
= self
.ospec()
268 self
.out_do_z
= Signal(reset_less
=True)
271 return FPNumBase2Ops(self
.width
)
274 return FPNumOut(self
.width
, False)
276 def setup(self
, m
, in_a
, in_b
, out_do_z
):
277 """ links module to inputs and outputs
279 m
.submodules
.specialcases
= self
280 m
.d
.comb
+= self
.i
.a
.eq(in_a
)
281 m
.d
.comb
+= self
.i
.b
.eq(in_b
)
282 m
.d
.comb
+= out_do_z
.eq(self
.out_do_z
)
284 def elaborate(self
, platform
):
287 m
.submodules
.sc_in_a
= self
.i
.a
288 m
.submodules
.sc_in_b
= self
.i
.b
289 m
.submodules
.sc_out_z
= self
.out_z
292 m
.d
.comb
+= s_nomatch
.eq(self
.i
.a
.s
!= self
.i
.b
.s
)
295 m
.d
.comb
+= m_match
.eq(self
.i
.a
.m
== self
.i
.b
.m
)
297 # if a is NaN or b is NaN return NaN
298 with m
.If(self
.i
.a
.is_nan | self
.i
.b
.is_nan
):
299 m
.d
.comb
+= self
.out_do_z
.eq(1)
300 m
.d
.comb
+= self
.out_z
.nan(0)
302 # XXX WEIRDNESS for FP16 non-canonical NaN handling
305 ## if a is zero and b is NaN return -b
306 #with m.If(a.is_zero & (a.s==0) & b.is_nan):
307 # m.d.comb += self.out_do_z.eq(1)
308 # m.d.comb += z.create(b.s, b.e, Cat(b.m[3:-2], ~b.m[0]))
310 ## if b is zero and a is NaN return -a
311 #with m.Elif(b.is_zero & (b.s==0) & a.is_nan):
312 # m.d.comb += self.out_do_z.eq(1)
313 # m.d.comb += z.create(a.s, a.e, Cat(a.m[3:-2], ~a.m[0]))
315 ## if a is -zero and b is NaN return -b
316 #with m.Elif(a.is_zero & (a.s==1) & b.is_nan):
317 # m.d.comb += self.out_do_z.eq(1)
318 # m.d.comb += z.create(a.s & b.s, b.e, Cat(b.m[3:-2], 1))
320 ## if b is -zero and a is NaN return -a
321 #with m.Elif(b.is_zero & (b.s==1) & a.is_nan):
322 # m.d.comb += self.out_do_z.eq(1)
323 # m.d.comb += z.create(a.s & b.s, a.e, Cat(a.m[3:-2], 1))
325 # if a is inf return inf (or NaN)
326 with m
.Elif(self
.i
.a
.is_inf
):
327 m
.d
.comb
+= self
.out_do_z
.eq(1)
328 m
.d
.comb
+= self
.out_z
.inf(self
.i
.a
.s
)
329 # if a is inf and signs don't match return NaN
330 with m
.If(self
.i
.b
.exp_128
& s_nomatch
):
331 m
.d
.comb
+= self
.out_z
.nan(0)
333 # if b is inf return inf
334 with m
.Elif(self
.i
.b
.is_inf
):
335 m
.d
.comb
+= self
.out_do_z
.eq(1)
336 m
.d
.comb
+= self
.out_z
.inf(self
.i
.b
.s
)
338 # if a is zero and b zero return signed-a/b
339 with m
.Elif(self
.i
.a
.is_zero
& self
.i
.b
.is_zero
):
340 m
.d
.comb
+= self
.out_do_z
.eq(1)
341 m
.d
.comb
+= self
.out_z
.create(self
.i
.a
.s
& self
.i
.b
.s
,
345 # if a is zero return b
346 with m
.Elif(self
.i
.a
.is_zero
):
347 m
.d
.comb
+= self
.out_do_z
.eq(1)
348 m
.d
.comb
+= self
.out_z
.create(self
.i
.b
.s
, self
.i
.b
.e
,
351 # if b is zero return a
352 with m
.Elif(self
.i
.b
.is_zero
):
353 m
.d
.comb
+= self
.out_do_z
.eq(1)
354 m
.d
.comb
+= self
.out_z
.create(self
.i
.a
.s
, self
.i
.a
.e
,
357 # if a equal to -b return zero (+ve zero)
358 with m
.Elif(s_nomatch
& m_match
& (self
.i
.a
.e
== self
.i
.b
.e
)):
359 m
.d
.comb
+= self
.out_do_z
.eq(1)
360 m
.d
.comb
+= self
.out_z
.zero(0)
362 # Denormalised Number checks
364 m
.d
.comb
+= self
.out_do_z
.eq(0)
370 def __init__(self
, id_wid
):
373 self
.in_mid
= Signal(id_wid
, reset_less
=True)
374 self
.out_mid
= Signal(id_wid
, reset_less
=True)
380 if self
.id_wid
is not None:
381 m
.d
.sync
+= self
.out_mid
.eq(self
.in_mid
)
384 class FPAddSpecialCases(FPState
, FPID
):
385 """ special cases: NaNs, infs, zeros, denormalised
386 NOTE: some of these are unique to add. see "Special Operations"
387 https://steve.hollasch.net/cgindex/coding/ieeefloat.html
390 def __init__(self
, width
, id_wid
):
391 FPState
.__init
__(self
, "special_cases")
392 FPID
.__init
__(self
, id_wid
)
393 self
.mod
= FPAddSpecialCasesMod(width
)
394 self
.out_z
= self
.mod
.ospec()
395 self
.out_do_z
= Signal(reset_less
=True)
397 def setup(self
, m
, in_a
, in_b
, in_mid
):
398 """ links module to inputs and outputs
400 self
.mod
.setup(m
, in_a
, in_b
, self
.out_do_z
)
401 if self
.in_mid
is not None:
402 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
406 with m
.If(self
.out_do_z
):
407 m
.d
.sync
+= self
.out_z
.v
.eq(self
.mod
.out_z
.v
) # only take the output
410 m
.next
= "denormalise"
413 class FPAddSpecialCasesDeNorm(FPState
, FPID
):
414 """ special cases: NaNs, infs, zeros, denormalised
415 NOTE: some of these are unique to add. see "Special Operations"
416 https://steve.hollasch.net/cgindex/coding/ieeefloat.html
419 def __init__(self
, width
, id_wid
):
420 FPState
.__init
__(self
, "special_cases")
421 FPID
.__init
__(self
, id_wid
)
422 self
.smod
= FPAddSpecialCasesMod(width
)
423 self
.out_z
= self
.smod
.ospec()
424 self
.out_do_z
= Signal(reset_less
=True)
426 self
.dmod
= FPAddDeNormMod(width
)
427 self
.o
= self
.dmod
.ospec()
429 def setup(self
, m
, in_a
, in_b
, in_mid
):
430 """ links module to inputs and outputs
432 self
.smod
.setup(m
, in_a
, in_b
, self
.out_do_z
)
433 self
.dmod
.setup(m
, in_a
, in_b
)
434 if self
.in_mid
is not None:
435 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
439 with m
.If(self
.out_do_z
):
440 m
.d
.sync
+= self
.out_z
.v
.eq(self
.smod
.out_z
.v
) # only take output
444 m
.d
.sync
+= self
.o
.a
.eq(self
.dmod
.o
.a
)
445 m
.d
.sync
+= self
.o
.b
.eq(self
.dmod
.o
.b
)
448 class FPAddDeNormMod(FPState
):
450 def __init__(self
, width
):
452 self
.i
= self
.ispec()
453 self
.o
= self
.ospec()
456 return FPNumBase2Ops(self
.width
)
459 return FPNumBase2Ops(self
.width
)
461 def setup(self
, m
, in_a
, in_b
):
462 """ links module to inputs and outputs
464 m
.submodules
.denormalise
= self
465 m
.d
.comb
+= self
.i
.a
.eq(in_a
)
466 m
.d
.comb
+= self
.i
.b
.eq(in_b
)
468 def elaborate(self
, platform
):
470 m
.submodules
.denorm_in_a
= self
.i
.a
471 m
.submodules
.denorm_in_b
= self
.i
.b
472 m
.submodules
.denorm_out_a
= self
.o
.a
473 m
.submodules
.denorm_out_b
= self
.o
.b
474 # hmmm, don't like repeating identical code
475 m
.d
.comb
+= self
.o
.a
.eq(self
.i
.a
)
476 with m
.If(self
.i
.a
.exp_n127
):
477 m
.d
.comb
+= self
.o
.a
.e
.eq(self
.i
.a
.N126
) # limit a exponent
479 m
.d
.comb
+= self
.o
.a
.m
[-1].eq(1) # set top mantissa bit
481 m
.d
.comb
+= self
.o
.b
.eq(self
.i
.b
)
482 with m
.If(self
.i
.b
.exp_n127
):
483 m
.d
.comb
+= self
.o
.b
.e
.eq(self
.i
.b
.N126
) # limit a exponent
485 m
.d
.comb
+= self
.o
.b
.m
[-1].eq(1) # set top mantissa bit
490 class FPAddDeNorm(FPState
, FPID
):
492 def __init__(self
, width
, id_wid
):
493 FPState
.__init
__(self
, "denormalise")
494 FPID
.__init
__(self
, id_wid
)
495 self
.mod
= FPAddDeNormMod(width
)
496 self
.out_a
= FPNumBase(width
)
497 self
.out_b
= FPNumBase(width
)
499 def setup(self
, m
, in_a
, in_b
, in_mid
):
500 """ links module to inputs and outputs
502 self
.mod
.setup(m
, in_a
, in_b
)
503 if self
.in_mid
is not None:
504 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
508 # Denormalised Number checks
510 m
.d
.sync
+= self
.out_a
.eq(self
.mod
.out_a
)
511 m
.d
.sync
+= self
.out_b
.eq(self
.mod
.out_b
)
514 class FPAddAlignMultiMod(FPState
):
516 def __init__(self
, width
):
517 self
.in_a
= FPNumBase(width
)
518 self
.in_b
= FPNumBase(width
)
519 self
.out_a
= FPNumIn(None, width
)
520 self
.out_b
= FPNumIn(None, width
)
521 self
.exp_eq
= Signal(reset_less
=True)
523 def elaborate(self
, platform
):
524 # This one however (single-cycle) will do the shift
529 m
.submodules
.align_in_a
= self
.in_a
530 m
.submodules
.align_in_b
= self
.in_b
531 m
.submodules
.align_out_a
= self
.out_a
532 m
.submodules
.align_out_b
= self
.out_b
534 # NOTE: this does *not* do single-cycle multi-shifting,
535 # it *STAYS* in the align state until exponents match
537 # exponent of a greater than b: shift b down
538 m
.d
.comb
+= self
.exp_eq
.eq(0)
539 m
.d
.comb
+= self
.out_a
.eq(self
.in_a
)
540 m
.d
.comb
+= self
.out_b
.eq(self
.in_b
)
541 agtb
= Signal(reset_less
=True)
542 altb
= Signal(reset_less
=True)
543 m
.d
.comb
+= agtb
.eq(self
.in_a
.e
> self
.in_b
.e
)
544 m
.d
.comb
+= altb
.eq(self
.in_a
.e
< self
.in_b
.e
)
546 m
.d
.comb
+= self
.out_b
.shift_down(self
.in_b
)
547 # exponent of b greater than a: shift a down
549 m
.d
.comb
+= self
.out_a
.shift_down(self
.in_a
)
550 # exponents equal: move to next stage.
552 m
.d
.comb
+= self
.exp_eq
.eq(1)
556 class FPAddAlignMulti(FPState
, FPID
):
558 def __init__(self
, width
, id_wid
):
559 FPID
.__init
__(self
, id_wid
)
560 FPState
.__init
__(self
, "align")
561 self
.mod
= FPAddAlignMultiMod(width
)
562 self
.out_a
= FPNumIn(None, width
)
563 self
.out_b
= FPNumIn(None, width
)
564 self
.exp_eq
= Signal(reset_less
=True)
566 def setup(self
, m
, in_a
, in_b
, in_mid
):
567 """ links module to inputs and outputs
569 m
.submodules
.align
= self
.mod
570 m
.d
.comb
+= self
.mod
.in_a
.eq(in_a
)
571 m
.d
.comb
+= self
.mod
.in_b
.eq(in_b
)
572 #m.d.comb += self.out_a.eq(self.mod.out_a)
573 #m.d.comb += self.out_b.eq(self.mod.out_b)
574 m
.d
.comb
+= self
.exp_eq
.eq(self
.mod
.exp_eq
)
575 if self
.in_mid
is not None:
576 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
580 m
.d
.sync
+= self
.out_a
.eq(self
.mod
.out_a
)
581 m
.d
.sync
+= self
.out_b
.eq(self
.mod
.out_b
)
582 with m
.If(self
.exp_eq
):
588 def __init__(self
, width
):
589 self
.a
= FPNumIn(None, width
)
590 self
.b
= FPNumIn(None, width
)
593 return [self
.a
.eq(i
.a
), self
.b
.eq(i
.b
)]
596 class FPAddAlignSingleMod
:
598 def __init__(self
, width
):
600 self
.i
= self
.ispec()
601 self
.o
= self
.ospec()
604 return FPNumBase2Ops(self
.width
)
607 return FPNumIn2Ops(self
.width
)
609 def setup(self
, m
, in_a
, in_b
):
610 """ links module to inputs and outputs
612 m
.submodules
.align
= self
613 m
.d
.comb
+= self
.i
.a
.eq(in_a
)
614 m
.d
.comb
+= self
.i
.b
.eq(in_b
)
616 def elaborate(self
, platform
):
617 """ Aligns A against B or B against A, depending on which has the
618 greater exponent. This is done in a *single* cycle using
619 variable-width bit-shift
621 the shifter used here is quite expensive in terms of gates.
622 Mux A or B in (and out) into temporaries, as only one of them
623 needs to be aligned against the other
627 m
.submodules
.align_in_a
= self
.i
.a
628 m
.submodules
.align_in_b
= self
.i
.b
629 m
.submodules
.align_out_a
= self
.o
.a
630 m
.submodules
.align_out_b
= self
.o
.b
632 # temporary (muxed) input and output to be shifted
633 t_inp
= FPNumBase(self
.width
)
634 t_out
= FPNumIn(None, self
.width
)
635 espec
= (len(self
.i
.a
.e
), True)
636 msr
= MultiShiftRMerge(self
.i
.a
.m_width
, espec
)
637 m
.submodules
.align_t_in
= t_inp
638 m
.submodules
.align_t_out
= t_out
639 m
.submodules
.multishift_r
= msr
641 ediff
= Signal(espec
, reset_less
=True)
642 ediffr
= Signal(espec
, reset_less
=True)
643 tdiff
= Signal(espec
, reset_less
=True)
644 elz
= Signal(reset_less
=True)
645 egz
= Signal(reset_less
=True)
647 # connect multi-shifter to t_inp/out mantissa (and tdiff)
648 m
.d
.comb
+= msr
.inp
.eq(t_inp
.m
)
649 m
.d
.comb
+= msr
.diff
.eq(tdiff
)
650 m
.d
.comb
+= t_out
.m
.eq(msr
.m
)
651 m
.d
.comb
+= t_out
.e
.eq(t_inp
.e
+ tdiff
)
652 m
.d
.comb
+= t_out
.s
.eq(t_inp
.s
)
654 m
.d
.comb
+= ediff
.eq(self
.i
.a
.e
- self
.i
.b
.e
)
655 m
.d
.comb
+= ediffr
.eq(self
.i
.b
.e
- self
.i
.a
.e
)
656 m
.d
.comb
+= elz
.eq(self
.i
.a
.e
< self
.i
.b
.e
)
657 m
.d
.comb
+= egz
.eq(self
.i
.a
.e
> self
.i
.b
.e
)
659 # default: A-exp == B-exp, A and B untouched (fall through)
660 m
.d
.comb
+= self
.o
.a
.eq(self
.i
.a
)
661 m
.d
.comb
+= self
.o
.b
.eq(self
.i
.b
)
662 # only one shifter (muxed)
663 #m.d.comb += t_out.shift_down_multi(tdiff, t_inp)
664 # exponent of a greater than b: shift b down
666 m
.d
.comb
+= [t_inp
.eq(self
.i
.b
),
669 self
.o
.b
.s
.eq(self
.i
.b
.s
), # whoops forgot sign
671 # exponent of b greater than a: shift a down
673 m
.d
.comb
+= [t_inp
.eq(self
.i
.a
),
676 self
.o
.a
.s
.eq(self
.i
.a
.s
), # whoops forgot sign
681 class FPAddAlignSingle(FPState
, FPID
):
683 def __init__(self
, width
, id_wid
):
684 FPState
.__init
__(self
, "align")
685 FPID
.__init
__(self
, id_wid
)
686 self
.mod
= FPAddAlignSingleMod(width
)
687 self
.out_a
= FPNumIn(None, width
)
688 self
.out_b
= FPNumIn(None, width
)
690 def setup(self
, m
, in_a
, in_b
, in_mid
):
691 """ links module to inputs and outputs
693 self
.mod
.setup(m
, in_a
, in_b
)
694 if self
.in_mid
is not None:
695 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
699 # NOTE: could be done as comb
700 m
.d
.sync
+= self
.out_a
.eq(self
.mod
.out_a
)
701 m
.d
.sync
+= self
.out_b
.eq(self
.mod
.out_b
)
705 class FPAddAlignSingleAdd(FPState
, FPID
):
707 def __init__(self
, width
, id_wid
):
708 FPState
.__init
__(self
, "align")
709 FPID
.__init
__(self
, id_wid
)
710 self
.mod
= FPAddAlignSingleMod(width
)
711 self
.o
= self
.mod
.ospec()
713 self
.a0mod
= FPAddStage0Mod(width
)
714 self
.a0o
= self
.a0mod
.ospec()
716 self
.a1mod
= FPAddStage1Mod(width
)
717 self
.a1o
= self
.a1mod
.ospec()
719 def setup(self
, m
, in_a
, in_b
, in_mid
):
720 """ links module to inputs and outputs
722 self
.mod
.setup(m
, in_a
, in_b
)
723 m
.d
.comb
+= self
.o
.eq(self
.mod
.o
)
725 self
.a0mod
.setup(m
, self
.o
.a
, self
.o
.b
)
726 m
.d
.comb
+= self
.a0o
.eq(self
.a0mod
.o
)
728 self
.a1mod
.setup(m
, self
.a0o
.tot
, self
.a0o
.z
)
730 if self
.in_mid
is not None:
731 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
735 m
.d
.sync
+= self
.a1o
.eq(self
.a1mod
.o
)
736 m
.next
= "normalise_1"
739 class FPAddStage0Data
:
741 def __init__(self
, width
):
742 self
.z
= FPNumBase(width
, False)
743 self
.tot
= Signal(self
.z
.m_width
+ 4, reset_less
=True)
746 return [self
.z
.eq(i
.z
), self
.tot
.eq(i
.tot
)]
749 class FPAddStage0Mod
:
751 def __init__(self
, width
):
753 self
.i
= self
.ispec()
754 self
.o
= self
.ospec()
757 return FPNumBase2Ops(self
.width
)
760 return FPAddStage0Data(self
.width
)
762 def setup(self
, m
, in_a
, in_b
):
763 """ links module to inputs and outputs
765 m
.submodules
.add0
= self
766 m
.d
.comb
+= self
.i
.a
.eq(in_a
)
767 m
.d
.comb
+= self
.i
.b
.eq(in_b
)
769 def elaborate(self
, platform
):
771 m
.submodules
.add0_in_a
= self
.i
.a
772 m
.submodules
.add0_in_b
= self
.i
.b
773 m
.submodules
.add0_out_z
= self
.o
.z
775 m
.d
.comb
+= self
.o
.z
.e
.eq(self
.i
.a
.e
)
777 # store intermediate tests (and zero-extended mantissas)
778 seq
= Signal(reset_less
=True)
779 mge
= Signal(reset_less
=True)
780 am0
= Signal(len(self
.i
.a
.m
)+1, reset_less
=True)
781 bm0
= Signal(len(self
.i
.b
.m
)+1, reset_less
=True)
782 m
.d
.comb
+= [seq
.eq(self
.i
.a
.s
== self
.i
.b
.s
),
783 mge
.eq(self
.i
.a
.m
>= self
.i
.b
.m
),
784 am0
.eq(Cat(self
.i
.a
.m
, 0)),
785 bm0
.eq(Cat(self
.i
.b
.m
, 0))
787 # same-sign (both negative or both positive) add mantissas
790 self
.o
.tot
.eq(am0
+ bm0
),
791 self
.o
.z
.s
.eq(self
.i
.a
.s
)
793 # a mantissa greater than b, use a
796 self
.o
.tot
.eq(am0
- bm0
),
797 self
.o
.z
.s
.eq(self
.i
.a
.s
)
799 # b mantissa greater than a, use b
802 self
.o
.tot
.eq(bm0
- am0
),
803 self
.o
.z
.s
.eq(self
.i
.b
.s
)
808 class FPAddStage0(FPState
, FPID
):
809 """ First stage of add. covers same-sign (add) and subtract
810 special-casing when mantissas are greater or equal, to
811 give greatest accuracy.
814 def __init__(self
, width
, id_wid
):
815 FPState
.__init
__(self
, "add_0")
816 FPID
.__init
__(self
, id_wid
)
817 self
.mod
= FPAddStage0Mod(width
)
818 self
.o
= self
.mod
.ospec()
820 def setup(self
, m
, in_a
, in_b
, in_mid
):
821 """ links module to inputs and outputs
823 self
.mod
.setup(m
, in_a
, in_b
)
824 if self
.in_mid
is not None:
825 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
829 # NOTE: these could be done as combinatorial (merge add0+add1)
830 m
.d
.sync
+= self
.o
.eq(self
.mod
.o
)
834 class FPAddStage1Data
:
836 def __init__(self
, width
):
837 self
.z
= FPNumBase(width
, False)
841 return [self
.z
.eq(i
.z
), self
.of
.eq(i
.of
)]
845 class FPAddStage1Mod(FPState
):
846 """ Second stage of add: preparation for normalisation.
847 detects when tot sum is too big (tot[27] is kinda a carry bit)
850 def __init__(self
, width
):
852 self
.i
= self
.ispec()
853 self
.o
= self
.ospec()
856 return FPAddStage0Data(self
.width
)
859 return FPAddStage1Data(self
.width
)
861 def setup(self
, m
, in_tot
, in_z
):
862 """ links module to inputs and outputs
864 m
.submodules
.add1
= self
865 m
.submodules
.add1_out_overflow
= self
.o
.of
867 m
.d
.comb
+= self
.i
.z
.eq(in_z
)
868 m
.d
.comb
+= self
.i
.tot
.eq(in_tot
)
870 def elaborate(self
, platform
):
872 #m.submodules.norm1_in_overflow = self.in_of
873 #m.submodules.norm1_out_overflow = self.out_of
874 #m.submodules.norm1_in_z = self.in_z
875 #m.submodules.norm1_out_z = self.out_z
876 m
.d
.comb
+= self
.o
.z
.eq(self
.i
.z
)
877 # tot[-1] (MSB) gets set when the sum overflows. shift result down
878 with m
.If(self
.i
.tot
[-1]):
880 self
.o
.z
.m
.eq(self
.i
.tot
[4:]),
881 self
.o
.of
.m0
.eq(self
.i
.tot
[4]),
882 self
.o
.of
.guard
.eq(self
.i
.tot
[3]),
883 self
.o
.of
.round_bit
.eq(self
.i
.tot
[2]),
884 self
.o
.of
.sticky
.eq(self
.i
.tot
[1] | self
.i
.tot
[0]),
885 self
.o
.z
.e
.eq(self
.i
.z
.e
+ 1)
887 # tot[-1] (MSB) zero case
890 self
.o
.z
.m
.eq(self
.i
.tot
[3:]),
891 self
.o
.of
.m0
.eq(self
.i
.tot
[3]),
892 self
.o
.of
.guard
.eq(self
.i
.tot
[2]),
893 self
.o
.of
.round_bit
.eq(self
.i
.tot
[1]),
894 self
.o
.of
.sticky
.eq(self
.i
.tot
[0])
899 class FPAddStage1(FPState
, FPID
):
901 def __init__(self
, width
, id_wid
):
902 FPState
.__init
__(self
, "add_1")
903 FPID
.__init
__(self
, id_wid
)
904 self
.mod
= FPAddStage1Mod(width
)
905 self
.out_z
= FPNumBase(width
, False)
906 self
.out_of
= Overflow()
907 self
.norm_stb
= Signal()
909 def setup(self
, m
, in_tot
, in_z
, in_mid
):
910 """ links module to inputs and outputs
912 self
.mod
.setup(m
, in_tot
, in_z
)
914 m
.d
.sync
+= self
.norm_stb
.eq(0) # sets to zero when not in add1 state
916 if self
.in_mid
is not None:
917 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
921 m
.d
.sync
+= self
.out_of
.eq(self
.mod
.out_of
)
922 m
.d
.sync
+= self
.out_z
.eq(self
.mod
.out_z
)
923 m
.d
.sync
+= self
.norm_stb
.eq(1)
924 m
.next
= "normalise_1"
927 class FPNormaliseModSingle
:
929 def __init__(self
, width
):
931 self
.in_z
= self
.ispec()
932 self
.out_z
= self
.ospec()
935 return FPNumBase(self
.width
, False)
938 return FPNumBase(self
.width
, False)
940 def setup(self
, m
, in_z
, out_z
):
941 """ links module to inputs and outputs
943 m
.submodules
.normalise
= self
944 m
.d
.comb
+= self
.in_z
.eq(in_z
)
945 m
.d
.comb
+= out_z
.eq(self
.out_z
)
947 def elaborate(self
, platform
):
950 mwid
= self
.out_z
.m_width
+2
951 pe
= PriorityEncoder(mwid
)
952 m
.submodules
.norm_pe
= pe
954 m
.submodules
.norm1_out_z
= self
.out_z
955 m
.submodules
.norm1_in_z
= self
.in_z
957 in_z
= FPNumBase(self
.width
, False)
959 m
.submodules
.norm1_insel_z
= in_z
960 m
.submodules
.norm1_insel_overflow
= in_of
962 espec
= (len(in_z
.e
), True)
963 ediff_n126
= Signal(espec
, reset_less
=True)
964 msr
= MultiShiftRMerge(mwid
, espec
)
965 m
.submodules
.multishift_r
= msr
967 m
.d
.comb
+= in_z
.eq(self
.in_z
)
968 m
.d
.comb
+= in_of
.eq(self
.in_of
)
969 # initialise out from in (overridden below)
970 m
.d
.comb
+= self
.out_z
.eq(in_z
)
971 m
.d
.comb
+= self
.out_of
.eq(in_of
)
972 # normalisation decrease condition
973 decrease
= Signal(reset_less
=True)
974 m
.d
.comb
+= decrease
.eq(in_z
.m_msbzero
)
977 # *sigh* not entirely obvious: count leading zeros (clz)
978 # with a PriorityEncoder: to find from the MSB
979 # we reverse the order of the bits.
980 temp_m
= Signal(mwid
, reset_less
=True)
981 temp_s
= Signal(mwid
+1, reset_less
=True)
982 clz
= Signal((len(in_z
.e
), True), reset_less
=True)
984 # cat round and guard bits back into the mantissa
985 temp_m
.eq(Cat(in_of
.round_bit
, in_of
.guard
, in_z
.m
)),
986 pe
.i
.eq(temp_m
[::-1]), # inverted
987 clz
.eq(pe
.o
), # count zeros from MSB down
988 temp_s
.eq(temp_m
<< clz
), # shift mantissa UP
989 self
.out_z
.e
.eq(in_z
.e
- clz
), # DECREASE exponent
990 self
.out_z
.m
.eq(temp_s
[2:]), # exclude bits 0&1
997 def __init__(self
, width
):
999 self
.roundz
= Signal(reset_less
=True)
1000 self
.z
= FPNumBase(width
, False)
1003 return [self
.z
.eq(i
.z
), self
.roundz
.eq(i
.roundz
)]
1006 class FPNorm1ModSingle
:
1008 def __init__(self
, width
):
1010 self
.i
= self
.ispec()
1011 self
.o
= self
.ospec()
1014 return FPAddStage1Data(self
.width
)
1017 return FPNorm1Data(self
.width
)
1019 def setup(self
, m
, in_z
, in_of
, out_z
):
1020 """ links module to inputs and outputs
1022 m
.submodules
.normalise_1
= self
1024 m
.d
.comb
+= self
.i
.z
.eq(in_z
)
1025 m
.d
.comb
+= self
.i
.of
.eq(in_of
)
1027 m
.d
.comb
+= out_z
.eq(self
.o
.z
)
1029 def elaborate(self
, platform
):
1032 mwid
= self
.o
.z
.m_width
+2
1033 pe
= PriorityEncoder(mwid
)
1034 m
.submodules
.norm_pe
= pe
1037 m
.d
.comb
+= self
.o
.roundz
.eq(of
.roundz
)
1039 m
.submodules
.norm1_out_z
= self
.o
.z
1040 m
.submodules
.norm1_out_overflow
= of
1041 m
.submodules
.norm1_in_z
= self
.i
.z
1042 m
.submodules
.norm1_in_overflow
= self
.i
.of
1045 m
.submodules
.norm1_insel_z
= i
.z
1046 m
.submodules
.norm1_insel_overflow
= i
.of
1048 espec
= (len(i
.z
.e
), True)
1049 ediff_n126
= Signal(espec
, reset_less
=True)
1050 msr
= MultiShiftRMerge(mwid
, espec
)
1051 m
.submodules
.multishift_r
= msr
1053 m
.d
.comb
+= i
.eq(self
.i
)
1054 # initialise out from in (overridden below)
1055 m
.d
.comb
+= self
.o
.z
.eq(i
.z
)
1056 m
.d
.comb
+= of
.eq(i
.of
)
1057 # normalisation increase/decrease conditions
1058 decrease
= Signal(reset_less
=True)
1059 increase
= Signal(reset_less
=True)
1060 m
.d
.comb
+= decrease
.eq(i
.z
.m_msbzero
& i
.z
.exp_gt_n126
)
1061 m
.d
.comb
+= increase
.eq(i
.z
.exp_lt_n126
)
1063 with m
.If(decrease
):
1064 # *sigh* not entirely obvious: count leading zeros (clz)
1065 # with a PriorityEncoder: to find from the MSB
1066 # we reverse the order of the bits.
1067 temp_m
= Signal(mwid
, reset_less
=True)
1068 temp_s
= Signal(mwid
+1, reset_less
=True)
1069 clz
= Signal((len(i
.z
.e
), True), reset_less
=True)
1070 # make sure that the amount to decrease by does NOT
1071 # go below the minimum non-INF/NaN exponent
1072 limclz
= Mux(i
.z
.exp_sub_n126
> pe
.o
, pe
.o
,
1075 # cat round and guard bits back into the mantissa
1076 temp_m
.eq(Cat(i
.of
.round_bit
, i
.of
.guard
, i
.z
.m
)),
1077 pe
.i
.eq(temp_m
[::-1]), # inverted
1078 clz
.eq(limclz
), # count zeros from MSB down
1079 temp_s
.eq(temp_m
<< clz
), # shift mantissa UP
1080 self
.o
.z
.e
.eq(i
.z
.e
- clz
), # DECREASE exponent
1081 self
.o
.z
.m
.eq(temp_s
[2:]), # exclude bits 0&1
1082 of
.m0
.eq(temp_s
[2]), # copy of mantissa[0]
1083 # overflow in bits 0..1: got shifted too (leave sticky)
1084 of
.guard
.eq(temp_s
[1]), # guard
1085 of
.round_bit
.eq(temp_s
[0]), # round
1088 with m
.Elif(increase
):
1089 temp_m
= Signal(mwid
+1, reset_less
=True)
1091 temp_m
.eq(Cat(i
.of
.sticky
, i
.of
.round_bit
, i
.of
.guard
,
1093 ediff_n126
.eq(i
.z
.N126
- i
.z
.e
),
1094 # connect multi-shifter to inp/out mantissa (and ediff)
1096 msr
.diff
.eq(ediff_n126
),
1097 self
.o
.z
.m
.eq(msr
.m
[3:]),
1098 of
.m0
.eq(temp_s
[3]), # copy of mantissa[0]
1099 # overflow in bits 0..1: got shifted too (leave sticky)
1100 of
.guard
.eq(temp_s
[2]), # guard
1101 of
.round_bit
.eq(temp_s
[1]), # round
1102 of
.sticky
.eq(temp_s
[0]), # sticky
1103 self
.o
.z
.e
.eq(i
.z
.e
+ ediff_n126
),
1109 class FPNorm1ModMulti
:
1111 def __init__(self
, width
, single_cycle
=True):
1113 self
.in_select
= Signal(reset_less
=True)
1114 self
.in_z
= FPNumBase(width
, False)
1115 self
.in_of
= Overflow()
1116 self
.temp_z
= FPNumBase(width
, False)
1117 self
.temp_of
= Overflow()
1118 self
.out_z
= FPNumBase(width
, False)
1119 self
.out_of
= Overflow()
1121 def elaborate(self
, platform
):
1124 m
.submodules
.norm1_out_z
= self
.out_z
1125 m
.submodules
.norm1_out_overflow
= self
.out_of
1126 m
.submodules
.norm1_temp_z
= self
.temp_z
1127 m
.submodules
.norm1_temp_of
= self
.temp_of
1128 m
.submodules
.norm1_in_z
= self
.in_z
1129 m
.submodules
.norm1_in_overflow
= self
.in_of
1131 in_z
= FPNumBase(self
.width
, False)
1133 m
.submodules
.norm1_insel_z
= in_z
1134 m
.submodules
.norm1_insel_overflow
= in_of
1136 # select which of temp or in z/of to use
1137 with m
.If(self
.in_select
):
1138 m
.d
.comb
+= in_z
.eq(self
.in_z
)
1139 m
.d
.comb
+= in_of
.eq(self
.in_of
)
1141 m
.d
.comb
+= in_z
.eq(self
.temp_z
)
1142 m
.d
.comb
+= in_of
.eq(self
.temp_of
)
1143 # initialise out from in (overridden below)
1144 m
.d
.comb
+= self
.out_z
.eq(in_z
)
1145 m
.d
.comb
+= self
.out_of
.eq(in_of
)
1146 # normalisation increase/decrease conditions
1147 decrease
= Signal(reset_less
=True)
1148 increase
= Signal(reset_less
=True)
1149 m
.d
.comb
+= decrease
.eq(in_z
.m_msbzero
& in_z
.exp_gt_n126
)
1150 m
.d
.comb
+= increase
.eq(in_z
.exp_lt_n126
)
1151 m
.d
.comb
+= self
.out_norm
.eq(decrease | increase
) # loop-end
1153 with m
.If(decrease
):
1155 self
.out_z
.e
.eq(in_z
.e
- 1), # DECREASE exponent
1156 self
.out_z
.m
.eq(in_z
.m
<< 1), # shift mantissa UP
1157 self
.out_z
.m
[0].eq(in_of
.guard
), # steal guard (was tot[2])
1158 self
.out_of
.guard
.eq(in_of
.round_bit
), # round (was tot[1])
1159 self
.out_of
.round_bit
.eq(0), # reset round bit
1160 self
.out_of
.m0
.eq(in_of
.guard
),
1163 with m
.Elif(increase
):
1165 self
.out_z
.e
.eq(in_z
.e
+ 1), # INCREASE exponent
1166 self
.out_z
.m
.eq(in_z
.m
>> 1), # shift mantissa DOWN
1167 self
.out_of
.guard
.eq(in_z
.m
[0]),
1168 self
.out_of
.m0
.eq(in_z
.m
[1]),
1169 self
.out_of
.round_bit
.eq(in_of
.guard
),
1170 self
.out_of
.sticky
.eq(in_of
.sticky | in_of
.round_bit
)
1176 class FPNorm1Single(FPState
, FPID
):
1178 def __init__(self
, width
, id_wid
, single_cycle
=True):
1179 FPID
.__init
__(self
, id_wid
)
1180 FPState
.__init
__(self
, "normalise_1")
1181 self
.mod
= FPNorm1ModSingle(width
)
1182 self
.out_z
= FPNumBase(width
, False)
1183 self
.out_roundz
= Signal(reset_less
=True)
1185 def setup(self
, m
, in_z
, in_of
, in_mid
):
1186 """ links module to inputs and outputs
1188 self
.mod
.setup(m
, in_z
, in_of
, self
.out_z
)
1190 if self
.in_mid
is not None:
1191 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1193 def action(self
, m
):
1195 m
.d
.sync
+= self
.out_roundz
.eq(self
.mod
.out_of
.roundz
)
1199 class FPNorm1Multi(FPState
, FPID
):
1201 def __init__(self
, width
, id_wid
):
1202 FPID
.__init
__(self
, id_wid
)
1203 FPState
.__init
__(self
, "normalise_1")
1204 self
.mod
= FPNorm1ModMulti(width
)
1205 self
.stb
= Signal(reset_less
=True)
1206 self
.ack
= Signal(reset
=0, reset_less
=True)
1207 self
.out_norm
= Signal(reset_less
=True)
1208 self
.in_accept
= Signal(reset_less
=True)
1209 self
.temp_z
= FPNumBase(width
)
1210 self
.temp_of
= Overflow()
1211 self
.out_z
= FPNumBase(width
)
1212 self
.out_roundz
= Signal(reset_less
=True)
1214 def setup(self
, m
, in_z
, in_of
, norm_stb
, in_mid
):
1215 """ links module to inputs and outputs
1217 self
.mod
.setup(m
, in_z
, in_of
, norm_stb
,
1218 self
.in_accept
, self
.temp_z
, self
.temp_of
,
1219 self
.out_z
, self
.out_norm
)
1221 m
.d
.comb
+= self
.stb
.eq(norm_stb
)
1222 m
.d
.sync
+= self
.ack
.eq(0) # sets to zero when not in normalise_1 state
1224 if self
.in_mid
is not None:
1225 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1227 def action(self
, m
):
1229 m
.d
.comb
+= self
.in_accept
.eq((~self
.ack
) & (self
.stb
))
1230 m
.d
.sync
+= self
.temp_of
.eq(self
.mod
.out_of
)
1231 m
.d
.sync
+= self
.temp_z
.eq(self
.out_z
)
1232 with m
.If(self
.out_norm
):
1233 with m
.If(self
.in_accept
):
1238 m
.d
.sync
+= self
.ack
.eq(0)
1240 # normalisation not required (or done).
1242 m
.d
.sync
+= self
.ack
.eq(1)
1243 m
.d
.sync
+= self
.out_roundz
.eq(self
.mod
.out_of
.roundz
)
1246 class FPNormToPack(FPState
, FPID
):
1248 def __init__(self
, width
, id_wid
):
1249 FPID
.__init
__(self
, id_wid
)
1250 FPState
.__init
__(self
, "normalise_1")
1253 def setup(self
, m
, in_z
, in_of
, in_mid
):
1254 """ links module to inputs and outputs
1257 # Normalisation (chained to input in_z+in_of)
1258 nmod
= FPNorm1ModSingle(self
.width
)
1259 n_out_z
= FPNumBase(self
.width
)
1260 n_out_roundz
= Signal(reset_less
=True)
1261 nmod
.setup(m
, in_z
, in_of
, n_out_z
)
1263 # Rounding (chained to normalisation)
1264 rmod
= FPRoundMod(self
.width
)
1265 r_out_z
= rmod
.ospec()
1266 rmod
.setup(m
, n_out_z
, n_out_roundz
)
1267 m
.d
.comb
+= n_out_roundz
.eq(nmod
.o
.roundz
)
1268 m
.d
.comb
+= r_out_z
.eq(rmod
.out_z
)
1270 # Corrections (chained to rounding)
1271 cmod
= FPCorrectionsMod(self
.width
)
1272 c_out_z
= cmod
.ospec()
1273 cmod
.setup(m
, r_out_z
)
1274 m
.d
.comb
+= c_out_z
.eq(cmod
.out_z
)
1276 # Pack (chained to corrections)
1277 self
.pmod
= FPPackMod(self
.width
)
1278 self
.out_z
= self
.pmod
.ospec()
1279 self
.pmod
.setup(m
, c_out_z
)
1282 if self
.in_mid
is not None:
1283 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1285 def action(self
, m
):
1286 self
.idsync(m
) # copies incoming ID to outgoing
1287 m
.d
.sync
+= self
.out_z
.v
.eq(self
.pmod
.out_z
.v
) # outputs packed result
1288 m
.next
= "pack_put_z"
1293 def __init__(self
, width
):
1295 self
.i
= self
.ispec()
1296 self
.out_z
= self
.ospec()
1299 return FPNorm1Data(self
.width
)
1302 return FPNumBase(self
.width
, False)
1304 def setup(self
, m
, in_z
, roundz
):
1305 m
.submodules
.roundz
= self
1307 m
.d
.comb
+= self
.i
.z
.eq(in_z
)
1308 m
.d
.comb
+= self
.i
.roundz
.eq(roundz
)
1310 def elaborate(self
, platform
):
1312 m
.d
.comb
+= self
.out_z
.eq(self
.i
.z
)
1313 with m
.If(self
.i
.roundz
):
1314 m
.d
.comb
+= self
.out_z
.m
.eq(self
.i
.z
.m
+ 1) # mantissa rounds up
1315 with m
.If(self
.i
.z
.m
== self
.i
.z
.m1s
): # all 1s
1316 m
.d
.comb
+= self
.out_z
.e
.eq(self
.i
.z
.e
+ 1) # exponent up
1320 class FPRound(FPState
, FPID
):
1322 def __init__(self
, width
, id_wid
):
1323 FPState
.__init
__(self
, "round")
1324 FPID
.__init
__(self
, id_wid
)
1325 self
.mod
= FPRoundMod(width
)
1326 self
.out_z
= self
.mod
.ospec()
1328 def setup(self
, m
, in_z
, roundz
, in_mid
):
1329 """ links module to inputs and outputs
1331 self
.mod
.setup(m
, in_z
, roundz
)
1333 if self
.in_mid
is not None:
1334 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1336 def action(self
, m
):
1338 m
.d
.sync
+= self
.out_z
.eq(self
.mod
.out_z
)
1339 m
.next
= "corrections"
1342 class FPCorrectionsMod
:
1344 def __init__(self
, width
):
1346 self
.in_z
= self
.ispec()
1347 self
.out_z
= self
.ospec()
1350 return FPNumOut(self
.width
, False)
1353 return FPNumOut(self
.width
, False)
1355 def setup(self
, m
, in_z
):
1356 """ links module to inputs and outputs
1358 m
.submodules
.corrections
= self
1359 m
.d
.comb
+= self
.in_z
.eq(in_z
)
1361 def elaborate(self
, platform
):
1363 m
.submodules
.corr_in_z
= self
.in_z
1364 m
.submodules
.corr_out_z
= self
.out_z
1365 m
.d
.comb
+= self
.out_z
.eq(self
.in_z
)
1366 with m
.If(self
.in_z
.is_denormalised
):
1367 m
.d
.comb
+= self
.out_z
.e
.eq(self
.in_z
.N127
)
1371 class FPCorrections(FPState
, FPID
):
1373 def __init__(self
, width
, id_wid
):
1374 FPState
.__init
__(self
, "corrections")
1375 FPID
.__init
__(self
, id_wid
)
1376 self
.mod
= FPCorrectionsMod(width
)
1377 self
.out_z
= self
.mod
.ospec()
1379 def setup(self
, m
, in_z
, in_mid
):
1380 """ links module to inputs and outputs
1382 self
.mod
.setup(m
, in_z
)
1383 if self
.in_mid
is not None:
1384 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1386 def action(self
, m
):
1388 m
.d
.sync
+= self
.out_z
.eq(self
.mod
.out_z
)
1394 def __init__(self
, width
):
1396 self
.in_z
= self
.ispec()
1397 self
.out_z
= self
.ospec()
1400 return FPNumOut(self
.width
, False)
1403 return FPNumOut(self
.width
, False)
1405 def setup(self
, m
, in_z
):
1406 """ links module to inputs and outputs
1408 m
.submodules
.pack
= self
1409 m
.d
.comb
+= self
.in_z
.eq(in_z
)
1411 def elaborate(self
, platform
):
1413 m
.submodules
.pack_in_z
= self
.in_z
1414 with m
.If(self
.in_z
.is_overflowed
):
1415 m
.d
.comb
+= self
.out_z
.inf(self
.in_z
.s
)
1417 m
.d
.comb
+= self
.out_z
.create(self
.in_z
.s
, self
.in_z
.e
, self
.in_z
.m
)
1421 class FPPack(FPState
, FPID
):
1423 def __init__(self
, width
, id_wid
):
1424 FPState
.__init
__(self
, "pack")
1425 FPID
.__init
__(self
, id_wid
)
1426 self
.mod
= FPPackMod(width
)
1427 self
.out_z
= self
.mod
.ospec()
1429 def setup(self
, m
, in_z
, in_mid
):
1430 """ links module to inputs and outputs
1432 self
.mod
.setup(m
, in_z
)
1433 if self
.in_mid
is not None:
1434 m
.d
.comb
+= self
.in_mid
.eq(in_mid
)
1436 def action(self
, m
):
1438 m
.d
.sync
+= self
.out_z
.v
.eq(self
.mod
.out_z
.v
)
1439 m
.next
= "pack_put_z"
1442 class FPPutZ(FPState
):
1444 def __init__(self
, state
, in_z
, out_z
, in_mid
, out_mid
, to_state
=None):
1445 FPState
.__init
__(self
, state
)
1446 if to_state
is None:
1447 to_state
= "get_ops"
1448 self
.to_state
= to_state
1451 self
.in_mid
= in_mid
1452 self
.out_mid
= out_mid
1454 def action(self
, m
):
1455 if self
.in_mid
is not None:
1456 m
.d
.sync
+= self
.out_mid
.eq(self
.in_mid
)
1458 self
.out_z
.v
.eq(self
.in_z
.v
)
1460 with m
.If(self
.out_z
.stb
& self
.out_z
.ack
):
1461 m
.d
.sync
+= self
.out_z
.stb
.eq(0)
1462 m
.next
= self
.to_state
1464 m
.d
.sync
+= self
.out_z
.stb
.eq(1)
1467 class FPPutZIdx(FPState
):
1469 def __init__(self
, state
, in_z
, out_zs
, in_mid
, to_state
=None):
1470 FPState
.__init
__(self
, state
)
1471 if to_state
is None:
1472 to_state
= "get_ops"
1473 self
.to_state
= to_state
1475 self
.out_zs
= out_zs
1476 self
.in_mid
= in_mid
1478 def action(self
, m
):
1479 outz_stb
= Signal(reset_less
=True)
1480 outz_ack
= Signal(reset_less
=True)
1481 m
.d
.comb
+= [outz_stb
.eq(self
.out_zs
[self
.in_mid
].stb
),
1482 outz_ack
.eq(self
.out_zs
[self
.in_mid
].ack
),
1485 self
.out_zs
[self
.in_mid
].v
.eq(self
.in_z
.v
)
1487 with m
.If(outz_stb
& outz_ack
):
1488 m
.d
.sync
+= self
.out_zs
[self
.in_mid
].stb
.eq(0)
1489 m
.next
= self
.to_state
1491 m
.d
.sync
+= self
.out_zs
[self
.in_mid
].stb
.eq(1)
1494 class FPADDBaseMod(FPID
):
1496 def __init__(self
, width
, id_wid
=None, single_cycle
=False, compact
=True):
1499 * width: bit-width of IEEE754. supported: 16, 32, 64
1500 * id_wid: an identifier that is sync-connected to the input
1501 * single_cycle: True indicates each stage to complete in 1 clock
1502 * compact: True indicates a reduced number of stages
1504 FPID
.__init
__(self
, id_wid
)
1506 self
.single_cycle
= single_cycle
1507 self
.compact
= compact
1509 self
.in_t
= Trigger()
1510 self
.in_a
= Signal(width
)
1511 self
.in_b
= Signal(width
)
1512 self
.out_z
= FPOp(width
)
1516 def add_state(self
, state
):
1517 self
.states
.append(state
)
1520 def get_fragment(self
, platform
=None):
1521 """ creates the HDL code-fragment for FPAdd
1524 m
.submodules
.out_z
= self
.out_z
1525 m
.submodules
.in_t
= self
.in_t
1527 self
.get_compact_fragment(m
, platform
)
1529 self
.get_longer_fragment(m
, platform
)
1531 with m
.FSM() as fsm
:
1533 for state
in self
.states
:
1534 with m
.State(state
.state_from
):
1539 def get_longer_fragment(self
, m
, platform
=None):
1541 get
= self
.add_state(FPGet2Op("get_ops", "special_cases",
1542 self
.in_a
, self
.in_b
, self
.width
))
1543 get
.setup(m
, self
.in_a
, self
.in_b
, self
.in_t
.stb
, self
.in_t
.ack
)
1547 sc
= self
.add_state(FPAddSpecialCases(self
.width
, self
.id_wid
))
1548 sc
.setup(m
, a
, b
, self
.in_mid
)
1550 dn
= self
.add_state(FPAddDeNorm(self
.width
, self
.id_wid
))
1551 dn
.setup(m
, a
, b
, sc
.in_mid
)
1553 if self
.single_cycle
:
1554 alm
= self
.add_state(FPAddAlignSingle(self
.width
, self
.id_wid
))
1555 alm
.setup(m
, dn
.out_a
, dn
.out_b
, dn
.in_mid
)
1557 alm
= self
.add_state(FPAddAlignMulti(self
.width
, self
.id_wid
))
1558 alm
.setup(m
, dn
.out_a
, dn
.out_b
, dn
.in_mid
)
1560 add0
= self
.add_state(FPAddStage0(self
.width
, self
.id_wid
))
1561 add0
.setup(m
, alm
.out_a
, alm
.out_b
, alm
.in_mid
)
1563 add1
= self
.add_state(FPAddStage1(self
.width
, self
.id_wid
))
1564 add1
.setup(m
, add0
.out_tot
, add0
.out_z
, add0
.in_mid
)
1566 if self
.single_cycle
:
1567 n1
= self
.add_state(FPNorm1Single(self
.width
, self
.id_wid
))
1568 n1
.setup(m
, add1
.out_z
, add1
.out_of
, add0
.in_mid
)
1570 n1
= self
.add_state(FPNorm1Multi(self
.width
, self
.id_wid
))
1571 n1
.setup(m
, add1
.out_z
, add1
.out_of
, add1
.norm_stb
, add0
.in_mid
)
1573 rn
= self
.add_state(FPRound(self
.width
, self
.id_wid
))
1574 rn
.setup(m
, n1
.out_z
, n1
.out_roundz
, n1
.in_mid
)
1576 cor
= self
.add_state(FPCorrections(self
.width
, self
.id_wid
))
1577 cor
.setup(m
, rn
.out_z
, rn
.in_mid
)
1579 pa
= self
.add_state(FPPack(self
.width
, self
.id_wid
))
1580 pa
.setup(m
, cor
.out_z
, rn
.in_mid
)
1582 ppz
= self
.add_state(FPPutZ("pack_put_z", pa
.out_z
, self
.out_z
,
1583 pa
.in_mid
, self
.out_mid
))
1585 pz
= self
.add_state(FPPutZ("put_z", sc
.out_z
, self
.out_z
,
1586 pa
.in_mid
, self
.out_mid
))
1588 def get_compact_fragment(self
, m
, platform
=None):
1590 get
= self
.add_state(FPGet2Op("get_ops", "special_cases",
1591 self
.in_a
, self
.in_b
, self
.width
))
1592 get
.setup(m
, self
.in_a
, self
.in_b
, self
.in_t
.stb
, self
.in_t
.ack
)
1596 sc
= self
.add_state(FPAddSpecialCasesDeNorm(self
.width
, self
.id_wid
))
1597 sc
.setup(m
, a
, b
, self
.in_mid
)
1599 alm
= self
.add_state(FPAddAlignSingleAdd(self
.width
, self
.id_wid
))
1600 alm
.setup(m
, sc
.o
.a
, sc
.o
.b
, sc
.in_mid
)
1602 n1
= self
.add_state(FPNormToPack(self
.width
, self
.id_wid
))
1603 n1
.setup(m
, alm
.a1o
.z
, alm
.a1o
.of
, alm
.in_mid
)
1605 ppz
= self
.add_state(FPPutZ("pack_put_z", n1
.out_z
, self
.out_z
,
1606 n1
.in_mid
, self
.out_mid
))
1608 pz
= self
.add_state(FPPutZ("put_z", sc
.out_z
, self
.out_z
,
1609 sc
.in_mid
, self
.out_mid
))
1612 class FPADDBase(FPState
, FPID
):
1614 def __init__(self
, width
, id_wid
=None, single_cycle
=False):
1617 * width: bit-width of IEEE754. supported: 16, 32, 64
1618 * id_wid: an identifier that is sync-connected to the input
1619 * single_cycle: True indicates each stage to complete in 1 clock
1621 FPID
.__init
__(self
, id_wid
)
1622 FPState
.__init
__(self
, "fpadd")
1624 self
.single_cycle
= single_cycle
1625 self
.mod
= FPADDBaseMod(width
, id_wid
, single_cycle
)
1627 self
.in_t
= Trigger()
1628 self
.in_a
= Signal(width
)
1629 self
.in_b
= Signal(width
)
1630 #self.out_z = FPOp(width)
1632 self
.z_done
= Signal(reset_less
=True) # connects to out_z Strobe
1633 self
.in_accept
= Signal(reset_less
=True)
1634 self
.add_stb
= Signal(reset_less
=True)
1635 self
.add_ack
= Signal(reset
=0, reset_less
=True)
1637 def setup(self
, m
, a
, b
, add_stb
, in_mid
, out_z
, out_mid
):
1639 self
.out_mid
= out_mid
1640 m
.d
.comb
+= [self
.in_a
.eq(a
),
1642 self
.mod
.in_a
.eq(self
.in_a
),
1643 self
.mod
.in_b
.eq(self
.in_b
),
1644 self
.in_mid
.eq(in_mid
),
1645 self
.mod
.in_mid
.eq(self
.in_mid
),
1646 self
.z_done
.eq(self
.mod
.out_z
.trigger
),
1647 #self.add_stb.eq(add_stb),
1648 self
.mod
.in_t
.stb
.eq(self
.in_t
.stb
),
1649 self
.in_t
.ack
.eq(self
.mod
.in_t
.ack
),
1650 self
.out_mid
.eq(self
.mod
.out_mid
),
1651 self
.out_z
.v
.eq(self
.mod
.out_z
.v
),
1652 self
.out_z
.stb
.eq(self
.mod
.out_z
.stb
),
1653 self
.mod
.out_z
.ack
.eq(self
.out_z
.ack
),
1656 m
.d
.sync
+= self
.add_stb
.eq(add_stb
)
1657 m
.d
.sync
+= self
.add_ack
.eq(0) # sets to zero when not in active state
1658 m
.d
.sync
+= self
.out_z
.ack
.eq(0) # likewise
1659 #m.d.sync += self.in_t.stb.eq(0)
1661 m
.submodules
.fpadd
= self
.mod
1663 def action(self
, m
):
1665 # in_accept is set on incoming strobe HIGH and ack LOW.
1666 m
.d
.comb
+= self
.in_accept
.eq((~self
.add_ack
) & (self
.add_stb
))
1668 #with m.If(self.in_t.ack):
1669 # m.d.sync += self.in_t.stb.eq(0)
1670 with m
.If(~self
.z_done
):
1671 # not done: test for accepting an incoming operand pair
1672 with m
.If(self
.in_accept
):
1674 self
.add_ack
.eq(1), # acknowledge receipt...
1675 self
.in_t
.stb
.eq(1), # initiate add
1678 m
.d
.sync
+= [self
.add_ack
.eq(0),
1679 self
.in_t
.stb
.eq(0),
1680 self
.out_z
.ack
.eq(1),
1683 # done: acknowledge, and write out id and value
1684 m
.d
.sync
+= [self
.add_ack
.eq(1),
1691 if self
.in_mid
is not None:
1692 m
.d
.sync
+= self
.out_mid
.eq(self
.mod
.out_mid
)
1695 self
.out_z
.v
.eq(self
.mod
.out_z
.v
)
1697 # move to output state on detecting z ack
1698 with m
.If(self
.out_z
.trigger
):
1699 m
.d
.sync
+= self
.out_z
.stb
.eq(0)
1702 m
.d
.sync
+= self
.out_z
.stb
.eq(1)
1705 def __init__(self
, width
, id_wid
):
1707 self
.id_wid
= id_wid
1709 for i
in range(rs_sz
):
1711 out_z
.name
= "out_z_%d" % i
1713 self
.res
= Array(res
)
1714 self
.in_z
= FPOp(width
)
1715 self
.in_mid
= Signal(self
.id_wid
, reset_less
=True)
1717 def setup(self
, m
, in_z
, in_mid
):
1718 m
.d
.comb
+= [self
.in_z
.eq(in_z
),
1719 self
.in_mid
.eq(in_mid
)]
1721 def get_fragment(self
, platform
=None):
1722 """ creates the HDL code-fragment for FPAdd
1725 m
.submodules
.res_in_z
= self
.in_z
1726 m
.submodules
+= self
.res
1738 """ FPADD: stages as follows:
1744 FPAddBase---> FPAddBaseMod
1746 PutZ GetOps->Specials->Align->Add1/2->Norm->Round/Pack->PutZ
1748 FPAddBase is tricky: it is both a stage and *has* stages.
1749 Connection to FPAddBaseMod therefore requires an in stb/ack
1750 and an out stb/ack. Just as with Add1-Norm1 interaction, FPGetOp
1751 needs to be the thing that raises the incoming stb.
1754 def __init__(self
, width
, id_wid
=None, single_cycle
=False, rs_sz
=2):
1757 * width: bit-width of IEEE754. supported: 16, 32, 64
1758 * id_wid: an identifier that is sync-connected to the input
1759 * single_cycle: True indicates each stage to complete in 1 clock
1762 self
.id_wid
= id_wid
1763 self
.single_cycle
= single_cycle
1765 #self.out_z = FPOp(width)
1766 self
.ids
= FPID(id_wid
)
1769 for i
in range(rs_sz
):
1772 in_a
.name
= "in_a_%d" % i
1773 in_b
.name
= "in_b_%d" % i
1774 rs
.append((in_a
, in_b
))
1778 for i
in range(rs_sz
):
1780 out_z
.name
= "out_z_%d" % i
1782 self
.res
= Array(res
)
1786 def add_state(self
, state
):
1787 self
.states
.append(state
)
1790 def get_fragment(self
, platform
=None):
1791 """ creates the HDL code-fragment for FPAdd
1794 m
.submodules
+= self
.rs
1796 in_a
= self
.rs
[0][0]
1797 in_b
= self
.rs
[0][1]
1799 out_z
= FPOp(self
.width
)
1800 out_mid
= Signal(self
.id_wid
, reset_less
=True)
1801 m
.submodules
.out_z
= out_z
1803 geta
= self
.add_state(FPGetOp("get_a", "get_b",
1808 getb
= self
.add_state(FPGetOp("get_b", "fpadd",
1813 ab
= FPADDBase(self
.width
, self
.id_wid
, self
.single_cycle
)
1814 ab
= self
.add_state(ab
)
1815 ab
.setup(m
, a
, b
, getb
.out_decode
, self
.ids
.in_mid
,
1818 pz
= self
.add_state(FPPutZIdx("put_z", ab
.out_z
, self
.res
,
1821 with m
.FSM() as fsm
:
1823 for state
in self
.states
:
1824 with m
.State(state
.state_from
):
1830 if __name__
== "__main__":
1832 alu
= FPADD(width
=32, id_wid
=5, single_cycle
=True)
1833 main(alu
, ports
=alu
.rs
[0][0].ports() + \
1834 alu
.rs
[0][1].ports() + \
1835 alu
.res
[0].ports() + \
1836 [alu
.ids
.in_mid
, alu
.ids
.out_mid
])
1838 alu
= FPADDBase(width
=32, id_wid
=5, single_cycle
=True)
1839 main(alu
, ports
=[alu
.in_a
, alu
.in_b
] + \
1840 alu
.in_t
.ports() + \
1841 alu
.out_z
.ports() + \
1842 [alu
.in_mid
, alu
.out_mid
])
1845 # works... but don't use, just do "python fname.py convert -t v"
1846 #print (verilog.convert(alu, ports=[
1847 # ports=alu.in_a.ports() + \
1848 # alu.in_b.ports() + \
1849 # alu.out_z.ports())