coreboot-kgpe-d16/util
Furquan Shaikh bbade24241 util/sconfig: Drop use of ref_count for chip_instance
chip_instance structure currently uses a ref_count to determine how
many devices hold reference to that instance. If the count drops to
zero, then it is assumed that the chip instance is a duplicate in
override tree and has a similar instance that is already overriden in
base device tree.

ref_count is currently decremented whenever a device in override tree
matches the one in base device tree and the registers from the
override tree instance are copied over to the base tree instance. On
the other hand, if a device in override tree does not match any device
in base tree under a given parent, then the device is added to base
tree and all the devices in its subtree that hold pointers to its
parent chip instance are updated to point to the parent's chip
instance in base tree. This is done as part of update_chip_pointers.

However, there are a couple of issues that this suffers from:
a) If a device is present only in override tree and it does not have
its own chip (i.e. pointing to parent's chip instance), then it
results in sconfig emiiting parent's chip instance (which can be the
SoC chip instance) in static.c even though it is unused. This is
because update_chip_pointers() does not call delete_chip_instance()
before reassigning the chip instance pointer.
b) If a device is added under root device only in the override tree
and it does not have its own chip instance (i.e. uses SoC chip
instance), then it results in sconfig emitting a copy of the SoC chip
instance and setting that as chip_ops for this new device in the
override tree.

In order to fix the above issues, this change drops the ref_count
field from chip_instance structure and instead adds a forwarding
pointer `base_chip_instance`. This is setup as per the following
rules:
1. If the instance belongs to base devicetree, base_chip_instance is
set to NULL.
2. If the instance belongs to override tree, then it is set to its
corresponding chip instance in base tree (if present), else set to
NULL.

State of base_chip_instance is then used when emitting chips and
devices using the following rules:
1. If a chip_instance has non-NULL base_chip_instance, then that chip
instance is not emitted to static.c
2. When emitting chip_ops for a device, base_chip_instance is used to
determine the correct chip instance name to emit.

BUG=b:155549176
TEST=Verified that the static.c file generated for base/override tree
combination is correct when new devices without chips are added only
to override tree.

Change-Id: Idbb5b34f49bf874da3f30ebb6a6a0e2d8d091fe5
Signed-off-by: Furquan Shaikh <furquan@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/41007
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2020-05-07 11:55:55 +00:00
..
abuild src/Kconfig: enable USE_BLOBS by default 2020-04-14 10:03:55 +00:00
acpi
amdfwtool treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
amdtools
archive
autoport treewide: Drop ACPI_VIDEO_DEVICE macro 2020-05-04 09:41:20 +00:00
bincfg util/bincfg: Add DDR4 SPD spec 2020-03-19 10:31:08 +00:00
board_status util/board-status: Reject logs from dirty images 2020-03-25 20:03:03 +00:00
bucts
cavium
cbfstool treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
cbmem treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
chromeos util/chromeos: Add unzip as a dependency 2020-03-03 12:06:44 +00:00
crossgcc Revert "crossgcc: Upgrade GCC to 9.2.0" 2020-03-16 14:45:32 +00:00
docker treewide: Replace uses of "Nehalem" 2020-03-15 13:04:39 +00:00
dtd_parser
ectool treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
exynos
find_usbdebug
futility cbfstool: Build vboot library 2020-03-23 08:34:23 +00:00
fuzz-tests treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
genbuild_h
genprof
gitconfig util/gitconfig: Fix commit-msg for BSD grep 2020-03-04 16:13:58 +00:00
ifdtool util/ifdtool: add --output flag 2020-03-03 10:12:52 +00:00
intelmetool treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
inteltool treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
intelvbttool
ipqheader
kbc1126 treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
kconfig util/kconfig: Remove miniconfig script 2020-04-29 10:46:07 +00:00
lint util/lint: Accept "GPL-2.0-only WITH Linux-syscall-note" licenses 2020-04-13 19:54:19 +00:00
mainboard/google treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
marvell util/*: more typo fixes 2020-01-30 13:47:49 +00:00
me_cleaner
mma
msrtool treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
mtkheader
nvidia
nvramtool treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
pgtblgen treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
pmh7tool treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
post
qualcomm treewide: move copyrights and authors to AUTHORS 2020-05-06 22:20:43 +00:00
release
riscv
rockchip
sconfig util/sconfig: Drop use of ref_count for chip_instance 2020-05-07 11:55:55 +00:00
scripts util/scripts/ucode_h_to_bin.sh: Fix .inc-lines with just comment 2020-04-22 17:33:58 +00:00
showdevicetree
spdtool
spkmodem_recv
superiotool util/superiotool: Drop one SCH5317 entry 2020-03-09 08:09:11 +00:00
supermicro treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
testing util: Remove viatool 2020-03-04 15:46:44 +00:00
uio_usbdebug treewide: capitalize 'USB' 2020-02-26 17:06:40 +00:00
util_readme
vboot_list Documentation: Spell vboot all lowercase 2020-04-28 06:14:25 +00:00
vgabios treewide: replace GPLv2 long form headers with SPDX header 2020-05-06 22:20:57 +00:00
x86 treewide: Move "is part of the coreboot project" line in its own comment 2020-05-06 22:20:28 +00:00
xcompile util/xcompile: Split $CFLAGS_GCC 2020-03-20 09:33:35 +00:00
README.md Doc,util: Update list of utilities 2020-04-20 06:55:49 +00:00

README.md

  • 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
  • archive - Concatenate files and create an archive C
  • autoport - Automated porting coreboot to Sandy Bridge/Ivy Bridge platforms Go
  • bincfg - Compiler/Decompiler for data blobs with specs Lex Yacc
  • board_status - Tools to collect logs and upload them to the board status repository Bash Go
  • bucts - A tool to manipulate the BUC.TS bit on Intel targets. C
  • cavium - Devicetree_convert Tool to convert a DTB to a static C file Python
  • 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
  • cbmem - CBMEM parser to read e.g. timestamps and console log C
  • chromeos - These scripts can be used to access Chrome OS resources, for example to extract System Agent reference code and other 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)
  • docker - Dockerfiles for coreboot-sdk, coreboot-jenkins-node, coreboot.org-status and docs.coreboot.org
  • 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). Python2
  • find_usbdebug - Help find USB debug ports
  • 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
  • genprof - Format function tracing logs Bash C
  • gitconfig - Initialize git repository submodules install git hooks Bash
  • ifdtool - Extract and dump Intel Firmware Descriptor information C
  • intelmetool - Dump interesting things about Management Engine even if hidden C
  • 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
    • 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
  • 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
  • kconfig - Build system Make
  • lint - Source linter and linting rules Shell
  • marvell - Add U-Boot boot loader for Marvell ARMADA38X C
  • me_cleaner - Tool for partial deblobbing of Intel ME/TXE firmware images Python
  • mma - Memory Margin Analysis automation tests Bash
  • msrtool - Dumps chipset-specific MSR registers. C
  • mtkheader - Generate MediaTek bootload header. Python2
  • 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
  • qualcomm - CMM script to debug Qualcomm coreboot environments. CMM
  • release - Generate coreboot release Bash
  • 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
  • rockchip - Generate Rockchip idblock bootloader. Python2
  • sconfig - coreboot device tree compiler Lex Yacc
  • 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
    • decode_spd.sh - Decodes Serial Presence Detect (SPD) files into various human readable formats.
    • 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
  • showdevicetree - Compile and dump the device tree C
  • 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
  • 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 of the Super I/O. C
  • smcbiosinfo - Generates SMC biosinfo for BMC BIOS updates C
  • testing - coreboot test targets Make
  • uio_usbdebug - Debug coreboot's usbdebug driver inside a running operating system (only Linux at this time). C
  • util_readme - Creates README.md of description files in ./util subdirectories Bash
  • vboot_list - Tools to generate a list of vboot enabled devices to the documentation Bash
  • vgabios - emulated vga driver for qemu C
  • x86 - Generates 32-bit PAE page tables based on a CSV input file. Go
  • xcompile - Cross compile setup Bash