uefi-rs

Crates.io Docs.rs Stars License Build status

[UEFI] is the successor to the BIOS. It provides an early boot environment for OS loaders, hypervisors and other low-level applications.

The uefi crate makes it easy to: - Write UEFI applications in Rust (for i686, x86_64, or aarch64) - Call UEFI functions from an OS (usually built with a custom target)

The objective is to provide safe and performant wrappers for UEFI interfaces, and allow developers to write idiomatic Rust code.

Check out the [UEFI application template] for a quick start.

Optional features

This crate's features are described in [src/lib.rs].

See also the [uefi-services] crate, which provides a panic handler and initializes the global_allocator and logger features.

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 - docs.rs/uefi-macros - docs.rs/uefi-services

For additional information, refer to the UEFI specification.

Building UEFI programs

For instructions on how to create your own UEFI apps, see the [tutorial].

The uefi-rs crates currently require some [unstable features]. The nightly MSRV is currently 2022-08-25.

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.

The full text of the license is available in the license file.