patina_debugger: Do not initialize the transport by default#1550
Merged
Conversation
This change removes the default behavior to initialize the debugger transport serial port. Most systems will use a shared transport, and so the re-initialization is at best unnecessary. In some scenarios the Patina serial transport initialization may stomp on the existing configuration. It is best to just skip unless requested. This commit inverts the default, deprecates `without_transport_init`, and introduces `with_transport_init` for the rare platforms that require this.
Contributor
✅ QEMU Validation PassedAll QEMU validation jobs completed successfully.
Workflow run: https://github.com/OpenDevicePartnership/patina/actions/runs/26915246980 Boot Time to EFI Shell
Dependencies
This comment was automatically generated by the Patina QEMU PR Validation Post workflow. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
os-d
approved these changes
Jun 3, 2026
makubacki
added
the
type:design-change
makubacki
reviewed
Jun 3, 2026
makubacki
left a comment
makubacki
left a comment
Collaborator
There was a problem hiding this comment.
I added the design change label to at least rev the minor version for visibility to the deprecation change in the release notes. There should be integration guidance in the PR description as well though.
makubacki
approved these changes
Jun 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Description
This change removes the default behavior to initialize the debugger transport serial port. Most systems will use a shared transport, and so the re-initialization is at best unnecessary. In some scenarios the Patina serial transport initialization may stomp on the existing configuration. This has caused confusion on multiple platforms during enablement. It is best to just skip unless requested. This commit inverts the default, deprecates
without_transport_init, and introduceswith_transport_initfor the rare platforms that require this.How This Was Tested
Tested that Q35 & SBSA debuggers still function
Integration Instructions
Platforms using
without_transport_init()may safely drop that function call. There are no known platforms that require transport initialization, but if so those should now callwith_transport_init()as needed.