// Copyright © 2019-2023
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

`include "VX_define.vh"

interface VX_pipeline_perf_if ();
    wire [`PERF_CTR_BITS-1:0] sched_idles;
    wire [`PERF_CTR_BITS-1:0] sched_stalls;
    wire [`PERF_CTR_BITS-1:0] sched_barrier_idles;
    wire [`PERF_CTR_BITS-1:0] scalar_sched_ready_cycles;
    wire [`PERF_CTR_BITS-1:0] tensor_sched_ready_cycles;
    wire [`PERF_CTR_BITS-1:0] scalar_sched_issued_cycles;
    wire [`PERF_CTR_BITS-1:0] tensor_sched_issued_cycles;
    wire [`PERF_CTR_BITS-1:0] illegal_tensor_reg_access;
    wire [`PERF_CTR_BITS-1:0] illegal_tensor_scalar_op;
    wire [`PERF_CTR_BITS-1:0] illegal_scalar_tensor_op;
    wire [`PERF_CTR_BITS-1:0] ibf_stalls;
    wire [`PERF_CTR_BITS-1:0] scb_stalls;
    wire [`PERF_CTR_BITS-1:0] scb_any_unit_uses;
    wire [`PERF_CTR_BITS-1:0] scb_fires;
    wire [`PERF_CTR_BITS-1:0] scb_any_fire_cycles;
    wire [`PERF_CTR_BITS-1:0] units_uses [`NUM_EX_UNITS];
    wire [`PERF_CTR_BITS-1:0] sfu_uses [`NUM_SFU_UNITS];
    wire [`PERF_CTR_BITS-1:0] dispatch_stalls [`NUM_EX_UNITS];
    wire [`PERF_CTR_BITS-1:0] dispatch_valids [`NUM_EX_UNITS];
    wire [`PERF_CTR_BITS-1:0] dispatch_fires [`NUM_EX_UNITS];
    wire [`PERF_CTR_BITS-1:0] dispatch_any_fire_cycles;

    wire [`PERF_CTR_BITS-1:0] ifetches;
    wire [`PERF_CTR_BITS-1:0] loads;
    wire [`PERF_CTR_BITS-1:0] stores;    
    wire [`PERF_CTR_BITS-1:0] ifetch_latency;
    wire [`PERF_CTR_BITS-1:0] load_latency;
    wire [`PERF_CTR_BITS-1:0] scalar_lsu_reqs;
    wire [`PERF_CTR_BITS-1:0] tensor_lsu_reqs;
    wire [`PERF_CTR_BITS-1:0] scalar_lsu_stalls;
    wire [`PERF_CTR_BITS-1:0] tensor_lsu_stalls;
    wire [`PERF_CTR_BITS-1:0] mem_merge_stalls;

    modport schedule (
        output sched_idles,
        output sched_barrier_idles,
        output sched_stalls,
        output scalar_sched_ready_cycles,
        output tensor_sched_ready_cycles,
        output scalar_sched_issued_cycles,
        output tensor_sched_issued_cycles
    );

    modport decode (
        output illegal_tensor_reg_access,
        output illegal_tensor_scalar_op,
        output illegal_scalar_tensor_op
    );

    modport issue (
        output ibf_stalls,
        output scb_stalls,
        output scb_any_unit_uses,
        output scb_fires,
        output scb_any_fire_cycles,
        output units_uses,
        output sfu_uses,
        output dispatch_stalls,
        output dispatch_valids,
        output dispatch_fires,
        output dispatch_any_fire_cycles
    );

    modport execute (
        output scalar_lsu_reqs,
        output tensor_lsu_reqs,
        output scalar_lsu_stalls,
        output tensor_lsu_stalls,
        output mem_merge_stalls
    );

    modport slave (
        input sched_idles,
        input sched_barrier_idles,
        input sched_stalls,
        input scalar_sched_ready_cycles,
        input tensor_sched_ready_cycles,
        input scalar_sched_issued_cycles,
        input tensor_sched_issued_cycles,
        input illegal_tensor_reg_access,
        input illegal_tensor_scalar_op,
        input illegal_scalar_tensor_op,
        input ibf_stalls,
        input scb_stalls,
        input scb_any_unit_uses,
        input scb_fires,
        input scb_any_fire_cycles,
        input units_uses,
        input sfu_uses,
        input dispatch_stalls,
        input dispatch_valids,
        input dispatch_fires,
        input dispatch_any_fire_cycles,
        input ifetches,
        input loads,
        input stores,
        input ifetch_latency,
        input load_latency,
        input scalar_lsu_reqs,
        input tensor_lsu_reqs,
        input scalar_lsu_stalls,
        input tensor_lsu_stalls,
        input mem_merge_stalls
    );

endinterface