Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise crypto core register descriptions in RDL #470

Closed
calebofearth opened this issue Mar 15, 2024 · 0 comments · Fixed by #480
Closed

Revise crypto core register descriptions in RDL #470

calebofearth opened this issue Mar 15, 2024 · 0 comments · Fixed by #480
Labels
documentation Improvements or additions to documentation

Comments

@calebofearth
Copy link
Collaborator

Sha256/sha512/HMAC/ECC register descriptions should be updated in RDL (and ultimately in the generated HTML). There are two issues I see:

  1. Address offsets for each reg are hardcoded in the text description. These are auto-generated when we create the HTML doc anyway, and subject to becoming outdated, so they shouldn't be hardcoded in the text.
  2. Bit descriptions are redundantly provided in the register text description, but also in the subsequent section relative to each register field. As a result, there are some mismatches, and some of the text descriptions are missing certain bit fields. E.g. SHA256_CTRL has a text description that is missing all mention of WNTZ-related bits. All reg "field descriptions" should be updated and then individual field descriptions should be removed from the global register "description" field.
@calebofearth calebofearth added the documentation Improvements or additions to documentation label Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant