uefi: significantly improve ergonomics of Handle (device path and component2 protocols) #1858
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
phip1611
force-pushed
the
handle-convenience
branch
4 times, most recently
from
8dd6b43 to
b9c1651
Compare
Clean up the mess and follow our convention: - pub mod - mod - pub use - use
This change is a prerequisite for the subsequent commit introducing Display. Display already provides a to_string() method, so keeping the existing name would cause ambiguity. While fully qualified paths could be used to disambiguate, a dedicated name is significantly more convenient. It also makes the distinction between standard Rust strings and UEFI (UTF-16) strings explicit.
For device paths, it is very convenient to use the DevicePathToText protocol to visualize/print the device path. By providing a convenient Display impl, we improve the ergonomics of device paths significantly and reducing boilerplate.
phip1611
force-pushed
the
handle-convenience
branch
from
b9c1651 to
312e542
Compare
In practice, UEFI applications frequently need to extract additional metadata from handles for logging, debugging, and user-facing selection. The Device Path and Component Name 2 protocols provide this information, but accessing them repeatedly requires non-trivial boilerplate. This change introduces convenience helpers on Handle to streamline common queries and improve ergonomics when working with these protocols.
phip1611
force-pushed
the
handle-convenience
branch
from
312e542 to
a3c3e1e
Compare
| crate::proto::device_path::DevicePath, | ||
| crate::proto::driver::ComponentName2, | ||
| }; | ||
|
|
Member
There was a problem hiding this comment.
To fix the cargo doc error:
Suggested change
| #[cfg(doc)] | |
| use crate::Status; |
| /// ); | ||
| /// ``` | ||
| #[cfg(feature = "alloc")] | ||
| pub fn component_name2(&self) -> Result<ScopedProtocol<ComponentName2>> { |
Member
There was a problem hiding this comment.
In the interests of keeping the API higher level, maybe we should call this just component_name?
| /// cn2_prot.controller_name(handle, None, "en").unwrap() | ||
| /// ); | ||
| /// ``` | ||
| #[cfg(feature = "alloc")] |
| /// .expect("should have device path"); | ||
| /// log::info!("device path: {device_path}"); | ||
| /// ``` | ||
| #[cfg(feature = "alloc")] |
Member
There was a problem hiding this comment.
Same here, seems like this should work without alloc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR prepares and implements a significant simplification of handling typical tasks with handles: printing a device path and using the component2 protocol.
addboot::open_protocol_[exclusive]if_exists()helpers (eventually replacing the base methods which we could deprecate)Handle::device_path()andHandle::component_name2()This improves the convenience and ergonomics in every Rust uefi code base I've seen so far at work and in private projects.
Checklist