hw: Fully gate debug support in Snitch core

pulp-platform · Sep 27, 2023 · 5d2b0a0 · 5d2b0a0
1 parent f8f8a18
commit 5d2b0a0
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 19 deletions.
diff --git a/hw/snitch/src/snitch.sv b/hw/snitch/src/snitch.sv
@@ -55,6 +55,8 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
   parameter int unsigned NumDTLBEntries = 0,
   parameter int unsigned NumITLBEntries = 0,
   parameter snitch_pma_pkg::snitch_pma_t SnitchPMACfg = '{default: 0},
+  /// Enable debug support.
+  parameter bit         DebugSupport = 1,
   /// Derived parameter *Do not override*
   parameter type addr_t = logic [AddrWidth-1:0],
   parameter type data_t = logic [DataWidth-1:0]
@@ -293,10 +295,17 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
   `FFAR(ssip_q, ssip_d, '0, clk_i, rst_i)
   `FFAR(scip_q, scip_d, '0, clk_i, rst_i)
 
-  `FFAR(dcsr_q, dcsr_d, '0, clk_i, rst_i)
-  `FFNR(dpc_q, dpc_d, clk_i)
-  `FFNR(dscratch_q, dscratch_d, clk_i)
-  `FFAR(debug_q, debug_d, '0, clk_i, rst_i) // Debug mode
+  if (DebugSupport) begin : gen_debug
+    `FFAR(dcsr_q, dcsr_d, '0, clk_i, rst_i)
+    `FFNR(dpc_q, dpc_d, clk_i)
+    `FFNR(dscratch_q, dscratch_d, clk_i)
+    `FFAR(debug_q, debug_d, '0, clk_i, rst_i) // Debug mode
+  end else begin : gen_no_debug
+    assign dcsr_q = '0;
+    assign dpc_q  = '0;
+    assign dscratch_q = '0;
+    assign debug_q = '0;
+  end
 
   `FFAR(csr_stall_q, csr_stall_d, '0, clk_i, rst_i)
 
@@ -481,7 +490,8 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
           DmBaseAddress + dm::HaltAddress : DmBaseAddress + dm::ExceptionAddress;
       end else begin
       end
-      if (!debug_q && (irq_i.debug || dcsr_q.step)) pc_d = DmBaseAddress + dm::HaltAddress;
+      if (!debug_q && ((DebugSupport && irq_i.debug) || dcsr_q.step))
+        pc_d = DmBaseAddress + dm::HaltAddress;
     end
   end
 
@@ -529,7 +539,7 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
     debug_d = (!debug_q && (
           // the external debugger or an ebreak instruction triggerd the
           // request to debug.
-          irq_i.debug ||
+          (DebugSupport && irq_i.debug) ||
           // We encountered an ebreak and the default ebreak behaviour is switched off
           (dcsr_q.ebreakm && inst_data_i == EBREAK) ||
           // This was a single-step
@@ -539,7 +549,7 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
     csr_en = 1'b0;
     // Debug request and wake up are possibilties to move out of
     // the low power state.
-    wfi_d = (irq_i.debug || debug_q || any_interrupt_pending) ? 1'b0 : wfi_q;
+    wfi_d = ((DebugSupport && irq_i.debug) || debug_q || any_interrupt_pending) ? 1'b0 : wfi_q;
 
     unique casez (inst_data_i)
       ADD: begin
@@ -2291,7 +2301,7 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
       if (valid_instr && inst_data_i == EBREAK) begin
         dpc_d = pc_q;
         dcsr_d.cause = dm::CauseBreakpoint;
-      end else if (irq_i.debug) begin
+      end else if (DebugSupport && irq_i.debug) begin
         dpc_d = npc;
         dcsr_d.cause = dm::CauseRequest;
       end else if (valid_instr && dcsr_q.step) begin
@@ -2333,17 +2343,23 @@ module snitch import snitch_pkg::*; import riscv_instr::*; #(
             csr_rvalue = hart_id_i;
           end
           CSR_DCSR: begin
-            csr_rvalue = dcsr_q;
-            dcsr_d.ebreakm = alu_result[15];
-            dcsr_d.step = alu_result[2];
+            if (DebugSupport) begin
+              csr_rvalue = dcsr_q;
+              dcsr_d.ebreakm = alu_result[15];
+              dcsr_d.step = alu_result[2];
+            end else illegal_csr = 1'b1;
           end
           CSR_DPC: begin
-            csr_rvalue = dpc_q;
-            dpc_d = alu_result;
+            if (DebugSupport) begin
+              csr_rvalue = dpc_q;
+              dpc_d = alu_result;
+            end else illegal_csr = 1'b1;
           end
           CSR_DSCRATCH0: begin
-            csr_rvalue = dscratch_q;
-            dscratch_d = alu_result;
+            if (DebugSupport) begin
+              csr_rvalue = dscratch_q;
+              dscratch_d = alu_result;
+            end else illegal_csr = 1'b1;
           end
           `ifdef SNITCH_ENABLE_PERF
           CSR_MCYCLE: begin

diff --git a/hw/snitch_cluster/src/snitch_cc.sv b/hw/snitch_cluster/src/snitch_cc.sv
@@ -97,6 +97,8 @@ module snitch_cc #(
   /// Insert Pipeline registers immediately after FPU datapath
   parameter bit          RegisterFPUOut     = 0,
   parameter snitch_pma_pkg::snitch_pma_t SnitchPMACfg = '{default: 0},
+  /// Enable debug support.
+  parameter bit          DebugSupport = 1,
   /// Derived parameter *Do not override*
   parameter int unsigned TCDMPorts = (NumSsrs > 1 ? NumSsrs : 1),
   parameter type addr_t = logic [AddrWidth-1:0],
@@ -225,7 +227,8 @@ module snitch_cc #(
     .XFVEC (XFVEC),
     .XFDOTP (XFDOTP),
     .XFAUX (XFauxMerged),
-    .FLEN (FLEN)
+    .FLEN (FLEN),
+    .DebugSupport (DebugSupport)
   ) i_snitch (
     .clk_i ( clk_d2_i ), // if necessary operate on half the frequency
     .rst_i ( ~rst_ni ),

diff --git a/hw/snitch_cluster/src/snitch_cluster.sv b/hw/snitch_cluster/src/snitch_cluster.sv
@@ -185,7 +185,9 @@ module snitch_cluster
   // value here. This only applies to the TCDM. The instruction cache macros will break!
   // In case you are using the `RegisterTCDMCuts` feature this adds an
   // additional cycle latency, which is taken into account here.
-  parameter int unsigned MemoryMacroLatency = 1 + RegisterTCDMCuts
+  parameter int unsigned MemoryMacroLatency = 1 + RegisterTCDMCuts,
+  /// Enable debug support.
+  parameter bit         DebugSupport = 1
 ) (
   /// System clock. If `IsoCrossing` is enabled this port is the _fast_ clock.
   /// The slower, half-frequency clock, is derived internally.
@@ -876,7 +878,8 @@ module snitch_cluster
         .RegisterSequencer (RegisterSequencer),
         .RegisterFPUIn (RegisterFPUIn),
         .RegisterFPUOut (RegisterFPUOut),
-        .TCDMAddrWidth (TCDMAddrWidth)
+        .TCDMAddrWidth (TCDMAddrWidth),
+        .DebugSupport (DebugSupport)
       ) i_snitch_cc (
         .clk_i,
         .clk_d2_i (clk_d2),

diff --git a/hw/snitch_cluster/src/snitch_cluster_wrapper.sv.tpl b/hw/snitch_cluster/src/snitch_cluster_wrapper.sv.tpl
@@ -333,7 +333,8 @@ module ${cfg['name']}_wrapper (
     .NarrowMaxMstTrans (${cfg['narrow_trans']}),
     .NarrowMaxSlvTrans (${cfg['narrow_trans']}),
     .sram_cfg_t (${cfg['pkg_name']}::sram_cfg_t),
-    .sram_cfgs_t (${cfg['pkg_name']}::sram_cfgs_t)
+    .sram_cfgs_t (${cfg['pkg_name']}::sram_cfgs_t),
+    .DebugSupport (${int(cfg['enable_debug'])})
   ) i_cluster (
     .clk_i,
     .rst_ni,