<p>Tom Hiller has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/27594">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Documentation: Add Utilities descriptions<br><br>Same README from util directory added to documentation<br><br>Change-Id: I77b7b5727c3e183b8cf23b5f0dbc57ca926922b3<br>Signed-off-by: Tom Hiller <thrilleratplay@gmail.com><br>---<br>A Documentation/Utils.md<br>M Documentation/index.md<br>M util/util_readme/util_readme.sh<br>3 files changed, 90 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/94/27594/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/Documentation/Utils.md b/Documentation/Utils.md</span><br><span>new file mode 100644</span><br><span>index 0000000..8b201d7</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/Utils.md</span><br><span>@@ -0,0 +1,83 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# Utilities</span><br><span style="color: hsl(120, 100%, 40%);">+* __abuild__ - coreboot autobuild script builds coreboot images for all available targets. `bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __acpi__ - Walk through all ACPI tables with their addresses. `bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __amdfwtool__ - Create AMD Firmware combination `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __amdtools__ - A set of tools to compare extended) K8 memory settings. `Perl`</span><br><span style="color: hsl(120, 100%, 40%);">+* __archive__ - Concatenate files and create an archive `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __arm_boot_tools__ - A simple tool to generate bootable image for sunxi platform. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge platforms `Go`</span><br><span style="color: hsl(120, 100%, 40%);">+* __bimgtool__ - 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`</span><br><span style="color: hsl(120, 100%, 40%);">+* __bincfg__ - Compiler/Decompiler for data blobs with specs `Lex` `Yacc`</span><br><span style="color: hsl(120, 100%, 40%);">+* __board_status__ - Tools to collect logs and upload them to the board status repository `Bash` `Go`</span><br><span style="color: hsl(120, 100%, 40%);">+* __broadcom__ - Generate Broadcom secure boot image. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __cavium__ - Devicetree_convert Tool to convert a DTB to a static C file `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+* __cbfstool__</span><br><span style="color: hsl(120, 100%, 40%);">+  * _cbfstool_ - For manipulating CBFS file `C`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _rmodtool_ - Creates rmodules `C`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _ifwitool_ - For manipulating IFWI `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __cbmem__ - Cbmem console log reader `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __checklist__ - Board implementation checklist generator `Make`</span><br><span style="color: hsl(120, 100%, 40%);">+* __chromeos__ - 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`</span><br><span style="color: hsl(120, 100%, 40%);">+* __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no libc support)</span><br><span style="color: hsl(120, 100%, 40%);">+* __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_, _coreboot.org-status_ and _docs.coreboot.org_</span><br><span style="color: hsl(120, 100%, 40%);">+* __dtd_parser__ - DTD structure parser `Python2`</span><br><span style="color: hsl(120, 100%, 40%);">+* __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental Controller (EC). `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2). `Python2`</span><br><span style="color: hsl(120, 100%, 40%);">+* __futility__ - Firmware utility for signing ChromeOS images `Make`</span><br><span style="color: hsl(120, 100%, 40%);">+* __fuzz-tests__ - Create test cases that crash the jpeg code. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __genbuild_h__ - Generate build system definitions `Shell`</span><br><span style="color: hsl(120, 100%, 40%);">+* __genprof__ - Format function tracing logs `Bash` `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __gitconfig__ - Initialize git repository submodules install git hooks `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __ifdfake__ - Create an Intel Firmware Descriptor with just a section layout `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __ifdtool__ - Extract and dump Intel Firmware Descriptor information `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __intelmetool__ - Dump interesting things about Management Engine even if hidden `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __inteltool__ - Provides information about the Intel CPU/chipset hardware configuration (register contents, MSRs, etc). `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __intelvbttool__ - Parse VBT from VGA BIOS `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __ipqheader__</span><br><span style="color: hsl(120, 100%, 40%);">+  * _createxbl.py_ - Concatentates XBL segments into one ELF image `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _ipqheader.py_ - Returns a packed MBN header image with the specified base and size `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _mbncat.py_ - Generate ipq8064 uber SBL `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+  * *mbn_tools.py* - Contains all MBN Utilities for image generation `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+* __k8resdump__ - This program will dump the IO/memory/PCI resources from the K8 memory controller `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __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. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __kconfig__ - Build system `Make`</span><br><span style="color: hsl(120, 100%, 40%);">+* __lint__ - Source linter and linting rules `Shell`</span><br><span style="color: hsl(120, 100%, 40%);">+* __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __[me_cleaner](https://github.com/corna/me_cleaner)__ - Tool for partial deblobbing of Intel ME/TXE firmware images `Python`</span><br><span style="color: hsl(120, 100%, 40%);">+* __mma__ - Memory Margin Analysis automation tests `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __msrtool__ - Dumps chipset-specific MSR registers. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __mtkheader__ - Generate MediaTek bootload header. `Python2`</span><br><span style="color: hsl(120, 100%, 40%);">+* __nvidia__ - nvidia blob parsers</span><br><span style="color: hsl(120, 100%, 40%);">+* __nvramtool__ - Reads and writes coreboot parameters and displaying information from the coreboot table in CMOS/NVRAM. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __post__ - Userspace utility that can be used to test POST cards. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __qualcomm__ - CMM script to debug Qualcomm coreboot environments. `CMM`</span><br><span style="color: hsl(120, 100%, 40%);">+* __release__ - Generate coreboot release `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __riscv__</span><br><span style="color: hsl(120, 100%, 40%);">+  * _make-spike-elf.sh_ - Converts a flat file into an ELF, that can be passed to SPIKE, the RISC-V reference emulator. `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _sifive-gpt.py_ - Wraps the bootblock in a GPT partition for SiFive's bootrom. `Python3`</span><br><span style="color: hsl(120, 100%, 40%);">+* __rockchip__ - Generate Rockchip idblock bootloader. `Python2`</span><br><span style="color: hsl(120, 100%, 40%);">+* __romcc__ - Compile a C source file generating a binary that does not implicilty use RAM. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __sconfig__ - coreboot device tree compiler `Lex` `Yacc`</span><br><span style="color: hsl(120, 100%, 40%);">+* __scripts__</span><br><span style="color: hsl(120, 100%, 40%);">+  * _config_ - Manipulate options in a .config file from the command line `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _cross-repo-cherrypick_ - Pull in patches from another tree from a gerrit repository. `Shell`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an fmaptool compatible .fmd format `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _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`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _gerrit-rebase_ - Applies all commits that from-branch has over to-branch, based on a common ancestor and gerrit meta-data `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _get_maintainer.pl_ - Print selected MAINTAINERS information for the files modified in a patch or for a file `Perl`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _maintainers.go_ - Build subsystem Maintainers `Go`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _no-fsf-addresses.sh_ - Removes various FSF addresses from license headers `Shell`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _parse-maintainers.pl_ - Script to alphabetize MAINTAINERS file `Perl`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _ucode_h_to_bin.sh_ - Microcode conversion tool `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+  * _update_submodules_ - Check all submodules for updates `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __showdevicetree__ - Compile and dump the device tree `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __spkmodem_recv__ - Decode spkmodem signals `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __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. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __testing__ - coreboot test targets `Make`</span><br><span style="color: hsl(120, 100%, 40%);">+* __uio_usbdebug__ - Debug coreboot's usbdebug driver inside a running operating system (only Linux at this time). `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __util_readme__ - Creates README.md of description files in `./util` subdirectories `Bash`</span><br><span style="color: hsl(120, 100%, 40%);">+* __vgabios__ - emulated vga driver for qemu `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __viatool__ - Extract certain configuration bits on VIA chipsets and CPUs. `C`</span><br><span style="color: hsl(120, 100%, 40%);">+* __x86__ - Generates 32-bit PAE page tables based on a CSV input file. `Go`</span><br><span style="color: hsl(120, 100%, 40%);">+* __xcompile__ - Cross compile setup `Bash`</span><br><span>diff --git a/Documentation/index.md b/Documentation/index.md</span><br><span>index cf22dca..b91ef12 100644</span><br><span>--- a/Documentation/index.md</span><br><span>+++ b/Documentation/index.md</span><br><span>@@ -19,4 +19,5 @@</span><br><span> * [Mainboard-specific documentation](mainboard/index.md)</span><br><span> * [SuperIO-specific documentation](superio/index.md)</span><br><span> * [Vendorcode-specific documentation](vendorcode/index.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Utilities](Utils.md)</span><br><span> * [Release notes for past releases](releases/index.md)</span><br><span>diff --git a/util/util_readme/util_readme.sh b/util/util_readme/util_readme.sh</span><br><span>index 3a99734..f2727fd 100755</span><br><span>--- a/util/util_readme/util_readme.sh</span><br><span>+++ b/util/util_readme/util_readme.sh</span><br><span>@@ -1,16 +1,19 @@</span><br><span> #!/bin/bash</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-# Creates `./util/README.md` of description files</span><br><span style="color: hsl(120, 100%, 40%);">+# Creates `./util/README.md` and `./Documentation/Utils.md`of description files</span><br><span> # in `./util` subdirectories</span><br><span> #</span><br><span> # Execute from root of project.  Example:</span><br><span> # `sh util/util_readme/util_readme.sh`</span><br><span> </span><br><span> UTIL_DIR=$(dirname "$(dirname $0)")</span><br><span style="color: hsl(120, 100%, 40%);">+COREBOOT_ROOT_DIR=$(dirname "$(dirname "$(dirname $0)")")</span><br><span style="color: hsl(120, 100%, 40%);">+DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation"</span><br><span> </span><br><span> DESCRIPTION_FILES=$(find $UTIL_DIR -name "description.md" | sort)</span><br><span> </span><br><span> echo -n "" > "$UTIL_DIR/README.md"</span><br><span style="color: hsl(120, 100%, 40%);">+echo "# Utilities" > "$DOCMENTATION_DIR/Utils.md"</span><br><span> </span><br><span> for DESC_FILE in $DESCRIPTION_FILES; do</span><br><span>   UTIL_NAME=$(echo $DESC_FILE  | cut -d '/' -f2)</span><br><span>@@ -18,7 +21,9 @@</span><br><span> </span><br><span>   if [[ $DESC == "__"${UTIL_NAME}* || $DESC == "__["${UTIL_NAME}* ]]; then</span><br><span>     echo "* $DESC" >> "$UTIL_DIR/README.md"</span><br><span style="color: hsl(120, 100%, 40%);">+    echo "* $DESC" >> "$DOCMENTATION_DIR/Utils.md"</span><br><span>   else</span><br><span>     echo "* __${UTIL_NAME}__ - $DESC" >> "$UTIL_DIR/README.md"</span><br><span style="color: hsl(120, 100%, 40%);">+    echo "* __${UTIL_NAME}__ - $DESC" >> "$DOCMENTATION_DIR/Utils.md"</span><br><span>   fi</span><br><span> done</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/27594">change 27594</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/27594"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I77b7b5727c3e183b8cf23b5f0dbc57ca926922b3 </div>
<div style="display:none"> Gerrit-Change-Number: 27594 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Tom Hiller <thrilleratplay@gmail.com> </div>