Subversion Repositories riscv_vhdl

/**

 * @file

 * @copyright  Copyright 2016 GNSS Sensor Ltd. All right reserved.

 * @author     Sergey Khabarov - sergeykhbr@gmail.com

 * @brief      CPU pipeline implementation.

 */

#ifndef __DEBUGGER_RIVERLIB_PROC_H__

#define __DEBUGGER_RIVERLIB_PROC_H__

#include <systemc.h>

#include "../river_cfg.h"

#include "fetch.h"

#include "decoder.h"

#include "execute.h"

#include "memaccess.h"

#include "execute.h"

#include "regibank.h"

#include "csr.h"

#include "br_predic.h"

#include "dbg_port.h"

#include <fstream>

namespace debugger {

SC_MODULE(Processor) {

    sc_in<bool> i_clk;                                  // CPU clock

    sc_in<bool> i_nrst;                                 // Reset. Active LOW

    // Control path:

    sc_in<bool> i_req_ctrl_ready;                       // ICache is ready to accept request

    sc_out<bool> o_req_ctrl_valid;                      // Request to ICache is valid

    sc_out<sc_uint<BUS_ADDR_WIDTH>> o_req_ctrl_addr;    // Requesting address to ICache

    sc_in<bool> i_resp_ctrl_valid;                      // ICache response is valid

    sc_in<sc_uint<BUS_ADDR_WIDTH>> i_resp_ctrl_addr;    // Response address must be equal to the latest request address

    sc_in<sc_uint<32>> i_resp_ctrl_data;                // Read value

    sc_out<bool> o_resp_ctrl_ready;                     // Core is ready to accept response from ICache

    // Data path:

    sc_in<bool> i_req_data_ready;                       // DCache is ready to accept request

    sc_out<bool> o_req_data_valid;                      // Request to DCache is valid

    sc_out<bool> o_req_data_write;                      // Read/Write transaction

    sc_out<sc_uint<2>> o_req_data_size;                 // Size [Bytes]: 0=1B; 1=2B; 2=4B; 3=8B

    sc_out<sc_uint<BUS_ADDR_WIDTH>> o_req_data_addr;    // Requesting address to DCache

    sc_out<sc_uint<RISCV_ARCH>> o_req_data_data;        // Writing value

    sc_in<bool> i_resp_data_valid;                      // DCache response is valid

    sc_in<sc_uint<BUS_ADDR_WIDTH>> i_resp_data_addr;    // DCache response address must be equal to the latest request address

    sc_in<sc_uint<RISCV_ARCH>> i_resp_data_data;        // Read value

    sc_out<bool> o_resp_data_ready;                     // Core is ready to accept response from DCache

    // External interrupt pin

    sc_in<bool> i_ext_irq;                              // PLIC interrupt accordingly with spec

    sc_out<sc_uint<64>> o_time;                         // Clock/Step counter depending attribute "GenerateRef"

    // Debug interface

    sc_in<bool> i_dport_valid;                          // Debug access from DSU is valid

    sc_in<bool> i_dport_write;                          // Write command flag

    sc_in<sc_uint<2>> i_dport_region;                   // Registers region ID: 0=CSR; 1=IREGS; 2=Control

    sc_in<sc_uint<12>> i_dport_addr;                    // Register idx

    sc_in<sc_uint<RISCV_ARCH>> i_dport_wdata;           // Write value

    sc_out<bool> o_dport_ready;                         // Response is ready

    sc_out<sc_uint<RISCV_ARCH>> o_dport_rdata;          // Response value

    // Cache debug signals:

    sc_in<sc_uint<2>> i_istate;                         // ICache transaction state

    sc_in<sc_uint<2>> i_dstate;                         // DCache transaction state

    sc_in<sc_uint<2>> i_cstate;                         // CacheTop state machine value

    void comb();

    void negedge_dbg_print();

    void generateRef(bool v);

    void generateVCD(sc_trace_file *i_vcd, sc_trace_file *o_vcd);

    SC_HAS_PROCESS(Processor);

    Processor(sc_module_name name_);

    virtual ~Processor();

private:

    struct FetchType {

        sc_signal<bool> req_fire;

        sc_signal<bool> valid;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> pc;

        sc_signal<sc_uint<32>> instr;

        sc_signal<bool> imem_req_valid;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> imem_req_addr;

        sc_signal<bool> predict_miss;

        sc_signal<bool> pipeline_hold;

        sc_signal<sc_biguint<DBG_FETCH_TRACE_SIZE*64>> instr_buf;

    };

    struct InstructionDecodeType {

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> pc;

        sc_signal<sc_uint<32>> instr;

        sc_signal<bool> instr_valid;

        sc_signal<bool> memop_store;

        sc_signal<bool> memop_load;

        sc_signal<bool> memop_sign_ext;

        sc_signal<sc_uint<2>> memop_size;

        sc_signal<bool> rv32;                       // 32-bits instruction

        sc_signal<bool> unsigned_op;                // Unsigned operands

        sc_signal<sc_bv<ISA_Total>> isa_type;

        sc_signal<sc_bv<Instr_Total>> instr_vec;

        sc_signal<bool> exception;

    };

    struct ExecuteType {

        sc_signal<bool> valid;

        sc_signal<sc_uint<32>> instr;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> pc;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> npc;

        sc_signal<sc_uint<5>> radr1;

        sc_signal<sc_uint<5>> radr2;

        sc_signal<sc_uint<5>> res_addr;

        sc_signal<sc_uint<RISCV_ARCH>> res_data;

        sc_signal<bool> trap_ena;                    // Trap pulse

        sc_signal<sc_uint<5>> trap_code;             // bit[4] : 1=interrupt; 0=exception; bits[3:0]=code

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> trap_pc;  // trap on pc

        sc_signal<bool> xret;

        sc_signal<sc_uint<12>> csr_addr;

        sc_signal<bool> csr_wena;

        sc_signal<sc_uint<RISCV_ARCH>> csr_wdata;

        sc_signal<bool> memop_sign_ext;

        sc_signal<bool> memop_load;

        sc_signal<bool> memop_store;

        sc_signal<sc_uint<2>> memop_size;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> memop_addr;

        sc_signal<bool> pipeline_hold;           // Hold pipeline from Execution stage

        sc_signal<bool> breakpoint;

        sc_signal<bool> call;                       // pseudo-instruction CALL

        sc_signal<bool> ret;                        // pseudo-instruction RET

    };

    struct MemoryType {

        sc_signal<bool> valid;

        sc_signal<sc_uint<32>> instr;

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> pc;

        sc_signal<bool> pipeline_hold;

    };

    struct WriteBackType {

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> pc;

        sc_signal<bool> wena;

        sc_signal<sc_uint<5>> waddr;

        sc_signal<sc_uint<RISCV_ARCH>> wdata;

    };

    struct IntRegsType {

        sc_signal<sc_uint<RISCV_ARCH>> rdata1;

        sc_signal<sc_uint<RISCV_ARCH>> rdata2;

        sc_signal<sc_uint<RISCV_ARCH>> dport_rdata;

        sc_signal<sc_uint<RISCV_ARCH>> ra;      // Return address

    } ireg;

    struct CsrType {

        sc_signal<sc_uint<RISCV_ARCH>> rdata;

        sc_signal<sc_uint<RISCV_ARCH>> dport_rdata;

        sc_signal<bool> ie;                     // Interrupt enable bit

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> mtvec;// Interrupt descriptor table

        sc_signal<sc_uint<2>> mode;             // Current processor mode

    } csr;

    struct DebugType {

        sc_signal<sc_uint<12>> core_addr;           // Address of the sub-region register

        sc_signal<sc_uint<RISCV_ARCH>> core_wdata;  // Write data

        sc_signal<bool> csr_ena;                    // Region 0: Access to CSR bank is enabled.

        sc_signal<bool> csr_write;                  // Region 0: CSR write enable

        sc_signal<bool> ireg_ena;                   // Region 1: Access to integer register bank is enabled

        sc_signal<bool> ireg_write;                 // Region 1: Integer registers bank write pulse

        sc_signal<bool> npc_write;                  // Region 1: npc write enable

        sc_signal<bool> halt;                       // Halt signal is equal to hold pipeline

        sc_signal<sc_uint<64>> clock_cnt;           // Number of clocks excluding halt state

        sc_signal<sc_uint<64>> executed_cnt;        // Number of executed instruction

        sc_signal<bool> break_mode;                          // Behaviour on EBREAK instruction: 0 = halt; 1 = generate trap

        sc_signal<bool> br_fetch_valid;                      // Fetch injection address/instr are valid

        sc_signal<sc_uint<BUS_ADDR_WIDTH>> br_address_fetch; // Fetch injection address to skip ebreak instruciton only once

        sc_signal<sc_uint<32>> br_instr_fetch;               // Real instruction value that was replaced by ebreak

    } dbg;

    /** 5-stages CPU pipeline */

    struct PipelineType {

        FetchType f;                            // Fetch instruction stage

        InstructionDecodeType d;                // Decode instruction stage

        ExecuteType e;                          // Execute instruction

        MemoryType m;                           // Memory load/store

        WriteBackType w;                        // Write back registers value

    } w;

    sc_signal<sc_uint<BUS_ADDR_WIDTH>> wb_npc_predict;

    sc_signal<sc_uint<5>> wb_ireg_dport_addr;

    sc_signal<sc_uint<BUS_ADDR_WIDTH>> wb_exec_dport_npc;

    sc_signal<bool> w_fetch_pipeline_hold;

    sc_signal<bool> w_any_pipeline_hold;

    sc_signal<bool> w_exec_pipeline_hold;

    InstrFetch *fetch0;

    InstrDecoder *dec0;

    InstrExecute *exec0;

    MemAccess *mem0;

    BranchPredictor *predic0;

    RegIntBank *iregs0;

    CsrRegs *csr0;

    DbgPort *dbg0;

    /** Used only for reference trace generation to compare with

        functional model */

    bool generate_ref_;

    char tstr[1024];

    ofstream *reg_dbg;

    ofstream *mem_dbg;

    bool mem_dbg_write_flag;

    uint64_t dbg_mem_value_mask;

    uint64_t dbg_mem_write_value;

};

}  // namespace debugger

#endif  // __DEBUGGER_RIVERLIB_PROC_H__