add comments for SPR pipe_data
[soc.git] / src / soc / fu / spr / pipe_data.py
1 """SPR Pipeline Data structures
2
3 Covers MFSPR and MTSPR. however given that the SPRs are split across
4 XER (which is 3 separate registers), Fast-SPR and Slow-SPR regfiles,
5 the data structures are slightly more involved than just "INT, SPR".
6
7 Links:
8 * https://bugs.libre-soc.org/show_bug.cgi?id=348
9 * https://libre-soc.org/openpower/isa/sprset/
10 """
11
12 from nmigen import Signal, Const
13 from ieee754.fpcommon.getop import FPPipeContext
14 from soc.fu.pipe_data import IntegerData
15 from soc.decoder.power_decoder2 import Data
16 from soc.fu.spr.spr_input_record import CompSPROpSubset
17
18
19 class SPRInputData(IntegerData):
20 regspec = [('INT', 'a', '0:63'),
21 ('SPR', 'spr1', '0:63'),
22 ('FAST', 'spr2', '0:63'),
23 ('XER', 'xer_so', '32'),
24 ('XER', 'xer_ov', '33,44'),
25 ('XER', 'xer_ca', '34,45')]
26 def __init__(self, pspec):
27 super().__init__(pspec)
28 self.a = Signal(64, reset_less=True) # RA
29 self.spr1 = Signal(64, reset_less=True) # SPR (slow)
30 self.spr2 = Signal(64, reset_less=True) # SPR (fast: MSR, LR, CTR etc)
31 self.xer_so = Signal(reset_less=True) # XER bit 32: SO
32 self.xer_ca = Signal(2, reset_less=True) # XER bit 34/45: CA/CA32
33 self.xer_ov = Signal(2, reset_less=True) # bit0: ov, bit1: ov32
34
35 def __iter__(self):
36 yield from super().__iter__()
37 yield self.a
38 yield self.spr1
39 yield self.spr2
40 yield self.xer_ca
41 yield self.xer_ov
42 yield self.xer_so
43
44 def eq(self, i):
45 lst = super().eq(i)
46 return lst + [self.a.eq(i.a), self.reg.eq(i.reg),
47 self.spr1.eq(i.spr1), self.spr2.eq(i.spr2),
48 self.xer_ca.eq(i.xer_ca),
49 self.xer_ov.eq(i.xer_ov),
50 self.xer_so.eq(i.xer_so)]
51
52
53 class SPROutputData(IntegerData):
54 regspec = [('INT', 'o', '0:63'),
55 ('SPR', 'spr1', '0:63'),
56 ('FAST', 'spr2', '0:63'),
57 ('XER', 'xer_so', '32'),
58 ('XER', 'xer_ov', '33,44'),
59 ('XER', 'xer_ca', '34,45')]
60 def __init__(self, pspec):
61 super().__init__(pspec)
62 self.o = Data(64, name="rt") # RT
63 self.spr1 = Data(64, name="spr1") # SPR (slow)
64 self.spr2 = Data(64, name="spr2") # SPR (fast: MSR, LR, CTR etc)
65 self.xer_so = Data(1, name="xer_so") # XER bit 32: SO
66 self.xer_ca = Data(2, name="xer_ca") # XER bit 34/45: CA/CA32
67 self.xer_ov = Data(2, name="xer_ov") # bit0: ov, bit1: ov32
68
69 def __iter__(self):
70 yield from super().__iter__()
71 yield self.o
72 yield self.spr1
73 yield self.spr2
74 yield self.xer_ca
75 yield self.xer_ov
76 yield self.xer_so
77
78 def eq(self, i):
79 lst = super().eq(i)
80 return lst + [self.o.eq(i.o), self.reg.eq(i.reg),
81 self.spr1.eq(i.spr1), self.spr2.eq(i.spr2),
82 self.xer_ca.eq(i.xer_ca),
83 self.xer_ov.eq(i.xer_ov),
84 self.xer_so.eq(i.xer_so)]
85
86
87
88 class SPRPipeSpec:
89 regspec = (SPRInputData.regspec, SPROutputData.regspec)
90 opsubsetkls = CompSPROpSubset
91 def __init__(self, id_wid, op_wid):
92 self.id_wid = id_wid
93 self.op_wid = op_wid
94 self.opkls = lambda _: self.opsubsetkls(name="op")
95 self.stage = None
96 self.pipekls = SimpleHandshakeRedir