Documentation/util.md

   1 # Utilities
   2
   3 ## List of utils
   4
   5 _Scripts and programs found in the coreboot `./util` directory_
   6 * __abuild__ - coreboot autobuild script builds coreboot images for all
   7 available targets. `bash`
   8 * __acpi__ - Walk through all ACPI tables with their addresses. `bash`
   9 * __amdfwtool__ - Create AMD Firmware combination `C`
  10 * __amdtools__ - A set of tools to compare extended) K8 memory
  11 settings. `Perl`
  12 * __apcb__ - AMD PSP Control Block tools
  13         * _apcb_edit.py_ - This tool allows patching an existing APCB
  14 binary with specific SPDs and GPIO selection pins. `Python3`
  15 * __archive__ - Concatenate files and create an archive `C`
  16 * __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
  17 platforms `Go`
  18 * __bincfg__ - Compiler/Decompiler for data blobs with specs `Lex`
  19 `Yacc`
  20 * __board_status__ - Tools to collect logs and upload them to the board
  21 status repository `Bash` `Go`
  22 * __bucts__ - A tool to manipulate the BUC.TS bit on Intel targets. `C`
  23 * __cavium__ - Devicetree_convert Tool to convert a DTB to a static C
  24 file `Python`
  25 * __cbfstool__
  26         * [_cbfstool_](cbfstool/index.md) - For manipulating CBFS file
  27 `C`
  28         * _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
  29         * _rmodtool_ - Creates rmodules `C`
  30         * _ifwitool_ - For manipulating IFWI `C`
  31 * __cbmem__ - CBMEM parser to read e.g. timestamps and console log `C`
  32 * __chromeos__ - These scripts can be used to access Chrome OS
  33 resources, for example to extract System Agent reference code and other
  34 blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
  35 recovery image. `C`
  36 * __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
  37 libc support)
  38 * __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
  39 _coreboot.org-status_ and _docs.coreboot.org_
  40 * __dtd_parser__ - DTD structure parser `Python2`
  41 * __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
  42 Controller (EC). `C`
  43 * __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
  44 `Python3`
  45 * __find_usbdebug__ - Help find USB debug ports
  46 * __futility__ - Firmware utility for signing ChromeOS images `Make`
  47 * __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
  48 * __genbuild_h__ - Generate build system definitions `Shell`
  49 * __gitconfig__ - Initialize git repository submodules install git
  50 hooks `Bash`
  51 * [__ifdtool__](ifdtool/index.md) - Extract and dump Intel Firmware
  52 Descriptor information `C`
  53 * __intelmetool__ - Dump interesting things about Management Engine
  54 even if hidden `C`
  55 * __intelp2m__ - Intel Pad to Macro (intelp2m) converter 'Go'
  56 * __inteltool__ - Provides information about the Intel CPU/chipset
  57 hardware configuration (register contents, MSRs, etc). `C`
  58 * __intelvbttool__ - Parse VBT from VGA BIOS `C`
  59 * __ipqheader__
  60         * _createxbl.py_ - Concatenates XBL segments into one ELF
  61 image `Python`
  62         * _ipqheader.py_ - Returns a packed MBN header image with the
  63 specified base and size `Python`
  64         * _mbncat.py_ - Generate ipq8064 uber SBL `Python`
  65         * *mbn_tools.py* - Contains all MBN Utilities for image
  66 generation `Python`
  67 * __kbc1126__ - Tools used to dump the two blobs from the factory
  68 firmware of many HP laptops with 8051-based SMSC KBC1098/KBC1126
  69 embedded controller and insert them to the firmware image. `C`
  70 * __kconfig__ - Build system `Make`
  71 * __lint__ - Source linter and linting rules `Shell`
  72 * __mainboard__ - mainboard specific scripts
  73         * _google_ - Directory for google mainboard specific scripts
  74 * __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
  75 * __[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for
  76 partial deblobbing of Intel ME/TXE firmware images `Python`
  77 * __mma__ - Memory Margin Analysis automation tests `Bash`
  78 * __msrtool__ - Dumps chipset-specific MSR registers. `C`
  79 * __mtkheader__ - Generate MediaTek bootload header. `Python3`
  80 * __nvidia__ - nvidia blob parsers
  81 * __nvramtool__ - Reads and writes coreboot parameters and displaying
  82 information from the coreboot table in CMOS/NVRAM. `C`
  83 * __pgtblgen__ - Generates page tables based on fixed physical address.
  84 `C`
  85 * __pmh7tool__ - Dumps, reads and writes PMH7 registers on Lenovo
  86 ThinkPads. PMH7 is used for switching on and off the power of some
  87 devices on the board such as dGPU. `C`
  88 * __post__ - Userspace utility that can be used to test POST cards. `C`
  89 * __qemu__ - Makefile & comprehensive default config for QEMU Q35
  90 emulation
  91 * __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
  92 `CMM`
  93 * __release__ - Generate coreboot release `Bash`
  94 * __riscv__
  95         * _make-spike-elf.sh_ - Converts a flat file into an ELF, that
  96 can be passed to SPIKE, the RISC-V reference emulator.`Bash`
  97         * _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for
  98 SiFive's bootrom. `Python3`
  99 * __rockchip__ - Generate Rockchip idblock bootloader. `Python3`
 100 * __sconfig__ - coreboot device tree compiler `Lex` `Yacc`
 101 * __scripts__
 102         * _config_ - Manipulate options in a .config file from the
 103 command line `Bash`
 104         * _cross-repo-cherrypick_ - Pull in patches from another tree
 105 from a gerrit repository. `Shell`
 106         * _decode_spd.sh_ - Decodes Serial Presence Detect (SPD) files
 107 into various human readable formats.
 108         * _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
 109 fmaptool compatible .fmd format `Bash`
 110         * _find-unused-kconfig-symbols.sh_ - Points out Kconfig
 111 variables that may be unused. There are some false positives, but it
 112 serves as a starting point `Shell`
 113         * _gerrit-rebase_ - Applies all commits that from-branch has
 114 over to-branch, based on a common ancestor and gerrit meta-data `Bash`
 115         * _get_maintainer.pl_ - Print selected MAINTAINERS information
 116 for the files modified in a patch or for a file `Perl`
 117         * _maintainers.go_ - Build subsystem Maintainers `Go`
 118         * _no-fsf-addresses.sh_ - Removes various FSF addresses from
 119 license headers `Shell`
 120         * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS
 121 file `Perl`
 122         * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash`
 123         * _update_submodules_ - Check all submodules for updates `Bash`
 124 * __showdevicetree__ - Compile and dump the device tree `C`
 125 * __spdtool__ - Dumps SPD ROMs from a given blob to separate files
 126 using known patterns and reserved bits. Useful for analysing firmware
 127 that holds SPDs on boards that have soldered down DRAM. `python`
 128 * __spd_tools__ - Tools for generating SPD files for DDR4 memory used
 129 in platforms with memory down configuration.
 130         * _gen_spd.go_ - Generates de-duplicated SPD files using a
 131 global memory part list provided by the mainboard in JSON format. `Go`
 132         * _gen_part_id.go_ - Allocates DRAM strap IDs for different
 133 DDR4 memory parts used by the board. `Go`
 134 * __spkmodem_recv__ - Decode spkmodem signals `C`
 135 * __superiotool__ - A user-space utility to detect Super I/O of a
 136 mainboard and provide detailed information about the register contents
 137 of the Super I/O. `C`
 138 * __supermicro__ - Tools for supermicro platforms
 139         * _smcbiosinfo_ - Generates SMC biosinfo for BMC BIOS updates
 140 `C`
 141 * __testing__ - coreboot test targets `Make`
 142 * __uio_usbdebug__ - Debug coreboot's usbdebug driver inside a running
 143 operating system (only Linux at this time). `C`
 144 * __util_readme__ - Creates README.md of description files in `./util`
 145 subdirectories `Bash`
 146 * __vboot_list__ - Tools to generate a list of vboot enabled devices to
 147 the documentation `Bash`
 148 * __vgabios__ - emulated vga driver for qemu `C`
 149 * __x86__ - Generates 32-bit PAE page tables based on a CSV input file.
 150 `Go`
 151 * __xcompile__ - Cross compile setup `Bash`
 152
 153
 154  ## In depth documentation
 155
 156 * [ifdtool](ifdtool/index.md)
 157
 158 ## Generated documentation
 159
 160 **Please do not edit the markdown file in the documentation directory
 161 *directly.**
 162
 163 This file was generated by running util_readme.sh. Please make sure it
 164 is rerun when new tools are added or when documentation is updated.
 165
 166 To update, edit the markdown files in the util directory, then
 167 re-generate this file by running `util/util_readme/util_readme.sh`