mirror of
https://github.com/rust-osdev/uefi-rs
synced 2026-06-08 17:17:36 +00:00
Deploy from CI
236 lines
15 KiB
HTML
236 lines
15 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Running on Hardware - 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"><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" class="active"><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="running-on-hardware"><a class="header" href="#running-on-hardware">Running on Hardware</a></h1>
|
|
<p>Prerequisite: To allow loading your unsigned binary on your personal machine,
|
|
<a href="https://en.wikipedia.org/wiki/UEFI#Secure_Boot">secure boot</a> needs to be disabled in the BIOS setup.</p>
|
|
<p>To run on real hardware you'll need a specially-prepared USB drive.</p>
|
|
<h2 id="preparation"><a class="header" href="#preparation">Preparation</a></h2>
|
|
<p>The general steps to prepare the drive are:</p>
|
|
<ol>
|
|
<li>Partition the drive using <a href="https://en.wikipedia.org/wiki/GUID_Partition_Table">GPT</a>.</li>
|
|
<li>Create a partition.</li>
|
|
<li>Set the partition type GUID to
|
|
<code>C12A7328-F81F-11D2-BA4B-00A0C93EC93B</code>. That marks it as an EFI
|
|
System partition. (On many UEFI implementations this is not strictly
|
|
necessary, see note below.)</li>
|
|
<li>Format the partition as <a href="https://en.wikipedia.org/wiki/File_Allocation_Table">FAT</a>.</li>
|
|
<li>Mount the partition.</li>
|
|
<li>Create the directory path <code>EFI/BOOT</code> on the partition. (FAT is case
|
|
insensitive, so capitalization doesn't matter.)</li>
|
|
<li>Copy your EFI application to a file under <code>EFI/BOOT</code>. The file name
|
|
is specific to the architecture. For example, on x86_64 the file name
|
|
must be <code>BOOTX64.EFI</code>. See the <a href="../concepts/gpt.html#system-partition">boot files</a> table for other
|
|
architectures.</li>
|
|
</ol>
|
|
<p>The details of exactly how to do these steps will vary depending on your OS.</p>
|
|
<p>Note that most UEFI implementations do not strictly require GPT
|
|
partitioning or the EFI System partition GUID; they will look for any
|
|
FAT partition with the appropriate directory structure. This is not
|
|
required however; the UEFI Specification says "UEFI implementations may
|
|
allow the use of conforming FAT partitions which do not use the ESP
|
|
GUID."</p>
|
|
<h3 id="example-on-linux"><a class="header" href="#example-on-linux">Example on Linux</a></h3>
|
|
<p><strong>Warning: these operations are destructive! Do not run these commands
|
|
on a disk if you care about the data it contains.</strong></p>
|
|
<pre><code class="language-sh"># Create the GPT, create a 9MB partition starting at 1MB, and set the
|
|
# partition type to EFI System.
|
|
sgdisk \
|
|
--clear \
|
|
--new=1:1M:10M \
|
|
--typecode=1:C12A7328-F81F-11D2-BA4B-00A0C93EC93B \
|
|
/path/to/disk
|
|
|
|
# Format the partition as FAT.
|
|
mkfs.fat /path/to/disk_partition
|
|
|
|
# Mount the partition.
|
|
mkdir esp
|
|
mount /path/to/disk_partition esp
|
|
|
|
# Create the boot directory.
|
|
mkdir esp/EFI/BOOT
|
|
|
|
# Copy in the boot executable.
|
|
cp /path/to/your-executable.efi esp/EFI/BOOT/BOOTX64.EFI
|
|
</code></pre>
|
|
<h2 id="booting-the-usb"><a class="header" href="#booting-the-usb">Booting the USB</a></h2>
|
|
<p>Insert the USB into the target computer. Reboot the machine, then press
|
|
the one-time boot key. Which key to press depends on the vendor. For
|
|
example, Dell uses F12, HP uses F9, and on Macs you hold down the Option
|
|
key.</p>
|
|
<p>Once the one-time boot menu appears, select your USB drive and press enter.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../tutorial/vm.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="../how_to/introduction.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/vm.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="../how_to/introduction.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>
|