| 1 |
# r-efi - UEFI Reference Specification Protocol Constants and Definitions |
| 2 |
|
| 3 |
## CHANGES WITH 5.3.0: |
| 4 |
|
| 5 |
* Remove the optional dependency on `compiler-builtins`, which was |
| 6 |
needed to build r-efi as part of rustc. This is no longer necessary. |
| 7 |
|
| 8 |
Contributions from: David Rheinsberg, Trevor Gross |
| 9 |
|
| 10 |
- Dußlingen, 2025-06-17 |
| 11 |
|
| 12 |
## CHANGES WITH 5.2.0: |
| 13 |
|
| 14 |
* Add the memory attribute protocol. |
| 15 |
|
| 16 |
Contributions from: David Rheinsberg, Oliver Smith-Denny |
| 17 |
|
| 18 |
- Dußlingen, 2024-12-22 |
| 19 |
|
| 20 |
## CHANGES WITH 5.1.0: |
| 21 |
|
| 22 |
* Mark `Guid::as_bytes` and `Guid::from_bytes` as `const fn`, aligning |
| 23 |
them with the other methods on `Guid`. This helps creating constant |
| 24 |
GUIDs via macros or other external helpers. |
| 25 |
|
| 26 |
Contributions from: Christopher Zurcher, David Rheinsberg |
| 27 |
|
| 28 |
- Dußlingen, 2024-09-01 |
| 29 |
|
| 30 |
## CHANGES WITH 5.0.0: |
| 31 |
|
| 32 |
* Change the type of the `unload` function-pointer of the Loaded Image |
| 33 |
Protocol to `Option<Unload>`, given that it can be `NULL` to indicate |
| 34 |
that the image cannot be unloaded. |
| 35 |
This is a major API break, but any users very likely need to adjust |
| 36 |
anyway to avoid NULL-derefs. |
| 37 |
|
| 38 |
Contributions from: David Rheinsberg, John Schock |
| 39 |
|
| 40 |
- Dußlingen, 2024-07-30 |
| 41 |
|
| 42 |
## CHANGES WITH 4.5.0: |
| 43 |
|
| 44 |
* Implement or derive more standard traits for UEFI base types. In |
| 45 |
particular, implement `[Partial]Eq`, `Hash`, `[Partial]Ord` for |
| 46 |
`Boolean`, `Status`, `Guid`, and network address types. |
| 47 |
|
| 48 |
* Fix the signature of `BootUninstallMultipleProtocolInterfaces` to |
| 49 |
match the UEFI specification. Note that it uses var-args and is thus |
| 50 |
not fully usable from stable Rust. |
| 51 |
|
| 52 |
Contributions from: Ayush Singh, David Rheinsberg, John Schock |
| 53 |
|
| 54 |
- Dußlingen, 2024-05-23 |
| 55 |
|
| 56 |
## CHANGES WITH 4.4.0: |
| 57 |
|
| 58 |
* Add definitions for `UNACCEPTED_MEMORY_TYPE`, media device subtypes |
| 59 |
for device paths, before-EBS and after-RTB event groups, missing |
| 60 |
memory attributes. |
| 61 |
|
| 62 |
* Add memory masks for common memory attribute classes. The symbol |
| 63 |
names are takend from EDK2, yet their purpose is defined in the |
| 64 |
specification. |
| 65 |
|
| 66 |
* New protocols: platform_driver_override, bus_specific_driver_override, |
| 67 |
driver_family_override, load_file, load_file2, pci-io |
| 68 |
|
| 69 |
Contributions from: David Rheinsberg, Dmitry Mostovenko, John Schock, |
| 70 |
Michael Kubacki |
| 71 |
|
| 72 |
- Dußlingen, 2024-03-27 |
| 73 |
|
| 74 |
## CHANGES WITH 4.3.0: |
| 75 |
|
| 76 |
* Change alignment of `Guid` to 4 (was 8 before). This deviates from |
| 77 |
the specification, but aligns with EDK2. This should fix alignment |
| 78 |
mismatches when combining r-efi with EDK2, or other UEFI |
| 79 |
implementations. |
| 80 |
|
| 81 |
* `Guid` gained a new constructor `from_bytes()` to allow creating |
| 82 |
GUID-abstractions from foreign types based on the standardized |
| 83 |
memory representation. |
| 84 |
|
| 85 |
* Add all configuration-table GUIDs mentioned in the spec. These are |
| 86 |
often rooted in external specifications, but are strongly related |
| 87 |
to UEFI. |
| 88 |
|
| 89 |
* Add configuration-table definitions for RT_PROPERTIES and |
| 90 |
CONFORMANCE_PROFILES. |
| 91 |
|
| 92 |
* New protocols: hii_package_list, absolute_pointer |
| 93 |
|
| 94 |
Contributions from: David Rheinsberg, John Schock, Michael Kubacki, |
| 95 |
Nicholas Bishop |
| 96 |
|
| 97 |
- Dußlingen, 2023-10-18 |
| 98 |
|
| 99 |
## CHANGES WITH 4.2.0: |
| 100 |
|
| 101 |
* Bump required compiler version to: rust-1.68 |
| 102 |
|
| 103 |
* New Protocols: debugport, debug-support, driver-diagnostics2, |
| 104 |
mp-services, shell, shell-dynamic-command, |
| 105 |
shell-parameters, udp-4, udp-6 |
| 106 |
|
| 107 |
* Use const-generics instead of ZSTs to represent dynamic trailing |
| 108 |
members in C structs. |
| 109 |
|
| 110 |
* The `examples` feature has been renamed to `native` (a backwards |
| 111 |
compatible feature is left in place). |
| 112 |
|
| 113 |
* Add support for riscv64. |
| 114 |
|
| 115 |
* Use the official rust `efiapi` calling convention. This was |
| 116 |
stabilized with rust-1.68. |
| 117 |
|
| 118 |
Contributions from: Ayush Singh, David Rheinsberg, Rob Bradford |
| 119 |
|
| 120 |
- Dußlingen, 2023-03-20 |
| 121 |
|
| 122 |
## CHANGES WITH 4.1.0: |
| 123 |
|
| 124 |
* New Protocols: device-path-{from,to}-text, ip4, ip6, managed-network, |
| 125 |
rng, service-binding, tcp4, tcp6, timestamp |
| 126 |
|
| 127 |
* `ImageEntryPoint` is now correctly annotated as `eficall`. |
| 128 |
|
| 129 |
* `Time` now derives `Default`. |
| 130 |
|
| 131 |
* Fix nullable function pointers to use `Option<fn ...>`. |
| 132 |
|
| 133 |
* Function prototypes now have an explicit type definition and can be |
| 134 |
used independent of their protocol definition. |
| 135 |
|
| 136 |
* The new `rust-dep-of-std` feature option allows pulling in r-efi |
| 137 |
into the rust standard library. It prepares the crate workspace to |
| 138 |
be suitable for the standard library. It has no use outside of this. |
| 139 |
|
| 140 |
* Adopt the MIT license as 3rd licensing option to allow for |
| 141 |
integration into the rust compiler and ecosystem. |
| 142 |
|
| 143 |
Contributions from: Ayush Singh, David Rheinsberg, Joe Richey |
| 144 |
|
| 145 |
- Tübingen, 2022-08-23 |
| 146 |
|
| 147 |
## CHANGES WITH 4.0.0: |
| 148 |
|
| 149 |
* Convert all enums to constants with type-aliases. This is an API |
| 150 |
break, but it is needed for spec-compliance. With the old enums, one |
| 151 |
couldn't encode all the possible values defined by the spec. |
| 152 |
Especially, the vendor-reserved ranges were unable to be encoded in |
| 153 |
a safe manner. Also see commit 401a91901e860 for a detailed |
| 154 |
discussion. |
| 155 |
API users likely need to convert their CamelCase enum usage to the |
| 156 |
new UPPER_CASE constants. |
| 157 |
|
| 158 |
* Convert all incomplete types to empty arrays. This affects all |
| 159 |
structures that use trailing unbound arrays. These are actually ABI |
| 160 |
incompatible with UEFI, since rust represents raw-pointers to such |
| 161 |
types as fat-pointers. Such arrays have now been converted to empty |
| 162 |
arrays, which should still allow accessing the memory location and |
| 163 |
retaining structure properties, but avoids fat-pointers. |
| 164 |
This is an API break, so you might have to adjust your accessors of |
| 165 |
those trailing structure members. |
| 166 |
|
| 167 |
* Implement `Clone` and `Copy` for most basic structures. Since these |
| 168 |
are used as plain carriers, no higher clone/copy logic is needed. It |
| 169 |
should be clear from the project-description, that only basic UEFI |
| 170 |
compatibility is provided. |
| 171 |
|
| 172 |
* Add the console-control vendor protocol. This protocol allows |
| 173 |
controlling console properties. It is not part of the UEFI |
| 174 |
specification, but rather defined by the TianoCore project. |
| 175 |
|
| 176 |
* Add a new example showing how to use the GOP functions to query the |
| 177 |
active graphics device. |
| 178 |
|
| 179 |
Contributions from: David Rheinsberg, GGRei, Hiroki Tokunaga, |
| 180 |
Richard Wiedenhöft |
| 181 |
|
| 182 |
- Tübingen, 2021-06-23 |
| 183 |
|
| 184 |
## CHANGES WITH 3.2.0: |
| 185 |
|
| 186 |
* Add new protocols: DiskIo, DiskIo2, BlockIo, DriverBinding |
| 187 |
|
| 188 |
* Extend the Device-Path payload structure and add the HardDriveMedia |
| 189 |
payload. |
| 190 |
|
| 191 |
* Add HII definitions: A new top-level module `hii` with all the basic |
| 192 |
HII constants, as well as a handful of HII protocols (hii_database, |
| 193 |
hii_font, hii_string) |
| 194 |
|
| 195 |
* Document new `-Zbuild-std` based cross-compilation, serving as |
| 196 |
official rust alternative to cargo-xbuild. |
| 197 |
|
| 198 |
Contributions from: Alex James, Bret Barkelew, David Rheinsberg, |
| 199 |
Michael Kubacki |
| 200 |
|
| 201 |
- Tübingen, 2020-10-23 |
| 202 |
|
| 203 |
## CHANGES WITH 3.1.0: |
| 204 |
|
| 205 |
* Add the basic networking types to `r_efi::base`. This includes MAC |
| 206 |
and IP address types. |
| 207 |
|
| 208 |
* Add the EFI_SIMPLE_NETWORK_PROTOCOL definitions and all required |
| 209 |
constants to make basic networking available. |
| 210 |
|
| 211 |
* Add a new uefi-cross example, which is copied from upstream rustc |
| 212 |
sources, so we can test local modifications to it. |
| 213 |
|
| 214 |
Contributions from: Alex James, David Rheinsberg |
| 215 |
|
| 216 |
- Tübingen, 2020-09-10 |
| 217 |
|
| 218 |
## CHANGES WITH 3.0.0: |
| 219 |
|
| 220 |
* Fix a missing parameter in `BootServices::locate_device_path()`. The |
| 221 |
prototype incorrectly had 2 arguments, while the official version |
| 222 |
takes 3. The final `handle` argument was missing. |
| 223 |
This is an API break in `r-efi`. It should have a limited impact, |
| 224 |
since the function was mostly useless without a handle. |
| 225 |
Thanks to Michael Kubacki for catching this! |
| 226 |
|
| 227 |
* Adjust the `device_path` parameter in a bunch of `BootServices` |
| 228 |
calls. This used to take a `*mut c_void` parameter, since the device |
| 229 |
path protocol was not implemented. |
| 230 |
Since we have to bump the major version anyway, we use this to also |
| 231 |
fix these argument-types to the correct device-path protocol type, |
| 232 |
which has been implemented some time ago. |
| 233 |
|
| 234 |
Contributions from: David Rheinsberg, Michael Kubacki |
| 235 |
|
| 236 |
- Tübingen, 2020-04-24 |
| 237 |
|
| 238 |
## CHANGES WITH 2.2.0: |
| 239 |
|
| 240 |
* Provide `as_usize()` accessor for `efi::Status` types. This allows |
| 241 |
accessing the raw underlying value of a status object. |
| 242 |
|
| 243 |
* The project moved to its new home at: github.com/r-efi/r-efi |
| 244 |
|
| 245 |
Contributions from: David Rheinsberg, Joe Richey |
| 246 |
|
| 247 |
- Tübingen, 2020-04-16 |
| 248 |
|
| 249 |
## CHANGES WITH 2.1.0: |
| 250 |
|
| 251 |
* Add the graphics-output-protocol. |
| 252 |
|
| 253 |
* Expose reserved fields in open structures, otherwise they cannot be |
| 254 |
instantiated from outside the crate itself. |
| 255 |
|
| 256 |
Contributions from: David Herrmann, Richard Wiedenhöft, Rob Bradford |
| 257 |
|
| 258 |
- Tübingen, 2019-03-20 |
| 259 |
|
| 260 |
## CHANGES WITH 2.0.0: |
| 261 |
|
| 262 |
* Add a set of UEFI protocols, including simple-text-input, |
| 263 |
file-protocol, simple-file-system, device-path, and more. |
| 264 |
|
| 265 |
* Fix signature of `BootServices::allocate_pages`. |
| 266 |
|
| 267 |
Contributions from: David Rheinsberg, Richard Wiedenhöft, Tom Gundersen |
| 268 |
|
| 269 |
- Tübingen, 2019-03-01 |
| 270 |
|
| 271 |
## CHANGES WITH 1.0.0: |
| 272 |
|
| 273 |
* Enhance the basic UEFI type integration with the rust ecosystem. Add |
| 274 |
`Debug`, `Eq`, `Ord`, ... derivations, provide converters to/from the |
| 275 |
core library, and document the internal workings. |
| 276 |
|
| 277 |
* Fix `Boolean` to use `newtype(u8)` to make it ABI compatible to UEFI. |
| 278 |
This now accepts any byte value that UEFI accetps without any |
| 279 |
conversion required. |
| 280 |
|
| 281 |
Contributions from: Boris-Chengbiao Zhou, David Rheinsberg, Tom |
| 282 |
Gundersen |
| 283 |
|
| 284 |
- Tübingen, 2019-02-14 |
| 285 |
|
| 286 |
## CHANGES WITH 0.1.1: |
| 287 |
|
| 288 |
* Feature gate examples to make `cargo test` work on non-UEFI systems |
| 289 |
like CI. |
| 290 |
|
| 291 |
Contributions from: David Herrmann |
| 292 |
|
| 293 |
- Tübingen, 2018-12-10 |
| 294 |
|
| 295 |
## CHANGES WITH 0.1.0: |
| 296 |
|
| 297 |
* Initial release of r-efi. |
| 298 |
|
| 299 |
Contributions from: David Herrmann |
| 300 |
|
| 301 |
- Tübingen, 2018-12-10 |