Deploy slimbootloader/documentation to github.com/slimbootloader/slimbootloader.github.io.git:master

This commit is contained in:
Sabryna (via Travis CI)
2025-06-16 03:14:55 +00:00
parent 6bde63b366
commit 5d18d933b5
124 changed files with 200 additions and 166 deletions
BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 290 KiB

BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 149 KiB

BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 259 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 62 KiB

@@ -22,11 +22,15 @@ Prerequisite
<a href="https://firmware.intel.com/develop/intel-uefi-tools-and-utilities/intel-uefi-development-kit-debugger-tool#overlay-context=develop" target="_blank">Intel UDK Debugger</a>
* The Intel |copy| UDK Debugger can be downloaded |here| for Windows and Linux, install Intel UDK Debugger with default configuration values.
* The Intel |copy| UDK Debugger can be downloaded |here| for Windows and |this| for Linux, install Intel UDK Debugger with default configuration values.
.. |here| raw:: html
<a href="https://firmware.intel.com/develop/intel-uefi-tools-and-utilities/intel-uefi-development-kit-debugger-tool#overlay-context=develop" target="_blank">here</a>
<a href="https://www.intel.com/content/dam/develop/external/us/en/documents/udk-debugger-tool-v1-5-win.zip" target="_blank">here</a>
.. |this| raw:: html
<a href="https://www.intel.com/content/dam/develop/external/us/en/documents/udk-debugger-tool-v1-5-1-linux.zip" target="_blank">this</a>
* Install |Windows Debug Tool(WinDbg)| with default configuration values.
@@ -11,7 +11,7 @@ Build Environment
Building on Linux
^^^^^^^^^^^^^^^^^^^^
Supported environment: **Ubuntu Linux 18.04 LTS**
Supported environment: **Ubuntu Linux 22.04 LTS**
Install the following software:
@@ -45,7 +45,7 @@ You can also consider Dockers containers to build |SPN|. See :ref:`misc_setup_do
Building on Windows
^^^^^^^^^^^^^^^^^^^^^
Supported environment: **Microsoft Visual Studio 2015 or Microsoft Visual Studio 2017 Community**
Supported environment: **Microsoft Visual Studio 2019 or Microsoft Visual Studio 2022 Community**
Please ensure to install **Dekstop Development with C++** along with Microsoft Visual Studio installation.
Install the **exact** versions (if specified) of the following tools to the designated directories:
@@ -15,7 +15,7 @@ Download |SPN|
Source code is available on GitHub::
git clone https://github.com/slimbootloader/slimbootloader.git
git clone https://github.com/slimbootloader/slimbootloader.git slimbootloader
cd slimbootloader
git submodule update --init --recursive
@@ -34,7 +34,7 @@ Build |SPN|
Example: python BuildLoader.py build qemu
For more details on the build tool, see :ref:`build-tool`.
For more details on the build options & tool, see :ref:`build-tool`.
Build Outputs
+2 -2
View File
@@ -81,9 +81,9 @@ Does it support RTOS?
|SPN| features loading x86 ELF executables in its payload stage. We have verified loading Open Source Zephyr RTOS (See :ref:`boot-zephyr`).
What tool chains are supported to compile |SPN|?
|SPN| supports Microsoft Visual Studio 2015/2017 and GNU GCC toolchains (gcc 7 or newer). Additional tools including Python (3.6), nasm, and IASL are required to build |SPN|.
|SPN| supports Microsoft Visual Studio 2015-2022 and GNU GCC toolchains (gcc 7 or newer). Additional tools including Python (3.10), nasm, and IASL are required to build |SPN|.
The current version of BaseTools is UDK2018 from EDKII open source project.
The current version of BaseTools is UDK2023 from EDKII open source project.
Does |SPN| support verified boot and measured boot?
Yes. |SPN| supports both from software point of view. In order to enable hardware root-of-trust in |SPN|, the Intel stitching software kit is required. For measured boot, |SPN| supports TPM (Trusted Platform Module) 2.0.
@@ -4,7 +4,13 @@ Exercise \\- \ Build |SPN| for QEMU
------------------------------------------
.. note::
**In this exercise, we'll learn how to build SBL for QEMU emulator.**
**In this exercise, we'll learn how to build SBL for |QEMU emulator|.**
|QEMU emulator|.
.. |QEMU emulator| raw:: html
<a href="https://www.qemu.org/download/" target="_blank">QEMU emulator</a>
You can build |SPN| with the following steps:
@@ -10,11 +10,9 @@ Prepare SBL QEMU image
By default, SBL uses compile optimization for binary size and code speed.
The compile optimization sometime makes source level debugging hard to use.
To demonstrate better source level debugging, let's lower the compile optimization level for this tutorial session.
'--noopt' will generate less optimized image, but still link time optimization is done to avoid very big size image. ::
$ cd /path/to/slimbootloader/
$ python BuildLoader.py build qemu --noopt
$ python BuildLoader.py build qemu
Launch QEMU target
^^^^^^^^^^^^^^^^^^
+20 -8
View File
@@ -15,24 +15,32 @@ You can execute |SPN| with the following steps:
2. Execute cmd on Shell by type-in:
+------------+------------------------------------------------+
| **acpi** | \\- \ Display ACPI table data |
+------------+------------------------------------------------+
| **boot** | \\- \ Print or modify the OS boot option list |
+------------+------------------------------------------------+
| **cdata** | \\- \ Display configuration data |
+------------+------------------------------------------------+
| **cls** | \\- \ Clear console |
+------------+------------------------------------------------+
| **cpuid** | \\- \ Read CPU specific information |
+------------+------------------------------------------------+
| **dmesg** | \\- \ Print messages stored in boot log buffer |
+------------+------------------------------------------------+
| **exit** | \\- \ Exit the shell |
+------------+------------------------------------------------+
| **fs** | \\- \ filesystem access command |
+------------+------------------------------------------------+
| **help** | \\- \ List supported commands |
+------------+------------------------------------------------+
| **hob** | \\- \ List HOBs |
+------------+------------------------------------------------+
| **mem** | \\- \ Read or write system memory |
| **mm** | \\- \ Read or write system memory |
+------------+------------------------------------------------+
| **mmap** | \\- \ Display memory map |
+------------+------------------------------------------------+
| **perf** | \\- \ Display performance data |
+------------+------------------------------------------------+
| **boot** | \\- \ Print or modify the OS boot option list |
+------------+------------------------------------------------+
| **cpuid** | \\- \ Read CPU specific information |
+------------+------------------------------------------------+
| **io** | \\- \ Read or write I/O ports |
| **mmcdll**| \\- \ Tune or print MMC DLL data |
+------------+------------------------------------------------+
| **msr** | \\- \ Read or write model specific registers |
+------------+------------------------------------------------+
@@ -40,10 +48,14 @@ You can execute |SPN| with the following steps:
+------------+------------------------------------------------+
| **pci** | \\- \ Display PCI devices (example) |
+------------+------------------------------------------------+
| **perf** | \\- \ Display performance data |
+------------+------------------------------------------------+
| **reset** | \\- \ Reset the system |
+------------+------------------------------------------------+
| **ucode** | \\- \ Display microcode version |
+------------+------------------------------------------------+
| **usbdev**| \\- \ Display USB devices |
+------------+------------------------------------------------+
+1 -1
View File
@@ -337,7 +337,7 @@ function to retrieve the location.</p>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -204,7 +204,7 @@
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -242,7 +242,7 @@ to by the Firmware Performance Data Table (FPDT). Refer to ACPI Specification fo
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -142,7 +142,7 @@ and can also load the boot image from a raw partition using the LBA number.</p>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -463,7 +463,7 @@ components inside it</p>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -520,7 +520,7 @@ for GPP_A3, and GPP_A4</p>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -153,7 +153,7 @@ and agrees to them.</p>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+1 -1
View File
@@ -434,7 +434,7 @@ status. If the breakpoint is set properly, then it should as below:</p></li>
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>
+2 -2
View File
@@ -133,7 +133,7 @@
</li>
</ul>
<ul class="simple">
<li><p>The Intel© UDK Debugger can be downloaded <a href="https://firmware.intel.com/develop/intel-uefi-tools-and-utilities/intel-uefi-development-kit-debugger-tool#overlay-context=develop" target="_blank">here</a> for Windows and Linux, install Intel UDK Debugger with default configuration values.</p></li>
<li><p>The Intel© UDK Debugger can be downloaded <a href="https://www.intel.com/content/dam/develop/external/us/en/documents/udk-debugger-tool-v1-5-win.zip" target="_blank">here</a> for Windows and <a href="https://www.intel.com/content/dam/develop/external/us/en/documents/udk-debugger-tool-v1-5-1-linux.zip" target="_blank">this</a> for Linux, install Intel UDK Debugger with default configuration values.</p></li>
</ul>
<ul class="simple">
<li><p>Install <a href="https://github.com/pyrasis/windowsprojectbook/blob/master/Applications/Debugging%20Tools%20for%20Windows/dbg_x86_6.11.1.404.msi" target="_blank">Windows Debug Tool(WinDbg)</a> with default configuration values.</p></li>
@@ -335,7 +335,7 @@
<div role="contentinfo">
<p>&#169; Copyright 2018 - 2025, Intel Corporation.
<span class="lastupdated">Last updated on May 13, 2025.
<span class="lastupdated">Last updated on Jun 16, 2025.
</span></p>
</div>

Some files were not shown because too many files have changed in this diff Show More