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

initial markdown conversion of hardware spec #309

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Conversation

steph-morton
Copy link
Contributor

This is an initial markdown conversion of the HW spec, generated on November 13 from the edited and SME-reviewed .docx snapshot. It includes fixes and updates for:

  • accepted SME revisions
  • table updates: converted to markdown with no html
  • removed heading numbers
  • general manual formatting updates
  • images generated for the equations

Notes:

  • Most images are not included in this PR; these are todo in a future PR.
  • The TODOs that were in the docx snapshot remain in this markdown version.

Copy link
Collaborator

@andreslagarcavilla andreslagarcavilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving conversion. We will improve iterativel form here onwards

@andreslagarcavilla andreslagarcavilla merged commit 532117f into main Nov 28, 2023
47 checks passed

The baud rate can be configured using the CTRL.NCO register field. This should be set using the following equation:

![](./images/Caliptra_eq_NCO.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there math/equation support in markdown?

Might be easier to maintain if we put those equations directly here versus modifying an image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree that would be ideal. We could experiment with: https://github.blog/2022-05-19-math-support-in-markdown/ but will need to verify correct display outside github (our other potential output formats are html, pdf).

@steph-morton steph-morton deleted the stephm-newdoc branch November 28, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants