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