util, Documentation: Run util_readme.sh to regen util.md
Change-Id: Ie14204d0637bb5081e2fae4a9a0e2590bf7abeeb
Signed-off-by: Martin Roth <gaumless@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/64582
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
Reviewed-by: Raul Rangel <rrangel@chromium.org>
diff --git a/Documentation/util.md b/Documentation/util.md
index 0c50d30..3bdb6fa 100644
--- a/Documentation/util.md
+++ b/Documentation/util.md
@@ -1,19 +1,36 @@
+
+[//]: # ( DO NOT EDIT - AUTOGENERATED FILE )
+
+[//]: # ( RUN 'util/util_readme/util_readme.sh' to regenerate )
+
# Utilities
## List of utils
_Scripts and programs found in the coreboot `./util` directory_
+
* __abuild__ - coreboot autobuild script builds coreboot images for all
available targets. `bash`
* __acpi__ - Walk through all ACPI tables with their addresses. `bash`
* __amdfwtool__ - Create AMD Firmware combination `C`
-* __amdtools__ - A set of tools to compare extended) K8 memory
-settings. `Perl`
+* __amdtools__ Various tools for AMD processors
+ * _update_efs_spi_speed_ - Change SPI speed in binary. `Bash`
+ * Tools to compare extended K8 memory settings.
+ * _k8-compare-pci-space.pl_ - Shows differences between values
+in PCI space and the default value. `Perl`
+ * _k8-interpret-extended-memory-settings.pl_ - Shows
+differences between memory controller values and the default value.
+`Perl`
+ * _k8-read-mem-settings.sh_ - Makes data files understood by
+the k8-interpret-extended-memory-settings script. `Bash`
+ * _parse-bkdg.pl_ - Make bkdg.data file used by above scripts.
+`Perl`
+ * _example_input_ - Sample input for the above scripts. `Text`
* __apcb__ - AMD PSP Control Block tools
* _apcb_edit.py_ - This tool allows patching an existing APCB
binary with specific SPDs and GPIO selection pins. `Python3`
- * _apcb_v3_edit.py_ - This tool allows patching an existing APCB V3
-binary with specific SPDs. `Python3`
+ * _apcb_v3_edit.py_ - This tool allows patching an existing
+APCB v3 binary with up to 16 specific SPDs. `Python3`
* __archive__ - Concatenate files and create an archive `C`
* __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
platforms `Go`
@@ -25,8 +42,7 @@
* __cavium__ - Devicetree_convert Tool to convert a DTB to a static C
file `Python`
* __cbfstool__
- * [_cbfstool_](util/cbfstool/index.md) - For manipulating CBFS file
-`C`
+ * _cbfstool_ - For manipulating CBFS file `C`
* _fmaptool_ - Converts plaintext fmd files into fmap blobs `C`
* _rmodtool_ - Creates rmodules `C`
* _ifwitool_ - For manipulating IFWI `C`
@@ -36,31 +52,32 @@
blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
recovery image. `C`
* __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
-libc support)
+libc support) `Bash`
* __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
-_coreboot.org-status_ and _docs.coreboot.org_
+_coreboot.org-status_ and _docs.coreboot.org_ `Make`
* __dtd_parser__ - DTD structure parser `Python2`
* __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
Controller (EC). `C`
* __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
`Python3`
-* __find_usbdebug__ - Help find USB debug ports
+* __find_usbdebug__ - Help find USB debug ports `Bash`
* __futility__ - Firmware utility for signing ChromeOS images `Make`
* __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
* __genbuild_h__ - Generate build system definitions `Shell`
* __gitconfig__ - Initialize git repository submodules install git
hooks `Bash`
-* [__ifdtool__](util/ifdtool/index.md) - Extract and dump Intel Firmware
-Descriptor information `C`
+* __ifdtool__ - Extract and dump Intel Firmware Descriptor information
+`C`
* __intelmetool__ - Dump interesting things about Management Engine
even if hidden `C`
-* __intelp2m__ - Intel Pad to Macro (intelp2m) converter 'Go'
+* __intelp2m__ - convert the configuration DW0/1 registers value from
+an inteltool dump to coreboot macros. `go`
* __inteltool__ - Provides information about the Intel CPU/chipset
hardware configuration (register contents, MSRs, etc). `C`
* __intelvbttool__ - Parse VBT from VGA BIOS `C`
* __ipqheader__
- * _createxbl.py_ - Concatenates XBL segments into one ELF
-image `Python`
+ * _createxbl.py_ - Concatenates 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`
@@ -71,6 +88,8 @@
embedded controller and insert them to the firmware image. `C`
* __kconfig__ - Build system `Make`
* __lint__ - Source linter and linting rules `Shell`
+* __liveiso__ - A script and NixOS configuration files to create an ISO
+image for testing purposes and for working on firmware. `Bash`
* __mainboard__ - mainboard specific scripts
* _google_ - Directory for google mainboard specific scripts
* __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
@@ -82,14 +101,12 @@
* __nvidia__ - nvidia blob parsers
* __nvramtool__ - Reads and writes coreboot parameters and displaying
information from the coreboot table in CMOS/NVRAM. `C`
-* __pgtblgen__ - Generates page tables based on fixed physical address.
-`C`
* __pmh7tool__ - Dumps, reads and writes PMH7 registers on Lenovo
ThinkPads. PMH7 is used for switching on and off the power of some
devices on the board such as dGPU. `C`
* __post__ - Userspace utility that can be used to test POST cards. `C`
* __qemu__ - Makefile & comprehensive default config for QEMU Q35
-emulation
+emulation `Make`
* __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
`CMM`
* __release__ - Generate coreboot release `Bash`
@@ -106,7 +123,7 @@
* _cross-repo-cherrypick_ - Pull in patches from another tree
from a gerrit repository. `Shell`
* _decode_spd.sh_ - Decodes Serial Presence Detect (SPD) files
-into various human readable formats.
+into various human readable formats. `Bash`
* _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
fmaptool compatible .fmd format `Bash`
* _find-unused-kconfig-symbols.sh_ - Points out Kconfig
@@ -127,12 +144,6 @@
* __spdtool__ - Dumps SPD ROMs from a given blob to separate files
using known patterns and reserved bits. Useful for analysing firmware
that holds SPDs on boards that have soldered down DRAM. `python`
-* __spd_tools__ - Tools for generating SPD files for DDR4 memory used
-in platforms with memory down configuration.
- * _gen_spd.go_ - Generates de-duplicated SPD files using a
-global memory part list provided by the mainboard in JSON format. `Go`
- * _gen_part_id.go_ - Allocates DRAM strap IDs for different
-DDR4 memory parts used by the board. `Go`
* __spkmodem_recv__ - Decode spkmodem signals `C`
* __superiotool__ - A user-space utility to detect Super I/O of a
mainboard and provide detailed information about the register contents
@@ -152,8 +163,7 @@
`Go`
* __xcompile__ - Cross compile setup `Bash`
-
- ## In depth documentation
+## In depth documentation
* [cbfstool](util/cbfstool/index.md)
* [ifdtool](util/ifdtool/index.md)
diff --git a/util/README.md b/util/README.md
index 004da04..8be29d4 100644
--- a/util/README.md
+++ b/util/README.md
@@ -2,11 +2,24 @@
available targets. `bash`
* __acpi__ - Walk through all ACPI tables with their addresses. `bash`
* __amdfwtool__ - Create AMD Firmware combination `C`
-* __amdtools__ - A set of tools to compare extended) K8 memory
-settings. `Perl`
+* __amdtools__ Various tools for AMD processors
+ * _update_efs_spi_speed_ - Change SPI speed in binary. `Bash`
+ * Tools to compare extended K8 memory settings.
+ * _k8-compare-pci-space.pl_ - Shows differences between values
+in PCI space and the default value. `Perl`
+ * _k8-interpret-extended-memory-settings.pl_ - Shows
+differences between memory controller values and the default value.
+`Perl`
+ * _k8-read-mem-settings.sh_ - Makes data files understood by
+the k8-interpret-extended-memory-settings script. `Bash`
+ * _parse-bkdg.pl_ - Make bkdg.data file used by above scripts.
+`Perl`
+ * _example_input_ - Sample input for the above scripts. `Text`
* __apcb__ - AMD PSP Control Block tools
* _apcb_edit.py_ - This tool allows patching an existing APCB
binary with specific SPDs and GPIO selection pins. `Python3`
+ * _apcb_v3_edit.py_ - This tool allows patching an existing
+APCB v3 binary with up to 16 specific SPDs. `Python3`
* __archive__ - Concatenate files and create an archive `C`
* __autoport__ - Automated porting coreboot to Sandy Bridge/Ivy Bridge
platforms `Go`
@@ -28,15 +41,15 @@
blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
recovery image. `C`
* __crossgcc__ - A cross toolchain builder for -elf toolchains (ie. no
-libc support)
+libc support) `Bash`
* __docker__ - Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
-_coreboot.org-status_ and _docs.coreboot.org_
+_coreboot.org-status_ and _docs.coreboot.org_ `Make`
* __dtd_parser__ - DTD structure parser `Python2`
* __ectool__ - Dumps the RAM of a laptop's Embedded/Environmental
Controller (EC). `C`
* __exynos__ - Computes and fills Exynos ROM checksum (for BL1 or BL2).
`Python3`
-* __find_usbdebug__ - Help find USB debug ports
+* __find_usbdebug__ - Help find USB debug ports `Bash`
* __futility__ - Firmware utility for signing ChromeOS images `Make`
* __fuzz-tests__ - Create test cases that crash the jpeg code. `C`
* __genbuild_h__ - Generate build system definitions `Shell`
@@ -46,13 +59,14 @@
`C`
* __intelmetool__ - Dump interesting things about Management Engine
even if hidden `C`
-* __intelp2m__ - Intel Pad to Macro (intelp2m) converter 'Go'
+* __intelp2m__ - convert the configuration DW0/1 registers value from
+an inteltool dump to coreboot macros. `go`
* __inteltool__ - Provides information about the Intel CPU/chipset
hardware configuration (register contents, MSRs, etc). `C`
* __intelvbttool__ - Parse VBT from VGA BIOS `C`
* __ipqheader__
- * _createxbl.py_ - Concatentates XBL segments into one ELF
-image `Python`
+ * _createxbl.py_ - Concatenates 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`
@@ -63,6 +77,8 @@
embedded controller and insert them to the firmware image. `C`
* __kconfig__ - Build system `Make`
* __lint__ - Source linter and linting rules `Shell`
+* __liveiso__ - A script and NixOS configuration files to create an ISO
+image for testing purposes and for working on firmware. `Bash`
* __mainboard__ - mainboard specific scripts
* _google_ - Directory for google mainboard specific scripts
* __marvell__ - Add U-Boot boot loader for Marvell ARMADA38X `C`
@@ -74,14 +90,12 @@
* __nvidia__ - nvidia blob parsers
* __nvramtool__ - Reads and writes coreboot parameters and displaying
information from the coreboot table in CMOS/NVRAM. `C`
-* __pgtblgen__ - Generates page tables based on fixed physical address.
-`C`
* __pmh7tool__ - Dumps, reads and writes PMH7 registers on Lenovo
ThinkPads. PMH7 is used for switching on and off the power of some
devices on the board such as dGPU. `C`
* __post__ - Userspace utility that can be used to test POST cards. `C`
* __qemu__ - Makefile & comprehensive default config for QEMU Q35
-emulation
+emulation `Make`
* __qualcomm__ - CMM script to debug Qualcomm coreboot environments.
`CMM`
* __release__ - Generate coreboot release `Bash`
@@ -98,7 +112,7 @@
* _cross-repo-cherrypick_ - Pull in patches from another tree
from a gerrit repository. `Shell`
* _decode_spd.sh_ - Decodes Serial Presence Detect (SPD) files
-into various human readable formats.
+into various human readable formats. `Bash`
* _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an
fmaptool compatible .fmd format `Bash`
* _find-unused-kconfig-symbols.sh_ - Points out Kconfig
@@ -119,12 +133,6 @@
* __spdtool__ - Dumps SPD ROMs from a given blob to separate files
using known patterns and reserved bits. Useful for analysing firmware
that holds SPDs on boards that have soldered down DRAM. `python`
-* __spd_tools__ - Tools for generating SPD files for DDR4 memory used
-in platforms with memory down configuration.
- * _gen_spd.go_ - Generates de-duplicated SPD files using a
-global memory part list provided by the mainboard in JSON format. `Go`
- * _gen_part_id.go_ - Allocates DRAM strap IDs for different
-DDR4 memory parts used by the board. `Go`
* __spkmodem_recv__ - Decode spkmodem signals `C`
* __superiotool__ - A user-space utility to detect Super I/O of a
mainboard and provide detailed information about the register contents