Files
slimbootloader.github.io/how-tos/index.html

266 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How-Tos &mdash; Slim Bootloader 1.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<link rel="shortcut icon" href="../_static/sbl_logo_blue_32x32_icon.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Customize Build" href="customize-build.html" />
<link rel="prev" title="Firmware Resiliency and Recovery" href="../security/firmware-resiliency-and-recovery.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
Slim Bootloader
<img src="../_static/sbl_logo_white_200x200.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../supported-hardware/index.html">Supported Hardware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developer-guides/index.html">Developers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security/index.html">Security Features</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How-Tos</a><ul>
<li class="toctree-l2"><a class="reference internal" href="customize-build.html">Customize Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html">Change Boot Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-verified-boot.html">Enable Verified Boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html">Intel® TCC enable</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html">TSN</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-tsn-gbe-sgmii.html">Enable TSN GbE SGMII</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-pre-os-payload.html">Enable Pre-OS Payload Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="reduce-debug-message.html">Reduce debug messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-new-library.html">Add New Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-new-payload.html">Create New Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-new-payload.html#helloworld-payload">HelloWorld Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="integrate-multiple-payloads.html">Integrate Multiple Payloads</a></li>
<li class="toctree-l2"><a class="reference internal" href="create-container-boot-image.html">Create Container Boot Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="create-ias-boot-image.html">Create IAS Boot Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-windows.html">Boot Windows with UEFI Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-netboot.html">Netboot / PXE boot with UEFI Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-ubuntu.html">Boot Ubuntu</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-ubuntu.html#setup-spn-os-container-boot">Setup SBL OS Container Boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-vxworks.html">Boot VxWorks</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-zephyr.html">Boot Zephyr</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-micropython.html">Boot MicroPython</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html">Boot Linux as a Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html">Boot Linux with U-Boot Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-pxe-uboot.html">PXE Boot Through U-Boot Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="configure-memory-down.html">Configure Memory Down</a></li>
<li class="toctree-l2"><a class="reference internal" href="collect-time-logs.html">Capture Boot Time Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="configure_gpio.html">GPIO / CFIO Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configure_gpio.html#run-gengpiodata-tool">Run GenGpioData Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-fastboot.html">Add Fastboot Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html">Boot ACRN Hypervisor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specs/index.html">Specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../references/references.html">References and Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="../references/terminology.html">Terminology and Acronyms</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Slim Bootloader</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">How-Tos</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="how-tos">
<h1>How-Tos<a class="headerlink" href="#how-tos" title="Permalink to this heading"></a></h1>
<p>A collection of guides to make SBL to work for you.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="customize-build.html">Customize Build</a></li>
<li class="toctree-l1"><a class="reference internal" href="change-boot-option.html">Change Boot Options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html#change-at-pre-build-time">Change at Pre Build Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html#change-at-post-build-time">Change at Post Build time</a></li>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html#run-cfgdata-stitch-utility">Run CfgData Stitch Utility</a></li>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html#outputs">Outputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="change-boot-option.html#change-at-runtime">Change at Runtime</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="enable-verified-boot.html">Enable Verified Boot</a></li>
<li class="toctree-l1"><a class="reference internal" href="enable-intel-tcc.html">Intel® TCC enable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html#intel-tcc-overview">Intel® TCC overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html#intel-tcc-subregion">Intel® TCC subregion</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html#intel-tcc-detail-settings">Intel® TCC detail settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html#intel-tcc-rtcm-setting">Intel® TCC RTCM setting</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tcc.html#update-component-in-intel-tcc-subregion">Update component in Intel® TCC subregion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="enable-intel-tsn.html">TSN</a><ul>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html#tsn-container">TSN container</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html#different-options-to-update-tsn-container">Different options to update TSN container</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html#tsn-configuration-settings">TSN configuration settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-intel-tsn.html#tsn-capsule-generation">TSN capsule generation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="enable-tsn-gbe-sgmii.html">Enable TSN GbE SGMII</a><ul>
<li class="toctree-l2"><a class="reference internal" href="enable-tsn-gbe-sgmii.html#tsn-gbe-configuration-settings">TSN GbE configuration settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-tsn-gbe-sgmii.html#update-configuration-data-with-configeditor-gui">Update configuration data with ConfigEditor GUI</a></li>
<li class="toctree-l2"><a class="reference internal" href="enable-tsn-gbe-sgmii.html#update-configuration-data-directly-on-delta-file">Update configuration data directly on delta file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="enable-pre-os-payload.html">Enable Pre-OS Payload Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="reduce-debug-message.html">Reduce debug messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="add-new-library.html">Add New Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="add-new-payload.html">Create New Payload</a></li>
<li class="toctree-l1"><a class="reference internal" href="add-new-payload.html#helloworld-payload">HelloWorld Payload</a></li>
<li class="toctree-l1"><a class="reference internal" href="integrate-multiple-payloads.html">Integrate Multiple Payloads</a></li>
<li class="toctree-l1"><a class="reference internal" href="create-container-boot-image.html">Create Container Boot Image</a></li>
<li class="toctree-l1"><a class="reference internal" href="create-ias-boot-image.html">Create IAS Boot Image</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-windows.html">Boot Windows with UEFI Payload</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-netboot.html">Netboot / PXE boot with UEFI Payload</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-ubuntu.html">Boot Ubuntu</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-ubuntu.html#setup-spn-os-container-boot">Setup SBL OS Container Boot</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-vxworks.html">Boot VxWorks</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-zephyr.html">Boot Zephyr</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-zephyr.html#up2-board">UP<sup>2</sup> Board</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-zephyr.html#qemu">QEMU</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="boot-micropython.html">Boot MicroPython</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-micropython.html#how-to-build-micropython-payload-module">How to Build MicroPython Payload Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-micropython.html#how-to-integrate-micropython-into-slim-bootloader">How to Integrate MicroPython into Slim Bootloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-micropython.html#how-to-enable-micropython-for-other-platforms">How to Enable MicroPython for Other Platforms</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="boot-with-linux-payload.html">Boot Linux as a Payload</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html#building-the-kernel">Building the Kernel</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html#building-the-initramfs">Building the initramfs</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html#pre-built-image">Pre-built image</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html#enabling-linux-payload-for-sbl">Enabling Linux Payload for SBL</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-linux-payload.html#pxe-boot-using-linux-u-root">PXE Boot using Linux &amp; U-Root</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="boot-with-u-boot-payload.html">Boot Linux with U-Boot Payload</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#build-instruction-for-u-boot">Build Instruction for U-Boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#prepare-slim-bootloader">Prepare Slim Bootloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#build-instruction-for-qemu-target">Build Instruction for QEMU target</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#test-linux-booting-on-qemu-target">Test Linux booting on QEMU target</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#build-instruction-for-leafhill-apl-target">Build Instruction for LeafHill (APL) target</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-with-u-boot-payload.html#build-instruction-to-use-elf-u-boot">Build Instruction to use ELF U-Boot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="boot-pxe-uboot.html">PXE Boot Through U-Boot Payload</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-pxe-uboot.html#u-boot-confiugration-to-enable-pxe-boot-support">U-Boot Confiugration to enable PXE Boot Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-pxe-uboot.html#u-boot-device-tree-changes">U-Boot Device Tree Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-pxe-uboot.html#build-slim-bootloader-with-u-boot-as-payload">Build Slim Bootloader with U-Boot as Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-pxe-uboot.html#u-boot-shell-pxe-boot-commands">U-Boot Shell PXE Boot Commands</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configure-memory-down.html">Configure Memory Down</a></li>
<li class="toctree-l1"><a class="reference internal" href="collect-time-logs.html">Capture Boot Time Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="configure_gpio.html">GPIO / CFIO Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configure_gpio.html#gpio-config-data">GPIO config data</a></li>
<li class="toctree-l2"><a class="reference internal" href="configure_gpio.html#gengpiodata-tool">GenGpioData Tool</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configure_gpio.html#run-gengpiodata-tool">Run GenGpioData Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="add-fastboot.html">Add Fastboot Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="add-fastboot.html#load-from-usb">Load from USB</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-fastboot.html#load-from-spi">Load from SPI</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="boot-acrn.html">Boot ACRN Hypervisor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#build-spn">Build SBL</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#flash-spn">Flash SBL</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#boot-up">Boot Up</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#enter-fastboot-mode">Enter Fastboot Mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#acrn-how-to">ACRN How-To</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot-acrn.html#upgrade-spn">Upgrade SBL</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../security/firmware-resiliency-and-recovery.html" class="btn btn-neutral float-left" title="Firmware Resiliency and Recovery" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="customize-build.html" class="btn btn-neutral float-right" title="Customize Build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on Jun 27, 2025.
</span></p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>