Skip to content

Commit 2812468

Browse files
committed
doc: extend About section with Example Use Cases and more info
1 parent 1743690 commit 2812468

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,6 @@ You can use the abstractions for example to:
3232
- create OS-specific loaders and leverage UEFI boot service
3333
- access UEFI runtime services from an OS
3434

35-
All crates are compatible with all platforms that both the Rust compiler and
36-
UEFI support, such as `i686`, `x86_64`, and `aarch64`). Please note that we
37-
can't test all possible hardware/firmware/platform combinations.
38-
3935
[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface
4036

4137
![UEFI App running in QEMU](https://imgur.com/SFPSVuO.png)

uefi/src/lib.rs

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,27 @@
2828
//! _Note that for producing EFI images, you also need to use a corresponding
2929
//! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
3030
//!
31-
//! # Interaction with uefi services
31+
//! ## Example Use Cases
3232
//!
3333
//! With this crate you can write code for the pre- and post-exit boot services
34-
//! epochs. However, the `uefi` crate unfolds its true potential when
35-
//! interacting with UEFI boot services.
34+
//! epochs. However, the `uefi` crate unfolds its true potential when crafting
35+
//! EFI images interacting with UEFI boot services and eventually exiting them.
36+
//!
37+
//! By EFI images (`image.efi`), we are referring to EFI applications, EFI
38+
//! boot service drivers, and EFI runtime service drivers. An EFI application
39+
//! might be your OS-specific loader technically similar to _GRUB_ or _Limine_.
40+
//!
41+
//! You can also use this crate to parse the UEFI memory map when a bootloader,
42+
//! such as _GRUB_ or _Limine_, passed the UEFI memory map as part of the
43+
//! corresponding boot information to your kernel, or to access runtime services
44+
//! from your kernel. Hence, when you also use utilize `uefi` also in ELF
45+
//! binaries and are not limited to EFI images.
46+
//!
47+
//! ## Supported Architectures
48+
//!
49+
//! `uefi` is compatible with all platforms that both the Rust compiler and
50+
//! UEFI support, such as `i686`, `x86_64`, and `aarch64`. Please note that we
51+
//! can't test all possible hardware/firmware/platform combinations in CI.
3652
//!
3753
//! # Crate organisation
3854
//!

0 commit comments

Comments
 (0)