Subversion Repositories zipcpu

////////////////////////////////////////////////////////////////////////////////

//

// Filename:    idecode.v

//

// Project:     Zip CPU -- a small, lightweight, RISC CPU soft core

//

// Purpose:     This RTL file specifies how instructions are to be decoded

//              into their underlying meanings.  This is specifically a version

//      designed to support a "Next Generation", or "Version 2" instruction

//      set as (currently) activated by the OPT_NEW_INSTRUCTION_SET option

//      in cpudefs.v.

//

//      I expect to (eventually) retire the old instruction set, at which point

//      this will become the default instruction set decoder.

//

//

// Creator:     Dan Gisselquist, Ph.D.

//              Gisselquist Technology, LLC

//

////////////////////////////////////////////////////////////////////////////////

//

// Copyright (C) 2015-2019, Gisselquist Technology, LLC

//

// This program is free software (firmware): you can redistribute it and/or

// modify it under the terms of  the GNU General Public License as published

// by the Free Software Foundation, either version 3 of the License, or (at

// your option) any later version.

//

// This program is distributed in the hope that it will be useful, but WITHOUT

// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or

// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

// for more details.

//

// You should have received a copy of the GNU General Public License along

// with this program.  (It's in the $(ROOT)/doc directory.  Run make with no

// target there if the PDF file isn't present.)  If not, see

// <http://www.gnu.org/licenses/> for a copy.

//

// License:     GPL, v3, as defined and found on www.gnu.org,

//              http://www.gnu.org/licenses/gpl.html

//

//

////////////////////////////////////////////////////////////////////////////////

//

//

`default_nettype        none

//

`define CPU_SP_REG      4'hd

`define CPU_CC_REG      4'he

`define CPU_PC_REG      4'hf

//

`define CISBIT          31

`define CISIMMSEL       23

`define IMMSEL          18

//

//

//

module  idecode(i_clk, i_reset, i_ce, i_stalled,

                i_instruction, i_gie, i_pc, i_pf_valid,

                        i_illegal,

                o_valid,

                o_phase, o_illegal,

                o_pc,

                o_dcdR, o_dcdA, o_dcdB,

                o_preA, o_preB,

                o_I, o_zI,

                o_cond, o_wF,

                o_op, o_ALU, o_M, o_DV, o_FP, o_break, o_lock,

                o_wR, o_rA, o_rB,

                o_early_branch, o_early_branch_stb, o_branch_pc, o_ljmp,

                o_pipe,

                o_sim, o_sim_immv

`ifdef  FORMAL

                , f_insn_word, f_insn_gie

`endif

                );

        parameter               ADDRESS_WIDTH=24;

        parameter       [0:0]     OPT_MPY = 1'b1;

        parameter       [0:0]     OPT_EARLY_BRANCHING = 1'b1;

        parameter       [0:0]     OPT_PIPELINED = 1'b1;

        parameter       [0:0]     OPT_DIVIDE = (OPT_PIPELINED);

        parameter       [0:0]     OPT_FPU    = 1'b0;

        parameter       [0:0]     OPT_CIS    = 1'b1;

        parameter       [0:0]     OPT_LOCK   = (OPT_PIPELINED);

        parameter       [0:0]     OPT_OPIPE  = (OPT_PIPELINED);

        parameter       [0:0]     OPT_SIM    = 1'b0;

        parameter       [0:0]     OPT_NO_USERMODE = 1'b0;

        localparam              AW = ADDRESS_WIDTH;

        //

        input   wire            i_clk, i_reset, i_ce, i_stalled;

        input   wire [31:0]      i_instruction;

        input   wire            i_gie;

        input   wire [(AW+1):0]  i_pc;

        input   wire            i_pf_valid, i_illegal;

        output  wire            o_valid, o_phase;

        output  reg             o_illegal;

        output  reg     [(AW+1):0]       o_pc;

        output  reg     [6:0]    o_dcdR, o_dcdA, o_dcdB;

        output  wire    [4:0]    o_preA, o_preB;

        output  wire    [31:0]   o_I;

        output  reg             o_zI;

        output  reg     [3:0]    o_cond;

        output  reg             o_wF;

        output  reg     [3:0]    o_op;

        output  reg             o_ALU, o_M, o_DV, o_FP, o_break;

        output  reg             o_lock;

        output  reg             o_wR, o_rA, o_rB;

        output  wire            o_early_branch, o_early_branch_stb;

        output  wire    [(AW+1):0]       o_branch_pc;

        output  wire            o_ljmp;

        output  wire            o_pipe;

        output  reg             o_sim           /* verilator public_flat */;

        output  reg     [22:0]   o_sim_immv      /* verilator public_flat */;

`ifdef  FORMAL

        output  reg     [31:0]   f_insn_word;

        output  reg             f_insn_gie;

`endif

        wire    [4:0]    w_op;

        wire            w_ldi, w_mov, w_cmptst, w_ldilo, w_ALU, w_brev,

                        w_noop, w_lock, w_sim, w_break, w_special, w_add,

                        w_mpy;

        wire    [4:0]    w_dcdR, w_dcdB, w_dcdA;

        wire            w_dcdR_pc, w_dcdR_cc;

        wire            w_dcdA_pc, w_dcdA_cc;

        wire            w_dcdB_pc, w_dcdB_cc;

        wire    [3:0]    w_cond;

        wire            w_wF, w_mem, w_sto, w_div, w_fpu;

        wire            w_wR, w_rA, w_rB, w_wR_n;

        wire            w_ljmp, w_ljmp_dly, w_cis_ljmp;

        wire    [31:0]   iword;

        wire            pf_valid;

        assign  pf_valid = (i_pf_valid)&&(!o_early_branch_stb);

        reg     [14:0]   r_nxt_half;

        generate if (OPT_CIS)

        begin : SET_IWORD

                assign  iword = (o_phase)

                                // set second half as a NOOP ... but really

                                // shouldn't matter

                        ? { 1'b1, r_nxt_half[14:0], i_instruction[15:0] }

                        : i_instruction;

        end else begin : CLR_IWORD

                assign  iword = { 1'b0, i_instruction[30:0] };

                // verilator lint_off UNUSED

                wire    [14:0]   unused_nxt_half;

                assign          unused_nxt_half = r_nxt_half;

                // verilator lint_on  UNUSED

        end endgenerate

        generate

        if (OPT_EARLY_BRANCHING)

        begin

                if (OPT_CIS)

                begin : CIS_EARLY_BRANCHING

                        assign  w_cis_ljmp = (o_phase)&&(iword[31:16] == 16'hfcf8);

                end else begin : NOCIS_EARLY_BRANCH

                        assign  w_cis_ljmp = 1'b0;

                end

                assign  w_ljmp = (iword == 32'h7c87c000);

        end else begin : NO_EARLY_BRANCHING

                assign  w_cis_ljmp = 1'b0;

                assign  w_ljmp = 1'b0;

        end endgenerate

        reg     [4:0]    w_cis_op;

        generate if (OPT_CIS)

        begin : GEN_CIS_OP

                always @(*)

                if (!iword[`CISBIT])

                        w_cis_op = iword[26:22];

                else case(iword[26:24])

                3'h0: w_cis_op = 5'h00; // ADD

                3'h1: w_cis_op = 5'h01; // AND

                3'h2: w_cis_op = 5'h02; // SUB

                3'h3: w_cis_op = 5'h10; // BREV

                3'h4: w_cis_op = 5'h12; // LW

                3'h5: w_cis_op = 5'h13; // SW

                3'h6: w_cis_op = 5'h18; // LDI

                3'h7: w_cis_op = 5'h0d; // MOV

                endcase

        end else begin : GEN_NOCIS_OP

                always @(*)

                        w_cis_op = w_op;

        end endgenerate

        // Decode instructions

        assign  w_op= iword[26:22];

        assign  w_mov    = (w_cis_op      == 5'h0d);

        assign  w_ldi    = (w_cis_op[4:1] == 4'hc);

        assign  w_brev   = (w_cis_op      == 5'h08);

        assign  w_mpy    = (w_cis_op[4:1] == 4'h5)||(w_cis_op[4:0]==5'h0c);

        assign  w_cmptst = (w_cis_op[4:1] == 4'h8);

        assign  w_ldilo  = (w_cis_op[4:0] == 5'h09);

        assign  w_ALU    = (!w_cis_op[4]) // anything with [4]==0, but ...

                                &&(w_cis_op[3:1] != 3'h7); // not the divide

        assign  w_add    = (w_cis_op[4:0] == 5'h02);

        assign  w_mem    = (w_cis_op[4:3] == 2'b10)&&(w_cis_op[2:1] !=2'b00);

        assign  w_sto    = (w_mem)&&( w_cis_op[0]);

        assign  w_div    = (!iword[`CISBIT])&&(w_op[4:1] == 4'h7);

        assign  w_fpu    = (!iword[`CISBIT])&&(w_op[4:3] == 2'b11)

                                &&(w_dcdR[3:1] != 3'h7)&&(w_op[2:1] != 2'b00);

        // If the result register is either CC or PC, and this would otherwise

        // be a floating point instruction with floating point opcode of 0,

        // then this is a NOOP.

        assign  w_special= (!iword[`CISBIT])&&((!OPT_FPU)||(w_dcdR[3:1]==3'h7))

                        &&(w_op[4:2] == 3'b111);

        assign  w_break = (w_special)&&(w_op[4:0]==5'h1c);

        assign  w_lock  = (w_special)&&(w_op[4:0]==5'h1d);

        assign  w_sim   = (w_special)&&(w_op[4:0]==5'h1e);

        assign  w_noop  = (w_special)&&(w_op[4:0]==5'h1f);

        // w_dcdR (4 LUTs)

        //

        // What register will we be placing results into (if at all)?

        //

        // Two parts to the result register: the register set, given for

        // moves in iword[18] but only for the supervisor, and the other

        // four bits encoded in the instruction.

        //

        assign  w_dcdR = { ((!iword[`CISBIT])&&(!OPT_NO_USERMODE)&&(w_mov)&&(!i_gie))?iword[`IMMSEL]:i_gie,

                                iword[30:27] };

        // dcdB - What register is used in the opB?

        //

        assign w_dcdB[4] = ((!iword[`CISBIT])&&(w_mov)&&(!OPT_NO_USERMODE)&&(!i_gie))?iword[13]:i_gie;

        assign w_dcdB[3:0]= (iword[`CISBIT])

                                ? (((!iword[`CISIMMSEL])&&(iword[26:25]==2'b10))

                                        ? `CPU_SP_REG : iword[22:19])

                                : iword[17:14];

        // 0 LUTs

        assign  w_dcdA = w_dcdR;        // on ZipCPU, A is always result reg

        // 2 LUTs, 1 delay each

        assign  w_dcdR_pc = (w_dcdR == {i_gie, `CPU_PC_REG});

        assign  w_dcdR_cc = (w_dcdR == {i_gie, `CPU_CC_REG});

        // 0 LUTs

        assign  w_dcdA_pc = w_dcdR_pc;

        assign  w_dcdA_cc = w_dcdR_cc;

        // 2 LUTs, 1 delays each

        assign  w_dcdB_pc = (w_rB)&&(w_dcdB[3:0] == `CPU_PC_REG);

        assign  w_dcdB_cc = (w_rB)&&(w_dcdB[3:0] == `CPU_CC_REG);

        //

        // Under what condition will we execute this instruction?  Only the

        // load immediate instruction and the CIS instructions are completely

        // unconditional.  Well ... not quite.  The BREAK, LOCK, and SIM/NOOP

        // instructions are also unconditional.

        //

        assign  w_cond = ((w_ldi)||(w_special)||(iword[`CISBIT])) ? 4'h8 :

                        { (iword[21:19]==3'h0), iword[21:19] };

        // rA - do we need to read register A?

        assign  w_rA = // Floating point reads reg A

                        ((w_fpu)&&(OPT_FPU))

                        // Divide's read A

                        ||(w_div)

                        // ALU ops read A,

                        //      except for MOV's and BREV's which don't

                        ||((w_ALU)&&(!w_brev)&&(!w_mov))

                        // STO's read A

                        ||(w_sto)

                        // Test/compares

                        ||(w_cmptst);

        // rB -- do we read a register for operand B?  Specifically, do we

        // add the registers value to the immediate to create opB?

        assign  w_rB     = (w_mov)

                                ||((!iword[`CISBIT])&&(iword[`IMMSEL])&&(!w_ldi)&&(!w_special))

                                ||(( iword[`CISBIT])&&(iword[`CISIMMSEL])&&(!w_ldi))

                                // If using compressed instruction sets,

                                // we *always* read on memory operands.

                                ||(( iword[`CISBIT])&&(w_mem));

        // wR -- will we be writing our result back?

        // wR_n = !wR

        // All but STO, NOOP/BREAK/LOCK, and CMP/TST write back to w_dcdR

        assign  w_wR_n   = (w_sto)

                                ||(w_special)

                                ||(w_cmptst);

        assign  w_wR     = !w_wR_n;

        //

        // wF -- do we write flags when we are done?

        //

        assign  w_wF     = (w_cmptst)

                        ||((w_cond[3])&&(((w_fpu)&&(OPT_FPU))||(w_div)

                                ||((w_ALU)&&(!w_mov)&&(!w_ldilo)&&(!w_brev)

                                        &&(w_dcdR[3:1] != 3'h7))));

        // Bottom 13 bits: no LUT's

        // w_dcd[12: 0] -- no LUTs

        // w_dcd[   13] -- 2 LUTs

        // w_dcd[17:14] -- (5+i0+i1) = 3 LUTs, 1 delay

        // w_dcd[22:18] : 5 LUTs, 1 delay (assuming high bit is o/w determined)

        reg     [22:0]   r_I;

        wire    [22:0]   w_I, w_fullI;

        wire            w_Iz;

        assign  w_fullI = (w_ldi) ? { iword[22:0] } // LDI

                        // MOVE immediates have one less bit

                        :((w_mov) ?{ {(23-13){iword[12]}}, iword[12:0] }

                        // Normal Op-B immediate ... 18 or 14 bits

                        :((!iword[`IMMSEL]) ? { {(23-18){iword[17]}}, iword[17:0] }

                        : { {(23-14){iword[13]}}, iword[13:0] }

                        ));

        generate if (OPT_CIS)

        begin : GEN_CIS_IMMEDIATE

                wire    [7:0]    w_halfbits;

                assign  w_halfbits = iword[`CISIMMSEL:16];

                wire    [7:0]    w_halfI;

                assign  w_halfI = (iword[26:24]==3'h6) ? w_halfbits[7:0] // 8'b for LDI

                                :(w_halfbits[7])?

                                        { {(6){w_halfbits[2]}}, w_halfbits[1:0]}

                                        :{ w_halfbits[6], w_halfbits[6:0] };

                assign  w_I  = (iword[`CISBIT])

                                ? {{(23-8){w_halfI[7]}}, w_halfI }

                                : w_fullI;

        end else begin : GEN_NOCIS_IMMEDIATE

                assign  w_I  = w_fullI;

        end endgenerate

        assign  w_Iz = (w_I == 0);

        //

        // The o_phase parameter is special.  It needs to let the software

        // following know that it cannot break/interrupt on an o_phase asserted

        // instruction, lest the break take place between the first and second

        // half of a CIS instruction.  To do this, o_phase must be asserted

        // when the first instruction half is valid, but not asserted on either

        // a 32-bit instruction or the second half of a 2x16-bit instruction.

        generate if (OPT_CIS)

        begin : GEN_CIS_PHASE

                reg     r_phase;

                // Phase is '1' on the first instruction of a two-part set

                // But, due to the delay in processing, it's '1' when our

                // output is valid for that first part, but that'll be the

                // same time we are processing the second part ... so it may

                // look to us like a '1' on the second half of processing.

                // When no instruction is in the pipe, phase is zero

                initial r_phase = 1'b0;

                always @(posedge i_clk)

                if ((i_reset)||(w_ljmp_dly))

                        r_phase <= 1'b0;

                else if ((i_ce)&&(pf_valid))

                begin

                        if (o_phase)

                                // CIS instructions only have two parts.  On

                                // the second part (o_phase is true), return

                                // back to the first

                                r_phase <= 0;

                        else

                                r_phase <= (i_instruction[`CISBIT])&&(!i_illegal);

                end else if (i_ce)

                        r_phase <= 1'b0;

                assign  o_phase = r_phase;

        end else begin

                assign  o_phase = 1'b0;

        end endgenerate

        initial o_illegal = 1'b0;

        always @(posedge i_clk)

        if (i_ce)

        begin

                if (OPT_PIPELINED)

                        o_illegal <= ((i_illegal)

                                        &&((!o_phase)||(!o_valid)))

                                ||((o_illegal)&&(o_phase)&&(o_valid));

                else

                        o_illegal <= (i_illegal)&&(!o_phase);

                if ((!OPT_CIS)&&(i_instruction[`CISBIT]))

                        o_illegal <= 1'b1;

                if ((!OPT_MPY)&&(w_mpy))

                        o_illegal <= 1'b1;

                if ((!OPT_DIVIDE)&&(w_div))

                        o_illegal <= 1'b1;

                else if ((OPT_DIVIDE)&&(w_div)&&(w_dcdR[3:1]==3'h7))

                        o_illegal <= 1'b1;

                if ((!OPT_FPU)&&(w_fpu))

                        o_illegal <= 1'b1;

                if ((!OPT_SIM)&&(w_sim))

                // Simulation instructions on real hardware should

                // always cause an illegal instruction error

                        o_illegal <= 1'b1;

                // There are two (missing) special instructions

                // These should cause an illegal instruction error

                if ((w_dcdR[3:1]==3'h7)&&(w_cis_op[4:1]==4'b1101))

                        o_illegal <= 1'b1;

                // If the lock function isn't implemented, this should

                // also cause an illegal instruction error

                if ((!OPT_LOCK)&&(w_lock))

                        o_illegal <= 1'b1;

        end

        initial o_pc = 0;

        always @(posedge i_clk)

        if ((i_ce)&&((o_phase)||(i_pf_valid)))

        begin

                o_pc[0] <= 1'b0;

                if (OPT_CIS)

                begin

                        if (iword[`CISBIT])

                        begin

                                if (o_phase)

                                        o_pc[AW+1:1] <= o_pc[AW+1:1] + 1'b1;

                                else

                                        o_pc <= { i_pc[AW+1:2], 1'b1, 1'b0 };

                        end else begin

                                // The normal, non-CIS case

                                o_pc <= { i_pc[AW+1:2] + 1'b1, 2'b00 };

                        end

                end else begin

                        // The normal, non-CIS case

                        o_pc <= { i_pc[AW+1:2] + 1'b1, 2'b00 };

                end

        end

        initial o_dcdR = 0;

        initial o_dcdA = 0;

        initial o_dcdB = 0;

        initial o_DV   = 0;

        initial o_FP   = 0;

        initial o_lock = 0;

        always @(posedge i_clk)

        if (i_ce)

        begin

                // Under what condition will we execute this

                // instruction?  Only the load immediate instruction

                // is completely unconditional.

                o_cond <= w_cond;

                // Don't change the flags on conditional instructions,

                // UNLESS: the conditional instruction was a CMP

                // or TST instruction.

                o_wF <= w_wF;

                // Record what operation/op-code (4-bits) we are doing

                //      Note that LDI magically becomes a MOV

                //      instruction here.  That way it's a pass through

                //      the ALU.  Likewise, the two compare instructions

                //      CMP and TST becomes SUB and AND here as well.

                // We keep only the bottom four bits, since we've

                // already done the rest of the decode necessary to

                // settle between the other instructions.  For example,

                // o_FP plus these four bits uniquely defines the FP

                // instruction, o_DV plus the bottom of these defines

                // the divide, etc.

                o_op <= w_cis_op[3:0];

                if ((w_ldi)||(w_noop)||(w_lock))

                        o_op <= 4'hd;

                // Default values

                o_dcdR <= { w_dcdR_cc, w_dcdR_pc, w_dcdR};

                o_dcdA <= { w_dcdA_cc, w_dcdA_pc, w_dcdA};

                o_dcdB <= { w_dcdB_cc, w_dcdB_pc, w_dcdB};

                o_wR  <= w_wR;

                o_rA  <= w_rA;

                o_rB  <= w_rB;

                r_I    <= w_I;

                o_zI   <= w_Iz;

                // Turn a NOOP into an ALU operation--subtract in

                // particular, although it doesn't really matter as long

                // as it doesn't take longer than one clock.  Note

                // also that this depends upon not setting any registers

                // or flags, which should already be true.

                o_ALU  <=  (w_ALU)||(w_ldi)||(w_cmptst)||(w_noop)

                                ||((!OPT_LOCK)&&(w_lock));

                o_M    <=  w_mem;

                o_DV   <=  (OPT_DIVIDE)&&(w_div);

                o_FP   <=  (OPT_FPU)&&(w_fpu);

                o_break <= w_break;

                o_lock  <= (OPT_LOCK)&&(w_lock);

                if (OPT_CIS)

                        r_nxt_half <= { iword[14:0] };

                else

                        r_nxt_half <= 0;

                if (OPT_SIM)

                begin

                        // Support the SIM instruction(s)

                        o_sim <= (w_sim)||(w_noop);

                        o_sim_immv <= iword[22:0];

                end else begin

                        o_sim <= 1'b0;

                        o_sim_immv <= 0;

                end

        end

        assign  o_preA = w_dcdA;

        assign  o_preB = w_dcdB;

        generate if (OPT_EARLY_BRANCHING)

        begin : GEN_EARLY_BRANCH_LOGIC

                reg                     r_early_branch,

                                        r_early_branch_stb,

                                        r_ljmp;

                reg     [(AW+1):0]       r_branch_pc;

                initial r_ljmp = 1'b0;

                always @(posedge i_clk)

                if (i_reset)

                        r_ljmp <= 1'b0;

                else if (i_ce)

                begin

                        if ((r_ljmp)&&(pf_valid))

                                r_ljmp <= 1'b0;

                        else if (o_early_branch_stb)

                                r_ljmp <= 1'b0;

                        else if (pf_valid)

                        begin

                                if ((OPT_CIS)&&(iword[`CISBIT]))

                                        r_ljmp <= w_cis_ljmp;

                                else

                                        r_ljmp <= (w_ljmp);

                        end else if ((OPT_CIS)&&(o_phase)&&(iword[`CISBIT]))

                                r_ljmp <= w_cis_ljmp;

                end

                assign  o_ljmp = r_ljmp;

                initial r_early_branch     = 1'b0;

                initial r_early_branch_stb = 1'b0;

                always @(posedge i_clk)

                if (i_reset)

                begin

                        r_early_branch     <= 1'b0;

                        r_early_branch_stb <= 1'b0;

                end else if ((i_ce)&&(pf_valid))

                begin

                        if (r_ljmp)

                        begin