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

docs: Add info on chipyard's tests directory and how to do multithreading in RTL simulations #1646

Merged
merged 2 commits into from
Nov 4, 2023

Conversation

JL102
Copy link
Contributor

@JL102 JL102 commented Nov 3, 2023

The most important part of this addition, IMO, is the note about __main(), since it's currently not noted anywhere in Chipyard's docs. It was initially very hard for me to find any explanation about __main until I stumbled across libgloss-htif's readme page.

@ maintainers: I don't actually know for sure if libgloss-htif is the right place to link to. It's the only documentation I could find that includes an explanation on __main, but I don't know if that's actually the code used for Verilator/VCS simulations.

Related PRs / Issues:

Type of change:

  • Bug fix
  • New feature
  • Other enhancement

Impact:

  • RTL change
  • Software change (RISC-V software)
  • Build system change
  • Other

Contributor Checklist:

  • Did you set main as the base branch?
  • Is this PR's title suitable for inclusion in the changelog and have you added a changelog:<topic> label?
  • Did you state the type-of-change/impact?
  • [N/A] Did you delete any extraneous prints/debugging code?
  • [N/A, no permissions] Did you mark the PR with a changelog: label?
  • [N/A] (If applicable) Did you update the conda .conda-lock.yml file if you updated the conda requirements file?
  • (If applicable) Did you add documentation for the feature?
  • [N/A] (If applicable) Did you add a test demonstrating the PR?
  • [N/A] (If applicable) Did you mark the PR as Please Backport?

The most important part of this addition, IMO, is the note about `__main()`, since
it's currently not noted anywhere in Chipyard's docs. It was initially very hard for
me to find any explanation about __main until I stumbled across libgloss-htif's readme page.

Signed-off-by: JL102 <jordanlees@mailbox.org>
@JL102 JL102 changed the title docs: Add info on chipyard's tests directory and multithreading with __main docs: Add info on chipyard's tests directory and how to do multithreading in RTL simulations Nov 3, 2023
Copy link
Contributor

@jerryz123 jerryz123 left a comment

Choose a reason for hiding this comment

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

Thanks for adding this. I suggested some changes to make this even more clear.

docs/Simulation/Software-RTL-Simulation.rst Outdated Show resolved Hide resolved
Co-authored-by: Jerry Zhao <qwertyuiopghb@gmail.com>
@jerryz123 jerryz123 merged commit e3106fe into ucb-bar:main Nov 4, 2023
1 check passed
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.

None yet

2 participants