uefi-ref/uefi-rs
1
0
Fork 0
mirror of https://github.com/rust-osdev/uefi-rs synced 2026-08-26 18:26:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: standardize rustdoc section headings

Browse source
This commit is contained in:
Philipp Schuster 2026-08-13 17:38:48 +02:00
parent c93fa3633a
commit e909d21fd9
No known key found for this signature in database
12 changed files with 29 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

4
uefi/src/boot.rs
View file

@ -1882,7 +1882,7 @@ pub enum OpenProtocolAttributes {
/// attribute of `ByDriver`, then an attempt will be made to remove
/// them by calling the driver's `Stop` function.
///
/// # Warning
/// # Warnings
///
/// Opening an interface in exclusive mode can have surprising side
/// effects. For example:
@ -1907,7 +1907,7 @@ pub enum OpenProtocolAttributes {
/// opened with an attribute of `ByDriver`, then an attempt will be
/// made to remove them with `DisconnectController`.
///
/// # Warning
/// # Warnings
///
/// See warning section of [`Exclusive`].
///

6
uefi/src/proto/ata/pass_thru.rs
View file

@ -25,7 +25,7 @@ pub type AtaPassThruMode = uefi_raw::protocol::ata::AtaPassThruMode;
/// It is designed as a foundational layer, leaving higher-level abstractions responsible for implementing
/// richer storage semantics, device-specific commands, and advanced use cases.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// Provides services that allow ATA commands to be sent to ATA Devices attached to an ATA controller. Packet-
/// based commands would be sent to ATAPI devices only through the Extended SCSI Pass Thru Protocol. While
/// the ATA_PASS_THRU interface would expose an interface to the underlying ATA devices on an ATA controller,
@ -78,7 +78,7 @@ impl AtaPassThru {
/// Iterate over all potential ATA devices on this channel.
///
/// # Warning
/// # Warnings
/// Depending on the UEFI implementation, this does not only return all actually available devices.
/// Most implementations instead return a list of all possible fully-qualified device addresses.
/// You have to probe for availability yourself, using [`AtaDevice::execute_command`].
@ -98,7 +98,7 @@ impl AtaPassThru {
/// Represents an ATA device on a controller.
///
/// # Warning
/// # Warnings
/// This is only a potentially valid device address. Verify it by probing for an actually
/// available / connected device using [`AtaDevice::execute_command`] before doing anything meaningful.
#[derive(Debug)]

4
uefi/src/proto/hii/config.rs
View file

@ -7,7 +7,7 @@ use uefi_raw::protocol::hii::config::{ConfigKeywordHandlerProtocol, HiiConfigAcc
/// The HII Keyword Handler Protocol.
///
/// # UEFI Spec Description
/// # UEFI Specification
///
/// This protocol provides the mechanism to set and get the values associated
/// with a keyword exposed through a x-UEFI- prefixed configuration language namespace.
@ -18,7 +18,7 @@ pub struct ConfigKeywordHandler(ConfigKeywordHandlerProtocol);
/// The HII Configuration Access Protocol.
///
/// # UEFI Spec Description
/// # UEFI Specification
///
/// This protocol is responsible for facilitating access to configuration data from HII.
/// It is typically invoked by the HII Configuration Routing Protocol for handling

2
uefi/src/proto/hii/config_routing.rs
View file

@ -13,7 +13,7 @@ use crate::{CStr16, StatusExt};
/// The HII Configuration Routing Protocol.
///
/// # UEFI Spec Description
/// # UEFI Specification
///
/// The EFI HII Configuration Routing Protocol manages the movement of configuration
/// data from drivers to configuration applications. It then serves as the single point

2
uefi/src/proto/hii/database.rs
View file

@ -15,7 +15,7 @@ use crate::{Error, StatusExt};
/// This database contains internationalized strings, as well as a description of all
/// supported BIOS settings, together with their logic (e.g.: option A blocks option B if value is `true`).
///
/// # UEFI Spec Description
/// # UEFI Specification
///
/// Database manager for HII-related data structures.
#[derive(Debug)]

22
uefi/src/proto/media/disk.rs
View file

@ -24,12 +24,12 @@ pub struct DiskIo(DiskIoProtocol);
impl DiskIo {
/// Reads bytes from the disk device.
///
/// # Arguments:
/// # Arguments
/// * `media_id` - ID of the medium to be read.
/// * `offset` - Starting byte offset on the logical block I/O device to read from.
/// * `buffer` - Pointer to a buffer to read into.
///
/// # Errors:
/// # Errors
/// * [`Status::INVALID_PARAMETER`] The read request contains device addresses that are not valid for the device.
/// * [`Status::DEVICE_ERROR`] The device reported an error while performing the read operation.
/// * [`Status::NO_MEDIA`] There is no medium in the device.
@ -50,12 +50,12 @@ impl DiskIo {
/// Writes bytes to the disk device.
///
/// # Arguments:
/// # Arguments
/// * `media_id` - ID of the medium to be written.
/// * `offset` - Starting byte offset on the logical block I/O device to write to.
/// * `buffer` - Pointer to a buffer to write from.
///
/// # Errors:
/// # Errors
/// * [`Status::INVALID_PARAMETER`] The write request contains device addresses that are not valid for the device.
/// * [`Status::DEVICE_ERROR`] The device reported an error while performing the write operation.
/// * [`Status::NO_MEDIA`] There is no medium in the device.
@ -100,7 +100,7 @@ pub struct DiskIo2(DiskIo2Protocol);
impl DiskIo2 {
/// Terminates outstanding asynchronous requests to the device.
///
/// # Errors:
/// # Errors
/// * [`Status::DEVICE_ERROR`] The device reported an error while performing
pub fn cancel(&mut self) -> Result {
// SAFETY: The memory is valid.
@ -109,7 +109,7 @@ impl DiskIo2 {
/// Reads bytes from the disk device.
///
/// # Arguments:
/// # Arguments
/// * `media_id` - ID of the medium to be read from.
/// * `offset` - Starting byte offset on the logical block I/O device to read from.
/// * `token` - Transaction token for asynchronous read.
@ -121,7 +121,7 @@ impl DiskIo2 {
/// Because of the asynchronous nature of the disk transaction, manual lifetime
/// tracking is required.
///
/// # Errors:
/// # Errors
/// * [`Status::INVALID_PARAMETER`] The read request contains device addresses that are not valid for the device.
/// * [`Status::OUT_OF_RESOURCES`] The request could not be completed due to a lack of resources.
/// * [`Status::MEDIA_CHANGED`] `media_id` is not for the current medium.
@ -145,7 +145,7 @@ impl DiskIo2 {
/// Writes bytes to the disk device.
///
/// # Arguments:
/// # Arguments
/// * `media_id` - ID of the medium to write to.
/// * `offset` - Starting byte offset on the logical block I/O device to write to.
/// * `token` - Transaction token for asynchronous write.
@ -157,7 +157,7 @@ impl DiskIo2 {
/// Because of the asynchronous nature of the disk transaction, manual lifetime
/// tracking is required.
///
/// # Errors:
/// # Errors
/// * [`Status::INVALID_PARAMETER`] The write request contains device addresses that are not valid for the device.
/// * [`Status::OUT_OF_RESOURCES`] The request could not be completed due to a lack of resources.
/// * [`Status::MEDIA_CHANGED` `media_id` is not for the current medium.
@ -189,10 +189,10 @@ impl DiskIo2 {
/// Flushes all modified data to the physical device.
///
/// # Arguments:
/// # Arguments
/// * `token` - Transaction token for the asynchronous flush.
///
/// # Errors:
/// # Errors
/// * [`Status::OUT_OF_RESOURCES`] The request could not be completed due to a lack of resources.
/// * [`Status::MEDIA_CHANGED`] The medium in the device has changed since the last access.
/// * [`Status::NO_MEDIA`] There is no medium in the device.

2
uefi/src/proto/media/disk_info.rs
View file

@ -65,7 +65,7 @@ pub struct DeviceLocationInfo {
/// Either use [`DiskInfo::interface`] to determine what should be possible, or simply
/// try and handle the [`Status::UNSUPPORTED`] error return value.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// Provides the basic interfaces to abstract platform information regarding an IDE controller.
///
/// [`Protocol`]: uefi::proto::Protocol

4
uefi/src/proto/media/load_file.rs
View file

@ -19,7 +19,7 @@ use {
/// Used to obtain files, that are primarily boot options, from arbitrary
/// devices.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from
/// arbitrary devices.
///
@ -97,7 +97,7 @@ impl LoadFile {
/// The Load File2 protocol is used to obtain files from arbitrary devices that
/// are not boot options.
///
/// # UEFI Spec Description
/// # UEFI Specification
///
/// The EFI_LOAD_FILE2_PROTOCOL is a simple protocol used to obtain files from
/// arbitrary devices that are not boot options. It is used by LoadImage() when

2
uefi/src/proto/nvme/pass_thru.rs
View file

@ -34,7 +34,7 @@ pub type NvmeNamespaceId = u32;
/// It is designed as a foundational layer, leaving higher-level abstractions responsible for implementing
/// richer storage semantics, device-specific commands, and advanced use cases.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// The `EFI_NVM_EXPRESS_PASS_THRU_PROTOCOL` provides essential functionality for interacting
/// with NVMe controllers and namespaces. It allows sending NVMe commands to either the
/// controller itself or specific namespaces within the controller.

2
uefi/src/proto/pci/root_bridge.rs
View file

@ -21,7 +21,7 @@ use crate::Status;
/// Protocol that provides access to the PCI Root Bridge I/O protocol.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are
/// used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller.
#[derive(Debug)]

6
uefi/src/proto/scsi/pass_thru.rs
View file

@ -37,7 +37,7 @@ impl Default for ScsiTargetLun {
/// It is designed as a foundational layer, leaving higher-level abstractions responsible for implementing
/// richer storage semantics, device-specific commands, and advanced use cases.
///
/// # UEFI Spec Description
/// # UEFI Specification
/// Provides services that allow SCSI Pass Thru commands to be sent to SCSI devices attached to a SCSI channel. It also
/// allows packet-based commands (ATAPI cmds) to be sent to ATAPI devices attached to a ATA controller.
#[derive(Debug)]
@ -87,7 +87,7 @@ impl ExtScsiPassThru {
/// Iterate over all potential SCSI devices on this channel.
///
/// # Warning
/// # Warnings
/// Depending on the UEFI implementation, this does not only return all actually available devices.
/// Most implementations instead return a list of all possible fully-qualified device addresses.
/// You have to probe for availability yourself, using [`ScsiDevice::execute_command`].
@ -124,7 +124,7 @@ impl ExtScsiPassThru {
///
/// In the UEFI Specification, this corresponds to a (SCSI target, LUN) tuple.
///
/// # Warning
/// # Warnings
/// This does not actually have to correspond to an actual device!
/// You have to probe for availability before doing anything meaningful with it.
#[derive(Clone, Debug)]