|
28 | 28 | //! _Note that for producing EFI images, you also need to use a corresponding
|
29 | 29 | //! `uefi` compiler target of Rust, such as `x86_64-unknown-uefi`._
|
30 | 30 | //!
|
31 |
| -//! # Interaction with uefi services |
| 31 | +//! ## Example Use Cases |
32 | 32 | //!
|
33 | 33 | //! 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. |
36 | 52 | //!
|
37 | 53 | //! # Crate organisation
|
38 | 54 | //!
|
|
0 commit comments