Add long_name and description to AES and CSR instructions #689
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhower-qc
requested changes
Apr 29, 2025
arch/inst/Zicsr/csrrc.yaml
Outdated
Comment on lines
7
to
22
| description: | | ||
| No description available. | ||
| normative: false | ||
| text: | | ||
| The CSRRC (Atomic Read and Clear Bits in CSR) instruction reads the value of the CSR, zero-extends | ||
| the value to XLEN bits, and writes it to integer register `rd`. The initial value in integer register `rs1` is | ||
| treated as a bit mask that specifies bit positions to be cleared in the CSR. Any bit that is high in `rs1` will | ||
| cause the corresponding bit to be cleared in the CSR, if that CSR bit is writable. | ||
|
|
||
| For CSRRC, if `rs1=x0`, then the instruction will not write to the CSR at all, and so shall | ||
| not cause any of the side effects that might otherwise occur on a CSR write, nor raise illegal- | ||
| instruction exceptions on accesses to read-only CSRs. CSRRC always reads the addressed CSR and | ||
| cause any read side effects regardless of `rs1` and `rd` fields. | ||
| Note that if `rs1` specifies a register other than `x0`, and that register holds a zero value, | ||
| the instruction will not action any attendant per-field side effects, but will action any | ||
| side effects caused by writing to the entire CSR. |
There was a problem hiding this comment.
I'm glad you are using the new form of description, but it needs a few adjustments (applies to all in this PR):
- It should be an array, like:
description:
- normative: false
- text: |
# ...- An
idis required for each statement
Comment on lines
+7
to
+8
| This instruction implements part of the KeySchedule operation for the AES Block cipher involving | ||
| the SBox operation |
There was a problem hiding this comment.
Should be something like "AES KeySchedule"
arch/inst/Zknd/aes64ds.yaml
Outdated
| @@ -3,9 +3,13 @@ | |||
| $schema: "inst_schema.json#" | |||
| kind: instruction | |||
| name: aes64ds | |||
| long_name: No synopsis available. | |||
| long_name: AES final round decryption instruction for RV64 | |||
There was a problem hiding this comment.
remove "instruction for RV64" (multiple instances)
arch/inst/Zknd/aes64im.yaml
Outdated
Comment on lines
6
to
8
| long_name: | ||
| This instruction accelerates the inverse MixColumns step of the AES Block Cipher, and is used to | ||
| aid creation of the decryption KeySchedule |
There was a problem hiding this comment.
"AES inverse MixColumns"
sudo-abdullah
force-pushed
the
AES+CSR_spec
branch
from
7be61ef to
35be709
Compare
dhower-qc
requested changes
May 5, 2025
Comment on lines
+8
to
+10
| -id: inst-csrrc-behavior | ||
| -normative: false | ||
| -text: | |
There was a problem hiding this comment.
Close. This is an array of objects, so this will be:
- id: inst-csrrc-behavior
normative: false
text: |
# ...(no dashes for normative and text)
Same for the other files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds missing long_name and description to the following AES and CSR instructions: