1 """Computation Unit (aka "ALU Manager").
3 Manages a Pipeline or FSM, ensuring that the start and end time are 100%
4 monitored. At no time may the ALU proceed without this module notifying
5 the Dependency Matrices. At no time is a result production "abandoned".
6 This module blocks (indicates busy) starting from when it first receives
7 an opcode until it receives notification that
8 its result(s) have been successfully stored in the regfile(s)
10 Documented at http://libre-soc.org/3d_gpu/architecture/compunit
13 from nmigen
import Module
, Signal
, Mux
, Elaboratable
, Repl
, Cat
, Const
14 from nmigen
.hdl
.rec
import (Record
, DIR_FANIN
, DIR_FANOUT
)
16 from nmutil
.latch
import SRLatch
, latchregister
17 from nmutil
.iocontrol
import RecordObject
18 from nmutil
.util
import rising_edge
20 from soc
.fu
.regspec
import RegSpec
, RegSpecALUAPI
24 """find_ok helper function - finds field ending in "_ok"
26 for field_name
in fields
:
27 if field_name
.endswith("_ok"):
32 def go_record(n
, name
):
33 r
= Record([('go_i', n
, DIR_FANIN
),
34 ('rel_o', n
, DIR_FANOUT
)], name
=name
)
35 r
.go_i
.reset_less
= True
36 r
.rel_o
.reset_less
= True
40 # see https://libre-soc.org/3d_gpu/architecture/regfile/ section on regspecs
42 class CompUnitRecord(RegSpec
, RecordObject
):
45 base class for Computation Units, to provide a uniform API
46 and allow "record.connect" etc. to be used, particularly when
47 it comes to connecting multiple Computation Units up as a block
50 LDSTCompUnitRecord should derive from this class and add the
51 additional signals it requires
53 :subkls: the class (not an instance) needed to construct the opcode
54 :rwid: either an integer (specifies width of all regs) or a "regspec"
56 see https://libre-soc.org/3d_gpu/architecture/regfile/ section on regspecs
59 def __init__(self
, subkls
, rwid
, n_src
=None, n_dst
=None, name
=None):
60 RegSpec
.__init
__(self
, rwid
, n_src
, n_dst
)
62 RecordObject
.__init
__(self
)
64 n_src
, n_dst
= self
._n
_src
, self
._n
_dst
66 # create source operands
68 for i
in range(n_src
):
69 j
= i
+ 1 # name numbering to match src1/src2
71 rw
= self
._get
_srcwid
(i
)
72 sreg
= Signal(rw
, name
=sname
, reset_less
=True)
73 setattr(self
, sname
, sreg
)
77 # create dest operands
79 for i
in range(n_dst
):
80 j
= i
+ 1 # name numbering to match dest1/2...
81 dname
= "dest%d_o" % j
82 rw
= self
._get
_dstwid
(i
)
83 # dreg = Data(rw, name=name) XXX ??? output needs to be a Data type?
84 dreg
= Signal(rw
, name
=dname
, reset_less
=True)
85 setattr(self
, dname
, dreg
)
89 # operation / data input
90 self
.oper_i
= subkls(name
="oper_i_%s" % name
) # operand
92 # create read/write and other scoreboard signalling
93 self
.rd
= go_record(n_src
, name
="cu_rd") # read in, req out
94 self
.wr
= go_record(n_dst
, name
="cu_wr") # write in, req out
96 self
.rdmaskn
= Signal(n_src
, name
="cu_rdmaskn_i", reset_less
=True)
97 self
.wrmask
= Signal(n_dst
, name
="cu_wrmask_o", reset_less
=True)
100 self
.issue_i
= Signal(name
="cu_issue_i", reset_less
=True)
101 # shadow function, defaults to ON
102 self
.shadown_i
= Signal(name
="cu_shadown_i", reset
=1)
104 self
.go_die_i
= Signal(name
="cu_go_die_i")
107 self
.busy_o
= Signal(name
="cu_busy_o", reset_less
=True) # fn busy out
108 self
.done_o
= Signal(name
="cu_done_o", reset_less
=True)
109 self
.alu_done_o
= Signal(name
="cu_alu_done_o", reset_less
=True)
112 class MultiCompUnit(RegSpecALUAPI
, Elaboratable
):
113 def __init__(self
, rwid
, alu
, opsubsetkls
, n_src
=2, n_dst
=1, name
=None,
117 * :rwid: width of register latches (TODO: allocate per regspec)
118 * :alu: ALU (pipeline, FSM) - must conform to nmutil Pipe API
119 * :opsubsetkls: subset of Decode2ExecuteType
120 * :n_src: number of src operands
121 * :n_dst: number of destination operands
123 RegSpecALUAPI
.__init
__(self
, rwid
, alu
)
124 self
.sync_rw
= sync_rw
125 self
.alu_name
= name
or "alu"
126 self
.opsubsetkls
= opsubsetkls
127 self
.cu
= cu
= CompUnitRecord(opsubsetkls
, rwid
, n_src
, n_dst
,
129 n_src
, n_dst
= self
.n_src
, self
.n_dst
= cu
._n
_src
, cu
._n
_dst
130 print("n_src %d n_dst %d" % (self
.n_src
, self
.n_dst
))
132 # convenience names for src operands
133 for i
in range(n_src
):
134 j
= i
+ 1 # name numbering to match src1/src2
136 setattr(self
, name
, getattr(cu
, name
))
138 # convenience names for dest operands
139 for i
in range(n_dst
):
140 j
= i
+ 1 # name numbering to match dest1/2...
141 name
= "dest%d_o" % j
142 setattr(self
, name
, getattr(cu
, name
))
144 # more convenience names
147 self
.rdmaskn
= cu
.rdmaskn
148 self
.wrmask
= cu
.wrmask
149 self
.alu_done_o
= cu
.alu_done_o
150 self
.go_rd_i
= self
.rd
.go_i
# temporary naming
151 self
.go_wr_i
= self
.wr
.go_i
# temporary naming
152 self
.rd_rel_o
= self
.rd
.rel_o
# temporary naming
153 self
.req_rel_o
= self
.wr
.rel_o
# temporary naming
154 self
.issue_i
= cu
.issue_i
155 self
.shadown_i
= cu
.shadown_i
156 self
.go_die_i
= cu
.go_die_i
158 # operation / data input
159 self
.oper_i
= cu
.oper_i
160 self
.src_i
= cu
._src
_i
162 self
.busy_o
= cu
.busy_o
164 self
.o_data
= self
.dest
[0] # Dest out
165 self
.done_o
= cu
.done_o
167 def _mux_op(self
, m
, sl
, op_is_imm
, imm
, i
):
168 # select imm if opcode says so. however also change the latch
169 # to trigger *from* the opcode latch instead.
170 src_or_imm
= Signal(self
.cu
._get
_srcwid
(i
), reset_less
=True)
171 src_sel
= Signal(reset_less
=True)
172 m
.d
.comb
+= src_sel
.eq(Mux(op_is_imm
, self
.opc_l
.q
, sl
[i
][2]))
173 m
.d
.comb
+= src_or_imm
.eq(Mux(op_is_imm
, imm
, self
.src_i
[i
]))
174 # overwrite 1st src-latch with immediate-muxed stuff
175 sl
[i
][0] = src_or_imm
177 sl
[i
][3] = ~op_is_imm
# change rd.rel[i] gate condition
179 def elaborate(self
, platform
):
185 # add the ALU to the MultiCompUnit only if it is a "real" ALU
186 # see AllFunctionUnits as to why: a FunctionUnitBaseMulti
187 # only has one "real" ALU but multiple pseudo front-ends,
188 # aka "ReservationStations" (ALUProxy "fronts")
189 if isinstance(self
.alu
, Elaboratable
):
190 setattr(m
.submodules
, self
.alu_name
, self
.alu
)
191 m
.submodules
.src_l
= src_l
= SRLatch(False, self
.n_src
, name
="src")
192 m
.submodules
.opc_l
= opc_l
= SRLatch(sync
=False, name
="opc")
193 m
.submodules
.req_l
= req_l
= SRLatch(False, self
.n_dst
, name
="req")
194 m
.submodules
.rst_l
= rst_l
= SRLatch(sync
=False, name
="rst")
195 m
.submodules
.rok_l
= rok_l
= SRLatch(sync
=False, name
="rdok")
196 self
.opc_l
, self
.src_l
= opc_l
, src_l
198 # ALU only proceeds when all src are ready. rd_rel_o is delayed
199 # so combine it with go_rd_i. if all bits are set we're good
200 all_rd
= Signal(reset_less
=True)
201 m
.d
.comb
+= all_rd
.eq(self
.busy_o
& rok_l
.q
&
202 (((~self
.rd
.rel_o
) | self
.rd
.go_i
).all()))
204 # generate read-done pulse
205 all_rd_pulse
= Signal(reset_less
=True)
206 m
.d
.comb
+= all_rd_pulse
.eq(rising_edge(m
, all_rd
))
208 # create rising pulse from alu valid condition.
209 alu_done
= self
.cu
.alu_done_o
210 alu_pulse
= Signal(reset_less
=True)
211 alu_pulsem
= Signal(self
.n_dst
, reset_less
=True)
212 m
.d
.comb
+= alu_done
.eq(self
.alu
.n
.o_valid
)
213 m
.d
.comb
+= alu_pulse
.eq(rising_edge(m
, alu_done
))
214 m
.d
.comb
+= alu_pulsem
.eq(Repl(alu_pulse
, self
.n_dst
))
216 # sigh bug where req_l gets both set and reset raised at same time
217 prev_wr_go
= Signal(self
.n_dst
)
218 brd
= Repl(self
.busy_o
, self
.n_dst
)
219 m
.d
.sync
+= prev_wr_go
.eq(self
.wr
.go_i
& brd
)
221 # write_requests all done
222 # req_done works because any one of the last of the writes
223 # is enough, when combined with when read-phase is done (rst_l.q)
224 wr_any
= Signal(reset_less
=True)
225 req_done
= Signal(reset_less
=True)
226 m
.d
.comb
+= self
.done_o
.eq(self
.busy_o
& ~
(self
.wr
.rel_o
).bool())
227 m
.d
.comb
+= wr_any
.eq(self
.wr
.go_i
.bool() | prev_wr_go
.bool())
228 m
.d
.comb
+= req_done
.eq(wr_any
& ~self
.alu
.n
.i_ready
& (req_l
.q
== 0))
229 # argh, complicated hack: if there are no regs to write,
230 # instead of waiting for regs that are never going to happen,
231 # we indicate "done" when the ALU is "done"
232 with m
.If((self
.wrmask
== 0) &
233 self
.alu
.n
.i_ready
& self
.alu
.n
.o_valid
& self
.busy_o
):
234 m
.d
.comb
+= req_done
.eq(1)
237 reset
= Signal(reset_less
=True)
238 rst_r
= Signal(reset_less
=True) # reset latch off
239 reset_w
= Signal(self
.n_dst
, reset_less
=True)
240 reset_r
= Signal(self
.n_src
, reset_less
=True)
241 m
.d
.comb
+= reset
.eq(req_done | self
.go_die_i
)
242 m
.d
.comb
+= rst_r
.eq(self
.issue_i | self
.go_die_i
)
243 m
.d
.comb
+= reset_w
.eq(self
.wr
.go_i |
Repl(self
.go_die_i
, self
.n_dst
))
244 m
.d
.comb
+= reset_r
.eq(self
.rd
.go_i |
Repl(self
.go_die_i
, self
.n_src
))
246 # read-done,wr-proceed latch
247 rw_domain
+= rok_l
.s
.eq(self
.issue_i
) # set up when issue starts
248 rw_domain
+= rok_l
.r
.eq(self
.alu
.n
.o_valid
& self
.busy_o
) # ALU done
250 # wr-done, back-to-start latch
251 rw_domain
+= rst_l
.s
.eq(all_rd
) # set when read-phase is fully done
252 rw_domain
+= rst_l
.r
.eq(rst_r
) # *off* on issue
254 # opcode latch (not using go_rd_i) - inverted so that busy resets to 0
255 m
.d
.sync
+= opc_l
.s
.eq(self
.issue_i
) # set on issue
256 m
.d
.sync
+= opc_l
.r
.eq(req_done
) # reset on ALU
258 # src operand latch (not using go_wr_i)
259 m
.d
.sync
+= src_l
.s
.eq(Repl(self
.issue_i
, self
.n_src
) & ~self
.rdmaskn
)
260 m
.d
.sync
+= src_l
.r
.eq(reset_r
)
262 # dest operand latch (not using issue_i)
263 m
.d
.sync
+= req_l
.s
.eq(alu_pulsem
& self
.wrmask
)
264 m
.d
.sync
+= req_l
.r
.eq(reset_w | prev_wr_go
)
266 # pass operation to the ALU (sync: plenty time to wait for src reads)
268 with m
.If(self
.issue_i
):
269 m
.d
.sync
+= op
.eq(self
.oper_i
)
271 # and for each output from the ALU: capture when ALU output is valid
274 for i
in range(self
.n_dst
):
275 name
= "data_r%d" % i
276 lro
= self
.get_out(i
)
278 data_r_ok
= Const(1, 1)
279 if isinstance(lro
, Record
):
280 data_r
= Record
.like(lro
, name
=name
)
281 print("wr fields", i
, lro
, data_r
.fields
)
282 # bye-bye abstract interface design..
283 fname
= find_ok(data_r
.fields
)
285 ok
= getattr(lro
, fname
)
286 data_r_ok
= getattr(data_r
, fname
)
287 # write-ok based on incoming output *and* whether the latched
289 # XXX fails - wrok.append((ok|data_r_ok) & self.busy_o)
290 wrok
.append(ok
& self
.busy_o
)
292 # really should retire this but it's part of unit tests
293 data_r
= Signal
.like(lro
, name
=name
, reset_less
=True)
294 wrok
.append(ok
& self
.busy_o
)
295 with m
.If(alu_pulse
):
296 m
.d
.sync
+= data_r
.eq(lro
)
297 with m
.If(self
.issue_i
):
298 m
.d
.sync
+= data_r
.eq(0)
301 # ok, above we collated anything with an "ok" on the output side
302 # now actually use those to create a write-mask. this basically
303 # is now the Function Unit API tells the Comp Unit "do not request
304 # a regfile port because this particular output is not valid"
305 m
.d
.comb
+= self
.wrmask
.eq(Cat(*wrok
))
307 # create list of src/alu-src/src-latch. override 1st and 2nd one below.
308 # in the case, for ALU and Logical pipelines, we assume RB is the
309 # 2nd operand in the input "regspec". see for example
310 # soc.fu.alu.pipe_data.ALUInputData
312 print("src_i", self
.src_i
)
313 for i
in range(self
.n_src
):
314 sl
.append([self
.src_i
[i
], self
.get_in(i
), src_l
.q
[i
], Const(1, 1)])
316 # if the operand subset has "zero_a" we implicitly assume that means
317 # src_i[0] is an INT reg type where zero can be multiplexed in, instead.
318 # see https://bugs.libre-soc.org/show_bug.cgi?id=336
319 if hasattr(op
, "zero_a"):
320 # select zero imm if opcode says so. however also change the latch
321 # to trigger *from* the opcode latch instead.
322 self
._mux
_op
(m
, sl
, op
.zero_a
, 0, 0)
324 # if the operand subset has "imm_data" we implicitly assume that means
325 # "this is an INT ALU/Logical FU jobbie, RB is muxed with the immediate"
326 if hasattr(op
, "imm_data"):
327 # select immediate if opcode says so. however also change the latch
328 # to trigger *from* the opcode latch instead.
329 op_is_imm
= op
.imm_data
.ok
330 imm
= op
.imm_data
.data
331 self
._mux
_op
(m
, sl
, op_is_imm
, imm
, 1)
333 # create a latch/register for src1/src2 (even if it is a copy of imm)
334 for i
in range(self
.n_src
):
335 src
, alusrc
, latch
, _
= sl
[i
]
336 reg
= latchregister(m
, src
, alusrc
, latch
, name
="src_r%d" % i
)
337 # rdmask stops src latches from being set. clear all if not busy
338 with m
.If(~self
.busy_o
):
339 m
.d
.sync
+= reg
.eq(0)
342 # ALU connection / interaction
345 # on a go_read, tell the ALU we're accepting data.
346 m
.submodules
.alui_l
= alui_l
= SRLatch(False, name
="alui")
347 m
.d
.comb
+= self
.alu
.p
.i_valid
.eq(alui_l
.q
)
348 m
.d
.sync
+= alui_l
.r
.eq(self
.alu
.p
.o_ready
& alui_l
.q
)
349 m
.d
.comb
+= alui_l
.s
.eq(all_rd_pulse
)
351 # ALU output "ready" side. alu "ready" indication stays hi until
353 m
.submodules
.alu_l
= alu_l
= SRLatch(False, name
="alu")
354 m
.d
.comb
+= self
.alu
.n
.i_ready
.eq(alu_l
.q
)
355 m
.d
.sync
+= alu_l
.r
.eq(self
.alu
.n
.o_valid
& alu_l
.q
)
356 m
.d
.comb
+= alu_l
.s
.eq(all_rd_pulse
)
362 slg
= Cat(*map(lambda x
: x
[3], sl
)) # get req gate conditions
363 # all request signals gated by busy_o. prevents picker problems
364 m
.d
.comb
+= self
.busy_o
.eq(opc_l
.q
) # busy out
366 # read-release gated by busy (and read-mask)
367 bro
= Repl(self
.busy_o
, self
.n_src
)
368 m
.d
.comb
+= self
.rd
.rel_o
.eq(src_l
.q
& bro
& slg
)
370 # write-release gated by busy and by shadow (and write-mask)
371 brd
= Repl(self
.busy_o
& self
.shadown_i
, self
.n_dst
)
372 m
.d
.comb
+= self
.wr
.rel_o
.eq(req_l
.q
& brd
)
374 # output the data from the latch on go_write
375 for i
in range(self
.n_dst
):
376 with m
.If(self
.wr
.go_i
[i
] & self
.busy_o
):
377 m
.d
.comb
+= self
.dest
[i
].eq(drl
[i
])
381 def get_fu_out(self
, i
):
390 yield from self
.oper_i
.ports()