aboutsummaryrefslogtreecommitdiff
path: root/rv64cpu/rtl/core/privileged/trap_ctrl.sv
blob: 0969fdcdf8e0f942e487e4a84f4147ceb53ef500 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
//     Richard CPU
//     Copyright (C) 2026  Richard Qin

//     This program is free software: 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
//     MERCHANTABILITY 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.  If not, see <https://www.gnu.org/licenses/>.

// File path: rtl/core/trap_ctrl.sv
// Description: Privileged-level Trap Controller (Exception and Interrupt Handling)
//              Detects exceptions/interrupts, triggers context saving, and generates global pipeline flush and PC jump signals

module trap_ctrl 
    import rv64_pkg::*;
    import csr_pkg::*;
(
    // Submission signals from the WB stage (guarantee of precise exceptions)
    input  logic [XLEN-1:0]        wb_pc,
    input  logic                  trap_illegal_instr,
    input  logic                  trap_is_ecall,
    input  logic                  trap_is_ebreak,
    input  logic                  trap_is_mret,
    input  logic                  trap_is_sret,
    input  logic                  trap_instr_access_fault,
    input  logic                  trap_load_fault,
    input  logic                  trap_store_fault,
    input  logic                  trap_instr_page_fault,
    input  logic                  trap_load_page_fault,
    input  logic                  trap_store_page_fault,
    input  logic [XLEN-1:0]       trap_bad_addr,
    input  logic [INST_WIDTH-1:0] trap_bad_instr,

    // Status read from CSR Unit
    input  logic                  csr_mstatus_mie,    // Global interrupt enable (MIE)
    input  logic [XLEN-1:0]       csr_mie,            // Machine interrupt enable CSR
    input  logic [XLEN-1:0]       csr_sie,            // Supervisor interrupt enable CSR view
    input  logic [XLEN-1:0]       csr_mip,            // Machine interrupt pending CSR
    input  logic [XLEN-1:0]       csr_sip,            // Supervisor interrupt pending CSR view
    input  logic [XLEN-1:0]       csr_mstatus,        // Machine status CSR
    input  logic [XLEN-1:0]       csr_mtvec,          // Machine trap vector
    input  logic [XLEN-1:0]       csr_stvec,          // Supervisor trap vector
    input  logic [XLEN-1:0]       csr_mepc,           // Machine exception PC (for MRET)
    input  logic [XLEN-1:0]       csr_sepc,           // Supervisor exception PC (for SRET)
    input  logic [XLEN-1:0]       csr_medeleg,        // Exception delegation mask
    input  logic [XLEN-1:0]       csr_mideleg,        // Interrupt delegation mask
    input  logic [1:0]            csr_priv_mode,      // Current privilege level

    // Status update signal sent to the CSR Unit
    output logic                  trap_trigger,       // Trigger exception/interrupt context save
    output logic [XLEN-1:0]       trap_mepc,          // Saved PC (MEPC/SEPC selected by trap_to_s_mode)
    output logic [XLEN-1:0]       trap_mcause,        // Cause code (bit63 indicates interrupt)
    output logic [XLEN-1:0]       trap_mtval,         // Additional information saved to mtval/stval
    output logic                  trap_to_s_mode,     // 1: delegated to Supervisor mode
    output logic                  mret_en,            // Trigger MRET context restore
    output logic                  sret_en,            // Trigger SRET context restore

    // Control flow interference sent to the Hazard Unit and IF stage
    output logic                  trap_flush_req,     // Global pipeline flush request
    output logic                  trap_pc_sel,        // Forcibly take over PC MUX (0: normal, 1: Trap/Mret/Sret)
    output logic [XLEN-1:0]       trap_next_pc        // Target address for forced jump
);

    typedef enum logic [1:0] {
        PRIV_MODE_U = 2'b00,
        PRIV_MODE_S = 2'b01,
        PRIV_MODE_M = 2'b11
    } priv_mode_t;

    localparam logic [XLEN-1:0] INTERRUPT_BIT = {1'b1, {(XLEN-1){1'b0}}};
    localparam int INTERRUPT_M_SOFTWARE_BIT = int'(INTERRUPT_M_SOFTWARE);
    localparam int INTERRUPT_M_TIMER_BIT    = int'(INTERRUPT_M_TIMER);
    localparam int INTERRUPT_M_EXTERNAL_BIT = int'(INTERRUPT_M_EXTERNAL);
    localparam int INTERRUPT_S_SOFTWARE_BIT = int'(INTERRUPT_S_SOFTWARE);
    localparam int INTERRUPT_S_TIMER_BIT    = int'(INTERRUPT_S_TIMER);
    localparam int INTERRUPT_S_EXTERNAL_BIT = int'(INTERRUPT_S_EXTERNAL);
    localparam int MSTATUS_SIE_BIT = 1;
    localparam int MSTATUS_TSR_BIT = 22;

    logic                 has_sync_exception;
    logic [XLEN-1:0]      sync_cause;
    logic [XLEN-1:0]      sync_mtval;
    logic [XLEN-1:0]      illegal_instr_value;
    logic                 sret_tsr_illegal;

    assign illegal_instr_value = {{(XLEN-INST_WIDTH){1'b0}}, trap_bad_instr};
    assign sret_tsr_illegal    = trap_is_sret &&
                                  (priv_mode_t'(csr_priv_mode) == PRIV_MODE_S) &&
                                  csr_mstatus[MSTATUS_TSR_BIT];

    always_comb begin
        has_sync_exception = 1'b0;
        sync_cause         = '0;
        sync_mtval         = '0;

        if (trap_instr_access_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_INST_FAULT;
            sync_mtval         = trap_bad_addr;
        end else if (trap_instr_page_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_INSTR_PAGE_FAULT;
            sync_mtval         = trap_bad_addr;
        end else if (trap_illegal_instr || sret_tsr_illegal) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_INST_ILLEGAL;
            sync_mtval         = illegal_instr_value;
        end else if (trap_is_ebreak) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_BREAKPOINT;
            sync_mtval         = wb_pc;
        end else if (trap_is_ecall) begin
            has_sync_exception = 1'b1;
            case (priv_mode_t'(csr_priv_mode))
                PRIV_MODE_U: sync_cause = EXC_ECALL_FROM_U;
                PRIV_MODE_S: sync_cause = EXC_ECALL_FROM_S;
                default:     sync_cause = EXC_ECALL_FROM_M;
            endcase
            sync_mtval = '0;
        end else if (trap_load_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_LOAD_FAULT;
            sync_mtval         = trap_bad_addr;
        end else if (trap_store_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_STORE_FAULT;
            sync_mtval         = trap_bad_addr;
        end else if (trap_load_page_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_LOAD_PAGE_FAULT;
            sync_mtval         = trap_bad_addr;
        end else if (trap_store_page_fault) begin
            has_sync_exception = 1'b1;
            sync_cause         = EXC_STORE_PAGE_FAULT;
            sync_mtval         = trap_bad_addr;
        end
    end

    // Interrupt Detection - Asynchronous, gated by mie and privilege global-enable rules.
    logic               has_interrupt;
    logic [XLEN-1:0]    interrupt_cause;
    logic               machine_interrupts_globally_enabled;
    logic               supervisor_interrupts_globally_enabled;
    logic               interrupt_targets_s_mode;

    assign machine_interrupts_globally_enabled = (priv_mode_t'(csr_priv_mode) != PRIV_MODE_M) ||
                                                 csr_mstatus_mie;
    assign supervisor_interrupts_globally_enabled = (priv_mode_t'(csr_priv_mode) == PRIV_MODE_U) ||
                                                    ((priv_mode_t'(csr_priv_mode) == PRIV_MODE_S) &&
                                                     csr_mstatus[MSTATUS_SIE_BIT]);

    function automatic logic interrupt_pending_enabled(
        input logic [XLEN-1:0] pending,
        input logic [XLEN-1:0] enable,
        input int              cause
    );
        interrupt_pending_enabled = pending[cause[5:0]] && enable[cause[5:0]];
    endfunction

    task automatic take_interrupt(
        input  logic [XLEN-1:0] cause,
        input  logic            to_s_mode,
        output logic            taken,
        output logic [XLEN-1:0] taken_cause,
        output logic            taken_targets_s_mode
    );
        taken                = 1'b1;
        taken_cause          = INTERRUPT_BIT | cause;
        taken_targets_s_mode = to_s_mode;
    endtask

    function automatic logic s_interrupt_cause_delegated(input int cause);
        s_interrupt_cause_delegated = csr_mideleg[cause[5:0]];
    endfunction

    function automatic logic s_interrupt_cause_takeable(input int cause);
        if (s_interrupt_cause_delegated(cause)) begin
            s_interrupt_cause_takeable = supervisor_interrupts_globally_enabled &&
                                         interrupt_pending_enabled(csr_sip, csr_sie, cause);
        end else begin
            s_interrupt_cause_takeable = machine_interrupts_globally_enabled &&
                                         interrupt_pending_enabled(csr_mip, csr_mie, cause);
        end
    endfunction

    always_comb begin
        has_interrupt             = 1'b0;
        interrupt_cause           = '0;
        interrupt_targets_s_mode  = 1'b0;

        if (machine_interrupts_globally_enabled &&
            interrupt_pending_enabled(csr_mip, csr_mie, INTERRUPT_M_EXTERNAL_BIT)) begin
            take_interrupt(INTERRUPT_M_EXTERNAL, 1'b0, has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end else if (machine_interrupts_globally_enabled &&
                     interrupt_pending_enabled(csr_mip, csr_mie, INTERRUPT_M_SOFTWARE_BIT)) begin
            take_interrupt(INTERRUPT_M_SOFTWARE, 1'b0, has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end else if (machine_interrupts_globally_enabled &&
                     interrupt_pending_enabled(csr_mip, csr_mie, INTERRUPT_M_TIMER_BIT)) begin
            take_interrupt(INTERRUPT_M_TIMER, 1'b0, has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end else if (s_interrupt_cause_takeable(INTERRUPT_S_EXTERNAL_BIT)) begin
            take_interrupt(INTERRUPT_S_EXTERNAL, s_interrupt_cause_delegated(INTERRUPT_S_EXTERNAL_BIT),
                           has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end else if (s_interrupt_cause_takeable(INTERRUPT_S_SOFTWARE_BIT)) begin
            take_interrupt(INTERRUPT_S_SOFTWARE, s_interrupt_cause_delegated(INTERRUPT_S_SOFTWARE_BIT),
                           has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end else if (s_interrupt_cause_takeable(INTERRUPT_S_TIMER_BIT)) begin
            take_interrupt(INTERRUPT_S_TIMER, s_interrupt_cause_delegated(INTERRUPT_S_TIMER_BIT),
                           has_interrupt, interrupt_cause, interrupt_targets_s_mode);
        end
    end 

    logic [XLEN-1:0] trap_cause_value;
    logic [XLEN-1:0] trap_mtval_value;
    logic            trap_is_interrupt;

    assign trap_is_interrupt = has_interrupt;
    assign trap_cause_value  = has_interrupt ? interrupt_cause : sync_cause;
    assign trap_mtval_value  = has_interrupt ? '0 : sync_mtval;

    assign trap_trigger = has_interrupt | has_sync_exception;

    logic [5:0]      trap_cause_index;
    logic            delegate_to_s;
    logic [XLEN-1:0] deleg_mask;
    logic            machine_interrupt_cause;

    assign trap_cause_index = trap_cause_value[5:0];
    assign deleg_mask       = trap_is_interrupt ? csr_mideleg : csr_medeleg;
    assign machine_interrupt_cause = trap_is_interrupt &&
                                     ((trap_cause_index == INTERRUPT_M_SOFTWARE_BIT[5:0]) ||
                                      (trap_cause_index == INTERRUPT_M_TIMER_BIT[5:0]) ||
                                      (trap_cause_index == INTERRUPT_M_EXTERNAL_BIT[5:0]));
    assign delegate_to_s    = trap_trigger && (priv_mode_t'(csr_priv_mode) != PRIV_MODE_M) &&
                              ((trap_is_interrupt && interrupt_targets_s_mode) ||
                               (!trap_is_interrupt && deleg_mask[trap_cause_index] && !machine_interrupt_cause));
    assign trap_to_s_mode   = delegate_to_s;

    assign trap_mcause = trap_trigger ? trap_cause_value : '0;
    assign trap_mtval  = trap_trigger ? trap_mtval_value : '0;
    assign trap_mepc   = trap_trigger ? wb_pc : '0;

    assign mret_en = trap_is_mret & ~trap_trigger;
    assign sret_en = trap_is_sret & ~trap_trigger;

    assign trap_flush_req = trap_trigger | mret_en | sret_en;
    assign trap_pc_sel    = trap_flush_req;

    logic [XLEN-1:0] trap_vector_base;
    logic [1:0]      trap_vector_mode;
    logic [XLEN-1:0] trap_vector_aligned;

    assign trap_vector_base    = delegate_to_s ? csr_stvec : csr_mtvec;
    assign trap_vector_mode    = trap_vector_base[1:0];
    assign trap_vector_aligned = {trap_vector_base[XLEN-1:2], 2'b00};

    always_comb begin
        if (trap_trigger) begin
            if ((trap_vector_mode == 2'b01) && trap_is_interrupt) begin
                trap_next_pc = trap_vector_aligned + (({{(XLEN-6){1'b0}}, trap_cause_index}) << 2);
            end else begin
                trap_next_pc = trap_vector_aligned;
            end
        end else if (mret_en) begin
            trap_next_pc = csr_mepc;
        end else if (sret_en) begin
            trap_next_pc = csr_sepc;
        end else begin
            trap_next_pc = '0;
        end
    end

endmodule