mirror of
https://github.com/rust-osdev/uefi-rs
synced 2026-06-08 17:17:36 +00:00
Deploy from CI
268 lines
16 KiB
HTML
268 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Creating a UEFI Application - Rust UEFI Book</title>
|
|
<!-- Custom HTML head -->
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff" />
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../highlight.css">
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
</head>
|
|
<body>
|
|
<!-- Provide site root to javascript -->
|
|
<script type="text/javascript">
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script type="text/javascript">
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script type="text/javascript">
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('no-js')
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add('js');
|
|
</script>
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script type="text/javascript">
|
|
var html = document.querySelector('html');
|
|
var sidebar = 'hidden';
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
}
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="../introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="../tutorial/introduction.html"><strong aria-hidden="true">2.</strong> Tutorial</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../tutorial/app.html" class="active"><strong aria-hidden="true">2.1.</strong> Creating a UEFI Application</a></li><li class="chapter-item expanded "><a href="../tutorial/building.html"><strong aria-hidden="true">2.2.</strong> Building</a></li><li class="chapter-item expanded "><a href="../tutorial/vm.html"><strong aria-hidden="true">2.3.</strong> Running in a VM</a></li><li class="chapter-item expanded "><a href="../tutorial/hardware.html"><strong aria-hidden="true">2.4.</strong> Running on Hardware</a></li></ol></li><li class="chapter-item expanded "><a href="../how_to/introduction.html"><strong aria-hidden="true">3.</strong> How-to</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../how_to/protocols.html"><strong aria-hidden="true">3.1.</strong> Using Protocols</a></li><li class="chapter-item expanded "><a href="../how_to/drawing.html"><strong aria-hidden="true">3.2.</strong> Drawing to the Screen</a></li><li class="chapter-item expanded "><a href="../how_to/building_drivers.html"><strong aria-hidden="true">3.3.</strong> Building drivers</a></li><li class="chapter-item expanded "><a href="../how_to/rust-std.html"><strong aria-hidden="true">3.4.</strong> Combining Rust std with uefi</a></li></ol></li><li class="chapter-item expanded "><a href="../concepts/introduction.html"><strong aria-hidden="true">4.</strong> Concepts</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../concepts/boot_stages.html"><strong aria-hidden="true">4.1.</strong> Boot Stages</a></li><li class="chapter-item expanded "><a href="../concepts/tables.html"><strong aria-hidden="true">4.2.</strong> Tables</a></li><li class="chapter-item expanded "><a href="../concepts/guid.html"><strong aria-hidden="true">4.3.</strong> GUID</a></li><li class="chapter-item expanded "><a href="../concepts/handles_and_protocols.html"><strong aria-hidden="true">4.4.</strong> Handles and Protocols</a></li><li class="chapter-item expanded "><a href="../concepts/device_paths.html"><strong aria-hidden="true">4.5.</strong> Device Paths</a></li><li class="chapter-item expanded "><a href="../concepts/variables.html"><strong aria-hidden="true">4.6.</strong> Variables</a></li><li class="chapter-item expanded "><a href="../concepts/gpt.html"><strong aria-hidden="true">4.7.</strong> GPT</a></li></ol></li><li class="chapter-item expanded "><a href="../reference.html"><strong aria-hidden="true">5.</strong> Reference</a></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|
<div class="left-buttons">
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</button>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Rust UEFI Book</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script type="text/javascript">
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="creating-a-uefi-application"><a class="header" href="#creating-a-uefi-application">Creating a UEFI application</a></h1>
|
|
<h2 id="install-dependencies"><a class="header" href="#install-dependencies">Install dependencies</a></h2>
|
|
<p>Follow the <a href="https://www.rust-lang.org/tools/install">Rust installation instructions</a> to set up Rust.</p>
|
|
<h2 id="create-a-minimal-application"><a class="header" href="#create-a-minimal-application">Create a minimal application</a></h2>
|
|
<p>Create an empty application and change to that directory:</p>
|
|
<pre><code class="language-sh">cargo new my-uefi-app
|
|
cd my-uefi-app
|
|
</code></pre>
|
|
<p>Add a few dependencies:</p>
|
|
<pre><code class="language-sh">cargo add log
|
|
cargo add uefi --features logger,panic_handler
|
|
</code></pre>
|
|
<p>to your <code>Cargo.toml</code>. The resulting <code>Cargo.toml</code> should look like that:</p>
|
|
<pre><code class="language-toml">[dependencies]
|
|
log = "0.4"
|
|
# Check crates.io for the latest version.
|
|
uefi = { version = "<latest, e.g. 0.36>", features = [ "panic_handler", "logger" ] }
|
|
</code></pre>
|
|
<p>Replace the contents of <code>src/main.rs</code> with this:</p>
|
|
<pre><pre class="playground"><code class="language-rust">#![no_main]
|
|
#![no_std]
|
|
|
|
use core::time::Duration;
|
|
use log::info;
|
|
use uefi::prelude::*;
|
|
|
|
#[entry]
|
|
fn main() -> Status {
|
|
uefi::helpers::init().unwrap();
|
|
info!("Hello world!");
|
|
boot::stall(Duration::from_secs(10));
|
|
Status::SUCCESS
|
|
}
|
|
</code></pre></pre>
|
|
<h2 id="walkthrough"><a class="header" href="#walkthrough">Walkthrough</a></h2>
|
|
<p>Let's look a quick look at what each part of the program is doing,
|
|
starting with the <code>#![...]</code> lines at the top:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span>#![no_main]
|
|
#![no_std]
|
|
<span class="boring">fn main() {
|
|
</span><span class="boring">}
|
|
</span></code></pre></pre>
|
|
<p>This is some boilerplate that all Rust UEFI applications will
|
|
need. <code>no_main</code> is needed because the UEFI application entry point is
|
|
different from the standard Rust <code>main</code> function. <code>no_std</code> is needed to
|
|
turn off the <code>std</code> library; the <code>core</code> and <code>alloc</code> crates can still be
|
|
used.</p>
|
|
<p>Next up are some <code>use</code> lines. Nothing too exciting here; the
|
|
<code>uefi::prelude</code> module is intended to be glob-imported, and exports a
|
|
number of commonly-used macros, modules, and types.</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>use core::time::Duration;
|
|
use log::info;
|
|
use uefi::prelude::*;
|
|
<span class="boring">}
|
|
</span></code></pre></pre>
|
|
<p>Now we get to the UEFI application <code>main</code> function, and here things look
|
|
a little different from a standard Rust program.</p>
|
|
<pre><pre class="playground"><code class="language-rust">#[entry]
|
|
fn main() -> Status {
|
|
</code></pre></pre>
|
|
<p>The <code>main</code> function in a UEFI application takes no arguments and returns
|
|
a <a href="https://docs.rs/uefi/latest/uefi/struct.Status.html"><code>Status</code></a>, which is essentially a numeric error (or success) code
|
|
defined by UEFI. The <code>main</code> function must be marked with the <code>#[entry]</code>
|
|
macro.</p>
|
|
<p>The first thing we do inside of <code>main</code> is initialize the <code>helpers</code>
|
|
module, which initializes logging:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span> uefi::helpers::init().unwrap();
|
|
<span class="boring">}
|
|
</span></code></pre></pre>
|
|
<p>Next we use the standard <code>log</code> crate to output "Hello world!". Then we
|
|
call <code>stall</code> to make the system pause for 10 seconds. This just ensures
|
|
you have enough time to see the output.</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span> info!("Hello world!");
|
|
boot::stall(Duration::from_secs(10));
|
|
<span class="boring">}
|
|
</span></code></pre></pre>
|
|
<p>Finally we return <code>Status::SUCCESS</code> indicating that everything completed
|
|
successfully:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span> Status::SUCCESS
|
|
}
|
|
<span class="boring">}
|
|
</span></code></pre></pre>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../tutorial/introduction.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
<a rel="next" href="../tutorial/building.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../tutorial/introduction.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
<a rel="next" href="../tutorial/building.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
window.playground_copyable = true;
|
|
</script>
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
</body>
|
|
</html>
|