Merge branch 'main' into main

Author: sky5454

.editorconfig

@@ -12,6 +12,6 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 
-[*.{json,md,nix,yml}]
+[*.{json,md,nix,toml,yml}]
 indent_style = space
 indent_size = 2

.github/workflows/qa.yml

@@ -7,4 +7,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       # Executes "typos ."
-      - uses: crate-ci/typos@v1.19.0
+      - uses: crate-ci/typos@v1.20.8

.github/workflows/rust.yml

@@ -11,6 +11,8 @@ on:
       - version-*
   schedule:
     - cron: '0 0 * * 0-6'
+env:
+  RUSTFLAGS: -D warnings
 jobs:
   test_aarch64:
     name: Integration Test (AArch64)

.typos.toml

@@ -2,12 +2,19 @@
 
 [files]
 extend-exclude = [
-    # "uefi/src/table/boot.rs"
+  # Generated sources
+  "uefi/src/proto/device_path/device_path_gen.rs"
+]
+
+[default]
+extend-ignore-identifiers-re = [
+  # uefi-raw/src/protocol/device_path.rs
+  "PnP"
 ]
 
 [default.extend-words]
-# FOOBAR = "FOOBAR"
+# ./uefi-test-runner/src/proto/device_path.rs:92:14
+HD = "HD"
 
 [default.extend-identifiers]
-# FOOBAR = "FOOBAR"
 

Cargo.lock

@@ -2,70 +2,100 @@
 
 [![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
 [![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
-![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
 ![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
 ![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
+![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)
 
 ## Description
 
-[UEFI] is the successor to the BIOS. It provides an early boot environment for
-OS loaders, hypervisors and other low-level applications. While it started out
-as x86-specific, it has been adopted on other platforms, such as ARM.
+[UEFI] started as the successor firmware to the BIOS in x86 space and developed
+to a universal firmware specification for various platforms, such as ARM. It
+provides an early boot environment with a variety of [specified][spec]
+ready-to-use "high-level" functionality, such as accessing disks or the network.
+EFI images, the files that can be loaded by an UEFI environment, can leverage
+these abstractions to extend the functionality in form of additional drivers,
+OS-specific bootloaders, or different kind of low-level applications.
+
+Our mission is to provide **safe** and **performant** wrappers for UEFI
+interfaces, and allow developers to write idiomatic Rust code.
+
+This repository provides various crates:
+
+- `uefi-raw`: Raw Rust UEFI bindings for basic structures and functions.
+- `uefi`: High-level wrapper around various low-level UEFI APIs. \
+  Offers various optional features for typical Rust convenience, such as a
+  Logger and an Allocator. (_This is what you are usually looking for!_)
+- `uefi-macros`: Helper macros. Used by `uefi`.
 
-This crate makes it easy to both:
-  - Write UEFI applications in Rust (for `i686`, `x86_64`, or `aarch64`)
-  - Call UEFI functions from an OS (usually built with a [custom target][rustc-custom])
 
-The objective is to provide **safe** and **performant** wrappers for UEFI interfaces,
-and allow developers to write idiomatic Rust code.
+You can use the abstractions for example to:
 
-Check out [the UEFI application template](template) for a quick start.
+- create OS-specific loaders and leverage UEFI boot service
+- access UEFI runtime services from an OS
+
+All crates are compatible with all platforms that both the Rust compiler and
+UEFI support, such as `i686`, `x86_64`, and `aarch64`). Please note that we
+can't test all possible hardware/firmware/platform combinations.
 
 [UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface
-[rustc-custom]: https://doc.rust-lang.org/rustc/targets/custom.html
 
-![uefi-rs running in QEMU](https://imgur.com/SFPSVuO.png)
+![UEFI App running in QEMU](https://imgur.com/SFPSVuO.png)
+Screenshot of an application running in QEMU on an UEFI firmware that leverages
+our Rust library.
+
+## User Documentation
+
+<!-- KEEP IN SYNC WITH uefi/README -->
+
+For a quick start, please check out [the UEFI application template](template).
+
+The [uefi-rs book] contains a tutorial, how-tos, and overviews of some important
+UEFI concepts. Reference documentation for the various crates can be found on
+[docs.rs]:
+
+- [docs.rs/uefi](https://docs.rs/uefi)
+- [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
+- [docs.rs/uefi-raw](https://docs.rs/uefi-raw)
+
+For additional information, refer to the [UEFI specification][spec].
+
+[spec]: https://uefi.org/specs/UEFI/2.10
+[uefi-rs book]: https://rust-osdev.github.io/uefi-rs/HEAD
+[docs.rs]: https://docs.rs
+
+### MSRV
+
+See the [uefi package's README](uefi/README.md#MSRV).
 
-## Project structure
+## Developer Guide
+
+### Project structure
 
 This project contains multiple sub-crates:
 
 - `uefi`: defines the standard UEFI tables / interfaces.
   The objective is to stay unopinionated and safely wrap most interfaces.
 
-- `uefi-macros`: procedural macros that are used to derive some traits in `uefi`.
+- `uefi-macros`: procedural macros that are used to derive some traits
+  in `uefi`.
 
 - `uefi-raw`: raw types that closely match the definitions in the UEFI
   Specification. Safe wrappers for these types are provided by the `uefi`
   crate. The raw types are suitable for implementing UEFI firmware.
 
-- `uefi-services`: provides a panic handler, and initializes the `alloc` / `logger` features.
+- `uefi-services`: provides a panic handler, and initializes
+  the `alloc` / `logger` features.
 
 - `uefi-test-runner`: a UEFI application that runs unit / integration tests.
 
 [log]: https://github.com/rust-lang-nursery/log
 
-## Documentation
-
-The [uefi-rs book] contains a tutorial, how-tos, and overviews of some
-important UEFI concepts.
-
-Reference documentation can be found on docs.rs:
-- [docs.rs/uefi](https://docs.rs/uefi)
-- [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
-- [docs.rs/uefi-raw](https://docs.rs/uefi-raw)
-- [docs.rs/uefi-services](https://docs.rs/uefi-services)
-
-For additional information, refer to the [UEFI specification][spec].
-
-[spec]: http://www.uefi.org/specifications
-[uefi-rs book]: https://rust-osdev.github.io/uefi-rs/HEAD
-
-## Building and testing uefi-rs
+### Building and testing uefi-rs
 
 Use the `cargo xtask` command to build and test the crate.
 
 Available commands:
+
 - `build`: build all the UEFI packages
   - `--release`: build in release mode
   - `--target {x86_64,ia32,aarch64}`: choose target UEFI arch
@@ -77,9 +107,10 @@ Available commands:
   - `--warnings-as-errors`: treat warnings as errors
 - `run`: build `uefi-test-runner` and run it in QEMU
   - `--ci`: disable some tests that don't work in the CI
-  - `--disable-kvm`: disable hardware accelerated virtualization support in QEMU.
-                     Especially useful if you want to run the tests under
-                     [WSL](https://docs.microsoft.com/en-us/windows/wsl) on Windows.
+  - `--disable-kvm`: disable hardware accelerated virtualization support in
+    QEMU.
+    Especially useful if you want to run the tests under
+    [WSL](https://docs.microsoft.com/en-us/windows/wsl) on Windows.
   - `--example <NAME>`: run an example instead of the main binary.
   - `--headless`: run QEMU without a GUI
   - `--ovmf-code <PATH>`: path of an OVMF code file
@@ -94,18 +125,16 @@ most of the library's functionality.
 Check out the testing project's [`README.md`](uefi-test-runner/README.md) for
 prerequisites for running the tests.
 
-## MSRV
-
-See the [uefi package's README](uefi/README.md#MSRV).
-
 ## Contributing
 
-We welcome issues and pull requests! For instructions on how to set up a development
-environment and how to add new protocols, check out [CONTRIBUTING.md](CONTRIBUTING.md).
+We welcome issues and pull requests! For instructions on how to set up a
+development environment and how to add new protocols, check out
+[CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
 The code in this repository is licensed under the Mozilla Public License 2.
-This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced.
+This license allows you to use the crate in proprietary programs, but any
+modifications to the files must be open-sourced.
 
 The full text of the license is available in the [license file](LICENSE).

README.md

@@ -1,14 +1,14 @@
 {
     "nixpkgs": {
-        "branch": "nixos-23.05",
+        "branch": "nixos-23.11",
         "description": "Nix Packages collection",
         "homepage": null,
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "da4024d0ead5d7820f6bd15147d3fe2a0c0cec73",
-        "sha256": "1y12a4hgxx2lixrcbyhycwxvrrfik1lxjnwkprar0r6173rwy9ax",
+        "rev": "e38d7cb66ea4f7a0eb6681920615dfcc30fc2920",
+        "sha256": "1shml3mf52smfra0x3mpfixddr4krp3n78fc2sv07ghiphn22k43",
         "type": "tarball",
-        "url": "https://github.com/NixOS/nixpkgs/archive/da4024d0ead5d7820f6bd15147d3fe2a0c0cec73.tar.gz",
+        "url": "https://github.com/NixOS/nixpkgs/archive/e38d7cb66ea4f7a0eb6681920615dfcc30fc2920.tar.gz",
         "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
     },
     "rust-overlay": {
@@ -17,10 +17,10 @@
         "homepage": "",
         "owner": "oxalica",
         "repo": "rust-overlay",
-        "rev": "e485313fc485700a9f1f9b8b272ddc0621d08357",
-        "sha256": "1v1gq022rnni6mm42pxmw6c5yy9il4jb2l92irh154ax616x2rzd",
+        "rev": "ece8bdb3c3b58def25f204b9a1261dee55d7c9c0",
+        "sha256": "1avinp5vcaicbjssmfwwfii5v8gab6ygh2hfmg4jli822469p5si",
         "type": "tarball",
-        "url": "https://github.com/oxalica/rust-overlay/archive/e485313fc485700a9f1f9b8b272ddc0621d08357.tar.gz",
+        "url": "https://github.com/oxalica/rust-overlay/archive/ece8bdb3c3b58def25f204b9a1261dee55d7c9c0.tar.gz",
         "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
     }
 }

nix/sources.json

@@ -6,4 +6,3 @@ publish = false
 
 [dependencies]
 uefi = { version = "0.27.0", features = ["alloc"] }
-uefi-services = "0.24.0"