coreboot-kgpe-d16/util
Nico Huber 8e1ea525d1 sconfig: Allow to link devices to other device's drivers
Rarely, the driver of one device needs to know about another device
that can be anywhere in the device hierarchy. Current applications
boil down to EEPROMs that store information that is consumed by some
code (e.g. MAC address).

The idea is to give device nodes in the `devicetree.cb` an alias that
can later be used to link it to a device driver's `config` structure.
The driver has to declare a field of type `struct device *`, e.g.

    struct some_chip_driver_config {
            DEVTREE_CONST struct device *needed_eeprom;
    };

In the devicetree, the referenced device gets an alias, e.g.

    device i2c 0x50 alias my_eeprom on end

The author of the devicetree is free to choose any alias name that
is unique in the devicetree. Later, when configuring the driver the
alias can be used to link the device with the field of a driver's
config:

    chip some/chip/driver
            use my_eeprom as needed_eeprom
    end

Override devices can add an alias if it does not exist, but cannot
change the alias for a device that already exists.

Alias names are checked for conflicts both in the base tree and in the
override tree.

References are resolved after the tree is parsed so aliases and
references do not need to be in a specific order in the tree.

Change-Id: I058a319f9b968924fbef9485a96c9e3f900a3ee8
Signed-off-by: Nico Huber <nico.huber@secunet.com>
Signed-off-by: Duncan Laurie <dlaurie@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/35456
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2020-09-11 17:34:01 +00:00
..
abuild util/abuild: Remove symbols that don't exist anymore in Kconfig 2020-09-10 15:50:27 +00:00
acpi
amdfwtool util/amdfwtool: Add PSP verstage signature entry 2020-09-03 16:30:14 +00:00
amdtools treewide: use /usr/bin/env where appropriate 2018-11-17 07:32:03 +00:00
apcb util/apcb_edit: fix handling of binary SPD files 2020-09-08 05:44:28 +00:00
archive
autoport mb/lenovo: Prepend EC event number with 0x to denote hex notation 2020-07-26 21:40:16 +00:00
bincfg util: Use SPDX headers 2020-05-11 19:38:40 +00:00
board_status util/board-status: Reject logs with unknown timestamps 2020-07-15 12:31:46 +00:00
bucts util/: Replace GPLv2 boiler plate with SPDX header 2020-05-09 21:22:08 +00:00
cavium
cbfstool util/cbfstool: Defuse vboot's openssl linking 2020-07-01 18:06:16 +00:00
cbmem
chromeos treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
crossgcc crossgcc: Ensure that GMP is built for a generic CPU on x86 2020-09-03 18:47:09 +00:00
docker Fix up Docker paths to match jenkins nomenclature 2020-06-26 18:56:48 +00:00
dtd_parser
ectool treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
exynos
find_usbdebug util/: Replace GPLv2 boiler plate with SPDX header 2020-05-09 21:22:08 +00:00
futility util/futility: Check for pkg-config and libcrypto 2020-07-01 18:12:05 +00:00
fuzz-tests treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
genbuild_h treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
genprof
gitconfig treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
ifdtool util/ifdtool: Add NULL check for pointer fpsba 2020-09-08 05:37:36 +00:00
intelmetool util/intelmetool: Fix error message 2020-07-15 08:33:55 +00:00
intelp2m util/intelp2m: Add support for Cannonlake-LP SoCs 2020-08-18 08:49:27 +00:00
inteltool util/inteltool: Add support for Comet Lake-U 2020-08-29 13:41:04 +00:00
intelvbttool intelvbttool: Fix some typos in error messages 2020-07-28 19:20:05 +00:00
ipqheader sdm845: Combine BB with QC-Sec for ROM boot 2019-05-03 21:59:05 +00:00
kbc1126 treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
kconfig treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
lint lint/lint-extended-007-checkpatch: Remove obsolete path 2020-08-31 06:40:55 +00:00
mainboard/google util/mb/google: Update dalboz/trembyle template 2020-09-09 10:46:43 +00:00
marvell
me_cleaner util: Use SPDX headers 2020-05-11 19:38:40 +00:00
mma
msrtool treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
mtkheader
nvidia
nvramtool util: Allow overriding gcc as default host compiler 2020-06-04 08:11:48 +00:00
pgtblgen pgtblgen: Update comment to match what the code does 2020-07-06 17:24:59 +00:00
pmh7tool treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
post
qualcomm
release
riscv treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
rockchip
sconfig sconfig: Allow to link devices to other device's drivers 2020-09-11 17:34:01 +00:00
scripts cross-repo-cherrypick: Do not prepend "Original-" to "Cq-Depend:" 2020-08-31 06:33:56 +00:00
showdevicetree
spd_tools util/spd_tools: Support comments in mem_parts_used 2020-09-09 10:46:03 +00:00
spdtool util: Add SPDX header, replacing boiler plate where applicable 2020-05-11 17:11:59 +00:00
spkmodem_recv util: Add SPDX header, replacing boiler plate where applicable 2020-05-11 17:11:59 +00:00
superiotool util: Add SPDX header, replacing boiler plate where applicable 2020-05-11 17:11:59 +00:00
supermicro
testing testing: Add unit tests to what-jenkins-does procedure 2020-05-28 09:47:56 +00:00
uio_usbdebug util: Add SPDX header, replacing boiler plate where applicable 2020-05-11 17:11:59 +00:00
util_readme
vboot_list
vgabios util: Add SPDX header, replacing boiler plate where applicable 2020-05-11 17:11:59 +00:00
x86 treewide: Remove "this file is part of" lines 2020-05-11 17:11:40 +00:00
xcompile
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