util: Add description.md to each util

Descriptions are taken from the files themselves or READMEs. Description
followed by a space with the language in marked up as code.

Change-Id: I5f91e85d1034736289aedf27de00df00db3ff19c
Signed-off-by: Tom Hiller <thrilleratplay@gmail.com>
Reviewed-on: https://review.coreboot.org/27563
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>

60 files changed, 116 insertions, 0 deletions

diff --git a/util/abuild/description.md b/util/abuild/description.md
new file mode 100644
index 000000000000..0f03ed4bee1b
--- /dev/null
+++ b/util/abuild/description.md
@@ -0,0 +1,2 @@
+coreboot autobuild script builds coreboot images for all available
+targets. `bash`
diff --git a/util/acpi/description.md b/util/acpi/description.md
new file mode 100644
index 000000000000..bd71d5d29261
--- /dev/null
+++ b/util/acpi/description.md
@@ -0,0 +1 @@
+Walk through all ACPI tables with their addresses. `bash`
diff --git a/util/amdfwtool/description.md b/util/amdfwtool/description.md
new file mode 100644
index 000000000000..94dcc14b8b39
--- /dev/null
+++ b/util/amdfwtool/description.md
@@ -0,0 +1 @@
+Create AMD Firmware combination `C`
diff --git a/util/amdtools/description.md b/util/amdtools/description.md
new file mode 100644
index 000000000000..17642ab1e360
--- /dev/null
+++ b/util/amdtools/description.md
@@ -0,0 +1 @@
+A set of tools to compare extended) K8 memory settings. `Perl`
diff --git a/util/archive/description.md b/util/archive/description.md
new file mode 100644
index 000000000000..5ffde4704a7a
--- /dev/null
+++ b/util/archive/description.md
@@ -0,0 +1 @@
+Concatenate files and create an archive `C`
diff --git a/util/arm_boot_tools/mksunxiboot/description.md b/util/arm_boot_tools/mksunxiboot/description.md
new file mode 100644
index 000000000000..cd90b75325ba
--- /dev/null
+++ b/util/arm_boot_tools/mksunxiboot/description.md
@@ -0,0 +1 @@
+A simple tool to generate bootable image for sunxi platform. `C`
diff --git a/util/autoport/description.md b/util/autoport/description.md
new file mode 100644
index 000000000000..9a0e8d4309ed
--- /dev/null
+++ b/util/autoport/description.md
@@ -0,0 +1 @@
+Automated porting coreboot to Sandy Bridge/Ivy Bridge platforms `Go`
diff --git a/util/bimgtool/description.md b/util/bimgtool/description.md
new file mode 100644
index 000000000000..aa1059a8dc63
--- /dev/null
+++ b/util/bimgtool/description.md
@@ -0,0 +1,3 @@
+A simple tool which generates and verifies boot images in the BIMG
+format, used in systems designed by Imagination Technologies, for
+example the Pistachio SoC. `C`
diff --git a/util/bincfg/description.md b/util/bincfg/description.md
new file mode 100644
index 000000000000..244e5e06ea9f
--- /dev/null
+++ b/util/bincfg/description.md
@@ -0,0 +1 @@
+Compiler/Decompiler for data blobs with specs `Lex` `Yacc`
diff --git a/util/board_status/description.md b/util/board_status/description.md
new file mode 100644
index 000000000000..cda2315e4c5f
--- /dev/null
+++ b/util/board_status/description.md
@@ -0,0 +1,2 @@
+Tools to collect logs and upload them to the board status repository
+`Bash` `Go`
diff --git a/util/broadcom/description.md b/util/broadcom/description.md
new file mode 100644
index 000000000000..572b412a0fdc
--- /dev/null
+++ b/util/broadcom/description.md
@@ -0,0 +1 @@
+Generate Broadcom secure boot image. `C`
diff --git a/util/cavium/description.md b/util/cavium/description.md
new file mode 100644
index 000000000000..858d465d942b
--- /dev/null
+++ b/util/cavium/description.md
@@ -0,0 +1 @@
+Devicetree_convert Tool to convert a DTB to a static C file `Python`
diff --git a/util/cbfstool/description.md b/util/cbfstool/description.md
new file mode 100644
index 000000000000..63b50f2f1241
--- /dev/null
+++ b/util/cbfstool/description.md
@@ -0,0 +1,5 @@
+__cbfstool__
+  * _cbfstool_ - For manipulating CBFS file `C`
+  * _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
+  * _rmodtool_ - Creates rmodules `C`
+  * _ifwitool_ - For manipulating IFWI `C`
diff --git a/util/cbmem/description.md b/util/cbmem/description.md
new file mode 100644
index 000000000000..38977ecba35c
--- /dev/null
+++ b/util/cbmem/description.md
@@ -0,0 +1 @@
+Cbmem console log reader `C`
diff --git a/util/checklist/description.md b/util/checklist/description.md
new file mode 100644
index 000000000000..3133ed2b087d
--- /dev/null
+++ b/util/checklist/description.md
@@ -0,0 +1 @@
+Board implementation checklist generator `Make`
diff --git a/util/chromeos/description.md b/util/chromeos/description.md
new file mode 100644
index 000000000000..d2da57770ed0
--- /dev/null
+++ b/util/chromeos/description.md
@@ -0,0 +1,3 @@
+These scripts can be used to extract System Agent reference code and
+other blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
+recovery image. `C`
diff --git a/util/crossgcc/description.md b/util/crossgcc/description.md
new file mode 100644
index 000000000000..fa37c2b6ab58
--- /dev/null
+++ b/util/crossgcc/description.md
@@ -0,0 +1 @@
+A cross toolchain builder for -elf toolchains (ie. no libc support)
diff --git a/util/docker/description.md b/util/docker/description.md
new file mode 100644
index 000000000000..a45d1da01406
--- /dev/null
+++ b/util/docker/description.md
@@ -0,0 +1,2 @@
+Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
+_coreboot.org-status_ and _docs.coreboot.org_
diff --git a/util/dtd_parser/description.md b/util/dtd_parser/description.md
new file mode 100644
index 000000000000..d5f76e8d41ea
--- /dev/null
+++ b/util/dtd_parser/description.md
@@ -0,0 +1 @@
+DTD structure parser `Python2`
diff --git a/util/ectool/description.md b/util/ectool/description.md
new file mode 100644
index 000000000000..c6f5372bb4db
--- /dev/null
+++ b/util/ectool/description.md
@@ -0,0 +1 @@
+Dumps the RAM of a laptop's Embedded/Environmental Controller (EC). `C`
diff --git a/util/exynos/description.md b/util/exynos/description.md
new file mode 100644
index 000000000000..26cd20d3a460
--- /dev/null
+++ b/util/exynos/description.md
@@ -0,0 +1 @@
+Computes and fills Exynos ROM checksum (for BL1 or BL2). `Python2`
diff --git a/util/futility/description.md b/util/futility/description.md
new file mode 100644
index 000000000000..5a56e8c4dfb1
--- /dev/null
+++ b/util/futility/description.md
@@ -0,0 +1 @@
+Firmware utility for signing ChromeOS images `Make`
diff --git a/util/fuzz-tests/description.md b/util/fuzz-tests/description.md
new file mode 100644
index 000000000000..4785a07e80f6
--- /dev/null
+++ b/util/fuzz-tests/description.md
@@ -0,0 +1 @@
+Create test cases that crash the jpeg code. `C`
diff --git a/util/genbuild_h/description.md b/util/genbuild_h/description.md
new file mode 100644
index 000000000000..59f930d38453
--- /dev/null
+++ b/util/genbuild_h/description.md
@@ -0,0 +1 @@
+Generate build system definitions `Shell`
diff --git a/util/genprof/description.md b/util/genprof/description.md
new file mode 100644
index 000000000000..84618a4187ec
--- /dev/null
+++ b/util/genprof/description.md
@@ -0,0 +1 @@
+Format function tracing logs `Bash` `C`
diff --git a/util/gitconfig/description.md b/util/gitconfig/description.md
new file mode 100644
index 000000000000..c1454008538a
--- /dev/null
+++ b/util/gitconfig/description.md
@@ -0,0 +1 @@
+Initialize git repository submodules install git hooks `Bash`
diff --git a/util/ifdfake/description.md b/util/ifdfake/description.md
new file mode 100644
index 000000000000..5835bec6ce07
--- /dev/null
+++ b/util/ifdfake/description.md
@@ -0,0 +1 @@
+Create an Intel Firmware Descriptor with just a section layout `C`
diff --git a/util/ifdtool/description.md b/util/ifdtool/description.md
new file mode 100644
index 000000000000..813d401cb999
--- /dev/null
+++ b/util/ifdtool/description.md
@@ -0,0 +1 @@
+Extract and dump Intel Firmware Descriptor information `C`
diff --git a/util/intelmetool/description.md b/util/intelmetool/description.md
new file mode 100644
index 000000000000..0525dd0f9caf
--- /dev/null
+++ b/util/intelmetool/description.md
@@ -0,0 +1 @@
+Dump interesting things about Management Engine even if hidden `C`
diff --git a/util/inteltool/description.md b/util/inteltool/description.md
new file mode 100644
index 000000000000..bf1126666dc1
--- /dev/null
+++ b/util/inteltool/description.md
@@ -0,0 +1,2 @@
+Provides information about the Intel CPU/chipset hardware configuration
+(register contents, MSRs, etc). `C`
diff --git a/util/intelvbttool/description.md b/util/intelvbttool/description.md
new file mode 100644
index 000000000000..c76e38afe702
--- /dev/null
+++ b/util/intelvbttool/description.md
@@ -0,0 +1 @@
+Parse VBT from VGA BIOS `C`
diff --git a/util/ipqheader/description.md b/util/ipqheader/description.md
new file mode 100644
index 000000000000..f747b562f657
--- /dev/null
+++ b/util/ipqheader/description.md
@@ -0,0 +1,8 @@
+__ipqheader__
+  * _createxbl.py_ - Concatentates XBL segments into one ELF image
+                    `Python`
+  * _ipqheader.py_ - Returns a packed MBN header image with the
+                     specified base and size `Python`
+  * _mbncat.py_ - Generate ipq8064 uber SBL `Python`
+  * *mbn_tools.py* - Contains all MBN Utilities for image generation
+                     `Python`
diff --git a/util/k8resdump/description.md b/util/k8resdump/description.md
new file mode 100644
index 000000000000..dd1f1449af68
--- /dev/null
+++ b/util/k8resdump/description.md
@@ -0,0 +1,2 @@
+This program will dump the IO/memory/PCI resources from the K8 memory
+controller `C`
diff --git a/util/kbc1126/description.md b/util/kbc1126/description.md
new file mode 100644
index 000000000000..460117574d14
--- /dev/null
+++ b/util/kbc1126/description.md
@@ -0,0 +1,3 @@
+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. `C`
diff --git a/util/kconfig/description.md b/util/kconfig/description.md
new file mode 100644
index 000000000000..1761b31ce9de
--- /dev/null
+++ b/util/kconfig/description.md
@@ -0,0 +1 @@
+Build system `Make`
diff --git a/util/lint/description.md b/util/lint/description.md
new file mode 100644
index 000000000000..df855ad233ac
--- /dev/null
+++ b/util/lint/description.md
@@ -0,0 +1 @@
+Source linter and linting rules `Shell`
diff --git a/util/marvell/description.md b/util/marvell/description.md
new file mode 100644
index 000000000000..3ba3739cd32e
--- /dev/null
+++ b/util/marvell/description.md
@@ -0,0 +1 @@
+Add U-Boot boot loader for Marvell ARMADA38X `C`
diff --git a/util/me_cleaner/description.md b/util/me_cleaner/description.md
new file mode 100644
index 000000000000..d5de2d5c5698
--- /dev/null
+++ b/util/me_cleaner/description.md
@@ -0,0 +1,2 @@
+__[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for
+partial deblobbing of Intel ME/TXE firmware images `Python`
diff --git a/util/mma/description.md b/util/mma/description.md
new file mode 100644
index 000000000000..8f702f1a991a
--- /dev/null
+++ b/util/mma/description.md
@@ -0,0 +1 @@
+Memory Margin Analysis automation tests `Bash`
diff --git a/util/msrtool/description.md b/util/msrtool/description.md
new file mode 100644
index 000000000000..bc2041f9538b
--- /dev/null
+++ b/util/msrtool/description.md
@@ -0,0 +1 @@
+Dumps chipset-specific MSR registers. `C`
diff --git a/util/mtkheader/description.md b/util/mtkheader/description.md
new file mode 100644
index 000000000000..d426636da849
--- /dev/null
+++ b/util/mtkheader/description.md
@@ -0,0 +1 @@
+Generate MediaTek bootload header. `Python2`
diff --git a/util/nvidia/description.md b/util/nvidia/description.md
new file mode 100644
index 000000000000..2dcb93b2697c
--- /dev/null
+++ b/util/nvidia/description.md
@@ -0,0 +1 @@
+nvidia blob parsers
diff --git a/util/nvramtool/description.md b/util/nvramtool/description.md
new file mode 100644
index 000000000000..6252ed17a3c1
--- /dev/null
+++ b/util/nvramtool/description.md
@@ -0,0 +1,2 @@
+Reads and writes coreboot parameters and displaying information from
+the coreboot table in CMOS/NVRAM. `C`
diff --git a/util/post/description.md b/util/post/description.md
new file mode 100644
index 000000000000..fd6e4229cfd6
--- /dev/null
+++ b/util/post/description.md
@@ -0,0 +1 @@
+Userspace utility that can be used to test POST cards. `C`
diff --git a/util/qualcomm/description.md b/util/qualcomm/description.md
new file mode 100644
index 000000000000..22238c648ff2
--- /dev/null
+++ b/util/qualcomm/description.md
@@ -0,0 +1 @@
+CMM script to debug Qualcomm coreboot environments. `CMM`
diff --git a/util/release/description.md b/util/release/description.md
new file mode 100644
index 000000000000..02a6d4abf885
--- /dev/null
+++ b/util/release/description.md
@@ -0,0 +1 @@
+Generate coreboot release `Bash`
diff --git a/util/riscv/description.md b/util/riscv/description.md
new file mode 100644
index 000000000000..0245a4aa178a
--- /dev/null
+++ b/util/riscv/description.md
@@ -0,0 +1,6 @@
+__riscv__
+  * _make-spike-elf.sh_ - Converts a flat file into an ELF, that can be
+                          passed to SPIKE, the RISC-V reference
+                          emulator.`Bash`
+  * _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for
+                      SiFive's bootrom. `Python3`
diff --git a/util/rockchip/description.md b/util/rockchip/description.md
new file mode 100644
index 000000000000..3eed7a6899bd
--- /dev/null
+++ b/util/rockchip/description.md
@@ -0,0 +1 @@
+Generate Rockchip idblock bootloader. `Python2`
diff --git a/util/romcc/description.md b/util/romcc/description.md
new file mode 100644
index 000000000000..4c12261730a6
--- /dev/null
+++ b/util/romcc/description.md
@@ -0,0 +1,2 @@
+Compile a C source file generating a binary that does not implicitly
+use RAM. `C`
diff --git a/util/sconfig/description.md b/util/sconfig/description.md
new file mode 100644
index 000000000000..b7719b249c4a
--- /dev/null
+++ b/util/sconfig/description.md
@@ -0,0 +1 @@
+coreboot device tree compiler `Lex` `Yacc`
diff --git a/util/scripts/description.md b/util/scripts/description.md
new file mode 100644
index 000000000000..1f4e7df04256
--- /dev/null
+++ b/util/scripts/description.md
@@ -0,0 +1,25 @@
+__scripts__
+  * _config_ - Manipulate options in a .config file from the command
+              line `Bash`
+  * _cross-repo-cherrypick_ - Pull in patches from another tree from a
+                              gerrit repository. `Shell`
+  * _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an fmaptool
+                     compatible .fmd format `Bash`
+  * _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
+                                       `Shell`
+  * _gerrit-rebase_ - Applies all commits that from-branch has over
+                      to-branch, based on a common ancestor and gerrit
+                      meta-data `Bash`
+  * _get_maintainer.pl_ - Print selected MAINTAINERS information for
+                          the files modified in a patch or for a file
+                          `Perl`
+  * _maintainers.go_ - Build subsystem Maintainers `Go`
+  * _no-fsf-addresses.sh_ - Removes various FSF addresses from license
+                            headers `Shell`
+  * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS file
+                             `Perl`
+  * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash`
+  * _update_submodules_ - Check all submodules for updates `Bash`
diff --git a/util/showdevicetree/description.md b/util/showdevicetree/description.md
new file mode 100644
index 000000000000..46b7ba84bfe2
--- /dev/null
+++ b/util/showdevicetree/description.md
@@ -0,0 +1 @@
+Compile and dump the device tree `C`
diff --git a/util/spkmodem_recv/description.md b/util/spkmodem_recv/description.md
new file mode 100644
index 000000000000..fe62f1691787
--- /dev/null
+++ b/util/spkmodem_recv/description.md
@@ -0,0 +1 @@
+Decode spkmodem signals `C`
diff --git a/util/superiotool/description.md b/util/superiotool/description.md
new file mode 100644
index 000000000000..89a10eb2c6f4
--- /dev/null
+++ b/util/superiotool/description.md
@@ -0,0 +1,2 @@
+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. `C`
diff --git a/util/testing/description.md b/util/testing/description.md
new file mode 100644
index 000000000000..c0fb99e7e0a6
--- /dev/null
+++ b/util/testing/description.md
@@ -0,0 +1 @@
+coreboot test targets `Make`
diff --git a/util/uio_usbdebug/description.md b/util/uio_usbdebug/description.md
new file mode 100644
index 000000000000..624b48d76acb
--- /dev/null
+++ b/util/uio_usbdebug/description.md
@@ -0,0 +1,2 @@
+Debug coreboot's usbdebug driver inside a running operating system
+(only Linux at this time). `C`
diff --git a/util/vgabios/description.md b/util/vgabios/description.md
new file mode 100644
index 000000000000..b04d618c59fe
--- /dev/null
+++ b/util/vgabios/description.md
@@ -0,0 +1 @@
+emulated vga driver for qemu `C`
diff --git a/util/viatool/description.md b/util/viatool/description.md
new file mode 100644
index 000000000000..7eb892810591
--- /dev/null
+++ b/util/viatool/description.md
@@ -0,0 +1 @@
+Extract certain configuration bits on VIA chipsets and CPUs. `C`
diff --git a/util/x86/description.md b/util/x86/description.md
new file mode 100644
index 000000000000..77e9b2fc6fa6
--- /dev/null
+++ b/util/x86/description.md
@@ -0,0 +1 @@
+Generates 32-bit PAE page tables based on a CSV input file. `Go`
diff --git a/util/xcompile/description.md b/util/xcompile/description.md
new file mode 100644
index 000000000000..3c56cd36d0d0
--- /dev/null
+++ b/util/xcompile/description.md
@@ -0,0 +1 @@
+Cross compile setup `Bash`