[hmac,doc] Wipe secret doc update

- fix doc to be aligned with the RTL as the FSMs are not affected by the wipe secret triggering. But this is not a security issue. Signed-off-by: Martin Velay <[email protected]>
lowRISC · Dec 17, 2024 · ee23638 · ee23638
1 parent 11988f6
commit ee23638
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/hw/ip/hmac/data/hmac.hjson b/hw/ip/hmac/data/hmac.hjson
@@ -420,7 +420,7 @@
     { name: "WIPE_SECRET",
       desc: '''Clear internal secret registers.
 
-            If CPU writes a value into the register, the value is used to clear the internal variables such as the secret key, internal state machine, or hash value.
+            If CPU writes a value into the register, the value is used to clear the internal variables such as the secret key, intermediate hash results, digest and the internal message scheduling array.
             The clear secret operation overwrites the internal variables with the provided 32-bit value.
             For SHA-2 384/512 that work with 64-bit words, the 32-bit value is duplicated and concatenated to generate the 64-bit value.
             It is recommended to use a value extracted from an entropy source.

diff --git a/hw/ip/hmac/doc/registers.md b/hw/ip/hmac/doc/registers.md
@@ -326,7 +326,7 @@ HMAC Error Code
 ## WIPE_SECRET
 Clear internal secret registers.
 
-If CPU writes a value into the register, the value is used to clear the internal variables such as the secret key, internal state machine, or hash value.
+If CPU writes a value into the register, the value is used to clear the internal variables such as the secret key, intermediate hash results, digest and the internal message scheduling array.
 The clear secret operation overwrites the internal variables with the provided 32-bit value.
 For SHA-2 384/512 that work with 64-bit words, the 32-bit value is duplicated and concatenated to generate the 64-bit value.
 It is recommended to use a value extracted from an entropy source.