Documentation/util.md

   1 # Utilities
   2 _Scripts and programs found in the `./util` directory_
   3 * __abuild__ - coreboot autobuild script builds coreboot images for all
   4 available targets. `bash`
   5 * __acpi__ - Walk through all ACPI tables with their addresses. `bash`
   6 * __amdfwtool__ - Create AMD Firmware combination `C`
   7 * __amdtools__ - A set of tools to compare extended) K8 memory
   8 settings. `Perl`
   9 * __archive__ - Concatenate files and create an archive `C`
  10 * __mksunxiboot__ - A simple tool to generate bootable image for sunxi
  11 platform. `C`
  12 * __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
  13 platforms `Go`
  14 * __bimgtool__ - A simple tool which generates and verifies boot images
  15 in the BIMG format, used in systems designed by Imagination
  16 Technologies, for example the Pistachio SoC. `C`
  17 * __bincfg__ - Compiler/Decompiler for data blobs with specs `Lex`
  18 `Yacc`
  19 * __board_status__ - Tools to collect logs and upload them to the board
  20 status repository `Bash` `Go`
  21 * __bucts__ - A tool to manipulate the BUC.TS bit on Intel targets. `C`
  22 * __cavium__ - Devicetree_convert Tool to convert a DTB to a static C
  23 file `Python`
  24 * __cbfstool__
  25         * _cbfstool_ - For manipulating CBFS file `C`
  26         * _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
  27         * _rmodtool_ - Creates rmodules `C`
  28         * _ifwitool_ - For manipulating IFWI `C`
  29 * __cbmem__ - Cbmem console log reader `C`
  30 * __checklist__ - Board implementation checklist generator `Make`
  31 * __chromeos__ - These scripts can be used to extract System Agent
  32 reference code and other blobs (e.g. mrc.bin, refcode, VGA option roms)
  33 from a Chrome OS recovery image. `C`
  34 * __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
  35 libc support)
  36 * __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
  37 _coreboot.org-status_ and _docs.coreboot.org_
  38 * __dtd_parser__ - DTD structure parser `Python2`
  39 * __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
  40 Controller (EC). `C`
  41 * __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
  42 `Python2`
  43 * __find_usbdebug__ - Help find USB debug ports
  44 * __futility__ - Firmware utility for signing ChromeOS images `Make`
  45 * __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
  46 * __genbuild_h__ - Generate build system definitions `Shell`
  47 * __genprof__ - Format function tracing logs `Bash` `C`
  48 * __gitconfig__ - Initialize git repository submodules install git
  49 hooks `Bash`
  50 * __ifdtool__ - Extract and dump Intel Firmware Descriptor information
  51 `C`
  52 * __intelmetool__ - Dump interesting things about Management Engine
  53 even if hidden `C`
  54 * __inteltool__ - Provides information about the Intel CPU/chipset
  55 hardware configuration (register contents, MSRs, etc). `C`
  56 * __intelvbttool__ - Parse VBT from VGA BIOS `C`
  57 * __ipqheader__
  58         * _createxbl.py_ - Concatentates XBL segments into one ELF
  59 image `Python`
  60         * _ipqheader.py_ - Returns a packed MBN header image with the
  61 specified base and size `Python`
  62         * _mbncat.py_ - Generate ipq8064 uber SBL `Python`
  63         * *mbn_tools.py* - Contains all MBN Utilities for image
  64 generation `Python`
  65 * __k8resdump__ - This program will dump the IO/memory/PCI resources
  66 from the K8 memory controller `C`
  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 * __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
  73 * __[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for
  74 partial deblobbing of Intel ME/TXE firmware images `Python`
  75 * __mma__ - Memory Margin Analysis automation tests `Bash`
  76 * __msrtool__ - Dumps chipset-specific MSR registers. `C`
  77 * __mtkheader__ - Generate MediaTek bootload header. `Python2`
  78 * __nvidia__ - nvidia blob parsers
  79 * __nvramtool__ - Reads and writes coreboot parameters and displaying
  80 information from the coreboot table in CMOS/NVRAM. `C`
  81 * __pmh7tool__ - Dumps, reads and writes PMH7 registers on Lenovo
  82 ThinkPads. PMH7 is used for switching on and off the power of some
  83 devices on the board such as dGPU. `C`
  84 * __post__ - Userspace utility that can be used to test POST cards. `C`
  85 * __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
  86 `CMM`
  87 * __release__ - Generate coreboot release `Bash`
  88 * __riscv__
  89         * _make-spike-elf.sh_ - Converts a flat file into an ELF, that
  90 can be passed to SPIKE, the RISC-V reference emulator.`Bash`
  91         * _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for
  92 SiFive's bootrom. `Python3`
  93 * __rockchip__ - Generate Rockchip idblock bootloader. `Python2`
  94 * __romcc__ - Compile a C source file generating a binary that does not
  95 implicitly use RAM. `C`
  96 * __sconfig__ - coreboot device tree compiler `Lex` `Yacc`
  97 * __scripts__
  98         * _config_ - Manipulate options in a .config file from the
  99 command line `Bash`
 100         * _cross-repo-cherrypick_ - Pull in patches from another tree
 101 from a gerrit repository. `Shell`
 102         * _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
 103 fmaptool compatible .fmd format `Bash`
 104         * _find-unused-kconfig-symbols.sh_ - Points out Kconfig
 105 variables that may be unused. There are some false positives, but it
 106 serves as a starting point `Shell`
 107         * _gerrit-rebase_ - Applies all commits that from-branch has
 108 over to-branch, based on a common ancestor and gerrit meta-data `Bash`
 109         * _get_maintainer.pl_ - Print selected MAINTAINERS information
 110 for the files modified in a patch or for a file `Perl`
 111         * _maintainers.go_ - Build subsystem Maintainers `Go`
 112         * _no-fsf-addresses.sh_ - Removes various FSF addresses from
 113 license headers `Shell`
 114         * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS
 115 file `Perl`
 116         * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash`
 117         * _update_submodules_ - Check all submodules for updates `Bash`
 118 * __showdevicetree__ - Compile and dump the device tree `C`
 119 * __spkmodem_recv__ - Decode spkmodem signals `C`
 120 * __superiotool__ - A user-space utility to detect Super I/O of a
 121 mainboard and provide detailed information about the register contents
 122 of the Super I/O. `C`
 123 * __testing__ - coreboot test targets `Make`
 124 * __uio_usbdebug__ - Debug coreboot's usbdebug driver inside a running
 125 operating system (only Linux at this time). `C`
 126 * __util_readme__ - Creates README.md of description files in `./util`
 127 subdirectories `Bash`
 128 * __vgabios__ - emulated vga driver for qemu `C`
 129 * __viatool__ - Extract certain configuration bits on VIA chipsets and
 130 CPUs. `C`
 131 * __x86__ - Generates 32-bit PAE page tables based on a CSV input file.
 132 `Go`
 133 * __xcompile__ - Cross compile setup `Bash`