|
1 | 1 | // SPDX-License-Identifier: MIT OR Apache-2.0 |
2 | 2 |
|
| 3 | +//! # `uefi-rs` |
| 4 | +//! |
3 | 5 | //! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI]. |
4 | 6 | //! |
5 | 7 | //! This crate makes it easy to develop Rust software that leverages **safe**, |
|
208 | 210 | //! Licensed under either of [Apache License, Version 2.0][apache] or |
209 | 211 | //! [MIT license][mit] at your option. |
210 | 212 | //! |
211 | | -//! # Terminology |
212 | | -//! |
213 | | -//! Both "EFI" and "UEFI" can be used interchangeably, such as "UEFI image" or |
214 | | -//! "EFI image". We prefer "UEFI" in our crate and its documentation. |
| 213 | +//! # UEFI and `uefi-rs` Terminology |
| 214 | +//! |
| 215 | +//! Please look into the [specification][spec] for a comprehensive overview. In |
| 216 | +//! UEFI, both "EFI" and "UEFI" are often used interchangeably, such as |
| 217 | +//! "UEFI image" or "EFI image". We prefer "UEFI" in our crate and its |
| 218 | +//! documentation. |
| 219 | +//! |
| 220 | +//! ## Important UEFI Terms and Abstractions |
| 221 | +//! |
| 222 | +//! - **agent**: The entity (usually a driver or application) performing |
| 223 | +//! operations on a handle or protocol. |
| 224 | +//! - **controller**: A handle that represents a hardware device managed by |
| 225 | +//! drivers. |
| 226 | +//! - **device path**: A structured description of a device's location or |
| 227 | +//! access method, used for booting and device identification. |
| 228 | +//! - **driver binding**: A service that matches drivers to controllers and |
| 229 | +//! manages their lifecycle. |
| 230 | +//! - **image**: A loaded executable (e.g., UEFI application or driver) with its |
| 231 | +//! own execution context - an `.efi` file (PE/COFF executable). |
| 232 | +//! - **handle**: An opaque identifier representing a UEFI object to which |
| 233 | +//! protocols can be attached. |
| 234 | +//! - **protocol**: A standardized set of functions and data structures defining |
| 235 | +//! an interface for services. |
| 236 | +//! - **(protocol) interface**: A concrete implementation of a protocol attached |
| 237 | +//! to a handle. |
215 | 238 | //! |
216 | 239 | //! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/ |
217 | 240 | //! [UEFI]: https://uefi.org/ |
|
0 commit comments