2 use ieee.std_logic_1164.all;
3 use ieee.numeric_std.all;
6 use work.decode_types.all;
9 -- Processor Version Number
10 constant PVR_MICROWATT : std_ulogic_vector(31 downto 0) := x"00630000";
13 constant MSR_SF : integer := (63 - 0); -- Sixty-Four bit mode
14 constant MSR_EE : integer := (63 - 48); -- External interrupt Enable
15 constant MSR_PR : integer := (63 - 49); -- PRoblem state
16 constant MSR_IR : integer := (63 - 58); -- Instruction Relocation
17 constant MSR_DR : integer := (63 - 59); -- Data Relocation
18 constant MSR_RI : integer := (63 - 62); -- Recoverable Interrupt
19 constant MSR_LE : integer := (63 - 63); -- Little Endian
22 subtype spr_num_t is integer range 0 to 1023;
24 function decode_spr_num(insn: std_ulogic_vector(31 downto 0)) return spr_num_t;
26 constant SPR_XER : spr_num_t := 1;
27 constant SPR_LR : spr_num_t := 8;
28 constant SPR_CTR : spr_num_t := 9;
29 constant SPR_DSISR : spr_num_t := 18;
30 constant SPR_DAR : spr_num_t := 19;
31 constant SPR_TB : spr_num_t := 268;
32 constant SPR_TBU : spr_num_t := 269;
33 constant SPR_DEC : spr_num_t := 22;
34 constant SPR_SRR0 : spr_num_t := 26;
35 constant SPR_SRR1 : spr_num_t := 27;
36 constant SPR_CFAR : spr_num_t := 28;
37 constant SPR_HSRR0 : spr_num_t := 314;
38 constant SPR_HSRR1 : spr_num_t := 315;
39 constant SPR_SPRG0 : spr_num_t := 272;
40 constant SPR_SPRG1 : spr_num_t := 273;
41 constant SPR_SPRG2 : spr_num_t := 274;
42 constant SPR_SPRG3 : spr_num_t := 275;
43 constant SPR_SPRG3U : spr_num_t := 259;
44 constant SPR_HSPRG0 : spr_num_t := 304;
45 constant SPR_HSPRG1 : spr_num_t := 305;
46 constant SPR_PID : spr_num_t := 48;
47 constant SPR_PRTBL : spr_num_t := 720;
48 constant SPR_PVR : spr_num_t := 287;
50 -- GPR indices in the register file (GPR only)
51 subtype gpr_index_t is std_ulogic_vector(4 downto 0);
53 -- Extended GPR indice (can hold an SPR)
54 subtype gspr_index_t is std_ulogic_vector(5 downto 0);
56 -- Some SPRs are stored in the register file, they use the magic
57 -- GPR numbers above 31.
59 -- The function fast_spr_num() returns the corresponding fast
60 -- pseudo-GPR number for a given SPR number. The result MSB
61 -- indicates if this is indeed a fast SPR. If clear, then
62 -- the SPR is not stored in the GPR file.
64 function fast_spr_num(spr: spr_num_t) return gspr_index_t;
66 -- Indices conversion functions
67 function gspr_to_gpr(i: gspr_index_t) return gpr_index_t;
68 function gpr_to_gspr(i: gpr_index_t) return gspr_index_t;
69 function gpr_or_spr_to_gspr(g: gpr_index_t; s: gspr_index_t) return gspr_index_t;
70 function is_fast_spr(s: gspr_index_t) return std_ulogic;
72 -- The XER is split: the common bits (CA, OV, SO, OV32 and CA32) are
73 -- in the CR file as a kind of CR extension (with a separate write
74 -- control). The rest is stored as a fast SPR.
75 type xer_common_t is record
82 constant xerc_init : xer_common_t := (others => '0');
84 type irq_state_t is (WRITE_SRR0, WRITE_SRR1);
86 -- For now, fixed 16 sources, make this either a parametric
87 -- package of some sort or an unconstrainted array.
88 type ics_to_icp_t is record
89 -- Level interrupts only, ICS just keeps prsenting the
90 -- highest priority interrupt. Once handling edge, something
91 -- smarter involving handshake & reject support will be needed
92 src : std_ulogic_vector(3 downto 0);
93 pri : std_ulogic_vector(7 downto 0);
96 -- This needs to die...
98 tb: std_ulogic_vector(63 downto 0);
99 dec: std_ulogic_vector(63 downto 0);
100 msr: std_ulogic_vector(63 downto 0);
101 cfar: std_ulogic_vector(63 downto 0);
102 irq_state : irq_state_t;
103 srr1: std_ulogic_vector(63 downto 0);
106 type Fetch1ToIcacheType is record
108 virt_mode : std_ulogic;
109 priv_mode : std_ulogic;
110 stop_mark: std_ulogic;
111 sequential: std_ulogic;
112 nia: std_ulogic_vector(63 downto 0);
115 type IcacheToDecode1Type is record
117 stop_mark: std_ulogic;
118 fetch_failed: std_ulogic;
119 nia: std_ulogic_vector(63 downto 0);
120 insn: std_ulogic_vector(31 downto 0);
123 type Decode1ToDecode2Type is record
125 stop_mark : std_ulogic;
126 nia: std_ulogic_vector(63 downto 0);
127 insn: std_ulogic_vector(31 downto 0);
128 ispr1: gspr_index_t; -- (G)SPR used for branch condition (CTR) or mfspr
129 ispr2: gspr_index_t; -- (G)SPR used for branch target (CTR, LR, TAR)
130 decode: decode_rom_t;
131 br_pred: std_ulogic; -- Branch was predicted to be taken
133 constant Decode1ToDecode2Init : Decode1ToDecode2Type :=
134 (valid => '0', stop_mark => '0', nia => (others => '0'), insn => (others => '0'),
135 ispr1 => (others => '0'), ispr2 => (others => '0'), decode => decode_rom_init, br_pred => '0');
137 type Decode1ToFetch1Type is record
138 redirect : std_ulogic;
139 redirect_nia : std_ulogic_vector(63 downto 0);
142 type Decode2ToExecute1Type is record
145 insn_type: insn_type_t;
146 nia: std_ulogic_vector(63 downto 0);
147 write_reg: gspr_index_t;
148 read_reg1: gspr_index_t;
149 read_reg2: gspr_index_t;
150 read_data1: std_ulogic_vector(63 downto 0);
151 read_data2: std_ulogic_vector(63 downto 0);
152 read_data3: std_ulogic_vector(63 downto 0);
153 bypass_data1: std_ulogic;
154 bypass_data2: std_ulogic;
155 bypass_data3: std_ulogic;
156 cr: std_ulogic_vector(31 downto 0);
157 bypass_cr : std_ulogic;
162 invert_a: std_ulogic;
163 invert_out: std_ulogic;
164 input_carry: carry_in_t;
165 output_carry: std_ulogic;
166 input_cr: std_ulogic;
167 output_cr: std_ulogic;
168 is_32bit: std_ulogic;
169 is_signed: std_ulogic;
170 insn: std_ulogic_vector(31 downto 0);
171 data_len: std_ulogic_vector(3 downto 0);
172 byte_reverse : std_ulogic;
173 sign_extend : std_ulogic; -- do we need to sign extend?
174 update : std_ulogic; -- is this an update instruction?
175 reserve : std_ulogic; -- set for larx/stcx
176 br_pred : std_ulogic;
178 constant Decode2ToExecute1Init : Decode2ToExecute1Type :=
179 (valid => '0', unit => NONE, insn_type => OP_ILLEGAL, bypass_data1 => '0', bypass_data2 => '0', bypass_data3 => '0',
180 bypass_cr => '0', lr => '0', rc => '0', oe => '0', invert_a => '0',
181 invert_out => '0', input_carry => ZERO, output_carry => '0', input_cr => '0', output_cr => '0',
182 is_32bit => '0', is_signed => '0', xerc => xerc_init, reserve => '0', br_pred => '0',
183 byte_reverse => '0', sign_extend => '0', update => '0', nia => (others => '0'), read_data1 => (others => '0'), read_data2 => (others => '0'), read_data3 => (others => '0'), cr => (others => '0'), insn => (others => '0'), data_len => (others => '0'), others => (others => '0'));
185 type MultiplyInputType is record
187 data1: std_ulogic_vector(63 downto 0);
188 data2: std_ulogic_vector(63 downto 0);
189 addend: std_ulogic_vector(127 downto 0);
190 is_32bit: std_ulogic;
191 not_result: std_ulogic;
193 constant MultiplyInputInit : MultiplyInputType := (valid => '0',
194 is_32bit => '0', not_result => '0',
195 others => (others => '0'));
197 type MultiplyOutputType is record
199 result: std_ulogic_vector(127 downto 0);
200 overflow : std_ulogic;
202 constant MultiplyOutputInit : MultiplyOutputType := (valid => '0', overflow => '0',
203 others => (others => '0'));
205 type Execute1ToDividerType is record
207 dividend: std_ulogic_vector(63 downto 0);
208 divisor: std_ulogic_vector(63 downto 0);
209 is_signed: std_ulogic;
210 is_32bit: std_ulogic;
211 is_extended: std_ulogic;
212 is_modulus: std_ulogic;
213 neg_result: std_ulogic;
215 constant Execute1ToDividerInit: Execute1ToDividerType := (valid => '0', is_signed => '0', is_32bit => '0',
216 is_extended => '0', is_modulus => '0',
217 neg_result => '0', others => (others => '0'));
219 type Decode2ToRegisterFileType is record
220 read1_enable : std_ulogic;
221 read1_reg : gspr_index_t;
222 read2_enable : std_ulogic;
223 read2_reg : gspr_index_t;
224 read3_enable : std_ulogic;
225 read3_reg : gpr_index_t;
228 type RegisterFileToDecode2Type is record
229 read1_data : std_ulogic_vector(63 downto 0);
230 read2_data : std_ulogic_vector(63 downto 0);
231 read3_data : std_ulogic_vector(63 downto 0);
234 type Decode2ToCrFileType is record
238 type CrFileToDecode2Type is record
239 read_cr_data : std_ulogic_vector(31 downto 0);
240 read_xerc_data : xer_common_t;
243 type Execute1ToFetch1Type is record
244 redirect: std_ulogic;
245 virt_mode: std_ulogic;
246 priv_mode: std_ulogic;
247 redirect_nia: std_ulogic_vector(63 downto 0);
249 constant Execute1ToFetch1Init : Execute1ToFetch1Type := (redirect => '0', virt_mode => '0',
250 priv_mode => '0', others => (others => '0'));
252 type Execute1ToLoadstore1Type is record
254 op : insn_type_t; -- what ld/st or m[tf]spr or TLB op to do
255 nia : std_ulogic_vector(63 downto 0);
256 insn : std_ulogic_vector(31 downto 0);
257 addr1 : std_ulogic_vector(63 downto 0);
258 addr2 : std_ulogic_vector(63 downto 0);
259 data : std_ulogic_vector(63 downto 0); -- data to write, unused for read
260 write_reg : gpr_index_t;
261 length : std_ulogic_vector(3 downto 0);
262 ci : std_ulogic; -- cache-inhibited load/store
263 byte_reverse : std_ulogic;
264 sign_extend : std_ulogic; -- do we need to sign extend?
265 update : std_ulogic; -- is this an update instruction?
266 update_reg : gpr_index_t; -- if so, the register to update
268 reserve : std_ulogic; -- set for larx/stcx.
269 rc : std_ulogic; -- set for stcx.
270 virt_mode : std_ulogic; -- do translation through TLB
271 priv_mode : std_ulogic; -- privileged mode (MSR[PR] = 0)
273 constant Execute1ToLoadstore1Init : Execute1ToLoadstore1Type := (valid => '0', op => OP_ILLEGAL, ci => '0', byte_reverse => '0',
274 sign_extend => '0', update => '0', xerc => xerc_init,
275 reserve => '0', rc => '0', virt_mode => '0', priv_mode => '0',
276 nia => (others => '0'), insn => (others => '0'),
277 addr1 => (others => '0'), addr2 => (others => '0'), data => (others => '0'), length => (others => '0'),
278 others => (others => '0'));
280 type Loadstore1ToExecute1Type is record
282 exception : std_ulogic;
283 invalid : std_ulogic;
284 perm_error : std_ulogic;
285 rc_error : std_ulogic;
286 badtree : std_ulogic;
287 segment_fault : std_ulogic;
288 instr_fault : std_ulogic;
291 type Loadstore1ToDcacheType is record
293 load : std_ulogic; -- is this a load
296 reserve : std_ulogic;
297 virt_mode : std_ulogic;
298 priv_mode : std_ulogic;
299 addr : std_ulogic_vector(63 downto 0);
300 data : std_ulogic_vector(63 downto 0);
301 byte_sel : std_ulogic_vector(7 downto 0);
304 type DcacheToLoadstore1Type is record
306 data : std_ulogic_vector(63 downto 0);
307 store_done : std_ulogic;
309 cache_paradox : std_ulogic;
312 type Loadstore1ToMmuType is record
320 sprn : std_ulogic_vector(9 downto 0);
321 addr : std_ulogic_vector(63 downto 0);
322 rs : std_ulogic_vector(63 downto 0);
325 type MmuToLoadstore1Type is record
328 invalid : std_ulogic;
329 badtree : std_ulogic;
331 perm_error : std_ulogic;
332 rc_error : std_ulogic;
333 sprval : std_ulogic_vector(63 downto 0);
336 type MmuToDcacheType is record
341 addr : std_ulogic_vector(63 downto 0);
342 pte : std_ulogic_vector(63 downto 0);
345 type DcacheToMmuType is record
349 data : std_ulogic_vector(63 downto 0);
352 type MmuToIcacheType is record
356 addr : std_ulogic_vector(63 downto 0);
357 pte : std_ulogic_vector(63 downto 0);
360 type Loadstore1ToWritebackType is record
362 write_enable: std_ulogic;
363 write_reg : gpr_index_t;
364 write_data : std_ulogic_vector(63 downto 0);
367 store_done : std_ulogic;
369 constant Loadstore1ToWritebackInit : Loadstore1ToWritebackType := (valid => '0', write_enable => '0', xerc => xerc_init,
370 rc => '0', store_done => '0', write_data => (others => '0'), others => (others => '0'));
372 type Execute1ToWritebackType is record
375 write_enable : std_ulogic;
376 write_reg: gspr_index_t;
377 write_data: std_ulogic_vector(63 downto 0);
378 write_cr_enable : std_ulogic;
379 write_cr_mask : std_ulogic_vector(7 downto 0);
380 write_cr_data : std_ulogic_vector(31 downto 0);
381 write_xerc_enable : std_ulogic;
383 exc_write_enable : std_ulogic;
384 exc_write_reg : gspr_index_t;
385 exc_write_data : std_ulogic_vector(63 downto 0);
387 constant Execute1ToWritebackInit : Execute1ToWritebackType := (valid => '0', rc => '0', write_enable => '0',
388 write_cr_enable => '0', exc_write_enable => '0',
389 write_xerc_enable => '0', xerc => xerc_init,
390 write_data => (others => '0'), write_cr_mask => (others => '0'),
391 write_cr_data => (others => '0'), write_reg => (others => '0'),
392 exc_write_reg => (others => '0'), exc_write_data => (others => '0'));
394 type DividerToExecute1Type is record
396 write_reg_data: std_ulogic_vector(63 downto 0);
397 overflow : std_ulogic;
399 constant DividerToExecute1Init : DividerToExecute1Type := (valid => '0', overflow => '0',
400 others => (others => '0'));
402 type WritebackToRegisterFileType is record
403 write_reg : gspr_index_t;
404 write_data : std_ulogic_vector(63 downto 0);
405 write_enable : std_ulogic;
407 constant WritebackToRegisterFileInit : WritebackToRegisterFileType := (write_enable => '0', write_data => (others => '0'), others => (others => '0'));
409 type WritebackToCrFileType is record
410 write_cr_enable : std_ulogic;
411 write_cr_mask : std_ulogic_vector(7 downto 0);
412 write_cr_data : std_ulogic_vector(31 downto 0);
413 write_xerc_enable : std_ulogic;
414 write_xerc_data : xer_common_t;
416 constant WritebackToCrFileInit : WritebackToCrFileType := (write_cr_enable => '0', write_xerc_enable => '0',
417 write_xerc_data => xerc_init,
418 write_cr_mask => (others => '0'),
419 write_cr_data => (others => '0'));
423 package body common is
424 function decode_spr_num(insn: std_ulogic_vector(31 downto 0)) return spr_num_t is
426 return to_integer(unsigned(insn(15 downto 11) & insn(20 downto 16)));
428 function fast_spr_num(spr: spr_num_t) return gspr_index_t is
429 variable n : integer range 0 to 31;
430 -- tmp variable introduced as workaround for VCS compilation
431 -- simulation was failing with subtype constraint mismatch error
432 -- see GitHub PR #173
433 variable tmp : std_ulogic_vector(4 downto 0);
454 when SPR_SPRG3 | SPR_SPRG3U =>
466 tmp := std_ulogic_vector(to_unsigned(n, 5));
470 function gspr_to_gpr(i: gspr_index_t) return gpr_index_t is
472 return i(4 downto 0);
475 function gpr_to_gspr(i: gpr_index_t) return gspr_index_t is
480 function gpr_or_spr_to_gspr(g: gpr_index_t; s: gspr_index_t) return gspr_index_t is
485 return gpr_to_gspr(g);
489 function is_fast_spr(s: gspr_index_t) return std_ulogic is