Allow the formal engine to perform a same-cycle result in the ALU
[soc.git] / src / soc / fu / shift_rot / main_stage.py
1 # License: LGPLv3+
2 # Copyright (C) 2020 Michael Nolan <mtnolan2640@gmail.com>
3 # Copyright (C) 2020 Luke Kenneth Casson Leighton <lkcl@lkcl.net>
4
5 # This stage is intended to do most of the work of executing shift
6 # instructions, as well as carry and overflow generation. This module
7 # however should not gate the carry or overflow, that's up to the
8 # output stage
9 from nmigen import (Module, Signal, Cat, Repl, Mux, Const)
10 from nmutil.pipemodbase import PipeModBase
11 from soc.fu.pipe_data import get_pspec_draft_bitmanip
12 from soc.fu.shift_rot.pipe_data import (ShiftRotOutputData,
13 ShiftRotInputData)
14 from nmutil.lut import BitwiseLut
15 from openpower.decoder.power_enums import MicrOp
16 from soc.fu.shift_rot.rotator import Rotator
17
18 from openpower.decoder.power_fields import DecodeFields
19 from openpower.decoder.power_fieldsn import SignalBitRange
20
21
22 class ShiftRotMainStage(PipeModBase):
23 def __init__(self, pspec):
24 super().__init__(pspec, "main")
25 self.draft_bitmanip = get_pspec_draft_bitmanip(pspec)
26 self.fields = DecodeFields(SignalBitRange, [self.i.ctx.op.insn])
27 self.fields.create_specs()
28
29 def ispec(self):
30 return ShiftRotInputData(self.pspec)
31
32 def ospec(self):
33 return ShiftRotOutputData(self.pspec)
34
35 def elaborate(self, platform):
36 XLEN = self.pspec.XLEN
37 m = Module()
38 comb = m.d.comb
39 op = self.i.ctx.op
40 o = self.o.o
41
42 bitwise_lut = None
43 if self.draft_bitmanip:
44 bitwise_lut = BitwiseLut(input_count=3, width=XLEN)
45 m.submodules.bitwise_lut = bitwise_lut
46 comb += bitwise_lut.inputs[0].eq(self.i.rb)
47 comb += bitwise_lut.inputs[1].eq(self.i.ra)
48 comb += bitwise_lut.inputs[2].eq(self.i.rc)
49
50 # NOTE: the sh field immediate is read in by PowerDecode2
51 # (actually DecodeRB), whereupon by way of rb "immediate" mode
52 # it ends up in self.i.rb.
53
54 # obtain me and mb fields from instruction.
55 m_fields = self.fields.instrs['M']
56 md_fields = self.fields.instrs['MD']
57 mb = Signal(m_fields['MB'][0:-1].shape())
58 me = Signal(m_fields['ME'][0:-1].shape())
59 mb_extra = Signal(1, reset_less=True)
60 comb += mb.eq(m_fields['MB'][0:-1])
61 comb += me.eq(m_fields['ME'][0:-1])
62 comb += mb_extra.eq(md_fields['mb'][0:-1][0])
63
64 # set up microwatt rotator module
65 m.submodules.rotator = rotator = Rotator(XLEN)
66 comb += [
67 rotator.me.eq(me),
68 rotator.mb.eq(mb),
69 rotator.mb_extra.eq(mb_extra),
70 rotator.rs.eq(self.i.rs),
71 rotator.ra.eq(self.i.a),
72 rotator.shift.eq(self.i.rb), # can also be sh (in immediate mode)
73 rotator.is_32bit.eq(op.is_32bit),
74 rotator.arith.eq(op.is_signed),
75 ]
76
77 comb += o.ok.eq(1) # defaults to enabled
78
79 # instruction rotate type
80 mode = Signal(4, reset_less=True)
81 comb += Cat(rotator.right_shift,
82 rotator.clear_left,
83 rotator.clear_right,
84 rotator.sign_ext_rs).eq(mode)
85
86 # outputs from the microwatt rotator module
87 comb += [o.data.eq(rotator.result_o),
88 self.o.xer_ca.data.eq(Repl(rotator.carry_out_o, 2))]
89
90 with m.Switch(op.insn_type):
91 with m.Case(MicrOp.OP_SHL):
92 comb += mode.eq(0b0000) # L-shift
93 with m.Case(MicrOp.OP_SHR):
94 comb += mode.eq(0b0001) # R-shift
95 with m.Case(MicrOp.OP_RLC):
96 comb += mode.eq(0b0110) # clear LR
97 with m.Case(MicrOp.OP_RLCL):
98 comb += mode.eq(0b0010) # clear L
99 with m.Case(MicrOp.OP_RLCR):
100 comb += mode.eq(0b0100) # clear R
101 with m.Case(MicrOp.OP_EXTSWSLI):
102 comb += mode.eq(0b1000) # L-ext
103 if self.draft_bitmanip:
104 with m.Case(MicrOp.OP_TERNLOG):
105 # TODO: this only works for ternlogi, change to get lut
106 # value from register when we implement other variants
107 comb += bitwise_lut.lut.eq(self.fields.FormTLI.TLI[:])
108 comb += o.data.eq(bitwise_lut.output)
109 comb += self.o.xer_ca.data.eq(0)
110 with m.Default():
111 comb += o.ok.eq(0) # otherwise disable
112
113 ###### sticky overflow and context, both pass-through #####
114
115 comb += self.o.xer_so.data.eq(self.i.xer_so)
116 comb += self.o.ctx.eq(self.i.ctx)
117
118 return m