[docs,qemu] Add QEMU OT documentation #28553
Open
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
jwnrt
approved these changes
Oct 24, 2025
To allow for more general OpenTitan QEMU documentation, move the current setup / build system documentation to its own separate `setup.md` page. Make a new general QEMU `README.md` containing documentation not specific to setup / using a local build override. Signed-off-by: Alex Jones <[email protected]>
Add the new `bootstrap` parameter to the existing documentation, and also add a link to better explain the `traces` parameter. Signed-off-by: Alex Jones <[email protected]>
Now that we're adding more centralized OpenTitan QEMU documentation, document the newly support command-line argument format here. Signed-off-by: Alex Jones <[email protected]>
Add a short section on the QEMU tessting documentation that describes how the QEMU UART console output and log output are muxed into stdout without line buffering, to avoid confusion about interleaving of characters from both inputs. Signed-off-by: Alex Jones <[email protected]>
Add some introductory documentation to explain QEMU, it's integration into OpenTitan itself, and caveats that users should be aware of. The focus of these docs are primarily on introducing the basic concepts of QEMU, explaining the integration with OpenTitan, and noting any caveats that are useful to be aware of when testing or developing software stacks. Where possible, detailed explanations of QEMU's internals or explanations of how OpenTitan emulation works is delegated to the existing QEMU / QEMU fork documentation, to avoid replication and docs getting out of date. The one exception is the list of unemulated features - a short non-comprehensive list is reproduced as it is probably useful that anyone who wants to use QEMU is aware of some of the major caveats, even if the list is not complete / comprehensive. Signed-off-by: Alex Jones <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Move some of the existing QEMU documentation, and add much more. This aims to be some short introductory documentation (deferring to upstream QEMU docs where necessary), explanations of many key caveats found during development & integration to be aware of, and more comprehensive documentation on the different Bazel parameters and arguments that are available.
See the commit messages for more details.