CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Utilities — coreboot 25.03-103-g64931a3d65 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> <link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=f9a4a06c" />  <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=5c15f395"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></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="abuild" href="util/abuild/index.html" /> <link rel="prev" title="Eltan Security" href="vendorcode/eltan/security.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"> coreboot </a> <div class="version"> 25.03 </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="getting_started/index.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Tutorial</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="community/index.html">Community</a></li> <li class="toctree-l1"><a class="reference internal" href="payloads.html">Payloads</a></li> <li class="toctree-l1"><a class="reference internal" href="distributions.html">Distributions</a></li> <li class="toctree-l1"><a class="reference internal" href="technotes/index.html">Technotes</a></li> <li class="toctree-l1"><a class="reference internal" href="acpi/index.html">ACPI</a></li> <li class="toctree-l1"><a class="reference internal" href="gfx/libgfxinit.html">Native Graphics Initialization with libgfxinit</a></li> <li class="toctree-l1"><a class="reference internal" href="gfx/display-panel.html">Display panel</a></li> <li class="toctree-l1"><a class="reference internal" href="arch/index.html">CPU Architecture</a></li> <li class="toctree-l1"><a class="reference internal" href="drivers/index.html">Platform independent drivers</a></li> <li class="toctree-l1"><a class="reference internal" href="northbridge/index.html">Northbridge</a></li> <li class="toctree-l1"><a class="reference internal" href="soc/index.html">System on Chip</a></li> <li class="toctree-l1"><a class="reference internal" href="mainboard/index.html">Mainboard</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/payloads/index.html">Payloads</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/index.html">Libraries</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/option.html">Option API</a></li> <li class="toctree-l1"><a class="reference internal" href="lib/option.html#mainboard-specific-option-backend">Mainboard-specific option backend</a></li> <li class="toctree-l1"><a class="reference internal" href="security/index.html">Security</a></li> <li class="toctree-l1"><a class="reference internal" href="superio/index.html">SuperIO</a></li> <li class="toctree-l1"><a class="reference internal" href="vendorcode/index.html">Vendorcode</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Utilities</a><ul> <li class="toctree-l2"><a class="reference internal" href="#list-of-utils">List of utils</a></li> <li class="toctree-l2"><a class="reference internal" href="#in-depth-documentation">In depth documentation</a><ul> <li class="toctree-l3"><a class="reference internal" href="util/abuild/index.html">abuild</a></li> <li class="toctree-l3"><a class="reference internal" href="util/cbfstool/index.html">cbfstool</a></li> <li class="toctree-l3"><a class="reference internal" href="util/ifdtool/index.html">ifdtool</a></li> <li class="toctree-l3"><a class="reference internal" href="util/intelp2m/index.html">intelp2m</a></li> <li class="toctree-l3"><a class="reference internal" href="util/smmstoretool/index.html">smmstoretool</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#generated-documentation">Generated documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="sbom/sbom.html">Software Bill of Materials</a></li> <li class="toctree-l1"><a class="reference internal" href="infrastructure/index.html">Project infrastructure & services</a></li> <li class="toctree-l1"><a class="reference internal" href="releases/boards_supported_on_branches.html">Boards supported in each release directory</a></li> <li class="toctree-l1"><a class="reference internal" href="releases/index.html">Release notes</a></li> <li class="toctree-l1"><a class="reference internal" href="acronyms.html">Acronyms & Definitions</a></li> <li class="toctree-l1"><a class="reference internal" href="external_docs.html">External Resources</a></li> <li class="toctree-l1"><a class="reference internal" href="documentation_license.html">Documentation License</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" > <a href="index.html">coreboot</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">Utilities</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/util.md.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody">   <section id="utilities"> <h1>Utilities<a class="headerlink" href="#utilities" title="Link to this heading"></a></h1> <section id="list-of-utils"> <h2>List of utils<a class="headerlink" href="#list-of-utils" title="Link to this heading"></a></h2> Scripts and programs found in the coreboot <code class="docutils literal notranslate">./util</code> directory <ul class="simple"> <li>abuild - coreboot autobuild script builds coreboot images for all available targets. <code class="docutils literal notranslate">bash</code></li> <li>acpi - Walk through all ACPI tables with their addresses. <code class="docutils literal notranslate">bash</code></li> <li>amdfwtool - Create AMD Firmware combination <code class="docutils literal notranslate">C</code></li> <li>amdtools Various tools for AMD processors <ul> <li>update_efs_spi_speed - Change SPI speed in binary. <code class="docutils literal notranslate">Bash</code></li> <li>Tools to compare extended K8 memory settings.</li> <li>k8-compare-pci-space.pl - Shows differences between values in PCI space and the default value. <code class="docutils literal notranslate">Perl</code></li> <li>k8-interpret-extended-memory-settings.pl - Shows differences between memory controller values and the default value. <code class="docutils literal notranslate">Perl</code></li> <li>k8-read-mem-settings.sh - Makes data files understood by the k8-interpret-extended-memory-settings script. <code class="docutils literal notranslate">Bash</code></li> <li>parse-bkdg.pl - Make bkdg.data file used by above scripts. <code class="docutils literal notranslate">Perl</code></li> <li>example_input - Sample input for the above scripts. <code class="docutils literal notranslate">Text</code></li> </ul> </li> <li>apcb - AMD PSP Control Block tools <ul> <li>apcb_edit.py - This tool allows patching an existing APCB binary with specific SPDs and GPIO selection pins. <code class="docutils literal notranslate">Python3</code></li> <li>apcb_v3_edit.py - This tool allows patching an existing APCB v3 binary with up to 16 specific SPDs. <code class="docutils literal notranslate">Python3</code></li> </ul> </li> <li>archive - Concatenate files and create an archive <code class="docutils literal notranslate">C</code></li> <li>autoport - Automated porting coreboot to Sandy Bridge/Ivy Bridge/Haswell platforms <code class="docutils literal notranslate">Go</code></li> <li>bincfg - Compiler/Decompiler for data blobs with specs <code class="docutils literal notranslate">Lex</code> <code class="docutils literal notranslate">Yacc</code></li> <li>board_status - Tools to collect logs and upload them to the board status repository <code class="docutils literal notranslate">Bash</code> <code class="docutils literal notranslate">Go</code></li> <li>bucts - A tool to manipulate the BUC.TS bit on Intel targets. <code class="docutils literal notranslate">C</code></li> <li>cavium - Devicetree_convert Tool to convert a DTB to a static C file <code class="docutils literal notranslate">Python</code></li> <li>cbfstool <ul> <li>cbfstool - For manipulating CBFS file <code class="docutils literal notranslate">C</code></li> <li>fmaptool - Converts plaintext fmd files into fmap blobs <code class="docutils literal notranslate">C</code></li> <li>rmodtool - Creates rmodules <code class="docutils literal notranslate">C</code></li> <li>ifwitool - For manipulating IFWI <code class="docutils literal notranslate">C</code></li> </ul> </li> <li>cbmem - CBMEM parser to read e.g. timestamps and console log <code class="docutils literal notranslate">C</code></li> <li>chromeos - These scripts can be used to access ChromeOS resources, for example to extract System Agent reference code and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a ChromeOS recovery image. <code class="docutils literal notranslate">C</code></li> <li>crossgcc - A cross toolchain builder for -elf toolchains (ie. no libc support) <code class="docutils literal notranslate">Bash</code></li> <li>docker - Dockerfiles for coreboot-sdk, coreboot-jenkins-node, coreboot.org-status and docs.coreboot.org <code class="docutils literal notranslate">Make</code></li> <li>dtd_parser - DTD structure parser <code class="docutils literal notranslate">Python2</code></li> <li>ectool - Dumps the RAM of a laptop’s Embedded/Environmental Controller (EC). <code class="docutils literal notranslate">C</code></li> <li>exynos - Computes and fills Exynos ROM checksum (for BL1 or BL2). <code class="docutils literal notranslate">Python3</code></li> <li>find_usbdebug - Help find USB debug ports <code class="docutils literal notranslate">Bash</code></li> <li>futility - Firmware utility for signing ChromeOS images <code class="docutils literal notranslate">Make</code></li> <li>fuzz-tests - Create test cases that crash the jpeg code. <code class="docutils literal notranslate">C</code></li> <li>genbuild_h - Generate build system definitions <code class="docutils literal notranslate">Shell</code></li> <li>gitconfig - Initialize git repository submodules install git hooks <code class="docutils literal notranslate">Bash</code></li> <li>hda-decoder - Dumps decoded HDA default configuration registers into a format which can be used in coreboot’s verb table <code class="docutils literal notranslate">Go</code></li> <li>ifdtool - Extract and dump Intel Firmware Descriptor information <code class="docutils literal notranslate">C</code></li> <li>intelmetool - Dump interesting things about Management Engine even if hidden <code class="docutils literal notranslate">C</code></li> <li>intelp2m - Convert the inteltool register dump to gpio.h with GPIO configuration for porting coreboot to your motherboard. <code class="docutils literal notranslate">Go</code></li> <li>inteltool - Provides information about the Intel CPU/chipset hardware configuration (register contents, MSRs, etc). <code class="docutils literal notranslate">C</code></li> <li>intelvbttool - Parse VBT from VGA BIOS <code class="docutils literal notranslate">C</code></li> <li>kbc1126 - Tools used to dump the two blobs from the factory firmware of many HP laptops with 8051-based SMSC KBC1098/KBC1126 embedded controller and insert them to the firmware image. <code class="docutils literal notranslate">C</code></li> <li>kconfig - Build system <code class="docutils literal notranslate">Make</code></li> <li>lint - Source linter and linting rules <code class="docutils literal notranslate">Shell</code></li> <li>nixos - A script and NixOS configuration files to create an ISO image for testing purposes and for working on firmware. <code class="docutils literal notranslate">Bash</code></li> <li>mainboard - mainboard specific scripts <ul> <li>google - Directory for google mainboard specific scripts</li> </ul> </li> <li>marvell - Add U-Boot boot loader for Marvell ARMADA38X <code class="docutils literal notranslate">C</code></li> <li><a class="reference external" href="https://github.com/corna/me_cleaner">me_cleaner</a> - Tool for partial deblobbing of Intel ME/TXE firmware images <code class="docutils literal notranslate">Python</code></li> <li>mma - Memory Margin Analysis automation tests <code class="docutils literal notranslate">Bash</code></li> <li>msrtool - Dumps chipset-specific MSR registers. <code class="docutils literal notranslate">C</code></li> <li>mtkheader - Generate MediaTek bootload header. <code class="docutils literal notranslate">Python3</code></li> <li>nvidia - nvidia blob parsers</li> <li>nvramtool - Reads and writes coreboot parameters and displaying information from the coreboot table in CMOS/NVRAM. <code class="docutils literal notranslate">C</code></li> <li>pmh7tool - Dumps, reads and writes PMH7 registers on Lenovo ThinkPads. PMH7 is used for switching on and off the power of some devices on the board such as dGPU. <code class="docutils literal notranslate">C</code></li> <li>post - Userspace utility that can be used to test POST cards. <code class="docutils literal notranslate">C</code></li> <li>qemu - Makefile & comprehensive default config for QEMU Q35 emulation <code class="docutils literal notranslate">Make</code></li> <li>qualcomm - cmm <ul> <li>CMM script to debug Qualcomm coreboot environments. <code class="docutils literal notranslate">CMM</code> ipqheader</li> <li>createxbl.py - Concatenates XBL segments into one ELF image <code class="docutils literal notranslate">Python</code></li> <li>ipqheader.py - Returns a packed MBN header image with the specified base and size <code class="docutils literal notranslate">Python</code></li> <li>mbncat.py - Generate ipq8064 uber SBL <code class="docutils literal notranslate">Python</code></li> <li>mbn_tools.py - Contains all MBN Utilities for image generation <code class="docutils literal notranslate">Python</code></li> </ul> </li> <li>release - Generate coreboot release <code class="docutils literal notranslate">Bash</code></li> <li>riscv <ul> <li>make-spike-elf.sh - Converts a flat file into an ELF, that can be passed to SPIKE, the RISC-V reference emulator.<code class="docutils literal notranslate">Bash</code></li> <li>sifive-gpt.py - Wraps the bootblock in a GPT partition for SiFive’s bootrom. <code class="docutils literal notranslate">Python3</code></li> </ul> </li> <li>rockchip - Generate Rockchip idblock bootloader. <code class="docutils literal notranslate">Python3</code></li> <li>sconfig - coreboot device tree compiler <code class="docutils literal notranslate">Lex</code> <code class="docutils literal notranslate">Yacc</code></li> <li>scripts <ul> <li>capture_commands.sh - Write all commands from the build to a file. <code class="docutils literal notranslate">Shell</code></li> <li>config - Manipulate options in a .config file from the command line <code class="docutils literal notranslate">Bash</code></li> <li>cross-repo-cherrypick - Pull in patches from another tree from a gerrit repository. <code class="docutils literal notranslate">Shell</code></li> <li>decode_spd.sh - Decodes Serial Presence Detect (SPD) files into various human readable formats. <code class="docutils literal notranslate">Bash</code></li> <li>dts-to-fmd.sh -Converts a depthcharge fmap.dts into an fmaptool compatible .fmd format <code class="docutils literal notranslate">Bash</code></li> <li>find_new_user_commits.sh - Finds new gerrit committers <code class="docutils literal notranslate">Bash</code></li> <li>find-unused-kconfig-symbols.sh - Points out Kconfig variables that may be unused. There are some false positives, but it serves as a starting point <code class="docutils literal notranslate">Shell</code></li> <li>gerrit-rebase - Applies all commits that from-branch has over to-branch, based on a common ancestor and gerrit meta-data <code class="docutils literal notranslate">Bash</code></li> <li>get_maintainer.pl - Print selected MAINTAINERS information for the files modified in a patch or for a file <code class="docutils literal notranslate">Perl</code></li> <li>maintainers.go - Build subsystem Maintainers <code class="docutils literal notranslate">Go</code></li> <li>no-fsf-addresses.sh - Removes various FSF addresses from license headers <code class="docutils literal notranslate">Shell</code></li> <li>parse-maintainers.pl - Script to alphabetize MAINTAINERS file <code class="docutils literal notranslate">Perl</code></li> <li>rm_unused_code - Remove all code not used for a platform from the local git repository for auditing or release <code class="docutils literal notranslate">Bash</code></li> <li>show_platforms.sh - Makes a list of platforms in the tree. Does not show variants. <code class="docutils literal notranslate">Shell</code></li> <li>ucode_h_to_bin.sh - Microcode conversion tool <code class="docutils literal notranslate">Bash</code></li> <li>update_submodules - Check all submodules for updates <code class="docutils literal notranslate">Bash</code></li> </ul> </li> <li>smmstoretool - Offline SMMSTORE variable modification tool <code class="docutils literal notranslate">C</code></li> <li>spdtool - Dumps SPD ROMs from a given blob to separate files using known patterns and reserved bits. Useful for analysing firmware that holds SPDs on boards that have soldered down DRAM. <code class="docutils literal notranslate">python</code></li> <li>spkmodem_recv - Decode spkmodem signals <code class="docutils literal notranslate">C</code></li> <li>superiotool - A user-space utility to detect Super I/O of a mainboard and provide detailed information about the register contents of the Super I/O. <code class="docutils literal notranslate">C</code></li> <li>supermicro - Tools for supermicro platforms <ul> <li>smcbiosinfo - Generates SMC biosinfo for BMC BIOS updates <code class="docutils literal notranslate">C</code></li> </ul> </li> <li>testing - coreboot test targets <code class="docutils literal notranslate">Make</code></li> <li>uio_usbdebug - Debug coreboot’s usbdebug driver inside a running operating system (only Linux at this time). <code class="docutils literal notranslate">C</code></li> <li>util_readme - Creates README.md of description files in <code class="docutils literal notranslate">./util</code> subdirectories <code class="docutils literal notranslate">Bash</code></li> <li>vboot_list - Tools to generate a list of vboot enabled devices to the documentation <code class="docutils literal notranslate">Bash</code></li> <li>vgabios - emulated vga driver for qemu <code class="docutils literal notranslate">C</code></li> <li>x86 - Generates 32-bit PAE page tables based on a CSV input file. <code class="docutils literal notranslate">Go</code></li> <li>xcompile - Cross compile setup <code class="docutils literal notranslate">Bash</code></li> </ul> </section> <section id="in-depth-documentation"> <h2>In depth documentation<a class="headerlink" href="#in-depth-documentation" title="Link to this heading"></a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="util/abuild/index.html">abuild</a></li> <li class="toctree-l1"><a class="reference internal" href="util/cbfstool/index.html">cbfstool</a></li> <li class="toctree-l1"><a class="reference internal" href="util/ifdtool/index.html">ifdtool</a></li> <li class="toctree-l1"><a class="reference internal" href="util/intelp2m/index.html">intelp2m</a></li> <li class="toctree-l1"><a class="reference internal" href="util/smmstoretool/index.html">smmstoretool</a></li> </ul> </div> </section> <section id="generated-documentation"> <h2>Generated documentation<a class="headerlink" href="#generated-documentation" title="Link to this heading"></a></h2> *Please do not edit the markdown file in the documentation directory directly. This file was generated by running util_readme.sh. Please make sure it is rerun when new tools are added or when documentation is updated. To update, edit the markdown files in the util directory, then re-generate this file by running <code class="docutils literal notranslate">util/util_readme/util_readme.sh</code> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="vendorcode/eltan/security.html" class="btn btn-neutral float-left" title="Eltan Security" accesskey="p" rel="prev"> Previous</a> <a href="util/abuild/index.html" class="btn btn-neutral float-right" title="abuild" accesskey="n" rel="next">Next </a> </div> <hr/> <div role="contentinfo"> © Copyright CC-by 4.0 the coreboot project. </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>