Subversion Repositories zipcpu

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

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

//

//

// Filename:    zipcpu.v

// Filename:    zipcpu.v

//

//

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

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

//

//

// Purpose:     This is the top level module holding the core of the Zip CPU

// Purpose:     This is the top level module holding the core of the Zip CPU

//              together.  The Zip CPU is designed to be as simple as possible.

//              together.  The Zip CPU is designed to be as simple as possible.

//      (actual implementation aside ...)  The instruction set is about as

//      (actual implementation aside ...)  The instruction set is about as

//      RISC as you can get, there are only 16 instruction types supported.

//      RISC as you can get, there are only 16 instruction types supported.

//      Please see the accompanying spec.pdf file for a description of these

//      Please see the accompanying spec.pdf file for a description of these

//      instructions.

//      instructions.

//

//

//      All instructions are 32-bits wide.  All bus accesses, both address and

//      All instructions are 32-bits wide.  All bus accesses, both address and

//      data, are 32-bits over a wishbone bus.

//      data, are 32-bits over a wishbone bus.

//

//

//      The Zip CPU is fully pipelined with the following pipeline stages:

//      The Zip CPU is fully pipelined with the following pipeline stages:

//

//

//              1. Prefetch, returns the instruction from memory. 

//              1. Prefetch, returns the instruction from memory. 

//

//

//              2. Instruction Decode

//              2. Instruction Decode

//

//

//              3. Read Operands

//              3. Read Operands

//

//

//              4. Apply Instruction

//              4. Apply Instruction

//

//

//              4. Write-back Results

//              4. Write-back Results

//

//

//      Further information about the inner workings of this CPU may be

//      Further information about the inner workings of this CPU may be

//      found in the spec.pdf file.  (The documentation within this file

//      found in the spec.pdf file.  (The documentation within this file

//      had become out of date and out of sync with the spec.pdf, so look

//      had become out of date and out of sync with the spec.pdf, so look

//      to the spec.pdf for accurate and up to date information.)

//      to the spec.pdf for accurate and up to date information.)

//

//

//

//

//      In general, the pipelining is controlled by three pieces of logic

//      In general, the pipelining is controlled by three pieces of logic

//      per stage: _ce, _stall, and _valid.  _valid means that the stage

//      per stage: _ce, _stall, and _valid.  _valid means that the stage

//      holds a valid instruction.  _ce means that the instruction from the

//      holds a valid instruction.  _ce means that the instruction from the

//      previous stage is to move into this one, and _stall means that the

//      previous stage is to move into this one, and _stall means that the

//      instruction from the previous stage may not move into this one.

//      instruction from the previous stage may not move into this one.

//      The difference between these control signals allows individual stages

//      The difference between these control signals allows individual stages

//      to propagate instructions independently.  In general, the logic works

//      to propagate instructions independently.  In general, the logic works

//      as:

//      as:

//

//

//

//

//      assign  (n)_ce = (n-1)_valid && (~(n)_stall)

//      assign  (n)_ce = (n-1)_valid && (~(n)_stall)

//

//

//

//

//      always @(posedge i_clk)

//      always @(posedge i_clk)

//              if ((i_rst)||(clear_pipeline))

//              if ((i_rst)||(clear_pipeline))

//                      (n)_valid = 0

//                      (n)_valid = 0

//              else if (n)_ce

//              else if (n)_ce

//                      (n)_valid = 1

//                      (n)_valid = 1

//              else if (n+1)_ce

//              else if (n+1)_ce

//                      (n)_valid = 0

//                      (n)_valid = 0

//

//

//      assign (n)_stall = (  (n-1)_valid && ( pipeline hazard detection )  )

//      assign (n)_stall = (  (n-1)_valid && ( pipeline hazard detection )  )

//                      || (  (n)_valid && (n+1)_stall );

//                      || (  (n)_valid && (n+1)_stall );

//

//

//      and ...

//      and ...

//

//

//      always @(posedge i_clk)

//      always @(posedge i_clk)

//              if (n)_ce

//              if (n)_ce

//                      (n)_variable = ... whatever logic for this stage

//                      (n)_variable = ... whatever logic for this stage

//

//

//      Note that a stage can stall even if no instruction is loaded into

//      Note that a stage can stall even if no instruction is loaded into

//      it.

//      it.

//

//

//

//

// Creator:     Dan Gisselquist, Ph.D.

// Creator:     Dan Gisselquist, Ph.D.

//              Gisselquist Technology, LLC

//              Gisselquist Technology, LLC

//

//

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

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

//

//

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

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

//

//

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

// 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

// 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

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

// your option) any later version.

// your option) any later version.

//

//

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

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

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

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

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

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

// for more details.

// for more details.

//

//

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

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

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

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

//

//

//

//

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

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

//

//

// We can either pipeline our fetches, or issue one fetch at a time.  Pipelined

// We can either pipeline our fetches, or issue one fetch at a time.  Pipelined

// fetches are more complicated and therefore use more FPGA resources, while

// fetches are more complicated and therefore use more FPGA resources, while

// single fetches will cause the CPU to stall for about 5 stalls each 

// single fetches will cause the CPU to stall for about 5 stalls each 

// instruction cycle, effectively reducing the instruction count per clock to

// instruction cycle, effectively reducing the instruction count per clock to

// about 0.2.  However, the area cost may be worth it.  Consider:

// about 0.2.  However, the area cost may be worth it.  Consider:

//

//

//      Slice LUTs              ZipSystem       ZipCPU

//      Slice LUTs              ZipSystem       ZipCPU

//      Single Fetching         2521            1734

//      Single Fetching         2521            1734

//      Pipelined fetching      2796            2046

//      Pipelined fetching      2796            2046

//

//

//

//

//

//

`define CPU_CC_REG      4'he

`define CPU_CC_REG      4'he

`define CPU_PC_REG      4'hf

`define CPU_PC_REG      4'hf

`define CPU_FPUERR_BIT  12      // Floating point error flag, set on error

`define CPU_FPUERR_BIT  12      // Floating point error flag, set on error

`define CPU_DIVERR_BIT  11      // Divide error flag, set on divide by zero

`define CPU_DIVERR_BIT  11      // Divide error flag, set on divide by zero

`define CPU_BUSERR_BIT  10      // Bus error flag, set on error

`define CPU_BUSERR_BIT  10      // Bus error flag, set on error

`define CPU_TRAP_BIT    9       // User TRAP has taken place

`define CPU_TRAP_BIT    9       // User TRAP has taken place

`define CPU_ILL_BIT     8       // Illegal instruction

`define CPU_ILL_BIT     8       // Illegal instruction

`define CPU_BREAK_BIT   7

`define CPU_BREAK_BIT   7

`define CPU_STEP_BIT    6       // Will step one or two (VLIW) instructions

`define CPU_STEP_BIT    6       // Will step one or two (VLIW) instructions

`define CPU_GIE_BIT     5

`define CPU_GIE_BIT     5

`define CPU_SLEEP_BIT   4

`define CPU_SLEEP_BIT   4

// Compile time defines

// Compile time defines

//

//

`include "cpudefs.v"

`include "cpudefs.v"

//

//

//

//

module  zipcpu(i_clk, i_rst, i_interrupt,

module  zipcpu(i_clk, i_rst, i_interrupt,

                // Debug interface

                // Debug interface

                i_halt, i_clear_pf_cache, i_dbg_reg, i_dbg_we, i_dbg_data,

                i_halt, i_clear_pf_cache, i_dbg_reg, i_dbg_we, i_dbg_data,

                        o_dbg_stall, o_dbg_reg, o_dbg_cc,

                        o_dbg_stall, o_dbg_reg, o_dbg_cc,

                        o_break,

                        o_break,

                // CPU interface to the wishbone bus

                // CPU interface to the wishbone bus

                o_wb_gbl_cyc, o_wb_gbl_stb,

                o_wb_gbl_cyc, o_wb_gbl_stb,

                        o_wb_lcl_cyc, o_wb_lcl_stb,

                        o_wb_lcl_cyc, o_wb_lcl_stb,

                        o_wb_we, o_wb_addr, o_wb_data,

                        o_wb_we, o_wb_addr, o_wb_data,

                        i_wb_ack, i_wb_stall, i_wb_data,

                        i_wb_ack, i_wb_stall, i_wb_data,

                        i_wb_err,

                        i_wb_err,

                // Accounting/CPU usage interface

                // Accounting/CPU usage interface

                o_op_stall, o_pf_stall, o_i_count

                o_op_stall, o_pf_stall, o_i_count

`ifdef  DEBUG_SCOPE

`ifdef  DEBUG_SCOPE

                , o_debug

                , o_debug

`endif

`endif

                );

                );

        parameter       RESET_ADDRESS=32'h0100000, ADDRESS_WIDTH=24,

        parameter       RESET_ADDRESS=32'h0100000, ADDRESS_WIDTH=24,

                        LGICACHE=6;

                        LGICACHE=6;

`ifdef  OPT_MULTIPLY

`ifdef  OPT_MULTIPLY

        parameter       IMPLEMENT_MPY = 1;

        parameter       IMPLEMENT_MPY = 1;

`else

`else

        parameter       IMPLEMENT_MPY = 0;

        parameter       IMPLEMENT_MPY = 0;

`endif

`endif

                        IMPLEMENT_LOCK=1;

                        IMPLEMENT_LOCK=1;

`ifdef  OPT_EARLY_BRANCHING

`ifdef  OPT_EARLY_BRANCHING

        parameter       EARLY_BRANCHING = 1;

        parameter       EARLY_BRANCHING = 1;

`else

`else

        parameter       EARLY_BRANCHING = 0;

        parameter       EARLY_BRANCHING = 0;

`endif

`endif

        parameter       AW=ADDRESS_WIDTH;

        parameter       AW=ADDRESS_WIDTH;

        input                   i_clk, i_rst, i_interrupt;

        input                   i_clk, i_rst, i_interrupt;

        // Debug interface -- inputs

        // Debug interface -- inputs

        input                   i_halt, i_clear_pf_cache;

        input                   i_halt, i_clear_pf_cache;

        input           [4:0]    i_dbg_reg;

        input           [4:0]    i_dbg_reg;

        input                   i_dbg_we;

        input                   i_dbg_we;

        input           [31:0]   i_dbg_data;

        input           [31:0]   i_dbg_data;

        // Debug interface -- outputs

        // Debug interface -- outputs

        output  reg             o_dbg_stall;

        output  reg             o_dbg_stall;

        output  reg     [31:0]   o_dbg_reg;

        output  reg     [31:0]   o_dbg_reg;

        output  reg     [3:0]    o_dbg_cc;

        output  reg     [3:0]    o_dbg_cc;

        output  wire            o_break;

        output  wire            o_break;

        // Wishbone interface -- outputs

        // Wishbone interface -- outputs

        output  wire            o_wb_gbl_cyc, o_wb_gbl_stb;

        output  wire            o_wb_gbl_cyc, o_wb_gbl_stb;

        output  wire            o_wb_lcl_cyc, o_wb_lcl_stb, o_wb_we;

        output  wire            o_wb_lcl_cyc, o_wb_lcl_stb, o_wb_we;

        output  wire    [(AW-1):0]       o_wb_addr;

        output  wire    [(AW-1):0]       o_wb_addr;

        output  wire    [31:0]   o_wb_data;

        output  wire    [31:0]   o_wb_data;

        // Wishbone interface -- inputs

        // Wishbone interface -- inputs

        input                   i_wb_ack, i_wb_stall;

        input                   i_wb_ack, i_wb_stall;

        input           [31:0]   i_wb_data;

        input           [31:0]   i_wb_data;

        input                   i_wb_err;

        input                   i_wb_err;

        // Accounting outputs ... to help us count stalls and usage

        // Accounting outputs ... to help us count stalls and usage

        output  wire            o_op_stall;

        output  wire            o_op_stall;

        output  wire            o_pf_stall;

        output  wire            o_pf_stall;

        output  wire            o_i_count;

        output  wire            o_i_count;

        //

        //

`ifdef  DEBUG_SCOPE

`ifdef  DEBUG_SCOPE

        output  reg     [31:0]   o_debug;

        output  reg     [31:0]   o_debug;

`endif

`endif

        // Registers

        // Registers

        //

        //

        //      The distributed RAM style comment is necessary on the

        //      The distributed RAM style comment is necessary on the

        // SPARTAN6 with XST to prevent XST from oversimplifying the register

        // SPARTAN6 with XST to prevent XST from oversimplifying the register

        // set and in the process ruining everything else.  It basically

        // set and in the process ruining everything else.  It basically

        // optimizes logic away, to where it no longer works.  The logic

        // optimizes logic away, to where it no longer works.  The logic

        // as described herein will work, this just makes sure XST implements

        // as described herein will work, this just makes sure XST implements

        // that logic.

        // that logic.

        //

        //

        (* ram_style = "distributed" *)

        (* ram_style = "distributed" *)

        reg     [31:0]   regset [0:31];

        reg     [31:0]   regset [0:31];

        // Condition codes

        // Condition codes

        // (BUS, TRAP,ILL,BREAKEN,STEP,GIE,SLEEP ), V, N, C, Z

        // (BUS, TRAP,ILL,BREAKEN,STEP,GIE,SLEEP ), V, N, C, Z

        reg     [3:0]    flags, iflags;

        reg     [3:0]    flags, iflags;

        wire    [12:0]   w_uflags, w_iflags;

        wire    [12:0]   w_uflags, w_iflags;

        reg             trap, break_en, step, gie, sleep;

        reg             trap, break_en, step, gie, sleep;

`ifdef  OPT_ILLEGAL_INSTRUCTION

`ifdef  OPT_ILLEGAL_INSTRUCTION

        reg             ill_err_u, ill_err_i;

        reg             ill_err_u, ill_err_i;

`else

`else

        wire            ill_err_u, ill_err_i;

        wire            ill_err_u, ill_err_i;

`endif

`endif

        reg             ibus_err_flag, ubus_err_flag;

        reg             ibus_err_flag, ubus_err_flag;

        wire            idiv_err_flag, udiv_err_flag;

        wire            idiv_err_flag, udiv_err_flag;

        wire            ifpu_err_flag, ufpu_err_flag;

        wire            ifpu_err_flag, ufpu_err_flag;

        wire            ihalt_phase, uhalt_phase;

        wire            ihalt_phase, uhalt_phase;

        // The master chip enable

        // The master chip enable

        wire            master_ce;

        wire            master_ce;

        //

        //

        //

        //

        //      PIPELINE STAGE #1 :: Prefetch

        //      PIPELINE STAGE #1 :: Prefetch

        //              Variable declarations

        //              Variable declarations

        //

        //

        reg     [(AW-1):0]       pf_pc;

        reg     [(AW-1):0]       pf_pc;

        reg     new_pc;

        reg     new_pc;

        wire    clear_pipeline;

        wire    clear_pipeline;

        assign  clear_pipeline = new_pc || i_clear_pf_cache;

        assign  clear_pipeline = new_pc || i_clear_pf_cache;

        wire            dcd_stalled;

        wire            dcd_stalled;

        wire            pf_cyc, pf_stb, pf_we, pf_busy, pf_ack, pf_stall, pf_err;

        wire            pf_cyc, pf_stb, pf_we, pf_busy, pf_ack, pf_stall, pf_err;

        wire    [(AW-1):0]       pf_addr;

        wire    [(AW-1):0]       pf_addr;

        wire    [31:0]           pf_data;

        wire    [31:0]           pf_data;

        wire    [31:0]           instruction;

        wire    [31:0]           instruction;

        wire    [(AW-1):0]       instruction_pc;

        wire    [(AW-1):0]       instruction_pc;

        wire    pf_valid, instruction_gie, pf_illegal;

        wire    pf_valid, instruction_gie, pf_illegal;

        //

        //

        //

        //

        //      PIPELINE STAGE #2 :: Instruction Decode

        //      PIPELINE STAGE #2 :: Instruction Decode

        //              Variable declarations

        //              Variable declarations

        //

        //

        //

        //

        reg             opvalid, opvalid_mem, opvalid_alu, op_wr_pc;

        reg             opvalid, opvalid_mem, opvalid_alu, op_wr_pc;

        reg             opvalid_div, opvalid_fpu;

        reg             opvalid_div, opvalid_fpu;

        wire            op_stall, dcd_ce, dcd_phase;

        wire            op_stall, dcd_ce, dcd_phase;

        wire    [3:0]    dcdOp;

        wire    [3:0]    dcdOp;

        wire    [4:0]    dcdA, dcdB, dcdR;

        wire    [4:0]    dcdA, dcdB, dcdR;

        wire            dcdA_cc, dcdB_cc, dcdA_pc, dcdB_pc, dcdR_cc, dcdR_pc;

        wire            dcdA_cc, dcdB_cc, dcdA_pc, dcdB_pc, dcdR_cc, dcdR_pc;

        wire    [3:0]    dcdF;

        wire    [3:0]    dcdF;

        wire            dcdR_wr, dcdA_rd, dcdB_rd,

        wire            dcdR_wr, dcdA_rd, dcdB_rd,

                                dcdALU, dcdM, dcdDV, dcdFP,

                                dcdALU, dcdM, dcdDV, dcdFP,

        reg             r_dcdvalid;

        reg             r_dcdvalid;

        wire            dcdvalid;

        wire            dcdvalid;

        wire    [(AW-1):0]       dcd_pc;

        wire    [(AW-1):0]       dcd_pc;

        wire    [31:0]   dcdI;

        wire    [31:0]   dcdI;

        wire            dcd_zI; // true if dcdI == 0

        wire            dcd_zI; // true if dcdI == 0

        wire    dcdA_stall, dcdB_stall, dcdF_stall;

        wire    dcdA_stall, dcdB_stall, dcdF_stall;

        wire    dcd_illegal;

        wire    dcd_illegal;

        wire                    dcd_early_branch;

        wire                    dcd_early_branch;

        wire    [(AW-1):0]       dcd_branch_pc;

        wire    [(AW-1):0]       dcd_branch_pc;

        //

        //

        //

        //

        //      PIPELINE STAGE #3 :: Read Operands

        //      PIPELINE STAGE #3 :: Read Operands

        //              Variable declarations

        //              Variable declarations

        //

        //

        //

        //

        //

        //

        // Now, let's read our operands

        // Now, let's read our operands

        reg     [4:0]    alu_reg;

        reg     [4:0]    alu_reg;

        reg     [3:0]    opn;

        reg     [3:0]    opn;

        reg     [4:0]    opR;

        reg     [4:0]    opR;

        reg     [31:0]   r_opA, r_opB;

        reg     [31:0]   r_opA, r_opB;

        reg     [(AW-1):0]       op_pc;

        reg     [(AW-1):0]       op_pc;

        wire    [31:0]   w_opA, w_opB;

        wire    [31:0]   w_opA, w_opB;

        wire    [31:0]   opA_nowait, opB_nowait, opA, opB;

        wire    [31:0]   opA_nowait, opB_nowait, opA, opB;

        reg             opR_wr, opR_cc, opF_wr, op_gie;

        reg             opR_wr, opR_cc, opF_wr, op_gie;

        wire    [12:0]   opFl;

        wire    [12:0]   opFl;

        reg     [5:0]    r_opF;

        reg     [5:0]    r_opF;

        wire    [7:0]    opF;

        wire    [7:0]    opF;

        reg     [2:0]    opF_cp;

        reg     [2:0]    opF_cp;

        wire            op_ce, op_phase;

        wire            op_ce, op_phase;

        // Some pipeline control wires

        // Some pipeline control wires

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        reg     opA_alu, opA_mem;

        reg     opA_alu, opA_mem;

        reg     opB_alu, opB_mem;

        reg     opB_alu, opB_mem;

`endif

`endif

`ifdef  OPT_ILLEGAL_INSTRUCTION

`ifdef  OPT_ILLEGAL_INSTRUCTION

        reg     op_illegal;

        reg     op_illegal;

`endif

`endif

        reg     op_break;

        reg     op_break;

        wire    op_lock;

        wire    op_lock;

        //

        //

        //

        //

        //      PIPELINE STAGE #4 :: ALU / Memory

        //      PIPELINE STAGE #4 :: ALU / Memory

        //              Variable declarations

        //              Variable declarations

        //

        //

        //

        //

        reg     [(AW-1):0]       alu_pc;

        reg     [(AW-1):0]       alu_pc;

        reg             alu_pc_valid;

        reg             alu_pc_valid;

        wire            alu_phase;

        wire            alu_phase;

        wire            alu_ce, alu_stall;

        wire            alu_ce, alu_stall;

        wire    [31:0]   alu_result;

        wire    [31:0]   alu_result;

        wire    [3:0]    alu_flags;

        wire    [3:0]    alu_flags;

        wire            set_cond;

        wire            set_cond;

        reg             alu_wr, alF_wr, alu_gie;

        reg             alu_wr, alF_wr, alu_gie;

        wire            alu_illegal_op;

        wire            alu_illegal_op;

        wire            alu_illegal;

        wire            alu_illegal;

        wire    mem_ce, mem_stalled;

        wire    mem_ce, mem_stalled;

`ifdef  OPT_PIPELINED_BUS_ACCESS

`ifdef  OPT_PIPELINED_BUS_ACCESS

        wire    mem_pipe_stalled;

        wire    mem_pipe_stalled;

`endif

`endif

        wire    mem_valid, mem_ack, mem_stall, mem_err, bus_err,

        wire    mem_valid, mem_ack, mem_stall, mem_err, bus_err,

                mem_cyc_gbl, mem_cyc_lcl, mem_stb_gbl, mem_stb_lcl, mem_we;

                mem_cyc_gbl, mem_cyc_lcl, mem_stb_gbl, mem_stb_lcl, mem_we;

        wire    [4:0]            mem_wreg;

        wire    [4:0]            mem_wreg;

        wire                    mem_busy, mem_rdbusy;

        wire                    mem_busy, mem_rdbusy;

        wire    [(AW-1):0]       mem_addr;

        wire    [(AW-1):0]       mem_addr;

        wire    [31:0]           mem_data, mem_result;

        wire    [31:0]           mem_data, mem_result;

        wire    div_ce, div_error, div_busy, div_valid;

        wire    div_ce, div_error, div_busy, div_valid;

        wire    [31:0]   div_result;

        wire    [31:0]   div_result;

        wire    [3:0]    div_flags;

        wire    [3:0]    div_flags;

        assign  div_ce = (master_ce)&&(~clear_pipeline)&&(opvalid_div)

        assign  div_ce = (master_ce)&&(~clear_pipeline)&&(opvalid_div)

                                &&(~mem_rdbusy)&&(~div_busy)&&(~fpu_busy)

                                &&(~mem_rdbusy)&&(~div_busy)&&(~fpu_busy)

                                &&(set_cond);

                                &&(set_cond);

        wire    fpu_ce, fpu_error, fpu_busy, fpu_valid;

        wire    fpu_ce, fpu_error, fpu_busy, fpu_valid;

        wire    [31:0]   fpu_result;

        wire    [31:0]   fpu_result;

        wire    [3:0]    fpu_flags;

        wire    [3:0]    fpu_flags;

        assign  fpu_ce = (master_ce)&&(~clear_pipeline)&&(opvalid_fpu)

        assign  fpu_ce = (master_ce)&&(~clear_pipeline)&&(opvalid_fpu)

                                &&(~mem_rdbusy)&&(~div_busy)&&(~fpu_busy)

                                &&(~mem_rdbusy)&&(~div_busy)&&(~fpu_busy)

                                &&(set_cond);

                                &&(set_cond);

        //

        //

        //

        //

        //      PIPELINE STAGE #5 :: Write-back

        //      PIPELINE STAGE #5 :: Write-back

        //              Variable declarations

        //              Variable declarations

        //

        //

        wire            wr_reg_ce, wr_flags_ce, wr_write_pc, wr_write_cc;

        wire            wr_reg_ce, wr_flags_ce, wr_write_pc, wr_write_cc;

        wire    [4:0]    wr_reg_id;

        wire    [4:0]    wr_reg_id;

        wire    [31:0]   wr_reg_vl;

        wire    [31:0]   wr_reg_vl;

        wire    w_switch_to_interrupt, w_release_from_interrupt;

        wire    w_switch_to_interrupt, w_release_from_interrupt;

        reg     [(AW-1):0]       upc, ipc;

        reg     [(AW-1):0]       upc, ipc;

        //

        //

        //      MASTER: clock enable.

        //      MASTER: clock enable.

        //

        //

        assign  master_ce = (~i_halt)&&(~o_break)&&(~sleep);

        assign  master_ce = (~i_halt)&&(~o_break)&&(~sleep);

        //

        //

        //      PIPELINE STAGE #1 :: Prefetch

        //      PIPELINE STAGE #1 :: Prefetch

        //              Calculate stall conditions

        //              Calculate stall conditions

        //

        //

        //      These are calculated externally, within the prefetch module.

        //      These are calculated externally, within the prefetch module.

        //

        //

        //

        //

        //      PIPELINE STAGE #2 :: Instruction Decode

        //      PIPELINE STAGE #2 :: Instruction Decode

        //              Calculate stall conditions

        //              Calculate stall conditions

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        assign          dcd_ce = ((~dcdvalid)||(~dcd_stalled))&&(~clear_pipeline);

        assign          dcd_ce = ((~dcdvalid)||(~dcd_stalled))&&(~clear_pipeline);

`else

`else

        assign          dcd_ce = 1'b1;

        assign          dcd_ce = 1'b1;

`endif

`endif

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        assign          dcd_stalled = (dcdvalid)&&(op_stall);

        assign          dcd_stalled = (dcdvalid)&&(op_stall);

`else

`else

        // If not pipelined, there will be no opvalid_ anything, and the

        // If not pipelined, there will be no opvalid_ anything, and the

        // op_stall will be false, dcdX_stall will be false, thus we can simply

        // op_stall will be false, dcdX_stall will be false, thus we can simply

        // do a ...

        // do a ...

        assign          dcd_stalled = 1'b0;

        assign          dcd_stalled = 1'b0;

`endif

`endif

        //

        //

        //      PIPELINE STAGE #3 :: Read Operands

        //      PIPELINE STAGE #3 :: Read Operands

        //              Calculate stall conditions

        //              Calculate stall conditions

        wire    op_lock_stall;

        wire    op_lock_stall;

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        assign  op_stall = (opvalid)&&( // Only stall if we're loaded w/validins

        assign  op_stall = (opvalid)&&( // Only stall if we're loaded w/validins

                        // Stall if we're stopped, and not allowed to execute

                        // Stall if we're stopped, and not allowed to execute

                        // an instruction

                        // an instruction

                        // (~master_ce)         // Already captured in alu_stall

                        // (~master_ce)         // Already captured in alu_stall

                        //

                        //

                        // Stall if going into the ALU and the ALU is stalled

                        // Stall if going into the ALU and the ALU is stalled

                        //      i.e. if the memory is busy, or we are single

                        //      i.e. if the memory is busy, or we are single

                        //      stepping.  This also includes our stalls for

                        //      stepping.  This also includes our stalls for

                        //      op_break and op_lock, so we don't need to

                        //      op_break and op_lock, so we don't need to

                        //      include those as well here.

                        //      include those as well here.

                        ((opvalid)&&(alu_stall))

                        ((opvalid)&&(alu_stall))

                        // Stall if the divide is busy, since we can't have

                        // Stall if the divide is busy, since we can't have

                        // two parallel stages writing back at the same time

                        // two parallel stages writing back at the same time

                        ||(div_busy)

                        ||(div_busy)

                        // Same for the floating point unit

                        // Same for the floating point unit

                        ||(fpu_busy)

                        ||(fpu_busy)

                        //

                        //

                        // ||((opvalid_alu)&&(mem_rdbusy)) // part of alu_stall

                        // ||((opvalid_alu)&&(mem_rdbusy)) // part of alu_stall

                        // Stall if we are going into memory with an operation

                        // Stall if we are going into memory with an operation

                        //      that cannot be pipelined, and the memory is

                        //      that cannot be pipelined, and the memory is

                        //      already busy

                        //      already busy

                        ||((opvalid_mem)&&(mem_stalled))

                        ||((opvalid_mem)&&(mem_stalled))

                        )

                        )

                        ||(dcdvalid)&&(

                        ||(dcdvalid)&&(

                                // to be ready to read

                                // to be ready to read

                                // Likewise for B, also includes logic

                                // Likewise for B, also includes logic

                                // regarding immediate offset (register must

                                // regarding immediate offset (register must

                                // be in register file if we need to add to

                                // be in register file if we need to add to

                                // an immediate)

                                // an immediate)

                                ||(dcdB_stall)

                                ||(dcdB_stall)

                                // Or if we need to wait on flags to work on the

                                // Or if we need to wait on flags to work on the

                                // CC register

                                // CC register

                                ||(dcdF_stall)

                                ||(dcdF_stall)

                        );

                        );

`else

`else

        assign  op_stall = (opvalid)&&(~master_ce);

        assign  op_stall = (opvalid)&&(~master_ce);

`endif

`endif

        //

        //

        //      PIPELINE STAGE #4 :: ALU / Memory

        //      PIPELINE STAGE #4 :: ALU / Memory

        //              Calculate stall conditions

        //              Calculate stall conditions

        //

        //

        // 1. Basic stall is if the previous stage is valid and the next is

        // 1. Basic stall is if the previous stage is valid and the next is

        //      busy.  

        //      busy.  

        // 2. Also stall if the prior stage is valid and the master clock enable

        // 2. Also stall if the prior stage is valid and the master clock enable

        //      is de-selected

        //      is de-selected

        // 3. Stall if someone on the other end is writing the CC register,

        // 3. Stall if someone on the other end is writing the CC register,

        //      since we don't know if it'll put us to sleep or not.

        //      since we don't know if it'll put us to sleep or not.

        // 4. Last case: Stall if we would otherwise move a break instruction

        // 4. Last case: Stall if we would otherwise move a break instruction

        //      through the ALU.  Break instructions are not allowed through

        //      through the ALU.  Break instructions are not allowed through

        //      the ALU.

        //      the ALU.

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

                        // Old case #3--this isn't an ALU stall though ...

                        // Old case #3--this isn't an ALU stall though ...

                        ||((opvalid_alu)&&(wr_reg_ce)&&(wr_reg_id[4] == op_gie)

                        ||((opvalid_alu)&&(wr_reg_ce)&&(wr_reg_id[4] == op_gie)

                                &&(wr_write_cc)) // Case 3

                                &&(wr_write_cc)) // Case 3

                        ||((opvalid)&&(op_lock)&&(op_lock_stall))

                        ||((opvalid)&&(op_lock)&&(op_lock_stall))

                        ||((opvalid)&&(op_break))

                        ||((opvalid)&&(op_break))

                        ||(div_busy)||(fpu_busy);

                        ||(div_busy)||(fpu_busy);

                                &&(~alu_stall)

                                &&(~alu_stall)

                                &&(~clear_pipeline);

                                &&(~clear_pipeline);

`else

`else

        assign  alu_stall = ((~master_ce)&&(opvalid_alu))

        assign  alu_stall = ((~master_ce)&&(opvalid_alu))

                                ||((opvalid_alu)&&(op_break));

                                ||((opvalid_alu)&&(op_break));

`endif

`endif

        //

        //

        //

        //

        // Note: if you change the conditions for mem_ce, you must also change

        // Note: if you change the conditions for mem_ce, you must also change

        // alu_pc_valid.

        // alu_pc_valid.

        //

        //

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        assign  mem_ce = (master_ce)&&(opvalid_mem)&&(~mem_stalled)

        assign  mem_ce = (master_ce)&&(opvalid_mem)&&(~mem_stalled)

`else

`else

        // If we aren't pipelined, then no one will be changing what's in the

        // If we aren't pipelined, then no one will be changing what's in the

        // pipeline (i.e. clear_pipeline), while our only instruction goes

        // pipeline (i.e. clear_pipeline), while our only instruction goes

        // through the ... pipeline.

        // through the ... pipeline.

`endif

`endif

`ifdef  OPT_PIPELINED_BUS_ACCESS

`ifdef  OPT_PIPELINED_BUS_ACCESS

                                (mem_pipe_stalled)

                                (mem_pipe_stalled)

                                ||((~op_pipe)&&(mem_busy))

                                ||((~op_pipe)&&(mem_busy))

                                ||(div_busy)

                                ||(div_busy)

                                ||(fpu_busy)

                                ||(fpu_busy)

                                // Stall waiting for flags to be valid

                                // Stall waiting for flags to be valid

                                // Or waiting for a write to the PC register

                                // Or waiting for a write to the PC register

                                // Or CC register, since that can change the

                                // Or CC register, since that can change the

                                //  PC as well

                                //  PC as well

                                ||((wr_reg_ce)&&(wr_reg_id[4] == op_gie)

                                ||((wr_reg_ce)&&(wr_reg_id[4] == op_gie)

                                        &&((wr_write_pc)||(wr_write_cc)))));

                                        &&((wr_write_pc)||(wr_write_cc)))));

`else

`else

`ifdef  OPT_PIPELINED

`ifdef  OPT_PIPELINED

        assign  mem_stalled = (mem_busy)||((opvalid_mem)&&(

        assign  mem_stalled = (mem_busy)||((opvalid_mem)&&(

                                (~master_ce)

                                (~master_ce)

                                // Stall waiting for flags to be valid

                                // Stall waiting for flags to be valid

                                // Or waiting for a write to the PC register

                                // Or waiting for a write to the PC register

                                // Or CC register, since that can change the

                                // Or CC register, since that can change the

                                //  PC as well

                                //  PC as well

                                ||((wr_reg_ce)&&(wr_reg_id[4] == op_gie)&&((wr_write_pc)||(wr_write_cc)))));

                                ||((wr_reg_ce)&&(wr_reg_id[4] == op_gie)&&((wr_write_pc)||(wr_write_cc)))));

`else

`else

        assign  mem_stalled = (opvalid_mem)&&(~master_ce);

        assign  mem_stalled = (opvalid_mem)&&(~master_ce);

`endif

`endif

`endif

`endif

        //

        //

        //

        //

        //      PIPELINE STAGE #1 :: Prefetch

        //      PIPELINE STAGE #1 :: Prefetch

        //

        //

        //

        //

`ifdef  OPT_SINGLE_FETCH

`ifdef  OPT_SINGLE_FETCH

        wire            pf_ce;

        wire            pf_ce;

        assign          pf_ce = (~pf_valid)&&(~dcdvalid)&&(~opvalid)&&(~alu_valid);

        assign          pf_ce = (~pf_valid)&&(~dcdvalid)&&(~opvalid)&&(~alu_valid);

        prefetch        #(ADDRESS_WIDTH)

        prefetch        #(ADDRESS_WIDTH)

                        pf(i_clk, i_rst, (pf_ce), (~dcd_stalled), pf_pc, gie,

                        pf(i_clk, i_rst, (pf_ce), (~dcd_stalled), pf_pc, gie,

                                instruction, instruction_pc, instruction_gie,

                                instruction, instruction_pc, instruction_gie,

                                        pf_valid, pf_illegal,

                                        pf_valid, pf_illegal,