added restore feature for SHA512 (#612)

* added restore feature for SHA512 * updated sha512 acc * added val for restore feature * Removed kv port from sha512 * MICROSOFT AUTOMATED PIPELINE: Stamp 'mojtaba-msft-sha512restore' with updated timestamp and hash after successful run * updated smoke_test with mldsa * MICROSOFT AUTOMATED PIPELINE: Stamp 'mojtaba-msft-sha512restore' with updated timestamp and hash after successful run
chipsalliance · Oct 30, 2024 · 73f1356 · 73f1356
1 parent c4915df
commit 73f1356
Show file tree

Hide file tree

Showing 22 changed files with 934 additions and 224 deletions.
diff --git a/.github/workflow_metadata/pr_hash b/.github/workflow_metadata/pr_hash
@@ -1 +1 @@
-4c8faff2f6d91d6196096aae143f7d81fc0b7dc5f38742cbe5398f2ecf7abd11327d51d29c1f95540503721dad790fd3
+6c8e7c3d77cadcbbf3b13e4f0f6853df60f57395826819dfbfda73a1a14f4533e5ca20c786cbb1b2535b771c4ebfa2b4
diff --git a/.github/workflow_metadata/pr_timestamp b/.github/workflow_metadata/pr_timestamp
@@ -1 +1 @@
-1730225605
+1730243083
diff --git a/src/integration/asserts/caliptra_top_sva.sv b/src/integration/asserts/caliptra_top_sva.sv
@@ -159,13 +159,6 @@ module caliptra_top_sva
 
   generate
     for(genvar dword = 0; dword < KV_NUM_DWORDS; dword++) begin
-      //sha512 block read
-      kv_sha512_block_r_flow:   assert property (
-                                            @(posedge `SVA_RDC_CLK)
-                                            $rose(`SHA512_PATH.kv_src_done & ~`SHA512_PATH.pcr_hash_extend_ip) && (dword < (`KEYVAULT_PATH.kv_reg1.hwif_out.KEY_CTRL[`SHA512_PATH.kv_read.read_entry].last_dword.value + 1)) |-> (`KEYVAULT_PATH.kv_reg1.hwif_out.KEY_ENTRY[`SHA512_PATH.kv_read.read_entry][dword].data.value == `SHA512_PATH.block_reg[dword])
-                                            )
-                                else $display("SVA ERROR: SHA384 block mismatch!, 0x%04x, 0x%04x", `KEYVAULT_PATH.kv_reg1.hwif_out.KEY_ENTRY[`SHA512_PATH.kv_read.read_entry][dword].data.value, `SHA512_PATH.block_reg[dword]);
-
       //sha512 digest write
       if (dword < SHA512_DIG_NUM_DWORDS) begin
         kv_sha512_digest_w_flow:  assert property (
@@ -553,6 +546,13 @@ module caliptra_top_sva
                                     )
                         else $display("SVA ERROR: ECC VALID flag mismatch!");      
 
+  //SVA for SHA512 restore
+  sha512_restore_cmd:   assert property ( 
+                                    @(posedge `SVA_RDC_CLK) 
+                                    `SHA512_PATH.restore_reg |-> (`SHA512_PATH.next_reg && !`SHA512_PATH.init_reg)
+                                    ) 
+                         else $display("SVA ERROR: SHA512 restore is not valid!");
+
   //SVA for modular operations
   ecc_opa_input:        assert property (
                                       @(posedge `SVA_RDC_CLK)

diff --git a/src/integration/rtl/caliptra_reg.h b/src/integration/rtl/caliptra_reg.h
@@ -3967,6 +3967,8 @@
 #define SHA512_REG_SHA512_CTRL_ZEROIZE_MASK                                                         (0x10)
 #define SHA512_REG_SHA512_CTRL_LAST_LOW                                                             (5)
 #define SHA512_REG_SHA512_CTRL_LAST_MASK                                                            (0x20)
+#define SHA512_REG_SHA512_CTRL_RESTORE_LOW                                                          (6)
+#define SHA512_REG_SHA512_CTRL_RESTORE_MASK                                                         (0x40)
 #define CLP_SHA512_REG_SHA512_STATUS                                                                (0x10020018)
 #define SHA512_REG_SHA512_STATUS                                                                    (0x18)
 #define SHA512_REG_SHA512_STATUS_READY_LOW                                                          (0)

diff --git a/src/integration/rtl/caliptra_reg_defines.svh b/src/integration/rtl/caliptra_reg_defines.svh
@@ -3967,6 +3967,8 @@
 `define SHA512_REG_SHA512_CTRL_ZEROIZE_MASK                                                         (32'h10)
 `define SHA512_REG_SHA512_CTRL_LAST_LOW                                                             (5)
 `define SHA512_REG_SHA512_CTRL_LAST_MASK                                                            (32'h20)
+`define SHA512_REG_SHA512_CTRL_RESTORE_LOW                                                          (6)
+`define SHA512_REG_SHA512_CTRL_RESTORE_MASK                                                         (32'h40)
 `define CLP_SHA512_REG_SHA512_STATUS                                                                (32'h10020018)
 `define SHA512_REG_SHA512_STATUS                                                                    (32'h18)
 `define SHA512_REG_SHA512_STATUS_READY_LOW                                                          (0)

diff --git a/src/integration/rtl/caliptra_top.sv b/src/integration/rtl/caliptra_top.sv
@@ -798,10 +798,6 @@ sha512_ctrl #(
     .hresp_o        (responder_inst[`CALIPTRA_SLAVE_SEL_SHA512].hresp),
     .hreadyout_o    (responder_inst[`CALIPTRA_SLAVE_SEL_SHA512].hreadyout),
     .hrdata_o       (responder_inst[`CALIPTRA_SLAVE_SEL_SHA512].hrdata),
-    .kv_read        (kv_read[2]),
-    .kv_write       (kv_write[1]),
-    .kv_rd_resp     (kv_rd_resp[2]),
-    .kv_wr_resp     (kv_wr_resp[1]),
     .pv_read        (pv_read),
     .pv_write       (pv_write),
     .pv_rd_resp     (pv_rd_resp),
@@ -813,6 +809,9 @@ sha512_ctrl #(
     .debugUnlock_or_scan_mode_switch(debug_lock_or_scan_mode_switch)
 );
 
+always_comb kv_read[2] = '0;
+always_comb kv_write[1] = '0;
+
 sha256_ctrl #(
     .AHB_DATA_WIDTH (`CALIPTRA_AHB_HDATA_SIZE),
     .AHB_ADDR_WIDTH (`CALIPTRA_SLAVE_ADDR_WIDTH(`CALIPTRA_SLAVE_SEL_SHA256))

diff --git a/src/integration/stimulus/L0_regression.yml b/src/integration/stimulus/L0_regression.yml
@@ -12,6 +12,7 @@ contents:
         - ../test_suites/smoke_test_mbox_byte_read/smoke_test_mbox_byte_read.yml
         - ../test_suites/smoke_test_mbox_cg/smoke_test_mbox_cg.yml
         - ../test_suites/smoke_test_sha512/smoke_test_sha512.yml
+        - ../test_suites/smoke_test_sha512_restore/smoke_test_sha512_restore.yml
         - ../test_suites/smoke_test_sha256/smoke_test_sha256.yml
         - ../test_suites/smoke_test_sha256_wntz/smoke_test_sha256_wntz.yml
         - ../test_suites/smoke_test_sha256_wntz_rand/smoke_test_sha256_wntz_rand.yml

diff --git a/src/integration/test_suites/libs/sha512/sha512.c b/src/integration/test_suites/libs/sha512/sha512.c
@@ -190,4 +190,54 @@ void sha512_flow(sha512_io block, uint8_t mode, sha512_io digest){
         offset++;
     }
 
+}
+
+void sha512_restore_flow(sha512_io block, uint8_t mode, sha512_io restore_digest, sha512_io digest){
+    volatile uint32_t * reg_ptr;
+    uint8_t offset;
+    uint8_t fail_cmd = 0x1;
+    uint32_t sha512_digest [16];
+
+    // wait for SHA to be ready
+    while((lsu_read_32(CLP_SHA512_REG_SHA512_STATUS) & SHA512_REG_SHA512_STATUS_READY_MASK) == 0);
+
+    // Write SHA512 block
+    reg_ptr = (uint32_t*) CLP_SHA512_REG_SHA512_BLOCK_0;
+    offset = 0;
+    while (reg_ptr <= (uint32_t*) CLP_SHA512_REG_SHA512_BLOCK_31) {
+        *reg_ptr++ = block.data[offset++];
+    }
+
+    // Write SHA512 restore DIGEST
+    reg_ptr = (uint32_t*) CLP_SHA512_REG_SHA512_DIGEST_0;
+    offset = 0;
+    while (reg_ptr <= (uint32_t*) CLP_SHA512_REG_SHA512_DIGEST_15) {
+        *reg_ptr++ = restore_digest.data[offset++];
+    }
+
+    // Enable SHA512 core 
+    VPRINTF(LOW, "Enable SHA512\n");
+    lsu_write_32(CLP_SHA512_REG_SHA512_CTRL, SHA512_REG_SHA512_CTRL_NEXT_MASK | 
+                                             SHA512_REG_SHA512_CTRL_RESTORE_MASK |
+                                            (mode << SHA512_REG_SHA512_CTRL_MODE_LOW) & SHA512_REG_SHA512_CTRL_MODE_MASK);
+
+    // wait for SHA to be valid
+    wait_for_sha512_intr();
+
+    reg_ptr = (uint32_t *) CLP_SHA512_REG_SHA512_DIGEST_0;
+    printf("Load DIGEST data from SHA512\n");
+    offset = 0;
+    while (reg_ptr <= (uint32_t*) CLP_SHA512_REG_SHA512_DIGEST_15) {
+        sha512_digest[offset] = *reg_ptr;
+        if (sha512_digest[offset] != digest.data[offset]) {
+            printf("At offset [%d], sha_digest data mismatch!\n", offset);
+            printf("Actual   data: 0x%x\n", sha512_digest[offset]);
+            printf("Expected data: 0x%x\n", digest.data[offset]);
+            printf("%c", fail_cmd);
+            while(1);
+        }
+        reg_ptr++;
+        offset++;
+    }
+
 }
diff --git a/src/integration/test_suites/libs/sha512/sha512.h b/src/integration/test_suites/libs/sha512/sha512.h
@@ -42,6 +42,7 @@ void sha_next_last(enum sha512_mode_e mode);
 void sha384_kvflow(uint8_t sha_kv_id, uint8_t store_to_kv, uint8_t digest_kv_id, uint32_t expected_digest[12]);
 void sha512_zeroize();
 void sha512_flow(sha512_io block, uint8_t mode, sha512_io digest);
+void sha512_restore_flow(sha512_io block, uint8_t mode, sha512_io restore_digest, sha512_io digest);
 
 //polls until sha512 is ready to be used
 inline void sha512_poll_ready() {
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		4c8faff2f6d91d6196096aae143f7d81fc0b7dc5f38742cbe5398f2ecf7abd11327d51d29c1f95540503721dad790fd3
		6c8e7c3d77cadcbbf3b13e4f0f6853df60f57395826819dfbfda73a1a14f4533e5ca20c786cbb1b2535b771c4ebfa2b4