move common functionality between PipeSpecs to soc.fu.pipe_data
[soc.git] / src / soc / fu / branch / pipe_data.py
1 """
2 Optional Register allocation listed below. mandatory input
3 (CompBROpSubset, CIA) not included.
4
5 * CR is Condition Register (not an SPR)
6 * SPR1 and SPR2 are all from the SPR regfile. 2 ports are needed
7
8 insn CR SPR1 SPR2
9 ---- -- ---- ----
10 op_b xx xx xx
11 op_ba xx xx xx
12 op_bl xx xx xx
13 op_bla xx xx xx
14 op_bc CR, xx, CTR
15 op_bca CR, xx, CTR
16 op_bcl CR, xx, CTR
17 op_bcla CR, xx, CTR
18 op_bclr CR, LR, CTR
19 op_bclrl CR, LR, CTR
20 op_bcctr CR, xx, CTR
21 op_bcctrl CR, xx, CTR
22 op_bctar CR, TAR, CTR
23 op_bctarl CR, TAR, CTR
24 """
25
26 from nmigen import Signal, Const
27 from ieee754.fpcommon.getop import FPPipeContext
28 from soc.decoder.power_decoder2 import Data
29 from soc.fu.pipe_data import IntegerData, CommonPipeSpec
30 from soc.fu.alu.alu_input_record import CompALUOpSubset # TODO: replace
31
32
33 class BranchInputData(IntegerData):
34 regspec = [('SPR', 'spr1', '0:63'),
35 ('SPR', 'spr2', '0:63'),
36 ('CR', 'cr', '32'),
37 ('PC', 'cia', '0:63')]
38 def __init__(self, pspec):
39 super().__init__(pspec)
40 # Note: for OP_BCREG, SPR1 will either be CTR, LR, or TAR
41 # this involves the *decode* unit selecting the register, based
42 # on detecting the operand being bcctr, bclr or bctar
43
44 self.spr1 = Signal(64, reset_less=True) # see table above, SPR1
45 self.spr2 = Signal(64, reset_less=True) # see table above, SPR2
46 self.cr = Signal(32, reset_less=True) # Condition Register(s) CR0-7
47 self.cia = Signal(64, reset_less=True) # Current Instruction Address
48
49 # convenience variables. not all of these are used at once
50 self.ctr = self.srr0 = self.hsrr0 = self.spr2
51 self.lr = self.tar = self.srr1 = self.hsrr1 = self.spr1
52
53 def __iter__(self):
54 yield from super().__iter__()
55 yield self.spr1
56 yield self.spr2
57 yield self.cr
58 yield self.cia
59
60 def eq(self, i):
61 lst = super().eq(i)
62 return lst + [self.spr1.eq(i.spr1), self.spr2.eq(i.spr2),
63 self.cr.eq(i.cr), self.cia.eq(i.cia)]
64
65
66 class BranchOutputData(IntegerData):
67 regspec = [('SPR', 'spr1', '0:63'),
68 ('SPR', 'spr2', '0:63'),
69 ('PC', 'nia', '0:63')]
70 def __init__(self, pspec):
71 super().__init__(pspec)
72 self.spr1 = Data(64, name="spr1")
73 self.spr2 = Data(64, name="spr2")
74 self.nia = Data(64, name="nia")
75
76 # convenience variables.
77 self.lr = self.tar = self.spr1
78 self.ctr = self.spr2
79
80 def __iter__(self):
81 yield from super().__iter__()
82 yield from self.spr1
83 yield from self.spr2
84 yield from self.nia
85
86 def eq(self, i):
87 lst = super().eq(i)
88 return lst + [self.spr1.eq(i.spr1), self.spr2.eq(i.spr2),
89 self.nia.eq(i.nia)]
90
91
92 # TODO: replace CompALUOpSubset with CompBranchOpSubset
93 class BranchPipeSpec(CommonPipeSpec):
94 regspec = (BranchInputData.regspec, BranchOutputData.regspec)
95 opsubsetkls = CompALUOpSubset