Skip to content

Commit 0742202

Browse files
Add crate links to unknown-uefi.md
1 parent 1d8d7b1 commit 0742202

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

src/doc/rustc/src/platform-support/unknown-uefi.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ UEFI applications can be copied into the ESP on any UEFI system and executed
8888
via the firmware boot menu. The qemu suite allows emulating UEFI systems and
8989
executing UEFI applications as well. See its documentation for details.
9090

91-
The [uefi-run](https://github.com/Richard-W/uefi-run) rust tool is a simple
91+
The [uefi-run] rust tool is a simple
9292
wrapper around `qemu` that can spawn UEFI applications in qemu. You can install
9393
it via `cargo install uefi-run` and execute qemu applications as
9494
`uefi-run ./application.efi`.
@@ -132,19 +132,19 @@ have been developed to provide access to UEFI protocols and make UEFI
132132
programming more ergonomic in rust. The following list is a short overview (in
133133
alphabetical ordering):
134134

135-
- **efi**: *Ergonomic Rust bindings for writing UEFI applications*. Provides
135+
- **[efi][efi-crate]**: *Ergonomic Rust bindings for writing UEFI applications*. Provides
136136
_rustified_ access to UEFI protocols, implements allocators and a safe
137137
environment to write UEFI applications.
138-
- **r-efi**: *UEFI Reference Specification Protocol Constants and Definitions*.
138+
- **[r-efi]**: *UEFI Reference Specification Protocol Constants and Definitions*.
139139
A pure transpose of the UEFI specification into rust. This provides the raw
140140
definitions from the specification, without any extended helpers or
141141
_rustification_. It serves as baseline to implement any more elaborate rust
142142
UEFI layers.
143-
- **uefi-rs**: *Safe and easy-to-use wrapper for building UEFI apps*. An
143+
- **[uefi-rs]**: *Safe and easy-to-use wrapper for building UEFI apps*. An
144144
elaborate library providing safe abstractions for UEFI protocols and
145145
features. It implements allocators and provides an execution environment to
146146
UEFI applications written in rust.
147-
- **uefi-run**: *Run UEFI applications*. A small wrapper around _qemu_ to spawn
147+
- **[uefi-run]**: *Run UEFI applications*. A small wrapper around _qemu_ to spawn
148148
UEFI applications in an emulated `x86_64` machine.
149149

150150
## Example: Freestanding
@@ -311,3 +311,8 @@ pub fn main() {
311311
The current implementation of std makes `BootServices` unavailable once `ExitBootServices` is called. Refer to [Runtime Drivers](https://edk2-docs.gitbook.io/edk-ii-uefi-driver-writer-s-guide/7_driver_entry_point/711_runtime_drivers) for more information regarding how to handle switching from using physical addresses to using virtual addresses.
312312

313313
Note: It should be noted that it is up to the user to drop all allocated memory before `ExitBootServices` is called.
314+
315+
[efi-crate]: https://github.com/gurry/efi
316+
[r-efi]: https://github.com/r-efi/r-efi
317+
[uefi-rs]: https://github.com/rust-osdev/uefi-rs
318+
[uefi-run]: https://github.com/Richard-W/uefi-run

0 commit comments

Comments
 (0)