From e95520138967f0c184af691b3ae6e998a8b52527 Mon Sep 17 00:00:00 2001
From: Tim Fischer <fischeti@iis.ee.ethz.ch>
Date: Fri, 19 Jul 2024 13:55:54 +0200
Subject: [PATCH] misc: Small fixes

---
 .../snitch_cluster_peripheral.sv              | 70 +++++++++----------
 sw/snRuntime/src/perf_cnt.h                   | 11 +--
 2 files changed, 41 insertions(+), 40 deletions(-)

diff --git a/hw/snitch_cluster/src/snitch_cluster_peripheral/snitch_cluster_peripheral.sv b/hw/snitch_cluster/src/snitch_cluster_peripheral/snitch_cluster_peripheral.sv
index 772a6a0a0a..8885245f49 100644
--- a/hw/snitch_cluster/src/snitch_cluster_peripheral/snitch_cluster_peripheral.sv
+++ b/hw/snitch_cluster/src/snitch_cluster_peripheral/snitch_cluster_peripheral.sv
@@ -60,42 +60,42 @@ module snitch_cluster_peripheral
     .hw2reg (hw2reg)
   );
 
-  // As defined in the `.hjson` file. Unforunately,
+  // As defined in the `.hjson` file. Unfortunately,
   // The regtool does not generate enums for SV,
   // only for C. So we have to define them here.
-  typedef enum logic[9:0] {
-    Cycle           = 10'd0,
-    TcdmAccessed    = 10'd1,
-    TcdmCongested   = 10'd2,
-    IssueFpu        = 10'd3,
-    IssueFpuSeq     = 10'd4,
-    IssueCoreToFpu  = 10'd5,
-    RetiredInstr    = 10'd6,
-    RetiredLoad     = 10'd7,
-    RetiredI        = 10'd8,
-    RetiredAcc      = 10'd9,
-    DmaAwStall      = 10'd10,
-    DmaArStall      = 10'd11,
-    DmaRStall       = 10'd12,
-    DmaWStall       = 10'd13,
-    DmaBufWStall    = 10'd14,
-    DmaBufRStall    = 10'd15,
-    DmaAwDone       = 10'd16,
-    DmaAwBw         = 10'd17,
-    DmaArDone       = 10'd18,
-    DmaArBw         = 10'd19,
-    DmaRDone        = 10'd20,
-    DmaRBw          = 10'd21,
-    DmaWDone        = 10'd22,
-    DmaWBw          = 10'd23,
-    DmaBDone        = 10'd24,
-    DmaBusy         = 10'd25,
-    IcacheMiss      = 10'd26,
-    IcacheHit       = 10'd27,
-    IcachePrefetch  = 10'd28,
-    IcacheDoubleHit = 10'd29,
-    IcacheStall     = 10'd30,
-    NumMetrics      = 10'd31
+  typedef enum logic[4:0] {
+    Cycle           = 5'd0,
+    TcdmAccessed    = 5'd1,
+    TcdmCongested   = 5'd2,
+    IssueFpu        = 5'd3,
+    IssueFpuSeq     = 5'd4,
+    IssueCoreToFpu  = 5'd5,
+    RetiredInstr    = 5'd6,
+    RetiredLoad     = 5'd7,
+    RetiredI        = 5'd8,
+    RetiredAcc      = 5'd9,
+    DmaAwStall      = 5'd10,
+    DmaArStall      = 5'd11,
+    DmaRStall       = 5'd12,
+    DmaWStall       = 5'd13,
+    DmaBufWStall    = 5'd14,
+    DmaBufRStall    = 5'd15,
+    DmaAwDone       = 5'd16,
+    DmaAwBw         = 5'd17,
+    DmaArDone       = 5'd18,
+    DmaArBw         = 5'd19,
+    DmaRDone        = 5'd20,
+    DmaRBw          = 5'd21,
+    DmaWDone        = 5'd22,
+    DmaWBw          = 5'd23,
+    DmaBDone        = 5'd24,
+    DmaBusy         = 5'd25,
+    IcacheMiss      = 5'd26,
+    IcacheHit       = 5'd27,
+    IcachePrefetch  = 5'd28,
+    IcacheDoubleHit = 5'd29,
+    IcacheStall     = 5'd30,
+    NumMetrics      = 5'd31
   } perf_metrics_e;
 
   // The metrics that should be tracked immediately after reset.
@@ -195,7 +195,7 @@ module snitch_cluster_peripheral
     end
   end
 
-  // Actual performance counters.
+  // Performance counter FFs.
   for (genvar i = 0; i < NumPerfCounters; i++) begin : gen_perf_cnt
     `FFLARNC(perf_cnt_q[i], perf_cnt_d[i],
              reg2hw.perf_cnt_en[i], reg2hw.perf_cnt[i].qe, '0, clk_i, rst_ni)
diff --git a/sw/snRuntime/src/perf_cnt.h b/sw/snRuntime/src/perf_cnt.h
index 297673a637..474e10ab79 100644
--- a/sw/snRuntime/src/perf_cnt.h
+++ b/sw/snRuntime/src/perf_cnt.h
@@ -20,12 +20,13 @@ typedef struct {
     volatile perf_reg32_t perf_counter[SNRT_NUM_PERF_CNTS];
 } perf_regs_t;
 
-// Return the pointer to the perf_counters
+// Return the pointer to the performance counter cfg registers
 inline perf_regs_t* snrt_perf_counters() {
     return (perf_regs_t*)snrt_cluster_perf_counters_addr();
 }
 
-// Configure a specific perf_counter
+// Configure a perf_counter, the metrics which can be set
+// are defined in `snitch_cluster_peripheral.h`
 inline void snrt_cfg_perf_counter(uint32_t perf_cnt, uint16_t metric,
                                   uint16_t hart) {
     // Make sure the configuration is written in a single write
@@ -34,7 +35,7 @@ inline void snrt_cfg_perf_counter(uint32_t perf_cnt, uint16_t metric,
     snrt_perf_counters()->select[perf_cnt].value = cfg_reg.value;
 }
 
-// Enable a specific perf_counter
+// Enable a performance counter
 inline void snrt_start_perf_counter(uint32_t perf_cnt) {
     snrt_perf_counters()->enable[perf_cnt].value = 0x1;
 }
@@ -44,12 +45,12 @@ inline void snrt_stop_perf_counter(uint32_t perf_cnt) {
     snrt_perf_counters()->enable[perf_cnt].value = 0x0;
 }
 
-// Resets the counter completely
+// Resets the counter to zero
 inline void snrt_reset_perf_counter(uint32_t perf_cnt) {
     snrt_perf_counters()->perf_counter[perf_cnt].value = 0x0;
 }
 
-// Get counter of specified perf_counter
+// Get counter value of a perf_counter
 inline uint32_t snrt_get_perf_counter(uint32_t perf_cnt) {
     return snrt_perf_counters()->perf_counter[perf_cnt].value;
 }