You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rollup merge of #119937 - nicholasbishop:bishop-uefi-doc-improve, r=ehuss
Improve UEFI target docs
* Add a section showing exactly how to build a driver instead of an application
* Add links to the crates mentioned in the doc
CC `@dvdhrm`
UEFI applications can be copied into the ESP on any UEFI system and executed
88
104
via the firmware boot menu. The qemu suite allows emulating UEFI systems and
89
105
executing UEFI applications as well. See its documentation for details.
90
106
91
-
The [uefi-run](https://github.com/Richard-W/uefi-run) rust tool is a simple
107
+
The [uefi-run] rust tool is a simple
92
108
wrapper around `qemu` that can spawn UEFI applications in qemu. You can install
93
109
it via `cargo install uefi-run` and execute qemu applications as
94
110
`uefi-run ./application.efi`.
@@ -132,19 +148,19 @@ have been developed to provide access to UEFI protocols and make UEFI
132
148
programming more ergonomic in rust. The following list is a short overview (in
133
149
alphabetical ordering):
134
150
135
-
-**efi**: *Ergonomic Rust bindings for writing UEFI applications*. Provides
151
+
-**[efi][efi-crate]**: *Ergonomic Rust bindings for writing UEFI applications*. Provides
136
152
_rustified_ access to UEFI protocols, implements allocators and a safe
137
153
environment to write UEFI applications.
138
-
-**r-efi**: *UEFI Reference Specification Protocol Constants and Definitions*.
154
+
-**[r-efi]**: *UEFI Reference Specification Protocol Constants and Definitions*.
139
155
A pure transpose of the UEFI specification into rust. This provides the raw
140
156
definitions from the specification, without any extended helpers or
141
157
_rustification_. It serves as baseline to implement any more elaborate rust
142
158
UEFI layers.
143
-
-**uefi-rs**: *Safe and easy-to-use wrapper for building UEFI apps*. An
159
+
-**[uefi-rs]**: *Safe and easy-to-use wrapper for building UEFI apps*. An
144
160
elaborate library providing safe abstractions for UEFI protocols and
145
161
features. It implements allocators and provides an execution environment to
146
162
UEFI applications written in rust.
147
-
-**uefi-run**: *Run UEFI applications*. A small wrapper around _qemu_ to spawn
163
+
-**[uefi-run]**: *Run UEFI applications*. A small wrapper around _qemu_ to spawn
148
164
UEFI applications in an emulated `x86_64` machine.
149
165
150
166
## Example: Freestanding
@@ -311,3 +327,9 @@ pub fn main() {
311
327
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.
312
328
313
329
Note: It should be noted that it is up to the user to drop all allocated memory before `ExitBootServices` is called.
0 commit comments