common.vhdl

   1 library ieee;
   2 use ieee.std_logic_1164.all;
   3 use ieee.numeric_std.all;
   4
   5 library work;
   6 use work.decode_types.all;
   7
   8 package common is
   9     -- Processor Version Number
  10     constant PVR_MICROWATT  : std_ulogic_vector(31 downto 0) := x"00630000";
  11
  12     -- MSR bit numbers
  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_FP  : integer := (63 - 50);    -- Floating Point available
  17     constant MSR_FE0 : integer := (63 - 52);    -- Floating Exception mode
  18     constant MSR_SE  : integer := (63 - 53);    -- Single-step bit of TE field
  19     constant MSR_BE  : integer := (63 - 54);    -- Branch trace bit of TE field
  20     constant MSR_FE1 : integer := (63 - 55);    -- Floating Exception mode
  21     constant MSR_IR  : integer := (63 - 58);    -- Instruction Relocation
  22     constant MSR_DR  : integer := (63 - 59);    -- Data Relocation
  23     constant MSR_RI  : integer := (63 - 62);    -- Recoverable Interrupt
  24     constant MSR_LE  : integer := (63 - 63);    -- Little Endian
  25
  26     -- SPR numbers
  27     subtype spr_num_t is integer range 0 to 1023;
  28
  29     function decode_spr_num(insn: std_ulogic_vector(31 downto 0)) return spr_num_t;
  30
  31     constant SPR_XER    : spr_num_t := 1;
  32     constant SPR_LR     : spr_num_t := 8;
  33     constant SPR_CTR    : spr_num_t := 9;
  34     constant SPR_TAR    : spr_num_t := 815;
  35     constant SPR_DSISR  : spr_num_t := 18;
  36     constant SPR_DAR    : spr_num_t := 19;
  37     constant SPR_TB     : spr_num_t := 268;
  38     constant SPR_TBU    : spr_num_t := 269;
  39     constant SPR_DEC    : spr_num_t := 22;
  40     constant SPR_SRR0   : spr_num_t := 26;
  41     constant SPR_SRR1   : spr_num_t := 27;
  42     constant SPR_CFAR   : spr_num_t := 28;
  43     constant SPR_HSRR0  : spr_num_t := 314;
  44     constant SPR_HSRR1  : spr_num_t := 315;
  45     constant SPR_SPRG0  : spr_num_t := 272;
  46     constant SPR_SPRG1  : spr_num_t := 273;
  47     constant SPR_SPRG2  : spr_num_t := 274;
  48     constant SPR_SPRG3  : spr_num_t := 275;
  49     constant SPR_SPRG3U : spr_num_t := 259;
  50     constant SPR_HSPRG0 : spr_num_t := 304;
  51     constant SPR_HSPRG1 : spr_num_t := 305;
  52     constant SPR_PID    : spr_num_t := 48;
  53     constant SPR_PRTBL  : spr_num_t := 720;
  54     constant SPR_PVR    : spr_num_t := 287;
  55
  56     -- GPR indices in the register file (GPR only)
  57     subtype gpr_index_t is std_ulogic_vector(4 downto 0);
  58
  59     -- Extended GPR index (can hold an SPR or a FPR)
  60     subtype gspr_index_t is std_ulogic_vector(6 downto 0);
  61
  62     -- FPR indices
  63     subtype fpr_index_t is std_ulogic_vector(4 downto 0);
  64
  65     -- Some SPRs are stored in the register file, they use the magic
  66     -- GPR numbers above 31.
  67     --
  68     -- The function fast_spr_num() returns the corresponding fast
  69     -- pseudo-GPR number for a given SPR number. The result MSB
  70     -- indicates if this is indeed a fast SPR. If clear, then
  71     -- the SPR is not stored in the GPR file.
  72     --
  73     -- FPRs are also stored in the register file, using GSPR
  74     -- numbers from 64 to 95.
  75     --
  76     function fast_spr_num(spr: spr_num_t) return gspr_index_t;
  77
  78     -- Indices conversion functions
  79     function gspr_to_gpr(i: gspr_index_t) return gpr_index_t;
  80     function gpr_to_gspr(i: gpr_index_t) return gspr_index_t;
  81     function gpr_or_spr_to_gspr(g: gpr_index_t; s: gspr_index_t) return gspr_index_t;
  82     function is_fast_spr(s: gspr_index_t) return std_ulogic;
  83     function fpr_to_gspr(f: fpr_index_t) return gspr_index_t;
  84
  85     -- The XER is split: the common bits (CA, OV, SO, OV32 and CA32) are
  86     -- in the CR file as a kind of CR extension (with a separate write
  87     -- control). The rest is stored as a fast SPR.
  88     type xer_common_t is record
  89         ca : std_ulogic;
  90         ca32 : std_ulogic;
  91         ov : std_ulogic;
  92         ov32 : std_ulogic;
  93         so : std_ulogic;
  94     end record;
  95     constant xerc_init : xer_common_t := (others => '0');
  96
  97     -- FPSCR bit numbers
  98     constant FPSCR_FX     : integer := 63 - 32;
  99     constant FPSCR_FEX    : integer := 63 - 33;
 100     constant FPSCR_VX     : integer := 63 - 34;
 101     constant FPSCR_OX     : integer := 63 - 35;
 102     constant FPSCR_UX     : integer := 63 - 36;
 103     constant FPSCR_ZX     : integer := 63 - 37;
 104     constant FPSCR_XX     : integer := 63 - 38;
 105     constant FPSCR_VXSNAN : integer := 63 - 39;
 106     constant FPSCR_VXISI  : integer := 63 - 40;
 107     constant FPSCR_VXIDI  : integer := 63 - 41;
 108     constant FPSCR_VXZDZ  : integer := 63 - 42;
 109     constant FPSCR_VXIMZ  : integer := 63 - 43;
 110     constant FPSCR_VXVC   : integer := 63 - 44;
 111     constant FPSCR_FR     : integer := 63 - 45;
 112     constant FPSCR_FI     : integer := 63 - 46;
 113     constant FPSCR_C      : integer := 63 - 47;
 114     constant FPSCR_FL     : integer := 63 - 48;
 115     constant FPSCR_FG     : integer := 63 - 49;
 116     constant FPSCR_FE     : integer := 63 - 50;
 117     constant FPSCR_FU     : integer := 63 - 51;
 118     constant FPSCR_VXSOFT : integer := 63 - 53;
 119     constant FPSCR_VXSQRT : integer := 63 - 54;
 120     constant FPSCR_VXCVI  : integer := 63 - 55;
 121     constant FPSCR_VE     : integer := 63 - 56;
 122     constant FPSCR_OE     : integer := 63 - 57;
 123     constant FPSCR_UE     : integer := 63 - 58;
 124     constant FPSCR_ZE     : integer := 63 - 59;
 125     constant FPSCR_XE     : integer := 63 - 60;
 126     constant FPSCR_NI     : integer := 63 - 61;
 127     constant FPSCR_RN     : integer := 63 - 63;
 128
 129     type irq_state_t is (WRITE_SRR0, WRITE_SRR1);
 130
 131     -- For now, fixed 16 sources, make this either a parametric
 132     -- package of some sort or an unconstrainted array.
 133     type ics_to_icp_t is record
 134         -- Level interrupts only, ICS just keeps prsenting the
 135         -- highest priority interrupt. Once handling edge, something
 136         -- smarter involving handshake & reject support will be needed
 137         src : std_ulogic_vector(3 downto 0);
 138         pri : std_ulogic_vector(7 downto 0);
 139     end record;
 140
 141     -- This needs to die...
 142     type ctrl_t is record
 143         tb: std_ulogic_vector(63 downto 0);
 144         dec: std_ulogic_vector(63 downto 0);
 145         msr: std_ulogic_vector(63 downto 0);
 146         cfar: std_ulogic_vector(63 downto 0);
 147         irq_state : irq_state_t;
 148         srr1: std_ulogic_vector(63 downto 0);
 149     end record;
 150
 151     type Fetch1ToIcacheType is record
 152         req: std_ulogic;
 153         virt_mode : std_ulogic;
 154         priv_mode : std_ulogic;
 155         big_endian : std_ulogic;
 156         stop_mark: std_ulogic;
 157         sequential: std_ulogic;
 158         predicted : std_ulogic;
 159         nia: std_ulogic_vector(63 downto 0);
 160     end record;
 161
 162     type IcacheToDecode1Type is record
 163         valid: std_ulogic;
 164         stop_mark: std_ulogic;
 165         fetch_failed: std_ulogic;
 166         nia: std_ulogic_vector(63 downto 0);
 167         insn: std_ulogic_vector(31 downto 0);
 168         big_endian: std_ulogic;
 169         next_predicted: std_ulogic;
 170     end record;
 171
 172     type Decode1ToDecode2Type is record
 173         valid: std_ulogic;
 174         stop_mark : std_ulogic;
 175         nia: std_ulogic_vector(63 downto 0);
 176         insn: std_ulogic_vector(31 downto 0);
 177         ispr1: gspr_index_t; -- (G)SPR used for branch condition (CTR) or mfspr
 178         ispr2: gspr_index_t; -- (G)SPR used for branch target (CTR, LR, TAR)
 179         decode: decode_rom_t;
 180         br_pred: std_ulogic; -- Branch was predicted to be taken
 181         big_endian: std_ulogic;
 182     end record;
 183     constant Decode1ToDecode2Init : Decode1ToDecode2Type :=
 184         (valid => '0', stop_mark => '0', nia => (others => '0'), insn => (others => '0'),
 185          ispr1 => (others => '0'), ispr2 => (others => '0'), decode => decode_rom_init,
 186          br_pred => '0', big_endian => '0');
 187
 188     type Decode1ToFetch1Type is record
 189         redirect     : std_ulogic;
 190         redirect_nia : std_ulogic_vector(63 downto 0);
 191     end record;
 192
 193     type Decode2ToExecute1Type is record
 194         valid: std_ulogic;
 195         unit : unit_t;
 196         fac : facility_t;
 197         insn_type: insn_type_t;
 198         nia: std_ulogic_vector(63 downto 0);
 199         write_reg: gspr_index_t;
 200         write_reg_enable: std_ulogic;
 201         read_reg1: gspr_index_t;
 202         read_reg2: gspr_index_t;
 203         read_data1: std_ulogic_vector(63 downto 0);
 204         read_data2: std_ulogic_vector(63 downto 0);
 205         read_data3: std_ulogic_vector(63 downto 0);
 206         bypass_data1: std_ulogic;
 207         bypass_data2: std_ulogic;
 208         bypass_data3: std_ulogic;
 209         cr: std_ulogic_vector(31 downto 0);
 210         bypass_cr : std_ulogic;
 211         xerc: xer_common_t;
 212         lr: std_ulogic;
 213         rc: std_ulogic;
 214         oe: std_ulogic;
 215         invert_a: std_ulogic;
 216         addm1 : std_ulogic;
 217         invert_out: std_ulogic;
 218         input_carry: carry_in_t;
 219         output_carry: std_ulogic;
 220         input_cr: std_ulogic;
 221         output_cr: std_ulogic;
 222         is_32bit: std_ulogic;
 223         is_signed: std_ulogic;
 224         insn: std_ulogic_vector(31 downto 0);
 225         data_len: std_ulogic_vector(3 downto 0);
 226         byte_reverse : std_ulogic;
 227         sign_extend : std_ulogic;                       -- do we need to sign extend?
 228         update : std_ulogic;                            -- is this an update instruction?
 229         reserve : std_ulogic;                           -- set for larx/stcx
 230         br_pred : std_ulogic;
 231         result_sel : std_ulogic_vector(2 downto 0);     -- select source of result
 232         sub_select : std_ulogic_vector(2 downto 0);     -- sub-result selection
 233         repeat : std_ulogic;                            -- set if instruction is cracked into two ops
 234         second : std_ulogic;                            -- set if this is the second op
 235     end record;
 236     constant Decode2ToExecute1Init : Decode2ToExecute1Type :=
 237         (valid => '0', unit => NONE, fac => NONE, insn_type => OP_ILLEGAL,
 238          write_reg_enable => '0', bypass_data1 => '0', bypass_data2 => '0', bypass_data3 => '0',
 239          bypass_cr => '0', lr => '0', rc => '0', oe => '0', invert_a => '0', addm1 => '0',
 240          invert_out => '0', input_carry => ZERO, output_carry => '0', input_cr => '0', output_cr => '0',
 241          is_32bit => '0', is_signed => '0', xerc => xerc_init, reserve => '0', br_pred => '0',
 242          byte_reverse => '0', sign_extend => '0', update => '0', nia => (others => '0'),
 243          read_data1 => (others => '0'), read_data2 => (others => '0'), read_data3 => (others => '0'),
 244          cr => (others => '0'), insn => (others => '0'), data_len => (others => '0'),
 245          result_sel => "000", sub_select => "000",
 246          repeat => '0', second => '0', others => (others => '0'));
 247
 248     type MultiplyInputType is record
 249         valid: std_ulogic;
 250         data1: std_ulogic_vector(63 downto 0);
 251         data2: std_ulogic_vector(63 downto 0);
 252         addend: std_ulogic_vector(127 downto 0);
 253         is_32bit: std_ulogic;
 254         not_result: std_ulogic;
 255     end record;
 256     constant MultiplyInputInit : MultiplyInputType := (valid => '0',
 257                                                        is_32bit => '0', not_result => '0',
 258                                                        others => (others => '0'));
 259
 260     type MultiplyOutputType is record
 261         valid: std_ulogic;
 262         result: std_ulogic_vector(127 downto 0);
 263         overflow : std_ulogic;
 264     end record;
 265     constant MultiplyOutputInit : MultiplyOutputType := (valid => '0', overflow => '0',
 266                                                          others => (others => '0'));
 267
 268     type Execute1ToDividerType is record
 269         valid: std_ulogic;
 270         dividend: std_ulogic_vector(63 downto 0);
 271         divisor: std_ulogic_vector(63 downto 0);
 272         is_signed: std_ulogic;
 273         is_32bit: std_ulogic;
 274         is_extended: std_ulogic;
 275         is_modulus: std_ulogic;
 276         neg_result: std_ulogic;
 277     end record;
 278     constant Execute1ToDividerInit: Execute1ToDividerType := (valid => '0', is_signed => '0', is_32bit => '0',
 279                                                               is_extended => '0', is_modulus => '0',
 280                                                               neg_result => '0', others => (others => '0'));
 281
 282     type Decode2ToRegisterFileType is record
 283         read1_enable : std_ulogic;
 284         read1_reg : gspr_index_t;
 285         read2_enable : std_ulogic;
 286         read2_reg : gspr_index_t;
 287         read3_enable : std_ulogic;
 288         read3_reg : gspr_index_t;
 289     end record;
 290
 291     type RegisterFileToDecode2Type is record
 292         read1_data : std_ulogic_vector(63 downto 0);
 293         read2_data : std_ulogic_vector(63 downto 0);
 294         read3_data : std_ulogic_vector(63 downto 0);
 295     end record;
 296
 297     type Decode2ToCrFileType is record
 298         read : std_ulogic;
 299     end record;
 300
 301     type CrFileToDecode2Type is record
 302         read_cr_data   : std_ulogic_vector(31 downto 0);
 303         read_xerc_data : xer_common_t;
 304     end record;
 305
 306     type Execute1ToFetch1Type is record
 307         redirect: std_ulogic;
 308         virt_mode: std_ulogic;
 309         priv_mode: std_ulogic;
 310         big_endian: std_ulogic;
 311         mode_32bit: std_ulogic;
 312         redirect_nia: std_ulogic_vector(63 downto 0);
 313         br_nia : std_ulogic_vector(63 downto 0);
 314         br_last : std_ulogic;
 315         br_taken : std_ulogic;
 316     end record;
 317     constant Execute1ToFetch1Init : Execute1ToFetch1Type := (redirect => '0', virt_mode => '0',
 318                                                              priv_mode => '0', big_endian => '0',
 319                                                              mode_32bit => '0', br_taken => '0',
 320                                                              br_last => '0', others => (others => '0'));
 321
 322     type Execute1ToLoadstore1Type is record
 323         valid : std_ulogic;
 324         op : insn_type_t;                               -- what ld/st or m[tf]spr or TLB op to do
 325         nia : std_ulogic_vector(63 downto 0);
 326         insn : std_ulogic_vector(31 downto 0);
 327         addr1 : std_ulogic_vector(63 downto 0);
 328         addr2 : std_ulogic_vector(63 downto 0);
 329         data : std_ulogic_vector(63 downto 0);          -- data to write, unused for read
 330         write_reg : gspr_index_t;
 331         length : std_ulogic_vector(3 downto 0);
 332         ci : std_ulogic;                                -- cache-inhibited load/store
 333         byte_reverse : std_ulogic;
 334         sign_extend : std_ulogic;                       -- do we need to sign extend?
 335         update : std_ulogic;                            -- is this an update instruction?
 336         update_reg : gpr_index_t;                       -- if so, the register to update
 337         xerc : xer_common_t;
 338         reserve : std_ulogic;                           -- set for larx/stcx.
 339         rc : std_ulogic;                                -- set for stcx.
 340         virt_mode : std_ulogic;                         -- do translation through TLB
 341         priv_mode : std_ulogic;                         -- privileged mode (MSR[PR] = 0)
 342         mode_32bit : std_ulogic;                        -- trim addresses to 32 bits
 343         is_32bit : std_ulogic;
 344         repeat : std_ulogic;
 345         second : std_ulogic;
 346     end record;
 347     constant Execute1ToLoadstore1Init : Execute1ToLoadstore1Type := (valid => '0', op => OP_ILLEGAL, ci => '0', byte_reverse => '0',
 348                                                                      sign_extend => '0', update => '0', xerc => xerc_init,
 349                                                                      reserve => '0', rc => '0', virt_mode => '0', priv_mode => '0',
 350                                                                      nia => (others => '0'), insn => (others => '0'),
 351                                                                      addr1 => (others => '0'), addr2 => (others => '0'), data => (others => '0'),
 352                                                                      write_reg => (others => '0'), length => (others => '0'),
 353                                                                      mode_32bit => '0', is_32bit => '0',
 354                                                                      repeat => '0', second => '0', others => (others => '0'));
 355
 356     type Loadstore1ToExecute1Type is record
 357         busy : std_ulogic;
 358         exception : std_ulogic;
 359         alignment : std_ulogic;
 360         invalid : std_ulogic;
 361         perm_error : std_ulogic;
 362         rc_error : std_ulogic;
 363         badtree : std_ulogic;
 364         segment_fault : std_ulogic;
 365         instr_fault : std_ulogic;
 366     end record;
 367
 368     type Loadstore1ToDcacheType is record
 369         valid : std_ulogic;
 370         load : std_ulogic;                              -- is this a load
 371         dcbz : std_ulogic;
 372         nc : std_ulogic;
 373         reserve : std_ulogic;
 374         atomic : std_ulogic;                            -- part of a multi-transfer atomic op
 375         atomic_last : std_ulogic;
 376         virt_mode : std_ulogic;
 377         priv_mode : std_ulogic;
 378         addr : std_ulogic_vector(63 downto 0);
 379         data : std_ulogic_vector(63 downto 0);          -- valid the cycle after .valid = 1
 380         byte_sel : std_ulogic_vector(7 downto 0);
 381     end record;
 382
 383     type DcacheToLoadstore1Type is record
 384         valid : std_ulogic;
 385         data : std_ulogic_vector(63 downto 0);
 386         store_done : std_ulogic;
 387         error : std_ulogic;
 388         cache_paradox : std_ulogic;
 389     end record;
 390
 391     type Loadstore1ToMmuType is record
 392         valid : std_ulogic;
 393         tlbie : std_ulogic;
 394         slbia : std_ulogic;
 395         mtspr : std_ulogic;
 396         iside : std_ulogic;
 397         load  : std_ulogic;
 398         priv  : std_ulogic;
 399         sprn  : std_ulogic_vector(9 downto 0);
 400         addr  : std_ulogic_vector(63 downto 0);
 401         rs    : std_ulogic_vector(63 downto 0);
 402     end record;
 403
 404     type MmuToLoadstore1Type is record
 405         done       : std_ulogic;
 406         err        : std_ulogic;
 407         invalid    : std_ulogic;
 408         badtree    : std_ulogic;
 409         segerr     : std_ulogic;
 410         perm_error : std_ulogic;
 411         rc_error   : std_ulogic;
 412         sprval     : std_ulogic_vector(63 downto 0);
 413     end record;
 414
 415     type MmuToDcacheType is record
 416         valid : std_ulogic;
 417         tlbie : std_ulogic;
 418         doall : std_ulogic;
 419         tlbld : std_ulogic;
 420         addr  : std_ulogic_vector(63 downto 0);
 421         pte   : std_ulogic_vector(63 downto 0);
 422     end record;
 423
 424     type DcacheToMmuType is record
 425         stall : std_ulogic;
 426         done  : std_ulogic;
 427         err   : std_ulogic;
 428         data  : std_ulogic_vector(63 downto 0);
 429     end record;
 430
 431     type MmuToIcacheType is record
 432         tlbld : std_ulogic;
 433         tlbie : std_ulogic;
 434         doall : std_ulogic;
 435         addr  : std_ulogic_vector(63 downto 0);
 436         pte   : std_ulogic_vector(63 downto 0);
 437     end record;
 438
 439     type Loadstore1ToWritebackType is record
 440         valid : std_ulogic;
 441         write_enable: std_ulogic;
 442         write_reg : gspr_index_t;
 443         write_data : std_ulogic_vector(63 downto 0);
 444         xerc : xer_common_t;
 445         rc : std_ulogic;
 446         store_done : std_ulogic;
 447     end record;
 448     constant Loadstore1ToWritebackInit : Loadstore1ToWritebackType := (valid => '0', write_enable => '0', xerc => xerc_init,
 449                                                                        rc => '0', store_done => '0', write_data => (others => '0'), others => (others => '0'));
 450
 451     type Execute1ToWritebackType is record
 452         valid: std_ulogic;
 453         rc : std_ulogic;
 454         mode_32bit : std_ulogic;
 455         write_enable : std_ulogic;
 456         write_reg: gspr_index_t;
 457         write_data: std_ulogic_vector(63 downto 0);
 458         write_cr_enable : std_ulogic;
 459         write_cr_mask : std_ulogic_vector(7 downto 0);
 460         write_cr_data : std_ulogic_vector(31 downto 0);
 461         write_xerc_enable : std_ulogic;
 462         xerc : xer_common_t;
 463         exc_write_enable : std_ulogic;
 464         exc_write_reg : gspr_index_t;
 465         exc_write_data : std_ulogic_vector(63 downto 0);
 466     end record;
 467     constant Execute1ToWritebackInit : Execute1ToWritebackType := (valid => '0', rc => '0', mode_32bit => '0', write_enable => '0',
 468                                                                    write_cr_enable => '0', exc_write_enable => '0',
 469                                                                    write_xerc_enable => '0', xerc => xerc_init,
 470                                    write_data => (others => '0'), write_cr_mask => (others => '0'),
 471                                    write_cr_data => (others => '0'), write_reg => (others => '0'),
 472                                    exc_write_reg => (others => '0'), exc_write_data => (others => '0'));
 473
 474     type Execute1ToFPUType is record
 475         valid   : std_ulogic;
 476         op      : insn_type_t;
 477         nia     : std_ulogic_vector(63 downto 0);
 478         insn    : std_ulogic_vector(31 downto 0);
 479         single  : std_ulogic;
 480         fe_mode : std_ulogic_vector(1 downto 0);
 481         fra     : std_ulogic_vector(63 downto 0);
 482         frb     : std_ulogic_vector(63 downto 0);
 483         frc     : std_ulogic_vector(63 downto 0);
 484         frt     : gspr_index_t;
 485         rc      : std_ulogic;
 486         out_cr  : std_ulogic;
 487     end record;
 488     constant Execute1ToFPUInit : Execute1ToFPUType := (valid => '0', op => OP_ILLEGAL, nia => (others => '0'),
 489                                                        insn  => (others => '0'), fe_mode => "00", rc => '0',
 490                                                        fra => (others => '0'), frb => (others => '0'),
 491                                                        frc => (others => '0'), frt => (others => '0'),
 492                                                        single => '0', out_cr => '0');
 493
 494     type FPUToExecute1Type is record
 495         busy      : std_ulogic;
 496         exception : std_ulogic;
 497         interrupt : std_ulogic;
 498         illegal   : std_ulogic;
 499     end record;
 500     constant FPUToExecute1Init : FPUToExecute1Type := (others => '0');
 501
 502     type FPUToWritebackType is record
 503         valid           : std_ulogic;
 504         write_enable    : std_ulogic;
 505         write_reg       : gspr_index_t;
 506         write_data      : std_ulogic_vector(63 downto 0);
 507         write_cr_enable : std_ulogic;
 508         write_cr_mask   : std_ulogic_vector(7 downto 0);
 509         write_cr_data   : std_ulogic_vector(31 downto 0);
 510     end record;
 511     constant FPUToWritebackInit : FPUToWritebackType :=  (valid => '0', write_enable => '0', write_cr_enable => '0', others => (others => '0'));
 512
 513     type DividerToExecute1Type is record
 514         valid: std_ulogic;
 515         write_reg_data: std_ulogic_vector(63 downto 0);
 516         overflow : std_ulogic;
 517     end record;
 518     constant DividerToExecute1Init : DividerToExecute1Type := (valid => '0', overflow => '0',
 519                                                                others => (others => '0'));
 520
 521     type WritebackToRegisterFileType is record
 522         write_reg : gspr_index_t;
 523         write_data : std_ulogic_vector(63 downto 0);
 524         write_enable : std_ulogic;
 525     end record;
 526     constant WritebackToRegisterFileInit : WritebackToRegisterFileType := (write_enable => '0', write_data => (others => '0'), others => (others => '0'));
 527
 528     type WritebackToCrFileType is record
 529         write_cr_enable : std_ulogic;
 530         write_cr_mask : std_ulogic_vector(7 downto 0);
 531         write_cr_data : std_ulogic_vector(31 downto 0);
 532         write_xerc_enable : std_ulogic;
 533         write_xerc_data : xer_common_t;
 534     end record;
 535     constant WritebackToCrFileInit : WritebackToCrFileType := (write_cr_enable => '0', write_xerc_enable => '0',
 536                                                                write_xerc_data => xerc_init,
 537                                                                write_cr_mask => (others => '0'),
 538                                                                write_cr_data => (others => '0'));
 539
 540 end common;
 541
 542 package body common is
 543     function decode_spr_num(insn: std_ulogic_vector(31 downto 0)) return spr_num_t is
 544     begin
 545         return to_integer(unsigned(insn(15 downto 11) & insn(20 downto 16)));
 546     end;
 547     function fast_spr_num(spr: spr_num_t) return gspr_index_t is
 548        variable n : integer range 0 to 31;
 549        -- tmp variable introduced as workaround for VCS compilation
 550        -- simulation was failing with subtype constraint mismatch error
 551        -- see GitHub PR #173
 552        variable tmp : std_ulogic_vector(4 downto 0);
 553     begin
 554        case spr is
 555        when SPR_LR =>
 556            n := 0;
 557        when SPR_CTR =>
 558            n:= 1;
 559        when SPR_SRR0 =>
 560            n := 2;
 561        when SPR_SRR1 =>
 562            n := 3;
 563        when SPR_HSRR0 =>
 564            n := 4;
 565        when SPR_HSRR1 =>
 566            n := 5;
 567        when SPR_SPRG0 =>
 568            n := 6;
 569        when SPR_SPRG1 =>
 570            n := 7;
 571        when SPR_SPRG2 =>
 572            n := 8;
 573        when SPR_SPRG3 | SPR_SPRG3U =>
 574            n := 9;
 575        when SPR_HSPRG0 =>
 576            n := 10;
 577        when SPR_HSPRG1 =>
 578            n := 11;
 579        when SPR_XER =>
 580            n := 12;
 581        when SPR_TAR =>
 582            n := 13;
 583        when others =>
 584            n := 0;
 585            return "0000000";
 586        end case;
 587        tmp := std_ulogic_vector(to_unsigned(n, 5));
 588        return "01" & tmp;
 589     end;
 590
 591     function gspr_to_gpr(i: gspr_index_t) return gpr_index_t is
 592     begin
 593         return i(4 downto 0);
 594     end;
 595
 596     function gpr_to_gspr(i: gpr_index_t) return gspr_index_t is
 597     begin
 598         return "00" & i;
 599     end;
 600
 601     function gpr_or_spr_to_gspr(g: gpr_index_t; s: gspr_index_t) return gspr_index_t is
 602     begin
 603         if s(5) = '1' then
 604             return s;
 605         else
 606             return gpr_to_gspr(g);
 607         end if;
 608     end;
 609
 610     function is_fast_spr(s: gspr_index_t) return std_ulogic is
 611     begin
 612         return s(5);
 613     end;
 614
 615     function fpr_to_gspr(f: fpr_index_t) return gspr_index_t is
 616     begin
 617         return "10" & f;
 618     end;
 619 end common;